update_site_option

説明

bool update_site_option( string $option, mixed $default )
サイトオプションの値を更新する。

パラメータ

  • $option
    サイトオプション名。'siteurl'、'site_name'、'user_count'、'blog_count'、'global_terms_enabled'など。
  • $default
    オプションの値。

返り値

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

注意

基本的にはマルチサイト向けの関数となる。サイトがシングルサイトの場合、 update_option関数を使用してその値を更新する。

設定する値は、サイトオプション名に応じてサニタイズしてから更新される。

[4.4.0] update_network_option関数が準備され、中身はupdate_network_option関数へ移り、本関数はラッパー関数となった。


使用例

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

フィルター

[2.9.0]更新の前段階で現在のオプション値を取得しておりその直後に'pre_update_site_option_{$option}'フィルターを呼び出す。パラメータ$valueには本関数が受け取った値が、$old_valueには現在のオプション値が格納されている。
$value = apply_filters( "pre_update_site_option_{$option}", $value, $old_value );

アクション

[2.9.0]オプション値を更新した場合に'update_site_option_{$option}'アクションを呼び出す。パラメータ$optionおよび$valueには本関数が受け取った値が、$old_valueには更新前のオプションの値が格納されている。
do_action( "update_site_option_{$option}", $option, $value, $old_value );
[3.0.0]上記のアクション後に'update_site_option'アクションを呼び出す。パラメータ$optionおよび$valueには本関数が受け取った値が、$old_valueには更新前のオプションの値が格納されている。
do_action( 'update_site_option', $option, $value, $old_value );

ソースファイル

/wp-includes/option.php

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



お勧め

投稿一覧ページに「更新日時」カラムを追加してみた(2019年8月27日 更新)

サイトの特性によるが、「投稿」には繰り返し更新するものがある。そんなサイトでは投稿一覧ページに「更新日時」があった方が便利。というわけで、今回は投稿一覧にソートに対応した「更新日時」カラムを追加する方法を紹介する。

5.3の機能強化:サブメニューの位置が指定可能になる(2019年10月29日 更新)

プラグインや一部のテーマでは管理画面の左側にあるナビゲーションメニューに任意のサブメニューを追加できる。従来、追加したサブメニューは既存のサブメニューの末尾となっているが、5.3ではその場所を指定できるようになる。

PHPとMySQLのバージョンを確認(2013年9月11日 更新)

先日、WordPressで構築されたサイトについて最新版へのバージョンアップを依頼される。使用されていたWordPressはバージョン2.xということで、最新版へバージョンアップできるのか、PHPとMySQLのバージョンを確認することになった。

ポップアップのログインフォームに何か表示する(2018年11月6日 更新)

まもなくリリースされるWordPress 5.0にタイミングを合わせて「Login rebuilder」プラグインのアップデートを予定している。管理画面にログインしてしばらく操作しないと、ログインフォームがポップアップ表示される。このログインフォームに何かを表示するのが今回の内容だ。

ブロックエディターの色設定を変えてみる(2019年12月11日 更新)

バージョン5.3で機能強化されたブロックエディター。対応を考えて新テーマ「Twenty Twenty」のソースコードを眺めていく。