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



お勧め

5.3の新機能:クエリーログに任意の項目を追加できる新フィルター(2019年10月23日 更新)

5.3 RC2」が公開され、正式リリースまであと20日。公式ディレクトリにプラグインを公開していることもあり、5.3に関する開発者向けの情報「Miscellaneous Developer Focused Changes in 5.3」を読んでいる。

ログインページのタイトルを変更してみる(2018年5月27日 更新)

バージョン4.9では新しいフィルターやフィルターのパラメータの追加が多数行われている。ここではその一例としてログインページ関連で追加された2つのフィルターを紹介する。

プラグインで注意が必要な関数(2013年11月27日 更新)

先日「Login rebuilder」という自作プラグインをアップデートした際、ユーザーさんからエラーになると連絡をいただいた。標準環境では問題なく、どうやら何らかのプラグインが影響しているらしい。

ブロックエディターの色設定を変えてみる(2019年12月11日 更新)

バージョン5.3で機能強化されたブロックエディター。対応を考えて新テーマ「Twenty Twenty」のソースコードを眺めていく。

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

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