ブロックエディターで編集したページが出力した余分な改行を削除

説明

ブロックエディターで編集したページのHTMLソースは、投稿本文部分の改行が目立った。Webページとしての表示は問題ないのだが、データとしては不要なので削除することにした。

ブロック名のコメント

まずはWordPressの初期投稿をブロックに変換した本文部分をデータベースで確認する。

<!-- wp:paragraph -->
<p>Welcome to WordPress. This is your first post. Edit or delete it, then start writing!</p>
<!-- /wp:paragraph -->

p要素の前後のコメントはブロック名（タイプ）を示すもので、ブロック固有の設定情報もこのコメント内に記述される仕組みだ。この投稿を表示した際のHTMLコード（本文部分を抜粋）は次のようになる。

<p>Welcome to WordPress. This is your first post. Edit or delete it, then start writing!</p>

このようにブロックエディターで編集したページは、p要素のようなブロックの前後にあるコメントが削除されてから出力されている。ただし、コメント部分を削除した際に改行が残ってしまい、複数のブロックが存在する投稿では改行が目立ってしまうことになる。

the_contentフィルターを使う

改行を削除には、投稿本文を出力する the_content関数のthe_contentフィルターが利用できる。このフィルターは投稿本文中のブロックを展開した後に実行するようにしたいので、そのプライオリティ値を確認する。

/wp-includes/default-filters.phpを見てみると、投稿本文のブロックを展開するdo_blocks関数は、プライオリティ値9で指定されている。

add_filter( 'the_content', 'do_blocks',                      9 );

プライオリティ値がわかったのでテーマのfunctions.phpに以下のコードを追加する。

add_filter( 'the_content', 'remove_repeated_cr', 10 );

function remove_repeated_cr( $content ) {
	return preg_replace( "/\n+/", "\n", $content );
}

今後のWordPressのバージョンアップによりこのことは解消されるかもしれないが、とりあえずの対応としてはこんな感じだろう。