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



お勧め

個人データのエクスポートメール向けに追加された新フィルター(2020年4月2日 更新)

先週「WordPress 5.4 RC3」が公開され、正式リリースまであと1週間。ブロックエディターの機能強化が目立つわけですが、地味な変更点もちらほらと。今回はその中の1つ、「個人データのエクスポート」機能に関連するフィルターを紹介する。

決まった値を返すだけの関数群(2018年5月27日 更新)

WordPressのソースコードを眺めているとフィルター関数名で'__return_○○'が指定されている部分を時々見かけます。それらの関数定義を見てみると、すべて決まった値を単純に返すだけでした。これらの関数がちょっと気になったので、まとめてみました。

サイドバーの初期化はwidgets_initアクションで(2011年7月14日 更新)

ウィジェットを使ってみたくなり新テーマ「Twenty Eleven」を覗いてみると、codexに記載されていた内容と少し違っている。これって「Twenty Ten」ですでに変更されていたんだね。

Gutenbergでカスタムフィールドを使う(2018年8月10日 更新)

Gutenbergの新エディターではカスタムフィールドのウィジェットが表示されない。既存のカスタムフィールドのデータはなくなるわけでないので、新エディター上で編集・更新できないか調べてみた。

favicon.icoがWordPressロゴになる!?(2020年2月25日 更新)

先週「WordPress 5.4 Beta2」が公開され、来月末には正式リリース。タイミングよく三連休だったので、1つ前の「ニュース」で紹介されていた変更点から確認してみた。