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

概要

woocommerce_taxonomy_archive_description_raw フィルタは、WooCommerceにおけるタクソノミーアーカイブページの説明テキストをカスタマイズするために使用されるフックです。このフィルタを利用することで、商品のカテゴリーやタグのアーカイブページに表示される内容を変更することが可能です。

使用する場面

このフィルタは以下のような場面でよく使用されます。
1. アーカイブページの説明に特定のHTML要素やスタイルを追加したい場合。
2. デフォルトの説明文をカスタマイズしたい場合。
3. 特定の条件に基づいて説明テキストを動的に変更したい場合。
4. マーケティングメッセージを追加したい場合。
5. SEO対策として、タクソノミーに関連するキーワードを強調したい場合。
6. ユーザーエクスペリエンス向上のために、説明文にビジュアル要素を追加したい場合。

構文

add_filter('woocommerce_taxonomy_archive_description_raw', 'your_function_name', 10, 2);

パラメータ

description: 現在の説明文
taxonomy: 現在のタクソノミー名（例: product_cat）

戻り値

このフィルタは、文字列（カスタマイズされた説明文）を返します。

バージョン

WooCommerce: 2.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_taxonomy_archive_description_raw', 'custom_archive_description', 10, 2);
function custom_archive_description($description, $taxonomy) {
    if ($taxonomy === 'product_cat') {
        return '特別な製品カテゴリーへのようこそ！';
    }
    return $description;
}

このサンプルは、商品カテゴリーのアーカイブページに「特別な製品カテゴリーへのようこそ！」というテキストを表示します。

サンプル2: デフォルトの説明文を削除

add_filter('woocommerce_taxonomy_archive_description_raw', 'remove_archive_description', 10, 2);
function remove_archive_description($description, $taxonomy) {
    return '';
}

このサンプルは、アーカイブページの説明文を空にすることで、表示を削除します。

サンプル3: タクソノミーに基づく条件的なテキスト追加

add_filter('woocommerce_taxonomy_archive_description_raw', 'conditional_text_customization', 10, 2);
function conditional_text_customization($description, $taxonomy) {
    if ($taxonomy === 'product_tag') {
        return $description . ' – 新しいトレンドを見逃すな！';
    }
    return $description;
}

このサンプルでは、商品タグのアーカイブページに追加のメッセージを付加しています。

サンプル4: HTMLを含むカスタマイズ

add_filter('woocommerce_taxonomy_archive_description_raw', 'html_custom_archive_description', 10, 2);
function html_custom_archive_description($description, $taxonomy) {
    return '<strong>' . $description . '</strong>';
}

このサンプルは、アーカイブページの説明を太字で強調表示します。

サンプル5: カスタムメッセージの追加

add_filter('woocommerce_taxonomy_archive_description_raw', 'custom_message_archive_description', 10, 2);
function custom_message_archive_description($description, $taxonomy) {
    if ($taxonomy === 'product_cat') {
        return $description . '<br>特別オファーをご覧ください！';
    }
    return $description;
}

このサンプルでは、商品カテゴリーのアーカイブページに特別オファーのメッセージを追加しています。

引用元: https://woocommerce.com/document/woocommerce-rest-api/

概要