get_header_textcolor()


WordPressget_header_textcolor()は、現在のテーマでヘッダーテキストの色を取得するための関数です。

シンタックス

get_header_textcolor();

この関数は、現在のテーマで定義されているヘッダーテキストの色を16進数形式（例: #ffffff）またはblankとして返します。これは、テーマのカスタマイザーで設定されている値に基づきます。

注意点

  • get_header_textcolor()は引数を受け取りません。
  • カスタムヘッダーがサポートされていないテーマでは、この関数は値を返さない可能性があります。

例 1: ヘッダーテキスト色の取得と出力

以下のコードは現在のテーマで設定されているヘッダーテキストの色を取得して表示します。

<?php echo get_header_textcolor(); ?>

例 2: デフォルト値との比較

このコードは現在のヘッダーテキストの色がデフォルト値かどうかを確認します。

<?php
if ( get_header_textcolor() === HEADER_TEXTCOLOR ) {
    echo 'デフォルトのヘッダーテキスト色が使用されています。';
} else {
    echo 'カスタムヘッダーテキスト色が設定されています。';
}
?>

例 3: 条件に基づいてスタイルを変更

ヘッダーテキストが空（blank）の場合、特定のスタイルを適用します。

<?php
if ( get_header_textcolor() === 'blank' ) {
    echo '<style>.site-title, .site-description { display: none; }</style>';
} else {
    echo '<style>.site-title, .site-description { color: #' . get_header_textcolor() . '; }</style>';
}
?>

例 4: テーマカスタマイザーでの使用

テーマカスタマイザーのプレビュー内で現在のヘッダーテキスト色を表示します。

<?php
function mytheme_customize_preview_js() {
    echo '<script>
        wp.customize("header_textcolor", function(value) {
            value.bind(function(to) {
                document.querySelector(".site-title, .site-description").style.color = to === "blank" ? "transparent" : "#" + to;
            });
        });
    </script>';
}
add_action( "customize_preview_init", "mytheme_customize_preview_js" );
?>

例 5: 色を使用したカスタム背景の設定

ヘッダーテキストの色を背景色として適用します。

<?php
$header_color = get_header_textcolor();
echo '<style>header { background-color: #' . $header_color . '; }</style>';
?>

使用上の注意

  • この関数は、テーマでadd_theme_support( 'custom-header' )が有効化されている必要があります。
  • 返される値がblankの場合、ヘッダーテキストは非表示にすることが推奨されます。

関連機能：