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

説明

基本構文

add_option( string $option, mixed $value = '', string $deprecated = '', string|bool $autoload = 'yes' ): bool

引数

• $option：オプション名
• $value：値
• $deprecated：使用しません（空文字）
• $autoload：自動読み込みするか

戻り値

追加できたら true。

使い方（サンプル）

add_option( 'my_plugin_version', '1.0.0' );

注意点

• 既に存在する場合は上書きしません。上書きしたいときは update_option() を使います。
• プラグイン有効化時の初期値の登録によく使います。

実務での使いどころ

• オプションを、なければ新規に作るとき（プラグインの有効化時の初期値など）。
• すでにある値を、上書きしたくないとき。

よくあるミスと対処

• 更新のつもりで使っている。すでに存在すると、何もせず false が返る。更新には update_option() を使う。
• 戻り値を確認していない。

NG例

add_option( 'my_setting', 'new' ); // すでに存在すると、更新されない

OK例

update_option( 'my_setting', 'new' );

使い分け早見表

関連項目

update_option()、get_option()

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