プラグインWooCommerceのwoocommerce_archive_descriptionアクションの使用方法・解説

概要

woocommerce_archive_description は、WooCommerce のアーカイブページにおいて、製品カテゴリーやタグの説明を表示するためのフックです。このアクションは主に以下のような機能を実装する際に使用されます。

カテゴリーまたはタグのカスタム説明を表示する
SEO に関連するメタ情報を追加する
カテゴリーの画像を表示する
特別なプロモーションメッセージを挿入する
メタデータを使用した詳細な統計情報を提示する
カスタムスタイリングやレイアウトの追加

構文

do_action( 'woocommerce_archive_description' );

パラメータ

このアクションには、直接的なパラメータはありません。カスタム機能を持つコールバック関数を作成することで、アーカイブの説明部分をカスタマイズできます。

戻り値

このアクションは戻り値を持ちません。

使用可能なプラグイン WooCommerce のバージョン

WooCommerce 3.0 以降で可能です。

使用可能な WordPress のバージョン

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_action( 'woocommerce_archive_description', 'custom_category_description' );
function custom_category_description() {
    if ( is_product_category() ) {
        echo '<div class="custom-description">このカテゴリーの製品は特におすすめです。</div>';
    }
}

このサンプルコードでは、製品カテゴリーのアーカイブページでカスタムメッセージを表示します。

サンプル 2: SEO メタ情報の追加

add_action( 'woocommerce_archive_description', 'add_seo_meta_description' );
function add_seo_meta_description() {
    if ( is_product_tag() ) {
        echo '<meta name="description" content="このタグに関連する製品の詳細説明。">';
    }
}

このコードでは、製品タグアーカイブ用に SEO メタ情報を追加しています。

サンプル 3: カテゴリー画像の表示

add_action( 'woocommerce_archive_description', 'display_category_image' );
function display_category_image() {
    if ( is_product_category() ) {
        $thumbnail_id = get_woocommerce_term_meta( get_queried_object()->term_id, 'thumbnail_id', true );
        $image = wp_get_attachment_url( $thumbnail_id );
        if ( $image ) {
            echo '<img src="' . esc_url( $image ) . '" alt="' . esc_attr( single_cat_title( '', false ) ) . '" />';
        }
    }
}

このサンプルは、製品カテゴリーの画像をアーカイブページに表示します。

サンプル 4: プロモーションメッセージの追加

add_action( 'woocommerce_archive_description', 'insert_promotion_message' );
function insert_promotion_message() {
    echo '<div class="promotion-message">今月の特別ディスカウントをお見逃しなく！</div>';
}

このサンプルでは、アーカイブページにプロモーションメッセージを表示しています。

サンプル 5: カスタムスタイリングの適用

add_action( 'woocommerce_archive_description', 'add_custom_style_to_description' );
function add_custom_style_to_description() {
    echo '<style>.custom-description { color: red; font-weight: bold; }</style>';
}

上記のコードはアーカイブページにカスタムスタイリングを追加し、特定の要素にスタイルを適用します。

概要

構文