the_custom_header_markup()


関数the_custom_header_markup()は、WordPressでカスタムヘッダーのマークアップを表示するために使用されます。この関数は、テーマファイル内でカスタムヘッダーのHTMLを出力する際に役立ちます。

構文

the_custom_header_markup( array $args = array() );

引数の説明:

  • $args(array) — カスタムヘッダーの表示に関するオプションを指定する配列。以下のキーを持つことができます：
    • 'video' — ビデオヘッダーを有効にするかどうかを指定します。
    • 'video-active-callback' — ビデオヘッダーがアクティブかどうかを判断するコールバック関数。
    • 'image' — 画像ヘッダーを有効にするかどうかを指定します。
    • 'image-active-callback' — 画像ヘッダーがアクティブかどうかを判断するコールバック関数。

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

カスタムヘッダーを表示する最も基本的な例です。

<?php the_custom_header_markup(); ?>

例2: ビデオヘッダーを有効にする

ビデオヘッダーを有効にして表示します。

<?php the_custom_header_markup( array( 'video' => true ) ); ?>

例3: 画像ヘッダーを無効にする

画像ヘッダーを無効にして、ビデオヘッダーのみを表示します。

<?php the_custom_header_markup( array( 'image' => false, 'video' => true ) ); ?>

例4: カスタムコールバック関数を使用する

カスタムコールバック関数を使用して、ビデオヘッダーがアクティブかどうかを判断します。

<?php the_custom_header_markup( array( 'video-active-callback' => 'my_custom_video_callback' ) ); ?>

例5: 画像ヘッダーとビデオヘッダーの両方を無効にする

画像ヘッダーとビデオヘッダーの両方を無効にします。

<?php the_custom_header_markup( array( 'image' => false, 'video' => false ) ); ?>

例6: カスタムヘッダーに追加のクラスを指定する

カスタムヘッダーに追加のクラスを指定して、スタイルを調整します。

<?php the_custom_header_markup( array( 'class' => 'custom-header-class' ) ); ?>

注意点

  • カスタムヘッダーを正しく表示するためには、テーマがadd_theme_support( 'custom-header' )をサポートしている必要があります。
  • ビデオヘッダーを使用する場合、適切なコールバック関数を指定して、ビデオが表示される条件を制御することが重要です。

関連機能：