get_user_option

函数
get_user_option ( $option, $user = 0, $deprecated = '' )
参数
  • (string) $option User option name.
    Required:
  • (int) $user Optional. User ID.
    Required:
  • (string) $deprecated Use get_option() to check for an option in the options table.
    Required:
    Default: (empty)
返回值
  • (mixed) User option value on success, false on failure.
定义位置
相关方法
get_site_optiondelete_user_optionget_optionupdate_user_optionget_network_option
引入
2.0.0
弃用
-

get_user_option: 这个函数用来从WordPress数据库中检索一个用户的选项值: 该函数以一个用户ID和一个选项名称作为参数,并返回选项的值。

检索用户选项,可以是每个网站或每个网络。

如果没有给出用户ID,那么将使用当前用户来代替。如果给出了用户ID,那么用户数据将被检索出来。结果的过滤器
结果的过滤器,也将传递原始的选项名称,最后传递用户数据对象作为第三个参数。

该选项将首先检查每个站点的名称,然后检查每个网络的名称。

function get_user_option( $option, $user = 0, $deprecated = '' ) {
	global $wpdb;

	if ( ! empty( $deprecated ) ) {
		_deprecated_argument( __FUNCTION__, '3.0.0' );
	}

	if ( empty( $user ) ) {
		$user = get_current_user_id();
	}

	$user = get_userdata( $user );
	if ( ! $user ) {
		return false;
	}

	$prefix = $wpdb->get_blog_prefix();
	if ( $user->has_prop( $prefix . $option ) ) { // Blog-specific.
		$result = $user->get( $prefix . $option );
	} elseif ( $user->has_prop( $option ) ) { // User-specific and cross-blog.
		$result = $user->get( $option );
	} else {
		$result = false;
	}

	/**
	 * Filters a specific user option value.
	 *
	 * The dynamic portion of the hook name, `$option`, refers to the user option name.
	 *
	 * @since 2.5.0
	 *
	 * @param mixed   $result Value for the user's option.
	 * @param string  $option Name of the option being retrieved.
	 * @param WP_User $user   WP_User object of the user whose option is being retrieved.
	 */
	return apply_filters( "get_user_option_{$option}", $result, $option, $user );
}

常见问题

FAQs
查看更多 >