Skip to content

Instantly share code, notes, and snippets.

@timrross
Last active June 6, 2022 19:51
Show Gist options
  • Star 2 You must be signed in to star a gist
  • Fork 1 You must be signed in to fork a gist
  • Save timrross/35c2e3d6521dcbbce46ad07f3074ae73 to your computer and use it in GitHub Desktop.
Save timrross/35c2e3d6521dcbbce46ad07f3074ae73 to your computer and use it in GitHub Desktop.
Enable orderby custom parameter in WP REST API
<?php
/**
* The filter is named rest_{post_type}_collection_params. So you need to hook a new filter for each
* of the custom post types you need to sort.
* @link https://www.timrosswebdevelopment.com/wordpress-rest-api-post-order/
*/
// This enables the orderby=menu_order for Posts
add_filter( 'rest_post_collection_params', 'filter_add_rest_orderby_params', 10, 1 );
// And this for a custom post type called 'portfolio'
add_filter( 'rest_portfolio_collection_params', 'filter_add_rest_orderby_params', 10, 1 );
/**
* Add menu_order to the list of permitted orderby values
*/
function filter_add_rest_orderby_params( $params ) {
$params['orderby']['enum'][] = 'menu_order';
return $params;
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment