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
檢視更多 >