概要
get_header_image 関数は、ヘッダ用イメージのURLを取得するための関数です。この関数は、カスタマイズ可能なテーマで、ユーザーが設定したヘッダー画像を取得する際に非常に便利です。この関数は、テーマのヘッダーにダイナミックな画像を表示することを可能にし、以下の機能を実装する際によく使われます：
- カスタマイザーでのヘッダー画像設定
- ページタイトルに合わせた画像の表示
- テーマデザインの一貫性を保つ
- ユーザーエクスペリエンスの向上
- ブランディングの強化
- レスポンシブデザインへの対応
- ヘッダーに関連する特別なイベントのプロモーション
- 写真やビジュアルコンテンツを通じた Communicatonの向上
構文
get_header_image();
パラメータ
この関数には、パラメータはありません。
戻り値
この関数は、ヘッダ画像のURLを返します。
関連する関数
使用可能なバージョン
get_header_image 関数は WordPress 2.9.0 以降で使用できます。
コアファイルのパス
get_header_image 関数は次のファイルに含まれています：
/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 | 〇 |
非推奨または削除されたバージョン
特定のバージョンで非推奨または削除されていません。
サンプルコード
サンプル1: ヘッダー画像を表示する
<?php if ( get_header_image() ) : ?>
<img src="<?php echo esc_url( get_header_image() ); ?>" alt="<?php bloginfo( 'name' ); ?>">
<?php endif; ?>
このコードは、設定されたヘッダー画像のURLを取得し、それを<img>タグで表示します。
サンプル2: ヘッダー画像のスタイルを追加する
<?php if ( get_header_image() ) : ?>
<div style="background-image: url('<?php echo esc_url( get_header_image() ); ?>'); height: 300px; background-size: cover;">
<h1><?php bloginfo( 'name' ); ?></h1>
</div>
<?php endif; ?>
ヘッダー画像を背景として使用し、その上にサイト名を表示します。
サンプル3: デフォルトのヘッダー画像を設定する
function my_custom_header_setup() {
add_theme_support( 'custom-header', array(
'default-image' => get_template_directory_uri() . '/images/default-header.jpg',
));
}
add_action( 'after_setup_theme', 'my_custom_header_setup' );
このコードは、デフォルトのヘッダー画像を設定するためのもので、カスタムヘッダーのサポートを追加します。
サンプル4: ヘッダー画像が設定されていない場合のフォールバック
<?php
$header_image = get_header_image();
if ( empty( $header_image ) ) {
$header_image = get_template_directory_uri() . '/images/fallback-header.jpg';
}
?>
<img src="<?php echo esc_url( $header_image ); ?>" alt="<?php bloginfo( 'name' ); ?>">
ヘッダー画像が設定されていない場合にフォールバック用の画像を使用するサンプルです。
サンプル5: ヘッダー画像のURLをリダイレクトする
function redirect_to_header_image() {
$header_image_url = get_header_image();
if ( $header_image_url ) {
wp_redirect( $header_image_url );
exit;
}
}
add_action( 'template_redirect', 'redirect_to_header_image' );
ヘッダー画像のURLにリダイレクトするためのサンプルコードになります。
上記のサンプルコードはすべて著作権フリーのものであり、WordPressのカスタマイズに役立ちます。