如何利用WordPress的`REST API`实现自定义字段的读写操作？ - 智猿学院-前后端，数据库，人工智能，云计算等领域前沿技术讲座

WordPress REST API 自定义字段读写详解

大家好，今天我们来深入探讨如何利用 WordPress 的 REST API 来实现自定义字段的读写操作。自定义字段是 WordPress 中扩展内容模型的重要手段，而 REST API 则为我们提供了一种通过 HTTP 协议与 WordPress 交互的强大方式。通过结合这两者，我们可以轻松地创建、读取、更新和删除自定义字段数据，从而构建更灵活、更强大的应用程序。

一、自定义字段的存储方式

在深入 REST API 之前，我们需要理解 WordPress 如何存储自定义字段。自定义字段（也称为元数据）通常存储在以下两个数据库表中：

wp_postmeta: 存储文章、页面等类型的自定义字段。
wp_usermeta: 存储用户相关的自定义字段。

这两个表的结构类似，都包含以下关键字段：

字段名	数据类型	描述
`meta_id`	BIGINT	自增主键。
`post_id` / `user_id`	BIGINT	关联的文章 ID (对于 `wp_postmeta`) 或用户 ID (对于 `wp_usermeta`)。
`meta_key`	VARCHAR(255)	自定义字段的键名。
`meta_value`	LONGTEXT	自定义字段的值。 WordPress 会自动序列化复杂数据类型（如数组、对象）为字符串，然后再存储。

二、使用 REST API 读取自定义字段

WordPress REST API 默认情况下不会直接公开所有自定义字段。我们需要采取一些步骤才能通过 API 访问它们。

1. 注册自定义字段:

为了让 REST API 知道我们需要公开哪些自定义字段，我们需要使用 register_rest_field() 函数。这个函数将自定义字段注册到特定文章类型（例如 ‘post’, ‘page’）或用户对象。

<?php
// 在 functions.php 文件中添加以下代码

add_action( 'rest_api_init', 'register_custom_fields' );

function register_custom_fields() {
    // 文章类型：post
    register_rest_field(
        'post',  // 文章类型
        'my_custom_field',  // 自定义字段的键名
        array(
            'get_callback'    => 'get_post_custom_field', // 获取值的回调函数
            'update_callback' => 'update_post_custom_field', // 更新值的回调函数
            'schema'          => null, // 定义数据结构，可以设置为 null
        )
    );

    // 文章类型：page
    register_rest_field(
        'page',
        'my_page_field',
        array(
            'get_callback'    => 'get_page_custom_field',
            'update_callback' => 'update_page_custom_field',
            'schema'          => null,
        )
    );

    // 用户
    register_rest_field(
        'user',
        'my_user_field',
        array(
            'get_callback'    => 'get_user_custom_field',
            'update_callback' => 'update_user_custom_field',
            'schema'          => null,
        )
    );
}

2. 定义回调函数:

我们需要定义 get_callback 函数来获取自定义字段的值。此函数接收文章对象或用户对象作为参数，并返回相应的自定义字段值。

<?php
// 获取文章自定义字段的回调函数
function get_post_custom_field( $object, $field_name, $request ) {
    return get_post_meta( $object['id'], $field_name, true );
}

// 获取页面自定义字段的回调函数
function get_page_custom_field( $object, $field_name, $request ) {
    return get_post_meta( $object['id'], $field_name, true );
}

// 获取用户自定义字段的回调函数
function get_user_custom_field( $object, $field_name, $request ) {
    return get_user_meta( $object['id'], $field_name, true );
}

3. 发起 GET 请求:

现在，我们可以通过 REST API 发起 GET 请求来获取包含自定义字段的文章、页面或用户信息。

获取文章: GET /wp-json/wp/v2/posts/{id}
获取页面: GET /wp-json/wp/v2/pages/{id}
获取用户: GET /wp-json/wp/v2/users/{id}

