プラグインAdvanced custom fields(ACF)のacf/admin/license_key_constant_messageフィルタの使用方法・解説

概要

acf/admin/license_key_constant_messageフィルタは、Advanced Custom Fields (ACF) プラグインにおいて、ライセンスキーがコードで定義されている場合に、管理画面のメッセージを変更するために使用されます。このフィルタは、ライセンス関連の通知や参加者へのメッセージをカスタマイズする際に役立ちます。以下は、一般的にこのフィルタが使われるシーンの例です。

カスタムメッセージの表示
エラーメッセージの修正
警告メッセージのカスタマイズ
ライセンス状況に応じたメッセージの変更
特定条件下でのメッセージ非表示
管理者向けの通知メッセージの変更

構文

add_filter('acf/admin/license_key_constant_message', 'my_custom_license_message');

パラメータ

string $message: 現在のメッセージの内容。

戻り値

string: 変更後のメッセージ内容。

使用可能なバージョン

ACFバージョン: 5.9.0 以降
WordPressバージョン: 4.0 以降

サンプルコード

サンプルコード 1

add_filter('acf/admin/license_key_constant_message', function($message) {
    return 'カスタムライセンスキーが必要です。詳細は設定ページをご覧ください。';
});

このコードは、ライセンスが必要であることを示すカスタムメッセージに変更します。

サンプルコード 2

add_filter('acf/admin/license_key_constant_message', function($message) {
    return '<strong>注意:</strong> ACFが正しく動作しない可能性があります。ライセンスを確認してください。';
});

このコードは、注意喚起を強調したメッセージに変更します。

サンプルコード 3

add_filter('acf/admin/license_key_constant_message', function($message) {
    if (current_user_can('administrator')) {
        return 'あなたは管理者です。ライセンス状況を確認してください。';
    }
    return $message;
});

このサンプルは、管理者に対して特別なメッセージを表示します。

サンプルコード 4

add_filter('acf/admin/license_key_constant_message', function($message) {
    return strpos($message, '無効') !== false ? 'ライセンスが無効です。再登録してください。' : $message;
});

このコードは、メッセージ内に「無効」という単語が含まれている場合に、特定のメッセージを表示します。

サンプルコード 5

add_filter('acf/admin/license_key_constant_message', function($message) {
    $timestamp = time();
    return 'ライセンスチェック: ' . date('Y-m-d H:i:s', $timestamp);
});

このコードは、メッセージに現在の日時を追加します。

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

アクション	使用例
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

このフィルタは、ACFプラグイン内部で使用されており、上記のアクションでは基本的に利用されていないことがわかります。

概要

構文