add_option

説明

bool add_option( string $option [ , mixed $value = '' [ , mixed $deprecated = '' [ , string | bool $autoload = 'yes' null ] ] ] )
サイトオプションを追加する。

パラメータ

  • $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 );
[2.9.0]オプション値を追加した後に"add_option_{$option}"アクションを呼び出す。パラメータ$optionには本関数が受け取った内容が、$valueにはサニタイズ済みの内容が格納されている。
do_action( "add_option_{$option}", $option, $value );
[2.9.0]オプション値を追加した後に'added_option'アクションを呼び出す。パラメータ$optionには本関数が受け取った内容が、$valueにはサニタイズ済みの内容が格納されている。
do_action( 'added_option', $option, $value );

ソースファイル

/wp-includes/option.php

最終更新 : 2024年07月20日 14:34



お勧め

5.3の新機能:JPEG画像の向きを自動調整(2019年10月17日 更新)

WordPress 5.3 Beta 1」に記載されていた「Automatic image rotation during upload」という見出し。画像ファイルに含まれるEXIF情報内の「向き」により、画像の向きを自動的に調整するというもの。どんな実装なのか気になったのでソースコードをざっくり眺めてみた。

Login rebuilderに「XML-RPC設定」を追加しました(2018年5月27日 更新)

公式サイトで公開しているプラグイン「Login rebuilder」をバージョンアップし、XML-RPCリクエストの管理機能を追加しました。Login rebuilderの主たる機能は、ログインページをサイト別にユニークなURLに変更し、ログインページへの不正アクセスを回避することです。WordPressのXML-RPCリクエストはピンバックや外部ツールやサイトなどとの連携に利用されていますが、今回追加した機能ではXML-RPCリクエストの処理に対していくつかの制限できるようにしています。

query_posts(WP_Queryクラス)でカテゴリーを絞り込む(2011年9月14日 更新)

久しぶりに query_posts関数を見直してみると、見知らぬパラメータがいくつか追加されていた。気になったのでカテゴリー関係の指定を'tax_query'パラメータを交えて整理してみた。

5.5の機能強化:テーマ変更時に要求バージョンを確認(2020年8月12日 更新)

WordPress 5.5 RC 2が公開され、来週には正式版がリリース。変更箇所が多い「WordPress 5.5 RC 2(以降RC 2)」のソースコードを眺めていると、テーマの切り替え前にWordPressとPHPのバージョンを確認するようになっていた。

テーブルの1列目をth要素にしてみる(2021年12月21日 更新)

標準の「テーブル」ブロックでは、tbody要素内のセルはすべてtd要素になっている。テーブルの1列目についてはth要素を使いたいケースがあり、「トグル」コントロールを使って切り替え可能にできないか調べてみた。