get_users_of_blog()
云策文档标注
概述
get_users_of_blog() 是一个用于获取指定站点用户的 WordPress 函数,主要用于多站点设置,但也可在非多站点环境中使用。该函数自 3.1.0 版本起已被弃用,建议使用 get_users() 替代。
关键要点
- 函数用途:获取指定站点 ID 的用户列表,适用于多站点功能。
- 参数:$id(整数,必需),表示站点 ID;若为空,则使用当前站点 ID。
- 返回值:返回一个包含用户信息的数组。
- 弃用状态:自 WordPress 3.1.0 起弃用,推荐使用 get_users() 函数。
- 相关函数:涉及 wpdb::get_blog_prefix()、get_current_blog_id()、_deprecated_function() 和 wpdb::get_results() 等。
代码示例
function get_users_of_blog( $id = '' ) {
_deprecated_function( __FUNCTION__, '3.1.0', 'get_users()' );
global $wpdb;
if ( empty( $id ) ) {
$id = get_current_blog_id();
}
$blog_prefix = $wpdb->get_blog_prefix($id);
$users = $wpdb->get_results( "SELECT user_id, user_id AS ID, user_login, display_name, user_email, meta_value FROM $wpdb->users, $wpdb->usermeta WHERE {$wpdb->users}.ID = {$wpdb->usermeta}.user_id AND meta_key = '{$blog_prefix}capabilities' ORDER BY {$wpdb->usermeta}.user_id" );
return $users;
}注意事项
由于该函数已弃用,开发者应避免在新代码中使用,并迁移到 get_users() 函数以确保兼容性和最佳实践。
原文内容
Get users for the site.
Description
For setups that use the multisite feature. Can be used outside of the multisite feature.
See also
Parameters
$idintrequired-
Site ID.
Source
function get_users_of_blog( $id = '' ) {
_deprecated_function( __FUNCTION__, '3.1.0', 'get_users()' );
global $wpdb;
if ( empty( $id ) ) {
$id = get_current_blog_id();
}
$blog_prefix = $wpdb->get_blog_prefix($id);
$users = $wpdb->get_results( "SELECT user_id, user_id AS ID, user_login, display_name, user_email, meta_value FROM $wpdb->users, $wpdb->usermeta WHERE {$wpdb->users}.ID = {$wpdb->usermeta}.user_id AND meta_key = '{$blog_prefix}capabilities' ORDER BY {$wpdb->usermeta}.user_id" );
return $users;
}
Changelog
| Version | Description |
|---|---|
| 3.1.0 | Deprecated. Use get_users() |
| 2.2.0 | Introduced. |