WordPressテンプレートタグをテーマ・プラグイン開発で使える内容で徹底解説（チートシート）

みなさんこんにちは！エンジニアの高澤です！

今回はWordPressテーマ開発に使うテンプレートタグ全集について解説していきたいと思います。

テンプレートタグとはWordPressで用意された専用の関数のことをいいますが、このテンプレートタグはテーマ開発はもちろん、プラグイン開発などにも必ず使用する必須の知識になります。

必須なだけに、初心者エンジニアの方にとっては「テンプレートタグはたくさんありすぎて学習したいけど一体どのテンプレートタグがテーマ開発で必要なのか？」

また上級者エンジニアの方にとっては「テンプレートタグがたくさんありすぎて忘れてるから仕事ですぐに使えるチートシートが欲しい！」

といった問題やご要望があるかと思います。

今回の記事はそこを解決する構成で現役エンジニアのわたくし高澤が力を入れて執筆いたしました。

よろしければぜひ当記事をお仕事などにお役立ていただけましたら幸いです。

テンプレートタグとは

テンプレートタグとは、WordPressで用意された専用の関数のことをいいます。

WordPressのコアの内部では、WordPressのデータベースに保存されたデータを出力したり取得したりといったデータベース操作を簡単にしてくれるAPIという目的で、専用のテンプレートタグという関数を定義しています。

このテンプレートタグを使えば、以下のような関数一つ記述するだけで記事のタイトルや記事の本文などを簡単に表示することが可能です。

<!-- the_title(): 現在の投稿やページのタイトルを表示します。 -->
<h1><?php the_title(); ?></h1>

<!-- the_content(): 現在の投稿やページのコンテンツを表示します。 -->
<div class="entry-content">
    <?php the_content(); ?>
</div>

<!-- the_post_thumbnail(): 現在の投稿やページのアイキャッチ画像（投稿サムネイル）を表示します。 -->
<?php if ( has_post_thumbnail() ) : ?>
    <div class="post-thumbnail">
        <?php the_post_thumbnail(); ?>
    </div>
<?php endif; ?>

<!-- the_author(): 現在の投稿やページの著者を表示します。 -->
<p>投稿者: <?php the_author(); ?></p>

<!-- the_time(): 現在の投稿やページの投稿日時を表示します。 -->
<p>投稿日: <?php the_time('Y年m月d日'); ?></p>

<!-- wp_nav_menu(): ナビゲーションメニューを表示します。 -->
<?php wp_nav_menu( array( 'theme_location' => 'primary' ) ); ?>

上記コードのように、たった一つの関数を書くだけで必要なデータを表示することができてしまいます。

このテンプレートタグは数千ほどの非常に膨大な数があるので、すべてを習得することは現実的ではありません。

そのため、当記事では現役エンジニアである筆者が本当にお仕事に必要な厳選したテンプレートタグをご紹介したいと思います。

テンプレートタグを知っておくメリット

テンプレートタグを知っておくべきメリットについて解説いたします。

筆者が考えるメリットは以下になります。

• テーマを開発できる
• プラグインを開発できる
• データ処理の効率化や管理画面カスタマイズなどの応用力がつく

テンプレートタグを知っておくことで、問題なくテーマ開発をできるようになり、またフックというWordPress専用の仕組みと組み合わせればプラグインを開発することも可能です。

また、データ処理の効率化や管理画面カスタマイズなどの応用力がつき、WordPressを自由自在にカスタマイズすることができます。

テンプレートタグが定義されたコアファイル

テンプレートタグはWordPress本体に定義されているため使用することが可能です。

このテンプレートファイルが定義されているファイルは、WordPressコアファイルを構成するものの一つであるwp-includesファイル内のPHPファイルに定義されております。

具体的には以下になります。

• wp-includes/general-template.php
• wp-includes/author-template.php
• wp-includes/bookmark-template.php
• wp-includes/category-template.php
• wp-includes/comment-template.php
• wp-includes/link-template.php
• wp-includes/post-template.php
• wp-includes/post-thumbnail-template.php
• wp-includes/nav-menu-template.php

上記内容を把握しておくことで、今後応用をきかせて実際に上記PHPファイルを開いて、どのような関数が定義されているのか、どのような処理が記述されているのかを確認して色々と対応することが可能となります。

WordPressの公式ドキュメント

そもそもですが、WordPressは公式ドキュメントで全てのテンプレートタグを公開しています。

ここではまず事前に、当記事で解説するテンプレートタグのWordPress公式ドキュメントをご紹介させていただき、お仕事で当記事を利用する際に公式ドキュメントの閲覧と交えながらツールとしてご利用いただければと思います。

以下のURLをクリックしてご確認いただけます。

https://developer.wordpress.org/reference/functions

