「不明な書式」って何ですか。

説明

オートコンプリート機能を利用して四字熟語を挿入するプラグインを作った際、ツールバーに「不明な書式をクリア（Clear Unknown Formatting）」ボタンが表示されるようになった。この「書式」、何を指しているのかわからないんだが。

挿入した内容を確認

今回コートコンプリート機能で実装した四字熟語は次のような内容は次の通りで、abbr要素でruby要素で囲む形式にしている。

<abbr title="虎が鋭い目で獲物を見下ろしているさま。相手のすきを狙って機会をうかがうこと。">
<ruby>虎視眈眈<rt>こしたんたん</rt></ruby>
</abbr>

「不明な書式をクリア」ボタンが表示されるのは、テキストカーソルが挿入された四字熟語の部分にかかった時だけだったので、「HTML編集」で挿入された内容を編集しながら「不明な書式をクリア」ボタンが消える状態を確認。外側のabbr要素を取り除くと「不明な書式をクリア」ボタンが表示されないことがわかった。またabbr要素のほかにcite要素なども同様だったので、何か対処できないかと思った。

Unknown Formattingを探す

四字熟語の部分はabbr要素で囲まれた状態でその「投稿」を更新しても問題なく保存できている。グローバル変数$allowedposttags（wp-includes/kses.php）を確認すると、デフォルトではabbr要素、cite要素とも登録されており、「不明な書式をクリア」ボタンが表示されることと$allowedposttagsは関係がなさそうだ。

ということで実際に「不明な書式をクリア」ボタンを表示しているところを探してみる。ブロックエディターに関連するソースコードはwp-includes/js/distディレクトリにあり、「不明な書式をクリア」ボタンはformat-library.jsで定義されていた。ビルド前のソースコードを確認するため、Githubの「format-library」へ。registerFormatTypeメソッドを使っていくつかのフォーマットが登録されていた。registerFormatTypeメソッドは、段落ブロックなどのツールバーに独自のボタンを登録する際に使用しており、試しに次のような感じでabbr要素を登録してみた。

registerFormatType( 'core-ex/abbr',
	{
		title: '略語',
		tagName: 'abbr',
		className: null,
	}
);

第1パラメータのネームスペースは適当にし、第2パラメータのeditプロパティは特に機能を割り当てないので省略した。

上記を有効にして投稿編集ページをリロード。四字熟語にテキストカーソルを移動しても「不明な書式をクリア」ボタンは表示されなくなった。「そういうことか」という感じである。

あらためて関連ドキュメントを見てみると、registerFormatTypeメソッドについて説明している「書式ツールバー API」では『WordPress の世界で「書式」とは、テキストレベルのセマンティクスでの HTML タグを指します。』と記載されている。なるほど、abbrタグは「書式」らしい。

本件、「HTML編集」を使って未登録のタグを使用するともれなく遭遇することになる。「不明な書式をクリア」ボタンが表示されても無視できればよいのだが、「何かやってしまったのでは」と思う方も少なくないだろう。「不明な書式をクリア」ボタンを非表示にできる簡単な手段はないものだろうか。