class WP_Block_Bindings_Source {}

In this article

Class representing block bindings source.

Description

This class is designed for internal use by the Block Bindings registry.

See also

Methods

NameDescription
WP_Block_Bindings_Source::__constructConstructor.
WP_Block_Bindings_Source::__wakeupWakeup magic method.
WP_Block_Bindings_Source::get_valueRetrieves the value from the source.

Source

final class WP_Block_Bindings_Source {

	/**
	 * The name of the source.
	 *
	 * @since 6.5.0
	 * @var string
	 */
	public $name;

	/**
	 * The label of the source.
	 *
	 * @since 6.5.0
	 * @var string
	 */
	public $label;


	/**
	 * The function used to get the value from the source.
	 *
	 * @since 6.5.0
	 * @var callable
	 */
	private $get_value_callback;

	/**
	 * The context added to the blocks needed by the source.
	 *
	 * @since 6.5.0
	 * @var array|null
	 */
	public $uses_context = null;

	/**
	 * Constructor.
	 *
	 * Do not use this constructor directly. Instead, use the
	 * `WP_Block_Bindings_Registry::register` method or the `register_block_bindings_source` function.
	 *
	 * @since 6.5.0
	 *
	 * @param string $name               The name of the source.
	 * @param array  $source_properties  The properties of the source.
	 */
	public function __construct( string $name, array $source_properties ) {
		$this->name = $name;
		foreach ( $source_properties as $property_name => $property_value ) {
			$this->$property_name = $property_value;
		}
	}

	/**
	 * Retrieves the value from the source.
	 *
	 * @since 6.5.0
	 *
	 * @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.
	 *
	 * @return mixed The value of the source.
	 */
	public function get_value( array $source_args, $block_instance, string $attribute_name ) {
		return call_user_func_array( $this->get_value_callback, array( $source_args, $block_instance, $attribute_name ) );
	}

	/**
	 * Wakeup magic method.
	 *
	 * @since 6.5.0
	 */
	public function __wakeup() {
		throw new \LogicException( __CLASS__ . ' should never be unserialized' );
	}
}

Changelog

VersionDescription
6.5.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.