1780c6ec3d
PHP 8.5 deprecates the `__sleep()` and `__wakeup()` magic methods in favor of `__serialize()` and `__unserialize()`: > `Deprecated: The __wakeup() serialization magic method has been deprecated. Implement __unserialize() instead (or in addition, if support for old PHP versions is necessary)` For PHP < 7.4 compatibility, `__sleep()` and `__wakeup()` need to be kept for the time being. This commit moves the logic of `__wakeup()` methods in core to `__unserialize()`, and turns the former into wrappers. WordPress core does not use `__sleep()` methods, so these are the only changes required. Reference: [https://wiki.php.net/rfc/deprecations_php_8_5#deprecate_the_sleep_and_wakeup_magic_methods PHP RFC: Deprecations for PHP 8.5: Deprecate the __sleep() and __wakeup() magic methods]. Follow-up to [56835], [60787], [60795]. Props TobiasBg, tusharbharti, swissspidy, dmsnell, SergeyBiryukov. Fixes #63962. See #63061. Built from https://develop.svn.wordpress.org/trunk@60796 git-svn-id: http://core.svn.wordpress.org/trunk@60132 1a063a9b-81f0-0310-95a4-ce76da25c4cd
121 lines
3.2 KiB
PHP
121 lines
3.2 KiB
PHP
<?php
|
|
/**
|
|
* Block Bindings API: WP_Block_Bindings_Source class.
|
|
*
|
|
* @package WordPress
|
|
* @subpackage Block Bindings
|
|
* @since 6.5.0
|
|
*/
|
|
|
|
/**
|
|
* Class representing block bindings source.
|
|
*
|
|
* This class is designed for internal use by the Block Bindings registry.
|
|
*
|
|
* @since 6.5.0
|
|
* @access private
|
|
*
|
|
* @see WP_Block_Bindings_Registry
|
|
*/
|
|
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 string[]|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;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Calls the callback function specified in the `$get_value_callback` property
|
|
* with the given arguments and returns the result. It can be modified with
|
|
* `block_bindings_source_value` filter.
|
|
*
|
|
* @since 6.5.0
|
|
* @since 6.7.0 `block_bindings_source_value` filter was added.
|
|
*
|
|
* @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 ) {
|
|
$value = call_user_func_array( $this->get_value_callback, array( $source_args, $block_instance, $attribute_name ) );
|
|
/**
|
|
* Filters the output of a block bindings source.
|
|
*
|
|
* @since 6.7.0
|
|
*
|
|
* @param mixed $value The computed value for the source.
|
|
* @param string $name The name of the source.
|
|
* @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.
|
|
*/
|
|
return apply_filters( 'block_bindings_source_value', $value, $this->name, $source_args, $block_instance, $attribute_name );
|
|
}
|
|
|
|
/**
|
|
* Unserialize magic method.
|
|
*
|
|
* @since 6.9.0
|
|
*
|
|
* @param array $data Data to unserialize.
|
|
*/
|
|
public function __unserialize( $data ) { // phpcs:ignore PHPCompatibility.FunctionNameRestrictions.NewMagicMethods.__unserializeFound
|
|
throw new \LogicException( __CLASS__ . ' should never be unserialized' );
|
|
}
|
|
|
|
/**
|
|
* Wakeup magic method.
|
|
*
|
|
* @since 6.5.0
|
|
*/
|
|
public function __wakeup() {
|
|
$this->__unserialize( array() );
|
|
}
|
|
}
|