wp_dropdown_users
函数
wp_dropdown_users ( $args = '' )
- 参数
-
-
(array|string)
$args
{ Optional. Array or string of arguments to generate a drop-down of users. See WP_User_Query::prepare_query() for additional available arguments. @type string $show_option_all Text to show as the drop-down default (all). Default empty. @type string $show_option_none Text to show as the drop-down default when no users were found. Default empty. @type int|string $option_none_value Value to use for $show_option_non when no users were found. Default -1. @type string $hide_if_only_one_author Whether to skip generating the drop-down if only one user was found. Default empty. @type string $orderby Field to order found users by. Accepts user fields. Default 'display_name'. @type string $order Whether to order users in ascending or descending order. Accepts 'ASC' (ascending) or 'DESC' (descending). Default 'ASC'. @type int[]|string $include Array or comma-separated list of user IDs to include. Default empty. @type int[]|string $exclude Array or comma-separated list of user IDs to exclude. Default empty. @type bool|int $multi Whether to skip the ID attribute on the 'select' element. Accepts 1|true or 0|false. Default 0|false. @type string $show User data to display. If the selected item is empty then the 'user_login' will be displayed in parentheses. Accepts any user field, or 'display_name_with_login' to show the display name with user_login in parentheses. Default 'display_name'. @type int|bool $echo Whether to echo or return the drop-down. Accepts 1|true (echo) or 0|false (return). Default 1|true. @type int $selected Which user ID should be selected. Default 0. @type bool $include_selected Whether to always include the selected user ID in the drop- down. Default false. @type string $name Name attribute of select element. Default 'user'. @type string $id ID attribute of the select element. Default is the value of $name. @type string $class Class attribute of the select element. Default empty. @type int $blog_id ID of blog (Multisite only). Default is ID of the current blog. @type string $who Which type of users to query. Accepts only an empty string or 'authors'. Default empty. @type string|array $role An array or a comma-separated list of role names that users must match to be included in results. Note that this is an inclusive list: users must match *each* role. Default empty. @type string[] $role__in An array of role names. Matched users must have at least one of these roles. Default empty array. @type string[] $role__not_in An array of role names to exclude. Users matching one or more of these roles will not be included in results. Default empty array. }
- Required: 否
- Default: (empty)
-
(array|string)
$args
{ Optional. Array or string of arguments to generate a drop-down of users. See WP_User_Query::prepare_query() for additional available arguments. @type string $show_option_all Text to show as the drop-down default (all). Default empty. @type string $show_option_none Text to show as the drop-down default when no users were found. Default empty. @type int|string $option_none_value Value to use for $show_option_non when no users were found. Default -1. @type string $hide_if_only_one_author Whether to skip generating the drop-down if only one user was found. Default empty. @type string $orderby Field to order found users by. Accepts user fields. Default 'display_name'. @type string $order Whether to order users in ascending or descending order. Accepts 'ASC' (ascending) or 'DESC' (descending). Default 'ASC'. @type int[]|string $include Array or comma-separated list of user IDs to include. Default empty. @type int[]|string $exclude Array or comma-separated list of user IDs to exclude. Default empty. @type bool|int $multi Whether to skip the ID attribute on the 'select' element. Accepts 1|true or 0|false. Default 0|false. @type string $show User data to display. If the selected item is empty then the 'user_login' will be displayed in parentheses. Accepts any user field, or 'display_name_with_login' to show the display name with user_login in parentheses. Default 'display_name'. @type int|bool $echo Whether to echo or return the drop-down. Accepts 1|true (echo) or 0|false (return). Default 1|true. @type int $selected Which user ID should be selected. Default 0. @type bool $include_selected Whether to always include the selected user ID in the drop- down. Default false. @type string $name Name attribute of select element. Default 'user'. @type string $id ID attribute of the select element. Default is the value of $name. @type string $class Class attribute of the select element. Default empty. @type int $blog_id ID of blog (Multisite only). Default is ID of the current blog. @type string $who Which type of users to query. Accepts only an empty string or 'authors'. Default empty. @type string|array $role An array or a comma-separated list of role names that users must match to be included in results. Note that this is an inclusive list: users must match *each* role. Default empty. @type string[] $role__in An array of role names. Matched users must have at least one of these roles. Default empty array. @type string[] $role__not_in An array of role names to exclude. Users matching one or more of these roles will not be included in results. Default empty array. }
- 返回值
-
- (string) HTML dropdown list of users.
- 定义位置
-
- wp-includes/user.php , line 1580
- 引入
- 2.3.0
- 弃用
- -
wp_dropdown_users: 这个函数用来显示WordPress网站中用户的下拉菜单: 这个函数可以用来让管理员为各种任务选择不同的用户,并且可以定制包括不同的显示选项和参数。
创建用户的下拉式HTML内容。
该内容可以被显示,默认情况下是这样的,或者通过设置’echo’参数来检索。包括”和”排除”参数不需要使用。
不需要使用;在这种情况下,所有的用户都会被显示。只能使用一个,要么’包括’要么’排除’,但不能同时使用。
可用的参数如下:
function wp_dropdown_users( $args = '' ) {
$defaults = array(
'show_option_all' => '',
'show_option_none' => '',
'hide_if_only_one_author' => '',
'orderby' => 'display_name',
'order' => 'ASC',
'include' => '',
'exclude' => '',
'multi' => 0,
'show' => 'display_name',
'echo' => 1,
'selected' => 0,
'name' => 'user',
'class' => '',
'id' => '',
'blog_id' => get_current_blog_id(),
'who' => '',
'include_selected' => false,
'option_none_value' => -1,
'role' => '',
'role__in' => array(),
'role__not_in' => array(),
'capability' => '',
'capability__in' => array(),
'capability__not_in' => array(),
);
$defaults['selected'] = is_author() ? get_query_var( 'author' ) : 0;
$parsed_args = wp_parse_args( $args, $defaults );
$query_args = wp_array_slice_assoc(
$parsed_args,
array(
'blog_id',
'include',
'exclude',
'orderby',
'order',
'who',
'role',
'role__in',
'role__not_in',
'capability',
'capability__in',
'capability__not_in',
)
);
$fields = array( 'ID', 'user_login' );
$show = ! empty( $parsed_args['show'] ) ? $parsed_args['show'] : 'display_name';
if ( 'display_name_with_login' === $show ) {
$fields[] = 'display_name';
} else {
$fields[] = $show;
}
$query_args['fields'] = $fields;
$show_option_all = $parsed_args['show_option_all'];
$show_option_none = $parsed_args['show_option_none'];
$option_none_value = $parsed_args['option_none_value'];
/**
* Filters the query arguments for the list of users in the dropdown.
*
* @since 4.4.0
*
* @param array $query_args The query arguments for get_users().
* @param array $parsed_args The arguments passed to wp_dropdown_users() combined with the defaults.
*/
$query_args = apply_filters( 'wp_dropdown_users_args', $query_args, $parsed_args );
$users = get_users( $query_args );
$output = '';
if ( ! empty( $users ) && ( empty( $parsed_args['hide_if_only_one_author'] ) || count( $users ) > 1 ) ) {
$name = esc_attr( $parsed_args['name'] );
if ( $parsed_args['multi'] && ! $parsed_args['id'] ) {
$id = '';
} else {
$id = $parsed_args['id'] ? " id='" . esc_attr( $parsed_args['id'] ) . "'" : " id='$name'";
}
$output = "<select name='{$name}'{$id} class='" . $parsed_args['class'] . "'>n";
if ( $show_option_all ) {
$output .= "t<option value='0'>$show_option_all</option>n";
}
if ( $show_option_none ) {
$_selected = selected( $option_none_value, $parsed_args['selected'], false );
$output .= "t<option value='" . esc_attr( $option_none_value ) . "'$_selected>$show_option_none</option>n";
}
if ( $parsed_args['include_selected'] && ( $parsed_args['selected'] > 0 ) ) {
$found_selected = false;
$parsed_args['selected'] = (int) $parsed_args['selected'];
foreach ( (array) $users as $user ) {
$user->ID = (int) $user->ID;
if ( $user->ID === $parsed_args['selected'] ) {
$found_selected = true;
}
}
if ( ! $found_selected ) {
$selected_user = get_userdata( $parsed_args['selected'] );
if ( $selected_user ) {
$users[] = $selected_user;
}
}
}
foreach ( (array) $users as $user ) {
if ( 'display_name_with_login' === $show ) {
/* translators: 1: User's display name, 2: User login. */
$display = sprintf( _x( '%1$s (%2$s)', 'user dropdown' ), $user->display_name, $user->user_login );
} elseif ( ! empty( $user->$show ) ) {
$display = $user->$show;
} else {
$display = '(' . $user->user_login . ')';
}
$_selected = selected( $user->ID, $parsed_args['selected'], false );
$output .= "t<option value='$user->ID'$_selected>" . esc_html( $display ) . "</option>n";
}
$output .= '</select>';
}
/**
* Filters the wp_dropdown_users() HTML output.
*
* @since 2.3.0
*
* @param string $output HTML output generated by wp_dropdown_users().
*/
$html = apply_filters( 'wp_dropdown_users', $output );
if ( $parsed_args['echo'] ) {
echo $html;
}
return $html;
}
常见问题
FAQs-
如何使用get_users获取所有用户列表?
要使用`
get_users`函数获取所有用户列表,可以按照以下步骤进行:1. 使用`
get_users`函数调用获取用户列表:$users = get_users();
2. 您可以按需使用参数来过滤结果。例如,您可以通过角色、用户ID、用户登录名等过滤用户列表。以下是一个根据用户角色为过滤条件的示例:
$users = get_users( array( 'role' => 'subscriber' // 将角色名称替换为您要过滤的角色 ) );在上述示例中,将`
role`参数设置为所需的角色名称来过滤用户列表。3. 您可以使用循环遍历获取的用户列表,并访问每个用户的属性。例如,以下示例将显示每个用户的用户名和电子邮件地址:
foreach( $users as $user ) { echo '用户名:' . $user->user_login . ', 电子邮件:' . $user->user_email . ; }在上述示例中,通过`
$user->user_login`和`$user->user_email`访问每个用户的用户名和电子邮件地址。请注意,`
get_users`函数默认返回所有用户,并可以根据需要使用更多参数进行过滤。您可以参阅WordPress官方文档中的`get_users`函数文档,了解更多可用参数和用法示例。总结起来,使用`
get_users`函数获取所有用户列表的步骤是:- 调用`
get_users`函数获取用户列表。 - 使用可选的过滤参数,根据需要过滤用户列表。
- 使用循环遍历用户列表,并访问每个用户的属性。
- 调用`
-
如何使用WP_PLUGIN_DIR和WP_PLUGIN_URL定义插件的目录和URL?
在WordPress中,可以使用WP_PLUGIN_DIR和WP_PLUGIN_URL常量来定义插件的目录路径和URL。
1. `WP_PLUGIN_DIR`:这是一个常量,用于定义插件的目录路径(文件系统路径)。您可以使用以下代码在插件文件中访问该常量:
$plugin_dir = WP_PLUGIN_DIR . '/your-plugin-folder/';
在上述代码中,将"your-plugin-folder"替换为您插件的实际文件夹名称。使用该常量,您可以获取插件文件的完整路径。
2. `WP_PLUGIN_URL`:这是一个常量,用于定义插件的URL(用于在网页上访问插件文件)。以下是一个使用该常量的示例:
$plugin_url = WP_PLUGIN_URL . '/your-plugin-folder/';
同样,请将"your-plugin-folder"替换为您插件的实际文件夹名称。使用该常量,您可以获取插件在网页上的完整URL。
请注意,`WP_PLUGIN_DIR`和`WP_PLUGIN_URL`常量在WordPress版本2.6之后引入。从WordPress 5.5版本开始,这两个常量被标记为过时(deprecated),因为WordPress更倾向于使用新的插件文件结构。如果您正在开发新插件,建议使用新的插件文件结构和相关函数。
在新的插件文件结构中,可以使用以下函数来获取插件的目录路径和URL:
- `plugin_dir_path()`:获取插件目录路径。
- `plugin_dir_url()`:获取插件URL。这些函数会自动将插件的版本、多站点和SSL等考虑因素纳入计算。
总结起来,使用`WP_PLUGIN_DIR`和`WP_PLUGIN_URL`常量定义插件的目录和URL的方法是:
$plugin_dir = WP_PLUGIN_DIR . '/your-plugin-folder/'; $plugin_url = WP_PLUGIN_URL . '/your-plugin-folder/';
但请注意,这两个常量已被标记为过时,建议使用新的插件文件结构和相关函数来获取插件的路径和URL。
-
如何使用PHP在WordPress中添加自定义功能?
使用PHP在WordPress中添加自定义功能可以通过以下方式实现:
- 创建一个自定义插件,将功能代码添加到插件中。
- 使用WordPress的钩子系统,将自定义功能绑定到适当的钩子上。
- 在主题文件中添加自定义功能代码,例如functions.php文件。
- 使用WordPress的短代码功能,将自定义功能封装为短代码。
- 使用WordPress的插件或主题编辑器,将自定义功能代码添加到适当的位置。
下面是一个实操示例。
要在WordPress中添加自定义功能,可以按照以下步骤使用PHP编写并添加自定义功能:
- 打开WordPress安装目录中的主题文件夹,通常位于wp-content/themes/下,找到正在使用的主题文件夹。
- 在主题文件夹中,可以创建一个名为functions.php的文件。如果该文件已经存在,可以直接编辑它。
- 在functions.php文件中,可以使用PHP代码添加自定义功能。以下是一些常见的示例:
// 添加自定义功能示例 // 1. 创建自定义短代码 function custom_shortcode() { return '这是我的自定义短代码内容'; } add_shortcode('custom', 'custom_shortcode'); // 2. 自定义小工具 function custom_widget() { echo '这是我的自定义小工具内容'; } register_widget('custom_widget'); // 3. 自定义菜单 function custom_menu() { register_nav_menu('custom-menu', '自定义菜单'); } add_action('after_setup_theme', 'custom_menu'); // 4. 自定义页面模板 function custom_page_template() { /* Template Name: 自定义模板 */ // 自定义模板的内容和样式 } - 编辑完functions.php文件后,保存并上传到WordPress主题文件夹中。
请注意,修改主题文件可以在主题更新时丢失,因此建议在进行任何更改之前备份functions.php文件。此外,为避免不必要的错误和冲突,建议在添加自定义功能前先了解WordPress开发文档和最佳实践,以确保正确、安全地实现所需的自定义功能。
-
如何进行WordPress数据库查询优化?
-
如何使用do_action来触发一个钩子函数?
使用
do_action函数可以触发一个钩子函数。do_action函数的参数与要触发的钩子函数的参数相同。例如,触发save_post钩子函数的代码如下:
do_action( 'save_post', $post_ID, $post );
这里,
$post_ID和$post是传递给钩子函数的参数。 -
如何使用wp_get_current_user获取当前登录用户的信息?
使用
wp_get_current_user获取当前登录用户的信息:$current_user = wp_get_current_user(); // 获取当前用户的ID $user_id = $current_user->ID; // 获取当前用户的用户名 $user_login = $current_user->user_login; // 获取当前用户的邮箱 $user_email = $current_user->user_email; // 获取当前用户的显示名称 $display_name = $current_user->display_name;
