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

the_post()

基本構文と使い方(引数・実行結果)

基本構文

処理対象の記事をセットします。セットされた記事は、記事を処理するテンプレートタグ(例:the_title()など)を実行したときの処理対象となります。

the_post();

引数

なし。

実行結果

処理対象の記事をセットします。その後、内部的にループのポインタを次の投稿へ進めます。(詳しくは下記例を参照ください。)

例1.WordPressループの構文

下記の例では、メインクエリで取得した記事一覧データを、while 文で1件ずつループして処理しています。ループ内で the_post() が実行されると、現在の記事データがグローバル変数 $post にセットされ、テンプレートタグが参照できる状態になります。それにより、the_title() などのテンプレートタグを使って、現在の記事のタイトルや本文を出力することができます。

また、the_post() は処理対象の記事をセットした後、内部的にループのポインタを次の投稿へ進めます。そのため、コード例の2行目のhave_posts()は、2回目以降のループにおいても常に次の投稿が存在するかどうかを正しく判定することができます。(the_post()がポインタを次に進めなければ永遠と同じ記事を処理してしまいます。)

<?php if (have_posts()) : ?>
	<?php while (have_posts()) : ?>
		<?php the_post(); ?>
		<?php the_title(); ?>
	<?php endwhile; ?>
<?php endif; ?>

学習者向け補足情報

【引数とは】
テンプレートタグ(=関数)を実行する際に、引数を渡すことができるテンプレートタグがあります。引数は、関数の中で使われるので、渡す引数の値によって実行結果が変わってきます。何を処理したいのか、どのようなデータを取得したいのかによって渡す引数が変わります。

【引数について】

  • 指定できる引数の数はテンプレートタグによって異なります。(引数なしもあり)
  • 引数ごとに必須 / 任意が決まっています。(必須は必ず指定、任意は指定しなければ初期値)
  • 引数名(例:$post)は仕様の便宜上の名前と考えてください。(この名前自体はテンプレートタグ実行に関係しません。各引数に何を指定するのかを理解していればOKです。)

参考コード

例えばarchive.phpで記事一覧ページを作成する場合に、下記のようなコードで記事一覧を表示します。

<?php if (have_posts()): ?>
	<ul class="cards">
		<?php while (have_posts()): ?>
			<?php the_post(); ?>
			<li class="cards__item card">
				<a class="card__link" href="<?php the_permalink(); ?>">
					<div class="card__data">
						<div class="card__img">
							<?php if (has_post_thumbnail()) : ?>
								<?php the_post_thumbnail(); ?>
							<?php endif; ?>
						</div>
						<div class="card__date"><?php echo get_the_date('') ?></div>
						<div class="card__title"><?php the_title(); ?></div>
					</div>
				</a>
			</li>
		<?php endwhile; ?>
	</ul>
<?php endif; ?>

※当サイトでは初期値とデフォルト値の言葉の定義を区別せず、原則統一して初期値を採用しています。

関連するテンプレートタグ

テンプレートタグ 説明
get_search_query() 検索キーワードを取得する。
get_post_type() 記事が所属する投稿タイプの名前を返す。
get_queried_object_id() 現在のクエリ(DBへの問い合わせ条件)に関するオブジェクトのIDを返す。
get_queried_object() 現在のクエリ(DBへの問い合わせ条件)に関するオブジェクトを返します。
the_posts_pagination() アーカイブページ(記事一覧ページ)にてページネーションを表示します。
get_the_posts_pagination() アーカイブページ(記事一覧ページ)にて利用可能なページネーションを取得します。
get_posts() 指定した条件にマッチする記事オブジェクトの配列を取得する。
get_post() 指定した投稿情報を取得する。
wp_reset_postdata() サブクエリによって上書きされたグローバルオブジェクト$postをリセットしてメインクエリに戻します。
have_posts() 記事が存在するかどうか調べて真偽値を返します。