Menu

WordPress カスタマイズで登録したサイトアイコン（ファビコン）の取得方法

2022年11月23日

WordPress のメニュー > カスタマイズ > サイト基本情報 > サイトアイコン より、サイトのアイコン（ファビコン）を登録する事ができます。

登録したサイトアイコンをテーマ内 PHP にて呼び出すには、get_site_icon_url() 関数を使用することでサイトアイコンを取得することが可能です。

get_site_icon_url() 関数

get_site_icon_url() 関数には3つの引数があります。引数はすべて省略可能です。

第１引数は int型（半角数字）でサイトアイコンのサイズを指定します。第１引数を省略した場合は 512 pxのサイズで呼び出しされます。

第２引数は String 型（文字列）でサイトアイコンが登録されていない場合に指定したい画像URLを指定します。第２引数を省略した場合は ”（空文字）が指定されます。

第３引数は int型（半角数字）でマルチサイトを運営している場合にサイトIDを指定します。第３引数を省略した場合は現在表示されているブログのIDが指定されます。

ソースコード

// 第１引数にサイズ 120 を指定して呼び出し
$site_icon_url = get_site_icon_url( 120 );

// 第１引数にサイズ 120 を指定して呼び出し
// 第２引数にサイトアイコンがない場合の画像を指定
$site_icon_url = get_site_icon_url( 120, '/img_6295.jpg' );

// 第１引数にサイズ 120 を指定して呼び出し
// 第２引数にサイトアイコンがない場合の画像を指定
// 第３引数にブログID 10 を指定（マルチサイト運営中の場合）
$site_icon_url = get_site_icon_url( 120, '/img_6295.jpg', 10 );

WordPressのテーマファイル内で上記のようなソースコードを記載した場合、サイトアイコンの登録状況により、変数 $site_icon_url にサイトアイコンまたは事前に指定した画像を呼び出す事が可能です。

参考
get_site_icon_url() | Function | WordPress Developer Resources

広告