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



お勧め

カスタムフィールド関連関数のおさらい(2012年6月22日 更新)

カスタムフィールドは、投稿記事の拡張情報としてよく利用されている。投稿ページで登録した情報をアーカイブや投稿ページで表示しているが、投稿ページを表示する際にカスタムフィールドの値を更新して、サイドバーのようなページ内要素に利用したりしている。

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

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

日本語名のユーザーを登録する(2018年5月27日 更新)

標準のログインID(ユーザー名)は、英数字と一部の記号の組み合わせで構成されている。一般的なシステムのログインIDはおおむねこんな感じだが、ふと「インターネット環境ならログインIDに日本語が使用できてもいいんじゃないか」と思い、実現できるか調べてみた。

ショートコードを使ってテーマ内の画像URLを簡単に指定する(2018年5月27日 更新)

投稿記事の中で画像パーツを使いたいときがある。画像パーツの配置場所は、/imgディレクトリのようなテーマ外の場合と、/wp-content/themes/mytheme/imagesディレクトリのようなテーマ内の場合があり、今回は後者のケース。ショートコードを使って投稿記事の画像ファイルのURLを記述する方法を紹介したい。

HTML entities button:プラグイン作ってみました(2017年12月17日 更新)

以前投稿した「HTML編集モードに定型文ボタンを追加する」をアレンジして、HTML編集モードに特殊文字(HTMLエンティティ)を挿入できるボタン、顔文字を挿入できるボタン、過去の投稿ページのリンクを挿入できるボタンを追加するプラグインを作ってみました。HTML編集モードの作業効率を向上させるプラグインです。2.1.0では「Dashiconsの挿入」を追加しました。HTML編集モードをメインに使用されている方は、お試しあれ。