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

概要

woocommerce_admin_obsolete_notes_namesフィルタは、WooCommerceの管理パネルで表示される古い通知メッセージの名前を変更または除外するために使用されます。このフィルタは、サイトのメンテナンスや特定のエラー通知のカスタマイズを行いたい場合に便利です。以下は、このフィルタが実際の開発において頻繁に使用されるシナリオの例です：

古いプラグインに関する警告を非表示にする
特定の条件下でのみ通知を表示する
トランスレーション（翻訳）を行う際に通知メッセージをカスタマイズする
競合するプラグインが原因での通知の表示を制御する
特定のユーザーにだけ異なる情報を表示する
カスタムフィルタリングロジックを実装し、通知を管理する

構文

add_filter('woocommerce_admin_obsolete_notes_names', 'custom_function_name');

パラメータ

$obsolete_notes（配列）：古い通知メッセージの名前を含む配列。

戻り値

フィルタリングされた古い通知名の配列。

使用可能なバージョン

WooCommerce：4.0以降
WordPress：5.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_admin_obsolete_notes_names', function($obsolete_notes) {
    unset($obsolete_notes['old_plugin_warning']);
    return $obsolete_notes;
});

このコードは、特定の古いプラグインに関する警告メッセージを管理パネルから非表示にします。

サンプル2

add_filter('woocommerce_admin_obsolete_notes_names', function($obsolete_notes) {
    if (current_user_can('administrator')) {
        unset($obsolete_notes['deprecated_settings']);
    }
    return $obsolete_notes;
});

このコードは、管理者ユーザーの場合、一定の設定の旧版通知メッセージを削除します。

サンプル3

add_filter('woocommerce_admin_obsolete_notes_names', function($obsolete_notes) {
    if (!is_plugin_active('specific-plugin/specific-plugin.php')) {
        unset($obsolete_notes['update_notice']);
    }
    return $obsolete_notes;
});

このコードは、指定のプラグインが無効化されている場合に、更新通知を非表示にします。

サンプル4

add_filter('woocommerce_admin_obsolete_notes_names', function($obsolete_notes) {
    $obsolete_notes['custom_message'] = __('This is a custom message.', 'text-domain');
    return $obsolete_notes;
});

このコードは、新しいカスタムメッセージを通知に追加します。

サンプル5

add_filter('woocommerce_admin_obsolete_notes_names', function($obsolete_notes) {
    if (get_option('hide_deprecated_notices')) {
        unset($obsolete_notes['legacy_feature_usage']);
    }
    return $obsolete_notes;
});

このコードは、特定のオプションが有効な場合にレガシー機能に関する通知を非表示にします。

概要

構文