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

概要

woocommerce_shipping_may_be_available_html フィルタは、WooCommerceの配送オプションが利用可能かどうかを表示する際に、カスタマイズを行うために使用されます。このフィルタを使うことで、配送に関するメッセージの内容や表示方法を変更することができます。具体的には、以下のような機能に対応する際によく使われます。

配送オプションの可用性メッセージのカスタマイズ
特定の条件に基づいたメッセージの追加
デザインの変更やスタイルの適用
他のプラグインやテーマとの統合における通知メッセージの調整
ユーザーへの特別なプロモーション情報の表示
地域や国に基づくカスタマイズメッセージの表示

構文

add_filter( 'woocommerce_shipping_may_be_available_html', 'your_custom_function', 10, 2 );

パラメータ
– $html: 既存のHTMLメッセージ
– $package: 配送パッケージ情報の配列

戻り値
カスタマイズされたHTMLメッセージ（string）

使用可能なバージョン
– WooCommerce: 3.0以上
– WordPress: 4.7以上

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

アクション	使用例
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_shipping_may_be_available_html', 'custom_shipping_availability_message', 10, 2 );

function custom_shipping_availability_message( $html, $package ) {
    // 特定の地域に対して特別なメッセージを追加
    if ( isset( $package['destination'] ) && $package['destination']['country'] === 'JP' ) {
        $html .= '<p>日本への発送は通常3-4日掛かります。</p>';
    }
    return $html;
}

このコードは、日本の配送先に対して追加のメッセージを表示します。

サンプルコード2

add_filter( 'woocommerce_shipping_may_be_available_html', 'highlight_shipping_option', 10, 2 );

function highlight_shipping_option( $html, $package ) {
    // 目立たせるためにスタイルを追加
    return '<div style="color: red; font-weight: bold;">' . $html . '</div>';
}

このコードは、配送オプションの可用性メッセージを赤色の太字で表示します。

サンプルコード3

add_filter( 'woocommerce_shipping_may_be_available_html', 'append_special_offer_message', 10, 2 );

function append_special_offer_message( $html, $package ) {
    // 特別オファー情報を追加
    return $html . '<p>現在、送料無料キャンペーン中です！</p>';
}

このコードは、配送メッセージの最後に送料無料キャンペーンのメッセージを追加します。

サンプルコード4

add_filter( 'woocommerce_shipping_may_be_available_html', 'conditional_offer_for_holidays', 10, 2 );

function conditional_offer_for_holidays( $html, $package ) {
    // 祝日にスペシャルメッセージを表示
    if ( date( 'm-d' ) === '12-25' ) {
        $html .= '<p>メリークリスマス！特別配送オファーあり。</p>';
    }
    return $html;
}

このコードは、クリスマスの日に特別なメッセージを追加します。

サンプルコード5

add_filter( 'woocommerce_shipping_may_be_available_html', 'remove_default_message', 10, 2 );

function remove_default_message( $html, $package ) {
    // デフォルトのメッセージを削除
    return '';
}

このコードは、配送の可用性に関するデフォルトメッセージを表示しないようにします。

概要