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

Description

function my_plugin_get_custom_source_value( array $source_args, $block_instance, string $attribute_name ) {
 // Your custom logic to get the value from the source.
 // For example, you can use the $source_args to look up a value in a custom table or get it from an external API.
 $value = $source_args['key'];

 return "The value passed to the block is: $value"
}

function my_plugin_register_block_bindings_sources() {
 register_block_bindings_source( 'my-plugin/my-custom-source', array(
 'label' => __( 'My Custom Source', 'my-plugin' ),
 'get_value_callback' => 'my_plugin_get_custom_source_value',
 ) );
}
add_action( 'init', 'my_plugin_register_block_bindings_sources' );

<!-- wp:paragraph {
 "metadata": {
 "bindings": {
 "content": {
 "source": "my-plugin/my-custom-source",
 "args": {
 "key": "you can pass any custom arguments here"
 }
 }
 }
 }
} -->
<p>Fallback text that gets replaced.</p>
<!-- /wp:paragraph -->

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

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 an 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 value

WP_Block_Bindings_Source|false

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

Performance profile

How much work a call to register_block_bindings_source() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Trivial

Touches nothing outside its own arguments.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

9

Executed per call on PHP 8.5. The body compiles to 9.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

5

5 places in core call this, so the cost is paid more often than your own code shows.

What one call costs · 1 distinct outcome

One number would be a lie: the work depends on which branch runs. These are every distinct cost register_block_bindings_source() can have, taken from its control-flow graph on PHP 8.5.

Uses · 2

• WP_Block_Bindings_Registry::get_instance()::register()
• WP_Block_Bindings_Registry::get_instance()Utility method to retrieve the main instance of the class.

Used by · 5

• _register_block_bindings_pattern_overrides_source()Registers Pattern Overrides source in the Block Bindings registry.
• _register_block_bindings_post_data_source()Registers Post Data source in the block bindings registry.
• _register_block_bindings_post_meta_source()Registers Post Meta source in the block bindings registry.
• _register_block_bindings_term_data_source()Registers Term Data source in the block bindings registry.
• twentytwentyfive_register_block_bindings()Registers the post format block binding source.

Source code

View on Trac ↗View on GitHub ↗

94function register_block_bindings_source( string $source_name, array $source_properties ) {95	return WP_Block_Bindings_Registry::get_instance()->register( $source_name, $source_properties );96}

Changelog

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/block-bindings.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.