HUSKY - WooCommerce Product Filter Professional

WooCommerce商品フィルターがWP Rocketで動かない時の対処法

WP Rocketなどの最適化プラグインを使うと WooCommerce の商品フィルターが動作しない場合、パターンはほぼ決まっています。ログイン中はすべて正常に動くのに、訪問者にとってはクリックしても何も起きない、ローダーが回り続ける、価格スライダーが単なるテキストフィールドとして表示される、といった症状です。HUSKYは両者にまったく同じコードを送っています。違いは、キャッシュやJavaScript最適化が通常ログイン中の管理者をスキップするため、訪問者に配信される最適化済みのページを管理者は目にしないという点です。この記事では、エラーを1分で読み取る方法、WP Rocket、LiteSpeed Cache、Autoptimize、SiteGround Optimizer、Cloudflareで除外すべき対象、そしてページキャッシュが nonce error でAJAXフィルタリングを壊すのを防ぐ方法を解説します。

フィルターが管理者では動き、訪問者では動かない理由

フィルターのフロントエンドは1つのスクリプトファイルではなく、決まった順序で実行されなければならない一連の処理です。

  1. jQuery:すべてのフィルタースクリプトが依存しています。
  2. インライン設定ブロック:ページ内に出力されます(ソースでは <script id="woof_front-js-before"> です)。フィルターに必要な変数を定義します:woof_current_values、woof_is_ajax、swoof_search_slug、woof_ext_init_functions、セキュリティトークン woof_front_nonce など。
  3. プラグインのファイル:/wp-content/plugins/woocommerce-products-filter/ にあります。これらの変数を読み取る js/front.js、フィルター要素や拡張機能のスクリプト、そしてiCheck(チェックボックスのスキン)、ion.rangeSlider(スライダー)、plainOverlay(読み込みオーバーレイ)などのjQueryアドオンです。

最適化とキャッシュは、この連鎖を3通りの方法で壊します。最適化は順序を変えてしまいます。たとえば、ファイルは遅延させるのにインラインブロックは遅延させない、あるいはその逆です。結合や圧縮の際にインラインブロックを移動したり書き換えたりします。そしてページキャッシュは、有効期限のあるデータ、つまりセキュリティトークンを含むHTMLを保存します。ほとんどのキャッシュ/最適化プラグインは、ログインユーザーにはキャッシュも最適化もされていないページを返します。そのため、管理者として見た画面で証明できるのは、フィルター自体が動作するということだけです。

まずブラウザのコンソールを確認する

ログインしていないプライベートウィンドウでショップを開きます。F12(Macでは Cmd+Option+I)を押し、コンソール (Console) タブを開いてページを再読み込みし、フィルターをクリックします。最初に表示される赤いエラーが、調べるべき場所を示しています。

