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

お勧め

カスタムフィールド関連関数のおさらい（2012年6月22日 更新）

カスタムフィールドは、投稿記事の拡張情報としてよく利用されている。投稿ページで登録した情報をアーカイブや投稿ページで表示しているが、投稿ページを表示する際にカスタムフィールドの値を更新して、サイドバーのようなページ内要素に利用したりしている。

MOファイルを作ってみた（2018年7月25日 更新）

テーマやプラグインで使用するMOファイルはWindows環境では「Poedit」アプリを使うことが多かったが、最近では「GlotPress」のようなプラグインも増えてきており、選択肢は広がっている。定期的に開発環境を見直す過程で「Poedit」から「GlotPress」に切り替えようと思ったのだが、微妙にしっくりこなかった。

日本語名のユーザーを登録する（2018年5月27日 更新）

標準のログインID（ユーザー名）は、英数字と一部の記号の組み合わせで構成されている。一般的なシステムのログインIDはおおむねこんな感じだが、ふと「インターネット環境ならログインIDに日本語が使用できてもいいんじゃないか」と思い、実現できるか調べてみた。

ショートコードを使ってテーマ内の画像URLを簡単に指定する（2018年5月27日 更新）

投稿記事の中で画像パーツを使いたいときがある。画像パーツの配置場所は、/imgディレクトリのようなテーマ外の場合と、/wp-content/themes/mytheme/imagesディレクトリのようなテーマ内の場合があり、今回は後者のケース。ショートコードを使って投稿記事の画像ファイルのURLを記述する方法を紹介したい。

HTML entities button：プラグイン作ってみました（2017年12月17日 更新）

以前投稿した「HTML編集モードに定型文ボタンを追加する」をアレンジして、HTML編集モードに特殊文字（HTMLエンティティ）を挿入できるボタン、顔文字を挿入できるボタン、過去の投稿ページのリンクを挿入できるボタンを追加するプラグインを作ってみました。HTML編集モードの作業効率を向上させるプラグインです。2.1.0では「Dashiconsの挿入」を追加しました。HTML編集モードをメインに使用されている方は、お試しあれ。