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月22日 09:30



お勧め

6.2に追加されるsearch_columnsパラメータが便利(2023年3月30日 更新)

バージョン6.2では記事検索機能を備えたWP_Queryクラスにsearch_columnsパラメータが追加される。標準のキーワード検索では、タイトル(post_title)、本文(post_content)、抜粋(post_excerpt)が対象になっているが、search_columnsパラメータを使うと対象を絞り込めるようになる。

固定ページのURLの拡張子をhtmlに変更する(2013年3月9日 更新)

固定ページについて、URLを静的ページっぽく拡張子htmlに変更したいという要望を受けることがある。これまでは「.html on PAGES」というプラグインを使っていて特に不満があったわけではないのだが、今回ひょんなことから簡単に対応できることがわかったので、メモ書きしておく。

KUSANAGIでマルチサイト(サブドメイン)を試した(2019年8月6日 更新)

本サイトはサブディレクトリタイプのマルチサイト機能を採用して構築しているが、これまでサブドメインタイプは利用した経験はない。マルチサイト機能のサブドメインタイプは以前から1度は試してみたいと思っており、今回実際にサイトを構築してみた。

Fotepo:プラグイン作ってみました(2019年9月19日 更新)

仕事柄、Chromeの「デベロッパーツール」を使ってページのフォントを変更することがある。そんな時、無効なフォント名を指定してしまったり、フォント名をまちがえることがあり、もう少しお手軽にできないかと思って作ったのが今回紹介するプラグイン「Fotepo」である。

カテゴリー専用の投稿一覧と新規投稿メニューを追加する(2012年1月23日 更新)

サイト更新の1クリックを省くため、特定カテゴリーの投稿に対して同じようにメニューを追加してみた。カスタム投稿タイプの専用投稿メニューみたいな感じである。