钩子文档

users_list_table_query_args

💡 云策文档标注

概述

users_list_table_query_args 是一个 WordPress 过滤器,用于修改在用户列表页面中检索用户时传递给 WP_User_Query 的查询参数。它允许开发者自定义用户查询条件,例如基于角色、搜索词或分页等。

关键要点

  • 这是一个过滤器 Hook,名称为 users_list_table_query_args,用于过滤用户列表表的查询参数。
  • 参数 $args 是一个数组,包含传递给 WP_User_Query 的参数,用于检索当前用户列表表的项目。
  • 该过滤器在 WordPress 4.4.0 版本中引入,主要用于 WP_MS_Users_List_Table::prepare_items() 和 WP_Users_List_Table::prepare_items() 方法中。

代码示例

$args = apply_filters( 'users_list_table_query_args', $args );

📄 原文内容

Filters the query arguments used to retrieve users for the current users list table.

Parameters

$argsarray
Arguments passed to WP_User_Query to retrieve items for the current users list table.

Source

$args = apply_filters( 'users_list_table_query_args', $args );

Changelog

Version Description
4.4.0 Introduced.