<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[48543] trunk/src/wp-includes/sitemaps: Sitemaps: Replace `wp_sitemaps_register_providers` filter with more suitable `wp_sitemaps_add_provider` filter.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/48543">48543</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/48543","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>swissspidy</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2020-07-21 16:12:49 +0000 (Tue, 21 Jul 2020)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Sitemaps: Replace `wp_sitemaps_register_providers` filter with more suitable `wp_sitemaps_add_provider` filter.
The previous filter failed the goal of allowing developers to filter all providers before they are registered, since it only filtered the built-in ones.
The more specific `wp_sitemaps_add_provider` filter enables exactly that, as it filters every sitemap provider right before it is added to the sitemaps registry.
Props pbiron, pfefferle, Chouby, swissspidy.
Fixes <a href="https://core.trac.wordpress.org/ticket/50660">#50660</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludessitemapsclasswpsitemapsregistryphp">trunk/src/wp-includes/sitemaps/class-wp-sitemaps-registry.php</a></li>
<li><a href="#trunksrcwpincludessitemapsclasswpsitemapsphp">trunk/src/wp-includes/sitemaps/class-wp-sitemaps.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludessitemapsclasswpsitemapsregistryphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/sitemaps/class-wp-sitemaps-registry.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/sitemaps/class-wp-sitemaps-registry.php 2020-07-21 16:08:44 UTC (rev 48542)
+++ trunk/src/wp-includes/sitemaps/class-wp-sitemaps-registry.php 2020-07-21 16:12:49 UTC (rev 48543)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -25,13 +25,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> private $providers = array();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Adds a sitemap with route to the registry.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Adds a new sitemap provider.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.5.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $name Name of the sitemap provider.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param WP_Sitemaps_Provider $provider Instance of a WP_Sitemaps_Provider.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return bool True if the provider was added, false if it is already registered.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return bool Whether the provider was added successfully.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function add_provider( $name, WP_Sitemaps_Provider $provider ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( isset( $this->providers[ $name ] ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -38,6 +38,19 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return false;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Filters the sitemap provider before it is added.
+ *
+ * @since 5.5.0
+ *
+ * @param WP_Sitemaps_Provider $provider Instance of a WP_Sitemaps_Provider.
+ * @param string $name Name of the sitemap provider.
+ */
+ $provider = apply_filters( 'wp_sitemaps_add_provider', $provider, $name );
+ if ( ! $provider instanceof WP_Sitemaps_Provider ) {
+ return false;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->providers[ $name ] = $provider;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> return true;
</span></span></pre></div>
<a id="trunksrcwpincludessitemapsclasswpsitemapsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/sitemaps/class-wp-sitemaps.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/sitemaps/class-wp-sitemaps.php 2020-07-21 16:08:44 UTC (rev 48542)
+++ trunk/src/wp-includes/sitemaps/class-wp-sitemaps.php 2020-07-21 16:12:49 UTC (rev 48543)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -110,29 +110,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.5.0
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function register_sitemaps() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- /**
- * Filters the list of registered sitemap providers.
- *
- * @since 5.5.0
- *
- * @param array $providers {
- * Array of WP_Sitemaps_Provider objects keyed by their name.
- *
- * @type WP_Sitemaps_Posts $posts The WP_Sitemaps_Posts object.
- * @type WP_Sitemaps_Taxonomies $taxonomies The WP_Sitemaps_Taxonomies object.
- * @type WP_Sitemaps_Users $users The WP_Sitemaps_Users object.
- * }
- */
- $providers = apply_filters(
- 'wp_sitemaps_register_providers',
- array(
- 'posts' => new WP_Sitemaps_Posts(),
- 'taxonomies' => new WP_Sitemaps_Taxonomies(),
- 'users' => new WP_Sitemaps_Users(),
- )
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $providers = array(
+ 'posts' => new WP_Sitemaps_Posts(),
+ 'taxonomies' => new WP_Sitemaps_Taxonomies(),
+ 'users' => new WP_Sitemaps_Users(),
</ins><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Register each supported provider.
</del><span class="cx" style="display: block; padding: 0 10px"> /* @var WP_Sitemaps_Provider $provider */
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $providers as $name => $provider ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->registry->add_provider( $name, $provider );
</span></span></pre>
</div>
</div>
</body>
</html>