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

最終更新 : 2018年05月27日 10:50



お勧め

投稿記事でrubyタグを使えるようにする(前編)(2012年1月25日 更新)

rubyなどのルビ関連タグはIEの独自サポートから始まり、少し前のChrome/Safariが追随して利用できるようになっている。Firefoxはいまだにサポートしていないのだが、それなりに代替表示されるので、投稿記事で使えるようにしてみた。

CSSやJavaScriptファイルのバージョン番号を変える(2017年3月14日 更新)

WordPress 4.7系の脆弱性をついた攻撃も落ち着いた感じなので、標準でヘッダーやフッター内に出力されるWordPressのバージョン番号について一考しました。

投稿日の検索が自由自在に(2015年3月7日 更新)

WordPress 3.7.0ではWP_Date_Queryクラスが追加され、WP_Queryクラス(もちろん query_posts関数でも)で利用できるようになった。このWP_Date_Queryにより、○年○月○日以前や以降の投稿情報を取得したり、○年○月○日から○年○月○日の範囲の投稿情報を取得したりといったことが、容易に行えるようになった。

絵文字画像がPNGからSVGへ(2016年8月30日 更新)

WordPressでは絵文字に対応していないブラウザ環境で絵文字を表示する仕組みをバージョン4.2から提供。絵文字に対応しているブラウザとそん色がない表示を実現する。

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

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