HUSKY - WooCommerce Product Filter Professional

WooCommerceフィルターのProduct接頭辞を削除しタイトルを変更

Product Color、Product Size、Product Material。ショップのフィルターの属性ブロックがすべて同じ単語で始まっているなら、フィルターはWooCommerceが属性に付けた名前をそのまま表示しているだけです。WooCommerceフィルターのタイトルからProductの接頭辞を削除するには、ブロックに独自のタイトルを設定します。フィルター設定で1つずつ設定するか、数行のコードですべての属性に一括で設定します。同じ場所で、フィルターの他のテキストも制御できます。ブロックのタイトル、ドロップダウンの最初のオプション、すべてクリア (Clear All)、リセット (Reset)、フィルター (Filter)、もっと見る (Show more)、さらには個々の用語の名前まで、プラグインのファイルを編集せずにすべて変更できます。

フィルターの各テキストの出所

HUSKYは、タクソノミーに独自の名前を保存していません。カスタムラベルを設定しない限り、WordPressからタクソノミーの複数形の名前を取得して、そのまま表示します。WooCommerceはすべてのグローバル属性を複数形の名前Product %sで登録するため、属性Colorは「Product Color」というタクソノミーになり、単数形の名前は「Color」のままです。カテゴリーとタグも同じで、複数形の名前は「Product categories」と「Product tags」です。次の表は、表示される各テキストの出所と、変更する場所を示しています。

ページ上のテキスト出所変更する場所
フィルター全体の上の見出し(「HUSKY Filter」)ウィジェットのタイトルウィジェットのタイトル (Title)フィールド
ブロックのタイトル(Product Color、Product categories)タクソノミー名タクソノミーのカスタムラベル (Taxonomy custom label)、またはwoof_filter_titleフック
ドロップダウンの最初のオプション同じタクソノミー名ブロックのタイトル、またはドロップダウンテンプレートのコピー
価格フィルターのタイトル価格フィルターのタイトルテキスト (Title text)価格で検索 (Search by Price)のadditional options
在庫あり (In stock)、セール中 (On sale)、おすすめ商品 (Featured products)拡張機能のテキストwoof_ext_custom_title_*フック
アクティブフィルターのパネルにあるすべてクリア (Clear All)プラグインの文字列woof_clear_all_textフック
フィルター (Filter)とリセット (Reset)のボタン、並べ替え (orderby)ラベルプラグインの文字列とオプションOptionsタブ、または翻訳
もっと見る (Show more) / 表示を減らす (Show less)、モバイルのフィルターを開く (Open filter) / フィルターを閉じる (Close filter)DesignタブのオプションDesignタブ
個々の用語の名前用語そのものwoof_sort_terms_before_outフック

WooCommerceフィルターのタイトルからProduct接頭辞を削除する

方法は3つあり、影響が最も狭いものから広いものの順です。1つ選べば十分で、すべて行う必要はありません。

ブロックごとに設定する:Taxonomy custom label

  1. WooCommerce > 設定 > Products Filter (WooCommerce > Settings > Products Filter)の構造 (Structure)タブを開きます。
  2. 属性の行(たとえばpa_color)で、歯車アイコン(追加オプション (additional options))をクリックします。
  3. タクソノミーのカスタムラベル (Taxonomy custom label)に、希望のタイトルを入力します。たとえばColorです。WooCommerceの名前に戻すには、フィールドを空のままにします。
  4. ポップアップの適用 (Apply)をクリックし、設定ページ下部の変更を保存 (Save changes)をクリックします。

カスタムラベルは、フィルターがタクソノミー名を使うあらゆる場所で、その名前を置き換えます。ブロックのタイトル、ドロップダウンの最初のオプション、マルチセレクトのプレースホルダー、アクティブフィルターのパネルで選択値に付くラベルが対象です。「Product categories」を「Categories」や「Shop by type」に変更する場合や、ブランドのタクソノミーに別のタイトルを付ける場合も、同じ方法です。階層型ドロップダウンでは、このフィールドに各階層のタイトルを入力します。その書式は年式・メーカー・モデルのフィルターのガイドで解説しています。

すべての属性を一括で:woof_filter_titleフック

