HUSKY - WooCommerce Product Filter Professional

WooCommerce AJAXフィルターで商品グリッドが崩れる原因と対処法

最初のフィルタークリックまでは、ショップは正しく表示されています。ところがその後、3列が4列になる、行に隙間ができる、商品カードからテーマのバッジやボタンが消える、サイドバーが商品の下に回り込む、といった現象が起きます。WooCommerceのAJAXフィルターが商品グリッドのレイアウトを崩す場合、商品自体は正しく、変わっているのはそれを描画するHTMLです。以下では、HUSKYのAJAXモードが何を置き換えるのか、なぜテーマ固有のマークアップが途中で失われるのか、症状ごとの対処法を説明します。

AJAXモードが置き換えるものと、コピーできないもの

ショップをAJAX化する(Try to ajaxify the shop) を はい(Yes) に設定する(WooCommerce → 設定 → Products Filter → オプション(Options))と、プラグインはショップページとカテゴリーページの商品エリアを区切ります。フック woocommerce_before_shop_loop(優先度2)でコンテナー <div class="woocommerce woocommerce-page woof_shortcode_output"> を開き、その内側に <div id="woof_results_by_ajax"> を置きます。そして woocommerce_after_shop_loop(優先度10)で両方を閉じます。

訪問者がフィルターを変更すると、スクリプトはアクション woof_draw_products を指定して /wp-admin/admin-ajax.php にリクエストを送ります。サーバーは [woof_products is_ajax=1] を描画し、スクリプトがコンテナーをその結果に差し替えます。この結果は、WooCommerce標準の部品だけで作られます。

  • woocommerce_before_shop_loop フック(通知、結果件数、並べ替えのドロップダウン)
  • woocommerce_product_loop_start()。<ul class="products columns-N"> を出力します
  • 各商品の content-product.php テンプレートパーツ
  • woocommerce_product_loop_end() と woocommerce_after_shop_loop フック(ページネーション)

ここから2つのことが分かります。1つ目は、テーマのアーカイブテンプレートが2つのフックの間で自前で出力するもの(追加のラッパー、グリッドのクラス、ビルダーのループスキン)は、新しいHTMLには含まれないということです。2つ目は、新しいHTMLがショップページではなく、admin-ajaxのリクエストの中で生成されるということです。ショップページの読み込み中に実行されるコード、つまり wp や template_redirect アクション、アーカイブテンプレートの内部、あるいは is_admin() がfalseのときだけ動くコードは、このリクエストでは実行されません。ページの読み込み時に一度だけグリッドにスタイルを適用していたテーマのスクリプトも、再実行されません。

変化を調べる:前後のマークアップを比較する

プライベートウィンドウでショップを開き、最初の商品を右クリックして 検証(Inspect) を選びます。ul.products、その親要素、最初の li.product のクラスを控えておきます。フィルターを適用して、同じ場所をもう一度検証します。違いが対処法を示します。

フィルター後の症状原因セクション
列数が変わる。columns-3 が columns-4 になるテーマの列数設定がAJAXリクエストで適用されない列と隙間
3個、1個、3個の行になる。グリッドに隙間ができる行のクラス first/last が別の列数で計算されている列と隙間
サイドバーやフッターが移動する、消える、繰り返される。商品が2回表示されるテーマがループの前後で2つのショップループフックを呼び出していないショップループフック
ul.products のクラスがなくなる。ボタンやバッジが元に戻る。グリッド/リスト表示が失われる。画像が空白になるテーマのマークアップ、PHPの条件、テーマのスクリプトテーマのカード機能

フィルター後に商品の列数が変わり、隙間ができる

[woof_products] は、WooCommerceの loop_shop_columns フィルターから列数を取得します。このフィルターは、外観 → カスタマイズ → WooCommerce → 商品カタログ の 1行あたりの商品数(Products per row) にフォールバックします。独自の列数オプションを持つテーマは、多くの場合それをショップページの読み込み中にだけ適用します。AJAXリクエストではそのコードが実行されないため、結果にはWooCommerceの値が使われます。ショップでは3列なのに4列になる、というのがよくある例です。

