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

関連

参考

Code Reference: get_theme_mod

お勧めコンテンツ

標準で使用できる数少ないショートコード[caption]とは（2011年5月7日 登録）

画像をアップロードして「投稿に追加」ボタンをクリックすると、投稿記事内にリンク付きのimgタグか、ショートコードのが挿入される。ここではそれらの書式を整理する。

ログアウト後はいつもサイトトップ（2015年5月7日 登録）

ログアウト後に表示（リダイレクト）されるページは、標準ではログインページ（wp-login.php）である。4.2.0ではログアウト処理後のページリダイレクト前に呼び出されるフィルターが追加された。

カレンダーウィジェットをAjaxで切り替える（2011年8月22日 登録）

ウィジェットベースでテーマを構築していてカレンダーを表示してみた。標準では、前月や次月のリンク先はそれぞれの月のアーカイブページとなっているのだが、記事を探すだけであればカレンダー部分だけを更新するほうが便利なのではと考え、そのアイデアを実装してみた。

headタグのmeta（generator）タグを取り除く（2011年2月18日 登録）

標準的なWordPressのテーマで出力されるHTMLには、headタグ内に次のようなmetaタグが出力されている。 
<meta name="generator" content="WordPress 3.0.5" />

「投稿に挿入」時のタグをちょっとカスタマイズ（2011年7月29日 登録）

投稿画面において、画像をアップロードし投稿に挿入するすると、imgタグをaタグで囲んだものが挿入される（キャプションを指定した場合はタグも）。それらの画像をLightBox（JavaScriptライブラリ）で表示する場合、aタグにrel属性を追加するのだが、その作業を毎回投稿に挿入した後で行うのがちょっと面倒。というわけで、自動的にrel属性を追加するようにしてみました。

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