WP_Sitemaps_Users::get_url_list( int $page_num, string $object_subtype = '' ): array[]
- Since
- 5.5.0
- Source
wp-includes/sitemaps/providers/class-wp-sitemaps-users.php:39
Gets a URL list for a user sitemap.
Parameters
$page_numint- Page of results.
$object_subtypestringoptional- Not applicable for Users but required for compatibility with the parent provider class. Default empty.Default:
''
Return
array[]- Array of URL information for a sitemap.
Hooks fired · 2
2 hooks fire while WP_Sitemaps_Users::get_url_list() runs, in this order:
- apply_filters( wp_sitemaps_users_pre_url_list )filterline 51 (+12 into the body)
Filters the users URL list before it is generated.
- apply_filters( wp_sitemaps_users_entry )filterline 81 (+42 into the body)
Filters the sitemap entry for an individual user.
Uses · 4
- apply_filters()Calls the callback functions that have been added to a filter hook.
- get_author_posts_url()Retrieves the URL to the author page for the user with the ID provided.
- WP_Sitemaps_Users::get_users_query_args()Returns the query args for retrieving users to list in the sitemap.
- WP_User_Query::__construct()Constructor.
Source
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; }History
Introduced in 5.5.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 6.8.8 tag, from
src/wp-includes/sitemaps/providers/class-wp-sitemaps-users.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it. - Corrections
- Something wrong on this page? Report it and it gets fixed in the next regeneration.