| [ Index ] |
PHP Cross Reference of WordPress |
[Source view] [Print] [Project Stats]
User API: WP_User_Query class
| File Size: | 1093 lines (39 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
WP_User_Query:: (16 methods):
__construct()
fill_query_vars()
prepare_query()
query()
get()
set()
get_search_sql()
get_results()
get_total()
parse_orderby()
parse_order()
__get()
__set()
__isset()
__unset()
__call()
Class: WP_User_Query - X-Ref
Core class used for querying users.| __construct( $query = null ) X-Ref |
| PHP5 constructor. param: null|string|array $query Optional. The query variables. since: 3.1.0 |
| fill_query_vars( $args ) X-Ref |
| Fills in missing query variables with default values. return: array Complete query variables with undefined ones filled in with defaults. param: array $args Query vars, as passed to `WP_User_Query`. since: 4.4.0 |
| prepare_query( $query = array() X-Ref |
| Prepares the query variables. param: string|array $query { since: 3.1.0 since: 4.1.0 Added the ability to order by the `include` value. since: 4.2.0 Added 'meta_value_num' support for `$orderby` parameter. Added multi-dimensional array syntax since: 4.3.0 Added 'has_published_posts' parameter. since: 4.4.0 Added 'paged', 'role__in', and 'role__not_in' parameters. The 'role' parameter was updated to since: 4.7.0 Added 'nicename', 'nicename__in', 'nicename__not_in', 'login', 'login__in', 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. |
| query() X-Ref |
| Executes the query, with the current variables. since: 3.1.0 |
| get( $query_var ) X-Ref |
| Retrieves query variable. return: mixed param: string $query_var Query variable key. since: 3.5.0 |
| set( $query_var, $value ) X-Ref |
| Sets query variable. param: string $query_var Query variable key. param: mixed $value Query variable value. since: 3.5.0 |
| get_search_sql( $search, $columns, $wild = false ) X-Ref |
| Used internally to generate an SQL string for searching across multiple columns. return: string param: string $search Search string. param: string[] $columns Array of columns to search. param: bool $wild Whether to allow wildcard searches. Default is false for Network Admin, true for single site. since: 3.1.0 |
| get_results() X-Ref |
| Returns the list of users. return: array Array of results. since: 3.1.0 |
| get_total() X-Ref |
| Returns the total number of users for the current query. return: int Number of total users. since: 3.1.0 |
| parse_orderby( $orderby ) X-Ref |
| Parses and sanitizes 'orderby' keys passed to the user query. return: string Value to used in the ORDER clause, if `$orderby` is valid. param: string $orderby Alias for the field to order by. since: 4.2.0 |
| parse_order( $order ) X-Ref |
| Parses an 'order' query variable and casts it to ASC or DESC as necessary. return: string The sanitized 'order' query variable. param: string $order The 'order' query variable. since: 4.2.0 |
| __get( $name ) X-Ref |
| Makes private properties readable for backward compatibility. return: mixed Property. param: string $name Property to get. since: 4.0.0 |
| __set( $name, $value ) X-Ref |
| Makes private properties settable for backward compatibility. return: mixed Newly-set property. param: string $name Property to check if set. param: mixed $value Property value. since: 4.0.0 |
| __isset( $name ) X-Ref |
| Makes private properties checkable for backward compatibility. return: bool Whether the property is set. param: string $name Property to check if set. since: 4.0.0 |
| __unset( $name ) X-Ref |
| Makes private properties un-settable for backward compatibility. param: string $name Property to unset. since: 4.0.0 |
| __call( $name, $arguments ) X-Ref |
| Makes private/protected methods readable for backward compatibility. return: mixed Return value of the callback, false otherwise. param: string $name Method to call. param: array $arguments Arguments to pass when calling. since: 4.0.0 |
| Generated: Sat Apr 27 01:00:02 2024 | Cross-referenced by PHPXref 0.7.1 |