つまりはこちらのドキュメントに全てのテンプレートタグが掲載されているのですが、全てを根こそぎ見て覚えることは無謀というか、本当に全て覚える意味があるのか？というと筆者的には意味はないのかなと思っております。

理由は、今や当記事のように仕事で使うテンプレートタグをまとめた情報だったり、ChatGPTなどのAIツールで自動生成することができてしまうので、わざわざ全て覚える必要はないかと考えます。

覚える必要があるのは、実際に実装の中で出てきたテンプレートタグや必要そうだなと予想されるものを事前に覚えるなど、本当に意味のあるフローで覚えていくことが重要なのではないかと考えます。

テーマ開発でよく使うテンプレートタグのまとめ

まず初めに、テーマ開発でよく使う必須のテンプレートタグをおまとめさせていただきます。

記事一覧表示およびページネーションに使用されるテンプレートタグ

以下は記事一覧の表示や、記事一覧に欠かせないページネーションの関連のテンプレートタグになります。

ここから多くのテンプレートタグを解説することになりますが、ここでざっくりとテンプレートタグとは具体的にどんなものなのかの感覚を掴めるようにしておきましょう。

上記テンプレートタグを使って、以下のようなPHPのwhile文によるループ処理と組み合わせて記事一覧と、一覧と連携して出力されるページネーションのPHPのサンプルコードになります。

<?php
$paged = (get_query_var('paged')) ? get_query_var('paged') : 1;

$args = array(
    'post_type' => 'post',
    'posts_per_page' => 5,
    'paged' => $paged,
);

$my_query = new WP_Query($args);

if ($my_query->have_posts()) {
    while ($my_query->have_posts()) {
        $my_query->the_post();
        // 投稿の表示 (タイトル、サムネイルなど)
        the_title('<h2><a href="' . get_permalink() . '">', '</a></h2>');
        the_excerpt();
    }

    // ページネーションを表示
    the_posts_pagination(array(
        'mid_size'  => 2,
        'prev_text' => __('« Previous'),
        'next_text' => __('Next »'),
    ));
} else {
    echo '投稿が見つかりませんでした。';
}

wp_reset_postdata();
?>

上記コードでは、5件ずつの投稿を表示し、ページネーションを適用しています。the_posts_pagination()を使って、前後のページリンクをカスタマイズしています。

いかがでしょうか？テンプレートタグといってもWordPress側で事前に用意されたただの関数なので、決して難しくないと思います。

実際のテーマ開発やプラグイン開発ではこのようにテンプレートタグを使うことが必須となりますが、例えば当記事のようなたくさんテンプレートタグがまとまっているページなどを使って好きなだけカンニングしていたいて大丈夫です。

WordPress構築で知っておくべきテンプレートタグ

それでは早速、WordPressのテーマ開発やプラグイン開発で知っとくべきテンプレートタグを解説していきたいと思います。

もしお仕事で必要になったらよろしければぜひ当記事をご確認いただきながら快適に開発をしていただけましたら幸いです。

それではジャンル別に確認していきましょう。

インクルード系

インクルード系関数の役割は、WordPressテーマやプラグインの開発において共通のテンプレートパーツを一箇所にまとめて管理し、コードの再利用性とメンテナンス性を向上させることです。

これにより、サイト全体の一貫性を保ちつつ、効率的なコーディングが可能になります。例えば、ヘッダー、フッター、サイドバーなどの共通要素を個別に管理することで、デザインや機能の変更を一箇所で行うだけでサイト全体に反映させることができます。

また、テンプレートパーツを再利用することで、開発時間の短縮やコードの重複を避けることができます。これらの関数は、柔軟でカスタマイズ性の高いサイト構築を実現するために不可欠なツールです。

コンテンツ系

コンテンツ系の関数は、WordPressの投稿やページのコンテンツを取得して表示するための重要なツールです。

例えば、the_content() は本文を表示し、投稿の内容をテーマに組み込む役割を果たします。また、the_excerpt() は投稿の抜粋を表示し、記事の概要を提供するために使用されます。

これらの関数を使用することで、コンテンツの表示を柔軟にカスタマイズし、デザインやレイアウトに応じた情報提供が可能になります。結果として、サイトのユーザー体験を向上させるために不可欠な要素となります。

タグ出力系

タグ出力系の関数は、WordPressの投稿やページに関連するタクソノミー情報を表示するための重要なツールです。

例えば、the_terms() は投稿に関連付けられたタームを取得し、カスタムタクソノミーやカテゴリを表示する役割を果たします。また、the_category_list() は、投稿が属するカテゴリをリスト形式で表示し、サイト内のナビゲーションを助けます。

