update_option

説明

bool update_option( string $option, mixed $newvalue [, mixed $autoload = null ] )
サイトオプションの値を更新する。

パラメータ

  • $option
    サイトオプション名。'siteurl'、'home'、'blogname'、'template'など。
  • $newvalue
    オプションの値。
  • $autoload
    [4.2.0]自動的にロードするかどうかを指定。'yes'またはtrueの場合は自動的にロードされ、'no'またはfalseの場合は自動的にロードされない。

返り値

パラメータ$optionで指定されたサイトオプションの値を更新できた場合はtrue、更新できなかった場合はfalseを返す。なお。更新する値と現在の値が同じ場合はfalseを返す。

注意

一部のWordPressシステムのサイトオプション情報も更新できるが、テーマやプラグイン独自のオプション情報を保存する場合にも使用できる。
パラメータ$optionで指定されたオプションが登録されていない場合は、内部で add_option関数を呼び出してそのオプション情報を追加する。なおパラメータ$newvalueで指定される値は、サイトオプション名に応じてサニタイズしてから更新される。 [4.2.0]新しいオプション情報を追加する際、$autoloadが省略(null)の場合は'yes'となる。自動的にロードする指定を変更する場合は、オプション値を変更しなければならない(4.2.0では現在のオプション値のまま$autoloadの指定を変更することはできないため、既存のオプション値の指定を変更する場合は注意すること)。

使用例

  • サイトオプション'blogname'の値を更新する。
    <?php update_option( 'blogname', 'Myブログ' ); ?>

フィルター

[2.6.0]現在の値を取得後に'pre_update_option_'.$optionフィルターを呼び出す(例:pre_update_option_blogname)。パラメータ$valueには更新後の値が、$old_valueには更新前の値がそれぞれ格納されている。
$value = apply_filters( 'pre_update_option_' . $option, $value, $old_value );
[3.9.0]更新する値が現在の値か比較する直前に'pre_update_option'フィルターを呼び出す。パラメータ$valueには更新後の値が、$optionにはオプション名が、$old_valueには更新前の値がそれぞれ格納されている。
$value = apply_filters( 'pre_update_option', $value, $option, $old_value );

アクション

[2.0.1]アップデート後に "update_option_{$option}"アクションを呼び出す(例:update_option_blogname)。パラメータ$old_valueには更新前の値が、$valueには更新後の値がそれぞれ格納されている。
do_action( "update_option_{$option}", $old_value, $value );
[2.9.0]アップデート後に'updated_option'アクションを呼び出す。パラメータ$optionにはオプション名が、$old_valueには更新前の値が、$valueには更新後の値がそれぞれ格納されている。
do_action( 'updated_option', $option, $old_value, $value );

ソースファイル

/wp-includes/option.php

最終更新 : 2019年04月23日 17:45



お勧め

メディア(attachment)を拡張してより便利に活用する(2014年5月22日 更新)

「メディア(attachment)」は、標準ではカテゴリもタグもカスタムフィールドもない。投稿と親子関係を作って利用することが前提だからともいえるが、メディアをもっと便利に活用するために、それらの付加情報を絞り込みの材料として利用できないか調べてみた。

MOファイルを作ってみた(2018年7月25日 更新)

テーマやプラグインで使用するMOファイルはWindows環境では「Poedit」アプリを使うことが多かったが、最近では「GlotPress」のようなプラグインも増えてきており、選択肢は広がっている。定期的に開発環境を見直す過程で「Poedit」から「GlotPress」に切り替えようと思ったのだが、微妙にしっくりこなかった。

headタグのmeta(generator)タグを取り除く(2018年5月27日 更新)

標準的なWordPressのテーマで出力されるHTMLには、headタグ内に次のようなmetaタグが出力されている。
<meta name="generator" content="WordPress 3.0.5" />

さくらのVPSでKUSANAGI(2018年5月27日 更新)

請け負っていた業務が一段落したので、「さくらのVPS」で「KUSANAGI」を試してみました。推奨環境はメモリ4GBとなっているが、今回は実験的な利用なので、SSD 2GBプランでトライしました。

新「WordPress Events and News」ウィジェットが興味深い(2018年5月27日 更新)

4.8のベータ版ですぐに新機能とわかるのが管理者ダッシュボードの新「WordPress Events and News」ウィジェット。ユーザーが指定した地域近隣で開催されるイベント情報を表示してくれるウィジェットで、この中のフォームがちょっと興味深かった。なおこの記事はWordPress 4.8 beta-2をもとにしており、以降のバージョンで変更される可能性があることをあらかじめ断っておく。