Skip to content

Add multiple orderby support to REST Posts Controller #1186

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
gwwar wants to merge 1 commit into from
Closed

Add multiple orderby support to REST Posts Controller #1186

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
141 changes: 119 additions & 22 deletions src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -198,8 +198,24 @@ public function check_password_required( $required, $post ) {
*/
public function get_items( $request ) {

// Process orderby first, to allow for an early exit when a request is a client error (400)
$orderby_keys = array();
if ( isset( $request['orderby'] ) ) {
// The orderby query string parameter can look like ?orderby=menu_order, ?orderby[]=menu_order, or ?orderby[menu_order]=asc.
if ( rest_is_array( $request['orderby'] ) ) {
// An array: ?orderby[]=menu_order
// A fake array: ?orderby=menu_order,title
// A string: ?orderby=menu_order
// The latter two because rest_is_array() and rest_sanitize_array() pass scalars through wp_parse_list()
$orderby_keys = $request['orderby'];
} else {
// An object: ?orderby[menu_order]=asc
$orderby_keys = array_keys( $request['orderby'] );
}
}

// Ensure a search string is set in case the orderby is set to 'relevance'.
if ( ! empty( $request['orderby'] ) && 'relevance' === $request['orderby'] && empty( $request['search'] ) ) {
if ( ! empty( $request['orderby'] ) && in_array( 'relevance', $orderby_keys, true ) && empty( $request['search'] ) ) {
return new WP_Error(
'rest_no_search_term_defined',
__( 'You need to define a search term to order by relevance.' ),
Expand All @@ -208,7 +224,7 @@ public function get_items( $request ) {
}

// Ensure an include parameter is set in case the orderby is set to 'include'.
if ( ! empty( $request['orderby'] ) && 'include' === $request['orderby'] && empty( $request['include'] ) ) {
if ( ! empty( $request['orderby'] ) && in_array( 'include', $orderby_keys, true ) && empty( $request['include'] ) ) {
return new WP_Error(
'rest_orderby_include_missing_include',
__( 'You need to define an include parameter to order by include.' ),
Expand Down Expand Up @@ -1072,16 +1088,50 @@ protected function prepare_items_query( $prepared_args = array(), $request = nul
}

// Map to proper WP_Query orderby param.
if ( isset( $query_args['orderby'] ) && isset( $request['orderby'] ) ) {
if ( isset( $query_args['orderby'] ) ) {
$orderby_mappings = array(
'id' => 'ID',
'include' => 'post__in',
'slug' => 'post_name',
'include_slugs' => 'post_name__in',
);

if ( isset( $orderby_mappings[ $request['orderby'] ] ) ) {
$query_args['orderby'] = $orderby_mappings[ $request['orderby'] ];
// The orderby query string parameter can look like ?orderby=menu_order, ?orderby[]=menu_order, or ?orderby[menu_order]=asc.
if ( rest_is_array( $query_args['orderby'] ) ) {
// An array: ?orderby[]=menu_order
// A fake array: ?orderby=menu_order,title
// A string: ?orderby=menu_order
// The latter two because rest_is_array() and rest_sanitize_array() pass scalars through wp_parse_list()
$orderby_mappings_in_request = array_intersect_key( $orderby_mappings, array_flip( $query_args['orderby'] ) );

$new_arg = array();
// Remaps values. Preserves value order.
foreach ( $query_args['orderby'] as $orderby ) {
if ( array_key_exists( $orderby, $orderby_mappings_in_request ) ) {
$new_arg[] = $orderby_mappings_in_request[ $orderby ];
} else {
$new_arg[] = $orderby;
}
}

// WP_Query expects a space separated list.
$query_args['orderby'] = join( ' ', $new_arg );
} else {
// An object: ?orderby[menu_order]=asc
$orderby_mappings_in_request = array_intersect_key( $orderby_mappings, $query_args['orderby'] );

$new_arg = array();
// Remaps keys. Preserves key order.
foreach ( $query_args['orderby'] as $orderby => $order ) {
if ( array_key_exists( $orderby, $orderby_mappings_in_request ) ) {
$new_arg[ $orderby_mappings_in_request[ $orderby ] ] = $order;
} else {
$new_arg[ $orderby ] = $order;
}
}

// WP_Query expects an array with orderby (database table column) keys and order ("asc", "desc") values.
$query_args['orderby'] = $new_arg;
}
}

Expand Down Expand Up @@ -2794,28 +2844,75 @@ public function get_collection_params() {
'enum' => array( 'asc', 'desc' ),
);

$query_params['orderby'] = array(
'description' => __( 'Sort collection by post attribute.' ),
'type' => 'string',
'default' => 'date',
'enum' => array(
'author',
'date',
'id',
'include',
'modified',
'parent',
'relevance',
'slug',
'include_slugs',
'title',
),
$orderby_enum = array(
'author',
'date',
'id',
'include',
'modified',
'parent',
'relevance',
'slug',
'include_slugs',
'title',
);

if ( 'page' === $this->post_type || post_type_supports( $this->post_type, 'page-attributes' ) ) {
$query_params['orderby']['enum'][] = 'menu_order';
$orderby_enum[] = 'menu_order';
}

$query_params['orderby'] = array(
'description' => __( 'Sort collection by post attribute.' ),
'type' => array( 'string', 'array', 'object' ),
'anyOf' => array(
// ?orderby[]=date&orderby[]=title OR ?orderby=date,title
array(
'type' => 'array',
'items' => array(
'type' => 'string',
'enum' => $orderby_enum,
),
),
/* The string case *must* come after the array case above.
* anyOf will use the first schema that validates, and the array case above will
* correctly validate ?orderby=date and ?orderby=date,title, which both look like
* strings but are handled as arrays since rest_is_array() and rest_sanitize_array()
* will pass scalars through wp_parse_list().
*
* If the string case were first, we'd need more complex logic in ->get_items() and
* ->prepare_items_query().
*
* This string case, then, is never used and is here only for documentation in the
* schema.
*
* Note that oneOf may seem more natural than anyOf here, but, because of this string
* parsing behavior of the array case, string inputs match both the array case and the
* string case.
*/
// ?orderby=date
array(
'type' => 'string',
'enum' => $orderby_enum,
),
// ?orderby[date]=desc&orderby[title]=desc
array(
'type' => 'object',
'properties' => array_fill_keys(
$orderby_enum,
array(
'type' => 'string',
'enum' => array(
'asc',
'desc',
),
)
),
'additionalProperties' => false,
),
),
'default' => 'date',
);

$post_type = get_post_type_object( $this->post_type );

if ( $post_type->hierarchical || 'attachment' === $this->post_type ) {
Expand Down
Loading