在返回的 JSON 数据中，你会找到 my_custom_field (或其他你注册的自定义字段) 字段，其值就是该文章/页面的自定义字段值。

示例:

假设你有一篇 ID 为 123 的文章，并且设置了 my_custom_field 的值为 "Hello World"。那么，访问 GET /wp-json/wp/v2/posts/123 将会返回类似下面的 JSON 数据：

{
    "id": 123,
    "date": "2023-10-27T10:00:00",
    "date_gmt": "2023-10-27T10:00:00",
    "guid": {
        "rendered": "http://example.com/?p=123"
    },
    "modified": "2023-10-27T10:00:00",
    "modified_gmt": "2023-10-27T10:00:00",
    "slug": "my-article",
    "status": "publish",
    "type": "post",
    "link": "http://example.com/my-article/",
    "title": {
        "rendered": "My Article"
    },
    "content": {
        "rendered": "<p>This is my article content.</p>n",
        "protected": false
    },
    "excerpt": {
        "rendered": "<p>This is my article excerpt.</p>n",
        "protected": false
    },
    "author": 1,
    "featured_media": 0,
    "comment_status": "open",
    "ping_status": "open",
    "sticky": false,
    "template": "",
    "format": "standard",
    "meta": [],
    "categories": [
        1
    ],
    "tags": [],
    "my_custom_field": "Hello World"  //  自定义字段的值
}

三、使用 REST API 写入 (更新) 自定义字段

要通过 REST API 更新自定义字段，我们需要使用 update_callback 函数，并在请求中使用 PUT 或 POST 方法。

1. 定义 update_callback 函数:

update_callback 函数负责接收传入的新值，并将其保存到数据库中。此函数接收三个参数：

$value: 要更新的值。
$object: 文章对象或用户对象。
$field_name: 自定义字段的键名。

<?php
// 更新文章自定义字段的回调函数
function update_post_custom_field( $value, $object, $field_name ) {
    return update_post_meta( $object->ID, $field_name, $value );
}

// 更新页面自定义字段的回调函数
function update_page_custom_field( $value, $object, $field_name ) {
    return update_post_meta( $object->ID, $field_name, $value );
}

// 更新用户自定义字段的回调函数
function update_user_custom_field( $value, $object, $field_name ) {
    return update_user_meta( $object->ID, $field_name, $value );
}

2. 发起 PUT/POST 请求:

使用 PUT 或 POST 方法，向相应的 REST API 端点发送请求，并在请求体中包含要更新的自定义字段及其新值。

更新文章: PUT /wp-json/wp/v2/posts/{id} 或 POST /wp-json/wp/v2/posts/{id}
更新页面: PUT /wp-json/wp/v2/pages/{id} 或 POST /wp-json/wp/v2/pages/{id}
更新用户: PUT /wp-json/wp/v2/users/{id} 或 POST /wp-json/wp/v2/users/{id}

请求体应该是一个 JSON 对象，其中包含要更新的自定义字段及其对应的值。

示例:

要将 ID 为 123 的文章的 my_custom_field 更新为 "New Value"，你可以发送一个如下的 PUT 请求：

PUT /wp-json/wp/v2/posts/123
Content-Type: application/json
Authorization: Bearer YOUR_JWT_TOKEN (如果需要身份验证)

{
    "my_custom_field": "New Value"
}

重要提示:

身份验证: 更新数据通常需要身份验证。 WordPress 提供了多种身份验证方式，例如 Cookie 验证、JWT (JSON Web Token) 验证等。你需要根据你的应用场景选择合适的身份验证方式。
数据验证和清理: 在 update_callback 函数中，务必对传入的值进行验证和清理，以防止恶意数据注入或意外错误。
错误处理: 在 update_callback 函数中，如果更新失败，应该返回一个 WP_Error 对象，以便 API 客户端能够识别错误并采取相应的措施。

四、处理复杂数据类型

