説明
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
関連
お勧め
ブロックエディターをちょっとだけカスタマイズしてみる（2021年11月3日 更新）
ブロックエディターで投稿を編集していると「ここは〇〇だったらいいのにな」と思うところがある。今回は、そんな気になるところをいくつか（自分好みに）調整してみた。
初期化に関連するアクションのおさらい（2013年11月27日 更新）
いつも何気なくfunctions.phpで使っているafter_setup_themeアクションやinitアクション。普段はあまり意識していなかったが、ふとしたことからどんな順番に呼び出されるのか気になってしまい、ちょっと調べてみた。プラグインのロード順を制御する（2014年6月9日 更新）
これまでプラグインがどのような順番でロードされるか意識していなかったのだが、とある自作プラグインを他のプラグインよりも先にロードさせたくなったので調べてみた。
3.2標準テーマ「Twenty Eleven」は投稿フォーマットに着目（2011年7月6日 更新）
新テーマ「Twenty Eleven」のトップページでは、投稿フォーマットに応じて表示を切り替える仕組みが提案されている。ここでは、その投稿フォームの活用方法を簡単に紹介する。プラグインのヘッダー情報を国際化対応しよう（2018年5月27日 更新）
バージョン4.8がリリースされてひと段落。あらためてプラグイン一覧ページを見てみると「Akismet」が「Akismet Anti-Spam (アンチスパム)」と表示されていた。説明文だけじゃなくプラグイン名も国際化対応できたのね。