素敵なサムシングを独断と偏見で一方的に紹介するブログ(´・ω・`)

IT

【項目追加】WordPress4.7で追加されたRestAPIのレスポンスにアイキャッチ画像のURLやサイズを追加するやり方【カスタマイズ方法】

投稿日:

スポンサーリンク

336×280




WordPressのAPIではアイキャッチが取れない

WordPress4.7でRestAPIが追加

WordPress4.7で追加された便利な機能として、投稿をREST APIで取得することが可能です。

WordPress はアプリケーションフレームワークへと生まれ変わろうとしています。このプロジェクトは、簡単で理解しやすく、信頼性の高い API フレームワークを開発することを目的として生まれました。そして WordPress 本体の API を開発することも目的としています。

このプラグインは簡単な HTTP ベースの REST API を提供します。あなたのサイトのユーザー、投稿、タクソノミー、その他のデータに対してシンプルな HTTP リクエストを送信することで、取り出したりアップデートすることが可能です。
WP REST API v2 Documentation

デフォルトで取得出来る情報は以下となっています。

上記はpost_id指定ですが、複数取得の場合は同様の配列形式で取得出来ます。

アイキャッチのURLが含まれていない。。。

デフォルトのレスポンスでは、記事内容に関する情報はおおよそ含まれているのですが、アイキャッチに関する情報が含まれていませんorz

他のブログやシステムからREST API経由で関連記事として表示したい場合に、アイキャッチ画像が取れないのは不便ですよね。。。

アイキャッチのURLが含まれていない。。。

しかし、WordpressのREST APIはとてもカスタマイズ性が高く、レスポンス項目を自由に拡張することが出来ますので、今回はREST APIへのアイキャッチ画像を追加する方法をご紹介致します♪

手順

functions.phpに追記

REST APIをカスタマイズするにはfunctions.phpにコードを追加する必要があります。

今回はアイキャッチ画像のURLとサイズを取得出来るようにしてみましょう。
以下を末尾に追記してください。

これは、rest_api_add_image関数で画像のsrc/width/height取得し、custom_wp_rest_api_post関数でregister_rest_field関数を使ってfeatured_imageという項目名でセットし、rest_api_initにアクションを追加しています。

確認

では、実際に再度叩いてレスポンスを確認してみましょう。

正しくfeatured_image項目が追加されましたね♪

オススメの参考書

ワードプレス: 初心者のための完全なステップバイステップガイド2019

WordPressユーザーのためのPHP入門 はじめから、ていねいに。

終わりに

上記のように必要な情報をREST API経由で取得するようにしておきえば、記事ごとに手入力する必要が無くなり、ショートコード等で自動化を図ることが出来ます。

WordPressのREST APIは使い勝手が良くかなり便利なので、是非触ってみてはいかがでしょうか♪

336×280




336×280




CATEGORIES & TAGS

IT, , , , , , , , ,

blogenist

Author: blogenist