has_custom_header()


WordPressのhas_custom_header()関数は、現在のテーマがカスタムヘッダーをサポートしているかどうかを確認するために使用されます。この関数は、テーマがカスタムヘッダー機能を有効にしている場合にtrueを返します。

構文

has_custom_header();
  • bool — カスタムヘッダーがサポートされている場合はtrue、それ以外はfalseを返します。

例1: カスタムヘッダーのサポートを確認する

この例では、テーマがカスタムヘッダーをサポートしているかどうかを確認します。

<?php if ( has_custom_header() ) { echo 'カスタムヘッダーがサポートされています。'; } else { echo 'カスタムヘッダーはサポートされていません。'; } ?>

例2: カスタムヘッダーが有効な場合にのみヘッダーを表示する

カスタムヘッダーが有効な場合にのみ、特定のヘッダーコンテンツを表示します。

<?php if ( has_custom_header() ) { the_custom_header_markup(); } ?>

例3: カスタムヘッダーのサポートに基づいてスタイルを適用する

カスタムヘッダーが有効な場合にのみ、特定のCSSクラスを追加します。

<?php $header_class = has_custom_header() ? 'custom-header-enabled' : 'custom-header-disabled'; ?>
<div class="<?php echo $header_class; ?>">ヘッダーコンテンツ</div>

例4: カスタムヘッダーのサポートをチェックして条件付きロジックを実行する

カスタムヘッダーが有効な場合にのみ、特定の関数を実行します。

<?php if ( has_custom_header() ) { custom_header_function(); } ?>

例5: カスタムヘッダーのサポートをチェックして異なるHTMLを出力する

カスタムヘッダーが有効かどうかに基づいて、異なるHTMLを出力します。

<?php if ( has_custom_header() ) { echo '<header class="custom-header">カスタムヘッダー</header>'; } else { echo '<header class="default-header">デフォルトヘッダー</header>'; } ?>

例6: カスタムヘッダーのサポートをチェックしてJavaScriptを条件付きで読み込む

カスタムヘッダーが有効な場合にのみ、特定のJavaScriptファイルを読み込みます。

<?php if ( has_custom_header() ) { wp_enqueue_script( 'custom-header-script', get_template_directory_uri() . '/js/custom-header.js', array(), null, true ); } ?>

注意点

  • この関数は、テーマがadd_theme_support( 'custom-header' )を使用してカスタムヘッダーを有効にしている場合にのみ動作します。
  • カスタムヘッダーが無効な場合、この関数はfalseを返します。

関連機能：