説明
string get_header_image_tag( array $attr = array() )
カスタムヘッダーのimg要素を取得する。
パラメータ
- $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
関連
お勧め
ダッシュボードの「クイックドラフト」を「CodeMirror」に変更してみた（2019年11月5日 更新）
管理ページの「テーマエディター」では4.9以降「CodeMirror」が利用されている。今回はこの「CodeMirror」をプラグインで活用できないか調べた話である。
headタグのmeta（generator）タグを取り除く（2018年5月27日 更新）
標準的なWordPressのテーマで出力されるHTMLには、headタグ内に次のようなmetaタグが出力されている。<meta name="generator" content="WordPress 3.0.5" />
Blacklist keys manager：プラグイン作ってみました（2015年5月22日 更新）
少し前から明らかにスパムと思われるコメントが投稿され、そのモデレーションメールを受け取る回数が増えてきた。あまりにもあからさまなコメントばかりなので、何らかの対策ができないか考えてみました。
5.5の機能強化：テーマ変更時に要求バージョンを確認（2020年8月12日 更新）
WordPress 5.5 RC 2が公開され、来週には正式版がリリース。変更箇所が多い「WordPress 5.5 RC 2（以降RC 2）」のソースコードを眺めていると、テーマの切り替え前にWordPressとPHPのバージョンを確認するようになっていた。
投稿内容に応じてwpautopを制御する（2013年8月13日 更新）
投稿内容を表示する the_content関数では、 wpautop関数がフィルターの1つとして呼び出され、改行をbrタグに変換したり、pタグで調整したりする。この機能自体は便利なのだが、きちんとデザインされたHTMLソースを流し込んだ場合はこの機能は好ましくない。そんなわけで、記事内容に応じてwpautop関数を制御できないか考えてみた。