これらの関数を使用することで、コンテンツの関連性を明確にし、訪問者が興味のある情報に簡単にアクセスできるようにすることができます。結果として、サイトのユーザビリティやSEO効果を向上させるために重要な要素となります。

条件分岐タグ系

条件分岐タグ系の関数は、特定の条件に基づいて異なるテンプレートやコンテンツを表示するための重要なツールです。

例えば、is_single() は現在表示されているページが単一の投稿であるかどうかを判定し、特定の投稿専用のレイアウトやスタイルを適用するために使用されます。また、is_category() は現在のアーカイブがカテゴリアーカイブであるかを確認し、カテゴリに特化したコンテンツや表示を行う役割を果たします。

これらの関数を活用することで、サイトの表示内容を動的に変更し、訪問者のニーズに応じたカスタマイズが可能になります。結果として、ユーザー体験を向上させるために不可欠な要素となります。

投稿タイプの主なAPI

投稿タイプのAPIは、WordPressでカスタム投稿タイプを管理し、サイトのコンテンツ構造を柔軟に拡張するための重要なツールです。

例えば、register_post_type() は、新しい投稿タイプを定義し、管理画面に表示させる役割を果たします。これにより、ブログ記事だけでなく、ページや商品、ポートフォリオなど、さまざまなコンテンツを扱うことが可能になります。
また、get_post_type() は、現在の投稿のタイプを取得し、特定の投稿タイプに応じた処理や表示を行うために使用されます。

これらのAPIを活用することで、サイトのコンテンツをより細かく分類・管理し、ユーザーのニーズに応じたカスタマイズが実現できます。

カスタムフィールドの主なAPI

カスタムフィールドのAPIは、WordPressの投稿やページに追加のデータを付加し、コンテンツを柔軟に拡張するための重要なツールです。

例えば、add_post_meta() は、新しいカスタムフィールドを投稿に追加し、特定の情報を保存する役割を果たします。
また、get_post_meta() は、投稿のカスタムフィールドからデータを取得し、テーマやプラグイン内で使用するために利用されます。また、update_post_meta() は既存のカスタムフィールドの値を更新し、データの管理を容易にします。

これらのAPIを活用することで、独自のコンテンツ構造を構築し、サイトの機能性を向上させることが可能になります。

タクソノミーの主なAPI

タクソノミーのAPIは、WordPressでコンテンツを分類し、管理するための重要なツールです。

例えば、register_taxonomy() は、新しいタクソノミーを定義し、投稿やカスタム投稿タイプに関連付ける役割を果たします。これにより、コンテンツをカテゴリーやタグだけでなく、柔軟に分類できます。
get_the_terms() は、特定の投稿に関連付けられたタクソノミーのタームを取得し、表示するために使用されます。
また、has_term() は、特定のタクソノミーのタームが投稿に関連付けられているかを確認するために利用されます。

これらのAPIを活用することで、コンテンツの整理と表示を効率的に行うことが可能になります。

コメントの主なAPI

コメントのAPIは、WordPressでコメント機能を管理し、サイトに対するユーザーの意見やフィードバックを収集するための重要なツールです。

例えば、wp_insert_comment() は、新しいコメントをデータベースに追加する役割を果たし、投稿へのユーザーの意見を記録します。
get_comments() は、特定の投稿に関連するコメントを取得し、表示するために使用されます。
また、comments_open() は、投稿に対してコメント機能が有効かどうかを判定するために利用されます。

これらのAPIを活用することで、コメント機能の柔軟な管理とカスタマイズが可能になります。

コメントのカスタムフィールドAPI

コメントのカスタムフィールドAPIは、WordPressのコメントに追加のデータを保存し、柔軟な情報管理を可能にする重要なツールです。

例えば、add_comment_meta() は、新しいカスタムフィールドをコメントに追加する役割を果たし、特定の情報を保存します。
get_comment_meta() は、コメントのカスタムフィールドからデータを取得し、テーマやプラグインで利用するために使用されます。
また、update_comment_meta() は既存のカスタムフィールドの値を更新し、データの管理を容易にします。

これらのAPIを活用することで、コメントに関連する情報を拡張し、サイトの機能性を向上させることが可能になります。

ユーザーの主なAPI

WordPressのユーザーAPIは、サイト上の著者やユーザーに関する情報を取得・表示するための一連の関数です。これらの関数を使用することで、投稿の著者名や著者に関連するリンク、著者の投稿数などの情報を簡単に表示できます。

例えば、get_the_author()やthe_author()は、投稿の著者名を取得・表示し、get_author_posts_url()やthe_author_posts_link()は、著者の投稿アーカイブページへのリンクを生成します。the_author_meta()は、著者のメールアドレスやURLなどのメタ情報を表示し、wp_dropdown_users()はユーザーのドロップダウンリストを作成します。

