プラグインNinja Formsのninja_forms_plugin_settings_groupsアクションの使用方法・解説

概要

ninja_forms_plugin_settings_groups アクションフックは、Ninja Formsプラグインの設定画面にカスタム設定グループを追加するために使用されます。このアクションを利用することで、独自の機能やオプションを設定ページに統合することができます。具体的な使用例としては以下が考えられます：

サードパーティサービスとの連携設定を追加
フォーム作成時のデフォルト設定の管理
管理者専用設定の追加
プラグインの新機能に対するユーザーガイダンスの提供
フォームのテーマやスタイル設定の追加
フィルタ機能による入力データの保存設定

構文

add_action('ninja_forms_plugin_settings_groups', 'your_custom_function');

パラメータ

groups（array）：既存の設定グループの配列。
form_id（int）：特定のフォームに関連するグループが必要な場合のID。

戻り値

このアクションフックは、特別な戻り値はありませんが、設定グループを追加することで、管理画面のユーザーエクスペリエンスを向上させます。

バージョン

Ninja Forms: 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_action('ninja_forms_plugin_settings_groups', function($groups) {
    $groups[] = array(
        'id' => 'third_party_integration',
        'name' => __('Third Party Integration', 'ninja-forms'),
        'icon' => 'dashicons-admin-network'
    );

    return $groups;
});

このサンプルコードは「Third Party Integration」という設定グループを追加します。

サンプル2: フォームのデフォルト設定の管理

add_action('ninja_forms_plugin_settings_groups', function($groups) {
    $groups[] = array(
        'id' => 'default_settings',
        'name' => __('Default Form Settings', 'ninja-forms'),
        'icon' => 'dashicons-schedule'
    );

    return $groups;
});

このコードはデフォルトのフォーム設定を管理するためのグループを追加します。

サンプル3: 管理者専用の設定を追加

add_action('ninja_forms_plugin_settings_groups', function($groups) {
    if (current_user_can('administrator')) {
        $groups[] = array(
            'id' => 'admin_only',
            'name' => __('Admin Only Settings', 'ninja-forms'),
            'icon' => 'dashicons-lock'
        );
    }

    return $groups;
});

このサンプルは、管理者のみがアクセスできる設定グループを追加します。

サンプル4: プラグインの新機能用説明を追加

add_action('ninja_forms_plugin_settings_groups', function($groups) {
    $groups[] = array(
        'id' => 'new_features',
        'name' => __('New Features', 'ninja-forms'),
        'icon' => 'dashicons-star-filled'
    );

    return $groups;
});

この例は、新機能用の説明を追加するための設定グループを作成します。

サンプル5: フォームテーマ設定グループの追加

add_action('ninja_forms_plugin_settings_groups', function($groups) {
    $groups[] = array(
        'id' => 'theme_settings',
        'name' => __('Form Theme Settings', 'ninja-forms'),
        'icon' => 'dashicons-admin-customizer'
    );

    return $groups;
});

このサンプルは、フォームのテーマ設定を管理するためのグループを追加します。

概要

構文