WordPress REST API 定制化输出文章信息及自定义字段信息

WordPress需要提供了REST API,但是有时候并不能完全满足我们的需求,比如他会把文章里好多我们用不到的数据显示出来,同时还不能显示自定义字段的数据,那么这个时候我们就需要对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,$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',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 状态码。这在一定程度上起到了保护作用。

遵循类似的思路,也可以通过自定义http 请求头的方式,如:

if ($http_x_access_token != 'your-token'){

return 403;

}以上主要内容引自:https://devework.com/wordpress-rest-api-dynamic-output.html

相关文章

我想将wordpress的默认接口路由改掉,愿意是默认的带一个 wp...
wordpress自定义分类法之后,我看到链接都自动在后面添加了一...
事情是这样的,我用 get_post_type 函数创建了一个自定义分类...
最近网站莫名其妙的被顶上了,过一个多小时,就注册一个账号...
最近服务器要到期了,就想着把网站转移到另外一台服务器,本...
今天在写wordpress的接口,然后碰到个奇怪的问题,怎么访问都...