get_header_image_tag

説明

string get_header_image_tag( array $attr = array() )
カスタムヘッダーのimg要素を取得する。

パラメータ

  • $attr
    img要素に指定する属性を格納した連想配列を指定(省略時はarray())。

返り値

カスタムヘッダーの画像を表示するためのimg要素の文字列を返す。

注意

パラメータ$attrは、標準で以下の内容が設定される(未指定の場合)。

キーデータ内容
'src'画像ファイルのURL
'width'
'height'高さ
'alt'ブログ名

また'srcset'属性が未指定で画像がアップロードされている場合は'srcset'および'sizes'の属性が追加される。

各属性の内容はこの関数内で esc_attr関数にてエスケープ処理されるので、パラメータ$attrに指定する際にエスケープ処理する必要はない。


使用例

  • カスタムヘッダーのimg要素を取得する。
    <?php $header_tag = get_header_image_tag(); ?>
  • alt属性を指定してカスタムヘッダーのimg要素を取得する。
    <?php $header_tag = get_header_image_tag( array( 'alt'=>'今日のフォト' ) ); ?>

フィルター

[4.4.0]img要素の文字列を返す前に'get_header_image_tag'フィルターを呼び出す。パラメータ$htmlにはimg要素の文字列が、$headerにはカスタムヘッダー情報が、$attrには本関数が受け取った内容を更新したものが格納されている。
return apply_filters( 'get_header_image_tag', $html, $header, $attr );

アクション

実行するアクションはありません。

ソースファイル

/wp-includes/theme.php

最終更新 : 2018年05月27日 10:43



お勧め

Login rebuilder 2.8.0の変更内容を紹介(2022年7月20日 更新)

先々週のアップデート」では、ダッシュボードの「ログインのログ」ウィジェット内に現在のユーザー(管理者のみ)のログイン状況を簡潔なメッセージで表示しましたが、一週間ほど使ってみると、もう少し詳しい情報が欲しくなりました。そんなわけで、ログイン中のユーザー情報を表示する新しいウィジェットを用意しました。

バージョン6.8へのアップデートに伴いユーザーのパスワードハッシュが更新される件について(2025年4月14日 更新)

WordPressバージョン6.8では、ユーザーのパスワードハッシュの生成方法が変更される。これに関連して、既存ユーザーのパスワードハッシュも更新されることがアナウンスされており、少し気になった。

カスタムフィールドで並び替え(2013年8月9日 更新)

WordPressでは複数の投稿記事を取得する際、並び順の指定を省略すると投稿日時の降順になる。並び順は、投稿日時だけでなく、更新日時、投稿名、記事タイトル、コメント数のほか、カスタムフィールドも指定できる。

初期化に関連するアクションのおさらい(2013年11月27日 更新)

いつも何気なくfunctions.phpで使っているafter_setup_themeアクションやinitアクション。普段はあまり意識していなかったが、ふとしたことからどんな順番に呼び出されるのか気になってしまい、ちょっと調べてみた。

5.5の新機能:XMLサイトマップの生成(2020年8月12日 更新)

来月にリリースされるWordPress 5.5に向けてついにRC 1が公開がされました。新機能であるXMLサイトマップについて「WordPress 5.5 RC 1(以降RC 1)」のソースコードを見ながら確認した。