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

概要

woocommerce_product_dimensionsフィルタは、WooCommerceの製品ページで表示される製品のサイズ情報をカスタマイズする際に使用されます。このフィルタを利用することで、製品の寸法を変更したり、新しい情報を追加することが可能です。主に以下のような機能を実装する際に使われることが一般的です。

製品の寸法を別のフォーマットで表示
追加の寸法情報を製品ページに表示
製品の寸法を基にしたオプション設定のカスタマイズ
製品のサイズ情報に基づく計算や表示の変更
国や地域による寸法表記の変換
UI/UX向上のための寸法情報のスタイリング変更

このフィルタは、WooCommerceバージョン3.0以降とWordPressバージョン4.0以降で利用可能です。

構文

add_filter('woocommerce_product_dimensions', 'your_custom_function');

パラメータ

$dimensions (string) – 製品の寸法情報。通常は長さ×幅×高さの形式で提供されます。

戻り値

(string) – 変更された寸法情報。

この関数のアクションでの使用可能性

アクション	使用可能性
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_product_dimensions', 'custom_product_dimensions_format');

function custom_product_dimensions_format($dimensions) {
    return "Size: " . $dimensions; // 元の寸法情報の前に「Size:」を追加
}

このコードは、製品の寸法情報の前に「Size:」というプレフィックスを追加します。

サンプルコード 2: 寸法についての追加情報を追加

add_filter('woocommerce_product_dimensions', 'add_additional_info_to_dimensions');

function add_additional_info_to_dimensions($dimensions) {
    return $dimensions . ' (including packaging)'; // 包装を含む旨を追加
}

このコードは、元の寸法情報に「(including packaging)」を追加しています。

サンプルコード 3: 寸法情報を特定の条件下で変更

add_filter('woocommerce_product_dimensions', 'conditionally_change_dimensions');

function conditionally_change_dimensions($dimensions) {
    if (is_product() && has_term('large', 'product_cat')) {
        return str_replace('cm', 'cm (for large items)', $dimensions); // 大きな商品の場合、説明を変更
    }
    return $dimensions;
}

このコードは、大きな商品カテゴリーに属する製品でのみ寸法情報を変更します。

サンプルコード 4: 寸法の単位を変更

add_filter('woocommerce_product_dimensions', 'change_dimension_unit');

function change_dimension_unit($dimensions) {
    return str_replace('cm', 'inches', $dimensions); // cmをinchesに変更
}

このコードでは、寸法表示の単位をセンチメートルからインチに変更しています。

サンプルコード 5: 寸法情報をスタイル付きで表示

add_filter('woocommerce_product_dimensions', 'styled_product_dimensions');

function styled_product_dimensions($dimensions) {
    return '<span style="font-weight:bold; color:red;">' . $dimensions . '</span>'; // 寸法情報を太字と赤色に
}

このコードは、寸法情報を太字で赤く表示するスタイルを追加しています。

引用元:
– https://developer.wordpress.org/reference/hooks/woocommerce_product_dimensions/
– https://wordpress.org/plugins/woocommerce/

概要

構文