概要
get_uploaded_header_images 関数は、WordPress でアップロードしたヘッダー用イメージを取得するために使用されます。これにより、ユーザーがカスタマイズしたサーバー上のヘッダー画像を簡単に取得して表示することができます。この関数は特に以下のような機能を実装する際に役立ちます。
- テーマにカスタムヘッダー機能を追加する
- ユーザーのカスタムデザインを表示する
- ランダムなヘッダー画像を表示する
- 特定のページや投稿に応じたヘッダー画像を変更する
- ヘッダー画像の管理機能を提供する
- モバイルデバイス向けのヘッダー画像最適化
- 複数のヘッダー画像から選択できるギャラリーの実装
- 行動追跡のためのヘッダー画像切り替え機能の実装
構文
$array = get_uploaded_header_images();
パラメータ
この関数にはパラメータはありません。
戻り値
戻り値は、アップロードされたヘッダー用イメージの配列です。各イメージは、URL、幅、高さ、および ID 等の情報を含みます。
関連する関数
WordPress バージョン
get_uploaded_header_images 関数は、WordPress 2.9.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 |
サンプルコード
サンプル 1: ヘッダー画像の取得
このコードは、アップロードしたヘッダー用イメージを取得し、ループして表示します。
$header_images = get_uploaded_header_images();
foreach ($header_images as $image) {
echo '<img src="' . esc_url($image['url']) . '" width="' . esc_attr($image['width']) . '" height="' . esc_attr($image['height']) . '" />';
}
引用元: https://developer.wordpress.org/reference/functions/get_uploaded_header_images/
サンプル 2: 特定の条件下でヘッダー画像を表示
このサンプルでは、特定の条件に基づいてヘッダー画像を表示します。
if (is_single() && has_post_thumbnail()) {
$header_images = get_uploaded_header_images();
echo '<img src="' . esc_url($header_images[0]['url']) . '" />';
}
引用元: https://developer.wordpress.org/reference/functions/get_uploaded_header_images/
サンプル 3: ヘッダー画像の数をカウント
アップロードしたヘッダー用イメージの数を数えるサンプルです。
$header_images = get_uploaded_header_images();
$count = count($header_images);
echo 'アップロードされたヘッダー画像の数： ' . esc_html($count);
引用元: https://developer.wordpress.org/reference/functions/get_uploaded_header_images/
サンプル 4: サムネイルとして表示
取得したヘッダー画像をサムネイル形式で表示する場合の例です。
$header_images = get_uploaded_header_images();
if (!empty($header_images)) {
foreach ($header_images as $image) {
echo '<div class="thumbnail"><img src="' . esc_url($image['url']) . '" /></div>';
}
}
引用元: https://developer.wordpress.org/reference/functions/get_uploaded_header_images/
サンプル 5: メディアライブラリの画像と統合
メディアライブラリの画像とヘッダー画像を組み合わせて表示する場合の例です。
$header_images = get_uploaded_header_images();
$media_images = get_posts(array('post_type' => 'attachment', 'posts_per_page' => -1));
foreach (array_merge($header_images, $media_images) as $image) {
echo '<img src="' . esc_url($image['url']) . '" />';
}
引用元: https://developer.wordpress.org/reference/functions/get_uploaded_header_images/