函数文档

delete_user_option()

💡 云策文档标注

概述

delete_user_option() 函数用于删除用户选项,支持全局博客选项功能。它通过将选项名称与博客前缀结合(除非指定为全局),并调用 delete_user_meta() 来实现删除操作。

关键要点

  • 函数用于删除用户选项,类似于用户元数据,但支持全局博客选项。
  • 参数包括 $user_id(用户ID,必填)、$option_name(选项名称,必填)和 $is_global(是否全局,可选,默认 false)。
  • 当 $is_global 为 false 时,函数会自动在选项名称前添加 WordPress 表前缀。
  • 返回值为布尔类型,成功时返回 true,失败时返回 false。
  • 函数内部依赖于 delete_user_meta() 和 wpdb::get_blog_prefix() 来实现功能。

代码示例

function delete_user_option( $user_id, $option_name, $is_global = false ) {
    global $wpdb;

    if ( ! $is_global ) {
        $option_name = $wpdb->get_blog_prefix() . $option_name;
    }

    return delete_user_meta( $user_id, $option_name );
}

注意事项

  • 此函数从 WordPress 3.0.0 版本开始引入。
  • 相关函数包括 delete_user_meta() 和 wpdb::get_blog_prefix(),用于元数据删除和前缀获取。
  • 在 wpmu_create_user() 等函数中被使用,适用于多站点环境。

📄 原文内容

Deletes user option with global blog capability.

Description

User options are just like user metadata except that they have support for global blog options. If the ‘is_global’ parameter is false, which it is by default, it will prepend the WordPress table prefix to the option name.

Parameters

$user_idintrequired
User ID
$option_namestringrequired
User option name.
$is_globalbooloptional
Whether option name is global or blog specific.
Default false (blog specific).

Default:false

Return

bool True on success, false on failure.

Source

function delete_user_option( $user_id, $option_name, $is_global = false ) {
	global $wpdb;

	if ( ! $is_global ) {
		$option_name = $wpdb->get_blog_prefix() . $option_name;
	}

	return delete_user_meta( $user_id, $option_name );
}

Changelog

Version Description
3.0.0 Introduced.