update_site_option

(2.8.0以降)
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

関連

お勧めコンテンツ

query_posts(WP_Queryクラス)でカスタムフィールドを使う(2011年9月15日 登録)

先週3回にわたってtax_queryパラメータを使ったカテゴリーや投稿タグ、投稿フォーマットの絞り込みを整理したが、その途中で目に付いたのが'meta_query'パラメータ。この'meta_query'パラメータは、カスタムフィールドの絞り込み条件を指定するためのもので、3.2で登場した新しいパラメータのようだ。

初期状態で「抜粋」ウィジェットを表示する(2014年1月7日 登録)

投稿編集ページのウィジェットは標準で表示されるものとされないものがある。フォーラムに『投稿の編集画面にデフォルトで抜粋を表示させたい』という投稿があったので、ちょっと調べてみた。

Post-tag automaton:プラグイン作ってみました(2012年7月3日 登録)

みなさんは投稿をポストする際に投稿タグを付け忘れたことはないでしょうか。このプラグインは、投稿をポストする際にタイトルと記事に投稿タグが含まれていないか調べ、含まれていた場合はその投稿タグを追加します。

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

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

固定ページのURLの拡張子をhtmlに変更する(2012年8月8日 登録)

固定ページについて、URLを静的ページっぽく拡張子htmlに変更したいという要望を受けることがある。これまでは「.html on PAGES」というプラグインを使っていて特に不満があったわけではないのだが、今回ひょんなことから簡単に対応できることがわかったので、メモ書きしておく。

最終更新日時 : 2017-03-23 14:08