WP_Block_Bindings_Registry::register( string $source_name, array $source_properties ): WP_Block_Bindings_Source|false

Description

Parameters

$source_namestring

The name of the source. It must be a string containing a namespace prefix, i.e. my-plugin/my-custom-source. It must only contain lowercase alphanumeric characters, the forward slash / and dashes.

$source_propertiesarray

The array of arguments that are used to register a source.

• $labelstring

  The label of the source.

• $get_value_callbackcallable

  A callback executed when the source is processed during block rendering. The callback should have the following signature: function( $source_args, $block_instance, $attribute_name ): mixed - @param array $source_args Array containing source arguments used to look up the override value, i.e. {"key": "foo"}. - @param WP_Block $block_instance The block instance. - @param string $attribute_name The name of the target attribute. The callback has a mixed return type; it may return a string to override the block's original value, null, false to remove an attribute, etc.

• $uses_contextstring[]

  Optional. Array of values to add to block uses_context needed by the source.

Return

WP_Block_Bindings_Source|false

Source when the registration was successful, or false on failure.

Uses · 4

• _doing_it_wrong()Marks something as being incorrectly called.
• __()Retrieves the translation of $text.
• WP_Block_Bindings_Registry::is_registered()Checks if a block bindings source is registered.
• WP_Block_Bindings_Source::__construct()Constructor.

Source

View on Trac ↗View on GitHub ↗

84	public function register( string $source_name, array $source_properties ) {85		if ( ! is_string( $source_name ) ) {86			_doing_it_wrong(87				__METHOD__,88				__( 'Block bindings source name must be a string.' ),89				'6.5.0'90			);91			return false;92		}93 94		if ( preg_match( '/[A-Z]+/', $source_name ) ) {95			_doing_it_wrong(96				__METHOD__,97				__( 'Block bindings source names must not contain uppercase characters.' ),98				'6.5.0'99			);100			return false;101		}102 103		$name_matcher = '/^[a-z0-9-]+\/[a-z0-9-]+$/';104		if ( ! preg_match( $name_matcher, $source_name ) ) {105			_doing_it_wrong(106				__METHOD__,107				__( 'Block bindings source names must contain a namespace prefix. Example: my-plugin/my-custom-source' ),108				'6.5.0'109			);110			return false;111		}112 113		if ( $this->is_registered( $source_name ) ) {114			_doing_it_wrong(115				__METHOD__,116				/* translators: %s: Block bindings source name. */117				sprintf( __( 'Block bindings source "%s" already registered.' ), $source_name ),118				'6.5.0'119			);120			return false;121		}122 123		// Validates that the source properties contain the label.124		if ( ! isset( $source_properties['label'] ) ) {125			_doing_it_wrong(126				__METHOD__,127				__( 'The $source_properties must contain a "label".' ),128				'6.5.0'129			);130			return false;131		}132 133		// Validates that the source properties contain the get_value_callback.134		if ( ! isset( $source_properties['get_value_callback'] ) ) {135			_doing_it_wrong(136				__METHOD__,137				__( 'The $source_properties must contain a "get_value_callback".' ),138				'6.5.0'139			);140			return false;141		}142 143		// Validates that the get_value_callback is a valid callback.144		if ( ! is_callable( $source_properties['get_value_callback'] ) ) {145			_doing_it_wrong(146				__METHOD__,147				__( 'The "get_value_callback" parameter must be a valid callback.' ),148				'6.5.0'149			);150			return false;151		}152 153		// Validates that the uses_context parameter is an array.154		if ( isset( $source_properties['uses_context'] ) && ! is_array( $source_properties['uses_context'] ) ) {155			_doing_it_wrong(156				__METHOD__,157				__( 'The "uses_context" parameter must be an array.' ),158				'6.5.0'159			);160			return false;161		}162 163		if ( ! empty( array_diff( array_keys( $source_properties ), $this->allowed_source_properties ) ) ) {

History

Introduced in 6.5.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/class-wp-block-bindings-registry.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.