钩子文档

wp_sitemaps_users_query_args

💡 云策文档标注

概述

wp_sitemaps_users_query_args 是一个 WordPress 过滤器,用于修改在站点地图中查询有公开文章的作者时的 WP_User_Query 参数。它允许开发者在查询前自定义用户查询条件。

关键要点

  • 这是一个过滤器,用于修改 WP_User_Query 的参数,以筛选有公开文章的作者。
  • 参数 $args 是一个数组,包含 WP_User_Query 的查询参数。
  • 默认参数包括 'has_published_posts' 和 'number',用于限制查询结果。
  • 该过滤器在 WP_Sitemaps_Users::get_users_query_args() 方法中被调用。
  • 从 WordPress 5.5.0 版本开始引入。

代码示例

$args = apply_filters(
    'wp_sitemaps_users_query_args',
    array(
        'has_published_posts' => array_keys( $public_post_types ),
        'number'              => wp_sitemaps_get_max_urls( $this->object_type ),
    )
);

📄 原文内容

Filters the query arguments for authors with public posts.

Description

Allows modification of the authors query arguments before querying.

See also

Parameters

$argsarray
Array of WP_User_Query arguments.

Source

$args = apply_filters(
	'wp_sitemaps_users_query_args',
	array(
		'has_published_posts' => array_keys( $public_post_types ),
		'number'              => wp_sitemaps_get_max_urls( $this->object_type ),
	)
);

Changelog

Version Description
5.5.0 Introduced.