HUSKY - WooCommerce Product Filter Professional

HUSKYターボモードが動かない:グレーアウトと商品の欠落

HUSKYのターボモードが動かない場合、症状は一見まったく無関係に見えます。フィルターがグレーアウトしたままになる、カテゴリーで商品が1件も返らない、新しい商品がいつまでも表示されない、件数が合わない、AJAXモードをオフにできない、といったものです。ほとんどは1つの設計上の仕様に由来します。ターボモードでは、フィルタリングが訪問者のブラウザー上で、あらかじめ作成された商品データのファイルに対して行われます。以下では、そのファイルがどのように作られ、どのように使われるのかと、症状ごとの対処法を説明します。

ターボモードの仕組みと、使う価値がある場面

通常モードでは、フィルターをクリックするたびにサーバーがWooCommerceのクエリを実行し、すべての用語について商品数をカウントします。ターボモードはこの処理をブラウザーに移します。HUSKYは、公開済みのすべての商品とそのバリエーションを1つのJSONファイル(デフォルトでは wp-content/uploads/uploads_woof_turbo_mode/)に書き出します。ファイルには、ID、タイトル、SKU、価格、在庫ステータス、各商品タクソノミーの用語、メタフィルターフィールドの値が含まれます。ブラウザーは、プラグインが動作するフロントエンドのすべてのページでこのファイルをダウンロードし(対象ページは 詳細設定(Advanced) タブの 次のサイトページでのみプラグインを初期化する(Init plugin on the next site pages only) で制限できます)、条件に一致する商品を見つけて件数を描画します。サーバーは、見つかった商品をIDにもとづいて表示するだけです。

そのため、結果はファイルの鮮度を超えて新しくなることはありません。ファイルにない商品は見つからず、適用されるのはブラウザーが解釈できる条件だけです。さらに、訪問者全員がカタログ全体をダウンロードするため、数万件の商品とバリエーションがあれば数メガバイトになり、スマートフォンでは表示開始が遅くなります。ターボモードが効果を発揮するのは、性能の低いサーバーで、あまり更新されない中規模のカタログを扱う場合です。サーバーがクエリを処理できるなら、まず 大規模カタログで商品フィルターを高速化する方法 で説明しているキャッシュを使った通常モードを試してください。

正しい順序で有効にする

  1. WooCommerce → 設定 → Products Filter → 拡張機能(Extensions):ターボモード(Turbo mode) にチェックを入れて保存します。
  2. 詳細設定(Advanced) → ターボモード(Turbo mode):ターボモードを有効にする(Enable turbo mode) を はい(Yes) に設定して保存します。
  3. 商品データを今すぐ再構築(Reassemble products data now!) の下にある 今すぐ更新(Update now!) をクリックし、ファイルを更新しました(File updated!!!) と表示されるまでページを開いたままにします。ファイルがなければ、フィルターは検索できません。
  4. WordPress Cron期間(WordPress Cron period) と 商品データファイルの保存場所(Where to keep products data file) を選択して保存します。
  5. オプション(Options) タブで 件数を表示(Show count)、動的再カウント(Dynamic recount)、空の用語を非表示(Hide empty terms) を設定します。ターボモードではこれらは別々のコピーです(後述)。その後、ページキャッシュとCDNキャッシュを削除します。

フィルターがグレーアウトしたまま操作できない

グレーのレイヤーは、クラス woof_turbo_mode_overlay を持つ要素です。最初からフィルターを覆っており、ファイルの読み込みと件数の描画が終わるとターボモードのスクリプトが取り除きます。レイヤーが残っているなら、そのスクリプトが最後まで実行されていません。

  • スクリプトが遅延、defer、結合されている。 WP RocketやLiteSpeed Cacheなどの最適化機能は、スクリプトの開始を遅らせたり、順序を入れ替えたり、実行しなかったりすることがあります。ターボモードには、jQueryの後に wp-content/plugins/woocommerce-products-filter/ にある ext/turbo_mode/js/turbo_mode.js と ext/quick_search/js/alasql/alasql.min.js が必要です。プラグインのフォルダーを遅延、defer、結合の対象から除外し、すべてのキャッシュを削除してください。除外の方法は WP Rocketとキャッシュ使用時のフィルター で説明しています。
  • JavaScriptエラー。 ブラウザーのコンソール(F12)を開いて再読み込みします。最初に出る赤いエラーが、以降の処理を止めたスクリプトを示しています。
  • 低速な回線で大きなファイル。 ネットワークタブで data_0000_xxx.json のサイズと所要時間を確認します。ダウンロードに数秒かかってフィルターがグレーのままになるなら、そのカタログはターボモードには大きすぎます。

