説明
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 );do_action( 'update_site_option', $option, $value, $old_value );ソースファイル
/wp-includes/option.php最終更新 : 2018年05月27日 10:50
関連
お勧め
ブロックエディターの色設定を変えてみる（2019年12月11日 更新）
バージョン5.3で機能強化されたブロックエディター。対応を考えて新テーマ「Twenty Twenty」のソースコードを眺めていく。
「姓」の後に「名」を（2013年11月6日 更新）
WordPressのユーザー情報設定ページでは、「名（First name）」の後に「姓（Last name）」を入力するようになっている。日本向けのユーザー登録できるサイトの場合、この並び順はちょっと違和感があるので、「姓」「名」の順に入力できるようにした。
ホームディレクトリから過去のファイルを削除する（2013年1月27日 更新）
WordPressで構築したサイトのホームディレクトリには、現在使われていないファイルが残っている時がある。3.5.1もリリースされたことだし、これを機にホームディレクトリを整理整頓した。Login rebuilder 2.6.5の新機能紹介（2021年3月8日 更新）
今回追加したものは、管理者のダッシュボードに表示されるログウィジェットの日時について任意の書式を設定する機能である。これまで日時の書式はサイト設定を利用していたが、ログの日時については揃えた方が見やすいと思ったので、今回の機能で対応することにしました。
投稿情報を連想配列で参照する（2018年5月27日 更新）
投稿情報は、タイトルや本文、投稿日時といったいくつかのデータが含んでおり、多くの場合オブジェクトになっている。これを連想配列で扱いたい場合はキャストして型変換することが多かった。基本的にはキャストで問題ないのだが、ふと目に留まったto_arrayメソッドが興味深かったのでメモとして残しておく。