概要
get_bloginfo 関数は、WordPress の基本的なサイト情報を取得するために使用されます。この関数を使用することで、サイトのタイトル、説明、URL、言語、テンプレートディレクトリなど、関連する情報を簡単に取得できます。
get_bloginfo 関数がよく使われるケースは以下のとおりです。
- サイトタイトルを表示する
- サイトURLを表示する
- サイトの説明文を表示する
- テンプレートディレクトリのパスを取得する
- サイトの管理者メールアドレスを取得する
- サイトの言語設定を取得する
- WordPress のバージョン番号を取得する
- 特定のオプション設定値を取得する
構文
get_bloginfo( $show, $filter );
パラメータ
$show(string) 【必須】: 取得したい情報の種類を指定します。$filter(bool) 【オプション】: フィルタの適用を指定します。
戻り値
取得した情報の文字列。
関連する関数
使用可能なバージョン
WordPress 1.5 から使用可能です。
コアファイルのパス
wp-includes/general-template.php
サンプルコード
1. サイトタイトルを取得する
$title = get_bloginfo('name');
echo 'サイトのタイトル: ' . $title;
このコードは、サイトのタイトルを取得し、表示します。
2. サイトの説明を取得する
$description = get_bloginfo('description');
echo 'サイトの説明: ' . $description;
このコードは、サイトの説明文を取得して、表示します。
3. サイトのURLを取得する
$site_url = get_bloginfo('url');
echo 'サイトのURL: ' . $site_url;
このコードは、サイトのURLを取得し、表示します。
4. テンプレートディレクトリのパスを取得する
$template_dir = get_bloginfo('template_directory');
echo 'テンプレートディレクトリのパス: ' . $template_dir;
このコードは、現在使用中のテンプレートディレクトリのパスを取得し、表示します。
5. サイトの管理者メールアドレスを取得する
$admin_email = get_bloginfo('admin_email');
echo '管理者メールアドレス: ' . $admin_email;
このコードは、サイトの管理者メールアドレスを取得して、表示します。
この関数のアクションでの使用可能性
| アクション | 使用例 |
|---|---|
| mu_plugin_loaded | 〇 |
| registered_post_type | |
| plugins_loaded | 〇 |
| wp_roles_init | |
| setup_theme | 〇 |
| after_setup_theme | 〇 |
| set_current_user | |
| init | 〇 |
| register_sidebar | |
| wp_loaded | 〇 |
| send_headers | |
| parse_query | 〇 |
| pre_get_posts | |
| wp | |
| template_redirect | |
| get_header | |
| wp_head | 〇 |
非推奨または削除されたバージョン
特に非推奨または削除されたバージョンはありません。