WordPress REST API入門基礎知識點

WordPress REST API正在改變WordPress。您可能沒有注意到，因為其中很多都在幕後，但是REST API的含義對WordPress的未來產生了巨大的影響，無論是在程式碼庫還是使用方面。

如果您沒有使用過WordPress REST API，您可能想知道它是什麼。因此，讓我們先看看REST API是什麼。

在本文中，我們講解WordPress REST API的一些基礎知識。我們將研究它的作用、工作原理以及它給平臺帶來的變化。最後，我們將討論您可以用它做的一些事情。

當REST API最終被新增到WordPress的核心時，漫長的旅程就結束了。許多人預計這一變化是該平臺歷史上WordPress向前邁出的最大一步。但是，如果您不熟悉REST API，您可能會對它所獲得的所有關注感到困惑。

簡而言之，WordPress REST API的加入使WordPress變成了一個功能齊全的應用程式框架。這顯著提高了它的“可擴充套件性”，或者說它可以通過新特性和功能進行擴充套件。此外，它還擴充套件了平臺與其他站點和應用程式進行通訊的潛力。

1. 什麼是WordPress REST API？
2. 瞭解WordPress REST API
3. 如何訪問WordPress REST API
4. WordPress REST API命令概述
5. 何時不使用WordPress REST API
6. 使用WordPress REST API的實際應用程式

什麼是WordPress REST API？

在我們深入研究WordPress REST API之前，瞭解我們的術語很重要。這是一個我們需要使用大量首字母縮略詞的主題，所以讓我們先把它們弄清楚。

什麼是應用程式程式設計介面 (API)？

首先，您需要知道什麼是應用程式程式設計介面 (API)。用最簡單的術語來說，API是一個系統使其他系統能夠連線到其資料的一種方式。例如，當網站向頁面新增Facebook的“Like”按鈕時，它會通過連線到Facebook的API來實現這一點。這讓網頁可以使用API來接收資料（點贊按鈕的程式碼）和傳送資料（點贊請求）。

應用程式程式設計介面或API被定義為：

“客戶端和伺服器之間的介面或通訊協議，旨在簡化客戶端軟體的構建。”

如果您不熟悉API，那可能沒有多大幫助。更簡單地說，API是一組允許一個系統與另一個系統互動（或“介面”）的程式碼。如果您曾經將Google地圖新增到您的WordPress站點，那麼您就使用了Google的Maps API，它允許您的WordPress站點與Google Maps互動。

這些系統不需要完全分開。WordPress已經有多個API，用於外掛、設定和短程式碼等。外掛和主題開發人員可以使用這些來與WordPress核心進行互動並使事情發生（例如建立短程式碼和向WordPress管理員新增設定螢幕）。

與REST API的不同之處在於它允許WordPress安裝本身之外的系統與WordPress互動，這就是REST部分的用武之地。

什麼是具象狀態轉移 (REST)？

那麼，REST API究竟是什麼？具象狀態傳輸 (REST)是一種特定於Web服務的 API。它包含一組標準化的指令和規則，使所有“RESTful”服務更容易相互連線。

簡而言之，REST API使您能夠向外部系統發出請求。這方面的一個例子是Twitter。您可以使用其API向特定使用者請求一定數量的推文。然後API將根據您的請求返回推文，您可以使用HTML和CSS將其嵌入您的網站。

這些請求是使用JavaScript Object Notation (JSON) 執行的。這是一種專為傳送、接收和儲存資料而設計的語言。我們將在本文後面介紹JSON，但我們建議您先花點時間熟悉一下這種語言。這將幫助您準備好使用WordPress REST API，並理解我們將要討論的一些概念。

WordPress REST API是一個介面，開發人員可以使用它從WordPress安裝本身之外訪問WordPress。您可以使用JavaScript訪問它，這意味著它可用於建立互動式網站和應用程式。

REST代表 Representational State Transfer，API 代表應用程式程式設計介面。讓我們來看看每一個的含義。

Representational State Transfer (REST) 提供了 Web 系統可以用來相互互動的標準。如果沒有 REST，兩個系統將無法相互理解，從而來回傳送資料。

要使應用程式成為RESTful，它必須符合五個原則：

