2022年05月02日

5.一般テンプレートの中で使われる関数

ここではTOPページのテンプレート及び文書を表示するテンプレートの中で使われる関数を解説しています。

1.文書情報関連

10.その他

1.文書情報関連

投稿や固定ページの情報を取り出したり、表示する関数一覧です。

項目	表示関数	取得関数
タイトル	the_title()	get_the_title()
本文	the_content()	get_the_content()
抜粋	the_excerpt()	get_the_excerpt()
投稿日	the_date()	get_the_date()
投稿日の時刻	the_time()	get_the_time()
最終更新日	the_modified_date()	get_the_modified_date()
最終更新日の時刻	the_modified_time()	get_the_modified_time()
ID	the_ID()	get_the_ID()
スラッグ名	-	関数は無いので下記で取得します。 global $post;//関数の場合は指定 $post -> post_name;

■the関数はエスケープ処理をしてから表示されますが、get関数で取得した情報を表示する場合は、自分でエスケープ（無害化処理）処理を行う必要があります。

詳細はエスケープ処理を参照してください。

2.カテゴリ＆タグ関連

カテゴリ関連

①投稿のカテゴリ情報

投稿に設定されているカテゴリに関する関数です。

関数	説明
has_category()	現在の投稿にカテゴリが選択されているかをチェックします。
the_category()	現在の投稿に設定されているカテゴリをリンク付きで表示します。
get_the_category()	カテゴリ情報を取得します。カテゴリID、カテゴリ名、スラッグ名はこの関数で取得します。

②カテゴリテーブルからの情報取得

カテゴリテーブルから情報を取得する関数です。

関数	説明
get_cat_ID()	カテゴリー名から、カテゴリーIDを取得します。
get_cat_name()	カテゴリIDから、カテゴリ名を取得します。
get_category()	カテゴリIDから、カテゴリ情報の総てを取得します。

③カテゴリの先祖を辿る関数

カテゴリの先祖を辿る関数です。

関数

説明

get_category_parents()

自分を含めた先祖のカテゴリ名リストを取得する関数です

get_ancestors()

固定ページID又は投稿のカテゴリIDを指定して、先祖のID配列を取得します。

get_category_parents()より使い勝手が良いです。

タグ関連

①投稿のタグ情報

投稿に設定されているタグに関する関数です。

関数	説明
has_tag()	現在の投稿にタグが選択されているかをチェックします。
the_tags()	現在の投稿に設定されているタグをリンク付きで表示します。
get_the_tags()	タグ情報を取得します。タグID、タグ名、スラッグ名はこの関数で取得します。

3.URL関連

URLに関連する関数です。

関数	説明
the_permalink()	文書のURLを表示する関数です。
get_the_permalink()	文書のURLを取得する関数です。
get_category_link()	カテゴリIDからカテゴリのURLを取得する関数です。

4.アイキャッチ画像関連

アイキャッチ画像は、投稿や固定ページに設定する事ができます。

もしアイキャッチ画像の設定画面が表示されない場合はadd_theme_support()で機能をONにして下さい。

関数	解説
has_post_thumbnail()	投稿や固定ページにアイキャッチ画像(サムネイル)が設定されているかどうかをチェックする関数です。
the_post_thumbnail()	投稿に設定されているアイキャッチ画像を表示します。
get_the_post_thumbnail()	投稿に設定されているアイキャッチ画素を取得します。
get_post_thumbnail_id()	指定した投稿IDに設定されているアイキャッチ画像のIDを取得します。
wp_get_attachment_image_src()	アイキャッチ画像のIDからメディアの画像情報を取得します。

5.投稿フォーマット関連

投稿フォーマットは、投稿ページの中に投稿ページの種類を指定させることにより、投稿のタイプ毎に表示プログラムを変更する時に利用する機能です。

関数	解説
get_post_format()	投稿ページに設定された投稿フォーマットの名前を返します。

6.カスタムフィールド関連

カスタムフィールドとは任意のキーと値を文書情報として登録しておき、PHPプログラム側でその情報を見て処理する時に利用します。

例えば、ECサイトで商品の価格をカスタムフィールドに設定しておき、商品を価格順に表示する等に利用する事ができます。

関数

解説

get_post_meta()

この関数は投稿IDとカスタムフィールドのキーを指定して、設定されている値を取得します。

update_post_meta()

指定した投稿のカスタムフィールドを新規追加/更新を実行します。

・指定したキーが無ければ新規追加

・指定してキーがある場合は更新を実行します。

7.検索ページ関連

関数	解説
the_search_query()	検索が行われた時に、そのリクエストの検索ワードを表示します。
get_search_query()	検索が行われた時に、そのリクエストの検索ワードを取得します。

8.サイドバーページ関連

関数	解説
dynamic_sidebar()	[外観→ウィジェット]で設定したサイドバーを表示します。

9.アーカイブページ関連

関数	解説
get_query_var()	アーカイブページの年と月の値を取得する時に利用します。
get_year_link()	年別アーカイブページのURLを取得する関数です。