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



お勧め

HTML編集モードに定型文ボタンを追加する(2011年6月1日 更新)

投稿編集ページにはビジュアル編集モードとHTML編集モードがあり、それらを拡張するプラグインも多数存在している。そういったプラグインを利用するのもいいのだが、仕組みを理解するのも悪くないはず。というわけで、ここではHTML編集モードのボタンの仕組みと定型文を挿入するボタンを追加する方法を紹介する。

4.4では投稿ページも専用テンプレートが適用できる(2018年5月27日 更新)

従来、特定の固定ページには専用テンプレートを適用できるのですが、投稿ページに適用させるためにはアクションやフィルターを利用する必要がありました。4.4では特定の投稿ページに標準で専用テンプレートを適用できるようになりそうです。

3.2標準テーマ「Twenty Eleven」は投稿フォーマットに着目(2011年7月6日 更新)

新テーマ「Twenty Eleven」のトップページでは、投稿フォーマットに応じて表示を切り替える仕組みが提案されている。ここでは、その投稿フォームの活用方法を簡単に紹介する。

標準で使用できる数少ないショートコード[caption]とは(2018年5月27日 更新)

画像をアップロードして「投稿に追加」ボタンをクリックすると、投稿記事内にリンク付きのimgタグか、ショートコードのが挿入される。ここではそれらの書式を整理する。

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

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