diff -r 7b1b88e27a20 -r 48c4eec2b7e6 wp/wp-includes/class-wp-block-type.php --- a/wp/wp-includes/class-wp-block-type.php Thu Sep 29 08:06:27 2022 +0200 +++ b/wp/wp-includes/class-wp-block-type.php Fri Sep 05 18:40:08 2025 +0200 @@ -14,6 +14,7 @@ * * @see register_block_type() */ +#[AllowDynamicProperties] class WP_Block_Type { /** @@ -54,7 +55,7 @@ * when nested within the specified blocks. * * @since 5.5.0 - * @var array|null + * @var string[]|null */ public $parent = null; @@ -63,11 +64,19 @@ * block types at any position of the ancestor's block subtree. * * @since 6.0.0 - * @var array|null + * @var string[]|null */ public $ancestor = null; /** + * Limits which block types can be inserted as children of this block type. + * + * @since 6.5.0 + * @var string[]|null + */ + public $allowed_blocks = null; + + /** * Block type icon. * * @since 5.5.0 @@ -112,9 +121,26 @@ * Block variations. * * @since 5.8.0 + * @since 6.5.0 Only accessible through magic getter. null by default. + * @var array[]|null + */ + private $variations = null; + + /** + * Block variations callback. + * + * @since 6.5.0 + * @var callable|null + */ + public $variation_callback = null; + + /** + * Custom CSS selectors for theme.json style generation. + * + * @since 6.3.0 * @var array */ - public $variations = array(); + public $selectors = array(); /** * Supported features. @@ -152,66 +178,110 @@ * Context values inherited by blocks of this type. * * @since 5.5.0 - * @var array + * @var string[] */ - public $uses_context = array(); + private $uses_context = array(); /** * Context provided by blocks of this type. * * @since 5.5.0 - * @var array|null + * @var string[]|null */ public $provides_context = null; /** - * Block type editor only script handle. + * Block hooks for this block type. * - * @since 5.0.0 - * @var string|null + * A block hook is specified by a block type and a relative position. + * The hooked block will be automatically inserted in the given position + * next to the "anchor" block whenever the latter is encountered. + * + * @since 6.4.0 + * @var string[] */ - public $editor_script = null; + public $block_hooks = array(); /** - * Block type front end and editor script handle. + * Block type editor only script handles. + * + * @since 6.1.0 + * @var string[] + */ + public $editor_script_handles = array(); + + /** + * Block type front end and editor script handles. * - * @since 5.0.0 - * @var string|null + * @since 6.1.0 + * @var string[] */ - public $script = null; + public $script_handles = array(); + + /** + * Block type front end only script handles. + * + * @since 6.1.0 + * @var string[] + */ + public $view_script_handles = array(); /** - * Block type front end only script handle. + * Block type front end only script module IDs. * - * @since 5.9.0 - * @var string|null + * @since 6.5.0 + * @var string[] */ - public $view_script = null; + public $view_script_module_ids = array(); + + /** + * Block type editor only style handles. + * + * @since 6.1.0 + * @var string[] + */ + public $editor_style_handles = array(); /** - * Block type editor only style handle. + * Block type front end and editor style handles. * - * @since 5.0.0 - * @var string|null + * @since 6.1.0 + * @var string[] */ - public $editor_style = null; + public $style_handles = array(); /** - * Block type front end and editor style handle. + * Block type front end only style handles. + * + * @since 6.5.0 + * @var string[] + */ + public $view_style_handles = array(); + + /** + * Deprecated block type properties for script and style handles. * - * @since 5.0.0 - * @var string|null + * @since 6.1.0 + * @var string[] */ - public $style = null; + private $deprecated_properties = array( + 'editor_script', + 'script', + 'view_script', + 'editor_style', + 'style', + ); /** * Attributes supported by every block. * - * @since 6.0.0 + * @since 6.0.0 Added `lock`. + * @since 6.5.0 Added `metadata`. * @var array */ const GLOBAL_ATTRIBUTES = array( - 'lock' => array( 'type' => 'object' ), + 'lock' => array( 'type' => 'object' ), + 'metadata' => array( 'type' => 'object' ), ); /** @@ -227,6 +297,12 @@ * @since 5.8.0 Added the `variations` property. * @since 5.9.0 Added the `view_script` property. * @since 6.0.0 Added the `ancestor` property. + * @since 6.1.0 Added the `editor_script_handles`, `script_handles`, `view_script_handles`, + * `editor_style_handles`, and `style_handles` properties. + * Deprecated the `editor_script`, `script`, `view_script`, `editor_style`, and `style` properties. + * @since 6.3.0 Added the `selectors` property. + * @since 6.4.0 Added the `block_hooks` property. + * @since 6.5.0 Added the `allowed_blocks`, `variation_callback`, and `view_style_handles` properties. * * @see register_block_type() * @@ -235,32 +311,37 @@ * Optional. Array or string of arguments for registering a block type. Any arguments may be defined, * however the ones described below are supported by default. Default empty array. * - * @type string $api_version Block API version. - * @type string $title Human-readable block type label. - * @type string|null $category Block type category classification, used in - * search interfaces to arrange block types by category. - * @type array|null $parent Setting parent lets a block require that it is only - * available when nested within the specified blocks. - * @type array|null $ancestor Setting ancestor makes a block available only inside the specified - * block types at any position of the ancestor's block subtree. - * @type string|null $icon Block type icon. - * @type string $description A detailed block type description. - * @type string[] $keywords Additional keywords to produce block type as - * result in search interfaces. - * @type string|null $textdomain The translation textdomain. - * @type array $styles Alternative block styles. - * @type array $variations Block variations. - * @type array|null $supports Supported features. - * @type array|null $example Structured data for the block preview. - * @type callable|null $render_callback Block type render callback. - * @type array|null $attributes Block type attributes property schemas. - * @type array $uses_context Context values inherited by blocks of this type. - * @type array|null $provides_context Context provided by blocks of this type. - * @type string|null $editor_script Block type editor only script handle. - * @type string|null $script Block type front end and editor script handle. - * @type string|null $view_script Block type front end only script handle. - * @type string|null $editor_style Block type editor only style handle. - * @type string|null $style Block type front end and editor style handle. + * @type string $api_version Block API version. + * @type string $title Human-readable block type label. + * @type string|null $category Block type category classification, used in + * search interfaces to arrange block types by category. + * @type string[]|null $parent Setting parent lets a block require that it is only + * available when nested within the specified blocks. + * @type string[]|null $ancestor Setting ancestor makes a block available only inside the specified + * block types at any position of the ancestor's block subtree. + * @type string[]|null $allowed_blocks Limits which block types can be inserted as children of this block type. + * @type string|null $icon Block type icon. + * @type string $description A detailed block type description. + * @type string[] $keywords Additional keywords to produce block type as + * result in search interfaces. + * @type string|null $textdomain The translation textdomain. + * @type array[] $styles Alternative block styles. + * @type array[] $variations Block variations. + * @type array $selectors Custom CSS selectors for theme.json style generation. + * @type array|null $supports Supported features. + * @type array|null $example Structured data for the block preview. + * @type callable|null $render_callback Block type render callback. + * @type callable|null $variation_callback Block type variations callback. + * @type array|null $attributes Block type attributes property schemas. + * @type string[] $uses_context Context values inherited by blocks of this type. + * @type string[]|null $provides_context Context provided by blocks of this type. + * @type string[] $block_hooks Block hooks. + * @type string[] $editor_script_handles Block type editor only script handles. + * @type string[] $script_handles Block type front end and editor script handles. + * @type string[] $view_script_handles Block type front end only script handles. + * @type string[] $editor_style_handles Block type editor only style handles. + * @type string[] $style_handles Block type front end and editor style handles. + * @type string[] $view_style_handles Block type front end only style handles. * } */ public function __construct( $block_type, $args = array() ) { @@ -270,6 +351,110 @@ } /** + * Proxies getting values for deprecated properties for script and style handles for backward compatibility. + * Gets the value for the corresponding new property if the first item in the array provided. + * + * @since 6.1.0 + * + * @param string $name Deprecated property name. + * + * @return string|string[]|null|void The value read from the new property if the first item in the array provided, + * null when value not found, or void when unknown property name provided. + */ + public function __get( $name ) { + if ( 'variations' === $name ) { + return $this->get_variations(); + } + + if ( 'uses_context' === $name ) { + return $this->get_uses_context(); + } + + if ( ! in_array( $name, $this->deprecated_properties, true ) ) { + return; + } + + $new_name = $name . '_handles'; + + if ( ! property_exists( $this, $new_name ) || ! is_array( $this->{$new_name} ) ) { + return null; + } + + if ( count( $this->{$new_name} ) > 1 ) { + return $this->{$new_name}; + } + return isset( $this->{$new_name}[0] ) ? $this->{$new_name}[0] : null; + } + + /** + * Proxies checking for deprecated properties for script and style handles for backward compatibility. + * Checks whether the corresponding new property has the first item in the array provided. + * + * @since 6.1.0 + * + * @param string $name Deprecated property name. + * + * @return bool Returns true when for the new property the first item in the array exists, + * or false otherwise. + */ + public function __isset( $name ) { + if ( in_array( $name, array( 'variations', 'uses_context' ), true ) ) { + return true; + } + + if ( ! in_array( $name, $this->deprecated_properties, true ) ) { + return false; + } + + $new_name = $name . '_handles'; + return isset( $this->{$new_name}[0] ); + } + + /** + * Proxies setting values for deprecated properties for script and style handles for backward compatibility. + * Sets the value for the corresponding new property as the first item in the array. + * It also allows setting custom properties for backward compatibility. + * + * @since 6.1.0 + * + * @param string $name Property name. + * @param mixed $value Property value. + */ + public function __set( $name, $value ) { + if ( ! in_array( $name, $this->deprecated_properties, true ) ) { + $this->{$name} = $value; + return; + } + + $new_name = $name . '_handles'; + + if ( is_array( $value ) ) { + $filtered = array_filter( $value, 'is_string' ); + + if ( count( $filtered ) !== count( $value ) ) { + _doing_it_wrong( + __METHOD__, + sprintf( + /* translators: %s: The '$value' argument. */ + __( 'The %s argument must be a string or a string array.' ), + '$value' + ), + '6.1.0' + ); + } + + $this->{$new_name} = array_values( $filtered ); + return; + } + + if ( ! is_string( $value ) ) { + return; + } + + $this->{$new_name} = array( $value ); + } + + /** * Renders the block type output for given attributes. * * @since 5.0.0 @@ -404,4 +589,49 @@ $this->attributes : array(); } + + /** + * Get block variations. + * + * @since 6.5.0 + * + * @return array[] + */ + public function get_variations() { + if ( ! isset( $this->variations ) ) { + $this->variations = array(); + if ( is_callable( $this->variation_callback ) ) { + $this->variations = call_user_func( $this->variation_callback ); + } + } + + /** + * Filters the registered variations for a block type. + * + * @since 6.5.0 + * + * @param array $variations Array of registered variations for a block type. + * @param WP_Block_Type $block_type The full block type object. + */ + return apply_filters( 'get_block_type_variations', $this->variations, $this ); + } + + /** + * Get block uses context. + * + * @since 6.5.0 + * + * @return string[] + */ + public function get_uses_context() { + /** + * Filters the registered uses context for a block type. + * + * @since 6.5.0 + * + * @param string[] $uses_context Array of registered uses context for a block type. + * @param WP_Block_Type $block_type The full block type object. + */ + return apply_filters( 'get_block_type_uses_context', $this->uses_context, $this ); + } }