隙間の原因も同じです。WooCommerceは各行の最初の商品にクラス first、最後の商品にクラス last を付けますが、これはその列数から計算されます。従来のフロートグリッドは first のたびに新しい行を始めます。テーマのCSSが1行3商品に合わせてあるのに、AJAXのHTMLが4で数えていると、4番目の商品ごとに新しい行が強制されます。3商品、次に1商品だけ、また3商品、という並びになります。

列数は、すべてのリクエストで共通になるよう、デスクトップでショップに表示される数に一度設定してください。

/**
 * Same number of columns on shop pages and in HUSKY AJAX results.
 * Child theme functions.php or a code snippets plugin.
 */
add_filter( 'loop_shop_columns', function () {
    return 3; // products per row on desktop
}, 999 );

これを is_shop() などの条件で囲まないでください。AJAXリクエストでスキップされてしまいます。優先度999により、テーマ自身のフィルターよりも優先されます。短いFAQ フィルター結果を指定した列数で表示する でも、同じフィルターを使っています。カスタムページでは、[woof_products columns=3] で数を直接指定できます。スマートフォンとタブレットは、どちらの場合もテーマのCSSメディアクエリでスタイルが決まります。

フィルター後にクラスが columns-3 になっているのに幅がまだおかしい場合、テーマは差し替え範囲の外側にある独自のラッパーのクラスで商品のサイズを決めています。外観 → カスタマイズ → 追加CSS、またはプラグインの カスタムCSSコード(Custom CSS code) フィールド(詳細設定 → コード)に、AJAXコンテナー用のCSSを追加してください。

/* HUSKY AJAX results: 3 products per row in a float-based grid */
#woof_results_by_ajax ul.products li.product {
    width: 30.75%;
    margin-right: 3.8%;
    clear: none;
}
#woof_results_by_ajax ul.products li.product:nth-child(3n) {
    margin-right: 0;
}
#woof_results_by_ajax ul.products li.product:nth-child(3n+1) {
    clear: both;
}

テーマが ul.products をフロートではなくCSSグリッドでレイアウトしている場合は、次の1つのルールで十分です:#woof_results_by_ajax ul.products { grid-template-columns: repeat(3, 1fr); }。テーマがスマートフォンでは列数を減らしている場合は、どちらの方式もデスクトップ用のメディアクエリで囲んでください。

サイドバーが商品の下に回る、フッターが崩れる、結果が二重になる:ショップループフック

AJAXモードでは、テーマが商品リストの直前で woocommerce_before_shop_loop、直後で woocommerce_after_shop_loop を、WooCommerce標準のテンプレートと同じように呼び出している必要があります。そうなっていない場合は次のようになります。

  • 閉じるフックがない。 2つのコンテナーは閉じられず、ブラウザーは親要素の終わりでやっとそれらを閉じます。サイドバー、2番目の列、フッターが商品エリアの内側に入り込みます。ページの読み込み時点でサイドバーが商品の下にあることがよくあり、最初のフィルタークリックの後は、フィルターを含むサイドバーも含め、コンテナー内のすべてが結果に置き換わります。
  • フックが別の場所で呼び出されている。 テーマがツールバーでフックを呼び出し、商品ループを woocommerce_after_shop_loop の後に出力していると、AJAXの結果はコンテナーに入り、元のグリッドはその下に残るため、商品が2回表示されます。
  • テーマのラッパーがコンテナーをまたいでいる。 テーマが woocommerce_before_shop_loop で開き、woocommerce_after_shop_loop で閉じる要素は、HUSKYのコンテナーの完全な内側(優先度2の後に開き、優先度10の前に閉じる)か、完全な外側になければなりません。その中間にあると、コンテナーと重なってネストが壊れます。

