mirror of
https://github.com/WordPress/WordPress.git
synced 2024-08-26 23:59:40 +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
276 lines
6.7 KiB
PHP
276 lines
6.7 KiB
PHP
<?php
|
|
/**
|
|
* Sitemaps: WP_Sitemaps_Renderer class
|
|
*
|
|
* Responsible for rendering Sitemaps data to XML in accordance with sitemap protocol.
|
|
*
|
|
* @package WordPress
|
|
* @subpackage Sitemaps
|
|
* @since 5.5.0
|
|
*/
|
|
|
|
/**
|
|
* Class WP_Sitemaps_Renderer
|
|
*
|
|
* @since 5.5.0
|
|
*/
|
|
#[AllowDynamicProperties]
|
|
class WP_Sitemaps_Renderer {
|
|
/**
|
|
* XSL stylesheet for styling a sitemap for web browsers.
|
|
*
|
|
* @since 5.5.0
|
|
*
|
|
* @var string
|
|
*/
|
|
protected $stylesheet = '';
|
|
|
|
/**
|
|
* XSL stylesheet for styling a sitemap for web browsers.
|
|
*
|
|
* @since 5.5.0
|
|
*
|
|
* @var string
|
|
*/
|
|
protected $stylesheet_index = '';
|
|
|
|
/**
|
|
* WP_Sitemaps_Renderer constructor.
|
|
*
|
|
* @since 5.5.0
|
|
*/
|
|
public function __construct() {
|
|
$stylesheet_url = $this->get_sitemap_stylesheet_url();
|
|
|
|
if ( $stylesheet_url ) {
|
|
$this->stylesheet = '<?xml-stylesheet type="text/xsl" href="' . esc_url( $stylesheet_url ) . '" ?>';
|
|
}
|
|
|
|
$stylesheet_index_url = $this->get_sitemap_index_stylesheet_url();
|
|
|
|
if ( $stylesheet_index_url ) {
|
|
$this->stylesheet_index = '<?xml-stylesheet type="text/xsl" href="' . esc_url( $stylesheet_index_url ) . '" ?>';
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Gets the URL for the sitemap stylesheet.
|
|
*
|
|
* @since 5.5.0
|
|
*
|
|
* @global WP_Rewrite $wp_rewrite WordPress rewrite component.
|
|
*
|
|
* @return string The sitemap stylesheet URL.
|
|
*/
|
|
public function get_sitemap_stylesheet_url() {
|
|
global $wp_rewrite;
|
|
|
|
$sitemap_url = home_url( '/wp-sitemap.xsl' );
|
|
|
|
if ( ! $wp_rewrite->using_permalinks() ) {
|
|
$sitemap_url = home_url( '/?sitemap-stylesheet=sitemap' );
|
|
}
|
|
|
|
/**
|
|
* Filters the URL for the sitemap stylesheet.
|
|
*
|
|
* If a falsey value is returned, no stylesheet will be used and
|
|
* the "raw" XML of the sitemap will be displayed.
|
|
*
|
|
* @since 5.5.0
|
|
*
|
|
* @param string $sitemap_url Full URL for the sitemaps XSL file.
|
|
*/
|
|
return apply_filters( 'wp_sitemaps_stylesheet_url', $sitemap_url );
|
|
}
|
|
|
|
/**
|
|
* Gets the URL for the sitemap index stylesheet.
|
|
*
|
|
* @since 5.5.0
|
|
*
|
|
* @global WP_Rewrite $wp_rewrite WordPress rewrite component.
|
|
*
|
|
* @return string The sitemap index stylesheet URL.
|
|
*/
|
|
public function get_sitemap_index_stylesheet_url() {
|
|
global $wp_rewrite;
|
|
|
|
$sitemap_url = home_url( '/wp-sitemap-index.xsl' );
|
|
|
|
if ( ! $wp_rewrite->using_permalinks() ) {
|
|
$sitemap_url = home_url( '/?sitemap-stylesheet=index' );
|
|
}
|
|
|
|
/**
|
|
* Filters the URL for the sitemap index stylesheet.
|
|
*
|
|
* If a falsey value is returned, no stylesheet will be used and
|
|
* the "raw" XML of the sitemap index will be displayed.
|
|
*
|
|
* @since 5.5.0
|
|
*
|
|
* @param string $sitemap_url Full URL for the sitemaps index XSL file.
|
|
*/
|
|
return apply_filters( 'wp_sitemaps_stylesheet_index_url', $sitemap_url );
|
|
}
|
|
|
|
/**
|
|
* Renders a sitemap index.
|
|
*
|
|
* @since 5.5.0
|
|
*
|
|
* @param array $sitemaps Array of sitemap URLs.
|
|
*/
|
|
public function render_index( $sitemaps ) {
|
|
header( 'Content-type: application/xml; charset=UTF-8' );
|
|
|
|
$this->check_for_simple_xml_availability();
|
|
|
|
$index_xml = $this->get_sitemap_index_xml( $sitemaps );
|
|
|
|
if ( ! empty( $index_xml ) ) {
|
|
// All output is escaped within get_sitemap_index_xml().
|
|
// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
|
|
echo $index_xml;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Gets XML for a sitemap index.
|
|
*
|
|
* @since 5.5.0
|
|
*
|
|
* @param array $sitemaps Array of sitemap URLs.
|
|
* @return string|false A well-formed XML string for a sitemap index. False on error.
|
|
*/
|
|
public function get_sitemap_index_xml( $sitemaps ) {
|
|
$sitemap_index = new SimpleXMLElement(
|
|
sprintf(
|
|
'%1$s%2$s%3$s',
|
|
'<?xml version="1.0" encoding="UTF-8" ?>',
|
|
$this->stylesheet_index,
|
|
'<sitemapindex xmlns="http://www.sitemaps.org/schemas/sitemap/0.9" />'
|
|
)
|
|
);
|
|
|
|
foreach ( $sitemaps as $entry ) {
|
|
$sitemap = $sitemap_index->addChild( 'sitemap' );
|
|
|
|
// Add each element as a child node to the <sitemap> entry.
|
|
foreach ( $entry as $name => $value ) {
|
|
if ( 'loc' === $name ) {
|
|
$sitemap->addChild( $name, esc_url( $value ) );
|
|
} elseif ( 'lastmod' === $name ) {
|
|
$sitemap->addChild( $name, esc_xml( $value ) );
|
|
} else {
|
|
_doing_it_wrong(
|
|
__METHOD__,
|
|
sprintf(
|
|
/* translators: %s: List of element names. */
|
|
__( 'Fields other than %s are not currently supported for the sitemap index.' ),
|
|
implode( ',', array( 'loc', 'lastmod' ) )
|
|
),
|
|
'5.5.0'
|
|
);
|
|
}
|
|
}
|
|
}
|
|
|
|
return $sitemap_index->asXML();
|
|
}
|
|
|
|
/**
|
|
* Renders a sitemap.
|
|
*
|
|
* @since 5.5.0
|
|
*
|
|
* @param array $url_list Array of URLs for a sitemap.
|
|
*/
|
|
public function render_sitemap( $url_list ) {
|
|
header( 'Content-type: application/xml; charset=UTF-8' );
|
|
|
|
$this->check_for_simple_xml_availability();
|
|
|
|
$sitemap_xml = $this->get_sitemap_xml( $url_list );
|
|
|
|
if ( ! empty( $sitemap_xml ) ) {
|
|
// All output is escaped within get_sitemap_xml().
|
|
// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
|
|
echo $sitemap_xml;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Gets XML for a sitemap.
|
|
*
|
|
* @since 5.5.0
|
|
*
|
|
* @param array $url_list Array of URLs for a sitemap.
|
|
* @return string|false A well-formed XML string for a sitemap index. False on error.
|
|
*/
|
|
public function get_sitemap_xml( $url_list ) {
|
|
$urlset = new SimpleXMLElement(
|
|
sprintf(
|
|
'%1$s%2$s%3$s',
|
|
'<?xml version="1.0" encoding="UTF-8" ?>',
|
|
$this->stylesheet,
|
|
'<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9" />'
|
|
)
|
|
);
|
|
|
|
foreach ( $url_list as $url_item ) {
|
|
$url = $urlset->addChild( 'url' );
|
|
|
|
// Add each element as a child node to the <url> entry.
|
|
foreach ( $url_item as $name => $value ) {
|
|
if ( 'loc' === $name ) {
|
|
$url->addChild( $name, esc_url( $value ) );
|
|
} elseif ( in_array( $name, array( 'lastmod', 'changefreq', 'priority' ), true ) ) {
|
|
$url->addChild( $name, esc_xml( $value ) );
|
|
} else {
|
|
_doing_it_wrong(
|
|
__METHOD__,
|
|
sprintf(
|
|
/* translators: %s: List of element names. */
|
|
__( 'Fields other than %s are not currently supported for sitemaps.' ),
|
|
implode( ',', array( 'loc', 'lastmod', 'changefreq', 'priority' ) )
|
|
),
|
|
'5.5.0'
|
|
);
|
|
}
|
|
}
|
|
}
|
|
|
|
return $urlset->asXML();
|
|
}
|
|
|
|
/**
|
|
* Checks for the availability of the SimpleXML extension and errors if missing.
|
|
*
|
|
* @since 5.5.0
|
|
*/
|
|
private function check_for_simple_xml_availability() {
|
|
if ( ! class_exists( 'SimpleXMLElement' ) ) {
|
|
add_filter(
|
|
'wp_die_handler',
|
|
static function () {
|
|
return '_xml_wp_die_handler';
|
|
}
|
|
);
|
|
|
|
wp_die(
|
|
sprintf(
|
|
/* translators: %s: SimpleXML */
|
|
esc_xml( __( 'Could not generate XML sitemap due to missing %s extension' ) ),
|
|
'SimpleXML'
|
|
),
|
|
esc_xml( __( 'WordPress › Error' ) ),
|
|
array(
|
|
'response' => 501, // "Not implemented".
|
|
)
|
|
);
|
|
}
|
|
}
|
|
}
|