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

概要

woocommerce_kses_notice_allowed_tagsフィルタは、WooCommerceでのユーザーノーティスやメッセージの出力時に許可されるHTMLタグを制御するために使用されます。このフィルタを使うことで、特定のHTMLタグを追加したり、削除したりすることができ、ユーザーが見る情報をカスタマイズできます。

よく使われる機能は次のとおりです：
1. メッセージ内の特定のリンクを許可する。
2. スタイルタグの追加によるメッセージのカスタマイズ。
3. HTMLリストを使用してメッセージをフォーマット。
4. 他のプラグインやテーマとの互換性を持たせるためのタグ調整。
5. 通知メッセージの視覚的な強調を目的とした追加タグの許可。
6. カスタムメッセージでSEO対策としてのHTML使用を許可。

構文

add_filter('woocommerce_kses_notice_allowed_tags', 'custom_allowed_tags');

パラメータ

allowed_tags: 許可されるHTMLタグの配列。

戻り値

修正されたHTMLタグの配列。

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

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_kses_notice_allowed_tags', 'add_custom_allowed_tags');

function add_custom_allowed_tags($allowed_tags) {
    $allowed_tags['strong'] = array();
    $allowed_tags['em'] = array();
    return $allowed_tags;
}

このサンプルコードでは、ユーザー通知メッセージに <strong> と <em> タグを追加して、強調表示を可能にします。

サンプルコード2

add_filter('woocommerce_kses_notice_allowed_tags', 'allow_custom_links');

function allow_custom_links($allowed_tags) {
    $allowed_tags['a'] = array(
        'href' => array(),
        'title' => array()
    );
    return $allowed_tags;
}

このコードは、通知メッセージ内でのリンク (<a> タグ) を許可し、属性として href と title を追加できます。

サンプルコード3

add_filter('woocommerce_kses_notice_allowed_tags', 'add_image_tag');

function add_image_tag($allowed_tags) {
    $allowed_tags['img'] = array(
        'src' => array(),
        'alt' => array(),
        'title' => array()
    );
    return $allowed_tags;
}

このサンプルコードは、通知メッセージ内に画像を表示するために <img> タグを追加し、src、alt、title 属性を許可します。

サンプルコード4

add_filter('woocommerce_kses_notice_allowed_tags', 'allow_list_tags');

function allow_list_tags($allowed_tags) {
    $allowed_tags['ul'] = array();
    $allowed_tags['ol'] = array();
    $allowed_tags['li'] = array();
    return $allowed_tags;
}

この例では、ユーザーへ見やすく情報を提供するため、リストタグ (<ul>, <ol>, <li>) を通知メッセージで使用可能にします。

サンプルコード5

add_filter('woocommerce_kses_notice_allowed_tags', 'modify_span_tag');

function modify_span_tag($allowed_tags) {
    $allowed_tags['span'] = array(
        'style' => array()
    );
    return $allowed_tags;
}

このサンプルコードでは、<span> タグを修正し、スタイル属性を許可することで、通知メッセージの一部にカスタムスタイルを適用できるようにします。

概要

構文