如何在 Wordpress API Post 中包含 META 字段？

Question

我使用的是 Wordpress 5.2.1 版，这意味着我没有使用 WP API 插件。我有工作代码可以在我的 WP 网站上创建一个新帖子（使用自定义帖子类型），一切都很好。问题是我使用 ACF 创建了自定义字段，但它们没有出现在新创建的帖子中。下面就是我通过发送给WP的例子：/wp-json/wp/v2/experience。

注意：experience是我的自定义帖子类型。

{'title': 'test', 'content': 'testing from python', 'status': 'draft', 'author': 1, 'meta': {'location': 'NYC', 'date': 'never', 'event_url': 'http://google.com'}, 'featured_media': 1221}

这会创建一个帖子，但里面的字段meta被完全忽略。我的目标是将我指定的字段meta包含在我新创建的帖子中。

我已经尝试了以下 URL 中列出的解决方案，但没有任何效果。

https://gist.github.com/rileypaulsen/9b4505cdd0ac88d5ef51

Wordpress Rest API - 自定义字段

https://jeffreyeverhart.com/2017/06/14/adding-custom-fields-wordpress-json-api/

我错过了什么？

Answer 1

首先，当您注册新的帖子类型时，您需要将'show_in_rest'属性设置为true' supports' 属性应包括在内'custom-fields'。如果要包含元字段，则需要支持“自定义字段”。

请注意，对于在自定义帖子类型上注册的元字段，帖子类型必须具有自定义字段支持。否则，元字段将不会出现在 REST API 中。https://developer.wordpress.org/rest-api/extending-the-rest-api/modifying-responses/

function cptui_register_my_cpts() {

    /**
     * Post Type: Experiences.
     */

    $labels = array(
        "name" => __( "Experiences", "twentynineteen" ),
        "singular_name" => __( "Experience", "twentynineteen" ),
    );

    $args = array(
        "label" => __( "Experiences", "twentynineteen" ),
        "labels" => $labels,
        "description" => "",
        "public" => true,
        "publicly_queryable" => true,
        "show_ui" => true,
        "delete_with_user" => false,
        "show_in_rest" => true,
        "rest_base" => "",
        "rest_controller_class" => "WP_REST_Posts_Controller",
        "has_archive" => false,
        "show_in_menu" => true,
        "show_in_nav_menus" => true,
        "exclude_from_search" => false,
        "capability_type" => "post",
        "map_meta_cap" => true,
        "hierarchical" => false,
        "rewrite" => array( "slug" => "experience", "with_front" => true ),
        "query_var" => true,
        "supports" => array( "title", "editor", "thumbnail", "custom-fields" ),
    );

    register_post_type( "experience", $args );
}

add_action( 'init', 'cptui_register_my_cpts' );

现在，您需要使用register_meta().

add_action( 'rest_api_init', 'register_experience_meta_fields');
function register_experience_meta_fields(){

    register_meta( 'post', 'location', array(
        'type' => 'string',
        'description' => 'event location',
        'single' => true,
        'show_in_rest' => true
    ));

    register_meta( 'post', 'date', array(
        'type' => 'string',
        'description' => 'event location',
        'single' => true,
        'show_in_rest' => true
    ));

    register_meta( 'post', 'event_url', array(
        'type' => 'string',
        'description' => 'event location',
        'single' => true,
        'show_in_rest' => true
    ));

}

注意：元字段必须是唯一的。在 ACF 中为您的字段添加前缀以使其独一无二。

JSON 不使用单引号来包装字符串。它使用双引号。您正在发送无效的 JSON。

现在，如果您想创建一个体验帖子类型。使用 JSON linter 来验证您的 json。https://jsonlint.com/

使用字段向http://paathsala-plugin.test/wp-json/wp/v2/experience发出 POST 请求

{
    "title": "test",
    "content": "testingfrompython",
    "status": "draft",
    "author": 1,
    "meta": {
        "location": "NYC",
        "date": "never",
        "event_url": "http: //google.com"
    },
    "featured_media": 1221
}

WordPress 不允许您直接创建资源。您需要验证您的 REST 请求。我正在使用基本身份验证来验证 WordPress REST API。你需要安装一个插件。从这里获取：https : //github.com/WP-API/Basic-Auth

我已经测试了以下 python 代码。

import base64
import json
import requests;

# Data to be send
data = {
    "title": "test",
    "content": "testingfrompython",
    "status": "draft",
    "author": 1,
    "meta": {
        "location": "NYC",
        "date": "never",
        "event_url": "http: //google.com"
    },
    "featured_media": 1221
}

# I am using basic auth plugin to for WP API authenticaiton
username = 'admin'
password = 'blood9807'

# Encode the username and password using base64
creds = base64.b64encode(username + ':' + password)

# Create headers to be send
headers = {
    'Authorization': 'Basic ' + creds,
    'Content-type': 'application/json', 
    'Accept': 'text/plain'
}

# Convert the python dictionary to JSON
data_json = json.dumps(data)

# Create a post
r = requests.post('http://paathsala-plugin.test/wp-json/wp/v2/experience', data = data_json, headers = headers )

print(r)