| [ Index ] |
PHP Cross Reference of WordPress Trunk (Updated Daily) |
[Source view] [Print] [Project Stats]
Block Bindings API Contains functions for managing block bindings in WordPress.
| File Size: | 131 lines (6 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
| register_block_bindings_source( string $source_name, array $source_properties ) X-Ref |
| Registers a new block bindings source. Registering a source consists of defining a **name** for that source and a callback function specifying how to get a value from that source and pass it to a block attribute. Once a source is registered, any block that supports the Block Bindings API can use a value from that source by setting its `metadata.bindings` attribute to a value that refers to the source. Note that `register_block_bindings_source()` should be called from a handler attached to the `init` hook. ## Example ### Registering a source First, you need to define a function that will be used to get the value from the source. 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" } The `$source_args` will contain the arguments passed to the source in the block's `metadata.bindings` attribute. See the example in the "Usage in a block" section below. 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' ); ### Usage in a block In a block's `metadata.bindings` attribute, you can specify the source and its arguments. Such a block will use the source to override the block attribute's value. For example: <!-- 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 --> return: WP_Block_Bindings_Source|false Source when the registration was successful, or `false` on failure. param: string $source_name The name of the source. It must be a string containing a namespace prefix, i.e. param: array $source_properties { |
| unregister_block_bindings_source( string $source_name ) X-Ref |
| Unregisters a block bindings source. return: WP_Block_Bindings_Source|false The unregistered block bindings source on success and `false` otherwise. param: string $source_name Block bindings source name including namespace. |
| get_all_registered_block_bindings_sources() X-Ref |
| Retrieves the list of all registered block bindings sources. return: WP_Block_Bindings_Source[] The array of registered block bindings sources. |
| get_block_bindings_source( string $source_name ) X-Ref |
| Retrieves a registered block bindings source. return: WP_Block_Bindings_Source|null The registered block bindings source, or `null` if it is not registered. param: string $source_name The name of the source. |
| Generated : Thu May 9 08:20:02 2024 | Cross-referenced by PHPXref |