説明
パラメータ
- $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
関連
お勧め
ブロックエディターの文字サイズ設定を変えてみる(2019年12月12日 更新)
今回は「前回投稿した内容」の続きブロックエディターの文字サイズ設定を変えようと思う。参考にするテーマはもちろん「Twenty Twenty」である。
the_date関数で投稿日を確実に表示する(2011年12月20日 更新)
投稿記事の投稿日時を表示する際、 the_date関数を使用することが多いだろう。このthe_date関数はphpのdate関数と同じパラメータを指定することで、好みの日時フォーマットで投稿日時を表示できるのだが、ある条件の場合に投稿日時を表示しない。最初にこの現象に遭遇したときは、ちょっと悩まされた。投稿内容に応じてwpautopを制御する(2013年8月13日 更新)
投稿内容を表示する the_content関数では、 wpautop関数がフィルターの1つとして呼び出され、改行をbrタグに変換したり、pタグで調整したりする。この機能自体は便利なのだが、きちんとデザインされたHTMLソースを流し込んだ場合はこの機能は好ましくない。そんなわけで、記事内容に応じてwpautop関数を制御できないか考えてみた。
xmlrpc.phpへのアクセスについてちょっと考えた(2018年5月27日 更新)
少し前のことですが、こちらのサーバーを何度かダウンさせてしまったのですが、その原因はxmlrpc.phpへアクセスが集中したことによってサーバーが過負荷となってしまったというものでした。すぐにサーバー性能を上げることはできないため、xmlrpc.phpのアクセスを全部拒否するという暫定対応してしまいました。
メディアライブラリに絞り込み用の「投稿タグ」を追加する(2014年6月24日 更新)
この記事は、先月投稿したコラム「メディア(attachment)を拡張してより便利に活用する」の続編。メディアで「投稿タグ」を追加するだけで「メディアライブラリ」ページの投稿一覧の中には「タグ」カラムが追加されるが、今回はその「投稿タグ」で絞り込み検索に対応してみる。