WordPress 読了 3 分

【WordPress】get_template_part関数

WordPressではget_template_part関数に引数を渡すことができます。
この機能は、WordPressのバージョン5.5以降に追加されました。これにより、テンプレートパーツにデータを渡すことが可能になり、より柔軟なテンプレート設計が実現されました。

get_template_part関数の基本的な使い方

get_template_part関数は、以下のように3つの引数を受け取ります。

get_template_part( string $slug, string $name = null, array $args = null )
  • $slug: 読み込むテンプレートパーツの基本名（必須）。
  • $name: 特定のテンプレート名（オプション）。
  • $args: テンプレートに渡す配列（オプション）。

引数の渡し方の例

以下は、引数を渡してテンプレートパーツを読み込む例です。

$args = array(
    'title' => 'Apple',
    'price' => 100,
);

get_template_part('template-parts/product', null, $args);

この場合、template-parts/product.phpファイル内で、渡された引数は次のようにアクセスできます。

<?php
$title = $args['title'];
$price = $args['price'];

echo "<h1>{$title}</h1>";
echo "<p>Price: {$price}</p>";
?>

引数を渡す利点

  • 再利用性の向上: 同じテンプレートパーツを異なるデータで再利用できるため、コードの重複を減らすことができます。
  • 動的なコンテンツ生成: テンプレートパーツ内で動的にコンテンツを生成することができ、より柔軟なデザインが可能になります。

まとめ

get_template_part関数を使用することで、WordPressのテンプレートシステムをより効率的に活用できるようになりました。引数を渡すことで、テンプレートパーツの再利用性が向上し、動的なコンテンツ生成が可能になります。これにより、開発者はよりクリーンでメンテナンスしやすいコードを書くことができます。

参考サイト

https://stackoverflow.com/questions/51569217/wordpress-get-template-part-pass-variable

https://satoshimurata.com/wordpress-get-template-part-args

https://ishilog.net/get-template-part-variable/

関連する notes