概要
wc_get_template_part 関数は、WooCommerce テンプレートの柔軟な管理を目的として提供されている関数です。一般的には、製品ページやカート、チェックアウトプロセスなどの WooCommerce 機能をカスタマイズする際に利用されます。この関数は、特定のテンプレートファイルを読み込むことができ、必要に応じてオーバーライドすることも可能です。以下のような機能実装時によく使われます：
- 製品リストの表示
- カート内容の表示
- チェックアウトページのカスタマイズ
- 顧客情報入力フォームの表示
- 自作のウィジェットやショートコードからのテンプレートのロード
- フィルターやアクションと組み合わせた高度なカスタマイズ
構文
wc_get_template_part( $slug, $name = null );
パラメータ
$slug(string) – 読み込むテンプレートのスラッグ。$name(string|null) – 特定の名前を持つテンプレートを指定する。省略可能。
戻り値
この関数は、指定されたテンプレート部分を含む HTML を返します。
使用可能な WooCommerce バージョン
wc_get_template_part は WooCommerce バージョン 2.1.0 以降で使用可能です。
使用可能な WordPress バージョン
WordPress 4.0 以降での使用が推奨されています。
この関数のアクションでの使用可能性
| アクション | 使用可能性 |
|---|---|
| mu_plugin_loaded | |
| registered_post_type | |
| plugins_loaded | |
| wp_roles_init | |
| setup_theme | |
| after_setup_theme | |
| set_current_user | |
| init | |
| register_sidebar | |
| wp_loaded | |
| send_headers | |
| parse_query | |
| pre_get_posts | |
| wp | |
| template_redirect | 〇 |
| get_header | |
| wp_head |
サンプルコード
サンプルコード 1
wc_get_template_part( 'content', 'product' );
このコードは、WooCommerce の製品内容を表示するためのテンプレート部分をロードします。たとえば、製品のリストやグリッドで表示するために役立ちます。
サンプルコード 2
wc_get_template_part( 'cart/cart', 'empty' );
このコードは、カートが空である場合に表示される特定のテンプレート部分を読み込みます。ユーザーにカートが空であることを伝えるために使用します。
サンプルコード 3
wc_get_template_part( 'checkout/form', 'billing' );
この例では、チェックアウトプロセスの請求情報入力フォームのテンプレート部分を取得しています。これにより、フォームをカスタマイズできます。
サンプルコード 4
wc_get_template_part( 'loop/loop', 'shop' );
このコードは、ショップページで表示されるループに関連するテンプレート部分を読み込むために使います。商品リストの表示に関連しています。
サンプルコード 5
wc_get_template_part( 'myaccount/form', 'login' );
この例では、WooCommerce のマイアカウントページにおけるログインフォームのテンプレート部分を取得します。ユーザーがアカウントにログインする際に必要です。
これらのサンプルは、WooCommerce のカスタマイズや機能拡張においてどのように wc_get_template_part を利用できるかを示しています。それぞれのコードが異なるシチュエーションでのテンプレート読み込みに使用されることを理解するのに役立つでしょう。