get_custom_logo

説明

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 );
[4.5.0]カスタムロゴのHTMLを返す前に'get_custom_logo'フィルターを呼び出す。パラメータ$htmlはカスタムロゴのHTMLが格納されている。[4.6.0]パラメータ$blog_idが追加され、本関数が受け取った内容が格納されている。
return apply_filters( 'get_custom_logo', $html, $blog_id );

アクション

実行するアクションはありません。

ソースファイル

/wp-includes/general-template.php

最終更新 : 2020年09月02日 13:40



お勧め

6.2に追加されるsearch_columnsパラメータが便利(2023年3月30日 更新)

バージョン6.2では記事検索機能を備えたWP_Queryクラスにsearch_columnsパラメータが追加される。標準のキーワード検索では、タイトル(post_title)、本文(post_content)、抜粋(post_excerpt)が対象になっているが、search_columnsパラメータを使うと対象を絞り込めるようになる。

固定ページのURLの拡張子をhtmlに変更する(2013年3月9日 更新)

固定ページについて、URLを静的ページっぽく拡張子htmlに変更したいという要望を受けることがある。これまでは「.html on PAGES」というプラグインを使っていて特に不満があったわけではないのだが、今回ひょんなことから簡単に対応できることがわかったので、メモ書きしておく。

KUSANAGIでマルチサイト(サブドメイン)を試した(2019年8月6日 更新)

本サイトはサブディレクトリタイプのマルチサイト機能を採用して構築しているが、これまでサブドメインタイプは利用した経験はない。マルチサイト機能のサブドメインタイプは以前から1度は試してみたいと思っており、今回実際にサイトを構築してみた。

Fotepo:プラグイン作ってみました(2019年9月19日 更新)

仕事柄、Chromeの「デベロッパーツール」を使ってページのフォントを変更することがある。そんな時、無効なフォント名を指定してしまったり、フォント名をまちがえることがあり、もう少しお手軽にできないかと思って作ったのが今回紹介するプラグイン「Fotepo」である。

カテゴリー専用の投稿一覧と新規投稿メニューを追加する(2012年1月23日 更新)

サイト更新の1クリックを省くため、特定カテゴリーの投稿に対して同じようにメニューを追加してみた。カスタム投稿タイプの専用投稿メニューみたいな感じである。