属性が20個もあると、1つずつラベルを入力するのは面倒で、新しい属性を追加するたびに入力が必要になります。フィルターのすべてのブロックタイトルはwoof_filter_titleフックを通るため、1つのスニペットで、すべての属性の「Product ...」という名前を単数形の名前に置き換えられます。

/*
 * HUSKY: show "Color" instead of "Product Color" in attribute filter titles.
 * Child theme functions.php or a code snippets plugin.
 */
add_filter('woof_filter_title', function ($title, $taxonomy_info, $index) {
    if (is_object($taxonomy_info)
        && isset($taxonomy_info->name, $taxonomy_info->labels->name, $taxonomy_info->labels->singular_name)
        && 0 === strpos($taxonomy_info->name, 'pa_')
        && $title === $taxonomy_info->labels->name) {
        // No custom label is set: use the attribute name without the prefix
        return $taxonomy_info->labels->singular_name;
    }
    return $title;
}, 10, 3);

$title === $taxonomy_info->labels->nameという判定により、設定済みのタクソノミーのカスタムラベル (Taxonomy custom label)は維持されます。このスニペットが変更するのは、まだWooCommerceの名前のままのタイトルだけです。フィルター以外には何も変更しません。このフックは、$taxonomy_infoが空の状態で一部のボタンのテキストも受け取るため、スニペットは最初にis_object()を確認しています。

サイト全体で:WooCommerceの文字列を変更する

他のウィジェットや管理画面を含め、属性のタクソノミー名を表示するすべての場所から接頭辞を取り除きたい場合は、WooCommerceの文字列そのものを変更します。接頭辞の元は_x( 'Product %s', 'Product Attribute', 'woocommerce' )なので、翻訳フィルターで名前だけを返せます。

/*
 * Remove the "Product" prefix from WooCommerce attribute names site-wide.
 * Child theme functions.php or a code snippets plugin.
 */
add_filter('gettext_with_context', function ($translation, $text, $context, $domain) {
    if ('woocommerce' === $domain && 'Product Attribute' === $context && 'Product %s' === $text) {
        return '%s';
    }
    return $translation;
}, 10, 4);

Loco Translateでも、WooCommerceのテキストドメインでProduct %sを%sに翻訳すれば、同じ結果になります。WooCommerceの更新で上書きされないよう、ファイルはLocoのカスタムの場所に保存してください。他の言語のサイトでは、翻訳後の文字列(たとえば「Produkt %s」)が表示されますが、スニペットは元の英語のテキストと比較するため、サイトの言語を問わず動作します。

どの名前変更の方法にも、副作用が1つあります。各ブロックには、タイトルから作られるCSSクラス(woof_container_productcolorなど)も付きます。名前を変更すると、それはwoof_container_colorになります。カスタムCSSが古いクラスを指定している場合は、変わることのないスラッグベースのクラスwoof_container_pa_colorに切り替えてください。

フィルターのタイトルとウィジェットの見出しを変更・非表示にする

フィルター全体の上にある「HUSKY Filter」というテキストはプラグインの設定ではなく、ウィジェットのタイトルです。外観 > ウィジェット (Appearance > Widgets)(またはブロックウィジェットエディター)を開き、HUSKYウィジェットを開いて、そのタイトル (Title)フィールドを変更するか、空にします。タイトルが空なら何も表示されません。[woof]ショートコードで配置したフィルターには、そもそもこのような見出しはありません。

1つのブロックのタイトルを非表示にするには、そのadditional optionsでタイトルラベルを表示 (Show title label)をいいえ (No)に設定します。ドロップダウンでは、最初のオプションですでに内容がわかるため、よく使われます。価格フィルターには専用のフィールドがあります。価格で検索 (Search by Price)のadditional optionsを開いてタイトルテキスト (Title text)に入力してください。空の場合、価格ブロックにはタイトルが付きません。ドロップダウン形式の価格フィルターでは、同じポップアップのドロップダウン価格フィルターのテキスト (Drop-down price filter text)で最初のオプションを設定します。

タクソノミーのタイトルはショップ全体で1つです。1つのカテゴリーだけ別のタイトルにしたい場合、たとえばShoesカテゴリーで「Shoe size」にしたい場合は、カテゴリー別ラベルのFAQで解説しています。最も簡単なコードは、woof_filter_titleの中に条件を置く方法です。

