阐述 WordPress `rest_prepare_post` 过滤器源码：如何修改文章返回的 REST API 数据。 - 智猿学院-前后端，数据库，人工智能，云计算等领域前沿技术讲座

各位观众老爷，晚上好！我是你们的老朋友，今天咱们来聊聊WordPress REST API里一个非常有意思的过滤器：rest_prepare_post。想象一下，你辛辛苦苦写了篇文章，发布到WordPress网站上。现在，你想通过REST API把它取出来，展示在你的App里。但是，WordPress默认返回的数据格式可能不完全符合你的需求，比如你可能想：

增加一些自定义字段，比如阅读量、点赞数、是否是热门文章等等。
修改某些字段的值，比如把作者ID换成作者昵称。
过滤掉某些字段，比如隐藏文章的修改日期。

这时候，rest_prepare_post就派上大用场了！它可以让你在文章数据返回之前，对数据进行一番“美容”，让它更符合你的口味。

什么是rest_prepare_post？

简单来说，rest_prepare_post是一个过滤器钩子（Filter Hook），它允许你拦截并修改文章通过REST API返回的数据。它会在文章数据被序列化成JSON格式之前被调用，给你一个机会去“摆弄”这个数据。

源码分析：rest_prepare_post的工作原理

要理解rest_prepare_post，我们先来看看它的工作原理。虽然我们不能直接看到WordPress内核里它的源码（因为它是一个过滤器，不是一个函数），但是我们可以通过分析相关的代码来推断它的工作流程。

WordPress处理REST API请求： 当你发送一个GET请求到wp-json/wp/v2/posts时，WordPress会接收到这个请求，并开始处理。
获取文章数据： WordPress会查询数据库，获取到所有符合条件的文章数据。
准备数据： 接下来，WordPress会循环遍历每一篇文章，并为每一篇文章准备REST API的响应数据。在这个过程中，rest_prepare_post过滤器会被调用。
应用过滤器： WordPress会执行所有挂载到rest_prepare_post上的函数。这些函数接收文章数据作为参数，可以对数据进行修改，然后返回修改后的数据。
序列化数据： WordPress会将经过过滤器处理后的文章数据序列化成JSON格式。
返回响应： 最后，WordPress会将JSON数据作为REST API的响应返回给客户端。

rest_prepare_post的参数

rest_prepare_post过滤器接收三个参数：

$response: (WP_REST_Response) The response object. 这是一个包含了文章数据的对象。你可以通过 $response->get_data() 来获取数据，通过 $response->set_data() 来修改数据。
$post: (WP_Post) The original Post object. 这是原始的文章对象，包含了文章的所有信息，比如ID、标题、内容、作者等等。
$request: (WP_REST_Request) The request used to generate the response. 这是REST API的请求对象，包含了请求的所有信息，比如请求方法、请求参数等等。

如何使用rest_prepare_post？

要使用rest_prepare_post，你需要在你的主题或者插件的functions.php文件中添加一个函数，并将这个函数挂载到rest_prepare_post过滤器上。

add_filter( 'rest_prepare_post', 'my_custom_rest_prepare_post', 10, 3 );

function my_custom_rest_prepare_post( $response, $post, $request ) {
  // 在这里编写你的代码，修改文章数据
  return $response;
}

解释一下：

add_filter( 'rest_prepare_post', 'my_custom_rest_prepare_post', 10, 3 );：这行代码将my_custom_rest_prepare_post函数挂载到rest_prepare_post过滤器上。
- 'rest_prepare_post'：这是过滤器的名称。
- 'my_custom_rest_prepare_post'：这是你要执行的函数的名称。
- 10：这是优先级，数值越小，优先级越高。通常使用默认值10。
- 3：这是传递给函数的参数个数，这里是3个，对应$response, $post, $request。
function my_custom_rest_prepare_post( $response, $post, $request ) { ... }：这是你的自定义函数，用于修改文章数据。你可以在这里编写你的代码。 务必返回 $response 对象，否则REST API将无法正常工作。

