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



お勧め

メディア(attachment)を拡張してより便利に活用する(2014年5月22日 更新)

「メディア(attachment)」は、標準ではカテゴリもタグもカスタムフィールドもない。投稿と親子関係を作って利用することが前提だからともいえるが、メディアをもっと便利に活用するために、それらの付加情報を絞り込みの材料として利用できないか調べてみた。

MOファイルを作ってみた(2018年7月25日 更新)

テーマやプラグインで使用するMOファイルはWindows環境では「Poedit」アプリを使うことが多かったが、最近では「GlotPress」のようなプラグインも増えてきており、選択肢は広がっている。定期的に開発環境を見直す過程で「Poedit」から「GlotPress」に切り替えようと思ったのだが、微妙にしっくりこなかった。

headタグのmeta(generator)タグを取り除く(2018年5月27日 更新)

標準的なWordPressのテーマで出力されるHTMLには、headタグ内に次のようなmetaタグが出力されている。
<meta name="generator" content="WordPress 3.0.5" />

さくらのVPSでKUSANAGI(2018年5月27日 更新)

請け負っていた業務が一段落したので、「さくらのVPS」で「KUSANAGI」を試してみました。推奨環境はメモリ4GBとなっているが、今回は実験的な利用なので、SSD 2GBプランでトライしました。

新「WordPress Events and News」ウィジェットが興味深い(2018年5月27日 更新)

4.8のベータ版ですぐに新機能とわかるのが管理者ダッシュボードの新「WordPress Events and News」ウィジェット。ユーザーが指定した地域近隣で開催されるイベント情報を表示してくれるウィジェットで、この中のフォームがちょっと興味深かった。なおこの記事はWordPress 4.8 beta-2をもとにしており、以降のバージョンで変更される可能性があることをあらかじめ断っておく。