YARPPの関連記事をカスタマイズ|テンプレートの作成方法

WordPressのプラグイン『Yet Another Related Posts Plugin(以後、YARPPと表記)』では、現在の投稿や固定ページなどで、そのページに関連する記事を取得し表示することが出来ます。

YARPPでは、あらかじめ関連記事を表示するレイアウトが用意されていますが、今回は、YARPPのテンプレートを作成し、関連記事の出力を自由にカスタマイズさせる例となります。

YARPPのテンプレートを作成して関連記事をカスタマイズさせる例

以下がYARPPのテンプレートを作成して関連記事をカスタマイズさせる手順となります。

YARPPのテンプレートを作成

まずは、YARPPのテンプレートを作成します。方法としては、作成するテンプレートのファイル名を「yarpp-template-」から始まるファイル名にすることで、YARPPのテンプレートファイルとなります。そして、作成したファイルはテーマフォルダの直下に配置します。

今回は例として、YARPPのテンプレートのファイル名を「yarpp-template-my-template.php」としました。そのテンプレートファイルに内に関連記事を出力するソースコードを記述します。以下がソースコードの例となります。

<?php if (have_posts()):?>
<div class="related">
	<h2 class="related-title">関連する記事</h2>
	<ul>
	<?php while (have_posts()) : the_post(); ?>
		<li>
			<a href="<?php the_permalink() ?>" rel="bookmark">
				<p class="entry-title"><?php echo get_the_title(); ?></p>
                <?php echo get_the_post_thumbnail( $post->ID, 'thumbnail' ); ?>
			</a>
		</li>
	<?php endwhile; ?>
	</ul>
</div>
<?php endif; ?>

yarpp_related() 関数で関連記事を表示

次に、上記で作成したテンプレートファイルを適用し関連記事を表示させます。方法は、yarpp_related関数を、関連記事を表示したい場所に記述します。以下がソースコードの例となります。

<?php
$args = array(
	// 関連記事を表示する最大件数
    'limit'    => 3, 
    // 使用するテンプレートの名前を指定
    'template' => 'yarpp-template-my-template.php',
);
yarpp_related($args);
?>

yarpp_related() 関数では、パラメータを指定することで、クエリを変更し指定した条件の関連記事を表示することができます。パラメータを指定しない場合は、WordPress管理画面のYARPPの設定で、指定した条件によって関連記事が表示されます。

yarpp_related() 関数の他のパラメータについては、以下のリンク先を参考にしてみてください。

コメントまたはTwitterで返信

コメントは、以下の項目(*は必須項目)を入力し「コメントを送信」ボタンから送信お願いします。メールアドレスは公開されることはありません。Twitterで返信する場合はコチラから。