WordPress.org

Make WordPress Core


Ignore:
Timestamp:
12/02/2016 10:17:36 PM (3 years ago)
Author:
rachelbaker
Message:

REST API: Fix handling of some orderby parameters for the Posts controller.

  • 'orderby' => 'include' requires an array of post_ids via the include collection param.

'orderby' => 'id' and 'orderby' => 'slug' need map the correct WP_Query equivalents.

Props flixos90, hnle, dd32, rachelbaker, joehoyle, pento.

Fixes #38971.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php

    r39353 r39440  
    149149        }
    150150
     151        // Ensure an include parameter is set in case the orderby is set to 'include'.
     152        if ( ! empty( $request['orderby'] ) && 'include' === $request['orderby'] && empty( $request['include'] ) ) {
     153            return new WP_Error( 'rest_orderby_include_missing_include', sprintf( __( 'Missing parameter(s): %s' ), 'include' ), array( 'status' => 400 ) );
     154        }
     155
    151156        // Retrieve the list of registered collection query parameters.
    152157        $registered = $this->get_collection_params();
     
    837842        }
    838843
    839         if ( 'include' === $query_args['orderby'] ) {
    840             $query_args['orderby'] = 'post__in';
     844        // Map to proper WP_Query orderby param.
     845        if ( isset( $query_args['orderby'] ) && isset( $request['orderby'] ) ) {
     846            $orderby_mappings = array(
     847                'id'      => 'ID',
     848                'include' => 'post__in',
     849                'slug'    => 'post_name',
     850            );
     851
     852            if ( isset( $orderby_mappings[ $request['orderby'] ] ) ) {
     853                $query_args['orderby'] = $orderby_mappings[ $request['orderby'] ];
     854            }
    841855        }
    842856
Note: See TracChangeset for help on using the changeset viewer.