add_option

説明

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

パラメータ

  • $option
    サイトオプション名を指定。
  • $value
    サイトオプションの値を指定(省略時は'')。
  • $deprecated
    使用不可(省略時は''、次の$autoloadを指定する場合は''を指定すること)。
  • $autoload
    自動読み込みする場合は'yes'、しない場合は'no'を指定(省略時は'yes')。

返り値

$optionで指定した名前で$valueを保存できた場合はtrue、それ以外はfalseを返す。

注意

テーマやプラグイン独自のオプション情報を保存する場合に使用する。ただ新規追加だけでなく更新を行う場合は、このadd_option関数と update_option関数を使い分けるよりも、update_option関数のみを使用するほうがシンプルである(update_option関数では、指定されたサイトオプションが登録されていない場合このadd_option関数を呼び出して追加してくれるため)。 パラメータ$autoloadは、WordPressのシステムが実行する際にデータベースから自動的に読み込むかどうかを指定するもので、通常(省略時)のサイトオプションの値は自動的に読み込まれる。

使用例

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

最終更新 : 2015年08月22日 11:29



お勧め

LevelとCapability(2011年4月14日 更新)

プラグインやテーマの管理ページを作成する際など、ユーザのレベルと権限を確認することがある。ここでは、権限グループ別のレベルと権限の有無を整理してみた。

プラグインのヘッダー情報を国際化対応しよう(2017年8月4日 更新)

バージョン4.8がリリースされてひと段落。あらためてプラグイン一覧ページを見てみると「Akismet」が「Akismet Anti-Spam (アンチスパム)」と表示されていた。説明文だけじゃなくプラグイン名も国際化対応できたのね。

投稿一覧に独自リンクを追加する(2013年10月16日 更新)

管理者ページの「投稿一覧」や「固定ページ一覧」の各投稿記事はマウスポインタを移動すると、「編集」や「クイック編集」といったリンクが表示される。このリンクに独自のリンクを追加する方法を調べてみた。

初期状態で「抜粋」ウィジェットを表示する(2014年1月7日 更新)

投稿編集ページのウィジェットは標準で表示されるものとされないものがある。フォーラムに『投稿の編集画面にデフォルトで抜粋を表示させたい』という投稿があったので、ちょっと調べてみた。

canvasタグを投稿したい(2013年12月27日 更新)

以前「投稿内容のid属性などを保存するための対策」で取り上げたように、WordPressでは投稿に記述できるHTMLタグが制限されている。同コラムでこの制限を調整する対策を紹介しているが、3.5以降ではフィルター関数を登録して対応できるようだ。