プラグインWooCommerceのwoocommerce_product_attribute_terms関数の使用方法・解説

概要

woocommerce_product_attribute_terms 関数は、WooCommerceで製品の属性に関連するタームを取得するために使用されます。この関数は、特にエクスプローラビリティやフィルタリング機能を強化するために、製品一覧や製品詳細ページにて属性を表示する際に役立ちます。具体的には以下のような場面でよく使われます。

商品のカスタムフィルターを作成する際
属性別の商品のサイドバーを作る時
製品詳細ページでの属性情報の表示の際
関連商品や特集商品に属性を関連付ける場合
Ajaxにより製品リストを動的に更新する際
カスタム商品検索機能を実装する場合

構文

woocommerce_product_attribute_terms( $attribute, $args = array() )

パラメータ

attribute (string) : タームを取得する属性の名前。
args (array) : オプションの引数を指定する配列。たとえば、タームの並べ替えやフィルタリング設定が含まれる。

戻り値

(array) : 指定された属性に関連するタームの配列。

使用可能なバージョン

WooCommerce バージョン： 4.0.0以降
WordPress バージョン： 5.2以降

この関数のアクションでの使用可能性

アクション	使用例がある
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

$terms = woocommerce_product_attribute_terms( 'color' );
foreach ( $terms as $term ) {
    echo '<div>' . esc_html( $term->name ) . '</div>';
}

このコードは、商品属性「color」に関連するタームを取得し、それぞれのターム名を表示します。主に製品のカラーバリエーションをユーザーに見せるために使用されます。

サンプルコード 2

$size_terms = woocommerce_product_attribute_terms( 'size', array( 'orderby' => 'name' ) );

このコードでは、属性「size」に関連するタームを名前で並べ替えて取得します。このようなオプションを使うことで、リストを必要な順序で表示することができます。

サンプルコード 3

$terms = woocommerce_product_attribute_terms( 'material', array( 'hide_empty' => false ) );
foreach ( $terms as $term ) {
    echo '<span>' . esc_html( $term->name ) . '</span>, ';
}

このコードは「material」属性に関連するタームを取得し、空でないタームも表示します。商品に使用されている素材をリストアップする際に便利です。

サンプルコード 4

$terms = woocommerce_product_attribute_terms( 'brand', array( 'orderby' => 'count' ) );
if ( ! empty( $terms ) ) {
    foreach ( $terms as $term ) {
        echo '<p>ブランド: ' . esc_html( $term->name ) . ' (' . $term->count . 'アイテム)</p>';
    }
}

このコードは属性「brand」に基づいて、各ブランドのアイテム数を含むタームを表示します。ブランド別に商品の数を示す際に役立ちます。

サンプルコード 5

$terms = woocommerce_product_attribute_terms( 'style' );
$term_links = array();
foreach ( $terms as $term ) {
    $term_links[] = '<a href="' . esc_url( get_term_link( $term ) ) . '">' . esc_html( $term->name ) . '</a>';
}
echo implode(', ', $term_links);

このコードは「style」属性に関連するタームを取得し、それぞれをリンクに変換して表示します。スタイル別の商品ページへのリンクを表示する際に使用されます。

これらのサンプルコードは、WooCommerceの機能を使って製品属性管理や表示のカスタマイズを容易にする方法を示しています。すべてのコードサンプルは著作権フリーで、学習や実践にご利用いただけます。

概要

構文