get_theme_mod() の使い方｜説明・引数・注意点

説明

基本構文

get_theme_mod( string $name, mixed $default_value = false ): mixed

引数

• $name：設定名
• $default_value：未設定のときの値

戻り値

設定値。

使い方（サンプル）

echo esc_html( get_theme_mod( 'footer_text', '© Sample' ) );

注意点

• テーマごとに保存されるため、テーマを切り替えると値は引き継がれません。

実務での使いどころ

• カスタマイザーで設定した、テーマの設定値（色、ロゴ、レイアウトなど）を、取得するとき。

よくあるミスと対処

• 保存されていないと false が返る。代わりの値は、第2引数で指定する。
• テーマを切り替えると、設定値が引き継がれない。テーマごとに、保存されるため。テーマをまたいで使う設定は、get_option() を使う。
• 出力時に、エスケープしていない。

NG例

$color = get_theme_mod( 'main_color' ); // 未設定だと false

OK例

$color = get_theme_mod( 'main_color', '#3b82f6' );
echo esc_attr( $color );

使い分け早見表

関連項目

set_theme_mod()、remove_theme_mod()、get_option()

公式リファレンス：get_theme_mod() | Function | WordPress Developer Resources