晚上好，各位！今天咱们来聊聊 WordPress 里一个挺实用的小家伙——wp_remote_retrieve_body()。这名字听着就直接，翻译过来就是“从远程请求中捞出正文”。但别看它名字直白，用起来还是有些门道的。咱们今天就好好扒一扒它的源码，看看它到底是怎么工作的，以及我们在实际开发中怎么把它用得溜溜的。
一、先来点儿背景知识：HTTP 请求和响应
在深入 wp_remote_retrieve_body() 之前，咱们先简单回顾一下 HTTP 请求和响应的基本概念。这就像咱们平时点外卖，你发出的订单（请求），商家收到的订单（请求），商家做好了饭（响应正文），外卖小哥送到你手里（完整的响应）。
-
HTTP 请求（Request）： 客户端（比如你的浏览器或者 WordPress）向服务器发送的请求，包含了请求方法（GET, POST, PUT, DELETE 等）、URL、Headers 和 Body（可选）。
-
HTTP 响应（Response）： 服务器收到请求后，返回给客户端的响应，包含了状态码（200 OK, 404 Not Found, 500 Internal Server Error 等）、Headers 和 Body。
而 wp_remote_retrieve_body()，就像是你只想要外卖小哥手里的饭，不要餐盒、发票等等。它专门从 HTTP 响应中提取 Body 部分，也就是响应正文。
二、wp_remote_retrieve_body() 的源码剖析
好了，背景知识铺垫完毕，咱们正式开始“解剖” wp_remote_retrieve_body()。它的源码其实很简单，咱们直接上代码：
/**
* Retrieve the body from the raw response.
*
* @since 2.7.0
*
* @param array|WP_Error $response Response.
* @return string|null|WP_Error The body. Null on error, unless WP_Error is passed to the function.
*/
function wp_remote_retrieve_body( $response ) {
if ( is_wp_error( $response ) ) {
return $response;
}
if ( isset( $response['body'] ) ) {
return $response['body'];
}
return '';
}是不是比想象中要简单得多？ 别急，咱们一行一行地分析：
-
函数定义：
function wp_remote_retrieve_body( $response ) {定义了一个名为
wp_remote_retrieve_body()的函数，它接收一个参数$response。这个$response期望是一个数组或者WP_Error对象。 -
错误检查：
if ( is_wp_error( $response ) ) { return $response; }首先检查
$response是否是一个WP_Error对象。如果是，说明之前的 HTTP 请求出错了，直接把错误信息返回，避免后续操作引发更多问题。 这就像外卖小哥压根没送到，直接告诉你订单取消了。 -
提取 Body：
if ( isset( $response['body'] ) ) { return $response['body']; }如果
$response不是错误，就检查它是否包含'body'键。如果包含，就直接返回'body'键对应的值，也就是响应正文。 这就像外卖小哥终于把饭送到了，你直接把饭拿走。 -
默认返回值：
return '';如果
$response既不是错误，也不包含'body'键，那就返回一个空字符串。 这就像外卖小哥来了，但是饭没了，他总得给你个说法，所以给了你一个空的餐盒。
三、wp_remote_retrieve_body() 的使用场景
现在我们知道了 wp_remote_retrieve_body() 的原理，接下来看看它在哪些场景下能发挥作用。
-
获取远程 API 的数据：
这是
wp_remote_retrieve_body()最常见的用途。比如，你想从某个 API 接口获取 JSON 数据，就可以使用wp_remote_get()或者wp_remote_post()发起请求，然后用wp_remote_retrieve_body()提取 JSON 数据。$response = wp_remote_get( 'https://api.example.com/data' ); if ( is_wp_error( $response ) ) { // 处理错误 $error_message = $response->get_error_message(); echo "Something went wrong: $error_message"; } else { $body = wp_remote_retrieve_body( $response ); if ( ! empty( $body ) ) { $data = json_decode( $body, true ); // 将 JSON 数据解码为 PHP 数组 // 使用 $data 进行后续操作 print_r( $data ); } else { echo "No data received."; } }在这个例子中，我们首先使用
wp_remote_get()向https://api.example.com/data发起 GET 请求。然后，我们检查$response是否是一个WP_Error对象。如果是，就输出错误信息。否则，我们使用wp_remote_retrieve_body()从$response中提取响应正文，并使用json_decode()将其解码为 PHP 数组。最后，我们可以使用$data进行后续操作。 -
抓取网页内容：
有时候，你需要从其他网站抓取一些内容，比如新闻标题、文章摘要等。同样可以使用
wp_remote_get()发起请求，然后用wp_remote_retrieve_body()提取 HTML 内容。$response = wp_remote_get( 'https://example.com' ); if ( is_wp_error( $response ) ) { // 处理错误 $error_message = $response->get_error_message(); echo "Something went wrong: $error_message"; } else { $html = wp_remote_retrieve_body( $response ); if ( ! empty( $html ) ) { // 使用 DOMDocument 或者正则表达式解析 HTML 内容 // 这里只是一个简单的示例 echo substr( $html, 0, 200 ); // 输出 HTML 内容的前 200 个字符 } else { echo "No content received."; } }在这个例子中，我们首先使用
wp_remote_get()向https://example.com发起 GET 请求。然后，我们检查$response是否是一个WP_Error对象。如果是，就输出错误信息。否则，我们使用wp_remote_retrieve_body()从$response中提取 HTML 内容。最后，我们可以使用 DOMDocument 或者正则表达式解析 HTML 内容。这里只是一个简单的示例，输出了 HTML 内容的前 200 个字符。 -
处理 POST 请求的响应：
如果你向某个 API 接口发送了 POST 请求，服务器返回的响应也需要提取 Body。
$args = array( 'body' => array( 'key1' => 'value1', 'key2' => 'value2', ), ); $response = wp_remote_post( 'https://api.example.com/data', $args ); if ( is_wp_error( $response ) ) { // 处理错误 $error_message = $response->get_error_message(); echo "Something went wrong: $error_message"; } else { $body = wp_remote_retrieve_body( $response ); if ( ! empty( $body ) ) { // 处理响应数据 echo $body; } else { echo "No response received."; } }这个例子演示了如何发送 POST 请求并提取响应。
四、注意事项和最佳实践
在使用 wp_remote_retrieve_body() 的时候，有一些注意事项和最佳实践需要牢记在心：
-
错误处理：
务必检查
wp_remote_get()或者wp_remote_post()的返回值是否是一个WP_Error对象。如果出错，及时处理，避免程序崩溃。 -
数据类型：
wp_remote_retrieve_body()返回的是字符串类型的数据。如果响应是 JSON 或者 XML，需要使用json_decode()或者 SimpleXML 等函数进行解析。 -
字符编码：
如果远程服务器返回的字符编码不是 UTF-8，可能会出现乱码问题。可以使用
mb_convert_encoding()函数进行转换。 -
超时设置：
HTTP 请求可能会因为网络问题或者服务器繁忙而超时。可以使用
timeout参数设置超时时间。$args = array( 'timeout' => 10, // 设置超时时间为 10 秒 ); $response = wp_remote_get( 'https://api.example.com/data', $args ); -
Headers：
有时候，服务器会通过 Headers 返回一些有用的信息，比如 Content-Type、Content-Length 等。可以使用
wp_remote_retrieve_headers()函数获取 Headers 信息。 -
缓存：
对于一些不经常变化的数据，可以考虑使用 WordPress 的 Transient API 进行缓存，减少对远程服务器的请求次数，提高性能。
*五、`wpremote` 系列函数一览**
既然提到了 wp_remote_retrieve_body()，不妨再顺便看看 WordPress 中常用的 wp_remote_* 系列函数，它们都是 HTTP 请求的好帮手。
| 函数名 | 功能 |
|---|---|
wp_remote_get() |
发起一个 GET 请求。 |
wp_remote_post() |
发起一个 POST 请求。 |
wp_remote_head() |
发起一个 HEAD 请求（只获取 Headers，不获取 Body）。 |
wp_remote_request() |
发起一个自定义的 HTTP 请求，可以设置请求方法、Headers、Body 等。 |
wp_remote_retrieve_body() |
从 HTTP 响应中提取 Body。 |
wp_remote_retrieve_headers() |
从 HTTP 响应中提取 Headers。 |
wp_remote_retrieve_response_code() |
从 HTTP 响应中提取状态码。 |
wp_remote_retrieve_response_message() |
从 HTTP 响应中提取状态信息（比如 "OK" 或者 "Not Found"）。 |
wp_safe_remote_get() |
发起一个安全的 GET 请求，会自动处理一些安全问题，比如防止 SSRF 攻击。 |
六、实战案例：获取 Github 的 Star 数
为了更好地理解 wp_remote_retrieve_body() 的用法，咱们来做一个实战案例：获取某个 Github 仓库的 Star 数。
-
Github API：
Github 提供了 API 接口，可以获取仓库的各种信息，包括 Star 数。API 地址是：
https://api.github.com/repos/{owner}/{repo}，其中{owner}是仓库所有者的用户名，{repo}是仓库的名称。 -
代码实现：
function get_github_stars( $owner, $repo ) { $api_url = "https://api.github.com/repos/{$owner}/{$repo}"; $response = wp_remote_get( $api_url ); if ( is_wp_error( $response ) ) { return 'Error: ' . $response->get_error_message(); } $body = wp_remote_retrieve_body( $response ); if ( ! empty( $body ) ) { $data = json_decode( $body, true ); if ( isset( $data['stargazers_count'] ) ) { return $data['stargazers_count']; } else { return 'Error: Could not find stargazers_count.'; } } else { return 'Error: No data received.'; } } // 使用示例 $owner = 'WordPress'; $repo = 'WordPress'; $stars = get_github_stars( $owner, $repo ); echo "The WordPress/WordPress repository has {$stars} stars.";在这个例子中，我们定义了一个名为
get_github_stars()的函数，它接收仓库所有者的用户名和仓库名称作为参数。然后，我们使用wp_remote_get()向 Github API 发起 GET 请求，并使用wp_remote_retrieve_body()提取响应正文。最后，我们将 JSON 数据解码为 PHP 数组，并从中提取stargazers_count键对应的值，也就是 Star 数。
七、总结
好了，今天关于 wp_remote_retrieve_body() 的讲解就到这里。希望通过今天的学习，大家对这个函数有了更深入的理解。 记住，wp_remote_retrieve_body() 只是 wp_remote_* 系列函数中的一个，它专门负责从 HTTP 响应中提取 Body。 要想熟练掌握 HTTP 请求，还需要熟悉其他的 wp_remote_* 函数，并结合实际场景灵活运用。
祝大家编程愉快！