WordPress

ワードプレス(WordPress)のRestAPIでアイキャッチ画像をアップロードする

ワードプレスでリモート環境から記事を投稿する際に、標準で用意されている API(WP Rest API) が便利です。

既にワードプレスのバージョンは 5 の時代ですが、この API が標準で搭載されたのは 4.8 くらいと比較的最近のことです。

記事投稿は POST で必要な情報を JSON でリクエストするだけなので 5 分もあれば作れちゃうのですが、今回はアイキャッチ画像を設定したかったので試行錯誤してみました。

画像アップロードのエンドポイント

post のエンドポイントで記事投稿と同時にアイキャッチ画像もアップロードできると楽なのですが、公式のドキュメントを見るとそこまでの利便性はないようです。

ドキュメントはちょっとわかりにくいですね・・・。

もう少し API ガチガチの仕様っぽく書いてほしい。

調べた感じ、ドキュメントにある以下のエンドポイントを使えばやりたいことが実現できそうだと判断しました。

メディアの登録
投稿時にメディアIDの登録

「メディアの登録」で画像をアップロードしておいて、その画像 ID を「記事投稿時に指定」でマッピングするというイメージです。

さっそく試してみます。

メディアの登録

メディアの登録は記事投稿と同じく POST メソッドが提供されています。

エンドポイントは以下の通りです。

/wp-json/wp/v2/media

画像のファイル名はリクエストヘッダに、画像のバイナリデータはリクエストボディに設定します。

PHP で書くと以下の通りですが、認証には簡易的に「Application Passwords」のプラグインで発行したパスワードを利用したいと思います。

ザックリなので上手くいくと思えないですが投稿してみます。

案の定、エラーが返ってきましたね。

メッセージはユニコードエスケープされているので、読めない場合は変換してください。

Linux なら echo の -e オプションでいけるかな。

リクエストボディの定義の仕方が悪かったですね。

アップロードはこれで完了です。

ドキュメントを見る限り、画像の alt テキストなどを設定可能だと思うのですが、この辺は API のリファレンスがよくわからない・・・。

Mediaを作成

date
date_gmt
password
slug
status
title
author
comment_status
ping_status
alt_text
caption
description
post

まあ、アイキャッチ画像なのでその辺は良しとしておきましょう。

あとは、レスポンスから画像の ID を抜き出して記事投稿の際に使用します。

記事投稿時に画像IDを指定

記事投稿の API は冒頭でも書いた通り、記事の内容を JSON 形式で POST するだけ。

アイキャッチ画像を指定したい場合は、先ほどアップロードした画像の ID を指定します。

項目名は「featured_media」になります。

これで記事投稿すれば、アイキャッチ画像として登録されます。

めでたしめでたし。