Bricks 中文文档：bricks/get_templates_query/cache_key

标签TAGS:

2026年8月30日

📄 原始资料 | 展开查看原始 JSON（bricks-get_templates_query-cache_key.json）{ “name”: “bricks/get_templates_query/cache_key”, “kind”: “filter”, “url”: “https://academy.bricksbuilder.io/developer/hooks/filters/bricks-get_templates_query-cache_key/”, “scraped_at”: “2026-08-29”, “hook_name”: “bricks/get…

📄 原始资料 | 展开查看原始 JSON（bricks-get_templates_query-cache_key.json）

{
  "name": "bricks/get_templates_query/cache_key",
  "kind": "filter",
  "url": "https://academy.bricksbuilder.io/developer/hooks/filters/bricks-get_templates_query-cache_key/",
  "scraped_at": "2026-08-29",
  "hook_name": "bricks/get_templates_query/cache_key",
  "description": {
    "en": "Filters the cache key used by Templates::get_templates_query() to store and retrieve template queries. Use this to create unique cache entries when modifying the template query arguments based on custom context (e.g., user role, language).",
    "zh": "此筛选器允许你向页面“管理媒体”面板添加新尺寸。"
  },
  "parameters": [
    {
      "name": "cache_key",
      "type": "string",
      "type_zh": null,
      "description": {
        "en": "The unique cache key string.",
        "zh": "唯一的缓存键字符串。"
      }
    }
  ],
  "example_usage": "add_filter( 'bricks/get_templates_query/cache_key', function( $cache_key ) {\n    // Example: Append current user role to cache key\n    $user = wp_get_current_user();\n    $role = ( array ) $user->roles;\n\n\n    return $cache_key . '_' . implode( '-', $role );\n} );"
}

前言

此筛选器允许你向页面“管理媒体”面板添加新尺寸。

用法

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

add_filter( 'bricks/get_templates_query/cache_key', function( $cache_key ) {
    // Example: Append current user role to cache key
    $user = wp_get_current_user();
    $role = ( array ) $user->roles;


    return $cache_key . '_' . implode( '-', $role );
} );

参数

$cache_key (string)：唯一的缓存键字符串。

示例代码

筛选返回值

add_filter( 'bricks/get_templates_query/cache_key', function( $cache_key ) {
    // Example: Append current user role to cache key
    $user = wp_get_current_user();
    $role = ( array ) $user->roles;


    return $cache_key . '_' . implode( '-', $role );
} );

根据条件短路返回原值

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

add_filter( 'bricks/get_templates_query/cache_key', function( $value, $cache_key ) {
    if ( is_admin() ) { return $value; }
    // TODO: custom logic here
    return $value;
} );

补充说明

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