mirror of
https://github.com/WordPress/WordPress.git
synced 2024-08-21 05:12:59 +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
192 lines
5.2 KiB
PHP
192 lines
5.2 KiB
PHP
<?php
|
|
/**
|
|
* Blocks API: WP_Block_Pattern_Categories_Registry class
|
|
*
|
|
* @package WordPress
|
|
* @subpackage Blocks
|
|
* @since 5.5.0
|
|
*/
|
|
|
|
/**
|
|
* Class used for interacting with block pattern categories.
|
|
*/
|
|
#[AllowDynamicProperties]
|
|
final class WP_Block_Pattern_Categories_Registry {
|
|
/**
|
|
* Registered block pattern categories array.
|
|
*
|
|
* @since 5.5.0
|
|
* @var array[]
|
|
*/
|
|
private $registered_categories = array();
|
|
|
|
/**
|
|
* Pattern categories registered outside the `init` action.
|
|
*
|
|
* @since 6.0.0
|
|
* @var array[]
|
|
*/
|
|
private $registered_categories_outside_init = array();
|
|
|
|
/**
|
|
* Container for the main instance of the class.
|
|
*
|
|
* @since 5.5.0
|
|
* @var WP_Block_Pattern_Categories_Registry|null
|
|
*/
|
|
private static $instance = null;
|
|
|
|
/**
|
|
* Registers a pattern category.
|
|
*
|
|
* @since 5.5.0
|
|
*
|
|
* @param string $category_name Pattern category name including namespace.
|
|
* @param array $category_properties {
|
|
* List of properties for the block pattern category.
|
|
*
|
|
* @type string $label Required. A human-readable label for the pattern category.
|
|
* }
|
|
* @return bool True if the pattern was registered with success and false otherwise.
|
|
*/
|
|
public function register( $category_name, $category_properties ) {
|
|
if ( ! isset( $category_name ) || ! is_string( $category_name ) ) {
|
|
_doing_it_wrong(
|
|
__METHOD__,
|
|
__( 'Block pattern category name must be a string.' ),
|
|
'5.5.0'
|
|
);
|
|
return false;
|
|
}
|
|
|
|
$category = array_merge(
|
|
array( 'name' => $category_name ),
|
|
$category_properties
|
|
);
|
|
|
|
$this->registered_categories[ $category_name ] = $category;
|
|
|
|
// If the category is registered inside an action other than `init`, store it
|
|
// also to a dedicated array. Used to detect deprecated registrations inside
|
|
// `admin_init` or `current_screen`.
|
|
if ( current_action() && 'init' !== current_action() ) {
|
|
$this->registered_categories_outside_init[ $category_name ] = $category;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Unregisters a pattern category.
|
|
*
|
|
* @since 5.5.0
|
|
*
|
|
* @param string $category_name Pattern category name including namespace.
|
|
* @return bool True if the pattern was unregistered with success and false otherwise.
|
|
*/
|
|
public function unregister( $category_name ) {
|
|
if ( ! $this->is_registered( $category_name ) ) {
|
|
_doing_it_wrong(
|
|
__METHOD__,
|
|
/* translators: %s: Block pattern name. */
|
|
sprintf( __( 'Block pattern category "%s" not found.' ), $category_name ),
|
|
'5.5.0'
|
|
);
|
|
return false;
|
|
}
|
|
|
|
unset( $this->registered_categories[ $category_name ] );
|
|
unset( $this->registered_categories_outside_init[ $category_name ] );
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Retrieves an array containing the properties of a registered pattern category.
|
|
*
|
|
* @since 5.5.0
|
|
*
|
|
* @param string $category_name Pattern category name including namespace.
|
|
* @return array Registered pattern properties.
|
|
*/
|
|
public function get_registered( $category_name ) {
|
|
if ( ! $this->is_registered( $category_name ) ) {
|
|
return null;
|
|
}
|
|
|
|
return $this->registered_categories[ $category_name ];
|
|
}
|
|
|
|
/**
|
|
* Retrieves all registered pattern categories.
|
|
*
|
|
* @since 5.5.0
|
|
*
|
|
* @param bool $outside_init_only Return only categories registered outside the `init` action.
|
|
* @return array[] Array of arrays containing the registered pattern categories properties.
|
|
*/
|
|
public function get_all_registered( $outside_init_only = false ) {
|
|
return array_values(
|
|
$outside_init_only
|
|
? $this->registered_categories_outside_init
|
|
: $this->registered_categories
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Checks if a pattern category is registered.
|
|
*
|
|
* @since 5.5.0
|
|
*
|
|
* @param string $category_name Pattern category name including namespace.
|
|
* @return bool True if the pattern category is registered, false otherwise.
|
|
*/
|
|
public function is_registered( $category_name ) {
|
|
return isset( $this->registered_categories[ $category_name ] );
|
|
}
|
|
|
|
/**
|
|
* Utility method to retrieve the main instance of the class.
|
|
*
|
|
* The instance will be created if it does not exist yet.
|
|
*
|
|
* @since 5.5.0
|
|
*
|
|
* @return WP_Block_Pattern_Categories_Registry The main instance.
|
|
*/
|
|
public static function get_instance() {
|
|
if ( null === self::$instance ) {
|
|
self::$instance = new self();
|
|
}
|
|
|
|
return self::$instance;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Registers a new pattern category.
|
|
*
|
|
* @since 5.5.0
|
|
*
|
|
* @param string $category_name Pattern category name including namespace.
|
|
* @param array $category_properties List of properties for the block pattern.
|
|
* See WP_Block_Pattern_Categories_Registry::register() for
|
|
* accepted arguments.
|
|
* @return bool True if the pattern category was registered with success and false otherwise.
|
|
*/
|
|
function register_block_pattern_category( $category_name, $category_properties ) {
|
|
return WP_Block_Pattern_Categories_Registry::get_instance()->register( $category_name, $category_properties );
|
|
}
|
|
|
|
/**
|
|
* Unregisters a pattern category.
|
|
*
|
|
* @since 5.5.0
|
|
*
|
|
* @param string $category_name Pattern category name including namespace.
|
|
* @return bool True if the pattern category was unregistered with success and false otherwise.
|
|
*/
|
|
function unregister_block_pattern_category( $category_name ) {
|
|
return WP_Block_Pattern_Categories_Registry::get_instance()->unregister( $category_name );
|
|
}
|