テンプレートタグ/get bloginfo

この項目「テンプレートタグ/get bloginfo」は、翻訳チェック待ちの項目です。加筆、訂正などを通して、Codex ドキュメンテーションにご協力下さい。

説明

PHP コード内の他の部分で使用できるようにサイトに関する情報を返します。またこの関数と bloginfo() はテンプレートファイル内の任意の場所で、サイト情報を表示するために使用できます。

使い方

<?php $bloginfo = get_bloginfo( $show, $filter ); ?>

パラメータ

$show

（文字列）（オプション）取得したい情報を指すキーワード。

初期値： 'name'

'name' - サイトのタイトル。設定 > 一般設定でセット。このデータは wp_options テーブルの「blogname」レコードから取得される。
'description' - サイトのキャッチフレーズ。設定 > 一般設定でセット。このデータは wp_options テーブルの「blogdescription」レコードから取得される。
'wpurl' - WordPress アドレス (URL)。設定 > 一般設定でセット。このデータは wp_options テーブルの「siteurl」レコードから取得される。特にサブドメインではなくパスを使うマルチサイト構成の場合は（この関数は現在のサブサイトではなくルートサイトを返すので）代わりに site_url() の使用を検討してください。
'url' - サイトアドレス (URL)。設定 > 一般設定でセット。このデータは wp_options テーブルの「home」レコードから取得される。 home_url() と同じ。
'admin_email' - メールアドレス。設定 > 一般設定でセット。このデータは wp_options テーブルの「admin_email」レコードから取得される。
'charset' - サイトの言語。設定 > 一般設定でセット。このデータは wp_options テーブルの「blog_charset」レコードから取得される。
'version' - 使用中の WordPress のバージョン。このデータは wp-includes/version.php 内でセットされる $wp_version 変数から取得される。
'html_type' - WordPress の HTML ページの Content-Type（デフォルト：「text/html」）。このデータは wp_options テーブルの「html_type」レコードから取得される。テーマとプラグインは pre_option_html_type /en フィルターを使ってデフォルト値を上書きできる。
'text_direction' - WordPress の HTML ページのテキスト方向。代わりに is_rtl() の使用を検討してください。
'language' - WordPress の言語を返す。
'stylesheet_url' - 有効なテーマのプライマリー CSS ファイル（ふつうは style.css）の URL。代わりに get_stylesheet_uri() の使用を検討してください。
'stylesheet_directory' - 有効なテーマのスタイルシートディレクトリーの URL。代わりに get_stylesheet_directory_uri() の使用を検討してください。
'template_url' / 'template_directory' - 有効なテーマのディレクトリー（2.6 より前はローカルパスでした。hackish な代用品は get_theme_root() と get_template() /en を見てください）。子テーマでは get_bloginfo('template_url') と get_template() の両方とも親テーマのディレクトリーを返す。代わりに get_template_directory_uri()（親テンプレートのディレクトリー）または get_stylesheet_directory_uri()（子テンプレートのディレクトリー）の使用を検討してください。
'pingback_url' - ピンバック用 XML-RPC ファイルの URL を返す。 (xmlrpc.php)
'atom_url' - Atom フィードの URL を返す。 (/feed/atom)
'rdf_url' - RDF/RSS 1.0 フィードの URL を返す。(/feed/rfd)
'rss_url' - RSS 0.92 フィードの URL を返す。 (/feed/rss)
'rss2_url' - RSS 2.0 フィードの URL を返す。 (/feed)
'comments_atom_url' - コメントの Atom フィードの URL を返す。 (/comments/feed)
'comments_rss2_url' - コメントの RSS 2.0 フィードの URL を返す。 (/comments/feed)
'siteurl' - バージョン 2.2 にて非推奨。 home_url() または get_bloginfo('url') を使ってください。
'home' - バージョン 2.2 にて非推奨。 home_url() または get_bloginfo('url') を使ってください。

$filter

（文字列）（オプション）取得した値に適用するフィルターを指定するキーワード。

初期値： 'raw'

'display' - $show に従って取得した値を wptexturize() 関数へ渡してから呼び出し元へ返す。
'raw' - $show に従って取得した値をそのまま返す。

