2024年06月14日

WP関数:get_home_url()


この関数の説明

WP関数の get_home_url()は、投稿IDを指定してサイトのURLを取得する事ができる関数です。

home_url() の方が使い勝手が良いと思います。

 


関数

get_home_url  ( $blog_id, $path, $scheme )

 


パラメータ

$blog_id(整数)(オプション

投稿IDを指定します。指定がない場合は現在のID

 

$path(文字列) (オプション)

サイト URL の 相対パスを指定します。初期値は「なし」

 

$scheme(整数) (オプション)

ホームURLの形式を指定できます。

'http'    : プロトコルをhttpにしてURLを取得します

 'https'   : プロトコルをhttpsにしてURLを取得します

 'relative': ドメイン名以降のパスを取得します 

初期値: null

 


返り値

ホームのURLが返されます。

 


事例

①ホームURLを表示する

<?php  echo esc_url(get_home_url());?>

■ホームURLをエスケープ処理をして表示します。

■このサイトの場合は下記が取得されます。

https://school.t-spirits.com

 

②メディアの画像を表示する

<img width=200 src='<?php echo esc_url(get_home_url().'/wp-content/uploads/2021/06/mirai.png');?>'>

■メディア画像はget_site_url()の下の[wp-content→uploads]の中に年月単位で分類されて管理されています。

home_url() の場合は、引数で任意のパスを追加する事ができるので下記になります。

<img width=200 src='<?php echo esc_url(home_url('/wp-content/uploads/2021/06/mirai.png'));?>'>

 

③ホームへのリンクを表示する

<?php 
   $icon_home = '<i class="fas fa-home"></i>' ; // Font Awesomeのホームアイコンの設定
   $home_url   =  esc_url(get_home_url());   // ホームURLを取得してエスケープ処理(無害化)します
?>
<a href='<?php echo $home_url; ?>'><?php echo $icon_home; ?>HOME</a>&nbsp;/&nbsp;<!-- ホームリンクの表示-->

■上記は下図の様なアイコン文字と合わせてホームリンクを表示するプログラムです。

 


関連情報

関連関数は URL関連関数 を参照してください。

 


関数一覧
  • 1.WPのエスケープ処理
  • 2.WPプログラムの基本
  • 3.ヘッダ/フッタ/サイドバで使われる関数
  • 4.DBからの読込関数
  • 5.一般テンプレートの中で使われる関数
  • 6.その他のWP関数
  • add_shortcode()
  • bloginfo()
  • body_class()
  • dynamic_sidebar()
  • edit_post_link()
  • esc_attr()
  • esc_html_e()
  • esc_html()
  • esc_url()
  • get_ancestors()
  • get_cat_ID()
  • get_cat_name()
  • get_category_link()
  • get_category_parents()
  • get_category()
  • get_footer()
  • get_header()
  • get_home_url()
  • get_post_format()
  • get_post_meta()
  • get_post_thumbnail_id()
  • get_query_var()
  • get_search_query()
  • get_sidebar()
  • get_site_url()
  • get_stylesheet_directory_uri()
  • get_stylesheet_uri()
  • get_template_directory_uri()
  • get_template_part()
  • get_the_category()
  • get_the_content()
  • get_the_date()
  • get_the_excerpt()
  • get_the_ID()
  • get_the_modified_date()
  • get_the_modified_time()
  • get_the_permalink()
  • get_the_post_thumbnail()
  • get_the_tags()
  • get_the_time()
  • get_the_title()
  • get_uploaded_header_images()
  • get_year_link()
  • has_category()
  • has_custom_logo()
  • has_header_image()
  • has_header_video()
  • has_nav_menu()
  • has_post_thumbnail()
  • has_tag()
  • header_image()
  • home_url()
  • is_admin()
  • is_category()
  • is_date()
  • is_front_page()
  • is_home()
  • is_main_query()
  • is_page()
  • is_search()
  • is_single()
  • language_attributes()
  • the_category()
  • the_content()
  • the_custom_header_markup()
  • the_custom_logo()
  • the_date()
  • the_excerpt()
  • the_ID()
  • the_modified_date()
  • the_modified_time()
  • the_permalink()
  • the_post_thumbnail()
  • the_search_query()
  • the_tags()
  • the_time()
  • the_title()
  • update_post_meta()
  • wp_date()
  • wp_get_attachment_image_src()
  • wp_nav_menu()
  • WP_Query()