add_filter('woof_filter_title', function ($title, $taxonomy_info, $index) {
    if (is_object($taxonomy_info) && 'pa_size' === $taxonomy_info->name && is_product_category('shoes')) {
        return 'Shoe size';
    }
    return $title;
}, 10, 3);

これは、フィルターを変更するたびにページが再読み込みされる場合に動作します。AJAXモードでは、フィルターフォームはバックグラウンドのリクエストで再構築され、そこではis_product_category()がfalseになるため、最初の選択後にタイトルがデフォルトに戻ります。

ドロップダウンのプレースホルダーテキストを変更する

タクソノミーのドロップダウンの最初のオプション、つまり「何も選択されていない」ことを表すものは、ブロックのタイトルと同じテキストを表示します。そのため、カスタムラベルを設定すると両方が変わります。両者を別にしたい場合、たとえばタイトルはColor、最初のオプションはAny colourにしたい場合は、ドロップダウンテンプレートのコピーを使います。プラグインはwoof_html_types_view_selectフックでこれを読み込むため、コピーは子テーマに置いておくことができ、プラグインを更新しても残ります。

  1. wp-content/plugins/woocommerce-products-filter/views/html_types/select.phpをwp-content/themes/your-child-theme/husky/select.phpにコピーします。
  2. コピーを使うようにプラグインに伝えます。
    /*
     * HUSKY: load the drop-down template from the child theme.
     * Child theme functions.php.
     */
    add_filter('woof_html_types_view_select', function ($path) {
        $custom = get_stylesheet_directory() . '/husky/select.php';
        return file_exists($custom) ? $custom : $path;
    });
  3. コピーの中で<option value="0">の行を見つけ、独自のテキストに置き換えます。そこでは$tax_slugが使えるため、1つのテンプレートですべてのドロップダウンに対応できます。
    <option value="0"><?php echo esc_html( 'pa_color' === $tax_slug ? 'Any colour' : 'All' ); ?></option>

マルチセレクトのブロックはタイトルをプレースホルダーとして表示します。そのテンプレートはviews/html_types/mselect.phpで、同じ方法でwoof_html_types_view_mselectから読み込まれます。プラグインの更新後は、コピーを新しいオリジナルと比較し、変更点を反映してください。

Clear All、Reset、Filterなどの組み込みテキストを変更する

プラグイン独自のテキストは、3つのグループに分かれます。

オプション。オプション (Options)タブのフィルターボタンのテキスト (Filter button text)とリセットボタンのテキスト (Reset button text)で、フォームの2つのボタンを設定します。リセットボタンのテキスト (Reset button text)にnoneと入力すると、そのボタンが非表示になります。無料版ではどちらのフィールドも無視され、デフォルトの文言が表示されます。変更するには、下の翻訳スニペットを使ってください。デザイン (Design)タブには、ブロックの展開時テキスト (Text for block more/less opened)とブロックの折りたたみ時テキスト (Text for block more/less closed)(デフォルトはもっと見る (Show more)と表示を減らす (Show less)で、ブロックに切り替えない用語数 (Not toggled terms count)が設定されているときに使われます)があり、さらにモバイルフィルターボタンのテキスト (Text for mobile filter button)とモバイルフィルターを閉じるテキスト (Text to close mobile filter)もあります。

フック。アクティブフィルターのパネルにあるすべてクリア (Clear All)には専用のwoof_clear_all_textフックがあり、チェックボックスの拡張機能にはwoof_ext_custom_title_*フックがあります。woof_ext_custom_title_by_instock、_by_onsales、_by_featured、_by_backorder、woof_ext_custom_title_stock_quantityです。

/*
 * HUSKY: rename built-in texts. Child theme functions.php or a code snippets plugin.
 */
add_filter('woof_clear_all_text', function ($text) {
    return 'Remove all filters';
});

add_filter('woof_ext_custom_title_by_instock', function ($title) {
    return 'Only products in stock';
});

add_filter('woof_ext_custom_title_by_onsales', function ($title) {
    return 'Discounted products';
});

すべてクリア (Clear All)のテキストは二重引用符で囲まれたJavaScript文字列に書き込まれるため、その中で二重引用符は使わないでください。

