mirror of
https://github.com/WordPress/WordPress.git
synced 2024-09-06 12:48:12 +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
172 lines
5.3 KiB
PHP
172 lines
5.3 KiB
PHP
<?php
|
|
/**
|
|
* Meta API: WP_Metadata_Lazyloader class
|
|
*
|
|
* @package WordPress
|
|
* @subpackage Meta
|
|
* @since 4.5.0
|
|
*/
|
|
|
|
/**
|
|
* Core class used for lazy-loading object metadata.
|
|
*
|
|
* When loading many objects of a given type, such as posts in a WP_Query loop, it often makes
|
|
* sense to prime various metadata caches at the beginning of the loop. This means fetching all
|
|
* relevant metadata with a single database query, a technique that has the potential to improve
|
|
* performance dramatically in some cases.
|
|
*
|
|
* In cases where the given metadata may not even be used in the loop, we can improve performance
|
|
* even more by only priming the metadata cache for affected items the first time a piece of metadata
|
|
* is requested - ie, by lazy-loading it. So, for example, comment meta may not be loaded into the
|
|
* cache in the comments section of a post until the first time get_comment_meta() is called in the
|
|
* context of the comment loop.
|
|
*
|
|
* WP uses the WP_Metadata_Lazyloader class to queue objects for metadata cache priming. The class
|
|
* then detects the relevant get_*_meta() function call, and queries the metadata of all queued objects.
|
|
*
|
|
* Do not access this class directly. Use the wp_metadata_lazyloader() function.
|
|
*
|
|
* @since 4.5.0
|
|
*/
|
|
#[AllowDynamicProperties]
|
|
class WP_Metadata_Lazyloader {
|
|
/**
|
|
* Pending objects queue.
|
|
*
|
|
* @since 4.5.0
|
|
* @var array
|
|
*/
|
|
protected $pending_objects;
|
|
|
|
/**
|
|
* Settings for supported object types.
|
|
*
|
|
* @since 4.5.0
|
|
* @var array
|
|
*/
|
|
protected $settings = array();
|
|
|
|
/**
|
|
* Constructor.
|
|
*
|
|
* @since 4.5.0
|
|
*/
|
|
public function __construct() {
|
|
$this->settings = array(
|
|
'term' => array(
|
|
'filter' => 'get_term_metadata',
|
|
'callback' => array( $this, 'lazyload_term_meta' ),
|
|
),
|
|
'comment' => array(
|
|
'filter' => 'get_comment_metadata',
|
|
'callback' => array( $this, 'lazyload_comment_meta' ),
|
|
),
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Adds objects to the metadata lazy-load queue.
|
|
*
|
|
* @since 4.5.0
|
|
*
|
|
* @param string $object_type Type of object whose meta is to be lazy-loaded. Accepts 'term' or 'comment'.
|
|
* @param array $object_ids Array of object IDs.
|
|
* @return void|WP_Error WP_Error on failure.
|
|
*/
|
|
public function queue_objects( $object_type, $object_ids ) {
|
|
if ( ! isset( $this->settings[ $object_type ] ) ) {
|
|
return new WP_Error( 'invalid_object_type', __( 'Invalid object type.' ) );
|
|
}
|
|
|
|
$type_settings = $this->settings[ $object_type ];
|
|
|
|
if ( ! isset( $this->pending_objects[ $object_type ] ) ) {
|
|
$this->pending_objects[ $object_type ] = array();
|
|
}
|
|
|
|
foreach ( $object_ids as $object_id ) {
|
|
// Keyed by ID for faster lookup.
|
|
if ( ! isset( $this->pending_objects[ $object_type ][ $object_id ] ) ) {
|
|
$this->pending_objects[ $object_type ][ $object_id ] = 1;
|
|
}
|
|
}
|
|
|
|
add_filter( $type_settings['filter'], $type_settings['callback'] );
|
|
|
|
/**
|
|
* Fires after objects are added to the metadata lazy-load queue.
|
|
*
|
|
* @since 4.5.0
|
|
*
|
|
* @param array $object_ids Array of object IDs.
|
|
* @param string $object_type Type of object being queued.
|
|
* @param WP_Metadata_Lazyloader $lazyloader The lazy-loader object.
|
|
*/
|
|
do_action( 'metadata_lazyloader_queued_objects', $object_ids, $object_type, $this );
|
|
}
|
|
|
|
/**
|
|
* Resets lazy-load queue for a given object type.
|
|
*
|
|
* @since 4.5.0
|
|
*
|
|
* @param string $object_type Object type. Accepts 'comment' or 'term'.
|
|
* @return void|WP_Error WP_Error on failure.
|
|
*/
|
|
public function reset_queue( $object_type ) {
|
|
if ( ! isset( $this->settings[ $object_type ] ) ) {
|
|
return new WP_Error( 'invalid_object_type', __( 'Invalid object type.' ) );
|
|
}
|
|
|
|
$type_settings = $this->settings[ $object_type ];
|
|
|
|
$this->pending_objects[ $object_type ] = array();
|
|
remove_filter( $type_settings['filter'], $type_settings['callback'] );
|
|
}
|
|
|
|
/**
|
|
* Lazy-loads term meta for queued terms.
|
|
*
|
|
* This method is public so that it can be used as a filter callback. As a rule, there
|
|
* is no need to invoke it directly.
|
|
*
|
|
* @since 4.5.0
|
|
*
|
|
* @param mixed $check The `$check` param passed from the 'get_term_metadata' hook.
|
|
* @return mixed In order not to short-circuit `get_metadata()`. Generally, this is `null`, but it could be
|
|
* another value if filtered by a plugin.
|
|
*/
|
|
public function lazyload_term_meta( $check ) {
|
|
if ( ! empty( $this->pending_objects['term'] ) ) {
|
|
update_termmeta_cache( array_keys( $this->pending_objects['term'] ) );
|
|
|
|
// No need to run again for this set of terms.
|
|
$this->reset_queue( 'term' );
|
|
}
|
|
|
|
return $check;
|
|
}
|
|
|
|
/**
|
|
* Lazy-loads comment meta for queued comments.
|
|
*
|
|
* This method is public so that it can be used as a filter callback. As a rule, there is no need to invoke it
|
|
* directly, from either inside or outside the `WP_Query` object.
|
|
*
|
|
* @since 4.5.0
|
|
*
|
|
* @param mixed $check The `$check` param passed from the {@see 'get_comment_metadata'} hook.
|
|
* @return mixed The original value of `$check`, so as not to short-circuit `get_comment_metadata()`.
|
|
*/
|
|
public function lazyload_comment_meta( $check ) {
|
|
if ( ! empty( $this->pending_objects['comment'] ) ) {
|
|
update_meta_cache( 'comment', array_keys( $this->pending_objects['comment'] ) );
|
|
|
|
// No need to run again for this set of comments.
|
|
$this->reset_queue( 'comment' );
|
|
}
|
|
|
|
return $check;
|
|
}
|
|
}
|