説明
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
関連
お勧め
Contact Form 7に確認フェーズを(2012年12月16日 更新)
Contact Form 7はWordPressによるサイト製作でお世話になることが多いプラグインの1つ。ただ、クライアント様によっては、入力、確認、送信の3フェーズにしたいという要望があり、そんな時は別の方法を採用していたのですが、JavaScript(jQuery)を使ってページ遷移しなくてもいいなら確認フェーズは用意できるかなと思い、作り込んでみた。投稿一覧に独自リンクを追加する(2013年10月16日 更新)
管理者ページの「投稿一覧」や「固定ページ一覧」の各投稿記事はマウスポインタを移動すると、「編集」や「クイック編集」といったリンクが表示される。このリンクに独自のリンクを追加する方法を調べてみた。HTML編集モードに定型文ボタンを追加する(2011年6月1日 更新)
投稿編集ページにはビジュアル編集モードとHTML編集モードがあり、それらを拡張するプラグインも多数存在している。そういったプラグインを利用するのもいいのだが、仕組みを理解するのも悪くないはず。というわけで、ここではHTML編集モードのボタンの仕組みと定型文を挿入するボタンを追加する方法を紹介する。投稿日の検索が自由自在に(2015年3月7日 更新)
WordPress 3.7.0ではWP_Date_Queryクラスが追加され、WP_Queryクラス(もちろん query_posts関数でも)で利用できるようになった。このWP_Date_Queryにより、○年○月○日以前や以降の投稿情報を取得したり、○年○月○日から○年○月○日の範囲の投稿情報を取得したりといったことが、容易に行えるようになった。
プラグインのヘッダー情報を国際化対応しよう(2018年5月27日 更新)
バージョン4.8がリリースされてひと段落。あらためてプラグイン一覧ページを見てみると「Akismet」が「Akismet Anti-Spam (アンチスパム)」と表示されていた。説明文だけじゃなくプラグイン名も国際化対応できたのね。