WordPress REST API を有効化にする!使い方!エンドポイント?プラグイン!必要なの?

Does WordPress need REST API?
  • URLをコピーしました!
How To Use The WordPress REST API Plugin
How To Use The WordPress REST API Plugin

今回はWordPress REST API の使い方を説明します。具体的にはAPIの追加方法や有効化です。プラグインはあるのか?REST APIは必要なのかも紹介します?

WordPress REST APIは、開発者がWordPressの外からWordPressにアクセスするためのインターフェースです。

JavaScript を使用してアクセスするため、インタラクティブな Web サイトやアプリを作成するために使用できます。

目次

WordPress REST APIは必要なの?プラグインは?

必要なの?

WordPressはすでにサイト構築のための豊富なツールやインターフェイスを提供しており、あなたのサイトがすでに期待通りに動いているのであれば、REST APIを使うことにプレッシャーを感じる必要はないでしょう。WordPress のテーマやプラグインを構築するために REST API を使用する必要はありません。

プラグインは?

バージョン4.4以降、このWP APIは標準で搭載されています。

そのためWordPress REST API の仕組みを理解するために、いくつかの概念や機能を知っておく必要があります。

WordPress REST API の使い方!有効化は?

How to use the WordPress REST API! How do I enable it?
How to use the WordPress REST API! How do I enable it?

WordPress REST API の使い方や有効化の方法は下記に示します。

REST APIにアクセスする

WP-REST APIへのアクセスは、コマンドラインから行います。

WordPressでは、これはWP-CLIと呼ばれています。

実際、管理画面を介して、またはサイトのコードに直接アクセスして、これを実行することはありません。

リモートサイトにアクセスするには、SSHでサーバーに接続して、WP-CLI経由でこれを実行する必要があります。

ローカルサイトにアクセスするには、コマンドラインから正しいディレクトリストラクチャを使用するだけでOKです。本番サイトで試す前に、ローカルテストサイトでREST APIを試すことをお勧めします。

REST APIにアクセスする必要があります。このあと、特定の種類のデータにアクセスするための要素を追加します。

×××.com/wp/v2

WP-CLIを使ってWP-RESTにアクセスする

WP-CLIは、WordPress用のコマンドラインインターフェースです。コンピューターのコマンドラインインターフェース(CLI)を介して、WordPressにアクセスし作業ができるようになります。ちなみにWP-CLIは、すべてのKinstaホスティングプランにプリインストールされています。

CLIにアクセスするには、MacまたはLinuxでターミナルを開くか、Windowsでコマンドプロンプトを開きます。

HTTPエンドポイントを送信できるアプリケーションであれば、WordPress REST APIに「アクセス」することができます。
例えば、お気に入りのブラウザで以下のコマンドを入力すると、WordPress の投稿の一覧が JSON 形式で返ってきます。
GET yourwebsiteurl.com/wp-json/wp/v2/posts

ただし、プレースホルダー(※1)のURLは自分のウェブサイトのものに置き換える必要があります。また、REST APIのリクエストを動作させるには、WordPressのバージョンが4.4以上である必要があります(すでに動作しているはずです)。

しかし、REST APIを実際に試してみたい場合、ブラウザは最適なツールではありません。代わりに、より柔軟なアプローチを提供するコマンドラインを使用することをお勧めします。

※1プレースホルダとは、実際の内容を後から挿入するために、とりあえず仮に確保した場所のこと。 また、そのことを示す標識などのこと。文書の編集などで、あるページに写真を掲載することは決まっているが、実際の画像データは後で手に入るような場合に、とりあえず四角い空白領域を作り「ここに写真Aを貼る」などとメモを記すことがある。この空白をその写真のプレースホルダであるという

REST APIを使用して特定の投稿を取得する

実行したコマンドは、WordPress の全投稿のリストを、その投稿 ID を含めて返したはずです。IDを使って特定の投稿を取得するには、次のようなエンドポイントを使用します。

GET yourwebsiteurl.com/wp-json/wp/v2/posts/535

GET yourwebsiteurl.com/wp-json/wp/v2/posts/535

モバイルアプリケーションで特定の投稿を紹介するのに適しています。

しかし、WordPress REST APIはWordPressからあらゆるデータを取得できるため、その実用的な用途は非常に柔軟です。

REST APIを使って、単に記事を取得するだけでなく、選択した記事にメタデータを追加したいとします。

その場合にはGETメソッドではなくPOSTメソッドを使用することになります。

特定の投稿にメタデータを追加する

すでに認証済みであると仮定すると、最後のセクションで紹介したのと同様のリクエストを使用して、GETの代わりにPOSTを使用して、任意の投稿に新しいデータを追加することができます。

POST yourwebsiteurl.com/wp-json/wp/v2/posts/535/meta?value=newmetadata

例えば、リッチスニペットを作成するために使用できるメタデータを追加したい場合、リクエストは次のようになります。

POST yourwebsiteurl.com/wp-json/wp/v2/POST yourwebsiteurl.com/wp-json/wp/v2/posts/535/meta?cookingtime=25

追加するメタデータの量によっては、JSONオブジェクトで指定した方が、より構造化されたアプローチになります

。いずれにせよ、最も一般的なエンドポイントが何であるか、そしてそれをどのように使用するかを理解すれば、あらゆる可能性が開けます。

WordPressにエンドポイントを追加する

WordPress REST API EndPoint Multiple
WordPress REST API EndPoint Multiple

WordPress REST APIは、カスタムルートとカスタムエンドポイントをサポートしています。これらは、2つ目のWordPressサイトを作成し、2つのサイト間の統合を追加したい場合に便利です。

REST APIのルートは、エンドポイントも無制限にサポートしています。

各エンドポイントには、HTTPメソッド、コールバック関数、パーミッションを指定できるほか、デフォルト値やその他いくつかのパラメータを指定することができます。

まとめ

WordPressのREST APIが登場してから数年が経ちました。

これまで使ったことがない場合、高度なアプリケーションを開発するために使えるようになるには、学ばなければならないことがたくさんあります。

よかったらシェアしてね!
  • URLをコピーしました!
  • URLをコピーしました!

コメント

コメントする

目次
閉じる