clean_pre()

clean_pre() は、投稿本文などの <pre> タグ内に含まれる不要な HTML タグやエスケープ済み改行コードなどを整理・削除し、適切なコード表示を維持するための WordPress 内部関数です。

特に、投稿エディタや自動整形機能によって <pre> タグ内のコードに不要な <br> や   が挿入されてしまう問題を解決するために使用されます。

基本構文

clean_pre( string $text ): string

解説

この関数は <pre> タグ内に含まれる文字列を解析し、以下のような処理を行います：

• <br /> を削除
•   をスペースに変換
• HTML エンティティの復元（例：< → <）

引き数と戻り値

使用例

タグを使った使用例

$original = '<pre><?php echo "Hello"; ?><br />    </pre>';
$cleaned  = clean_pre( $original );

echo $cleaned;

上記コードは、<pre> タグ内の <?php echo "Hello"; ?> を <?php echo "Hello"; ?> に戻し、<br /> や   を除去して、適切なコードブロックを維持します。

注意点

この関数は自動的に呼ばれる場面が限られている

the_content や format_to_edit による整形時に自動的に組み込まれる場合があります。

すべての投稿に対して使用する必要はない

<pre> タグを含む投稿の整形に限って適用すべきです。

関数自体はフィルターとして使えない

フィルター関数に渡して使うか、自前で呼び出す必要があります。

よく一緒に使われる関数

the_content

add_filter( 'the_content', function( $content ) {
    return clean_pre( $content );
} );

表示前に <pre> タグ内を整形して、綺麗に保つ。

format_to_edit

$content = format_to_edit( $post->post_content );
$content = clean_pre( $content );

投稿編集時の整形後処理に使用。

wp_kses_post()

$content = wp_kses_post( $raw );
$content = clean_pre( $content );

許可されたタグのみに制限した後に <pre> タグ整形。

想定されるトラブル

コードブロック内の表示が崩れる

投稿エディタや自動整形で <br /> が挿入され、コードが改行されてしまう。

解決方法

clean_pre() を使用して <br> や   を除去。

<pre> 内の文字が HTML エンティティのまま表示される

< や > などがそのまま表示され、実際のコードに見えない。

解決方法

clean_pre() でデコード処理を施すことで、可読性の高いコード表示に戻せる。

Q&A

まとめ

clean_pre() は、投稿やカスタムフィールド内の <pre> タグに対する自動整形による崩れを防ぎ、読みやすく整えたコード表示を実現するための内部関数です。

エンジニア向けサイトやコード付き解説記事では、コードブロックの品質向上に欠かせない補助ツールです。

投稿前または出力時に適切に使用することで、より見やすく整った投稿が可能になります。