WP_Sitemaps_Users::get_url_list() │ public │ WP 5.5.0

Gets a URL list for a user sitemap.

Method of the class: WP_Sitemaps_Users{}

Return

Array[]. Array of URL information for a sitemap.

Usage

$WP_Sitemaps_Users = new WP_Sitemaps_Users();
$WP_Sitemaps_Users->get_url_list( $page_num, $object_subtype );

$page_num(int) (required)

Page of results.

$object_subtype(string)

Not applicable for Users but required for compatibility with the parent provider class.
Default: ''

Changelog

WP_Sitemaps_Users::get_url_list() WP Sitemaps Users::get url list code ^{WP 6.6.1}

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;
}