函数文档

is_user_option_local()

💡 云策文档标注

概述

is_user_option_local() 函数用于检查用户元键是否与当前博客相关,但自 WordPress 4.9.0 起已被弃用。该函数通过构建本地键并检查当前用户对象中是否存在该键来返回布尔值。

关键要点

  • 函数 is_user_option_local() 已弃用,不建议在新代码中使用。
  • 参数包括 $key(必需)、$user_id(可选,默认为当前用户)和 $blog_id(可选,默认为当前博客)。
  • 返回布尔值,指示用户元键是否与指定博客相关。
  • 内部使用 wpdb::get_blog_prefix() 构建本地键,并依赖 wp_get_current_user() 获取当前用户对象。

注意事项

  • 自 WordPress 4.9.0 版本起,此函数被标记为弃用,应避免使用,并考虑替代方案。
  • 函数内部调用 _deprecated_function() 来通知开发者其弃用状态。

📄 原文内容

Check whether a usermeta key has to do with the current blog.

Parameters

$keystringrequired
$user_idintoptional
Defaults to current user.
$blog_idintoptional
Defaults to current blog.

Return

bool

Source

function is_user_option_local( $key, $user_id = 0, $blog_id = 0 ) {
	global $wpdb;

	_deprecated_function( __FUNCTION__, '4.9.0' );

	$current_user = wp_get_current_user();
	if ( $blog_id == 0 ) {
		$blog_id = get_current_blog_id();
	}
	$local_key = $wpdb->get_blog_prefix( $blog_id ) . $key;

	return isset( $current_user->$local_key );
}

Changelog

Version Description
4.9.0 Deprecated.
MU (3.0.0) Introduced.