Changeset 48536

Timestamp:

07/21/2020 03:27:48 PM (4 years ago)

Author:

SergeyBiryukov

Message:

Sitemaps: Rename 'sitemap' to 'provider' in WP_Sitemaps_Registry class.

This class is for registering sitemap providers, not individual sitemaps.

Props swissspidy.
Fixes #50724.

Location:

trunk

Files:

• src/wp-includes/sitemaps.php (modified) (2 diffs)
• src/wp-includes/sitemaps/class-wp-sitemaps-index.php (modified) (1 diff)
• src/wp-includes/sitemaps/class-wp-sitemaps-registry.php (modified) (6 diffs)
• src/wp-includes/sitemaps/class-wp-sitemaps.php (modified) (2 diffs)
• tests/phpunit/tests/sitemaps/sitemaps-index.php (modified) (3 diffs)
• tests/phpunit/tests/sitemaps/sitemaps-registry.php (modified) (2 diffs)

trunk/src/wp-includes/sitemaps.php

@@ -59 +59 @@
     }
 
-    return $sitemaps->registry->get_sitemaps();
+    return $sitemaps->registry->get_providers();
 }
 
@@ -78 +78 @@
     }
 
-    return $sitemaps->registry->add_sitemap( $name, $provider );
+    return $sitemaps->registry->add_provider( $name, $provider );
 }
 

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

@@ -55 +55 @@
         $sitemaps = array();
 
