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には更新前の値がそれぞれ格納されている。 [4.4.0]パラメータ$optionが追加され、オプション名が格納されている。
$value = apply_filters( 'pre_update_option_' . $option, $value, $old_value, $option );
[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

最終更新 : 2022年08月16日 17:55



お勧め

Posts filter multiselect:プラグイン作ってみました(2022年4月8日 更新)

先週の金曜日、知り合いの方から「投稿一覧ページで絞り込みを行う際、複数選択できないか」といった問い合わせがあり、その時には「標準では無理ですね」と返答しました。このこと自体は事実なのですが、要するに「複数選択可能なドロップダウンメニュー」が実現できれば対応するのはそれほど難しくないような気がしました。この週末、そんなノリでちょっとコーディングしてできたのがこのプラグインです。

全投稿を取得するのはnopaging=1でいい(2011年8月31日 更新)

query_posts関数(またはWP_Queryクラス)を使う場合、取得する件数の指定を省略すると管理者ページの「表示設定」-「1ページに表示する最大件数」の指定値分だけの投稿情報を取得する。それでは条件にマッチするすべての投稿情報を取得するには?

Contact Form 7に確認フェーズを(2012年12月16日 更新)

Contact Form 7はWordPressによるサイト製作でお世話になることが多いプラグインの1つ。ただ、クライアント様によっては、入力、確認、送信の3フェーズにしたいという要望があり、そんな時は別の方法を採用していたのですが、JavaScript(jQuery)を使ってページ遷移しなくてもいいなら確認フェーズは用意できるかなと思い、作り込んでみた。

古めのリビジョンを削除した時のメモ(2022年5月16日 更新)

大きく育ったデータベースを整理するため、古めのリビジョンとそれに紐づいたカスタムフィールドデータを削除。と思ったら「The total number of locks exceeds the lock table size」というエラーが発生して削除できなかった。

プラグインで注意が必要な関数(2013年11月27日 更新)

先日「Login rebuilder」という自作プラグインをアップデートした際、ユーザーさんからエラーになると連絡をいただいた。標準環境では問題なく、どうやら何らかのプラグインが影響しているらしい。