get_custom_logo() の使い方|説明・引数・注意点

説明

get_custom_logo() は、カスタムロゴのHTML(リンク付き画像)を返す関数です。

基本構文

get_custom_logo( int $blog_id = 0 ): string

引数

  • $blog_id:サイトID

戻り値

HTMLの文字列。

使い方(サンプル)

echo get_custom_logo();

注意点

  • ロゴが未設定の場合は、空文字です。

実務での使いどころ

  • ロゴのHTML(リンク付きの画像)を、文字列として、受け取って、加工するとき。

よくあるミスと対処

  • 出力ではなく、値を返す。echo し忘れる。
  • ロゴが未設定のとき、空文字が返る。確認せずに、枠を出力する。
  • 画像のURLだけが、欲しいのに、これを使っている。URLは、get_theme_mod( 'custom_logo' ) でIDを取得し、wp_get_attachment_image_url() などで、取得する。

NG例

get_custom_logo(); // 返すだけで、出力されない

OK例

$logo = get_custom_logo();
if ( $logo ) {
	echo $logo;
}

使い分け早見表

関数 役割
get_custom_logo() ロゴのHTMLを、文字列で取得する
the_custom_logo() ロゴを、出力する
has_custom_logo() ロゴが、設定されているかを確認する

関連項目

the_custom_logo()、has_custom_logo()

公式リファレンス:get_custom_logo() | Function | WordPress Developer Resources

コメント

タイトルとURLをコピーしました