確認するには、ページのソース(Ctrl+U)を開いて woof_results_by_ajax を検索し、そこから下のHTMLをたどります。商品とページネーションの閉じタグ </ul> の後、サイドバーやフッターが始まる前に、</div> が2つなければなりません。テーマのフォルダーでは、アーカイブテンプレートから woocommerce_after_shop_loop を検索します。AJAXモードで動作するテンプレートの商品部分は、WooCommerce自身の archive-product.php のようになっています。

<?php
if ( woocommerce_product_loop() ) {
    do_action( 'woocommerce_before_shop_loop' );

    woocommerce_product_loop_start();
    if ( wc_get_loop_prop( 'total' ) ) {
        while ( have_posts() ) {
            the_post();
            do_action( 'woocommerce_shop_loop' );
            wc_get_template_part( 'content', 'product' );
        }
    }
    woocommerce_product_loop_end();

    do_action( 'woocommerce_after_shop_loop' );
} else {
    do_action( 'woocommerce_no_products_found' );
}

変更はテンプレートの子テーマ用コピーで行うか、テーマの作者に不足しているフックの追加を依頼してください。ページビルダーのレイアウトが両方のフックを呼び出すことはまれです。その場合は、後述のリダイレクトモードが現実的な選択です。商品がまったく変わらない場合は フィルターのURLは変わるのに商品が変わらない場合、Elementorのテンプレートについては ElementorのLoop Gridとアーカイブテンプレートでフィルターが機能しない場合 で説明しています。

テーマのカード機能が失われる:バッジ、ボタン、グリッドのクラス、スクリプト

PHPがショップページでしか行わない変更

カートに追加ボタンを隠す、カテゴリーの行やバッジを追加するといったコードで、wp や template_redirect の中で is_shop() を使ってそれを判断している場合、AJAXリクエストでは実行されないため、フィルター後はデフォルトのカードに戻ります。HUSKYのリクエストでも実行させてください。admin_init は、すべてのadmin-ajaxリクエストで発火します。

/**
 * Card changes for shop pages AND for HUSKY AJAX results.
 * Child theme functions.php or a code snippets plugin.
 */
function my_shop_card_changes() {
    // Example: no add-to-cart buttons in the product grid
    remove_action( 'woocommerce_after_shop_loop_item', 'woocommerce_template_loop_add_to_cart', 10 );
}

// Normal page loads of the shop and product archives
add_action( 'wp', function () {
    if ( is_shop() || is_product_taxonomy() ) {
        my_shop_card_changes();
    }
} );

// HUSKY AJAX filtering, sent through admin-ajax.php
add_action( 'admin_init', function () {
    if ( wp_doing_ajax() && isset( $_REQUEST['action'] ) && 'woof_draw_products' === $_REQUEST['action'] ) {
        my_shop_card_changes();
    }
} );

カードを変えるテーマのオプション(カテゴリーの行、ホバー画像、クイックビューボタン)も、テーマの内部で同じ方法で適用されていることが少なくありません。フィルター後にそれらが消え、AJAXリクエストも対象にするフックがテーマにない場合は、リダイレクトモードを使ってください。

テーマが商品リストに追加するクラス

比較した結果、ページの読み込み時には ul.products にあるクラスが、フィルター後になくなっている場合は、woof_draw_products_html フィルターでAJAXレスポンスに追加します。このフィルターは、ブラウザーに送られる直前のHTMLを受け取ります。

/**
 * Add the theme's grid class to the product list in HUSKY AJAX results.
 * Child theme functions.php or a code snippets plugin.
 */
add_filter( 'woof_draw_products_html', function ( $html, $shortcode_str ) {
    return str_replace(
        '<ul class="products columns-',
        '<ul class="products my-theme-grid columns-', // use the class from your page
        $html
    );
}, 10, 2 );