1. 統一介面。用於訪問系統中資源的URL必須是統一的、一致的，並且可以通過常見的方法（例如GET）（稍後會介紹更多）進行訪問。
2. 客戶端伺服器。客戶端應用程式和伺服器應用程式必須是分開的，因此它們可以相互獨立開發。如果伺服器端技術（即 WordPress）發生變化，伺服器端應用程式（例如一個應用程式）必須仍然能夠通過相同的簡單方法訪問它。
3. 無國籍。使用API發出新請求時，伺服器不會更改狀態。它不儲存已發出的請求。
4. 可快取。所有資源都必須是可快取的，以提高速度並符合Web標準。快取可以在伺服器端或客戶端實現。
5. 分層系統。RESTful系統允許您使用多個層來訪問它，如果需要，將資料儲存在中間伺服器中。伺服器無法判斷最終客戶端是否直接連線到它。

所有這些約束都與網頁和應用程式相關，並控制應用程式與API互動的方式。

這對WordPress意味著什麼？

將REST和API放在一起意味著WordPress REST API是一組程式碼，旨在使其他系統能夠與WordPress互動，並且它的構建方式可確保這些系統能夠相互理解。

這意味著第三方網站或移動應用程式，例如，可以訪問您的WordPress資料庫，從中獲取資料並向其中新增資料。

不過，這有許多含義和用途。

瞭解WordPress REST API

WordPress REST API的功能與我們已經提到的例子大體相同。基本上，WordPress REST API使您可以從任何與JSON相容的框架中訪問WordPress的所有功能。

與Twitter的API使您能夠檢索和傳送推文的方式類似，WordPress REST API可用於管理來自外部平臺的文章、使用者、類別等。這使您能夠以多種前所未有的方式使用WordPress。

WordPress REST API的背景

REST API早在2013年就宣佈了，它以外掛的形式開始，旨在通過4.1版將其合併到WordPress核心中。正如經常發生的那樣，延遲會推遲釋出，直到三年後隨著WordPress 4.7的釋出，它最終被實現到核心中。

WordPress REST API於2016年12月作為4.7版核心的一部分發布，但在此之前它作為外掛存在。

對於許多人來說，這是一個漫長但值得的等待，他們將WordPress REST API視為平臺向前邁出的重要一步。您可能想知道為什麼這個新增如此重要，特別是因為很多使用者可能沒有注意到太大的區別。事實證明，出於多種原因，包含REST API是對WordPress的根本性更改。

例如，通過實施REST API，WordPress從簡單的建立網站的平臺邁出了一步。相反，它現在已經成為一個成熟的應用程式框架。這意味著開發人員可以使用WordPress站點為移動裝置和網路建立應用程式，或作為資訊儲存庫。

這種轉變也使WordPress擺脫了對PHP的依賴。通過使WordPress與任何JSON-compatible語言相容，REST API極大地擴充套件了開發人員的可能性，使他們能夠將WordPress功能與幾乎任何框架一起使用。

它旨在支援一系列基於WordPress構建的應用程式，並將WordPress從內容管理系統轉變為應用程式平臺。

它被WordPress.com廣泛使用，其基於JavaScript的介面使用REST API與WordPress資料庫進行互動。古騰堡編輯介面也使用它，該介面在2019年成為核心的一部分。

REST API擴大了WordPress可用於的應用程式範圍。雖然內容管理系統擅長執行復雜的網站，但應用程式平臺也可用於支援基於Web的單頁應用程式或SPA（如果您曾經使用過Google文件，那麼您已經使用過其中之一）。

在這些中，當使用者執行操作時會重新整理內容，而不是載入新頁面。因為它使用JavaScript（一種客戶端語言）而不是PHP（一種伺服器端語言），所以它可以在使用者的​​瀏覽器中進行操作，而無需不斷地向伺服器傳送請求。

對WordPress使用者和開發人員的影響

如果您是使用WordPress的使用者和/或開發人員，那麼REST API有很多含義。

對於使用者，這些包括：

• 對介面的更改，包括古騰堡編輯器。
• 對WordPress移動應用程式的更改和改進。
• 隨著時間的推移，自託管的WordPress管理螢幕看起來更像WordPress.com螢幕。

