update_option

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

関連

参考

Code Reference: update_option

お勧め

the_date関数で投稿日を確実に表示する（2011年12月20日 更新）

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

3.8の「アクティビティ」ウィジェットに投稿以外の情報も表示する（2014年1月17日 更新）

ちょうど1月前の「ダッシュボードの「概要」にカスタム投稿タイプ件数を表示する」にて、WordPress 3.8新ダッシュボードの「概要」ウィジェットにカスタム投稿タイプの投稿数を表示する方法を紹介したが、今回のその続編で「アクティビティ」ウィジェットを拡張する方法を紹介する。

Gutenberg、初見です（2018年8月6日 更新）

先週末、WordPress 4.9.8がリリースされ、事前に告知されてたように「Gutenberg」がお披露目になった。投稿編集ページがガラリと変わり、影響範囲はそれなりに大きいと思われる。まずはこの週末に感じたことを整理してみた。

Login rebuilder 2.4.0の新機能を紹介（2018年5月27日 更新）

昨日、約半年ぶりにLogin rebuilderをアップデートし、著者ページ（author page）の閲覧を制限できる機能を追加した。この機能は、著者ページの閲覧によってユーザーIDが類推されることを防ぐことが目的としている。

同じ名前のメタ情報をまとめて削除する（2014年3月21日 更新）

WordPressには、投稿情報、コメント情報、ユーザ情報のそれぞれを拡張できるメタ情報の仕組みが用意されている。投稿情報のメタ情報は「カスタムフィールド」として投稿画面に用意されているので投稿者自身が随時操作できるほか、テーマやプラグインからの操作も容易である。今回の中身はそんなメタ情報の一括削除の話だ。