概要
wpautopフィルタは、WordPressにおいてテキストの自動整形を行うための機能で、主に<p>タグや<br>タグを整頓する際に使用されます。このフィルタは、投稿やページのコンテンツを保存する際に、その内容をHTMLで適切に表示するために有用です。特にブログ記事など、マークアップが必要な場面で一般的に用いられます。
主な使用例
- ブログ記事の本文の自動整形
- コメント欄のテキスト整形
- カスタムフィールドの内容をHTMLに整形
- ショートコードを利用したコンテンツ作成時の整形
- ウィジェットコンテンツの自動整形
- 外部APIから取得したHTMLを整形
- マルチサイトでの投稿内容の整形
- カスタム投稿タイプの整形
構文
wpautop( string $pee, bool $br = true )
パラメータ
$pee(string) : 整形したいテキスト$br(bool) :trueの場合、改行を<br>タグに変換します。デフォルトはtrueです。
戻り値
整形されたHTML文字列が返されます。
関連する関数
wpautopは、以下のような関連関数と共に使用されます。
wp_trim_words()wp_kses_post()wp_rel_nofollow()
使用可能なバージョン
wpautopフィルタはWordPress 1.5以降で使用可能です。
コアファイルのパス
wp-includes/formatting.php
この関数のアクションでの使用可能性
| アクション | 使用可能 |
|---|---|
| mu_plugin_loaded | 〇 |
| registered_post_type | |
| plugins_loaded | 〇 |
| wp_roles_init | |
| setup_theme | 〇 |
| after_setup_theme | |
| set_current_user | |
| init | 〇 |
| register_sidebar | 〇 |
| wp_loaded | 〇 |
| send_headers | |
| parse_query | |
| pre_get_posts | |
| wp | 〇 |
| template_redirect | 〇 |
| get_header | |
| wp_head | 〇 |
非推奨または削除されたバージョン
該当なし。wpautopフィルタは現在も使用可能であり、特定のバージョンで非推奨または削除されていません。
サンプルコード
以下はwpautopフィルタを利用したサンプルコードです。
サンプルコード 1: 基本的な使い方
$text = "これはテストです。n次の行へ移動します。";
$formatted_text = wpautop($text);
echo $formatted_text;
このコードは、テキスト内の改行を自動で<p>タグに囲まれる形で整形します。
サンプルコード 2: <br>タグを含める
$text = "行1n行2n行3";
$formatted_text = wpautop($text, true);
echo $formatted_text;
このコードは、改行を<br>タグに変換し、出力します。
サンプルコード 3: 投稿の内容を整形
function my_custom_content($content) {
return wpautop($content);
}
add_filter('the_content', 'my_custom_content');
このコードは投稿内容を取得し、wpautopを使って整形した後に表示します。
サンプルコード 4: ウィジェットへの適用
function my_widget_text($text) {
return wpautop($text);
}
add_filter('widget_text', 'my_widget_text');
このコードはウィジェットのテキストも自動で整形します。
サンプルコード 5: カスタムフィールドの整形
$value = get_post_meta($post_id, 'my_custom_field', true);
$formatted_value = wpautop($value);
echo $formatted_value;
このコードはカスタムフィールドの内容を取得し、自動的に整形して出力します。
これらのサンプルコードは、wpautopフィルタの機能を示すためのものであり、それぞれの使い道を理解するのに役立ちます。