Changeset 48098 for trunk/src/wp-includes/sitemaps/class-wp-sitemaps-provider.php

Timestamp:

06/19/2020 10:24:14 PM (5 years ago)

Author:

johnbillion

Message:

Docs: Corrections and improvements to inline docs related to XML sitemaps.

See #50117, #49572

File:

• trunk/src/wp-includes/sitemaps/class-wp-sitemaps-provider.php (modified) (3 diffs)

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

@@ -62 +62 @@
      * @since 5.5.0
      *
-     * @return array List of sitemap types including object subtype name and number of pages.
+     * @return array[] Array of sitemap types including object subtype name and number of pages.
      */
     public function get_sitemap_type_data() {
@@ -99 +99 @@
      * @since 5.5.0
      *
-     * @return array List of sitemaps.
+     * @return array[] Array of sitemap entries.
      */
     public function get_sitemap_entries() {
@@ -121 +121 @@
                  * @param string $object_subtype Object subtype name.
                  *                               Empty string if the object type does not support subtypes.
-                 * @param string $page           Page of results.
+                 * @param int    $page           Page number of results.
                  */
                 $sitemap_entry = apply_filters( 'wp_sitemaps_index_entry', $sitemap_entry, $this->object_type, $type['name'], $page );