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

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

カスタム背景

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

カスタム背景は、背景色と画像のカスタマイズを提供するテーマ機能です。

管理画面/外観/背景もご覧ください。

テーマサポートを追加する

Version 3.4以降では、テーマでカスタム背景機能をサポートをするためには functions.phpファイル内に add_theme_support() 関数を使う必要があります。以下のように記述します。

add_theme_support( 'custom-background' );

以下を使って、デフォルトの引数を追加できることに留意しましょう。

$defaults = array(
	'default-color'          => '',
	'default-image'          => '',
	'default-repeat'         => '',
	'default-position-x'     => '',
	'default-attachment'     => '',
	'wp-head-callback'       => '_custom_background_cb',
	'admin-head-callback'    => '',
	'admin-preview-callback' => ''
);
add_theme_support( 'custom-background', $defaults );

用例

デフォルトの背景色を '#000000' に、背景画像を 'background.jpg' に設定する例。

$args = array(
	'default-color' => '000000',
	'default-image' => '%1$s/images/background.jpg',
);
add_theme_support( 'custom-background', $args );

出力内容

ここで add_theme_support() を呼び出す目的は、サイト管理者の「外観」管理画面でカスタム背景画面を有効化することです。またこれは、昨日の互換性を提供するためにテーマが適切な body_class()wp_head() タグを実装していることを宣言する役割も果たしています。

管理者がテーマに対してカスタム値を設定すると、WordPress は HTML ヘッダー内にインラインの追加スタイルシートを生成します。これは通常、ドキュメントの HEAD 要素の直前に配置されます。追加スタイルシートは、テーマのスタイルシートの背景色・画像の値を上書きします。

出力例:

<style type="text/css" id="custom-background-css">
body.custom-background { background-color: #bdd96e; }
</style>

デフォルト画像変数を設定すると、その値はすぐに有効なカスタム背景として反映されますが、デフォルト色を設定しても管理者がカスタム背景ページを訪れるまでは何も影響しないことに注意してください。このデフォルトの挙動を上書きするには、_custom_background_cb() 関数の代替となるものを用意する必要があります。

後方互換

古いバージョンに対しての後方互換性を追加するには、次のコードを使用します。

global $wp_version;
if ( version_compare( $wp_version, '3.4', '>=' ) ) :
	add_theme_support( 'custom-background' ); 
else :
	add_custom_background( $args );
endif;

注: 現在 WordPress 3.6 がすでにリリースされているため、3.4 以前のバージョンへの後方互換性を提供することはテーマレビューガイドラインに対する違反となります。

リソース

関連項目

テーマサポート: add_theme_support(), remove_theme_support(), current_theme_supports()
テーマ機能: サイドバー, ナビゲーションメニュー, 投稿フォーマット, 投稿サムネイル, カスタム背景, カスタムヘッダー, 自動フィードリンク, html5, コンテンツ幅, editor-style



最新英語版: WordPress Codex » Custom Backgrounds最新版との差分