WordPress 存储自定义字段时，会将复杂数据类型（如数组、对象）序列化为字符串。因此，在 get_callback 函数中，我们需要对取出的值进行反序列化，而在 update_callback 函数中，我们需要对要保存的值进行序列化。但是，由于 get_post_meta 和 get_user_meta 默认会自动反序列化数据，而 update_post_meta 和 update_user_meta 会自动序列化数据，因此我们通常不需要手动进行序列化和反序列化。

示例:

假设 my_custom_field 存储的是一个数组：

<?php
// 获取文章自定义字段的回调函数 (处理数组)
function get_post_custom_field_array( $object, $field_name, $request ) {
    return get_post_meta( $object['id'], $field_name, true ); // get_post_meta 会自动反序列化
}

// 更新文章自定义字段的回调函数 (处理数组)
function update_post_custom_field_array( $value, $object, $field_name ) {
    return update_post_meta( $object->ID, $field_name, $value ); // update_post_meta 会自动序列化
}

add_action( 'rest_api_init', 'register_custom_fields_array' );

function register_custom_fields_array() {
    register_rest_field(
        'post',
        'my_custom_field',
        array(
            'get_callback'    => 'get_post_custom_field_array',
            'update_callback' => 'update_post_custom_field_array',
            'schema'          => null,
        )
    );
}

五、使用 schema 定义数据结构

schema 参数允许我们定义自定义字段的数据结构，从而提供更好的 API 文档和数据验证。 schema 是一个数组，包含以下键：

type: 数据类型 (例如：string, integer, boolean, array, object)
description: 字段描述
properties: (如果 type 是 object) 一个包含对象属性及其数据结构的数组。
items: (如果 type 是 array) 一个包含数组元素数据结构的数组。
required: (如果 type 是 object) 一个包含必需属性名称的数组。
readonly: 指示字段是否只读。
context: 定义字段在哪些上下文中可用 (例如：view, edit, embed)

示例:

<?php
add_action( 'rest_api_init', 'register_custom_field_with_schema' );

function register_custom_field_with_schema() {
    register_rest_field(
        'post',
        'my_custom_object',
        array(
            'get_callback'    => 'get_post_custom_object',
            'update_callback' => 'update_post_custom_object',
            'schema'          => array(
                'type'        => 'object',
                'description' => 'My custom object',
                'properties'  => array(
                    'name'  => array(
                        'type'        => 'string',
                        'description' => 'Name of the object',
                    ),
                    'age'   => array(
                        'type'        => 'integer',
                        'description' => 'Age of the object',
                    ),
                    'active' => array(
                        'type'        => 'boolean',
                        'description' => 'Is the object active?',
                    ),
                ),
            ),
        )
    );
}

function get_post_custom_object( $object, $field_name, $request ) {
    return get_post_meta( $object['id'], $field_name, true );
}

function update_post_custom_object( $value, $object, $field_name ) {
    return update_post_meta( $object->ID, $field_name, $value );
}

在这个例子中，我们定义了一个名为 my_custom_object 的自定义字段，它的类型是 object，包含 name (string), age (integer), 和 active (boolean) 三个属性。

六、代码示例：一个完整的自定义字段 REST API 实现

下面是一个完整的例子，展示了如何注册、读取和写入一个名为 book_author 的自定义字段，用于存储文章的作者信息：

<?php
/**
 * Plugin Name: Custom Field REST API Example
 * Description: Demonstrates how to use the REST API to read and write custom fields.
 */

add_action( 'rest_api_init', 'register_book_author_field' );

function register_book_author_field() {
    register_rest_field(
        'post',
        'book_author',
        array(
            'get_callback'    => 'get_book_author',
            'update_callback' => 'update_book_author',
            'schema'          => array(
                'type'        => 'string',
                'description' => 'The author of the book.',
                'context'     => array( 'view', 'edit' ),
            ),
        )
    );
}

