mirror of
https://github.com/WordPress/WordPress.git
synced 2024-08-26 15:53:08 +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
181 lines
4.3 KiB
PHP
181 lines
4.3 KiB
PHP
<?php
|
|
/**
|
|
* Sitemaps: WP_Sitemaps_Provider class
|
|
*
|
|
* This class is a base class for other sitemap providers to extend and contains shared functionality.
|
|
*
|
|
* @package WordPress
|
|
* @subpackage Sitemaps
|
|
* @since 5.5.0
|
|
*/
|
|
|
|
/**
|
|
* Class WP_Sitemaps_Provider.
|
|
*
|
|
* @since 5.5.0
|
|
*/
|
|
#[AllowDynamicProperties]
|
|
abstract class WP_Sitemaps_Provider {
|
|
/**
|
|
* Provider name.
|
|
*
|
|
* This will also be used as the public-facing name in URLs.
|
|
*
|
|
* @since 5.5.0
|
|
*
|
|
* @var string
|
|
*/
|
|
protected $name = '';
|
|
|
|
/**
|
|
* Object type name (e.g. 'post', 'term', 'user').
|
|
*
|
|
* @since 5.5.0
|
|
*
|
|
* @var string
|
|
*/
|
|
protected $object_type = '';
|
|
|
|
/**
|
|
* Gets a URL list for a sitemap.
|
|
*
|
|
* @since 5.5.0
|
|
*
|
|
* @param int $page_num Page of results.
|
|
* @param string $object_subtype Optional. Object subtype name. Default empty.
|
|
* @return array[] Array of URL information for a sitemap.
|
|
*/
|
|
abstract public function get_url_list( $page_num, $object_subtype = '' );
|
|
|
|
/**
|
|
* Gets the max number of pages available for the object type.
|
|
*
|
|
* @since 5.5.0
|
|
*
|
|
* @param string $object_subtype Optional. Object subtype. Default empty.
|
|
* @return int Total number of pages.
|
|
*/
|
|
abstract public function get_max_num_pages( $object_subtype = '' );
|
|
|
|
/**
|
|
* Gets data about each sitemap type.
|
|
*
|
|
* @since 5.5.0
|
|
*
|
|
* @return array[] Array of sitemap types including object subtype name and number of pages.
|
|
*/
|
|
public function get_sitemap_type_data() {
|
|
$sitemap_data = array();
|
|
|
|
$object_subtypes = $this->get_object_subtypes();
|
|
|
|
// If there are no object subtypes, include a single sitemap for the
|
|
// entire object type.
|
|
if ( empty( $object_subtypes ) ) {
|
|
$sitemap_data[] = array(
|
|
'name' => '',
|
|
'pages' => $this->get_max_num_pages(),
|
|
);
|
|
return $sitemap_data;
|
|
}
|
|
|
|
// Otherwise, include individual sitemaps for every object subtype.
|
|
foreach ( $object_subtypes as $object_subtype_name => $data ) {
|
|
$object_subtype_name = (string) $object_subtype_name;
|
|
|
|
$sitemap_data[] = array(
|
|
'name' => $object_subtype_name,
|
|
'pages' => $this->get_max_num_pages( $object_subtype_name ),
|
|
);
|
|
}
|
|
|
|
return $sitemap_data;
|
|
}
|
|
|
|
/**
|
|
* Lists sitemap pages exposed by this provider.
|
|
*
|
|
* The returned data is used to populate the sitemap entries of the index.
|
|
*
|
|
* @since 5.5.0
|
|
*
|
|
* @return array[] Array of sitemap entries.
|
|
*/
|
|
public function get_sitemap_entries() {
|
|
$sitemaps = array();
|
|
|
|
$sitemap_types = $this->get_sitemap_type_data();
|
|
|
|
foreach ( $sitemap_types as $type ) {
|
|
for ( $page = 1; $page <= $type['pages']; $page ++ ) {
|
|
$sitemap_entry = array(
|
|
'loc' => $this->get_sitemap_url( $type['name'], $page ),
|
|
);
|
|
|
|
/**
|
|
* Filters the sitemap entry for the sitemap index.
|
|
*
|
|
* @since 5.5.0
|
|
*
|
|
* @param array $sitemap_entry Sitemap entry for the post.
|
|
* @param string $object_type Object empty name.
|
|
* @param string $object_subtype Object subtype name.
|
|
* Empty string if the object type does not support subtypes.
|
|
* @param int $page Page number of results.
|
|
*/
|
|
$sitemap_entry = apply_filters( 'wp_sitemaps_index_entry', $sitemap_entry, $this->object_type, $type['name'], $page );
|
|
|
|
$sitemaps[] = $sitemap_entry;
|
|
}
|
|
}
|
|
|
|
return $sitemaps;
|
|
}
|
|
|
|
/**
|
|
* Gets the URL of a sitemap entry.
|
|
*
|
|
* @since 5.5.0
|
|
*
|
|
* @global WP_Rewrite $wp_rewrite WordPress rewrite component.
|
|
*
|
|
* @param string $name The name of the sitemap.
|
|
* @param int $page The page of the sitemap.
|
|
* @return string The composed URL for a sitemap entry.
|
|
*/
|
|
public function get_sitemap_url( $name, $page ) {
|
|
global $wp_rewrite;
|
|
|
|
// Accounts for cases where name is not included, ex: sitemaps-users-1.xml.
|
|
$params = array_filter(
|
|
array(
|
|
'sitemap' => $this->name,
|
|
'sitemap-subtype' => $name,
|
|
'paged' => $page,
|
|
)
|
|
);
|
|
|
|
$basename = sprintf(
|
|
'/wp-sitemap-%1$s.xml',
|
|
implode( '-', $params )
|
|
);
|
|
|
|
if ( ! $wp_rewrite->using_permalinks() ) {
|
|
$basename = '/?' . http_build_query( $params, '', '&' );
|
|
}
|
|
|
|
return home_url( $basename );
|
|
}
|
|
|
|
/**
|
|
* Returns the list of supported object subtypes exposed by the provider.
|
|
*
|
|
* @since 5.5.0
|
|
*
|
|
* @return array List of object subtypes objects keyed by their name.
|
|
*/
|
|
public function get_object_subtypes() {
|
|
return array();
|
|
}
|
|
}
|