0 と 1 の世界の見習い探検家

タグ:WordPress

WordPress の API.NET のプログラムでつついていたところ、記事の投稿操作を行った際に下記のエラーが発生。
すぐに気付けたけど沼る方もいそうだなと思ったため、念のための備忘録です。
StreamWriter 使って Stream に JSON を書いてる方に当てはまるかも。

WordPress から返ってきたエラーの内容↓
rest_invalid_json: 無効な JSON ボディが渡されました。

結論
.NET の StreamWriter を使う際は、BOM に気をつけよう


無効な JSON というので、どんな壊れた内容で API をコールしてしまったのかとデバッガを覗いたところ、
見た目上はきれいな JSON が渡されているようでした。
見た目上は。

20240125-03_json


問題は、リクエスト時に送信する JSON を StreamWriter を使って Stream に書いていた時に起こっていました。
まずシリアライズ ツールを使って生成した JSON を String 型の文字列に格納し、その後送信用の Stream に StreamWriter を使って書いていました。

こんな感じ
var json = JsonSerializer.Serialize(obj, this._serializerOptions);
var ms = new MemoryStream();
using (var sw = new StreamWriter(ms, Encoding.UTF8, 512, true))
{
    await sw.WriteAsync(json);
}

良くなかったのがここで StreamWriter の Encoding 指定に Encoding.UTF8 を使っていたこと。
書き込み先の Stream の頭に BOM が付与されてしまい、それで受け取った側の WordPress が壊れた JSON として認識したようです。

雑なサンプルコードですが、UTF8 を使いたい場合は Encoding.UTF8 を使わずに、UTF8Encoding を new して、コンストラクタの第一引数に false を与えてあげましょう。BOM が付与されなくなります。

var json = JsonSerializer.Serialize(obj, this._serializerOptions);
var ms = new MemoryStream();
using (var sw = new StreamWriter(ms, new UTF8Encoding(false), 512, true))
{
    await sw.WriteAsync(json);
}


まぁそもそも、使っているシリアライザが System.Text.Json 名前空間のものなのですが、
デバッガで見た内容からして、ASCII で送信可能な状態にエンコーディングしてくれているので、UTF8 を使う必要がないと言えば無いのですが、ちょっとデバッグ目的で使いたて……ですね…… (もごもご)

こんにちは、
立て続けに備忘録です。
WordPress 環境を社内のイントラ環境や個人 PC 内の検証環境でお使いの方向けの記事です。

※この記事で対象としている WordPress のバージョンは 6.4.2

WordPress には REST API の機能があり、コールすることで「記事の投稿」「ファイルのアップロード」など様々な操作を行うことが出来ます。
利用するためには、WordPress の管理画面で「アプリケーションパスワード」を発行する必要がありますが、HTTPS でない環境の場合、このアプリケーションパスワードの発行機能がブロックされており、使えません。
※アプリケーションパスワードの詳細についてはぐぐってください


20240123-201_WP_APWBLOCKED

アプリケーションパスワードを使用すると、実際のパスワードを入力しなくても XML-RPC や REST API などの非対話型システムを介した認証が可能になります。アプリケーションパスワードは簡単に取り消すことができます。サイトへの従来のログインには使用できません。

アプリケーションパスワードには HTTPS が必要ですが、このサイトでは有効ではありません。

これが開発用サイトであれば、適宜、環境タイプを設定して、アプリケーションパスワードを有効化できます。

まぁ当然といえば当然です。
暗号化されてない環境でアプリケーションパスワードを利用するということは、セキュリティ上の重大なリスクがあります。

ただ、社内のイントラ環境やローカルに立てた検証環境などで利用している WordPress で REST API やアプリケーションパスワード機能を使いたい場合もあるかと思います。
その方法のご紹介です。

インターネットに公開されている環境の WordPress ではこの手順は実施しないでください。セキュリティ上のリスクになります。


wp-config.php を編集する


20240123-202_WP_wpconfig

wp-config.php とは WordPress のインストール ディレクトリ内にある php ファイルです。
このファイルに後述の行を追加することで非 HTTPS 環境でもアプリケーションパスワードの発行を受けることができるようになります。

まずは wp-config.php のバックアップを取ってください (破損すると環境自体が壊れるので)

wp-config.php をテキストエディタで開きます。
Windows の場合、改行コードを壊さぬようテキストエディタは VSCode あたりを利用すると安全かもしれません。

そして、一番末尾までスクロールし、
require_once ABSPATH . 'wp-settings.php';
の 1 つ手前の辺りに次の内容を追加してください

define( 'WP_ENVIRONMENT_TYPE', 'local' );
末尾のセミコロンも忘れないでください。
下記のような感じで OK です。

20240123-203_WP_lineadded

上書き保存を行い、WordPress の管理画面のアプリケーションパスワード発行の画面のページをリロードすると、「アプリケーションパスワードには HTTPS が必要ですが、このサイトでは有効ではありません。~~」のメッセージが消え、下記のようにアプリケーションパスワードが発行可能になっていることを確認できると思います。

20240123-204_WP_enabled

お疲れ様です。
WordPress の REST API をお楽しみください。


【おまけ】WP_ENVIRONMENT_TYPE の設定が反映されない!?

下記のコードを追加してもアプリケーションパスワードが有効にならないことがあります。
define( 'WP_ENVIRONMENT_TYPE', 'local' );

私が遭遇したケースでは、上記のコードの挿入位置がよくありませんでした。
最初 wp-config.php の末尾に記載をしていたのですが、その際は反映がなされませんでした。
wp-settings.php を require_once する前に define しないと正しく反映されないようです。
ご注意ください。

このページのトップヘ