Form field attributes aren’t included in form schema

[kinglozzer]

FormField::getSchemaDataDefaults() by default returns an empty array for the field’s attributes (third-last item in the below array):

silverstripe-framework/src/Forms/FormField.php

Lines 1538 to 1560 in 29a663c

	public function getSchemaDataDefaults()
	{
	return [
	'name' => $this->getName(),
	'id' => $this->ID(),
	'type' => $this->getInputType(),
	'schemaType' => $this->getSchemaDataType(),
	'component' => $this->getSchemaComponent(),
	'holderId' => $this->HolderID(),
	'title' => $this->obj('Title')->getSchemaValue(),
	'source' => null,
	'extraClass' => $this->extraClass(),
	'description' => $this->obj('Description')->getSchemaValue(),
	'rightTitle' => $this->obj('RightTitle')->getSchemaValue(),
	'leftTitle' => $this->obj('LeftTitle')->getSchemaValue(),
	'readOnly' => $this->isReadonly(),
	'disabled' => $this->isDisabled(),
	'customValidationMessage' => $this->getCustomValidationMessage(),
	'validation' => $this->getSchemaValidation(),
	'attributes' => [],
	'autoFocus' => $this->isAutofocus(),
	'data' => [],
	];

I noticed this when adding a new field to GridFieldFilterHeader, any attributes I add to the field go missing as it’s built using the form schema. Workaround is to just use ->setSchemaData() to add the attributes manually

Changing it to 'attributes' => $this->getAttributes(), has the desired effect. Edit: that won’t work because recursion #9125 (comment)

PRs

Kitchen sink CI

• FIX Ensure schema data includes attributes #11469
• FIX Avoid infinite recursive loop with attributes in schemadata silverstripe-tagfield#312
• FIX Avoid infinite recursive loop with attributes in schemadata silverstripe-admin#1853
• FIX Avoid infinite recursive loop with attributes in schemadata silverstripe-versioned-admin#370
• FIX Avoid infinite recursive loop with attributes in schemadata silverstripe-asset-admin#1510
• FIX Avoid infinite recursive loop with attributes in schemadata silverstripe-elemental-bannerblock#166
• ENH Use new $SchemaAttributesHtml template property silverstripe-session-manager#225
• ENH Use new $SchemaAttributesHtml template property silverstripe-mfa#575
• ENH Use new $SchemaAttributesHtml template property silverstripe-elemental#1277
• DOC Document including attributes in formfield schema data developer-docs#630

[micschk]

Temporary workaround (eg for placeholder attribute):
$field->setSchemaData(['attributes' => ['placeholder' => 'My placeholder value']]);

[GuySartorelli]

I think the way forward for this is in a major release call getAttributes() from getSchemaDataDefaults(), and make sure to update any core and supported modules to not call getSchemaData() in getAttributes() (e.g. TreeDropdownField - those data attributes should be added in the template directly instead, perhaps)

[emteknetnz]

Linked PRs have been merged, they're be released with CMS 6.0.0