2023年12月05日

3.ヘッダ/フッタ/サイドバで使われる関数

ここではヘッダ/フッタ/サイドバーで良く使われるWordPress関数を解説しています。

1.ヘッダ部で利用される関数

ヘッダで良く使われる関数には下記の様な物があります。

関数	説明
language_attributes()	HTMLの<html>タグに設定されている言語属性を表示します。日本語の場合は lang='ja' が出力されます。
body_class()	HTMLの<body>タグにページ毎に異なるクラスを自動設定（複数）する関数です。ページ毎にCSSで体裁を変更したい時に利用します。
bloginfo()	サイトの[管理画面の設定]等で設定されている情報を呼び出して、表示する関数です。使用言語、サイトタイトル、キャッチフレーズ等を表示するのに利用します。
date_i18n()	現在時刻を取得します。 PHP関数のdate()と異なり、WordPressのタイムゾーン時刻が取得できます。

メニュで良く使われる関数には下記の様な物があります。

関数	説明
wp_nav_menu()	ロケーション名を指定してナビゲーションメニューを表示する関数です。
has_nav_menu()	ロケーション名にメニュが設定されているかを確認する関数です。

■メニュを設計する時はregister_nav_menu()を参照して下さい。

サイドバーで良く使われる関数には下記の様な物があります。

関数	説明
dynamic_sidebar()	サイドバーを呼び出す関数です。

■サイドバーを設計する時は widgets_initアクションフックを参照して下さい。

URLを取得する関数には下記の様な物があります。

関数	説明
home_url()	サイトのURLを取得します。このサイトの場合は下記になります。 https://school.t-spirits.com
get_home_url() get_site_url()	投稿IDを指定してサイトのURLを取得する関数です。（あまり意味がない）お勧めは home_url() です。
get_stylesheet_uri()	現在のテーマで使われているスタイルシートのURLを取得します。このサイトの場合は下記になります。 https://school.t-spirits.com/wp-content/themes/my_template/style.css
get_stylesheet_directory_uri()	現在のテーマのスタイルシートがあるディレクトリのURLを取得します。このサイトの場合は下記になります。 https://school.t-spirits.com/wp-content/themes/my_template
get_template_directory_uri()	親テーマのスタイルシートがあるディレクトリのURLを取得します。このサイトは子テーマではないのでget_stylesheet_directory_uri()と同じになります。 https://school.t-spirits.com/wp-content/themes/my_template

■一般テンプレートの中で使われるURL関連関数は URL関連関数を参照してください

■URLとURI

URL：インターネットからアクセスされるアドレス

URI：URLとURN（インターネット上の識別番号）の総称

ヘッダ/フッタ/サイドバは、他のテンプレートから呼ばれるテンプレートです。

その時、どのテンプレートから呼ばれたのかを判断する関数が下記です。

判定関数	説明
is_home()	ホームページか否かを判断します。確実にホームページか否かを判断する為には下記を指定します。 if(is_home() \|\| is_front_page()){ホームページ処理} 否定は下記になります。 if(!i(s_home() \|\| is_front_page())){ホームページ以外の処理}
is_front_page()
is_single()	投稿ページか否かを判断します。投稿ページの場合はtrue、それ以外はfalseを返します。
is_page()	固定ページか否かを判断します。固定ページの場合はtrue、それ以外はfalseを返します。
is_category()	カテゴリページか否かを判断します。カテゴリページの場合はtrue、それ以外はfalseを返します。
is_search()	検索ページか否かを判断します。検索ページの場合はtrue、それ以外はfalseを返します。
is_date()	アーカイブページか否かを判断します。アーカイブページの場合は true それ以外は false を返します。
is_main_query()	メインクエリー(投稿、固定ページ等)か否かを判断します。メインクエリーの場合は true それ以外は false を返します。
is_admin()	ダッシュボードまたは管理画面か否かを判断します。ダッシュボードまたは管理画面の場合は true それ以外は false を返します。

■ページを判断する関数は上記以外にもありますが、ここでは説明を割愛します。

WordPressでは[外観→カスタマイズ]でヘッダに画像等を定義する事ができます。

何を使える様にするか？はadd_theme_support()関数で定義します。

区分	判定関数	説明
画像	has_header_image()	ヘッダー画像が設定されているかを確認します。
	get_uploaded_header_images()	ヘッダー画像情報を連想配列で取り出します。スライドさせる場合は、この関数を使います。
	header_image()	ヘッダー画像のURLを取得します。画像を1枚だけ表示する場合は、この関数を使います。
動画	has_header_video()	[外観→カスタマイズ]の[ヘッダメディア]の中に動画が設定されているかを確認します。
動画	the_custom_header_markup()	[外観→カスタマイズ]の[ヘッダメディア]の中の動画を表示します。
ロゴ	has_custom_logo()	[外観→カスタマイズ]の[ロゴ画像]にデータが設定されているかを確認します。
ロゴ	the_custom_logo()	[外観→カスタマイズ]の[ロゴ画像]に設定してあるロゴを表示します