register_block_bindings_source() — описание функции WordPress на русском

Сигнатура

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

Описание

Регистрация источника состоит из задания имени этого источника и функции обратного вызова, определяющей, как получить значение из этого источника и передать его в атрибут блока.
После регистрации источника любой блок, поддерживающий Block Bindings API, может использовать значение из него, задав своему атрибуту metadata.bindings значение, ссылающееся на этот источник.
Обратите внимание, что register_block_bindings_source() следует вызывать из обработчика, прикреплённого к хуку init.

Оригинал (английский)

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.

Параметры

$source_name string обязательный

Имя источника. Должно быть строкой, содержащей префикс пространства имён, например my-plugin/my-custom-source. Может содержать только строчные буквенно-цифровые символы, косую черту / и дефисы.

$source_properties array обязательный

Массив аргументов, используемых для регистрации источника. label stringМетка источника. get_value_callback callableФункция обратного вызова, выполняемая при обработке источника во время рендеринга блока. Функция обратного вызова должна иметь следующую сигнатуру: function( $source_args, $block_instance, $attribute_name ): mixed @param array $source_args Массив с аргументами источника, используемыми для поиска переопределяющего значения, например {"key": "foo"}. @param WP_Block $block_instance Экземпляр блока. @param string $attribute_name Имя атрибута. Функция обратного вызова имеет тип возвращаемого значения mixed; она может вернуть строку, чтобы переопределить исходное значение блока, null, false для удаления атрибута и т. д. uses_context string[]Необязательный. Массив значений, добавляемых в uses_context блока, необходимых источнику.

Возвращаемое значение

WP_Block_Bindings_Source|false

false

Исходный код

wp-includes/block-bindings.php:94

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

История изменений

Версия	Описание
6.5.0	Introduced.