• 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。(詳細

このWikiはいつでも誰でも編集できます

関数リファレンス/add custom image header

提供: WordPress Codex 日本語版
移動先: 案内検索

この関数は 非推奨となりました。これは新しい関数に置き換えられた、またはサポート外になった、あるいは将来バージョンにて削除されるためです。この関数を用いる全てのコードは、置き換えとなる関数が存在する場合、書き換えられる必要があります。wp-includes/deprecated.phpもご参照ください。 これらの関数から適切なものを代わりに用いてください。

説明

イメージヘッダー表示にコールバックを追加します。

パラメータ $header_callback コールバックは、'wp_head' アクションの中身を表示するのに必要です。パラメータ $admin_header_callback コールバックは、Custom_Image_Header クラスに追加され、'admin_menu' アクションに追加されます。

使い方

<?php add_custom_image_header( $header_callback, $admin_header_callback ) ?>

パラメータ

$header_callback
callback) (必須) 'wp_head' アクションで呼び出す
初期値: なし
$admin_header_callback
callback) (必須管理パネルで呼び出す
初期値: なし

戻り値

(void) 
この関数には、戻り値はありません。

用例

テーマの functions.php ファイルを編集して、以下のコードを追加してください。

カスタムイメージヘッダーが動作するには、4つの定数を定義しなければなりません。

define('HEADER_TEXTCOLOR', 'ffffff');
define('HEADER_IMAGE', '%s/images/default_header.jpg'); // %s is the template dir uri
define('HEADER_IMAGE_WIDTH', 775); // use width and height appropriate for your theme
define('HEADER_IMAGE_HEIGHT', 200);

ヘッダーのテキストの色を変化させたくない場合は、以下を追加してください。

define('NO_HEADER_TEXT', true );

それから、最初の定義を以下に変更してください。

define('HEADER_TEXTCOLOR', '');

子テーマを作りたい場合は、以下を使用してください。

define('HEADER_IMAGE', get_bloginfo('stylesheet_directory') . '/images/banner.jpg');

これをしない場合は、子テーマではなく、親テーマのヘッダー画像を取得します。

さらに、2つの関数を書く必要があります。1つは site header に含まれます。2つ目は admin header に含まれます。これらの関数は必須です。(必要なものを追加することもできますが、)最も少ない場合で以下のようになります。

// gets included in the site header
function header_style() {
    ?><style type="text/css">
        #header {
            background: url(<?php header_image(); ?>);
        }
    </style><?php
}
// gets included in the admin header
function admin_header_style() {
    ?><style type="text/css">
        #headimg {
            width: <?php echo HEADER_IMAGE_WIDTH; ?>px;
            height: <?php echo HEADER_IMAGE_HEIGHT; ?>px;
        }
    </style><?php
}

これら2つの関数名をパラメータとすることで、add_custom_image_header 関数の呼び出しが完了します。

add_custom_image_header('header_style', 'admin_header_style');

この手順で、カスタムヘッダーアイテムが、外観メニューに表示されます。後は、WordPress が面倒を見ます。

  • 使用: Custom_Image_Header管理パネル に表示する $admin_header_callback のセットアップ。

更新履歴

ソース

add_custom_image_header() は、wp-includes/theme.php にあります。

関連

get_header_image, header_image

最新英語版: WordPress Codex » Function Reference/add_custom_image_header最新版との差分