説明
パラメータ
- $optionサイトオプション名を指定。
- $valueサイトオプションの値を指定(省略時は'')。
- $deprecated使用不可(省略時は''、次の$autoloadを指定する場合は''を指定すること)。
- $autoload[6.6.0]自動読み込みする場合はtrueまたは'yes'、しない場合はfalseまたは'no'を指定(省略時はnull)。
6.5.x以前では自動読み込みする場合はtrueまたは'yes'、しない場合はfalseまたは'no'を指定(省略時は'yes')。
返り値
$optionで指定した名前で$valueを保存できた場合はtrue、それ以外はfalseを返す。注意
テーマやプラグイン独自のオプション情報を保存する場合に使用する。ただ新規追加だけでなく更新を行う場合は、この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' ); ?>
フィルター
直接実行するフィルターはありません。アクション
[2.9.0]オプション値を追加する前に'add_option'アクションを呼び出す。パラメータ$optionには本関数が受け取った内容が、$valueにはサニタイズ済みの内容が格納されている。do_action( 'add_option', $option, $value );do_action( "add_option_{$option}", $option, $value );do_action( 'added_option', $option, $value );ソースファイル
/wp-includes/option.php最終更新 : 2024年07月22日 09:30
関連
お勧め
5.3の新機能:サイト管理者のメールアドレスを定期的に確認する(2019年9月27日 更新)
「WordPress 5.3 Beta 1」に記載されていた「Admin Email Verification」の項目が目に留まる。管理者のメールアドレスを定期的に確認するという仕組みがどんなものなのか気になったので、ちょっと調べてみた。
Widgets on dashboard:プラグイン作ってみました(2014年5月7日 更新)
サイトバーなどのページ構成パーツとしてウィジェットを利用し、ある程度頻繁に更新している場合、毎回ウィジェットページを表示するのはちょっとだけ面倒かも。そんなわけで、シンプルにダッシュボードで直接編集できればいいかなと思い、調べてみました。
Login rebuilder 2.5.0の新機能紹介(2018年12月10日 更新)
今回追加したものは、任意の名前でロックファイルを設定し、そのファイルが存在する場合は常にログイン不可にする機能である。この機能を有効にしておくことで、何らかの理由により認証に関する情報が漏洩した場合でも不正なログインを防ぐことができる。
フォーム内のエスケープ処理を考える(2018年10月19日 更新)
WordPressにはエスケープ処理を行う esc_html関数と esc_attr関数がある。HTML要素(タグ)の属性値ならesc_attr関数を、それ以外はesc_html関数を使うことがほとんどだが、今回esc_html関数が適していないと思われるケースに遭遇した。
ショートコードを含んだページを表示する前に何か処理する(2014年5月28日 更新)
固定ページまたは投稿ページに独自のフォームを埋め込む。入力→登録の2段階のフォームなら著名なプラグイン「Contact Form 7」を利用すればいいのだが、クライアントの依頼は入力→確認→登録の3段階で組み込む要素が特化していたので、独自の実装方法を考えることになった。