これらのAPIは、ブログやニュースサイトで著者情報を表示したり、ユーザーリストを管理したりする際に非常に便利です。WordPressのユーザーAPIを利用することで、ユーザー情報の表示やリンク作成を簡単かつ効果的に行うことができます。

ユーザーの主なAPI（WP_Roles）

WP_Rolesは、WordPressのユーザーロールと権限管理を管理するクラスです。

このクラスは、サイト上のユーザーに対する役割（ロール）と、それに伴う権限（ケイパビリティ）を管理するための機能を提供します。

WP_Rolesは、WordPressサイト上で利用可能なすべての役割を定義し、管理します。各役割には一連の権限が関連付けられています。

また、権限の管理が可能であり、各役割にどのような権限があるかを管理します。権限とは、ユーザーがサイト上で実行できる特定の操作（例えば、投稿の公開、ページの編集、プラグインのインストールなど）を指します。

役割と権限の追加・削除としての機能があり、WP_Rolesクラスを使用して、新しい役割を追加したり、既存の役割を削除したりすることができます。また、特定の役割に対する権限を追加したり削除したりすることも可能です。

以下に、WP_Rolesの各メソッドについてご説明いたします。

WordPressにはデフォルトでいくつかの役割が定義されています。

• 管理者 (Administrator)：すべての権限を持つ。
• 編集者 (Editor)：すべてのコンテンツを管理できる。
• 著者 (Author)：自分の投稿を公開できる。
• 寄稿者 (Contributor)：自分の投稿を下書きとして保存できるが、公開はできない。
• 購読者 (Subscriber)：コンテンツを読むことができる。

上記WordPressデフォルトの権限（役割）やテンプレートタグをご参考に、ユーザー機能をカスタマイズしてください。

例えば、「新しいユーザーロールを追加する」場合は、以下のコードを記述します。

<?php
// 新しいユーザーロールを追加
add_role('custom_role', 'カスタムロール', array(
    'read' => true,
    'edit_posts' => true,
));

また、「ユーザーロールに新しい権限を追加する」場合は、以下のコードを記述します。

<?php
// カスタムロールに新しい権限を追加
$role = get_role('custom_role');
$role->add_cap('publish_posts');

ユーザーの主なAPI（WP_User）

WP_Userは、WordPressのユーザーに関する情報や操作を管理するためのクラスです。

このクラスは、WordPressサイトのユーザーをプログラム的に扱う際に利用されます。WP_Userクラスを使うことで、ユーザーの情報取得や更新、ユーザーの権限管理などが容易に行えます。

以下に、WP_Userの各メソッドについてご説明いたします。

例えば、「ユーザーに新しいロールを追加、設定、削除する」場合は以下のようにコードを記述します。

<?php
// ユーザーIDを指定
$user_id = 1;
$user = new WP_User($user_id);

// 新しいロールを追加する
$user->add_role('editor');

// ユーザーのロールを設定する（すでに存在するロールに変更する）
$user->set_role('administrator');

// ユーザーから特定のロールを削除する
$user->remove_role('editor');

WP_Userクラスは、WordPressのユーザー情報を操作および管理するための強力なツールです。これを使用することで、プラグインやテーマの開発者は、ユーザーのプロファイルや権限を柔軟に制御することができます。

トップメニューにメニューを追加する主なAPI

add_menu_page()などの管理画面のトップメニューにメニューを追加するAPIは、WordPressの管理画面にカスタムメニューを追加し、プラグインやテーマの設定を管理するための重要なツールです。

例えば、add_menu_page() は、新しい管理メニューを作成し、特定のページにリンクする役割を果たします。
また、add_submenu_page() は、親メニューの下にサブメニューを追加し、関連する機能を整理します。

これらのAPIを利用することで、管理画面のユーザーインターフェースを拡張し、ユーザーが簡単に設定や管理を行えるようにすることが可能になります。

サブメニューにメニューを追加する主なAPI

add_submenu_page()などのサブメニューにメニューを追加するAPIは、WordPressの管理画面において、親メニューの下に関連機能を整理するための重要なツールです。

例えば、add_submenu_page() は、指定した親メニューの下に新しいサブメニューを追加し、特定の設定や機能にアクセスできるようにします。
また、remove_submenu_page() は、特定のサブメニューを管理画面から削除する役割を果たします。

これらのAPIを活用することで、管理画面の構造を明確にし、ユーザーが必要な機能に迅速にアクセスできるようにすることが可能になります。

Settings API

Settings APIは、WordPressの管理画面に設定ページ（オプションページ）を追加し、オプションを管理するための重要なツールです。

これにより、プラグインやテーマが簡単に設定オプションを提供でき、ユーザーが直感的に管理できるようになります。
Settings APIを使用すると、設定の登録、表示、検証を効率的に行うことができ、フォームのセキュリティやバリデーションも容易に実装できます。

