WordPress REST API的默認端點設計為默認返回數據，為大多數站點和用例提供數據，但是往往需要擴展各種對象類型的響應。 為了適應這些需求，REST API被設計為高度可擴展的，就像其余的WordPress一樣。本文檔詳細介紹了如何使用register_rest_field和register_meta函數向默認端點的響應添加附加數據。您可以使用這些函數將字段添加到REST API支持的任何對象類型中。這些自定義字段可以支持get和update操作。 ##關于改變回應的重要注意事項 API提供了許多關于API響應的領域，包括您可能不需要的內容，或者可能不適合您的網站的工作原理。雖然從響應中修改或刪除字段很誘人，但這將導致API客戶端出現預期標準響應的問題。這包括移動客戶端或第三方工具，以幫助您管理您的網站，最終是wp-admin本身。 您可能只需要少量數據，但請務必記住，API是將界面暴露給所有客戶端，而不僅僅是您正在開發的功能。變化的反應是危險的。 添加字段不是危險的，所以如果你需要修改數據，最好是用修改的數據來復制字段。不鼓勵刪除字段;如果您需要回收較小的數據子集，請使用上下文，并考慮使用自己的上下文。 >[warning] 請注意，API不能阻止您更改響應，但代碼的結構強烈阻止此。在內部，現場注冊由過濾器供電，如果絕對沒有其他選擇，則可以使用這些注冊。 ## 什么register_rest_field 在響應的基礎架構中，全局變量$ wp_rest_additional_fields用于保存要添加到每個對象類型的響應的字段。 REST API提供了register_rest_field作為添加到這個全局變量的效用函數。應避免直接添加到全局變量，以確保最大化前向兼容性。 對于每個對象類型 - 帖子或用戶，術語，注釋等，$ wp_rest_additional_fields包含一個字段數組，每個字段可以具有用于檢索該值的回調值，并使用添加該字段的任何端點更新該值可用于更新。 ## 如何使用register_rest_field 函數register_rest_field字段接受三個參數： $ object_type：對象的名稱，作為字符串，或該字段正在注冊的對象名稱的數組。當添加到帖子類型端點時，應使用“post”。或者可以使用“條款”，“元”，“用戶”或“注釋”。 $ attribute：字段的名稱。該名稱將用于定義響應對象中的鍵。 $ args：具有鍵的數組，用于定義用于檢索字段值的回調函數，以更新字段的值并定義其模式。每個這些鍵都是可選的，但如果不使用，則不會添加該功能。 這意味著如果您指定一個回調函數來讀取該值，而不是一個用于更新的回調函數，那么它將是可讀的，但不可更新。這在許多情況下可能是需要的。 應在rest_api_init操作中注冊字段。使用此操作而不是init將阻止在不使用REST API的WordPress請求期間發生字段注冊。 ## 在評論回應中讀寫一個額外的字段 這個例子的TODO： 將匿名函數更改為命名函數（討論） 權限檢查如何工作？ 錯誤處理？ （在什么條件下更新代碼被調用，還有什么其他檢查需要在現實世界插件中完成？） 開發手冊中的代碼塊的更短的線條和/或樣式修復 ``` <?php add_action( 'rest_api_init', function() { register_rest_field( 'comment', 'karma', array( 'get_callback' => function( $comment_arr ) { $comment_obj = get_comment( $comment_arr['id'] ); return (int) $comment_obj->comment_karma; }, 'update_callback' => function( $karma, $comment_obj ) { $ret = wp_update_comment( array( 'comment_ID' => $comment_obj->comment_ID, 'comment_karma' => $karma ) ); if ( false === $ret ) { return new WP_Error( 'rest_comment_karma_failed', __( 'Failed to update comment karma.' ), array( 'status' => 500 ) ); } return true; }, 'schema' => array( 'description' => __( 'Comment karma.' ), 'type' => 'integer' ), ) ); } ); ``` 此示例說明如何將一個稱為業務的字段添加到帖子的響應中。 它的作用是因為comment_karma字段存在，但未被核心使用。 請注意，實際執行評論業務需要使用單獨的端點。 使用Meta＆register_meta 在帖子回復中讀寫一個后期元字段 ``` <?php // The object type. For custom post types, this is 'post'; // for custom comment types, this is 'comment'. For user meta, // this is 'user'. $object_type = 'post'; $args1 = array( // Validate and sanitize the meta value. // Note: currently (4.7) one of 'string', 'boolean', 'integer', // 'number' must be used as 'type'. The default is 'string'. 'type' => 'string', // Shown in the schema for the meta key. 'description' => 'A meta key associated with a string meta value.', // Return a single value of the type. 'single' => true, // Show in the WP REST API response. Default: false. 'show_in_rest' => true, ); register_meta( $object_type, 'my_meta_key', $args1 ); ``` 此示例顯示如何允許讀取和寫入后期元字段。 這將允許通過POST請求將宇宙飛船字段更新為wp-json / wp / v2 / posts / <post-id>，或者通過POST請求發送到wp-json / wp / v2 / posts / 。 >[warning] 請注意，對于在自定義帖子類型上注冊的元字段，帖子類型必須支持自定義字段。 否則，元字段不會出現在REST API中。