對於開發者來說，還有更廣泛的意義和可能性：

• 能夠使用REST API建立SPA，從WordPress中提取資料，但看起來與WordPress非常不同。
• 將WordPress與其他前端技術和系統整合的能力。
• 如果您是不編寫PHP的前端開發人員，則可以使用WordPress進行開發。
• 對於PHP開發人員來說，越來越需要擴充套件您的技能以包含JavaScript。
• 特定更改，例如需要在頁面和後期編輯螢幕中構建古騰堡區塊而不是元框。

隨著時間的推移，WordPress REST API將意味著更多的WordPress核心將用JavaScript而不是PHP編寫。如果您是WordPress開發人員，這意味著您需要學習JavaScript。

REST API和JSON如何協同工作

最後，REST API在可用於平臺的介面方面提供了更高的靈活性。它使管理介面完全可選，因為您現在可以完全通過JSON命令與您的WordPress站點進行互動。讓我們看看JSON和REST API如何結合起來使這成為可能。

WordPress REST API是為了響應網站和應用程式開發方式的變化以及更廣泛地開放WordPress的需要而開發的。

到目前為止，您應該對WordPress REST API的理論方面有所瞭解，所以讓我們看看該技術更實用的方面。官方手冊介紹如何使用REST API，如下所示：

“WordPress REST API為WordPress資料型別提供API端點，允許開發人員通過傳送和接收JSON（JavaScript Object Notation）物件與站點進行遠端互動。”

我們需要關注的第一個詞是“端點”。將端點視為可以使用JSON請求呼叫的一段資料或函式的最簡單方法。預設情況下，WordPress提供了大量可供使用的標準端點，但開發人員也可以建立自定義端點。

要到達端點，您必須使用採用普通URL形式的“路由”。您現在甚至可以自己嘗試一下。轉到您自己的WordPress站點，並將/wp-json/wp/v2 新增到其URL的末尾。如果您的站點是http://example.com，您將輸入http://example.com/wp-json/wp/v2。

當您載入此路由時，您將到達端點，在這種情況下，它以（凌亂的）JSON格式返回站點的所有內容和後設資料。通過使用不同的路由，您可以訪問不同的端點，以獲取特定型別的資訊並執行各種任務。

您將在REST API中使用三個主要的JSON請求，所以現在讓我們快速瀏覽一下它們。他們是：

• GET-此類請求用於從API檢索和列出資料。例如，您將使用GET請求返回您網站上的使用者列表或編譯特定時間範圍內的部落格文章。
• POST-此請求用於向API傳送資料。它使您能夠將新資訊推送到WordPress，例如新增新使用者和帖子或更新現有資料。
• DELET-顧名思義，這個請求是用來刪除資料的。這使您能夠刪除文章、頁面、使用者等。

有時可以將GET和POST與相同的端點一起使用以獲得不同的結果。例如，讓我們看看端點/me/settings/。如果您要在此端點上執行GET請求，您將收到當前使用者設定的列表。但是，通過在同一端點上使用POST請求，您將能夠改為更新設定。

如何訪問WordPress REST API

您如何訪問WordPress REST API？

要訪問WP-REST API，您需要通過命令列訪問您的站點。對於WordPress，這稱為WP-CLI。您不會通過管理螢幕或直接訪問您網站上的程式碼來執行任何這些操作。

讓我們來看看你是如何開始的。

通過WP-CLI 訪問WP-REST

WP-CLI是WordPress命令列介面。它允許您通過計算機上的命令列介面 (CLI) 訪問和使用WordPress。

要訪問CLI，請在Mac或Linux中開啟終端，或在Windows中開啟命令提示符。

要訪問遠端站點，您需要SSH到您的伺服器以通過WP-CLI訪問它（無法通過SSH連線？瞭解如何修復SSH“連線被拒絕”錯誤）。

要訪問本地站點，您只需從命令列使用正確的目錄結構。在實際站點上試用REST API之前，最好先在本地測試站點上試用REST API。

您需要專門訪問您網站的REST API，如下所示：

http://yoursite.com/wp-json/wp/v2

