WordPress API: 概要と使用方法

公開: 2024-09-13

WordPress JSON REST API は、WordPress コミュニティで大きな話題を呼び、開発者とコンテンツ作成者の両方に新たな可能性を提供します。

複雑に聞こえるかもしれませんが、JSON、REST、API などの重要な用語を理解すると、WordPress の幅広い機能を簡単に操作できるようになります。

APIとは何ですか?

API は「アプリケーションプログラミングインターフェイス」の略で、基本的にはさまざまなソフトウェアアプリケーションが相互に通信できるようにするプログラミング命令と標準のセットです。

あるソフトウェアアプリケーションが別のソフトウェアアプリケーションに指示を与えることを想像してください。API は、この対話を管理する合意されたルールのセットです。あるソフトウェアが別のソフトウェアに指示を送信すると、API はアクションを促進したり、必要な情報を提供したりします。

API は 2 つのソフトウェアシステム間の「ユーザーインターフェイス」と考えることができ、データの通信とタスクの実行を処理しますが、エンドユーザーには見えません。

APIの例

Web アプリケーションを開発する場合、API にアクセスできると非常に便利です。 API が公開されるということは、開発者がソフトウェアのサービスを活用したソリューションを作成したことを意味します。多くの場合、タスクはすでに作成されているため、多くのタスクを再発明する必要がなくなります。

API の好例は Amazon です。 Amazon は、開発者が製品とその情報に簡単にアクセスできるように API をリリースしました。これにアクセスすると、価格が更新され、購入オプションが表示される商品へのリンクを Amazon に簡単に投稿できます。

API の対話のもう 1 つの例は、コンサートチケットの購入です。チケットを正式に購入するにはクレジットカード情報の入力が必要です。 API を使用してクレジットカード情報がリモートアプリケーションに送信され、クレジットカード情報が正しいことが検証されます。

すべてがチェックアウトされると、リモートアプリケーションはチケット Web サイトに続行しても問題ないという応答を返します。この時点でチケットは正常に購入されます。これらすべてが行われると、インターフェースは 1 つだけ表示され、それがチケット Web サイトです。これはシームレスなプロセスです。舞台裏では、多くのアプリケーションが API を使用して連携していますが、ユーザーであるユーザーは、タスクがあるアプリケーションから別のアプリケーションに渡されることに気づきません。

APIとWordPress

Amazon とチケットの購入は、API がどのように連携するかを示す良い例ですが、これは WordPress にどのように適用されるのでしょうか?

まあ、すべて同じ考えが当てはまります。 WordPress API を使用すると、WordPress にデータをプッシュしたり、WordPress からデータをプルしたりできます。

API は、開発者が WordPress Web サイトから他の Web サイトやアプリケーションにデータを簡単に共有するために使用できる重要なツールです。具体的には、この API を使用すると、WordPress コンテンツに対してcreate 、 read 、 update 、およびdelete (CRUD) アクションを実行できます。コンテンツタイプの例をいくつか示します。

投稿
カスタム投稿タイプ
ページ
分類法
ユーザー
メディア

休息とはどういう意味ですか?

ここでは昼寝やいびきをかくことはありません。REST は API のアーキテクチャスタイルを指します。 REST は Representational State Transfer の略です。

プログラムが相互に通信できるように、API によって通信の詳細が提供されると述べたことを覚えていますか? REST API は、帯域幅を節約する軽量の通信方法を提供するように設計されています。 WordPress JSON REST API はまさにこれを行うため、大量のデータがある場合に最適なオプションになります。

ここでは REST の表面をなぞっただけです。さらに詳しく知りたい場合は、この REST に関する役立つチュートリアルを参照してください。

JSON形式

データにアクセスするには、取得元のソースが必要です。ここで JSON が登場します。JSON は JavaScript Object Notation の略です。

JSON は、人間にとっても機械にとっても読みやすく、理解するのが簡単です。これは、情報を整理してアクセスしやすい方法で保存するのに最適な方法です。 JSON はアクセスが非常に簡単であるため、REST API の作成に最適であり、WordPress JSON REST API に最適なソリューションです。

JSON 形式がどのようなものであるかについての基本的な考え方は次のとおりです。

[JavaScript]
{"従業員"：[
{“名”:“ジェーン”, “姓”:“スミス”},
{“名”:“アンナ”, “姓”:“オルセン”},
{“名”:“ジョシュ”、“姓”:“ジョーンズ”}
]}

[/javascript]

WordPress の JSON 形式

JSON はそれ自体を書き込むだけではありませんが、JSON ファイルを手動で作成する必要はないので、ご安心ください。それを作成できるプラグインがあります。これらのツールのいずれかを使用すると、サイトのデータ (ユーザー、投稿、ページ、分類法などを含む) が正しい形式になります。

JSON REST APIの使用

API の使用方法は一目瞭然です。サイトのデータを単純な JSON 形式で取得します。プラグインがインストールされている場合は、サイトの投稿をデータ形式で表示してみることができます。

データの取得または更新は、HTTP リクエストを送信するのと同じくらい簡単です。 HTTP はリクエスト/レスポンスプロトコルです。まず、データのリクエストを送信すると、データが応答として返されます。

GETメソッド

GET メソッドは情報を取得するために使用され、データには影響しません。 GET リクエスト/wp-json/wp/v2/postsに送信するだけです。何かを検索したいですか?たとえば、「開発」を検索すると、GET リクエスト/wp-json/wp/v2/posts?search=developmentで結果が得られます。

POSTリクエスト

データの送信には POST リクエストが使用されます。新しい API の機能を使用すると、たとえばユーザーを更新できます。 ID 10 のユーザーを更新するとします。必要なのは、POST リクエスト/wp-json/wp/v2/users/10に送信することだけです。

これを試すには、Google Chrome 拡張機能である Postman を使用することをお勧めします。

より多くの Javascript が混在

Backbone.js と API

Backbone.js は REST API を操作するために設計されたフレームワークであるため、API を操作するのに最適な方法です。 WordPress API には、バックボーンモデルに基づいた使いやすい Javascript API が含まれています。これにより、プラグインやテーマの開発者は、接続の詳細に関する非常に深い労力や知識がなくても、起動して実行できるようになります。

他にもたくさんの機能がありますが、Backbone はモデル、コレクション、ビューを提供することで Web アプリケーションに構造を与え、それをすべて REST JSON インターフェイス経由で WordPress API に接続します。

これは WordPress 開発者にとって何を意味しますか?

WordPress API が利用できるようになったことで、WordPress API を利用する新しい方法が増えており、人気が高まるにつれて今後も利用され続けるでしょう。 WordPress API は、JavaScript に依存する既存の WordPress 機能をほぼすべて改善できます。以下にいくつかの例を示します。

フォームの検証/送信
Backbone.js テーマまたはプラグイン
無限スクロール

他のソースからのコンテンツを表示するのにも最適な方法です。マルチサイト設定内で個々のサイトのコンテンツを簡単に表示できるようになりました。まったく別の WordPress サイトのコンテンツを表示することもできます。コンテンツを表示するだけでなく、コンテンツをより簡単かつ効果的に更新することもできます。

基本的な用語をいくつか説明したので、JSON が表記法、REST がアーキテクチャスタイル、API がそれらを構成するインターフェイスであることがわかりました。 API とその機能の基本を理解していれば、WordPress API の新しい可能性を探る際に良いスタートを切ることができます。