WordPress関数一覧｜まず覚えたい基本と全体像

WordPressのオリジナルテーマ制作では、投稿タイトルを表示したり、画像を読み込んだり、ページの種類によって表示内容を切り替えたりするために、さまざまなWordPress関数を使用します。

関数の数は非常に多いため、最初からすべてを覚える必要はありません。まずは、どのような目的の関数があるのかを知り、必要なときに適切な関数を選べるようになることが大切です。

この記事では、WordPressテーマ制作でよく使う関数を、役割ごとに整理して解説します。

学べる内容

• WordPress関数とテンプレートタグの基本的な役割
• テーマ制作で最初に覚えたい基本関数
• the_から始まる関数とget_から始まる関数の違い
• 関数を記述する主なテンプレートファイル
• WordPressループの基本的な仕組み
• 投稿タイトル・本文・日付・URLなどの表示と取得
• アイキャッチ画像やテーマ内画像の扱い方
• カテゴリー・タグ・カスタムタクソノミーに関する関数
• ページの種類を判定する条件分岐タグ
• ナビゲーションメニューを表示する方法
• functions.phpで使用する主な関数
• アクションフックやフィルターフックの基本
• ブロックエディターを拡張するときに使用する関数

コードは一つずつ暗記するのではなく、

ページを組み立てる関数
投稿情報を表示・取得する関数
表示するページを判定する関数
テーマに機能を追加する関数

WordPress関数とは

WordPress関数とは、WordPress本体に用意されている処理を、テーマファイルやプラグインから呼び出すための仕組みです。

通常のHTMLでは、見出しや本文を直接記述します。

<h1>記事タイトル</h1>
<p>ここに記事の本文を記述します。</p>

WordPressでは、投稿ごとにタイトルや本文が変わるため、関数を使って管理画面のデータを呼び出します。

<h1><?php the_title(); ?></h1>

<div class="entry-content">
	<?php the_content(); ?>
</div>

the_title()を記述した場所には投稿タイトルが表示され、the_content()を記述した場所には投稿本文が表示されます。

このようにWordPress関数を使うことで、1つのテンプレートファイルから、複数の投稿や固定ページを動的に表示できます。

WordPress関数でできること

WordPress関数には、次のような役割があります。

• header.phpやfooter.phpなどの共通パーツを読み込む
• 投稿タイトル・本文・日付・URLを表示する
• アイキャッチ画像を表示する
• 投稿を繰り返して一覧表示する
• トップページや個別投稿など、ページの種類を判定する
• ナビゲーションメニューを表示する
• CSSやJavaScriptを読み込む
• テーマにアイキャッチ画像やメニューなどの機能を追加する

まずは、

何を表示したいのか
どのファイルを読み込みたいのか
どのページで処理を行いたいのか

を考えて、目的に合う関数を調べながら使えるようになることが大切です。

最初に覚えたい20個のWordPress関数一覧

WordPressテーマ制作を始めると、多くの関数が登場します。

最初からすべて覚えようとせず、まずは次の20個を、役割ごとに確認しておきましょう。

テンプレートを組み立てる関数

基本的なテンプレート構成

<?php get_header(); ?>

<main>
	ページの内容
</main>

<?php get_sidebar(); ?>
<?php get_footer(); ?>

get_header()とget_footer()は、ほとんどのテンプレートファイルで使用します。

wp_head()は通常、header.phpの</head>直前に記述します。

<?php wp_head(); ?>
</head>

wp_footer()は、footer.phpの</body>直前に記述します。

<?php wp_footer(); ?>
</body>

これらがないと、WordPress本体やプラグインが追加するCSS・JavaScriptが正常に読み込まれない場合があります。

投稿を繰り返して表示する関数

have_posts()とthe_post()は、WordPressループの基本となる関数です。

<?php if ( have_posts() ) : ?>

	<?php while ( have_posts() ) : ?>
		<?php the_post(); ?>

		<article>
			<h2>
				<a href="<?php the_permalink(); ?>">
					<?php the_title(); ?>
				</a>
			</h2>

			<time datetime="<?php echo esc_attr( get_the_date( 'Y-m-d' ) ); ?>">
				<?php echo esc_html( get_the_date() ); ?>
			</time>

			<?php the_excerpt(); ?>
		</article>

	<?php endwhile; ?>

<?php else : ?>

	<p>投稿が見つかりませんでした。</p>

<?php endif; ?>

この一連の処理を、WordPressループと呼びます。

投稿一覧、検索結果、カテゴリー一覧、個別投稿など、WordPressの多くのテンプレートで使用されます。

画像・URL・サイト情報に関する関数

アイキャッチ画像は、設定されているかを確認してから表示すると安全です。

<?php if ( has_post_thumbnail() ) : ?>
	<div class="post-thumbnail">
		<?php the_post_thumbnail( 'large' ); ?>
	</div>
<?php endif; ?>

トップページへのリンクは、URLを直接書かずにhome_url()を使います。

