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

概要

woocommerce_my_account_my_address_description フィルタは、WooCommerceの「マイアカウント」セクションのユーザーアドレス情報に関連する説明文を変更するために使用されます。このフィルタを利用することで、アドレスの説明をカスタマイズしたり、特定の情報を追加することができます。主に以下のような機能実装時に活用されます。

プロモーション情報の追加
使用条件の説明文の付加
デフォルトの説明文の変更
ユーザーへのインフォメーションの追加
特定のユーザーロール向けのメッセージの表示
カスタムフィールドに基づく説明文の表示

構文

add_filter( 'woocommerce_my_account_my_address_description', 'custom_description' );

function custom_description( $description ) {
    return $description . ' 追加情報';
}

パラメータ

$description (string) – デフォルトの説明文。カスタマイズする内容をここで変更します。

戻り値

カスタマイズされた説明文 (string)

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

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_my_account_my_address_description', function($description) {
    return __('あなたのアドレス情報は、以下の目的で使用されます。', 'text-domain') . ' ' . $description;
});

説明

このサンプルコードは、デフォルトの説明文の前にカスタムメッセージを追加します。このカスタムメッセージは、アドレス情報がどのように使用されるかをユーザーに伝えることを目的としています。

サンプルコード2

add_filter('woocommerce_my_account_my_address_description', function($description) {
    if (current_user_can('premium_member')) {
        return $description . ' お得意様には特別な割引があります！';
    }
    return $description;
});

説明

このコードは、プレミアム会員のユーザーにのみ特別なメッセージを表示します。それ以外のユーザーにはデフォルトの説明文が表示されます。

サンプルコード3

add_filter('woocommerce_my_account_my_address_description', function($description) {
    return str_replace('標準の説明文', '新しいカスタマイズされた説明文', $description);
});

説明

このサンプルでは、既存の説明文の一部を新しいテキストに置き換えてカスタマイズしています。

サンプルコード4

add_filter('woocommerce_my_account_my_address_description', function($description) {
    return '<strong>注意:</strong> アドレス情報は厳重に管理されます。' . $description;
});

説明

このコードは、説明文の先頭に注意を喚起するメッセージを強調して追加します。ユーザーに対して安心感を与えることを目的とします。

サンプルコード5

add_filter('woocommerce_my_account_my_address_description', function($description) {
    $additional_info = get_option('custom_address_info', 'デフォルトの情報');
    return $description . ' ' . $additional_info;
});

説明

このサンプルでは、WordPressのオプションから取得したカスタム情報を追加しています。これにより、管理画面から簡単に表示内容を変更できるようになります。

概要

構文