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



お勧め

個人データのエクスポートメール向けに追加された新フィルター(2020年4月2日 更新)

先週「WordPress 5.4 RC3」が公開され、正式リリースまであと1週間。ブロックエディターの機能強化が目立つわけですが、地味な変更点もちらほらと。今回はその中の1つ、「個人データのエクスポート」機能に関連するフィルターを紹介する。

決まった値を返すだけの関数群(2018年5月27日 更新)

WordPressのソースコードを眺めているとフィルター関数名で'__return_○○'が指定されている部分を時々見かけます。それらの関数定義を見てみると、すべて決まった値を単純に返すだけでした。これらの関数がちょっと気になったので、まとめてみました。

サイドバーの初期化はwidgets_initアクションで(2011年7月14日 更新)

ウィジェットを使ってみたくなり新テーマ「Twenty Eleven」を覗いてみると、codexに記載されていた内容と少し違っている。これって「Twenty Ten」ですでに変更されていたんだね。

Gutenbergでカスタムフィールドを使う(2018年8月10日 更新)

Gutenbergの新エディターではカスタムフィールドのウィジェットが表示されない。既存のカスタムフィールドのデータはなくなるわけでないので、新エディター上で編集・更新できないか調べてみた。

favicon.icoがWordPressロゴになる!?(2020年2月25日 更新)

先週「WordPress 5.4 Beta2」が公開され、来月末には正式リリース。タイミングよく三連休だったので、1つ前の「ニュース」で紹介されていた変更点から確認してみた。