翻訳。それ以外のすべて、たとえばアクティブフィルターのパネルの並べ替え (orderby)、1ページあたり (per page)、価格帯 (price range)のラベルや、人気順 (popularity)のような並べ替えの値は、テキストドメインwoocommerce-products-filterの翻訳可能な文字列です。単一言語のショップでは、正確な文字列の一覧を使ったgettextフィルターが最も簡単な方法です。

/*
 * HUSKY: replace front-end strings. Child theme functions.php or a code snippets plugin.
 */
add_filter('gettext', function ($translation, $text, $domain) {
    if ('woocommerce-products-filter' !== $domain || (is_admin() && ! wp_doing_ajax())) {
        return $translation;
    }
    $texts = array(
        'Filter'     => 'Show products',
        'Reset'      => 'Start over',
        'orderby'    => 'Sort by',
        'popularity' => 'Popularity',
        'rating'     => 'Rating',
    );
    return isset($texts[$text]) ? $texts[$text] : $translation;
}, 20, 3);

文字列は、大文字・小文字も含めて完全に一致している必要があります。デフォルトのボタンのテキストは「Clear all」ではなくClear Allです。is_admin()の条件により、プラグインの設定ページは元の文言のまま保たれ、フィルターを再描画するAJAXリクエストには引き続き適用されます。置き換えた文字列は、プラグインがそれを表示するすべての場所で変わります。Filterは、WooCommerce風の価格スライダーのボタンや、スライドアウトタブのデフォルトのテキストでもあります。Loco Translateを使えば、コードなしで同じことができます。フィルターを複数の言語に翻訳する作業は別の話で、WPML、Polylang、Loco Translateでフィルターのラベルを翻訳するで解説しています。

フィルター内だけで用語の名前を変更する

カテゴリーや属性値を、商品ページとフィルターで別の表記にしたいことがあります。たとえば、長いカテゴリー名がサイドバーのレイアウトを崩す場合です。すべての用語リストは、チェックボックス、ラジオボタン、ドロップダウン、ラベル、色、画像のいずれでも、表示される前にwoof_sort_terms_before_outを通ります。

/*
 * HUSKY: show other names for some terms in the filter only.
 * Child theme functions.php or a code snippets plugin.
 */
add_filter('woof_sort_terms_before_out', function ($terms, $type) {
    $new_names = array(
        1019 => 'Garden tools',    // term ID => name shown in the filter
        1697 => 'Kids (4-12)',
    );
    foreach ($terms as $key => $term) {
        if (isset($term['term_id'], $new_names[$term['term_id']])) {
            $terms[$key]['name'] = $new_names[$term['term_id']];
        }
    }
    return $terms; // always return the whole array
}, 99, 2);

用語IDは、商品 > カテゴリー (Products > Categories)や属性の用語を設定 (Configure terms)画面で用語にマウスを合わせると、リンクの中のtag_IDとして確認できます。このフックは子用語に対しても実行されるため、サブカテゴリーも同じ方法で名前を変更できます。優先度99で実行される時点でリストはすでに並べ替えられているため、名前を変更した用語は、元の名前の位置を維持します。必ず配列全体を返してください。変更した用語だけを返すと、他のすべての用語がフィルターから消えてしまいます。

新しい名前が表示されない場合

  • 保存されていない。additional optionsポップアップの適用 (Apply)はフォームに入力するだけで、ラベルが保存されるのは、設定ページで変更を保存 (Save changes)をクリックしたときです。
  • 用語のキャッシュ。詳細設定 > オプション (Advanced > Options)で用語をキャッシュ (Cache terms)が有効になっていると、フィルターはキャッシュした用語名を保持します。WooCommerceで名前を変更した用語は、用語キャッシュをクリア (clear terms cache)をクリックするか、自動クリーンの期間が過ぎるまで、古い名前のままです。
  • ページキャッシュ。キャッシュされたページには古いHTMLが残っています。キャッシュプラグイン、サーバー、CDNのキャッシュを削除し、プライベートウィンドウで確認してください。
  • スニペットが動作していない。コードが有効な(子)テーマのfunctions.phpか、有効なスニペットに入っていること、そしてフィルター名、引数の数、文字列が上記のとおりであることを確認してください。

ここで扱っていないテキストがフィルターにある場合は、HUSKYサポートフォーラムで、そのテキストの正確な内容と表示されている場所を添えて質問してください。