これにより、一貫したユーザー体験を提供し、WordPressの管理画面をより使いやすくすることが可能になります。

バリデーションの関数

username_exists()などのバリデーション関数は、WordPressでユーザーの入力データを検証し、正しい形式や存在を確認するための重要なツールです。

username_exists() は、指定されたユーザー名が既にデータベースに存在するかどうかをチェックし、重複を防ぐ役割を果たします。
その他のバリデーション関数には、email_exists()（メールアドレスの存在確認）やvalidate_username()（ユーザー名の形式確認）などがあり、これらを使用することで、ユーザー登録やプロフィール編集の際にデータの整合性を保つことができます。

バリデーション関数を活用することで、セキュリティとユーザビリティの向上が図れます。

サニタイズの関数

sanitize_email()などのサニタイズ関数は、WordPressでユーザーからの入力データを安全な形式に変換し、データベースや表示に適した状態にするための重要なツールです。

例えば、sanitize_email() は、メールアドレスを正しい形式に整え、不正なデータが登録されないようにします。
他にも、sanitize_text_field()（テキストフィールドのデータをクリーンにする）、sanitize_url()（URLを安全な形式に整える）などがあり、これらの関数を使用することで、サイトのセキュリティを向上させ、潜在的な攻撃やデータの不整合を防ぐことが可能になります。

サニタイズ関数は、ユーザー入力の信頼性を確保するために不可欠です。

オプションAPI

オプションAPIは、WordPressで設定やオプションを保存、取得、管理するための重要なツールです。

例えば、add_option() は新しいオプションをデータベースに追加し、get_option() は保存されたオプションの値を取得する役割を果たします。
また、update_option() は既存のオプションの値を更新し、delete_option() は不要なオプションを削除するために使用されます。これらのAPIを活用することで、プラグインやテーマの設定を簡単に管理でき、ユーザーがカスタマイズ可能な機能を提供することが可能になります。

オプションAPIは、サイトの動作や機能を柔軟に調整するために不可欠です。

JavaScript管理の主なAPI

JavaScript管理の主なAPIは、WordPressサイトにスクリプトを効率的に追加、管理、制御するための重要なツールです。

例えば、wp_enqueue_script() は、必要なJavaScriptファイルを正しい順序でキューに追加し、依存関係を管理します。
また、wp_localize_script() は、JavaScriptにPHPからデータを渡すために使用され、インタラクティブな機能を実現します。
さらに、wp_add_inline_script() は、特定のスクリプトにインラインコードを追加する役割を果たします。

これらのAPIを利用することで、サイトのパフォーマンスを向上させつつ、柔軟なJavaScriptの実装が可能になります。

CSS管理の主なAPI

CSS管理の主なAPIは、WordPressサイトにスタイルシートを効率的に追加、管理するための重要なツールです。

例えば、wp_enqueue_style() は、必要なCSSファイルをキューに追加し、依存関係を管理します。また、wp_add_inline_style() は、特定のスタイルシートにインラインCSSを追加する役割を果たします。これにより、テーマやプラグインのスタイルを柔軟に調整できます。
さらに、wp_register_style() は、スタイルシートを登録して後で使用するために準備することができます。

これらのAPIを利用することで、サイトのパフォーマンスを向上させつつ、スタイルの一貫性を保つことが可能になります。

Object Cache API

Object Cache APIは、WordPressでデータベースへのアクセスを効率化するための重要なツールです。

このAPIを使用することで、データをメモリにキャッシュし、再利用することでパフォーマンスを向上させることができます。
主な関数には、wp_cache_set()（データをキャッシュに保存）、wp_cache_get()（キャッシュからデータを取得）、wp_cache_delete()（キャッシュからデータを削除）などがあります。また、wp_cache_flush()は、すべてのキャッシュをクリアする役割を果たします。

Object Cache APIを活用することで、データベースの負荷を軽減し、サイトの応答速度を改善することが可能になります。

Transients API

Transients APIは、WordPressで一時的なデータを簡単に保存し、管理するための重要なツールです。

このAPIを使用することで、データをデータベースにキャッシュし、指定した期限が過ぎると自動的に削除されるため、パフォーマンスを向上させることができます。

主な関数には、set_transient()（一時データを保存）、get_transient()（一時データを取得）、delete_transient()（一時データを削除）があります。

これにより、特定の処理結果や外部APIからのデータを一時的に保存し、再利用することで、サイトの応答速度を改善することが可能になります。

Transients APIは、キャッシュ機能を簡単に実装できるため、非常に便利です。

マルチサイト特有の関数

マルチサイト特有の関数は、WordPressのマルチサイト機能を管理するための重要なツールです。

