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

概要

woocommerce_archive_description フィルタは、WooCommerceのアーカイブページに表示される説明をカスタマイズするためのフックです。このフィルタを使用することで、商品カテゴリーやタグのアーカイブページに関連する情報を追加したり、テキストを変更したりすることができます。以下は、woocommerce_archive_description フィルタを使用することが多いシナリオの例です。

商品カテゴリーの説明文を変更する
ブランドアーカイブの説明をカスタマイズする
特定の条件に応じて説明文を追加する
SEOメタデータを強化するために説明を編集する
ユーザーの特定のアクションに基づいたカスタムメッセージの表示
アーカイブページのデザインを向上させるためのコンテンツの統合

構文

add_filter('woocommerce_archive_description', 'your_custom_function');

パラメータ

$description (string): アーカイブページに表示される初期の説明文。

戻り値

(string): 修正された説明文。

使用可能なバージョン

WooCommerce バージョン: 2.1.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_archive_description', 'custom_category_description');
function custom_category_description($description) {
    if (is_product_category()) {
        $description .= '<p>このカテゴリーでは最新の商品を取り揃えています。</p>';
    }
    return $description;
}

このコードは、商品カテゴリーのアーカイブページに「このカテゴリーでは最新の商品を取り揃えています。」というメッセージを追加します。

サンプル2: ブランドアーカイブのカスタマイズ

add_filter('woocommerce_archive_description', 'custom_brand_description');
function custom_brand_description($description) {
    if (is_brand()) {
        $description = 'このブランドは高品質な製品を提供しています。';
    }
    return $description;
}

このコードは、ブランドアーカイブページに特定の説明文を表示します。

サンプル3: 特定の条件に基づいた説明の追加

add_filter('woocommerce_archive_description', 'conditional_custom_description');
function conditional_custom_description($description) {
    if (is_product_category() && !is_product_category('特定のカテゴリー')) {
        $description .= '<p>特別なプロモーションをお見逃しなく！</p>';
    }
    return $description;
}

このコードは、特定のカテゴリーでない場合にプロモーションのメッセージを追加します。

サンプル4: SEO向けの説明文の調整

add_filter('woocommerce_archive_description', 'modify_for_seo');
function modify_for_seo($description) {
    return '<p>当店の製品はすべて厳選された高品質な商品です。</p>' . $description;
}

このコードは、SEOを強化するために説明文の最初にカスタムメッセージを追加します。

サンプル5: ユーザー向けのカスタムメッセージ

add_filter('woocommerce_archive_description', 'user_custom_message');
function user_custom_message($description) {
    if (current_user_can('customer')) {
        $description .= '<p>お得意様には特別割引があります！</p>';
    }
    return $description;
}

このコードは、ログインしたユーザーがカスタマーの場合に特別割引のメッセージを表示します。

概要

構文