説明
パラメータ
- $attrimg要素に指定する属性を格納した連想配列を指定(省略時は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
関連
お勧め
CSSやJavaScriptファイルのバージョン番号を変える(2018年5月27日 更新)
WordPress 4.7系の脆弱性をついた攻撃も落ち着いた感じなので、標準でヘッダーやフッター内に出力されるWordPressのバージョン番号について一考しました。
テーブルブロックを投稿メタ(カスタムフィールド)に保存する(2022年1月5日 更新)
ふと「テーブルブロックの内容を投稿メタ(カスタムフィールド)として保存できたら便利なのでは」と思い、投稿メタの使い方を調べてみた。
カスタム投稿タイプの投稿保存には専用アクションを使おう(2014年7月4日 更新)
カスタム投稿タイプを登録して、専用ウィジェット(meta_box)を使って拡張情報を入力させ、それらの情報をsave_postアクションで保存する。これまではこんな感じだったのだが、久しぶりにカスタム投稿タイプを使ったら、save_postアクションの前にsave_postに投稿タイプ名がくっついたアクションが追加されていた。
Fotepo:プラグイン作ってみました(2019年9月19日 更新)
仕事柄、Chromeの「デベロッパーツール」を使ってページのフォントを変更することがある。そんな時、無効なフォント名を指定してしまったり、フォント名をまちがえることがあり、もう少しお手軽にできないかと思って作ったのが今回紹介するプラグイン「Fotepo」である。
5.3への準備:投稿写真を使っているサイトは準備しておこう(2019年10月10日 更新)
この記事は先日公開した「5.3の新機能:JPEG画像の向きを調整」の続きのようなものになる。高解像度の投稿写真を扱っているサイトは、5.3のリリースに合わせて対応を検討しておくべきことをまとめてみた。