説明
string get_custom_logo( [ int $blog_id = 0 ] )
カスタムロゴのHTMLを取得する。
パラメータ
- $blog_idブログIDを指定（省略時は0）。
返り値
カスタムロゴのHTMLを返す。注意
カスタムロゴのメディアIDは get_theme_mod（パラメータ'custom_logo'）関数で取得でき、さらに wp_get_attachment_image関数で使ってカスタムロゴのimg要素を取得する。カスタムロゴが設定されている場合は次のようなHTMLとなる。
<a href="ホームURL" class="custom-logo-link" rel="home" itemprop="url">カスタムロゴimg要素</a>マルチサイトに対応しており、現在のブログ以外の場合はそのブログIDをパラメータに指定する。
[5.5.1]5.5.0で追加された'get_custom_logo_image_attributes'フィルターのパラメータ$custom_logo_attrの既定値が次のように変更され、デフォルトで遅延読み込み（lazy-loading）しないようになった。
$custom_logo_attr = array(
'class' => 'custom-logo',
'loading' => false, // [5.5.1]追加
);
使用例
- 現在のブログに設定されているカスタムロゴのHTMLを取得する。
<?php $html = get_custom_logo(); ?> - プログIDが2のブログに設定されているカスタムロゴのHTMLを取得する。
<?php $html = get_custom_logo( 2 ); ?>
フィルター
[5.5.0]wp_get_attachment_image関数を呼ぶ前に'get_custom_logo_image_attributes'フィルターを呼び出す。パラメータ$custom_logo_attrには（wp_get_attachment_image関数のパラメータとなる）連想配列が、$custom_logo_idにはカスタムロゴの添付IDが、$blog_idには本関数が受け取った内容が格納されている。$custom_logo_attr = apply_filters( 'get_custom_logo_image_attributes', $custom_logo_attr, $custom_logo_id, $blog_id );return apply_filters( 'get_custom_logo', $html, $blog_id );アクション
実行するアクションはありません。ソースファイル
/wp-includes/general-template.php最終更新 : 2020年09月02日 13:40
関連
お勧め
ブロックエディターの文字サイズ設定を変えてみる（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）を拡張してより便利に活用する」の続編。メディアで「投稿タグ」を追加するだけで「メディアライブラリ」ページの投稿一覧の中には「タグ」カラムが追加されるが、今回はその「投稿タグ」で絞り込み検索に対応してみる。