API包括一些控制API如何處理請求/響應處理的全局參數(也稱為“元參數”)。 它們在實際資源本身以上的層次上運行,并且在所有資源上可用。
## _jsonp
API原生支持JSONP響應,以允許傳統瀏覽器和客戶端的跨域請求。 此參數需要一個JavaScript回調函數,它將被添加到數據中。 然后可以通過`<script>`標簽加載該URL。
回調函數可以包含任何字母數字,_(下劃線)或。 (期)字。 包含無效字符的回調將收到HTTP 400錯誤響應,不會調用回調。
注意:現代瀏覽器可以使用跨域請求的跨原始資源共享(CORS)預檢要求,但可以使用JSONP來確保所有瀏覽器的支持。
瀏覽器支持
關于CORS的MDN文章
例如:
```
<script>
function receiveData( data ) {
// Do something with the data here.
// For demonstration purposes, we'll simply log it.
console.log( data );
}
</script>
<script src="https://demo.wp-api.org/wp-json/?_jsonp=receiveData"></script>
```
## _method (或X-HTTP-Method-Override標題)
某些服務器和客戶端無法正確處理API使用的一些HTTP方法。 例如,對資源的所有刪除請求都使用DELETE方法,但有些客戶端不提供發送此方法的功能。
為了確保與這些服務器和客戶端的兼容性,API支持方法覆蓋。 這可以通過_method參數或X-HTTP-Method-Override標頭傳遞,其值設置為要使用的HTTP方法。
警報:客戶端應該只發送具有POST請求的方法覆蓋參數或頭。 使用GET請求的方法覆蓋可能會導致請求被錯誤地緩存。
一個POST到/ wp-json / wp / v2 / posts / 42?_method = DELETE將被轉換為DELETE到wp / v2 / posts / 42路由。
類似地,以下POST請求將成為DELETE:
```
POST /wp-json/wp/v2/posts/42 HTTP/1.1
Host: example.com
X-HTTP-Method-Override: DELETE
```
## _envelope
與_method類似,一些服務器,客戶端和代理不支持訪問完整的響應數據。 API支持傳遞一個_envelope參數,該參數發送正文中的所有響應數據,包括頭文件和狀態代碼。
如果在查詢字符串(GET參數)中傳遞了_envelope參數,則啟用信封模式。 該參數不需要一個值(即?_envelope有效),但如果客戶端庫需要,可以將其作為值“1”傳遞。
注意:為了將來的兼容性,不應該傳遞其他值。
包含的回應包括一個“假的”HTTP 200響應代碼,沒有額外的標頭(Content-Type除外),應該確保響應正確地通過中介。
例如,給予對wp / v2 / users / me的GET的以下響應:
```
HTTP/1.1 302 Found
Location: http://example.com/wp-json/wp/v2/users/42
{
"id": 42,
...
}
```
等效的包絡響應(使用GET到wp / v2 / users / me?_envelope)將是:
```
HTTP/1.1 200 OK
{
"status": 302,
"headers": {
"Location": "http://example.com/wp-json/wp/v2/users/42"
},
"body": {
"id": 42
}
}
```
## _embed
大多數資源包括相關資源的鏈接。 例如,一個帖子可以鏈接到父帖子,或者發表評論。 為了減少所需的HTTP請求數量,客戶端可能希望獲取資源以及鏈接的資源。 _embed參數向服務器指示響應應包括這些嵌入式資源。
如果在查詢字符串(GET參數)中傳遞了_embed參數,則嵌入模式被啟用。 該參數不需要一個值(即__embed是有效的),但是如果客戶端庫需要,則可以將“1”作為值傳遞。
>[warning] 注意:為了將來的兼容性,不應該傳遞其他值。
嵌入模式中的資源將在包含鏈接資源的_links鍵旁邊包含一個附加的_embedded鍵。 將嵌入嵌入式參數設置為true的鏈接。
有關鏈接和嵌入的更多信息,請參閱鏈接和嵌入頁面。
- 簡介
- 主題開發
- WordPress許可證
- 什么是主題
- 開發環境
- 主題開發示例
- 主題基礎
- 模板文件
- 主樣式表(style.css)
- 文章類型
- 規劃主題文件
- 模板層級
- 模板標簽
- 循環
- 主題函數
- 連接主題文件和目錄
- 使用CSS和JavaScript
- 條件標簽
- 類別,標簽和自定義分類
- 模板文件
- 內容模板文件
- 頁面模板文件
- 附件模板文件
- 自定義內容類型
- 部分和其他模板文件
- 評論模板
- 分類模板
- 404頁面
- 主題功能
- 核心支持的功能
- 管理菜單
- 自定義Headers
- 自定義Logo
- 文章格式
- 置頂文章
- Sidebars
- Widgets
- 導航菜單
- 分頁
- 媒體
- Audio
- Images
- Galleries
- Video
- 精選圖片和縮略圖
- 國際化
- 本地化
- 輔助功能
- 主題選項 – 自定義API
- 定制對象
- 改進用戶體驗的工具
- 定制JavaScript API
- JavaScript / Underscore.js渲染的自定義控件
- 高級用法
- 主題安全
- 數據消毒/逃避
- 數據驗證
- 使用隨機數
- 常見漏洞
- 高級主題
- 子主題
- UI最佳實踐
- JavaScript最佳做法
- 主題單元測試
- 驗證你的主題
- Plugin API Hooks
- 發布你的主題
- 所需的主題文件
- 測試
- 主題評論指南
- 寫文檔
- 提交你的主題到WordPress.org
- 參考文獻
- 模板標簽列表
- 條件標簽列表
- 編碼標準
- HTML編碼標準
- CSS編碼標準
- JavaScript編碼標準
- PHP編碼標準
- 插件開發
- 插件開發簡介
- 什么是插件
- 插件基礎
- 頭部要求
- 包括軟件許可證
- 啟用 / 停用 Hooks
- 卸載方法
- 最佳做法
- 插件安全
- 檢查用戶功能
- 數據驗證
- 保護輸入
- 保護輸出
- 隨機數
- Hooks
- Actions
- Filters
- 自定義Hooks
- 高級主題
- 管理菜單
- 頂級菜單
- 子菜單
- 短代碼
- 基本短碼
- 封閉短碼
- 帶參數的短代碼
- TinyMCE增強型短碼
- 設置
- 設置API
- 使用設置API
- 選項API
- 自定義設置頁面
- 元數據
- 管理帖子元數據
- 自定義元數據
- 渲染元數據
- 自定義文章類型
- 注冊自定義文章類型
- 使用自定義文章類型
- 分類
- 使用自定義分類
- 在WP 4.2+中使用“split術語”
- 用戶
- 創建和管理用戶
- 使用用戶元數據
- 角色和功能
- HTTP API
- JavaScript
- jQuery
- Ajax
- 服務器端PHP和入隊
- Heartbeat API
- 概要
- 計劃任務
- 了解WP-Cron計劃
- 安排WP-Cron 事件
- 將WP-Cron掛接到系統任務計劃程序中
- WP-Cron簡單測試
- 國際化
- 本地化
- 如何國際化您的插件
- 國際化安全
- WordPress.org
- 詳細插件指南
- 規劃您的插件
- 如何使用Subversion
- 插件開發者常見問題
- 開發工具
- Debug Bar 和附加組件
- 輔助插件
- REST API手冊
- 資源
- 文章
- 文章修訂
- 文章類型
- 文章狀態
- 類別
- 標簽
- 頁面
- 評論
- 分類
- 媒體
- 用戶
- 設置
- 使用REST API
- 全局參數
- 分頁
- 鏈接和嵌入
- 發現
- 認證
- 經常問的問題
- 骨干JavaScript客戶端
- 客戶端庫
- 擴展REST API
- 添加自定義端點
- 自定義內容類型
- 修改回應
- 模式
- 詞匯表
- 路由和端點
- 控制器類