WEB制作のための情報サイト / unazuki Library

WordPressのテンプレートタグ等に関するリファレンスを掲載しています。

テーマ設定関連
タグ 説明
add_theme_support() 指定した機能をテーマに追加する。
add_editor_style() 編集画面でエディタ用のスタイルシートを読み込む。
wp_enqueue_style() スタイルシートを登録し、読み込み対象としてキューに追加します。
wp_enqueue_script() スクリプトを登録し、読み込み対象としてキューに追加します。
register_post_type() カスタム投稿タイプを登録する。
register_taxonomy() カスタムタクソノミーを追加する。
register_sidebar() ウィジェットを配置するためのエリアを登録する。
dynamic_sidebar() サイドバー(ウィジェットを配置するエリア)を表示する。
条件分岐タグ
リクエスト内容を判定して真偽値を返す条件分岐タグです。
タグ 説明
is_home() リクエストしたページがホームかどうかを判定する。
is_front_page() リクエストしたページがトップページかどうかを判定する。
is_single() リクエストしたページが投稿の個別ページかどうかを判定する。
is_singular() リクエストしたページが指定した投稿タイプの個別ページかどうかを判定する。
is_page() リクエストしたページが固定ページかどうかを判定する。
is_category() リクエストしたページがカテゴリーページかどうかを判定する。
is_tag() リクエストしたページがタグページかどうかを判定する。
is_tax() リクエストしたページがタクソノミーページ(ターム別記事一覧ページ)かどうかを判定する。
is_post_type_archive() リクエストしたページが投稿タイプのアーカイブページかどうかを判定する。
is_author() リクエストしたページが投稿者アーカイブページかどうかを判定する。
is_year() リクエストしたページが年別アーカイブページかどうかを判定する。
is_month() リクエストしたページが月別アーカイブページかどうかを判定する。
is_date() リクエストしたページが年別/月別/日付別のいずれかのアーカイブページかどうかを判定する。
is_day() リクエストしたページが日付別のアーカイブページかどうかを判定する。
is_archive() リクエストしたページがアーカイブページかどうかを判定する。
is_search() リクエストしたページが検索結果ページかどうかを判定する。
is_404() 表示するページが404ページかどうかを判定する。
is_paged() リクエストしたページがページングされたページかどうかを判定する。
is_user_logged_in() ユーザーがWordPressにログインしているかどうかを判定する。
is_main_query() 現在のクエリがメインクエリかどうかを判定する。
クエリ関連
メインクエリやサブクエリのようなクエリ発行に関するテンプレートタグや、現在のクエリの内容を取得するテンプレートタグをまとめています。
タグ 説明
have_posts() 記事が存在するかどうか調べて真偽値を返します。
the_post() 処理対象の記事をセットします。
wp_reset_postdata() サブクエリによって上書きされたグローバルオブジェクト$postをリセットしてメインクエリに戻します。
get_post() 指定した投稿情報を取得する。
get_posts() 指定した条件にマッチする記事オブジェクトの配列を取得する。
get_the_posts_pagination() アーカイブページ(記事一覧ページ)にて利用可能なページネーションを取得します。
the_posts_pagination() アーカイブページ(記事一覧ページ)にてページネーションを表示します。
get_queried_object() 現在のクエリ(DBへの問い合わせ条件)に関するオブジェクトを返します。
get_queried_object_id() 現在のクエリ(DBへの問い合わせ条件)に関するオブジェクトのIDを返す。
get_post_type() 記事が所属する投稿タイプの名前を返す。
get_search_query() 検索キーワードを取得する。
記事表示関連
タイトルや公開日など記事オブジェクトが持つデータを取得するためのテンプレートタグの一覧です。
タグ 説明
get_the_title() 記事のタイトルを取得します。
the_title() 記事のタイトルを表示します。
get_the_date() 記事(投稿や固定ページ)の公開日を取得する。
the_date() 現在の記事(投稿や固定ページ)の公開日を表示します。
get_the_time() 記事の公開時刻を取得します。
the_time() 記事の公開時刻を表示します。
get_the_excerpt() 記事の抜粋分を取得します。抜粋の長さはデフォルトで110文字(日本語)。
the_excerpt() 記事の抜粋分を表示します。抜粋の長さはデフォルトで110文字(日本語)。
get_the_content() 記事本文のHTMLを取得します。moreタグ(続きを読むタグ)を使っている場合は、引数の指定次第で記事の一部を取得します。
the_content() 記事本文を表示します。moreタグ(続きを読むタグ)を使っている場合は、引数の指定次第で記事の一部を表示します。
has_post_thumbnail() 投稿にアイキャッチ画像があるかないかを判定した結果、真偽値(true / false)を返す。
get_the_post_thumbnail() 記事にアイキャッチ画像がある場合は、アイキャッチ画像を含むimg要素を返す。
the_post_thumbnail() 記事にアイキャッチ画像がある場合は、アイキャッチ画像を表示する。
get_permalink() 記事のパーマリンク(URL)を表示します。
the_permalink() 記事のパーマリンク(URL)を表示します。
get_post_meta() カスタムフィールドの値を取得します。
get_the_ID() 現在の記事のIDを取得します。
the_ID() 現在の記事のIDを表示します。
get_the_author() 現在の記事の投稿者の名前を返します。
the_author() 現在の記事の投稿者の名前を表示します。
post_class() 投稿に関するclass名を表示する。
カテゴリー・ターム関連
ターム(カテゴリーやタグなど)の一覧を取得するためのテンプレートタグをまとめています。
タグ 説明
get_category_link() カテゴリーのURLを取得します。
get_tag_link() タグのURLを取得します。
get_term_link() タームのURLを取得します。
get_categories() 条件にマッチしたカテゴリーオブジェクトの配列を取得します。
get_tags() 条件にマッチしたタグオブジェクトの配列を取得します。
get_terms() 条件にマッチしたタームオブジェクトの配列を取得します。
get_the_category() 投稿に紐づいているカテゴリー情報を取得します。
get_the_tags() 投稿に紐づいているタグ情報を取得します。
get_the_terms() 投稿に紐づいているターム情報を取得します。
single_cat_title() カテゴリー別の記事一覧ページ(category.phpやarchive.phpなど)にて、現在のカテゴリー名を表示します。
single_term_title() ターム別の記事一覧ページ(taxonomy.phpやarchive.phpなど)にて、現在のカテゴリー名を表示します。
各種URLやパスを動的に表示・取得
各種URLやパスを動的に生成するためのテンプレートタグの一覧です。
タグ 説明
home_url() トップページのURLを取得します。
get_theme_file_uri() テーマディレクトリのURLを取得します。子テーマ利用時は子テーマディレクトリのURLを取得します。
wp_get_attachment_image() 指定した添付画像(管理画面からメディアに登録された画像)のimg要素を取得する。
get_template_directory_uri() テーマディレクトリのURLを取得します。子テーマ利用時も常に親テーマのURLを取得します。
wp_get_attachment_image_src() 指定した添付画像(管理画面からメディアに登録された画像)の情報を取得する。
エスケープ関連
WordPressではURL等を無害化するエスケープ処理のためのテンプレートタグが用意されています。
タグ 説明
esc_url() URLをエスケープし、安全な文字列として出力します。
esc_attr() 属性値をエスケープし、安全な文字列として出力します。
esc_html() HTMLをエスケープし、安全な文字列として出力します。
antispambot() エンティティ化したメールアドレスを返します。
その他一般
タグ 説明
get_template_part() テンプレートファイルにテンプレートパーツを呼び出して実行します。
get_previous_posts_link() アーカイブページにおいて前のページリンクのHTMLを取得する。
get_next_posts_link() アーカイブページにおいて次のページリンクのHTMLを取得する。
next_posts_link() アーカイブページにおいて次のページリンクを表示する。
previous_posts_link() アーカイブページにおいて次のページリンクを表示する。
get_next_post() 現在の投稿の次の投稿情報を取得する。
get_previous_post() 現在の投稿の前の投稿情報を取得する。
wp_head() アクションフックwp_headに登録されている関数を実行する。
wp_footer() アクションフックwp_footerに登録されている関数を実行する。
wp_body_open() アクションフックwp_body_openに登録されている関数を実行する。
add_shortcode() 任意のショートコードを作成して追加する。
do_shortcode() ショートコードが実行された文字列を返す。
body_class() body要素に関するclass名を表示する。