钩子文档

rest_query_var-{$key}

💡 云策文档标注

概述

rest_query_var-{$key} 是一个动态过滤器钩子,用于在 WordPress REST API 的 get_items() 方法中过滤查询变量。它允许开发者修改特定查询变量的值,以自定义 WP_Query 的行为。

关键要点

  • 这是一个动态钩子,$key 部分对应查询变量的键名,例如 rest_query_var-post_type。
  • 主要用于 WP_REST_Revisions_Controller 和 WP_REST_Posts_Controller 的 prepare_items_query() 方法中,以准备 WP_Query 的查询参数。
  • 钩子从 WordPress 4.7.0 版本开始引入。

代码示例

$query_args[ $key ] = apply_filters( "rest_query_var-{$key}", $value ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores

注意事项

  • 钩子名称使用连字符而非下划线,需注意命名规范。
  • 使用时需确保 $key 是有效的查询变量键,以避免错误。

📄 原文内容

Filters the query_vars used in get_items() for the constructed query.

Description

The dynamic portion of the hook name, $key, refers to the query_var key.

Parameters

$valuestring
The query_var value.

Source

$query_args[ $key ] = apply_filters( "rest_query_var-{$key}", $value ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores

Changelog

Version Description
4.7.0 Introduced.