コンソールのメッセージ意味
woof_current_values is not defined、および woof_is_ajax、swoof_search_slug、woof_ext_init_functions についての同様のメッセージ(Firefox:assignment to undeclared variable、Safari:Can't find variable)インライン設定ブロックが front.js より前に実行されませんでした。遅延、移動、削除、または破損しています
jQuery is not definedjQueryが遅延またはdeferされていますが、それを必要とするコードが先に実行されました
iCheck is not a function、plainOverlay is not a function、ionRangeSlider is not a functionアドオンのファイルが読み込まれなかったか、2つ目のjQueryが後から読み込まれてjQueryオブジェクトが置き換えられました
woof_husky_txt is not definedテキスト検索のデータブロックが削除されたか、そのファイルから切り離されました
インラインブロックを指す SyntaxErrorインラインブロックに無効なコードがあります。多くの場合、プラグイン独自のカスタムJavaScriptフィールドが原因です(後述)
Identifier 'woof_front_nonce' has already been declared設定ブロックが2回実行されました。最適化プラグイン、またはAJAXでページ遷移するテーマがインラインスクリプトを再実行しています
"nonce error" is not valid JSONページがキャッシュから配信され、そのセキュリティトークンの有効期限が切れています
Unexpected token '<' ... is not valid JSONサーバーがフィルターのリクエストにHTMLで応答しました。PHPの通知、ファイアウォールのページ、またはキャッシュされたページです
Bad escaped character in JSONAJAXの応答がブラウザに届く途中で何かに書き換えられました

エラーがまったく出ないのに、スライダーが通常の入力欄になり、階層リストの + 展開ボタンがなく、クリックしても何も起きない場合は、スクリプトがまだ実行されていません。「ユーザーの操作があるまでJavaScriptを遅延させる」機能の典型的な症状です。ページのソースを表示して woof_front を検索してください。スクリプトタグに rocketlazyloadscript や litespeed/javascript のようなtypeが付いていれば、最適化プラグインがスクリプトを止めています。ソースに woof_front がまったく見つからない場合は、次のサイトページでのみプラグインを初期化 (Init plugin on the next site pages only) フィールド(詳細設定 → コード)を確認してください。ページが指定されていると、プラグインはそのページでのみ読み込まれます。

JavaScript最適化から除外するもの

ルールはどのツールでも同じです。jQuery、インラインブロック、プラグインのファイルは、一緒に、元の順序のまま保つ必要があります。front.js だけを除外するのはよくある中途半端な対処で、設定ブロックとjQueryが依然として遅延されるため機能しません。次の3行ですべてをカバーできます。

/wp-includes/js/jquery/
woocommerce-products-filter
woof_

1行目はjQueryとjQuery UI(WooCommerceスタイルの価格スライダーが使用)に一致します。2行目はプラグインとその拡張機能のすべてのファイルに一致します。3行目はインラインブロックに一致します。そのidと内部の変数は woof_ で始まります。最適化プラグインの除外フィールドは通常、キーワードをファイルのURLとインラインスクリプトの内容の両方と照合します。

  • WP Rocket:ファイルの最適化 (File Optimization) で、JavaScriptの実行を遅延 (Delay JavaScript execution) の除外ファイルにこれらの行を追加します。それでもフィルターが壊れる場合は、JavaScriptを遅延読み込み (Load JavaScript deferred) の除外にも追加するか、このオプションをオフにします。CSS配信の最適化 (Optimize CSS delivery) で未使用CSSの削除が設定されている場合は、プラグインのスタイルと .woof クラスをCSSのセーフリストに追加します。多くのフィルタークラスはJavaScriptの実行後にしか現れないため、静的なページのスキャンでは未使用とみなされてしまいます。
  • LiteSpeed Cache:JS Combine と Load JS Deferred(deferまたは遅延)が通常の原因です。これらの行をJSの除外設定と、defer/遅延の除外設定に追加します。フィルターのリクエストは返ってくるのに商品が更新されず、コンソールに Bad escaped character in JSON が出る場合は、CDN Mapping をオフにしてください。確認された事例では、これがAJAXの応答を書き換えていました。
  • Autoptimize:JavaScriptを集約すると、jQueryはページ末尾の結合ファイルに移動する一方、インラインコードは元の位置に残るため、早すぎるタイミングで実行されます。Autoptimizeからスクリプトを除外 (Exclude scripts from Autoptimize) に js/jquery/jquery.min.js と woocommerce-products-filter を残してください。
  • SiteGround Speed Optimizer、WP-Optimizeなど:結合、defer、「インラインスクリプトの遅延」オプションはいずれも同じ除外設定が必要です。そうでなければオフにしてください。
  • Cloudflare Rocket Loader:インラインブロックを含むすべてのスクリプトを非同期で読み込み、さらに フィルターのフロントビルダー (Filter front builder) 拡張機能の起動も妨げます。Cloudflareの速度設定でオフにし、Cloudflareのキャッシュを消去してください。
  • HTMLの圧縮:「不要な文字を削除する」タイプのものは、インラインスクリプトを破損させることがあります。インラインJavaScriptの圧縮はオフにしてください。
  • script_loader_tag フィルターを使うテーマやスニペットのコード:WordPressはこのフィルターにスクリプトタグと一緒にインラインブロックも通すため、ここで属性を削除したり引用符を置換したりするコードは、インラインブロックを破損させる可能性があります。そのようなコードは削除するか、他のハンドルに限定してください。

フィルター内の2つの設定

AJAX完了後のJavaScriptコード (JavaScript code after AJAX is done)(WooCommerce → 設定 → Products Filter → 詳細設定 → コード)は、関数の本体としてインライン設定ブロックに挿入されます。閉じ括弧の欠落のようなタイプミスが1つあるだけでブロック全体が壊れ、すべてのフィルター変数が「not defined」になります。テストするにはフィールドを空にしてください。フィルタリング後にコードを実行したい場合は、woof_ajax_done イベントのほうが安全です。

HUSKYのJavaScriptファイルの読み込みを最適化 (Optimize loading of HUSKY JavaScript files)(詳細設定 → オプション)は、2通りの読み込み方法を切り替えます。いいえ (No) では front.js に加えて、ラジオボタン、チェックボックス、ドロップダウン用の4つの個別スクリプトを読み込みます。はい (Yes) では、圧縮された1つのファイル js/front_comprssd.js をフッターに読み込みます。最適化の構成によっては、どちらか一方の値でしか動かないことがあります。両方を試し、変更のたびにすべてのキャッシュを消去してください。

ページキャッシュと「nonce error」

AJAXモード(オプションタブの ショップをAJAX化する (Try to ajaxify the shop)、または [woof_products is_ajax=1] のページ)および ajax_redraw 属性を使う場合、フィルターはサーバーに新しい商品を要求し、ページから取得したトークン woof_front_nonce を送信します。サーバーはそれを検証し、無効な場合はプレーンテキストの nonce error で応答します。スクリプトはJSONを期待しているためその応答を読み取れず、ローダーが画面に残ったままになります。

トークンはHTMLが生成された時点で作られます。ログインしていない訪問者に対しては、WordPressのnonceは最短12時間、最長24時間有効です。それより古いキャッシュから配信されたページには、無効になったトークンが含まれます。これが、キャッシュが作成されてから1日後にキャッシュされたページで問題が現れる理由であり、再読み込みで直ることがあるのは、たまたま新しいコピーに当たるためです。キャッシュを消去しても、数時間しか効果がありません。恒久的な対処法は次のとおりです。

  • HTMLページのキャッシュ有効期間を12時間未満に保つ。WP Rocketのデフォルトの有効期間10時間は安全です。CDNでのHTMLの長期キャッシュが典型的な原因です。
  • ショップとカテゴリーのHTMLをCDNでキャッシュしない。Cloudflareの場合は、ショップ、/product-category/ のURL、およびフィルターのあるその他のページでキャッシュをバイパスするキャッシュルールを追加し、独自の有効期間を尊重するWordPressのページキャッシュはそのまま使います。フィルタリング後のURLだけをバイパスしても不十分です。訪問者が使うトークンは、フィルタリングを始めたページから取得されるためです。
  • このトークン1つだけの有効期間を延ばす。WordPress 6.1以降、nonce_life フィルターはアクション名を受け取るため、サイト上の他のnonceに触れることなく、フィルターのトークンだけを長く有効にできます。このトークンが保護するのは、公開されている商品一覧のリクエストのみです。
/*
 * HUSKY: keep the filter token valid longer than the page cache lifespan.
 * A token is valid for at least half of this time (here: 2 days).
 * Child theme functions.php or a code snippets plugin.
 */
add_filter('nonce_life', function ($life, $action = -1) {
    if ('woof_front_nonce' === $action) {
        return 4 * DAY_IN_SECONDS;
    }
    return $life;
}, 10, 2);

AJAXを使わず ajax_redraw も使わないプレーンなリダイレクトモードでは、トークンはまったく使用されません。フィルターを変更するたびに新しいURLが読み込まれ、ページキャッシュはフィルタリング後のURLを他のページと同様に配信できます。独自のコードからフィルターを呼び出す場合、たとえば woof_draw_products へのカスタムjQueryリクエストでは、リクエストデータに nonce_filter: woof_front_nonce を含める必要があります。含めないと、キャッシュがなくてもサーバーは nonce error で応答します。

古いフィルター表示とその他のキャッシュの副作用

  • 変更したフィルター設定が反映されない。設定はキャッシュされたHTMLとインラインブロックの一部です。設定を保存した後は、すべてのキャッシュ層を消去してください。キャッシュプラグイン、サーバーキャッシュ(Varnish、Nginx、ホスティングのキャッシュ)、CDN、そしてブラウザの強制再読み込み(Ctrl+F5、Macでは Cmd+Shift+R)の順です。
  • フィルタリング済みのリンクを開くと何も選択されていない、あるいは通常のショップを開くと以前の選択が残っている。キャッシュが、クエリ文字列の異なるURLを同じページとして扱っています。すべての ?swoof=1&... のURLは個別にキャッシュするか、キャッシュしない必要があります。ショップのURLでクエリ文字列を無視するようキャッシュを設定してはいけません。
  • モバイル用フィルターがデスクトップに表示される、またはその逆になる。フィルターのモバイルモードと一部の拡張機能は、何を出力するかをサーバー側でブラウザのユーザーエージェントから判断します。スマートフォン向けにキャッシュされたページをデスクトップに配信してはいけません。モバイルデバイス用に別々のキャッシュファイルを有効にしてください。
  • 新しいフィルターの組み合わせへの最初のアクセスが遅い:そのURLにはまだキャッシュされたコピーがありません。全般的な高速化については、大規模カタログでのフィルタリングの高速化を参照してください。

安全なテストの手順

  1. ログアウトした状態のプライベートウィンドウで、コンソールを開いて作業します。
  2. すべてのJavaScript最適化(圧縮、結合、defer、遅延、Rocket Loader)をオフにし、すべてのキャッシュ層を消去します。これでフィルターが動作するなら、原因は最適化です。それでも動かない場合、原因は別にあります。最初のコンソールエラーを読み、ステージングのコピーでデフォルトテーマを使ってテストしてください。
  3. オプションを1つずつオンに戻し、そのたびにキャッシュを消去してテストします。あるオプションでフィルターが壊れたら、そのオプションに3行の除外設定を追加するか、オフのままにします。
  4. AJAXモードでは、1日間キャッシュに残っているページでもう一度フィルターを確認します。nonce error が出なければ、キャッシュの有効期間かトークンの有効期間が適切です。
  5. デスクトップだけでなくスマートフォンでも、また検索結果の2ページ目でもテストします。

これらの手順を行っても、ログインユーザーでしかフィルターが動作しない場合は、ページのリンク、最初のコンソールエラー、有効にしている最適化オプションの一覧を添えて、HUSKYサポートフォーラムでトピックを作成してください。こちらで確認します。