Bricks 中文文档：bricks/query_filters/index_user/before

标签TAGS:

2026年8月30日

📄 原始资料 | 展开查看原始 JSON（bricks-query_filters-index_user-before.json）{ “name”: “bricks/query_filters/index_user/before”, “kind”: “action”, “url”: “https://academy.bricksbuilder.io/developer/hooks/actions/bricks-query_filters-index_user-before/”, “scraped_at”: “2026-08-29”, “hook_name”: “bric…

📄 原始资料 | 展开查看原始 JSON（bricks-query_filters-index_user-before.json）

{
  "name": "bricks/query_filters/index_user/before",
  "kind": "action",
  "url": "https://academy.bricksbuilder.io/developer/hooks/actions/bricks-query_filters-index_user-before/",
  "scraped_at": "2026-08-29",
  "hook_name": "bricks/query_filters/index_user/before",
  "description": {
    "en": "Runs before a user is indexed for Query Filters. This action is triggered during the indexing process for a specific user.",
    "zh": "在用户被纳入 Query Filters 索引之前触发。此动作在处理特定用户的索引过程中触发。"
  },
  "parameters": [
    {
      "name": "user_id",
      "type": "int",
      "type_zh": null,
      "description": {
        "en": "The ID of the user being indexed.",
        "zh": "正在被索引的用户的 ID。"
      }
    }
  ],
  "example_usage": "add_action( 'bricks/query_filters/index_user/before', function( $user_id ) {\n    // Perform actions before indexing a user\n    // error_log( \"Starting indexing for user ID: $user_id\" );\n\n\n    // Maybe register custom dynamic data providers if needed for indexing\n} );"
}

前言

在用户被纳入 Query Filters 索引之前触发。此动作在处理特定用户的索引过程中触发。

用法

将代码加入子主题的 functions.php：

add_action( 'bricks/query_filters/index_user/before', function( $user_id ) {
    // Perform actions before indexing a user
    // error_log( "Starting indexing for user ID: $user_id" );


    // Maybe register custom dynamic data providers if needed for indexing
} );

参数

$user_id (int)：正在被索引的用户的 ID。

示例代码

官方示例用法

add_action( 'bricks/query_filters/index_user/before', function( $user_id ) {
    // Perform actions before indexing a user
    // error_log( "Starting indexing for user ID: $user_id" );


    // Maybe register custom dynamic data providers if needed for indexing
} );

根据条件短路返回原值

根据条件跳过或修改返回值：

add_filter( 'bricks/query_filters/index_user/before', function( $value, $user_id ) {
    if ( is_admin() ) { return $value; }
    // TODO: custom logic here
    return $value;
} );

补充说明

更多细节可参考官方文档。