WordPress REST API 自定义字段排序方法

前言:WordPress 小程序通过 REST API 接口实现网站数据与小程序连接。今天在搜索其他问题时无意中在 WordPress 智库网站看到这一篇内容,觉得对小程序 API 开发还是很有帮助的,特别是针对开源免费版插件,基本上都是使用 WordPress REST API 功能。对于自定义字段的查询和排序功能,很多时候不方便。不过,丸子小程序付费版小程序 API 插件已经通过自定义接口方式实现了类似的功能。转载这篇文章,提供给丸子小程序开源免费版插件 Mini Program API 进行二次开发或扩展做参考。

WP REST API 文章查询接受一个 orderby 参数,用来对文章进行排序,默认情况下,改参数的值可以是:author, date, id, include, modified, parent, relevance, slug, include_slugs, title,如果传入了这些值以外的参数,WP REST API 将会返回一个错误信息:


{
  "code": "rest_invalid_param",
  "message": "Invalid parameter(s): orderby",
  "data": {
    "status": 400,
    "params": {
      "orderby": "orderby is not one of author, date, id, include, modified, parent, relevance, slug, include_slugs, title."
    }
  }
}

幸运的是,我们可以使用一个 Filter 来为 orderby 参数增加允许使用的字段,这个 Filter 为:rest_ {post_type} _collection_params

为文章和自定义文章类型启用 menu_order 排序方式


// 此代码为文章启用orderby=menu_order排序方法
add_filter( 'rest_post_collection_params', 'filter_add_rest_orderby_params', 10, 1 );

// 此代码为 'portfolio' 文章类型启用orderby=menu_order排序方法
add_filter( 'rest_portfolio_collection_params', 'filter_add_rest_orderby_params', 10, 1 );

// 添加menu_order排序方法到 rest api 中
function filter_add_rest_orderby_params( $params ) {
    $params['orderby']['enum'][] = 'menu_order';
    return $params;
}

把上面的代码添加到主题或插件中之后,再使用我们添加的自定义参数来获取文章,WP REST API 就会根据我们的要求,返回符合我们预期的文章。

为文章添加按自定义字段排序方式

如果我们需要让文章按自定义字段方式进行排序,方法是类似的。下面的代码为 WP REST API 添加了 views、area、random 排序方式。


add_filter('rest_post_collection_params', function($params)
{
    $params[ 'orderby' ][ 'enum' ][] = 'views';
    $params[ 'orderby' ][ 'enum' ][] = 'area';
    $params[ 'orderby' ][ 'enum' ][] = 'random';

    return $params;
}, 10, 1);

只添加了排序方法还没用,我们还需要把按这些自定义参数排序的逻辑添加到 REST API 查询中,代码如下,从代码中可以看出,修改 REST API 查询的方法和自定义 WP_Query 的方法类似。


add_filter('rest_post_query', function ($query_vars, $request)
{
    $orderby = $request->get_param('orderby');

    if (isset($orderby) && $orderby === 'views') {
        $query_vars[ "orderby" ]  = "meta_value_num";
        $query_vars[ "meta_key" ] = "wl_pageviews";
    }

    if (isset($orderby) && $orderby === 'area') {
        $query_vars[ "orderby" ]  = "meta_value_num";
        $query_vars[ "meta_key" ] = "area";
    }

    if (isset($orderby) && $orderby === 'random') {
        $query_vars[ "orderby" ] = "random";
    }

    return $query_vars;
}, 10, 2);

通过以上方式实现了自定义字段排序,也相当于自定义字段文章查询,更多具体的实现方法,这里就不做过多介绍了,可以查看官方文档。

转载来源:WordPress 智库

腾讯云高性能云服务器

相关推荐

发表评论

微信扫一扫

微信扫一扫

微信扫一扫,分享到朋友圈

WordPress REST API 自定义字段排序方法
返回顶部

显示

忘记密码?

显示

显示

获取验证码

Close