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



お勧め

Contact Form 7に確認フェーズを(2012年12月16日 更新)

Contact Form 7はWordPressによるサイト製作でお世話になることが多いプラグインの1つ。ただ、クライアント様によっては、入力、確認、送信の3フェーズにしたいという要望があり、そんな時は別の方法を採用していたのですが、JavaScript(jQuery)を使ってページ遷移しなくてもいいなら確認フェーズは用意できるかなと思い、作り込んでみた。

投稿一覧に独自リンクを追加する(2013年10月16日 更新)

管理者ページの「投稿一覧」や「固定ページ一覧」の各投稿記事はマウスポインタを移動すると、「編集」や「クイック編集」といったリンクが表示される。このリンクに独自のリンクを追加する方法を調べてみた。

HTML編集モードに定型文ボタンを追加する(2011年6月1日 更新)

投稿編集ページにはビジュアル編集モードとHTML編集モードがあり、それらを拡張するプラグインも多数存在している。そういったプラグインを利用するのもいいのだが、仕組みを理解するのも悪くないはず。というわけで、ここではHTML編集モードのボタンの仕組みと定型文を挿入するボタンを追加する方法を紹介する。

投稿日の検索が自由自在に(2015年3月7日 更新)

WordPress 3.7.0ではWP_Date_Queryクラスが追加され、WP_Queryクラス(もちろん query_posts関数でも)で利用できるようになった。このWP_Date_Queryにより、○年○月○日以前や以降の投稿情報を取得したり、○年○月○日から○年○月○日の範囲の投稿情報を取得したりといったことが、容易に行えるようになった。

プラグインのヘッダー情報を国際化対応しよう(2018年5月27日 更新)

バージョン4.8がリリースされてひと段落。あらためてプラグイン一覧ページを見てみると「Akismet」が「Akismet Anti-Spam (アンチスパム)」と表示されていた。説明文だけじゃなくプラグイン名も国際化対応できたのね。