get_theme_mod

(2.1.0以降)
get_theme_mod - 現在のテーマ固有のプロパティ値を取得する

説明

string get_theme_mod( string $name [ , mixed $default = false ] )
現在のテーマ固有のプロパティ値を取得する。

パラメータ

  • $name
    プロパティ名を指定。
  • $default
    プロパティの値がない場合のデフォルト値を指定(省略時はfalse)。

返り値

パラメータ$nameで設定されているテーマ固有のプロパティ値を返す。パラメータ$nameのプロパティ値が設定されていない場合はパラメータ$defaultの値を返す。

注意

現在のテーマ固有のプロパティは、update_optionで 'theme_mods_$theme_slug' という名前($theme_slugは現在のテーマのスラッグ)で格納される。
パラメータ$nameのプロパティ値が設定されておらず、パラメータ$defaultの値に%sが含まれている場合は、1つ目の%sにget_template_directory_uriが、2つ目の%sにはget_stylesheet_directory_uriの値が適用される。

使用例

  • 現在のテーマ固有の'background_color'プロパティ値を取得する。
    <?php $bcolor = get_theme_mod( 'background_color', '000000' ); ?>

フィルター

設定されているプロパティ値を返す直前に theme_mod_$name フィルターを実行する。パラメータ$valueには設定されている値が格納されている。
return apply_filters( "theme_mod_$name", $value );

アクション

実行するアクションはありません。

ソースファイル

/wp-includes/theme.php

関連

お勧めコンテンツ

query_posts(WP_Queryクラス)で'tax_query'を使いこなす(2011年9月8日 登録)

2日にわたって投稿した「query_posts(WP_Queryクラス)でカテゴリーを絞り込む」「query_posts(WP_Queryクラス)で投稿タグを絞り込む」の続き。今日はカテゴリーや投稿タグ以外ののタクソノミーによる絞り込み、複数のタクソノミーの絞り込みの組み合わせについてまとめてみる。

3.2標準テーマ「Twenty Eleven」は投稿フォーマットに着目(2011年7月6日 登録)

新テーマ「Twenty Eleven」のトップページでは、投稿フォーマットに応じて表示を切り替える仕組みが提案されている。ここでは、その投稿フォームの活用方法を簡単に紹介する。

スクリプトファイルのバージョンパラメータを変更する(2015年2月10日 登録)

Java Scriptやスタイルシートの指定を直接head要素内に記述せず、wp_enqueue_scriptsフィルターなどを使って指定する場合、WordPressのバージョン番号が付与されている。このバージョン番号は、妥当なんだろうか。

初期状態で「抜粋」ウィジェットを表示する(2014年1月7日 登録)

投稿編集ページのウィジェットは標準で表示されるものとされないものがある。フォーラムに『投稿の編集画面にデフォルトで抜粋を表示させたい』という投稿があったので、ちょっと調べてみた。

開発環境(Windows 8)にimagickを入れる(2012年12月23日 登録)

WordPress 3.5のイメージエディタ(WP_Image_Editor)は、GDだけでなく、imagick(ImageMagick)にも対応している。そんなわけでWindows 8の開発環境にimagickをインストールしてみた。

最終更新日時 : 2016-05-22 15:08