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

概要

woocommerce_breadcrumb_main_term フィルタは、WooCommerceプラグインで使用されるフィルタであり、主に商品ページやカテゴリーページなどに表示されるパンくずリストのメインタームを変更する際に用いられます。このフィルタを使用することで、デフォルトで設定されたメインタームの表示内容をカスタマイズし、よりユーザーフレンドリーなナビゲーションを実現することができます。

このフィルタは次のような機能を実装する際によく使われます。
1. パンくずリストの表記をカスタマイズ
2. 特定のカテゴリーをメインタームとして表示
3. 商品の属性に基づいたメインタームの変更
4. SEO向上のためにパンくずリストを最適化
5. ローカライズされたタイトルを設定
6. ユーザーが訪れているページの特性に基づくダイナミックな表示

構文

apply_filters( 'woocommerce_breadcrumb_main_term', $term, $product );

パラメータ

$term: メインタームの名前。
$product: 現在の製品オブジェクト。

戻り値

フィルタによって変更されたメインタームの名前。

バージョン

WooCommerce バージョン: 3.0.0以上
WordPress バージョン: 4.0以上

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

アクション	使用例
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

サンプルコード

サンプル1: パンくずリストのメインタームをカスタマイズ

add_filter( 'woocommerce_breadcrumb_main_term', 'custom_breadcrumb_main_term', 10, 2 );

function custom_breadcrumb_main_term( $term, $product ) {
    if ( '特定のカテゴリ' === $term ) {
        return 'カスタムタイトル';
    }
    return $term;
}

このコードは、特定のカテゴリに対してパンくずリストの表示名をカスタマイズするものです。

サンプル2: 商品の属性に基づいてメインタームを表示

add_filter( 'woocommerce_breadcrumb_main_term', 'attribute_based_breadcrumb_term', 10, 2 );

function attribute_based_breadcrumb_term( $term, $product ) {
    $attributes = $product->get_attributes();
    if ( isset( $attributes['color'] ) ) {
        return 'カラー: ' . $attributes['color'];
    }
    return $term;
}

このサンプルコードは、商品の属性「カラー」に基づいてメインタームを変更する例です。

サンプル3: パンくずリストをSEOに最適化

add_filter( 'woocommerce_breadcrumb_main_term', 'seo_optimized_breadcrumb', 10, 2 );

function seo_optimized_breadcrumb( $term, $product ) {
    return $term . ' - 各製品レビュー';
}

このコードは、パンくずリストに「各製品レビュー」という文言を追加してSEOを最適化しています。

サンプル4: カスタマイズしたローカライズタイトル

add_filter( 'woocommerce_breadcrumb_main_term', 'localized_breadcrumb_title', 10, 2 );

function localized_breadcrumb_title( $term, $product ) {
    return __( 'カスタムタイトル', 'your-textdomain' );
}

このサンプルは、国際化に対応したローカライズタイトルを使用してパンくずリストを表示するものです。

サンプル5: デフォルトのメインタームを完全に無効にする

add_filter( 'woocommerce_breadcrumb_main_term', 'disable_breadcrumb_main_term', 10, 2 );

function disable_breadcrumb_main_term( $term, $product ) {
    return '';
}

このコードは、パンくずリストのメインタームを完全に無効にする例です。この場合、何も表示されなくなります。

概要

構文