🕊️

Wordpress REST APIでユーザーのプロフ画像を取得するには

2021/03/03に公開

結論

Wordpress REST APIでユーザーのプロフ画像を取得するには、プラグインの「Advance Custom Field」を用いてユーザー情報の登録項目をカスタマイズ可能にした上で、ユーザーの画像を登録するフィールドを作成することで実現される。

そもそもいかにしてREST APIでユーザー情報を取得するか

https://your-site-url/wp-json/wp/v2/users?_embed

このURLを叩けば、あなたは当該サイトのWordpressユーザーの情報を取得することができます。

デフォルトで取得できる情報は

しかし、デフォルトの状態で、ユーザー情報を取得することができる情報には限りがあります。
id,name,slug,などは取得できるものの、ユーザーのプロフ画像などは取得できません。

Advance Custom Fieldとは

通称、ACFと呼ばれる当該プラグインは、特定の投稿タイプなどにデフォルトでは登録できない情報を紐付けて登録できるようになるものです。

ACFを用いて、ユーザー情報に画像を登録できるようにする

ACFを有効化し、フィールドグループの新規追加を行ってください。
その後、フィールドグループ名を決定し、以下のように設定しましょう。

そして、「位置」の設定項目において、

現在のユーザー / 等しい / ログイン済
と登録すればOKです!

この作業を行っていただければ、

https://your-site-url/wp-json/wp/v2/users?_embed

にて、acfの項目でユーザー画像の取得ができるようになっていると思います!
不具合などあれば、twitterまでお気軽にお願いします!
github

Discussion