WordPress REST API 定制化输出

WordPress 自4.7 版本后与时俱进推出了REST API,如此一来想象空间又扩展了许多,如今WordPress 可以完全作为后端数据驱动了。本文通过几个例子展示如何定制化输出WordPress REST API 的相关数据。

文章数据(posts)禁止某些字段显示

默认的,当请求类似 your-site.com/wp-json/wp/v2/posts?per_page=5&page=1 的接口来获取文章列表,展示的不少字段对一般人来说是没有必要。

秉承“如无必要,勿增实体”的原则,减少请求时候的数据量,可以通过下面的代码移除:

// https://devework.com/wordpress-rest-api-dynamic-output.html function dw_rest_prepare_post( $data, $post, $request ) {   $_data = $data->data;   $params = $request->get_params();   // if ( ! isset( $params['id'] ) ) {   unset( $_data['excerpt'] );   unset( $_data['author'] );   unset( $_data['featured_media'] );   unset( $_data['format'] );   unset( $_data['ping_status'] );   unset( $_data['comment_status'] );   unset( $_data['sticky'] );   unset( $_data['template'] );   // }   $data->data = $_data;   return $data;   }   add_filter( 'rest_prepare_post', 'dw_rest_prepare_post', 10, 3 );

文章数据(posts)中输出 post meta 所有字段

可能考虑到数据隐私,文章数据(posts)默认并不显示post meta的相关字段,如果你需要输出对应文章下所有 post meta 字段,可以用下面的代码启用:

// https://devework.com/wordpress-rest-api-dynamic-output.html register_rest_field( 'post', 'metadata', array(   'get_callback' => function ( $data ) {   return get_post_meta( $data['id'], '', '' );   }, ));

输出 post meta 特定字段

接上,如果你在REST API 中仅仅想输出 post meta 特定字段而非全部,则通过类似下面代码:

// https://devework.com/wordpress-rest-api-dynamic-output.html function dw_rest_prepare_post( $data, $post, $request ) {   $_data = $data->data;   $params = $request->get_params();   $thumb = get_post_meta( $post->ID, 'thumb' );   if($thumb){   $_data['thumb_image'] = $thumb;   }   $data->data = $_data;   return $data;   }   add_filter( 'rest_prepare_post', 'dw_rest_prepare_post', 10, 3 );

上面的代码展示的是如何输出thumb 这个 post meta 字段,请按需使用。

借助 Nginx 控制 /wp-json 的访问

这个倒与WordPress 本身无关了,your-site.com/wp-json 的路由默认是所有人皆可访问。如果你基于服务器负载,或安全等方面考虑选择性输出,可以借助 Nginx 控制访问。先看下面的例子:

# https://devework.com/wordpress-rest-api-dynamic-output.html location /wp-json { if ($http_user_agent !~ '(iPhone|Android)'){ return 403; } try_files $uri $uri/ /index.php?$args; }

如果你熟悉Nginx 语法,就知道上面的代码实现了:除了iOS 跟Android 设备(通过判断请求头的UA 信息),其它访问 /wp-json 的路径均返回403 状态码。这在一定程度上起到了保护作用。

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

发表于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏北京马哥教育

像看电影一样看Python程序运行:Livepython

? 像看电影一样看Python程序运行 注意: Livepython目前是alpha版本的软件,它不会处理很多边缘情况,并且功能在将来也可能会改变 Live...

33260
来自专栏liukaili_666888999

测试人员怎样用TestFlight测试iOSBeta版本

15330
来自专栏LET

Web Workers实践(2)

18590
来自专栏Android自学

简单wordpress博客搭建从零开始全过程简单wordpress博客搭建从零开始全过程

20630
来自专栏服务端技术杂谈

Angular项目实践

今天主要和大家分享四个内容:第一,是为什么我们要选择 Angular;第二,是我们在使用 Angular 过程中总结的一些比较好的实践;第三,是怎样更好的组织项...

46670
来自专栏前端真相

浏览器存储之cookie

21470
来自专栏全栈

前端工程化(一)---工程目录搭建

13230
来自专栏哲学驱动设计

OEA 框架中集成的 RDLC 报表介绍

之前 OEA 一直用着一个 Delphi 开发的报表,所以两年来我一直就想在 OEA 中构建一个纯 .NET 的报表模块,但是一想到要开发复杂的报表引擎和设计器...

24860
来自专栏全华班

一款免费、开源,使用sprinbboot快速开发管理系统

BootDo是在SpringBoot基础上搭建的一个Java基础开发平台,MyBatis为数据访问层,ApacheShiro为权限授权层,Ehcahe对常用数据...

1.9K10
来自专栏更流畅、简洁的软件开发方式

【自然框架】之通用权限(九):权限的验证

继续,这是第九章了。本来这张应该好好写的,不过还是先简单介绍一下吧,以后有空再补上详细说明吧。 通用权限想要写的文章目录:(这是第九章) 1、 简介、数据库的总...

22490

扫码关注云+社区

领取腾讯云代金券