实战演练：几个常用的修改技巧

现在，让我们来看几个常用的修改技巧，并通过代码示例来演示如何使用rest_prepare_post。

1. 添加自定义字段：阅读量

假设你想在文章的REST API响应中添加一个reading_count字段，表示文章的阅读量。你可以这样实现：

add_filter( 'rest_prepare_post', 'add_reading_count_to_post', 10, 3 );

function add_reading_count_to_post( $response, $post, $request ) {
  // 假设你已经有一个函数可以获取文章的阅读量
  $reading_count = get_post_reading_count( $post->ID );

  // 将阅读量添加到响应数据中
  $response->data['reading_count'] = (int) $reading_count; // 确保是整数类型

  return $response;
}

// 辅助函数，用于获取文章阅读量（这里只是一个示例，你需要根据你的实际情况来实现）
function get_post_reading_count( $post_id ) {
  // 假设你使用了一个自定义字段来存储文章阅读量
  $reading_count = get_post_meta( $post_id, 'reading_count', true );

  // 如果没有阅读量，则默认为0
  return empty( $reading_count ) ? 0 : $reading_count;
}

这段代码做了什么？

add_reading_count_to_post函数被挂载到rest_prepare_post过滤器上。
在add_reading_count_to_post函数中，我们首先调用get_post_reading_count函数来获取文章的阅读量。这个get_post_reading_count函数只是一个示例，你需要根据你的实际情况来实现它。比如，你可以从数据库中读取阅读量，或者从某个缓存中读取。
然后，我们将阅读量添加到$response->data数组中，键名为reading_count。注意，我们使用(int)将阅读量转换为整数类型。
最后，我们返回$response对象。

现在，当你通过REST API获取文章数据时，你会发现响应数据中多了一个reading_count字段，表示文章的阅读量。

2. 修改字段值：作者ID改为作者昵称

WordPress默认返回的作者ID是一个数字，不太直观。如果你想把作者ID替换成作者的昵称，可以这样实现：

add_filter( 'rest_prepare_post', 'replace_author_id_with_nickname', 10, 3 );

function replace_author_id_with_nickname( $response, $post, $request ) {
  // 获取作者ID
  $author_id = $response->data['author'];

  // 获取作者对象
  $author = get_user_by( 'id', $author_id );

  // 检查作者是否存在
  if ( $author ) {
    // 将作者昵称添加到响应数据中
    $response->data['author_nickname'] = $author->nickname;

    // 删除作者ID
    unset( $response->data['author'] );
  }

  return $response;
}

这段代码做了什么？

replace_author_id_with_nickname函数被挂载到rest_prepare_post过滤器上。
在replace_author_id_with_nickname函数中，我们首先从$response->data数组中获取作者ID。
然后，我们使用get_user_by函数来获取作者对象。
如果作者存在，我们将作者的昵称添加到$response->data数组中，键名为author_nickname。
最后，我们使用unset函数删除原来的作者ID。

现在，当你通过REST API获取文章数据时，你会发现响应数据中没有了author字段，而多了一个author_nickname字段，表示作者的昵称。

3. 过滤字段：隐藏文章修改日期

有时候，你可能不想在REST API响应中显示文章的修改日期。你可以这样实现：

add_filter( 'rest_prepare_post', 'hide_modified_date', 10, 3 );

function hide_modified_date( $response, $post, $request ) {
  // 删除修改日期
  unset( $response->data['modified'] );
  unset( $response->data['modified_gmt'] );

  return $response;
}

这段代码很简单，它直接从$response->data数组中删除了modified和modified_gmt字段。

更高级的用法：根据请求参数修改数据

$request参数包含了REST API的请求信息，你可以根据请求参数来修改文章数据。比如，你可以根据请求中是否包含show_full_content参数来决定是否返回完整的文章内容。

