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

最終更新 : 2024年07月22日 09:30



お勧め

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

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

Somewhere search box:プラグイン作ってみました(2021年4月26日 更新)

投稿済みの記事を修正する際、毎回「投稿一覧」に戻るのは面倒だ、そんなことを感じて作ったのがこのプラグインです。また1.2.0では投稿内容(本文、カテゴリーや投稿タグ、カスタムフィールド)を複製するリンクを投稿一覧ページと投稿編集ページに追加、1.3.0では投稿タイトルのみの検索をサポートしました。

カスタムブロックを作っていると、ブロック自身の「サイズ」を指定するUIを持たせることがある。そんなときにちょっとモヤっとするのが、「マージン」や「パディング」の設定しているパネルのタイトルが「サイズ」なこと。この「サイズ」の原文は「Dimensions」であり、個人的にもう少しスッキリするワードに変更してみた。

決まった値を返すだけの関数群(2018年5月27日 更新)

WordPressのソースコードを眺めているとフィルター関数名で'__return_○○'が指定されている部分を時々見かけます。それらの関数定義を見てみると、すべて決まった値を単純に返すだけでした。これらの関数がちょっと気になったので、まとめてみました。

5.7の新機能:AJAXでパスワードを取得(2021年2月17日 更新)

日本時間の今朝「WordPress 5.7 Beta 3(以降Beta 3)」が予定通り公開されました。今回は、ソースコードを眺めていた時に気になったパスワードを取得できるAJAXについて確認した。