mirror of
https://github.com/WordPress/WordPress.git
synced 2024-08-21 13:22:57 +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
142 lines
3.3 KiB
PHP
142 lines
3.3 KiB
PHP
<?php
|
|
/**
|
|
* Widget API: WP_Widget_Factory class
|
|
*
|
|
* @package WordPress
|
|
* @subpackage Widgets
|
|
* @since 4.4.0
|
|
*/
|
|
|
|
/**
|
|
* Singleton that registers and instantiates WP_Widget classes.
|
|
*
|
|
* @since 2.8.0
|
|
* @since 4.4.0 Moved to its own file from wp-includes/widgets.php
|
|
*/
|
|
#[AllowDynamicProperties]
|
|
class WP_Widget_Factory {
|
|
|
|
/**
|
|
* Widgets array.
|
|
*
|
|
* @since 2.8.0
|
|
* @var array
|
|
*/
|
|
public $widgets = array();
|
|
|
|
/**
|
|
* PHP5 constructor.
|
|
*
|
|
* @since 4.3.0
|
|
*/
|
|
public function __construct() {
|
|
add_action( 'widgets_init', array( $this, '_register_widgets' ), 100 );
|
|
}
|
|
|
|
/**
|
|
* PHP4 constructor.
|
|
*
|
|
* @since 2.8.0
|
|
* @deprecated 4.3.0 Use __construct() instead.
|
|
*
|
|
* @see WP_Widget_Factory::__construct()
|
|
*/
|
|
public function WP_Widget_Factory() {
|
|
_deprecated_constructor( 'WP_Widget_Factory', '4.3.0' );
|
|
self::__construct();
|
|
}
|
|
|
|
/**
|
|
* Registers a widget subclass.
|
|
*
|
|
* @since 2.8.0
|
|
* @since 4.6.0 Updated the `$widget` parameter to also accept a WP_Widget instance object
|
|
* instead of simply a `WP_Widget` subclass name.
|
|
*
|
|
* @param string|WP_Widget $widget Either the name of a `WP_Widget` subclass or an instance of a `WP_Widget` subclass.
|
|
*/
|
|
public function register( $widget ) {
|
|
if ( $widget instanceof WP_Widget ) {
|
|
$this->widgets[ spl_object_hash( $widget ) ] = $widget;
|
|
} else {
|
|
$this->widgets[ $widget ] = new $widget();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Un-registers a widget subclass.
|
|
*
|
|
* @since 2.8.0
|
|
* @since 4.6.0 Updated the `$widget` parameter to also accept a WP_Widget instance object
|
|
* instead of simply a `WP_Widget` subclass name.
|
|
*
|
|
* @param string|WP_Widget $widget Either the name of a `WP_Widget` subclass or an instance of a `WP_Widget` subclass.
|
|
*/
|
|
public function unregister( $widget ) {
|
|
if ( $widget instanceof WP_Widget ) {
|
|
unset( $this->widgets[ spl_object_hash( $widget ) ] );
|
|
} else {
|
|
unset( $this->widgets[ $widget ] );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Serves as a utility method for adding widgets to the registered widgets global.
|
|
*
|
|
* @since 2.8.0
|
|
*
|
|
* @global array $wp_registered_widgets
|
|
*/
|
|
public function _register_widgets() {
|
|
global $wp_registered_widgets;
|
|
$keys = array_keys( $this->widgets );
|
|
$registered = array_keys( $wp_registered_widgets );
|
|
$registered = array_map( '_get_widget_id_base', $registered );
|
|
|
|
foreach ( $keys as $key ) {
|
|
// Don't register new widget if old widget with the same id is already registered.
|
|
if ( in_array( $this->widgets[ $key ]->id_base, $registered, true ) ) {
|
|
unset( $this->widgets[ $key ] );
|
|
continue;
|
|
}
|
|
|
|
$this->widgets[ $key ]->_register();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Returns the registered WP_Widget object for the given widget type.
|
|
*
|
|
* @since 5.8.0
|
|
*
|
|
* @param string $id_base Widget type ID.
|
|
* @return WP_Widget|null
|
|
*/
|
|
public function get_widget_object( $id_base ) {
|
|
$key = $this->get_widget_key( $id_base );
|
|
if ( '' === $key ) {
|
|
return null;
|
|
}
|
|
|
|
return $this->widgets[ $key ];
|
|
}
|
|
|
|
/**
|
|
* Returns the registered key for the given widget type.
|
|
*
|
|
* @since 5.8.0
|
|
*
|
|
* @param string $id_base Widget type ID.
|
|
* @return string
|
|
*/
|
|
public function get_widget_key( $id_base ) {
|
|
foreach ( $this->widgets as $key => $widget_object ) {
|
|
if ( $widget_object->id_base === $id_base ) {
|
|
return $key;
|
|
}
|
|
}
|
|
|
|
return '';
|
|
}
|
|
}
|