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

説明

remove_theme_mod() は、テーマカスタマイザーの設定値を削除する関数です。

基本構文

remove_theme_mod( string $name ): void

引数

  • $name:設定名

戻り値

戻り値はありません。

使い方(サンプル)

remove_theme_mod( 'footer_text' );

注意点

  • 削除すると、get_theme_mod() の既定値が使われます。

実務での使いどころ

  • テーマの、特定の設定値を、削除して、既定の値に戻すとき。

よくあるミスと対処

  • remove_theme_mods()(複数形)と、取り違える。複数形は、そのテーマのすべての設定値を、削除する。
  • 削除した設定の既定値を、get_theme_mod() の第2引数で、指定していない。

NG例

remove_theme_mods(); // すべての設定値が、削除される

OK例

remove_theme_mod( 'main_color' ); // 1つの設定値だけを削除

使い分け早見表

関数 役割
remove_theme_mod() 1つの設定値を、削除する
remove_theme_mods() すべての設定値を、削除する
set_theme_mod() 設定値を、保存する

関連項目

get_theme_mod()、set_theme_mod()

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

コメント

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