get_bloginfo()
get_bloginfo()関数とは
get_bloginfo()関数は、WordPressサイトのブログ情報を取得するための関数です。この関数は、特定のパラメーターを渡すことで、サイトのタイトル、タグライン、説明文などを取得することができます。取得されたブログ情報は、文字列として返されます。また、サイト内の他のテンプレートからもブログ情報を取得することができます。
get_bloginfo()関数のパラメーター
get_bloginfo()関数には、次のようなパラメーターがあります。
$show (string) – 取得したい情報の種類を指定します。
- 'name' - サイトのタイトル(設定 > 一般で設定)。
- 'description' - サイトのキャッチフレーズ(「設定」>「一般」で設定)。
- 'wpurl' - ワードプレスのアドレス(URL)(「設定」>「一般」で設定)。
- 'url' - サイトのアドレス(URL)(「設定」>「一般」で設定)
- 'admin_email' - 管理者のメールアドレス (設定 > 一般で設定)
- 'charset' - "ページとフィードのエンコード" (設定 > 読み取り)で設定します。
- 'version' - 現在のWordPressのバージョン
- 'html_type' - content-type (デフォルト: "text/html"). テーマやプラグインは、 'pre_option_html_type' フィルタを使ってデフォルト値を上書きすることができます。
- 'text_direction' - サイトの言語によって決定されるテキストの方向。
- 'language' - 現在のサイトの言語コード。
- 'stylesheet_url' - 有効なテーマのスタイルシートのURL。アクティブな子テーマは、この値よりも優先されます。
get_bloginfo()関数の戻り値
get_bloginfo()関数は、get_bloginfo()関数を実行した時点でのWordPressサイトの情報を文字列として返します。
また、以下のように、取得した情報を使い、文字列を組み立てることも可能です。
$blog_name = get_bloginfo('name');
$blog_url = get_bloginfo('url');
echo 'サイト名:' . $blog_name . ', URL:' . $blog_url;
戻り値の例としては以上です。get_bloginfo()関数は、WordPressサイトに関する情報を取得するための関数です。取得された情報は、文字列として返されます。
get_bloginfo()関数の使い方
以下のように、サイトのタイトルを取得することができます。
1 上記のコードの出力例は下記の通りです。また、以下のように、サイトのURLを取得することもできます。
上記のコードの出力例は下記の通りです。
使い方の例としては以上です。get_bloginfo()関数は、WordPressを使用しているサイトの情報を取得するための関数です。複数のパラメーターを使用することで、取得する情報を絞り込むことができます。
まとめ
-
get_bloginfo() 関数は、WordPress 環境のブログ情報を取得するものです。
-
この関数は必須のパラメータとして情報の種類を受け取り、可変のパラメータとして情報を表示する形式を指定することができます。
-
この関数はブログ情報を文字列として返します。