Upstream/WordPress
1
0
Fork 0
mirror of https://github.com/WordPress/WordPress.git synced 2024-09-27 14:53:08 +02:00
Code Issues Projects Releases Wiki Activity

Improved 'orderby' meta syntax in WP_User_Query.

Browse Source 
Recent commits have added the ability to order query results by specific
clauses of the 'meta_query' parameter (comments [31467], posts [31312] and
[31340]). The current changeset ports the same functionality to `WP_User_Query`.

Also introduced is the ability to pass the value of `$meta_key` to 'orderby'.

The internals of `WP_User_Query::prepare_users()` had to be reordered
somewhat to support these changes, primarily to ensure that the `meta_query`
object generates its SQL clauses before the 'orderby' parameter is parsed.

See #31265.
Built from https://develop.svn.wordpress.org/trunk@31669


git-svn-id: http://core.svn.wordpress.org/trunk@31650 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Boone Gorges 2015-03-07 18:38:27 +00:00
parent 4e1a8b195f
commit f5513227db
2 changed files with 56 additions and 46 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

100
wp-includes/user.php
View File

@ -531,13 +531,14 @@ class WP_User_Query {
* column to search in based on search string. Default empty.
* @type array $search_columns Array of column names to be searched. Accepts 'ID', 'login',
* 'nicename', 'email', 'url'. Default empty array.
* @type string|array $orderby Field to sort the retrieved users by. May be a single value,
* @type string|array $orderby Field(s) to sort the retrieved users by. May be a single value,
* an array of values, or a multi-dimensional array with fields as keys
* and orders ('ASC' or 'DESC') as values. Accepted values are'ID',
* 'display_name' (or 'name'), 'user_login' (or 'login'),
* 'user_nicename' (or 'nicename'), 'user_email' (or 'email'),
* 'user_url' (or 'url'), 'user_registered' (or 'registered'),
* 'post_count', 'meta_value', or 'meta_value_num'. To use 'meta_value'
* 'post_count', 'meta_value', 'meta_value_num', the value of
* `$meta_key`, or an array key of `$meta_query`. To use 'meta_value'
* or 'meta_value_num', `$meta_key` must be also be defined.
* Default 'user_login'.
* @type string $order Designates ascending or descending order of users. Order values
@ -625,6 +626,52 @@ class WP_User_Query {
$include = false;
}
// Meta query.
$this->meta_query = new WP_Meta_Query();
$this->meta_query->parse_query_vars( $qv );
$blog_id = 0;
if ( isset( $qv['blog_id'] ) ) {
$blog_id = absint( $qv['blog_id'] );
}
$role = '';
if ( isset( $qv['role'] ) ) {
$role = trim( $qv['role'] );
}
if ( $blog_id && ( $role || is_multisite() ) ) {
$cap_meta_query = array();
$cap_meta_query['key'] = $wpdb->get_blog_prefix( $blog_id ) . 'capabilities';
if ( $role ) {
$cap_meta_query['value'] = '"' . $role . '"';
$cap_meta_query['compare'] = 'like';
}
if ( empty( $this->meta_query->queries ) ) {
$this->meta_query->queries = array( $cap_meta_query );
} elseif ( ! in_array( $cap_meta_query, $this->meta_query->queries, true ) ) {
// Append the cap query to the original queries and reparse the query.
$this->meta_query->queries = array(
'relation' => 'AND',
array( $this->meta_query->queries, $cap_meta_query ),
);
}
$this->meta_query->parse_query_vars( $this->meta_query->queries );
}
if ( ! empty( $this->meta_query->queries ) ) {
$clauses = $this->meta_query->get_sql( 'user', $wpdb->users, 'ID', $this );
$this->query_from .= $clauses['join'];
$this->query_where .= $clauses['where'];
if ( 'OR' == $this->meta_query->relation ) {
$this->query_fields = 'DISTINCT ' . $this->query_fields;
}
}
// sorting
$qv['order'] = isset( $qv['order'] ) ? strtoupper( $qv['order'] ) : '';
$order = $this->parse_order( $qv['order'] );
@ -728,10 +775,6 @@ class WP_User_Query {
$this->query_where .= $this->get_search_sql( $search, $search_columns, $wild );
}
$blog_id = 0;
if ( isset( $qv['blog_id'] ) )
$blog_id = absint( $qv['blog_id'] );
if ( isset( $qv['who'] ) && 'authors' == $qv['who'] && $blog_id ) {
$qv['meta_key'] = $wpdb->get_blog_prefix( $blog_id ) . 'user_level';
$qv['meta_value'] = 0;
@ -739,44 +782,6 @@ class WP_User_Query {
$qv['blog_id'] = $blog_id = 0; // Prevent extra meta query
}
$this->meta_query = new WP_Meta_Query();
$this->meta_query->parse_query_vars( $qv );
$role = '';
if ( isset( $qv['role'] ) )
$role = trim( $qv['role'] );
if ( $blog_id && ( $role || is_multisite() ) ) {
$cap_meta_query = array();
$cap_meta_query['key'] = $wpdb->get_blog_prefix( $blog_id ) . 'capabilities';
if ( $role ) {
$cap_meta_query['value'] = '"' . $role . '"';
$cap_meta_query['compare'] = 'like';
}
if ( empty( $this->meta_query->queries ) ) {
$this->meta_query->queries = array( $cap_meta_query );
} elseif ( ! in_array( $cap_meta_query, $this->meta_query->queries, true ) ) {
// Append the cap query to the original queries and reparse the query.
$this->meta_query->queries = array(
'relation' => 'AND',
array( $this->meta_query->queries, $cap_meta_query ),
);
}
$this->meta_query->parse_query_vars( $this->meta_query->queries );
}
if ( !empty( $this->meta_query->queries ) ) {
$clauses = $this->meta_query->get_sql( 'user', $wpdb->users, 'ID', $this );
$this->query_from .= $clauses['join'];
$this->query_where .= $clauses['where'];
if ( 'OR' == $this->meta_query->relation )
$this->query_fields = 'DISTINCT ' . $this->query_fields;
}
if ( ! empty( $include ) ) {
// Sanitized earlier.
$ids = implode( ',', $include );
@ -955,6 +960,8 @@ class WP_User_Query {
protected function parse_orderby( $orderby ) {
global $wpdb;
$meta_query_clauses = $this->meta_query->get_clauses();
$_orderby = '';
if ( in_array( $orderby, array( 'login', 'nicename', 'email', 'url', 'registered' ) ) ) {
$_orderby = 'user_' . $orderby;
@ -975,7 +982,7 @@ class WP_User_Query {
$_orderby = 'post_count';
} elseif ( 'ID' == $orderby || 'id' == $orderby ) {
$_orderby = 'ID';
} elseif ( 'meta_value' == $orderby ) {
} elseif ( 'meta_value' == $orderby || $this->get( 'meta_key' ) == $orderby ) {
$_orderby = "$wpdb->usermeta.meta_value";
} elseif ( 'meta_value_num' == $orderby ) {
$_orderby = "$wpdb->usermeta.meta_value+0";
@ -983,6 +990,9 @@ class WP_User_Query {
$include = wp_parse_id_list( $this->query_vars['include'] );
$include_sql = implode( ',', $include );
$_orderby = "FIELD( $wpdb->users.ID, $include_sql )";
} elseif ( isset( $meta_query_clauses[ $orderby ] ) ) {
$meta_clause = $meta_query_clauses[ $orderby ];
$_orderby = sprintf( "CAST(%s.meta_value AS %s)", esc_sql( $meta_clause['alias'] ), esc_sql( $meta_clause['cast'] ) );
}
return $_orderby;

2
wp-includes/version.php
View File

@ -4,7 +4,7 @@
*
* @global string $wp_version
*/
$wp_version = '4.2-alpha-31668';
$wp_version = '4.2-alpha-31669';
/**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.