add_option

（1.0.0以降）
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

関連

参考

Code Reference: add_option

お勧め

meta_compare_key使ってみた（2019年3月19日 更新）

ブロックエディターの登場により、標準のカスタムフィールドを使う機会はかなり減った気がする。そんな中、5.1.0で追加されたのが、カスタムフィールド名（メタキー）に含まれる文字列を指定する'meta_compare_key'キーだ。

WP_List_Tableクラスの「一括操作」フォームを使ってみた（2018年5月27日 更新）

今回は「WP_List_Tableクラスを使ってみた」の続き。投稿一覧やプラグインページなどにある「一括操作」（Bulkアクション）フォーム対応に関するメモである。

テーマから投稿画像のサイズを指定する（2012年3月15日 更新）

投稿記事に挿入する画像サイズは、サムネイル（150×150）、中サイズ（300×300）、大サイズ（1024×1024）がデフォルトだが、テーマによっては別のサイズを指定したい場合はある。基本的には、「設定」－「メディア」の「メディア設定」ページで指定できるが、テーマ内のfunctions.phpで設定しておくとちょっと便利かもしれない。

ログインページを変える（2014年9月12日 更新）

WordPressの標準的な不正ログイン対策としては、ログインIDは'admin'を避けるパスワードはユニークで長くする、場合によってはアクセスできるIPアドレスを制限する、といった具合だろう。これらの他に何かできないものだろうかと、ちょっと考えてみた。

新規投稿時の本文プレースホルダーテキストを変える（2021年9月9日 更新）

ブロックエディターに影響を与えるフィルターは多数存在する。今回紹介するフィルターはその1つで、新規投稿時の本文ブロックのプレースホルダーテキストを変更するものだ。