CSS(.woof_turbo_mode_overlay{display:none;})でレイヤーを隠しても、症状が見えなくなるだけです。フィルターは操作できるようになりますが、ファイルが読み込まれていなければ検索はできません。

ファイルを読み込めない場合、フィルターは おっと!フィルターが検索ファイルを開けないようです。(Oh no! It looks like the filter can't open the search file.) というメッセージに置き換わります。次の点を確認してください。

  • ファイルが存在すること。プラグインフォルダー(plugins\woocommerce-products-filter\ext\turbo_mode\data)に置いたファイルはプラグインの更新のたびに削除されるため、更新後に再構築するか、wp-uploads\uploads_woof_turbo_mode に保存してください。
  • サーバーの設定やセキュリティプラグインが、uploads内の .json ファイルをブロックしていないこと。ネットワークタブにあるファイルのアドレスを直接開いて確認します。
  • アドレスが正しいこと。プラグインは wp-content/uploads/uploads_woof_turbo_mode/ にリクエストするため、マルチサイトのサブサイトや、uploadsフォルダーを別の場所に移した環境では404が返ります。その場合は、ファイルをプラグインフォルダーに保存してください。

商品が見つからない、またはフィルター後に商品が消える

ターボモードが返すのは、ファイルに含まれる商品だけで、しかもそこに保存されたデータとの照合結果です。フィルターのあるページでフィルターの読み込みが終わった後、ブラウザーのコンソールで両方を確認します。

woof_turbo_mode_file.length                  // records in the file: products + variations
woof_turbo_mode_file.find(p => p.id == 123)  // what is stored for product 123

最初の数値を、公開済みの商品とバリエーションの合計と比較してください。WP-CLIでは wp post list --post_type=product,product_variation --post_status=publish --format=count で取得できます。商品が undefined を返すなら、ファイルに含まれていません。含まれている場合は、その taxonomies と stock を確認します。

ファイルが古い

新しい商品、変更したカテゴリー、属性、価格、在庫は、次の再構築が行われて初めてフィルターに反映されます。典型的な兆候は次のとおりです。新しい商品がショップページには表示されるのに最初のフィルタークリックで消える、新しい用語の件数が0になる、最後のページネーションのページが空になる、前回の再構築より後に追加したメタフィルターの要素で何も見つからない。インポートの後や、フィルターの要素を変更した後は、ファイルを再構築してください。

15,000件の上限

今すぐ更新(Update now!) は15,000件のレコードで停止します。バリエーションも件数に含まれます。8つのバリエーションを持つ可変商品が2,000件あるストアは、それだけで18,000件になります。ボタンは新しい商品から順に処理するため、除外されるのは最も古い商品です。ボタンの横のカウンターが Products and Variants: 15000 で止まっていたら、上限に達しています。woof_turbo_mode_products_limit フックで上限を引き上げ、再構築してください。

/*
 * HUSKY Turbo mode: let "Update now" write up to 40,000 products and variations.
 * Child theme functions.php or a code snippets plugin.
 */
add_filter('woof_turbo_mode_products_limit', function ($limit) {
    return 40000;
});

スケジュールによる再構築にはこのフックの上限は適用されず、カタログ全体が処理されます。

サブカテゴリーの商品が見つからない

ファイルに保存されるのは各商品でチェックされたカテゴリーだけで、ブラウザーはそれらをそのまま比較します。カテゴリーツリーは認識しません。WordPressでは親カテゴリーにサブカテゴリーの商品も表示されますが、ターボモードでは表示されません。ランニングシューズだけにチェックした商品は、最初のフィルタークリックまではシューズのページに表示されますが、その後は消えます。シューズの用語では見つからず、シューズの件数にも含まれません。こうした商品では、階層のすべてのレベル(シューズとランニングシューズ)にチェックを入れ、たとえば 商品 → 商品一覧 の一括編集を使って設定してから、ファイルを再構築してください。

非表示の商品と在庫切れの商品

カタログでの表示(Catalog visibility) が ショップのみ(Shop only) または 非表示(Hidden) の商品は検索から隠れているものとして扱われ、ターボモードは カタログの表示設定を反映する(Listen catalog visibility) の設定にかかわらず、フィルター後にこれらを返しません。そのため、ショップのみ(Shop only) の商品はショップページには表示されても、最初のクリックで消えます。フィルターの対象にしたい場合は ショップと検索結果(Shop and search results) に設定してください。WooCommerceの 在庫切れの商品をカタログから非表示にする(Hide out of stock items from the catalog) を有効にしていると、在庫切れの商品はファイルから除外され、在庫が復活した商品も次の再構築までは表示されません。

WPMLの言語

WPMLを使っている場合、HUSKYは言語ごとに1つのファイル(data_0000_en.json、data_0000_de.json)を書き出し、現在の言語のファイルを読み込みます。翻訳のない商品はその言語のファイルに含まれないため、翻訳した後は再構築してください。

検索ファイルを最新に保つ

今すぐ更新(Update now!) は、10件の商品またはバリエーションを1バッチとして、1秒に最大1バッチの速度でファイルを作成し、Products and Variants カウンターを表示します。バッチごとにファイル全体が書き換えられるため、15,000件には少なくとも25分かかります。スケジュールによる再構築と異なり、ボタンは現在のファイルを最初に削除します。完了するまでの間、サイトは不完全なデータでフィルタリングすることになります。アクセスの少ない時間帯に実行し、ページを開いたままにして、途中でターボモードをオフにしないでください。

WordPress Cron期間(WordPress Cron period) は自動再構築の間隔を決めます。選択肢は daily、weekly(デフォルト)、twicemonthly、monthly、min1、without update です。名前に反して、これはWP-Cronのイベントではありません。HUSKYは独自のスケジュール(オプション woof_turbo_init_wpcrone_)を持っています。再構築の時期が来ると、プラグインを読み込んでWordPressを起動するリクエストのたびに(ただし5秒に1回まで)、次の10件のレコードが一時ファイルに追加され、最後のバッチの後に一時ファイルが本番のファイルに置き換わります。それまでは、訪問者には以前のデータが提供されます。このことから次のことが言えます。

  • WP Crontrolなどのツールには表示されず、DISABLE_WP_CRON でも止まりません。
  • 速度はPHPに届くリクエストの数に左右され、ページキャッシュから配信されたページはカウントされません。20,000件のレコードには、5秒間隔で少なくとも2,000回のリクエストが必要です。安定したアクセスがあっても3時間近くかかり、アクセスの少ないサイトでは数日かかります。
  • 最初の自動再構築は、スケジュールを保存してから1期間分が経過した後に行われます。そのため、有効にした後は 今すぐ更新(Update now!) をクリックしてください。
  • 期間は前回の再構築の終了時点から数えます。min1 では1分後に次の再構築が始まるため、サイトは常に再構築を続けることになります。小規模なカタログにのみ使用してください。
  • 自動再構築の最中に 今すぐ更新(Update now!) をクリックすると、その一時ファイルも削除されます。自動処理が終わると、完全なファイルが、その後に作られた一部分だけのファイルに置き換えられます。手動で再構築した数時間後にまた商品が欠けた場合は、もう一度ボタンをクリックしてください。

アクセスの少ないサイトでは、サーバーのcronジョブでリクエストを補えます。FAQ 自動cron更新が失敗する理由 に、設定方法とPHPの制限を記載しています。1回の呼び出しで追加されるのは1バッチなので、1日に1回ではなく、1分ごとに呼び出してください。次のサイトページでのみプラグインを初期化する(Init plugin on the next site pages only) でプラグインを制限している場合は、プラグインが必ず読み込まれる /wp-admin/admin-ajax.php にリクエストさせます。それでも追加されるのは1時間に600件のレコードだけなので、一括で更新されるカタログでは、インポートのたびに 今すぐ更新(Update now!) をクリックしてください。

ほかの期間は、プラグインのファイルを編集せずに woof_turbo_mode_schedules フックで追加できます。追加後に新しい期間を選択して保存してください。

/*
 * HUSKY Turbo mode: add "every 12 hours" to WordPress Cron period.
 * Child theme functions.php or a code snippets plugin.
 */
add_filter('woof_turbo_mode_schedules', function ($schedules) {
    $schedules['every_12_hours'] = array(
        'name'  => 'every 12 hours',
        'value' => 12 * HOUR_IN_SECONDS,
    );
    return $schedules;
});

ファイルのアドレスは再構築のたびに変わりません。CDNやブラウザーが .json ファイルをキャッシュしていると、訪問者に古いデータが配信され続けることがあります。uploads_woof_turbo_mode フォルダーをCDNのキャッシュ対象から除外するか、再構築のたびに削除してください。

ターボモードにはAJAXが必要で、独自の件数設定がある

ターボモードが有効な間、HUSKYはページを読み込むたびに4つの設定をリセットします。ショップをAJAX化する(Try to ajaxify the shop) は はい(Yes) になり、通常の 件数を表示(Show count)、動的再カウント(Dynamic recount)、空の用語を非表示(Hide empty terms) は いいえ(No) になります。すると オプション(Options) タブには、これら3つのターボモード専用のコピーが同じ名前で表示され、動的再カウント(Dynamic recount) には はい、すべてのデバイス(Yes, for all devices) と はい、PCのみ(Yes, only for PC) が選べるようになります。

  • ターボモードがオンの間は、AJAXをオフにできません。ターボモードを有効にする(Enable turbo mode) を いいえ(No) に設定して保存し、その後で ショップをAJAX化する(Try to ajaxify the shop) を変更してください。
  • AJAXフィルタリングの後でテーマの商品グリッドが崩れる(1行に1商品、列が失われる、ページネーションが壊れる)場合、ターボモードもその影響を受けます。AJAXモードでの列数の設定 と AJAXモードのページネーションの問題 を参照するか、そのテーマではターボモードをオフにしておいてください。
  • ターボモードをオフにした後は、件数を表示(Show count)、動的再カウント(Dynamic recount)、空の用語を非表示(Hide empty terms) を設定し直してください。これらは いいえ(No) のままなので、その時点でカウンターが消えます。
  • 空の用語を非表示(Hide empty terms) は、件数を表示(Show count) と 動的再カウント(Dynamic recount) がオンのときにのみ機能します。件数を表示(Show count) をオフにすると、ほかの2つもオフになります。
  • フィルター内の各アイテムの動的再カウント数をキャッシュする(Cache dynamic recount number for each item in filter)、用語をキャッシュ(Cache terms)、価格フィルターを最適化する(Optimize price filter) は、ターボモードがオンの間は 詳細設定 → オプション から消えます。ターボモードには適用されないためです。

ターボモードにできないこと

  • 階層ドロップダウン(Hierarchy drop-down) 要素は、ターボモード拡張機能のページ に記載されているとおり、ターボモードでは動作しません。
  • 件数と 空の用語を非表示(Hide empty terms) は、標準の要素(チェックボックス、ラジオ、ドロップダウン、カラー、画像、ラベル、スライダー)で機能します。Smart Designerで作成した要素には件数が表示されません。
  • 在庫あり(In stock) は各商品自身の在庫ステータスだけを見ます。バリエーションを確認する設定は効かないため、サイズによるフィルターでも 在庫切れのバリエーションが表示される ことがあります。
  • テキスト検索は、入力された単語を商品タイトルとだけ比較します。テキスト検索要素が説明やほかのフィールドを検索する設定になっていても同じです。別のSKU要素は機能します。
  • PHPで追加した条件は検索に反映されません。どの商品が一致するかはブラウザーが判断するためです。woof_products_query や pre_get_posts のカスタムコード、カスタム拡張機能、ベンダーや顧客グループごとに商品を制限するプラグインは、見つかった商品の一部を後から隠すことしかできず、件数とページネーションがずれる原因になります。

ストアにこれらのいずれかが必要な場合や、価格と在庫が毎時間変わる場合は、ターボモードをオフにして、キャッシュで通常モードを高速化してください。

チェックリスト

  • コンソールに赤いエラーがない。プラグインのスクリプトが遅延、defer、結合の対象から除外されている。
  • woof_turbo_mode_file.length が公開済みの商品とバリエーションの合計と一致している。カウンターが上限で止まっていない。
  • 最後のインポートまたはフィルターの変更の後にファイルを再構築し、ページキャッシュとCDNを削除した。
  • 商品が階層全体のカテゴリーにチェックされ、公開設定が ショップと検索結果(Shop and search results) になっている。
  • 件数の設定をターボモードのコピーで設定し、ターボモードをオフにした後にもう一度設定した。

それでもフィルターの動作がおかしい場合は、ページのリンク、コンソールのエラー、woof_turbo_mode_file.length の値、商品とバリエーションの数を添えて、HUSKYサポートフォーラム でトピックを作成してください。