get_user_option()
get_user_option( string $option, int $user, string $dep…
get_user_option( string $option, int $user, string $deprecated = ” )
检索可以是每个站点或每个网络的用户选项。
Retrieve user option that can be either per Site or per Network.
目录锚点:#说明#参数#返回#源码#笔记
说明(Description)
如果没有给出用户ID,则将使用当前用户。如果给定了用户ID,则将检索用户数据。结果的过滤器还将传递原始选项名,最后将用户数据对象作为第三个参数。
该选项将首先检查每个站点名称,然后检查每个网络名称。
参数(Parameters)
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
$option | (string) | 必需 | 用户选项名称。 |
$user | (int) | 可选 | 用户ID。 |
$deprecated | (string) | 可选 | 使用get_option()检查选项表中的选项。 |
返回(Return)
(mixed)成功时的用户选项值,失败时为false。
源码(Source)
/** * Retrieve user option that can be either per Site or per Network. * * If the user ID is not given, then the current user will be used instead. If * the user ID is given, then the user data will be retrieved. The filter for * the result, will also pass the original option name and finally the user data * object as the third parameter. * * The option will first check for the per site name and then the per Network name. * * @since 2.0.0 * * @global wpdb $wpdb WordPress database object for queries. * * @param string $option User option name. * @param int $user Optional. User ID. * @param string $deprecated Use get_option() to check for an option in the options table. * @return mixed User option value on success, false on failure. */ function get_user_option( $option, $user = 0, $deprecated = '' ) { global $wpdb; if ( !empty( $deprecated ) ) _deprecated_argument( __FUNCTION__, '3.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; /** * Filter 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 ); }
更新版本 | 源码位置 | 使用 | 被使用 |
---|---|---|---|
2.0.0 | wp-includes/user.php:467 | 30 | 6 |
笔记(Notes)
基本示例
类别:WordPress 函数手册、
本文收集自互联网,转载请注明来源。
如有侵权,请联系 wper_net@163.com 删除。
还没有任何评论,赶紧来占个楼吧!