例えば、switch_to_blog() は、特定のサイトに切り替えてそのコンテキストで処理を実行する役割を果たします。
restore_current_blog() は、元のサイトに戻るために使用されます。また、get_blog_details() は、指定したサイトの詳細情報を取得するために利用されます。
さらに、is_multisite() は、現在のインストールがマルチサイトかどうかを確認するための関数です。

これらの関数を活用することで、マルチサイト環境での管理やカスタマイズを効率的に行うことが可能になります。

国際化するための関数

国際化するための関数は、WordPressサイトを多言語対応にするための重要なツールです。

例えば、__() は、翻訳可能な文字列を定義するために使用され、_e() は、翻訳された文字列を直接出力します。
また、_n() は、単数形と複数形を管理するために利用され、文脈に応じた翻訳を提供します。
さらに、load_textdomain() は、特定の言語ファイルを読み込むために使用されます。

これらの関数を活用することで、サイトを多言語化し、さまざまな地域のユーザーに対応したコンテンツを提供することが可能になります。

テーマのバージョン管理に使用される関数

テーマのバージョン管理に使用される関数は以下になります。

wp_get_theme()関数の使用例は以下になります。

<?php
$theme = wp_get_theme();
echo 'テーマ名: ' . $theme->get('Name');
echo 'バージョン: ' . $theme->get('Version');

このコードは、WordPressの現在アクティブなテーマの名前とバージョンを取得し、それぞれの情報を画面に出力しております。

取得できる情報は以下になります。

• Name: テーマの名前
• Version: テーマのバージョン
• Author: テーマの作成者
• Description: テーマの説明

上記のようにテーマのバージョン管理には、wp_get_theme()を使用してテーマ情報を取得し、スタイルやスクリプトにバージョンを指定するのが一般的です。

プラグインのバージョン管理に使用される関数

プラグインのバージョン管理に使用される関数は以下になります。

get_plugin_data()関数の使用例は以下になります。

<?php
$plugin_data = get_plugin_data(WP_PLUGIN_DIR . '/your-plugin/your-plugin.php');
echo 'プラグイン名: ' . $plugin_data['Name'];
echo 'バージョン: ' . $plugin_data['Version'];

このコードでは、WP_PLUGIN_DIR定数を使用してプラグインのメインファイルへのパスを指定し、get_plugin_data()関数でプラグインの情報を取得しています。

取得できる情報は以下になります。

• Name: プラグインの名前
• Version: プラグインのバージョン
• PluginURI: プラグインの公式
• URLAuthor: プラグインの作成者
• Description: プラグインの説明

上記のようにプラグインのバージョン管理には、get_plugin_data()を使用してプラグインのバージョン情報を取得し、必要に応じてスタイルやスクリプトにバージョンを指定します。

これらの関数を活用することで、テーマやプラグインのバージョン管理を効率的に行い、キャッシュ管理やバージョン情報の表示が容易に行えます。

wp_get_theme()やget_plugin_data()が取得する情報の元となる場所は、それぞれテーマ（テーマの場合はstyle.css）とプラグイン（プラグインの場合はプラグイン本体のPHPファイル）のメタデータファイルに定義されています。

wp_get_theme() の取得元

まずwp_get_theme()は、テーマの style.cssファイルに記載されているメタデータを取得します。

WordPressのテーマは、style.css ファイルの冒頭にテーマ情報がコメント形式で記載されています。このコメント部分に記載された情報が、wp_get_theme() で取得できる内容となります。

例えば、以下のようなテーマファイルのトップ階層にあるstyle.cssがあるとします。

/*
Theme Name: My Custom Theme
Theme URI: https://example.com/my-custom-theme
Author: John Doe
Author URI: https://example.com
Description: This is a custom WordPress theme.
Version: 1.0.0
License: GNU General Public License v2 or later
License URI: https://www.gnu.org/licenses/gpl-2.0.html
Text Domain: my-custom-theme
*/

上記のようなメタデータが style.css の最初に記述されていることで、WordPressはこの情報を元にテーマのバージョン、名前、作者情報などを取得します。これが wp_get_theme() 関数の取得元です。

get_plugin_data() の取得元

get_plugin_data() は、プラグインのメインファイル（通常、プラグイン名.php ファイル）の冒頭に記載されたメタデータを取得します。

プラグインのメタデータは、プラグインのメインPHPファイル（通常、プラグインフォルダ内のルートにあるPHPファイル）のコメントブロックに記載されています。このコメント部分からプラグインの情報が取得されます。

例えば、「My Custom Plugin」というプラグイン名のプラグイン自体のファイルのトップ階層に、以下の記述があるmy-custom-plugin.phpというプラグインを成り立たせるために必須のPHPファイルがあるとします。

