WP_Sitemaps_Users::get_url_list( int $page_num, string $object_subtype = '' ): array[]

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

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 value

array[]

Array of URL information for a sitemap.

Performance profile

How much work a call to WP_Sitemaps_Users::get_url_list() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Heavy

Reaches the database via ->get_results().

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

11–27

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 44.

Plugin surface

2 hooks

Third-party callbacks on 'wp_sitemaps_users_pre_url_list', 'wp_sitemaps_users_entry' run inside this call, and their cost is not bounded by anything here.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• hookthird-party callbacksapply_filters()called directly
• sqldatabase query->get_results()called directly

Further down the call graph this can also reach query, option, cache, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 2 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Sitemaps_Users::get_url_list() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 2

2 hooks fire while WP_Sitemaps_Users::get_url_list() runs, in this order:

1. 1
   apply_filters( wp_sitemaps_users_pre_url_list )filterline 51 (+12 into the body)

   Filters the users URL list before it is generated.

2. 2
   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 code

View on Trac ↗View on GitHub ↗

39	public function get_url_list( $page_num, $object_subtype = '' ) {40		/**41		 * Filters the users URL list before it is generated.42		 *43		 * Returning a non-null value will effectively short-circuit the generation,44		 * returning that value instead.45		 *46		 * @since 5.5.047		 *48		 * @param array[]|null $url_list The URL list. Default null.49		 * @param int        $page_num Page of results.50		 */51		$url_list = apply_filters(52			'wp_sitemaps_users_pre_url_list',53			null,54			$page_num55		);56 57		if ( null !== $url_list ) {58			return $url_list;59		}60 61		$args          = $this->get_users_query_args();62		$args['paged'] = $page_num;63 64		$query    = new WP_User_Query( $args );65		$users    = $query->get_results();66		$url_list = array();67 68		foreach ( $users as $user ) {69			$sitemap_entry = array(70				'loc' => get_author_posts_url( $user->ID ),71			);72 73			/**74			 * Filters the sitemap entry for an individual user.75			 *76			 * @since 5.5.077			 *78			 * @param array   $sitemap_entry Sitemap entry for the user.79			 * @param WP_User $user          User object.80			 */81			$sitemap_entry = apply_filters( 'wp_sitemaps_users_entry', $sitemap_entry, $user );82			$url_list[]    = $sitemap_entry;83		}84 85		return $url_list;86	}

Changelog

Introduced in 5.5.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 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.