ワードプレスのget_site_icon_url関数の使用方法・解説

概要

get_site_icon_url関数は、WordPressサイトのアイコン（サイトアイコン）URLを取得するための関数です。サイトアイコンは、ブラウザのタブやブックマーク、アプリケーションバージョンのアイコンとして使用されます。サイトアイコンのURLを取得することは、テーマやプラグインで多様な機能を実装する時に便利です。具体的には、以下のような機能を実装する際に使用されることがあります。

1. サイトのカスタムデザイン
2. ブラウザのタブアイコン設定
3. ソーシャルメディアでのシェア時のアイコン表示
4. モバイルアプリ用アイコンの設定
5. フaviconの動的表示
6. プラグイン設定ページでのアイコン表示
7. ユーザー用ダッシュボードでのサイト情報表示
8. アナリティクス用のトラッキングアイコン設定

構文

get_site_icon_url( $size = null );

パラメータ

• $size (int|null): オプションのパラメータで、リクエストするアイコンのサイズを指定します。指定しない場合は、デフォルトサイズで取得されます。

戻り値

• (string): サイトアイコンのURL。アイコンが設定されていない場合は空の文字列を返します。

関連する関数

• get_theme_support
• get_option

使用可能なバージョン

• この関数は、WordPress 4.3.0以降で使用可能です。

コアファイルのパス

• wp-includes/general-template.php

この関数のアクションでの使用可能性

アクション名	使用例
mu_plugin_loaded
registered_post_type
plugins_loaded	〇
wp_roles_init
setup_theme
after_setup_theme	〇
set_current_user
init
register_sidebar
wp_loaded	〇
send_headers
parse_query
pre_get_posts
wp
template_redirect	〇
get_header
wp_head	〇

サンプルコード

サンプル1: サイトアイコンの取得

$site_icon_url = get_site_icon_url();
echo '<link rel="icon" href="' . esc_url( $site_icon_url ) . '" />';

このコードは、サイトアイコンのURLを取得し、そのURLを用いてHTMLの<link>要素を生成します。

サンプル2: サイトアイコンの指定サイズを取得

$site_icon_url = get_site_icon_url( 512 );
echo '<link rel="icon" sizes="512x512" href="' . esc_url( $site_icon_url ) . '" />';

このコードは、指定したサイズ（512×512）でサイトアイコンのURLを取得し、HTMLにサイズ指定を追加しています。

サンプル3: アイコンが存在しない場合の処理

$site_icon_url = get_site_icon_url();
if ( empty( $site_icon_url ) ) {
    echo 'アイコンが設定されていません。';
} else {
    echo '<link rel="icon" href="' . esc_url( $site_icon_url ) . '" />';
}

このコードは、サイトアイコンが設定されていない場合にメッセージを表示します。

サンプル4: サイトアイコンをCSSに利用する

$site_icon_url = get_site_icon_url();
if ( ! empty( $site_icon_url ) ) {
    echo '<style>.site-icon { background-image: url(' . esc_url( $site_icon_url ) . '); }</style>';
}

このコードは、CSSでサイトアイコンを背景画像として利用する例です。

サンプル5: テーマにカスタムスタイルを追加

function enqueue_site_icon_styles() {
    $site_icon_url = get_site_icon_url();
    if ( $site_icon_url ) {
        wp_add_inline_style( 'theme-style', '.site-icon { background-image: url(' . esc_url( $site_icon_url ) . '); }' );
    }
}
add_action( 'wp_enqueue_scripts', 'enqueue_site_icon_styles' );

このコードは、WordPressのスタイルシートにカスタムスタイルを追加して、サイトアイコンを使用する例です。