get_header_image_tag

（4.4.0以降）
get_header_image_tag - カスタムヘッダーのimg要素を取得する

説明

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

関連

参考

Code Reference: get_header_image_tag

お勧め

Somewhere search box：プラグイン作ってみました（2018年5月8日 更新）

投稿済みの記事を修正する際、毎回「投稿一覧」に戻るのは面倒だ、そんなことを感じて作ったのがこのプラグインです。また1.2.0では投稿内容（本文、カテゴリーや投稿タグ、カスタムフィールド）を複製するリンクを投稿一覧ページと投稿編集ページに追加、1.3.0では投稿タイトルのみの検索をサポートしました。

WP_List_Tableクラスの「一括操作」フォームを使ってみた（2018年5月27日 更新）

今回は「WP_List_Tableクラスを使ってみた」の続き。投稿一覧やプラグインページなどにある「一括操作」（Bulkアクション）フォーム対応に関するメモである。

get_postsとquery_postsを使い分け（2018年5月27日 更新）

get_postsと query_postsは、どちらも複数の投稿情報を取得することができる便利な関数である。パラメータとして指定できる内容も共通しているものが多く、query_postsがより詳細なパラメータを指定でき、高機能になっている。

投稿ページでユニークなテンプレートを選択しよう（2018年5月27日 更新）

4.7の変更点に「投稿タイプテンプレート」がある。これは従来固定ページ（'page'）向けに任意のテンプレートを適用できる機能が拡張されたもので、投稿ページ（'post'）はもちろんカスタム投稿タイプのページにも適用可能になっている。

WordPressの鼓動（2013年10月1日 更新）

WordPressでは、Ajaxを利用する方法の1つとして add_action関数を利用することができる。この方法を調べている過程で、'heartbeat'というおもしろそうなAjaxアクションがあったので、紹介しておく。