Changeset 48536 for trunk/src/wp-includes/sitemaps/class-wp-sitemaps-registry.php

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.

File:

• trunk/src/wp-includes/sitemaps/class-wp-sitemaps-registry.php (modified) (6 diffs)

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;
     }
 }