get_site_icon_url

説明

string get_site_icon_url( [ int $size = 512 [ , string $url = '' [ , int $blog_id = 0 ] ] ] )
サイトアイコンのURLを取得する。

パラメータ

  • $size
    サイズ(ピクセル数)を指定(省略時は512)。
  • $url
    サイトアイコンが未設定時のURLを指定(省略時は'')。
  • $blog_id
    マルチサイト時のブログIDを指定(省略時は0)。

返り値

サイトアイコンが設定されている場合はそのURLを、設定されていない場合はパラメータ$urlの値を返す。

注意

パラメータ$sizeが512以上の場合、サイトアイコンのサイズは設定時の最大サイズとなる。

パラメータ$blog_idは、通常のシングルサイトやマルチサイト時のメインサイトに設定されたサイトアイコンの場合は不要である。


使用例

  • 最大サイズのサイトアイコンのURLを取得する。
    <?php $url = get_site_icon_url(); ?>
  • ブログIDが2のサイトに設定された32×32ピクセルのサイトアイコンを取得する。
    <?php $url = get_site_icon_url( 32, '', 2 ); ?>

フィルター

[4.4.0]URLを返す直前に'get_site_icon_url'フィルターを呼び出す。パラメータ$urlにはサイトアイコンのURLが、$size$blog_idには本関数が受け取った内容が格納される。
return apply_filters( 'get_site_icon_url', $url, $size, $blog_id );

アクション

実行するアクションはありません。

ソースファイル

/wp-includes/general-template.php

最終更新 : 2020年04月02日 11:21



お勧め

子カテゴリのアーカイブページを親カテゴリ用のテンプレートファイルで表示しよう(2011年12月8日 更新)

少し前に投稿した「適切なテンプレートファイルを用意してテンプレート内の振り分け処理を無くす」で説明した通り、特定のカテゴリ専用のテンプレートとしてcategory-○○.phpを用意することで、category.phpやarchive.php内で振り分けを行う必要がなくなる。ただ、すべてのカテゴリ分を用意するのは効率的ではないし、特に子カテゴリについては親カテゴリと共通内容になるケースが多いのではないだろうか。ここでは、子カテゴリの個別テンプレートファイルを作らず、親カテゴリのテンプレートを利用する方法を紹介する。

管理画面の'アイキャッチ画像'を'写真'に変える(2013年1月23日 更新)

クライアント向けに専用のテーマを提供する際、稀に管理画面内の用語の変更を依頼されることがある。今回は、'アイキャッチ画像'だとわかりにくいので'写真'に変えてほしいということだった。

5.7の機能拡張:投稿一覧画面向けのフィルター(2021年2月18日 更新)

昨日、予定通り公開された「WordPress 5.7 Beta 3(以降Beta 3)」。WordPressはバージョンアップ毎にアクションやフィルターが追加されており、今回のバージョンアップでは投稿一覧画面に影響を与えるフィルターが追加されていた。

Login rebuilder 2.6.0の新機能紹介(2019年4月22日 更新)

今回追加したものは、REST API / Usersの使用をログイン時のみ使用できるように制限する機能である。この機能を有効にすることで、管理者情報が漏洩するリスクを低減させる効果が期待できる。

タイトルのみをキーワード検索する(2014年4月3日 更新)

WordPressのキーワード検索は、投稿タイトルと本文のどちらかに指定したキーワードが含まれているかを調べるわけだが、時々タイトルだけとか、逆に本文だけ検索したいケースがある。