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



お勧め

WP_List_Tableクラスの「一括操作」フォームを使ってみた(2018年5月27日 更新)

今回は「WP_List_Tableクラスを使ってみた」の続き。投稿一覧やプラグインページなどにある「一括操作」(Bulkアクション)フォーム対応に関するメモである。

wp_titleからwp_get_document_titleへ(2018年5月27日 更新)

先週、WordPress 4.4 beta1(以降4.4 beta1)が公開されました。この4.4 beta1では新テーマ「Twenty Sixteen」が追加されたほか、wp-includesディレクトリ以下のファイルが大幅に変更された感じです。

WordPressのコーディングスタンダードとPSR-2がかみ合わない(2018年5月27日 更新)

先日パソコンのストレージを換装して開発環境を再構築。エディタのEclipseは「Neon(4.6)」から「Oxygen(4.7)」へ切り替わった。コードを書き始めるとそこはかとなく違和感があり、調べていくとPHPの「Code Style(Formatter)」が「PSR-2」に設定されていることが原因だった。

カテゴリー専用の投稿一覧と新規投稿メニューを追加する(2012年1月23日 更新)

サイト更新の1クリックを省くため、特定カテゴリーの投稿に対して同じようにメニューを追加してみた。カスタム投稿タイプの専用投稿メニューみたいな感じである。

さくらのVPSでKUSANAGI#3(2018年5月27日 更新)

今回は「前回」の続き。http(80番)をクローズ、そのほかに行った調整作業について整理する。