add_custom_image_header()

Q: add_custom_image_header() はまだ使える？

WordPress 3.4 以降では非推奨のため、代わりに add_theme_support('custom-header') を使うのが推奨される。

Q: ヘッダー画像のサイズは自由に変更できる？

add_theme_support('custom-header') の width と height を調整することで変更可能。

Function

2025/6/26 Thursday

add_custom_image_header() は、WordPress のテーマにカスタムヘッダー画像機能を追加するための関数です。

この関数を使用すると、ユーザーが管理画面から独自のヘッダー画像をアップロードし、設定できるようになります。

機能の説明

add_custom_image_header() は、WordPress テーマ内で動的なヘッダー画像のサポートを追加するために使用される関数です。これにより、サイト管理者はカスタマイズ画面からヘッダー画像を簡単に変更できるようになります。

この関数は functions.php に記述し、適用したいテーマで利用します。WordPress 3.4 以降では add_theme_support('custom-header') に統合されたため、現在では add_custom_image_header() は非推奨とされています。

シンプルなコード例

if (function_exists('add_custom_image_header')) {
    add_custom_image_header('my_header_style', 'my_admin_header_style');
}

function my_header_style() {
    echo '<style type="text/css">#header { background-image: url(' . get_header_image() . '); }</style>';
}

function my_admin_header_style() {
    echo '<style type="text/css">.appearance_page_custom-header #headimg { background-image: url(' . get_header_image() . '); }</style>';
}

使い方の説明

add_custom_image_header() には、以下の 2 つのコールバック関数を渡す必要があります。

第一引数：フロントエンドのスタイルを変更する関数
第二引数：管理画面のカスタムヘッダーエリアのスタイルを設定する関数

現在は add_theme_support('custom-header') を使用するのが推奨されており、以下のように記述します。

add_theme_support('custom-header', array(
    'width'         => 1200,
    'height'        => 400,
    'flex-height'   => true,
    'flex-width'    => true,
    'header-text'   => false,
));

一緒に使うことが多い関連タグ

`get_header_image()`

ヘッダー画像の URL を取得する。

<img src="<?php echo get_header_image(); ?>" alt="Header Image">

`get_custom_header()`

カスタムヘッダーのオブジェクトを取得する。

$header = get_custom_header();
echo '<img src="' . $header->url . '" width="' . $header->width . '" height="' . $header->height . '">';

追加情報で取得したい場合

`header_image()`

ヘッダー画像の URL を直接出力する。

header_image();

想定されるトラブル