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

概要

woocommerce_breadcrumb_product_terms_args フィルタは、WooCommerceのパンくずリストナビゲーションで表示される製品の用語の引数を変更するために使用されるフックです。このフィルタを利用することによって、特定の条件に基づいて表示する用語をカスタマイズできます。主に以下のような機能を実装する際によく使用されます。

カスタム用語の追加や削除
特定の条件に基づいた用語のフィルタリング
表示される用語の順序変更
用語表示に関する追加情報の提供
用語の表示形式のカスタマイズ
特定の製品タイプに対するカスタム設定

構文

apply_filters('woocommerce_breadcrumb_product_terms_args', $args, $product_id);

パラメータ

$args：配列 – 用語を取得するための引数。
$product_id：整数 – 対象となる製品のID。

戻り値

修正された引数の配列。

対応バージョン

WooCommerce：5.0以上
WordPress：5.0以上

サンプルコード

サンプル1: 特定の用語を排除する

このコードは、特定の製品タームをパンくずリストから排除します。

add_filter('woocommerce_breadcrumb_product_terms_args', function($args, $product_id) {
    $args['exclude'] = array(123, 456); // 123と456のタームを排除
    return $args;
});

サンプル2: タームの表示順序を変更する

こちらのコードでは、タームの表示順をカスタマイズします。

add_filter('woocommerce_breadcrumb_product_terms_args', function($args) {
    $args['orderby'] = 'name'; // 名前でソート
    $args['order'] = 'ASC'; // 昇順
    return $args;
});

サンプル3: タームの数を制限する

このコードは、パンくずリストに表示されるタームの数を制限します。

add_filter('woocommerce_breadcrumb_product_terms_args', function($args) {
    $args['number'] = 3; // 3つのタームのみ表示
    return $args;
});

サンプル4: カスタムタームを追加する

ここでは、カスタムタームをパンくずリストに追加します。

add_filter('woocommerce_breadcrumb_product_terms_args', function($args) {
    $args['include'] = array(789); // 789のカスタムタームを追加
    return $args;
});

サンプル5: タームに表示するカスタムフィールドを追加する

このコードは、タームに関連するカスタムフィールドを追加します。

add_filter('woocommerce_breadcrumb_product_terms_args', function($args, $product_id) {
    $args['taxonomy'] = 'your_custom_taxonomy'; // カスタムタクソノミーを指定
    return $args;
});

この関数のアクションでの使用可能性

アクション	使用可能
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_breadcrumb_product_terms_args フィルタが特定のアクションフックで使用される可能性を示しています。結果は、異なるコンテキストでの使用を考慮したものです。

概要

構文