钩子文档

rest_after_insert_attachment

💡 云策文档标注

概述

rest_after_insert_attachment 是一个 WordPress REST API 钩子,在通过 REST API 完全创建或更新单个附件后触发。它允许开发者在附件操作完成后执行自定义代码。

关键要点

  • 触发时机:在通过 REST API 创建或更新单个附件后立即触发。
  • 参数:$attachment(WP_Post 对象,表示插入或更新的附件)、$request(WP_REST_Request 对象,表示请求)、$creating(布尔值,创建时为 true,更新时为 false)。
  • 用途:常用于在附件操作后执行额外处理,如日志记录、通知或数据同步。
  • 相关函数:与 WP_REST_Attachments_Controller::create_item() 和 WP_REST_Attachments_Controller::update_item() 关联。
  • 版本:自 WordPress 5.0.0 引入。

📄 原文内容

Fires after a single attachment is completely created or updated via the REST API.

Parameters

$attachmentWP_Post
Inserted or updated attachment object.
$requestWP_REST_Request
Request object.
$creatingbool
True when creating an attachment, false when updating.

Source

do_action( 'rest_after_insert_attachment', $attachment, $request, true );

Changelog

Version Description
5.0.0 Introduced.