-        $providers = $this->registry->get_sitemaps();
+        $providers = $this->registry->get_providers();
         /* @var WP_Sitemaps_Provider $provider */
         foreach ( $providers as $name => $provider ) {

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

@@ -3 +3 @@
  * Sitemaps: WP_Sitemaps_Registry class
  *
- * Handles registering sitemaps.
+ * Handles registering sitemap providers.
  *
  * @package WordPress
@@ -17 +17 @@
 class WP_Sitemaps_Registry {
     /**
-     * Registered sitemaps.
+     * Registered sitemap providers.
      *
      * @since 5.5.0
      *
-     * @var WP_Sitemaps_Provider[] Array of registered sitemaps.
+     * @var WP_Sitemaps_Provider[] Array of registered sitemap providers.
      */
-    private $sitemaps = array();
+    private $providers = array();
 
     /**
@@ -30 +30 @@
      * @since 5.5.0
      *
-     * @param string               $name     Name of the sitemap.
+     * @param string               $name     Name of the sitemap provider.
      * @param WP_Sitemaps_Provider $provider Instance of a WP_Sitemaps_Provider.
-     * @return bool True if the sitemap was added, false if it is already registered.
+     * @return bool True if the provider was added, false if it is already registered.
      */
-    public function add_sitemap( $name, WP_Sitemaps_Provider $provider ) {
-        if ( isset( $this->sitemaps[ $name ] ) ) {
+    public function add_provider( $name, WP_Sitemaps_Provider $provider ) {
+        if ( isset( $this->providers[ $name ] ) ) {
             return false;
         }
 
-        $this->sitemaps[ $name ] = $provider;
+        $this->providers[ $name ] = $provider;
 
         return true;
@@ -45 +45 @@
 
     /**
-     * Returns a single registered sitemaps provider.
+     * Returns a single registered sitemap provider.
      *
      * @since 5.5.0
@@ -52 +52 @@
      * @return WP_Sitemaps_Provider|null Sitemaps provider if it exists, null otherwise.
      */
-    public function get_sitemap( $name ) {
-        if ( ! isset( $this->sitemaps[ $name ] ) ) {
+    public function get_provider( $name ) {
+        if ( ! isset( $this->providers[ $name ] ) ) {
             return null;
         }
 
-        return $this->sitemaps[ $name ];
+        return $this->providers[ $name ];
     }
 
@@ -67 +67 @@
      * @return WP_Sitemaps_Provider[] Array of sitemap providers.
      */
-    public function get_sitemaps() {
-        return $this->sitemaps;
+    public function get_providers() {
+        return $this->providers;
     }
 }

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

@@ -136 +136 @@
         /* @var WP_Sitemaps_Provider $provider */
         foreach ( $providers as $name => $provider ) {
-            $this->registry->add_sitemap( $name, $provider );
+            $this->registry->add_provider( $name, $provider );
         }
     }
@@ -213 +213 @@
         }
 
-        $provider = $this->registry->get_sitemap( $sitemap );
+        $provider = $this->registry->get_provider( $sitemap );
 
         if ( ! $provider ) {

trunk/tests/phpunit/tests/sitemaps/sitemaps-index.php

@@ -14 +14 @@
          * Hence, 3*4*2=24.
          */
-        $registry->add_sitemap( 'foo', new WP_Sitemaps_Test_Provider( 'foo' ) );
-        $registry->add_sitemap( 'bar', new WP_Sitemaps_Test_Provider( 'bar' ) );
+        $registry->add_provider( 'foo', new WP_Sitemaps_Test_Provider( 'foo' ) );
+        $registry->add_provider( 'bar', new WP_Sitemaps_Test_Provider( 'bar' ) );
 
         $sitemap_index = new WP_Sitemaps_Index( $registry );
@@ -30 +30 @@
 
         // add 3 providers, which combined produce more than the maximum 50000 sitemaps in the index.
-        $registry->add_sitemap( 'provider_1', new WP_Sitemaps_Large_Test_Provider( 25000 ) );
-        $registry->add_sitemap( 'provider_2', new WP_Sitemaps_Large_Test_Provider( 25000 ) );
-        $registry->add_sitemap( 'provider_3', new WP_Sitemaps_Large_Test_Provider( 25000 ) );
+        $registry->add_provider( 'provider_1', new WP_Sitemaps_Large_Test_Provider( 25000 ) );
+        $registry->add_provider( 'provider_2', new WP_Sitemaps_Large_Test_Provider( 25000 ) );
+        $registry->add_provider( 'provider_3', new WP_Sitemaps_Large_Test_Provider( 25000 ) );
 
         $count = 0;
-        foreach ( $registry->get_sitemaps() as $provider ) {
+        foreach ( $registry->get_providers() as $provider ) {
             $count += count( $provider->get_url_list( 1 ) );
         }
@@ -47 +47 @@
         $registry = new WP_Sitemaps_Registry();
 
-        $registry->add_sitemap( 'foo', new WP_Sitemaps_Empty_Test_Provider( 'foo' ) );
+        $registry->add_provider( 'foo', new WP_Sitemaps_Empty_Test_Provider( 'foo' ) );
 
         $sitemap_index = new WP_Sitemaps_Index( $registry );

trunk/tests/phpunit/tests/sitemaps/sitemaps-registry.php

@@ -5 +5 @@
  */
 class Test_WP_Sitemaps_Registry extends WP_UnitTestCase {
-    public function test_add_sitemap() {
+    public function test_add_provider() {
         $provider = new WP_Sitemaps_Test_Provider();
         $registry = new WP_Sitemaps_Registry();
 
-        $actual   = $registry->add_sitemap( 'foo', $provider );
-        $sitemaps = $registry->get_sitemaps();
+        $actual   = $registry->add_provider( 'foo', $provider );
+        $sitemaps = $registry->get_providers();
 
         $this->assertTrue( $actual );
@@ -17 +17 @@
     }
 
-    public function test_add_sitemap_prevent_duplicates() {
+    public function test_add_provider_prevent_duplicates() {
         $provider1 = new WP_Sitemaps_Test_Provider();
         $provider2 = new WP_Sitemaps_Test_Provider();
         $registry  = new WP_Sitemaps_Registry();
 
-        $actual1  = $registry->add_sitemap( 'foo', $provider1 );
-        $actual2  = $registry->add_sitemap( 'foo', $provider2 );
-        $sitemaps = $registry->get_sitemaps();
+        $actual1  = $registry->add_provider( 'foo', $provider1 );
+        $actual2  = $registry->add_provider( 'foo', $provider2 );
+        $sitemaps = $registry->get_providers();
 
         $this->assertTrue( $actual1 );