WP_Sitemaps_Posts::get_posts_query_args( string $post_type ): 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

$post_typestring

Post type name.

Return value

array

Array of WP_Query arguments.

Performance profile

How much work a call to WP_Sitemaps_Posts::get_posts_query_args() 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

Trivial

Touches nothing outside its own arguments.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

22

Executed per call on PHP 8.5. The body compiles to 22.

Plugin surface

1 hook

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

Called by

2

2 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksapply_filters()called directly

What one call costs · 1 distinct outcome

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

Hooks and filters fired · 1

One hook fires while WP_Sitemaps_Posts::get_posts_query_args() runs, in this order:

1. 1
   apply_filters( wp_sitemaps_posts_query_args )filterline 237 (+12 into the body)

   Filters the query arguments for post type sitemap queries.

Uses · 2

• apply_filters()Calls the callback functions that have been added to a filter hook.
• wp_sitemaps_get_max_urls()Gets the maximum number of URLs for a sitemap.

Used by · 2

• WP_Sitemaps_Posts::get_max_num_pages()Gets the max number of pages available for the object type.
• WP_Sitemaps_Posts::get_url_list()Gets a URL list for a post type sitemap.

Source code

View on Trac ↗View on GitHub ↗

225	protected function get_posts_query_args( $post_type ) {226		/**227		 * Filters the query arguments for post type sitemap queries.228		 *229		 * @see WP_Query for a full list of arguments.230		 *231		 * @since 5.5.0232		 * @since 6.1.0 Added `ignore_sticky_posts` default parameter.233		 *234		 * @param array  $args      Array of WP_Query arguments.235		 * @param string $post_type Post type name.236		 */237		$args = apply_filters(238			'wp_sitemaps_posts_query_args',239			array(240				'orderby'                => 'ID',241				'order'                  => 'ASC',242				'post_type'              => $post_type,243				'posts_per_page'         => wp_sitemaps_get_max_urls( $this->object_type ),244				'post_status'            => array( 'publish' ),245				'no_found_rows'          => true,246				'update_post_term_cache' => false,247				'update_post_meta_cache' => false,248				'ignore_sticky_posts'    => true, // Sticky posts will still appear, but they won't be moved to the front.249			),250			$post_type251		);252 253		return $args;254	}

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 6.7.7 tag, from src/wp-includes/sitemaps/providers/class-wp-sitemaps-posts.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.