戻り値

パラメーターで指定したブログの情報。

用例

デフォルトの使い方

デフォルトのまま使ってブログのタイトルを取得し、変数 $blog_title へセットします。

 <?php $blog_title = get_bloginfo(); ?>

ブログタイトル

次の例はブログのタイトルを変数 $blog_title へセットします。デフォルトの使い方と同じ値を返します。

 <?php $blog_title = get_bloginfo('name'); ?>

ブログのキャッチフレーズ

次の例は：

 <?php echo 'ブログのキャッチフレーズは: ' . get_bloginfo ( 'description' ); ?><br />

あなたのブログへ次のように表示します：

 ブログのキャッチフレーズは: All things WordPress

マルチサイトのキャッチフレーズ

次の例ではネットワークホームのタイトルとキャッチフレーズを取得できます：

 <?php
 switch_to_blog(1);
 $site_title = get_bloginfo( 'name' );
 $site_url = network_site_url( '/' );
 $site_description = get_bloginfo( 'description' );
 restore_current_blog();
 echo 'ネットワークホームの URL は: ' . $site_url;
 echo 'ネットワークホームのタイトルは: ' . $site_title;
 echo 'ネットワークホームのキャッチフレーズは: ' . $site_description;  
?>

あなたのブログへ次のように表示されます：

 ネットワークホームの URL は: http://example.com/
 ネットワークホームのタイトルは: Example
 ネットワークホームのキャッチフレーズは: The example site

出力例

バージョン 2.7 以降の例です。ホストが example.com で、サイトアドレス (URL) は http://www.example.com/home と表示され、WordPress アドレス (URL) は http://www.example.com/home/wp にインストールされているとします。

ディレクトリーの URL は最後のスラッシュがないことに注意してください。

admin_email          = admin@example.com
atom_url             = http://www.example.com/home/feed/atom
charset              = UTF-8
comments_atom_url    = http://www.example.com/home/comments/feed/atom
comments_rss2_url    = http://www.example.com/home/comments/feed
description          = Just another WordPress blog
home                 = http://www.example.com/home (非推奨! 代わりに url オプションを使ってください)
html_type            = text/html
language             = en-US
name                 = Testpilot
pingback_url         = http://www.example.com/home/wp/xmlrpc.php
rdf_url              = http://www.example.com/home/feed/rdf
rss2_url             = http://www.example.com/home/feed
rss_url              = http://www.example.com/home/feed/rss
siteurl              = http://www.example.com/home (非推奨! 代わりに url オプションを使ってください)
stylesheet_directory = http://www.example.com/home/wp/wp-content/themes/largo
stylesheet_url       = http://www.example.com/home/wp/wp-content/themes/largo/style.css
template_directory   = http://www.example.com/home/wp/wp-content/themes/largo
template_url         = http://www.example.com/home/wp/wp-content/themes/largo
text_direction       = ltr
url                  = http://www.example.com/home
version              = 3.5
wpurl                = http://www.example.com/home/wp

変更履歴

新規導入: 0.71

ソースファイル

get_bloginfo() は wp-includes/general-template.php にあります。

http://gatespace.jp/2013/02/22/underscores04/#sec3 -GateSpace スターターテーマ _s を使ってWordPressのテーマをつくる（ファイルパスとブログ情報編）

関数リファレンス、テンプレートタグ目次もご覧ください。

テンプレートタグ/get bloginfo

目次

説明

使い方

パラメータ

戻り値

用例

デフォルトの使い方

ブログタイトル

ブログのキャッチフレーズ

マルチサイトのキャッチフレーズ

出力例

変更履歴

ソースファイル

案内メニュー

個人用ツール

名前空間

変種

表示

その他

検索

このサイトについて

リファレンス

サーバー別情報

ドキュメント整備

協力・貢献

WordPress関連リンク

ツール

他言語版

テンプレートタグ/get bloginfo

目次

説明

使い方

パラメータ

戻り値

用例

デフォルトの使い方

ブログタイトル

ブログのキャッチフレーズ

マルチサイトのキャッチフレーズ

出力例

変更履歴

ソースファイル

関連項目

案内メニュー

検索