{
  "name": "bricks/query_filters/index_args",
  "kind": "filter",
  "url": "https://academy.bricksbuilder.io/developer/hooks/filters/bricks-query_filters-index_args/",
  "scraped_at": "2026-08-29",
  "hook_name": "bricks/query_filters/index_args",
  "description": {
    "en": "Filters the query arguments used by the Query Filters indexer to find objects (posts, terms, users) that need to be indexed.",
    "zh": "筛选 Query Filters 索引器用于查找需要索引的对象（文章、术语、用户）的查询参数。"
  },
  "parameters": [
    {
      "name": "args",
      "type": "array",
      "type_zh": null,
      "description": {
        "en": "The query arguments (for WP_Query , WP_Term_Query , or WP_User_Query ).",
        "zh": "查询参数（用于 WP_Query、WP_Term_Query 或 WP_User_Query）。"
      }
    },
    {
      "name": "filter_source",
      "type": "string",
      "type_zh": null,
      "description": {
        "en": "The source of the filter data (e.g., wpField , customField ).",
        "zh": "筛选数据来源（例如 wpField、customField）。"
      }
    },
    {
      "name": "filter_settings",
      "type": "array",
      "type_zh": null,
      "description": {
        "en": "The settings of the filter element being indexed.",
        "zh": "正在被索引的筛选元素的设置。"
      }
    },
    {
      "name": "query_type",
      "type": "string",
      "type_zh": null,
      "description": {
        "en": "The type of query being run ( wp_query , wp_term_query , wp_user_query ).",
        "zh": "正在运行的查询类型（wp_query、wp_term_query、wp_user_query）。"
      }
    }
  ],
  "example_usage": "add_filter( 'bricks/query_filters/index_args', function( $args, $filter_source, $filter_settings, $query_type ) {\n    // Example: Include 'private' posts when indexing\n    if ( $query_type === 'wp_query' ) {\n        $args['post_status'] = [ 'publish', 'private' ];\n    }\n\n\n    return $args;\n}, 10, 4 );"
}