<?php
/**
 * Plugin Name: My Custom Plugin
 * Plugin URI: https://example.com/my-custom-plugin
 * Description: This is a custom WordPress plugin.
 * Version: 1.0.0
 * Author: John Doe
 * Author URI: https://example.com
 * License: GPL2
 * Text Domain: my-custom-plugin
 */

上記このように、プラグインファイルの冒頭にコメント形式で記載されるメタデータが get_plugin_data() によって取得されます。

これらが使用できると効率的な開発が可能となるので、ぜひおさえておきましょう。

ブロック開発の主なAPI

ブロック開発のAPIは、WordPressのブロックエディターを活用して、カスタムブロックの作成や編集体験を強化するための重要なツールです。これにより、ユーザーはコンテンツのレイアウトやデザインをより柔軟にカスタマイズできるようになります。

例えば、register_block_type() 関数は、新しいカスタムブロックを登録し、ブロックエディターに表示させるために使用されます。これにより、デフォルトのブロックだけでなく、独自のデザインや機能を持つブロックを作成して、サイトに合わせたコンテンツ編集が可能になります。

また、JavaScriptライブラリのReactで使用するuseBlockProps() フックは、ブロックが必要とするクラス名や属性を簡単に管理し、ブロックの外観や動作を統一的にコントロールするための便利な手段です。

これらのAPIを効果的に活用することで、WordPressのブロックエディターの可能性を最大限に引き出し、より直感的でパワフルな編集体験を提供することができます。

ブロックとは、コンテンツを構成するための再利用可能な要素で、テキスト、画像、動画などを組み合わせて、ユーザーが視覚的にページや投稿を作成できるようにする機能のことをいいます。

下図のように編集画面左側のメニューにある「ボタン」や「カラム」などの機能がブロックです。

ブロックエディター（Gutenberg）を使用すると、これらのブロックをドラッグ＆ドロップで配置したり、カスタマイズしたりできるため、直感的なコンテンツ作成が可能になります 。

※ここの項目ではブロック開発の知識がなければついてこれない部分もあるため、事前に学習しておくことをおすすめいたします。

そして以下は、ブロック開発を実現するedit.jsやsave.jsなどのJavaScriptファイルを構成するReactで使用するAPI（関数）になります（ブロック開発については、別の記事でご確認ください）。

ブロックパターンの主なAPI

ブロックパターンは、複数のブロックを組み合わせた事前定義されたテンプレートです。これを使うことで、ユーザーはブログやページに素早くデザインを挿入でき、時間を節約できます。

ブロックパターンは、特定のレイアウトやデザインを持つため、サイトの一貫性を保ちながら多様なコンテンツを簡単に作成する手助けをします。たとえば、見出し、テキスト、画像を組み合わせたパターンを登録しておくことで、ユーザーは同じパターンを何度でも利用でき、手間を減らせます。新しいブロックパターンを追加するには、register_block_pattern() 関数を使用し、カスタムのパターンを作成できます。

WordPressでは以下のように多数のブロックパターンを無料公開したディレクトリページがありますが、これら用意されたパターン以外に自作で作るためのAPIがここで紹介するAPIになります。

https://ja.wordpress.org/patterns/

※ここの項目ではブロックパターンの知識がなければついてこれない部分もあるため、事前に学習しておくことをおすすめいたします。

ブロックスタイルの主なAPI

ブロックスタイルは、特定のブロックに対して異なる外観を提供する機能です。これにより、同じブロックの中でも異なるスタイルを適用でき、デザインに多様性を持たせることができます。

たとえば、段落ブロックに「太字」スタイルや「枠付き」スタイルを追加することで、視覚的なインパクトを変えることが可能です。ユーザーは、インターフェース上で簡単にスタイルを選択でき、特にデザインに関する知識が少ないユーザーでも直感的に操作できます。新しいスタイルを追加するには、register_block_style() 関数を使用し、既存のブロックに新しい外観を付与できます。

ブロックスタイルは、下図のように編集画面右メニューにある「スタイル」のボタンがブロックスタイル機能です。下図の例でいえば、本文に配置してあるブロックの見た目の設定として「デフォルト」と「角丸」が用意されており、それぞれクリックすると見た目がその通りに設定されます。

※ここの項目ではブロックスタイルの知識がなければついてこれない部分もあるため、事前に学習しておくことをおすすめいたします。

メニューの主なAPI

WordPressには標準でメニュー機能が備わっており、ここで解説するテンプレートタグを利用することによって、WordPressのメニュー機能を柔軟にカスタマイズすることができます。

ウィジェットの主なAPI

WordPressにはウィジェットに関連するテンプレートタグがいくつか用意されています。以下は、ウィジェットに関連する主要なテンプレートタグの一覧です。

