概要
woocommerce_template_directory 関数は、WooCommerce において、特定のテンプレートファイルを含むディレクトリパスを取得するために使用されます。この関数は、テーマやプラグインでカスタムテンプレートを操作する際によく利用され、以下のような機能を実装する際に役立ちます。
- 商品ページのカスタマイズ
- チェックアウトページのレイアウト変更
- カスタムウィジェットの作成
- 商品リストの表示形式の調整
- 管理画面でのカスタムテンプレートの表示
- ストアのデザインを変更するためのスタイルシートの適用
構文
woocommerce_template_directory( $sub_directory = '' );
パラメータ
- $sub_directory (string, optional): テンプレートディレクトリ内のサブディレクトリ名。デフォルトは空文字列。
戻り値
- (string): 指定されたサブディレクトリを含むテンプレートディレクトリのパス。
使用可能なバージョン
- WooCommerce バージョン: 3.0 以上
- 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: テンプレートディレクトリへのパスを取得する
$template_dir = woocommerce_template_directory();
echo $template_dir; // WooCommerceのテンプレートディレクトリのパスを表示します。
このサンプルコードは、WooCommerce のテンプレートディレクトリのパスを取得し、そのパスを表示します。
サンプルコード2: サブディレクトリを指定してパスを取得する
$cart_template_dir = woocommerce_template_directory('cart');
echo $cart_template_dir; // カート関連のテンプレートディレクトリのパスを表示します。
この例では、カートのサブディレクトリのパスを取得し表示しています。
サンプルコード3: カスタムテンプレートを読み込む
include( woocommerce_template_directory() . '/my-custom-template.php' );
このサンプルは、WooCommerce のカスタムテンプレートを読み込む方法を示しています。
サンプルコード4: テンプレートディレクトリでの条件分岐
if ( is_product() ) {
include( woocommerce_template_directory() . '/product-template.php' );
}
製品ページで特定のテンプレートを読み込む条件分岐の例です。
サンプルコード5: テンプレートのパスをURL形式に変換する
$template_url = str_replace( $_SERVER['DOCUMENT_ROOT'], '', woocommerce_template_directory() );
echo site_url() . $template_url; // テンプレートディレクトリへのURLを表示します。
このサンプルは、テンプレートディレクトリのパスをサイトのURL形式に変換して表示します。