钩子文档

pre_trash_post

💡 云策文档标注

概述

pre_trash_post 是一个 WordPress 过滤器,用于在将文章移至回收站前拦截或修改操作。它允许开发者基于文章对象和先前状态决定是否继续执行回收操作。

关键要点

  • 过滤器名称:pre_trash_post
  • 参数:$trash(布尔值或 null,决定是否继续回收)、$post(WP_Post 对象)、$previous_status(字符串,文章即将被回收前的状态)
  • 用途:在 wp_trash_post() 等函数中调用,可自定义回收逻辑
  • 相关函数:wp_trash_post() 和 WP_Customize_Manager::trash_changeset_post()
  • 版本历史:WordPress 4.9.0 引入,6.3.0 添加 $previous_status 参数

代码示例

$check = apply_filters( 'pre_trash_post', null, $post, $previous_status );

📄 原文内容

Filters whether a post trashing should take place.

Parameters

$trashbool|null
Whether to go forward with trashing.
$postWP_Post
Post object.
$previous_statusstring
The status of the post about to be trashed.

Source

$check = apply_filters( 'pre_trash_post', null, $post, $previous_status );

Changelog

Version Description
6.3.0 Added the $previous_status parameter.
4.9.0 Introduced.