set_theme_mod() の使い方|説明・引数・注意点

説明

set_theme_mod() は、テーマカスタマイザーの設定値を保存する関数です。

基本構文

set_theme_mod( string $name, mixed $value ): void

引数

  • $name:設定名
  • $value:値

戻り値

戻り値はありません。

使い方(サンプル)

set_theme_mod( 'footer_text', '© 2026' );

注意点

  • 現在のテーマの設定として保存されます。

実務での使いどころ

  • テーマの設定値を、プログラムから、保存するとき。

よくあるミスと対処

  • テーマをまたいで使う設定に、使っている。テーマを切り替えると、引き継がれない。そのような設定は、update_option() を使う。
  • カスタマイザーの設定を、通常は、カスタマイザーの画面から保存する。プログラムからの保存が、本当に必要かを、確認する。
  • 入力値を、検証・サニタイズしていない。

NG例

set_theme_mod( 'main_color', $_POST['color'] ); // サニタイズがない

OK例

$color = sanitize_hex_color( wp_unslash( $_POST['color'] ) );
if ( $color ) {
	set_theme_mod( 'main_color', $color );
}

使い分け早見表

関数 役割
set_theme_mod() テーマの設定値を、保存する
get_theme_mod() テーマの設定値を、取得する
update_option() テーマに依存しない設定値を、保存する

関連項目

get_theme_mod()、remove_theme_mod()

公式リファレンス:set_theme_mod() | Function | WordPress Developer Resources

コメント

タイトルとURLをコピーしました