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

最終更新 : 2018年05月27日 10:45



お勧め

query_posts(WP_Queryクラス)で投稿タグを絞り込む(2011年9月14日 更新)

投稿タグの絞り込みは、カテゴリーに似ているけど微妙に違っている。今日は、昨日投稿した「query_posts(WP_Queryクラス)でカテゴリーを絞り込む」の続きとして、投稿タグの絞り込みついてまとめてみる。

管理者ページに文言を表示する(2012年4月19日 更新)

お客様向けに管理者ページをカスタマイズする機会が増えてきている。カスタマイズするページや表示場所、表示内容によっていくつかの手段があるが、今回はページの冒頭部分に任意の文言を表示する方法を紹介する。

oEmbedについて考えてみた(2018年5月27日 更新)

本サイト向けにテーマをリニューアルしようと思い一から作っている最中、ふと生成されているHTMLの中にあるoEmbedの記述が目についた。「この記述いつからだっけ」くらいに思いながらリンク先を開き、ちょっとモヤモヤしてしまった。

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

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

WP_Postオブジェクトで投稿情報を直感的に使う(2012年10月4日 更新)

WordPress 3.5で登場するであろう WP_Postクラス。WordPressの投稿情報は、投稿情報本体のほか、カテゴリーや投稿タグ、カスタムフィールドなど、いくつかに分散して記録され、それぞれの情報を取得する際は、いくつかの関数をしていた。新しいWP_Postクラスにより、その習慣とおさらばできるかもしれない。