WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

wp_sitemaps_posts_query_args

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

In this article

Back to top

Filters the query arguments for post type sitemap queries.

Description

See also

  • WP_Query: for a full list of arguments.

Parameters

$argsarray
Array of WP_Query arguments.
$post_typestring
Post type name.

Source

$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
);

View all references View on Trac View on GitHub

Used byDescription
WP_Sitemaps_Posts::get_posts_query_args()wp-includes/sitemaps/providers/class-wp-sitemaps-posts.php

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

Changelog

VersionDescription
6.1.0Added ignore_sticky_posts default parameter.
5.5.0Introduced.

User Contributed Notes

  1. Skip to note 2 content
    Krunal Bhimajiyani
    You must log in to vote on the helpfulness of this noteVote results for this note: 2You must log in to vote on the helpfulness of this note

    Filters the custom query arguments for post-type sitemap queries.

    add_filter( 'wp_sitemaps_posts_query_args', 'wpdocs_sitemaps_posts_query_args_callback', 10, 2 );

function wpdocs_sitemaps_posts_query_args_callback( $args, $post_type ) {
	$post_type = 'post_type_name'; // your post type

	$args = array(
		'post_type'   => $post_type,
		'order'       => 'desc',
		'post_status' => array( 'publish' ),
		'meta_query'  => array(
			'relation' => 'AND',
			array(
				'key'     => 'some_key_name',
				'value'   => 'some_value',
				'compare' => 'LIKE',
			),
			array(
				'key'     => 'some_key_name_2',
				'value'   => 'some_value_2',
				'compare' => '>=',
			),
		),
	);

	return $args;
}

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