钩子文档

rest_pre_insert_{$this->taxonomy}

💡 云策文档标注

概述

rest_pre_insert_{$this->taxonomy} 是一个动态过滤器钩子,用于在通过 REST API 插入分类法术语之前过滤术语数据。它允许开发者在术语创建或更新前修改数据。

关键要点

  • 这是一个动态钩子,名称中的 {$this->taxonomy} 部分会根据分类法 slug 动态替换,例如 rest_pre_insert_category 或 rest_pre_insert_post_tag。
  • 钩子接收两个参数:$prepared_term(术语对象)和 $request(WP_REST_Request 对象),用于在 REST API 请求中处理术语数据。
  • 主要用于 WP_REST_Terms_Controller::prepare_item_for_database() 方法中,在术语插入数据库前进行数据准备。
  • 自 WordPress 4.7.0 版本引入,是 REST API 术语管理的关键过滤器。

代码示例

return apply_filters( "rest_pre_insert_{$this->taxonomy}", $prepared_term, $request );

📄 原文内容

Filters term data before inserting term via the REST API.

Description

The dynamic portion of the hook name, $this->taxonomy, refers to the taxonomy slug.

Possible hook names include:

  • rest_pre_insert_category
  • rest_pre_insert_post_tag

Parameters

$prepared_termobject
Term object.
$requestWP_REST_Request
Request object.

Source

return apply_filters( "rest_pre_insert_{$this->taxonomy}", $prepared_term, $request );

Changelog

Version Description
4.7.0 Introduced.