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

最終更新 : 2016年05月22日 15:08



お勧め

プラグインのロード順を制御する(2014年6月9日 更新)

これまでプラグインがどのような順番でロードされるか意識していなかったのだが、とある自作プラグインを他のプラグインよりも先にロードさせたくなったので調べてみた。

5.3の機能強化:カスタムフィールドキーの条件指定が使いやすくなる(2019年11月19日 更新)

5.3 RC4もリリースされ、正式リリースまであと1週間。5.3の変更点を確認していると、WP_Meta_Queryクラスが変更されていた。これは「Expanded meta key comparison operators in 5.3」で紹介されており、さまざまな条件指定が追加されていた。

HTML entities button:プラグイン作ってみました(2021年4月28日 更新)

以前投稿した「HTML編集モードに定型文ボタンを追加する」をアレンジして、HTML編集モードに特殊文字(HTMLエンティティ)を挿入できるボタン、顔文字を挿入できるボタン、過去の投稿ページのリンクを挿入できるボタンを追加するプラグインを作ってみました。HTML編集モードの作業効率を向上させるプラグインです。2.1.0では「Dashiconsの挿入」を追加しました。HTML編集モードをメインに使用されている方は、お試しあれ。

更新ボタンの横にスピナーを実装する(2019年5月14日 更新)

WordPressの管理画面ではAJAXを使って何らかの処理を行う際、数秒間の空き時間にアイコンがクルクル回る「スピナー」を表示しているところがある。今作っているプラグインでこの「スピナー」を使いたくなったので、実装方法を調べてみた。

「順序」をtextからnumberに変更してみた(2018年5月27日 更新)

固定ページの編集画面の「投稿の属性」ウィジェットには、ページの並び替えに使用できる「順序」のinput要素がある。この「順序」のinput要素はtype属性が'text'となっており、編集の際にIMEが有効になってしまう場合がある。ページの編集頻度が多くなると、その都度IMEをオフにするのがやや面倒になってくる。