然後，您可以在此之後新增元素以訪問某些型別的資料，我們稍後將更詳細地介紹這些資料。這些元素稱為端點。

驗證

訪問站點後，您可能需要進行身份驗證。一些端點是公共的，不需要身份驗證，而其他端點則需要。

您不是在此處登入站點管理員：REST API的處理方式略有不同。

為了能夠通過WP-CLI對您的站點進行身份驗證，您需要安裝一個身份驗證外掛。對於開發安裝，Basic Auth外掛可以完成這項工作並且很容易使用。

但是，對於實時站點，您應該使用更強大的身份驗證形式，例如JWT身份驗證外掛，它使用JSON Web Token並且更安全。

然後，您可以使用命令列訪問資料幷包括身份驗證。

下面的示例curl用於測試與WordPress的連線。它將輸出一個草稿列表。

curl -X GET --user username:password -i http://yoursite.com/wp-json/wp/v2/posts?status=draft

草稿帖子不是公開資訊，因此您需要進行身份驗證才能訪問它們。但是，如果您要查詢公開資料，則不需要身份驗證。因此，要檢索已釋出的文章列表，您可以使用：

curl -X GET http://yoursite.com/wp-json/wp/v2/posts

這將獲取所有已釋出的文章，因為這些帖子是公開的。

WordPress REST API命令概述

我們現在將把所有這些理論付諸實踐，並向您展示一些非常基本的示例，說明您可以使用REST API做什麼。這只是一種嘗試，以幫助您習慣使用REST API來處理對WordPress的請求。有關更多示例，我們建議您檢視官方參考庫和REST API資源。

以下技術將要求您使用命令列來處理JSON請求。這使您能夠通過使用基於文字的介面和傳送簡單的命令與您的 WordPress 站點進行互動。如果您沒有任何使用命令列的經驗，我們建議您先花一些時間學習基礎知識。您可能還想使用SSH來建立與您的站點的連線。

最後，當您準備好時，讓我們看一些有關如何使用WordPress REST API的示例！

一旦您訪問了您的站點並且您知道如何使用身份驗證（以及您是否需要），您將需要使用一系列命令中的一個來與您的站點進行互動。

您需要使用的命令是：

• GET 檢索資源，例如文章或其他一些資料。
• POST 向伺服器新增資源，例如文章、附件或其他資源。
• PUT 可用於編輯或更新伺服器上已有的資源。
• DELETE從伺服器中刪除資源。小心使用！

讓我們依次來看看其中的每一個。

Get

GET命令可能是最常用的：它檢索資料。下面的示例（您在成功訪問您的網站後使用）將獲取您網站中所有已釋出頁面的列表：

GET http://yoursite.com/wp-json/wp/v2/posts/?status=published

請注意，我沒有在上面的行中包含您站點的完整路徑，因為您已經使用WP-CLI訪問了該路徑。

檢索到該資料後，您可以使用它來通知您的下一步。您可以刪除其中一個文章，對其進行編輯或更新。您可以簡單地將帖子輸出到您的網路應用程式。

假設您想獲取最新的文章。你會用這個：

GET http://yoursite.com/wp-json/wp/v2/posts/?per_page=1

在處理文章時，您可以使用許多引數。有關更多資訊，請參閱WordPress REST API 手冊。

Post

POST用於向您的站點新增新資料或資源。

因此，例如，如果您想建立一個文章，您可以使用以下POST命令開始：

POST http://yoursite.com/wp-json/wp/v2/posts/

這將建立一個新的空草稿文章。

然後，您可以通過使用PUT命令進行編輯來更新文章。

使用POST命令，您還可以新增文章以外的其他資源，包括附件和其他文章型別。

要將頁面新增到您的站點，您可以使用以下方法：

POST http://yoursite.com/wp-json/wp/v2/posts/pages

這會以與建立空文章相同的方式建立一個空頁面。

Put

PUT命令允許您編輯現有資源，包括文章。

假設您的網站上有許多草稿文章。您想檢查它們並更新其中一個以使其釋出。

您可以首先獲取所有草稿文章的列表：

POST http://yoursite.com/wp-json/wp/v2/posts/?status="draft"

系統將為您提供所有當前草稿文章的列表。您可以使用其ID更改其中之一的狀態：

