mirror of
https://github.com/WordPress/WordPress.git
synced 2024-07-05 03:05:01 +02:00
742e8aae9c
It fixes the coding style issues reported. It goes further and improves the code quality it other places where the logic for block bindings was added. Follow-up for [57514]. Props: gziolo, mukesh27, youknowriad, santosguillamot. See #60282. Built from https://develop.svn.wordpress.org/trunk@57526 git-svn-id: http://core.svn.wordpress.org/trunk@57027 1a063a9b-81f0-0310-95a4-ce76da25c4cd
81 lines
3.3 KiB
PHP
81 lines
3.3 KiB
PHP
<?php
|
|
/**
|
|
* Block Bindings API
|
|
*
|
|
* Contains functions for managing block bindings in WordPress.
|
|
*
|
|
* @package WordPress
|
|
* @subpackage Block Bindings
|
|
* @since 6.5.0
|
|
*/
|
|
|
|
/**
|
|
* Registers a new block bindings source.
|
|
*
|
|
* Sources are used to override block's original attributes with a value
|
|
* coming from the source. Once a source is registered, it can be used by a
|
|
* block by setting its `metadata.bindings` attribute to a value that refers
|
|
* to the source.
|
|
*
|
|
* @since 6.5.0
|
|
*
|
|
* @param string $source_name 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.
|
|
* @param array $source_properties {
|
|
* The array of arguments that are used to register a source.
|
|
*
|
|
* @type string $label The label of the source.
|
|
* @type callback $get_value_callback 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.
|
|
* }
|
|
* @return array|false Source when the registration was successful, or `false` on failure.
|
|
*/
|
|
function register_block_bindings_source( string $source_name, array $source_properties ) {
|
|
return WP_Block_Bindings_Registry::get_instance()->register( $source_name, $source_properties );
|
|
}
|
|
|
|
/**
|
|
* Unregisters a block bindings source.
|
|
*
|
|
* @since 6.5.0
|
|
*
|
|
* @param string $source_name Block bindings source name including namespace.
|
|
* @return array|false The unregistered block bindings source on success and `false` otherwise.
|
|
*/
|
|
function unregister_block_bindings_source( string $source_name ) {
|
|
return WP_Block_Bindings_Registry::get_instance()->unregister( $source_name );
|
|
}
|
|
|
|
/**
|
|
* Retrieves the list of all registered block bindings sources.
|
|
*
|
|
* @since 6.5.0
|
|
*
|
|
* @return array The array of registered block bindings sources.
|
|
*/
|
|
function get_all_registered_block_bindings_sources() {
|
|
return WP_Block_Bindings_Registry::get_instance()->get_all_registered();
|
|
}
|
|
|
|
/**
|
|
* Retrieves a registered block bindings source.
|
|
*
|
|
* @since 6.5.0
|
|
*
|
|
* @param string $source_name The name of the source.
|
|
* @return array|null The registered block bindings source, or `null` if it is not registered.
|
|
*/
|
|
function get_block_bindings_source( string $source_name ) {
|
|
return WP_Block_Bindings_Registry::get_instance()->get_registered( $source_name );
|
|
}
|