WordPressのウィジェットを扱う際には、特に dynamic_sidebar() や register_sidebar() がよく使われます。また、カスタムウィジェットを作成する際は、register_widget() を使ってクラスベースのウィジェットを登録し、柔軟なウィジェットエリアを構築できます。

テーマカスタマイザーの主なAPI

以下はテーマカスタマイザーの処理で必要なテンプレートタグになります。

テーマカスタマイザー周りのカスタマイズには、主にカスタマイザーをカスタマイズするためのフックを使って独自のカスタマイザーを登録し、以下のテンプレートタグでデータを取得するなどして表示をカスタマイズすることができます。

ショートコードの主なAPI

WordPressのショートコード（Shortcode）は、特定の機能を簡単に投稿やページ内に挿入するための便利な方法です。ショートコードに関連するテンプレートタグを使用することで、テーマやプラグインの中でショートコードを登録、実行、操作できます。

フックの主なAPI

WordPressのフック機能に関連するテンプレートタグは、テーマやプラグインでカスタマイズや追加の機能を実装するために非常に重要です。フックは大きく分けて2種類あり、アクションフックとフィルターフックがあります。それぞれに関連するテンプレートタグについて説明します。

メール関連の主なAPI

ここではWordPressでメール送信を行うための主要なAPIや関数について解説します。

標準のメール送信機能であるwp_mail()を中心に、送信元の設定やメールコンテンツのカスタマイズなど、WordPressで柔軟にメール機能を操作するための方法を解説します。

これにより、通知メールやHTMLメール、カスタムSMTP設定など、実践的なメール処理が簡単に実装可能です。

カスタマイズを便利にする主なAPI

body_class()やpost_class()など、ページや投稿に動的なクラスやIDを自動付与する主要なテンプレートタグを解説します。

これらのタグを活用することで、ページの種類や投稿の状態に応じたスタイリングが容易になり、カスタムテーマのデザインや機能拡張に役立ちます。

タイムゾーン周りの便利なAPI

WordPressには、日時やタイムゾーンの操作に役立つテンプレートタグがいくつかあります。以下に、代表的なタイムゾーン関連のテンプレートタグとその用途を解説します。

なにかと便利なAPI

以下は分類がむずかしかったため、便利でかつプラグイン開発やテーマ開発でしばしば使用されるAPIとして解説いたします。

テーマのPHPテンプレートファイル以外のPHPファイルでテンプレートタグを使用可能にする方法

WordPressのテーマ開発やプラグイン開発において、テンプレートタグは非常に便利な機能ですが、通常はテーマのPHPテンプレートファイル内でのみ使用できます。

しかし、プラグインやカスタム機能を実装する際には、他のPHPファイルでもテンプレートタグを利用したい場合があります。

ここでは、テーマのPHPテンプレートファイル以外のPHPファイルでテンプレートタグを使用可能にする方法を紹介します。これにより、より柔軟で効果的な開発が実現できます。

まずは、WordPressをインストールしたトップディレクトリ以降のサーバー階層の中に、任意でPHPファイルを作成し、ファイルの先頭付近に以下のコードをコピー＆ペーストしてください。

ちなみに任意のPHPファイルとは、header.phpやindex.phpなどのWordPressの仕様に沿ったPHPファイル以外のファイル（自作したsample.phpやtext.phpなど任意のファイル名で作成したただのPHPファイル）のことをいいます。

ご自身で作成された独自のPHPファイルの上の方に以下のコードをコピー＆ペーストしてください。

<?php
require_once($_SERVER['DOCUMENT_ROOT']."/【サイトディレクトリ】/wp-load.php");

上記のコードをコピー＆ペーストしていただき保存していただくことで、ペーストした上記コードの下からはWordPressのテンプレートタグが使えるようになり、WordPressループなどWordPress独自の実装をおこなうことができます。

これはいざというときに便利なので、ぜひ覚えておきましょう。

まとめ

WordPressテーマ開発に使うテンプレートタグ全集についての解説は以上になります。

テンプレートタグとはWordPressで用意された専用の関数のことをいい、テンプレートタグはテーマ開発はもちろん、プラグイン開発などにも必ず使用する必須の知識になります。

テンプレートタグの数は非常に膨大で全てを覚えることはとても現実的ではありません。

また、初心者エンジニアの方からしたら一体何のテンプレートタグを覚えなければならないのか、また、上級者エンジニアの方からしたら仕事で使えるチートシートのようなものが欲しい、という疑問やご要望があるかと思います。

当記事ではそんな問題を解説するため、テンプレートタグについて現役エンジニアがこれまでの仕事の経験から厳選したテンプレートタグをご紹介いたしました。

よろしければぜひ当記事をご活用いただけましたら幸いです。