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



お勧め

スマートフォン向けの振り分けを自前で行う(2012年1月23日 更新)

PC向けのサイトをスマートフォン対応する場合、WPtouchやktai styleに代表されるスマートフォン対応のテンプレート切り替えプラグインを使用するのが一般的。そういったプラグインはテンプレート切り替え以外の機能も備えており、そういった機能は必ずしも必要ではない。そんなわけで、ここでは超シンプルなスマートフォン向けのテンプレート切り替えを実現する方法を紹介する。

使っていないか確認しないとね!(2017年11月18日 更新)

2003年に誕生したWordPress。その歴史の中には、廃止予定(deprecated)となっている関数がいくつも存在する。それらの関数をテーマやプラグインで使用するべきではないし、使用しているなら代替の関数に書き換えるべきである。ここでは3.24.9.0現在、廃止予定となっている関数をまとめて紹介する。

プラグインのロード順を制御する(2014年6月9日 更新)

これまでプラグインがどのような順番でロードされるか意識していなかったのだが、とある自作プラグインを他のプラグインよりも先にロードさせたくなったので調べてみた。

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

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

初期状態で「抜粋」ウィジェットを表示する(2014年1月7日 更新)

投稿編集ページのウィジェットは標準で表示されるものとされないものがある。フォーラムに『投稿の編集画面にデフォルトで抜粋を表示させたい』という投稿があったので、ちょっと調べてみた。