検索する文字列は、WooCommerce自身の loop/loop-start.php に一致します。テーマがそのファイルを上書きしている場合は、ページのソースから開始タグをコピーしてください。テーマが content-product.php 以外のテンプレートパーツでカードを描画している場合は、woof_template_part フィルターでその名前を返します。値 product-grid は、テーマの woocommerce フォルダーから content-product-grid.php を読み込みます。

テーマのスクリプト:遅延読み込み画像、高さ揃え、Masonry、クイックビュー

ページの読み込み時に一度だけ実行されるスクリプト(遅延読み込み画像、カードの高さ揃え、Masonry、グリッド/リスト切り替え、クイックビューボタン)は、新しい商品を認識しません。HUSKYは、差し替えのたびにjQueryイベント woof_ajax_done を発火します。テーマの初期化呼び出しをここに置いてください。テーマのJSファイルでも、AJAX完了後のJavaScriptコード(JavaScript code after AJAX is done)(詳細設定 → コード)でも構いません。関数名はテーマの作者に尋ねられます。このイベントの詳細は woof_ajax_done を参照してください。

jQuery(document).on('woof_ajax_done', function () {
    // Many layout scripts recalculate on resize
    jQuery(window).trigger('resize');
    // Call your theme's own init function here if it has one
});

結果件数や並べ替えが二重に表示される

商品エリアの外側に独自の件数と並べ替えバーを出力するテーマでも、AJAXの結果の内側にWooCommerceのデフォルトのコピーが含まれることがあります。内側のコピーは、本当に重複している場合にだけ隠してください。

#woof_results_by_ajax .woocommerce-result-count,
#woof_results_by_ajax .woocommerce-ordering {
    display: none;
}

エリアの外側にあるテーマ自身の件数がフィルター後に更新されない場合は、そのCSSセレクターを 結果件数のCSSセレクター(Result count css selector)(詳細設定 → オプション)に入力してください。プラグインはAJAXレスポンスのたびに新しい件数を送り、見つかった要素を置き換えます。

AJAXをやめるとき:リダイレクトモードとターボモード

標準のWooCommerceの部品からは再構築できないレイアウトもあります。ビルダーのループスキン、カルーセル、フックのないテーマのテンプレートなどです。その場合は ショップをAJAX化する(Try to ajaxify the shop) を いいえ(No) に設定してください。フィルターを変更するたびにフィルター済みのURLが読み込まれ、テーマがページ全体をいつもどおり描画するため、グリッドはフィルターなしのショップと同じになります。失われるのは、ページ内での更新です。クリックのたびではなく検索ごとに1回だけ再読み込みしたい場合は、自動送信(Autosubmit) を いいえ(No) に設定して、フィルターがボタンを待つようにしてください。訪問者を結果の位置に着地させる方法は、リダイレクトモードでの商品への自動スクロール を参照してください。

ショップをAJAX化する(Try to ajaxify the shop) が はい(Yes) に戻ってしまう場合は、ターボモード がオンになっています。ターボモードはページを読み込むたびにAJAXモードをオンにします。まずそのタブで ターボモードを有効にする(Enable turbo mode) を いいえ(No) に設定してからAJAXをオフにし、訪問者に新しい設定が届くようにページキャッシュを削除してください。

チェックリスト

  • ブラウザーのインスペクターで、フィルターの前後のマークアップを比較した。
  • loop_shop_columns が、ページの条件なしでショップの列数を返している。
  • ページのソースで、HUSKYの2つのコンテナーが商品とページネーションの直後に閉じている。
  • PHPによるカードの変更が woof_draw_products リクエストでも実行され、テーマのスクリプトが woof_ajax_done で再実行される。
  • それでもレイアウトが異なる場合:ターボモードをオフにしてキャッシュを削除したうえで、ショップをAJAX化する(Try to ajaxify the shop) = いいえ(No) にする。

Storefrontなどのデフォルトテーマでありながら、HUSKYだけを有効にしてもレイアウトが崩れる場合は、ショップページへのリンクと、フィルター後に何が変わるかの説明を添えて、HUSKYサポートフォーラム でトピックを作成してください。