PUT http://yoursite.com/wp-json/wp/v2/posts/567

這將訪問該文章並允許您對其進行編輯。然後，您可以使用status引數更改其狀態：

{
"status" = "publish"
}

或者您可以向文章新增內容併發布它：

{
"status" = "publish"
"content" = "content here"
}

伺服器將返回一個200 - OK狀態，告訴您PUT請求已成功編輯文章。

DELETE

DELETE命令執行您所期望的操作：它刪除一個資源。預設情況下，如果您使用它來刪除文章，它會將其放入垃圾箱，而不是永久刪除。

因此，如果您想將剛剛建立的文章移至垃圾箱，您可以使用以下命令：

DELETE http://yoursite.com/wp-json/wp/v2/posts/567

但是，如果您想繞過垃圾箱並永久刪除它，您可以使用以下force引數：

DELETE http://yoursite.com/wp-json/wp/v2/posts/567?force=true

這將永久刪除文章，無法撤消，因此應謹慎使用。

一些例子

1. 從站點返回文章

雖然您顯然需要適當的授權來編輯站點，但幾乎可以從任何 WordPress 站點檢索一些資訊。這是因為REST API在所有WordPress安裝中都是一致的。

正如我們所討論的，API存在的一個主要原因是使外部應用程式能夠訪問您的某些資料。在此示例中，我們可以從官方WordPress新聞部落格中檢索單個文章：

curl https://wordpress.org/news/wp-json/wp/v2/posts/1

ID已設定為1，這意味著此請求將檢索部落格上的第一篇文章。可能很難看到，因為JSON不是很可讀，但是在程式碼中，您可以找到文章的所有內容和後設資料。

然後，您可以在應用程式中使用此資訊，例如，使用您自己的自定義樣式來顯示它。

如果您想返回部落格中的每篇文章，您所要做的就是刪除末尾的ID。但是，您更有可能希望返回選定數量的帖子。以下請求將返回最新的三個文章：

curl https://wordpress.org/news/wp-json/wp/v2/posts/?per_page=3

您可以在其他網站甚至您自己的部落格上親自嘗試。

2. 更新文章

現在，讓我們嘗試使用REST API對WordPress進行一些更改。為此，您需要登入到要管理的站點。例如，如果您使用SSH，則需要登入到您的伺服器。

在這個例子中，我們將更新一個現有的文章。首先，讓我們使用一個請求來更新ID為1的文章的標題：

curl -X POST http://example.com/wp-json/wp/v2/posts/1 -d '{"title":"A Brand New Title"}'

這是不言自明的。title參數列明您正在更新文章的標題，後跟包含替換內容的文字字串。

還有很多其他的引數，你可以用它來進行更改後。例如，您可以使用列表為文章分配類別、釋出文章或完全更改其內容。

3. 刪除使用者

最後，讓我們看看如何使用REST API刪除資料。在此示例中，我們將從站點中刪除使用者。當然，您需要先登入並授權管理使用者，然後才能使用此功能。

然後，您可以使用以下請求刪除ID為101的使用者：

curl -X DELETE http://example.com/wp-json/wp/v2/users/101

這將從站點中刪除指定的使用者。您可以使用附加引數根據使用者的ID將使用者的文章重新分配給另一個使用者，或者強制永久刪除而不是將使用者新增到垃圾箱。

通過這些示例，您可以開始瞭解REST API如何使您能夠管理站點上的內容並連線到其他站點。如果您想了解更多資訊，我們建議您深入研究REST API手冊，並檢視有關學習JSON的課程。

何時不使用WordPress REST API

WordPress REST API並不總是開發網站或應用程式的正確方法。在使用它進行開發之前，您應該注意以下一些注意事項：

相容性

如果您的應用程式將在不執行JavaScript的裝置上或由可能關閉它的使用者使用，那麼如果您使用的是REST API，它就不會執行。

用PHP編碼的WordPress站點將輸出HTML，因此不會遇到此問題。不使用JavaScript的裝置越來越少，但如果您專門為這些裝置開發，REST API將無法工作。

同樣，如果您的使用者可能會關閉JavaScript，那麼使用REST API會導致問題。出於可訪問性或安全原因，某些使用者會在其瀏覽器中關閉JavaScript。

