Changeset 48543

Timestamp:

07/21/2020 04:12:49 PM (6 years ago)

Author:

swissspidy

Message:

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 #50660.

Location:

trunk/src/wp-includes/sitemaps

Files:

• class-wp-sitemaps-registry.php (modified) (2 diffs)
• class-wp-sitemaps.php (modified) (1 diff)

trunk/src/wp-includes/sitemaps/class-wp-sitemaps-registry.php

@@ -26 +26 @@
 
         /**
-         * Adds a sitemap with route to the registry.
+         * Adds a new sitemap provider.
          *
          * @since 5.5.0
@@ -32 +32 @@
          * @param string               $name     Name of the sitemap provider.
          * @param WP_Sitemaps_Provider $provider Instance of a WP_Sitemaps_Provider.
-         * @return bool True if the provider was added, false if it is already registered.
+         * @return bool Whether the provider was added successfully.
          */
         public function add_provider( $name, WP_Sitemaps_Provider $provider ) {
                 if ( isset( $this->providers[ $name ] ) ) {
+                        return false;
+                }
+
+                /**
+                 * 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;
                 }

trunk/src/wp-includes/sitemaps/class-wp-sitemaps.php

@@ -111 +111 @@
          */
         public function register_sitemaps() {
-                /**
-                 * 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(),
-                        )
+                $providers = array(
+                        'posts'      => new WP_Sitemaps_Posts(),
+                        'taxonomies' => new WP_Sitemaps_Taxonomies(),
+                        'users'      => new WP_Sitemaps_Users(),
                 );
 
-                // Register each supported provider.
                 /* @var WP_Sitemaps_Provider $provider */
                 foreach ( $providers as $name => $provider ) {