2018-12-13 10:38:25 +01:00
|
|
|
<?php
|
|
|
|
/**
|
|
|
|
* REST API: WP_REST_Search_Handler class
|
|
|
|
*
|
|
|
|
* @package WordPress
|
|
|
|
* @subpackage REST_API
|
|
|
|
* @since 5.0.0
|
|
|
|
*/
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Core base class representing a search handler for an object type in the REST API.
|
|
|
|
*
|
|
|
|
* @since 5.0.0
|
|
|
|
*/
|
Code Modernization: Add `AllowDynamicProperties` attribute to all (parent) classes.
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
2022-09-12 17:47:14 +02:00
|
|
|
#[AllowDynamicProperties]
|
2018-12-13 10:38:25 +01:00
|
|
|
abstract class WP_REST_Search_Handler {
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Field containing the IDs in the search result.
|
|
|
|
*/
|
|
|
|
const RESULT_IDS = 'ids';
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Field containing the total count in the search result.
|
|
|
|
*/
|
|
|
|
const RESULT_TOTAL = 'total';
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Object type managed by this search handler.
|
|
|
|
*
|
|
|
|
* @since 5.0.0
|
|
|
|
* @var string
|
|
|
|
*/
|
|
|
|
protected $type = '';
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Object subtypes managed by this search handler.
|
|
|
|
*
|
|
|
|
* @since 5.0.0
|
|
|
|
* @var array
|
|
|
|
*/
|
|
|
|
protected $subtypes = array();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Gets the object type managed by this search handler.
|
|
|
|
*
|
|
|
|
* @since 5.0.0
|
|
|
|
*
|
|
|
|
* @return string Object type identifier.
|
|
|
|
*/
|
|
|
|
public function get_type() {
|
|
|
|
return $this->type;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Gets the object subtypes managed by this search handler.
|
|
|
|
*
|
|
|
|
* @since 5.0.0
|
|
|
|
*
|
|
|
|
* @return array Array of object subtype identifiers.
|
|
|
|
*/
|
|
|
|
public function get_subtypes() {
|
|
|
|
return $this->subtypes;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Searches the object type content for a given search request.
|
|
|
|
*
|
|
|
|
* @since 5.0.0
|
|
|
|
*
|
|
|
|
* @param WP_REST_Request $request Full REST request.
|
|
|
|
* @return array Associative array containing an `WP_REST_Search_Handler::RESULT_IDS` containing
|
|
|
|
* an array of found IDs and `WP_REST_Search_Handler::RESULT_TOTAL` containing the
|
|
|
|
* total count for the matching search results.
|
|
|
|
*/
|
|
|
|
abstract public function search_items( WP_REST_Request $request );
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Prepares the search result for a given ID.
|
|
|
|
*
|
|
|
|
* @since 5.0.0
|
2020-10-03 03:22:11 +02:00
|
|
|
* @since 5.6.0 The `$id` parameter can accept a string.
|
2018-12-13 10:38:25 +01:00
|
|
|
*
|
2020-10-02 19:47:09 +02:00
|
|
|
* @param int|string $id Item ID.
|
|
|
|
* @param array $fields Fields to include for the item.
|
2018-12-13 10:38:25 +01:00
|
|
|
* @return array Associative array containing all fields for the item.
|
|
|
|
*/
|
|
|
|
abstract public function prepare_item( $id, array $fields );
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Prepares links for the search result of a given ID.
|
|
|
|
*
|
|
|
|
* @since 5.0.0
|
2020-10-03 03:22:11 +02:00
|
|
|
* @since 5.6.0 The `$id` parameter can accept a string.
|
2018-12-13 10:38:25 +01:00
|
|
|
*
|
2020-10-02 19:47:09 +02:00
|
|
|
* @param int|string $id Item ID.
|
2018-12-13 10:38:25 +01:00
|
|
|
* @return array Links for the given item.
|
|
|
|
*/
|
|
|
|
abstract public function prepare_item_links( $id );
|
|
|
|
}
|