无法通过 REST API (Wpapi) 更新分类自定义字段
Cannot update taxonomy custom field via REST API (Wpapi)
我通过以下方式创建了自定义分类“供应商”:
// Register Custom Taxonomy
add_action( 'init', 'vendor_taxonomy', 0 );
function vendor_taxonomy() {
$labels = array(
'name' => 'Vendors',
'singular_name' => 'Vendor',
'menu_name' => 'Vendors',
'all_items' => 'All Vendors',
'parent_item' => 'Parent Vendor',
'parent_item_colon' => 'Parent Vendor:',
'new_item_name' => 'New Vendor Name',
'add_new_item' => 'Add New Vendor',
'edit_item' => 'Edit Vendor',
'update_item' => 'Update Vendor',
'separate_items_with_commas' => 'Separate Vendors with commas',
'search_items' => 'Search Vendors',
'add_or_remove_items' => 'Add or remove Vendors',
'choose_from_most_used' => 'Choose from the most used Vendors',
);
$capabilities = array(
'manage_terms' => 'manage_woocommerce',
'edit_terms' => 'manage_woocommerce',
'delete_terms' => 'manage_woocommerce',
'assign_terms' => 'manage_woocommerce',
);
$args = array(
'labels' => $labels,
'hierarchical' => false,
'public' => true,
'show_ui' => true,
'show_admin_column' => true,
'show_in_nav_menus' => true,
'show_tagcloud' => true,
'show_in_rest' => true,
'query_var' => true,
'capabilities' => $capabilities,
);
register_taxonomy( 'vendors', 'product', $args );
register_taxonomy_for_object_type('vendors', 'product');
}
在分类法供应商中,我按以下方式创建了一个自定义字段 'vendor_email':
<?php
// Add Vendor Email
add_action('vendors_add_form_fields', 'vendor_email_field_wp_editor_add', 10, 1);
function vendor_email_field_wp_editor_add() {
?>
<div class="form-field">
<label for="vendor_email"><?php _e('Email', 'wh'); ?></label>
<input type="text" name="vendor_email" id="vendor_email">
<p class="description"><?php _e('Enter Vendor email', 'email'); ?></p>
</div>
<?php
}
add_action('vendors_edit_form_fields', 'vendor_email_field_wp_editor_edit', 10, 1);
function vendor_email_field_wp_editor_edit($term) {
$term_id = $term->term_id;
$vendor_email = get_term_meta($term_id, 'vendor_email', true);
?>
<tr class="form-field">
<th scope="row" valign="top"><label for="vendor_email"><?php _e('Vendor Email', 'email'); ?></label></th>
<td>
<input type="text" name="vendor_email" id="vendor_email" value="<?php echo esc_attr($vendor_email) ? esc_attr($vendor_email) : ''; ?>">
<p class="description"><?php _e('Enter Vendor email', 'email'); ?></p>
</td>
</tr>
<?php
}
add_action('edited_vendors', 'vendor_email_field_wp_editor_save', 10, 1);
add_action('create_vendors', 'vendor_email_field_wp_editor_save', 10, 1);
function vendor_email_field_wp_editor_save($term_id) {
$vendor_email = filter_input(INPUT_POST, 'vendor_email');
update_term_meta($term_id, 'vendor_email', $vendor_email);
}
自定义字段 'vendor_email' 通过以下方式注册用于 REST API 使用:
add_action( 'rest_api_init', 'register_rest_field_email' );
function register_rest_field_email() {
register_rest_field( 'vendors',
'vendor_email',
array(
'get_callback' => 'email_get_term_meta',
'update_callback' => 'email_update_term_meta',
'schema' => null
)
);}
function email_get_term_meta($object) {
return get_term_meta( $object['id'], 'vendor_email', true );}
function email_update_term_meta( $value, $object, $field_name ) {
if ( ! $value || ! is_string( $value ) ) {
return;
}
return update_term_meta( $object->ID, $field_name, $value);}
使用 Wpapi 我可以通过 API 调用 /wp-json/wp/v2/vendors/ 正确检索所有数据,还有自定义字段 'vendor_email'。当我执行 post 或 put 时,它可以在所有标准字段(如名称或分类“供应商”的描述)上正常工作。
但是当我尝试执行 post 或 put 来创建或更新自定义字段时 'vendor_email' 它不起作用。如果已经设置
,它似乎实际上取消了该值
我想问题出在 email_update_term_meta() 函数的某处。但无论如何,我在这里也分享了我创建的通过 Wpapi
更新“vendor_email”的函数
function updateVendor(vendorId, newVendorEmail){
const WPAPI = require('wpapi');
const wp = new WPAPI({
endpoint: 'http://localhost/fooshi/wp-json',
username: 'xxxxxxxxx',
password: 'xxxxxxxxx'
});
wp.vendors = wp.registerRoute( 'wp/v2', '/vendors/(?P<id>)');
return wp.vendors().id(vendorId).update({
vendor_email: newVendorEmail
}).then(function(res) {
return res.id;
}).catch((error) => {
console.log("Response Status:", error);
});
}
如果您在 register_taxonomy()
调用的参数中将 show_in_rest
设置为真,则不需要第一个示例中的任何代码。如果您正确注册,WordPress 核心会为分类法提供获取、更新和权限处理程序方法。您不需要使用 register_rest_field()
通过 REST API.
更新自定义分类关系
更新:
感谢您提供更多信息。使用 register_term_meta()
在 REST 中公开 vendor_email
。
谢谢,成功了。为了详细说明解决方案,我删除了 register_rest_field_email() 块并添加了:
add_action( 'rest_api_init', 'register_vendor_email');
function register_vendor_email(){
register_term_meta( 'vendors', 'vendor_email', array(
'type' => 'string',
'single' => true,
'show_in_rest' => array(
'schema' => array(
'type' => 'string',
'format' => 'url',
'context' => array( 'view', 'edit' ),
)
),
) );
}
我通过以下方式创建了自定义分类“供应商”:
// Register Custom Taxonomy
add_action( 'init', 'vendor_taxonomy', 0 );
function vendor_taxonomy() {
$labels = array(
'name' => 'Vendors',
'singular_name' => 'Vendor',
'menu_name' => 'Vendors',
'all_items' => 'All Vendors',
'parent_item' => 'Parent Vendor',
'parent_item_colon' => 'Parent Vendor:',
'new_item_name' => 'New Vendor Name',
'add_new_item' => 'Add New Vendor',
'edit_item' => 'Edit Vendor',
'update_item' => 'Update Vendor',
'separate_items_with_commas' => 'Separate Vendors with commas',
'search_items' => 'Search Vendors',
'add_or_remove_items' => 'Add or remove Vendors',
'choose_from_most_used' => 'Choose from the most used Vendors',
);
$capabilities = array(
'manage_terms' => 'manage_woocommerce',
'edit_terms' => 'manage_woocommerce',
'delete_terms' => 'manage_woocommerce',
'assign_terms' => 'manage_woocommerce',
);
$args = array(
'labels' => $labels,
'hierarchical' => false,
'public' => true,
'show_ui' => true,
'show_admin_column' => true,
'show_in_nav_menus' => true,
'show_tagcloud' => true,
'show_in_rest' => true,
'query_var' => true,
'capabilities' => $capabilities,
);
register_taxonomy( 'vendors', 'product', $args );
register_taxonomy_for_object_type('vendors', 'product');
}
在分类法供应商中,我按以下方式创建了一个自定义字段 'vendor_email':
<?php
// Add Vendor Email
add_action('vendors_add_form_fields', 'vendor_email_field_wp_editor_add', 10, 1);
function vendor_email_field_wp_editor_add() {
?>
<div class="form-field">
<label for="vendor_email"><?php _e('Email', 'wh'); ?></label>
<input type="text" name="vendor_email" id="vendor_email">
<p class="description"><?php _e('Enter Vendor email', 'email'); ?></p>
</div>
<?php
}
add_action('vendors_edit_form_fields', 'vendor_email_field_wp_editor_edit', 10, 1);
function vendor_email_field_wp_editor_edit($term) {
$term_id = $term->term_id;
$vendor_email = get_term_meta($term_id, 'vendor_email', true);
?>
<tr class="form-field">
<th scope="row" valign="top"><label for="vendor_email"><?php _e('Vendor Email', 'email'); ?></label></th>
<td>
<input type="text" name="vendor_email" id="vendor_email" value="<?php echo esc_attr($vendor_email) ? esc_attr($vendor_email) : ''; ?>">
<p class="description"><?php _e('Enter Vendor email', 'email'); ?></p>
</td>
</tr>
<?php
}
add_action('edited_vendors', 'vendor_email_field_wp_editor_save', 10, 1);
add_action('create_vendors', 'vendor_email_field_wp_editor_save', 10, 1);
function vendor_email_field_wp_editor_save($term_id) {
$vendor_email = filter_input(INPUT_POST, 'vendor_email');
update_term_meta($term_id, 'vendor_email', $vendor_email);
}
自定义字段 'vendor_email' 通过以下方式注册用于 REST API 使用:
add_action( 'rest_api_init', 'register_rest_field_email' );
function register_rest_field_email() {
register_rest_field( 'vendors',
'vendor_email',
array(
'get_callback' => 'email_get_term_meta',
'update_callback' => 'email_update_term_meta',
'schema' => null
)
);}
function email_get_term_meta($object) {
return get_term_meta( $object['id'], 'vendor_email', true );}
function email_update_term_meta( $value, $object, $field_name ) {
if ( ! $value || ! is_string( $value ) ) {
return;
}
return update_term_meta( $object->ID, $field_name, $value);}
使用 Wpapi 我可以通过 API 调用 /wp-json/wp/v2/vendors/ 正确检索所有数据,还有自定义字段 'vendor_email'。当我执行 post 或 put 时,它可以在所有标准字段(如名称或分类“供应商”的描述)上正常工作。
但是当我尝试执行 post 或 put 来创建或更新自定义字段时 'vendor_email' 它不起作用。如果已经设置
,它似乎实际上取消了该值我想问题出在 email_update_term_meta() 函数的某处。但无论如何,我在这里也分享了我创建的通过 Wpapi
更新“vendor_email”的函数function updateVendor(vendorId, newVendorEmail){
const WPAPI = require('wpapi');
const wp = new WPAPI({
endpoint: 'http://localhost/fooshi/wp-json',
username: 'xxxxxxxxx',
password: 'xxxxxxxxx'
});
wp.vendors = wp.registerRoute( 'wp/v2', '/vendors/(?P<id>)');
return wp.vendors().id(vendorId).update({
vendor_email: newVendorEmail
}).then(function(res) {
return res.id;
}).catch((error) => {
console.log("Response Status:", error);
});
}
如果您在 register_taxonomy()
调用的参数中将 show_in_rest
设置为真,则不需要第一个示例中的任何代码。如果您正确注册,WordPress 核心会为分类法提供获取、更新和权限处理程序方法。您不需要使用 register_rest_field()
通过 REST API.
更新:
感谢您提供更多信息。使用 register_term_meta()
在 REST 中公开 vendor_email
。
谢谢,成功了。为了详细说明解决方案,我删除了 register_rest_field_email() 块并添加了:
add_action( 'rest_api_init', 'register_vendor_email');
function register_vendor_email(){
register_term_meta( 'vendors', 'vendor_email', array(
'type' => 'string',
'single' => true,
'show_in_rest' => array(
'schema' => array(
'type' => 'string',
'format' => 'url',
'context' => array( 'view', 'edit' ),
)
),
) );
}