钩子文档

wp_validate_site_deletion

💡 云策文档标注

概述

wp_validate_site_deletion 是一个 WordPress 动作钩子,在从数据库删除站点前触发,允许插件验证删除操作。

关键要点

  • 此钩子用于在删除站点前添加验证逻辑,通过 WP_Error 对象收集错误。
  • 如果 $errors 对象包含任何错误,站点将不会被删除。
  • 钩子接收两个参数:$errors(WP_Error 对象)和 $old_site(要删除的站点对象)。
  • 在 WordPress 5.1.0 版本中引入。

代码示例

do_action( 'wp_validate_site_deletion', $errors, $old_site );

注意事项

  • 插件应使用 WP_Error::add() 方法向 $errors 对象添加验证错误。
  • 此钩子与 wp_delete_site() 函数相关,用于控制站点删除流程。

📄 原文内容

Fires before a site should be deleted from the database.

Description

Plugins should amend the $errors object via its WP_Error::add() method. If any errors are present, the site will not be deleted.

Parameters

$errorsWP_Error
Error object to add validation errors to.
$old_siteWP_Site
The site object to be deleted.

Source

do_action( 'wp_validate_site_deletion', $errors, $old_site );

Changelog

Version Description
5.1.0 Introduced.