wp怎么调用json

WordPress 调用 JSON 数据：从基础到实践的完整指南**

在当今的 Web 开发中，JSON（JavaScript Object Notation）因其轻量级、易读易写以及与 JavaScript 的良好兼容性，已成为数据交换的主流格式之一，WordPress 作为全球最受欢迎的内容管理系统（CMS），虽然默认以 HTML 形式输出内容，但在很多场景下，如构建单页应用（SPA）、移动端 App、前后端分离项目，或者实现跨域数据获取，我们都需要在 WordPress 中调用 JSON 数据，本文将详细介绍 WordPress 调用 JSON 数据的多种方法，从简单的内置函数到自定义 API 端点,帮助你轻松这一技能。

WordPress 内置的 JSON REST API（推荐）

WordPress 从 4.7 版本开始，核心集成了 JSON REST API，这使得通过 JSON 格式获取 WordPress 数据变得异常简单和强大，默认情况下，这个 API 已经启用,你可以直接使用。

什么是 WordPress REST API？

WordPress REST API 允许你通过 HTTP 请求（GET、POST、PUT、DELETE 等）来读取、创建、更新和删除 WordPress 的数据，如文章、页面、分类、标签、用户、评论等，所有数据都以 JSON 格式返回。

如何使用 WordPress REST API 调用 JSON？

最直接的方式是通过浏览器或 API 客户端工具（如 Postman、curl）访问特定的 API 端点。

基本结构： https://你的WordPress网站域名/wp-json/wp/v2/数据类型

示例：获取最新10篇文章

假设你的 WordPress 网站域名为 example.com，那么获取文章列表的 API 端点就是： https://example.com/wp-json/wp/v2/posts

你可以在浏览器地址栏中输入这个 URL，如果返回一大串 JSON 数据，就说明 API 工作正常。

常用参数：

• _fields: 指定返回 JSON 中包含的字段，减少数据传输量。
  • 示例：https://example.com/wp-json/wp/v2/posts?_fields=id,title,link （只返回文章的ID、标题和链接）
• per_page: 每页返回的数据数量，默认为10，最大为100。
  • 示例：https://example.com/wp-json/wp/v2/posts?per_page=5 （每页返回5篇文章）
• page: 当前页码。
  • 示例：https://example.com/wp-json/wp/v2/posts?per_page=5&page=2 （获取第2页的5篇文章）
• search: 搜索特定内容。
  • 示例：https://example.com/wp-json/wp/v2/posts?search=WordPress
• orderby: 排序依据，如 date（日期）、title）、modified（修改时间）等。
• order: 排序顺序，asc（升序）或 desc（降序）。

其他数据类型的 API 端点：

• 页面： /wp-json/wp/v2/pages
• 分类： /wp-json/wp/v2/categories
• /wp-json/wp/v2/tags
• 用户： /wp-json/wp/v2/users
• 媒体（附件）： /wp-json/wp/v2/media

在 WordPress 主题或插件中调用 JSON 数据

如果你想在 WordPress 主题的 PHP 文件中获取 JSON 数据，可以使用 wp_remote_get() 函数，它是 WordPress 提供的一个强大的 HTTP 请求工具。

示例代码（在主题的 functions.php 或模板文件中使用）：

<?php
// API 端点
$api_url = 'https://example.com/wp-json/wp/v2/posts?per_page=3';
// 发送 GET 请求
$response = wp_remote_get( $api_url );
// 检查请求是否成功
if ( is_wp_error( $response ) ) {
    echo '请求失败: ' . $response->get_error_message();
} else {
    // 获取响应体
    $body = wp_remote_retrieve_body( $response );
    // 将 JSON 字符串解码为 PHP 数组
    $posts = json_decode( $body, true ); // true 表示关联数组
    // 检查解码是否成功
    if ( is_array( $posts ) ) {
        // 遍历并输出文章数据
        foreach ( $posts as $post ) {
            echo '<h2><a href="' . esc_url( $post['link'] ) . '">' . esc_html( $post['title']['rendered'] ) . '</a></h2>';
            echo '<div>' . wp_kses_post( $post['excerpt']['rendered'] ) . '</div>';
        }
    } else {
        echo 'JSON 解码失败或没有数据。';
    }
}
?>

