mirror of
https://github.com/WordPress/WordPress.git
synced 2024-12-23 09:37:42 +01:00
c03305852e
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
138 lines
2.5 KiB
PHP
138 lines
2.5 KiB
PHP
<?php
|
|
/**
|
|
* Dependencies API: _WP_Dependency class
|
|
*
|
|
* @since 4.7.0
|
|
*
|
|
* @package WordPress
|
|
* @subpackage Dependencies
|
|
*/
|
|
|
|
/**
|
|
* Class _WP_Dependency
|
|
*
|
|
* Helper class to register a handle and associated data.
|
|
*
|
|
* @access private
|
|
* @since 2.6.0
|
|
*/
|
|
#[AllowDynamicProperties]
|
|
class _WP_Dependency {
|
|
/**
|
|
* The handle name.
|
|
*
|
|
* @since 2.6.0
|
|
* @var string
|
|
*/
|
|
public $handle;
|
|
|
|
/**
|
|
* The handle source.
|
|
*
|
|
* @since 2.6.0
|
|
* @var string
|
|
*/
|
|
public $src;
|
|
|
|
/**
|
|
* An array of handle dependencies.
|
|
*
|
|
* @since 2.6.0
|
|
* @var string[]
|
|
*/
|
|
public $deps = array();
|
|
|
|
/**
|
|
* The handle version.
|
|
*
|
|
* Used for cache-busting.
|
|
*
|
|
* @since 2.6.0
|
|
* @var bool|string
|
|
*/
|
|
public $ver = false;
|
|
|
|
/**
|
|
* Additional arguments for the handle.
|
|
*
|
|
* @since 2.6.0
|
|
* @var array
|
|
*/
|
|
public $args = null; // Custom property, such as $in_footer or $media.
|
|
|
|
/**
|
|
* Extra data to supply to the handle.
|
|
*
|
|
* @since 2.6.0
|
|
* @var array
|
|
*/
|
|
public $extra = array();
|
|
|
|
/**
|
|
* Translation textdomain set for this dependency.
|
|
*
|
|
* @since 5.0.0
|
|
* @var string
|
|
*/
|
|
public $textdomain;
|
|
|
|
/**
|
|
* Translation path set for this dependency.
|
|
*
|
|
* @since 5.0.0
|
|
* @var string
|
|
*/
|
|
public $translations_path;
|
|
|
|
/**
|
|
* Setup dependencies.
|
|
*
|
|
* @since 2.6.0
|
|
* @since 5.3.0 Formalized the existing `...$args` parameter by adding it
|
|
* to the function signature.
|
|
*
|
|
* @param mixed ...$args Dependency information.
|
|
*/
|
|
public function __construct( ...$args ) {
|
|
list( $this->handle, $this->src, $this->deps, $this->ver, $this->args ) = $args;
|
|
if ( ! is_array( $this->deps ) ) {
|
|
$this->deps = array();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Add handle data.
|
|
*
|
|
* @since 2.6.0
|
|
*
|
|
* @param string $name The data key to add.
|
|
* @param mixed $data The data value to add.
|
|
* @return bool False if not scalar, true otherwise.
|
|
*/
|
|
public function add_data( $name, $data ) {
|
|
if ( ! is_scalar( $name ) ) {
|
|
return false;
|
|
}
|
|
$this->extra[ $name ] = $data;
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Sets the translation domain for this dependency.
|
|
*
|
|
* @since 5.0.0
|
|
*
|
|
* @param string $domain The translation textdomain.
|
|
* @param string $path Optional. The full file path to the directory containing translation files.
|
|
* @return bool False if $domain is not a string, true otherwise.
|
|
*/
|
|
public function set_translations( $domain, $path = null ) {
|
|
if ( ! is_string( $domain ) ) {
|
|
return false;
|
|
}
|
|
$this->textdomain = $domain;
|
|
$this->translations_path = $path;
|
|
return true;
|
|
}
|
|
}
|