wpseek.com
A WordPress-centric search engine for devs and theme authors



wp_mark_auto_generate_control_attributes › WordPress Function

Since7.0.0
Deprecatedn/a
› wp_mark_auto_generate_control_attributes ( $args )
Access:
  • private
Parameters:
  • (array<string,mixed>) $args Array of arguments for registering a block type.
    Required: Yes
Returns:
  • (array<string,mixed>) Modified block type arguments.
Defined at:
Codex:

Marks user-defined attributes for auto-generated inspector controls.

This filter runs during block type registration, before the WP_Block_Type is instantiated. Block supports add their attributes AFTER the block type is created (via WP_Block_Supports::register_attributes), so any attributes present at this stage are user-defined. The marker tells generateFieldsFromAttributes() which attributes should get auto-generated inspector controls. Attributes are excluded if they: - Have a 'source' (HTML-derived, edited inline not via inspector) - Have role 'local' (internal state, not user-configurable) - Have an unsupported type (only 'string', 'number', 'integer', 'boolean' are supported) - Were added by block supports (added after this filter runs)


Related Functions: wp_get_post_content_block_attributes, wp_sanitize_script_attributes, wp_kses_uri_attributes, wp_add_crossorigin_attributes, wp_authenticate_cookie

Source 

function wp_mark_auto_generate_control_attributes( array $args ): array {
	if ( empty( $args['attributes'] ) || ! is_array( $args['attributes'] ) ) {
		return $args;
	}

	$has_auto_register = ! empty( $args['supports']['autoRegister'] );
	if ( ! $has_auto_register ) {
		return $args;
	}

	foreach ( $args['attributes'] as $attr_key => $attr_schema ) {
		// Skip HTML-derived attributes (edited inline, not via inspector).
		if ( ! empty( $attr_schema['source'] ) ) {
			continue;
		}
		// Skip internal attributes (not user-configurable).
		if ( isset( $attr_schema['role'] ) && 'local' === $attr_schema['role'] ) {
			continue;
		}
		// Skip unsupported types (only 'string', 'number', 'integer', 'boolean' are supported).
		$type = $attr_schema['type'] ?? null;
		if ( ! in_array( $type, array( 'string', 'number', 'integer', 'boolean' ), true ) ) {
			continue;
		}
		$args['attributes'][ $attr_key ]['autoGenerateControl'] = true;
	}

	return $args;
}