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



お勧め

4.4では投稿ページも専用テンプレートが適用できる(2018年5月27日 更新)

従来、特定の固定ページには専用テンプレートを適用できるのですが、投稿ページに適用させるためにはアクションやフィルターを利用する必要がありました。4.4では特定の投稿ページに標準で専用テンプレートを適用できるようになりそうです。

プラグインで注意が必要な関数(2013年11月27日 更新)

先日「Login rebuilder」という自作プラグインをアップデートした際、ユーザーさんからエラーになると連絡をいただいた。標準環境では問題なく、どうやら何らかのプラグインが影響しているらしい。

タイトルのみをキーワード検索する(2014年4月3日 更新)

WordPressのキーワード検索は、投稿タイトルと本文のどちらかに指定したキーワードが含まれているかを調べるわけだが、時々タイトルだけとか、逆に本文だけ検索したいケースがある。

oEmbedについて考えてみた(2018年5月27日 更新)

本サイト向けにテーマをリニューアルしようと思い一から作っている最中、ふと生成されているHTMLの中にあるoEmbedの記述が目についた。「この記述いつからだっけ」くらいに思いながらリンク先を開き、ちょっとモヤモヤしてしまった。

一定時間でログアウトする(2013年5月23日 更新)

ログイン関係を調べている関係で、 wp_set_auth_cookie関数に行き着く。ログイン画面の「ログイン状態を保持する」がチェックされた場合、クッキーの有効期限は14日間。チェックされていない場合は、ブラウザが閉じるまで常に有効となっているんだね。