wp/wp-includes/sitemaps/providers/class-wp-sitemaps-users.php
changeset 19 3d72ae0968f4
parent 16 a86126ab1dd4
child 21 48c4eec2b7e6
--- a/wp/wp-includes/sitemaps/providers/class-wp-sitemaps-users.php	Wed Sep 21 18:19:35 2022 +0200
+++ b/wp/wp-includes/sitemaps/providers/class-wp-sitemaps-users.php	Tue Sep 27 16:37:53 2022 +0200
@@ -34,19 +34,19 @@
 	 * @param string $object_subtype Optional. Not applicable for Users but
 	 *                               required for compatibility with the parent
 	 *                               provider class. 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 = '' ) {
 		/**
 		 * Filters the users URL list before it is generated.
 		 *
-		 * Passing a non-null value will effectively short-circuit the generation,
+		 * Returning a non-null value will effectively short-circuit the generation,
 		 * returning that value instead.
 		 *
 		 * @since 5.5.0
 		 *
-		 * @param array  $url_list The URL list. Default null.
-		 * @param int    $page_num Page of results.
+		 * @param array[]|null $url_list The URL list. Default null.
+		 * @param int        $page_num Page of results.
 		 */
 		$url_list = apply_filters(
 			'wp_sitemaps_users_pre_url_list',
@@ -99,14 +99,14 @@
 	 */
 	public function get_max_num_pages( $object_subtype = '' ) {
 		/**
-		 * Filters the max number of pages before it is generated.
+		 * Filters the max number of pages for a user sitemap before it is generated.
 		 *
-		 * Passing a non-null value will effectively short-circuit the generation,
+		 * Returning a non-null value will effectively short-circuit the generation,
 		 * returning that value instead.
 		 *
 		 * @since 5.5.0
 		 *
-		 * @param int $max_num_pages The maximum number of pages. Default null.
+		 * @param int|null $max_num_pages The maximum number of pages. Default null.
 		 */
 		$max_num_pages = apply_filters( 'wp_sitemaps_users_pre_max_num_pages', null );