代码解释：

1. wp_remote_get( $api_url ): 发送 HTTP GET 请求到指定的 API URL。
2. is_wp_error( $response ): 检查请求过程中是否发生错误。
3. wp_remote_retrieve_body( $response ): 从响应对象中获取响应体（即 JSON 数据字符串）。
4. json_decode( $body, true ): 将 JSON 字符串解码为 PHP 关联数组（第二个参数为 true 时）。
5. 后续就是遍历 PHP 数组，并使用 WordPress 提供的转义函数（如 esc_url, esc_html, wp_kses_post）来安全地输出数据，防止 XSS 攻击。

使用 wp_json_encode() 函数输出 JSON 数据

我们可能不是从外部获取 JSON，而是需要将 WordPress 的数据（如自定义查询结果）以 JSON 格式输出，供 JavaScript 前端或其他服务调用。

wp_json_encode() 是 WordPress 提供的 JSON 编码函数，它比 PHP 原生的 json_encode() 更安全，因为它会自动处理一些特殊情况,如中文字符的编码。

示例代码（在主题模板文件中）：

假设你想获取某个分类下的文章并以 JSON 格式输出：

<?php
// 获取ID为 1 的分类下的文章
$args = array(
    'category__in' => array( 1 ),
    'posts_per_page' => 5,
    'orderby' => 'date',
    'order' => 'DESC'
);
$posts_query = new WP_Query( $args );
$posts_data = array();
if ( $posts_query->have_posts() ) {
    while ( $posts_query->have_posts() ) {
        $posts_query->the_post();
        $posts_data[] = array(
            'id' => get_the_ID(),
            'title' => get_the_title(),
            'link' => get_permalink(),
            'excerpt' => get_the_excerpt(),
            'date' => get_the_date( 'Y-m-d H:i:s' )
        );
    }
}
wp_reset_postdata();
// 设置响应头为 JSON
header( 'Content-Type: application/json; charset=utf-8' );
// 输出 JSON 数据
echo wp_json_encode( $posts_data );
exit; // 确保之后没有其他输出
?>

这段代码会创建一个自定义的 JSON API 端点，访问这个模板文件（可能需要通过 rewrite 规则或短代码等方式触发），就会返回指定分类下的文章 JSON 数据。

使用第三方插件调用或创建 JSON API

如果你觉得使用代码比较复杂，或者需要更高级的功能,可以考虑使用第三方插件。

• 获取 JSON 数据： 有些插件可以帮你获取外部 API 数据并在 WordPress 中显示。
• 创建 JSON API： 像 JSON API 或 WP REST API - OAuth 1.0a Server（如果需要认证）等插件，可以提供更丰富的 REST API 功能，或者对默认 API 进行扩展和定制，随着 WordPress 核心 REST API 的不断完善，很多第三方插件的功能已经被内置 API 所取代。

注意事项

1. 性能考虑： 频繁的 API 请求可能会对服务器性能产生影响，特别是在高流量的网站上，可以考虑对 API 响应进行缓存（使用 WordPress Transients API 或缓存插件）。
2. 安全性：
   • 在调用外部 API 时，确保 API 来源的可信度。
   • 在输出 JSON 数据时，如果数据来自用户输入，务必进行适当的转义和验证，防止 XSS 攻击（虽然 wp_json_encode() 会处理大部分情况，但数据本身的处理也很重要）。
   • 如果你的 API 需要敏感操作，考虑使用 OAuth 等认证机制。
3. CORS（跨域资源共享）： 如果你从前端网站（域名与 WordPress 站点不同）直接调用 WordPress REST API，可能会遇到跨域问题，WordPress 4.9+ 版本默认对 REST API 的跨域请求有一定支持,但可能需要配置服务器或插件来完全解决。
4. API 版本： �