カスタムフィールドの情報をWordPress REST APIで取得

カスタムフィールド作成

カスタムフィールドを作成する方法は以下の3つ

• 既存機能を使う
• functions.phpに書く
• プラグインを使う

少し調べて試してみた結果、WordPress REST APIでカスタムフィールドを扱えてかつ難易度が低いものは「プラグインを使う」方法かなと思います。
というわけで今回はAdvanced Custom Fieldsというプラグインを使ってのカスタムフィールドの作り、その情報をACF to REST APIというプラグインを使いAPIで取得できるようにしていきます。

Advanced Custom Fields

デフォルトでもカスタムフィールドを作成できますが、Advanced Custom Fields（ACF）を使うと簡単にカスタムフィールドを作成することができるだけでなく、複雑な要件を満たすことも可能になるそうです。

使い方

プラグインをインストールすると左メニューに「カスタムフィールド」ができます。
ここから「新規追加」をクリックします。

そうすると「フィールドグループ」と言うものが作成できます。
上部の「タイトルを追加」部分にフィールドグループの名前を付けましょう。
そしてその下の「フィールドを追加」ボタンをクリックしフィールドを作成します。

フィールドは色々設定がありますが、最低限「フィールドラベル」「フィールド名」「フィールドタイプ」を入力します。
フィールドを作成したら位置を設定します。これを設定することでどこでこのカスタムフィールドを表示するかを決定します。

設定できたら投稿画面を見てみましょう。
作成したカスタムフィールドが表示されているはずです。

ACF to REST API

ACFで追加したカスタムフィールドはデフォルトでは取得出来ません。
（そもそもWordPress REST APIはデフォルトではカスタムフィールドのデータを取得できない。）
これを取得するために、ACF to REST APIというプラグインを導入します。

これを入れると投稿取得のAPIで

  "acf": {
    "test1": "xxxx"
  }

acfという項目が追加されます。

まとめ

Advanced Custom FieldsとACF to REST APIプラグインを導入して、カスタムフィールドの情報をWordPress REST APIで取得できるようにしました。
既存のWordPressソースをいじることなく簡単にできるのでおすすめです。