説明
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
関連
お勧め
6.2に追加されるsearch_columnsパラメータが便利（2023年3月30日 更新）
バージョン6.2では記事検索機能を備えたWP_Queryクラスにsearch_columnsパラメータが追加される。標準のキーワード検索では、タイトル（post_title）、本文（post_content）、抜粋（post_excerpt）が対象になっているが、search_columnsパラメータを使うと対象を絞り込めるようになる。
固定ページのURLの拡張子をhtmlに変更する（2013年3月9日 更新）
固定ページについて、URLを静的ページっぽく拡張子htmlに変更したいという要望を受けることがある。これまでは「.html on PAGES」というプラグインを使っていて特に不満があったわけではないのだが、今回ひょんなことから簡単に対応できることがわかったので、メモ書きしておく。KUSANAGIでマルチサイト（サブドメイン）を試した（2019年8月6日 更新）
本サイトはサブディレクトリタイプのマルチサイト機能を採用して構築しているが、これまでサブドメインタイプは利用した経験はない。マルチサイト機能のサブドメインタイプは以前から1度は試してみたいと思っており、今回実際にサイトを構築してみた。
Fotepo：プラグイン作ってみました（2019年9月19日 更新）
仕事柄、Chromeの「デベロッパーツール」を使ってページのフォントを変更することがある。そんな時、無効なフォント名を指定してしまったり、フォント名をまちがえることがあり、もう少しお手軽にできないかと思って作ったのが今回紹介するプラグイン「Fotepo」である。
カテゴリー専用の投稿一覧と新規投稿メニューを追加する（2012年1月23日 更新）
サイト更新の1クリックを省くため、特定カテゴリーの投稿に対して同じようにメニューを追加してみた。カスタム投稿タイプの専用投稿メニューみたいな感じである。