<a href="<?php echo esc_url( home_url( '/' ) ); ?>">
	<?php bloginfo( 'name' ); ?>
</a>

テーマ内の画像を読み込む場合は、get_theme_file_uri()が便利です。

<img
	src="<?php echo esc_url(
		get_theme_file_uri( 'assets/images/logo.svg' )
	); ?>"
	alt="<?php echo esc_attr( get_bloginfo( 'name' ) ); ?>"
>

get_theme_file_uri()は、子テーマに同じファイルがある場合は子テーマ側を優先して取得します。

ページ判定とメニュー表示に関する関数

is_front_page()は、表示中のページがフロントページかどうかを判定します。

<?php if ( is_front_page() ) : ?>
	<p>トップページだけに表示する内容です。</p>
<?php endif; ?>

ナビゲーションメニューは、wp_nav_menu()を使って表示します。

<?php
wp_nav_menu(
	array(
		'theme_location' => 'global-navigation',
		'container'      => 'nav',
		'container_class'=> 'global-navigation',
	)
);
?>

メニューを表示するためには、先にfunctions.phpでメニュー位置を登録する必要があります。

the_系とget_系の違い

WordPressの関数には、名前の先頭にthe_が付くものと、get_が付くものがあります。

基本的には、次のように考えると分かりやすくなります。

例えば、投稿タイトルを扱う場合は、次の2つがあります。

<?php the_title(); ?>

the_title()は、投稿タイトルをその場所に表示します。

<?php
$title = get_the_title();
echo esc_html( $title );
?>

get_the_title()は投稿タイトルを文字列として取得します。
取得した値は、変数へ代入したり、条件分岐で使用したり、加工してから表示したりできます。

投稿URLを表示する場合

投稿へのリンクを作成するときは、the_permalink()を使えます。

<a href="<?php the_permalink(); ?>">
	<?php the_title(); ?>
</a>

the_permalink()は、現在の投稿URLをその場所に表示します。

一方、URLを変数へ保存したい場合は、get_permalink()を使用します。

<?php
$url   = get_permalink();
$title = get_the_title();
?>

<a href="<?php echo esc_url( $url ); ?>">
	<?php echo esc_html( $title ); ?>
</a>

URLをHTML属性へ出力するときは、esc_url()を使って安全に表示します。

アイキャッチ画像を扱う場合

アイキャッチ画像をそのまま表示する場合は、the_post_thumbnail()を使います。

<?php if ( has_post_thumbnail() ) : ?>
	<?php the_post_thumbnail( 'large' ); ?>
<?php endif; ?>

画像のHTMLを文字列として取得したい場合は、get_the_post_thumbnail()を使います。

<?php
$thumbnail = get_the_post_thumbnail(
	get_the_ID(),
	'large',
	array(
		'class' => 'post-thumbnail__image',
	)
);

if ( $thumbnail !== '' ) {
	echo $thumbnail;
}
?>

get_the_post_thumbnail()は、画像URLではなくimg要素を含むHTMLを返します。

アイキャッチ画像のURLだけを取得したい場合は、次の関数を使用します。

<?php
$thumbnail_url = get_the_post_thumbnail_url(
	get_the_ID(),
	'large'
);
?>

<?php if ( $thumbnail_url ) : ?>
	<img
		src="<?php echo esc_url( $thumbnail_url ); ?>"
		alt=""
	>
<?php endif; ?>

目的に応じて、画像そのものを表示するのか、HTMLを取得するのか、URLだけを取得するのかを使い分けましょう。

サイト名を扱う場合

サイト名を直接表示する場合は、bloginfo()を使います。

<p><?php bloginfo( 'name' ); ?></p>

サイト名を値として取得する場合は、get_bloginfo()を使います。

<?php
$site_name = get_bloginfo( 'name' );
?>

<p><?php echo esc_html( $site_name ); ?></p>

HTML属性の中で使用する場合も、一度取得してから適切なエスケープ処理を行うと安全です。

<img
	src="<?php echo esc_url(
		get_theme_file_uri( 'assets/images/logo.svg' )
	); ?>"
	alt="<?php echo esc_attr( get_bloginfo( 'name' ) ); ?>"
>

取得した値を表示するときはエスケープする

get_系の関数で取得した値は、echoを使って表示することが多くなります。

その際は、表示する場所に合わせてエスケープ関数を使います。

通常の文章を表示する場合です。

<h1>
	<?php echo esc_html( get_the_title() ); ?>
</h1>

URLを表示する場合です。

<a href="<?php echo esc_url( get_permalink() ); ?>">
	記事を見る
</a>

classやaltなどのHTML属性へ表示する場合です。

<div class="<?php echo esc_attr( $class_name ); ?>">
	内容
</div>

値を取得できることだけでなく、どこへ出力するかに合わせて安全に表示することも大切です。

1．WordPressループで使う関数

2．カテゴリー・タグ・タクソノミーの関数

3．ナビゲーションメニューの関数

4．functions.phpでよく使う関数

5．CSS・JavaScriptを読み込む関数