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

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

関数リファレンス/get theme mod

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

この項目「関数リファレンス/get theme mod」は、翻訳チェック待ちの項目です。加筆、訂正などを通して、Codex ドキュメンテーションにご協力下さい。

説明

現在のテーマのテーマ設定値をひとつ取得します。基本的なテーマ固有設定を扱う必要がある場合、set_theme_mod() と共に、テーマ開発者にとって Settings API の簡単な代替になります。

テーマ設定の名前(キー)が存在しない場合、sprintf()$default を通した値が返されます。その時、第1引数(文字列)にテンプレートディレクトリーの URI、第2引数(文字列)にスタイルシートディレクトリーの URI が与えられます。

使い方

<?php get_theme_mod( $name, $default ); ?>

パラメーター

$name
文字列) (必須) テーマ設定の名前(キー)。
初期値: なし
$default
真偽値|文字列) (オプション) 名前(キー)が存在しない場合の値。
初期値: false

戻り値

(文字列) 
テーマ設定の値。

用例

カスタム背景色の取得

この例はフッター上部にカスタム背景色をボーダーとして配置するために利用できるかもしれません。次のような css コードをヘッダーに入れます:

.footer {
    border-top: solid 1px #<?php echo get_theme_mod( 'background_color' ); ?>;
}

参考

変更履歴

ソースファイル

get_theme_mod()wp-includes/theme.php にあります。

関連項目

background_color(), set_theme_mod(), get_theme_mod(), get_theme_mods(), remove_theme_mod(), remove_theme_mods()



関数リファレンステンプレートタグ目次もご覧ください。


最新英語版: WordPress Codex » Function_Reference/get_theme_mod最新版との差分