WP_User_Query
class WP_User_Query
// Constructor: function Object() { [native code] } Core class used for querying users.
Methods 17 methods
| Method / Return | Description |
|---|---|
| __construct() void | Constructor.
Parameters: $query: mixed |
| fill_query_vars() array | Fills in missing query variables with default values.
Parameters: $args: mixed |
| prepare_query() void | Prepares the query variables.
Parameters: $query: mixed |
| query() void | Executes the query, with the current variables. |
| get() mixed | Retrieves query variable.
Parameters: $query_var: mixed |
| set() void | Sets query variable.
Parameters: $query_var: mixed, $value: mixed |
| get_search_sql() string | Used internally to generate an SQL string for searching across multiple columns.
Parameters: $search: mixed, $columns: mixed, $wild: mixed |
| get_results() array | Returns the list of users. |
| get_total() int | Returns the total number of users for the current query. |
| parse_orderby() string | Parses and sanitizes 'orderby' keys passed to the user query.
Parameters: $orderby: mixed |
| generate_cache_key() string | Generate cache key.
Parameters: $args: array, $sql: mixed |
| parse_order() string | Parses an 'order' query variable and casts it to ASC or DESC as necessary.
Parameters: $order: mixed |
| __get() mixed | Makes private properties readable for backward compatibility.
Parameters: $name: mixed |
| __set() void | Makes private properties settable for backward compatibility.
Parameters: $name: mixed, $value: mixed |
| __isset() bool | Makes private properties checkable for backward compatibility.
Parameters: $name: mixed |
| __unset() void | Makes private properties un-settable for backward compatibility.
Parameters: $name: mixed |
| __call() mixed | Makes private/protected methods readable for backward compatibility.
Parameters: $name: mixed, $arguments: mixed |
Properties
| Property / Type | Description |
|---|---|
| $query_vars mixed public | No description available. |
| $results mixed public | No description available. |
| $total_users mixed public | No description available. |
| $meta_query mixed public | No description available. |
| $request mixed public | No description available. |
| $compat_fields mixed public | No description available. |
| $query_fields mixed public | No description available. |
| $query_from mixed public | No description available. |
| $query_where mixed public | No description available. |
| $query_orderby mixed public | No description available. |
| $query_limit mixed public | No description available. |