概要
get_custom_header_markup関数は、カスタムヘッダーのHTMLパーツを取得するための関数です。この関数は、テーマやプラグインで動的にカスタムヘッダーを表示したい場合に使用されます。具体的には、カスタムヘッダー画像やカスタムロゴなどをテーマ内で利用する際に便利です。また、ユーザーがアップロードした画像を表示するためにも使用されます。
以下は、get_custom_header_markup関数がよく使用されるシチュエーションの例です。
1. テーマ設定でユーザーが指定したヘッダー画像を表示する。
2. カスタムロゴをトップページや投稿ページに埋め込む。
3. ユーザーが変更できるヘッダー用の画像をインポートする。
4. モバイルデバイス用に異なるヘッダー画像を設定する。
5. ヘッダーに特定のデザインを持たせるためのHTMLの生成。
6. カスタムCSSをヘッダーに追加する。
7. ページごとに異なるヘッダーを表示する場合の条件分岐。
8. ウィジェットエリアにヘッダーを統合する。
構文
get_custom_header_markup();
パラメータ
この関数には引数はありません。
戻り値
カスタムヘッダーのHTMLマークアップを返します。
関連する関数
使用可能なバージョン
WordPress 4.3.0以降で使用可能です。
コアファイルのパス
wp-includes/theme.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 |
非推奨または削除されたバージョン
特に非推奨または削除されたバージョンはありません。