function get_book_author( $object, $field_name, $request ) {
    return get_post_meta( $object['id'], $field_name, true );
}

function update_book_author( $value, $object, $field_name ) {
    if ( ! current_user_can( 'edit_post', $object->ID ) ) {
        return new WP_Error( 'rest_forbidden', esc_html__( 'You are not allowed to edit this post.', 'my-plugin' ), array( 'status' => 401 ) );
    }

    if ( ! is_string( $value ) ) {
        return new WP_Error( 'rest_invalid_type', esc_html__( 'The book author must be a string.', 'my-plugin' ), array( 'status' => 400 ) );
    }

    return update_post_meta( $object->ID, $field_name, sanitize_text_field( $value ) );
}

要点:

权限控制: update_book_author 函数中添加了权限检查，确保只有具有 edit_post 权限的用户才能更新该字段。
数据验证: update_book_author 函数中添加了数据类型验证，确保传入的值是字符串。
数据清理: 使用 sanitize_text_field 函数对输入的值进行清理，防止 XSS 攻击。
错误处理: 如果用户没有权限或数据类型不正确，函数会返回一个 WP_Error 对象。

七、实际应用场景

通过 REST API 读写自定义字段在实际开发中有很多应用场景，例如：

构建 Headless WordPress 应用: 使用 React、Vue.js 或 Angular 等前端框架构建完全自定义的前端界面，并通过 REST API 与 WordPress 后端交互。
移动应用开发: 为 WordPress 网站创建移动应用，并通过 REST API 获取和更新数据。
集成第三方服务: 将 WordPress 与其他应用程序或服务集成，例如 CRM 系统、邮件营销平台等。
自动化工作流程: 使用 REST API 创建自动化工作流程，例如自动发布文章、更新产品信息等。

八、REST API 的扩展性

WordPress REST API 具有很强的扩展性。除了自定义字段，你还可以注册自定义端点、自定义路由等，以满足更复杂的业务需求。

九、一些需要注意的点

性能: 频繁的 API 请求可能会影响网站性能。建议使用缓存技术来减少数据库查询次数。
安全性: 确保 REST API 端点受到适当的保护，防止未经授权的访问。
版本控制: 随着 WordPress 的更新，REST API 可能会发生变化。建议使用版本控制来管理 API 的演进。

十、关于安全性的补充说明

安全性是REST API开发中至关重要的一环。除了前面提到的权限验证、数据清理外，还有一些额外的安全措施需要考虑：

HTTPS: 确保你的WordPress网站使用HTTPS协议。这可以加密客户端和服务器之间的通信，防止数据在传输过程中被窃取。
CORS (跨域资源共享): 如果你的前端应用和WordPress网站不在同一个域名下，你需要配置CORS策略，允许跨域请求。但是，要谨慎设置CORS策略，只允许受信任的域名访问API。
速率限制: 实施速率限制可以防止恶意用户通过发送大量请求来攻击你的API。 WordPress有一些插件可以帮助你实现速率限制。
输入验证和清理: 除了前面提到的sanitize_text_field，根据不同的数据类型，使用适当的验证和清理函数。例如，absint()用于整数，esc_url_raw()用于URL。
输出编码: 对API返回的数据进行适当的编码，防止XSS攻击。例如，使用esc_html()对HTML内容进行编码。
安全插件: 使用WordPress安全插件可以增强网站的整体安全性，并提供针对常见攻击的保护。
定期更新: 保持WordPress核心、插件和主题的最新版本，以修复已知的安全漏洞。

通过采取这些安全措施，可以大大提高你的WordPress REST API的安全性。

自定义字段读写是关键

掌握了 WordPress REST API 自定义字段的读写操作，你就可以构建更加灵活和强大的 WordPress 应用。记住要关注安全性、性能和扩展性，才能构建出稳定可靠的解决方案。

WordPress REST API 自定义字段读写详解

发表回复 取消回复

发表回复取消回复