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



お勧め

5.3の新機能:クエリーログに任意の項目を追加できる新フィルター(2019年10月23日 更新)

5.3 RC2」が公開され、正式リリースまであと20日。公式ディレクトリにプラグインを公開していることもあり、5.3に関する開発者向けの情報「Miscellaneous Developer Focused Changes in 5.3」を読んでいる。

Login rebuilder 2.7.4の変更内容を紹介(2022年7月6日 更新)

Login rebuilder 2.7.4では、ダッシュボードの「ログインのログ」ウィジェット内に現在のユーザー(管理者のみ)のログイン状況を簡潔なメッセージで表示するようにした。

ショートコードを含んだページを表示する前に何か処理する(2014年5月28日 更新)

固定ページまたは投稿ページに独自のフォームを埋め込む。入力→登録の2段階のフォームなら著名なプラグイン「Contact Form 7」を利用すればいいのだが、クライアントの依頼は入力→確認→登録の3段階で組み込む要素が特化していたので、独自の実装方法を考えることになった。

プラグインの設定ページもレスポンシブ対応(2014年6月3日 更新)

レスポンシブ対応したWordPressの管理画面。プラグインやテーマのカスタマイズで管理画面を拡張しているなら、切り替わるタイミングはきっちり押さえておきたいところではないだろうか。

oEmbed対応サイトを整理した(2023年8月9日 更新)

投稿記事にTwitterやYouTubeのURL(アドレス)を記述したとき、表示されるページにはリンクとしてではなく、埋め込んだURLの内容が表示される。この仕組み(機能)はoEmbedというもので、対応サイトは随時バージョンアップしている。