WP_Sitemaps_Users::get_url_list() WordPress Method
The WP_Sitemaps_Users::get_url_list() method is used to retrieve a list of URLs for a user sitemap. This sitemap is used to provide information about the author of a website or blog.
WP_Sitemaps_Users::get_url_list( int $page_num, string $object_subtype = '' ) #
Gets a URL list for a user sitemap.
Parameters
- $page_num
(int)(Required)Page of results.
- $object_subtype
(string)(Optional) Not applicable for Users but required for compatibility with the parent provider class.
Default value: ''
Return
(array[]) Array of URL information for a sitemap.
Source
File: wp-includes/sitemaps/providers/class-wp-sitemaps-users.php
public function get_url_list( $page_num, $object_subtype = '' ) { /** * Filters the users URL list before it is generated. * * Returning a non-null value will effectively short-circuit the generation, * returning that value instead. * * @since 5.5.0 * * @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', null, $page_num ); if ( null !== $url_list ) { return $url_list; } $args = $this->get_users_query_args(); $args['paged'] = $page_num; $query = new WP_User_Query( $args ); $users = $query->get_results(); $url_list = array(); foreach ( $users as $user ) { $sitemap_entry = array( 'loc' => get_author_posts_url( $user->ID ), ); /** * Filters the sitemap entry for an individual user. * * @since 5.5.0 * * @param array $sitemap_entry Sitemap entry for the user. * @param WP_User $user User object. */ $sitemap_entry = apply_filters( 'wp_sitemaps_users_entry', $sitemap_entry, $user ); $url_list[] = $sitemap_entry; } return $url_list; }
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
Version | Description |
---|---|
5.5.0 | Introduced. |