Changeset 52204 for trunk/src/wp-includes/sitemaps/providers/class-wp-sitemaps-taxonomies.php

Timestamp:

11/18/2021 01:48:43 PM (5 years ago)

Author:

johnbillion

Message:

Docs: Various corrections and improvements relating to types used in inline documentation.

See #53399

File:

• trunk/src/wp-includes/sitemaps/providers/class-wp-sitemaps-taxonomies.php (modified) (4 diffs)

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

@@ -57 +57 @@
          * @param int    $page_num       Page of results.
          * @param string $object_subtype Optional. Taxonomy name. Default empty.
-         * @return array Array of URLs for a sitemap.
+         * @return array[] Array of URL information for a sitemap.
          */
         public function get_url_list( $page_num, $object_subtype = '' ) {
@@ -77 +77 @@
                  * @since 5.5.0
                  *
-                 * @param array  $url_list The URL list. Default null.
-                 * @param string $taxonomy Taxonomy name.
-                 * @param int    $page_num Page of results.
+                 * @param array[]|null $url_list The URL list. Default null.
+                 * @param string       $taxonomy Taxonomy name.
+                 * @param int          $page_num Page of results.
                  */
                 $url_list = apply_filters(
@@ -150 +150 @@
 
                 /**
-                 * Filters the max number of pages before it is generated.
+                 * Filters the max number of pages for a taxonomy sitemap before it is generated.
                  *
                  * Passing a non-null value will short-circuit the generation,
@@ -157 +157 @@
                  * @since 5.5.0
                  *
-                 * @param int    $max_num_pages The maximum number of pages. Default null.
-                 * @param string $taxonomy      Taxonomy name.
+                 * @param int|null $max_num_pages The maximum number of pages. Default null.
+                 * @param string   $taxonomy      Taxonomy name.
                  */
                 $max_num_pages = apply_filters( 'wp_sitemaps_taxonomies_pre_max_num_pages', null, $taxonomy );