説明
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
関連
お勧め
ショートコードを使ってテーマ内の画像URLを簡単に指定する(2018年5月27日 更新)
投稿記事の中で画像パーツを使いたいときがある。画像パーツの配置場所は、/imgディレクトリのようなテーマ外の場合と、/wp-content/themes/mytheme/imagesディレクトリのようなテーマ内の場合があり、今回は後者のケース。ショートコードを使って投稿記事の画像ファイルのURLを記述する方法を紹介したい。リクエスト応答を終了する前に何かを処理する(2013年9月26日 更新)
PHPでは、register_shutdown_function関数を使うことでリクエストに対してレスポンスを返した後に何らかの処理を行うことができる。WordPressでもregister_shutdown_function関数は使えると思うのだが、テーマ内のテンプレートでページを表示した後で何かを行う場合はどうすればいいのか、ちょっと調べてみた。
投稿情報を連想配列で参照する(2018年5月27日 更新)
投稿情報は、タイトルや本文、投稿日時といったいくつかのデータが含んでおり、多くの場合オブジェクトになっている。これを連想配列で扱いたい場合はキャストして型変換することが多かった。基本的にはキャストで問題ないのだが、ふと目に留まったto_arrayメソッドが興味深かったのでメモとして残しておく。
段落ブロックに日付・時刻の入力支援を実装した(2023年1月25日 更新)
ブロックエディターには文字入力を支援するAutocompleteがある。自作ブロックだけでなく既存のブロックに適用できるため、ブロックの利用シーンを踏まえた入力支援機能を追加できる。
ブロックエディターのタグ入力にタグクラウド機能を追加した(2019年1月10日 更新)
ブロックエディターのタグ入力には「よく使われているタグから選択」から表示される「タグクラウド」がない。ブロックエディターの不満なところのひとつがこれであり、うまく解消することができないか考えてみた。