無障礙

使用JavaScript開發的站點或應用程式並不總是像HTML輸出那樣易於訪問。

這主要是因為JavaScript用於傳遞動態內容的方式可能無法與螢幕閱讀器很好地配合使用，並且可能會給視力障礙或光敏性癲癇患者帶來問題。

使用REST API訪問您的WordPress站點並以可訪問的形式輸出資料意味著您可以克服這些問題，但在開發站點時檢查站點的可訪問性是值得的。

搜尋引擎優化

頻繁重新整理的單頁應用程式有時會導致SEO問題。這是因為第一次輸出頁面時未交付的內容可能不會被搜尋引擎索引。

谷歌和其他搜尋引擎正在迎頭趕上這樣一個事實，即現在許多網站都由SPA驅動，並且正在適當地將它們編入索引。但是，對您使用REST API開發的任何站點進行徹底的SEO稽覈確實值得。

如何禁用WordPress REST API

如果您不希望應用程式能夠使用REST API從您的站點訪問資料，您可以禁用它。請記住，任何人都可以訪問公共資料，而不僅僅是您。

為此，您可以安裝Disable WP REST API外掛。這將為未登入到您的站點的任何人禁用REST API。

禁用WP REST API外掛

或者，您可以向主題的函式檔案中新增一些程式碼或編寫自己的外掛。最好編寫一個外掛，因為這不是特定於主題的功能。

在您的外掛中，只新增兩行：

add_filter( 'json_enabled', '__return_false' );
add_filter( 'json_jsonp_enabled', '__return_false' );

這將完全禁用您站點的REST API。它可能會對您的管理螢幕產生連鎖反應，因此請確保新增後一切正常。

使用WordPress REST API的實際應用程式

REST API為WordPress的未來提供了一些令人興奮的可能性。以下是使用WordPress REST API建立SPA或將WordPress連結到其他站點和技術的應用程式和站點的一些示例。

WordPress.com

WordPress.com介面

WordPress.com管理螢幕完全使用REST API構建，以提供使用者與之互動以管理其站點的SPA。

這使得介面和伺服器之間的動態通訊成為可能，並導致WordPress.org可能及時模仿的使用者友好介面。

區塊編輯器（古騰堡）

古騰堡編輯器

同樣在WordPress管理螢幕中，但這次也在自託管WordPress中，Gutenberg區塊編輯器使用REST API與您的資料庫進行通訊並建立塊。

要使文章型別與Gutenberg編輯器一起使用，它們必須啟用REST API。這意味著，如果您要註冊自定義文章型別並使用Gutenberg，則需要新增以下行以啟用該文章型別的區塊編輯器：

"show_in_rest" = true;

Event Espresso

Event Espresso

Event Espresso是一個WordPress外掛，可讓使用者組織和宣傳活動。它利用REST API，以便使用者可以從WordPress外部訪問其中的資料。這意味著您可以構建移動應用程式或SPA來管理您的活動。

UsTwo

UsTwo

UsTwo是一家數字機構，其網站是使用REST API作為單頁應用程式構建的。這結合了使用React構建的前端和由WordPress提供支援的後端。

他們的單個頁面的內容是模組化的，其結構與標準的WordPress頁面不同。為了完成這項工作，他們使用了一個自定義頁面構建器外掛，讓他們的團隊可以向站點新增模組化內容。

USA Today

USA Today

USA Today的網站是使用WordPress REST API與網站中現有系統和模組的整合重建的。

REST API允許使用JSON將站點內容推送到其他渠道，例如Facebook Instant Articles和Apple News。他們還為他們的體育部分編寫了一個使用JavaScript構建的線上社交遊戲。

小結

WordPress REST API為平臺，是一個巨大的進步，遠離其根源和未來。開發人員從一開始就很興奮，但如果您一開始不熟悉REST API，您可能會對其中的原理感到困惑。

WordPress REST API為WordPress使用者和開發人員帶來了一些令人興奮的挑戰，但也帶來了有趣的機會。這是WordPress的未來，很可能會徹底改變我們使用WordPress進行開發的方式以及我們使用它的方式。