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

概要

woocommerce_is_attribute_in_product_name関数は、WooCommerceの製品名に特定の属性が含まれているかどうかを確認するための関数です。この関数は、製品の属性を動的に管理し、製品表示をカスタマイズする際に役立ちます。以下のような機能を実装する際によく使用されます。

1. 製品名に属性情報を表示するカスタマイズ
2. 検索結果やフィルタリング結果の改善
3. 製品概要に基づくコンテンツの動的生成
4. 製品の表示スタイルやレイアウトの調整
5. 特定の属性に基づいたプロモーションの実施
6. カスタマーエクスペリエンスの向上

構文

woocommerce_is_attribute_in_product_name( $attribute, $product_name );

パラメータ

• $attribute (string): チェックしたい属性の名前。
• $product_name (string): 確認する製品名。

戻り値

• bool: 属性が製品名に含まれている場合はtrueを返し、含まれていない場合はfalseを返す。

WooCommerce バージョン

この関数はWooCommerceバージョン 2.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: 製品名に属性を追加する

このコードは、WooCommerce製品のタイトルに「色」属性を追加し、特定のテキストとして表示します。

add_filter( 'the_title', 'add_color_attribute_to_product_title', 10, 2 );

function add_color_attribute_to_product_title( $title, $id ) {
    if ( 'product' === get_post_type( $id ) ) {
        $color = get_post_meta( $id, '_color_attribute', true ); // 色属性を取得
        if ( ! empty( $color ) ) {
            $title .= ' - ' . $color; // 色を製品名に追加
        }
    }
    return $title;
}

(参照先: https://developer.woocommerce.com/)

サンプル2: 属性が製品名に含まれているか確認する

このコードは、製品名に「サイズ」属性が含まれているかをチェックし、条件に応じてメッセージを表示します。

add_action( 'woocommerce_after_shop_loop_item_title', 'check_size_in_product_title', 5 );

function check_size_in_product_title() {
    global $product;
    $product_name = $product->get_name();
    if ( woocommerce_is_attribute_in_product_name( 'size', $product_name ) ) {
        echo '<p>この製品は指定されたサイズを持っています。</p>';
    }
}

(参照先: https://woocommerce.com/)

サンプル3: 属性に基づくメッセージを表示

このコードは、異なる属性に基づいて異なるメッセージを製品ページに表示します。

add_action( 'woocommerce_single_product_summary', 'show_custom_message_based_on_attribute', 15 );

function show_custom_message_based_on_attribute() {
    global $product;
    $product_name = $product->get_name();

    if ( woocommerce_is_attribute_in_product_name( 'color', $product_name ) ) {
        echo '<div class="alert">この製品は特別な色です！</div>';
    }
}

(参照先: https://woocommerce.com/)

サンプル4: 製品フィルターで属性を使用する

このコードは、製品フィルターに属性を使用して、特定の属性を選択した場合のみ製品を表示します。

add_action( 'pre_get_posts', 'filter_products_by_attribute' );

function filter_products_by_attribute( $query ) {
    if ( is_post_type_archive( 'product' ) && $query->is_main_query() ) {
        $query->set( 'meta_query', array(
            array(
                'key' => '_size_attribute',
                'value' => 'M',
                'compare' => 'LIKE'
            )
        ));
    }
}

(参照先: https://woocommerce.com/)

サンプル5: 商品ページのタイトルをカスタマイズする

このコードは、特定の商品のタイトルをカスタマイズして、選択した属性が含まれている場合に特別なテキストを追加します。

add_filter( 'the_title', 'customize_product_title', 10, 2 );

function customize_product_title( $title, $id ) {
    if ( 'product' === get_post_type( $id ) ) {
        $is_in_title = woocommerce_is_attribute_in_product_name( 'weight', $title );
        if ( $is_in_title ) {
            $title .= ' (特別オファー中)';
        }
    }
    return $title;
}

(参照先: https://woocommerce.com/)