概要
get_custom_logo 関数は、WordPress テーマでカスタムロゴを表示するための機能を実装する際によく使われます。この関数を使用することで、テーマに設定されたカスタムロゴの HTML を取得することができます。主に以下のような機能で活用されることが多いです。
- サイトのヘッダー部分にロゴを表示する。
- カスタムテーマでブランディングを強化する。
- モバイルデバイス向けのレスポンシブデザインにロゴを組み込む。
- WordPress カスタマイザーでロゴを簡単に変更できるようにする。
- 特定のページや投稿テンプレートで異なるロゴを表示する。
- WooCommerce のショップページのロゴ表示に利用する。
- カスタムウィジェットでのロゴ表示に使用する。
- サイトのバリエーションを持たせるためのことで異なるロゴを表示する。
構文
get_custom_logo( int $id = 0 )
パラメータ
- $id (int): 表示するカスタムロゴの投稿 ID。指定しない場合は、現在のサイトのカスタムロゴが使用されます。
戻り値
- (string) カスタムロゴの HTML を含む文字列。設定されていない場合は空の文字列を返します。
関連する関数
使用可能なバージョン
この関数は WordPress 4.5 以降で使用可能です。
コアファイルのパス
wp-includes/general-template.php
この関数のアクションでの使用可能性
| アクション | 使用例 |
|---|---|
| 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 | 〇 |
この関数は特定のバージョンで非推奨又は削除されてはいません。