get_site_option

説明

mixed get_site_option( string $option [ , mixed $default = false [ , bool $use_cache$deprecated = true ] ] )
サイトオプションの値を取得する。

パラメータ

  • $option
    サイトオプション名。'siteurl'、'site_name'、'user_count'、'blog_count'、'global_terms_enabled'など。
  • $default
    オプションの値(省略時はfalse)。
  • $use_cache$deprecated
    キャッシュに保存された値を使用する場合はtrue、使用しない場合はfalseを指定(省略時はtrue)。[4.4.0]非推奨で実質的に未使用。

返り値

パラメータ$optionで指定されたサイトオプションの値を返す。サイトオプションが登録されていない場合は、パラメータ$defaultの値となる。

注意

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

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


使用例

  • サイトオプション'site_name'の値を取得する。
    <?php $name = get_site_option( 'site_name' ); ?>

フィルター

[2.9.0]データベースに保存された値を取得する前に'pre_site_option_{$option}'フィルターを呼び出す。パラメータ$valueには省略時の値としてfalseが格納されている。
$pre = apply_filters( "pre_site_option_{$option}", $value );
[3.4.0]ネットワークオプションが未登録の場合は'default_site_option_{$option}'フィルターを呼び出す。パラメータ$defaultが格納されている。
return apply_filters( "default_site_option_{$option}", $default );
[2.9.0]オプションの値を返す前に'site_option_{$option}'フィルターを呼び出す。パラメータ$valueには取得したオプションの値が格納されている。
return apply_filters( "site_option_{$option}", $value );

アクション

実行するアクションはありません。

ソースファイル

/wp-includes/option.php

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



お勧め

4.2で始まるiOSの絵文字ケア(2018年5月27日 更新)

WordPress 4.2のベータ1、ベータ2が立て続けにリリースされ、4.2の正式版リリースが近づいています。4.2のポイントの1つは絵文字のクロスブラウザ対応です。ここでの絵文字とは、UTF-8で4バイトのコードが割り当てられている(基本的にはiOSの)絵文字を指します。この絵文字を含んだ投稿が正しく保存できなかったり、iOS以外の環境で意図した通りに表示できないといった問題があり、4.2ではそのような問題を対処をコードが組み込まれています。

投稿内容のid属性などを保存するための対策(2012年6月15日 更新)

WordPress 3.4にアップデートしたとある環境で投稿記事を保存すると、divタグなどのid属性がクリアされて保存するようになった(id属性が保存できなくなった)。ここでは、その対策方法の1つを紹介しておく。

カレンダーウィジェットをAjaxで切り替える(2011年8月22日 更新)

ウィジェットベースでテーマを構築していてカレンダーを表示してみた。標準では、前月や次月のリンク先はそれぞれの月のアーカイブページとなっているのだが、記事を探すだけであればカレンダー部分だけを更新するほうが便利なのではと考え、そのアイデアを実装してみた。

続テーマを変更せずにWebフォントを使ってみた(2022年2月8日 更新)

先日投稿した「テーマを変更せずにWebフォントを使ってみた」では、テーマ「Twenty Twenty One」でWebフォントを使うことができた。その後、ほかのテーマで試したところ、そのままではWebフォントを使うことができなかった。今回は、それらのテーマの対応について紹介する。

LevelとCapability(2018年5月27日 更新)

プラグインやテーマの管理ページを作成する際など、ユーザのレベルと権限を確認することがある。ここでは、権限グループ別のレベルと権限の有無を整理してみた。