wp_body_open() の使い方|説明・引数・注意点

説明

wp_body_open() は、body 開始タグの直後でアクションフックを実行する関数です。タグマネージャーなどの出力に使われます。

基本構文

wp_body_open(): void

引数

引数はありません。

戻り値

戻り値はありません(wp_body_open アクションを実行します)。

使い方(サンプル)

// header.php の body タグの直後に記述
wp_body_open();

注意点

  • WordPress 5.2 で追加された関数です。テーマに入れていないと、Googleタグマネージャーの noscript などが出力されません。

実務での使いどころ

  • <body> の開始の直後に、タグ(Googleタグマネージャーの <noscript> など)を出力するとき。
  • header.php で、<body> の直後に、wp_body_open() を呼ぶ。

よくあるミスと対処

  • テーマの header.php で、wp_body_open() を呼んでいない。フックに登録した処理が、出力されない。
  • <body> の直後以外の場所で呼んでいる。
  • 古いWordPressでは、関数がない場合がある。呼ぶ前に、function_exists() で確認する。

NG例

<body <?php body_class(); ?>>
<!-- wp_body_open() が無く、フックの処理が出力されない -->

OK例

<body <?php body_class(); ?>>
<?php
if ( function_exists( 'wp_body_open' ) ) {
	wp_body_open();
}
?>

使い分け早見表

フック 出力する場所
wp_head() <head> の終わりの直前
wp_body_open <body> の開始の直後
wp_footer() </body> の直前

関連項目

wp_head()、wp_footer()

公式リファレンス:wp_body_open() | Function | WordPress Developer Resources

コメント

タイトルとURLをコピーしました