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

関連

お勧めコンテンツ

使っていないか確認しないとね!(2011年6月8日 登録)

2003年に誕生したWordPress。その歴史の中には、廃止予定(deprecated)となっている関数がいくつも存在する。それらの関数をテーマやプラグインで使用するべきではないし、使用しているなら代替の関数に書き換えるべきである。ここでは3.24.7.0現在、廃止予定となっている関数をまとめて紹介する。

add_actionを使って管理ページで独自cssを使う(2011年2月25日 登録)

テーマやプラグインで専用の管理ページを作る場合、そのページ向けのcssやjavascriptが必要になることがある。どちらもページ内に直接記述できるが、特にcssは別ファイルに分けたいほうが便利だ。ここではその方法を紹介しよう。

メディアライブラリに絞り込み用の「投稿タグ」を追加する(2014年6月24日 登録)

この記事は、先月投稿したコラム「メディア(attachment)を拡張してより便利に活用する」の続編。メディアで「投稿タグ」を追加するだけで「メディアライブラリ」ページの投稿一覧の中には「タグ」カラムが追加されるが、今回はその「投稿タグ」で絞り込み検索に対応してみる。

カスタムフィールドで並び替え(2013年8月9日 登録)

WordPressでは複数の投稿記事を取得する際、並び順の指定を省略すると投稿日時の降順になる。並び順は、投稿日時だけでなく、更新日時、投稿名、記事タイトル、コメント数のほか、カスタムフィールドも指定できる。

「投稿に挿入」時のタグをちょっとカスタマイズ(2011年7月29日 登録)

投稿画面において、画像をアップロードし投稿に挿入するすると、imgタグをaタグで囲んだものが挿入される(キャプションを指定した場合はタグも)。それらの画像をLightBox(JavaScriptライブラリ)で表示する場合、aタグにrel属性を追加するのだが、その作業を毎回投稿に挿入した後で行うのがちょっと面倒。というわけで、自動的にrel属性を追加するようにしてみました。

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