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



お勧め

初期化に関連するアクションのおさらい(2013年11月27日 更新)

いつも何気なくfunctions.phpで使っているafter_setup_themeアクションやinitアクション。普段はあまり意識していなかったが、ふとしたことからどんな順番に呼び出されるのか気になってしまい、ちょっと調べてみた。

WP_List_Tableクラスを使ってみた(2018年5月27日 更新)

WordPressの管理画面ではデータを一覧表示しているページがいくつもある。今回この仕組みを自分のプラグインでも使ってみたいと思い、調査しながらプラグインに組み込んでみた。

投稿ページでユニークなテンプレートを選択しよう(2018年5月27日 更新)

4.7の変更点に「投稿タイプテンプレート」がある。これは従来固定ページ('page')向けに任意のテンプレートを適用できる機能が拡張されたもので、投稿ページ('post')はもちろんカスタム投稿タイプのページにも適用可能になっている。

常時SSL接続に変更しました(2018年5月27日 更新)

先週末、本サイトを常時SSL接続に変更しました。本サイトは「さくらのVPS」(CentOS 6系、Apache 2.2系)上にWordPressのマルチサイト機能を使って構築しており、無償で使用できる「Let's Encrypt」を使って常時SSL接続に切り替えた手順をメモとして残しそうと思います。

テキストエディタの文字を変更する(2018年5月27日 更新)

テキストエディタ(投稿ページの「テキスト」タブのエディタ)に標準では備わっていない機能を追加する自作プラグイン「html entities button」がほぼ1年ぶりにアップデート。ここではバージョン2.0.0で追加したテキストエディタのフォント切り替え機能について紹介する。