mirror of
https://github.com/WordPress/WordPress.git
synced 2024-09-04 11:51:19 +02:00
Dynamic (non-explicitly declared) properties are deprecated as of PHP 8.2 and are expected to become a fatal error in PHP 9.0. There are a number of ways to mitigate this: * If it is an accidental typo for a declared property: fix the typo. * For known properties: declare them on the class. * For unknown properties: add the magic `__get()`, `__set()`, et al. methods to the class or let the class extend `stdClass` which has highly optimized versions of these magic methods built in. * For unknown ''use'' of dynamic properties, the `#[AllowDynamicProperties]` attribute can be added to the class. The attribute will automatically be inherited by child classes. Trac ticket #56034 is open to investigate and handle the third and fourth type of situations, however it has become clear this will need more time and will not be ready in time for WP 6.1. To reduce “noise” in the meantime, both in the error logs of WP users moving onto PHP 8.2, in the test run logs of WP itself, in test runs of plugins and themes, as well as to prevent duplicate tickets from being opened for the same issue, this commit adds the `#[AllowDynamicProperties]` attribute to all “parent” classes in WP. The logic used for this commit is as follows: * If a class already has the attribute: no action needed. * If a class does not `extend`: add the attribute. * If a class does `extend`: - If it extends `stdClass`: no action needed (as `stdClass` supports dynamic properties). - If it extends a PHP native class: add the attribute. - If it extends a class from one of WP's external dependencies: add the attribute. * In all other cases: no action — the attribute should not be needed as child classes inherit from the parent. Whether or not a class contains magic methods has not been taken into account, as a review of the currently existing magic methods has shown that those are generally not sturdy enough and often even set dynamic properties (which they should not). See the [https://www.youtube.com/watch?v=vDZWepDQQVE live stream from August 16, 2022] for more details. This commit only affects classes in the `src` directory of WordPress core. * Tests should not get this attribute, but should be fixed to not use dynamic properties instead. Patches for this are already being committed under ticket #56033. * While a number bundled themes (2014, 2019, 2020, 2021) contain classes, they are not a part of this commit and may be updated separately. Reference: [https://wiki.php.net/rfc/deprecate_dynamic_properties PHP RFC: Deprecate dynamic properties]. Follow-up to [53922]. Props jrf, hellofromTonya, markjaquith, peterwilsoncc, costdev, knutsp, aristath. See #56513, #56034. Built from https://develop.svn.wordpress.org/trunk@54133 git-svn-id: http://core.svn.wordpress.org/trunk@53692 1a063a9b-81f0-0310-95a4-ce76da25c4cd
188 lines
4.6 KiB
PHP
188 lines
4.6 KiB
PHP
<?php
|
|
/**
|
|
* Blocks API: WP_Block_Type_Registry class
|
|
*
|
|
* @package WordPress
|
|
* @subpackage Blocks
|
|
* @since 5.0.0
|
|
*/
|
|
|
|
/**
|
|
* Core class used for interacting with block types.
|
|
*
|
|
* @since 5.0.0
|
|
*/
|
|
#[AllowDynamicProperties]
|
|
final class WP_Block_Type_Registry {
|
|
/**
|
|
* Registered block types, as `$name => $instance` pairs.
|
|
*
|
|
* @since 5.0.0
|
|
* @var WP_Block_Type[]
|
|
*/
|
|
private $registered_block_types = array();
|
|
|
|
/**
|
|
* Container for the main instance of the class.
|
|
*
|
|
* @since 5.0.0
|
|
* @var WP_Block_Type_Registry|null
|
|
*/
|
|
private static $instance = null;
|
|
|
|
/**
|
|
* Registers a block type.
|
|
*
|
|
* @since 5.0.0
|
|
*
|
|
* @see WP_Block_Type::__construct()
|
|
*
|
|
* @param string|WP_Block_Type $name Block type name including namespace, or alternatively
|
|
* a complete WP_Block_Type instance. In case a WP_Block_Type
|
|
* is provided, the $args parameter will be ignored.
|
|
* @param array $args Optional. Array of block type arguments. Accepts any public property
|
|
* of `WP_Block_Type`. See WP_Block_Type::__construct() for information
|
|
* on accepted arguments. Default empty array.
|
|
* @return WP_Block_Type|false The registered block type on success, or false on failure.
|
|
*/
|
|
public function register( $name, $args = array() ) {
|
|
$block_type = null;
|
|
if ( $name instanceof WP_Block_Type ) {
|
|
$block_type = $name;
|
|
$name = $block_type->name;
|
|
}
|
|
|
|
if ( ! is_string( $name ) ) {
|
|
_doing_it_wrong(
|
|
__METHOD__,
|
|
__( 'Block type names must be strings.' ),
|
|
'5.0.0'
|
|
);
|
|
return false;
|
|
}
|
|
|
|
if ( preg_match( '/[A-Z]+/', $name ) ) {
|
|
_doing_it_wrong(
|
|
__METHOD__,
|
|
__( 'Block type names must not contain uppercase characters.' ),
|
|
'5.0.0'
|
|
);
|
|
return false;
|
|
}
|
|
|
|
$name_matcher = '/^[a-z0-9-]+\/[a-z0-9-]+$/';
|
|
if ( ! preg_match( $name_matcher, $name ) ) {
|
|
_doing_it_wrong(
|
|
__METHOD__,
|
|
__( 'Block type names must contain a namespace prefix. Example: my-plugin/my-custom-block-type' ),
|
|
'5.0.0'
|
|
);
|
|
return false;
|
|
}
|
|
|
|
if ( $this->is_registered( $name ) ) {
|
|
_doing_it_wrong(
|
|
__METHOD__,
|
|
/* translators: %s: Block name. */
|
|
sprintf( __( 'Block type "%s" is already registered.' ), $name ),
|
|
'5.0.0'
|
|
);
|
|
return false;
|
|
}
|
|
|
|
if ( ! $block_type ) {
|
|
$block_type = new WP_Block_Type( $name, $args );
|
|
}
|
|
|
|
$this->registered_block_types[ $name ] = $block_type;
|
|
|
|
return $block_type;
|
|
}
|
|
|
|
/**
|
|
* Unregisters a block type.
|
|
*
|
|
* @since 5.0.0
|
|
*
|
|
* @param string|WP_Block_Type $name Block type name including namespace, or alternatively
|
|
* a complete WP_Block_Type instance.
|
|
* @return WP_Block_Type|false The unregistered block type on success, or false on failure.
|
|
*/
|
|
public function unregister( $name ) {
|
|
if ( $name instanceof WP_Block_Type ) {
|
|
$name = $name->name;
|
|
}
|
|
|
|
if ( ! $this->is_registered( $name ) ) {
|
|
_doing_it_wrong(
|
|
__METHOD__,
|
|
/* translators: %s: Block name. */
|
|
sprintf( __( 'Block type "%s" is not registered.' ), $name ),
|
|
'5.0.0'
|
|
);
|
|
return false;
|
|
}
|
|
|
|
$unregistered_block_type = $this->registered_block_types[ $name ];
|
|
unset( $this->registered_block_types[ $name ] );
|
|
|
|
return $unregistered_block_type;
|
|
}
|
|
|
|
/**
|
|
* Retrieves a registered block type.
|
|
*
|
|
* @since 5.0.0
|
|
*
|
|
* @param string $name Block type name including namespace.
|
|
* @return WP_Block_Type|null The registered block type, or null if it is not registered.
|
|
*/
|
|
public function get_registered( $name ) {
|
|
if ( ! $this->is_registered( $name ) ) {
|
|
return null;
|
|
}
|
|
|
|
return $this->registered_block_types[ $name ];
|
|
}
|
|
|
|
/**
|
|
* Retrieves all registered block types.
|
|
*
|
|
* @since 5.0.0
|
|
*
|
|
* @return WP_Block_Type[] Associative array of `$block_type_name => $block_type` pairs.
|
|
*/
|
|
public function get_all_registered() {
|
|
return $this->registered_block_types;
|
|
}
|
|
|
|
/**
|
|
* Checks if a block type is registered.
|
|
*
|
|
* @since 5.0.0
|
|
*
|
|
* @param string $name Block type name including namespace.
|
|
* @return bool True if the block type is registered, false otherwise.
|
|
*/
|
|
public function is_registered( $name ) {
|
|
return isset( $this->registered_block_types[ $name ] );
|
|
}
|
|
|
|
/**
|
|
* Utility method to retrieve the main instance of the class.
|
|
*
|
|
* The instance will be created if it does not exist yet.
|
|
*
|
|
* @since 5.0.0
|
|
*
|
|
* @return WP_Block_Type_Registry The main instance.
|
|
*/
|
|
public static function get_instance() {
|
|
if ( null === self::$instance ) {
|
|
self::$instance = new self();
|
|
}
|
|
|
|
return self::$instance;
|
|
}
|
|
}
|