使用wpapi Node.js创建WordPress自定义字段后meta为空的原因与解决方法

问题重现 #

你通过WPAPI成功创建了带自定义meta字段的文章，但调用接口获取文章时，meta字段是空的，代码示例：

var wp = new WPAPI({ endpoint: 'http://your-site.com/wp-json', username: 'someusername', password: 'password' });
wp.posts().create({ 
    title: 'Your Post Title', 
    content: 'Your post content', 
    status: 'publish', 
    meta: { "custom_field": "my custom field value" } 
}).then(function( response ) { 
    console.log( response.id ); 
})

核心原因 #

这是WP REST API的默认行为，主要出于安全和性能考量：

• WordPress不会自动把所有自定义meta字段暴露给REST API，只有明确注册为可通过API访问的字段才会被返回。
• 你创建文章时传入的custom_field确实已经存入数据库，但因为没注册API权限，获取接口不会把它包含在返回结果里。

解决步骤 #

1. 在WordPress中注册自定义meta字段的API访问权限

需要在你的主题functions.php文件（或者自定义插件）中添加代码，把custom_field注册为可通过REST API读写的字段。推荐两种方式：

方式一：使用register_meta（简洁易用）

function register_custom_field_for_rest() {
    register_meta('post', 'custom_field', array(
        'show_in_rest' => true,       // 关键：允许字段在REST API中暴露
        'single' => true,             // 字段是单值类型（不是数组）
        'type' => 'string',           // 字段数据类型
        'auth_callback' => function() {
            // 控制权限：只允许有编辑文章权限的用户操作
            return current_user_can('edit_posts');
        }
    ));
}
add_action('rest_api_init', 'register_custom_field_for_rest');

方式二：使用register_rest_field（更灵活）

如果需要更精细地控制读取/写入逻辑（比如数据校验、格式化），可以用这个方法：

function add_custom_field_to_rest_response() {
    register_rest_field('post', 'custom_field', array(
        'get_callback' => function($post_data) {
            // 读取字段时返回数据库中的值
            return get_post_meta($post_data['id'], 'custom_field', true);
        },
        'update_callback' => function($value, $post) {
            // 更新字段时校验权限并 sanitize 数据
            if(current_user_can('edit_post', $post->ID)) {
                update_post_meta($post->ID, 'custom_field', sanitize_text_field($value));
            }
        },
        'schema' => array(
            'description' => '我的自定义字段',
            'type' => 'string'
        )
    ));
}
add_action('rest_api_init', 'add_custom_field_to_rest_response');

2. 验证效果

保存代码后，重新创建一篇带custom_field的文章，或者调用WPAPI更新已有文章的meta字段，然后再调用获取文章的接口：

wp.posts().get({ id: 123 }) // 替换为你的文章ID
.then(post => console.log(post.meta));

这时候就能看到custom_field及其值出现在meta对象里了。

额外注意

如果你操作的是自定义文章类型，要确保该文章类型在注册时设置了show_in_rest => true，否则不仅meta字段，连文章本身都无法通过REST API正常访问。

内容的提问来源于stack exchange，提问作者GhitaB