WordPressサイトの基本情報を表示するには、bloginfo()
もしくはget_bloginfo()
が使われます。
- サイト名
- サイトのキャッチフレーズ
- サイトアドレス
- 管理用として設定されたメールアドレス
- 使用言語
などを表示するための関数です。
WordPressでサイトを作る際にはほぼ100%使われる関数なので、実際に何ができるのか、を詳しくまとめました。
bloginfo と get_bloginfo の違い
サイトの基本的な情報を取得するには、下記の2種類があります。
- bloginfo
- get_bloginfo
どちらも、あとに続く() の中に「どんな情報が欲しいか」を記述して使います。
bloginfo
/ get_bloginfo
という関数の引数として、扱いたい項目名を指定するという形ですね。
例えば、サイト名を扱うための「項目名/引数」は、name
です。
よって、サイト内でサイト名を出力したいときは↓となります。
<?php bloginfo('name'); ?>
「項目名/引数」に、シングルクォーテーション(’ ‘)を付けて使うんですね。
bloginfo
とget_bloginfo
では、扱える情報は一緒ですが、機能面で決定的な違いがあるので注意してください。
bloginfo
は、指定した情報を取得して出力までしてくれます。
そのため、サイト名を表示したいときは↓
<h1><?php bloginfo('name'); ?></h1>
最終的に、きちんと↓のようなHTMLになります。
<h1>Miyachi Labo</h1>
ただし、get_bloginfo
は「取得するだけ」です。
実際に画面に出すにはecho
を付けて出力する必要があります。
<h1><?php echo get_bloginfo('name'); ?></h1>
例えば、サイト名を取得してから、情報を加工して出力したいときなどにget_bloginfo
が使われます。
bloginfo / get_bloginfo で呼び出せる全情報まとめ
bloginfo
ないしはget_bloginfo
で呼び出せるものは、現在20項目あります。
かつては22項目でしたが、WordPressのバージョンが2.2になった時に2項目が廃止され、使えなくなっています。
そこで、現在使える20項目をまとめました。
項目名/引数 | 取得(・出力)できる情報 |
---|---|
name | サイトタイトル 管理画面の「設定」>「一般」で設定されたもの |
description | キャッチフレーズ 管理画面の「設定」>「一般」で設定されたもの |
wpurl | WordPress アドレス (URL) 管理画面の「設定」>「一般」で設定されたもの マルチサイト構成にしており、サブドメインの代わりにパスを用いている場合は非推奨 |
url | サイトアドレス (URL) 管理画面の「設定」>「一般」で設定されたもの ※ home_url() での取得を推奨 |
admin_email | メールアドレス 管理画面の「設定」>「一般」で設定されたもの |
charset | 文字コード WordPressのバージョン3.5.0以降は、常に「UTF-8」 それ以前のバージョンでは、管理画面の「設定」>「表示設定」で設定されたものとなる |
version | 使用中のWordPressのバージョン |
html_type | HTML ページの Content-Type デフォルトの場合は「text/html」 |
text_direction | HTML ページの文字の向き ※ is_rtl() の利用を推奨 |
language | 使用されている言語 |
stylesheet_url | テーマファイル内に配置された初期CSSファイルのURL ※ get_stylesheet_uri() の利用を推奨 |
stylesheet_directory | 有効化されているテーマのディレクトリーURL ※ get_stylesheet_directory_uri() の利用を推奨 |
template_url / template_directory | 有効化されているテーマファイルのディレクトリーURL 子テーマでは get_bloginfo(‘template_url’) は親テーマのディレクトリーを習得する |
pingback_url | Pingback XML-RPC ファイルの URL (xmlrpc.php) |
atom_url | Atom feed URL (/feed/atom) |
rdf_url | RDF/RSS 1.0 feed URL (/feed/rfd) |
rss_url | RSS 0.92 feed URL (/feed/rss) |
rss2_url | RSS 2.0 feed URL (/feed) |
comments_atom_url | Atom feed URL (/comments/feed) |
comments_rss2_url | RSS 2.0 feed URL (/comments/feed) |
使用するときは、「項目名/引数」をシングルクォーテーション(’ ‘)でくくって使用してください。
<?php bloginfo('language'); ?>
ちなみに、↓のように「項目名/引数」を指定せず使った場合は、サイト名が扱えます。
<?php bloginfo(); ?>
サイトの基本情報を扱うには bloginfo / get_bloginfo
サイト全般にまたがるような基本的な情報は、bloginfo
ないしはget_bloginfo
で取り扱いができます。
特に、サイト名、キャッチフレーズ、サイトアドレス、言語設定はHTMLの<head>
タグなどでよく使われますね。
<!DOCTYPE html>
<html lang="<?php bloginfo('language'); ?>">
<head>
<!-- 文字コード -->
<meta charset="<?php bloginfo('charset'); ?>" />
<!-- カノニカルURL -->
<link rel="canonical" href="<?php bloginfo('url'); ?>" />
<!-- タイトル -->
<title><?php bloginfo('name'); ?></title>
</head>
どんな風に使われるのか気になる人は、WordPressテーマのheader.phpなどを見てみると参考になりますよ!