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



お勧め

wp_titleからwp_get_document_titleへ(2018年5月27日 更新)

先週、WordPress 4.4 beta1(以降4.4 beta1)が公開されました。この4.4 beta1では新テーマ「Twenty Sixteen」が追加されたほか、wp-includesディレクトリ以下のファイルが大幅に変更された感じです。

ツイート引用が簡単になる仕組み(2012年6月8日 更新)

WordPress 3.4では、投稿記事の中にツイートのURLを記述するだけで、投稿ページにそれっぽい表示をしてくれるようになる。ちょっと気になったので、その仕組みを追っかけてみた。

5.5の機能強化:テーマ変更時に要求バージョンを確認(2020年8月12日 更新)

WordPress 5.5 RC 2が公開され、来週には正式版がリリース。変更箇所が多い「WordPress 5.5 RC 2(以降RC 2)」のソースコードを眺めていると、テーマの切り替え前にWordPressとPHPのバージョンを確認するようになっていた。

サイトヘルス機能を使ってみた(2019年4月12日 更新)

先月末にWordPress 5.2 Beta1が、今日はWordPress 5.2 Beta2(以降5.2Beta2)が公開された。5.2ではブロックエディターの機能が強化され、サイトの安全性とパフォーマンス向上に役立つとされるサイトヘルス機能が追加される。

ブロックエディターで編集したページが出力した余分な改行を削除(2019年2月22日 更新)

ブロックエディターで編集したページのHTMLソースは、投稿本文部分の改行が目立った。Webページとしての表示は問題ないのだが、データとしては不要なので削除することにした。