delete_network_option()
云策文档标注
概述
delete_network_option() 函数用于删除指定网络（network）的选项（option）。它接受网络ID和选项名称作为参数，并返回删除操作是否成功。
关键要点
- 函数签名：delete_network_option( $network_id, $option )，其中 $network_id 可为 null 以默认使用当前网络ID，$option 为要删除的选项名称（无需SQL转义）。
- 返回值：布尔值，true 表示选项已删除，false 表示删除失败。
- 支持多站点（Multisite）环境：在非多站点时调用 delete_option()，在多站点时直接操作数据库表 wp_sitemeta。
- 触发相关 Hook：包括 pre_delete_site_option_{$option}（删除前）、delete_site_option_{$option}（删除后）和 delete_site_option（删除后）。
- 内部处理：包括参数验证、缓存清理（使用 wp_cache_delete 和 wp_cache_set）和数据库操作（使用 wpdb::delete）。
代码示例
// 删除当前网络的选项
$deleted = delete_network_option( null, 'my_network_option' );
if ( $deleted ) {
echo '选项已删除';
} else {
echo '删除失败';
}注意事项
- 函数自 WordPress 4.4.0 版本引入。
- 在非多站点环境中，此函数会回退到 delete_option()。
- 选项名称不应进行 SQL 转义，函数内部会处理安全性。
- 删除操作会触发相关 Hook，开发者可以利用这些 Hook 执行额外逻辑。
原文内容
Removes a network option by name.
Description
See also
Parameters
$network_idint|nullrequired-
ID of the network. Can be null to default to the current network ID.
$optionstringrequired-
Name of the option to delete. Expected to not be SQL-escaped.
Source
function delete_network_option( $network_id, $option ) {
global $wpdb;
if ( $network_id && ! is_numeric( $network_id ) ) {
return false;
}
$network_id = (int) $network_id;
// Fallback to the current network if a network ID is not specified.
if ( ! $network_id ) {
$network_id = get_current_network_id();
}
/**
* Fires immediately before a specific network option is deleted.
*
* The dynamic portion of the hook name, `$option`, refers to the option name.
*
* @since 3.0.0
* @since 4.4.0 The `$option` parameter was added.
* @since 4.7.0 The `$network_id` parameter was added.
*
* @param string $option Option name.
* @param int $network_id ID of the network.
*/
do_action( "pre_delete_site_option_{$option}", $option, $network_id );
if ( ! is_multisite() ) {
$result = delete_option( $option );
} else {
$row = $wpdb->get_row( $wpdb->prepare( "SELECT meta_id FROM {$wpdb->sitemeta} WHERE meta_key = %s AND site_id = %d", $option, $network_id ) );
if ( is_null( $row ) || ! $row->meta_id ) {
return false;
}
$cache_key = "$network_id:$option";
wp_cache_delete( $cache_key, 'site-options' );
$result = $wpdb->delete(
$wpdb->sitemeta,
array(
'meta_key' => $option,
'site_id' => $network_id,
)
);
if ( $result ) {
$notoptions_key = "$network_id:notoptions";
$notoptions = wp_cache_get( $notoptions_key, 'site-options' );
if ( ! is_array( $notoptions ) ) {
$notoptions = array();
}
$notoptions[ $option ] = true;
wp_cache_set( $notoptions_key, $notoptions, 'site-options' );
}
}
if ( $result ) {
/**
* Fires after a specific network option has been deleted.
*
* The dynamic portion of the hook name, `$option`, refers to the option name.
*
* @since 2.9.0 As "delete_site_option_{$key}"
* @since 3.0.0
* @since 4.7.0 The `$network_id` parameter was added.
*
* @param string $option Name of the network option.
* @param int $network_id ID of the network.
*/
do_action( "delete_site_option_{$option}", $option, $network_id );
/**
* Fires after a network option has been deleted.
*
* @since 3.0.0
* @since 4.7.0 The `$network_id` parameter was added.
*
* @param string $option Name of the network option.
* @param int $network_id ID of the network.
*/
do_action( 'delete_site_option', $option, $network_id );
return true;
}
return false;
}
Hooks
- do_action( ‘delete_site_option’, string $option, int $network_id )
-
Fires after a network option has been deleted.
- do_action( “delete_site_option_{$option}”, string $option, int $network_id )
-
Fires after a specific network option has been deleted.
- do_action( “pre_delete_site_option_{$option}”, string $option, int $network_id )
-
Fires immediately before a specific network option is deleted.
Changelog
| Version | Description |
|---|---|
| 4.4.0 | Introduced. |