get_custom_logo

（4.5.0以降）
get_custom_logo - カスタムロゴのHTMLを取得する

説明

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

関連

参考

Code Reference: get_custom_logo

お勧め

Login rebuilder 2.3.0の新機能を紹介（2018年5月27日 更新）

プラグイン「Login rebuilder」はログイン時の履歴（ログ）や不正なログインページへのアクセス履歴を保存している。これらの履歴情報はダッシュボートで確認できるが、バージョン2.3.0においてそれぞれがダウンロードできるようになった。

古めのリビジョンを削除した時のメモ（2022年5月16日 更新）

大きく育ったデータベースを整理するため、古めのリビジョンとそれに紐づいたカスタムフィールドデータを削除。と思ったら「The total number of locks exceeds the lock table size」というエラーが発生して削除できなかった。

決まった値を返すだけの関数群（2018年5月27日 更新）

WordPressのソースコードを眺めているとフィルター関数名で'__return_○○'が指定されている部分を時々見かけます。それらの関数定義を見てみると、すべて決まった値を単純に返すだけでした。これらの関数がちょっと気になったので、まとめてみました。

「Align widgets horizontally」プラグインのフィルター使用例（2024年5月15日 更新）

ダッシュボードのウィジェットを横並びに変える「Align widgets horizontally」プラグインには緒設定を変更できるフィルターが用意されている。ここではフィルターの使い方と設定できる項目について紹介する。

WP_Postオブジェクトで投稿情報を直感的に使う（2012年10月4日 更新）

WordPress 3.5で登場するであろう WP_Postクラス。WordPressの投稿情報は、投稿情報本体のほか、カテゴリーや投稿タグ、カスタムフィールドなど、いくつかに分散して記録され、それぞれの情報を取得する際は、いくつかの関数をしていた。新しいWP_Postクラスにより、その習慣とおさらばできるかもしれない。