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

説明

delete_option() は、オプションを削除する関数です。

基本構文

delete_option( string $option ): bool

引数

  • $option:オプション名

戻り値

削除できたら true。

使い方(サンプル)

delete_option( 'my_plugin_settings' );

注意点

  • プラグインのアンインストール時にデータを片付けるために使います。
  • WordPress標準のオプションを削除すると、サイトが動かなくなる恐れがあります。

実務での使いどころ

  • プラグインを削除するときに、保存した設定を消すとき(uninstall.php など)。
  • 不要になった設定を、削除するとき。

よくあるミスと対処

  • 存在しないオプションの削除では false が返る。失敗と区別して扱わない。
  • WordPress本体のオプション(siteurl など)を削除し、サイトが壊れる。
  • 無効化の時点で削除している。設定は、削除(アンインストール)時に消す。

NG例

register_deactivation_hook( __FILE__, function () {
	delete_option( 'my_setting' ); // 無効化しただけで、設定が消える
} );

OK例

// uninstall.php
if ( ! defined( 'WP_UNINSTALL_PLUGIN' ) ) {
	exit;
}
delete_option( 'my_setting' );

使い分け早見表

関数 役割
delete_option() オプションを削除する
update_option() 値を保存する
get_option() 値を取得する

関連項目

get_option()、update_option()

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

コメント

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