WP_Sitemaps_Posts::get_posts_query_args( string $post_type ): array

In this article

Returns the query args for retrieving posts to list in the sitemap.

Parameters

$post_typestringrequired
Post type name.

Return

array Array of WP_Query arguments.

Source

protected function get_posts_query_args( $post_type ) {
	/**
	 * Filters the query arguments for post type sitemap queries.
	 *
	 * @see WP_Query for a full list of arguments.
	 *
	 * @since 5.5.0
	 * @since 6.1.0 Added `ignore_sticky_posts` default parameter.
	 *
	 * @param array  $args      Array of WP_Query arguments.
	 * @param string $post_type Post type name.
	 */
	$args = apply_filters(
		'wp_sitemaps_posts_query_args',
		array(
			'orderby'                => 'ID',
			'order'                  => 'ASC',
			'post_type'              => $post_type,
			'posts_per_page'         => wp_sitemaps_get_max_urls( $this->object_type ),
			'post_status'            => array( 'publish' ),
			'no_found_rows'          => true,
			'update_post_term_cache' => false,
			'update_post_meta_cache' => false,
			'ignore_sticky_posts'    => true, // Sticky posts will still appear, but they won't be moved to the front.
		),
		$post_type
	);

	return $args;
}

Hooks

apply_filters( ‘wp_sitemaps_posts_query_args’, array $args, string $post_type )

Filters the query arguments for post type sitemap queries.

Changelog

VersionDescription
6.1.0Added ignore_sticky_posts default parameter.
5.5.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.