add_option

パラメータ

• $option
  サイトオプション名を指定。
• $value
  サイトオプションの値を指定（省略時は''）。
• $deprecated
  使用不可（省略時は''、次の$autoloadを指定する場合は''を指定すること）。
• $autoload
  [6.6.0]自動読み込みする場合はtrueまたは'yes'、しない場合はfalseまたは'no'を指定（省略時はnull）。
  6.5.x以前では自動読み込みする場合はtrueまたは'yes'、しない場合はfalseまたは'no'を指定（省略時は'yes'）。

返り値

注意

テーマやプラグイン独自のオプション情報を保存する場合に使用する。ただ新規追加だけでなく更新を行う場合は、このadd_option関数と update_option関数を使い分けるよりも、update_option関数のみを使用するほうがシンプルである（update_option関数では、指定されたサイトオプションが登録されていない場合このadd_option関数を呼び出して追加してくれるため）。

パラメータ$autoloadは、WordPressのシステムが実行する際にデータベースから自動的に読み込むかどうかを指定するもので、通常（省略時）のサイトオプションの値は自動的に読み込まれる。

[6.6.0]パラメータ$autoloadのデフォルト値がnullに変更された。後方互換のため'yes'または'no'にも対応している。

使用例

• 'mytheme_setting'という名前で値10を追加する。
  <?php add_option( 'mytheme_setting', 10 ); ?>
• 'mytheme_setting'という名前で文字列'mytheme'を自動読み込みしない状態で追加する。
  <?php add_option( 'mytheme_setting', 'mytheme', '', 'no' ); ?>

フィルター

アクション

do_action( 'add_option', $option, $value );

do_action( "add_option_{$option}", $option, $value );

do_action( 'added_option', $option, $value );

ソースファイル