プラグインNinja Formsのninja_forms_update_setting_{$setting_id}アクションの使用方法・解説

概要

ninja_forms_update_setting_{$setting_id} アクションは、Ninja Formsプラグインで特定の設定が更新されたときにフックされるアクションです。このフックを使用すると、設定が変更されるたびに特定のロジックを実行できます。例えば、カスタムな設定ロジックやログの作成などが考えられます。

よく使われる機能

設定の変更時にカスタムバリデーションを追加する
変更された設定値を外部APIに送信する
ユーザーに通知メッセージを表示する
設定変更の履歴をデータベースに保存する
特定の条件下で他のプラグインや機能と連携する
管理者ダッシュボードにカスタムのログを表示する

構文

add_action('ninja_forms_update_setting_{$setting_id}', 'your_custom_function');

パラメータ

$setting_id: 更新された設定のID（文字列型）
$value: 更新された値（任意の型）

戻り値

このアクションには戻り値はありません。実行される際は、特定の処理を行います。

使用可能なバージョン

Ninja Formsバージョン: 3.3.0以降
WordPressバージョン: 4.9.0以降

サンプルコード

サンプル1: 設定変更時の通知を表示

add_action('ninja_forms_update_setting_custom_email', 'notify_admin_on_setting_change');

function notify_admin_on_setting_change($value) {
    // 管理者に通知を送信
    wp_mail('admin@example.com', '設定が変更されました', '新しい設定値: ' . $value);
}

このコードは、特定の設定が変更されたときに、管理者にメール通知を送る機能を実装しています。

サンプル2: APIへの値を送信

add_action('ninja_forms_update_setting_api_endpoint', 'send_data_to_api');

function send_data_to_api($value) {
    $response = wp_remote_post('https://example.com/api/endpoint', array(
        'body' => json_encode(array('new_value' => $value)),
        'headers' => array('Content-Type' => 'application/json'),
    ));
}

このコードは、設定の更新時にAPIに新しい値をPOSTする機能を実装しています。

サンプル3: 設定値の履歴を保存

add_action('ninja_forms_update_setting_form_title', 'save_setting_change_history');

function save_setting_change_history($value) {
    global $wpdb;
    $wpdb->insert(
        'wp_setting_history',
        array(
            'setting_value' => $value,
            'changed_at' => current_time('mysql'),
        )
    );
}

このコードは、変更された設定値をデータベースの履歴テーブルに保存する機能を実装しています。

サンプル4: 特定の条件で他のプラグインと連携

add_action('ninja_forms_update_setting_custom_option', 'connect_with_other_plugin');

function connect_with_other_plugin($value) {
    if ($value == '特定の条件') {
        do_action('other_plugin_specific_action', $value);
    }
}

このコードは、設定が特定の条件を満たした場合に、他のプラグインのアクションを呼び出す機能を実装しています。

サンプル5: 設定変更のログを管理ダッシュボードに表示

add_action('ninja_forms_update_setting_custom_log', 'log_setting_change');

function log_setting_change($value) {
    error_log('設定が変更されました。新しい値: ' . $value);
}

このコードは、設定が変更されるたびに、PHPエラーログにその情報を記録する機能を実装しています。

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

アクション	使用可能性
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

概要