概要
wp_site_icon関数は、WordPressサイトのサイトアイコン（ファビコン）を表示するための関数です。この関数は、ブログやウェブサイトに特定のアイコンを設定する際によく使用されます。以下は、主な利用ケースの例です。
- ブラウザタブに表示されるアイコンを設定する。
- スマートフォンやタブレットのホーム画面に表示するアイコンを設定する。
- iOSやAndroidデバイス用のアプリケーションアイコンを指定する。
- ビジュアルブラウザのブックマークフィールドで使用されるアイコンを設定する。
- ソーシャルメディアプラットフォームでのシェア時に表示されるアイコンを設定する。
- さまざまなテーマやプラグインでのカスタムアイコンに使用される。
- サイトのブランドとして特定のロゴやマークを使用する。
- サイトの識別を助けるための視覚的な要素として機能する。
構文
wp_site_icon();
パラメータ
この関数は、パラメータを持たず、引数として何も受け取ることはありません。
戻り値
この関数は、サイトアイコンを出力します。具体的には、HTMLの<link rel="icon">タグを生成し、サイトアイコンを表示する役割を果たします。
関連する関数
ワードプレスのバージョン
wp_site_icon関数はWordPress 4.3.0以降で使用可能です。
コアファイルのパス
wp-includes/general-template.php
サンプルコード
サンプルコード1: サイトアイコンの表示
if ( function_exists( 'wp_site_icon' ) ) {
wp_site_icon();
}
このコードは、wp_site_icon関数が存在する場合にサイトアイコンを表示します。アイコンが設定されていれば、ブラウザタブやデバイスのホーム画面に表示されます。
サンプルコード2: サイトアイコンのURLを取得
$icon_url = get_site_icon_url();
if ( $icon_url ) {
echo '<img src="' . esc_url( $icon_url ) . '" alt="Site Icon">';
}
このコードは、get_site_icon_url関数を使用してサイトアイコンのURLを取得し、そのアイコンを画像として表示します。
サンプルコード3: サイトアイコンが設定されているかチェック
if ( has_site_icon() ) {
echo 'サイトアイコンが設定されています。';
} else {
echo 'サイトアイコンが設定されていません。';
}
このコードは、has_site_icon関数を使用して、サイトアイコンが設定されているかどうかを確認し、メッセージを表示します。
サンプルコード4: サイトアイコンを設定する
if ( isset( $_POST['icon_upload'] ) ) {
set_site_icon( $_POST['icon_url'] );
}
このコードは、フォームから送信されたURLを使ってサイトアイコンを設定します。set_site_icon関数を用いてアイコンを変更します。
サンプルコード5: サイトアイコンのスタイルを変更
add_action( 'wp_head', function() {
echo '<style>
link[rel="icon"] {
width: 32px;
height: 32px;
}
</style>';
});
このコードは、wp_headアクションを使用して、サイトアイコンのサイズを変更するCSSスタイルを出力します。
この関数のアクションでの使用可能性
| アクション | 使用例 |
|---|---|
| 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 | 〇 |
非推奨または削除されたバージョン
wp_site_icon関数は、特定のワードプレスバージョンで非推奨または削除されていません。