get_custom_header_markup()


WordPressのget_custom_header_markup()関数は、カスタムヘッダーのHTMLマークアップを取得するために使用されます。この関数は、テーマのヘッダー部分にカスタムヘッダーを表示する際に便利です。

構文

get_custom_header_markup();
  • get_custom_header_markup()は引数を取りません。

例1: カスタムヘッダーの表示

この例では、カスタムヘッダーのHTMLマークアップを取得し、表示します。

<?php echo get_custom_header_markup(); ?>

例2: カスタムヘッダーを条件付きで表示

カスタムヘッダーが設定されている場合にのみ表示する例です。

<?php if ( get_header_image() ) { echo get_custom_header_markup(); } ?>

例3: カスタムヘッダーにクラスを追加

カスタムヘッダーのマークアップにクラスを追加する例です。

<?php $header_markup = get_custom_header_markup(); echo str_replace('class="header-image"', 'class="header-image custom-class"', $header_markup); ?>

例4: カスタムヘッダーを特定の投稿タイプでのみ表示

特定の投稿タイプでのみカスタムヘッダーを表示する例です。

<?php if ( is_singular('post') ) { echo get_custom_header_markup(); } ?>

例5: カスタムヘッダーにラッパー要素を追加

カスタムヘッダーの周りにラッパー要素を追加する例です。

<?php echo '<div class="header-wrapper">' . get_custom_header_markup() . '</div>'; ?>

例6: カスタムヘッダーをフッターに表示

カスタムヘッダーをフッター部分に表示する例です。

<?php add_action('wp_footer', function() { echo get_custom_header_markup(); }); ?>

注意点:

  • カスタムヘッダーが設定されていない場合、この関数は何も返しません。
  • カスタムヘッダーの設定は、テーマのfunctions.phpやカスタマイザーで行う必要があります。

関連機能：