string(11) "3.239.76.25"

2022年04月25日

WP関数:get_theme_mod()

この関数の説明

WP関数の get_theme_mod() は、カスタマイザ(customize_register)の「ユーザ作成メニュ」で追加した変数値の値を取得する関数です。

 


関数

get_theme_mod( $name, $default )

 


パラメータ

$name(文字列)(必須)

カスタマイザで設定した変数名(キー)。

初期値: なし

 

$default(真偽値|文字列|数字) (必須

変数名(キー)のデフォルト値を指定します。

・文字入力の場合:''

・数値入力の場合:デフォルトの数値

・ラジオBOXの場合:'1'

・チェックBOXの場合:false

・カラーコードの場合:デフォルトのカラーコード

 メモ

マニュアルでは$defaultは必須パラメータではありません。

しかし、これを指定しないとデフォルト値が取得できないケースがあります。

そこで、デフォルト値でも変更値でも確実に取得する為には、これを指定する事をお勧めします。

 


戻り値

カスタマイズのテーマ設定の変数値の値を返します。

 


事例

下記を参照してください。

カスタマイズ画面に「ユーザ作成メニュ」を追加する方法

 

アクションフック&関数
  • admin_init
  • admin_menu
  • after_setup_theme
  • customize_register
  • manage_pages_custom_column
  • manage_posts_custom_column
  • pre_get_posts
  • save_post
  • widgets_init
  • wp_enqueue_scripts
  • wp_head
  • add_editor_style()
  • add_post_type_support()
  • add_theme_support()
  • do_action()
  • get_post()
  • get_theme_mod()
  • register_nav_menu()
  • register_post_type()
  • register_sidebar()
  • register_taxonomy()
  • register_widget()
  • remove_action()
  • remove_editor_styles()
  • remove_theme_support()
  • set_post_thumbnail_size()
  • set_query_var()
  • show_admin_bar()
  • unregister_nav_menu()
  • unregister_widget()
  • wp_enqueue_script()
  • wp_enqueue_style()