mirror of
https://github.com/WordPress/WordPress.git
synced 2024-12-22 17:18:32 +01:00
Docs: Add a note that the who parameter in WP_User_Query is deprecated.
Any usage of `'who' => 'authors'` should be updated to use capability queries instead. Includes documenting the capability query parameters in `wp_dropdown_users()`. Follow-up to [51943]. Props kkmuffme, swissspidy, SergeyBiryukov. See #61243. Built from https://develop.svn.wordpress.org/trunk@58172 git-svn-id: http://core.svn.wordpress.org/trunk@57635 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Sergey Biryukov
parent
ff2929bf19
commit
e59e190855
@ -142,6 +142,7 @@ class WP_User_Query {
|
||||
* @since 5.1.0 Introduced the 'meta_compare_key' parameter.
|
||||
* @since 5.3.0 Introduced the 'meta_type_key' parameter.
|
||||
* @since 5.9.0 Added 'capability', 'capability__in', and 'capability__not_in' parameters.
|
||||
* Deprecated the 'who' parameter.
|
||||
* @since 6.3.0 Added 'cache_results' parameter.
|
||||
*
|
||||
* @global wpdb $wpdb WordPress database abstraction object.
|
||||
@ -151,13 +152,13 @@ class WP_User_Query {
|
||||
* Optional. Array or string of query parameters.
|
||||
*
|
||||
* @type int $blog_id The site ID. Default is the current site.
|
||||
* @type string|string[] $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.
|
||||
* @type string|string[] $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.
|
||||
* @type string|string[] $meta_key Meta key or keys to filter by.
|
||||
* @type string|string[] $meta_value Meta value or values to filter by.
|
||||
* @type string $meta_compare MySQL operator used for comparing the meta value.
|
||||
@ -170,19 +171,19 @@ class WP_User_Query {
|
||||
* See WP_Meta_Query::__construct() for accepted values and default value.
|
||||
* @type array $meta_query An associative array of WP_Meta_Query arguments.
|
||||
* See WP_Meta_Query::__construct() for accepted values.
|
||||
* @type string|string[] $capability An array or a comma-separated list of capability names that users must match
|
||||
* to be included in results. Note that this is an inclusive list: users
|
||||
* must match *each* capability.
|
||||
* Does NOT work for capabilities not in the database or filtered via {@see 'map_meta_cap'}.
|
||||
* Default empty.
|
||||
* @type string[] $capability__in An array of capability names. Matched users must have at least one of these
|
||||
* capabilities.
|
||||
* Does NOT work for capabilities not in the database or filtered via {@see 'map_meta_cap'}.
|
||||
* Default empty array.
|
||||
* @type string[] $capability__not_in An array of capability names to exclude. Users matching one or more of these
|
||||
* capabilities will not be included in results.
|
||||
* Does NOT work for capabilities not in the database or filtered via {@see 'map_meta_cap'}.
|
||||
* Default empty array.
|
||||
* @type string|string[] $capability An array or a comma-separated list of capability names that users
|
||||
* must match to be included in results. Note that this is
|
||||
* an inclusive list: users must match *each* capability.
|
||||
* Does NOT work for capabilities not in the database or filtered
|
||||
* via {@see 'map_meta_cap'}. Default empty.
|
||||
* @type string[] $capability__in An array of capability names. Matched users must have at least one
|
||||
* of these capabilities.
|
||||
* Does NOT work for capabilities not in the database or filtered
|
||||
* via {@see 'map_meta_cap'}. Default empty array.
|
||||
* @type string[] $capability__not_in An array of capability names to exclude. Users matching one or more
|
||||
* of these capabilities will not be included in results.
|
||||
* Does NOT work for capabilities not in the database or filtered
|
||||
* via {@see 'map_meta_cap'}. Default empty array.
|
||||
* @type int[] $include An array of user IDs to include. Default empty array.
|
||||
* @type int[] $exclude An array of user IDs to exclude. Default empty array.
|
||||
* @type string $search Search keyword. Searches for possible string matches on columns.
|
||||
@ -242,7 +243,8 @@ class WP_User_Query {
|
||||
* - 'all' for all fields and loads user meta.
|
||||
* - 'all_with_meta' Deprecated. Use 'all'.
|
||||
* Default 'all'.
|
||||
* @type string $who Type of users to query. Accepts 'authors'.
|
||||
* @type string $who Deprecated, use `$capability` instead.
|
||||
* Type of users to query. Accepts 'authors'.
|
||||
* Default empty (all users).
|
||||
* @type bool|string[] $has_published_posts Pass an array of post types to filter results to users who have
|
||||
* published posts in those post types. `true` is an alias for all
|
||||
|
||||
@ -1540,7 +1540,9 @@ function setup_userdata( $for_user_id = 0 ) {
|
||||
*
|
||||
* @since 2.3.0
|
||||
* @since 4.5.0 Added the 'display_name_with_login' value for 'show'.
|
||||
* @since 4.7.0 Added the `$role`, `$role__in`, and `$role__not_in` parameters.
|
||||
* @since 4.7.0 Added the 'role', 'role__in', and 'role__not_in' parameters.
|
||||
* @since 5.9.0 Added the 'capability', 'capability__in', and 'capability__not_in' parameters.
|
||||
* Deprecated the 'who' parameter.
|
||||
*
|
||||
* @param array|string $args {
|
||||
* Optional. Array or string of arguments to generate a drop-down of users.
|
||||
@ -1550,7 +1552,7 @@ function setup_userdata( $for_user_id = 0 ) {
|
||||
* 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_none when no users
|
||||
* @type int|string $option_none_value Value to use for `$show_option_none` 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.
|
||||
@ -1576,18 +1578,32 @@ function setup_userdata( $for_user_id = 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 $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.
|
||||
* @type string $who Deprecated, use `$capability` instead.
|
||||
* Which type of users to query. Accepts only an empty string or
|
||||
* 'authors'. Default empty (all users).
|
||||
* @type string|string[] $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.
|
||||
* @type string|string[] $capability An array or a comma-separated list of capability names that users
|
||||
* must match to be included in results. Note that this is
|
||||
* an inclusive list: users must match *each* capability.
|
||||
* Does NOT work for capabilities not in the database or filtered
|
||||
* via {@see 'map_meta_cap'}. Default empty.
|
||||
* @type string[] $capability__in An array of capability names. Matched users must have at least one
|
||||
* of these capabilities.
|
||||
* Does NOT work for capabilities not in the database or filtered
|
||||
* via {@see 'map_meta_cap'}. Default empty array.
|
||||
* @type string[] $capability__not_in An array of capability names to exclude. Users matching one or more
|
||||
* of these capabilities will not be included in results.
|
||||
* Does NOT work for capabilities not in the database or filtered
|
||||
* via {@see 'map_meta_cap'}. Default empty array.
|
||||
* }
|
||||
* @return string HTML dropdown list of users.
|
||||
*/
|
||||
|
||||
@ -16,7 +16,7 @@
|
||||
*
|
||||
* @global string $wp_version
|
||||
*/
|
||||
$wp_version = '6.6-alpha-58171';
|
||||
$wp_version = '6.6-alpha-58172';
|
||||
|
||||
/**
|
||||
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.
|
||||
|
||||
Loading…
Reference in New Issue
Block a user