get_user_option()

检索可以是每个站点还是每个网络的用户选项。

原型

get_user_option( string $option, int $user, string $deprecated = '' )

描述

如果未给出用户ID，则将使用当前用户。如果给出了用户ID，则将检索用户数据。结果的过滤器也将传递原始选项名称，最后传递用户数据对象作为第三个参数。

参数

$option (string) (Required) 用户选项名称。

$user (int) (Optional)  用户身份。

$deprecated (string) (Optional) 使用get_option（）检查选项表中的选项。

返回值

(mixed)  成功时的用户选项值，失败时为false。

源文件

路径：wp-includes/user.php

<?php
...
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();
	if ( ! $user = get_userdata( $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 );
}
...
?>

其他

英文文档：https://developer.wordpress.org/reference/functions/get_user_option/