説明
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 );do_action( "add_option_{$option}", $option, $value );do_action( 'added_option', $option, $value );ソースファイル
/wp-includes/option.php最終更新 : 2024年07月22日 09:30
関連
お勧め
ショートコードを使ってテーマ内の画像URLを簡単に指定する（2018年5月27日 更新）
投稿記事の中で画像パーツを使いたいときがある。画像パーツの配置場所は、/imgディレクトリのようなテーマ外の場合と、/wp-content/themes/mytheme/imagesディレクトリのようなテーマ内の場合があり、今回は後者のケース。ショートコードを使って投稿記事の画像ファイルのURLを記述する方法を紹介したい。リクエスト応答を終了する前に何かを処理する（2013年9月26日 更新）
PHPでは、register_shutdown_function関数を使うことでリクエストに対してレスポンスを返した後に何らかの処理を行うことができる。WordPressでもregister_shutdown_function関数は使えると思うのだが、テーマ内のテンプレートでページを表示した後で何かを行う場合はどうすればいいのか、ちょっと調べてみた。
投稿情報を連想配列で参照する（2018年5月27日 更新）
投稿情報は、タイトルや本文、投稿日時といったいくつかのデータが含んでおり、多くの場合オブジェクトになっている。これを連想配列で扱いたい場合はキャストして型変換することが多かった。基本的にはキャストで問題ないのだが、ふと目に留まったto_arrayメソッドが興味深かったのでメモとして残しておく。
段落ブロックに日付・時刻の入力支援を実装した（2023年1月25日 更新）
ブロックエディターには文字入力を支援するAutocompleteがある。自作ブロックだけでなく既存のブロックに適用できるため、ブロックの利用シーンを踏まえた入力支援機能を追加できる。
ブロックエディターのタグ入力にタグクラウド機能を追加した（2019年1月10日 更新）
ブロックエディターのタグ入力には「よく使われているタグから選択」から表示される「タグクラウド」がない。ブロックエディターの不満なところのひとつがこれであり、うまく解消することができないか考えてみた。