add_option

(1.0.0以降)
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' ); ?>

関連

お勧めコンテンツ

the_date関数で投稿日を確実に表示する(2011年12月20日 登録)

投稿記事の投稿日時を表示する際、the_date関数を使用することが多いだろう。このthe_date関数はphpのdate関数と同じパラメータを指定することで、好みの日時フォーマットで投稿日時を表示できるのだが、ある条件の場合に投稿日時を表示しない。最初にこの現象に遭遇したときは、ちょっと悩まされた。

ページを表示する直前の前処理にtemplate_redirectアクションを(2013年4月13日 登録)

リクエストに応じてページを表示する直前の準備として何かしらの処理を行っておきたいケースがある。そんな時、テーマの各テンプレートファイルの先頭部分に処理内容をずらずらと記述していませんか。

パスとURL(2011年10月6日 登録)

テーマやプラグインで、WordPressシステム関連のディレクトリやURLを使う時があり、それらの多くは関数や定数として定義されている。今回は、それらの関数や定数について整理していく。

開発環境(Windows 8)にimagickを入れる(2012年12月23日 登録)

WordPress 3.5のイメージエディタ(WP_Image_Editor)は、GDだけでなく、imagick(ImageMagick)にも対応している。そんなわけでWindows 8の開発環境にimagickをインストールしてみた。

HTML entities button:プラグイン作ってみました(2011年6月29日 登録)

以前投稿した「HTML編集モードに定型文ボタンを追加する」をアレンジして、HTML編集モードに特殊文字(HTMLエンティティ)を挿入できるボタン、顔文字を挿入できるボタン、過去の投稿ページのリンクを挿入できるボタンを追加するプラグインを作ってみました。HTML編集モードの作業効率を向上させるプラグインです。2.0.0の新機能は「こちら」で確認してください。HTML編集モードをメインに使用されている方は、お試しあれ。

最終更新日時 : 2015-08-22 11:29