ninja-forms-example-admin-settings.php

<?php if ( ! defined( 'ABSPATH' ) ) exit;

/**
 * Class NF_Example_Admin_Settings
 *
 * This is an example implementation of a Settings Class for a Ninja Forms Add-on.
 * The Ninja Forms Settings Submenu page handles registering, rendering, and saving settings.
 * Settings handled by Ninja Forms can be access using the Ninja Forms API.
 * Multiple WordPress Hooks are available for interacting with settings processing.
 */
final class NF_Example_Admin_Settings
{
    /**
     * NF_Example_Admin_Settings constructor.
     *
     * The following WordPress hooks are listed in processing order.
     */
    public function __construct()
    {
        /*
         * On Settings Page Load
         */
        add_filter( 'ninja_forms_plugin_settings',                array( $this, 'plugin_settings'        ), 10, 1 );
        add_filter( 'ninja_forms_plugin_settings_groups',         array( $this, 'plugin_settings_groups' ), 10, 1 );
        add_filter( 'ninja_forms_check_setting_example_setting',  array( $this, 'check_example_setting'  ), 10, 1 );

        /*
         * On Settings Page Save (Submit)
         */
        add_filter( 'ninja_forms_update_setting_example_setting', array( $this, 'update_example_setting' ), 10, 1 );
        add_action( 'ninja_forms_save_setting_example_setting',   array( $this, 'save_example_setting'   ), 10, 1 );
    }

    /**
     * Add Plugin Settings
     *
     * Add a new setting within a defined setting group.
     * The setting's configuration is similar to Action Settings and Fields Settings.
     *
     * @param array $settings
     * @return array $settings
     */
    public function plugin_settings( $settings )
    {
        $settings[ 'example' ] = array(
            'example_setting' => array(
                'id'    => 'example_setting',
                'type'  => 'textbox',
                'label'  => __( 'Example Setting', 'ninja-forms-example' ),
                'desc'  => __( 'This is an example setting.', 'ninja-forms-example' ),
            ),
        );
        return $settings;
    }

    /**
     * Add Plugin Settings Groups
     *
     * Add a new Settings Groups for this plugin's settings.
     * The grouped settings will be rendered as a metabox in the Ninja Forms Settings Submenu page.
     *
     * @param array $groups
     * @return array $groups
     */
    public function plugin_settings_groups( $groups )
    {
        $groups[ 'example' ] = array(
            'id' => 'example',
            'label' => __( 'Example Settings', 'ninja-forms-example' ),
        );
        return $groups;
    }

    /**
     * Check Example Setting for Errors
     *
     * Before the Example Setting is disaplyed, check for / add errors for display.
     * Note: This check is performed when the Ninja Forms Settings Submenu page is loaded.
     *
     * @param array $setting
     * @return array $setting
     */
    public function check_example_setting( $setting )
    {
        if( $has_errors ) {
            $setting['errors'][] = __('The value you have entered appears to be invalid.', 'ninja-forms-example');
        }
        return $setting;
    }

    /**
     * Update Example Setting Value
     *
     * Before the Example Setting is saved, update the value.
     *
     * @param $setting
     * @return mixed
     */
    public function update_example_setting( $setting_value )
    {
        $setting_value = trim( $setting_value );
        return $setting_value;
    }

    /**
     * Save Example Setting
     *
     * After the Example Setting is saved, do something with the saved value.
     *
     * @param $setting
     * @return void
     */
    public function save_example_setting( $setting_value )
    {
        if( strpos( $setting_value, '_' ) ){
            $parts = explode( '_', $setting_value );

            foreach( $parts as $key => $value ){
                Ninja_Forms()->update_setting( 'example_part_' . $key, $value );
            }
        }
    }

} // End Class NF_Example_Admin_Settings