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

概要

woocommerce_price_trim_zerosは、WooCommerceプラグイン内で価格を表示する際に、数値の末尾にあるゼロを削除するために使用されるフィルターフックです。このフィルターを使用することで、価格表示がよりシンプルかつ見やすくなり、特に通貨の小数点以下が不必要に表示されるのを防ぐことができます。次のような機能を実装する際によく使われます。

見た目を整えるための価格フォーマッティング
セール価格と通常価格の表示を適切に調整
通貨の表示形式を変更する際のカスタマイズ
高額商品の表示を分かりやすくするための調整
消費者向けの価格表示を明確にする
国や地域による異なる価格表示形式への対応

このフィルタは、WooCommerceのさまざまなバージョンで利用可能で、WordPressの最新バージョンでもサポートされています。

構文

add_filter( 'woocommerce_price_trim_zeros', 'your_custom_function' );

パラメータ

$trim: デフォルトはtrueまたはfalse。価格のゼロを削除するかどうかの設定。
$price: フィルターが適用される元の価格文字列。

戻り値

調整された価格の文字列。

バージョン情報

WooCommerce: 対応はバージョン3.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_price_trim_zeros', function( $trim ) {
    return true;
});

サンプルコード2: 特定の通貨のためにカスタマイズ

特定の通貨に対して小数点以下を削除するためのコードです。

add_filter( 'woocommerce_price_trim_zeros', function( $trim, $price ) {
    if (strpos($price, '¥') !== false) {
        return true;
    }
    return $trim;
}, 10, 2);

サンプルコード3: セール価格のみトリム

セール価格のみを対象とするコードです。

add_filter( 'woocommerce_price_trim_zeros', function( $trim, $price ) {
    global $product;
    if ($product->is_on_sale()) {
        return true;
    }
    return $trim;
}, 10, 2);

サンプルコード4: 特定のカテゴリーの価格をフォーマット

特定のカテゴリーの商品価格に対してフィルタを適用するコードです。

add_filter( 'woocommerce_price_trim_zeros', function( $trim, $price ) {
    if (has_term('特定カテゴリー', 'product_cat')) {
        return true;
    }
    return $trim;
}, 10, 2);

サンプルコード5: メンバーシップ価格の表示

メンバーシップ価格に特別なフォーマットを適用するコードです。

add_filter( 'woocommerce_price_trim_zeros', function( $trim, $price ) {
    if (is_user_logged_in() && user_can(get_current_user_id(), 'membership')) {
        return true;
    }
    return $trim;
}, 10, 2);

これらのサンプルコードは、WooCommerceで価格を表示する際に、ゼロを削除したり、特定の条件に応じてフォーマットを変更したりする方法を示しています。詳細な実装方法は、WooCommerceのドキュメントやフォーラムで探すことができます。

概要

構文