プラグインWooCommerceのwoocommerce_related_productsフィルタの使用方法・解説

概要

woocommerce_related_products フィルタは、WooCommerce プラグインで関連商品をカスタマイズするために使用されるフックです。このフィルタを使うことで、表示される関連商品の数や条件を変更したり、特定の商品を除外したりすることが可能です。以下はこのフィルタがよく使われる機能の例です。

関連商品の表示数を変更
特定の商品を関連商品から除外
カスタム条件に基づいた関連商品の取得
デフォルトの関連商品を置き換え
属性に基づく関連商品のフィルタリング
関連商品の表示順序の変更

フィルタの概要

構文: add_filter('woocommerce_related_products', 'custom_function', 10, 2);
パラメータ:
- $related_posts: 取得された関連商品の配列
- $product_id: 現在の商品の ID
戻り値: 修正された関連商品の配列
利用可能なプラグインのバージョン: 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

サンプルコード

以下にwoocommerce_related_products フィルタのサンプルコードを示します。

サンプルコード1: 関連商品の表示数を変更

function custom_related_products_limit( $related_posts, $product_id ) {
    return array_slice( $related_posts, 0, 4 ); // 最初の4つの関連商品だけを表示
}
add_filter( 'woocommerce_related_products', 'custom_related_products_limit', 10, 2 );

このコードは、関連商品の数を4に制限します。

サンプルコード2: 特定の商品を関連商品から除外

function exclude_specific_related_products( $related_posts, $product_id ) {
    // 除外したい商品IDの配列
    $excluded_ids = array( 12, 34, 56 );
    return array_diff( $related_posts, $excluded_ids ); // 除外商品を取り除く
}
add_filter( 'woocommerce_related_products', 'exclude_specific_related_products', 10, 2 );

このコードは、関連商品から特定の商品を除外します。

サンプルコード3: カスタム条件に基づく関連商品の取得

function custom_conditions_related_products( $related_posts, $product_id ) {
    global $product;
    if ( $product->get_category_ids() ) {
        // カテゴリに基づく関連商品をフィルタリング
        $related_posts = array_filter( $related_posts, function( $post_id ) {
            return has_term( '特定のカテゴリ', 'product_cat', $post_id );
        });
    }
    return $related_posts;
}
add_filter( 'woocommerce_related_products', 'custom_conditions_related_products', 10, 2 );

このコードは、特定のカテゴリに基づいて関連商品をフィルタリングします。

サンプルコード4: デフォルトの関連商品を置き換え

function replace_related_products( $related_posts, $product_id ) {
    return array( 789, 1011 ); // 別の商品のIDを設定
}
add_filter( 'woocommerce_related_products', 'replace_related_products', 10, 2 );

このコードは、デフォルトの関連商品を指定した商品に置き換えます。

サンプルコード5: 関連商品の表示順序の変更

function reorder_related_products( $related_posts, $product_id ) {
    // ランダムな順序で表示
    shuffle( $related_posts );
    return $related_posts;
}
add_filter( 'woocommerce_related_products', 'reorder_related_products', 10, 2 );

このコードは関連商品の表示順序をランダムに変更します。

概要