add_filter( 'rest_prepare_post', 'modify_content_based_on_request', 10, 3 );

function modify_content_based_on_request( $response, $post, $request ) {
  // 获取请求参数
  $params = $request->get_params();

  // 检查是否包含show_full_content参数，并且值为true
  if ( isset( $params['show_full_content'] ) && $params['show_full_content'] === 'true' ) {
    // 返回完整的文章内容
    $response->data['content']['rendered'] = apply_filters( 'the_content', $post->post_content );
  } else {
    // 返回文章摘要
    $response->data['content']['rendered'] = wp_trim_words( $post->post_content, 50 );
  }

  return $response;
}

这段代码做了什么？

modify_content_based_on_request函数被挂载到rest_prepare_post过滤器上。
在modify_content_based_on_request函数中，我们首先使用$request->get_params()来获取请求参数。
然后，我们检查请求参数中是否包含show_full_content参数，并且值为true。
如果条件成立，我们使用apply_filters( 'the_content', $post->post_content )来获取完整的文章内容。 apply_filters( 'the_content' )会应用所有挂载到the_content过滤器上的函数，比如自动段落、图片懒加载等等。
否则，我们使用wp_trim_words( $post->post_content, 50 )来获取文章摘要，只显示前50个单词。

现在，当你通过REST API获取文章数据时，你可以通过添加show_full_content=true参数来获取完整的文章内容，或者不添加该参数来获取文章摘要。

总结：rest_prepare_post的强大之处

rest_prepare_post过滤器是一个非常强大的工具，它可以让你灵活地修改WordPress REST API返回的文章数据。你可以使用它来：

添加自定义字段
修改字段值
过滤字段
根据请求参数修改数据

通过合理地使用rest_prepare_post，你可以定制出符合你需求的REST API，让你的App或者其他应用能够更好地与WordPress网站进行交互。

注意事项

性能： 修改REST API响应数据可能会影响性能，特别是当你的网站有大量的文章时。因此，你应该尽量避免在rest_prepare_post过滤器中执行复杂的逻辑。可以考虑使用缓存来提高性能。
数据类型： 确保你添加或者修改的字段的数据类型是正确的。比如，如果你要添加一个数字字段，你应该使用(int)或者(float)将值转换为数字类型。
版本兼容性： rest_prepare_post过滤器是在WordPress 4.7版本中引入的。如果你的网站需要支持更早的版本，你需要使用其他方法来修改REST API响应数据。

表格总结

功能	代码示例	说明
添加自定义字段：阅读量	`php $response->data['reading_count'] = (int) $reading_count;` \| 添加一个名为`reading_count`的自定义字段，值为文章的阅读量。务必转换为整数类型。
修改字段值：作者昵称	`php $response->data['author_nickname'] = $author->nickname; unset( $response->data['author'] );` \| 将作者ID替换为作者昵称。先添加`author_nickname`字段，然后删除原来的`author`字段。
过滤字段：隐藏修改日期	`php unset( $response->data['modified'] ); unset( $response->data['modified_gmt'] );` \| 删除`modified`和`modified_gmt`字段，隐藏文章的修改日期。
根据请求参数修改内容	`php if ( isset( $params['show_full_content'] ) && $params['show_full_content'] === 'true' ) { ... } else { ... }` \| 根据请求参数`show_full_content`的值，决定返回完整的文章内容还是文章摘要。利用`$request->get_params()`获取请求参数。
性能优化	考虑使用缓存	大量文章的情况下，修改REST API响应数据可能会影响性能。可以使用缓存来提高性能。
数据类型转换	`(int)`, `(float)`, `(string)`	确保添加或修改的字段的数据类型是正确的。
版本兼容性	WordPress 4.7+	`rest_prepare_post`过滤器是在WordPress 4.7版本中引入的。

希望今天的讲座对大家有所帮助。祝大家编程愉快！下次再见！

发表回复 取消回复

发表回复取消回复