eventespresso / event-espresso-core

core/EE_Config.core.php

Indentation +3154 added lines, -3154 removed lines

@@ -14,2509 +14,2509 @@ 
 final class EE_Config implements ResettableInterface
 {
 
-    const OPTION_NAME = 'ee_config';
-
-    const LOG_NAME = 'ee_config_log';
-
-    const LOG_LENGTH = 100;
-
-    const ADDON_OPTION_NAMES = 'ee_config_option_names';
-
-    /**
-     *    instance of the EE_Config object
-     *
-     * @var    EE_Config $_instance
-     * @access    private
-     */
-    private static $_instance;
-
-    /**
-     * @var boolean $_logging_enabled
-     */
-    private static $_logging_enabled = false;
-
-    /**
-     * @var LegacyShortcodesManager $legacy_shortcodes_manager
-     */
-    private $legacy_shortcodes_manager;
-
-    /**
-     * An StdClass whose property names are addon slugs,
-     * and values are their config classes
-     *
-     * @var StdClass
-     */
-    public $addons;
-
-    /**
-     * @var EE_Admin_Config
-     */
-    public $admin;
-
-    /**
-     * @var EE_Core_Config
-     */
-    public $core;
-
-    /**
-     * @var EE_Currency_Config
-     */
-    public $currency;
-
-    /**
-     * @var EE_Organization_Config
-     */
-    public $organization;
-
-    /**
-     * @var EE_Registration_Config
-     */
-    public $registration;
-
-    /**
-     * @var EE_Template_Config
-     */
-    public $template_settings;
-
-    /**
-     * Holds EE environment values.
-     *
-     * @var EE_Environment_Config
-     */
-    public $environment;
-
-    /**
-     * settings pertaining to Google maps
-     *
-     * @var EE_Map_Config
-     */
-    public $map_settings;
-
-    /**
-     * settings pertaining to Taxes
-     *
-     * @var EE_Tax_Config
-     */
-    public $tax_settings;
-
-    /**
-     * Settings pertaining to global messages settings.
-     *
-     * @var EE_Messages_Config
-     */
-    public $messages;
-
-    /**
-     * @deprecated
-     * @var EE_Gateway_Config
-     */
-    public $gateway;
-
-    /**
-     * @var    array $_addon_option_names
-     * @access    private
-     */
-    private $_addon_option_names = array();
-
-    /**
-     * @var    array $_module_route_map
-     * @access    private
-     */
-    private static $_module_route_map = array();
-
-    /**
-     * @var    array $_module_forward_map
-     * @access    private
-     */
-    private static $_module_forward_map = array();
-
-    /**
-     * @var    array $_module_view_map
-     * @access    private
-     */
-    private static $_module_view_map = array();
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @access    public
-     * @return EE_Config instance
-     */
-    public static function instance()
-    {
-        // check if class object is instantiated, and instantiated properly
-        if (! self::$_instance instanceof EE_Config) {
-            self::$_instance = new self();
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * Resets the config
-     *
-     * @param bool    $hard_reset    if TRUE, sets EE_CONFig back to its original settings in the database. If FALSE
-     *                               (default) leaves the database alone, and merely resets the EE_Config object to
-     *                               reflect its state in the database
-     * @param boolean $reinstantiate if TRUE (default) call instance() and return it. Otherwise, just leave
-     *                               $_instance as NULL. Useful in case you want to forget about the old instance on
-     *                               EE_Config, but might not be ready to instantiate EE_Config currently (eg if the
-     *                               site was put into maintenance mode)
-     * @return EE_Config
-     */
-    public static function reset($hard_reset = false, $reinstantiate = true)
-    {
-        if (self::$_instance instanceof EE_Config) {
-            if ($hard_reset) {
-                self::$_instance->legacy_shortcodes_manager = null;
-                self::$_instance->_addon_option_names = array();
-                self::$_instance->_initialize_config();
-                self::$_instance->update_espresso_config();
-            }
-            self::$_instance->update_addon_option_names();
-        }
-        self::$_instance = null;
-        // we don't need to reset the static properties imo because those should
-        // only change when a module is added or removed. Currently we don't
-        // support removing a module during a request when it previously existed
-        if ($reinstantiate) {
-            return self::instance();
-        } else {
-            return null;
-        }
-    }
-
-
-    /**
-     *    class constructor
-     *
-     * @access    private
-     */
-    private function __construct()
-    {
-        do_action('AHEE__EE_Config__construct__begin', $this);
-        EE_Config::$_logging_enabled = apply_filters('FHEE__EE_Config___construct__logging_enabled', false);
-        // setup empty config classes
-        $this->_initialize_config();
-        // load existing EE site settings
-        $this->_load_core_config();
-        // confirm everything loaded correctly and set filtered defaults if not
-        $this->_verify_config();
-        //  register shortcodes and modules
-        add_action(
-            'AHEE__EE_System__register_shortcodes_modules_and_widgets',
-            array($this, 'register_shortcodes_and_modules'),
-            999
-        );
-        //  initialize shortcodes and modules
-        add_action('AHEE__EE_System__core_loaded_and_ready', array($this, 'initialize_shortcodes_and_modules'));
-        // register widgets
-        add_action('widgets_init', array($this, 'widgets_init'), 10);
-        // shutdown
-        add_action('shutdown', array($this, 'shutdown'), 10);
-        // construct__end hook
-        do_action('AHEE__EE_Config__construct__end', $this);
-        // hardcoded hack
-        $this->template_settings->current_espresso_theme = 'Espresso_Arabica_2014';
-    }
-
-
-    /**
-     * @return boolean
-     */
-    public static function logging_enabled()
-    {
-        return self::$_logging_enabled;
-    }
-
-
-    /**
-     * use to get the current theme if needed from static context
-     *
-     * @return string current theme set.
-     */
-    public static function get_current_theme()
-    {
-        return isset(self::$_instance->template_settings->current_espresso_theme)
-            ? self::$_instance->template_settings->current_espresso_theme : 'Espresso_Arabica_2014';
-    }
-
-
-    /**
-     *        _initialize_config
-     *
-     * @access private
-     * @return void
-     */
-    private function _initialize_config()
-    {
-        EE_Config::trim_log();
-        // set defaults
-        $this->_addon_option_names = get_option(EE_Config::ADDON_OPTION_NAMES, array());
-        $this->addons = new stdClass();
-        // set _module_route_map
-        EE_Config::$_module_route_map = array();
-        // set _module_forward_map
-        EE_Config::$_module_forward_map = array();
-        // set _module_view_map
-        EE_Config::$_module_view_map = array();
-    }
-
-
-    /**
-     *        load core plugin configuration
-     *
-     * @access private
-     * @return void
-     */
-    private function _load_core_config()
-    {
-        // load_core_config__start hook
-        do_action('AHEE__EE_Config___load_core_config__start', $this);
-        $espresso_config = $this->get_espresso_config();
-        foreach ($espresso_config as $config => $settings) {
-            // load_core_config__start hook
-            $settings = apply_filters(
-                'FHEE__EE_Config___load_core_config__config_settings',
-                $settings,
-                $config,
-                $this
-            );
-            if (is_object($settings) && property_exists($this, $config)) {
-                $this->{$config} = apply_filters('FHEE__EE_Config___load_core_config__' . $config, $settings);
-                // call configs populate method to ensure any defaults are set for empty values.
-                if (method_exists($settings, 'populate')) {
-                    $this->{$config}->populate();
-                }
-                if (method_exists($settings, 'do_hooks')) {
-                    $this->{$config}->do_hooks();
-                }
-            }
-        }
-        if (apply_filters('FHEE__EE_Config___load_core_config__update_espresso_config', false)) {
-            $this->update_espresso_config();
-        }
-        // load_core_config__end hook
-        do_action('AHEE__EE_Config___load_core_config__end', $this);
-    }
-
-
-    /**
-     *    _verify_config
-     *
-     * @access    protected
-     * @return    void
-     */
-    protected function _verify_config()
-    {
-        $this->core = $this->core instanceof EE_Core_Config
-            ? $this->core
-            : new EE_Core_Config();
-        $this->core = apply_filters('FHEE__EE_Config___initialize_config__core', $this->core);
-        $this->organization = $this->organization instanceof EE_Organization_Config
-            ? $this->organization
-            : new EE_Organization_Config();
-        $this->organization = apply_filters(
-            'FHEE__EE_Config___initialize_config__organization',
-            $this->organization
-        );
-        $this->currency = $this->currency instanceof EE_Currency_Config
-            ? $this->currency
-            : new EE_Currency_Config();
-        $this->currency = apply_filters('FHEE__EE_Config___initialize_config__currency', $this->currency);
-        $this->registration = $this->registration instanceof EE_Registration_Config
-            ? $this->registration
-            : new EE_Registration_Config();
-        $this->registration = apply_filters(
-            'FHEE__EE_Config___initialize_config__registration',
-            $this->registration
-        );
-        $this->admin = $this->admin instanceof EE_Admin_Config
-            ? $this->admin
-            : new EE_Admin_Config();
-        $this->admin = apply_filters('FHEE__EE_Config___initialize_config__admin', $this->admin);
-        $this->template_settings = $this->template_settings instanceof EE_Template_Config
-            ? $this->template_settings
-            : new EE_Template_Config();
-        $this->template_settings = apply_filters(
-            'FHEE__EE_Config___initialize_config__template_settings',
-            $this->template_settings
-        );
-        $this->map_settings = $this->map_settings instanceof EE_Map_Config
-            ? $this->map_settings
-            : new EE_Map_Config();
-        $this->map_settings = apply_filters(
-            'FHEE__EE_Config___initialize_config__map_settings',
-            $this->map_settings
-        );
-        $this->environment = $this->environment instanceof EE_Environment_Config
-            ? $this->environment
-            : new EE_Environment_Config();
-        $this->environment = apply_filters(
-            'FHEE__EE_Config___initialize_config__environment',
-            $this->environment
-        );
-        $this->tax_settings = $this->tax_settings instanceof EE_Tax_Config
-            ? $this->tax_settings
-            : new EE_Tax_Config();
-        $this->tax_settings = apply_filters(
-            'FHEE__EE_Config___initialize_config__tax_settings',
-            $this->tax_settings
-        );
-        $this->messages = apply_filters('FHEE__EE_Config__initialize_config__messages', $this->messages);
-        $this->messages = $this->messages instanceof EE_Messages_Config
-            ? $this->messages
-            : new EE_Messages_Config();
-        $this->gateway = $this->gateway instanceof EE_Gateway_Config
-            ? $this->gateway
-            : new EE_Gateway_Config();
-        $this->gateway = apply_filters('FHEE__EE_Config___initialize_config__gateway', $this->gateway);
-        $this->legacy_shortcodes_manager = null;
-    }
-
-
-    /**
-     *    get_espresso_config
-     *
-     * @access    public
-     * @return    array of espresso config stuff
-     */
-    public function get_espresso_config()
-    {
-        // grab espresso configuration
-        return apply_filters(
-            'FHEE__EE_Config__get_espresso_config__CFG',
-            get_option(EE_Config::OPTION_NAME, array())
-        );
-    }
-
-
-    /**
-     *    double_check_config_comparison
-     *
-     * @access    public
-     * @param string $option
-     * @param        $old_value
-     * @param        $value
-     */
-    public function double_check_config_comparison($option = '', $old_value, $value)
-    {
-        // make sure we're checking the ee config
-        if ($option === EE_Config::OPTION_NAME) {
-            // run a loose comparison of the old value against the new value for type and properties,
-            // but NOT exact instance like WP update_option does (ie: NOT type safe comparison)
-            if ($value != $old_value) {
-                // if they are NOT the same, then remove the hook,
-                // which means the subsequent update results will be based solely on the update query results
-                // the reason we do this is because, as stated above,
-                // WP update_option performs an exact instance comparison (===) on any update values passed to it
-                // this happens PRIOR to serialization and any subsequent update.
-                // If values are found to match their previous old value,
-                // then WP bails before performing any update.
-                // Since we are passing the EE_Config object, it is comparing the EXACT instance of the saved version
-                // it just pulled from the db, with the one being passed to it (which will not match).
-                // HOWEVER, once the object is serialized and passed off to MySQL to update,
-                // MySQL MAY ALSO NOT perform the update because
-                // the string it sees in the db looks the same as the new one it has been passed!!!
-                // This results in the query returning an "affected rows" value of ZERO,
-                // which gets returned immediately by WP update_option and looks like an error.
-                remove_action('update_option', array($this, 'check_config_updated'));
-            }
-        }
-    }
-
-
-    /**
-     *    update_espresso_config
-     *
-     * @access   public
-     */
-    protected function _reset_espresso_addon_config()
-    {
-        $this->_addon_option_names = array();
-        foreach ($this->addons as $addon_name => $addon_config_obj) {
-            $addon_config_obj = maybe_unserialize($addon_config_obj);
-            if ($addon_config_obj instanceof EE_Config_Base) {
-                $this->update_config('addons', $addon_name, $addon_config_obj, false);
-            }
-            $this->addons->{$addon_name} = null;
-        }
-    }
-
-
-    /**
-     *    update_espresso_config
-     *
-     * @access   public
-     * @param   bool $add_success
-     * @param   bool $add_error
-     * @return   bool
-     */
-    public function update_espresso_config($add_success = false, $add_error = true)
-    {
-        // don't allow config updates during WP heartbeats
-        if (\EE_Registry::instance()->REQ->get('action', '') === 'heartbeat') {
-            return false;
-        }
-        // commented out the following re: https://events.codebasehq.com/projects/event-espresso/tickets/8197
-        // $clone = clone( self::$_instance );
-        // self::$_instance = NULL;
-        do_action('AHEE__EE_Config__update_espresso_config__begin', $this);
-        $this->_reset_espresso_addon_config();
-        // hook into update_option because that happens AFTER the ( $value === $old_value ) conditional
-        // but BEFORE the actual update occurs
-        add_action('update_option', array($this, 'double_check_config_comparison'), 1, 3);
-        // don't want to persist legacy_shortcodes_manager, but don't want to lose it either
-        $legacy_shortcodes_manager = $this->legacy_shortcodes_manager;
-        $this->legacy_shortcodes_manager = null;
-        // now update "ee_config"
-        $saved = update_option(EE_Config::OPTION_NAME, $this);
-        $this->legacy_shortcodes_manager = $legacy_shortcodes_manager;
-        EE_Config::log(EE_Config::OPTION_NAME);
-        // if not saved... check if the hook we just added still exists;
-        // if it does, it means one of two things:
-        // that update_option bailed at the($value === $old_value) conditional,
-        // or...
-        // the db update query returned 0 rows affected
-        // (probably because the data  value was the same from it's perspective)
-        // so the existence of the hook means that a negative result from update_option is NOT an error,
-        // but just means no update occurred, so don't display an error to the user.
-        // BUT... if update_option returns FALSE, AND the hook is missing,
-        // then it means that something truly went wrong
-        $saved = ! $saved ? has_action('update_option', array($this, 'double_check_config_comparison')) : $saved;
-        // remove our action since we don't want it in the system anymore
-        remove_action('update_option', array($this, 'double_check_config_comparison'), 1);
-        do_action('AHEE__EE_Config__update_espresso_config__end', $this, $saved);
-        // self::$_instance = $clone;
-        // unset( $clone );
-        // if config remains the same or was updated successfully
-        if ($saved) {
-            if ($add_success) {
-                EE_Error::add_success(
-                    __('The Event Espresso Configuration Settings have been successfully updated.', 'event_espresso'),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-            return true;
-        } else {
-            if ($add_error) {
-                EE_Error::add_error(
-                    __('The Event Espresso Configuration Settings were not updated.', 'event_espresso'),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-            return false;
-        }
-    }
-
-
-    /**
-     *    _verify_config_params
-     *
-     * @access    private
-     * @param    string         $section
-     * @param    string         $name
-     * @param    string         $config_class
-     * @param    EE_Config_Base $config_obj
-     * @param    array          $tests_to_run
-     * @param    bool           $display_errors
-     * @return    bool    TRUE on success, FALSE on fail
-     */
-    private function _verify_config_params(
-        $section = '',
-        $name = '',
-        $config_class = '',
-        $config_obj = null,
-        $tests_to_run = array(1, 2, 3, 4, 5, 6, 7, 8),
-        $display_errors = true
-    ) {
-        try {
-            foreach ($tests_to_run as $test) {
-                switch ($test) {
-                    // TEST #1 : check that section was set
-                    case 1:
-                        if (empty($section)) {
-                            if ($display_errors) {
-                                throw new EE_Error(
-                                    sprintf(
-                                        __(
-                                            'No configuration section has been provided while attempting to save "%s".',
-                                            'event_espresso'
-                                        ),
-                                        $config_class
-                                    )
-                                );
-                            }
-                            return false;
-                        }
-                        break;
-                    // TEST #2 : check that settings section exists
-                    case 2:
-                        if (! isset($this->{$section})) {
-                            if ($display_errors) {
-                                throw new EE_Error(
-                                    sprintf(
-                                        __('The "%s" configuration section does not exist.', 'event_espresso'),
-                                        $section
-                                    )
-                                );
-                            }
-                            return false;
-                        }
-                        break;
-                    // TEST #3 : check that section is the proper format
-                    case 3:
-                        if (! ($this->{$section} instanceof EE_Config_Base || $this->{$section} instanceof stdClass)
-                        ) {
-                            if ($display_errors) {
-                                throw new EE_Error(
-                                    sprintf(
-                                        __(
-                                            'The "%s" configuration settings have not been formatted correctly.',
-                                            'event_espresso'
-                                        ),
-                                        $section
-                                    )
-                                );
-                            }
-                            return false;
-                        }
-                        break;
-                    // TEST #4 : check that config section name has been set
-                    case 4:
-                        if (empty($name)) {
-                            if ($display_errors) {
-                                throw new EE_Error(
-                                    __(
-                                        'No name has been provided for the specific configuration section.',
-                                        'event_espresso'
-                                    )
-                                );
-                            }
-                            return false;
-                        }
-                        break;
-                    // TEST #5 : check that a config class name has been set
-                    case 5:
-                        if (empty($config_class)) {
-                            if ($display_errors) {
-                                throw new EE_Error(
-                                    __(
-                                        'No class name has been provided for the specific configuration section.',
-                                        'event_espresso'
-                                    )
-                                );
-                            }
-                            return false;
-                        }
-                        break;
-                    // TEST #6 : verify config class is accessible
-                    case 6:
-                        if (! class_exists($config_class)) {
-                            if ($display_errors) {
-                                throw new EE_Error(
-                                    sprintf(
-                                        __(
-                                            'The "%s" class does not exist. Please ensure that an autoloader has been set for it.',
-                                            'event_espresso'
-                                        ),
-                                        $config_class
-                                    )
-                                );
-                            }
-                            return false;
-                        }
-                        break;
-                    // TEST #7 : check that config has even been set
-                    case 7:
-                        if (! isset($this->{$section}->{$name})) {
-                            if ($display_errors) {
-                                throw new EE_Error(
-                                    sprintf(
-                                        __('No configuration has been set for "%1$s->%2$s".', 'event_espresso'),
-                                        $section,
-                                        $name
-                                    )
-                                );
-                            }
-                            return false;
-                        } else {
-                            // and make sure it's not serialized
-                            $this->{$section}->{$name} = maybe_unserialize($this->{$section}->{$name});
-                        }
-                        break;
-                    // TEST #8 : check that config is the requested type
-                    case 8:
-                        if (! $this->{$section}->{$name} instanceof $config_class) {
-                            if ($display_errors) {
-                                throw new EE_Error(
-                                    sprintf(
-                                        __(
-                                            'The configuration for "%1$s->%2$s" is not of the "%3$s" class.',
-                                            'event_espresso'
-                                        ),
-                                        $section,
-                                        $name,
-                                        $config_class
-                                    )
-                                );
-                            }
-                            return false;
-                        }
-                        break;
-                    // TEST #9 : verify config object
-                    case 9:
-                        if (! $config_obj instanceof EE_Config_Base) {
-                            if ($display_errors) {
-                                throw new EE_Error(
-                                    sprintf(
-                                        __('The "%s" class is not an instance of EE_Config_Base.', 'event_espresso'),
-                                        print_r($config_obj, true)
-                                    )
-                                );
-                            }
-                            return false;
-                        }
-                        break;
-                }
-            }
-        } catch (EE_Error $e) {
-            $e->get_error();
-        }
-        // you have successfully run the gauntlet
-        return true;
-    }
-
-
-    /**
-     *    _generate_config_option_name
-     *
-     * @access        protected
-     * @param        string $section
-     * @param        string $name
-     * @return        string
-     */
-    private function _generate_config_option_name($section = '', $name = '')
-    {
-        return 'ee_config-' . strtolower($section . '-' . str_replace(array('EE_', 'EED_'), '', $name));
-    }
-
-
-    /**
-     *    _set_config_class
-     * ensures that a config class is set, either from a passed config class or one generated from the config name
-     *
-     * @access    private
-     * @param    string $config_class
-     * @param    string $name
-     * @return    string
-     */
-    private function _set_config_class($config_class = '', $name = '')
-    {
-        return ! empty($config_class)
-            ? $config_class
-            : str_replace(' ', '_', ucwords(str_replace('_', ' ', $name))) . '_Config';
-    }
-
-
-    /**
-     *    set_config
-     *
-     * @access    protected
-     * @param    string         $section
-     * @param    string         $name
-     * @param    string         $config_class
-     * @param    EE_Config_Base $config_obj
-     * @return    EE_Config_Base
-     */
-    public function set_config($section = '', $name = '', $config_class = '', EE_Config_Base $config_obj = null)
-    {
-        // ensure config class is set to something
-        $config_class = $this->_set_config_class($config_class, $name);
-        // run tests 1-4, 6, and 7 to verify all config params are set and valid
-        if (! $this->_verify_config_params($section, $name, $config_class, null, array(1, 2, 3, 4, 5, 6))) {
-            return null;
-        }
-        $config_option_name = $this->_generate_config_option_name($section, $name);
-        // if the config option name hasn't been added yet to the list of option names we're tracking, then do so now
-        if (! isset($this->_addon_option_names[ $config_option_name ])) {
-            $this->_addon_option_names[ $config_option_name ] = $config_class;
-            $this->update_addon_option_names();
-        }
-        // verify the incoming config object but suppress errors
-        if (! $this->_verify_config_params($section, $name, $config_class, $config_obj, array(9), false)) {
-            $config_obj = new $config_class();
-        }
-        if (get_option($config_option_name)) {
-            EE_Config::log($config_option_name);
-            update_option($config_option_name, $config_obj);
-            $this->{$section}->{$name} = $config_obj;
-            return $this->{$section}->{$name};
-        } else {
-            // create a wp-option for this config
-            if (add_option($config_option_name, $config_obj, '', 'no')) {
-                $this->{$section}->{$name} = maybe_unserialize($config_obj);
-                return $this->{$section}->{$name};
-            } else {
-                EE_Error::add_error(
-                    sprintf(__('The "%s" could not be saved to the database.', 'event_espresso'), $config_class),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-                return null;
-            }
-        }
-    }
-
-
-    /**
-     *    update_config
-     * Important: the config object must ALREADY be set, otherwise this will produce an error.
-     *
-     * @access    public
-     * @param    string                $section
-     * @param    string                $name
-     * @param    EE_Config_Base|string $config_obj
-     * @param    bool                  $throw_errors
-     * @return    bool
-     */
-    public function update_config($section = '', $name = '', $config_obj = '', $throw_errors = true)
-    {
-        // don't allow config updates during WP heartbeats
-        if (\EE_Registry::instance()->REQ->get('action', '') === 'heartbeat') {
-            return false;
-        }
-        $config_obj = maybe_unserialize($config_obj);
-        // get class name of the incoming object
-        $config_class = get_class($config_obj);
-        // run tests 1-5 and 9 to verify config
-        if (! $this->_verify_config_params(
-            $section,
-            $name,
-            $config_class,
-            $config_obj,
-            array(1, 2, 3, 4, 7, 9)
-        )
-        ) {
-            return false;
-        }
-        $config_option_name = $this->_generate_config_option_name($section, $name);
-        // check if config object has been added to db by seeing if config option name is in $this->_addon_option_names array
-        if (! isset($this->_addon_option_names[ $config_option_name ])) {
-            // save new config to db
-            if ($this->set_config($section, $name, $config_class, $config_obj)) {
-                return true;
-            }
-        } else {
-            // first check if the record already exists
-            $existing_config = get_option($config_option_name);
-            $config_obj = serialize($config_obj);
-            // just return if db record is already up to date (NOT type safe comparison)
-            if ($existing_config == $config_obj) {
-                $this->{$section}->{$name} = $config_obj;
-                return true;
-            } elseif (update_option($config_option_name, $config_obj)) {
-                EE_Config::log($config_option_name);
-                // update wp-option for this config class
-                $this->{$section}->{$name} = $config_obj;
-                return true;
-            } elseif ($throw_errors) {
-                EE_Error::add_error(
-                    sprintf(
-                        __(
-                            'The "%1$s" object stored at"%2$s" was not successfully updated in the database.',
-                            'event_espresso'
-                        ),
-                        $config_class,
-                        'EE_Config->' . $section . '->' . $name
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     *    get_config
-     *
-     * @access    public
-     * @param    string $section
-     * @param    string $name
-     * @param    string $config_class
-     * @return    mixed EE_Config_Base | NULL
-     */
-    public function get_config($section = '', $name = '', $config_class = '')
-    {
-        // ensure config class is set to something
-        $config_class = $this->_set_config_class($config_class, $name);
-        // run tests 1-4, 6 and 7 to verify that all params have been set
-        if (! $this->_verify_config_params($section, $name, $config_class, null, array(1, 2, 3, 4, 5, 6))) {
-            return null;
-        }
-        // now test if the requested config object exists, but suppress errors
-        if ($this->_verify_config_params($section, $name, $config_class, null, array(7, 8), false)) {
-            // config already exists, so pass it back
-            return $this->{$section}->{$name};
-        }
-        // load config option from db if it exists
-        $config_obj = $this->get_config_option($this->_generate_config_option_name($section, $name));
-        // verify the newly retrieved config object, but suppress errors
-        if ($this->_verify_config_params($section, $name, $config_class, $config_obj, array(9), false)) {
-            // config is good, so set it and pass it back
-            $this->{$section}->{$name} = $config_obj;
-            return $this->{$section}->{$name};
-        }
-        // oops! $config_obj is not already set and does not exist in the db, so create a new one
-        $config_obj = $this->set_config($section, $name, $config_class);
-        // verify the newly created config object
-        if ($this->_verify_config_params($section, $name, $config_class, $config_obj, array(9))) {
-            return $this->{$section}->{$name};
-        } else {
-            EE_Error::add_error(
-                sprintf(__('The "%s" could not be retrieved from the database.', 'event_espresso'), $config_class),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        return null;
-    }
-
-
-    /**
-     *    get_config_option
-     *
-     * @access    public
-     * @param    string $config_option_name
-     * @return    mixed EE_Config_Base | FALSE
-     */
-    public function get_config_option($config_option_name = '')
-    {
-        // retrieve the wp-option for this config class.
-        $config_option = maybe_unserialize(get_option($config_option_name, array()));
-        if (empty($config_option)) {
-            EE_Config::log($config_option_name . '-NOT-FOUND');
-        }
-        return $config_option;
-    }
-
-
-    /**
-     * log
-     *
-     * @param string $config_option_name
-     */
-    public static function log($config_option_name = '')
-    {
-        if (EE_Config::logging_enabled() && ! empty($config_option_name)) {
-            $config_log = get_option(EE_Config::LOG_NAME, array());
-            // copy incoming $_REQUEST and sanitize it so we can save it
-            $_request = $_REQUEST;
-            array_walk_recursive($_request, 'sanitize_text_field');
-            $config_log[ (string) microtime(true) ] = array(
-                'config_name' => $config_option_name,
-                'request'     => $_request,
-            );
-            update_option(EE_Config::LOG_NAME, $config_log);
-        }
-    }
-
-
-    /**
-     * trim_log
-     * reduces the size of the config log to the length specified by EE_Config::LOG_LENGTH
-     */
-    public static function trim_log()
-    {
-        if (! EE_Config::logging_enabled()) {
-            return;
-        }
-        $config_log = maybe_unserialize(get_option(EE_Config::LOG_NAME, array()));
-        $log_length = count($config_log);
-        if ($log_length > EE_Config::LOG_LENGTH) {
-            ksort($config_log);
-            $config_log = array_slice($config_log, $log_length - EE_Config::LOG_LENGTH, null, true);
-            update_option(EE_Config::LOG_NAME, $config_log);
-        }
-    }
-
-
-    /**
-     *    get_page_for_posts
-     *    if the wp-option "show_on_front" is set to "page", then this is the post_name for the post set in the
-     *    wp-option "page_for_posts", or "posts" if no page is selected
-     *
-     * @access    public
-     * @return    string
-     */
-    public static function get_page_for_posts()
-    {
-        $page_for_posts = get_option('page_for_posts');
-        if (! $page_for_posts) {
-            return 'posts';
-        }
-        /** @type WPDB $wpdb */
-        global $wpdb;
-        $SQL = "SELECT post_name from $wpdb->posts WHERE post_type='posts' OR post_type='page' AND post_status='publish' AND ID=%d";
-        return $wpdb->get_var($wpdb->prepare($SQL, $page_for_posts));
-    }
-
-
-    /**
-     *    register_shortcodes_and_modules.
-     *    At this point, it's too early to tell if we're maintenance mode or not.
-     *    In fact, this is where we give modules a chance to let core know they exist
-     *    so they can help trigger maintenance mode if it's needed
-     *
-     * @access    public
-     * @return    void
-     */
-    public function register_shortcodes_and_modules()
-    {
-        // allow modules to set hooks for the rest of the system
-        EE_Registry::instance()->modules = $this->_register_modules();
-    }
-
-
-    /**
-     *    initialize_shortcodes_and_modules
-     *    meaning they can start adding their hooks to get stuff done
-     *
-     * @access    public
-     * @return    void
-     */
-    public function initialize_shortcodes_and_modules()
-    {
-        // allow modules to set hooks for the rest of the system
-        $this->_initialize_modules();
-    }
-
-
-    /**
-     *    widgets_init
-     *
-     * @access private
-     * @return void
-     */
-    public function widgets_init()
-    {
-        // only init widgets on admin pages when not in complete maintenance, and
-        // on frontend when not in any maintenance mode
-        if (! EE_Maintenance_Mode::instance()->level()
-            || (
-                is_admin()
-                && EE_Maintenance_Mode::instance()->level() !== EE_Maintenance_Mode::level_2_complete_maintenance
-            )
-        ) {
-            // grab list of installed widgets
-            $widgets_to_register = glob(EE_WIDGETS . '*', GLOB_ONLYDIR);
-            // filter list of modules to register
-            $widgets_to_register = apply_filters(
-                'FHEE__EE_Config__register_widgets__widgets_to_register',
-                $widgets_to_register
-            );
-            if (! empty($widgets_to_register)) {
-                // cycle thru widget folders
-                foreach ($widgets_to_register as $widget_path) {
-                    // add to list of installed widget modules
-                    EE_Config::register_ee_widget($widget_path);
-                }
-            }
-            // filter list of installed modules
-            EE_Registry::instance()->widgets = apply_filters(
-                'FHEE__EE_Config__register_widgets__installed_widgets',
-                EE_Registry::instance()->widgets
-            );
-        }
-    }
-
-
-    /**
-     *    register_ee_widget - makes core aware of this widget
-     *
-     * @access    public
-     * @param    string $widget_path - full path up to and including widget folder
-     * @return    void
-     */
-    public static function register_ee_widget($widget_path = null)
-    {
-        do_action('AHEE__EE_Config__register_widget__begin', $widget_path);
-        $widget_ext = '.widget.php';
-        // make all separators match
-        $widget_path = rtrim(str_replace('\\', DS, $widget_path), DS);
-        // does the file path INCLUDE the actual file name as part of the path ?
-        if (strpos($widget_path, $widget_ext) !== false) {
-            // grab and shortcode file name from directory name and break apart at dots
-            $file_name = explode('.', basename($widget_path));
-            // take first segment from file name pieces and remove class prefix if it exists
-            $widget = strpos($file_name[0], 'EEW_') === 0 ? substr($file_name[0], 4) : $file_name[0];
-            // sanitize shortcode directory name
-            $widget = sanitize_key($widget);
-            // now we need to rebuild the shortcode path
-            $widget_path = explode('/', $widget_path);
-            // remove last segment
-            array_pop($widget_path);
-            // glue it back together
-            $widget_path = implode(DS, $widget_path);
-        } else {
-            // grab and sanitize widget directory name
-            $widget = sanitize_key(basename($widget_path));
-        }
-        // create classname from widget directory name
-        $widget = str_replace(' ', '_', ucwords(str_replace('_', ' ', $widget)));
-        // add class prefix
-        $widget_class = 'EEW_' . $widget;
-        // does the widget exist ?
-        if (! is_readable($widget_path . '/' . $widget_class . $widget_ext)) {
-            $msg = sprintf(
-                __(
-                    'The requested %s widget file could not be found or is not readable due to file permissions. Please ensure the following path is correct: %s',
-                    'event_espresso'
-                ),
-                $widget_class,
-                $widget_path . '/' . $widget_class . $widget_ext
-            );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return;
-        }
-        // load the widget class file
-        require_once($widget_path . '/' . $widget_class . $widget_ext);
-        // verify that class exists
-        if (! class_exists($widget_class)) {
-            $msg = sprintf(__('The requested %s widget class does not exist.', 'event_espresso'), $widget_class);
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return;
-        }
-        register_widget($widget_class);
-        // add to array of registered widgets
-        EE_Registry::instance()->widgets->{$widget_class} = $widget_path . '/' . $widget_class . $widget_ext;
-    }
-
-
-    /**
-     *        _register_modules
-     *
-     * @access private
-     * @return array
-     */
-    private function _register_modules()
-    {
-        // grab list of installed modules
-        $modules_to_register = glob(EE_MODULES . '*', GLOB_ONLYDIR);
-        // filter list of modules to register
-        $modules_to_register = apply_filters(
-            'FHEE__EE_Config__register_modules__modules_to_register',
-            $modules_to_register
-        );
-        if (! empty($modules_to_register)) {
-            // loop through folders
-            foreach ($modules_to_register as $module_path) {
-                /**TEMPORARILY EXCLUDE gateways from modules for time being**/
-                if ($module_path !== EE_MODULES . 'zzz-copy-this-module-template'
-                    && $module_path !== EE_MODULES . 'gateways'
-                ) {
-                    // add to list of installed modules
-                    EE_Config::register_module($module_path);
-                }
-            }
-        }
-        // filter list of installed modules
-        return apply_filters(
-            'FHEE__EE_Config___register_modules__installed_modules',
-            EE_Registry::instance()->modules
-        );
-    }
-
-
-    /**
-     *    register_module - makes core aware of this module
-     *
-     * @access    public
-     * @param    string $module_path - full path up to and including module folder
-     * @return    bool
-     */
-    public static function register_module($module_path = null)
-    {
-        do_action('AHEE__EE_Config__register_module__begin', $module_path);
-        $module_ext = '.module.php';
-        // make all separators match
-        $module_path = str_replace(array('\\', '/'), '/', $module_path);
-        // does the file path INCLUDE the actual file name as part of the path ?
-        if (strpos($module_path, $module_ext) !== false) {
-            // grab and shortcode file name from directory name and break apart at dots
-            $module_file = explode('.', basename($module_path));
-            // now we need to rebuild the shortcode path
-            $module_path = explode('/', $module_path);
-            // remove last segment
-            array_pop($module_path);
-            // glue it back together
-            $module_path = implode('/', $module_path) . '/';
-            // take first segment from file name pieces and sanitize it
-            $module = preg_replace('/[^a-zA-Z0-9_\-]/', '', $module_file[0]);
-            // ensure class prefix is added
-            $module_class = strpos($module, 'EED_') !== 0 ? 'EED_' . $module : $module;
-        } else {
-            // we need to generate the filename based off of the folder name
-            // grab and sanitize module name
-            $module = strtolower(basename($module_path));
-            $module = preg_replace('/[^a-z0-9_\-]/', '', $module);
-            // like trailingslashit()
-            $module_path = rtrim($module_path, '/') . '/';
-            // create classname from module directory name
-            $module = str_replace(' ', '_', ucwords(str_replace('_', ' ', $module)));
-            // add class prefix
-            $module_class = 'EED_' . $module;
-        }
-        // does the module exist ?
-        if (! is_readable($module_path . '/' . $module_class . $module_ext)) {
-            $msg = sprintf(
-                __(
-                    'The requested %s module file could not be found or is not readable due to file permissions.',
-                    'event_espresso'
-                ),
-                $module
-            );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        // load the module class file
-        require_once($module_path . $module_class . $module_ext);
-        // verify that class exists
-        if (! class_exists($module_class)) {
-            $msg = sprintf(__('The requested %s module class does not exist.', 'event_espresso'), $module_class);
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        // add to array of registered modules
-        EE_Registry::instance()->modules->{$module_class} = $module_path . $module_class . $module_ext;
-        do_action(
-            'AHEE__EE_Config__register_module__complete',
-            $module_class,
-            EE_Registry::instance()->modules->{$module_class}
-        );
-        return true;
-    }
-
-
-    /**
-     *    _initialize_modules
-     *    allow modules to set hooks for the rest of the system
-     *
-     * @access private
-     * @return void
-     */
-    private function _initialize_modules()
-    {
-        // cycle thru shortcode folders
-        foreach (EE_Registry::instance()->modules as $module_class => $module_path) {
-            // fire the shortcode class's set_hooks methods in case it needs to hook into other parts of the system
-            // which set hooks ?
-            if (is_admin()) {
-                // fire immediately
-                call_user_func(array($module_class, 'set_hooks_admin'));
-            } else {
-                // delay until other systems are online
-                add_action(
-                    'AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons',
-                    array($module_class, 'set_hooks')
-                );
-            }
-        }
-    }
-
-
-    /**
-     *    register_route - adds module method routes to route_map
-     *
-     * @access    public
-     * @param    string $route       - "pretty" public alias for module method
-     * @param    string $module      - module name (classname without EED_ prefix)
-     * @param    string $method_name - the actual module method to be routed to
-     * @param    string $key         - url param key indicating a route is being called
-     * @return    bool
-     */
-    public static function register_route($route = null, $module = null, $method_name = null, $key = 'ee')
-    {
-        do_action('AHEE__EE_Config__register_route__begin', $route, $module, $method_name);
-        $module = str_replace('EED_', '', $module);
-        $module_class = 'EED_' . $module;
-        if (! isset(EE_Registry::instance()->modules->{$module_class})) {
-            $msg = sprintf(__('The module %s has not been registered.', 'event_espresso'), $module);
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        if (empty($route)) {
-            $msg = sprintf(__('No route has been supplied.', 'event_espresso'), $route);
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        if (! method_exists('EED_' . $module, $method_name)) {
-            $msg = sprintf(
-                __('A valid class method for the %s route has not been supplied.', 'event_espresso'),
-                $route
-            );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        EE_Config::$_module_route_map[ (string) $key ][ (string) $route ] = array('EED_' . $module, $method_name);
-        return true;
-    }
-
-
-    /**
-     *    get_route - get module method route
-     *
-     * @access    public
-     * @param    string $route - "pretty" public alias for module method
-     * @param    string $key   - url param key indicating a route is being called
-     * @return    string
-     */
-    public static function get_route($route = null, $key = 'ee')
-    {
-        do_action('AHEE__EE_Config__get_route__begin', $route);
-        $route = (string) apply_filters('FHEE__EE_Config__get_route', $route);
-        if (isset(EE_Config::$_module_route_map[ $key ][ $route ])) {
-            return EE_Config::$_module_route_map[ $key ][ $route ];
-        }
-        return null;
-    }
-
-
-    /**
-     *    get_routes - get ALL module method routes
-     *
-     * @access    public
-     * @return    array
-     */
-    public static function get_routes()
-    {
-        return EE_Config::$_module_route_map;
-    }
-
-
-    /**
-     *    register_forward - allows modules to forward request to another module for further processing
-     *
-     * @access    public
-     * @param    string       $route   - "pretty" public alias for module method
-     * @param    integer      $status  - integer value corresponding  to status constant strings set in module parent
-     *                                 class, allows different forwards to be served based on status
-     * @param    array|string $forward - function name or array( class, method )
-     * @param    string       $key     - url param key indicating a route is being called
-     * @return    bool
-     */
-    public static function register_forward($route = null, $status = 0, $forward = null, $key = 'ee')
-    {
-        do_action('AHEE__EE_Config__register_forward', $route, $status, $forward);
-        if (! isset(EE_Config::$_module_route_map[ $key ][ $route ]) || empty($route)) {
-            $msg = sprintf(
-                __('The module route %s for this forward has not been registered.', 'event_espresso'),
-                $route
-            );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        if (empty($forward)) {
-            $msg = sprintf(__('No forwarding route has been supplied.', 'event_espresso'), $route);
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        if (is_array($forward)) {
-            if (! isset($forward[1])) {
-                $msg = sprintf(
-                    __('A class method for the %s forwarding route has not been supplied.', 'event_espresso'),
-                    $route
-                );
-                EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-                return false;
-            }
-            if (! method_exists($forward[0], $forward[1])) {
-                $msg = sprintf(
-                    __('The class method %s for the %s forwarding route is in invalid.', 'event_espresso'),
-                    $forward[1],
-                    $route
-                );
-                EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-                return false;
-            }
-        } elseif (! function_exists($forward)) {
-            $msg = sprintf(
-                __('The function %s for the %s forwarding route is in invalid.', 'event_espresso'),
-                $forward,
-                $route
-            );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        EE_Config::$_module_forward_map[ $key ][ $route ][ absint($status) ] = $forward;
-        return true;
-    }
-
-
-    /**
-     *    get_forward - get forwarding route
-     *
-     * @access    public
-     * @param    string  $route  - "pretty" public alias for module method
-     * @param    integer $status - integer value corresponding  to status constant strings set in module parent class,
-     *                           allows different forwards to be served based on status
-     * @param    string  $key    - url param key indicating a route is being called
-     * @return    string
-     */
-    public static function get_forward($route = null, $status = 0, $key = 'ee')
-    {
-        do_action('AHEE__EE_Config__get_forward__begin', $route, $status);
-        if (isset(EE_Config::$_module_forward_map[ $key ][ $route ][ $status ])) {
-            return apply_filters(
-                'FHEE__EE_Config__get_forward',
-                EE_Config::$_module_forward_map[ $key ][ $route ][ $status ],
-                $route,
-                $status
-            );
-        }
-        return null;
-    }
-
-
-    /**
-     *    register_forward - allows modules to specify different view templates for different method routes and status
-     *    results
-     *
-     * @access    public
-     * @param    string  $route  - "pretty" public alias for module method
-     * @param    integer $status - integer value corresponding  to status constant strings set in module parent class,
-     *                           allows different views to be served based on status
-     * @param    string  $view
-     * @param    string  $key    - url param key indicating a route is being called
-     * @return    bool
-     */
-    public static function register_view($route = null, $status = 0, $view = null, $key = 'ee')
-    {
-        do_action('AHEE__EE_Config__register_view__begin', $route, $status, $view);
-        if (! isset(EE_Config::$_module_route_map[ $key ][ $route ]) || empty($route)) {
-            $msg = sprintf(
-                __('The module route %s for this view has not been registered.', 'event_espresso'),
-                $route
-            );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        if (! is_readable($view)) {
-            $msg = sprintf(
-                __(
-                    'The %s view file could not be found or is not readable due to file permissions.',
-                    'event_espresso'
-                ),
-                $view
-            );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        EE_Config::$_module_view_map[ $key ][ $route ][ absint($status) ] = $view;
-        return true;
-    }
-
-
-    /**
-     *    get_view - get view for route and status
-     *
-     * @access    public
-     * @param    string  $route  - "pretty" public alias for module method
-     * @param    integer $status - integer value corresponding  to status constant strings set in module parent class,
-     *                           allows different views to be served based on status
-     * @param    string  $key    - url param key indicating a route is being called
-     * @return    string
-     */
-    public static function get_view($route = null, $status = 0, $key = 'ee')
-    {
-        do_action('AHEE__EE_Config__get_view__begin', $route, $status);
-        if (isset(EE_Config::$_module_view_map[ $key ][ $route ][ $status ])) {
-            return apply_filters(
-                'FHEE__EE_Config__get_view',
-                EE_Config::$_module_view_map[ $key ][ $route ][ $status ],
-                $route,
-                $status
-            );
-        }
-        return null;
-    }
-
-
-    public function update_addon_option_names()
-    {
-        update_option(EE_Config::ADDON_OPTION_NAMES, $this->_addon_option_names);
-    }
-
-
-    public function shutdown()
-    {
-        $this->update_addon_option_names();
-    }
-
-
-    /**
-     * @return LegacyShortcodesManager
-     */
-    public static function getLegacyShortcodesManager()
-    {
-
-        if (! EE_Config::instance()->legacy_shortcodes_manager instanceof LegacyShortcodesManager) {
-            EE_Config::instance()->legacy_shortcodes_manager = new LegacyShortcodesManager(
-                EE_Registry::instance()
-            );
-        }
-        return EE_Config::instance()->legacy_shortcodes_manager;
-    }
-
-
-    /**
-     * register_shortcode - makes core aware of this shortcode
-     *
-     * @deprecated 4.9.26
-     * @param    string $shortcode_path - full path up to and including shortcode folder
-     * @return    bool
-     */
-    public static function register_shortcode($shortcode_path = null)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            __(
-                'Usage is deprecated. Use \EventEspresso\core\services\shortcodes\LegacyShortcodesManager::registerShortcode() as direct replacement, or better yet, please see the new \EventEspresso\core\services\shortcodes\ShortcodesManager class.',
-                'event_espresso'
-            ),
-            '4.9.26'
-        );
-        return EE_Config::instance()->getLegacyShortcodesManager()->registerShortcode($shortcode_path);
-    }
-}
-
-/**
- * Base class used for config classes. These classes should generally not have
- * magic functions in use, except we'll allow them to magically set and get stuff...
- * basically, they should just be well-defined stdClasses
- */
-class EE_Config_Base
-{
-
-    /**
-     * Utility function for escaping the value of a property and returning.
-     *
-     * @param string $property property name (checks to see if exists).
-     * @return mixed if a detected type found return the escaped value, otherwise just the raw value is returned.
-     * @throws \EE_Error
-     */
-    public function get_pretty($property)
-    {
-        if (! property_exists($this, $property)) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        '%1$s::get_pretty() has been called with the property %2$s which does not exist on the %1$s config class.',
-                        'event_espresso'
-                    ),
-                    get_class($this),
-                    $property
-                )
-            );
-        }
-        // just handling escaping of strings for now.
-        if (is_string($this->{$property})) {
-            return stripslashes($this->{$property});
-        }
-        return $this->{$property};
-    }
-
-
-    public function populate()
-    {
-        // grab defaults via a new instance of this class.
-        $class_name = get_class($this);
-        $defaults = new $class_name;
-        // loop through the properties for this class and see if they are set.  If they are NOT, then grab the
-        // default from our $defaults object.
-        foreach (get_object_vars($defaults) as $property => $value) {
-            if ($this->{$property} === null) {
-                $this->{$property} = $value;
-            }
-        }
-        // cleanup
-        unset($defaults);
-    }
-
-
-    /**
-     *        __isset
-     *
-     * @param $a
-     * @return bool
-     */
-    public function __isset($a)
-    {
-        return false;
-    }
-
-
-    /**
-     *        __unset
-     *
-     * @param $a
-     * @return bool
-     */
-    public function __unset($a)
-    {
-        return false;
-    }
-
-
-    /**
-     *        __clone
-     */
-    public function __clone()
-    {
-    }
-
-
-    /**
-     *        __wakeup
-     */
-    public function __wakeup()
-    {
-    }
-
-
-    /**
-     *        __destruct
-     */
-    public function __destruct()
-    {
-    }
-}
-
-/**
- * Class for defining what's in the EE_Config relating to registration settings
- */
-class EE_Core_Config extends EE_Config_Base
-{
-
-    const OPTION_NAME_UXIP = 'ee_ueip_optin';
-
-
-    public $current_blog_id;
-
-    public $ee_ueip_optin;
-
-    public $ee_ueip_has_notified;
-
-    /**
-     * Not to be confused with the 4 critical page variables (See
-     * get_critical_pages_array()), this is just an array of wp posts that have EE
-     * shortcodes in them. Keys are slugs, values are arrays with only 1 element: where the key is the shortcode
-     * in the page, and the value is the page's ID. The key 'posts' is basically a duplicate of this same array.
-     *
-     * @var array
-     */
-    public $post_shortcodes;
-
-    public $module_route_map;
-
-    public $module_forward_map;
-
-    public $module_view_map;
-
-    /**
-     * The next 4 vars are the IDs of critical EE pages.
-     *
-     * @var int
-     */
-    public $reg_page_id;
-
-    public $txn_page_id;
-
-    public $thank_you_page_id;
-
-    public $cancel_page_id;
-
-    /**
-     * The next 4 vars are the URLs of critical EE pages.
-     *
-     * @var int
-     */
-    public $reg_page_url;
-
-    public $txn_page_url;
-
-    public $thank_you_page_url;
-
-    public $cancel_page_url;
-
-    /**
-     * The next vars relate to the custom slugs for EE CPT routes
-     */
-    public $event_cpt_slug;
-
-    /**
-     * This caches the _ee_ueip_option in case this config is reset in the same
-     * request across blog switches in a multisite context.
-     * Avoids extra queries to the db for this option.
-     *
-     * @var bool
-     */
-    public static $ee_ueip_option;
-
-
-    /**
-     *    class constructor
-     *
-     * @access    public
-     */
-    public function __construct()
-    {
-        // set default organization settings
-        $this->current_blog_id = get_current_blog_id();
-        $this->current_blog_id = $this->current_blog_id === null ? 1 : $this->current_blog_id;
-        $this->ee_ueip_optin = $this->_get_main_ee_ueip_optin();
-        $this->ee_ueip_has_notified = is_main_site() ? get_option('ee_ueip_has_notified', false) : true;
-        $this->post_shortcodes = array();
-        $this->module_route_map = array();
-        $this->module_forward_map = array();
-        $this->module_view_map = array();
-        // critical EE page IDs
-        $this->reg_page_id = 0;
-        $this->txn_page_id = 0;
-        $this->thank_you_page_id = 0;
-        $this->cancel_page_id = 0;
-        // critical EE page URLs
-        $this->reg_page_url = '';
-        $this->txn_page_url = '';
-        $this->thank_you_page_url = '';
-        $this->cancel_page_url = '';
-        // cpt slugs
-        $this->event_cpt_slug = __('events', 'event_espresso');
-        // ueip constant check
-        if (defined('EE_DISABLE_UXIP') && EE_DISABLE_UXIP) {
-            $this->ee_ueip_optin = false;
-            $this->ee_ueip_has_notified = true;
-        }
-    }
-
-
-    /**
-     * @return array
-     */
-    public function get_critical_pages_array()
-    {
-        return array(
-            $this->reg_page_id,
-            $this->txn_page_id,
-            $this->thank_you_page_id,
-            $this->cancel_page_id,
-        );
-    }
-
-
-    /**
-     * @return array
-     */
-    public function get_critical_pages_shortcodes_array()
-    {
-        return array(
-            $this->reg_page_id       => 'ESPRESSO_CHECKOUT',
-            $this->txn_page_id       => 'ESPRESSO_TXN_PAGE',
-            $this->thank_you_page_id => 'ESPRESSO_THANK_YOU',
-            $this->cancel_page_id    => 'ESPRESSO_CANCELLED',
-        );
-    }
-
-
-    /**
-     *  gets/returns URL for EE reg_page
-     *
-     * @access    public
-     * @return    string
-     */
-    public function reg_page_url()
-    {
-        if (! $this->reg_page_url) {
-            $this->reg_page_url = add_query_arg(
-                array('uts' => time()),
-                get_permalink($this->reg_page_id)
-            ) . '#checkout';
-        }
-        return $this->reg_page_url;
-    }
-
-
-    /**
-     *  gets/returns URL for EE txn_page
-     *
-     * @param array $query_args like what gets passed to
-     *                          add_query_arg() as the first argument
-     * @access    public
-     * @return    string
-     */
-    public function txn_page_url($query_args = array())
-    {
-        if (! $this->txn_page_url) {
-            $this->txn_page_url = get_permalink($this->txn_page_id);
-        }
-        if ($query_args) {
-            return add_query_arg($query_args, $this->txn_page_url);
-        } else {
-            return $this->txn_page_url;
-        }
-    }
-
-
-    /**
-     *  gets/returns URL for EE thank_you_page
-     *
-     * @param array $query_args like what gets passed to
-     *                          add_query_arg() as the first argument
-     * @access    public
-     * @return    string
-     */
-    public function thank_you_page_url($query_args = array())
-    {
-        if (! $this->thank_you_page_url) {
-            $this->thank_you_page_url = get_permalink($this->thank_you_page_id);
-        }
-        if ($query_args) {
-            return add_query_arg($query_args, $this->thank_you_page_url);
-        } else {
-            return $this->thank_you_page_url;
-        }
-    }
-
-
-    /**
-     *  gets/returns URL for EE cancel_page
-     *
-     * @access    public
-     * @return    string
-     */
-    public function cancel_page_url()
-    {
-        if (! $this->cancel_page_url) {
-            $this->cancel_page_url = get_permalink($this->cancel_page_id);
-        }
-        return $this->cancel_page_url;
-    }
-
-
-    /**
-     * Resets all critical page urls to their original state.  Used primarily by the __sleep() magic method currently.
-     *
-     * @since 4.7.5
-     */
-    protected function _reset_urls()
-    {
-        $this->reg_page_url = '';
-        $this->txn_page_url = '';
-        $this->cancel_page_url = '';
-        $this->thank_you_page_url = '';
-    }
-
-
-    /**
-     * Used to return what the optin value is set for the EE User Experience Program.
-     * This accounts for multisite and this value being requested for a subsite.  In multisite, the value is set
-     * on the main site only.
-     *
-     * @return bool
-     */
-    protected function _get_main_ee_ueip_optin()
-    {
-        // if this is the main site then we can just bypass our direct query.
-        if (is_main_site()) {
-            return get_option(self::OPTION_NAME_UXIP, false);
-        }
-        // is this already cached for this request?  If so use it.
-        if (EE_Core_Config::$ee_ueip_option !== null) {
-            return EE_Core_Config::$ee_ueip_option;
-        }
-        global $wpdb;
-        $current_network_main_site = is_multisite() ? get_current_site() : null;
-        $current_main_site_id = ! empty($current_network_main_site) ? $current_network_main_site->blog_id : 1;
-        $option = self::OPTION_NAME_UXIP;
-        // set correct table for query
-        $table_name = $wpdb->get_blog_prefix($current_main_site_id) . 'options';
-        // rather than getting blog option for the $current_main_site_id, we do a direct $wpdb query because
-        // get_blog_option() does a switch_to_blog an that could cause infinite recursion because EE_Core_Config might be
-        // re-constructed on the blog switch.  Note, we are still executing any core wp filters on this option retrieval.
-        // this bit of code is basically a direct copy of get_option without any caching because we are NOT switched to the blog
-        // for the purpose of caching.
-        $pre = apply_filters('pre_option_' . $option, false, $option);
-        if (false !== $pre) {
-            EE_Core_Config::$ee_ueip_option = $pre;
-            return EE_Core_Config::$ee_ueip_option;
-        }
-        $row = $wpdb->get_row(
-            $wpdb->prepare(
-                "SELECT option_value FROM $table_name WHERE option_name = %s LIMIT 1",
-                $option
-            )
-        );
-        if (is_object($row)) {
-            $value = $row->option_value;
-        } else { // option does not exist so use default.
-            EE_Core_Config::$ee_ueip_option =  apply_filters('default_option_' . $option, false, $option);
-            return EE_Core_Config::$ee_ueip_option;
-        }
-        EE_Core_Config::$ee_ueip_option = apply_filters('option_' . $option, maybe_unserialize($value), $option);
-        return EE_Core_Config::$ee_ueip_option;
-    }
-
-
-    /**
-     * Utility function for escaping the value of a property and returning.
-     *
-     * @param string $property property name (checks to see if exists).
-     * @return mixed if a detected type found return the escaped value, otherwise just the raw value is returned.
-     * @throws \EE_Error
-     */
-    public function get_pretty($property)
-    {
-        if ($property === self::OPTION_NAME_UXIP) {
-            return $this->ee_ueip_optin ? 'yes' : 'no';
-        }
-        return parent::get_pretty($property);
-    }
-
-
-    /**
-     * Currently used to ensure critical page urls have initial values saved to the db instead of any current set values
-     * on the object.
-     *
-     * @return array
-     */
-    public function __sleep()
-    {
-        // reset all url properties
-        $this->_reset_urls();
-        // return what to save to db
-        return array_keys(get_object_vars($this));
-    }
-}
-
-/**
- * Config class for storing info on the Organization
- */
-class EE_Organization_Config extends EE_Config_Base
-{
-
-    /**
-     * @var string $name
-     * eg EE4.1
-     */
-    public $name;
-
-    /**
-     * @var string $address_1
-     * eg 123 Onna Road
-     */
-    public $address_1 = '';
-
-    /**
-     * @var string $address_2
-     * eg PO Box 123
-     */
-    public $address_2 = '';
-
-    /**
-     * @var string $city
-     * eg Inna City
-     */
-    public $city = '';
-
-    /**
-     * @var int $STA_ID
-     * eg 4
-     */
-    public $STA_ID = 0;
-
-    /**
-     * @var string $CNT_ISO
-     * eg US
-     */
-    public $CNT_ISO = '';
-
-    /**
-     * @var string $zip
-     * eg 12345  or V1A 2B3
-     */
-    public $zip = '';
-
-    /**
-     * @var string $email
-     * eg support@eventespresso.com
-     */
-    public $email;
-
-    /**
-     * @var string $phone
-     * eg. 111-111-1111
-     */
-    public $phone = '';
-
-    /**
-     * @var string $vat
-     * VAT/Tax Number
-     */
-    public $vat = '';
-
-    /**
-     * @var string $logo_url
-     * eg http://www.somedomain.com/wp-content/uploads/kittehs.jpg
-     */
-    public $logo_url = '';
-
-    /**
-     * The below are all various properties for holding links to organization social network profiles
-     *
-     * @var string
-     */
-    /**
-     * facebook (facebook.com/profile.name)
-     *
-     * @var string
-     */
-    public $facebook = '';
-
-    /**
-     * twitter (twitter.com/twitter_handle)
-     *
-     * @var string
-     */
-    public $twitter = '';
-
-    /**
-     * linkedin (linkedin.com/in/profile_name)
-     *
-     * @var string
-     */
-    public $linkedin = '';
-
-    /**
-     * pinterest (www.pinterest.com/profile_name)
-     *
-     * @var string
-     */
-    public $pinterest = '';
-
-    /**
-     * google+ (google.com/+profileName)
-     *
-     * @var string
-     */
-    public $google = '';
-
-    /**
-     * instagram (instagram.com/handle)
-     *
-     * @var string
-     */
-    public $instagram = '';
-
-
-    /**
-     *    class constructor
-     *
-     * @access    public
-     */
-    public function __construct()
-    {
-        // set default organization settings
-        // decode HTML entities from the WP blogname, because it's stored in the DB with HTML entities encoded
-        $this->name = wp_specialchars_decode(get_bloginfo('name'), ENT_QUOTES);
-        $this->email = get_bloginfo('admin_email');
-    }
-}
-
-/**
- * Class for defining what's in the EE_Config relating to currency
- */
-class EE_Currency_Config extends EE_Config_Base
-{
-
-    /**
-     * @var string $code
-     * eg 'US'
-     */
-    public $code;
-
-    /**
-     * @var string $name
-     * eg 'Dollar'
-     */
-    public $name;
-
-    /**
-     * plural name
-     *
-     * @var string $plural
-     * eg 'Dollars'
-     */
-    public $plural;
-
-    /**
-     * currency sign
-     *
-     * @var string $sign
-     * eg '$'
-     */
-    public $sign;
-
-    /**
-     * Whether the currency sign should come before the number or not
-     *
-     * @var boolean $sign_b4
-     */
-    public $sign_b4;
-
-    /**
-     * How many digits should come after the decimal place
-     *
-     * @var int $dec_plc
-     */
-    public $dec_plc;
-
-    /**
-     * Symbol to use for decimal mark
-     *
-     * @var string $dec_mrk
-     * eg '.'
-     */
-    public $dec_mrk;
-
-    /**
-     * Symbol to use for thousands
-     *
-     * @var string $thsnds
-     * eg ','
-     */
-    public $thsnds;
-
-
-    /**
-     *    class constructor
-     *
-     * @access    public
-     * @param string $CNT_ISO
-     * @throws \EE_Error
-     */
-    public function __construct($CNT_ISO = '')
-    {
-        /** @var \EventEspresso\core\services\database\TableAnalysis $table_analysis */
-        $table_analysis = EE_Registry::instance()->create('TableAnalysis', array(), true);
-        // get country code from organization settings or use default
-        $ORG_CNT = isset(EE_Registry::instance()->CFG->organization)
-                   && EE_Registry::instance()->CFG->organization instanceof EE_Organization_Config
-            ? EE_Registry::instance()->CFG->organization->CNT_ISO
-            : '';
-        // but override if requested
-        $CNT_ISO = ! empty($CNT_ISO) ? $CNT_ISO : $ORG_CNT;
-        // so if that all went well, and we are not in M-Mode (cuz you can't query the db in M-Mode) and double-check the countries table exists
-        if (! empty($CNT_ISO)
-            && EE_Maintenance_Mode::instance()->models_can_query()
-            && $table_analysis->tableExists(EE_Registry::instance()->load_model('Country')->table())
-        ) {
-            // retrieve the country settings from the db, just in case they have been customized
-            $country = EE_Registry::instance()->load_model('Country')->get_one_by_ID($CNT_ISO);
-            if ($country instanceof EE_Country) {
-                $this->code = $country->currency_code();    // currency code: USD, CAD, EUR
-                $this->name = $country->currency_name_single();    // Dollar
-                $this->plural = $country->currency_name_plural();    // Dollars
-                $this->sign = $country->currency_sign();            // currency sign: $
-                $this->sign_b4 = $country->currency_sign_before(
-                );        // currency sign before or after: $TRUE  or  FALSE$
-                $this->dec_plc = $country->currency_decimal_places();    // decimal places: 2 = 0.00  3 = 0.000
-                $this->dec_mrk = $country->currency_decimal_mark(
-                );    // decimal mark: (comma) ',' = 0,01   or (decimal) '.' = 0.01
-                $this->thsnds = $country->currency_thousands_separator(
-                );    // thousands separator: (comma) ',' = 1,000   or (decimal) '.' = 1.000
-            }
-        }
-        // fallback to hardcoded defaults, in case the above failed
-        if (empty($this->code)) {
-            // set default currency settings
-            $this->code = 'USD';    // currency code: USD, CAD, EUR
-            $this->name = __('Dollar', 'event_espresso');    // Dollar
-            $this->plural = __('Dollars', 'event_espresso');    // Dollars
-            $this->sign = '$';    // currency sign: $
-            $this->sign_b4 = true;    // currency sign before or after: $TRUE  or  FALSE$
-            $this->dec_plc = 2;    // decimal places: 2 = 0.00  3 = 0.000
-            $this->dec_mrk = '.';    // decimal mark: (comma) ',' = 0,01   or (decimal) '.' = 0.01
-            $this->thsnds = ',';    // thousands separator: (comma) ',' = 1,000   or (decimal) '.' = 1.000
-        }
-    }
-}
-
-/**
- * Class for defining what's in the EE_Config relating to registration settings
- */
-class EE_Registration_Config extends EE_Config_Base
-{
-
-    /**
-     * Default registration status
-     *
-     * @var string $default_STS_ID
-     * eg 'RPP'
-     */
-    public $default_STS_ID;
-
-    /**
-     * For new events, this will be the default value for the maximum number of tickets (equivalent to maximum number of
-     * registrations)
-     *
-     * @var int
-     */
-    public $default_maximum_number_of_tickets;
-
-    /**
-     * level of validation to apply to email addresses
-     *
-     * @var string $email_validation_level
-     * options: 'basic', 'wp_default', 'i18n', 'i18n_dns'
-     */
-    public $email_validation_level;
-
-    /**
-     *    whether or not to show alternate payment options during the reg process if payment status is pending
-     *
-     * @var boolean $show_pending_payment_options
-     */
-    public $show_pending_payment_options;
-
-    /**
-     * Whether to skip the registration confirmation page
-     *
-     * @var boolean $skip_reg_confirmation
-     */
-    public $skip_reg_confirmation;
-
-    /**
-     * an array of SPCO reg steps where:
-     *        the keys denotes the reg step order
-     *        each element consists of an array with the following elements:
-     *            "file_path" => the file path to the EE_SPCO_Reg_Step class
-     *            "class_name" => the specific EE_SPCO_Reg_Step child class name
-     *            "slug" => the URL param used to trigger the reg step
-     *
-     * @var array $reg_steps
-     */
-    public $reg_steps;
-
-    /**
-     * Whether registration confirmation should be the last page of SPCO
-     *
-     * @var boolean $reg_confirmation_last
-     */
-    public $reg_confirmation_last;
-
-    /**
-     * Whether or not to enable the EE Bot Trap
-     *
-     * @var boolean $use_bot_trap
-     */
-    public $use_bot_trap;
-
-    /**
-     * Whether or not to encrypt some data sent by the EE Bot Trap
-     *
-     * @var boolean $use_encryption
-     */
-    public $use_encryption;
-
-    /**
-     * Whether or not to use ReCaptcha
-     *
-     * @var boolean $use_captcha
-     */
-    public $use_captcha;
-
-    /**
-     * ReCaptcha Theme
-     *
-     * @var string $recaptcha_theme
-     *    options: 'dark', 'light', 'invisible'
-     */
-    public $recaptcha_theme;
-
-    /**
-     * ReCaptcha Badge - determines the position of the reCAPTCHA badge if using Invisible ReCaptcha.
-     *
-     * @var string $recaptcha_badge
-     *    options: 'bottomright', 'bottomleft', 'inline'
-     */
-    public $recaptcha_badge;
+	const OPTION_NAME = 'ee_config';
+
+	const LOG_NAME = 'ee_config_log';
+
+	const LOG_LENGTH = 100;
+
+	const ADDON_OPTION_NAMES = 'ee_config_option_names';
+
+	/**
+	 *    instance of the EE_Config object
+	 *
+	 * @var    EE_Config $_instance
+	 * @access    private
+	 */
+	private static $_instance;
+
+	/**
+	 * @var boolean $_logging_enabled
+	 */
+	private static $_logging_enabled = false;
+
+	/**
+	 * @var LegacyShortcodesManager $legacy_shortcodes_manager
+	 */
+	private $legacy_shortcodes_manager;
+
+	/**
+	 * An StdClass whose property names are addon slugs,
+	 * and values are their config classes
+	 *
+	 * @var StdClass
+	 */
+	public $addons;
+
+	/**
+	 * @var EE_Admin_Config
+	 */
+	public $admin;
+
+	/**
+	 * @var EE_Core_Config
+	 */
+	public $core;
+
+	/**
+	 * @var EE_Currency_Config
+	 */
+	public $currency;
+
+	/**
+	 * @var EE_Organization_Config
+	 */
+	public $organization;
+
+	/**
+	 * @var EE_Registration_Config
+	 */
+	public $registration;
+
+	/**
+	 * @var EE_Template_Config
+	 */
+	public $template_settings;
+
+	/**
+	 * Holds EE environment values.
+	 *
+	 * @var EE_Environment_Config
+	 */
+	public $environment;
+
+	/**
+	 * settings pertaining to Google maps
+	 *
+	 * @var EE_Map_Config
+	 */
+	public $map_settings;
+
+	/**
+	 * settings pertaining to Taxes
+	 *
+	 * @var EE_Tax_Config
+	 */
+	public $tax_settings;
+
+	/**
+	 * Settings pertaining to global messages settings.
+	 *
+	 * @var EE_Messages_Config
+	 */
+	public $messages;
+
+	/**
+	 * @deprecated
+	 * @var EE_Gateway_Config
+	 */
+	public $gateway;
+
+	/**
+	 * @var    array $_addon_option_names
+	 * @access    private
+	 */
+	private $_addon_option_names = array();
+
+	/**
+	 * @var    array $_module_route_map
+	 * @access    private
+	 */
+	private static $_module_route_map = array();
+
+	/**
+	 * @var    array $_module_forward_map
+	 * @access    private
+	 */
+	private static $_module_forward_map = array();
+
+	/**
+	 * @var    array $_module_view_map
+	 * @access    private
+	 */
+	private static $_module_view_map = array();
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @access    public
+	 * @return EE_Config instance
+	 */
+	public static function instance()
+	{
+		// check if class object is instantiated, and instantiated properly
+		if (! self::$_instance instanceof EE_Config) {
+			self::$_instance = new self();
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * Resets the config
+	 *
+	 * @param bool    $hard_reset    if TRUE, sets EE_CONFig back to its original settings in the database. If FALSE
+	 *                               (default) leaves the database alone, and merely resets the EE_Config object to
+	 *                               reflect its state in the database
+	 * @param boolean $reinstantiate if TRUE (default) call instance() and return it. Otherwise, just leave
+	 *                               $_instance as NULL. Useful in case you want to forget about the old instance on
+	 *                               EE_Config, but might not be ready to instantiate EE_Config currently (eg if the
+	 *                               site was put into maintenance mode)
+	 * @return EE_Config
+	 */
+	public static function reset($hard_reset = false, $reinstantiate = true)
+	{
+		if (self::$_instance instanceof EE_Config) {
+			if ($hard_reset) {
+				self::$_instance->legacy_shortcodes_manager = null;
+				self::$_instance->_addon_option_names = array();
+				self::$_instance->_initialize_config();
+				self::$_instance->update_espresso_config();
+			}
+			self::$_instance->update_addon_option_names();
+		}
+		self::$_instance = null;
+		// we don't need to reset the static properties imo because those should
+		// only change when a module is added or removed. Currently we don't
+		// support removing a module during a request when it previously existed
+		if ($reinstantiate) {
+			return self::instance();
+		} else {
+			return null;
+		}
+	}
+
+
+	/**
+	 *    class constructor
+	 *
+	 * @access    private
+	 */
+	private function __construct()
+	{
+		do_action('AHEE__EE_Config__construct__begin', $this);
+		EE_Config::$_logging_enabled = apply_filters('FHEE__EE_Config___construct__logging_enabled', false);
+		// setup empty config classes
+		$this->_initialize_config();
+		// load existing EE site settings
+		$this->_load_core_config();
+		// confirm everything loaded correctly and set filtered defaults if not
+		$this->_verify_config();
+		//  register shortcodes and modules
+		add_action(
+			'AHEE__EE_System__register_shortcodes_modules_and_widgets',
+			array($this, 'register_shortcodes_and_modules'),
+			999
+		);
+		//  initialize shortcodes and modules
+		add_action('AHEE__EE_System__core_loaded_and_ready', array($this, 'initialize_shortcodes_and_modules'));
+		// register widgets
+		add_action('widgets_init', array($this, 'widgets_init'), 10);
+		// shutdown
+		add_action('shutdown', array($this, 'shutdown'), 10);
+		// construct__end hook
+		do_action('AHEE__EE_Config__construct__end', $this);
+		// hardcoded hack
+		$this->template_settings->current_espresso_theme = 'Espresso_Arabica_2014';
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	public static function logging_enabled()
+	{
+		return self::$_logging_enabled;
+	}
+
+
+	/**
+	 * use to get the current theme if needed from static context
+	 *
+	 * @return string current theme set.
+	 */
+	public static function get_current_theme()
+	{
+		return isset(self::$_instance->template_settings->current_espresso_theme)
+			? self::$_instance->template_settings->current_espresso_theme : 'Espresso_Arabica_2014';
+	}
+
+
+	/**
+	 *        _initialize_config
+	 *
+	 * @access private
+	 * @return void
+	 */
+	private function _initialize_config()
+	{
+		EE_Config::trim_log();
+		// set defaults
+		$this->_addon_option_names = get_option(EE_Config::ADDON_OPTION_NAMES, array());
+		$this->addons = new stdClass();
+		// set _module_route_map
+		EE_Config::$_module_route_map = array();
+		// set _module_forward_map
+		EE_Config::$_module_forward_map = array();
+		// set _module_view_map
+		EE_Config::$_module_view_map = array();
+	}
+
+
+	/**
+	 *        load core plugin configuration
+	 *
+	 * @access private
+	 * @return void
+	 */
+	private function _load_core_config()
+	{
+		// load_core_config__start hook
+		do_action('AHEE__EE_Config___load_core_config__start', $this);
+		$espresso_config = $this->get_espresso_config();
+		foreach ($espresso_config as $config => $settings) {
+			// load_core_config__start hook
+			$settings = apply_filters(
+				'FHEE__EE_Config___load_core_config__config_settings',
+				$settings,
+				$config,
+				$this
+			);
+			if (is_object($settings) && property_exists($this, $config)) {
+				$this->{$config} = apply_filters('FHEE__EE_Config___load_core_config__' . $config, $settings);
+				// call configs populate method to ensure any defaults are set for empty values.
+				if (method_exists($settings, 'populate')) {
+					$this->{$config}->populate();
+				}
+				if (method_exists($settings, 'do_hooks')) {
+					$this->{$config}->do_hooks();
+				}
+			}
+		}
+		if (apply_filters('FHEE__EE_Config___load_core_config__update_espresso_config', false)) {
+			$this->update_espresso_config();
+		}
+		// load_core_config__end hook
+		do_action('AHEE__EE_Config___load_core_config__end', $this);
+	}
+
+
+	/**
+	 *    _verify_config
+	 *
+	 * @access    protected
+	 * @return    void
+	 */
+	protected function _verify_config()
+	{
+		$this->core = $this->core instanceof EE_Core_Config
+			? $this->core
+			: new EE_Core_Config();
+		$this->core = apply_filters('FHEE__EE_Config___initialize_config__core', $this->core);
+		$this->organization = $this->organization instanceof EE_Organization_Config
+			? $this->organization
+			: new EE_Organization_Config();
+		$this->organization = apply_filters(
+			'FHEE__EE_Config___initialize_config__organization',
+			$this->organization
+		);
+		$this->currency = $this->currency instanceof EE_Currency_Config
+			? $this->currency
+			: new EE_Currency_Config();
+		$this->currency = apply_filters('FHEE__EE_Config___initialize_config__currency', $this->currency);
+		$this->registration = $this->registration instanceof EE_Registration_Config
+			? $this->registration
+			: new EE_Registration_Config();
+		$this->registration = apply_filters(
+			'FHEE__EE_Config___initialize_config__registration',
+			$this->registration
+		);
+		$this->admin = $this->admin instanceof EE_Admin_Config
+			? $this->admin
+			: new EE_Admin_Config();
+		$this->admin = apply_filters('FHEE__EE_Config___initialize_config__admin', $this->admin);
+		$this->template_settings = $this->template_settings instanceof EE_Template_Config
+			? $this->template_settings
+			: new EE_Template_Config();
+		$this->template_settings = apply_filters(
+			'FHEE__EE_Config___initialize_config__template_settings',
+			$this->template_settings
+		);
+		$this->map_settings = $this->map_settings instanceof EE_Map_Config
+			? $this->map_settings
+			: new EE_Map_Config();
+		$this->map_settings = apply_filters(
+			'FHEE__EE_Config___initialize_config__map_settings',
+			$this->map_settings
+		);
+		$this->environment = $this->environment instanceof EE_Environment_Config
+			? $this->environment
+			: new EE_Environment_Config();
+		$this->environment = apply_filters(
+			'FHEE__EE_Config___initialize_config__environment',
+			$this->environment
+		);
+		$this->tax_settings = $this->tax_settings instanceof EE_Tax_Config
+			? $this->tax_settings
+			: new EE_Tax_Config();
+		$this->tax_settings = apply_filters(
+			'FHEE__EE_Config___initialize_config__tax_settings',
+			$this->tax_settings
+		);
+		$this->messages = apply_filters('FHEE__EE_Config__initialize_config__messages', $this->messages);
+		$this->messages = $this->messages instanceof EE_Messages_Config
+			? $this->messages
+			: new EE_Messages_Config();
+		$this->gateway = $this->gateway instanceof EE_Gateway_Config
+			? $this->gateway
+			: new EE_Gateway_Config();
+		$this->gateway = apply_filters('FHEE__EE_Config___initialize_config__gateway', $this->gateway);
+		$this->legacy_shortcodes_manager = null;
+	}
+
+
+	/**
+	 *    get_espresso_config
+	 *
+	 * @access    public
+	 * @return    array of espresso config stuff
+	 */
+	public function get_espresso_config()
+	{
+		// grab espresso configuration
+		return apply_filters(
+			'FHEE__EE_Config__get_espresso_config__CFG',
+			get_option(EE_Config::OPTION_NAME, array())
+		);
+	}
+
+
+	/**
+	 *    double_check_config_comparison
+	 *
+	 * @access    public
+	 * @param string $option
+	 * @param        $old_value
+	 * @param        $value
+	 */
+	public function double_check_config_comparison($option = '', $old_value, $value)
+	{
+		// make sure we're checking the ee config
+		if ($option === EE_Config::OPTION_NAME) {
+			// run a loose comparison of the old value against the new value for type and properties,
+			// but NOT exact instance like WP update_option does (ie: NOT type safe comparison)
+			if ($value != $old_value) {
+				// if they are NOT the same, then remove the hook,
+				// which means the subsequent update results will be based solely on the update query results
+				// the reason we do this is because, as stated above,
+				// WP update_option performs an exact instance comparison (===) on any update values passed to it
+				// this happens PRIOR to serialization and any subsequent update.
+				// If values are found to match their previous old value,
+				// then WP bails before performing any update.
+				// Since we are passing the EE_Config object, it is comparing the EXACT instance of the saved version
+				// it just pulled from the db, with the one being passed to it (which will not match).
+				// HOWEVER, once the object is serialized and passed off to MySQL to update,
+				// MySQL MAY ALSO NOT perform the update because
+				// the string it sees in the db looks the same as the new one it has been passed!!!
+				// This results in the query returning an "affected rows" value of ZERO,
+				// which gets returned immediately by WP update_option and looks like an error.
+				remove_action('update_option', array($this, 'check_config_updated'));
+			}
+		}
+	}
+
+
+	/**
+	 *    update_espresso_config
+	 *
+	 * @access   public
+	 */
+	protected function _reset_espresso_addon_config()
+	{
+		$this->_addon_option_names = array();
+		foreach ($this->addons as $addon_name => $addon_config_obj) {
+			$addon_config_obj = maybe_unserialize($addon_config_obj);
+			if ($addon_config_obj instanceof EE_Config_Base) {
+				$this->update_config('addons', $addon_name, $addon_config_obj, false);
+			}
+			$this->addons->{$addon_name} = null;
+		}
+	}
+
+
+	/**
+	 *    update_espresso_config
+	 *
+	 * @access   public
+	 * @param   bool $add_success
+	 * @param   bool $add_error
+	 * @return   bool
+	 */
+	public function update_espresso_config($add_success = false, $add_error = true)
+	{
+		// don't allow config updates during WP heartbeats
+		if (\EE_Registry::instance()->REQ->get('action', '') === 'heartbeat') {
+			return false;
+		}
+		// commented out the following re: https://events.codebasehq.com/projects/event-espresso/tickets/8197
+		// $clone = clone( self::$_instance );
+		// self::$_instance = NULL;
+		do_action('AHEE__EE_Config__update_espresso_config__begin', $this);
+		$this->_reset_espresso_addon_config();
+		// hook into update_option because that happens AFTER the ( $value === $old_value ) conditional
+		// but BEFORE the actual update occurs
+		add_action('update_option', array($this, 'double_check_config_comparison'), 1, 3);
+		// don't want to persist legacy_shortcodes_manager, but don't want to lose it either
+		$legacy_shortcodes_manager = $this->legacy_shortcodes_manager;
+		$this->legacy_shortcodes_manager = null;
+		// now update "ee_config"
+		$saved = update_option(EE_Config::OPTION_NAME, $this);
+		$this->legacy_shortcodes_manager = $legacy_shortcodes_manager;
+		EE_Config::log(EE_Config::OPTION_NAME);
+		// if not saved... check if the hook we just added still exists;
+		// if it does, it means one of two things:
+		// that update_option bailed at the($value === $old_value) conditional,
+		// or...
+		// the db update query returned 0 rows affected
+		// (probably because the data  value was the same from it's perspective)
+		// so the existence of the hook means that a negative result from update_option is NOT an error,
+		// but just means no update occurred, so don't display an error to the user.
+		// BUT... if update_option returns FALSE, AND the hook is missing,
+		// then it means that something truly went wrong
+		$saved = ! $saved ? has_action('update_option', array($this, 'double_check_config_comparison')) : $saved;
+		// remove our action since we don't want it in the system anymore
+		remove_action('update_option', array($this, 'double_check_config_comparison'), 1);
+		do_action('AHEE__EE_Config__update_espresso_config__end', $this, $saved);
+		// self::$_instance = $clone;
+		// unset( $clone );
+		// if config remains the same or was updated successfully
+		if ($saved) {
+			if ($add_success) {
+				EE_Error::add_success(
+					__('The Event Espresso Configuration Settings have been successfully updated.', 'event_espresso'),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+			return true;
+		} else {
+			if ($add_error) {
+				EE_Error::add_error(
+					__('The Event Espresso Configuration Settings were not updated.', 'event_espresso'),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+			return false;
+		}
+	}
+
+
+	/**
+	 *    _verify_config_params
+	 *
+	 * @access    private
+	 * @param    string         $section
+	 * @param    string         $name
+	 * @param    string         $config_class
+	 * @param    EE_Config_Base $config_obj
+	 * @param    array          $tests_to_run
+	 * @param    bool           $display_errors
+	 * @return    bool    TRUE on success, FALSE on fail
+	 */
+	private function _verify_config_params(
+		$section = '',
+		$name = '',
+		$config_class = '',
+		$config_obj = null,
+		$tests_to_run = array(1, 2, 3, 4, 5, 6, 7, 8),
+		$display_errors = true
+	) {
+		try {
+			foreach ($tests_to_run as $test) {
+				switch ($test) {
+					// TEST #1 : check that section was set
+					case 1:
+						if (empty($section)) {
+							if ($display_errors) {
+								throw new EE_Error(
+									sprintf(
+										__(
+											'No configuration section has been provided while attempting to save "%s".',
+											'event_espresso'
+										),
+										$config_class
+									)
+								);
+							}
+							return false;
+						}
+						break;
+					// TEST #2 : check that settings section exists
+					case 2:
+						if (! isset($this->{$section})) {
+							if ($display_errors) {
+								throw new EE_Error(
+									sprintf(
+										__('The "%s" configuration section does not exist.', 'event_espresso'),
+										$section
+									)
+								);
+							}
+							return false;
+						}
+						break;
+					// TEST #3 : check that section is the proper format
+					case 3:
+						if (! ($this->{$section} instanceof EE_Config_Base || $this->{$section} instanceof stdClass)
+						) {
+							if ($display_errors) {
+								throw new EE_Error(
+									sprintf(
+										__(
+											'The "%s" configuration settings have not been formatted correctly.',
+											'event_espresso'
+										),
+										$section
+									)
+								);
+							}
+							return false;
+						}
+						break;
+					// TEST #4 : check that config section name has been set
+					case 4:
+						if (empty($name)) {
+							if ($display_errors) {
+								throw new EE_Error(
+									__(
+										'No name has been provided for the specific configuration section.',
+										'event_espresso'
+									)
+								);
+							}
+							return false;
+						}
+						break;
+					// TEST #5 : check that a config class name has been set
+					case 5:
+						if (empty($config_class)) {
+							if ($display_errors) {
+								throw new EE_Error(
+									__(
+										'No class name has been provided for the specific configuration section.',
+										'event_espresso'
+									)
+								);
+							}
+							return false;
+						}
+						break;
+					// TEST #6 : verify config class is accessible
+					case 6:
+						if (! class_exists($config_class)) {
+							if ($display_errors) {
+								throw new EE_Error(
+									sprintf(
+										__(
+											'The "%s" class does not exist. Please ensure that an autoloader has been set for it.',
+											'event_espresso'
+										),
+										$config_class
+									)
+								);
+							}
+							return false;
+						}
+						break;
+					// TEST #7 : check that config has even been set
+					case 7:
+						if (! isset($this->{$section}->{$name})) {
+							if ($display_errors) {
+								throw new EE_Error(
+									sprintf(
+										__('No configuration has been set for "%1$s->%2$s".', 'event_espresso'),
+										$section,
+										$name
+									)
+								);
+							}
+							return false;
+						} else {
+							// and make sure it's not serialized
+							$this->{$section}->{$name} = maybe_unserialize($this->{$section}->{$name});
+						}
+						break;
+					// TEST #8 : check that config is the requested type
+					case 8:
+						if (! $this->{$section}->{$name} instanceof $config_class) {
+							if ($display_errors) {
+								throw new EE_Error(
+									sprintf(
+										__(
+											'The configuration for "%1$s->%2$s" is not of the "%3$s" class.',
+											'event_espresso'
+										),
+										$section,
+										$name,
+										$config_class
+									)
+								);
+							}
+							return false;
+						}
+						break;
+					// TEST #9 : verify config object
+					case 9:
+						if (! $config_obj instanceof EE_Config_Base) {
+							if ($display_errors) {
+								throw new EE_Error(
+									sprintf(
+										__('The "%s" class is not an instance of EE_Config_Base.', 'event_espresso'),
+										print_r($config_obj, true)
+									)
+								);
+							}
+							return false;
+						}
+						break;
+				}
+			}
+		} catch (EE_Error $e) {
+			$e->get_error();
+		}
+		// you have successfully run the gauntlet
+		return true;
+	}
+
+
+	/**
+	 *    _generate_config_option_name
+	 *
+	 * @access        protected
+	 * @param        string $section
+	 * @param        string $name
+	 * @return        string
+	 */
+	private function _generate_config_option_name($section = '', $name = '')
+	{
+		return 'ee_config-' . strtolower($section . '-' . str_replace(array('EE_', 'EED_'), '', $name));
+	}
+
+
+	/**
+	 *    _set_config_class
+	 * ensures that a config class is set, either from a passed config class or one generated from the config name
+	 *
+	 * @access    private
+	 * @param    string $config_class
+	 * @param    string $name
+	 * @return    string
+	 */
+	private function _set_config_class($config_class = '', $name = '')
+	{
+		return ! empty($config_class)
+			? $config_class
+			: str_replace(' ', '_', ucwords(str_replace('_', ' ', $name))) . '_Config';
+	}
+
+
+	/**
+	 *    set_config
+	 *
+	 * @access    protected
+	 * @param    string         $section
+	 * @param    string         $name
+	 * @param    string         $config_class
+	 * @param    EE_Config_Base $config_obj
+	 * @return    EE_Config_Base
+	 */
+	public function set_config($section = '', $name = '', $config_class = '', EE_Config_Base $config_obj = null)
+	{
+		// ensure config class is set to something
+		$config_class = $this->_set_config_class($config_class, $name);
+		// run tests 1-4, 6, and 7 to verify all config params are set and valid
+		if (! $this->_verify_config_params($section, $name, $config_class, null, array(1, 2, 3, 4, 5, 6))) {
+			return null;
+		}
+		$config_option_name = $this->_generate_config_option_name($section, $name);
+		// if the config option name hasn't been added yet to the list of option names we're tracking, then do so now
+		if (! isset($this->_addon_option_names[ $config_option_name ])) {
+			$this->_addon_option_names[ $config_option_name ] = $config_class;
+			$this->update_addon_option_names();
+		}
+		// verify the incoming config object but suppress errors
+		if (! $this->_verify_config_params($section, $name, $config_class, $config_obj, array(9), false)) {
+			$config_obj = new $config_class();
+		}
+		if (get_option($config_option_name)) {
+			EE_Config::log($config_option_name);
+			update_option($config_option_name, $config_obj);
+			$this->{$section}->{$name} = $config_obj;
+			return $this->{$section}->{$name};
+		} else {
+			// create a wp-option for this config
+			if (add_option($config_option_name, $config_obj, '', 'no')) {
+				$this->{$section}->{$name} = maybe_unserialize($config_obj);
+				return $this->{$section}->{$name};
+			} else {
+				EE_Error::add_error(
+					sprintf(__('The "%s" could not be saved to the database.', 'event_espresso'), $config_class),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+				return null;
+			}
+		}
+	}
+
+
+	/**
+	 *    update_config
+	 * Important: the config object must ALREADY be set, otherwise this will produce an error.
+	 *
+	 * @access    public
+	 * @param    string                $section
+	 * @param    string                $name
+	 * @param    EE_Config_Base|string $config_obj
+	 * @param    bool                  $throw_errors
+	 * @return    bool
+	 */
+	public function update_config($section = '', $name = '', $config_obj = '', $throw_errors = true)
+	{
+		// don't allow config updates during WP heartbeats
+		if (\EE_Registry::instance()->REQ->get('action', '') === 'heartbeat') {
+			return false;
+		}
+		$config_obj = maybe_unserialize($config_obj);
+		// get class name of the incoming object
+		$config_class = get_class($config_obj);
+		// run tests 1-5 and 9 to verify config
+		if (! $this->_verify_config_params(
+			$section,
+			$name,
+			$config_class,
+			$config_obj,
+			array(1, 2, 3, 4, 7, 9)
+		)
+		) {
+			return false;
+		}
+		$config_option_name = $this->_generate_config_option_name($section, $name);
+		// check if config object has been added to db by seeing if config option name is in $this->_addon_option_names array
+		if (! isset($this->_addon_option_names[ $config_option_name ])) {
+			// save new config to db
+			if ($this->set_config($section, $name, $config_class, $config_obj)) {
+				return true;
+			}
+		} else {
+			// first check if the record already exists
+			$existing_config = get_option($config_option_name);
+			$config_obj = serialize($config_obj);
+			// just return if db record is already up to date (NOT type safe comparison)
+			if ($existing_config == $config_obj) {
+				$this->{$section}->{$name} = $config_obj;
+				return true;
+			} elseif (update_option($config_option_name, $config_obj)) {
+				EE_Config::log($config_option_name);
+				// update wp-option for this config class
+				$this->{$section}->{$name} = $config_obj;
+				return true;
+			} elseif ($throw_errors) {
+				EE_Error::add_error(
+					sprintf(
+						__(
+							'The "%1$s" object stored at"%2$s" was not successfully updated in the database.',
+							'event_espresso'
+						),
+						$config_class,
+						'EE_Config->' . $section . '->' . $name
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 *    get_config
+	 *
+	 * @access    public
+	 * @param    string $section
+	 * @param    string $name
+	 * @param    string $config_class
+	 * @return    mixed EE_Config_Base | NULL
+	 */
+	public function get_config($section = '', $name = '', $config_class = '')
+	{
+		// ensure config class is set to something
+		$config_class = $this->_set_config_class($config_class, $name);
+		// run tests 1-4, 6 and 7 to verify that all params have been set
+		if (! $this->_verify_config_params($section, $name, $config_class, null, array(1, 2, 3, 4, 5, 6))) {
+			return null;
+		}
+		// now test if the requested config object exists, but suppress errors
+		if ($this->_verify_config_params($section, $name, $config_class, null, array(7, 8), false)) {
+			// config already exists, so pass it back
+			return $this->{$section}->{$name};
+		}
+		// load config option from db if it exists
+		$config_obj = $this->get_config_option($this->_generate_config_option_name($section, $name));
+		// verify the newly retrieved config object, but suppress errors
+		if ($this->_verify_config_params($section, $name, $config_class, $config_obj, array(9), false)) {
+			// config is good, so set it and pass it back
+			$this->{$section}->{$name} = $config_obj;
+			return $this->{$section}->{$name};
+		}
+		// oops! $config_obj is not already set and does not exist in the db, so create a new one
+		$config_obj = $this->set_config($section, $name, $config_class);
+		// verify the newly created config object
+		if ($this->_verify_config_params($section, $name, $config_class, $config_obj, array(9))) {
+			return $this->{$section}->{$name};
+		} else {
+			EE_Error::add_error(
+				sprintf(__('The "%s" could not be retrieved from the database.', 'event_espresso'), $config_class),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		return null;
+	}
+
+
+	/**
+	 *    get_config_option
+	 *
+	 * @access    public
+	 * @param    string $config_option_name
+	 * @return    mixed EE_Config_Base | FALSE
+	 */
+	public function get_config_option($config_option_name = '')
+	{
+		// retrieve the wp-option for this config class.
+		$config_option = maybe_unserialize(get_option($config_option_name, array()));
+		if (empty($config_option)) {
+			EE_Config::log($config_option_name . '-NOT-FOUND');
+		}
+		return $config_option;
+	}
+
+
+	/**
+	 * log
+	 *
+	 * @param string $config_option_name
+	 */
+	public static function log($config_option_name = '')
+	{
+		if (EE_Config::logging_enabled() && ! empty($config_option_name)) {
+			$config_log = get_option(EE_Config::LOG_NAME, array());
+			// copy incoming $_REQUEST and sanitize it so we can save it
+			$_request = $_REQUEST;
+			array_walk_recursive($_request, 'sanitize_text_field');
+			$config_log[ (string) microtime(true) ] = array(
+				'config_name' => $config_option_name,
+				'request'     => $_request,
+			);
+			update_option(EE_Config::LOG_NAME, $config_log);
+		}
+	}
+
+
+	/**
+	 * trim_log
+	 * reduces the size of the config log to the length specified by EE_Config::LOG_LENGTH
+	 */
+	public static function trim_log()
+	{
+		if (! EE_Config::logging_enabled()) {
+			return;
+		}
+		$config_log = maybe_unserialize(get_option(EE_Config::LOG_NAME, array()));
+		$log_length = count($config_log);
+		if ($log_length > EE_Config::LOG_LENGTH) {
+			ksort($config_log);
+			$config_log = array_slice($config_log, $log_length - EE_Config::LOG_LENGTH, null, true);
+			update_option(EE_Config::LOG_NAME, $config_log);
+		}
+	}
+
+
+	/**
+	 *    get_page_for_posts
+	 *    if the wp-option "show_on_front" is set to "page", then this is the post_name for the post set in the
+	 *    wp-option "page_for_posts", or "posts" if no page is selected
+	 *
+	 * @access    public
+	 * @return    string
+	 */
+	public static function get_page_for_posts()
+	{
+		$page_for_posts = get_option('page_for_posts');
+		if (! $page_for_posts) {
+			return 'posts';
+		}
+		/** @type WPDB $wpdb */
+		global $wpdb;
+		$SQL = "SELECT post_name from $wpdb->posts WHERE post_type='posts' OR post_type='page' AND post_status='publish' AND ID=%d";
+		return $wpdb->get_var($wpdb->prepare($SQL, $page_for_posts));
+	}
+
+
+	/**
+	 *    register_shortcodes_and_modules.
+	 *    At this point, it's too early to tell if we're maintenance mode or not.
+	 *    In fact, this is where we give modules a chance to let core know they exist
+	 *    so they can help trigger maintenance mode if it's needed
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public function register_shortcodes_and_modules()
+	{
+		// allow modules to set hooks for the rest of the system
+		EE_Registry::instance()->modules = $this->_register_modules();
+	}
+
+
+	/**
+	 *    initialize_shortcodes_and_modules
+	 *    meaning they can start adding their hooks to get stuff done
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public function initialize_shortcodes_and_modules()
+	{
+		// allow modules to set hooks for the rest of the system
+		$this->_initialize_modules();
+	}
+
+
+	/**
+	 *    widgets_init
+	 *
+	 * @access private
+	 * @return void
+	 */
+	public function widgets_init()
+	{
+		// only init widgets on admin pages when not in complete maintenance, and
+		// on frontend when not in any maintenance mode
+		if (! EE_Maintenance_Mode::instance()->level()
+			|| (
+				is_admin()
+				&& EE_Maintenance_Mode::instance()->level() !== EE_Maintenance_Mode::level_2_complete_maintenance
+			)
+		) {
+			// grab list of installed widgets
+			$widgets_to_register = glob(EE_WIDGETS . '*', GLOB_ONLYDIR);
+			// filter list of modules to register
+			$widgets_to_register = apply_filters(
+				'FHEE__EE_Config__register_widgets__widgets_to_register',
+				$widgets_to_register
+			);
+			if (! empty($widgets_to_register)) {
+				// cycle thru widget folders
+				foreach ($widgets_to_register as $widget_path) {
+					// add to list of installed widget modules
+					EE_Config::register_ee_widget($widget_path);
+				}
+			}
+			// filter list of installed modules
+			EE_Registry::instance()->widgets = apply_filters(
+				'FHEE__EE_Config__register_widgets__installed_widgets',
+				EE_Registry::instance()->widgets
+			);
+		}
+	}
+
+
+	/**
+	 *    register_ee_widget - makes core aware of this widget
+	 *
+	 * @access    public
+	 * @param    string $widget_path - full path up to and including widget folder
+	 * @return    void
+	 */
+	public static function register_ee_widget($widget_path = null)
+	{
+		do_action('AHEE__EE_Config__register_widget__begin', $widget_path);
+		$widget_ext = '.widget.php';
+		// make all separators match
+		$widget_path = rtrim(str_replace('\\', DS, $widget_path), DS);
+		// does the file path INCLUDE the actual file name as part of the path ?
+		if (strpos($widget_path, $widget_ext) !== false) {
+			// grab and shortcode file name from directory name and break apart at dots
+			$file_name = explode('.', basename($widget_path));
+			// take first segment from file name pieces and remove class prefix if it exists
+			$widget = strpos($file_name[0], 'EEW_') === 0 ? substr($file_name[0], 4) : $file_name[0];
+			// sanitize shortcode directory name
+			$widget = sanitize_key($widget);
+			// now we need to rebuild the shortcode path
+			$widget_path = explode('/', $widget_path);
+			// remove last segment
+			array_pop($widget_path);
+			// glue it back together
+			$widget_path = implode(DS, $widget_path);
+		} else {
+			// grab and sanitize widget directory name
+			$widget = sanitize_key(basename($widget_path));
+		}
+		// create classname from widget directory name
+		$widget = str_replace(' ', '_', ucwords(str_replace('_', ' ', $widget)));
+		// add class prefix
+		$widget_class = 'EEW_' . $widget;
+		// does the widget exist ?
+		if (! is_readable($widget_path . '/' . $widget_class . $widget_ext)) {
+			$msg = sprintf(
+				__(
+					'The requested %s widget file could not be found or is not readable due to file permissions. Please ensure the following path is correct: %s',
+					'event_espresso'
+				),
+				$widget_class,
+				$widget_path . '/' . $widget_class . $widget_ext
+			);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return;
+		}
+		// load the widget class file
+		require_once($widget_path . '/' . $widget_class . $widget_ext);
+		// verify that class exists
+		if (! class_exists($widget_class)) {
+			$msg = sprintf(__('The requested %s widget class does not exist.', 'event_espresso'), $widget_class);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return;
+		}
+		register_widget($widget_class);
+		// add to array of registered widgets
+		EE_Registry::instance()->widgets->{$widget_class} = $widget_path . '/' . $widget_class . $widget_ext;
+	}
+
+
+	/**
+	 *        _register_modules
+	 *
+	 * @access private
+	 * @return array
+	 */
+	private function _register_modules()
+	{
+		// grab list of installed modules
+		$modules_to_register = glob(EE_MODULES . '*', GLOB_ONLYDIR);
+		// filter list of modules to register
+		$modules_to_register = apply_filters(
+			'FHEE__EE_Config__register_modules__modules_to_register',
+			$modules_to_register
+		);
+		if (! empty($modules_to_register)) {
+			// loop through folders
+			foreach ($modules_to_register as $module_path) {
+				/**TEMPORARILY EXCLUDE gateways from modules for time being**/
+				if ($module_path !== EE_MODULES . 'zzz-copy-this-module-template'
+					&& $module_path !== EE_MODULES . 'gateways'
+				) {
+					// add to list of installed modules
+					EE_Config::register_module($module_path);
+				}
+			}
+		}
+		// filter list of installed modules
+		return apply_filters(
+			'FHEE__EE_Config___register_modules__installed_modules',
+			EE_Registry::instance()->modules
+		);
+	}
+
+
+	/**
+	 *    register_module - makes core aware of this module
+	 *
+	 * @access    public
+	 * @param    string $module_path - full path up to and including module folder
+	 * @return    bool
+	 */
+	public static function register_module($module_path = null)
+	{
+		do_action('AHEE__EE_Config__register_module__begin', $module_path);
+		$module_ext = '.module.php';
+		// make all separators match
+		$module_path = str_replace(array('\\', '/'), '/', $module_path);
+		// does the file path INCLUDE the actual file name as part of the path ?
+		if (strpos($module_path, $module_ext) !== false) {
+			// grab and shortcode file name from directory name and break apart at dots
+			$module_file = explode('.', basename($module_path));
+			// now we need to rebuild the shortcode path
+			$module_path = explode('/', $module_path);
+			// remove last segment
+			array_pop($module_path);
+			// glue it back together
+			$module_path = implode('/', $module_path) . '/';
+			// take first segment from file name pieces and sanitize it
+			$module = preg_replace('/[^a-zA-Z0-9_\-]/', '', $module_file[0]);
+			// ensure class prefix is added
+			$module_class = strpos($module, 'EED_') !== 0 ? 'EED_' . $module : $module;
+		} else {
+			// we need to generate the filename based off of the folder name
+			// grab and sanitize module name
+			$module = strtolower(basename($module_path));
+			$module = preg_replace('/[^a-z0-9_\-]/', '', $module);
+			// like trailingslashit()
+			$module_path = rtrim($module_path, '/') . '/';
+			// create classname from module directory name
+			$module = str_replace(' ', '_', ucwords(str_replace('_', ' ', $module)));
+			// add class prefix
+			$module_class = 'EED_' . $module;
+		}
+		// does the module exist ?
+		if (! is_readable($module_path . '/' . $module_class . $module_ext)) {
+			$msg = sprintf(
+				__(
+					'The requested %s module file could not be found or is not readable due to file permissions.',
+					'event_espresso'
+				),
+				$module
+			);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		// load the module class file
+		require_once($module_path . $module_class . $module_ext);
+		// verify that class exists
+		if (! class_exists($module_class)) {
+			$msg = sprintf(__('The requested %s module class does not exist.', 'event_espresso'), $module_class);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		// add to array of registered modules
+		EE_Registry::instance()->modules->{$module_class} = $module_path . $module_class . $module_ext;
+		do_action(
+			'AHEE__EE_Config__register_module__complete',
+			$module_class,
+			EE_Registry::instance()->modules->{$module_class}
+		);
+		return true;
+	}
+
+
+	/**
+	 *    _initialize_modules
+	 *    allow modules to set hooks for the rest of the system
+	 *
+	 * @access private
+	 * @return void
+	 */
+	private function _initialize_modules()
+	{
+		// cycle thru shortcode folders
+		foreach (EE_Registry::instance()->modules as $module_class => $module_path) {
+			// fire the shortcode class's set_hooks methods in case it needs to hook into other parts of the system
+			// which set hooks ?
+			if (is_admin()) {
+				// fire immediately
+				call_user_func(array($module_class, 'set_hooks_admin'));
+			} else {
+				// delay until other systems are online
+				add_action(
+					'AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons',
+					array($module_class, 'set_hooks')
+				);
+			}
+		}
+	}
+
+
+	/**
+	 *    register_route - adds module method routes to route_map
+	 *
+	 * @access    public
+	 * @param    string $route       - "pretty" public alias for module method
+	 * @param    string $module      - module name (classname without EED_ prefix)
+	 * @param    string $method_name - the actual module method to be routed to
+	 * @param    string $key         - url param key indicating a route is being called
+	 * @return    bool
+	 */
+	public static function register_route($route = null, $module = null, $method_name = null, $key = 'ee')
+	{
+		do_action('AHEE__EE_Config__register_route__begin', $route, $module, $method_name);
+		$module = str_replace('EED_', '', $module);
+		$module_class = 'EED_' . $module;
+		if (! isset(EE_Registry::instance()->modules->{$module_class})) {
+			$msg = sprintf(__('The module %s has not been registered.', 'event_espresso'), $module);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		if (empty($route)) {
+			$msg = sprintf(__('No route has been supplied.', 'event_espresso'), $route);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		if (! method_exists('EED_' . $module, $method_name)) {
+			$msg = sprintf(
+				__('A valid class method for the %s route has not been supplied.', 'event_espresso'),
+				$route
+			);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		EE_Config::$_module_route_map[ (string) $key ][ (string) $route ] = array('EED_' . $module, $method_name);
+		return true;
+	}
+
+
+	/**
+	 *    get_route - get module method route
+	 *
+	 * @access    public
+	 * @param    string $route - "pretty" public alias for module method
+	 * @param    string $key   - url param key indicating a route is being called
+	 * @return    string
+	 */
+	public static function get_route($route = null, $key = 'ee')
+	{
+		do_action('AHEE__EE_Config__get_route__begin', $route);
+		$route = (string) apply_filters('FHEE__EE_Config__get_route', $route);
+		if (isset(EE_Config::$_module_route_map[ $key ][ $route ])) {
+			return EE_Config::$_module_route_map[ $key ][ $route ];
+		}
+		return null;
+	}
+
+
+	/**
+	 *    get_routes - get ALL module method routes
+	 *
+	 * @access    public
+	 * @return    array
+	 */
+	public static function get_routes()
+	{
+		return EE_Config::$_module_route_map;
+	}
+
+
+	/**
+	 *    register_forward - allows modules to forward request to another module for further processing
+	 *
+	 * @access    public
+	 * @param    string       $route   - "pretty" public alias for module method
+	 * @param    integer      $status  - integer value corresponding  to status constant strings set in module parent
+	 *                                 class, allows different forwards to be served based on status
+	 * @param    array|string $forward - function name or array( class, method )
+	 * @param    string       $key     - url param key indicating a route is being called
+	 * @return    bool
+	 */
+	public static function register_forward($route = null, $status = 0, $forward = null, $key = 'ee')
+	{
+		do_action('AHEE__EE_Config__register_forward', $route, $status, $forward);
+		if (! isset(EE_Config::$_module_route_map[ $key ][ $route ]) || empty($route)) {
+			$msg = sprintf(
+				__('The module route %s for this forward has not been registered.', 'event_espresso'),
+				$route
+			);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		if (empty($forward)) {
+			$msg = sprintf(__('No forwarding route has been supplied.', 'event_espresso'), $route);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		if (is_array($forward)) {
+			if (! isset($forward[1])) {
+				$msg = sprintf(
+					__('A class method for the %s forwarding route has not been supplied.', 'event_espresso'),
+					$route
+				);
+				EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+				return false;
+			}
+			if (! method_exists($forward[0], $forward[1])) {
+				$msg = sprintf(
+					__('The class method %s for the %s forwarding route is in invalid.', 'event_espresso'),
+					$forward[1],
+					$route
+				);
+				EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+				return false;
+			}
+		} elseif (! function_exists($forward)) {
+			$msg = sprintf(
+				__('The function %s for the %s forwarding route is in invalid.', 'event_espresso'),
+				$forward,
+				$route
+			);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		EE_Config::$_module_forward_map[ $key ][ $route ][ absint($status) ] = $forward;
+		return true;
+	}
+
+
+	/**
+	 *    get_forward - get forwarding route
+	 *
+	 * @access    public
+	 * @param    string  $route  - "pretty" public alias for module method
+	 * @param    integer $status - integer value corresponding  to status constant strings set in module parent class,
+	 *                           allows different forwards to be served based on status
+	 * @param    string  $key    - url param key indicating a route is being called
+	 * @return    string
+	 */
+	public static function get_forward($route = null, $status = 0, $key = 'ee')
+	{
+		do_action('AHEE__EE_Config__get_forward__begin', $route, $status);
+		if (isset(EE_Config::$_module_forward_map[ $key ][ $route ][ $status ])) {
+			return apply_filters(
+				'FHEE__EE_Config__get_forward',
+				EE_Config::$_module_forward_map[ $key ][ $route ][ $status ],
+				$route,
+				$status
+			);
+		}
+		return null;
+	}
+
+
+	/**
+	 *    register_forward - allows modules to specify different view templates for different method routes and status
+	 *    results
+	 *
+	 * @access    public
+	 * @param    string  $route  - "pretty" public alias for module method
+	 * @param    integer $status - integer value corresponding  to status constant strings set in module parent class,
+	 *                           allows different views to be served based on status
+	 * @param    string  $view
+	 * @param    string  $key    - url param key indicating a route is being called
+	 * @return    bool
+	 */
+	public static function register_view($route = null, $status = 0, $view = null, $key = 'ee')
+	{
+		do_action('AHEE__EE_Config__register_view__begin', $route, $status, $view);
+		if (! isset(EE_Config::$_module_route_map[ $key ][ $route ]) || empty($route)) {
+			$msg = sprintf(
+				__('The module route %s for this view has not been registered.', 'event_espresso'),
+				$route
+			);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		if (! is_readable($view)) {
+			$msg = sprintf(
+				__(
+					'The %s view file could not be found or is not readable due to file permissions.',
+					'event_espresso'
+				),
+				$view
+			);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		EE_Config::$_module_view_map[ $key ][ $route ][ absint($status) ] = $view;
+		return true;
+	}
+
+
+	/**
+	 *    get_view - get view for route and status
+	 *
+	 * @access    public
+	 * @param    string  $route  - "pretty" public alias for module method
+	 * @param    integer $status - integer value corresponding  to status constant strings set in module parent class,
+	 *                           allows different views to be served based on status
+	 * @param    string  $key    - url param key indicating a route is being called
+	 * @return    string
+	 */
+	public static function get_view($route = null, $status = 0, $key = 'ee')
+	{
+		do_action('AHEE__EE_Config__get_view__begin', $route, $status);
+		if (isset(EE_Config::$_module_view_map[ $key ][ $route ][ $status ])) {
+			return apply_filters(
+				'FHEE__EE_Config__get_view',
+				EE_Config::$_module_view_map[ $key ][ $route ][ $status ],
+				$route,
+				$status
+			);
+		}
+		return null;
+	}
+
+
+	public function update_addon_option_names()
+	{
+		update_option(EE_Config::ADDON_OPTION_NAMES, $this->_addon_option_names);
+	}
+
+
+	public function shutdown()
+	{
+		$this->update_addon_option_names();
+	}
+
+
+	/**
+	 * @return LegacyShortcodesManager
+	 */
+	public static function getLegacyShortcodesManager()
+	{
+
+		if (! EE_Config::instance()->legacy_shortcodes_manager instanceof LegacyShortcodesManager) {
+			EE_Config::instance()->legacy_shortcodes_manager = new LegacyShortcodesManager(
+				EE_Registry::instance()
+			);
+		}
+		return EE_Config::instance()->legacy_shortcodes_manager;
+	}
+
+
+	/**
+	 * register_shortcode - makes core aware of this shortcode
+	 *
+	 * @deprecated 4.9.26
+	 * @param    string $shortcode_path - full path up to and including shortcode folder
+	 * @return    bool
+	 */
+	public static function register_shortcode($shortcode_path = null)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			__(
+				'Usage is deprecated. Use \EventEspresso\core\services\shortcodes\LegacyShortcodesManager::registerShortcode() as direct replacement, or better yet, please see the new \EventEspresso\core\services\shortcodes\ShortcodesManager class.',
+				'event_espresso'
+			),
+			'4.9.26'
+		);
+		return EE_Config::instance()->getLegacyShortcodesManager()->registerShortcode($shortcode_path);
+	}
+}
 
-    /**
-     * ReCaptcha Type
-     *
-     * @var string $recaptcha_type
-     *    options: 'audio', 'image'
-     */
-    public $recaptcha_type;
+/**
+ * Base class used for config classes. These classes should generally not have
+ * magic functions in use, except we'll allow them to magically set and get stuff...
+ * basically, they should just be well-defined stdClasses
+ */
+class EE_Config_Base
+{
 
-    /**
-     * ReCaptcha language
-     *
-     * @var string $recaptcha_language
-     * eg 'en'
-     */
-    public $recaptcha_language;
+	/**
+	 * Utility function for escaping the value of a property and returning.
+	 *
+	 * @param string $property property name (checks to see if exists).
+	 * @return mixed if a detected type found return the escaped value, otherwise just the raw value is returned.
+	 * @throws \EE_Error
+	 */
+	public function get_pretty($property)
+	{
+		if (! property_exists($this, $property)) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'%1$s::get_pretty() has been called with the property %2$s which does not exist on the %1$s config class.',
+						'event_espresso'
+					),
+					get_class($this),
+					$property
+				)
+			);
+		}
+		// just handling escaping of strings for now.
+		if (is_string($this->{$property})) {
+			return stripslashes($this->{$property});
+		}
+		return $this->{$property};
+	}
+
+
+	public function populate()
+	{
+		// grab defaults via a new instance of this class.
+		$class_name = get_class($this);
+		$defaults = new $class_name;
+		// loop through the properties for this class and see if they are set.  If they are NOT, then grab the
+		// default from our $defaults object.
+		foreach (get_object_vars($defaults) as $property => $value) {
+			if ($this->{$property} === null) {
+				$this->{$property} = $value;
+			}
+		}
+		// cleanup
+		unset($defaults);
+	}
+
+
+	/**
+	 *        __isset
+	 *
+	 * @param $a
+	 * @return bool
+	 */
+	public function __isset($a)
+	{
+		return false;
+	}
+
+
+	/**
+	 *        __unset
+	 *
+	 * @param $a
+	 * @return bool
+	 */
+	public function __unset($a)
+	{
+		return false;
+	}
+
+
+	/**
+	 *        __clone
+	 */
+	public function __clone()
+	{
+	}
+
+
+	/**
+	 *        __wakeup
+	 */
+	public function __wakeup()
+	{
+	}
+
+
+	/**
+	 *        __destruct
+	 */
+	public function __destruct()
+	{
+	}
+}
 
-    /**
-     * ReCaptcha public key
-     *
-     * @var string $recaptcha_publickey
-     */
-    public $recaptcha_publickey;
+/**
+ * Class for defining what's in the EE_Config relating to registration settings
+ */
+class EE_Core_Config extends EE_Config_Base
+{
 
-    /**
-     * ReCaptcha private key
-     *
-     * @var string $recaptcha_privatekey
-     */
-    public $recaptcha_privatekey;
+	const OPTION_NAME_UXIP = 'ee_ueip_optin';
+
+
+	public $current_blog_id;
+
+	public $ee_ueip_optin;
+
+	public $ee_ueip_has_notified;
+
+	/**
+	 * Not to be confused with the 4 critical page variables (See
+	 * get_critical_pages_array()), this is just an array of wp posts that have EE
+	 * shortcodes in them. Keys are slugs, values are arrays with only 1 element: where the key is the shortcode
+	 * in the page, and the value is the page's ID. The key 'posts' is basically a duplicate of this same array.
+	 *
+	 * @var array
+	 */
+	public $post_shortcodes;
+
+	public $module_route_map;
+
+	public $module_forward_map;
+
+	public $module_view_map;
+
+	/**
+	 * The next 4 vars are the IDs of critical EE pages.
+	 *
+	 * @var int
+	 */
+	public $reg_page_id;
+
+	public $txn_page_id;
+
+	public $thank_you_page_id;
+
+	public $cancel_page_id;
+
+	/**
+	 * The next 4 vars are the URLs of critical EE pages.
+	 *
+	 * @var int
+	 */
+	public $reg_page_url;
+
+	public $txn_page_url;
+
+	public $thank_you_page_url;
+
+	public $cancel_page_url;
+
+	/**
+	 * The next vars relate to the custom slugs for EE CPT routes
+	 */
+	public $event_cpt_slug;
+
+	/**
+	 * This caches the _ee_ueip_option in case this config is reset in the same
+	 * request across blog switches in a multisite context.
+	 * Avoids extra queries to the db for this option.
+	 *
+	 * @var bool
+	 */
+	public static $ee_ueip_option;
+
+
+	/**
+	 *    class constructor
+	 *
+	 * @access    public
+	 */
+	public function __construct()
+	{
+		// set default organization settings
+		$this->current_blog_id = get_current_blog_id();
+		$this->current_blog_id = $this->current_blog_id === null ? 1 : $this->current_blog_id;
+		$this->ee_ueip_optin = $this->_get_main_ee_ueip_optin();
+		$this->ee_ueip_has_notified = is_main_site() ? get_option('ee_ueip_has_notified', false) : true;
+		$this->post_shortcodes = array();
+		$this->module_route_map = array();
+		$this->module_forward_map = array();
+		$this->module_view_map = array();
+		// critical EE page IDs
+		$this->reg_page_id = 0;
+		$this->txn_page_id = 0;
+		$this->thank_you_page_id = 0;
+		$this->cancel_page_id = 0;
+		// critical EE page URLs
+		$this->reg_page_url = '';
+		$this->txn_page_url = '';
+		$this->thank_you_page_url = '';
+		$this->cancel_page_url = '';
+		// cpt slugs
+		$this->event_cpt_slug = __('events', 'event_espresso');
+		// ueip constant check
+		if (defined('EE_DISABLE_UXIP') && EE_DISABLE_UXIP) {
+			$this->ee_ueip_optin = false;
+			$this->ee_ueip_has_notified = true;
+		}
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function get_critical_pages_array()
+	{
+		return array(
+			$this->reg_page_id,
+			$this->txn_page_id,
+			$this->thank_you_page_id,
+			$this->cancel_page_id,
+		);
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function get_critical_pages_shortcodes_array()
+	{
+		return array(
+			$this->reg_page_id       => 'ESPRESSO_CHECKOUT',
+			$this->txn_page_id       => 'ESPRESSO_TXN_PAGE',
+			$this->thank_you_page_id => 'ESPRESSO_THANK_YOU',
+			$this->cancel_page_id    => 'ESPRESSO_CANCELLED',
+		);
+	}
+
+
+	/**
+	 *  gets/returns URL for EE reg_page
+	 *
+	 * @access    public
+	 * @return    string
+	 */
+	public function reg_page_url()
+	{
+		if (! $this->reg_page_url) {
+			$this->reg_page_url = add_query_arg(
+				array('uts' => time()),
+				get_permalink($this->reg_page_id)
+			) . '#checkout';
+		}
+		return $this->reg_page_url;
+	}
+
+
+	/**
+	 *  gets/returns URL for EE txn_page
+	 *
+	 * @param array $query_args like what gets passed to
+	 *                          add_query_arg() as the first argument
+	 * @access    public
+	 * @return    string
+	 */
+	public function txn_page_url($query_args = array())
+	{
+		if (! $this->txn_page_url) {
+			$this->txn_page_url = get_permalink($this->txn_page_id);
+		}
+		if ($query_args) {
+			return add_query_arg($query_args, $this->txn_page_url);
+		} else {
+			return $this->txn_page_url;
+		}
+	}
+
+
+	/**
+	 *  gets/returns URL for EE thank_you_page
+	 *
+	 * @param array $query_args like what gets passed to
+	 *                          add_query_arg() as the first argument
+	 * @access    public
+	 * @return    string
+	 */
+	public function thank_you_page_url($query_args = array())
+	{
+		if (! $this->thank_you_page_url) {
+			$this->thank_you_page_url = get_permalink($this->thank_you_page_id);
+		}
+		if ($query_args) {
+			return add_query_arg($query_args, $this->thank_you_page_url);
+		} else {
+			return $this->thank_you_page_url;
+		}
+	}
+
+
+	/**
+	 *  gets/returns URL for EE cancel_page
+	 *
+	 * @access    public
+	 * @return    string
+	 */
+	public function cancel_page_url()
+	{
+		if (! $this->cancel_page_url) {
+			$this->cancel_page_url = get_permalink($this->cancel_page_id);
+		}
+		return $this->cancel_page_url;
+	}
+
+
+	/**
+	 * Resets all critical page urls to their original state.  Used primarily by the __sleep() magic method currently.
+	 *
+	 * @since 4.7.5
+	 */
+	protected function _reset_urls()
+	{
+		$this->reg_page_url = '';
+		$this->txn_page_url = '';
+		$this->cancel_page_url = '';
+		$this->thank_you_page_url = '';
+	}
+
+
+	/**
+	 * Used to return what the optin value is set for the EE User Experience Program.
+	 * This accounts for multisite and this value being requested for a subsite.  In multisite, the value is set
+	 * on the main site only.
+	 *
+	 * @return bool
+	 */
+	protected function _get_main_ee_ueip_optin()
+	{
+		// if this is the main site then we can just bypass our direct query.
+		if (is_main_site()) {
+			return get_option(self::OPTION_NAME_UXIP, false);
+		}
+		// is this already cached for this request?  If so use it.
+		if (EE_Core_Config::$ee_ueip_option !== null) {
+			return EE_Core_Config::$ee_ueip_option;
+		}
+		global $wpdb;
+		$current_network_main_site = is_multisite() ? get_current_site() : null;
+		$current_main_site_id = ! empty($current_network_main_site) ? $current_network_main_site->blog_id : 1;
+		$option = self::OPTION_NAME_UXIP;
+		// set correct table for query
+		$table_name = $wpdb->get_blog_prefix($current_main_site_id) . 'options';
+		// rather than getting blog option for the $current_main_site_id, we do a direct $wpdb query because
+		// get_blog_option() does a switch_to_blog an that could cause infinite recursion because EE_Core_Config might be
+		// re-constructed on the blog switch.  Note, we are still executing any core wp filters on this option retrieval.
+		// this bit of code is basically a direct copy of get_option without any caching because we are NOT switched to the blog
+		// for the purpose of caching.
+		$pre = apply_filters('pre_option_' . $option, false, $option);
+		if (false !== $pre) {
+			EE_Core_Config::$ee_ueip_option = $pre;
+			return EE_Core_Config::$ee_ueip_option;
+		}
+		$row = $wpdb->get_row(
+			$wpdb->prepare(
+				"SELECT option_value FROM $table_name WHERE option_name = %s LIMIT 1",
+				$option
+			)
+		);
+		if (is_object($row)) {
+			$value = $row->option_value;
+		} else { // option does not exist so use default.
+			EE_Core_Config::$ee_ueip_option =  apply_filters('default_option_' . $option, false, $option);
+			return EE_Core_Config::$ee_ueip_option;
+		}
+		EE_Core_Config::$ee_ueip_option = apply_filters('option_' . $option, maybe_unserialize($value), $option);
+		return EE_Core_Config::$ee_ueip_option;
+	}
+
+
+	/**
+	 * Utility function for escaping the value of a property and returning.
+	 *
+	 * @param string $property property name (checks to see if exists).
+	 * @return mixed if a detected type found return the escaped value, otherwise just the raw value is returned.
+	 * @throws \EE_Error
+	 */
+	public function get_pretty($property)
+	{
+		if ($property === self::OPTION_NAME_UXIP) {
+			return $this->ee_ueip_optin ? 'yes' : 'no';
+		}
+		return parent::get_pretty($property);
+	}
+
+
+	/**
+	 * Currently used to ensure critical page urls have initial values saved to the db instead of any current set values
+	 * on the object.
+	 *
+	 * @return array
+	 */
+	public function __sleep()
+	{
+		// reset all url properties
+		$this->_reset_urls();
+		// return what to save to db
+		return array_keys(get_object_vars($this));
+	}
+}
 
-    /**
-     * array of form names protected by ReCaptcha
-     *
-     * @var array $recaptcha_protected_forms
-     */
-    public $recaptcha_protected_forms;
+/**
+ * Config class for storing info on the Organization
+ */
+class EE_Organization_Config extends EE_Config_Base
+{
 
-    /**
-     * ReCaptcha width
-     *
-     * @var int $recaptcha_width
-     * @deprecated
-     */
-    public $recaptcha_width;
+	/**
+	 * @var string $name
+	 * eg EE4.1
+	 */
+	public $name;
+
+	/**
+	 * @var string $address_1
+	 * eg 123 Onna Road
+	 */
+	public $address_1 = '';
+
+	/**
+	 * @var string $address_2
+	 * eg PO Box 123
+	 */
+	public $address_2 = '';
+
+	/**
+	 * @var string $city
+	 * eg Inna City
+	 */
+	public $city = '';
+
+	/**
+	 * @var int $STA_ID
+	 * eg 4
+	 */
+	public $STA_ID = 0;
+
+	/**
+	 * @var string $CNT_ISO
+	 * eg US
+	 */
+	public $CNT_ISO = '';
+
+	/**
+	 * @var string $zip
+	 * eg 12345  or V1A 2B3
+	 */
+	public $zip = '';
+
+	/**
+	 * @var string $email
+	 * eg support@eventespresso.com
+	 */
+	public $email;
+
+	/**
+	 * @var string $phone
+	 * eg. 111-111-1111
+	 */
+	public $phone = '';
+
+	/**
+	 * @var string $vat
+	 * VAT/Tax Number
+	 */
+	public $vat = '';
+
+	/**
+	 * @var string $logo_url
+	 * eg http://www.somedomain.com/wp-content/uploads/kittehs.jpg
+	 */
+	public $logo_url = '';
+
+	/**
+	 * The below are all various properties for holding links to organization social network profiles
+	 *
+	 * @var string
+	 */
+	/**
+	 * facebook (facebook.com/profile.name)
+	 *
+	 * @var string
+	 */
+	public $facebook = '';
+
+	/**
+	 * twitter (twitter.com/twitter_handle)
+	 *
+	 * @var string
+	 */
+	public $twitter = '';
+
+	/**
+	 * linkedin (linkedin.com/in/profile_name)
+	 *
+	 * @var string
+	 */
+	public $linkedin = '';
+
+	/**
+	 * pinterest (www.pinterest.com/profile_name)
+	 *
+	 * @var string
+	 */
+	public $pinterest = '';
+
+	/**
+	 * google+ (google.com/+profileName)
+	 *
+	 * @var string
+	 */
+	public $google = '';
+
+	/**
+	 * instagram (instagram.com/handle)
+	 *
+	 * @var string
+	 */
+	public $instagram = '';
+
+
+	/**
+	 *    class constructor
+	 *
+	 * @access    public
+	 */
+	public function __construct()
+	{
+		// set default organization settings
+		// decode HTML entities from the WP blogname, because it's stored in the DB with HTML entities encoded
+		$this->name = wp_specialchars_decode(get_bloginfo('name'), ENT_QUOTES);
+		$this->email = get_bloginfo('admin_email');
+	}
+}
 
-    /**
-     * Whether or not invalid attempts to directly access the registration checkout page should be tracked.
-     *
-     * @var boolean $track_invalid_checkout_access
-     */
-    protected $track_invalid_checkout_access = true;
+/**
+ * Class for defining what's in the EE_Config relating to currency
+ */
+class EE_Currency_Config extends EE_Config_Base
+{
 
-    /**
-     * Whether or not to show the privacy policy consent checkbox
-     *
-     * @var bool
-     */
-    public $consent_checkbox_enabled;
+	/**
+	 * @var string $code
+	 * eg 'US'
+	 */
+	public $code;
+
+	/**
+	 * @var string $name
+	 * eg 'Dollar'
+	 */
+	public $name;
+
+	/**
+	 * plural name
+	 *
+	 * @var string $plural
+	 * eg 'Dollars'
+	 */
+	public $plural;
+
+	/**
+	 * currency sign
+	 *
+	 * @var string $sign
+	 * eg '$'
+	 */
+	public $sign;
+
+	/**
+	 * Whether the currency sign should come before the number or not
+	 *
+	 * @var boolean $sign_b4
+	 */
+	public $sign_b4;
+
+	/**
+	 * How many digits should come after the decimal place
+	 *
+	 * @var int $dec_plc
+	 */
+	public $dec_plc;
+
+	/**
+	 * Symbol to use for decimal mark
+	 *
+	 * @var string $dec_mrk
+	 * eg '.'
+	 */
+	public $dec_mrk;
+
+	/**
+	 * Symbol to use for thousands
+	 *
+	 * @var string $thsnds
+	 * eg ','
+	 */
+	public $thsnds;
+
+
+	/**
+	 *    class constructor
+	 *
+	 * @access    public
+	 * @param string $CNT_ISO
+	 * @throws \EE_Error
+	 */
+	public function __construct($CNT_ISO = '')
+	{
+		/** @var \EventEspresso\core\services\database\TableAnalysis $table_analysis */
+		$table_analysis = EE_Registry::instance()->create('TableAnalysis', array(), true);
+		// get country code from organization settings or use default
+		$ORG_CNT = isset(EE_Registry::instance()->CFG->organization)
+				   && EE_Registry::instance()->CFG->organization instanceof EE_Organization_Config
+			? EE_Registry::instance()->CFG->organization->CNT_ISO
+			: '';
+		// but override if requested
+		$CNT_ISO = ! empty($CNT_ISO) ? $CNT_ISO : $ORG_CNT;
+		// so if that all went well, and we are not in M-Mode (cuz you can't query the db in M-Mode) and double-check the countries table exists
+		if (! empty($CNT_ISO)
+			&& EE_Maintenance_Mode::instance()->models_can_query()
+			&& $table_analysis->tableExists(EE_Registry::instance()->load_model('Country')->table())
+		) {
+			// retrieve the country settings from the db, just in case they have been customized
+			$country = EE_Registry::instance()->load_model('Country')->get_one_by_ID($CNT_ISO);
+			if ($country instanceof EE_Country) {
+				$this->code = $country->currency_code();    // currency code: USD, CAD, EUR
+				$this->name = $country->currency_name_single();    // Dollar
+				$this->plural = $country->currency_name_plural();    // Dollars
+				$this->sign = $country->currency_sign();            // currency sign: $
+				$this->sign_b4 = $country->currency_sign_before(
+				);        // currency sign before or after: $TRUE  or  FALSE$
+				$this->dec_plc = $country->currency_decimal_places();    // decimal places: 2 = 0.00  3 = 0.000
+				$this->dec_mrk = $country->currency_decimal_mark(
+				);    // decimal mark: (comma) ',' = 0,01   or (decimal) '.' = 0.01
+				$this->thsnds = $country->currency_thousands_separator(
+				);    // thousands separator: (comma) ',' = 1,000   or (decimal) '.' = 1.000
+			}
+		}
+		// fallback to hardcoded defaults, in case the above failed
+		if (empty($this->code)) {
+			// set default currency settings
+			$this->code = 'USD';    // currency code: USD, CAD, EUR
+			$this->name = __('Dollar', 'event_espresso');    // Dollar
+			$this->plural = __('Dollars', 'event_espresso');    // Dollars
+			$this->sign = '$';    // currency sign: $
+			$this->sign_b4 = true;    // currency sign before or after: $TRUE  or  FALSE$
+			$this->dec_plc = 2;    // decimal places: 2 = 0.00  3 = 0.000
+			$this->dec_mrk = '.';    // decimal mark: (comma) ',' = 0,01   or (decimal) '.' = 0.01
+			$this->thsnds = ',';    // thousands separator: (comma) ',' = 1,000   or (decimal) '.' = 1.000
+		}
+	}
+}
 
-    /**
-     * Label text to show on the checkbox
-     *
-     * @var string
-     */
-    public $consent_checkbox_label_text;
+/**
+ * Class for defining what's in the EE_Config relating to registration settings
+ */
+class EE_Registration_Config extends EE_Config_Base
+{
 
-    /*
+	/**
+	 * Default registration status
+	 *
+	 * @var string $default_STS_ID
+	 * eg 'RPP'
+	 */
+	public $default_STS_ID;
+
+	/**
+	 * For new events, this will be the default value for the maximum number of tickets (equivalent to maximum number of
+	 * registrations)
+	 *
+	 * @var int
+	 */
+	public $default_maximum_number_of_tickets;
+
+	/**
+	 * level of validation to apply to email addresses
+	 *
+	 * @var string $email_validation_level
+	 * options: 'basic', 'wp_default', 'i18n', 'i18n_dns'
+	 */
+	public $email_validation_level;
+
+	/**
+	 *    whether or not to show alternate payment options during the reg process if payment status is pending
+	 *
+	 * @var boolean $show_pending_payment_options
+	 */
+	public $show_pending_payment_options;
+
+	/**
+	 * Whether to skip the registration confirmation page
+	 *
+	 * @var boolean $skip_reg_confirmation
+	 */
+	public $skip_reg_confirmation;
+
+	/**
+	 * an array of SPCO reg steps where:
+	 *        the keys denotes the reg step order
+	 *        each element consists of an array with the following elements:
+	 *            "file_path" => the file path to the EE_SPCO_Reg_Step class
+	 *            "class_name" => the specific EE_SPCO_Reg_Step child class name
+	 *            "slug" => the URL param used to trigger the reg step
+	 *
+	 * @var array $reg_steps
+	 */
+	public $reg_steps;
+
+	/**
+	 * Whether registration confirmation should be the last page of SPCO
+	 *
+	 * @var boolean $reg_confirmation_last
+	 */
+	public $reg_confirmation_last;
+
+	/**
+	 * Whether or not to enable the EE Bot Trap
+	 *
+	 * @var boolean $use_bot_trap
+	 */
+	public $use_bot_trap;
+
+	/**
+	 * Whether or not to encrypt some data sent by the EE Bot Trap
+	 *
+	 * @var boolean $use_encryption
+	 */
+	public $use_encryption;
+
+	/**
+	 * Whether or not to use ReCaptcha
+	 *
+	 * @var boolean $use_captcha
+	 */
+	public $use_captcha;
+
+	/**
+	 * ReCaptcha Theme
+	 *
+	 * @var string $recaptcha_theme
+	 *    options: 'dark', 'light', 'invisible'
+	 */
+	public $recaptcha_theme;
+
+	/**
+	 * ReCaptcha Badge - determines the position of the reCAPTCHA badge if using Invisible ReCaptcha.
+	 *
+	 * @var string $recaptcha_badge
+	 *    options: 'bottomright', 'bottomleft', 'inline'
+	 */
+	public $recaptcha_badge;
+
+	/**
+	 * ReCaptcha Type
+	 *
+	 * @var string $recaptcha_type
+	 *    options: 'audio', 'image'
+	 */
+	public $recaptcha_type;
+
+	/**
+	 * ReCaptcha language
+	 *
+	 * @var string $recaptcha_language
+	 * eg 'en'
+	 */
+	public $recaptcha_language;
+
+	/**
+	 * ReCaptcha public key
+	 *
+	 * @var string $recaptcha_publickey
+	 */
+	public $recaptcha_publickey;
+
+	/**
+	 * ReCaptcha private key
+	 *
+	 * @var string $recaptcha_privatekey
+	 */
+	public $recaptcha_privatekey;
+
+	/**
+	 * array of form names protected by ReCaptcha
+	 *
+	 * @var array $recaptcha_protected_forms
+	 */
+	public $recaptcha_protected_forms;
+
+	/**
+	 * ReCaptcha width
+	 *
+	 * @var int $recaptcha_width
+	 * @deprecated
+	 */
+	public $recaptcha_width;
+
+	/**
+	 * Whether or not invalid attempts to directly access the registration checkout page should be tracked.
+	 *
+	 * @var boolean $track_invalid_checkout_access
+	 */
+	protected $track_invalid_checkout_access = true;
+
+	/**
+	 * Whether or not to show the privacy policy consent checkbox
+	 *
+	 * @var bool
+	 */
+	public $consent_checkbox_enabled;
+
+	/**
+	 * Label text to show on the checkbox
+	 *
+	 * @var string
+	 */
+	public $consent_checkbox_label_text;
+
+	/*
      * String describing how long to keep payment logs. Passed into DateTime constructor
      * @var string
      */
-    public $gateway_log_lifespan = '1 week';
-
-
-    /**
-     *    class constructor
-     *
-     * @access    public
-     */
-    public function __construct()
-    {
-        // set default registration settings
-        $this->default_STS_ID = EEM_Registration::status_id_pending_payment;
-        $this->email_validation_level = 'wp_default';
-        $this->show_pending_payment_options = true;
-        $this->skip_reg_confirmation = true;
-        $this->reg_steps = array();
-        $this->reg_confirmation_last = false;
-        $this->use_bot_trap = true;
-        $this->use_encryption = true;
-        $this->use_captcha = false;
-        $this->recaptcha_theme = 'light';
-        $this->recaptcha_badge = 'bottomleft';
-        $this->recaptcha_type = 'image';
-        $this->recaptcha_language = 'en';
-        $this->recaptcha_publickey = null;
-        $this->recaptcha_privatekey = null;
-        $this->recaptcha_protected_forms = array();
-        $this->recaptcha_width = 500;
-        $this->default_maximum_number_of_tickets = 10;
-        $this->consent_checkbox_enabled = false;
-        $this->consent_checkbox_label_text = '';
-        $this->gateway_log_lifespan = '7 days';
-    }
-
-
-    /**
-     * This is called by the config loader and hooks are initialized AFTER the config has been populated.
-     *
-     * @since 4.8.8.rc.019
-     */
-    public function do_hooks()
-    {
-        add_action('AHEE__EE_Config___load_core_config__end', array($this, 'set_default_reg_status_on_EEM_Event'));
-        add_action('AHEE__EE_Config___load_core_config__end', array($this, 'set_default_max_ticket_on_EEM_Event'));
-        add_action('setup_theme', array($this, 'setDefaultCheckboxLabelText'));
-    }
-
-
-    /**
-     * Hooked into `AHEE__EE_Config___load_core_config__end` to ensure the default for the
-     * EVT_default_registration_status field matches the config setting for default_STS_ID.
-     */
-    public function set_default_reg_status_on_EEM_Event()
-    {
-        EEM_Event::set_default_reg_status($this->default_STS_ID);
-    }
-
-
-    /**
-     * Hooked into `AHEE__EE_Config___load_core_config__end` to ensure the default for the EVT_additional_limit field
-     * for Events matches the config setting for default_maximum_number_of_tickets
-     */
-    public function set_default_max_ticket_on_EEM_Event()
-    {
-        EEM_Event::set_default_additional_limit($this->default_maximum_number_of_tickets);
-    }
-
-
-    /**
-     * Sets the default consent checkbox text. This needs to be done a bit later than when EE_Registration_Config is
-     * constructed because that happens before we can get the privacy policy page's permalink.
-     *
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    public function setDefaultCheckboxLabelText()
-    {
-        if ($this->getConsentCheckboxLabelText() === null
-            || $this->getConsentCheckboxLabelText() === '') {
-            $opening_a_tag = '';
-            $closing_a_tag = '';
-            if (function_exists('get_privacy_policy_url')) {
-                $privacy_page_url = get_privacy_policy_url();
-                if (! empty($privacy_page_url)) {
-                    $opening_a_tag = '<a href="' . $privacy_page_url . '" target="_blank">';
-                    $closing_a_tag = '</a>';
-                }
-            }
-            $loader = LoaderFactory::getLoader();
-            $org_config = $loader->getShared('EE_Organization_Config');
-            /**
-             * @var $org_config EE_Organization_Config
-             */
-
-            $this->setConsentCheckboxLabelText(
-                sprintf(
-                    esc_html__(
-                        'I consent to %1$s storing and using my personal information, according to their %2$sprivacy policy%3$s.',
-                        'event_espresso'
-                    ),
-                    $org_config->name,
-                    $opening_a_tag,
-                    $closing_a_tag
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @return boolean
-     */
-    public function track_invalid_checkout_access()
-    {
-        return $this->track_invalid_checkout_access;
-    }
-
-
-    /**
-     * @param boolean $track_invalid_checkout_access
-     */
-    public function set_track_invalid_checkout_access($track_invalid_checkout_access)
-    {
-        $this->track_invalid_checkout_access = filter_var(
-            $track_invalid_checkout_access,
-            FILTER_VALIDATE_BOOLEAN
-        );
-    }
-
-
-    /**
-     * Gets the options to make availalbe for the gateway log lifespan
-     * @return array
-     */
-    public function gatewayLogLifespanOptions()
-    {
-        return (array) apply_filters(
-            'FHEE_EE_Admin_Config__gatewayLogLifespanOptions',
-            array(
-                '1 second' => esc_html__('Don\'t Log At All', 'event_espresso'),
-                '1 day' => esc_html__('1 Day', 'event_espresso'),
-                '7 days' => esc_html__('7 Days', 'event_espresso'),
-                '14 days' => esc_html__('14 Days', 'event_espresso'),
-                '30 days' => esc_html__('30 Days', 'event_espresso')
-            )
-        );
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isConsentCheckboxEnabled()
-    {
-        return $this->consent_checkbox_enabled;
-    }
-
-
-    /**
-     * @param bool $consent_checkbox_enabled
-     */
-    public function setConsentCheckboxEnabled($consent_checkbox_enabled)
-    {
-        $this->consent_checkbox_enabled = filter_var(
-            $consent_checkbox_enabled,
-            FILTER_VALIDATE_BOOLEAN
-        );
-    }
-
-
-    /**
-     * @return string
-     */
-    public function getConsentCheckboxLabelText()
-    {
-        return $this->consent_checkbox_label_text;
-    }
-
-
-    /**
-     * @param string $consent_checkbox_label_text
-     */
-    public function setConsentCheckboxLabelText($consent_checkbox_label_text)
-    {
-        $this->consent_checkbox_label_text = (string) $consent_checkbox_label_text;
-    }
+	public $gateway_log_lifespan = '1 week';
+
+
+	/**
+	 *    class constructor
+	 *
+	 * @access    public
+	 */
+	public function __construct()
+	{
+		// set default registration settings
+		$this->default_STS_ID = EEM_Registration::status_id_pending_payment;
+		$this->email_validation_level = 'wp_default';
+		$this->show_pending_payment_options = true;
+		$this->skip_reg_confirmation = true;
+		$this->reg_steps = array();
+		$this->reg_confirmation_last = false;
+		$this->use_bot_trap = true;
+		$this->use_encryption = true;
+		$this->use_captcha = false;
+		$this->recaptcha_theme = 'light';
+		$this->recaptcha_badge = 'bottomleft';
+		$this->recaptcha_type = 'image';
+		$this->recaptcha_language = 'en';
+		$this->recaptcha_publickey = null;
+		$this->recaptcha_privatekey = null;
+		$this->recaptcha_protected_forms = array();
+		$this->recaptcha_width = 500;
+		$this->default_maximum_number_of_tickets = 10;
+		$this->consent_checkbox_enabled = false;
+		$this->consent_checkbox_label_text = '';
+		$this->gateway_log_lifespan = '7 days';
+	}
+
+
+	/**
+	 * This is called by the config loader and hooks are initialized AFTER the config has been populated.
+	 *
+	 * @since 4.8.8.rc.019
+	 */
+	public function do_hooks()
+	{
+		add_action('AHEE__EE_Config___load_core_config__end', array($this, 'set_default_reg_status_on_EEM_Event'));
+		add_action('AHEE__EE_Config___load_core_config__end', array($this, 'set_default_max_ticket_on_EEM_Event'));
+		add_action('setup_theme', array($this, 'setDefaultCheckboxLabelText'));
+	}
+
+
+	/**
+	 * Hooked into `AHEE__EE_Config___load_core_config__end` to ensure the default for the
+	 * EVT_default_registration_status field matches the config setting for default_STS_ID.
+	 */
+	public function set_default_reg_status_on_EEM_Event()
+	{
+		EEM_Event::set_default_reg_status($this->default_STS_ID);
+	}
+
+
+	/**
+	 * Hooked into `AHEE__EE_Config___load_core_config__end` to ensure the default for the EVT_additional_limit field
+	 * for Events matches the config setting for default_maximum_number_of_tickets
+	 */
+	public function set_default_max_ticket_on_EEM_Event()
+	{
+		EEM_Event::set_default_additional_limit($this->default_maximum_number_of_tickets);
+	}
+
+
+	/**
+	 * Sets the default consent checkbox text. This needs to be done a bit later than when EE_Registration_Config is
+	 * constructed because that happens before we can get the privacy policy page's permalink.
+	 *
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	public function setDefaultCheckboxLabelText()
+	{
+		if ($this->getConsentCheckboxLabelText() === null
+			|| $this->getConsentCheckboxLabelText() === '') {
+			$opening_a_tag = '';
+			$closing_a_tag = '';
+			if (function_exists('get_privacy_policy_url')) {
+				$privacy_page_url = get_privacy_policy_url();
+				if (! empty($privacy_page_url)) {
+					$opening_a_tag = '<a href="' . $privacy_page_url . '" target="_blank">';
+					$closing_a_tag = '</a>';
+				}
+			}
+			$loader = LoaderFactory::getLoader();
+			$org_config = $loader->getShared('EE_Organization_Config');
+			/**
+			 * @var $org_config EE_Organization_Config
+			 */
+
+			$this->setConsentCheckboxLabelText(
+				sprintf(
+					esc_html__(
+						'I consent to %1$s storing and using my personal information, according to their %2$sprivacy policy%3$s.',
+						'event_espresso'
+					),
+					$org_config->name,
+					$opening_a_tag,
+					$closing_a_tag
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	public function track_invalid_checkout_access()
+	{
+		return $this->track_invalid_checkout_access;
+	}
+
+
+	/**
+	 * @param boolean $track_invalid_checkout_access
+	 */
+	public function set_track_invalid_checkout_access($track_invalid_checkout_access)
+	{
+		$this->track_invalid_checkout_access = filter_var(
+			$track_invalid_checkout_access,
+			FILTER_VALIDATE_BOOLEAN
+		);
+	}
+
+
+	/**
+	 * Gets the options to make availalbe for the gateway log lifespan
+	 * @return array
+	 */
+	public function gatewayLogLifespanOptions()
+	{
+		return (array) apply_filters(
+			'FHEE_EE_Admin_Config__gatewayLogLifespanOptions',
+			array(
+				'1 second' => esc_html__('Don\'t Log At All', 'event_espresso'),
+				'1 day' => esc_html__('1 Day', 'event_espresso'),
+				'7 days' => esc_html__('7 Days', 'event_espresso'),
+				'14 days' => esc_html__('14 Days', 'event_espresso'),
+				'30 days' => esc_html__('30 Days', 'event_espresso')
+			)
+		);
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isConsentCheckboxEnabled()
+	{
+		return $this->consent_checkbox_enabled;
+	}
+
+
+	/**
+	 * @param bool $consent_checkbox_enabled
+	 */
+	public function setConsentCheckboxEnabled($consent_checkbox_enabled)
+	{
+		$this->consent_checkbox_enabled = filter_var(
+			$consent_checkbox_enabled,
+			FILTER_VALIDATE_BOOLEAN
+		);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function getConsentCheckboxLabelText()
+	{
+		return $this->consent_checkbox_label_text;
+	}
+
+
+	/**
+	 * @param string $consent_checkbox_label_text
+	 */
+	public function setConsentCheckboxLabelText($consent_checkbox_label_text)
+	{
+		$this->consent_checkbox_label_text = (string) $consent_checkbox_label_text;
+	}
 }
 
 /**
@@ -2525,157 +2525,157 @@ 
 class EE_Admin_Config extends EE_Config_Base
 {
 
-    /**
-     * @var boolean $use_personnel_manager
-     */
-    public $use_personnel_manager;
-
-    /**
-     * @var boolean $use_dashboard_widget
-     */
-    public $use_dashboard_widget;
-
-    /**
-     * @var int $events_in_dashboard
-     */
-    public $events_in_dashboard;
-
-    /**
-     * @var boolean $use_event_timezones
-     */
-    public $use_event_timezones;
-
-    /**
-     * @var boolean $use_full_logging
-     */
-    public $use_full_logging;
-
-    /**
-     * @var string $log_file_name
-     */
-    public $log_file_name;
-
-    /**
-     * @var string $debug_file_name
-     */
-    public $debug_file_name;
-
-    /**
-     * @var boolean $use_remote_logging
-     */
-    public $use_remote_logging;
-
-    /**
-     * @var string $remote_logging_url
-     */
-    public $remote_logging_url;
-
-    /**
-     * @var boolean $show_reg_footer
-     */
-    public $show_reg_footer;
-
-    /**
-     * @var string $affiliate_id
-     */
-    public $affiliate_id;
-
-    /**
-     * help tours on or off (global setting)
-     *
-     * @var boolean
-     */
-    public $help_tour_activation;
-
-    /**
-     * adds extra layer of encoding to session data to prevent serialization errors
-     * but is incompatible with some server configuration errors
-     * if you get "500 internal server errors" during registration, try turning this on
-     * if you get PHP fatal errors regarding base 64 methods not defined, then turn this off
-     *
-     * @var boolean $encode_session_data
-     */
-    private $encode_session_data = false;
-
-
-    /**
-     *    class constructor
-     *
-     * @access    public
-     */
-    public function __construct()
-    {
-        // set default general admin settings
-        $this->use_personnel_manager = true;
-        $this->use_dashboard_widget = true;
-        $this->events_in_dashboard = 30;
-        $this->use_event_timezones = false;
-        $this->use_full_logging = false;
-        $this->use_remote_logging = false;
-        $this->remote_logging_url = null;
-        $this->show_reg_footer = apply_filters(
-            'FHEE__EE_Admin_Config__show_reg_footer__default',
-            false
-        );
-        $this->affiliate_id = 'default';
-        $this->help_tour_activation = true;
-        $this->encode_session_data = false;
-    }
-
-
-    /**
-     * @param bool $reset
-     * @return string
-     */
-    public function log_file_name($reset = false)
-    {
-        if (empty($this->log_file_name) || $reset) {
-            $this->log_file_name = sanitize_key('espresso_log_' . md5(uniqid('', true))) . '.txt';
-            EE_Config::instance()->update_espresso_config(false, false);
-        }
-        return $this->log_file_name;
-    }
-
-
-    /**
-     * @param bool $reset
-     * @return string
-     */
-    public function debug_file_name($reset = false)
-    {
-        if (empty($this->debug_file_name) || $reset) {
-            $this->debug_file_name = sanitize_key('espresso_debug_' . md5(uniqid('', true))) . '.txt';
-            EE_Config::instance()->update_espresso_config(false, false);
-        }
-        return $this->debug_file_name;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function affiliate_id()
-    {
-        return ! empty($this->affiliate_id) ? $this->affiliate_id : 'default';
-    }
-
-
-    /**
-     * @return boolean
-     */
-    public function encode_session_data()
-    {
-        return filter_var($this->encode_session_data, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * @param boolean $encode_session_data
-     */
-    public function set_encode_session_data($encode_session_data)
-    {
-        $this->encode_session_data = filter_var($encode_session_data, FILTER_VALIDATE_BOOLEAN);
-    }
+	/**
+	 * @var boolean $use_personnel_manager
+	 */
+	public $use_personnel_manager;
+
+	/**
+	 * @var boolean $use_dashboard_widget
+	 */
+	public $use_dashboard_widget;
+
+	/**
+	 * @var int $events_in_dashboard
+	 */
+	public $events_in_dashboard;
+
+	/**
+	 * @var boolean $use_event_timezones
+	 */
+	public $use_event_timezones;
+
+	/**
+	 * @var boolean $use_full_logging
+	 */
+	public $use_full_logging;
+
+	/**
+	 * @var string $log_file_name
+	 */
+	public $log_file_name;
+
+	/**
+	 * @var string $debug_file_name
+	 */
+	public $debug_file_name;
+
+	/**
+	 * @var boolean $use_remote_logging
+	 */
+	public $use_remote_logging;
+
+	/**
+	 * @var string $remote_logging_url
+	 */
+	public $remote_logging_url;
+
+	/**
+	 * @var boolean $show_reg_footer
+	 */
+	public $show_reg_footer;
+
+	/**
+	 * @var string $affiliate_id
+	 */
+	public $affiliate_id;
+
+	/**
+	 * help tours on or off (global setting)
+	 *
+	 * @var boolean
+	 */
+	public $help_tour_activation;
+
+	/**
+	 * adds extra layer of encoding to session data to prevent serialization errors
+	 * but is incompatible with some server configuration errors
+	 * if you get "500 internal server errors" during registration, try turning this on
+	 * if you get PHP fatal errors regarding base 64 methods not defined, then turn this off
+	 *
+	 * @var boolean $encode_session_data
+	 */
+	private $encode_session_data = false;
+
+
+	/**
+	 *    class constructor
+	 *
+	 * @access    public
+	 */
+	public function __construct()
+	{
+		// set default general admin settings
+		$this->use_personnel_manager = true;
+		$this->use_dashboard_widget = true;
+		$this->events_in_dashboard = 30;
+		$this->use_event_timezones = false;
+		$this->use_full_logging = false;
+		$this->use_remote_logging = false;
+		$this->remote_logging_url = null;
+		$this->show_reg_footer = apply_filters(
+			'FHEE__EE_Admin_Config__show_reg_footer__default',
+			false
+		);
+		$this->affiliate_id = 'default';
+		$this->help_tour_activation = true;
+		$this->encode_session_data = false;
+	}
+
+
+	/**
+	 * @param bool $reset
+	 * @return string
+	 */
+	public function log_file_name($reset = false)
+	{
+		if (empty($this->log_file_name) || $reset) {
+			$this->log_file_name = sanitize_key('espresso_log_' . md5(uniqid('', true))) . '.txt';
+			EE_Config::instance()->update_espresso_config(false, false);
+		}
+		return $this->log_file_name;
+	}
+
+
+	/**
+	 * @param bool $reset
+	 * @return string
+	 */
+	public function debug_file_name($reset = false)
+	{
+		if (empty($this->debug_file_name) || $reset) {
+			$this->debug_file_name = sanitize_key('espresso_debug_' . md5(uniqid('', true))) . '.txt';
+			EE_Config::instance()->update_espresso_config(false, false);
+		}
+		return $this->debug_file_name;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function affiliate_id()
+	{
+		return ! empty($this->affiliate_id) ? $this->affiliate_id : 'default';
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	public function encode_session_data()
+	{
+		return filter_var($this->encode_session_data, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * @param boolean $encode_session_data
+	 */
+	public function set_encode_session_data($encode_session_data)
+	{
+		$this->encode_session_data = filter_var($encode_session_data, FILTER_VALIDATE_BOOLEAN);
+	}
 }
 
 /**
@@ -2684,70 +2684,70 @@ 
 class EE_Template_Config extends EE_Config_Base
 {
 
-    /**
-     * @var boolean $enable_default_style
-     */
-    public $enable_default_style;
-
-    /**
-     * @var string $custom_style_sheet
-     */
-    public $custom_style_sheet;
-
-    /**
-     * @var boolean $display_address_in_regform
-     */
-    public $display_address_in_regform;
-
-    /**
-     * @var int $display_description_on_multi_reg_page
-     */
-    public $display_description_on_multi_reg_page;
-
-    /**
-     * @var boolean $use_custom_templates
-     */
-    public $use_custom_templates;
-
-    /**
-     * @var string $current_espresso_theme
-     */
-    public $current_espresso_theme;
-
-    /**
-     * @var EE_Ticket_Selector_Config $EED_Ticket_Selector
-     */
-    public $EED_Ticket_Selector;
-
-    /**
-     * @var EE_Event_Single_Config $EED_Event_Single
-     */
-    public $EED_Event_Single;
-
-    /**
-     * @var EE_Events_Archive_Config $EED_Events_Archive
-     */
-    public $EED_Events_Archive;
-
-
-    /**
-     *    class constructor
-     *
-     * @access    public
-     */
-    public function __construct()
-    {
-        // set default template settings
-        $this->enable_default_style = true;
-        $this->custom_style_sheet = null;
-        $this->display_address_in_regform = true;
-        $this->display_description_on_multi_reg_page = false;
-        $this->use_custom_templates = false;
-        $this->current_espresso_theme = 'Espresso_Arabica_2014';
-        $this->EED_Event_Single = null;
-        $this->EED_Events_Archive = null;
-        $this->EED_Ticket_Selector = null;
-    }
+	/**
+	 * @var boolean $enable_default_style
+	 */
+	public $enable_default_style;
+
+	/**
+	 * @var string $custom_style_sheet
+	 */
+	public $custom_style_sheet;
+
+	/**
+	 * @var boolean $display_address_in_regform
+	 */
+	public $display_address_in_regform;
+
+	/**
+	 * @var int $display_description_on_multi_reg_page
+	 */
+	public $display_description_on_multi_reg_page;
+
+	/**
+	 * @var boolean $use_custom_templates
+	 */
+	public $use_custom_templates;
+
+	/**
+	 * @var string $current_espresso_theme
+	 */
+	public $current_espresso_theme;
+
+	/**
+	 * @var EE_Ticket_Selector_Config $EED_Ticket_Selector
+	 */
+	public $EED_Ticket_Selector;
+
+	/**
+	 * @var EE_Event_Single_Config $EED_Event_Single
+	 */
+	public $EED_Event_Single;
+
+	/**
+	 * @var EE_Events_Archive_Config $EED_Events_Archive
+	 */
+	public $EED_Events_Archive;
+
+
+	/**
+	 *    class constructor
+	 *
+	 * @access    public
+	 */
+	public function __construct()
+	{
+		// set default template settings
+		$this->enable_default_style = true;
+		$this->custom_style_sheet = null;
+		$this->display_address_in_regform = true;
+		$this->display_description_on_multi_reg_page = false;
+		$this->use_custom_templates = false;
+		$this->current_espresso_theme = 'Espresso_Arabica_2014';
+		$this->EED_Event_Single = null;
+		$this->EED_Events_Archive = null;
+		$this->EED_Ticket_Selector = null;
+	}
 }
 
 /**
@@ -2756,114 +2756,114 @@ 
 class EE_Map_Config extends EE_Config_Base
 {
 
-    /**
-     * @var boolean $use_google_maps
-     */
-    public $use_google_maps;
-
-    /**
-     * @var string $api_key
-     */
-    public $google_map_api_key;
-
-    /**
-     * @var int $event_details_map_width
-     */
-    public $event_details_map_width;
-
-    /**
-     * @var int $event_details_map_height
-     */
-    public $event_details_map_height;
-
-    /**
-     * @var int $event_details_map_zoom
-     */
-    public $event_details_map_zoom;
-
-    /**
-     * @var boolean $event_details_display_nav
-     */
-    public $event_details_display_nav;
-
-    /**
-     * @var boolean $event_details_nav_size
-     */
-    public $event_details_nav_size;
-
-    /**
-     * @var string $event_details_control_type
-     */
-    public $event_details_control_type;
-
-    /**
-     * @var string $event_details_map_align
-     */
-    public $event_details_map_align;
-
-    /**
-     * @var int $event_list_map_width
-     */
-    public $event_list_map_width;
-
-    /**
-     * @var int $event_list_map_height
-     */
-    public $event_list_map_height;
-
-    /**
-     * @var int $event_list_map_zoom
-     */
-    public $event_list_map_zoom;
-
-    /**
-     * @var boolean $event_list_display_nav
-     */
-    public $event_list_display_nav;
-
-    /**
-     * @var boolean $event_list_nav_size
-     */
-    public $event_list_nav_size;
-
-    /**
-     * @var string $event_list_control_type
-     */
-    public $event_list_control_type;
-
-    /**
-     * @var string $event_list_map_align
-     */
-    public $event_list_map_align;
-
-
-    /**
-     *    class constructor
-     *
-     * @access    public
-     */
-    public function __construct()
-    {
-        // set default map settings
-        $this->use_google_maps = true;
-        $this->google_map_api_key = '';
-        // for event details pages (reg page)
-        $this->event_details_map_width = 585;            // ee_map_width_single
-        $this->event_details_map_height = 362;            // ee_map_height_single
-        $this->event_details_map_zoom = 14;            // ee_map_zoom_single
-        $this->event_details_display_nav = true;            // ee_map_nav_display_single
-        $this->event_details_nav_size = false;            // ee_map_nav_size_single
-        $this->event_details_control_type = 'default';        // ee_map_type_control_single
-        $this->event_details_map_align = 'center';            // ee_map_align_single
-        // for event list pages
-        $this->event_list_map_width = 300;            // ee_map_width
-        $this->event_list_map_height = 185;        // ee_map_height
-        $this->event_list_map_zoom = 12;            // ee_map_zoom
-        $this->event_list_display_nav = false;        // ee_map_nav_display
-        $this->event_list_nav_size = true;            // ee_map_nav_size
-        $this->event_list_control_type = 'dropdown';        // ee_map_type_control
-        $this->event_list_map_align = 'center';            // ee_map_align
-    }
+	/**
+	 * @var boolean $use_google_maps
+	 */
+	public $use_google_maps;
+
+	/**
+	 * @var string $api_key
+	 */
+	public $google_map_api_key;
+
+	/**
+	 * @var int $event_details_map_width
+	 */
+	public $event_details_map_width;
+
+	/**
+	 * @var int $event_details_map_height
+	 */
+	public $event_details_map_height;
+
+	/**
+	 * @var int $event_details_map_zoom
+	 */
+	public $event_details_map_zoom;
+
+	/**
+	 * @var boolean $event_details_display_nav
+	 */
+	public $event_details_display_nav;
+
+	/**
+	 * @var boolean $event_details_nav_size
+	 */
+	public $event_details_nav_size;
+
+	/**
+	 * @var string $event_details_control_type
+	 */
+	public $event_details_control_type;
+
+	/**
+	 * @var string $event_details_map_align
+	 */
+	public $event_details_map_align;
+
+	/**
+	 * @var int $event_list_map_width
+	 */
+	public $event_list_map_width;
+
+	/**
+	 * @var int $event_list_map_height
+	 */
+	public $event_list_map_height;
+
+	/**
+	 * @var int $event_list_map_zoom
+	 */
+	public $event_list_map_zoom;
+
+	/**
+	 * @var boolean $event_list_display_nav
+	 */
+	public $event_list_display_nav;
+
+	/**
+	 * @var boolean $event_list_nav_size
+	 */
+	public $event_list_nav_size;
+
+	/**
+	 * @var string $event_list_control_type
+	 */
+	public $event_list_control_type;
+
+	/**
+	 * @var string $event_list_map_align
+	 */
+	public $event_list_map_align;
+
+
+	/**
+	 *    class constructor
+	 *
+	 * @access    public
+	 */
+	public function __construct()
+	{
+		// set default map settings
+		$this->use_google_maps = true;
+		$this->google_map_api_key = '';
+		// for event details pages (reg page)
+		$this->event_details_map_width = 585;            // ee_map_width_single
+		$this->event_details_map_height = 362;            // ee_map_height_single
+		$this->event_details_map_zoom = 14;            // ee_map_zoom_single
+		$this->event_details_display_nav = true;            // ee_map_nav_display_single
+		$this->event_details_nav_size = false;            // ee_map_nav_size_single
+		$this->event_details_control_type = 'default';        // ee_map_type_control_single
+		$this->event_details_map_align = 'center';            // ee_map_align_single
+		// for event list pages
+		$this->event_list_map_width = 300;            // ee_map_width
+		$this->event_list_map_height = 185;        // ee_map_height
+		$this->event_list_map_zoom = 12;            // ee_map_zoom
+		$this->event_list_display_nav = false;        // ee_map_nav_display
+		$this->event_list_nav_size = true;            // ee_map_nav_size
+		$this->event_list_control_type = 'dropdown';        // ee_map_type_control
+		$this->event_list_map_align = 'center';            // ee_map_align
+	}
 }
 
 /**
@@ -2872,46 +2872,46 @@ 
 class EE_Events_Archive_Config extends EE_Config_Base
 {
 
-    public $display_status_banner;
+	public $display_status_banner;
 
-    public $display_description;
+	public $display_description;
 
-    public $display_ticket_selector;
+	public $display_ticket_selector;
 
-    public $display_datetimes;
+	public $display_datetimes;
 
-    public $display_venue;
+	public $display_venue;
 
-    public $display_expired_events;
+	public $display_expired_events;
 
-    public $use_sortable_display_order;
+	public $use_sortable_display_order;
 
-    public $display_order_tickets;
+	public $display_order_tickets;
 
-    public $display_order_datetimes;
+	public $display_order_datetimes;
 
-    public $display_order_event;
+	public $display_order_event;
 
-    public $display_order_venue;
+	public $display_order_venue;
 
 
-    /**
-     *    class constructor
-     */
-    public function __construct()
-    {
-        $this->display_status_banner = 0;
-        $this->display_description = 1;
-        $this->display_ticket_selector = 0;
-        $this->display_datetimes = 1;
-        $this->display_venue = 0;
-        $this->display_expired_events = 0;
-        $this->use_sortable_display_order = false;
-        $this->display_order_tickets = 100;
-        $this->display_order_datetimes = 110;
-        $this->display_order_event = 120;
-        $this->display_order_venue = 130;
-    }
+	/**
+	 *    class constructor
+	 */
+	public function __construct()
+	{
+		$this->display_status_banner = 0;
+		$this->display_description = 1;
+		$this->display_ticket_selector = 0;
+		$this->display_datetimes = 1;
+		$this->display_venue = 0;
+		$this->display_expired_events = 0;
+		$this->use_sortable_display_order = false;
+		$this->display_order_tickets = 100;
+		$this->display_order_datetimes = 110;
+		$this->display_order_event = 120;
+		$this->display_order_venue = 130;
+	}
 }
 
 /**
@@ -2920,34 +2920,34 @@ 
 class EE_Event_Single_Config extends EE_Config_Base
 {
 
-    public $display_status_banner_single;
+	public $display_status_banner_single;
 
-    public $display_venue;
+	public $display_venue;
 
-    public $use_sortable_display_order;
+	public $use_sortable_display_order;
 
-    public $display_order_tickets;
+	public $display_order_tickets;
 
-    public $display_order_datetimes;
+	public $display_order_datetimes;
 
-    public $display_order_event;
+	public $display_order_event;
 
-    public $display_order_venue;
+	public $display_order_venue;
 
 
-    /**
-     *    class constructor
-     */
-    public function __construct()
-    {
-        $this->display_status_banner_single = 0;
-        $this->display_venue = 1;
-        $this->use_sortable_display_order = false;
-        $this->display_order_tickets = 100;
-        $this->display_order_datetimes = 110;
-        $this->display_order_event = 120;
-        $this->display_order_venue = 130;
-    }
+	/**
+	 *    class constructor
+	 */
+	public function __construct()
+	{
+		$this->display_status_banner_single = 0;
+		$this->display_venue = 1;
+		$this->use_sortable_display_order = false;
+		$this->display_order_tickets = 100;
+		$this->display_order_datetimes = 110;
+		$this->display_order_event = 120;
+		$this->display_order_venue = 130;
+	}
 }
 
 /**
@@ -2956,172 +2956,172 @@ 
 class EE_Ticket_Selector_Config extends EE_Config_Base
 {
 
-    /**
-     * constant to indicate that a datetime selector should NEVER be shown for ticket selectors
-     */
-    const DO_NOT_SHOW_DATETIME_SELECTOR = 'no_datetime_selector';
-
-    /**
-     * constant to indicate that a datetime selector should only be shown for ticket selectors
-     * when the number of datetimes for the event matches the value set for $datetime_selector_threshold
-     */
-    const MAYBE_SHOW_DATETIME_SELECTOR = 'maybe_datetime_selector';
-
-    /**
-     * @var boolean $show_ticket_sale_columns
-     */
-    public $show_ticket_sale_columns;
-
-    /**
-     * @var boolean $show_ticket_details
-     */
-    public $show_ticket_details;
-
-    /**
-     * @var boolean $show_expired_tickets
-     */
-    public $show_expired_tickets;
-
-    /**
-     * whether or not to display a dropdown box populated with event datetimes
-     * that toggles which tickets are displayed for a ticket selector.
-     * uses one of the *_DATETIME_SELECTOR constants defined above
-     *
-     * @var string $show_datetime_selector
-     */
-    private $show_datetime_selector = 'no_datetime_selector';
-
-    /**
-     * the number of datetimes an event has to have before conditionally displaying a datetime selector
-     *
-     * @var int $datetime_selector_threshold
-     */
-    private $datetime_selector_threshold = 3;
-
-    /**
-     * determines the maximum number of "checked" dates in the date and time filter
-     *
-     * @var int $datetime_selector_checked
-     */
-    private $datetime_selector_max_checked = 10;
-
-
-    /**
-     *    class constructor
-     */
-    public function __construct()
-    {
-        $this->show_ticket_sale_columns = true;
-        $this->show_ticket_details = true;
-        $this->show_expired_tickets = true;
-        $this->show_datetime_selector = \EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR;
-        $this->datetime_selector_threshold = 3;
-        $this->datetime_selector_max_checked = 10;
-    }
-
-
-    /**
-     * returns true if a datetime selector should be displayed
-     *
-     * @param array $datetimes
-     * @return bool
-     */
-    public function showDatetimeSelector(array $datetimes)
-    {
-        // if the settings are NOT: don't show OR below threshold, THEN active = true
-        return ! (
-            $this->getShowDatetimeSelector() === \EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR
-            || (
-                $this->getShowDatetimeSelector() === \EE_Ticket_Selector_Config::MAYBE_SHOW_DATETIME_SELECTOR
-                && count($datetimes) < $this->getDatetimeSelectorThreshold()
-            )
-        );
-    }
-
-
-    /**
-     * @return string
-     */
-    public function getShowDatetimeSelector()
-    {
-        return $this->show_datetime_selector;
-    }
-
-
-    /**
-     * @param bool $keys_only
-     * @return array
-     */
-    public function getShowDatetimeSelectorOptions($keys_only = true)
-    {
-        return $keys_only
-            ? array(
-                \EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR,
-                \EE_Ticket_Selector_Config::MAYBE_SHOW_DATETIME_SELECTOR,
-            )
-            : array(
-                \EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR => esc_html__(
-                    'Do not show date & time filter',
-                    'event_espresso'
-                ),
-                \EE_Ticket_Selector_Config::MAYBE_SHOW_DATETIME_SELECTOR  => esc_html__(
-                    'Maybe show date & time filter',
-                    'event_espresso'
-                ),
-            );
-    }
-
-
-    /**
-     * @param string $show_datetime_selector
-     */
-    public function setShowDatetimeSelector($show_datetime_selector)
-    {
-        $this->show_datetime_selector = in_array(
-            $show_datetime_selector,
-            $this->getShowDatetimeSelectorOptions(),
-            true
-        )
-            ? $show_datetime_selector
-            : \EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR;
-    }
-
-
-    /**
-     * @return int
-     */
-    public function getDatetimeSelectorThreshold()
-    {
-        return $this->datetime_selector_threshold;
-    }
-
-
-    /**
-     * @param int $datetime_selector_threshold
-     */
-    public function setDatetimeSelectorThreshold($datetime_selector_threshold)
-    {
-        $datetime_selector_threshold = absint($datetime_selector_threshold);
-        $this->datetime_selector_threshold = $datetime_selector_threshold ? $datetime_selector_threshold : 3;
-    }
-
-
-    /**
-     * @return int
-     */
-    public function getDatetimeSelectorMaxChecked()
-    {
-        return $this->datetime_selector_max_checked;
-    }
-
-
-    /**
-     * @param int $datetime_selector_max_checked
-     */
-    public function setDatetimeSelectorMaxChecked($datetime_selector_max_checked)
-    {
-        $this->datetime_selector_max_checked = absint($datetime_selector_max_checked);
-    }
+	/**
+	 * constant to indicate that a datetime selector should NEVER be shown for ticket selectors
+	 */
+	const DO_NOT_SHOW_DATETIME_SELECTOR = 'no_datetime_selector';
+
+	/**
+	 * constant to indicate that a datetime selector should only be shown for ticket selectors
+	 * when the number of datetimes for the event matches the value set for $datetime_selector_threshold
+	 */
+	const MAYBE_SHOW_DATETIME_SELECTOR = 'maybe_datetime_selector';
+
+	/**
+	 * @var boolean $show_ticket_sale_columns
+	 */
+	public $show_ticket_sale_columns;
+
+	/**
+	 * @var boolean $show_ticket_details
+	 */
+	public $show_ticket_details;
+
+	/**
+	 * @var boolean $show_expired_tickets
+	 */
+	public $show_expired_tickets;
+
+	/**
+	 * whether or not to display a dropdown box populated with event datetimes
+	 * that toggles which tickets are displayed for a ticket selector.
+	 * uses one of the *_DATETIME_SELECTOR constants defined above
+	 *
+	 * @var string $show_datetime_selector
+	 */
+	private $show_datetime_selector = 'no_datetime_selector';
+
+	/**
+	 * the number of datetimes an event has to have before conditionally displaying a datetime selector
+	 *
+	 * @var int $datetime_selector_threshold
+	 */
+	private $datetime_selector_threshold = 3;
+
+	/**
+	 * determines the maximum number of "checked" dates in the date and time filter
+	 *
+	 * @var int $datetime_selector_checked
+	 */
+	private $datetime_selector_max_checked = 10;
+
+
+	/**
+	 *    class constructor
+	 */
+	public function __construct()
+	{
+		$this->show_ticket_sale_columns = true;
+		$this->show_ticket_details = true;
+		$this->show_expired_tickets = true;
+		$this->show_datetime_selector = \EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR;
+		$this->datetime_selector_threshold = 3;
+		$this->datetime_selector_max_checked = 10;
+	}
+
+
+	/**
+	 * returns true if a datetime selector should be displayed
+	 *
+	 * @param array $datetimes
+	 * @return bool
+	 */
+	public function showDatetimeSelector(array $datetimes)
+	{
+		// if the settings are NOT: don't show OR below threshold, THEN active = true
+		return ! (
+			$this->getShowDatetimeSelector() === \EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR
+			|| (
+				$this->getShowDatetimeSelector() === \EE_Ticket_Selector_Config::MAYBE_SHOW_DATETIME_SELECTOR
+				&& count($datetimes) < $this->getDatetimeSelectorThreshold()
+			)
+		);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function getShowDatetimeSelector()
+	{
+		return $this->show_datetime_selector;
+	}
+
+
+	/**
+	 * @param bool $keys_only
+	 * @return array
+	 */
+	public function getShowDatetimeSelectorOptions($keys_only = true)
+	{
+		return $keys_only
+			? array(
+				\EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR,
+				\EE_Ticket_Selector_Config::MAYBE_SHOW_DATETIME_SELECTOR,
+			)
+			: array(
+				\EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR => esc_html__(
+					'Do not show date & time filter',
+					'event_espresso'
+				),
+				\EE_Ticket_Selector_Config::MAYBE_SHOW_DATETIME_SELECTOR  => esc_html__(
+					'Maybe show date & time filter',
+					'event_espresso'
+				),
+			);
+	}
+
+
+	/**
+	 * @param string $show_datetime_selector
+	 */
+	public function setShowDatetimeSelector($show_datetime_selector)
+	{
+		$this->show_datetime_selector = in_array(
+			$show_datetime_selector,
+			$this->getShowDatetimeSelectorOptions(),
+			true
+		)
+			? $show_datetime_selector
+			: \EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR;
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function getDatetimeSelectorThreshold()
+	{
+		return $this->datetime_selector_threshold;
+	}
+
+
+	/**
+	 * @param int $datetime_selector_threshold
+	 */
+	public function setDatetimeSelectorThreshold($datetime_selector_threshold)
+	{
+		$datetime_selector_threshold = absint($datetime_selector_threshold);
+		$this->datetime_selector_threshold = $datetime_selector_threshold ? $datetime_selector_threshold : 3;
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function getDatetimeSelectorMaxChecked()
+	{
+		return $this->datetime_selector_max_checked;
+	}
+
+
+	/**
+	 * @param int $datetime_selector_max_checked
+	 */
+	public function setDatetimeSelectorMaxChecked($datetime_selector_max_checked)
+	{
+		$this->datetime_selector_max_checked = absint($datetime_selector_max_checked);
+	}
 }
 
 /**
@@ -3134,86 +3134,86 @@ 
 class EE_Environment_Config extends EE_Config_Base
 {
 
-    /**
-     * Hold any php environment variables that we want to track.
-     *
-     * @var stdClass;
-     */
-    public $php;
-
-
-    /**
-     *    constructor
-     */
-    public function __construct()
-    {
-        $this->php = new stdClass();
-        $this->_set_php_values();
-    }
-
-
-    /**
-     * This sets the php environment variables.
-     *
-     * @since 4.4.0
-     * @return void
-     */
-    protected function _set_php_values()
-    {
-        $this->php->max_input_vars = ini_get('max_input_vars');
-        $this->php->version = phpversion();
-    }
-
-
-    /**
-     * helper method for determining whether input_count is
-     * reaching the potential maximum the server can handle
-     * according to max_input_vars
-     *
-     * @param int   $input_count the count of input vars.
-     * @return array {
-     *                           An array that represents whether available space and if no available space the error
-     *                           message.
-     * @type bool   $has_space   whether more inputs can be added.
-     * @type string $msg         Any message to be displayed.
-     *                           }
-     */
-    public function max_input_vars_limit_check($input_count = 0)
-    {
-        if (! empty($this->php->max_input_vars)
-            && ($input_count >= $this->php->max_input_vars)
-        ) {
-            // check the server setting because the config value could be stale
-            $max_input_vars = ini_get('max_input_vars');
-            if ($input_count >= $max_input_vars) {
-                return sprintf(
-                    esc_html__(
-                        'The maximum number of inputs on this page has been exceeded. You cannot make edits to this page because of your server\'s PHP "max_input_vars" setting.%1$sThere are %2$d inputs and the maximum amount currently allowed by your server is %3$d.%1$sPlease contact your web host and ask them to raise the "max_input_vars" limit.',
-                        'event_espresso'
-                    ),
-                    '<br>',
-                    $input_count,
-                    $max_input_vars
-                );
-            } else {
-                return '';
-            }
-        } else {
-            return '';
-        }
-    }
-
-
-    /**
-     * The purpose of this method is just to force rechecking php values so if they've changed, they get updated.
-     *
-     * @since 4.4.1
-     * @return void
-     */
-    public function recheck_values()
-    {
-        $this->_set_php_values();
-    }
+	/**
+	 * Hold any php environment variables that we want to track.
+	 *
+	 * @var stdClass;
+	 */
+	public $php;
+
+
+	/**
+	 *    constructor
+	 */
+	public function __construct()
+	{
+		$this->php = new stdClass();
+		$this->_set_php_values();
+	}
+
+
+	/**
+	 * This sets the php environment variables.
+	 *
+	 * @since 4.4.0
+	 * @return void
+	 */
+	protected function _set_php_values()
+	{
+		$this->php->max_input_vars = ini_get('max_input_vars');
+		$this->php->version = phpversion();
+	}
+
+
+	/**
+	 * helper method for determining whether input_count is
+	 * reaching the potential maximum the server can handle
+	 * according to max_input_vars
+	 *
+	 * @param int   $input_count the count of input vars.
+	 * @return array {
+	 *                           An array that represents whether available space and if no available space the error
+	 *                           message.
+	 * @type bool   $has_space   whether more inputs can be added.
+	 * @type string $msg         Any message to be displayed.
+	 *                           }
+	 */
+	public function max_input_vars_limit_check($input_count = 0)
+	{
+		if (! empty($this->php->max_input_vars)
+			&& ($input_count >= $this->php->max_input_vars)
+		) {
+			// check the server setting because the config value could be stale
+			$max_input_vars = ini_get('max_input_vars');
+			if ($input_count >= $max_input_vars) {
+				return sprintf(
+					esc_html__(
+						'The maximum number of inputs on this page has been exceeded. You cannot make edits to this page because of your server\'s PHP "max_input_vars" setting.%1$sThere are %2$d inputs and the maximum amount currently allowed by your server is %3$d.%1$sPlease contact your web host and ask them to raise the "max_input_vars" limit.',
+						'event_espresso'
+					),
+					'<br>',
+					$input_count,
+					$max_input_vars
+				);
+			} else {
+				return '';
+			}
+		} else {
+			return '';
+		}
+	}
+
+
+	/**
+	 * The purpose of this method is just to force rechecking php values so if they've changed, they get updated.
+	 *
+	 * @since 4.4.1
+	 * @return void
+	 */
+	public function recheck_values()
+	{
+		$this->_set_php_values();
+	}
 }
 
 /**
@@ -3226,21 +3226,21 @@ 
 class EE_Tax_Config extends EE_Config_Base
 {
 
-    /*
+	/*
      * flag to indicate whether or not to display ticket prices with the taxes included
      *
      * @var boolean $prices_displayed_including_taxes
      */
-    public $prices_displayed_including_taxes;
+	public $prices_displayed_including_taxes;
 
 
-    /**
-     *    class constructor
-     */
-    public function __construct()
-    {
-        $this->prices_displayed_including_taxes = true;
-    }
+	/**
+	 *    class constructor
+	 */
+	public function __construct()
+	{
+		$this->prices_displayed_including_taxes = true;
+	}
 }
 
 /**
@@ -3254,19 +3254,19 @@ 
 class EE_Messages_Config extends EE_Config_Base
 {
 
-    /**
-     * This is an integer representing the deletion threshold in months for when old messages will get deleted.
-     * A value of 0 represents never deleting.  Default is 0.
-     *
-     * @var integer
-     */
-    public $delete_threshold;
+	/**
+	 * This is an integer representing the deletion threshold in months for when old messages will get deleted.
+	 * A value of 0 represents never deleting.  Default is 0.
+	 *
+	 * @var integer
+	 */
+	public $delete_threshold;
 
 
-    public function __construct()
-    {
-        $this->delete_threshold = 0;
-    }
+	public function __construct()
+	{
+		$this->delete_threshold = 0;
+	}
 }
 
 /**
@@ -3277,31 +3277,31 @@ 
 class EE_Gateway_Config extends EE_Config_Base
 {
 
-    /**
-     * Array with keys that are payment gateways slugs, and values are arrays
-     * with any config info the gateway wants to store
-     *
-     * @var array
-     */
-    public $payment_settings;
-
-    /**
-     * Where keys are gateway slugs, and values are booleans indicating whether or not
-     * the gateway is stored in the uploads directory
-     *
-     * @var array
-     */
-    public $active_gateways;
-
-
-    /**
-     *    class constructor
-     *
-     * @deprecated
-     */
-    public function __construct()
-    {
-        $this->payment_settings = array();
-        $this->active_gateways = array('Invoice' => false);
-    }
+	/**
+	 * Array with keys that are payment gateways slugs, and values are arrays
+	 * with any config info the gateway wants to store
+	 *
+	 * @var array
+	 */
+	public $payment_settings;
+
+	/**
+	 * Where keys are gateway slugs, and values are booleans indicating whether or not
+	 * the gateway is stored in the uploads directory
+	 *
+	 * @var array
+	 */
+	public $active_gateways;
+
+
+	/**
+	 *    class constructor
+	 *
+	 * @deprecated
+	 */
+	public function __construct()
+	{
+		$this->payment_settings = array();
+		$this->active_gateways = array('Invoice' => false);
+	}
 }

Spacing +122 added lines, -122 removed lines

@@ -145,7 +145,7 @@ 
     public static function instance()
     {
         // check if class object is instantiated, and instantiated properly
-        if (! self::$_instance instanceof EE_Config) {
+        if ( ! self::$_instance instanceof EE_Config) {
             self::$_instance = new self();
         }
         return self::$_instance;
@@ -283,7 +283,7 @@ 
                 $this
             );
             if (is_object($settings) && property_exists($this, $config)) {
-                $this->{$config} = apply_filters('FHEE__EE_Config___load_core_config__' . $config, $settings);
+                $this->{$config} = apply_filters('FHEE__EE_Config___load_core_config__'.$config, $settings);
                 // call configs populate method to ensure any defaults are set for empty values.
                 if (method_exists($settings, 'populate')) {
                     $this->{$config}->populate();
@@ -556,7 +556,7 @@ 
                         break;
                     // TEST #2 : check that settings section exists
                     case 2:
-                        if (! isset($this->{$section})) {
+                        if ( ! isset($this->{$section})) {
                             if ($display_errors) {
                                 throw new EE_Error(
                                     sprintf(
@@ -570,7 +570,7 @@ 
                         break;
                     // TEST #3 : check that section is the proper format
                     case 3:
-                        if (! ($this->{$section} instanceof EE_Config_Base || $this->{$section} instanceof stdClass)
+                        if ( ! ($this->{$section} instanceof EE_Config_Base || $this->{$section} instanceof stdClass)
                         ) {
                             if ($display_errors) {
                                 throw new EE_Error(
@@ -616,7 +616,7 @@ 
                         break;
                     // TEST #6 : verify config class is accessible
                     case 6:
-                        if (! class_exists($config_class)) {
+                        if ( ! class_exists($config_class)) {
                             if ($display_errors) {
                                 throw new EE_Error(
                                     sprintf(
@@ -633,7 +633,7 @@ 
                         break;
                     // TEST #7 : check that config has even been set
                     case 7:
-                        if (! isset($this->{$section}->{$name})) {
+                        if ( ! isset($this->{$section}->{$name})) {
                             if ($display_errors) {
                                 throw new EE_Error(
                                     sprintf(
@@ -651,7 +651,7 @@ 
                         break;
                     // TEST #8 : check that config is the requested type
                     case 8:
-                        if (! $this->{$section}->{$name} instanceof $config_class) {
+                        if ( ! $this->{$section}->{$name} instanceof $config_class) {
                             if ($display_errors) {
                                 throw new EE_Error(
                                     sprintf(
@@ -670,7 +670,7 @@ 
                         break;
                     // TEST #9 : verify config object
                     case 9:
-                        if (! $config_obj instanceof EE_Config_Base) {
+                        if ( ! $config_obj instanceof EE_Config_Base) {
                             if ($display_errors) {
                                 throw new EE_Error(
                                     sprintf(
@@ -702,7 +702,7 @@ 
      */
     private function _generate_config_option_name($section = '', $name = '')
     {
-        return 'ee_config-' . strtolower($section . '-' . str_replace(array('EE_', 'EED_'), '', $name));
+        return 'ee_config-'.strtolower($section.'-'.str_replace(array('EE_', 'EED_'), '', $name));
     }
 
 
@@ -719,7 +719,7 @@ 
     {
         return ! empty($config_class)
             ? $config_class
-            : str_replace(' ', '_', ucwords(str_replace('_', ' ', $name))) . '_Config';
+            : str_replace(' ', '_', ucwords(str_replace('_', ' ', $name))).'_Config';
     }
 
 
@@ -738,17 +738,17 @@ 
         // ensure config class is set to something
         $config_class = $this->_set_config_class($config_class, $name);
         // run tests 1-4, 6, and 7 to verify all config params are set and valid
-        if (! $this->_verify_config_params($section, $name, $config_class, null, array(1, 2, 3, 4, 5, 6))) {
+        if ( ! $this->_verify_config_params($section, $name, $config_class, null, array(1, 2, 3, 4, 5, 6))) {
             return null;
         }
         $config_option_name = $this->_generate_config_option_name($section, $name);
         // if the config option name hasn't been added yet to the list of option names we're tracking, then do so now
-        if (! isset($this->_addon_option_names[ $config_option_name ])) {
-            $this->_addon_option_names[ $config_option_name ] = $config_class;
+        if ( ! isset($this->_addon_option_names[$config_option_name])) {
+            $this->_addon_option_names[$config_option_name] = $config_class;
             $this->update_addon_option_names();
         }
         // verify the incoming config object but suppress errors
-        if (! $this->_verify_config_params($section, $name, $config_class, $config_obj, array(9), false)) {
+        if ( ! $this->_verify_config_params($section, $name, $config_class, $config_obj, array(9), false)) {
             $config_obj = new $config_class();
         }
         if (get_option($config_option_name)) {
@@ -795,7 +795,7 @@ 
         // get class name of the incoming object
         $config_class = get_class($config_obj);
         // run tests 1-5 and 9 to verify config
-        if (! $this->_verify_config_params(
+        if ( ! $this->_verify_config_params(
             $section,
             $name,
             $config_class,
@@ -807,7 +807,7 @@ 
         }
         $config_option_name = $this->_generate_config_option_name($section, $name);
         // check if config object has been added to db by seeing if config option name is in $this->_addon_option_names array
-        if (! isset($this->_addon_option_names[ $config_option_name ])) {
+        if ( ! isset($this->_addon_option_names[$config_option_name])) {
             // save new config to db
             if ($this->set_config($section, $name, $config_class, $config_obj)) {
                 return true;
@@ -833,7 +833,7 @@ 
                             'event_espresso'
                         ),
                         $config_class,
-                        'EE_Config->' . $section . '->' . $name
+                        'EE_Config->'.$section.'->'.$name
                     ),
                     __FILE__,
                     __FUNCTION__,
@@ -859,7 +859,7 @@ 
         // ensure config class is set to something
         $config_class = $this->_set_config_class($config_class, $name);
         // run tests 1-4, 6 and 7 to verify that all params have been set
-        if (! $this->_verify_config_params($section, $name, $config_class, null, array(1, 2, 3, 4, 5, 6))) {
+        if ( ! $this->_verify_config_params($section, $name, $config_class, null, array(1, 2, 3, 4, 5, 6))) {
             return null;
         }
         // now test if the requested config object exists, but suppress errors
@@ -904,7 +904,7 @@ 
         // retrieve the wp-option for this config class.
         $config_option = maybe_unserialize(get_option($config_option_name, array()));
         if (empty($config_option)) {
-            EE_Config::log($config_option_name . '-NOT-FOUND');
+            EE_Config::log($config_option_name.'-NOT-FOUND');
         }
         return $config_option;
     }
@@ -922,7 +922,7 @@ 
             // copy incoming $_REQUEST and sanitize it so we can save it
             $_request = $_REQUEST;
             array_walk_recursive($_request, 'sanitize_text_field');
-            $config_log[ (string) microtime(true) ] = array(
+            $config_log[(string) microtime(true)] = array(
                 'config_name' => $config_option_name,
                 'request'     => $_request,
             );
@@ -937,7 +937,7 @@ 
      */
     public static function trim_log()
     {
-        if (! EE_Config::logging_enabled()) {
+        if ( ! EE_Config::logging_enabled()) {
             return;
         }
         $config_log = maybe_unserialize(get_option(EE_Config::LOG_NAME, array()));
@@ -961,7 +961,7 @@ 
     public static function get_page_for_posts()
     {
         $page_for_posts = get_option('page_for_posts');
-        if (! $page_for_posts) {
+        if ( ! $page_for_posts) {
             return 'posts';
         }
         /** @type WPDB $wpdb */
@@ -1011,20 +1011,20 @@ 
     {
         // only init widgets on admin pages when not in complete maintenance, and
         // on frontend when not in any maintenance mode
-        if (! EE_Maintenance_Mode::instance()->level()
+        if ( ! EE_Maintenance_Mode::instance()->level()
             || (
                 is_admin()
                 && EE_Maintenance_Mode::instance()->level() !== EE_Maintenance_Mode::level_2_complete_maintenance
             )
         ) {
             // grab list of installed widgets
-            $widgets_to_register = glob(EE_WIDGETS . '*', GLOB_ONLYDIR);
+            $widgets_to_register = glob(EE_WIDGETS.'*', GLOB_ONLYDIR);
             // filter list of modules to register
             $widgets_to_register = apply_filters(
                 'FHEE__EE_Config__register_widgets__widgets_to_register',
                 $widgets_to_register
             );
-            if (! empty($widgets_to_register)) {
+            if ( ! empty($widgets_to_register)) {
                 // cycle thru widget folders
                 foreach ($widgets_to_register as $widget_path) {
                     // add to list of installed widget modules
@@ -1074,31 +1074,31 @@ 
         // create classname from widget directory name
         $widget = str_replace(' ', '_', ucwords(str_replace('_', ' ', $widget)));
         // add class prefix
-        $widget_class = 'EEW_' . $widget;
+        $widget_class = 'EEW_'.$widget;
         // does the widget exist ?
-        if (! is_readable($widget_path . '/' . $widget_class . $widget_ext)) {
+        if ( ! is_readable($widget_path.'/'.$widget_class.$widget_ext)) {
             $msg = sprintf(
                 __(
                     'The requested %s widget file could not be found or is not readable due to file permissions. Please ensure the following path is correct: %s',
                     'event_espresso'
                 ),
                 $widget_class,
-                $widget_path . '/' . $widget_class . $widget_ext
+                $widget_path.'/'.$widget_class.$widget_ext
             );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+            EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
             return;
         }
         // load the widget class file
-        require_once($widget_path . '/' . $widget_class . $widget_ext);
+        require_once($widget_path.'/'.$widget_class.$widget_ext);
         // verify that class exists
-        if (! class_exists($widget_class)) {
+        if ( ! class_exists($widget_class)) {
             $msg = sprintf(__('The requested %s widget class does not exist.', 'event_espresso'), $widget_class);
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+            EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
             return;
         }
         register_widget($widget_class);
         // add to array of registered widgets
-        EE_Registry::instance()->widgets->{$widget_class} = $widget_path . '/' . $widget_class . $widget_ext;
+        EE_Registry::instance()->widgets->{$widget_class} = $widget_path.'/'.$widget_class.$widget_ext;
     }
 
 
@@ -1111,18 +1111,18 @@ 
     private function _register_modules()
     {
         // grab list of installed modules
-        $modules_to_register = glob(EE_MODULES . '*', GLOB_ONLYDIR);
+        $modules_to_register = glob(EE_MODULES.'*', GLOB_ONLYDIR);
         // filter list of modules to register
         $modules_to_register = apply_filters(
             'FHEE__EE_Config__register_modules__modules_to_register',
             $modules_to_register
         );
-        if (! empty($modules_to_register)) {
+        if ( ! empty($modules_to_register)) {
             // loop through folders
             foreach ($modules_to_register as $module_path) {
                 /**TEMPORARILY EXCLUDE gateways from modules for time being**/
-                if ($module_path !== EE_MODULES . 'zzz-copy-this-module-template'
-                    && $module_path !== EE_MODULES . 'gateways'
+                if ($module_path !== EE_MODULES.'zzz-copy-this-module-template'
+                    && $module_path !== EE_MODULES.'gateways'
                 ) {
                     // add to list of installed modules
                     EE_Config::register_module($module_path);
@@ -1159,25 +1159,25 @@ 
             // remove last segment
             array_pop($module_path);
             // glue it back together
-            $module_path = implode('/', $module_path) . '/';
+            $module_path = implode('/', $module_path).'/';
             // take first segment from file name pieces and sanitize it
             $module = preg_replace('/[^a-zA-Z0-9_\-]/', '', $module_file[0]);
             // ensure class prefix is added
-            $module_class = strpos($module, 'EED_') !== 0 ? 'EED_' . $module : $module;
+            $module_class = strpos($module, 'EED_') !== 0 ? 'EED_'.$module : $module;
         } else {
             // we need to generate the filename based off of the folder name
             // grab and sanitize module name
             $module = strtolower(basename($module_path));
             $module = preg_replace('/[^a-z0-9_\-]/', '', $module);
             // like trailingslashit()
-            $module_path = rtrim($module_path, '/') . '/';
+            $module_path = rtrim($module_path, '/').'/';
             // create classname from module directory name
             $module = str_replace(' ', '_', ucwords(str_replace('_', ' ', $module)));
             // add class prefix
-            $module_class = 'EED_' . $module;
+            $module_class = 'EED_'.$module;
         }
         // does the module exist ?
-        if (! is_readable($module_path . '/' . $module_class . $module_ext)) {
+        if ( ! is_readable($module_path.'/'.$module_class.$module_ext)) {
             $msg = sprintf(
                 __(
                     'The requested %s module file could not be found or is not readable due to file permissions.',
@@ -1185,19 +1185,19 @@ 
                 ),
                 $module
             );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+            EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
             return false;
         }
         // load the module class file
-        require_once($module_path . $module_class . $module_ext);
+        require_once($module_path.$module_class.$module_ext);
         // verify that class exists
-        if (! class_exists($module_class)) {
+        if ( ! class_exists($module_class)) {
             $msg = sprintf(__('The requested %s module class does not exist.', 'event_espresso'), $module_class);
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+            EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
             return false;
         }
         // add to array of registered modules
-        EE_Registry::instance()->modules->{$module_class} = $module_path . $module_class . $module_ext;
+        EE_Registry::instance()->modules->{$module_class} = $module_path.$module_class.$module_ext;
         do_action(
             'AHEE__EE_Config__register_module__complete',
             $module_class,
@@ -1248,26 +1248,26 @@ 
     {
         do_action('AHEE__EE_Config__register_route__begin', $route, $module, $method_name);
         $module = str_replace('EED_', '', $module);
-        $module_class = 'EED_' . $module;
-        if (! isset(EE_Registry::instance()->modules->{$module_class})) {
+        $module_class = 'EED_'.$module;
+        if ( ! isset(EE_Registry::instance()->modules->{$module_class})) {
             $msg = sprintf(__('The module %s has not been registered.', 'event_espresso'), $module);
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+            EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
             return false;
         }
         if (empty($route)) {
             $msg = sprintf(__('No route has been supplied.', 'event_espresso'), $route);
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+            EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
             return false;
         }
-        if (! method_exists('EED_' . $module, $method_name)) {
+        if ( ! method_exists('EED_'.$module, $method_name)) {
             $msg = sprintf(
                 __('A valid class method for the %s route has not been supplied.', 'event_espresso'),
                 $route
             );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+            EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
             return false;
         }
-        EE_Config::$_module_route_map[ (string) $key ][ (string) $route ] = array('EED_' . $module, $method_name);
+        EE_Config::$_module_route_map[(string) $key][(string) $route] = array('EED_'.$module, $method_name);
         return true;
     }
 
@@ -1284,8 +1284,8 @@ 
     {
         do_action('AHEE__EE_Config__get_route__begin', $route);
         $route = (string) apply_filters('FHEE__EE_Config__get_route', $route);
-        if (isset(EE_Config::$_module_route_map[ $key ][ $route ])) {
-            return EE_Config::$_module_route_map[ $key ][ $route ];
+        if (isset(EE_Config::$_module_route_map[$key][$route])) {
+            return EE_Config::$_module_route_map[$key][$route];
         }
         return null;
     }
@@ -1317,47 +1317,47 @@ 
     public static function register_forward($route = null, $status = 0, $forward = null, $key = 'ee')
     {
         do_action('AHEE__EE_Config__register_forward', $route, $status, $forward);
-        if (! isset(EE_Config::$_module_route_map[ $key ][ $route ]) || empty($route)) {
+        if ( ! isset(EE_Config::$_module_route_map[$key][$route]) || empty($route)) {
             $msg = sprintf(
                 __('The module route %s for this forward has not been registered.', 'event_espresso'),
                 $route
             );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+            EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
             return false;
         }
         if (empty($forward)) {
             $msg = sprintf(__('No forwarding route has been supplied.', 'event_espresso'), $route);
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+            EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
             return false;
         }
         if (is_array($forward)) {
-            if (! isset($forward[1])) {
+            if ( ! isset($forward[1])) {
                 $msg = sprintf(
                     __('A class method for the %s forwarding route has not been supplied.', 'event_espresso'),
                     $route
                 );
-                EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+                EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
                 return false;
             }
-            if (! method_exists($forward[0], $forward[1])) {
+            if ( ! method_exists($forward[0], $forward[1])) {
                 $msg = sprintf(
                     __('The class method %s for the %s forwarding route is in invalid.', 'event_espresso'),
                     $forward[1],
                     $route
                 );
-                EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+                EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
                 return false;
             }
-        } elseif (! function_exists($forward)) {
+        } elseif ( ! function_exists($forward)) {
             $msg = sprintf(
                 __('The function %s for the %s forwarding route is in invalid.', 'event_espresso'),
                 $forward,
                 $route
             );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+            EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
             return false;
         }
-        EE_Config::$_module_forward_map[ $key ][ $route ][ absint($status) ] = $forward;
+        EE_Config::$_module_forward_map[$key][$route][absint($status)] = $forward;
         return true;
     }
 
@@ -1375,10 +1375,10 @@ 
     public static function get_forward($route = null, $status = 0, $key = 'ee')
     {
         do_action('AHEE__EE_Config__get_forward__begin', $route, $status);
-        if (isset(EE_Config::$_module_forward_map[ $key ][ $route ][ $status ])) {
+        if (isset(EE_Config::$_module_forward_map[$key][$route][$status])) {
             return apply_filters(
                 'FHEE__EE_Config__get_forward',
-                EE_Config::$_module_forward_map[ $key ][ $route ][ $status ],
+                EE_Config::$_module_forward_map[$key][$route][$status],
                 $route,
                 $status
             );
@@ -1402,15 +1402,15 @@ 
     public static function register_view($route = null, $status = 0, $view = null, $key = 'ee')
     {
         do_action('AHEE__EE_Config__register_view__begin', $route, $status, $view);
-        if (! isset(EE_Config::$_module_route_map[ $key ][ $route ]) || empty($route)) {
+        if ( ! isset(EE_Config::$_module_route_map[$key][$route]) || empty($route)) {
             $msg = sprintf(
                 __('The module route %s for this view has not been registered.', 'event_espresso'),
                 $route
             );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+            EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
             return false;
         }
-        if (! is_readable($view)) {
+        if ( ! is_readable($view)) {
             $msg = sprintf(
                 __(
                     'The %s view file could not be found or is not readable due to file permissions.',
@@ -1418,10 +1418,10 @@ 
                 ),
                 $view
             );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+            EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
             return false;
         }
-        EE_Config::$_module_view_map[ $key ][ $route ][ absint($status) ] = $view;
+        EE_Config::$_module_view_map[$key][$route][absint($status)] = $view;
         return true;
     }
 
@@ -1439,10 +1439,10 @@ 
     public static function get_view($route = null, $status = 0, $key = 'ee')
     {
         do_action('AHEE__EE_Config__get_view__begin', $route, $status);
-        if (isset(EE_Config::$_module_view_map[ $key ][ $route ][ $status ])) {
+        if (isset(EE_Config::$_module_view_map[$key][$route][$status])) {
             return apply_filters(
                 'FHEE__EE_Config__get_view',
-                EE_Config::$_module_view_map[ $key ][ $route ][ $status ],
+                EE_Config::$_module_view_map[$key][$route][$status],
                 $route,
                 $status
             );
@@ -1469,7 +1469,7 @@ 
     public static function getLegacyShortcodesManager()
     {
 
-        if (! EE_Config::instance()->legacy_shortcodes_manager instanceof LegacyShortcodesManager) {
+        if ( ! EE_Config::instance()->legacy_shortcodes_manager instanceof LegacyShortcodesManager) {
             EE_Config::instance()->legacy_shortcodes_manager = new LegacyShortcodesManager(
                 EE_Registry::instance()
             );
@@ -1516,7 +1516,7 @@ 
      */
     public function get_pretty($property)
     {
-        if (! property_exists($this, $property)) {
+        if ( ! property_exists($this, $property)) {
             throw new EE_Error(
                 sprintf(
                     __(
@@ -1745,11 +1745,11 @@ 
      */
     public function reg_page_url()
     {
-        if (! $this->reg_page_url) {
+        if ( ! $this->reg_page_url) {
             $this->reg_page_url = add_query_arg(
                 array('uts' => time()),
                 get_permalink($this->reg_page_id)
-            ) . '#checkout';
+            ).'#checkout';
         }
         return $this->reg_page_url;
     }
@@ -1765,7 +1765,7 @@ 
      */
     public function txn_page_url($query_args = array())
     {
-        if (! $this->txn_page_url) {
+        if ( ! $this->txn_page_url) {
             $this->txn_page_url = get_permalink($this->txn_page_id);
         }
         if ($query_args) {
@@ -1786,7 +1786,7 @@ 
      */
     public function thank_you_page_url($query_args = array())
     {
-        if (! $this->thank_you_page_url) {
+        if ( ! $this->thank_you_page_url) {
             $this->thank_you_page_url = get_permalink($this->thank_you_page_id);
         }
         if ($query_args) {
@@ -1805,7 +1805,7 @@ 
      */
     public function cancel_page_url()
     {
-        if (! $this->cancel_page_url) {
+        if ( ! $this->cancel_page_url) {
             $this->cancel_page_url = get_permalink($this->cancel_page_id);
         }
         return $this->cancel_page_url;
@@ -1848,13 +1848,13 @@ 
         $current_main_site_id = ! empty($current_network_main_site) ? $current_network_main_site->blog_id : 1;
         $option = self::OPTION_NAME_UXIP;
         // set correct table for query
-        $table_name = $wpdb->get_blog_prefix($current_main_site_id) . 'options';
+        $table_name = $wpdb->get_blog_prefix($current_main_site_id).'options';
         // rather than getting blog option for the $current_main_site_id, we do a direct $wpdb query because
         // get_blog_option() does a switch_to_blog an that could cause infinite recursion because EE_Core_Config might be
         // re-constructed on the blog switch.  Note, we are still executing any core wp filters on this option retrieval.
         // this bit of code is basically a direct copy of get_option without any caching because we are NOT switched to the blog
         // for the purpose of caching.
-        $pre = apply_filters('pre_option_' . $option, false, $option);
+        $pre = apply_filters('pre_option_'.$option, false, $option);
         if (false !== $pre) {
             EE_Core_Config::$ee_ueip_option = $pre;
             return EE_Core_Config::$ee_ueip_option;
@@ -1868,10 +1868,10 @@ 
         if (is_object($row)) {
             $value = $row->option_value;
         } else { // option does not exist so use default.
-            EE_Core_Config::$ee_ueip_option =  apply_filters('default_option_' . $option, false, $option);
+            EE_Core_Config::$ee_ueip_option = apply_filters('default_option_'.$option, false, $option);
             return EE_Core_Config::$ee_ueip_option;
         }
-        EE_Core_Config::$ee_ueip_option = apply_filters('option_' . $option, maybe_unserialize($value), $option);
+        EE_Core_Config::$ee_ueip_option = apply_filters('option_'.$option, maybe_unserialize($value), $option);
         return EE_Core_Config::$ee_ueip_option;
     }
 
@@ -2125,37 +2125,37 @@ 
         // but override if requested
         $CNT_ISO = ! empty($CNT_ISO) ? $CNT_ISO : $ORG_CNT;
         // so if that all went well, and we are not in M-Mode (cuz you can't query the db in M-Mode) and double-check the countries table exists
-        if (! empty($CNT_ISO)
+        if ( ! empty($CNT_ISO)
             && EE_Maintenance_Mode::instance()->models_can_query()
             && $table_analysis->tableExists(EE_Registry::instance()->load_model('Country')->table())
         ) {
             // retrieve the country settings from the db, just in case they have been customized
             $country = EE_Registry::instance()->load_model('Country')->get_one_by_ID($CNT_ISO);
             if ($country instanceof EE_Country) {
-                $this->code = $country->currency_code();    // currency code: USD, CAD, EUR
-                $this->name = $country->currency_name_single();    // Dollar
-                $this->plural = $country->currency_name_plural();    // Dollars
-                $this->sign = $country->currency_sign();            // currency sign: $
+                $this->code = $country->currency_code(); // currency code: USD, CAD, EUR
+                $this->name = $country->currency_name_single(); // Dollar
+                $this->plural = $country->currency_name_plural(); // Dollars
+                $this->sign = $country->currency_sign(); // currency sign: $
                 $this->sign_b4 = $country->currency_sign_before(
-                );        // currency sign before or after: $TRUE  or  FALSE$
-                $this->dec_plc = $country->currency_decimal_places();    // decimal places: 2 = 0.00  3 = 0.000
+                ); // currency sign before or after: $TRUE  or  FALSE$
+                $this->dec_plc = $country->currency_decimal_places(); // decimal places: 2 = 0.00  3 = 0.000
                 $this->dec_mrk = $country->currency_decimal_mark(
-                );    // decimal mark: (comma) ',' = 0,01   or (decimal) '.' = 0.01
+                ); // decimal mark: (comma) ',' = 0,01   or (decimal) '.' = 0.01
                 $this->thsnds = $country->currency_thousands_separator(
-                );    // thousands separator: (comma) ',' = 1,000   or (decimal) '.' = 1.000
+                ); // thousands separator: (comma) ',' = 1,000   or (decimal) '.' = 1.000
             }
         }
         // fallback to hardcoded defaults, in case the above failed
         if (empty($this->code)) {
             // set default currency settings
-            $this->code = 'USD';    // currency code: USD, CAD, EUR
-            $this->name = __('Dollar', 'event_espresso');    // Dollar
-            $this->plural = __('Dollars', 'event_espresso');    // Dollars
-            $this->sign = '$';    // currency sign: $
-            $this->sign_b4 = true;    // currency sign before or after: $TRUE  or  FALSE$
-            $this->dec_plc = 2;    // decimal places: 2 = 0.00  3 = 0.000
-            $this->dec_mrk = '.';    // decimal mark: (comma) ',' = 0,01   or (decimal) '.' = 0.01
-            $this->thsnds = ',';    // thousands separator: (comma) ',' = 1,000   or (decimal) '.' = 1.000
+            $this->code = 'USD'; // currency code: USD, CAD, EUR
+            $this->name = __('Dollar', 'event_espresso'); // Dollar
+            $this->plural = __('Dollars', 'event_espresso'); // Dollars
+            $this->sign = '$'; // currency sign: $
+            $this->sign_b4 = true; // currency sign before or after: $TRUE  or  FALSE$
+            $this->dec_plc = 2; // decimal places: 2 = 0.00  3 = 0.000
+            $this->dec_mrk = '.'; // decimal mark: (comma) ',' = 0,01   or (decimal) '.' = 0.01
+            $this->thsnds = ','; // thousands separator: (comma) ',' = 1,000   or (decimal) '.' = 1.000
         }
     }
 }
@@ -2414,8 +2414,8 @@ 
             $closing_a_tag = '';
             if (function_exists('get_privacy_policy_url')) {
                 $privacy_page_url = get_privacy_policy_url();
-                if (! empty($privacy_page_url)) {
-                    $opening_a_tag = '<a href="' . $privacy_page_url . '" target="_blank">';
+                if ( ! empty($privacy_page_url)) {
+                    $opening_a_tag = '<a href="'.$privacy_page_url.'" target="_blank">';
                     $closing_a_tag = '</a>';
                 }
             }
@@ -2630,7 +2630,7 @@ 
     public function log_file_name($reset = false)
     {
         if (empty($this->log_file_name) || $reset) {
-            $this->log_file_name = sanitize_key('espresso_log_' . md5(uniqid('', true))) . '.txt';
+            $this->log_file_name = sanitize_key('espresso_log_'.md5(uniqid('', true))).'.txt';
             EE_Config::instance()->update_espresso_config(false, false);
         }
         return $this->log_file_name;
@@ -2644,7 +2644,7 @@ 
     public function debug_file_name($reset = false)
     {
         if (empty($this->debug_file_name) || $reset) {
-            $this->debug_file_name = sanitize_key('espresso_debug_' . md5(uniqid('', true))) . '.txt';
+            $this->debug_file_name = sanitize_key('espresso_debug_'.md5(uniqid('', true))).'.txt';
             EE_Config::instance()->update_espresso_config(false, false);
         }
         return $this->debug_file_name;
@@ -2848,21 +2848,21 @@ 
         $this->use_google_maps = true;
         $this->google_map_api_key = '';
         // for event details pages (reg page)
-        $this->event_details_map_width = 585;            // ee_map_width_single
-        $this->event_details_map_height = 362;            // ee_map_height_single
-        $this->event_details_map_zoom = 14;            // ee_map_zoom_single
-        $this->event_details_display_nav = true;            // ee_map_nav_display_single
-        $this->event_details_nav_size = false;            // ee_map_nav_size_single
-        $this->event_details_control_type = 'default';        // ee_map_type_control_single
-        $this->event_details_map_align = 'center';            // ee_map_align_single
+        $this->event_details_map_width = 585; // ee_map_width_single
+        $this->event_details_map_height = 362; // ee_map_height_single
+        $this->event_details_map_zoom = 14; // ee_map_zoom_single
+        $this->event_details_display_nav = true; // ee_map_nav_display_single
+        $this->event_details_nav_size = false; // ee_map_nav_size_single
+        $this->event_details_control_type = 'default'; // ee_map_type_control_single
+        $this->event_details_map_align = 'center'; // ee_map_align_single
         // for event list pages
-        $this->event_list_map_width = 300;            // ee_map_width
-        $this->event_list_map_height = 185;        // ee_map_height
-        $this->event_list_map_zoom = 12;            // ee_map_zoom
-        $this->event_list_display_nav = false;        // ee_map_nav_display
-        $this->event_list_nav_size = true;            // ee_map_nav_size
-        $this->event_list_control_type = 'dropdown';        // ee_map_type_control
-        $this->event_list_map_align = 'center';            // ee_map_align
+        $this->event_list_map_width = 300; // ee_map_width
+        $this->event_list_map_height = 185; // ee_map_height
+        $this->event_list_map_zoom = 12; // ee_map_zoom
+        $this->event_list_display_nav = false; // ee_map_nav_display
+        $this->event_list_nav_size = true; // ee_map_nav_size
+        $this->event_list_control_type = 'dropdown'; // ee_map_type_control
+        $this->event_list_map_align = 'center'; // ee_map_align
     }
 }
 
@@ -3180,7 +3180,7 @@ 
      */
     public function max_input_vars_limit_check($input_count = 0)
     {
-        if (! empty($this->php->max_input_vars)
+        if ( ! empty($this->php->max_input_vars)
             && ($input_count >= $this->php->max_input_vars)
         ) {
             // check the server setting because the config value could be stale

core/espresso_definitions.php

Indentation +11 added lines, -11 removed lines

@@ -7,16 +7,16 @@ 
 define('EE_SUPPORT_EMAIL', 'support@eventespresso.com');
 // used to be DIRECTORY_SEPARATOR, but that caused issues on windows
 if (! defined('DS')) {
-    define('DS', '/');
+	define('DS', '/');
 }
 if (! defined('PS')) {
-    define('PS', PATH_SEPARATOR);
+	define('PS', PATH_SEPARATOR);
 }
 if (! defined('SP')) {
-    define('SP', ' ');
+	define('SP', ' ');
 }
 if (! defined('EENL')) {
-    define('EENL', "\n");
+	define('EENL', "\n");
 }
 // define the plugin directory and URL
 define('EE_PLUGIN_BASENAME', plugin_basename(EVENT_ESPRESSO_MAIN_FILE));
@@ -70,16 +70,16 @@ 
 define('EE_LANGUAGES_SAFE_DIR', EVENT_ESPRESSO_UPLOAD_DIR . 'languages/');
 // check for DOMPDF fonts in uploads
 if (file_exists(EVENT_ESPRESSO_UPLOAD_DIR . 'fonts/')) {
-    define('DOMPDF_FONT_DIR', EVENT_ESPRESSO_UPLOAD_DIR . 'fonts/');
+	define('DOMPDF_FONT_DIR', EVENT_ESPRESSO_UPLOAD_DIR . 'fonts/');
 }
 // ajax constants
 define(
-    'EE_FRONT_AJAX',
-    isset($_REQUEST['ee_front_ajax']) || isset($_REQUEST['data']['ee_front_ajax'])
+	'EE_FRONT_AJAX',
+	isset($_REQUEST['ee_front_ajax']) || isset($_REQUEST['data']['ee_front_ajax'])
 );
 define(
-    'EE_ADMIN_AJAX',
-    isset($_REQUEST['ee_admin_ajax']) || isset($_REQUEST['data']['ee_admin_ajax'])
+	'EE_ADMIN_AJAX',
+	isset($_REQUEST['ee_admin_ajax']) || isset($_REQUEST['data']['ee_admin_ajax'])
 );
 // just a handy constant occasionally needed for finding values representing infinity in the DB
 // you're better to use this than its straight value (currently -1) in case you ever
@@ -87,9 +87,9 @@ 
 define('EE_INF_IN_DB', -1);
 define('EE_INF', INF > (float) PHP_INT_MAX ? INF : PHP_INT_MAX);
 if (! defined('EE_DEBUG')) {
-    define('EE_DEBUG', false);
+	define('EE_DEBUG', false);
 }
 // for older WP versions
 if (! defined('MONTH_IN_SECONDS')) {
-    define('MONTH_IN_SECONDS', DAY_IN_SECONDS * 30);
+	define('MONTH_IN_SECONDS', DAY_IN_SECONDS * 30);
 }

Spacing +45 added lines, -45 removed lines

@@ -6,71 +6,71 @@ 
 define('EE_MIN_PHP_VER_RECOMMENDED', '5.6.32');
 define('EE_SUPPORT_EMAIL', 'support@eventespresso.com');
 // used to be DIRECTORY_SEPARATOR, but that caused issues on windows
-if (! defined('DS')) {
+if ( ! defined('DS')) {
     define('DS', '/');
 }
-if (! defined('PS')) {
+if ( ! defined('PS')) {
     define('PS', PATH_SEPARATOR);
 }
-if (! defined('SP')) {
+if ( ! defined('SP')) {
     define('SP', ' ');
 }
-if (! defined('EENL')) {
+if ( ! defined('EENL')) {
     define('EENL', "\n");
 }
 // define the plugin directory and URL
 define('EE_PLUGIN_BASENAME', plugin_basename(EVENT_ESPRESSO_MAIN_FILE));
-define('EE_PLUGIN_DIR_PATH', dirname(EVENT_ESPRESSO_MAIN_FILE) . '/');
+define('EE_PLUGIN_DIR_PATH', dirname(EVENT_ESPRESSO_MAIN_FILE).'/');
 define('EE_PLUGIN_DIR_URL', plugin_dir_url(EVENT_ESPRESSO_MAIN_FILE));
 // main root folder paths
-define('EE_ADMIN_PAGES', EE_PLUGIN_DIR_PATH . 'admin_pages/');
-define('EE_CORE', EE_PLUGIN_DIR_PATH . 'core/');
-define('EE_MODULES', EE_PLUGIN_DIR_PATH . 'modules/');
-define('EE_PUBLIC', EE_PLUGIN_DIR_PATH . 'public/');
-define('EE_SHORTCODES', EE_PLUGIN_DIR_PATH . 'shortcodes/');
-define('EE_WIDGETS', EE_PLUGIN_DIR_PATH . 'widgets/');
-define('EE_PAYMENT_METHODS', EE_PLUGIN_DIR_PATH . 'payment_methods/');
-define('EE_CAFF_PATH', EE_PLUGIN_DIR_PATH . 'caffeinated/');
+define('EE_ADMIN_PAGES', EE_PLUGIN_DIR_PATH.'admin_pages/');
+define('EE_CORE', EE_PLUGIN_DIR_PATH.'core/');
+define('EE_MODULES', EE_PLUGIN_DIR_PATH.'modules/');
+define('EE_PUBLIC', EE_PLUGIN_DIR_PATH.'public/');
+define('EE_SHORTCODES', EE_PLUGIN_DIR_PATH.'shortcodes/');
+define('EE_WIDGETS', EE_PLUGIN_DIR_PATH.'widgets/');
+define('EE_PAYMENT_METHODS', EE_PLUGIN_DIR_PATH.'payment_methods/');
+define('EE_CAFF_PATH', EE_PLUGIN_DIR_PATH.'caffeinated/');
 // core system paths
-define('EE_ADMIN', EE_CORE . 'admin/');
-define('EE_CPTS', EE_CORE . 'CPTs/');
-define('EE_CLASSES', EE_CORE . 'db_classes/');
-define('EE_INTERFACES', EE_CORE . 'interfaces/');
-define('EE_BUSINESS', EE_CORE . 'business/');
-define('EE_MODELS', EE_CORE . 'db_models/');
-define('EE_HELPERS', EE_CORE . 'helpers/');
-define('EE_LIBRARIES', EE_CORE . 'libraries/');
-define('EE_TEMPLATES', EE_CORE . 'templates/');
-define('EE_THIRD_PARTY', EE_CORE . 'third_party_libs/');
-define('EE_GLOBAL_ASSETS', EE_TEMPLATES . 'global_assets/');
-define('EE_FORM_SECTIONS', EE_LIBRARIES . 'form_sections/');
+define('EE_ADMIN', EE_CORE.'admin/');
+define('EE_CPTS', EE_CORE.'CPTs/');
+define('EE_CLASSES', EE_CORE.'db_classes/');
+define('EE_INTERFACES', EE_CORE.'interfaces/');
+define('EE_BUSINESS', EE_CORE.'business/');
+define('EE_MODELS', EE_CORE.'db_models/');
+define('EE_HELPERS', EE_CORE.'helpers/');
+define('EE_LIBRARIES', EE_CORE.'libraries/');
+define('EE_TEMPLATES', EE_CORE.'templates/');
+define('EE_THIRD_PARTY', EE_CORE.'third_party_libs/');
+define('EE_GLOBAL_ASSETS', EE_TEMPLATES.'global_assets/');
+define('EE_FORM_SECTIONS', EE_LIBRARIES.'form_sections/');
 // gateways
-define('EE_GATEWAYS', EE_MODULES . 'gateways/');
-define('EE_GATEWAYS_URL', EE_PLUGIN_DIR_URL . 'modules/gateways/');
+define('EE_GATEWAYS', EE_MODULES.'gateways/');
+define('EE_GATEWAYS_URL', EE_PLUGIN_DIR_URL.'modules/gateways/');
 // asset URL paths
-define('EE_TEMPLATES_URL', EE_PLUGIN_DIR_URL . 'core/templates/');
-define('EE_GLOBAL_ASSETS_URL', EE_TEMPLATES_URL . 'global_assets/');
-define('EE_IMAGES_URL', EE_GLOBAL_ASSETS_URL . 'images/');
-define('EE_THIRD_PARTY_URL', EE_PLUGIN_DIR_URL . 'core/third_party_libs/');
-define('EE_HELPERS_ASSETS', EE_PLUGIN_DIR_URL . 'core/helpers/assets/');
-define('EE_LIBRARIES_URL', EE_PLUGIN_DIR_URL . 'core/libraries/');
+define('EE_TEMPLATES_URL', EE_PLUGIN_DIR_URL.'core/templates/');
+define('EE_GLOBAL_ASSETS_URL', EE_TEMPLATES_URL.'global_assets/');
+define('EE_IMAGES_URL', EE_GLOBAL_ASSETS_URL.'images/');
+define('EE_THIRD_PARTY_URL', EE_PLUGIN_DIR_URL.'core/third_party_libs/');
+define('EE_HELPERS_ASSETS', EE_PLUGIN_DIR_URL.'core/helpers/assets/');
+define('EE_LIBRARIES_URL', EE_PLUGIN_DIR_URL.'core/libraries/');
 // define upload paths
 $uploads = wp_upload_dir();
 // define the uploads directory and URL
-define('EVENT_ESPRESSO_UPLOAD_DIR', $uploads['basedir'] . '/espresso/');
-define('EVENT_ESPRESSO_UPLOAD_URL', $uploads['baseurl'] . '/espresso/');
+define('EVENT_ESPRESSO_UPLOAD_DIR', $uploads['basedir'].'/espresso/');
+define('EVENT_ESPRESSO_UPLOAD_URL', $uploads['baseurl'].'/espresso/');
 // define the templates directory and URL
-define('EVENT_ESPRESSO_TEMPLATE_DIR', $uploads['basedir'] . '/espresso/templates/');
-define('EVENT_ESPRESSO_TEMPLATE_URL', $uploads['baseurl'] . '/espresso/templates/');
+define('EVENT_ESPRESSO_TEMPLATE_DIR', $uploads['basedir'].'/espresso/templates/');
+define('EVENT_ESPRESSO_TEMPLATE_URL', $uploads['baseurl'].'/espresso/templates/');
 // define the gateway directory and URL
-define('EVENT_ESPRESSO_GATEWAY_DIR', $uploads['basedir'] . '/espresso/gateways/');
-define('EVENT_ESPRESSO_GATEWAY_URL', $uploads['baseurl'] . '/espresso/gateways/');
+define('EVENT_ESPRESSO_GATEWAY_DIR', $uploads['basedir'].'/espresso/gateways/');
+define('EVENT_ESPRESSO_GATEWAY_URL', $uploads['baseurl'].'/espresso/gateways/');
 // languages folder/path
-define('EE_LANGUAGES_SAFE_LOC', '../' . 'uploads/' . 'espresso/languages/');
-define('EE_LANGUAGES_SAFE_DIR', EVENT_ESPRESSO_UPLOAD_DIR . 'languages/');
+define('EE_LANGUAGES_SAFE_LOC', '../'.'uploads/'.'espresso/languages/');
+define('EE_LANGUAGES_SAFE_DIR', EVENT_ESPRESSO_UPLOAD_DIR.'languages/');
 // check for DOMPDF fonts in uploads
-if (file_exists(EVENT_ESPRESSO_UPLOAD_DIR . 'fonts/')) {
-    define('DOMPDF_FONT_DIR', EVENT_ESPRESSO_UPLOAD_DIR . 'fonts/');
+if (file_exists(EVENT_ESPRESSO_UPLOAD_DIR.'fonts/')) {
+    define('DOMPDF_FONT_DIR', EVENT_ESPRESSO_UPLOAD_DIR.'fonts/');
 }
 // ajax constants
 define(
@@ -86,10 +86,10 @@ 
 // want to change its default value! or find when -1 means infinity
 define('EE_INF_IN_DB', -1);
 define('EE_INF', INF > (float) PHP_INT_MAX ? INF : PHP_INT_MAX);
-if (! defined('EE_DEBUG')) {
+if ( ! defined('EE_DEBUG')) {
     define('EE_DEBUG', false);
 }
 // for older WP versions
-if (! defined('MONTH_IN_SECONDS')) {
+if ( ! defined('MONTH_IN_SECONDS')) {
     define('MONTH_IN_SECONDS', DAY_IN_SECONDS * 30);
 }

core/admin/EE_Admin.core.php

Indentation +1025 added lines, -1025 removed lines

@@ -20,488 +20,488 @@ 
 final class EE_Admin implements InterminableInterface
 {
 
-    /**
-     * @var EE_Admin $_instance
-     */
-    private static $_instance;
-
-    /**
-     * @var PersistentAdminNoticeManager $persistent_admin_notice_manager
-     */
-    private $persistent_admin_notice_manager;
-
-    /**
-     * @var LoaderInterface
-     */
-    protected $loader;
-
-    /**
-     * @singleton method used to instantiate class object
-     * @return EE_Admin
-     * @throws EE_Error
-     */
-    public static function instance()
-    {
-        // check if class object is instantiated
-        if (! self::$_instance instanceof EE_Admin) {
-            self::$_instance = new self();
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * @return EE_Admin
-     * @throws EE_Error
-     */
-    public static function reset()
-    {
-        self::$_instance = null;
-        return self::instance();
-    }
-
-
-    /**
-     * class constructor
-     *
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    protected function __construct()
-    {
-        // define global EE_Admin constants
-        $this->_define_all_constants();
-        // set autoloaders for our admin page classes based on included path information
-        EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder(EE_ADMIN);
-        // admin hooks
-        add_filter('plugin_action_links', array($this, 'filter_plugin_actions'), 10, 2);
-        // load EE_Request_Handler early
-        add_action('AHEE__EE_System__core_loaded_and_ready', array($this, 'get_request'));
-        add_action('AHEE__EE_System__initialize_last', array($this, 'init'));
-        add_action('AHEE__EE_Admin_Page__route_admin_request', array($this, 'route_admin_request'), 100, 2);
-        add_action('wp_loaded', array($this, 'wp_loaded'), 100);
-        add_action('admin_init', array($this, 'admin_init'), 100);
-        add_action('admin_enqueue_scripts', array($this, 'enqueue_admin_scripts'), 20);
-        add_action('admin_notices', array($this, 'display_admin_notices'), 10);
-        add_action('network_admin_notices', array($this, 'display_admin_notices'), 10);
-        add_filter('pre_update_option', array($this, 'check_for_invalid_datetime_formats'), 100, 2);
-        add_filter('admin_footer_text', array($this, 'espresso_admin_footer'));
-        add_action('load-plugins.php', array($this, 'hookIntoWpPluginsPage'));
-        add_action('display_post_states', array($this, 'displayStateForCriticalPages'), 10, 2);
-        add_filter('plugin_row_meta', array($this, 'addLinksToPluginRowMeta'), 10, 2);
-        // reset Environment config (we only do this on admin page loads);
-        EE_Registry::instance()->CFG->environment->recheck_values();
-        do_action('AHEE__EE_Admin__loaded');
-    }
-
-
-    /**
-     * _define_all_constants
-     * define constants that are set globally for all admin pages
-     *
-     * @return void
-     */
-    private function _define_all_constants()
-    {
-        if (! defined('EE_ADMIN_URL')) {
-            define('EE_ADMIN_URL', EE_PLUGIN_DIR_URL . 'core/admin/');
-            define('EE_ADMIN_PAGES_URL', EE_PLUGIN_DIR_URL . 'admin_pages/');
-            define('EE_ADMIN_TEMPLATE', EE_ADMIN . 'templates/');
-            define('WP_ADMIN_PATH', ABSPATH . 'wp-admin/');
-            define('WP_AJAX_URL', admin_url('admin-ajax.php'));
-        }
-    }
-
-
-    /**
-     * filter_plugin_actions - adds links to the Plugins page listing
-     *
-     * @param    array  $links
-     * @param    string $plugin
-     * @return    array
-     */
-    public function filter_plugin_actions($links, $plugin)
-    {
-        // set $main_file in stone
-        static $main_file;
-        // if $main_file is not set yet
-        if (! $main_file) {
-            $main_file = plugin_basename(EVENT_ESPRESSO_MAIN_FILE);
-        }
-        if ($plugin === $main_file) {
-            // compare current plugin to this one
-            if (EE_Maintenance_Mode::instance()->level() === EE_Maintenance_Mode::level_2_complete_maintenance) {
-                $maintenance_link = '<a href="admin.php?page=espresso_maintenance_settings"'
-                                    . ' title="Event Espresso is in maintenance mode.  Click this link to learn why.">'
-                                    . esc_html__('Maintenance Mode Active', 'event_espresso')
-                                    . '</a>';
-                array_unshift($links, $maintenance_link);
-            } else {
-                $org_settings_link = '<a href="admin.php?page=espresso_general_settings">'
-                                     . esc_html__('Settings', 'event_espresso')
-                                     . '</a>';
-                $events_link = '<a href="admin.php?page=espresso_events">'
-                               . esc_html__('Events', 'event_espresso')
-                               . '</a>';
-                // add before other links
-                array_unshift($links, $org_settings_link, $events_link);
-            }
-        }
-        return $links;
-    }
-
-
-    /**
-     * _get_request
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function get_request()
-    {
-        EE_Registry::instance()->load_core('Request_Handler');
-    }
-
-
-    /**
-     * hide_admin_pages_except_maintenance_mode
-     *
-     * @param array $admin_page_folder_names
-     * @return array
-     */
-    public function hide_admin_pages_except_maintenance_mode($admin_page_folder_names = array())
-    {
-        return array(
-            'maintenance' => EE_ADMIN_PAGES . 'maintenance/',
-            'about'       => EE_ADMIN_PAGES . 'about/',
-            'support'     => EE_ADMIN_PAGES . 'support/',
-        );
-    }
-
-
-    /**
-     * init- should fire after shortcode, module,  addon, other plugin (default priority), and even
-     * EE_Front_Controller's init phases have run
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws ServiceNotFoundException
-     */
-    public function init()
-    {
-        // only enable most of the EE_Admin IF we're not in full maintenance mode
-        if (EE_Maintenance_Mode::instance()->models_can_query()) {
-            $this->initModelsReady();
-        }
-        // run the admin page factory but ONLY if we are doing an ee admin ajax request
-        if (! defined('DOING_AJAX') || EE_ADMIN_AJAX) {
-            try {
-                // this loads the controller for the admin pages which will setup routing etc
-                EE_Registry::instance()->load_core('Admin_Page_Loader');
-            } catch (EE_Error $e) {
-                $e->get_error();
-            }
-        }
-        add_filter('content_save_pre', array($this, 'its_eSpresso'), 10, 1);
-        // make sure our CPTs and custom taxonomy metaboxes get shown for first time users
-        add_action('admin_head', array($this, 'enable_hidden_ee_nav_menu_metaboxes'), 10);
-        add_action('admin_head', array($this, 'register_custom_nav_menu_boxes'), 10);
-        // exclude EE critical pages from all nav menus and wp_list_pages
-        add_filter('nav_menu_meta_box_object', array($this, 'remove_pages_from_nav_menu'), 10);
-    }
-
-
-    /**
-     * Gets the loader (and if it wasn't previously set, sets it)
-     * @return LoaderInterface
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function getLoader()
-    {
-        if (! $this->loader instanceof LoaderInterface) {
-            $this->loader = LoaderFactory::getLoader();
-        }
-        return $this->loader;
-    }
-
-
-    /**
-     * Method that's fired on admin requests (including admin ajax) but only when the models are usable
-     * (ie, the site isn't in maintenance mode)
-     * @since 4.9.63.p
-     * @return void
-     */
-    protected function initModelsReady()
-    {
-        // ok so we want to enable the entire admin
-        $this->persistent_admin_notice_manager = $this->getLoader()->getShared(
-            'EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
-        );
-        $this->persistent_admin_notice_manager->setReturnUrl(
-            EE_Admin_Page::add_query_args_and_nonce(
-                array(
-                    'page'   => EE_Registry::instance()->REQ->get('page', ''),
-                    'action' => EE_Registry::instance()->REQ->get('action', ''),
-                ),
-                EE_ADMIN_URL
-            )
-        );
-        $this->maybeSetDatetimeWarningNotice();
-        // at a glance dashboard widget
-        add_filter('dashboard_glance_items', array($this, 'dashboard_glance_items'), 10);
-        // filter for get_edit_post_link used on comments for custom post types
-        add_filter('get_edit_post_link', array($this, 'modify_edit_post_link'), 10, 2);
-    }
-
-
-    /**
-     *    get_persistent_admin_notices
-     *
-     * @access    public
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function maybeSetDatetimeWarningNotice()
-    {
-        // add dismissable notice for datetime changes.  Only valid if site does not have a timezone_string set.
-        // @todo This needs to stay in core for a bit to catch anyone upgrading from a version without this to a version
-        // with this.  But after enough time (indeterminate at this point) we can just remove this notice.
-        // this was added with https://events.codebasehq.com/projects/event-espresso/tickets/10626
-        if (apply_filters('FHEE__EE_Admin__maybeSetDatetimeWarningNotice', true)
-            && ! get_option('timezone_string')
-            && EEM_Event::instance()->count() > 0
-        ) {
-            new PersistentAdminNotice(
-                'datetime_fix_notice',
-                sprintf(
-                    esc_html__(
-                        '%1$sImportant announcement related to your install of Event Espresso%2$s: There are some changes made to your site that could affect how dates display for your events and other related items with dates and times.  Read more about it %3$shere%4$s. If your dates and times are displaying incorrectly (incorrect offset), you can fix it using the tool on %5$sthis page%4$s.',
-                        'event_espresso'
-                    ),
-                    '<strong>',
-                    '</strong>',
-                    '<a href="https://eventespresso.com/2017/08/important-upcoming-changes-dates-times">',
-                    '</a>',
-                    '<a href="' . EE_Admin_Page::add_query_args_and_nonce(
-                        array(
-                            'page'   => 'espresso_maintenance_settings',
-                            'action' => 'datetime_tools',
-                        ),
-                        admin_url('admin.php')
-                    ) . '">'
-                ),
-                false,
-                'manage_options',
-                'datetime_fix_persistent_notice'
-            );
-        }
-    }
-
-
-    /**
-     * this simply hooks into the nav menu setup of pages metabox and makes sure that we remove EE critical pages from
-     * the list of options. the wp function "wp_nav_menu_item_post_type_meta_box" found in
-     * wp-admin/includes/nav-menu.php looks for the "_default_query" property on the post_type object and it uses that
-     * to override any queries found in the existing query for the given post type.  Note that _default_query is not a
-     * normal property on the post_type object.  It's found ONLY in this particular context.
-     *
-     * @param WP_Post $post_type WP post type object
-     * @return WP_Post
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function remove_pages_from_nav_menu($post_type)
-    {
-        // if this isn't the "pages" post type let's get out
-        if ($post_type->name !== 'page') {
-            return $post_type;
-        }
-        $critical_pages = EE_Registry::instance()->CFG->core->get_critical_pages_array();
-        $post_type->_default_query = array(
-            'post__not_in' => $critical_pages,
-        );
-        return $post_type;
-    }
-
-
-    /**
-     * WP by default only shows three metaboxes in "nav-menus.php" for first times users.  We want to make sure our
-     * metaboxes get shown as well
-     *
-     * @return void
-     */
-    public function enable_hidden_ee_nav_menu_metaboxes()
-    {
-        global $wp_meta_boxes, $pagenow;
-        if (! is_array($wp_meta_boxes) || $pagenow !== 'nav-menus.php') {
-            return;
-        }
-        $user = wp_get_current_user();
-        // has this been done yet?
-        if (get_user_option('ee_nav_menu_initialized', $user->ID)) {
-            return;
-        }
-
-        $hidden_meta_boxes = get_user_option('metaboxhidden_nav-menus', $user->ID);
-        $initial_meta_boxes = apply_filters(
-            'FHEE__EE_Admin__enable_hidden_ee_nav_menu_boxes__initial_meta_boxes',
-            array(
-                'nav-menu-theme-locations',
-                'add-page',
-                'add-custom-links',
-                'add-category',
-                'add-espresso_events',
-                'add-espresso_venues',
-                'add-espresso_event_categories',
-                'add-espresso_venue_categories',
-                'add-post-type-post',
-                'add-post-type-page',
-            )
-        );
-
-        if (is_array($hidden_meta_boxes)) {
-            foreach ($hidden_meta_boxes as $key => $meta_box_id) {
-                if (in_array($meta_box_id, $initial_meta_boxes, true)) {
-                    unset($hidden_meta_boxes[ $key ]);
-                }
-            }
-        }
-        update_user_option($user->ID, 'metaboxhidden_nav-menus', $hidden_meta_boxes, true);
-        update_user_option($user->ID, 'ee_nav_menu_initialized', 1, true);
-    }
-
-
-    /**
-     * This method simply registers custom nav menu boxes for "nav_menus.php route"
-     * Currently EE is using this to make sure there are menu options for our CPT archive page routes.
-     *
-     * @todo   modify this so its more dynamic and automatic for all ee CPTs and setups and can also be hooked into by
-     *         addons etc.
-     * @return void
-     */
-    public function register_custom_nav_menu_boxes()
-    {
-        add_meta_box(
-            'add-extra-nav-menu-pages',
-            esc_html__('Event Espresso Pages', 'event_espresso'),
-            array($this, 'ee_cpt_archive_pages'),
-            'nav-menus',
-            'side',
-            'core'
-        );
-    }
-
-
-    /**
-     * Use this to edit the post link for our cpts so that the edit link points to the correct page.
-     *
-     * @since   4.3.0
-     * @param string $link the original link generated by wp
-     * @param int    $id   post id
-     * @return string  the (maybe) modified link
-     */
-    public function modify_edit_post_link($link, $id)
-    {
-        if (! $post = get_post($id)) {
-            return $link;
-        }
-        if ($post->post_type === 'espresso_attendees') {
-            $query_args = array(
-                'action' => 'edit_attendee',
-                'post'   => $id,
-            );
-            return EEH_URL::add_query_args_and_nonce(
-                $query_args,
-                admin_url('admin.php?page=espresso_registrations')
-            );
-        }
-        return $link;
-    }
-
-
-    public function ee_cpt_archive_pages()
-    {
-        global $nav_menu_selected_id;
-        $db_fields = false;
-        $walker = new Walker_Nav_Menu_Checklist($db_fields);
-        $current_tab = 'event-archives';
-        $removed_args = array(
-            'action',
-            'customlink-tab',
-            'edit-menu-item',
-            'menu-item',
-            'page-tab',
-            '_wpnonce',
-        );
-        ?>
+	/**
+	 * @var EE_Admin $_instance
+	 */
+	private static $_instance;
+
+	/**
+	 * @var PersistentAdminNoticeManager $persistent_admin_notice_manager
+	 */
+	private $persistent_admin_notice_manager;
+
+	/**
+	 * @var LoaderInterface
+	 */
+	protected $loader;
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @return EE_Admin
+	 * @throws EE_Error
+	 */
+	public static function instance()
+	{
+		// check if class object is instantiated
+		if (! self::$_instance instanceof EE_Admin) {
+			self::$_instance = new self();
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * @return EE_Admin
+	 * @throws EE_Error
+	 */
+	public static function reset()
+	{
+		self::$_instance = null;
+		return self::instance();
+	}
+
+
+	/**
+	 * class constructor
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	protected function __construct()
+	{
+		// define global EE_Admin constants
+		$this->_define_all_constants();
+		// set autoloaders for our admin page classes based on included path information
+		EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder(EE_ADMIN);
+		// admin hooks
+		add_filter('plugin_action_links', array($this, 'filter_plugin_actions'), 10, 2);
+		// load EE_Request_Handler early
+		add_action('AHEE__EE_System__core_loaded_and_ready', array($this, 'get_request'));
+		add_action('AHEE__EE_System__initialize_last', array($this, 'init'));
+		add_action('AHEE__EE_Admin_Page__route_admin_request', array($this, 'route_admin_request'), 100, 2);
+		add_action('wp_loaded', array($this, 'wp_loaded'), 100);
+		add_action('admin_init', array($this, 'admin_init'), 100);
+		add_action('admin_enqueue_scripts', array($this, 'enqueue_admin_scripts'), 20);
+		add_action('admin_notices', array($this, 'display_admin_notices'), 10);
+		add_action('network_admin_notices', array($this, 'display_admin_notices'), 10);
+		add_filter('pre_update_option', array($this, 'check_for_invalid_datetime_formats'), 100, 2);
+		add_filter('admin_footer_text', array($this, 'espresso_admin_footer'));
+		add_action('load-plugins.php', array($this, 'hookIntoWpPluginsPage'));
+		add_action('display_post_states', array($this, 'displayStateForCriticalPages'), 10, 2);
+		add_filter('plugin_row_meta', array($this, 'addLinksToPluginRowMeta'), 10, 2);
+		// reset Environment config (we only do this on admin page loads);
+		EE_Registry::instance()->CFG->environment->recheck_values();
+		do_action('AHEE__EE_Admin__loaded');
+	}
+
+
+	/**
+	 * _define_all_constants
+	 * define constants that are set globally for all admin pages
+	 *
+	 * @return void
+	 */
+	private function _define_all_constants()
+	{
+		if (! defined('EE_ADMIN_URL')) {
+			define('EE_ADMIN_URL', EE_PLUGIN_DIR_URL . 'core/admin/');
+			define('EE_ADMIN_PAGES_URL', EE_PLUGIN_DIR_URL . 'admin_pages/');
+			define('EE_ADMIN_TEMPLATE', EE_ADMIN . 'templates/');
+			define('WP_ADMIN_PATH', ABSPATH . 'wp-admin/');
+			define('WP_AJAX_URL', admin_url('admin-ajax.php'));
+		}
+	}
+
+
+	/**
+	 * filter_plugin_actions - adds links to the Plugins page listing
+	 *
+	 * @param    array  $links
+	 * @param    string $plugin
+	 * @return    array
+	 */
+	public function filter_plugin_actions($links, $plugin)
+	{
+		// set $main_file in stone
+		static $main_file;
+		// if $main_file is not set yet
+		if (! $main_file) {
+			$main_file = plugin_basename(EVENT_ESPRESSO_MAIN_FILE);
+		}
+		if ($plugin === $main_file) {
+			// compare current plugin to this one
+			if (EE_Maintenance_Mode::instance()->level() === EE_Maintenance_Mode::level_2_complete_maintenance) {
+				$maintenance_link = '<a href="admin.php?page=espresso_maintenance_settings"'
+									. ' title="Event Espresso is in maintenance mode.  Click this link to learn why.">'
+									. esc_html__('Maintenance Mode Active', 'event_espresso')
+									. '</a>';
+				array_unshift($links, $maintenance_link);
+			} else {
+				$org_settings_link = '<a href="admin.php?page=espresso_general_settings">'
+									 . esc_html__('Settings', 'event_espresso')
+									 . '</a>';
+				$events_link = '<a href="admin.php?page=espresso_events">'
+							   . esc_html__('Events', 'event_espresso')
+							   . '</a>';
+				// add before other links
+				array_unshift($links, $org_settings_link, $events_link);
+			}
+		}
+		return $links;
+	}
+
+
+	/**
+	 * _get_request
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function get_request()
+	{
+		EE_Registry::instance()->load_core('Request_Handler');
+	}
+
+
+	/**
+	 * hide_admin_pages_except_maintenance_mode
+	 *
+	 * @param array $admin_page_folder_names
+	 * @return array
+	 */
+	public function hide_admin_pages_except_maintenance_mode($admin_page_folder_names = array())
+	{
+		return array(
+			'maintenance' => EE_ADMIN_PAGES . 'maintenance/',
+			'about'       => EE_ADMIN_PAGES . 'about/',
+			'support'     => EE_ADMIN_PAGES . 'support/',
+		);
+	}
+
+
+	/**
+	 * init- should fire after shortcode, module,  addon, other plugin (default priority), and even
+	 * EE_Front_Controller's init phases have run
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws ServiceNotFoundException
+	 */
+	public function init()
+	{
+		// only enable most of the EE_Admin IF we're not in full maintenance mode
+		if (EE_Maintenance_Mode::instance()->models_can_query()) {
+			$this->initModelsReady();
+		}
+		// run the admin page factory but ONLY if we are doing an ee admin ajax request
+		if (! defined('DOING_AJAX') || EE_ADMIN_AJAX) {
+			try {
+				// this loads the controller for the admin pages which will setup routing etc
+				EE_Registry::instance()->load_core('Admin_Page_Loader');
+			} catch (EE_Error $e) {
+				$e->get_error();
+			}
+		}
+		add_filter('content_save_pre', array($this, 'its_eSpresso'), 10, 1);
+		// make sure our CPTs and custom taxonomy metaboxes get shown for first time users
+		add_action('admin_head', array($this, 'enable_hidden_ee_nav_menu_metaboxes'), 10);
+		add_action('admin_head', array($this, 'register_custom_nav_menu_boxes'), 10);
+		// exclude EE critical pages from all nav menus and wp_list_pages
+		add_filter('nav_menu_meta_box_object', array($this, 'remove_pages_from_nav_menu'), 10);
+	}
+
+
+	/**
+	 * Gets the loader (and if it wasn't previously set, sets it)
+	 * @return LoaderInterface
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function getLoader()
+	{
+		if (! $this->loader instanceof LoaderInterface) {
+			$this->loader = LoaderFactory::getLoader();
+		}
+		return $this->loader;
+	}
+
+
+	/**
+	 * Method that's fired on admin requests (including admin ajax) but only when the models are usable
+	 * (ie, the site isn't in maintenance mode)
+	 * @since 4.9.63.p
+	 * @return void
+	 */
+	protected function initModelsReady()
+	{
+		// ok so we want to enable the entire admin
+		$this->persistent_admin_notice_manager = $this->getLoader()->getShared(
+			'EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
+		);
+		$this->persistent_admin_notice_manager->setReturnUrl(
+			EE_Admin_Page::add_query_args_and_nonce(
+				array(
+					'page'   => EE_Registry::instance()->REQ->get('page', ''),
+					'action' => EE_Registry::instance()->REQ->get('action', ''),
+				),
+				EE_ADMIN_URL
+			)
+		);
+		$this->maybeSetDatetimeWarningNotice();
+		// at a glance dashboard widget
+		add_filter('dashboard_glance_items', array($this, 'dashboard_glance_items'), 10);
+		// filter for get_edit_post_link used on comments for custom post types
+		add_filter('get_edit_post_link', array($this, 'modify_edit_post_link'), 10, 2);
+	}
+
+
+	/**
+	 *    get_persistent_admin_notices
+	 *
+	 * @access    public
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function maybeSetDatetimeWarningNotice()
+	{
+		// add dismissable notice for datetime changes.  Only valid if site does not have a timezone_string set.
+		// @todo This needs to stay in core for a bit to catch anyone upgrading from a version without this to a version
+		// with this.  But after enough time (indeterminate at this point) we can just remove this notice.
+		// this was added with https://events.codebasehq.com/projects/event-espresso/tickets/10626
+		if (apply_filters('FHEE__EE_Admin__maybeSetDatetimeWarningNotice', true)
+			&& ! get_option('timezone_string')
+			&& EEM_Event::instance()->count() > 0
+		) {
+			new PersistentAdminNotice(
+				'datetime_fix_notice',
+				sprintf(
+					esc_html__(
+						'%1$sImportant announcement related to your install of Event Espresso%2$s: There are some changes made to your site that could affect how dates display for your events and other related items with dates and times.  Read more about it %3$shere%4$s. If your dates and times are displaying incorrectly (incorrect offset), you can fix it using the tool on %5$sthis page%4$s.',
+						'event_espresso'
+					),
+					'<strong>',
+					'</strong>',
+					'<a href="https://eventespresso.com/2017/08/important-upcoming-changes-dates-times">',
+					'</a>',
+					'<a href="' . EE_Admin_Page::add_query_args_and_nonce(
+						array(
+							'page'   => 'espresso_maintenance_settings',
+							'action' => 'datetime_tools',
+						),
+						admin_url('admin.php')
+					) . '">'
+				),
+				false,
+				'manage_options',
+				'datetime_fix_persistent_notice'
+			);
+		}
+	}
+
+
+	/**
+	 * this simply hooks into the nav menu setup of pages metabox and makes sure that we remove EE critical pages from
+	 * the list of options. the wp function "wp_nav_menu_item_post_type_meta_box" found in
+	 * wp-admin/includes/nav-menu.php looks for the "_default_query" property on the post_type object and it uses that
+	 * to override any queries found in the existing query for the given post type.  Note that _default_query is not a
+	 * normal property on the post_type object.  It's found ONLY in this particular context.
+	 *
+	 * @param WP_Post $post_type WP post type object
+	 * @return WP_Post
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function remove_pages_from_nav_menu($post_type)
+	{
+		// if this isn't the "pages" post type let's get out
+		if ($post_type->name !== 'page') {
+			return $post_type;
+		}
+		$critical_pages = EE_Registry::instance()->CFG->core->get_critical_pages_array();
+		$post_type->_default_query = array(
+			'post__not_in' => $critical_pages,
+		);
+		return $post_type;
+	}
+
+
+	/**
+	 * WP by default only shows three metaboxes in "nav-menus.php" for first times users.  We want to make sure our
+	 * metaboxes get shown as well
+	 *
+	 * @return void
+	 */
+	public function enable_hidden_ee_nav_menu_metaboxes()
+	{
+		global $wp_meta_boxes, $pagenow;
+		if (! is_array($wp_meta_boxes) || $pagenow !== 'nav-menus.php') {
+			return;
+		}
+		$user = wp_get_current_user();
+		// has this been done yet?
+		if (get_user_option('ee_nav_menu_initialized', $user->ID)) {
+			return;
+		}
+
+		$hidden_meta_boxes = get_user_option('metaboxhidden_nav-menus', $user->ID);
+		$initial_meta_boxes = apply_filters(
+			'FHEE__EE_Admin__enable_hidden_ee_nav_menu_boxes__initial_meta_boxes',
+			array(
+				'nav-menu-theme-locations',
+				'add-page',
+				'add-custom-links',
+				'add-category',
+				'add-espresso_events',
+				'add-espresso_venues',
+				'add-espresso_event_categories',
+				'add-espresso_venue_categories',
+				'add-post-type-post',
+				'add-post-type-page',
+			)
+		);
+
+		if (is_array($hidden_meta_boxes)) {
+			foreach ($hidden_meta_boxes as $key => $meta_box_id) {
+				if (in_array($meta_box_id, $initial_meta_boxes, true)) {
+					unset($hidden_meta_boxes[ $key ]);
+				}
+			}
+		}
+		update_user_option($user->ID, 'metaboxhidden_nav-menus', $hidden_meta_boxes, true);
+		update_user_option($user->ID, 'ee_nav_menu_initialized', 1, true);
+	}
+
+
+	/**
+	 * This method simply registers custom nav menu boxes for "nav_menus.php route"
+	 * Currently EE is using this to make sure there are menu options for our CPT archive page routes.
+	 *
+	 * @todo   modify this so its more dynamic and automatic for all ee CPTs and setups and can also be hooked into by
+	 *         addons etc.
+	 * @return void
+	 */
+	public function register_custom_nav_menu_boxes()
+	{
+		add_meta_box(
+			'add-extra-nav-menu-pages',
+			esc_html__('Event Espresso Pages', 'event_espresso'),
+			array($this, 'ee_cpt_archive_pages'),
+			'nav-menus',
+			'side',
+			'core'
+		);
+	}
+
+
+	/**
+	 * Use this to edit the post link for our cpts so that the edit link points to the correct page.
+	 *
+	 * @since   4.3.0
+	 * @param string $link the original link generated by wp
+	 * @param int    $id   post id
+	 * @return string  the (maybe) modified link
+	 */
+	public function modify_edit_post_link($link, $id)
+	{
+		if (! $post = get_post($id)) {
+			return $link;
+		}
+		if ($post->post_type === 'espresso_attendees') {
+			$query_args = array(
+				'action' => 'edit_attendee',
+				'post'   => $id,
+			);
+			return EEH_URL::add_query_args_and_nonce(
+				$query_args,
+				admin_url('admin.php?page=espresso_registrations')
+			);
+		}
+		return $link;
+	}
+
+
+	public function ee_cpt_archive_pages()
+	{
+		global $nav_menu_selected_id;
+		$db_fields = false;
+		$walker = new Walker_Nav_Menu_Checklist($db_fields);
+		$current_tab = 'event-archives';
+		$removed_args = array(
+			'action',
+			'customlink-tab',
+			'edit-menu-item',
+			'menu-item',
+			'page-tab',
+			'_wpnonce',
+		);
+		?>
         <div id="posttype-extra-nav-menu-pages" class="posttypediv">
             <ul id="posttype-extra-nav-menu-pages-tabs" class="posttype-tabs add-menu-item-tabs">
                 <li <?php echo('event-archives' === $current_tab ? ' class="tabs"' : ''); ?>>
                     <a class="nav-tab-link" data-type="tabs-panel-posttype-extra-nav-menu-pages-event-archives"
                        href="<?php
-                        if ($nav_menu_selected_id) {
-                            echo esc_url(
-                                add_query_arg(
-                                    'extra-nav-menu-pages-tab',
-                                    'event-archives',
-                                    remove_query_arg($removed_args)
-                                )
-                            );
-                        }
-                        ?>#tabs-panel-posttype-extra-nav-menu-pages-event-archives">
+						if ($nav_menu_selected_id) {
+							echo esc_url(
+								add_query_arg(
+									'extra-nav-menu-pages-tab',
+									'event-archives',
+									remove_query_arg($removed_args)
+								)
+							);
+						}
+						?>#tabs-panel-posttype-extra-nav-menu-pages-event-archives">
                         <?php esc_html_e('Event Archive Pages', 'event_espresso'); ?>
                     </a>
                 </li>
             </ul><!-- .posttype-tabs -->
 
             <div id="tabs-panel-posttype-extra-nav-menu-pages-event-archives" class="tabs-panel <?php
-            echo('event-archives' === $current_tab ? 'tabs-panel-active' : 'tabs-panel-inactive');
-            ?>">
+			echo('event-archives' === $current_tab ? 'tabs-panel-active' : 'tabs-panel-inactive');
+			?>">
                 <ul id="extra-nav-menu-pageschecklist-event-archives" class="categorychecklist form-no-clear">
                     <?php
-                    $pages = $this->_get_extra_nav_menu_pages_items();
-                    $args['walker'] = $walker;
-                    echo walk_nav_menu_tree(
-                        array_map(
-                            array($this, '_setup_extra_nav_menu_pages_items'),
-                            $pages
-                        ),
-                        0,
-                        (object) $args
-                    );
-                    ?>
+					$pages = $this->_get_extra_nav_menu_pages_items();
+					$args['walker'] = $walker;
+					echo walk_nav_menu_tree(
+						array_map(
+							array($this, '_setup_extra_nav_menu_pages_items'),
+							$pages
+						),
+						0,
+						(object) $args
+					);
+					?>
                 </ul>
             </div><!-- /.tabs-panel -->
 
             <p class="button-controls">
                 <span class="list-controls">
                     <a href="<?php
-                             echo esc_url(
-                                 add_query_arg(
-                                     array(
-                                         'extra-nav-menu-pages-tab' => 'event-archives',
-                                         'selectall'                => 1,
-                                     ),
-                                     remove_query_arg($removed_args)
-                                 )
-                             );
-                        ?>#posttype-extra-nav-menu-pages" class="select-all"><?php esc_html_e('Select All', 'event_espresso'); ?></a>
+							 echo esc_url(
+								 add_query_arg(
+									 array(
+										 'extra-nav-menu-pages-tab' => 'event-archives',
+										 'selectall'                => 1,
+									 ),
+									 remove_query_arg($removed_args)
+								 )
+							 );
+						?>#posttype-extra-nav-menu-pages" class="select-all"><?php esc_html_e('Select All', 'event_espresso'); ?></a>
                 </span>
                 <span class="add-to-menu">
                     <input type="submit"<?php wp_nav_menu_disabled_check($nav_menu_selected_id); ?>
@@ -514,566 +514,566 @@ 
 
         </div><!-- /.posttypediv -->
         <?php
-    }
-
-
-    /**
-     * Returns an array of event archive nav items.
-     *
-     * @todo  for now this method is just in place so when it gets abstracted further we can substitute in whatever
-     *        method we use for getting the extra nav menu items
-     * @return array
-     */
-    private function _get_extra_nav_menu_pages_items()
-    {
-        $menuitems[] = array(
-            'title'       => esc_html__('Event List', 'event_espresso'),
-            'url'         => get_post_type_archive_link('espresso_events'),
-            'description' => esc_html__('Archive page for all events.', 'event_espresso'),
-        );
-        return apply_filters('FHEE__EE_Admin__get_extra_nav_menu_pages_items', $menuitems);
-    }
-
-
-    /**
-     * Setup nav menu walker item for usage in the event archive nav menu metabox.  It receives a menu_item array with
-     * the properties and converts it to the menu item object.
-     *
-     * @see wp_setup_nav_menu_item() in wp-includes/nav-menu.php
-     * @param $menu_item_values
-     * @return stdClass
-     */
-    private function _setup_extra_nav_menu_pages_items($menu_item_values)
-    {
-        $menu_item = new stdClass();
-        $keys = array(
-            'ID'               => 0,
-            'db_id'            => 0,
-            'menu_item_parent' => 0,
-            'object_id'        => -1,
-            'post_parent'      => 0,
-            'type'             => 'custom',
-            'object'           => '',
-            'type_label'       => esc_html__('Extra Nav Menu Item', 'event_espresso'),
-            'title'            => '',
-            'url'              => '',
-            'target'           => '',
-            'attr_title'       => '',
-            'description'      => '',
-            'classes'          => array(),
-            'xfn'              => '',
-        );
-
-        foreach ($keys as $key => $value) {
-            $menu_item->{$key} = isset($menu_item_values[ $key ]) ? $menu_item_values[ $key ] : $value;
-        }
-        return $menu_item;
-    }
-
-
-    /**
-     * This is the action hook for the AHEE__EE_Admin_Page__route_admin_request hook that fires off right before an
-     * EE_Admin_Page route is called.
-     *
-     * @return void
-     */
-    public function route_admin_request()
-    {
-    }
-
-
-    /**
-     * wp_loaded should fire on the WordPress wp_loaded hook.  This fires on a VERY late priority.
-     *
-     * @return void
-     */
-    public function wp_loaded()
-    {
-    }
-
-
-    /**
-     * admin_init
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function admin_init()
-    {
-        /**
-         * our cpt models must be instantiated on WordPress post processing routes (wp-admin/post.php),
-         * so any hooking into core WP routes is taken care of.  So in this next few lines of code:
-         * - check if doing post processing.
-         * - check if doing post processing of one of EE CPTs
-         * - instantiate the corresponding EE CPT model for the post_type being processed.
-         */
-        if (isset($_POST['action'], $_POST['post_type']) && $_POST['action'] === 'editpost') {
-            /** @var EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions $custom_post_types */
-            $custom_post_types = $this->getLoader()->getShared(
-                'EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions'
-            );
-            $custom_post_types->getCustomPostTypeModels($_POST['post_type']);
-        }
-
-
-        /**
-         * This code excludes EE critical pages anywhere `wp_dropdown_pages` is used to create a dropdown for selecting
-         * critical pages.  The only place critical pages need included in a generated dropdown is on the "Critical
-         * Pages" tab in the EE General Settings Admin page.
-         * This is for user-proofing.
-         */
-        add_filter('wp_dropdown_pages', array($this, 'modify_dropdown_pages'));
-        if (EE_Maintenance_Mode::instance()->models_can_query()) {
-            $this->adminInitModelsReady();
-        }
-    }
-
-
-    /**
-     * Runs on admin_init but only if models are usable (ie, we're not in maintenanc emode)
-     */
-    protected function adminInitModelsReady()
-    {
-        if (function_exists('wp_add_privacy_policy_content')) {
-            $this->getLoader()->getShared('EventEspresso\core\services\privacy\policy\PrivacyPolicyManager');
-        }
-    }
-
-
-    /**
-     * Callback for wp_dropdown_pages hook to remove ee critical pages from the dropdown selection.
-     *
-     * @param string $output Current output.
-     * @return string
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function modify_dropdown_pages($output)
-    {
-        // get critical pages
-        $critical_pages = EE_Registry::instance()->CFG->core->get_critical_pages_array();
-
-        // split current output by line break for easier parsing.
-        $split_output = explode("\n", $output);
-
-        // loop through to remove any critical pages from the array.
-        foreach ($critical_pages as $page_id) {
-            $needle = 'value="' . $page_id . '"';
-            foreach ($split_output as $key => $haystack) {
-                if (strpos($haystack, $needle) !== false) {
-                    unset($split_output[ $key ]);
-                }
-            }
-        }
-        // replace output with the new contents
-        return implode("\n", $split_output);
-    }
-
-
-    /**
-     * enqueue all admin scripts that need loaded for admin pages
-     *
-     * @return void
-     */
-    public function enqueue_admin_scripts()
-    {
-        // this javascript is loaded on every admin page to catch any injections ee needs to add to wp run js.
-        // Note: the intention of this script is to only do TARGETED injections.  I.E, only injecting on certain script
-        // calls.
-        wp_enqueue_script(
-            'ee-inject-wp',
-            EE_ADMIN_URL . 'assets/ee-cpt-wp-injects.js',
-            array('jquery'),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        // register cookie script for future dependencies
-        wp_register_script(
-            'jquery-cookie',
-            EE_THIRD_PARTY_URL . 'joyride/jquery.cookie.js',
-            array('jquery'),
-            '2.1',
-            true
-        );
-        // joyride is turned OFF by default, but prior to the admin_enqueue_scripts hook, can be turned back on again
-        // via: add_filter('FHEE_load_joyride', '__return_true' );
-        if (apply_filters('FHEE_load_joyride', false)) {
-            // joyride style
-            wp_register_style('joyride-css', EE_THIRD_PARTY_URL . 'joyride/joyride-2.1.css', array(), '2.1');
-            wp_register_style(
-                'ee-joyride-css',
-                EE_GLOBAL_ASSETS_URL . 'css/ee-joyride-styles.css',
-                array('joyride-css'),
-                EVENT_ESPRESSO_VERSION
-            );
-            wp_register_script(
-                'joyride-modernizr',
-                EE_THIRD_PARTY_URL . 'joyride/modernizr.mq.js',
-                array(),
-                '2.1',
-                true
-            );
-            // joyride JS
-            wp_register_script(
-                'jquery-joyride',
-                EE_THIRD_PARTY_URL . 'joyride/jquery.joyride-2.1.js',
-                array('jquery-cookie', 'joyride-modernizr'),
-                '2.1',
-                true
-            );
-            // wanna go for a joyride?
-            wp_enqueue_style('ee-joyride-css');
-            wp_enqueue_script('jquery-joyride');
-        }
-    }
-
-
-    /**
-     * display_admin_notices
-     *
-     * @return void
-     */
-    public function display_admin_notices()
-    {
-        echo EE_Error::get_notices();
-    }
-
-
-    /**
-     * @param array $elements
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function dashboard_glance_items($elements)
-    {
-        $elements = is_array($elements) ? $elements : array($elements);
-        $events = EEM_Event::instance()->count();
-        $items['events']['url'] = EE_Admin_Page::add_query_args_and_nonce(
-            array('page' => 'espresso_events'),
-            admin_url('admin.php')
-        );
-        $items['events']['text'] = sprintf(
-            esc_html(
-                _n('%s Event', '%s Events', $events, 'event_espresso')
-            ),
-            number_format_i18n($events)
-        );
-        $items['events']['title'] = esc_html__('Click to view all Events', 'event_espresso');
-        $registrations = EEM_Registration::instance()->count(
-            array(
-                array(
-                    'STS_ID' => array('!=', EEM_Registration::status_id_incomplete),
-                ),
-            )
-        );
-        $items['registrations']['url'] = EE_Admin_Page::add_query_args_and_nonce(
-            array('page' => 'espresso_registrations'),
-            admin_url('admin.php')
-        );
-        $items['registrations']['text'] = sprintf(
-            esc_html(
-                _n('%s Registration', '%s Registrations', $registrations, 'event_espresso')
-            ),
-            number_format_i18n($registrations)
-        );
-        $items['registrations']['title'] = esc_html__('Click to view all registrations', 'event_espresso');
-
-        $items = (array) apply_filters('FHEE__EE_Admin__dashboard_glance_items__items', $items);
-
-        foreach ($items as $type => $item_properties) {
-            $elements[] = sprintf(
-                '<a class="ee-dashboard-link-' . $type . '" href="%s" title="%s">%s</a>',
-                $item_properties['url'],
-                $item_properties['title'],
-                $item_properties['text']
-            );
-        }
-        return $elements;
-    }
-
-
-    /**
-     * check_for_invalid_datetime_formats
-     * if an admin changes their date or time format settings on the WP General Settings admin page, verify that
-     * their selected format can be parsed by PHP
-     *
-     * @param    $value
-     * @param    $option
-     * @throws EE_Error
-     * @return    string
-     */
-    public function check_for_invalid_datetime_formats($value, $option)
-    {
-        // check for date_format or time_format
-        switch ($option) {
-            case 'date_format':
-                $date_time_format = $value . ' ' . get_option('time_format');
-                break;
-            case 'time_format':
-                $date_time_format = get_option('date_format') . ' ' . $value;
-                break;
-            default:
-                $date_time_format = false;
-        }
-        // do we have a date_time format to check ?
-        if ($date_time_format) {
-            $error_msg = EEH_DTT_Helper::validate_format_string($date_time_format);
-
-            if (is_array($error_msg)) {
-                $msg = '<p>'
-                       . sprintf(
-                           esc_html__(
-                               'The following date time "%s" ( %s ) is difficult to be properly parsed by PHP for the following reasons:',
-                               'event_espresso'
-                           ),
-                           date($date_time_format),
-                           $date_time_format
-                       )
-                       . '</p><p><ul>';
-
-
-                foreach ($error_msg as $error) {
-                    $msg .= '<li>' . $error . '</li>';
-                }
-
-                $msg .= '</ul></p><p>'
-                        . sprintf(
-                            esc_html__(
-                                '%sPlease note that your date and time formats have been reset to "F j, Y" and "g:i a" respectively.%s',
-                                'event_espresso'
-                            ),
-                            '<span style="color:#D54E21;">',
-                            '</span>'
-                        )
-                        . '</p>';
-
-                // trigger WP settings error
-                add_settings_error(
-                    'date_format',
-                    'date_format',
-                    $msg
-                );
-
-                // set format to something valid
-                switch ($option) {
-                    case 'date_format':
-                        $value = 'F j, Y';
-                        break;
-                    case 'time_format':
-                        $value = 'g:i a';
-                        break;
-                }
-            }
-        }
-        return $value;
-    }
-
-
-    /**
-     * its_eSpresso - converts the less commonly used spelling of "Expresso" to "Espresso"
-     *
-     * @param $content
-     * @return    string
-     */
-    public function its_eSpresso($content)
-    {
-        return str_replace('[EXPRESSO_', '[ESPRESSO_', $content);
-    }
-
-
-    /**
-     * espresso_admin_footer
-     *
-     * @return    string
-     */
-    public function espresso_admin_footer()
-    {
-        return \EEH_Template::powered_by_event_espresso('aln-cntr', '', array('utm_content' => 'admin_footer'));
-    }
-
-
-    /**
-     * static method for registering ee admin page.
-     * This method is deprecated in favor of the new location in EE_Register_Admin_Page::register.
-     *
-     * @since      4.3.0
-     * @deprecated 4.3.0    Use EE_Register_Admin_Page::register() instead
-     * @see        EE_Register_Admin_Page::register()
-     * @param       $page_basename
-     * @param       $page_path
-     * @param array $config
-     * @return void
-     * @throws EE_Error
-     */
-    public static function register_ee_admin_page($page_basename, $page_path, $config = array())
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            sprintf(
-                esc_html__(
-                    'Usage is deprecated.  Use EE_Register_Admin_Page::register() for registering the %s admin page.',
-                    'event_espresso'
-                ),
-                $page_basename
-            ),
-            '4.3'
-        );
-        if (class_exists('EE_Register_Admin_Page')) {
-            $config['page_path'] = $page_path;
-        }
-        EE_Register_Admin_Page::register($page_basename, $config);
-    }
-
-
-    /**
-     * @deprecated 4.8.41
-     * @param  int      $post_ID
-     * @param  \WP_Post $post
-     * @return void
-     */
-    public static function parse_post_content_on_save($post_ID, $post)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__('Usage is deprecated', 'event_espresso'),
-            '4.8.41'
-        );
-    }
-
-
-    /**
-     * @deprecated 4.8.41
-     * @param  $option
-     * @param  $old_value
-     * @param  $value
-     * @return void
-     */
-    public function reset_page_for_posts_on_change($option, $old_value, $value)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__('Usage is deprecated', 'event_espresso'),
-            '4.8.41'
-        );
-    }
-
-
-    /**
-     * @deprecated 4.9.27
-     * @return void
-     */
-    public function get_persistent_admin_notices()
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            sprintf(
-                esc_html__('Usage is deprecated. Use "%1$s" instead.', 'event_espresso'),
-                '\EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
-            ),
-            '4.9.27'
-        );
-    }
-
-
-    /**
-     * @deprecated 4.9.27
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws DomainException
-     */
-    public function dismiss_ee_nag_notice_callback()
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            sprintf(
-                esc_html__('Usage is deprecated. Use "%1$s" instead.', 'event_espresso'),
-                '\EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
-            ),
-            '4.9.27'
-        );
-        $this->persistent_admin_notice_manager->dismissNotice();
-    }
-
-
-    /**
-     * Callback on load-plugins.php hook for setting up anything hooking into the wp plugins page.
-     *
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function hookIntoWpPluginsPage()
-    {
-        $this->getLoader()->getShared('EventEspresso\core\domain\services\admin\ExitModal');
-        $this->getLoader()
-                     ->getShared('EventEspresso\core\domain\services\admin\PluginUpsells')
-                     ->decafUpsells();
-    }
-
-
-    /**
-     * Hooks into the "post states" filter in a wp post type list table.
-     *
-     * @param array   $post_states
-     * @param WP_Post $post
-     * @return array
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function displayStateForCriticalPages($post_states, $post)
-    {
-        $post_states = (array) $post_states;
-        if (! $post instanceof WP_Post || $post->post_type !== 'page') {
-            return $post_states;
-        }
-        /** @var EE_Core_Config $config */
-        $config = $this->getLoader()->getShared('EE_Config')->core;
-        if (in_array($post->ID, $config->get_critical_pages_array(), true)) {
-            $post_states[] = sprintf(
-                /* Translators: Using company name - Event Espresso Critical Page */
-                esc_html__('%s Critical Page', 'event_espresso'),
-                'Event Espresso'
-            );
-        }
-        return $post_states;
-    }
-
-
-    /**
-     * Show documentation links on the plugins page
-     *
-     * @param mixed $meta Plugin Row Meta
-     * @param mixed $file Plugin Base file
-     * @return array
-     */
-    public function addLinksToPluginRowMeta($meta, $file)
-    {
-        if (EE_PLUGIN_BASENAME === $file) {
-            $row_meta = array(
-                'docs' => '<a href="https://eventespresso.com/support/documentation/versioned-docs/?doc_ver=ee4"'
-                          . ' aria-label="'
-                          . esc_attr__('View Event Espresso documentation', 'event_espresso')
-                          . '">'
-                          . esc_html__('Docs', 'event_espresso')
-                          . '</a>',
-                'api'  => '<a href="https://github.com/eventespresso/event-espresso-core/tree/master/docs/C--REST-API"'
-                          . ' aria-label="'
-                          . esc_attr__('View Event Espresso API docs', 'event_espresso')
-                          . '">'
-                          . esc_html__('API docs', 'event_espresso')
-                          . '</a>',
-            );
-            return array_merge($meta, $row_meta);
-        }
-        return (array) $meta;
-    }
+	}
+
+
+	/**
+	 * Returns an array of event archive nav items.
+	 *
+	 * @todo  for now this method is just in place so when it gets abstracted further we can substitute in whatever
+	 *        method we use for getting the extra nav menu items
+	 * @return array
+	 */
+	private function _get_extra_nav_menu_pages_items()
+	{
+		$menuitems[] = array(
+			'title'       => esc_html__('Event List', 'event_espresso'),
+			'url'         => get_post_type_archive_link('espresso_events'),
+			'description' => esc_html__('Archive page for all events.', 'event_espresso'),
+		);
+		return apply_filters('FHEE__EE_Admin__get_extra_nav_menu_pages_items', $menuitems);
+	}
+
+
+	/**
+	 * Setup nav menu walker item for usage in the event archive nav menu metabox.  It receives a menu_item array with
+	 * the properties and converts it to the menu item object.
+	 *
+	 * @see wp_setup_nav_menu_item() in wp-includes/nav-menu.php
+	 * @param $menu_item_values
+	 * @return stdClass
+	 */
+	private function _setup_extra_nav_menu_pages_items($menu_item_values)
+	{
+		$menu_item = new stdClass();
+		$keys = array(
+			'ID'               => 0,
+			'db_id'            => 0,
+			'menu_item_parent' => 0,
+			'object_id'        => -1,
+			'post_parent'      => 0,
+			'type'             => 'custom',
+			'object'           => '',
+			'type_label'       => esc_html__('Extra Nav Menu Item', 'event_espresso'),
+			'title'            => '',
+			'url'              => '',
+			'target'           => '',
+			'attr_title'       => '',
+			'description'      => '',
+			'classes'          => array(),
+			'xfn'              => '',
+		);
+
+		foreach ($keys as $key => $value) {
+			$menu_item->{$key} = isset($menu_item_values[ $key ]) ? $menu_item_values[ $key ] : $value;
+		}
+		return $menu_item;
+	}
+
+
+	/**
+	 * This is the action hook for the AHEE__EE_Admin_Page__route_admin_request hook that fires off right before an
+	 * EE_Admin_Page route is called.
+	 *
+	 * @return void
+	 */
+	public function route_admin_request()
+	{
+	}
+
+
+	/**
+	 * wp_loaded should fire on the WordPress wp_loaded hook.  This fires on a VERY late priority.
+	 *
+	 * @return void
+	 */
+	public function wp_loaded()
+	{
+	}
+
+
+	/**
+	 * admin_init
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function admin_init()
+	{
+		/**
+		 * our cpt models must be instantiated on WordPress post processing routes (wp-admin/post.php),
+		 * so any hooking into core WP routes is taken care of.  So in this next few lines of code:
+		 * - check if doing post processing.
+		 * - check if doing post processing of one of EE CPTs
+		 * - instantiate the corresponding EE CPT model for the post_type being processed.
+		 */
+		if (isset($_POST['action'], $_POST['post_type']) && $_POST['action'] === 'editpost') {
+			/** @var EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions $custom_post_types */
+			$custom_post_types = $this->getLoader()->getShared(
+				'EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions'
+			);
+			$custom_post_types->getCustomPostTypeModels($_POST['post_type']);
+		}
+
+
+		/**
+		 * This code excludes EE critical pages anywhere `wp_dropdown_pages` is used to create a dropdown for selecting
+		 * critical pages.  The only place critical pages need included in a generated dropdown is on the "Critical
+		 * Pages" tab in the EE General Settings Admin page.
+		 * This is for user-proofing.
+		 */
+		add_filter('wp_dropdown_pages', array($this, 'modify_dropdown_pages'));
+		if (EE_Maintenance_Mode::instance()->models_can_query()) {
+			$this->adminInitModelsReady();
+		}
+	}
+
+
+	/**
+	 * Runs on admin_init but only if models are usable (ie, we're not in maintenanc emode)
+	 */
+	protected function adminInitModelsReady()
+	{
+		if (function_exists('wp_add_privacy_policy_content')) {
+			$this->getLoader()->getShared('EventEspresso\core\services\privacy\policy\PrivacyPolicyManager');
+		}
+	}
+
+
+	/**
+	 * Callback for wp_dropdown_pages hook to remove ee critical pages from the dropdown selection.
+	 *
+	 * @param string $output Current output.
+	 * @return string
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function modify_dropdown_pages($output)
+	{
+		// get critical pages
+		$critical_pages = EE_Registry::instance()->CFG->core->get_critical_pages_array();
+
+		// split current output by line break for easier parsing.
+		$split_output = explode("\n", $output);
+
+		// loop through to remove any critical pages from the array.
+		foreach ($critical_pages as $page_id) {
+			$needle = 'value="' . $page_id . '"';
+			foreach ($split_output as $key => $haystack) {
+				if (strpos($haystack, $needle) !== false) {
+					unset($split_output[ $key ]);
+				}
+			}
+		}
+		// replace output with the new contents
+		return implode("\n", $split_output);
+	}
+
+
+	/**
+	 * enqueue all admin scripts that need loaded for admin pages
+	 *
+	 * @return void
+	 */
+	public function enqueue_admin_scripts()
+	{
+		// this javascript is loaded on every admin page to catch any injections ee needs to add to wp run js.
+		// Note: the intention of this script is to only do TARGETED injections.  I.E, only injecting on certain script
+		// calls.
+		wp_enqueue_script(
+			'ee-inject-wp',
+			EE_ADMIN_URL . 'assets/ee-cpt-wp-injects.js',
+			array('jquery'),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		// register cookie script for future dependencies
+		wp_register_script(
+			'jquery-cookie',
+			EE_THIRD_PARTY_URL . 'joyride/jquery.cookie.js',
+			array('jquery'),
+			'2.1',
+			true
+		);
+		// joyride is turned OFF by default, but prior to the admin_enqueue_scripts hook, can be turned back on again
+		// via: add_filter('FHEE_load_joyride', '__return_true' );
+		if (apply_filters('FHEE_load_joyride', false)) {
+			// joyride style
+			wp_register_style('joyride-css', EE_THIRD_PARTY_URL . 'joyride/joyride-2.1.css', array(), '2.1');
+			wp_register_style(
+				'ee-joyride-css',
+				EE_GLOBAL_ASSETS_URL . 'css/ee-joyride-styles.css',
+				array('joyride-css'),
+				EVENT_ESPRESSO_VERSION
+			);
+			wp_register_script(
+				'joyride-modernizr',
+				EE_THIRD_PARTY_URL . 'joyride/modernizr.mq.js',
+				array(),
+				'2.1',
+				true
+			);
+			// joyride JS
+			wp_register_script(
+				'jquery-joyride',
+				EE_THIRD_PARTY_URL . 'joyride/jquery.joyride-2.1.js',
+				array('jquery-cookie', 'joyride-modernizr'),
+				'2.1',
+				true
+			);
+			// wanna go for a joyride?
+			wp_enqueue_style('ee-joyride-css');
+			wp_enqueue_script('jquery-joyride');
+		}
+	}
+
+
+	/**
+	 * display_admin_notices
+	 *
+	 * @return void
+	 */
+	public function display_admin_notices()
+	{
+		echo EE_Error::get_notices();
+	}
+
+
+	/**
+	 * @param array $elements
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function dashboard_glance_items($elements)
+	{
+		$elements = is_array($elements) ? $elements : array($elements);
+		$events = EEM_Event::instance()->count();
+		$items['events']['url'] = EE_Admin_Page::add_query_args_and_nonce(
+			array('page' => 'espresso_events'),
+			admin_url('admin.php')
+		);
+		$items['events']['text'] = sprintf(
+			esc_html(
+				_n('%s Event', '%s Events', $events, 'event_espresso')
+			),
+			number_format_i18n($events)
+		);
+		$items['events']['title'] = esc_html__('Click to view all Events', 'event_espresso');
+		$registrations = EEM_Registration::instance()->count(
+			array(
+				array(
+					'STS_ID' => array('!=', EEM_Registration::status_id_incomplete),
+				),
+			)
+		);
+		$items['registrations']['url'] = EE_Admin_Page::add_query_args_and_nonce(
+			array('page' => 'espresso_registrations'),
+			admin_url('admin.php')
+		);
+		$items['registrations']['text'] = sprintf(
+			esc_html(
+				_n('%s Registration', '%s Registrations', $registrations, 'event_espresso')
+			),
+			number_format_i18n($registrations)
+		);
+		$items['registrations']['title'] = esc_html__('Click to view all registrations', 'event_espresso');
+
+		$items = (array) apply_filters('FHEE__EE_Admin__dashboard_glance_items__items', $items);
+
+		foreach ($items as $type => $item_properties) {
+			$elements[] = sprintf(
+				'<a class="ee-dashboard-link-' . $type . '" href="%s" title="%s">%s</a>',
+				$item_properties['url'],
+				$item_properties['title'],
+				$item_properties['text']
+			);
+		}
+		return $elements;
+	}
+
+
+	/**
+	 * check_for_invalid_datetime_formats
+	 * if an admin changes their date or time format settings on the WP General Settings admin page, verify that
+	 * their selected format can be parsed by PHP
+	 *
+	 * @param    $value
+	 * @param    $option
+	 * @throws EE_Error
+	 * @return    string
+	 */
+	public function check_for_invalid_datetime_formats($value, $option)
+	{
+		// check for date_format or time_format
+		switch ($option) {
+			case 'date_format':
+				$date_time_format = $value . ' ' . get_option('time_format');
+				break;
+			case 'time_format':
+				$date_time_format = get_option('date_format') . ' ' . $value;
+				break;
+			default:
+				$date_time_format = false;
+		}
+		// do we have a date_time format to check ?
+		if ($date_time_format) {
+			$error_msg = EEH_DTT_Helper::validate_format_string($date_time_format);
+
+			if (is_array($error_msg)) {
+				$msg = '<p>'
+					   . sprintf(
+						   esc_html__(
+							   'The following date time "%s" ( %s ) is difficult to be properly parsed by PHP for the following reasons:',
+							   'event_espresso'
+						   ),
+						   date($date_time_format),
+						   $date_time_format
+					   )
+					   . '</p><p><ul>';
+
+
+				foreach ($error_msg as $error) {
+					$msg .= '<li>' . $error . '</li>';
+				}
+
+				$msg .= '</ul></p><p>'
+						. sprintf(
+							esc_html__(
+								'%sPlease note that your date and time formats have been reset to "F j, Y" and "g:i a" respectively.%s',
+								'event_espresso'
+							),
+							'<span style="color:#D54E21;">',
+							'</span>'
+						)
+						. '</p>';
+
+				// trigger WP settings error
+				add_settings_error(
+					'date_format',
+					'date_format',
+					$msg
+				);
+
+				// set format to something valid
+				switch ($option) {
+					case 'date_format':
+						$value = 'F j, Y';
+						break;
+					case 'time_format':
+						$value = 'g:i a';
+						break;
+				}
+			}
+		}
+		return $value;
+	}
+
+
+	/**
+	 * its_eSpresso - converts the less commonly used spelling of "Expresso" to "Espresso"
+	 *
+	 * @param $content
+	 * @return    string
+	 */
+	public function its_eSpresso($content)
+	{
+		return str_replace('[EXPRESSO_', '[ESPRESSO_', $content);
+	}
+
+
+	/**
+	 * espresso_admin_footer
+	 *
+	 * @return    string
+	 */
+	public function espresso_admin_footer()
+	{
+		return \EEH_Template::powered_by_event_espresso('aln-cntr', '', array('utm_content' => 'admin_footer'));
+	}
+
+
+	/**
+	 * static method for registering ee admin page.
+	 * This method is deprecated in favor of the new location in EE_Register_Admin_Page::register.
+	 *
+	 * @since      4.3.0
+	 * @deprecated 4.3.0    Use EE_Register_Admin_Page::register() instead
+	 * @see        EE_Register_Admin_Page::register()
+	 * @param       $page_basename
+	 * @param       $page_path
+	 * @param array $config
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public static function register_ee_admin_page($page_basename, $page_path, $config = array())
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			sprintf(
+				esc_html__(
+					'Usage is deprecated.  Use EE_Register_Admin_Page::register() for registering the %s admin page.',
+					'event_espresso'
+				),
+				$page_basename
+			),
+			'4.3'
+		);
+		if (class_exists('EE_Register_Admin_Page')) {
+			$config['page_path'] = $page_path;
+		}
+		EE_Register_Admin_Page::register($page_basename, $config);
+	}
+
+
+	/**
+	 * @deprecated 4.8.41
+	 * @param  int      $post_ID
+	 * @param  \WP_Post $post
+	 * @return void
+	 */
+	public static function parse_post_content_on_save($post_ID, $post)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__('Usage is deprecated', 'event_espresso'),
+			'4.8.41'
+		);
+	}
+
+
+	/**
+	 * @deprecated 4.8.41
+	 * @param  $option
+	 * @param  $old_value
+	 * @param  $value
+	 * @return void
+	 */
+	public function reset_page_for_posts_on_change($option, $old_value, $value)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__('Usage is deprecated', 'event_espresso'),
+			'4.8.41'
+		);
+	}
+
+
+	/**
+	 * @deprecated 4.9.27
+	 * @return void
+	 */
+	public function get_persistent_admin_notices()
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			sprintf(
+				esc_html__('Usage is deprecated. Use "%1$s" instead.', 'event_espresso'),
+				'\EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
+			),
+			'4.9.27'
+		);
+	}
+
+
+	/**
+	 * @deprecated 4.9.27
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws DomainException
+	 */
+	public function dismiss_ee_nag_notice_callback()
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			sprintf(
+				esc_html__('Usage is deprecated. Use "%1$s" instead.', 'event_espresso'),
+				'\EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
+			),
+			'4.9.27'
+		);
+		$this->persistent_admin_notice_manager->dismissNotice();
+	}
+
+
+	/**
+	 * Callback on load-plugins.php hook for setting up anything hooking into the wp plugins page.
+	 *
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function hookIntoWpPluginsPage()
+	{
+		$this->getLoader()->getShared('EventEspresso\core\domain\services\admin\ExitModal');
+		$this->getLoader()
+					 ->getShared('EventEspresso\core\domain\services\admin\PluginUpsells')
+					 ->decafUpsells();
+	}
+
+
+	/**
+	 * Hooks into the "post states" filter in a wp post type list table.
+	 *
+	 * @param array   $post_states
+	 * @param WP_Post $post
+	 * @return array
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function displayStateForCriticalPages($post_states, $post)
+	{
+		$post_states = (array) $post_states;
+		if (! $post instanceof WP_Post || $post->post_type !== 'page') {
+			return $post_states;
+		}
+		/** @var EE_Core_Config $config */
+		$config = $this->getLoader()->getShared('EE_Config')->core;
+		if (in_array($post->ID, $config->get_critical_pages_array(), true)) {
+			$post_states[] = sprintf(
+				/* Translators: Using company name - Event Espresso Critical Page */
+				esc_html__('%s Critical Page', 'event_espresso'),
+				'Event Espresso'
+			);
+		}
+		return $post_states;
+	}
+
+
+	/**
+	 * Show documentation links on the plugins page
+	 *
+	 * @param mixed $meta Plugin Row Meta
+	 * @param mixed $file Plugin Base file
+	 * @return array
+	 */
+	public function addLinksToPluginRowMeta($meta, $file)
+	{
+		if (EE_PLUGIN_BASENAME === $file) {
+			$row_meta = array(
+				'docs' => '<a href="https://eventespresso.com/support/documentation/versioned-docs/?doc_ver=ee4"'
+						  . ' aria-label="'
+						  . esc_attr__('View Event Espresso documentation', 'event_espresso')
+						  . '">'
+						  . esc_html__('Docs', 'event_espresso')
+						  . '</a>',
+				'api'  => '<a href="https://github.com/eventespresso/event-espresso-core/tree/master/docs/C--REST-API"'
+						  . ' aria-label="'
+						  . esc_attr__('View Event Espresso API docs', 'event_espresso')
+						  . '">'
+						  . esc_html__('API docs', 'event_espresso')
+						  . '</a>',
+			);
+			return array_merge($meta, $row_meta);
+		}
+		return (array) $meta;
+	}
 }

Spacing +31 added lines, -31 removed lines

@@ -43,7 +43,7 @@ 
     public static function instance()
     {
         // check if class object is instantiated
-        if (! self::$_instance instanceof EE_Admin) {
+        if ( ! self::$_instance instanceof EE_Admin) {
             self::$_instance = new self();
         }
         return self::$_instance;
@@ -105,11 +105,11 @@ 
      */
     private function _define_all_constants()
     {
-        if (! defined('EE_ADMIN_URL')) {
-            define('EE_ADMIN_URL', EE_PLUGIN_DIR_URL . 'core/admin/');
-            define('EE_ADMIN_PAGES_URL', EE_PLUGIN_DIR_URL . 'admin_pages/');
-            define('EE_ADMIN_TEMPLATE', EE_ADMIN . 'templates/');
-            define('WP_ADMIN_PATH', ABSPATH . 'wp-admin/');
+        if ( ! defined('EE_ADMIN_URL')) {
+            define('EE_ADMIN_URL', EE_PLUGIN_DIR_URL.'core/admin/');
+            define('EE_ADMIN_PAGES_URL', EE_PLUGIN_DIR_URL.'admin_pages/');
+            define('EE_ADMIN_TEMPLATE', EE_ADMIN.'templates/');
+            define('WP_ADMIN_PATH', ABSPATH.'wp-admin/');
             define('WP_AJAX_URL', admin_url('admin-ajax.php'));
         }
     }
@@ -127,7 +127,7 @@ 
         // set $main_file in stone
         static $main_file;
         // if $main_file is not set yet
-        if (! $main_file) {
+        if ( ! $main_file) {
             $main_file = plugin_basename(EVENT_ESPRESSO_MAIN_FILE);
         }
         if ($plugin === $main_file) {
@@ -178,9 +178,9 @@ 
     public function hide_admin_pages_except_maintenance_mode($admin_page_folder_names = array())
     {
         return array(
-            'maintenance' => EE_ADMIN_PAGES . 'maintenance/',
-            'about'       => EE_ADMIN_PAGES . 'about/',
-            'support'     => EE_ADMIN_PAGES . 'support/',
+            'maintenance' => EE_ADMIN_PAGES.'maintenance/',
+            'about'       => EE_ADMIN_PAGES.'about/',
+            'support'     => EE_ADMIN_PAGES.'support/',
         );
     }
 
@@ -204,7 +204,7 @@ 
             $this->initModelsReady();
         }
         // run the admin page factory but ONLY if we are doing an ee admin ajax request
-        if (! defined('DOING_AJAX') || EE_ADMIN_AJAX) {
+        if ( ! defined('DOING_AJAX') || EE_ADMIN_AJAX) {
             try {
                 // this loads the controller for the admin pages which will setup routing etc
                 EE_Registry::instance()->load_core('Admin_Page_Loader');
@@ -230,7 +230,7 @@ 
      */
     protected function getLoader()
     {
-        if (! $this->loader instanceof LoaderInterface) {
+        if ( ! $this->loader instanceof LoaderInterface) {
             $this->loader = LoaderFactory::getLoader();
         }
         return $this->loader;
@@ -297,13 +297,13 @@ 
                     '</strong>',
                     '<a href="https://eventespresso.com/2017/08/important-upcoming-changes-dates-times">',
                     '</a>',
-                    '<a href="' . EE_Admin_Page::add_query_args_and_nonce(
+                    '<a href="'.EE_Admin_Page::add_query_args_and_nonce(
                         array(
                             'page'   => 'espresso_maintenance_settings',
                             'action' => 'datetime_tools',
                         ),
                         admin_url('admin.php')
-                    ) . '">'
+                    ).'">'
                 ),
                 false,
                 'manage_options',
@@ -349,7 +349,7 @@ 
     public function enable_hidden_ee_nav_menu_metaboxes()
     {
         global $wp_meta_boxes, $pagenow;
-        if (! is_array($wp_meta_boxes) || $pagenow !== 'nav-menus.php') {
+        if ( ! is_array($wp_meta_boxes) || $pagenow !== 'nav-menus.php') {
             return;
         }
         $user = wp_get_current_user();
@@ -378,7 +378,7 @@ 
         if (is_array($hidden_meta_boxes)) {
             foreach ($hidden_meta_boxes as $key => $meta_box_id) {
                 if (in_array($meta_box_id, $initial_meta_boxes, true)) {
-                    unset($hidden_meta_boxes[ $key ]);
+                    unset($hidden_meta_boxes[$key]);
                 }
             }
         }
@@ -418,7 +418,7 @@ 
      */
     public function modify_edit_post_link($link, $id)
     {
-        if (! $post = get_post($id)) {
+        if ( ! $post = get_post($id)) {
             return $link;
         }
         if ($post->post_type === 'espresso_attendees') {
@@ -565,7 +565,7 @@ 
         );
 
         foreach ($keys as $key => $value) {
-            $menu_item->{$key} = isset($menu_item_values[ $key ]) ? $menu_item_values[ $key ] : $value;
+            $menu_item->{$key} = isset($menu_item_values[$key]) ? $menu_item_values[$key] : $value;
         }
         return $menu_item;
     }
@@ -663,10 +663,10 @@ 
 
         // loop through to remove any critical pages from the array.
         foreach ($critical_pages as $page_id) {
-            $needle = 'value="' . $page_id . '"';
+            $needle = 'value="'.$page_id.'"';
             foreach ($split_output as $key => $haystack) {
                 if (strpos($haystack, $needle) !== false) {
-                    unset($split_output[ $key ]);
+                    unset($split_output[$key]);
                 }
             }
         }
@@ -687,7 +687,7 @@ 
         // calls.
         wp_enqueue_script(
             'ee-inject-wp',
-            EE_ADMIN_URL . 'assets/ee-cpt-wp-injects.js',
+            EE_ADMIN_URL.'assets/ee-cpt-wp-injects.js',
             array('jquery'),
             EVENT_ESPRESSO_VERSION,
             true
@@ -695,7 +695,7 @@ 
         // register cookie script for future dependencies
         wp_register_script(
             'jquery-cookie',
-            EE_THIRD_PARTY_URL . 'joyride/jquery.cookie.js',
+            EE_THIRD_PARTY_URL.'joyride/jquery.cookie.js',
             array('jquery'),
             '2.1',
             true
@@ -704,16 +704,16 @@ 
         // via: add_filter('FHEE_load_joyride', '__return_true' );
         if (apply_filters('FHEE_load_joyride', false)) {
             // joyride style
-            wp_register_style('joyride-css', EE_THIRD_PARTY_URL . 'joyride/joyride-2.1.css', array(), '2.1');
+            wp_register_style('joyride-css', EE_THIRD_PARTY_URL.'joyride/joyride-2.1.css', array(), '2.1');
             wp_register_style(
                 'ee-joyride-css',
-                EE_GLOBAL_ASSETS_URL . 'css/ee-joyride-styles.css',
+                EE_GLOBAL_ASSETS_URL.'css/ee-joyride-styles.css',
                 array('joyride-css'),
                 EVENT_ESPRESSO_VERSION
             );
             wp_register_script(
                 'joyride-modernizr',
-                EE_THIRD_PARTY_URL . 'joyride/modernizr.mq.js',
+                EE_THIRD_PARTY_URL.'joyride/modernizr.mq.js',
                 array(),
                 '2.1',
                 true
@@ -721,7 +721,7 @@ 
             // joyride JS
             wp_register_script(
                 'jquery-joyride',
-                EE_THIRD_PARTY_URL . 'joyride/jquery.joyride-2.1.js',
+                EE_THIRD_PARTY_URL.'joyride/jquery.joyride-2.1.js',
                 array('jquery-cookie', 'joyride-modernizr'),
                 '2.1',
                 true
@@ -790,7 +790,7 @@ 
 
         foreach ($items as $type => $item_properties) {
             $elements[] = sprintf(
-                '<a class="ee-dashboard-link-' . $type . '" href="%s" title="%s">%s</a>',
+                '<a class="ee-dashboard-link-'.$type.'" href="%s" title="%s">%s</a>',
                 $item_properties['url'],
                 $item_properties['title'],
                 $item_properties['text']
@@ -815,10 +815,10 @@ 
         // check for date_format or time_format
         switch ($option) {
             case 'date_format':
-                $date_time_format = $value . ' ' . get_option('time_format');
+                $date_time_format = $value.' '.get_option('time_format');
                 break;
             case 'time_format':
-                $date_time_format = get_option('date_format') . ' ' . $value;
+                $date_time_format = get_option('date_format').' '.$value;
                 break;
             default:
                 $date_time_format = false;
@@ -841,7 +841,7 @@ 
 
 
                 foreach ($error_msg as $error) {
-                    $msg .= '<li>' . $error . '</li>';
+                    $msg .= '<li>'.$error.'</li>';
                 }
 
                 $msg .= '</ul></p><p>'
@@ -1032,7 +1032,7 @@ 
     public function displayStateForCriticalPages($post_states, $post)
     {
         $post_states = (array) $post_states;
-        if (! $post instanceof WP_Post || $post->post_type !== 'page') {
+        if ( ! $post instanceof WP_Post || $post->post_type !== 'page') {
             return $post_states;
         }
         /** @var EE_Core_Config $config */

core/admin/EE_Admin_Page_Loader.core.php

Indentation +673 added lines, -673 removed lines

@@ -24,677 +24,677 @@
 class EE_Admin_Page_Loader
 {
 
-    /**
-     * _installed_pages
-     * objects for page_init objects detected and loaded
-     *
-     * @access private
-     * @var \EE_Admin_Page_Init[]
-     */
-    private $_installed_pages = array();
-
-
-    /**
-     * this is used to hold the registry of menu slugs for all the installed admin pages
-     *
-     * @var array
-     */
-    private $_menu_slugs = array();
-
-
-    /**
-     * _caffeinated_extends
-     * This array is the generated configuration array for which core EE_Admin pages are extended (and the bits and
-     * pieces needed to do so).  This property is defined in the _set_caffeinated method.
-     *
-     * @var array
-     */
-    private $_caffeinated_extends = array();
-
-
-    /**
-     * _current_caf_extend_slug
-     * This property is used for holding the page slug that is required for referencing the correct
-     * _caffeinated_extends index when the corresponding core child EE_Admin_Page_init hooks are executed.
-     *
-     * @var array
-     */
-    private $_current_caf_extend_slug;
-
-    /**
-     * _prepped_menu_maps
-     * This is the prepared array of EE_Admin_Page_Menu_Maps for adding to the admin_menu.
-     *
-     * @since  4.4.0
-     * @var EE_Admin_Page_Menu_Map[]
-     */
-    private $_prepped_menu_maps = array();
-
-
-    /**
-     * _admin_menu_groups
-     * array that holds the group headings and details for
-     *
-     * @access private
-     * @var array
-     */
-    private $_admin_menu_groups = array();
-
-
-    /**
-     * This property will hold the hook file for setting up the filter that does all the connections between admin
-     * pages.
-     *
-     * @var string
-     */
-    public $hook_file;
-
-
-    /**
-     * constructor
-     *
-     * @access public
-     * @return \EE_Admin_Page_Loader
-     */
-    public function __construct()
-    {
-        // load menu_map classes
-        EE_Registry::instance()->load_file(EE_ADMIN, 'EE_Admin_Page_Menu_Map', 'core');
-        // define the default "groups" for the admin_pages
-        $this->_set_menu_groups();
-
-        // let's do a scan and see what installed pages we have
-        $this->_get_installed_pages();
-        // set menus (has to be done on every load - we're not actually loading the page just setting the menus and where they point to).
-        add_action('admin_menu', array($this, 'set_menus'));
-        add_action('network_admin_menu', array($this, 'set_network_menus'));
-    }
-
-
-    /**
-     * When caffeinated system is detected, this method is called to setup the caffeinated directory constants used by
-     * files in the caffeinated folder.
-     *
-     * @access private
-     * @return void
-     */
-    private function _define_caffeinated_constants()
-    {
-        if (! defined('EE_CORE_CAF_ADMIN')) {
-            define('EE_CORE_CAF_ADMIN', EE_PLUGIN_DIR_PATH . 'caffeinated/admin/');
-            define('EE_CORE_CAF_ADMIN_URL', EE_PLUGIN_DIR_URL . 'caffeinated/admin/');
-            define('EE_CORE_CAF_ADMIN_NEW', EE_CORE_CAF_ADMIN . 'new/');
-            define('EE_CORE_CAF_ADMIN_EXTEND', EE_CORE_CAF_ADMIN . 'extend/');
-            define('EE_CORE_CAF_ADMIN_EXTEND_URL', EE_CORE_CAF_ADMIN_URL . 'extend/');
-            define('EE_CORE_CAF_ADMIN_HOOKS', EE_CORE_CAF_ADMIN . 'hooks/');
-        }
-    }
-
-
-    /**
-     * _set_menu_groups
-     * sets the filterable _admin_menu_groups property (list of various "groupings" within the EE admin menu array)
-     *
-     * @access private
-     * @return void
-     */
-    private function _set_menu_groups()
-    {
-
-        // set array of EE_Admin_Page_Menu_Group objects
-        $groups = array(
-            'main'       => new EE_Admin_Page_Menu_Group(
-                array(
-                    'menu_label'   => __('Main', 'event_espresso'),
-                    'show_on_menu' => EE_Admin_Page_Menu_Map::NONE,
-                    'menu_slug'    => 'main',
-                    'capability'   => 'ee_read_ee',
-                    'menu_order'   => 0,
-                    'parent_slug'  => 'espresso_events',
-                )
-            ),
-            'management' => new EE_Admin_Page_Menu_Group(
-                array(
-                    'menu_label'   => __('Management', 'event_espresso'),
-                    'show_on_menu' => EE_Admin_Page_Menu_Map::BLOG_ADMIN_ONLY,
-                    'menu_slug'    => 'management',
-                    'capability'   => 'ee_read_ee',
-                    'menu_order'   => 10,
-                    'parent_slug'  => 'espresso_events',
-                )
-            ),
-            'settings'   => new EE_Admin_Page_Menu_Group(
-                array(
-                    'menu_label'   => __('Settings', 'event_espresso'),
-                    'show_on_menu' => EE_Admin_Page_Menu_Map::BLOG_ADMIN_ONLY,
-                    'menu_slug'    => 'settings',
-                    'capability'   => 'ee_read_ee',
-                    'menu_order'   => 30,
-                    'parent_slug'  => 'espresso_events',
-                )
-            ),
-            'templates'  => new EE_Admin_Page_Menu_Group(
-                array(
-                    'menu_label'   => __('Templates', 'event_espresso'),
-                    'show_on_menu' => EE_Admin_Page_Menu_Map::BLOG_ADMIN_ONLY,
-                    'menu_slug'    => 'templates',
-                    'capability'   => 'ee_read_ee',
-                    'menu_order'   => 40,
-                    'parent_slug'  => 'espresso_events',
-                )
-            ),
-            'extras'     => new EE_Admin_Page_Menu_Group(
-                array(
-                    'menu_label'              => __('Extras', 'event_espresso'),
-                    'show_on_menu'            => EE_Admin_Page_Menu_Map::BLOG_AND_NETWORK_ADMIN,
-                    'menu_slug'               => 'extras',
-                    'capability'              => 'ee_read_ee',
-                    'menu_order'              => 50,
-                    'parent_slug'             => 'espresso_events',
-                    'maintenance_mode_parent' => 'espresso_maintenance_settings',
-                )
-            ),
-            'tools'      => new EE_Admin_Page_Menu_Group(
-                array(
-                    'menu_label'   => __("Tools", "event_espresso"),
-                    'show_on_menu' => EE_Admin_Page_Menu_Map::BLOG_ADMIN_ONLY,
-                    'menu_slug'    => 'tools',
-                    'capability'   => 'ee_read_ee',
-                    'menu_order'   => 60,
-                    'parent_slug'  => 'espresso_events',
-                )
-            ),
-            'addons'     => new EE_Admin_Page_Menu_Group(
-                array(
-                    'show_on_menu' => EE_Admin_Page_Menu_Map::BLOG_AND_NETWORK_ADMIN,
-                    'menu_label'   => __('Add-ons', 'event_espresso'),
-                    'menu_slug'    => 'addons',
-                    'capability'   => 'ee_read_ee',
-                    'menu_order'   => 20,
-                    'parent_slug'  => 'espresso_events',
-                )
-            ),
-        );
-        $this->_admin_menu_groups = apply_filters(
-            'FHEE__EE_Admin_Page_Loader___set_menu_groups__admin_menu_groups',
-            $groups
-        );
-    }
-
-
-    /**
-     * This takes all the groups in the _admin_menu_groups array and returns the array indexed by group
-     * slug.  The other utility with this function is it validates that all the groups are instances of
-     * EE_Admin_Page_Menu_Group (cause some invalid things might have slipped in via addons).
-     *
-     * @since  4.4.0
-     * @throws \EE_Error
-     * @return EE_Admin_Page_Menu_Group[]
-     */
-    private function _rearrange_menu_groups()
-    {
-        $groups = array();
-        // first let's order the menu groups by their internal menu order (note usort type hinting to ensure the incoming array is EE_Admin_Page_Menu_Map objects )
-        usort($this->_admin_menu_groups, array($this, '_sort_menu_maps'));
-        foreach ($this->_admin_menu_groups as $group) {
-            if (! $group instanceof EE_Admin_Page_Menu_Group) {
-                throw new EE_Error(
-                    sprintf(
-                        __(
-                            'Unable to continue sorting the menu groups array because there is an invalid value for the menu groups.  All values in this array are required to be a EE_Admin_Page_Menu_Group object.  Instead there was: %s',
-                            'event_espresso'
-                        ),
-                        print_r($group, true)
-                    )
-                );
-            }
-            $groups[ $group->menu_slug ] = $group;
-        }
-        return $groups;
-    }
-
-
-    /**
-     * _get_installed_pages
-     * This just gets the list of installed EE_Admin_pages.
-     *
-     * @access private
-     * @throws EE_Error
-     * @return void
-     */
-    private function _get_installed_pages()
-    {
-        $installed_refs = array();
-        $exclude = array('assets', 'templates');
-        // grab everything in the  admin core directory
-        $admin_screens = glob(EE_ADMIN_PAGES . '*', GLOB_ONLYDIR);
-        if ($admin_screens) {
-            foreach ($admin_screens as $admin_screen) {
-                // files and anything in the exclude array need not apply
-                if (is_dir($admin_screen) && ! in_array(basename($admin_screen), $exclude)) {
-                    // these folders represent the different EE admin pages
-                    $installed_refs[ basename($admin_screen) ] = $admin_screen;
-                }
-            }
-        }
-        if (empty($installed_refs)) {
-            $error_msg[] = __(
-                'There are no EE_Admin pages detected, it looks like EE did not install properly',
-                'event_espresso'
-            );
-            $error_msg[] = $error_msg[0] . "\r\n"
-                           . sprintf(
-                               __(
-                                   'Check that the %s folder exists and is writable. Maybe try deactivating, then reactivating Event Espresso again.',
-                                   'event_espresso'
-                               ),
-                               EE_ADMIN_PAGES
-                           );
-            throw new EE_Error(implode('||', $error_msg));
-        }
-        // this just checks the caffeinated folder and takes care of setting up any caffeinated stuff.
-        $installed_refs = $this->_set_caffeinated($installed_refs);
-        // allow plugins to add in their own pages (note at this point they will need to have an autoloader defined for their class) OR hook into EEH_Autoloader::load_admin_page() to add their path.;
-        $installed_refs = apply_filters(
-            'FHEE__EE_Admin_Page_Loader___get_installed_pages__installed_refs',
-            $installed_refs
-        );
-        $this->_caffeinated_extends = apply_filters(
-            'FHEE__EE_Admin_Page_Loader___get_installed_pages__caffeinated_extends',
-            $this->_caffeinated_extends
-        );
-        // loop through admin pages and setup the $_installed_pages array.
-        $hooks_ref = array();
-        foreach ($installed_refs as $page => $path) {
-            // set autoloaders for our admin page classes based on included path information
-            EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder($path);
-            // build list of installed pages
-            $this->_installed_pages[ $page ] = $this->_load_admin_page($page, $path);
-            // verify returned object
-            if ($this->_installed_pages[ $page ] instanceof EE_Admin_Page_Init) {
-                if (! $this->_installed_pages[ $page ]->get_menu_map() instanceof EE_Admin_Page_Menu_Map) {
-                    continue;
-                }
-                // skip if in full maintenance mode and maintenance_mode_parent is set
-                $maintenance_mode_parent = $this->_installed_pages[ $page ]->get_menu_map()->maintenance_mode_parent;
-                if (empty($maintenance_mode_parent)
-                    && EE_Maintenance_Mode::instance()->level() === EE_Maintenance_Mode::level_2_complete_maintenance
-                ) {
-                    unset($installed_refs[ $page ]);
-                    continue;
-                }
-                $menu_slug = $this->_installed_pages[ $page ]->get_menu_map()->menu_slug;
-                $this->_menu_slugs[ $menu_slug ] = $page;
-                // flag for register hooks on extended pages b/c extended pages use the default INIT.
-                $extend = false;
-                // now that we've got the admin_init objects... lets see if there are any caffeinated pages extending the originals.  If there are then let's hook into the init admin filter and load our extend instead.
-                if (isset($this->_caffeinated_extends[ $page ])) {
-                    $this->_current_caf_extend_slug = $page;
-                    $admin_page_name = $this->_installed_pages[ $page ]->get_admin_page_name();
-                    $caf_path = $this->_caffeinated_extends[ $this->_current_caf_extend_slug ]['path'];
-                    $caf_admin_page = $this->_caffeinated_extends[ $this->_current_caf_extend_slug ]['admin_page'];
-                    add_filter(
-                        "FHEE__EE_Admin_Page_Init___initialize_admin_page__path_to_file__{$menu_slug}_{$admin_page_name}",
-                        function ($path_to_file) use ($caf_path) {
-                            return $caf_path;
-                        }
-                    );
-                    add_filter(
-                        "FHEE__EE_Admin_Page_Init___initialize_admin_page__admin_page__{$menu_slug}_{$admin_page_name}",
-                        function ($admin_page) use ($caf_admin_page) {
-                            return $caf_admin_page;
-                        }
-                    );
-                    $extend = true;
-                }
-                // let's do the registered hooks
-                $extended_hooks = $this->_installed_pages[ $page ]->register_hooks($extend);
-                $hooks_ref = array_merge($hooks_ref, $extended_hooks);
-            }
-        }
-        // the hooks_ref is all the pages where we have $extended _Hooks files that will extend a class in a different folder.  So we want to make sure we load the file for the parent.
-        // first make sure we've got unique values
-        $hooks_ref = array_unique($hooks_ref);
-        // now let's loop and require!
-        foreach ($hooks_ref as $path) {
-            require_once($path);
-        }
-        // make sure we have menu slugs global setup. Used in EE_Admin_Page->page_setup() to ensure we don't do a full class load for an admin page that isn't requested.
-        global $ee_menu_slugs;
-        $ee_menu_slugs = $this->_menu_slugs;
-        // we need to loop again to run any early code
-        foreach ($installed_refs as $page => $path) {
-            if ($this->_installed_pages[ $page ] instanceof EE_Admin_Page_Init) {
-                $this->_installed_pages[ $page ]->do_initial_loads();
-            }
-        }
-        do_action('AHEE__EE_Admin_Page_Loader___get_installed_pages_loaded', $this->_installed_pages);
-    }
-
-
-    /**
-     * get_admin_page_object
-     *
-     * @param string $page_slug
-     * @return EE_Admin_Page
-     */
-    public function get_admin_page_object($page_slug = '')
-    {
-        if (isset($this->_installed_pages[ $page_slug ])) {
-            return $this->_installed_pages[ $page_slug ]->loaded_page_object();
-        }
-        return null;
-    }
-
-
-    /**
-     * _get_classname_for_admin_page
-     * generates an "Admin Page" class based on the directory  name
-     *
-     * @param $dir_name
-     * @return string
-     */
-    private function _get_classname_for_admin_page($dir_name = '')
-    {
-        $class_name = str_replace('_', ' ', strtolower($dir_name));
-        return str_replace(' ', '_', ucwords($class_name)) . '_Admin_Page';
-    }
-
-
-    /**
-     * _get_classname_for_admin_init_page
-     * generates an "Admin Page Init" class based on the directory  name
-     *
-     * @param $dir_name
-     * @return string
-     */
-    private function _get_classname_for_admin_init_page($dir_name = '')
-    {
-        $class_name = str_replace('_', ' ', strtolower($dir_name));
-        return str_replace(' ', '_', ucwords($class_name)) . '_Admin_Page_Init';
-    }
-
-
-    /**
-     * _load_admin_page
-     * Loads and instantiates page_init object for a single EE_admin page.
-     *
-     * @param  string $page page_reference
-     * @param string  $path
-     * @throws EE_Error
-     * @return object|bool  return page object if valid, bool false if not.
-     */
-    private function _load_admin_page($page = '', $path = '')
-    {
-        $class_name = $this->_get_classname_for_admin_init_page($page);
-        EE_Registry::instance()->load_file($path, $class_name, 'core');
-        if (! class_exists($class_name)) {
-            $inner_error_msg = '<br />'
-                               . sprintf(
-                                   esc_html__(
-                                       'Make sure you have %1$s defined. If this is a non-EE-core admin page then you also must have an autoloader in place for your class',
-                                       'event_espresso'
-                                   ),
-                                   '<strong>' . $class_name . '</strong>'
-                               );
-            $error_msg[] = sprintf(
-                __('Something went wrong with loading the %s admin page.', 'event_espresso'),
-                $page
-            );
-            $error_msg[] = $error_msg[0]
-                           . "\r\n"
-                           . sprintf(
-                               esc_html__(
-                                   'There is no Init class in place for the %s admin page.',
-                                   'event_espresso'
-                               ),
-                               $page
-                           )
-                           . $inner_error_msg;
-            throw new EE_Error(implode('||', $error_msg));
-        }
-        $a = new ReflectionClass($class_name);
-        return $a->newInstance();
-    }
-
-
-    /**
-     * set_menus
-     * This method sets up the menus for EE Admin Pages
-     *
-     * @access private
-     * @return void
-     */
-    public function set_menus()
-    {
-        // prep the menu pages (sort, group.)
-        $this->_prep_pages();
-        foreach ($this->_prepped_menu_maps as $menu_map) {
-            if (EE_Registry::instance()->CAP->current_user_can($menu_map->capability, $menu_map->menu_slug)) {
-                $menu_map->add_menu_page(false);
-            }
-        }
-    }
-
-
-    /**
-     * set_network_menus
-     * This method sets up the menus for network EE Admin Pages.
-     * Almost identical to EE_Admin_Page_Loader::set_menus() except pages
-     * are only added to the menu map if they are intended for the admin menu
-     *
-     * @return void
-     */
-    public function set_network_menus()
-    {
-        $this->_prep_pages();
-        foreach ($this->_prepped_menu_maps as $menu_map) {
-            if (EE_Registry::instance()->CAP->current_user_can($menu_map->capability, $menu_map->menu_slug)) {
-                $menu_map->add_menu_page(true);
-            }
-        }
-    }
-
-
-    /**
-     * _prep_pages
-     * sets the _prepped_menu_maps property
-     *
-     * @access private
-     * @throws EE_Error
-     * @return void
-     */
-    private function _prep_pages()
-    {
-        $pages_array = array();
-        // rearrange _admin_menu_groups to be indexed by group slug.
-        $menu_groups = $this->_rearrange_menu_groups();
-        foreach ($this->_installed_pages as $page) {
-            if ($page instanceof EE_Admin_page_Init) {
-                $page_map = $page->get_menu_map();
-                // if we've got an array then the menu map is in the old format so let's throw a persistent notice that the admin system isn't setup correctly for this item.
-                if (is_array($page_map) || empty($page_map)) {
-                    new PersistentAdminNotice(
-                        'menu_map_warning_' . str_replace(' ', '_', $page->label) . '_' . EVENT_ESPRESSO_VERSION,
-                        sprintf(
-                            __(
-                                'The admin page for %s was not correctly setup because it is using an older method for integrating with Event Espresso Core.  This means that full functionality for this component is not available.  This error message usually appears with an Add-on that is out of date.  Make sure you update all your Event Espresso 4 add-ons to the latest version to ensure they have necessary compatibility updates in place.',
-                                'event_espresso'
-                            ),
-                            $page->label
-                        )
-                    );
-                    continue;
-                }
-                // if page map is NOT a EE_Admin_Page_Menu_Map object then throw error.
-                if (! $page_map instanceof EE_Admin_Page_Menu_Map) {
-                    throw new EE_Error(
-                        sprintf(
-                            __(
-                                'The menu map for %s must be an EE_Admin_Page_Menu_Map object.  Instead it is %s.  Please double check that the menu map has been configured correctly.',
-                                'event_espresso'
-                            ),
-                            $page->label,
-                            $page_map
-                        )
-                    );
-                }
-                // use the maintenance_mode_parent property and maintenance mode status to determine if this page even gets added to array.
-                if (empty($page_map->maintenance_mode_parent)
-                    && EE_Maintenance_Mode::instance()->level()
-                       == EE_Maintenance_Mode::level_2_complete_maintenance) {
-                    continue;
-                }
-                // assign to group (remember $page_map has the admin page stored in it).
-                $pages_array[ $page_map->menu_group ][] = $page_map;
-            }
-        }
-        if (empty($pages_array)) {
-            throw new EE_Error(__('Something went wrong when prepping the admin pages', 'event_espresso'));
-        }
-        // let's sort the groups, make sure it's a valid group, add header (if to show).
-        foreach ($pages_array as $group => $menu_maps) {
-            // valid_group?
-            if (! array_key_exists($group, $menu_groups)) {
-                continue;
-            }
-            // sort pages.
-            usort($menu_maps, array($this, '_sort_menu_maps'));
-            // prepend header
-            array_unshift($menu_maps, $menu_groups[ $group ]);
-            // reset $pages_array with prepped data
-            $pages_array[ $group ] = $menu_maps;
-        }
-        // now let's setup the _prepped_menu_maps property
-        foreach ($menu_groups as $group => $group_objs) {
-            if (isset($pages_array[ $group ])) {
-                $this->_prepped_menu_maps = array_merge($this->_prepped_menu_maps, $pages_array[ $group ]);
-            }
-        }/**/
-    }
-
-
-    /**
-     * This method is the "workhorse" for detecting and setting up caffeinated functionality.
-     * In this method there are three checks being done:
-     * 1. Do we have any NEW admin page sets.  If we do, lets add them into the menu setup (via the $installed_refs
-     * array) etc.  (new page sets are found in caffeinated/new/{page})
-     * 2. Do we have any EXTENDED page sets.  Basically an extended EE_Admin Page extends the core {child}_Admin_Page
-     * class.  eg. would be caffeinated/extend/events/Extend_Events_Admin_Page.core.php and in there would be a class:
-     * Extend_Events_Admin_Page extends Events_Admin_Page.
-     * 3. Do we have any files just for setting up hooks into other core pages.  The files can be any name in
-     * "caffeinated/hooks" EXCEPT they need a ".class.php" extension and the file name must correspond with the
-     * classname inside.  These classes are instantiated really early so that any hooks in them are run before the
-     * corresponding apply_filters/do_actions that are found in any future loaded EE_Admin pages (INCLUDING caffeinated
-     * admin_pages)
-     *
-     * @param array $installed_refs the original installed_refs array that may contain our NEW EE_Admin_Pages to be
-     *                              loaded.
-     * @return array
-     */
-    private function _set_caffeinated($installed_refs)
-    {
-
-        // first let's check if there IS a caffeinated folder. If there is not then lets get out.
-        if (! is_dir(EE_PLUGIN_DIR_PATH . 'caffeinated/admin') || (defined('EE_DECAF') && EE_DECAF)) {
-            return $installed_refs;
-        }
-        $this->_define_caffeinated_constants();
-        $exclude = array('tickets');
-        // okay let's setup an "New" pages first (we'll return installed refs later)
-        $new_admin_screens = glob(EE_CORE_CAF_ADMIN . 'new/*', GLOB_ONLYDIR);
-        if ($new_admin_screens) {
-            foreach ($new_admin_screens as $admin_screen) {
-                // files and anything in the exclude array need not apply
-                if (is_dir($admin_screen) && ! in_array(basename($admin_screen), $exclude)) {
-                    // these folders represent the different NEW EE admin pages
-                    $installed_refs[ basename($admin_screen) ] = $admin_screen;
-                    // set autoloaders for our admin page classes based on included path information
-                    EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder($admin_screen);
-                }
-            }
-        }
-        // let's see if there are any EXTENDS to setup in the $_caffeinated_extends array (that will be used later for hooking into the _initialize_admin_age in the related core_init admin page)
-        $extends = glob(EE_CORE_CAF_ADMIN . 'extend/*', GLOB_ONLYDIR);
-        if ($extends) {
-            foreach ($extends as $extend) {
-                if (is_dir($extend)) {
-                    $extend_ref = basename($extend);
-                    // now let's make sure there is a file that matches the expected format
-                    $filename = str_replace(
-                        ' ',
-                        '_',
-                        ucwords(
-                            str_replace(
-                                '_',
-                                ' ',
-                                $extend_ref
-                            )
-                        )
-                    );
-                    $filename = 'Extend_' . $filename . '_Admin_Page';
-                    $this->_caffeinated_extends[ $extend_ref ]['path'] = str_replace(
-                        array('\\', '/'),
-                        '/',
-                        EE_CORE_CAF_ADMIN
-                        . 'extend/'
-                        . $extend_ref
-                        . '/'
-                        . $filename
-                        . '.core.php'
-                    );
-                    $this->_caffeinated_extends[ $extend_ref ]['admin_page'] = $filename;
-                    // set autoloaders for our admin page classes based on included path information
-                    EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder($extend);
-                }
-            }
-        }
-        // let's see if there are any HOOK files and instantiate them if there are (so that hooks are loaded early!).
-        $ee_admin_hooks = array();
-        $hooks = glob(EE_CORE_CAF_ADMIN . 'hooks/*.class.php');
-        if ($hooks) {
-            foreach ($hooks as $hook) {
-                if (is_readable($hook)) {
-                    require_once $hook;
-                    $classname = str_replace(EE_CORE_CAF_ADMIN . 'hooks/', '', $hook);
-                    $classname = str_replace('.class.php', '', $classname);
-                    if (class_exists($classname)) {
-                        $a = new ReflectionClass($classname);
-                        $ee_admin_hooks[] = $a->newInstance();
-                    }
-                }
-            }
-        }/**/
-        $ee_admin_hooks = apply_filters('FHEE__EE_Admin_Page_Loader__set_caffeinated__ee_admin_hooks', $ee_admin_hooks);
-        return $installed_refs;
-    }
-
-
-    /**
-     * Utility method for sorting the _menu_maps (callback for usort php function)
-     *
-     * @since  4.4.0
-     * @param  EE_Admin_Page_Menu_Map $a menu_map object
-     * @param  EE_Admin_Page_Menu_Map $b being compared to
-     * @return int    sort order
-     */
-    private function _sort_menu_maps(EE_Admin_Page_Menu_Map $a, EE_Admin_Page_Menu_Map $b)
-    {
-        if ($a->menu_order == $b->menu_order) {
-            return 0;
-        }
-        return ($a->menu_order < $b->menu_order) ? -1 : 1;
-    }
-
-
-    /**
-     * _default_header_link
-     * This is just a dummy method to use with header submenu items
-     *
-     * @return bool false
-     */
-    public function _default_header_link()
-    {
-        return false;
-    }
+	/**
+	 * _installed_pages
+	 * objects for page_init objects detected and loaded
+	 *
+	 * @access private
+	 * @var \EE_Admin_Page_Init[]
+	 */
+	private $_installed_pages = array();
+
+
+	/**
+	 * this is used to hold the registry of menu slugs for all the installed admin pages
+	 *
+	 * @var array
+	 */
+	private $_menu_slugs = array();
+
+
+	/**
+	 * _caffeinated_extends
+	 * This array is the generated configuration array for which core EE_Admin pages are extended (and the bits and
+	 * pieces needed to do so).  This property is defined in the _set_caffeinated method.
+	 *
+	 * @var array
+	 */
+	private $_caffeinated_extends = array();
+
+
+	/**
+	 * _current_caf_extend_slug
+	 * This property is used for holding the page slug that is required for referencing the correct
+	 * _caffeinated_extends index when the corresponding core child EE_Admin_Page_init hooks are executed.
+	 *
+	 * @var array
+	 */
+	private $_current_caf_extend_slug;
+
+	/**
+	 * _prepped_menu_maps
+	 * This is the prepared array of EE_Admin_Page_Menu_Maps for adding to the admin_menu.
+	 *
+	 * @since  4.4.0
+	 * @var EE_Admin_Page_Menu_Map[]
+	 */
+	private $_prepped_menu_maps = array();
+
+
+	/**
+	 * _admin_menu_groups
+	 * array that holds the group headings and details for
+	 *
+	 * @access private
+	 * @var array
+	 */
+	private $_admin_menu_groups = array();
+
+
+	/**
+	 * This property will hold the hook file for setting up the filter that does all the connections between admin
+	 * pages.
+	 *
+	 * @var string
+	 */
+	public $hook_file;
+
+
+	/**
+	 * constructor
+	 *
+	 * @access public
+	 * @return \EE_Admin_Page_Loader
+	 */
+	public function __construct()
+	{
+		// load menu_map classes
+		EE_Registry::instance()->load_file(EE_ADMIN, 'EE_Admin_Page_Menu_Map', 'core');
+		// define the default "groups" for the admin_pages
+		$this->_set_menu_groups();
+
+		// let's do a scan and see what installed pages we have
+		$this->_get_installed_pages();
+		// set menus (has to be done on every load - we're not actually loading the page just setting the menus and where they point to).
+		add_action('admin_menu', array($this, 'set_menus'));
+		add_action('network_admin_menu', array($this, 'set_network_menus'));
+	}
+
+
+	/**
+	 * When caffeinated system is detected, this method is called to setup the caffeinated directory constants used by
+	 * files in the caffeinated folder.
+	 *
+	 * @access private
+	 * @return void
+	 */
+	private function _define_caffeinated_constants()
+	{
+		if (! defined('EE_CORE_CAF_ADMIN')) {
+			define('EE_CORE_CAF_ADMIN', EE_PLUGIN_DIR_PATH . 'caffeinated/admin/');
+			define('EE_CORE_CAF_ADMIN_URL', EE_PLUGIN_DIR_URL . 'caffeinated/admin/');
+			define('EE_CORE_CAF_ADMIN_NEW', EE_CORE_CAF_ADMIN . 'new/');
+			define('EE_CORE_CAF_ADMIN_EXTEND', EE_CORE_CAF_ADMIN . 'extend/');
+			define('EE_CORE_CAF_ADMIN_EXTEND_URL', EE_CORE_CAF_ADMIN_URL . 'extend/');
+			define('EE_CORE_CAF_ADMIN_HOOKS', EE_CORE_CAF_ADMIN . 'hooks/');
+		}
+	}
+
+
+	/**
+	 * _set_menu_groups
+	 * sets the filterable _admin_menu_groups property (list of various "groupings" within the EE admin menu array)
+	 *
+	 * @access private
+	 * @return void
+	 */
+	private function _set_menu_groups()
+	{
+
+		// set array of EE_Admin_Page_Menu_Group objects
+		$groups = array(
+			'main'       => new EE_Admin_Page_Menu_Group(
+				array(
+					'menu_label'   => __('Main', 'event_espresso'),
+					'show_on_menu' => EE_Admin_Page_Menu_Map::NONE,
+					'menu_slug'    => 'main',
+					'capability'   => 'ee_read_ee',
+					'menu_order'   => 0,
+					'parent_slug'  => 'espresso_events',
+				)
+			),
+			'management' => new EE_Admin_Page_Menu_Group(
+				array(
+					'menu_label'   => __('Management', 'event_espresso'),
+					'show_on_menu' => EE_Admin_Page_Menu_Map::BLOG_ADMIN_ONLY,
+					'menu_slug'    => 'management',
+					'capability'   => 'ee_read_ee',
+					'menu_order'   => 10,
+					'parent_slug'  => 'espresso_events',
+				)
+			),
+			'settings'   => new EE_Admin_Page_Menu_Group(
+				array(
+					'menu_label'   => __('Settings', 'event_espresso'),
+					'show_on_menu' => EE_Admin_Page_Menu_Map::BLOG_ADMIN_ONLY,
+					'menu_slug'    => 'settings',
+					'capability'   => 'ee_read_ee',
+					'menu_order'   => 30,
+					'parent_slug'  => 'espresso_events',
+				)
+			),
+			'templates'  => new EE_Admin_Page_Menu_Group(
+				array(
+					'menu_label'   => __('Templates', 'event_espresso'),
+					'show_on_menu' => EE_Admin_Page_Menu_Map::BLOG_ADMIN_ONLY,
+					'menu_slug'    => 'templates',
+					'capability'   => 'ee_read_ee',
+					'menu_order'   => 40,
+					'parent_slug'  => 'espresso_events',
+				)
+			),
+			'extras'     => new EE_Admin_Page_Menu_Group(
+				array(
+					'menu_label'              => __('Extras', 'event_espresso'),
+					'show_on_menu'            => EE_Admin_Page_Menu_Map::BLOG_AND_NETWORK_ADMIN,
+					'menu_slug'               => 'extras',
+					'capability'              => 'ee_read_ee',
+					'menu_order'              => 50,
+					'parent_slug'             => 'espresso_events',
+					'maintenance_mode_parent' => 'espresso_maintenance_settings',
+				)
+			),
+			'tools'      => new EE_Admin_Page_Menu_Group(
+				array(
+					'menu_label'   => __("Tools", "event_espresso"),
+					'show_on_menu' => EE_Admin_Page_Menu_Map::BLOG_ADMIN_ONLY,
+					'menu_slug'    => 'tools',
+					'capability'   => 'ee_read_ee',
+					'menu_order'   => 60,
+					'parent_slug'  => 'espresso_events',
+				)
+			),
+			'addons'     => new EE_Admin_Page_Menu_Group(
+				array(
+					'show_on_menu' => EE_Admin_Page_Menu_Map::BLOG_AND_NETWORK_ADMIN,
+					'menu_label'   => __('Add-ons', 'event_espresso'),
+					'menu_slug'    => 'addons',
+					'capability'   => 'ee_read_ee',
+					'menu_order'   => 20,
+					'parent_slug'  => 'espresso_events',
+				)
+			),
+		);
+		$this->_admin_menu_groups = apply_filters(
+			'FHEE__EE_Admin_Page_Loader___set_menu_groups__admin_menu_groups',
+			$groups
+		);
+	}
+
+
+	/**
+	 * This takes all the groups in the _admin_menu_groups array and returns the array indexed by group
+	 * slug.  The other utility with this function is it validates that all the groups are instances of
+	 * EE_Admin_Page_Menu_Group (cause some invalid things might have slipped in via addons).
+	 *
+	 * @since  4.4.0
+	 * @throws \EE_Error
+	 * @return EE_Admin_Page_Menu_Group[]
+	 */
+	private function _rearrange_menu_groups()
+	{
+		$groups = array();
+		// first let's order the menu groups by their internal menu order (note usort type hinting to ensure the incoming array is EE_Admin_Page_Menu_Map objects )
+		usort($this->_admin_menu_groups, array($this, '_sort_menu_maps'));
+		foreach ($this->_admin_menu_groups as $group) {
+			if (! $group instanceof EE_Admin_Page_Menu_Group) {
+				throw new EE_Error(
+					sprintf(
+						__(
+							'Unable to continue sorting the menu groups array because there is an invalid value for the menu groups.  All values in this array are required to be a EE_Admin_Page_Menu_Group object.  Instead there was: %s',
+							'event_espresso'
+						),
+						print_r($group, true)
+					)
+				);
+			}
+			$groups[ $group->menu_slug ] = $group;
+		}
+		return $groups;
+	}
+
+
+	/**
+	 * _get_installed_pages
+	 * This just gets the list of installed EE_Admin_pages.
+	 *
+	 * @access private
+	 * @throws EE_Error
+	 * @return void
+	 */
+	private function _get_installed_pages()
+	{
+		$installed_refs = array();
+		$exclude = array('assets', 'templates');
+		// grab everything in the  admin core directory
+		$admin_screens = glob(EE_ADMIN_PAGES . '*', GLOB_ONLYDIR);
+		if ($admin_screens) {
+			foreach ($admin_screens as $admin_screen) {
+				// files and anything in the exclude array need not apply
+				if (is_dir($admin_screen) && ! in_array(basename($admin_screen), $exclude)) {
+					// these folders represent the different EE admin pages
+					$installed_refs[ basename($admin_screen) ] = $admin_screen;
+				}
+			}
+		}
+		if (empty($installed_refs)) {
+			$error_msg[] = __(
+				'There are no EE_Admin pages detected, it looks like EE did not install properly',
+				'event_espresso'
+			);
+			$error_msg[] = $error_msg[0] . "\r\n"
+						   . sprintf(
+							   __(
+								   'Check that the %s folder exists and is writable. Maybe try deactivating, then reactivating Event Espresso again.',
+								   'event_espresso'
+							   ),
+							   EE_ADMIN_PAGES
+						   );
+			throw new EE_Error(implode('||', $error_msg));
+		}
+		// this just checks the caffeinated folder and takes care of setting up any caffeinated stuff.
+		$installed_refs = $this->_set_caffeinated($installed_refs);
+		// allow plugins to add in their own pages (note at this point they will need to have an autoloader defined for their class) OR hook into EEH_Autoloader::load_admin_page() to add their path.;
+		$installed_refs = apply_filters(
+			'FHEE__EE_Admin_Page_Loader___get_installed_pages__installed_refs',
+			$installed_refs
+		);
+		$this->_caffeinated_extends = apply_filters(
+			'FHEE__EE_Admin_Page_Loader___get_installed_pages__caffeinated_extends',
+			$this->_caffeinated_extends
+		);
+		// loop through admin pages and setup the $_installed_pages array.
+		$hooks_ref = array();
+		foreach ($installed_refs as $page => $path) {
+			// set autoloaders for our admin page classes based on included path information
+			EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder($path);
+			// build list of installed pages
+			$this->_installed_pages[ $page ] = $this->_load_admin_page($page, $path);
+			// verify returned object
+			if ($this->_installed_pages[ $page ] instanceof EE_Admin_Page_Init) {
+				if (! $this->_installed_pages[ $page ]->get_menu_map() instanceof EE_Admin_Page_Menu_Map) {
+					continue;
+				}
+				// skip if in full maintenance mode and maintenance_mode_parent is set
+				$maintenance_mode_parent = $this->_installed_pages[ $page ]->get_menu_map()->maintenance_mode_parent;
+				if (empty($maintenance_mode_parent)
+					&& EE_Maintenance_Mode::instance()->level() === EE_Maintenance_Mode::level_2_complete_maintenance
+				) {
+					unset($installed_refs[ $page ]);
+					continue;
+				}
+				$menu_slug = $this->_installed_pages[ $page ]->get_menu_map()->menu_slug;
+				$this->_menu_slugs[ $menu_slug ] = $page;
+				// flag for register hooks on extended pages b/c extended pages use the default INIT.
+				$extend = false;
+				// now that we've got the admin_init objects... lets see if there are any caffeinated pages extending the originals.  If there are then let's hook into the init admin filter and load our extend instead.
+				if (isset($this->_caffeinated_extends[ $page ])) {
+					$this->_current_caf_extend_slug = $page;
+					$admin_page_name = $this->_installed_pages[ $page ]->get_admin_page_name();
+					$caf_path = $this->_caffeinated_extends[ $this->_current_caf_extend_slug ]['path'];
+					$caf_admin_page = $this->_caffeinated_extends[ $this->_current_caf_extend_slug ]['admin_page'];
+					add_filter(
+						"FHEE__EE_Admin_Page_Init___initialize_admin_page__path_to_file__{$menu_slug}_{$admin_page_name}",
+						function ($path_to_file) use ($caf_path) {
+							return $caf_path;
+						}
+					);
+					add_filter(
+						"FHEE__EE_Admin_Page_Init___initialize_admin_page__admin_page__{$menu_slug}_{$admin_page_name}",
+						function ($admin_page) use ($caf_admin_page) {
+							return $caf_admin_page;
+						}
+					);
+					$extend = true;
+				}
+				// let's do the registered hooks
+				$extended_hooks = $this->_installed_pages[ $page ]->register_hooks($extend);
+				$hooks_ref = array_merge($hooks_ref, $extended_hooks);
+			}
+		}
+		// the hooks_ref is all the pages where we have $extended _Hooks files that will extend a class in a different folder.  So we want to make sure we load the file for the parent.
+		// first make sure we've got unique values
+		$hooks_ref = array_unique($hooks_ref);
+		// now let's loop and require!
+		foreach ($hooks_ref as $path) {
+			require_once($path);
+		}
+		// make sure we have menu slugs global setup. Used in EE_Admin_Page->page_setup() to ensure we don't do a full class load for an admin page that isn't requested.
+		global $ee_menu_slugs;
+		$ee_menu_slugs = $this->_menu_slugs;
+		// we need to loop again to run any early code
+		foreach ($installed_refs as $page => $path) {
+			if ($this->_installed_pages[ $page ] instanceof EE_Admin_Page_Init) {
+				$this->_installed_pages[ $page ]->do_initial_loads();
+			}
+		}
+		do_action('AHEE__EE_Admin_Page_Loader___get_installed_pages_loaded', $this->_installed_pages);
+	}
+
+
+	/**
+	 * get_admin_page_object
+	 *
+	 * @param string $page_slug
+	 * @return EE_Admin_Page
+	 */
+	public function get_admin_page_object($page_slug = '')
+	{
+		if (isset($this->_installed_pages[ $page_slug ])) {
+			return $this->_installed_pages[ $page_slug ]->loaded_page_object();
+		}
+		return null;
+	}
+
+
+	/**
+	 * _get_classname_for_admin_page
+	 * generates an "Admin Page" class based on the directory  name
+	 *
+	 * @param $dir_name
+	 * @return string
+	 */
+	private function _get_classname_for_admin_page($dir_name = '')
+	{
+		$class_name = str_replace('_', ' ', strtolower($dir_name));
+		return str_replace(' ', '_', ucwords($class_name)) . '_Admin_Page';
+	}
+
+
+	/**
+	 * _get_classname_for_admin_init_page
+	 * generates an "Admin Page Init" class based on the directory  name
+	 *
+	 * @param $dir_name
+	 * @return string
+	 */
+	private function _get_classname_for_admin_init_page($dir_name = '')
+	{
+		$class_name = str_replace('_', ' ', strtolower($dir_name));
+		return str_replace(' ', '_', ucwords($class_name)) . '_Admin_Page_Init';
+	}
+
+
+	/**
+	 * _load_admin_page
+	 * Loads and instantiates page_init object for a single EE_admin page.
+	 *
+	 * @param  string $page page_reference
+	 * @param string  $path
+	 * @throws EE_Error
+	 * @return object|bool  return page object if valid, bool false if not.
+	 */
+	private function _load_admin_page($page = '', $path = '')
+	{
+		$class_name = $this->_get_classname_for_admin_init_page($page);
+		EE_Registry::instance()->load_file($path, $class_name, 'core');
+		if (! class_exists($class_name)) {
+			$inner_error_msg = '<br />'
+							   . sprintf(
+								   esc_html__(
+									   'Make sure you have %1$s defined. If this is a non-EE-core admin page then you also must have an autoloader in place for your class',
+									   'event_espresso'
+								   ),
+								   '<strong>' . $class_name . '</strong>'
+							   );
+			$error_msg[] = sprintf(
+				__('Something went wrong with loading the %s admin page.', 'event_espresso'),
+				$page
+			);
+			$error_msg[] = $error_msg[0]
+						   . "\r\n"
+						   . sprintf(
+							   esc_html__(
+								   'There is no Init class in place for the %s admin page.',
+								   'event_espresso'
+							   ),
+							   $page
+						   )
+						   . $inner_error_msg;
+			throw new EE_Error(implode('||', $error_msg));
+		}
+		$a = new ReflectionClass($class_name);
+		return $a->newInstance();
+	}
+
+
+	/**
+	 * set_menus
+	 * This method sets up the menus for EE Admin Pages
+	 *
+	 * @access private
+	 * @return void
+	 */
+	public function set_menus()
+	{
+		// prep the menu pages (sort, group.)
+		$this->_prep_pages();
+		foreach ($this->_prepped_menu_maps as $menu_map) {
+			if (EE_Registry::instance()->CAP->current_user_can($menu_map->capability, $menu_map->menu_slug)) {
+				$menu_map->add_menu_page(false);
+			}
+		}
+	}
+
+
+	/**
+	 * set_network_menus
+	 * This method sets up the menus for network EE Admin Pages.
+	 * Almost identical to EE_Admin_Page_Loader::set_menus() except pages
+	 * are only added to the menu map if they are intended for the admin menu
+	 *
+	 * @return void
+	 */
+	public function set_network_menus()
+	{
+		$this->_prep_pages();
+		foreach ($this->_prepped_menu_maps as $menu_map) {
+			if (EE_Registry::instance()->CAP->current_user_can($menu_map->capability, $menu_map->menu_slug)) {
+				$menu_map->add_menu_page(true);
+			}
+		}
+	}
+
+
+	/**
+	 * _prep_pages
+	 * sets the _prepped_menu_maps property
+	 *
+	 * @access private
+	 * @throws EE_Error
+	 * @return void
+	 */
+	private function _prep_pages()
+	{
+		$pages_array = array();
+		// rearrange _admin_menu_groups to be indexed by group slug.
+		$menu_groups = $this->_rearrange_menu_groups();
+		foreach ($this->_installed_pages as $page) {
+			if ($page instanceof EE_Admin_page_Init) {
+				$page_map = $page->get_menu_map();
+				// if we've got an array then the menu map is in the old format so let's throw a persistent notice that the admin system isn't setup correctly for this item.
+				if (is_array($page_map) || empty($page_map)) {
+					new PersistentAdminNotice(
+						'menu_map_warning_' . str_replace(' ', '_', $page->label) . '_' . EVENT_ESPRESSO_VERSION,
+						sprintf(
+							__(
+								'The admin page for %s was not correctly setup because it is using an older method for integrating with Event Espresso Core.  This means that full functionality for this component is not available.  This error message usually appears with an Add-on that is out of date.  Make sure you update all your Event Espresso 4 add-ons to the latest version to ensure they have necessary compatibility updates in place.',
+								'event_espresso'
+							),
+							$page->label
+						)
+					);
+					continue;
+				}
+				// if page map is NOT a EE_Admin_Page_Menu_Map object then throw error.
+				if (! $page_map instanceof EE_Admin_Page_Menu_Map) {
+					throw new EE_Error(
+						sprintf(
+							__(
+								'The menu map for %s must be an EE_Admin_Page_Menu_Map object.  Instead it is %s.  Please double check that the menu map has been configured correctly.',
+								'event_espresso'
+							),
+							$page->label,
+							$page_map
+						)
+					);
+				}
+				// use the maintenance_mode_parent property and maintenance mode status to determine if this page even gets added to array.
+				if (empty($page_map->maintenance_mode_parent)
+					&& EE_Maintenance_Mode::instance()->level()
+					   == EE_Maintenance_Mode::level_2_complete_maintenance) {
+					continue;
+				}
+				// assign to group (remember $page_map has the admin page stored in it).
+				$pages_array[ $page_map->menu_group ][] = $page_map;
+			}
+		}
+		if (empty($pages_array)) {
+			throw new EE_Error(__('Something went wrong when prepping the admin pages', 'event_espresso'));
+		}
+		// let's sort the groups, make sure it's a valid group, add header (if to show).
+		foreach ($pages_array as $group => $menu_maps) {
+			// valid_group?
+			if (! array_key_exists($group, $menu_groups)) {
+				continue;
+			}
+			// sort pages.
+			usort($menu_maps, array($this, '_sort_menu_maps'));
+			// prepend header
+			array_unshift($menu_maps, $menu_groups[ $group ]);
+			// reset $pages_array with prepped data
+			$pages_array[ $group ] = $menu_maps;
+		}
+		// now let's setup the _prepped_menu_maps property
+		foreach ($menu_groups as $group => $group_objs) {
+			if (isset($pages_array[ $group ])) {
+				$this->_prepped_menu_maps = array_merge($this->_prepped_menu_maps, $pages_array[ $group ]);
+			}
+		}/**/
+	}
+
+
+	/**
+	 * This method is the "workhorse" for detecting and setting up caffeinated functionality.
+	 * In this method there are three checks being done:
+	 * 1. Do we have any NEW admin page sets.  If we do, lets add them into the menu setup (via the $installed_refs
+	 * array) etc.  (new page sets are found in caffeinated/new/{page})
+	 * 2. Do we have any EXTENDED page sets.  Basically an extended EE_Admin Page extends the core {child}_Admin_Page
+	 * class.  eg. would be caffeinated/extend/events/Extend_Events_Admin_Page.core.php and in there would be a class:
+	 * Extend_Events_Admin_Page extends Events_Admin_Page.
+	 * 3. Do we have any files just for setting up hooks into other core pages.  The files can be any name in
+	 * "caffeinated/hooks" EXCEPT they need a ".class.php" extension and the file name must correspond with the
+	 * classname inside.  These classes are instantiated really early so that any hooks in them are run before the
+	 * corresponding apply_filters/do_actions that are found in any future loaded EE_Admin pages (INCLUDING caffeinated
+	 * admin_pages)
+	 *
+	 * @param array $installed_refs the original installed_refs array that may contain our NEW EE_Admin_Pages to be
+	 *                              loaded.
+	 * @return array
+	 */
+	private function _set_caffeinated($installed_refs)
+	{
+
+		// first let's check if there IS a caffeinated folder. If there is not then lets get out.
+		if (! is_dir(EE_PLUGIN_DIR_PATH . 'caffeinated/admin') || (defined('EE_DECAF') && EE_DECAF)) {
+			return $installed_refs;
+		}
+		$this->_define_caffeinated_constants();
+		$exclude = array('tickets');
+		// okay let's setup an "New" pages first (we'll return installed refs later)
+		$new_admin_screens = glob(EE_CORE_CAF_ADMIN . 'new/*', GLOB_ONLYDIR);
+		if ($new_admin_screens) {
+			foreach ($new_admin_screens as $admin_screen) {
+				// files and anything in the exclude array need not apply
+				if (is_dir($admin_screen) && ! in_array(basename($admin_screen), $exclude)) {
+					// these folders represent the different NEW EE admin pages
+					$installed_refs[ basename($admin_screen) ] = $admin_screen;
+					// set autoloaders for our admin page classes based on included path information
+					EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder($admin_screen);
+				}
+			}
+		}
+		// let's see if there are any EXTENDS to setup in the $_caffeinated_extends array (that will be used later for hooking into the _initialize_admin_age in the related core_init admin page)
+		$extends = glob(EE_CORE_CAF_ADMIN . 'extend/*', GLOB_ONLYDIR);
+		if ($extends) {
+			foreach ($extends as $extend) {
+				if (is_dir($extend)) {
+					$extend_ref = basename($extend);
+					// now let's make sure there is a file that matches the expected format
+					$filename = str_replace(
+						' ',
+						'_',
+						ucwords(
+							str_replace(
+								'_',
+								' ',
+								$extend_ref
+							)
+						)
+					);
+					$filename = 'Extend_' . $filename . '_Admin_Page';
+					$this->_caffeinated_extends[ $extend_ref ]['path'] = str_replace(
+						array('\\', '/'),
+						'/',
+						EE_CORE_CAF_ADMIN
+						. 'extend/'
+						. $extend_ref
+						. '/'
+						. $filename
+						. '.core.php'
+					);
+					$this->_caffeinated_extends[ $extend_ref ]['admin_page'] = $filename;
+					// set autoloaders for our admin page classes based on included path information
+					EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder($extend);
+				}
+			}
+		}
+		// let's see if there are any HOOK files and instantiate them if there are (so that hooks are loaded early!).
+		$ee_admin_hooks = array();
+		$hooks = glob(EE_CORE_CAF_ADMIN . 'hooks/*.class.php');
+		if ($hooks) {
+			foreach ($hooks as $hook) {
+				if (is_readable($hook)) {
+					require_once $hook;
+					$classname = str_replace(EE_CORE_CAF_ADMIN . 'hooks/', '', $hook);
+					$classname = str_replace('.class.php', '', $classname);
+					if (class_exists($classname)) {
+						$a = new ReflectionClass($classname);
+						$ee_admin_hooks[] = $a->newInstance();
+					}
+				}
+			}
+		}/**/
+		$ee_admin_hooks = apply_filters('FHEE__EE_Admin_Page_Loader__set_caffeinated__ee_admin_hooks', $ee_admin_hooks);
+		return $installed_refs;
+	}
+
+
+	/**
+	 * Utility method for sorting the _menu_maps (callback for usort php function)
+	 *
+	 * @since  4.4.0
+	 * @param  EE_Admin_Page_Menu_Map $a menu_map object
+	 * @param  EE_Admin_Page_Menu_Map $b being compared to
+	 * @return int    sort order
+	 */
+	private function _sort_menu_maps(EE_Admin_Page_Menu_Map $a, EE_Admin_Page_Menu_Map $b)
+	{
+		if ($a->menu_order == $b->menu_order) {
+			return 0;
+		}
+		return ($a->menu_order < $b->menu_order) ? -1 : 1;
+	}
+
+
+	/**
+	 * _default_header_link
+	 * This is just a dummy method to use with header submenu items
+	 *
+	 * @return bool false
+	 */
+	public function _default_header_link()
+	{
+		return false;
+	}
 }

Spacing +51 added lines, -51 removed lines

@@ -120,13 +120,13 @@ 
      */
     private function _define_caffeinated_constants()
     {
-        if (! defined('EE_CORE_CAF_ADMIN')) {
-            define('EE_CORE_CAF_ADMIN', EE_PLUGIN_DIR_PATH . 'caffeinated/admin/');
-            define('EE_CORE_CAF_ADMIN_URL', EE_PLUGIN_DIR_URL . 'caffeinated/admin/');
-            define('EE_CORE_CAF_ADMIN_NEW', EE_CORE_CAF_ADMIN . 'new/');
-            define('EE_CORE_CAF_ADMIN_EXTEND', EE_CORE_CAF_ADMIN . 'extend/');
-            define('EE_CORE_CAF_ADMIN_EXTEND_URL', EE_CORE_CAF_ADMIN_URL . 'extend/');
-            define('EE_CORE_CAF_ADMIN_HOOKS', EE_CORE_CAF_ADMIN . 'hooks/');
+        if ( ! defined('EE_CORE_CAF_ADMIN')) {
+            define('EE_CORE_CAF_ADMIN', EE_PLUGIN_DIR_PATH.'caffeinated/admin/');
+            define('EE_CORE_CAF_ADMIN_URL', EE_PLUGIN_DIR_URL.'caffeinated/admin/');
+            define('EE_CORE_CAF_ADMIN_NEW', EE_CORE_CAF_ADMIN.'new/');
+            define('EE_CORE_CAF_ADMIN_EXTEND', EE_CORE_CAF_ADMIN.'extend/');
+            define('EE_CORE_CAF_ADMIN_EXTEND_URL', EE_CORE_CAF_ADMIN_URL.'extend/');
+            define('EE_CORE_CAF_ADMIN_HOOKS', EE_CORE_CAF_ADMIN.'hooks/');
         }
     }
 
@@ -237,7 +237,7 @@ 
         // first let's order the menu groups by their internal menu order (note usort type hinting to ensure the incoming array is EE_Admin_Page_Menu_Map objects )
         usort($this->_admin_menu_groups, array($this, '_sort_menu_maps'));
         foreach ($this->_admin_menu_groups as $group) {
-            if (! $group instanceof EE_Admin_Page_Menu_Group) {
+            if ( ! $group instanceof EE_Admin_Page_Menu_Group) {
                 throw new EE_Error(
                     sprintf(
                         __(
@@ -248,7 +248,7 @@ 
                     )
                 );
             }
-            $groups[ $group->menu_slug ] = $group;
+            $groups[$group->menu_slug] = $group;
         }
         return $groups;
     }
@@ -267,13 +267,13 @@ 
         $installed_refs = array();
         $exclude = array('assets', 'templates');
         // grab everything in the  admin core directory
-        $admin_screens = glob(EE_ADMIN_PAGES . '*', GLOB_ONLYDIR);
+        $admin_screens = glob(EE_ADMIN_PAGES.'*', GLOB_ONLYDIR);
         if ($admin_screens) {
             foreach ($admin_screens as $admin_screen) {
                 // files and anything in the exclude array need not apply
                 if (is_dir($admin_screen) && ! in_array(basename($admin_screen), $exclude)) {
                     // these folders represent the different EE admin pages
-                    $installed_refs[ basename($admin_screen) ] = $admin_screen;
+                    $installed_refs[basename($admin_screen)] = $admin_screen;
                 }
             }
         }
@@ -282,7 +282,7 @@ 
                 'There are no EE_Admin pages detected, it looks like EE did not install properly',
                 'event_espresso'
             );
-            $error_msg[] = $error_msg[0] . "\r\n"
+            $error_msg[] = $error_msg[0]."\r\n"
                            . sprintf(
                                __(
                                    'Check that the %s folder exists and is writable. Maybe try deactivating, then reactivating Event Espresso again.',
@@ -309,46 +309,46 @@ 
             // set autoloaders for our admin page classes based on included path information
             EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder($path);
             // build list of installed pages
-            $this->_installed_pages[ $page ] = $this->_load_admin_page($page, $path);
+            $this->_installed_pages[$page] = $this->_load_admin_page($page, $path);
             // verify returned object
-            if ($this->_installed_pages[ $page ] instanceof EE_Admin_Page_Init) {
-                if (! $this->_installed_pages[ $page ]->get_menu_map() instanceof EE_Admin_Page_Menu_Map) {
+            if ($this->_installed_pages[$page] instanceof EE_Admin_Page_Init) {
+                if ( ! $this->_installed_pages[$page]->get_menu_map() instanceof EE_Admin_Page_Menu_Map) {
                     continue;
                 }
                 // skip if in full maintenance mode and maintenance_mode_parent is set
-                $maintenance_mode_parent = $this->_installed_pages[ $page ]->get_menu_map()->maintenance_mode_parent;
+                $maintenance_mode_parent = $this->_installed_pages[$page]->get_menu_map()->maintenance_mode_parent;
                 if (empty($maintenance_mode_parent)
                     && EE_Maintenance_Mode::instance()->level() === EE_Maintenance_Mode::level_2_complete_maintenance
                 ) {
-                    unset($installed_refs[ $page ]);
+                    unset($installed_refs[$page]);
                     continue;
                 }
-                $menu_slug = $this->_installed_pages[ $page ]->get_menu_map()->menu_slug;
-                $this->_menu_slugs[ $menu_slug ] = $page;
+                $menu_slug = $this->_installed_pages[$page]->get_menu_map()->menu_slug;
+                $this->_menu_slugs[$menu_slug] = $page;
                 // flag for register hooks on extended pages b/c extended pages use the default INIT.
                 $extend = false;
                 // now that we've got the admin_init objects... lets see if there are any caffeinated pages extending the originals.  If there are then let's hook into the init admin filter and load our extend instead.
-                if (isset($this->_caffeinated_extends[ $page ])) {
+                if (isset($this->_caffeinated_extends[$page])) {
                     $this->_current_caf_extend_slug = $page;
-                    $admin_page_name = $this->_installed_pages[ $page ]->get_admin_page_name();
-                    $caf_path = $this->_caffeinated_extends[ $this->_current_caf_extend_slug ]['path'];
-                    $caf_admin_page = $this->_caffeinated_extends[ $this->_current_caf_extend_slug ]['admin_page'];
+                    $admin_page_name = $this->_installed_pages[$page]->get_admin_page_name();
+                    $caf_path = $this->_caffeinated_extends[$this->_current_caf_extend_slug]['path'];
+                    $caf_admin_page = $this->_caffeinated_extends[$this->_current_caf_extend_slug]['admin_page'];
                     add_filter(
                         "FHEE__EE_Admin_Page_Init___initialize_admin_page__path_to_file__{$menu_slug}_{$admin_page_name}",
-                        function ($path_to_file) use ($caf_path) {
+                        function($path_to_file) use ($caf_path) {
                             return $caf_path;
                         }
                     );
                     add_filter(
                         "FHEE__EE_Admin_Page_Init___initialize_admin_page__admin_page__{$menu_slug}_{$admin_page_name}",
-                        function ($admin_page) use ($caf_admin_page) {
+                        function($admin_page) use ($caf_admin_page) {
                             return $caf_admin_page;
                         }
                     );
                     $extend = true;
                 }
                 // let's do the registered hooks
-                $extended_hooks = $this->_installed_pages[ $page ]->register_hooks($extend);
+                $extended_hooks = $this->_installed_pages[$page]->register_hooks($extend);
                 $hooks_ref = array_merge($hooks_ref, $extended_hooks);
             }
         }
@@ -364,8 +364,8 @@ 
         $ee_menu_slugs = $this->_menu_slugs;
         // we need to loop again to run any early code
         foreach ($installed_refs as $page => $path) {
-            if ($this->_installed_pages[ $page ] instanceof EE_Admin_Page_Init) {
-                $this->_installed_pages[ $page ]->do_initial_loads();
+            if ($this->_installed_pages[$page] instanceof EE_Admin_Page_Init) {
+                $this->_installed_pages[$page]->do_initial_loads();
             }
         }
         do_action('AHEE__EE_Admin_Page_Loader___get_installed_pages_loaded', $this->_installed_pages);
@@ -380,8 +380,8 @@ 
      */
     public function get_admin_page_object($page_slug = '')
     {
-        if (isset($this->_installed_pages[ $page_slug ])) {
-            return $this->_installed_pages[ $page_slug ]->loaded_page_object();
+        if (isset($this->_installed_pages[$page_slug])) {
+            return $this->_installed_pages[$page_slug]->loaded_page_object();
         }
         return null;
     }
@@ -397,7 +397,7 @@ 
     private function _get_classname_for_admin_page($dir_name = '')
     {
         $class_name = str_replace('_', ' ', strtolower($dir_name));
-        return str_replace(' ', '_', ucwords($class_name)) . '_Admin_Page';
+        return str_replace(' ', '_', ucwords($class_name)).'_Admin_Page';
     }
 
 
@@ -411,7 +411,7 @@ 
     private function _get_classname_for_admin_init_page($dir_name = '')
     {
         $class_name = str_replace('_', ' ', strtolower($dir_name));
-        return str_replace(' ', '_', ucwords($class_name)) . '_Admin_Page_Init';
+        return str_replace(' ', '_', ucwords($class_name)).'_Admin_Page_Init';
     }
 
 
@@ -428,14 +428,14 @@ 
     {
         $class_name = $this->_get_classname_for_admin_init_page($page);
         EE_Registry::instance()->load_file($path, $class_name, 'core');
-        if (! class_exists($class_name)) {
+        if ( ! class_exists($class_name)) {
             $inner_error_msg = '<br />'
                                . sprintf(
                                    esc_html__(
                                        'Make sure you have %1$s defined. If this is a non-EE-core admin page then you also must have an autoloader in place for your class',
                                        'event_espresso'
                                    ),
-                                   '<strong>' . $class_name . '</strong>'
+                                   '<strong>'.$class_name.'</strong>'
                                );
             $error_msg[] = sprintf(
                 __('Something went wrong with loading the %s admin page.', 'event_espresso'),
@@ -515,7 +515,7 @@ 
                 // if we've got an array then the menu map is in the old format so let's throw a persistent notice that the admin system isn't setup correctly for this item.
                 if (is_array($page_map) || empty($page_map)) {
                     new PersistentAdminNotice(
-                        'menu_map_warning_' . str_replace(' ', '_', $page->label) . '_' . EVENT_ESPRESSO_VERSION,
+                        'menu_map_warning_'.str_replace(' ', '_', $page->label).'_'.EVENT_ESPRESSO_VERSION,
                         sprintf(
                             __(
                                 'The admin page for %s was not correctly setup because it is using an older method for integrating with Event Espresso Core.  This means that full functionality for this component is not available.  This error message usually appears with an Add-on that is out of date.  Make sure you update all your Event Espresso 4 add-ons to the latest version to ensure they have necessary compatibility updates in place.',
@@ -527,7 +527,7 @@ 
                     continue;
                 }
                 // if page map is NOT a EE_Admin_Page_Menu_Map object then throw error.
-                if (! $page_map instanceof EE_Admin_Page_Menu_Map) {
+                if ( ! $page_map instanceof EE_Admin_Page_Menu_Map) {
                     throw new EE_Error(
                         sprintf(
                             __(
@@ -546,7 +546,7 @@ 
                     continue;
                 }
                 // assign to group (remember $page_map has the admin page stored in it).
-                $pages_array[ $page_map->menu_group ][] = $page_map;
+                $pages_array[$page_map->menu_group][] = $page_map;
             }
         }
         if (empty($pages_array)) {
@@ -555,20 +555,20 @@ 
         // let's sort the groups, make sure it's a valid group, add header (if to show).
         foreach ($pages_array as $group => $menu_maps) {
             // valid_group?
-            if (! array_key_exists($group, $menu_groups)) {
+            if ( ! array_key_exists($group, $menu_groups)) {
                 continue;
             }
             // sort pages.
             usort($menu_maps, array($this, '_sort_menu_maps'));
             // prepend header
-            array_unshift($menu_maps, $menu_groups[ $group ]);
+            array_unshift($menu_maps, $menu_groups[$group]);
             // reset $pages_array with prepped data
-            $pages_array[ $group ] = $menu_maps;
+            $pages_array[$group] = $menu_maps;
         }
         // now let's setup the _prepped_menu_maps property
         foreach ($menu_groups as $group => $group_objs) {
-            if (isset($pages_array[ $group ])) {
-                $this->_prepped_menu_maps = array_merge($this->_prepped_menu_maps, $pages_array[ $group ]);
+            if (isset($pages_array[$group])) {
+                $this->_prepped_menu_maps = array_merge($this->_prepped_menu_maps, $pages_array[$group]);
             }
         }/**/
     }
@@ -596,26 +596,26 @@ 
     {
 
         // first let's check if there IS a caffeinated folder. If there is not then lets get out.
-        if (! is_dir(EE_PLUGIN_DIR_PATH . 'caffeinated/admin') || (defined('EE_DECAF') && EE_DECAF)) {
+        if ( ! is_dir(EE_PLUGIN_DIR_PATH.'caffeinated/admin') || (defined('EE_DECAF') && EE_DECAF)) {
             return $installed_refs;
         }
         $this->_define_caffeinated_constants();
         $exclude = array('tickets');
         // okay let's setup an "New" pages first (we'll return installed refs later)
-        $new_admin_screens = glob(EE_CORE_CAF_ADMIN . 'new/*', GLOB_ONLYDIR);
+        $new_admin_screens = glob(EE_CORE_CAF_ADMIN.'new/*', GLOB_ONLYDIR);
         if ($new_admin_screens) {
             foreach ($new_admin_screens as $admin_screen) {
                 // files and anything in the exclude array need not apply
                 if (is_dir($admin_screen) && ! in_array(basename($admin_screen), $exclude)) {
                     // these folders represent the different NEW EE admin pages
-                    $installed_refs[ basename($admin_screen) ] = $admin_screen;
+                    $installed_refs[basename($admin_screen)] = $admin_screen;
                     // set autoloaders for our admin page classes based on included path information
                     EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder($admin_screen);
                 }
             }
         }
         // let's see if there are any EXTENDS to setup in the $_caffeinated_extends array (that will be used later for hooking into the _initialize_admin_age in the related core_init admin page)
-        $extends = glob(EE_CORE_CAF_ADMIN . 'extend/*', GLOB_ONLYDIR);
+        $extends = glob(EE_CORE_CAF_ADMIN.'extend/*', GLOB_ONLYDIR);
         if ($extends) {
             foreach ($extends as $extend) {
                 if (is_dir($extend)) {
@@ -632,8 +632,8 @@ 
                             )
                         )
                     );
-                    $filename = 'Extend_' . $filename . '_Admin_Page';
-                    $this->_caffeinated_extends[ $extend_ref ]['path'] = str_replace(
+                    $filename = 'Extend_'.$filename.'_Admin_Page';
+                    $this->_caffeinated_extends[$extend_ref]['path'] = str_replace(
                         array('\\', '/'),
                         '/',
                         EE_CORE_CAF_ADMIN
@@ -643,7 +643,7 @@ 
                         . $filename
                         . '.core.php'
                     );
-                    $this->_caffeinated_extends[ $extend_ref ]['admin_page'] = $filename;
+                    $this->_caffeinated_extends[$extend_ref]['admin_page'] = $filename;
                     // set autoloaders for our admin page classes based on included path information
                     EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder($extend);
                 }
@@ -651,12 +651,12 @@ 
         }
         // let's see if there are any HOOK files and instantiate them if there are (so that hooks are loaded early!).
         $ee_admin_hooks = array();
-        $hooks = glob(EE_CORE_CAF_ADMIN . 'hooks/*.class.php');
+        $hooks = glob(EE_CORE_CAF_ADMIN.'hooks/*.class.php');
         if ($hooks) {
             foreach ($hooks as $hook) {
                 if (is_readable($hook)) {
                     require_once $hook;
-                    $classname = str_replace(EE_CORE_CAF_ADMIN . 'hooks/', '', $hook);
+                    $classname = str_replace(EE_CORE_CAF_ADMIN.'hooks/', '', $hook);
                     $classname = str_replace('.class.php', '', $classname);
                     if (class_exists($classname)) {
                         $a = new ReflectionClass($classname);

core/admin/EE_Admin_Page_Init.core.php

Indentation +420 added lines, -420 removed lines

@@ -13,424 +13,424 @@
 abstract class EE_Admin_Page_Init extends EE_Base
 {
 
-    // identity properties (set in _set_defaults and _set_init_properties)
-    public $label;
-
-    /**
-     * Menu map has a capability.  However, this allows admin pages to have separate capability requirements for menus
-     * and accessing pages.  If capability is NOT set, then it defaults to the menu_map capability.
-     *
-     * @var string
-     */
-    public $capability;
-
-
-    /**
-     * This holds the menu map object for this admin page.
-     *
-     * @var EE_Admin_Page_Menu_Map
-     */
-    protected $_menu_map;
-
-    /**
-     * deprecated
-     */
-    public $menu_label;
-    public $menu_slug;
-
-
-    // set in _set_defaults
-    protected $_folder_name;
-    protected $_folder_path;
-    protected $_file_name;
-    public $hook_file;
-    protected $_wp_page_slug;
-    protected $_routing;
-
-
-    // will hold page object.
-    protected $_loaded_page_object;
-
-
-    // for caf
-    protected $_files_hooked;
-    protected $_hook_paths;
-
-    // load_page?
-    private $_load_page;
-
-
-    /**
-     * @Constructor
-     * @access public
-     * @return void
-     */
-    public function __construct()
-    {
-        // set global defaults
-        $this->_set_defaults();
-        // set properties that are always available with objects.
-        $this->_set_init_properties();
-        // global styles/scripts across all wp admin pages
-        add_action('admin_enqueue_scripts', array($this, 'load_wp_global_scripts_styles'), 5);
-        // load initial stuff.
-        $this->_set_file_and_folder_name();
-        $this->_set_menu_map();
-        if (empty($this->_menu_map) || is_array($this->_menu_map)) {
-            EE_Error::doing_it_wrong(
-                get_class($this) . '::$_menu_map',
-                sprintf(
-                    __(
-                        'The EE4 addon with the class %s is setting up the _menu_map property incorrectly for this version of EE core.  Please see Admin_Page_Init class examples in core for the new way of setting this property up.',
-                        'event_espresso'
-                    ),
-                    get_class($this)
-                ),
-                '4.4.0'
-            );
-            return;
-        }
-        // set default capability
-        $this->_set_capability();
-    }
-
-
-    /**
-     * _set_init_properties
-     * Child classes use to set the following properties:
-     * $label
-     *
-     * @abstract
-     * @access protected
-     * @return void
-     */
-    abstract protected function _set_init_properties();
-
-
-    /**
-     * _set_menu_map is a function that child classes use to set the menu_map property (which should be an instance of
-     * EE_Admin_Page_Menu_Map.  Their menu can either be EE_Admin_Page_Main_Menu or EE_Admin_Page_Sub_Menu.
-     *
-     * @since 4.4.0
-     * @ return void.
-     */
-    protected function _set_menu_map()
-    {
-        return array();
-    }
-
-
-    /**
-     * returns the menu map for this admin page
-     *
-     * @since 4.4.0
-     * @return EE_Admin_Page_Menu_Map
-     */
-    public function get_menu_map()
-    {
-        return $this->_menu_map;
-    }
-
-
-    /**
-     * This loads scripts and styles for the EE_Admin system
-     * that must be available on ALL WP admin pages (i.e. EE_menu items)
-     *
-     * @return void
-     */
-    public function load_wp_global_scripts_styles()
-    {
-        wp_register_style(
-            'espresso_menu',
-            EE_ADMIN_URL . 'assets/admin-menu-styles.css',
-            array('dashicons'),
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_style('espresso_menu');
-    }
-
-
-    /**
-     * this sets default properties (might be overridden in _set_init_properties);
-     *
-     * @access private
-     * @return  void
-     */
-    private function _set_defaults()
-    {
-        $this->_file_name = $this->_folder_name = $this->_wp_page_slug = $this->capability = null;
-        $this->_routing = true;
-        $this->_load_page = false;
-        $this->_files_hooked = $this->_hook_paths = array();
-        // menu_map
-        $this->_menu_map = $this->get_menu_map();
-    }
-
-
-    protected function _set_capability()
-    {
-        $capability = empty($this->capability) ? $this->_menu_map->capability : $this->capability;
-        $this->capability = apply_filters('FHEE_' . $this->_menu_map->menu_slug . '_capability', $capability);
-    }
-
-
-    /**
-     * initialize_admin_page
-     * This method is what executes the loading of the specific page class for the given dir_name as called by the
-     * EE_Admin_Init class.
-     *
-     * @access  public
-     * @uses    _initialize_admin_page()
-     * @param  string $dir_name directory name for specific admin_page being loaded.
-     * @return void
-     */
-    public function initialize_admin_page()
-    {
-        // let's check user access first
-        $this->_check_user_access();
-        if (! is_object($this->_loaded_page_object)) {
-            return;
-        }
-        $this->_loaded_page_object->route_admin_request();
-        return;
-    }
-
-
-    public function set_page_dependencies($wp_page_slug)
-    {
-        if (! $this->_load_page) {
-            return;
-        }
-        if (! is_object($this->_loaded_page_object)) {
-            $msg[] = __(
-                'We can\'t load the page because we\'re missing a valid page object that tells us what to load',
-                'event_espresso'
-            );
-            $msg[] = $msg[0] . "\r\n"
-                     . sprintf(
-                         __(
-                             'The custom slug you have set for this page is %s. This means we\'re looking for the class %s_Admin_Page (found in %s_Admin_Page.core.php) within your %s directory',
-                             'event_espresso'
-                         ),
-                         $this->_file_name,
-                         $this->_file_name,
-                         $this->_folder_path . $this->_file_name,
-                         $this->_menu_map->menu_slug
-                     );
-            throw new EE_Error(implode('||', $msg));
-        }
-        $this->_loaded_page_object->set_wp_page_slug($wp_page_slug);
-        $page_hook = 'load-' . $wp_page_slug;
-        // hook into page load hook so all page specific stuff get's loaded.
-        if (! empty($wp_page_slug)) {
-            add_action($page_hook, array($this->_loaded_page_object, 'load_page_dependencies'));
-        }
-    }
-
-
-    /**
-     * This executes the intial page loads for EE_Admin pages to take care of any ajax or other code needing to run
-     * before the load-page... hook. Note, the page loads are happening around the wp_init hook.
-     *
-     * @return void
-     */
-    public function do_initial_loads()
-    {
-        // no loading or initializing if menu map is setup incorrectly.
-        if (empty($this->_menu_map) || is_array($this->_menu_map)) {
-            return;
-        }
-        $this->_initialize_admin_page();
-    }
-
-
-    /**
-     * all we're doing here is setting the $_file_name property for later use.
-     *
-     * @access private
-     * @return void
-     */
-    private function _set_file_and_folder_name()
-    {
-        $bt = debug_backtrace();
-        // for more reliable determination of folder name
-        // we're using this to get the actual folder name of the CALLING class (i.e. the child class that extends this).  Why?  Because $this->menu_slug may be different than the folder name (to avoid conflicts with other plugins)
-        $class = get_class($this);
-        foreach ($bt as $index => $values) {
-            if (isset($values['class']) && $values['class'] == $class) {
-                $file_index = $index - 1;
-                $this->_folder_name = basename(dirname($bt[ $file_index ]['file']));
-                if (! empty($this->_folder_name)) {
-                    break;
-                }
-            }
-        }
-        $this->_folder_path = EE_ADMIN_PAGES . $this->_folder_name . '/';
-        $this->_file_name = preg_replace('/^ee/', 'EE', $this->_folder_name);
-        $this->_file_name = ucwords(str_replace('_', ' ', $this->_file_name));
-        $this->_file_name = str_replace(' ', '_', $this->_file_name);
-    }
-
-
-    /**
-     * This automatically checks if we have a hook class in the loaded child directory.  If we DO then we will register
-     * it with the appropriate pages.  That way all we have to do is make sure the file is named correctly and
-     * "dropped" in. Example: if we wanted to set this up for Messages hooking into Events then we would do:
-     * events_Messages_Hooks.class.php
-     *
-     * @param bool $extend This indicates whether we're checking the extend directory for any register_hooks
-     *                     files/classes
-     * @return array
-     */
-    public function register_hooks($extend = false)
-    {
-
-        // get a list of files in the directory that have the "Hook" in their name an
-        // if this is an extended check (i.e. caf is active) then we will scan the caffeinated/extend directory first and any hook files that are found will be have their reference added to the $_files_hook array property.  Then, we make sure that when we loop through the core decaf directories to find hook files that we skip over any hooks files that have already been set by caf.
-        if ($extend) {
-            $hook_files_glob_path = apply_filters(
-                'FHEE__EE_Admin_Page_Init__register_hooks__hook_files_glob_path__extend',
-                EE_CORE_CAF_ADMIN_EXTEND
-                . $this->_folder_name
-                . '/*'
-                . $this->_file_name
-                . '_Hooks_Extend.class.php'
-            );
-            $this->_hook_paths = $this->_register_hook_files($hook_files_glob_path, $extend);
-        }
-        // loop through decaf folders
-        $hook_files_glob_path = apply_filters(
-            'FHEE__EE_Admin_Page_Init__register_hooks__hook_files_glob_path',
-            $this->_folder_path . '*' . $this->_file_name . '_Hooks.class.php'
-        );
-        $this->_hook_paths = array_merge(
-            $this->_register_hook_files($hook_files_glob_path),
-            $this->_hook_paths
-        );  // making sure any extended hook paths are later in the array than the core hook paths!
-        return $this->_hook_paths;
-    }
-
-
-    protected function _register_hook_files($hook_files_glob_path, $extend = false)
-    {
-        $hook_paths = array();
-        if ($hook_files = glob($hook_files_glob_path)) {
-            if (empty($hook_files)) {
-                return array();
-            }
-            foreach ($hook_files as $file) {
-                // lets get the linked admin.
-                $hook_file = $extend ? str_replace(EE_CORE_CAF_ADMIN_EXTEND . $this->_folder_name . '/', '', $file)
-                    : str_replace($this->_folder_path, '', $file);
-                $replace = $extend
-                    ? '_' . $this->_file_name . '_Hooks_Extend.class.php'
-                    : '_'
-                      . $this->_file_name
-                      . '_Hooks.class.php';
-                $rel_admin = str_replace($replace, '', $hook_file);
-                $rel_admin = strtolower($rel_admin);
-                $hook_paths[] = $file;
-                // make sure we haven't already got a hook setup for this page path
-                if (in_array($rel_admin, $this->_files_hooked)) {
-                    continue;
-                }
-                $this->hook_file = $hook_file;
-                $rel_admin_hook = 'FHEE_do_other_page_hooks_' . $rel_admin;
-                $filter = add_filter($rel_admin_hook, array($this, 'load_admin_hook'));
-                $this->_files_hooked[] = $rel_admin;
-            }
-        }
-        return $hook_paths;
-    }
-
-
-    public function load_admin_hook($registered_pages)
-    {
-        $this->hook_file;
-        $hook_file = (array) $this->hook_file;
-        return array_merge($hook_file, $registered_pages);
-    }
-
-
-    /**
-     * _initialize_admin_page
-     *
-     * @see  initialize_admin_page() for info
-     */
-    protected function _initialize_admin_page()
-    {
-
-        // JUST CHECK WE'RE ON RIGHT PAGE.
-        if ((! isset($_REQUEST['page']) || $_REQUEST['page'] != $this->_menu_map->menu_slug) && $this->_routing) {
-            return;
-        } //not on the right page so let's get out.
-        $this->_load_page = true;
-
-        // we don't need to do a page_request check here because it's only called via WP menu system.
-        $admin_page = $this->_file_name . '_Admin_Page';
-        $hook_suffix = $this->_menu_map->menu_slug . '_' . $admin_page;
-        $admin_page = apply_filters(
-            "FHEE__EE_Admin_Page_Init___initialize_admin_page__admin_page__{$hook_suffix}",
-            $admin_page
-        );
-        // define requested admin page class name then load the file and instantiate
-        $path_to_file = str_replace(array('\\', '/'), '/', $this->_folder_path . $admin_page . '.core.php');
-        $path_to_file = apply_filters(
-            "FHEE__EE_Admin_Page_Init___initialize_admin_page__path_to_file__{$hook_suffix}",
-            $path_to_file
-        );// so if the file would be in EE_ADMIN/attendees/Attendee_Admin_Page.core.php, the filter would be FHEE__EE_Admin_Page_Init___initialize_admin_page__path_to_file__attendees_Attendee_Admin_Page
-        if (is_readable($path_to_file)) {
-            // This is a place where EE plugins can hook in to make sure their own files are required in the appropriate place
-            do_action('AHEE__EE_Admin_Page___initialize_admin_page__before_initialization');
-            do_action(
-                'AHEE__EE_Admin_Page___initialize_admin_page__before_initialization_' . $this->_menu_map->menu_slug
-            );
-            require_once($path_to_file);
-            $a = new ReflectionClass($admin_page);
-            $this->_loaded_page_object = $a->newInstance($this->_routing);
-        }
-        do_action('AHEE__EE_Admin_Page___initialize_admin_page__after_initialization');
-        do_action('AHEE__EE_Admin_Page___initialize_admin_page__after_initialization_' . $this->_menu_map->menu_slug);
-    }
-
-
-    public function get_admin_page_name()
-    {
-        return $this->_file_name . '_Admin_Page';
-    }
-
-
-    /**
-     * @return mixed
-     */
-    public function loaded_page_object()
-    {
-        return $this->_loaded_page_object;
-    }
-
-
-    // public function set_autoloaders($className)
-    // {
-    //     $dir_ref = array(
-    //         $this->_folder_path => array('core', 'class'),
-    //     );
-    //     EEH_Autoloader::try_autoload($dir_ref, $className);
-    // }
-    /**
-     * _check_user_access
-     * verifies user access for this admin page.  If no user access is available then let's gracefully exit with a
-     * WordPress die message.
-     *
-     * @return bool|die true if pass (or admin) wp_die if fail
-     */
-    private function _check_user_access()
-    {
-        if (! EE_Registry::instance()->CAP->current_user_can(
-            $this->_menu_map->capability,
-            $this->_menu_map->menu_slug
-        )) {
-            wp_die(__('You don\'t have access to this page.', 'event_espresso'), '', array('back_link' => true));
-        }
-        return true;
-    }
+	// identity properties (set in _set_defaults and _set_init_properties)
+	public $label;
+
+	/**
+	 * Menu map has a capability.  However, this allows admin pages to have separate capability requirements for menus
+	 * and accessing pages.  If capability is NOT set, then it defaults to the menu_map capability.
+	 *
+	 * @var string
+	 */
+	public $capability;
+
+
+	/**
+	 * This holds the menu map object for this admin page.
+	 *
+	 * @var EE_Admin_Page_Menu_Map
+	 */
+	protected $_menu_map;
+
+	/**
+	 * deprecated
+	 */
+	public $menu_label;
+	public $menu_slug;
+
+
+	// set in _set_defaults
+	protected $_folder_name;
+	protected $_folder_path;
+	protected $_file_name;
+	public $hook_file;
+	protected $_wp_page_slug;
+	protected $_routing;
+
+
+	// will hold page object.
+	protected $_loaded_page_object;
+
+
+	// for caf
+	protected $_files_hooked;
+	protected $_hook_paths;
+
+	// load_page?
+	private $_load_page;
+
+
+	/**
+	 * @Constructor
+	 * @access public
+	 * @return void
+	 */
+	public function __construct()
+	{
+		// set global defaults
+		$this->_set_defaults();
+		// set properties that are always available with objects.
+		$this->_set_init_properties();
+		// global styles/scripts across all wp admin pages
+		add_action('admin_enqueue_scripts', array($this, 'load_wp_global_scripts_styles'), 5);
+		// load initial stuff.
+		$this->_set_file_and_folder_name();
+		$this->_set_menu_map();
+		if (empty($this->_menu_map) || is_array($this->_menu_map)) {
+			EE_Error::doing_it_wrong(
+				get_class($this) . '::$_menu_map',
+				sprintf(
+					__(
+						'The EE4 addon with the class %s is setting up the _menu_map property incorrectly for this version of EE core.  Please see Admin_Page_Init class examples in core for the new way of setting this property up.',
+						'event_espresso'
+					),
+					get_class($this)
+				),
+				'4.4.0'
+			);
+			return;
+		}
+		// set default capability
+		$this->_set_capability();
+	}
+
+
+	/**
+	 * _set_init_properties
+	 * Child classes use to set the following properties:
+	 * $label
+	 *
+	 * @abstract
+	 * @access protected
+	 * @return void
+	 */
+	abstract protected function _set_init_properties();
+
+
+	/**
+	 * _set_menu_map is a function that child classes use to set the menu_map property (which should be an instance of
+	 * EE_Admin_Page_Menu_Map.  Their menu can either be EE_Admin_Page_Main_Menu or EE_Admin_Page_Sub_Menu.
+	 *
+	 * @since 4.4.0
+	 * @ return void.
+	 */
+	protected function _set_menu_map()
+	{
+		return array();
+	}
+
+
+	/**
+	 * returns the menu map for this admin page
+	 *
+	 * @since 4.4.0
+	 * @return EE_Admin_Page_Menu_Map
+	 */
+	public function get_menu_map()
+	{
+		return $this->_menu_map;
+	}
+
+
+	/**
+	 * This loads scripts and styles for the EE_Admin system
+	 * that must be available on ALL WP admin pages (i.e. EE_menu items)
+	 *
+	 * @return void
+	 */
+	public function load_wp_global_scripts_styles()
+	{
+		wp_register_style(
+			'espresso_menu',
+			EE_ADMIN_URL . 'assets/admin-menu-styles.css',
+			array('dashicons'),
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_style('espresso_menu');
+	}
+
+
+	/**
+	 * this sets default properties (might be overridden in _set_init_properties);
+	 *
+	 * @access private
+	 * @return  void
+	 */
+	private function _set_defaults()
+	{
+		$this->_file_name = $this->_folder_name = $this->_wp_page_slug = $this->capability = null;
+		$this->_routing = true;
+		$this->_load_page = false;
+		$this->_files_hooked = $this->_hook_paths = array();
+		// menu_map
+		$this->_menu_map = $this->get_menu_map();
+	}
+
+
+	protected function _set_capability()
+	{
+		$capability = empty($this->capability) ? $this->_menu_map->capability : $this->capability;
+		$this->capability = apply_filters('FHEE_' . $this->_menu_map->menu_slug . '_capability', $capability);
+	}
+
+
+	/**
+	 * initialize_admin_page
+	 * This method is what executes the loading of the specific page class for the given dir_name as called by the
+	 * EE_Admin_Init class.
+	 *
+	 * @access  public
+	 * @uses    _initialize_admin_page()
+	 * @param  string $dir_name directory name for specific admin_page being loaded.
+	 * @return void
+	 */
+	public function initialize_admin_page()
+	{
+		// let's check user access first
+		$this->_check_user_access();
+		if (! is_object($this->_loaded_page_object)) {
+			return;
+		}
+		$this->_loaded_page_object->route_admin_request();
+		return;
+	}
+
+
+	public function set_page_dependencies($wp_page_slug)
+	{
+		if (! $this->_load_page) {
+			return;
+		}
+		if (! is_object($this->_loaded_page_object)) {
+			$msg[] = __(
+				'We can\'t load the page because we\'re missing a valid page object that tells us what to load',
+				'event_espresso'
+			);
+			$msg[] = $msg[0] . "\r\n"
+					 . sprintf(
+						 __(
+							 'The custom slug you have set for this page is %s. This means we\'re looking for the class %s_Admin_Page (found in %s_Admin_Page.core.php) within your %s directory',
+							 'event_espresso'
+						 ),
+						 $this->_file_name,
+						 $this->_file_name,
+						 $this->_folder_path . $this->_file_name,
+						 $this->_menu_map->menu_slug
+					 );
+			throw new EE_Error(implode('||', $msg));
+		}
+		$this->_loaded_page_object->set_wp_page_slug($wp_page_slug);
+		$page_hook = 'load-' . $wp_page_slug;
+		// hook into page load hook so all page specific stuff get's loaded.
+		if (! empty($wp_page_slug)) {
+			add_action($page_hook, array($this->_loaded_page_object, 'load_page_dependencies'));
+		}
+	}
+
+
+	/**
+	 * This executes the intial page loads for EE_Admin pages to take care of any ajax or other code needing to run
+	 * before the load-page... hook. Note, the page loads are happening around the wp_init hook.
+	 *
+	 * @return void
+	 */
+	public function do_initial_loads()
+	{
+		// no loading or initializing if menu map is setup incorrectly.
+		if (empty($this->_menu_map) || is_array($this->_menu_map)) {
+			return;
+		}
+		$this->_initialize_admin_page();
+	}
+
+
+	/**
+	 * all we're doing here is setting the $_file_name property for later use.
+	 *
+	 * @access private
+	 * @return void
+	 */
+	private function _set_file_and_folder_name()
+	{
+		$bt = debug_backtrace();
+		// for more reliable determination of folder name
+		// we're using this to get the actual folder name of the CALLING class (i.e. the child class that extends this).  Why?  Because $this->menu_slug may be different than the folder name (to avoid conflicts with other plugins)
+		$class = get_class($this);
+		foreach ($bt as $index => $values) {
+			if (isset($values['class']) && $values['class'] == $class) {
+				$file_index = $index - 1;
+				$this->_folder_name = basename(dirname($bt[ $file_index ]['file']));
+				if (! empty($this->_folder_name)) {
+					break;
+				}
+			}
+		}
+		$this->_folder_path = EE_ADMIN_PAGES . $this->_folder_name . '/';
+		$this->_file_name = preg_replace('/^ee/', 'EE', $this->_folder_name);
+		$this->_file_name = ucwords(str_replace('_', ' ', $this->_file_name));
+		$this->_file_name = str_replace(' ', '_', $this->_file_name);
+	}
+
+
+	/**
+	 * This automatically checks if we have a hook class in the loaded child directory.  If we DO then we will register
+	 * it with the appropriate pages.  That way all we have to do is make sure the file is named correctly and
+	 * "dropped" in. Example: if we wanted to set this up for Messages hooking into Events then we would do:
+	 * events_Messages_Hooks.class.php
+	 *
+	 * @param bool $extend This indicates whether we're checking the extend directory for any register_hooks
+	 *                     files/classes
+	 * @return array
+	 */
+	public function register_hooks($extend = false)
+	{
+
+		// get a list of files in the directory that have the "Hook" in their name an
+		// if this is an extended check (i.e. caf is active) then we will scan the caffeinated/extend directory first and any hook files that are found will be have their reference added to the $_files_hook array property.  Then, we make sure that when we loop through the core decaf directories to find hook files that we skip over any hooks files that have already been set by caf.
+		if ($extend) {
+			$hook_files_glob_path = apply_filters(
+				'FHEE__EE_Admin_Page_Init__register_hooks__hook_files_glob_path__extend',
+				EE_CORE_CAF_ADMIN_EXTEND
+				. $this->_folder_name
+				. '/*'
+				. $this->_file_name
+				. '_Hooks_Extend.class.php'
+			);
+			$this->_hook_paths = $this->_register_hook_files($hook_files_glob_path, $extend);
+		}
+		// loop through decaf folders
+		$hook_files_glob_path = apply_filters(
+			'FHEE__EE_Admin_Page_Init__register_hooks__hook_files_glob_path',
+			$this->_folder_path . '*' . $this->_file_name . '_Hooks.class.php'
+		);
+		$this->_hook_paths = array_merge(
+			$this->_register_hook_files($hook_files_glob_path),
+			$this->_hook_paths
+		);  // making sure any extended hook paths are later in the array than the core hook paths!
+		return $this->_hook_paths;
+	}
+
+
+	protected function _register_hook_files($hook_files_glob_path, $extend = false)
+	{
+		$hook_paths = array();
+		if ($hook_files = glob($hook_files_glob_path)) {
+			if (empty($hook_files)) {
+				return array();
+			}
+			foreach ($hook_files as $file) {
+				// lets get the linked admin.
+				$hook_file = $extend ? str_replace(EE_CORE_CAF_ADMIN_EXTEND . $this->_folder_name . '/', '', $file)
+					: str_replace($this->_folder_path, '', $file);
+				$replace = $extend
+					? '_' . $this->_file_name . '_Hooks_Extend.class.php'
+					: '_'
+					  . $this->_file_name
+					  . '_Hooks.class.php';
+				$rel_admin = str_replace($replace, '', $hook_file);
+				$rel_admin = strtolower($rel_admin);
+				$hook_paths[] = $file;
+				// make sure we haven't already got a hook setup for this page path
+				if (in_array($rel_admin, $this->_files_hooked)) {
+					continue;
+				}
+				$this->hook_file = $hook_file;
+				$rel_admin_hook = 'FHEE_do_other_page_hooks_' . $rel_admin;
+				$filter = add_filter($rel_admin_hook, array($this, 'load_admin_hook'));
+				$this->_files_hooked[] = $rel_admin;
+			}
+		}
+		return $hook_paths;
+	}
+
+
+	public function load_admin_hook($registered_pages)
+	{
+		$this->hook_file;
+		$hook_file = (array) $this->hook_file;
+		return array_merge($hook_file, $registered_pages);
+	}
+
+
+	/**
+	 * _initialize_admin_page
+	 *
+	 * @see  initialize_admin_page() for info
+	 */
+	protected function _initialize_admin_page()
+	{
+
+		// JUST CHECK WE'RE ON RIGHT PAGE.
+		if ((! isset($_REQUEST['page']) || $_REQUEST['page'] != $this->_menu_map->menu_slug) && $this->_routing) {
+			return;
+		} //not on the right page so let's get out.
+		$this->_load_page = true;
+
+		// we don't need to do a page_request check here because it's only called via WP menu system.
+		$admin_page = $this->_file_name . '_Admin_Page';
+		$hook_suffix = $this->_menu_map->menu_slug . '_' . $admin_page;
+		$admin_page = apply_filters(
+			"FHEE__EE_Admin_Page_Init___initialize_admin_page__admin_page__{$hook_suffix}",
+			$admin_page
+		);
+		// define requested admin page class name then load the file and instantiate
+		$path_to_file = str_replace(array('\\', '/'), '/', $this->_folder_path . $admin_page . '.core.php');
+		$path_to_file = apply_filters(
+			"FHEE__EE_Admin_Page_Init___initialize_admin_page__path_to_file__{$hook_suffix}",
+			$path_to_file
+		);// so if the file would be in EE_ADMIN/attendees/Attendee_Admin_Page.core.php, the filter would be FHEE__EE_Admin_Page_Init___initialize_admin_page__path_to_file__attendees_Attendee_Admin_Page
+		if (is_readable($path_to_file)) {
+			// This is a place where EE plugins can hook in to make sure their own files are required in the appropriate place
+			do_action('AHEE__EE_Admin_Page___initialize_admin_page__before_initialization');
+			do_action(
+				'AHEE__EE_Admin_Page___initialize_admin_page__before_initialization_' . $this->_menu_map->menu_slug
+			);
+			require_once($path_to_file);
+			$a = new ReflectionClass($admin_page);
+			$this->_loaded_page_object = $a->newInstance($this->_routing);
+		}
+		do_action('AHEE__EE_Admin_Page___initialize_admin_page__after_initialization');
+		do_action('AHEE__EE_Admin_Page___initialize_admin_page__after_initialization_' . $this->_menu_map->menu_slug);
+	}
+
+
+	public function get_admin_page_name()
+	{
+		return $this->_file_name . '_Admin_Page';
+	}
+
+
+	/**
+	 * @return mixed
+	 */
+	public function loaded_page_object()
+	{
+		return $this->_loaded_page_object;
+	}
+
+
+	// public function set_autoloaders($className)
+	// {
+	//     $dir_ref = array(
+	//         $this->_folder_path => array('core', 'class'),
+	//     );
+	//     EEH_Autoloader::try_autoload($dir_ref, $className);
+	// }
+	/**
+	 * _check_user_access
+	 * verifies user access for this admin page.  If no user access is available then let's gracefully exit with a
+	 * WordPress die message.
+	 *
+	 * @return bool|die true if pass (or admin) wp_die if fail
+	 */
+	private function _check_user_access()
+	{
+		if (! EE_Registry::instance()->CAP->current_user_can(
+			$this->_menu_map->capability,
+			$this->_menu_map->menu_slug
+		)) {
+			wp_die(__('You don\'t have access to this page.', 'event_espresso'), '', array('back_link' => true));
+		}
+		return true;
+	}
 }

Spacing +27 added lines, -27 removed lines

@@ -78,7 +78,7 @@ 
         $this->_set_menu_map();
         if (empty($this->_menu_map) || is_array($this->_menu_map)) {
             EE_Error::doing_it_wrong(
-                get_class($this) . '::$_menu_map',
+                get_class($this).'::$_menu_map',
                 sprintf(
                     __(
                         'The EE4 addon with the class %s is setting up the _menu_map property incorrectly for this version of EE core.  Please see Admin_Page_Init class examples in core for the new way of setting this property up.',
@@ -142,7 +142,7 @@ 
     {
         wp_register_style(
             'espresso_menu',
-            EE_ADMIN_URL . 'assets/admin-menu-styles.css',
+            EE_ADMIN_URL.'assets/admin-menu-styles.css',
             array('dashicons'),
             EVENT_ESPRESSO_VERSION
         );
@@ -170,7 +170,7 @@ 
     protected function _set_capability()
     {
         $capability = empty($this->capability) ? $this->_menu_map->capability : $this->capability;
-        $this->capability = apply_filters('FHEE_' . $this->_menu_map->menu_slug . '_capability', $capability);
+        $this->capability = apply_filters('FHEE_'.$this->_menu_map->menu_slug.'_capability', $capability);
     }
 
 
@@ -188,7 +188,7 @@ 
     {
         // let's check user access first
         $this->_check_user_access();
-        if (! is_object($this->_loaded_page_object)) {
+        if ( ! is_object($this->_loaded_page_object)) {
             return;
         }
         $this->_loaded_page_object->route_admin_request();
@@ -198,15 +198,15 @@ 
 
     public function set_page_dependencies($wp_page_slug)
     {
-        if (! $this->_load_page) {
+        if ( ! $this->_load_page) {
             return;
         }
-        if (! is_object($this->_loaded_page_object)) {
+        if ( ! is_object($this->_loaded_page_object)) {
             $msg[] = __(
                 'We can\'t load the page because we\'re missing a valid page object that tells us what to load',
                 'event_espresso'
             );
-            $msg[] = $msg[0] . "\r\n"
+            $msg[] = $msg[0]."\r\n"
                      . sprintf(
                          __(
                              'The custom slug you have set for this page is %s. This means we\'re looking for the class %s_Admin_Page (found in %s_Admin_Page.core.php) within your %s directory',
@@ -214,15 +214,15 @@ 
                          ),
                          $this->_file_name,
                          $this->_file_name,
-                         $this->_folder_path . $this->_file_name,
+                         $this->_folder_path.$this->_file_name,
                          $this->_menu_map->menu_slug
                      );
             throw new EE_Error(implode('||', $msg));
         }
         $this->_loaded_page_object->set_wp_page_slug($wp_page_slug);
-        $page_hook = 'load-' . $wp_page_slug;
+        $page_hook = 'load-'.$wp_page_slug;
         // hook into page load hook so all page specific stuff get's loaded.
-        if (! empty($wp_page_slug)) {
+        if ( ! empty($wp_page_slug)) {
             add_action($page_hook, array($this->_loaded_page_object, 'load_page_dependencies'));
         }
     }
@@ -259,13 +259,13 @@ 
         foreach ($bt as $index => $values) {
             if (isset($values['class']) && $values['class'] == $class) {
                 $file_index = $index - 1;
-                $this->_folder_name = basename(dirname($bt[ $file_index ]['file']));
-                if (! empty($this->_folder_name)) {
+                $this->_folder_name = basename(dirname($bt[$file_index]['file']));
+                if ( ! empty($this->_folder_name)) {
                     break;
                 }
             }
         }
-        $this->_folder_path = EE_ADMIN_PAGES . $this->_folder_name . '/';
+        $this->_folder_path = EE_ADMIN_PAGES.$this->_folder_name.'/';
         $this->_file_name = preg_replace('/^ee/', 'EE', $this->_folder_name);
         $this->_file_name = ucwords(str_replace('_', ' ', $this->_file_name));
         $this->_file_name = str_replace(' ', '_', $this->_file_name);
@@ -301,12 +301,12 @@ 
         // loop through decaf folders
         $hook_files_glob_path = apply_filters(
             'FHEE__EE_Admin_Page_Init__register_hooks__hook_files_glob_path',
-            $this->_folder_path . '*' . $this->_file_name . '_Hooks.class.php'
+            $this->_folder_path.'*'.$this->_file_name.'_Hooks.class.php'
         );
         $this->_hook_paths = array_merge(
             $this->_register_hook_files($hook_files_glob_path),
             $this->_hook_paths
-        );  // making sure any extended hook paths are later in the array than the core hook paths!
+        ); // making sure any extended hook paths are later in the array than the core hook paths!
         return $this->_hook_paths;
     }
 
@@ -320,10 +320,10 @@ 
             }
             foreach ($hook_files as $file) {
                 // lets get the linked admin.
-                $hook_file = $extend ? str_replace(EE_CORE_CAF_ADMIN_EXTEND . $this->_folder_name . '/', '', $file)
+                $hook_file = $extend ? str_replace(EE_CORE_CAF_ADMIN_EXTEND.$this->_folder_name.'/', '', $file)
                     : str_replace($this->_folder_path, '', $file);
                 $replace = $extend
-                    ? '_' . $this->_file_name . '_Hooks_Extend.class.php'
+                    ? '_'.$this->_file_name.'_Hooks_Extend.class.php'
                     : '_'
                       . $this->_file_name
                       . '_Hooks.class.php';
@@ -335,7 +335,7 @@ 
                     continue;
                 }
                 $this->hook_file = $hook_file;
-                $rel_admin_hook = 'FHEE_do_other_page_hooks_' . $rel_admin;
+                $rel_admin_hook = 'FHEE_do_other_page_hooks_'.$rel_admin;
                 $filter = add_filter($rel_admin_hook, array($this, 'load_admin_hook'));
                 $this->_files_hooked[] = $rel_admin;
             }
@@ -361,42 +361,42 @@ 
     {
 
         // JUST CHECK WE'RE ON RIGHT PAGE.
-        if ((! isset($_REQUEST['page']) || $_REQUEST['page'] != $this->_menu_map->menu_slug) && $this->_routing) {
+        if (( ! isset($_REQUEST['page']) || $_REQUEST['page'] != $this->_menu_map->menu_slug) && $this->_routing) {
             return;
         } //not on the right page so let's get out.
         $this->_load_page = true;
 
         // we don't need to do a page_request check here because it's only called via WP menu system.
-        $admin_page = $this->_file_name . '_Admin_Page';
-        $hook_suffix = $this->_menu_map->menu_slug . '_' . $admin_page;
+        $admin_page = $this->_file_name.'_Admin_Page';
+        $hook_suffix = $this->_menu_map->menu_slug.'_'.$admin_page;
         $admin_page = apply_filters(
             "FHEE__EE_Admin_Page_Init___initialize_admin_page__admin_page__{$hook_suffix}",
             $admin_page
         );
         // define requested admin page class name then load the file and instantiate
-        $path_to_file = str_replace(array('\\', '/'), '/', $this->_folder_path . $admin_page . '.core.php');
+        $path_to_file = str_replace(array('\\', '/'), '/', $this->_folder_path.$admin_page.'.core.php');
         $path_to_file = apply_filters(
             "FHEE__EE_Admin_Page_Init___initialize_admin_page__path_to_file__{$hook_suffix}",
             $path_to_file
-        );// so if the file would be in EE_ADMIN/attendees/Attendee_Admin_Page.core.php, the filter would be FHEE__EE_Admin_Page_Init___initialize_admin_page__path_to_file__attendees_Attendee_Admin_Page
+        ); // so if the file would be in EE_ADMIN/attendees/Attendee_Admin_Page.core.php, the filter would be FHEE__EE_Admin_Page_Init___initialize_admin_page__path_to_file__attendees_Attendee_Admin_Page
         if (is_readable($path_to_file)) {
             // This is a place where EE plugins can hook in to make sure their own files are required in the appropriate place
             do_action('AHEE__EE_Admin_Page___initialize_admin_page__before_initialization');
             do_action(
-                'AHEE__EE_Admin_Page___initialize_admin_page__before_initialization_' . $this->_menu_map->menu_slug
+                'AHEE__EE_Admin_Page___initialize_admin_page__before_initialization_'.$this->_menu_map->menu_slug
             );
             require_once($path_to_file);
             $a = new ReflectionClass($admin_page);
             $this->_loaded_page_object = $a->newInstance($this->_routing);
         }
         do_action('AHEE__EE_Admin_Page___initialize_admin_page__after_initialization');
-        do_action('AHEE__EE_Admin_Page___initialize_admin_page__after_initialization_' . $this->_menu_map->menu_slug);
+        do_action('AHEE__EE_Admin_Page___initialize_admin_page__after_initialization_'.$this->_menu_map->menu_slug);
     }
 
 
     public function get_admin_page_name()
     {
-        return $this->_file_name . '_Admin_Page';
+        return $this->_file_name.'_Admin_Page';
     }
 
 
@@ -425,7 +425,7 @@ 
      */
     private function _check_user_access()
     {
-        if (! EE_Registry::instance()->CAP->current_user_can(
+        if ( ! EE_Registry::instance()->CAP->current_user_can(
             $this->_menu_map->capability,
             $this->_menu_map->menu_slug
         )) {

core/admin/EE_Admin_Hooks.core.php

Indentation +718 added lines, -718 removed lines

@@ -13,722 +13,722 @@
 {
 
 
-    /**
-     * we're just going to use this to hold the name of the caller class (child class name)
-     *
-     * @var string
-     */
-    public $caller;
-
-
-    /**
-     * this is just a flag set automatically to indicate whether we've got an extended hook class running (i.e.
-     * espresso_events_Registration_Form_Hooks_Extend extends espresso_events_Registration_Form_Hooks).  This flag is
-     * used later to make sure we require the needed files.
-     *
-     * @var bool
-     */
-    protected $_extend;
-
-
-    /**
-     * child classes MUST set this property so that the page object can be loaded correctly
-     *
-     * @var string
-     */
-    protected $_name;
-
-
-    /**
-     * This is set by child classes and is an associative array of ajax hooks in the format:
-     * array(
-     *    'ajax_action_ref' => 'executing_method'; //must be public
-     * )
-     *
-     * @var array
-     */
-    protected $_ajax_func;
-
-
-    /**
-     * This is an array of methods that get executed on a page routes admin_init hook. Use the following format:
-     * array(
-     *    'page_route' => 'executing_method' //must be public
-     * )
-     *
-     * @var array
-     */
-    protected $_init_func;
-
-
-    /**
-     * This is an array of methods that output metabox content for the given page route.  Use the following format:
-     * array(
-     *    0 => array(
-     *        'page_route' => 'string_for_page_route', //must correspond to a page route in the class being connected
-     *        with (i.e. "edit_event") If this is in an array then the same params below will be used but the metabox
-     *        will be added to each route.
-     *        'func' =>  'executing_method',  //must be public (i.e. public function executing_method($post,
-     *        $callback_args){} ).  Note if you include callback args in the array then you need to declare them in the
-     *        method arguments.
-     *        'id' => 'identifier_for_metabox', //so it can be removed by addons (optional, class will set it
-     *        automatically)
-     *        'priority' => 'default', //default 'default' (optional)
-     *        'label' => __('Localized Title', 'event_espresso'),
-     *        'context' => 'advanced' //advanced is default (optional),
-     *    'callback_args' => array() //any callback args to include (optional)
-     * )
-     * Why are we indexing numerically?  Because it's possible there may be more than one metabox per page_route.
-     *
-     * @var array
-     */
-    protected $_metaboxes;
-
-
-    /**
-     * This is an array of values that indicate any metaboxes we want removed from a given page route.  Usually this is
-     * used when caffeinated functionality is replacing decaffeinated functionality.  Use the following format for the
-     * array: array(
-     *    0 => array(
-     *        'page_route' => 'string_for_page_route' //can be string or array of strings that match a page_route(s)
-     *        that are in the class being connected with (i.e. 'edit', or 'create_new').
-     *        'id' => 'identifier_for_metabox', //what the id is of the metabox being removed
-     *        'context' => 'normal', //the context for the metabox being removed (has to match)
-     *        'screen' => 'screen_id', //(optional), if not included then this class will attempt to remove the metabox
-     *        using the currently loaded screen object->id  however, there may be cases where you have to specify the
-     *        id for the screen the metabox is on.
-     *    )
-     * )
-     *
-     * @var array
-     */
-    protected $_remove_metaboxes;
-
-
-    /**
-     * This parent class takes care of loading the scripts and styles if the child class has set the properties for
-     * them in the following format.  Note, the first array index ('register') is for defining all the registers.  The
-     * second array index is for indicating what routes each script/style loads on. array(
-     * 'registers' => array(
-     *        'script_ref' => array( // if more than one script is to be loaded its best to use the 'dependency'
-     *        argument to link scripts together.
-     *            'type' => 'js' // 'js' or 'css' (defaults to js).  This tells us what type of wp_function to use
-     *            'url' => 'http://urltoscript.css.js',
-     *            'depends' => array('jquery'), //an array of dependencies for the scripts. REMEMBER, if a script has
-     *            already been registered elsewhere in the system.  You can just use the depends array to make sure it
-     *            gets loaded before the one you are setting here.
-     *            'footer' => TRUE //defaults to true (styles don't use this parameter)
-     *        ),
-     *    'enqueues' => array( //this time each key corresponds to the script ref followed by an array of page routes
-     *    the script gets enqueued on.
-     *        'script_ref' => array('route_one', 'route_two')
-     *    ),
-     *    'localize' => array( //this allows you to set a localize object.  Indicate which script the object is being
-     *    attached to and then include an array indexed by the name of the object and the array of key/value pairs for
-     *    the object.
-     *        'scrip_ref' => array(
-     *            'NAME_OF_JS_OBJECT' => array(
-     *                'translate_ref' => __('localized_string', 'event_espresso'),
-     *                'some_data' => 5
-     *            )
-     *        )
-     *    )
-     * )
-     *
-     * @var array
-     */
-    protected $_scripts_styles;
-
-
-    /**
-     * This is a property that will contain the current route.
-     *
-     * @var string;
-     */
-    protected $_current_route;
-
-
-    /**
-     * this optional property can be set by child classes to override the priority for the automatic action/filter hook
-     * loading in the `_load_routed_hooks()` method.  Please follow this format: array(
-     *    'wp_hook_reference' => 1
-     *    )
-     * )
-     *
-     * @var array
-     */
-    protected $_wp_action_filters_priority;
-
-
-    /**
-     * This just holds a merged array of the $_POST and $_GET vars in favor of $_POST
-     *
-     * @var array
-     */
-    protected $_req_data;
-
-
-    /**
-     * This just holds an instance of the page object for this hook
-     *
-     * @var EE_Admin_Page
-     */
-    protected $_page_object;
-
-
-    /**
-     * This holds the EE_Admin_Page object from the calling admin page that this object hooks into.
-     *
-     * @var EE_Admin_Page|EE_Admin_Page_CPT
-     */
-    protected $_adminpage_obj;
-
-
-    /**
-     * Holds EE_Registry object
-     *
-     * @var EE_Registry
-     */
-    protected $EE = null;
-
-
-    /**
-     * constructor
-     *
-     * @param EE_Admin_Page $admin_page the calling admin_page_object
-     */
-    public function __construct(EE_Admin_Page $adminpage)
-    {
-
-        $this->_adminpage_obj = $adminpage;
-        $this->_req_data = array_merge($_GET, $_POST);
-        $this->_set_defaults();
-        $this->_set_hooks_properties();
-        // first let's verify we're on the right page
-        if (! isset($this->_req_data['page'])
-            || (isset($this->_req_data['page'])
-                && $this->_adminpage_obj->page_slug
-                   != $this->_req_data['page'])) {
-            return;
-        } //get out nothing more to be done here.
-        // allow for extends to modify properties
-        if (method_exists($this, '_extend_properties')) {
-            $this->_extend_properties();
-        }
-        $this->_set_page_object();
-        $this->_init_hooks();
-        $this->_load_custom_methods();
-        $this->_load_routed_hooks();
-        add_action('admin_enqueue_scripts', array($this, 'enqueue_scripts_styles'));
-        add_action('admin_enqueue_scripts', array($this, 'add_metaboxes'), 20);
-        add_action('admin_enqueue_scripts', array($this, 'remove_metaboxes'), 15);
-        $this->_ajax_hooks();
-    }
-
-
-    /**
-     * used by child classes to set the following properties:
-     * $_ajax_func (optional)
-     * $_init_func (optional)
-     * $_metaboxes (optional)
-     * $_scripts (optional)
-     * $_styles (optional)
-     * $_name (required)
-     * Also in this method will be registered any scripts or styles loaded on the targeted page (as indicated in the
-     * _scripts/_styles properties) Also children should place in this method any filters/actions that have to happen
-     * really early on page load (just after admin_init) if they want to have them registered for handling early.
-     *
-     * @access protected
-     * @abstract
-     * @return void
-     */
-    abstract protected function _set_hooks_properties();
-
-
-    /**
-     * The hooks for enqueue_scripts and enqueue_styles will be run in here.  Child classes need to define their
-     * scripts and styles in the relevant $_scripts and $_styles properties.  Child classes must have also already
-     * registered the scripts and styles using wp_register_script and wp_register_style functions.
-     *
-     * @access public
-     * @return void
-     */
-    public function enqueue_scripts_styles()
-    {
-
-        if (! empty($this->_scripts_styles)) {
-            // first let's do all the registrations
-            if (! isset($this->_scripts_styles['registers'])) {
-                $msg[] = __(
-                    'There is no "registers" index in the <code>$this->_scripts_styles</code> property.',
-                    'event_espresso'
-                );
-                $msg[] = sprintf(
-                    __(
-                        'Make sure you read the phpdoc comments above the definition of the $_scripts_styles property in the <code>EE_Admin_Hooks</code> class and modify according in the %s child',
-                        'event_espresso'
-                    ),
-                    '<strong>' . $this->caller . '</strong>'
-                );
-                throw new EE_Error(implode('||', $msg));
-            }
-            foreach ($this->_scripts_styles['registers'] as $ref => $details) {
-                $defaults = array(
-                    'type'    => 'js',
-                    'url'     => '',
-                    'depends' => array(),
-                    'version' => EVENT_ESPRESSO_VERSION,
-                    'footer'  => true,
-                );
-                $details = wp_parse_args($details, $defaults);
-                extract($details);
-                // let's make sure that we set the 'registers' type if it's not set! We need it later to determine whhich enqueu we do
-                $this->_scripts_styles['registers'][ $ref ]['type'] = $type;
-                // let's make sure we're not missing any REQUIRED parameters
-                if (empty($url)) {
-                    $msg[] = sprintf(
-                        __('Missing the url for the requested %s', 'event_espresso'),
-                        $type == 'js' ? 'script' : 'stylesheet'
-                    );
-                    $msg[] = sprintf(
-                        __(
-                            'Doublecheck your <code>$this->_scripts_styles</code> array in %s and make sure that there is a "url" set for the %s ref',
-                            'event_espresso'
-                        ),
-                        '<strong>' . $this->caller . '</strong>',
-                        $ref
-                    );
-                    throw new EE_Error(implode('||', $msg));
-                }
-                // made it here so let's do the appropriate registration
-                $type == 'js'
-                    ? wp_register_script($ref, $url, $depends, $version, $footer)
-                    : wp_register_style(
-                        $ref,
-                        $url,
-                        $depends,
-                        $version
-                    );
-            }
-            // k now lets do the enqueues
-            if (! isset($this->_scripts_styles['enqueues'])) {
-                return;
-            }  //not sure if we should throw an error here or not.
-
-            foreach ($this->_scripts_styles['enqueues'] as $ref => $routes) {
-                // make sure $routes is an array
-                $routes = (array) $routes;
-                if (in_array($this->_current_route, $routes)) {
-                    $this->_scripts_styles['registers'][ $ref ]['type'] == 'js' ? wp_enqueue_script($ref)
-                        : wp_enqueue_style($ref);
-                    // if we have a localization for the script let's do that too.
-                    if (isset($this->_scripts_styles['localize'][ $ref ])) {
-                        foreach ($this->_scripts_styles['localize'][ $ref ] as $object_name => $indexes) {
-                            wp_localize_script(
-                                $ref,
-                                $object_name,
-                                $this->_scripts_styles['localize'][ $ref ][ $object_name ]
-                            );
-                        }
-                    }
-                }
-            }
-            // let's do the deregisters
-            if (! isset($this->_scripts_styles['deregisters'])) {
-                return;
-            }
-            foreach ($this->_scripts_styles['deregisters'] as $ref => $details) {
-                $defaults = array(
-                    'type' => 'js',
-                );
-                $details = wp_parse_args($details, $defaults);
-                extract($details);
-                $type == 'js' ? wp_deregister_script($ref) : wp_deregister_style($ref);
-            }
-        }
-    }
-
-
-    /**
-     * just set the defaults for the hooks properties.
-     *
-     * @access private
-     * @return void
-     */
-    private function _set_defaults()
-    {
-        $this->_ajax_func = $this->_init_func = $this->_metaboxes = $this->_scripts = $this->_styles = $this->_wp_action_filters_priority = array();
-        $this->_current_route = $this->getCurrentRoute();
-        $this->caller = get_class($this);
-        $this->_extend = stripos($this->caller, 'Extend') ? true : false;
-    }
-
-
-    /**
-     * A helper for determining the current route.
-     * @return string
-     */
-    private function getCurrentRoute()
-    {
-        // list tables do something else with 'action' for bulk actions.
-        $action = ! empty($_REQUEST['action']) && $_REQUEST['action'] !== '-1' ? $_REQUEST['action'] : 'default';
-        // we set a 'route' variable in some cases where action is being used by something else.
-        $action = $action === 'default' && isset($_REQUEST['route']) ? $_REQUEST['route'] : $action;
-        return sanitize_key($action);
-    }
-
-
-    /**
-     * this sets the _page_object property
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _set_page_object()
-    {
-        // first make sure $this->_name is set
-        if (empty($this->_name)) {
-            $msg[] = __('We can\'t load the page object', 'event_espresso');
-            $msg[] = sprintf(
-                __("This is because the %s child class has not set the '_name' property", 'event_espresso'),
-                $this->caller
-            );
-            throw new EE_Error(implode('||', $msg));
-        }
-        $ref = str_replace('_', ' ', $this->_name); // take the_message -> the message
-        $ref = str_replace(' ', '_', ucwords($ref)) . '_Admin_Page'; // take the message -> The_Message
-        // first default file (if exists)
-        $decaf_file = EE_ADMIN_PAGES . $this->_name . '/' . $ref . '.core.php';
-        if (is_readable($decaf_file)) {
-            require_once($decaf_file);
-        }
-        // now we have to do require for extended file (if needed)
-        if ($this->_extend) {
-            require_once(EE_CORE_CAF_ADMIN_EXTEND . $this->_name . '/Extend_' . $ref . '.core.php');
-        }
-        // if we've got an extended class we use that!
-        $ref = $this->_extend ? 'Extend_' . $ref : $ref;
-        // let's make sure the class exists
-        if (! class_exists($ref)) {
-            $msg[] = __('We can\'t load the page object', 'event_espresso');
-            $msg[] = sprintf(
-                __(
-                    'The class name that was given is %s. Check the spelling and make sure its correct, also there needs to be an autoloader setup for the class',
-                    'event_espresso'
-                ),
-                $ref
-            );
-            throw new EE_Error(implode('||', $msg));
-        }
-        $a = new ReflectionClass($ref);
-        $this->_page_object = $a->newInstance(false);
-    }
-
-
-    /**
-     * Child "hook" classes can declare any methods that they want executed when a specific page route is loaded.  The
-     * advantage of this is when doing things like running our own db interactions on saves etc.  Remember that
-     * $this->_req_data (all the _POST and _GET data) is available to your methods.
-     *
-     * @access private
-     * @return void
-     */
-    private function _load_custom_methods()
-    {
-        /**
-         * method cannot be named 'default' (@see http://us3.php
-         * .net/manual/en/reserved.keywords.php) so need to
-         * handle routes that are "default"
-         *
-         * @since 4.3.0
-         */
-        $method_callback = $this->_current_route == 'default' ? 'default_callback' : $this->_current_route;
-        // these run before the Admin_Page route executes.
-        if (method_exists($this, $method_callback)) {
-            call_user_func(array($this, $method_callback));
-        }
-        // these run via the _redirect_after_action method in EE_Admin_Page which usually happens after non_UI methods in EE_Admin_Page classes.  There are two redirect actions, the first fires before $query_args might be manipulated by "save and close" actions and the seond fires right before the actual redirect happens.
-        // first the actions
-        // note that these action hooks will have the $query_args value available.
-        $admin_class_name = get_class($this->_adminpage_obj);
-        if (method_exists($this, '_redirect_action_early_' . $this->_current_route)) {
-            add_action(
-                'AHEE__'
-                . $admin_class_name
-                . '___redirect_after_action__before_redirect_modification_'
-                . $this->_current_route,
-                array($this, '_redirect_action_early_' . $this->_current_route),
-                10
-            );
-        }
-        if (method_exists($this, '_redirect_action_' . $this->_current_route)) {
-            add_action(
-                'AHEE_redirect_' . $admin_class_name . $this->_current_route,
-                array($this, '_redirect_action_' . $this->_current_route),
-                10
-            );
-        }
-        // let's hook into the _redirect itself and allow for changing where the user goes after redirect.  This will have $query_args and $redirect_url available.
-        if (method_exists($this, '_redirect_filter_' . $this->_current_route)) {
-            add_filter(
-                'FHEE_redirect_' . $admin_class_name . $this->_current_route,
-                array($this, '_redirect_filter_' . $this->_current_route),
-                10,
-                2
-            );
-        }
-    }
-
-
-    /**
-     * This method will search for a corresponding method with a name matching the route and the wp_hook to run.  This
-     * allows child hook classes to target hooking into a specific wp action or filter hook ONLY on a certain route.
-     * just remember, methods MUST be public Future hooks should be added in here to be access by child classes.
-     *
-     * @return void
-     */
-    private function _load_routed_hooks()
-    {
-
-        // this array provides the hook action names that will be referenced.  Key is the action. Value is an array with the type (action or filter) and the number of parameters for the hook.  We'll default all priorities for automatic hooks to 10.
-        $hook_filter_array = array(
-            'admin_footer'                                                                            => array(
-                'type'     => 'action',
-                'argnum'   => 1,
-                'priority' => 10,
-            ),
-            'FHEE_list_table_views_' . $this->_adminpage_obj->page_slug . '_' . $this->_current_route => array(
-                'type'     => 'filter',
-                'argnum'   => 1,
-                'priority' => 10,
-            ),
-            'FHEE_list_table_views_' . $this->_adminpage_obj->page_slug                               => array(
-                'type'     => 'filter',
-                'argnum'   => 1,
-                'priority' => 10,
-            ),
-            'FHEE_list_table_views'                                                                   => array(
-                'type'     => 'filter',
-                'argnum'   => 1,
-                'priority' => 10,
-            ),
-            'AHEE__EE_Admin_Page___display_admin_page__modify_metaboxes'                              => array(
-                'type'     => 'action',
-                'argnum'   => 1,
-                'priority' => 10,
-            ),
-        );
-        foreach ($hook_filter_array as $hook => $args) {
-            if (method_exists($this, $this->_current_route . '_' . $hook)) {
-                if (isset($this->_wp_action_filters_priority[ $hook ])) {
-                    $args['priority'] = $this->_wp_action_filters_priority[ $hook ];
-                }
-                if ($args['type'] == 'action') {
-                    add_action(
-                        $hook,
-                        array($this, $this->_current_route . '_' . $hook),
-                        $args['priority'],
-                        $args['argnum']
-                    );
-                } else {
-                    add_filter(
-                        $hook,
-                        array($this, $this->_current_route . '_' . $hook),
-                        $args['priority'],
-                        $args['argnum']
-                    );
-                }
-            }
-        }
-    }
-
-
-    /**
-     * Loop throught the $_ajax_func array and add_actions for the array.
-     *
-     * @return void
-     */
-    private function _ajax_hooks()
-    {
-
-        if (empty($this->_ajax_func)) {
-            return;
-        } //get out there's nothing to take care of.
-        foreach ($this->_ajax_func as $action => $method) {
-            // make sure method exists
-            if (! method_exists($this, $method)) {
-                $msg[] = __(
-                    'There is no corresponding method for the hook labeled in the _ajax_func array',
-                    'event_espresso'
-                ) . '<br />';
-                $msg[] = sprintf(
-                    __(
-                        'The method name given in the array is %s, check the spelling and make sure it exists in the %s class',
-                        'event_espresso'
-                    ),
-                    $method,
-                    $this->caller
-                );
-                throw new EE_Error(implode('||', $msg));
-            }
-            add_action('wp_ajax_' . $action, array($this, $method));
-        }
-    }
-
-
-    /**
-     * Loop throught the $_init_func array and add_actions for the array.
-     *
-     * @return void
-     */
-    protected function _init_hooks()
-    {
-        if (empty($this->_init_func)) {
-            return;
-        } //get out there's nothing to take care of.
-        // We need to determine what page_route we are on!
-        $current_route = isset($_REQUEST['action']) ? $_REQUEST['action'] : 'default';
-        foreach ($this->_init_func as $route => $method) {
-            // make sure method exists
-            if (! method_exists($this, $method)) {
-                $msg[] = __(
-                    'There is no corresponding method for the hook labeled in the _init_func array',
-                    'event_espresso'
-                ) . '<br />';
-                $msg[] = sprintf(
-                    __(
-                        'The method name given in the array is %s, check the spelling and make sure it exists in the %s class',
-                        'event_espresso'
-                    ),
-                    $method,
-                    $this->caller
-                );
-                throw new EE_Error(implode('||', $msg));
-            }
-            if ($route == $this->_current_route) {
-                add_action('admin_init', array($this, $method));
-            }
-        }
-    }
-
-
-    /**
-     * Loop through the _metaboxes property and add_metaboxes accordingly
-     * //todo we could eventually make this a config component class (i.e. new EE_Metabox);
-     *
-     * @access public
-     * @return void
-     */
-    public function add_metaboxes()
-    {
-        if (empty($this->_metaboxes)) {
-            return;
-        } //get out we don't have any metaboxes to set for this connection
-        $this->_handle_metabox_array($this->_metaboxes);
-    }
-
-
-    private function _handle_metabox_array($boxes, $add = true)
-    {
-
-        foreach ($boxes as $box) {
-            if (! isset($box['page_route'])) {
-                continue;
-            } //we dont' have a valid array
-            // let's make sure $box['page_route'] is an array so the "foreach" will work.
-            $box['page_route'] = (array) $box['page_route'];
-            foreach ($box['page_route'] as $route) {
-                if ($route != $this->_current_route) {
-                    continue;
-                } //get out we only add metaboxes for set route.
-                if ($add) {
-                    $this->_add_metabox($box);
-                } else {
-                    $this->_remove_metabox($box);
-                }
-            }
-        }
-    }
-
-
-    /**
-     * Loop through the _remove_metaboxes property and remove metaboxes accordingly.
-     *
-     * @access public
-     * @return void
-     */
-    public function remove_metaboxes()
-    {
-
-        if (empty($this->_remove_metaboxes)) {
-            return;
-        } //get out there are no metaboxes to remove
-        $this->_handle_metabox_array($this->_remove_metaboxes, false);
-    }
-
-
-    /**
-     * This just handles adding a metabox
-     *
-     * @access private
-     * @param array $args an array of args that have been set for this metabox by the child class
-     */
-    private function _add_metabox($args)
-    {
-        $current_screen = get_current_screen();
-        $screen_id = is_object($current_screen) ? $current_screen->id : null;
-        $func = isset($args['func']) ? $args['func'] : 'some_invalid_callback';
-        // set defaults
-        $defaults = array(
-            'func'          => $func,
-            'id'            => $this->caller . '_' . $func . '_metabox',
-            'priority'      => 'default',
-            'label'         => $this->caller,
-            'context'       => 'advanced',
-            'callback_args' => array(),
-            'page'          => isset($args['page']) ? $args['page'] : $screen_id,
-        );
-        $args = wp_parse_args($args, $defaults);
-        extract($args);
-        // make sure method exists
-        if (! method_exists($this, $func)) {
-            $msg[] = __('There is no corresponding method to display the metabox content', 'event_espresso') . '<br />';
-            $msg[] = sprintf(
-                __(
-                    'The method name given in the array is %s, check the spelling and make sure it exists in the %s class',
-                    'event_espresso'
-                ),
-                $func,
-                $this->caller
-            );
-            throw new EE_Error(implode('||', $msg));
-        }
-        // everything checks out so lets add the metabox
-        add_meta_box($id, $label, array($this, $func), $page, $context, $priority, $callback_args);
-    }
-
-
-    private function _remove_metabox($args)
-    {
-        $current_screen = get_current_screen();
-        $screen_id = is_object($current_screen) ? $current_screen->id : null;
-        $func = isset($args['func']) ? $args['func'] : 'some_invalid_callback';
-        // set defaults
-        $defaults = array(
-            'id'      => isset($args['id'])
-                ? $args['id']
-                : $this->_current_route
-                  . '_'
-                  . $this->caller
-                  . '_'
-                  . $func
-                  . '_metabox',
-            'context' => 'default',
-            'screen'  => isset($args['screen']) ? $args['screen'] : $screen_id,
-        );
-        $args = wp_parse_args($args, $defaults);
-        extract($args);
-        // everything checks out so lets remove the box!
-        remove_meta_box($id, $screen, $context);
-    }
+	/**
+	 * we're just going to use this to hold the name of the caller class (child class name)
+	 *
+	 * @var string
+	 */
+	public $caller;
+
+
+	/**
+	 * this is just a flag set automatically to indicate whether we've got an extended hook class running (i.e.
+	 * espresso_events_Registration_Form_Hooks_Extend extends espresso_events_Registration_Form_Hooks).  This flag is
+	 * used later to make sure we require the needed files.
+	 *
+	 * @var bool
+	 */
+	protected $_extend;
+
+
+	/**
+	 * child classes MUST set this property so that the page object can be loaded correctly
+	 *
+	 * @var string
+	 */
+	protected $_name;
+
+
+	/**
+	 * This is set by child classes and is an associative array of ajax hooks in the format:
+	 * array(
+	 *    'ajax_action_ref' => 'executing_method'; //must be public
+	 * )
+	 *
+	 * @var array
+	 */
+	protected $_ajax_func;
+
+
+	/**
+	 * This is an array of methods that get executed on a page routes admin_init hook. Use the following format:
+	 * array(
+	 *    'page_route' => 'executing_method' //must be public
+	 * )
+	 *
+	 * @var array
+	 */
+	protected $_init_func;
+
+
+	/**
+	 * This is an array of methods that output metabox content for the given page route.  Use the following format:
+	 * array(
+	 *    0 => array(
+	 *        'page_route' => 'string_for_page_route', //must correspond to a page route in the class being connected
+	 *        with (i.e. "edit_event") If this is in an array then the same params below will be used but the metabox
+	 *        will be added to each route.
+	 *        'func' =>  'executing_method',  //must be public (i.e. public function executing_method($post,
+	 *        $callback_args){} ).  Note if you include callback args in the array then you need to declare them in the
+	 *        method arguments.
+	 *        'id' => 'identifier_for_metabox', //so it can be removed by addons (optional, class will set it
+	 *        automatically)
+	 *        'priority' => 'default', //default 'default' (optional)
+	 *        'label' => __('Localized Title', 'event_espresso'),
+	 *        'context' => 'advanced' //advanced is default (optional),
+	 *    'callback_args' => array() //any callback args to include (optional)
+	 * )
+	 * Why are we indexing numerically?  Because it's possible there may be more than one metabox per page_route.
+	 *
+	 * @var array
+	 */
+	protected $_metaboxes;
+
+
+	/**
+	 * This is an array of values that indicate any metaboxes we want removed from a given page route.  Usually this is
+	 * used when caffeinated functionality is replacing decaffeinated functionality.  Use the following format for the
+	 * array: array(
+	 *    0 => array(
+	 *        'page_route' => 'string_for_page_route' //can be string or array of strings that match a page_route(s)
+	 *        that are in the class being connected with (i.e. 'edit', or 'create_new').
+	 *        'id' => 'identifier_for_metabox', //what the id is of the metabox being removed
+	 *        'context' => 'normal', //the context for the metabox being removed (has to match)
+	 *        'screen' => 'screen_id', //(optional), if not included then this class will attempt to remove the metabox
+	 *        using the currently loaded screen object->id  however, there may be cases where you have to specify the
+	 *        id for the screen the metabox is on.
+	 *    )
+	 * )
+	 *
+	 * @var array
+	 */
+	protected $_remove_metaboxes;
+
+
+	/**
+	 * This parent class takes care of loading the scripts and styles if the child class has set the properties for
+	 * them in the following format.  Note, the first array index ('register') is for defining all the registers.  The
+	 * second array index is for indicating what routes each script/style loads on. array(
+	 * 'registers' => array(
+	 *        'script_ref' => array( // if more than one script is to be loaded its best to use the 'dependency'
+	 *        argument to link scripts together.
+	 *            'type' => 'js' // 'js' or 'css' (defaults to js).  This tells us what type of wp_function to use
+	 *            'url' => 'http://urltoscript.css.js',
+	 *            'depends' => array('jquery'), //an array of dependencies for the scripts. REMEMBER, if a script has
+	 *            already been registered elsewhere in the system.  You can just use the depends array to make sure it
+	 *            gets loaded before the one you are setting here.
+	 *            'footer' => TRUE //defaults to true (styles don't use this parameter)
+	 *        ),
+	 *    'enqueues' => array( //this time each key corresponds to the script ref followed by an array of page routes
+	 *    the script gets enqueued on.
+	 *        'script_ref' => array('route_one', 'route_two')
+	 *    ),
+	 *    'localize' => array( //this allows you to set a localize object.  Indicate which script the object is being
+	 *    attached to and then include an array indexed by the name of the object and the array of key/value pairs for
+	 *    the object.
+	 *        'scrip_ref' => array(
+	 *            'NAME_OF_JS_OBJECT' => array(
+	 *                'translate_ref' => __('localized_string', 'event_espresso'),
+	 *                'some_data' => 5
+	 *            )
+	 *        )
+	 *    )
+	 * )
+	 *
+	 * @var array
+	 */
+	protected $_scripts_styles;
+
+
+	/**
+	 * This is a property that will contain the current route.
+	 *
+	 * @var string;
+	 */
+	protected $_current_route;
+
+
+	/**
+	 * this optional property can be set by child classes to override the priority for the automatic action/filter hook
+	 * loading in the `_load_routed_hooks()` method.  Please follow this format: array(
+	 *    'wp_hook_reference' => 1
+	 *    )
+	 * )
+	 *
+	 * @var array
+	 */
+	protected $_wp_action_filters_priority;
+
+
+	/**
+	 * This just holds a merged array of the $_POST and $_GET vars in favor of $_POST
+	 *
+	 * @var array
+	 */
+	protected $_req_data;
+
+
+	/**
+	 * This just holds an instance of the page object for this hook
+	 *
+	 * @var EE_Admin_Page
+	 */
+	protected $_page_object;
+
+
+	/**
+	 * This holds the EE_Admin_Page object from the calling admin page that this object hooks into.
+	 *
+	 * @var EE_Admin_Page|EE_Admin_Page_CPT
+	 */
+	protected $_adminpage_obj;
+
+
+	/**
+	 * Holds EE_Registry object
+	 *
+	 * @var EE_Registry
+	 */
+	protected $EE = null;
+
+
+	/**
+	 * constructor
+	 *
+	 * @param EE_Admin_Page $admin_page the calling admin_page_object
+	 */
+	public function __construct(EE_Admin_Page $adminpage)
+	{
+
+		$this->_adminpage_obj = $adminpage;
+		$this->_req_data = array_merge($_GET, $_POST);
+		$this->_set_defaults();
+		$this->_set_hooks_properties();
+		// first let's verify we're on the right page
+		if (! isset($this->_req_data['page'])
+			|| (isset($this->_req_data['page'])
+				&& $this->_adminpage_obj->page_slug
+				   != $this->_req_data['page'])) {
+			return;
+		} //get out nothing more to be done here.
+		// allow for extends to modify properties
+		if (method_exists($this, '_extend_properties')) {
+			$this->_extend_properties();
+		}
+		$this->_set_page_object();
+		$this->_init_hooks();
+		$this->_load_custom_methods();
+		$this->_load_routed_hooks();
+		add_action('admin_enqueue_scripts', array($this, 'enqueue_scripts_styles'));
+		add_action('admin_enqueue_scripts', array($this, 'add_metaboxes'), 20);
+		add_action('admin_enqueue_scripts', array($this, 'remove_metaboxes'), 15);
+		$this->_ajax_hooks();
+	}
+
+
+	/**
+	 * used by child classes to set the following properties:
+	 * $_ajax_func (optional)
+	 * $_init_func (optional)
+	 * $_metaboxes (optional)
+	 * $_scripts (optional)
+	 * $_styles (optional)
+	 * $_name (required)
+	 * Also in this method will be registered any scripts or styles loaded on the targeted page (as indicated in the
+	 * _scripts/_styles properties) Also children should place in this method any filters/actions that have to happen
+	 * really early on page load (just after admin_init) if they want to have them registered for handling early.
+	 *
+	 * @access protected
+	 * @abstract
+	 * @return void
+	 */
+	abstract protected function _set_hooks_properties();
+
+
+	/**
+	 * The hooks for enqueue_scripts and enqueue_styles will be run in here.  Child classes need to define their
+	 * scripts and styles in the relevant $_scripts and $_styles properties.  Child classes must have also already
+	 * registered the scripts and styles using wp_register_script and wp_register_style functions.
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function enqueue_scripts_styles()
+	{
+
+		if (! empty($this->_scripts_styles)) {
+			// first let's do all the registrations
+			if (! isset($this->_scripts_styles['registers'])) {
+				$msg[] = __(
+					'There is no "registers" index in the <code>$this->_scripts_styles</code> property.',
+					'event_espresso'
+				);
+				$msg[] = sprintf(
+					__(
+						'Make sure you read the phpdoc comments above the definition of the $_scripts_styles property in the <code>EE_Admin_Hooks</code> class and modify according in the %s child',
+						'event_espresso'
+					),
+					'<strong>' . $this->caller . '</strong>'
+				);
+				throw new EE_Error(implode('||', $msg));
+			}
+			foreach ($this->_scripts_styles['registers'] as $ref => $details) {
+				$defaults = array(
+					'type'    => 'js',
+					'url'     => '',
+					'depends' => array(),
+					'version' => EVENT_ESPRESSO_VERSION,
+					'footer'  => true,
+				);
+				$details = wp_parse_args($details, $defaults);
+				extract($details);
+				// let's make sure that we set the 'registers' type if it's not set! We need it later to determine whhich enqueu we do
+				$this->_scripts_styles['registers'][ $ref ]['type'] = $type;
+				// let's make sure we're not missing any REQUIRED parameters
+				if (empty($url)) {
+					$msg[] = sprintf(
+						__('Missing the url for the requested %s', 'event_espresso'),
+						$type == 'js' ? 'script' : 'stylesheet'
+					);
+					$msg[] = sprintf(
+						__(
+							'Doublecheck your <code>$this->_scripts_styles</code> array in %s and make sure that there is a "url" set for the %s ref',
+							'event_espresso'
+						),
+						'<strong>' . $this->caller . '</strong>',
+						$ref
+					);
+					throw new EE_Error(implode('||', $msg));
+				}
+				// made it here so let's do the appropriate registration
+				$type == 'js'
+					? wp_register_script($ref, $url, $depends, $version, $footer)
+					: wp_register_style(
+						$ref,
+						$url,
+						$depends,
+						$version
+					);
+			}
+			// k now lets do the enqueues
+			if (! isset($this->_scripts_styles['enqueues'])) {
+				return;
+			}  //not sure if we should throw an error here or not.
+
+			foreach ($this->_scripts_styles['enqueues'] as $ref => $routes) {
+				// make sure $routes is an array
+				$routes = (array) $routes;
+				if (in_array($this->_current_route, $routes)) {
+					$this->_scripts_styles['registers'][ $ref ]['type'] == 'js' ? wp_enqueue_script($ref)
+						: wp_enqueue_style($ref);
+					// if we have a localization for the script let's do that too.
+					if (isset($this->_scripts_styles['localize'][ $ref ])) {
+						foreach ($this->_scripts_styles['localize'][ $ref ] as $object_name => $indexes) {
+							wp_localize_script(
+								$ref,
+								$object_name,
+								$this->_scripts_styles['localize'][ $ref ][ $object_name ]
+							);
+						}
+					}
+				}
+			}
+			// let's do the deregisters
+			if (! isset($this->_scripts_styles['deregisters'])) {
+				return;
+			}
+			foreach ($this->_scripts_styles['deregisters'] as $ref => $details) {
+				$defaults = array(
+					'type' => 'js',
+				);
+				$details = wp_parse_args($details, $defaults);
+				extract($details);
+				$type == 'js' ? wp_deregister_script($ref) : wp_deregister_style($ref);
+			}
+		}
+	}
+
+
+	/**
+	 * just set the defaults for the hooks properties.
+	 *
+	 * @access private
+	 * @return void
+	 */
+	private function _set_defaults()
+	{
+		$this->_ajax_func = $this->_init_func = $this->_metaboxes = $this->_scripts = $this->_styles = $this->_wp_action_filters_priority = array();
+		$this->_current_route = $this->getCurrentRoute();
+		$this->caller = get_class($this);
+		$this->_extend = stripos($this->caller, 'Extend') ? true : false;
+	}
+
+
+	/**
+	 * A helper for determining the current route.
+	 * @return string
+	 */
+	private function getCurrentRoute()
+	{
+		// list tables do something else with 'action' for bulk actions.
+		$action = ! empty($_REQUEST['action']) && $_REQUEST['action'] !== '-1' ? $_REQUEST['action'] : 'default';
+		// we set a 'route' variable in some cases where action is being used by something else.
+		$action = $action === 'default' && isset($_REQUEST['route']) ? $_REQUEST['route'] : $action;
+		return sanitize_key($action);
+	}
+
+
+	/**
+	 * this sets the _page_object property
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _set_page_object()
+	{
+		// first make sure $this->_name is set
+		if (empty($this->_name)) {
+			$msg[] = __('We can\'t load the page object', 'event_espresso');
+			$msg[] = sprintf(
+				__("This is because the %s child class has not set the '_name' property", 'event_espresso'),
+				$this->caller
+			);
+			throw new EE_Error(implode('||', $msg));
+		}
+		$ref = str_replace('_', ' ', $this->_name); // take the_message -> the message
+		$ref = str_replace(' ', '_', ucwords($ref)) . '_Admin_Page'; // take the message -> The_Message
+		// first default file (if exists)
+		$decaf_file = EE_ADMIN_PAGES . $this->_name . '/' . $ref . '.core.php';
+		if (is_readable($decaf_file)) {
+			require_once($decaf_file);
+		}
+		// now we have to do require for extended file (if needed)
+		if ($this->_extend) {
+			require_once(EE_CORE_CAF_ADMIN_EXTEND . $this->_name . '/Extend_' . $ref . '.core.php');
+		}
+		// if we've got an extended class we use that!
+		$ref = $this->_extend ? 'Extend_' . $ref : $ref;
+		// let's make sure the class exists
+		if (! class_exists($ref)) {
+			$msg[] = __('We can\'t load the page object', 'event_espresso');
+			$msg[] = sprintf(
+				__(
+					'The class name that was given is %s. Check the spelling and make sure its correct, also there needs to be an autoloader setup for the class',
+					'event_espresso'
+				),
+				$ref
+			);
+			throw new EE_Error(implode('||', $msg));
+		}
+		$a = new ReflectionClass($ref);
+		$this->_page_object = $a->newInstance(false);
+	}
+
+
+	/**
+	 * Child "hook" classes can declare any methods that they want executed when a specific page route is loaded.  The
+	 * advantage of this is when doing things like running our own db interactions on saves etc.  Remember that
+	 * $this->_req_data (all the _POST and _GET data) is available to your methods.
+	 *
+	 * @access private
+	 * @return void
+	 */
+	private function _load_custom_methods()
+	{
+		/**
+		 * method cannot be named 'default' (@see http://us3.php
+		 * .net/manual/en/reserved.keywords.php) so need to
+		 * handle routes that are "default"
+		 *
+		 * @since 4.3.0
+		 */
+		$method_callback = $this->_current_route == 'default' ? 'default_callback' : $this->_current_route;
+		// these run before the Admin_Page route executes.
+		if (method_exists($this, $method_callback)) {
+			call_user_func(array($this, $method_callback));
+		}
+		// these run via the _redirect_after_action method in EE_Admin_Page which usually happens after non_UI methods in EE_Admin_Page classes.  There are two redirect actions, the first fires before $query_args might be manipulated by "save and close" actions and the seond fires right before the actual redirect happens.
+		// first the actions
+		// note that these action hooks will have the $query_args value available.
+		$admin_class_name = get_class($this->_adminpage_obj);
+		if (method_exists($this, '_redirect_action_early_' . $this->_current_route)) {
+			add_action(
+				'AHEE__'
+				. $admin_class_name
+				. '___redirect_after_action__before_redirect_modification_'
+				. $this->_current_route,
+				array($this, '_redirect_action_early_' . $this->_current_route),
+				10
+			);
+		}
+		if (method_exists($this, '_redirect_action_' . $this->_current_route)) {
+			add_action(
+				'AHEE_redirect_' . $admin_class_name . $this->_current_route,
+				array($this, '_redirect_action_' . $this->_current_route),
+				10
+			);
+		}
+		// let's hook into the _redirect itself and allow for changing where the user goes after redirect.  This will have $query_args and $redirect_url available.
+		if (method_exists($this, '_redirect_filter_' . $this->_current_route)) {
+			add_filter(
+				'FHEE_redirect_' . $admin_class_name . $this->_current_route,
+				array($this, '_redirect_filter_' . $this->_current_route),
+				10,
+				2
+			);
+		}
+	}
+
+
+	/**
+	 * This method will search for a corresponding method with a name matching the route and the wp_hook to run.  This
+	 * allows child hook classes to target hooking into a specific wp action or filter hook ONLY on a certain route.
+	 * just remember, methods MUST be public Future hooks should be added in here to be access by child classes.
+	 *
+	 * @return void
+	 */
+	private function _load_routed_hooks()
+	{
+
+		// this array provides the hook action names that will be referenced.  Key is the action. Value is an array with the type (action or filter) and the number of parameters for the hook.  We'll default all priorities for automatic hooks to 10.
+		$hook_filter_array = array(
+			'admin_footer'                                                                            => array(
+				'type'     => 'action',
+				'argnum'   => 1,
+				'priority' => 10,
+			),
+			'FHEE_list_table_views_' . $this->_adminpage_obj->page_slug . '_' . $this->_current_route => array(
+				'type'     => 'filter',
+				'argnum'   => 1,
+				'priority' => 10,
+			),
+			'FHEE_list_table_views_' . $this->_adminpage_obj->page_slug                               => array(
+				'type'     => 'filter',
+				'argnum'   => 1,
+				'priority' => 10,
+			),
+			'FHEE_list_table_views'                                                                   => array(
+				'type'     => 'filter',
+				'argnum'   => 1,
+				'priority' => 10,
+			),
+			'AHEE__EE_Admin_Page___display_admin_page__modify_metaboxes'                              => array(
+				'type'     => 'action',
+				'argnum'   => 1,
+				'priority' => 10,
+			),
+		);
+		foreach ($hook_filter_array as $hook => $args) {
+			if (method_exists($this, $this->_current_route . '_' . $hook)) {
+				if (isset($this->_wp_action_filters_priority[ $hook ])) {
+					$args['priority'] = $this->_wp_action_filters_priority[ $hook ];
+				}
+				if ($args['type'] == 'action') {
+					add_action(
+						$hook,
+						array($this, $this->_current_route . '_' . $hook),
+						$args['priority'],
+						$args['argnum']
+					);
+				} else {
+					add_filter(
+						$hook,
+						array($this, $this->_current_route . '_' . $hook),
+						$args['priority'],
+						$args['argnum']
+					);
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * Loop throught the $_ajax_func array and add_actions for the array.
+	 *
+	 * @return void
+	 */
+	private function _ajax_hooks()
+	{
+
+		if (empty($this->_ajax_func)) {
+			return;
+		} //get out there's nothing to take care of.
+		foreach ($this->_ajax_func as $action => $method) {
+			// make sure method exists
+			if (! method_exists($this, $method)) {
+				$msg[] = __(
+					'There is no corresponding method for the hook labeled in the _ajax_func array',
+					'event_espresso'
+				) . '<br />';
+				$msg[] = sprintf(
+					__(
+						'The method name given in the array is %s, check the spelling and make sure it exists in the %s class',
+						'event_espresso'
+					),
+					$method,
+					$this->caller
+				);
+				throw new EE_Error(implode('||', $msg));
+			}
+			add_action('wp_ajax_' . $action, array($this, $method));
+		}
+	}
+
+
+	/**
+	 * Loop throught the $_init_func array and add_actions for the array.
+	 *
+	 * @return void
+	 */
+	protected function _init_hooks()
+	{
+		if (empty($this->_init_func)) {
+			return;
+		} //get out there's nothing to take care of.
+		// We need to determine what page_route we are on!
+		$current_route = isset($_REQUEST['action']) ? $_REQUEST['action'] : 'default';
+		foreach ($this->_init_func as $route => $method) {
+			// make sure method exists
+			if (! method_exists($this, $method)) {
+				$msg[] = __(
+					'There is no corresponding method for the hook labeled in the _init_func array',
+					'event_espresso'
+				) . '<br />';
+				$msg[] = sprintf(
+					__(
+						'The method name given in the array is %s, check the spelling and make sure it exists in the %s class',
+						'event_espresso'
+					),
+					$method,
+					$this->caller
+				);
+				throw new EE_Error(implode('||', $msg));
+			}
+			if ($route == $this->_current_route) {
+				add_action('admin_init', array($this, $method));
+			}
+		}
+	}
+
+
+	/**
+	 * Loop through the _metaboxes property and add_metaboxes accordingly
+	 * //todo we could eventually make this a config component class (i.e. new EE_Metabox);
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function add_metaboxes()
+	{
+		if (empty($this->_metaboxes)) {
+			return;
+		} //get out we don't have any metaboxes to set for this connection
+		$this->_handle_metabox_array($this->_metaboxes);
+	}
+
+
+	private function _handle_metabox_array($boxes, $add = true)
+	{
+
+		foreach ($boxes as $box) {
+			if (! isset($box['page_route'])) {
+				continue;
+			} //we dont' have a valid array
+			// let's make sure $box['page_route'] is an array so the "foreach" will work.
+			$box['page_route'] = (array) $box['page_route'];
+			foreach ($box['page_route'] as $route) {
+				if ($route != $this->_current_route) {
+					continue;
+				} //get out we only add metaboxes for set route.
+				if ($add) {
+					$this->_add_metabox($box);
+				} else {
+					$this->_remove_metabox($box);
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * Loop through the _remove_metaboxes property and remove metaboxes accordingly.
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function remove_metaboxes()
+	{
+
+		if (empty($this->_remove_metaboxes)) {
+			return;
+		} //get out there are no metaboxes to remove
+		$this->_handle_metabox_array($this->_remove_metaboxes, false);
+	}
+
+
+	/**
+	 * This just handles adding a metabox
+	 *
+	 * @access private
+	 * @param array $args an array of args that have been set for this metabox by the child class
+	 */
+	private function _add_metabox($args)
+	{
+		$current_screen = get_current_screen();
+		$screen_id = is_object($current_screen) ? $current_screen->id : null;
+		$func = isset($args['func']) ? $args['func'] : 'some_invalid_callback';
+		// set defaults
+		$defaults = array(
+			'func'          => $func,
+			'id'            => $this->caller . '_' . $func . '_metabox',
+			'priority'      => 'default',
+			'label'         => $this->caller,
+			'context'       => 'advanced',
+			'callback_args' => array(),
+			'page'          => isset($args['page']) ? $args['page'] : $screen_id,
+		);
+		$args = wp_parse_args($args, $defaults);
+		extract($args);
+		// make sure method exists
+		if (! method_exists($this, $func)) {
+			$msg[] = __('There is no corresponding method to display the metabox content', 'event_espresso') . '<br />';
+			$msg[] = sprintf(
+				__(
+					'The method name given in the array is %s, check the spelling and make sure it exists in the %s class',
+					'event_espresso'
+				),
+				$func,
+				$this->caller
+			);
+			throw new EE_Error(implode('||', $msg));
+		}
+		// everything checks out so lets add the metabox
+		add_meta_box($id, $label, array($this, $func), $page, $context, $priority, $callback_args);
+	}
+
+
+	private function _remove_metabox($args)
+	{
+		$current_screen = get_current_screen();
+		$screen_id = is_object($current_screen) ? $current_screen->id : null;
+		$func = isset($args['func']) ? $args['func'] : 'some_invalid_callback';
+		// set defaults
+		$defaults = array(
+			'id'      => isset($args['id'])
+				? $args['id']
+				: $this->_current_route
+				  . '_'
+				  . $this->caller
+				  . '_'
+				  . $func
+				  . '_metabox',
+			'context' => 'default',
+			'screen'  => isset($args['screen']) ? $args['screen'] : $screen_id,
+		);
+		$args = wp_parse_args($args, $defaults);
+		extract($args);
+		// everything checks out so lets remove the box!
+		remove_meta_box($id, $screen, $context);
+	}
 }

Spacing +41 added lines, -41 removed lines

@@ -205,7 +205,7 @@ 
         $this->_set_defaults();
         $this->_set_hooks_properties();
         // first let's verify we're on the right page
-        if (! isset($this->_req_data['page'])
+        if ( ! isset($this->_req_data['page'])
             || (isset($this->_req_data['page'])
                 && $this->_adminpage_obj->page_slug
                    != $this->_req_data['page'])) {
@@ -256,9 +256,9 @@ 
     public function enqueue_scripts_styles()
     {
 
-        if (! empty($this->_scripts_styles)) {
+        if ( ! empty($this->_scripts_styles)) {
             // first let's do all the registrations
-            if (! isset($this->_scripts_styles['registers'])) {
+            if ( ! isset($this->_scripts_styles['registers'])) {
                 $msg[] = __(
                     'There is no "registers" index in the <code>$this->_scripts_styles</code> property.',
                     'event_espresso'
@@ -268,7 +268,7 @@ 
                         'Make sure you read the phpdoc comments above the definition of the $_scripts_styles property in the <code>EE_Admin_Hooks</code> class and modify according in the %s child',
                         'event_espresso'
                     ),
-                    '<strong>' . $this->caller . '</strong>'
+                    '<strong>'.$this->caller.'</strong>'
                 );
                 throw new EE_Error(implode('||', $msg));
             }
@@ -283,7 +283,7 @@ 
                 $details = wp_parse_args($details, $defaults);
                 extract($details);
                 // let's make sure that we set the 'registers' type if it's not set! We need it later to determine whhich enqueu we do
-                $this->_scripts_styles['registers'][ $ref ]['type'] = $type;
+                $this->_scripts_styles['registers'][$ref]['type'] = $type;
                 // let's make sure we're not missing any REQUIRED parameters
                 if (empty($url)) {
                     $msg[] = sprintf(
@@ -295,7 +295,7 @@ 
                             'Doublecheck your <code>$this->_scripts_styles</code> array in %s and make sure that there is a "url" set for the %s ref',
                             'event_espresso'
                         ),
-                        '<strong>' . $this->caller . '</strong>',
+                        '<strong>'.$this->caller.'</strong>',
                         $ref
                     );
                     throw new EE_Error(implode('||', $msg));
@@ -311,7 +311,7 @@ 
                     );
             }
             // k now lets do the enqueues
-            if (! isset($this->_scripts_styles['enqueues'])) {
+            if ( ! isset($this->_scripts_styles['enqueues'])) {
                 return;
             }  //not sure if we should throw an error here or not.
 
@@ -319,22 +319,22 @@ 
                 // make sure $routes is an array
                 $routes = (array) $routes;
                 if (in_array($this->_current_route, $routes)) {
-                    $this->_scripts_styles['registers'][ $ref ]['type'] == 'js' ? wp_enqueue_script($ref)
+                    $this->_scripts_styles['registers'][$ref]['type'] == 'js' ? wp_enqueue_script($ref)
                         : wp_enqueue_style($ref);
                     // if we have a localization for the script let's do that too.
-                    if (isset($this->_scripts_styles['localize'][ $ref ])) {
-                        foreach ($this->_scripts_styles['localize'][ $ref ] as $object_name => $indexes) {
+                    if (isset($this->_scripts_styles['localize'][$ref])) {
+                        foreach ($this->_scripts_styles['localize'][$ref] as $object_name => $indexes) {
                             wp_localize_script(
                                 $ref,
                                 $object_name,
-                                $this->_scripts_styles['localize'][ $ref ][ $object_name ]
+                                $this->_scripts_styles['localize'][$ref][$object_name]
                             );
                         }
                     }
                 }
             }
             // let's do the deregisters
-            if (! isset($this->_scripts_styles['deregisters'])) {
+            if ( ! isset($this->_scripts_styles['deregisters'])) {
                 return;
             }
             foreach ($this->_scripts_styles['deregisters'] as $ref => $details) {
@@ -396,20 +396,20 @@ 
             throw new EE_Error(implode('||', $msg));
         }
         $ref = str_replace('_', ' ', $this->_name); // take the_message -> the message
-        $ref = str_replace(' ', '_', ucwords($ref)) . '_Admin_Page'; // take the message -> The_Message
+        $ref = str_replace(' ', '_', ucwords($ref)).'_Admin_Page'; // take the message -> The_Message
         // first default file (if exists)
-        $decaf_file = EE_ADMIN_PAGES . $this->_name . '/' . $ref . '.core.php';
+        $decaf_file = EE_ADMIN_PAGES.$this->_name.'/'.$ref.'.core.php';
         if (is_readable($decaf_file)) {
             require_once($decaf_file);
         }
         // now we have to do require for extended file (if needed)
         if ($this->_extend) {
-            require_once(EE_CORE_CAF_ADMIN_EXTEND . $this->_name . '/Extend_' . $ref . '.core.php');
+            require_once(EE_CORE_CAF_ADMIN_EXTEND.$this->_name.'/Extend_'.$ref.'.core.php');
         }
         // if we've got an extended class we use that!
-        $ref = $this->_extend ? 'Extend_' . $ref : $ref;
+        $ref = $this->_extend ? 'Extend_'.$ref : $ref;
         // let's make sure the class exists
-        if (! class_exists($ref)) {
+        if ( ! class_exists($ref)) {
             $msg[] = __('We can\'t load the page object', 'event_espresso');
             $msg[] = sprintf(
                 __(
@@ -451,28 +451,28 @@ 
         // first the actions
         // note that these action hooks will have the $query_args value available.
         $admin_class_name = get_class($this->_adminpage_obj);
-        if (method_exists($this, '_redirect_action_early_' . $this->_current_route)) {
+        if (method_exists($this, '_redirect_action_early_'.$this->_current_route)) {
             add_action(
                 'AHEE__'
                 . $admin_class_name
                 . '___redirect_after_action__before_redirect_modification_'
                 . $this->_current_route,
-                array($this, '_redirect_action_early_' . $this->_current_route),
+                array($this, '_redirect_action_early_'.$this->_current_route),
                 10
             );
         }
-        if (method_exists($this, '_redirect_action_' . $this->_current_route)) {
+        if (method_exists($this, '_redirect_action_'.$this->_current_route)) {
             add_action(
-                'AHEE_redirect_' . $admin_class_name . $this->_current_route,
-                array($this, '_redirect_action_' . $this->_current_route),
+                'AHEE_redirect_'.$admin_class_name.$this->_current_route,
+                array($this, '_redirect_action_'.$this->_current_route),
                 10
             );
         }
         // let's hook into the _redirect itself and allow for changing where the user goes after redirect.  This will have $query_args and $redirect_url available.
-        if (method_exists($this, '_redirect_filter_' . $this->_current_route)) {
+        if (method_exists($this, '_redirect_filter_'.$this->_current_route)) {
             add_filter(
-                'FHEE_redirect_' . $admin_class_name . $this->_current_route,
-                array($this, '_redirect_filter_' . $this->_current_route),
+                'FHEE_redirect_'.$admin_class_name.$this->_current_route,
+                array($this, '_redirect_filter_'.$this->_current_route),
                 10,
                 2
             );
@@ -497,12 +497,12 @@ 
                 'argnum'   => 1,
                 'priority' => 10,
             ),
-            'FHEE_list_table_views_' . $this->_adminpage_obj->page_slug . '_' . $this->_current_route => array(
+            'FHEE_list_table_views_'.$this->_adminpage_obj->page_slug.'_'.$this->_current_route => array(
                 'type'     => 'filter',
                 'argnum'   => 1,
                 'priority' => 10,
             ),
-            'FHEE_list_table_views_' . $this->_adminpage_obj->page_slug                               => array(
+            'FHEE_list_table_views_'.$this->_adminpage_obj->page_slug                               => array(
                 'type'     => 'filter',
                 'argnum'   => 1,
                 'priority' => 10,
@@ -519,21 +519,21 @@ 
             ),
         );
         foreach ($hook_filter_array as $hook => $args) {
-            if (method_exists($this, $this->_current_route . '_' . $hook)) {
-                if (isset($this->_wp_action_filters_priority[ $hook ])) {
-                    $args['priority'] = $this->_wp_action_filters_priority[ $hook ];
+            if (method_exists($this, $this->_current_route.'_'.$hook)) {
+                if (isset($this->_wp_action_filters_priority[$hook])) {
+                    $args['priority'] = $this->_wp_action_filters_priority[$hook];
                 }
                 if ($args['type'] == 'action') {
                     add_action(
                         $hook,
-                        array($this, $this->_current_route . '_' . $hook),
+                        array($this, $this->_current_route.'_'.$hook),
                         $args['priority'],
                         $args['argnum']
                     );
                 } else {
                     add_filter(
                         $hook,
-                        array($this, $this->_current_route . '_' . $hook),
+                        array($this, $this->_current_route.'_'.$hook),
                         $args['priority'],
                         $args['argnum']
                     );
@@ -556,11 +556,11 @@ 
         } //get out there's nothing to take care of.
         foreach ($this->_ajax_func as $action => $method) {
             // make sure method exists
-            if (! method_exists($this, $method)) {
+            if ( ! method_exists($this, $method)) {
                 $msg[] = __(
                     'There is no corresponding method for the hook labeled in the _ajax_func array',
                     'event_espresso'
-                ) . '<br />';
+                ).'<br />';
                 $msg[] = sprintf(
                     __(
                         'The method name given in the array is %s, check the spelling and make sure it exists in the %s class',
@@ -571,7 +571,7 @@ 
                 );
                 throw new EE_Error(implode('||', $msg));
             }
-            add_action('wp_ajax_' . $action, array($this, $method));
+            add_action('wp_ajax_'.$action, array($this, $method));
         }
     }
 
@@ -590,11 +590,11 @@ 
         $current_route = isset($_REQUEST['action']) ? $_REQUEST['action'] : 'default';
         foreach ($this->_init_func as $route => $method) {
             // make sure method exists
-            if (! method_exists($this, $method)) {
+            if ( ! method_exists($this, $method)) {
                 $msg[] = __(
                     'There is no corresponding method for the hook labeled in the _init_func array',
                     'event_espresso'
-                ) . '<br />';
+                ).'<br />';
                 $msg[] = sprintf(
                     __(
                         'The method name given in the array is %s, check the spelling and make sure it exists in the %s class',
@@ -632,7 +632,7 @@ 
     {
 
         foreach ($boxes as $box) {
-            if (! isset($box['page_route'])) {
+            if ( ! isset($box['page_route'])) {
                 continue;
             } //we dont' have a valid array
             // let's make sure $box['page_route'] is an array so the "foreach" will work.
@@ -681,7 +681,7 @@ 
         // set defaults
         $defaults = array(
             'func'          => $func,
-            'id'            => $this->caller . '_' . $func . '_metabox',
+            'id'            => $this->caller.'_'.$func.'_metabox',
             'priority'      => 'default',
             'label'         => $this->caller,
             'context'       => 'advanced',
@@ -691,8 +691,8 @@ 
         $args = wp_parse_args($args, $defaults);
         extract($args);
         // make sure method exists
-        if (! method_exists($this, $func)) {
-            $msg[] = __('There is no corresponding method to display the metabox content', 'event_espresso') . '<br />';
+        if ( ! method_exists($this, $func)) {
+            $msg[] = __('There is no corresponding method to display the metabox content', 'event_espresso').'<br />';
             $msg[] = sprintf(
                 __(
                     'The method name given in the array is %s, check the spelling and make sure it exists in the %s class',

core/db_classes/EE_Import.class.php

Indentation +950 added lines, -950 removed lines

@@ -14,91 +14,91 @@ 
 class EE_Import implements ResettableInterface
 {
 
-    const do_insert = 'insert';
-    const do_update = 'update';
-    const do_nothing = 'nothing';
-
-
-    // instance of the EE_Import object
-    private static $_instance = null;
-
-    private static $_csv_array = array();
-
-    /**
-     *
-     * @var array of model names
-     */
-    private static $_model_list = array();
-
-    private static $_columns_to_save = array();
-
-    protected $_total_inserts = 0;
-    protected $_total_updates = 0;
-    protected $_total_insert_errors = 0;
-    protected $_total_update_errors = 0;
-
-
-    /**
-     *        private constructor to prevent direct creation
-     *
-     * @Constructor
-     * @access private
-     * @return void
-     */
-    private function __construct()
-    {
-        $this->_total_inserts = 0;
-        $this->_total_updates = 0;
-        $this->_total_insert_errors = 0;
-        $this->_total_update_errors = 0;
-    }
-
-
-    /**
-     *    @ singleton method used to instantiate class object
-     *    @ access public
-     *
-     * @return EE_Import
-     */
-    public static function instance()
-    {
-        // check if class object is instantiated
-        if (self::$_instance === null or ! is_object(self::$_instance) or ! (self::$_instance instanceof EE_Import)) {
-            self::$_instance = new self();
-        }
-        return self::$_instance;
-    }
-
-    /**
-     * Resets the importer
-     *
-     * @return EE_Import
-     */
-    public static function reset()
-    {
-        self::$_instance = null;
-        return self::instance();
-    }
-
-
-    /**
-     *    @ generates HTML for a file upload input and form
-     *    @ access    public
-     *
-     * @param    string $title  - heading for the form
-     * @param    string $intro  - additional text explaing what to do
-     * @param    string $page   - EE Admin page to direct form to - in the form "espresso_{pageslug}"
-     * @param    string $action - EE Admin page route array "action" that form will direct to
-     * @param    string $type   - type of file to import
-     *                          @ return    string
-     */
-    public function upload_form($title, $intro, $form_url, $action, $type)
-    {
-
-        $form_url = EE_Admin_Page::add_query_args_and_nonce(array('action' => $action), $form_url);
-
-        ob_start();
-        ?>
+	const do_insert = 'insert';
+	const do_update = 'update';
+	const do_nothing = 'nothing';
+
+
+	// instance of the EE_Import object
+	private static $_instance = null;
+
+	private static $_csv_array = array();
+
+	/**
+	 *
+	 * @var array of model names
+	 */
+	private static $_model_list = array();
+
+	private static $_columns_to_save = array();
+
+	protected $_total_inserts = 0;
+	protected $_total_updates = 0;
+	protected $_total_insert_errors = 0;
+	protected $_total_update_errors = 0;
+
+
+	/**
+	 *        private constructor to prevent direct creation
+	 *
+	 * @Constructor
+	 * @access private
+	 * @return void
+	 */
+	private function __construct()
+	{
+		$this->_total_inserts = 0;
+		$this->_total_updates = 0;
+		$this->_total_insert_errors = 0;
+		$this->_total_update_errors = 0;
+	}
+
+
+	/**
+	 *    @ singleton method used to instantiate class object
+	 *    @ access public
+	 *
+	 * @return EE_Import
+	 */
+	public static function instance()
+	{
+		// check if class object is instantiated
+		if (self::$_instance === null or ! is_object(self::$_instance) or ! (self::$_instance instanceof EE_Import)) {
+			self::$_instance = new self();
+		}
+		return self::$_instance;
+	}
+
+	/**
+	 * Resets the importer
+	 *
+	 * @return EE_Import
+	 */
+	public static function reset()
+	{
+		self::$_instance = null;
+		return self::instance();
+	}
+
+
+	/**
+	 *    @ generates HTML for a file upload input and form
+	 *    @ access    public
+	 *
+	 * @param    string $title  - heading for the form
+	 * @param    string $intro  - additional text explaing what to do
+	 * @param    string $page   - EE Admin page to direct form to - in the form "espresso_{pageslug}"
+	 * @param    string $action - EE Admin page route array "action" that form will direct to
+	 * @param    string $type   - type of file to import
+	 *                          @ return    string
+	 */
+	public function upload_form($title, $intro, $form_url, $action, $type)
+	{
+
+		$form_url = EE_Admin_Page::add_query_args_and_nonce(array('action' => $action), $form_url);
+
+		ob_start();
+		?>
         <div class="ee-upload-form-dv">
             <h3><?php echo $title; ?></h3>
             <p><?php echo $intro; ?></p>
@@ -114,874 +114,874 @@ 
                 <b><?php _e('Attention', 'event_espresso'); ?></b><br/>
                 <?php echo sprintf(__('Accepts .%s file types only.', 'event_espresso'), $type); ?>
                 <?php echo __(
-                    'Please only import CSV files exported from Event Espresso, or compatible 3rd-party software.',
-                    'event_espresso'
-                ); ?>
+					'Please only import CSV files exported from Event Espresso, or compatible 3rd-party software.',
+					'event_espresso'
+				); ?>
             </p>
 
         </div>
 
         <?php
-        $uploader = ob_get_clean();
-        return $uploader;
-    }
-
-
-    /**
-     * @Import Event Espresso data - some code "borrowed" from event espresso csv_import.php
-     * @access public
-     * @return boolean success
-     */
-    public function import()
-    {
-
-        require_once(EE_CLASSES . 'EE_CSV.class.php');
-        $this->EE_CSV = EE_CSV::instance();
-
-        if (isset($_REQUEST['import'])) {
-            if (isset($_POST['csv_submitted'])) {
-                switch ($_FILES['file']['error'][0]) {
-                    case UPLOAD_ERR_OK:
-                        $error_msg = false;
-                        break;
-                    case UPLOAD_ERR_INI_SIZE:
-                        $error_msg = __(
-                            "'The uploaded file exceeds the upload_max_filesize directive in php.ini.'",
-                            "event_espresso"
-                        );
-                        break;
-                    case UPLOAD_ERR_FORM_SIZE:
-                        $error_msg = __(
-                            'The uploaded file exceeds the MAX_FILE_SIZE directive that was specified in the HTML form.',
-                            "event_espresso"
-                        );
-                        break;
-                    case UPLOAD_ERR_PARTIAL:
-                        $error_msg = __('The uploaded file was only partially uploaded.', "event_espresso");
-                        break;
-                    case UPLOAD_ERR_NO_FILE:
-                        $error_msg = __('No file was uploaded.', "event_espresso");
-                        break;
-                    case UPLOAD_ERR_NO_TMP_DIR:
-                        $error_msg = __('Missing a temporary folder.', "event_espresso");
-                        break;
-                    case UPLOAD_ERR_CANT_WRITE:
-                        $error_msg = __('Failed to write file to disk.', "event_espresso");
-                        break;
-                    case UPLOAD_ERR_EXTENSION:
-                        $error_msg = __('File upload stopped by extension.', "event_espresso");
-                        break;
-                    default:
-                        $error_msg = __(
-                            'An unknown error occurred and the file could not be uploaded',
-                            "event_espresso"
-                        );
-                        break;
-                }
-
-                if (! $error_msg) {
-                    $filename = $_FILES['file']['name'][0];
-                    $file_ext = substr(strrchr($filename, '.'), 1);
-                    $file_type = $_FILES['file']['type'][0];
-                    $temp_file = $_FILES['file']['tmp_name'][0];
-                    $filesize = $_FILES['file']['size'][0] / 1024;// convert from bytes to KB
-
-                    if ($file_ext == 'csv') {
-                        $max_upload = $this->EE_CSV->get_max_upload_size();// max upload size in KB
-                        if ($filesize < $max_upload || true) {
-                            $wp_upload_dir = str_replace(array('\\', '/'), '/', wp_upload_dir());
-                            $path_to_file = $wp_upload_dir['basedir'] . '/espresso/' . $filename;
-
-                            if (move_uploaded_file($temp_file, $path_to_file)) {
-                                // convert csv to array
-                                $this->csv_array = $this->EE_CSV->import_csv_to_model_data_array($path_to_file);
-
-                                // was data successfully stored in an array?
-                                if (is_array($this->csv_array)) {
-                                    $import_what = str_replace('csv_import_', '', $_REQUEST['action']);
-                                    $import_what = str_replace('_', ' ', ucwords($import_what));
-                                    $processed_data = $this->csv_array;
-                                    $this->columns_to_save = false;
-
-                                    // if any imports require funcky processing, we'll catch them in the switch
-                                    switch ($_REQUEST['action']) {
-                                        case "import_events":
-                                        case "event_list":
-                                            $import_what = 'Event Details';
-                                            break;
-
-                                        case 'groupon_import_csv':
-                                            $import_what = 'Groupon Codes';
-                                            $processed_data = $this->process_groupon_codes();
-                                            break;
-                                    }
-                                    // save processed codes to db
-                                    if ($this->save_csv_data_array_to_db($processed_data, $this->columns_to_save)) {
-                                        return true;
-                                    }
-                                } else {
-                                    // no array? must be an error
-                                    EE_Error::add_error(
-                                        sprintf(__("No file seems to have been uploaded", "event_espresso")),
-                                        __FILE__,
-                                        __FUNCTION__,
-                                        __LINE__
-                                    );
-                                    return false;
-                                }
-                            } else {
-                                EE_Error::add_error(
-                                    sprintf(__("%s was not successfully uploaded", "event_espresso"), $filename),
-                                    __FILE__,
-                                    __FUNCTION__,
-                                    __LINE__
-                                );
-                                return false;
-                            }
-                        } else {
-                            EE_Error::add_error(
-                                sprintf(
-                                    __(
-                                        "%s was too large of a file and could not be uploaded. The max filesize is %s' KB.",
-                                        "event_espresso"
-                                    ),
-                                    $filename,
-                                    $max_upload
-                                ),
-                                __FILE__,
-                                __FUNCTION__,
-                                __LINE__
-                            );
-                            return false;
-                        }
-                    } else {
-                        EE_Error::add_error(
-                            sprintf(__("%s  had an invalid file extension, not uploaded", "event_espresso"), $filename),
-                            __FILE__,
-                            __FUNCTION__,
-                            __LINE__
-                        );
-                        return false;
-                    }
-                } else {
-                    EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
-                    return false;
-                }
-            }
-        }
-        return;
-    }
-
-
-    /**
-     *    Given an array of data (usually from a CSV import) attempts to save that data to the db.
-     *    If $model_name ISN'T provided, assumes that this is a 3d array, with toplevel keys being model names,
-     *    next level being numeric indexes adn each value representing a model object, and the last layer down
-     *    being keys of model fields and their proposed values.
-     *    If $model_name IS provided, assumes a 2d array of the bottom two layers previously mentioned.
-     *    If the CSV data says (in the metadata row) that it's from the SAME database,
-     *    we treat the IDs in the CSV as the normal IDs, and try to update those records. However, if those
-     *    IDs DON'T exist in the database, they're treated as temporary IDs,
-     *    which can used elsewhere to refer to the same object. Once an item
-     *    with a temporary ID gets inserted, we record its mapping from temporary
-     *    ID to real ID, and use the real ID in place of the temporary ID
-     *    when that temporary ID was used as a foreign key.
-     *    If the CSV data says (in the metadata again) that it's from a DIFFERENT database,
-     *    we treat all the IDs in the CSV as temporary ID- eg, if the CSV specifies an event with
-     *    ID 1, and the database already has an event with ID 1, we assume that's just a coincidence,
-     *    and insert a new event, and map it's temporary ID of 1 over to its new real ID.
-     *    An important exception are non-auto-increment primary keys. If one entry in the
-     *    CSV file has the same ID as one in the DB, we assume they are meant to be
-     *    the same item, and instead update the item in the DB with that same ID.
-     *    Also note, we remember the mappings permanently. So the 2nd, 3rd, and 10000th
-     *    time you import a CSV from a different site, we remember their mappings, and
-     * will try to update the item in the DB instead of inserting another item (eg
-     * if we previously imported an event with temporary ID 1, and then it got a
-     * real ID of 123, we remember that. So the next time we import an event with
-     * temporary ID, from the same site, we know that it's real ID is 123, and will
-     * update that event, instead of adding a new event).
-     *
-     * @access public
-     * @param array $csv_data_array - the array containing the csv data produced from
-     *                              EE_CSV::import_csv_to_model_data_array()
-     * @param array $fields_to_save - an array containing the csv column names as keys with the corresponding db table
-     *                              fields they will be saved to
-     * @return TRUE on success, FALSE on fail
-     * @throws \EE_Error
-     */
-    public function save_csv_data_array_to_db($csv_data_array, $model_name = false)
-    {
-        $success = false;
-        $error = false;
-        // whther to treat this import as if it's data froma different database or not
-        // ie, if it IS from a different database, ignore foreign keys whihf
-        $export_from_site_a_to_b = true;
-        // first level of array is not table information but a table name was passed to the function
-        // array is only two levels deep, so let's fix that by adding a level, else the next steps will fail
-        if ($model_name) {
-            $csv_data_array = array($csv_data_array);
-        }
-        // begin looking through the $csv_data_array, expecting the toplevel key to be the model's name...
-        $old_site_url = 'none-specified';
-        // hanlde metadata
-        if (isset($csv_data_array[ EE_CSV::metadata_header ])) {
-            $csv_metadata = array_shift($csv_data_array[ EE_CSV::metadata_header ]);
-            // ok so its metadata, dont try to save it to ehte db obviously...
-            if (isset($csv_metadata['site_url']) && $csv_metadata['site_url'] == site_url()) {
-                EE_Error::add_attention(
-                    sprintf(
-                        __(
-                            "CSV Data appears to be from the same database, so attempting to update data",
-                            "event_espresso"
-                        )
-                    )
-                );
-                $export_from_site_a_to_b = false;
-            } else {
-                $old_site_url = isset($csv_metadata['site_url']) ? $csv_metadata['site_url'] : $old_site_url;
-                EE_Error::add_attention(
-                    sprintf(
-                        __(
-                            "CSV Data appears to be from a different database (%s instead of %s), so we assume IDs in the CSV data DO NOT correspond to IDs in this database",
-                            "event_espresso"
-                        ),
-                        $old_site_url,
-                        site_url()
-                    )
-                );
-            };
-            unset($csv_data_array[ EE_CSV::metadata_header ]);
-        }
-        /**
-         * @var $old_db_to_new_db_mapping 2d array: toplevel keys being model names, bottom-level keys being the original key, and
-         * the value will be the newly-inserted ID.
-         * If we have already imported data from the same website via CSV, it shoudl be kept in this wp option
-         */
-        $old_db_to_new_db_mapping = get_option('ee_id_mapping_from' . sanitize_title($old_site_url), array());
-        if ($old_db_to_new_db_mapping) {
-            EE_Error::add_attention(
-                sprintf(
-                    __(
-                        "We noticed you have imported data via CSV from %s before. Because of this, IDs in your CSV have been mapped to their new IDs in %s",
-                        "event_espresso"
-                    ),
-                    $old_site_url,
-                    site_url()
-                )
-            );
-        }
-        $old_db_to_new_db_mapping = $this->save_data_rows_to_db(
-            $csv_data_array,
-            $export_from_site_a_to_b,
-            $old_db_to_new_db_mapping
-        );
-
-        // save the mapping from old db to new db in case they try re-importing the same data from the same website again
-        update_option('ee_id_mapping_from' . sanitize_title($old_site_url), $old_db_to_new_db_mapping);
-
-        if ($this->_total_updates > 0) {
-            EE_Error::add_success(
-                sprintf(
-                    __("%s existing records in the database were updated.", "event_espresso"),
-                    $this->_total_updates
-                )
-            );
-            $success = true;
-        }
-        if ($this->_total_inserts > 0) {
-            EE_Error::add_success(
-                sprintf(__("%s new records were added to the database.", "event_espresso"), $this->_total_inserts)
-            );
-            $success = true;
-        }
-
-        if ($this->_total_update_errors > 0) {
-            EE_Error::add_error(
-                sprintf(
-                    __(
-                        "'One or more errors occurred, and a total of %s existing records in the database were <strong>not</strong> updated.'",
-                        "event_espresso"
-                    ),
-                    $this->_total_update_errors
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $error = true;
-        }
-        if ($this->_total_insert_errors > 0) {
-            EE_Error::add_error(
-                sprintf(
-                    __(
-                        "One or more errors occurred, and a total of %s new records were <strong>not</strong> added to the database.'",
-                        "event_espresso"
-                    ),
-                    $this->_total_insert_errors
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $error = true;
-        }
-
-        // lastly, we need to update the datetime and ticket sold amounts
-        // as those may have been affected by this
-        EEM_Ticket::instance()->update_tickets_sold(EEM_Ticket::instance()->get_all());
-
-        // if there was at least one success and absolutely no errors
-        if ($success && ! $error) {
-            return true;
-        } else {
-            return false;
-        }
-    }
-
-
-    /**
-     * Processes the array of data, given the knowledge that it's from the same database or a different one,
-     * and the mapping from temporary IDs to real IDs.
-     * If the data is from a different database, we treat the primary keys and their corresponding
-     * foreign keys as "temp Ids", basically identifiers that get mapped to real primary keys
-     * in the real target database. As items are inserted, their temporary primary keys
-     * are mapped to the real IDs in the target database. Also, before doing any update or
-     * insert, we replace all the temp ID which are foreign keys with their mapped real IDs.
-     * An exception: string primary keys are treated as real IDs, or else we'd need to
-     * dynamically generate new string primary keys which would be very awkard for the country table etc.
-     * Also, models with no primary key are strange too. We combine use their primar key INDEX (a
-     * combination of fields) to create a unique string identifying the row and store
-     * those in the mapping.
-     *
-     * If the data is from the same database, we usually treat primary keys as real IDs.
-     * An exception is if there is nothing in the database for that ID. If that's the case,
-     * we need to insert a new row for that ID, and then map from the non-existent ID
-     * to the newly-inserted real ID.
-     *
-     * @param type $csv_data_array
-     * @param type $export_from_site_a_to_b
-     * @param type $old_db_to_new_db_mapping
-     * @return array updated $old_db_to_new_db_mapping
-     */
-    public function save_data_rows_to_db($csv_data_array, $export_from_site_a_to_b, $old_db_to_new_db_mapping)
-    {
-        foreach ($csv_data_array as $model_name_in_csv_data => $model_data_from_import) {
-            // now check that assumption was correct. If
-            if (EE_Registry::instance()->is_model_name($model_name_in_csv_data)) {
-                $model_name = $model_name_in_csv_data;
-            } else {
-                // no table info in the array and no table name passed to the function?? FAIL
-                EE_Error::add_error(
-                    __(
-                        'No table information was specified and/or found, therefore the import could not be completed',
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-                return false;
-            }
-            /* @var $model EEM_Base */
-            $model = EE_Registry::instance()->load_model($model_name);
-
-            // so without further ado, scanning all the data provided for primary keys and their inital values
-            foreach ($model_data_from_import as $model_object_data) {
-                // before we do ANYTHING, make sure the csv row wasn't just completely blank
-                $row_is_completely_empty = true;
-                foreach ($model_object_data as $field) {
-                    if ($field) {
-                        $row_is_completely_empty = false;
-                    }
-                }
-                if ($row_is_completely_empty) {
-                    continue;
-                }
-                // find the PK in the row of data (or a combined key if
-                // there is no primary key)
-                if ($model->has_primary_key_field()) {
-                    $id_in_csv = $model_object_data[ $model->primary_key_name() ];
-                } else {
-                    $id_in_csv = $model->get_index_primary_key_string($model_object_data);
-                }
-
-
-                $model_object_data = $this->_replace_temp_ids_with_mappings(
-                    $model_object_data,
-                    $model,
-                    $old_db_to_new_db_mapping,
-                    $export_from_site_a_to_b
-                );
-                // now we need to decide if we're going to add a new model object given the $model_object_data,
-                // or just update.
-                if ($export_from_site_a_to_b) {
-                    $what_to_do = $this->_decide_whether_to_insert_or_update_given_data_from_other_db(
-                        $id_in_csv,
-                        $model_object_data,
-                        $model,
-                        $old_db_to_new_db_mapping
-                    );
-                } else {// this is just a re-import
-                    $what_to_do = $this->_decide_whether_to_insert_or_update_given_data_from_same_db(
-                        $id_in_csv,
-                        $model_object_data,
-                        $model,
-                        $old_db_to_new_db_mapping
-                    );
-                }
-                if ($what_to_do == self::do_nothing) {
-                    continue;
-                }
-
-                // double-check we actually want to insert, if that's what we're planning
-                // based on whether this item would be unique in the DB or not
-                if ($what_to_do == self::do_insert) {
-                    // we're supposed to be inserting. But wait, will this thing
-                    // be acceptable if inserted?
-                    $conflicting = $model->get_one_conflicting($model_object_data, false);
-                    if ($conflicting) {
-                        // ok, this item would conflict if inserted. Just update the item that it conflicts with.
-                        $what_to_do = self::do_update;
-                        // and if this model has a primary key, remember its mapping
-                        if ($model->has_primary_key_field()) {
-                            $old_db_to_new_db_mapping[ $model_name ][ $id_in_csv ] = $conflicting->ID();
-                            $model_object_data[ $model->primary_key_name() ] = $conflicting->ID();
-                        } else {
-                            // we want to update this conflicting item, instead of inserting a conflicting item
-                            // so we need to make sure they match entirely (its possible that they only conflicted on one field, but we need them to match on other fields
-                            // for the WHERE conditions in the update). At the time of this comment, there were no models like this
-                            foreach ($model->get_combined_primary_key_fields() as $key_field) {
-                                $model_object_data[ $key_field->get_name() ] = $conflicting->get(
-                                    $key_field->get_name()
-                                );
-                            }
-                        }
-                    }
-                }
-                if ($what_to_do == self::do_insert) {
-                    $old_db_to_new_db_mapping = $this->_insert_from_data_array(
-                        $id_in_csv,
-                        $model_object_data,
-                        $model,
-                        $old_db_to_new_db_mapping
-                    );
-                } elseif ($what_to_do == self::do_update) {
-                    $old_db_to_new_db_mapping = $this->_update_from_data_array(
-                        $id_in_csv,
-                        $model_object_data,
-                        $model,
-                        $old_db_to_new_db_mapping
-                    );
-                } else {
-                    throw new EE_Error(
-                        sprintf(
-                            __(
-                                'Programming error. We shoudl be inserting or updating, but instead we are being told to "%s", whifh is invalid',
-                                'event_espresso'
-                            ),
-                            $what_to_do
-                        )
-                    );
-                }
-            }
-        }
-        return $old_db_to_new_db_mapping;
-    }
-
-
-    /**
-     * Decides whether or not to insert, given that this data is from another database.
-     * So, if the primary key of this $model_object_data already exists in the database,
-     * it's just a coincidence and we should still insert. The only time we should
-     * update is when we know what it maps to, or there's something that would
-     * conflict (and we should instead just update that conflicting thing)
-     *
-     * @param string   $id_in_csv
-     * @param array    $model_object_data        by reference so it can be modified
-     * @param EEM_Base $model
-     * @param array    $old_db_to_new_db_mapping by reference so it can be modified
-     * @return string one of the consts on this class that starts with do_*
-     */
-    protected function _decide_whether_to_insert_or_update_given_data_from_other_db(
-        $id_in_csv,
-        $model_object_data,
-        $model,
-        $old_db_to_new_db_mapping
-    ) {
-        $model_name = $model->get_this_model_name();
-        // if it's a site-to-site export-and-import, see if this modelobject's id
-        // in the old data that we know of
-        if (isset($old_db_to_new_db_mapping[ $model_name ][ $id_in_csv ])) {
-            return self::do_update;
-        } else {
-            return self::do_insert;
-        }
-    }
-
-    /**
-     * If this thing basically already exists in the database, we want to update it;
-     * otherwise insert it (ie, someone tweaked the CSV file, or the item was
-     * deleted in the database so it should be re-inserted)
-     *
-     * @param type     $id_in_csv
-     * @param type     $model_object_data
-     * @param EEM_Base $model
-     * @param type     $old_db_to_new_db_mapping
-     * @return
-     */
-    protected function _decide_whether_to_insert_or_update_given_data_from_same_db(
-        $id_in_csv,
-        $model_object_data,
-        $model
-    ) {
-        // in this case, check if this thing ACTUALLY exists in the database
-        if ($model->get_one_conflicting($model_object_data)) {
-            return self::do_update;
-        } else {
-            return self::do_insert;
-        }
-    }
-
-    /**
-     * Using the $old_db_to_new_db_mapping array, replaces all the temporary IDs
-     * with their mapped real IDs. Eg, if importing from site A to B, the mapping
-     * file may indicate that the ID "my_event_id" maps to an actual event ID of 123.
-     * So this function searches for any event temp Ids called "my_event_id" and
-     * replaces them with 123.
-     * Also, if there is no temp ID for the INT foreign keys from another database,
-     * replaces them with 0 or the field's default.
-     *
-     * @param type     $model_object_data
-     * @param EEM_Base $model
-     * @param type     $old_db_to_new_db_mapping
-     * @param boolean  $export_from_site_a_to_b
-     * @return array updated model object data with temp IDs removed
-     */
-    protected function _replace_temp_ids_with_mappings(
-        $model_object_data,
-        $model,
-        $old_db_to_new_db_mapping,
-        $export_from_site_a_to_b
-    ) {
-        // if this model object's primary key is in the mapping, replace it
-        if ($model->has_primary_key_field() &&
-            $model->get_primary_key_field()->is_auto_increment() &&
-            isset($old_db_to_new_db_mapping[ $model->get_this_model_name() ]) &&
-            isset(
-                $old_db_to_new_db_mapping[ $model->get_this_model_name() ][ $model_object_data[ $model->primary_key_name() ] ]
-            )) {
-            $model_object_data[ $model->primary_key_name() ] = $old_db_to_new_db_mapping[ $model->get_this_model_name(
-            ) ][ $model_object_data[ $model->primary_key_name() ] ];
-        }
-
-        try {
-            $model_name_field = $model->get_field_containing_related_model_name();
-            $models_pointed_to_by_model_name_field = $model_name_field->get_model_names_pointed_to();
-        } catch (EE_Error $e) {
-            $model_name_field = null;
-            $models_pointed_to_by_model_name_field = array();
-        }
-        foreach ($model->field_settings(true) as $field_obj) {
-            if ($field_obj instanceof EE_Foreign_Key_Int_Field) {
-                $models_pointed_to = $field_obj->get_model_names_pointed_to();
-                $found_a_mapping = false;
-                foreach ($models_pointed_to as $model_pointed_to_by_fk) {
-                    if ($model_name_field) {
-                        $value_of_model_name_field = $model_object_data[ $model_name_field->get_name() ];
-                        if ($value_of_model_name_field == $model_pointed_to_by_fk) {
-                            $model_object_data[ $field_obj->get_name() ] = $this->_find_mapping_in(
-                                $model_object_data[ $field_obj->get_name() ],
-                                $model_pointed_to_by_fk,
-                                $old_db_to_new_db_mapping,
-                                $export_from_site_a_to_b
-                            );
-                            $found_a_mapping = true;
-                            break;
-                        }
-                    } else {
-                        $model_object_data[ $field_obj->get_name() ] = $this->_find_mapping_in(
-                            $model_object_data[ $field_obj->get_name() ],
-                            $model_pointed_to_by_fk,
-                            $old_db_to_new_db_mapping,
-                            $export_from_site_a_to_b
-                        );
-                        $found_a_mapping = true;
-                    }
-                    // once we've found a mapping for this field no need to continue
-                    if ($found_a_mapping) {
-                        break;
-                    }
-                }
-            } else {
-                // it's a string foreign key (which we leave alone, because those are things
-                // like country names, which we'd really rather not make 2 USAs etc (we'd actually
-                // prefer to just update one)
-                // or it's just a regular value that ought to be replaced
-            }
-        }
-        //
-        if ($model instanceof EEM_Term_Taxonomy) {
-            $model_object_data = $this->_handle_split_term_ids($model_object_data);
-        }
-        return $model_object_data;
-    }
-
-    /**
-     * If the data was exported PRE-4.2, but then imported POST-4.2, then the term_id
-     * this term-taxonomy refers to may be out-of-date so we need to update it.
-     * see https://make.wordpress.org/core/2015/02/16/taxonomy-term-splitting-in-4-2-a-developer-guide/
-     *
-     * @param type $model_object_data
-     * @return array new model object data
-     */
-    protected function _handle_split_term_ids($model_object_data)
-    {
-        if (isset($model_object_data['term_id'])
-            && isset($model_object_data['taxonomy'])
-            && apply_filters(
-                'FHEE__EE_Import__handle_split_term_ids__function_exists',
-                function_exists('wp_get_split_term'),
-                $model_object_data
-            )) {
-            $new_term_id = wp_get_split_term($model_object_data['term_id'], $model_object_data['taxonomy']);
-            if ($new_term_id) {
-                $model_object_data['term_id'] = $new_term_id;
-            }
-        }
-        return $model_object_data;
-    }
-
-    /**
-     * Given the object's ID and its model's name, find it int he mapping data,
-     * bearing in mind where it came from
-     *
-     * @param type   $object_id
-     * @param string $model_name
-     * @param array  $old_db_to_new_db_mapping
-     * @param type   $export_from_site_a_to_b
-     * @return int
-     */
-    protected function _find_mapping_in($object_id, $model_name, $old_db_to_new_db_mapping, $export_from_site_a_to_b)
-    {
-        if (isset($old_db_to_new_db_mapping[ $model_name ][ $object_id ])) {
-            return $old_db_to_new_db_mapping[ $model_name ][ $object_id ];
-        } elseif ($object_id == '0' || $object_id == '') {
-            // leave as-is
-            return $object_id;
-        } elseif ($export_from_site_a_to_b) {
-            // we couldn't find a mapping for this, and it's from a different site,
-            // so blank it out
-            return null;
-        } elseif (! $export_from_site_a_to_b) {
-            // we coudln't find a mapping for this, but it's from thsi DB anyway
-            // so let's just leave it as-is
-            return $object_id;
-        }
-    }
-
-    /**
-     *
-     * @param type     $id_in_csv
-     * @param type     $model_object_data
-     * @param EEM_Base $model
-     * @param type     $old_db_to_new_db_mapping
-     * @return array updated $old_db_to_new_db_mapping
-     */
-    protected function _insert_from_data_array($id_in_csv, $model_object_data, $model, $old_db_to_new_db_mapping)
-    {
-        // remove the primary key, if there is one (we don't want it for inserts OR updates)
-        // we'll put it back in if we need it
-        if ($model->has_primary_key_field() && $model->get_primary_key_field()->is_auto_increment()) {
-            $effective_id = $model_object_data[ $model->primary_key_name() ];
-            unset($model_object_data[ $model->primary_key_name() ]);
-        } else {
-            $effective_id = $model->get_index_primary_key_string($model_object_data);
-        }
-        // the model takes care of validating the CSV's input
-        try {
-            $new_id = $model->insert($model_object_data);
-            if ($new_id) {
-                $old_db_to_new_db_mapping[ $model->get_this_model_name() ][ $id_in_csv ] = $new_id;
-                $this->_total_inserts++;
-                EE_Error::add_success(
-                    sprintf(
-                        __("Successfully added new %s (with id %s) with csv data %s", "event_espresso"),
-                        $model->get_this_model_name(),
-                        $new_id,
-                        implode(",", $model_object_data)
-                    )
-                );
-            } else {
-                $this->_total_insert_errors++;
-                // put the ID used back in there for the error message
-                if ($model->has_primary_key_field()) {
-                    $model_object_data[ $model->primary_key_name() ] = $effective_id;
-                }
-                EE_Error::add_error(
-                    sprintf(
-                        __("Could not insert new %s with the csv data: %s", "event_espresso"),
-                        $model->get_this_model_name(),
-                        http_build_query($model_object_data)
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-        } catch (EE_Error $e) {
-            $this->_total_insert_errors++;
-            if ($model->has_primary_key_field()) {
-                $model_object_data[ $model->primary_key_name() ] = $effective_id;
-            }
-            EE_Error::add_error(
-                sprintf(
-                    __("Could not insert new %s with the csv data: %s because %s", "event_espresso"),
-                    $model->get_this_model_name(),
-                    implode(",", $model_object_data),
-                    $e->getMessage()
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        return $old_db_to_new_db_mapping;
-    }
-
-    /**
-     * Given the model object data, finds the row to update and updates it
-     *
-     * @param string|int $id_in_csv
-     * @param array      $model_object_data
-     * @param EEM_Base   $model
-     * @param array      $old_db_to_new_db_mapping
-     * @return array updated $old_db_to_new_db_mapping
-     */
-    protected function _update_from_data_array($id_in_csv, $model_object_data, $model, $old_db_to_new_db_mapping)
-    {
-        try {
-            // let's keep two copies of the model object data:
-            // one for performing an update, one for everthing else
-            $model_object_data_for_update = $model_object_data;
-            if ($model->has_primary_key_field()) {
-                $conditions = array($model->primary_key_name() => $model_object_data[ $model->primary_key_name() ]);
-                // remove the primary key because we shouldn't use it for updating
-                unset($model_object_data_for_update[ $model->primary_key_name() ]);
-            } elseif ($model->get_combined_primary_key_fields() > 1) {
-                $conditions = array();
-                foreach ($model->get_combined_primary_key_fields() as $key_field) {
-                    $conditions[ $key_field->get_name() ] = $model_object_data[ $key_field->get_name() ];
-                }
-            } else {
-                $model->primary_key_name(
-                );// this shoudl just throw an exception, explaining that we dont have a primary key (or a combine dkey)
-            }
-
-            $success = $model->update($model_object_data_for_update, array($conditions));
-            if ($success) {
-                $this->_total_updates++;
-                EE_Error::add_success(
-                    sprintf(
-                        __("Successfully updated %s with csv data %s", "event_espresso"),
-                        $model->get_this_model_name(),
-                        implode(",", $model_object_data_for_update)
-                    )
-                );
-                // we should still record the mapping even though it was an update
-                // because if we were going to insert somethign but it was going to conflict
-                // we would have last-minute decided to update. So we'd like to know what we updated
-                // and so we record what record ended up being updated using the mapping
-                if ($model->has_primary_key_field()) {
-                    $new_key_for_mapping = $model_object_data[ $model->primary_key_name() ];
-                } else {
-                    // no primary key just a combined key
-                    $new_key_for_mapping = $model->get_index_primary_key_string($model_object_data);
-                }
-                $old_db_to_new_db_mapping[ $model->get_this_model_name() ][ $id_in_csv ] = $new_key_for_mapping;
-            } else {
-                $matched_items = $model->get_all(array($conditions));
-                if (! $matched_items) {
-                    // no items were matched (so we shouldn't have updated)... but then we should have inserted? what the heck?
-                    $this->_total_update_errors++;
-                    EE_Error::add_error(
-                        sprintf(
-                            __(
-                                "Could not update %s with the csv data: '%s' for an unknown reason (using WHERE conditions %s)",
-                                "event_espresso"
-                            ),
-                            $model->get_this_model_name(),
-                            http_build_query($model_object_data),
-                            http_build_query($conditions)
-                        ),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                } else {
-                    $this->_total_updates++;
-                    EE_Error::add_success(
-                        sprintf(
-                            __(
-                                "%s with csv data '%s' was found in the database and didn't need updating because all the data is identical.",
-                                "event_espresso"
-                            ),
-                            $model->get_this_model_name(),
-                            implode(",", $model_object_data)
-                        )
-                    );
-                }
-            }
-        } catch (EE_Error $e) {
-            $this->_total_update_errors++;
-            $basic_message = sprintf(
-                __("Could not update %s with the csv data: %s because %s", "event_espresso"),
-                $model->get_this_model_name(),
-                implode(",", $model_object_data),
-                $e->getMessage()
-            );
-            $debug_message = $basic_message . ' Stack trace: ' . $e->getTraceAsString();
-            EE_Error::add_error("$basic_message | $debug_message", __FILE__, __FUNCTION__, __LINE__);
-        }
-        return $old_db_to_new_db_mapping;
-    }
-
-    /**
-     * Gets the number of inserts performed since importer was instantiated or reset
-     *
-     * @return int
-     */
-    public function get_total_inserts()
-    {
-        return $this->_total_inserts;
-    }
-
-    /**
-     *  Gets the number of insert errors since importer was instantiated or reset
-     *
-     * @return int
-     */
-    public function get_total_insert_errors()
-    {
-        return $this->_total_insert_errors;
-    }
-
-    /**
-     *  Gets the number of updates performed since importer was instantiated or reset
-     *
-     * @return int
-     */
-    public function get_total_updates()
-    {
-        return $this->_total_updates;
-    }
-
-    /**
-     *  Gets the number of update errors since importer was instantiated or reset
-     *
-     * @return int
-     */
-    public function get_total_update_errors()
-    {
-        return $this->_total_update_errors;
-    }
+		$uploader = ob_get_clean();
+		return $uploader;
+	}
+
+
+	/**
+	 * @Import Event Espresso data - some code "borrowed" from event espresso csv_import.php
+	 * @access public
+	 * @return boolean success
+	 */
+	public function import()
+	{
+
+		require_once(EE_CLASSES . 'EE_CSV.class.php');
+		$this->EE_CSV = EE_CSV::instance();
+
+		if (isset($_REQUEST['import'])) {
+			if (isset($_POST['csv_submitted'])) {
+				switch ($_FILES['file']['error'][0]) {
+					case UPLOAD_ERR_OK:
+						$error_msg = false;
+						break;
+					case UPLOAD_ERR_INI_SIZE:
+						$error_msg = __(
+							"'The uploaded file exceeds the upload_max_filesize directive in php.ini.'",
+							"event_espresso"
+						);
+						break;
+					case UPLOAD_ERR_FORM_SIZE:
+						$error_msg = __(
+							'The uploaded file exceeds the MAX_FILE_SIZE directive that was specified in the HTML form.',
+							"event_espresso"
+						);
+						break;
+					case UPLOAD_ERR_PARTIAL:
+						$error_msg = __('The uploaded file was only partially uploaded.', "event_espresso");
+						break;
+					case UPLOAD_ERR_NO_FILE:
+						$error_msg = __('No file was uploaded.', "event_espresso");
+						break;
+					case UPLOAD_ERR_NO_TMP_DIR:
+						$error_msg = __('Missing a temporary folder.', "event_espresso");
+						break;
+					case UPLOAD_ERR_CANT_WRITE:
+						$error_msg = __('Failed to write file to disk.', "event_espresso");
+						break;
+					case UPLOAD_ERR_EXTENSION:
+						$error_msg = __('File upload stopped by extension.', "event_espresso");
+						break;
+					default:
+						$error_msg = __(
+							'An unknown error occurred and the file could not be uploaded',
+							"event_espresso"
+						);
+						break;
+				}
+
+				if (! $error_msg) {
+					$filename = $_FILES['file']['name'][0];
+					$file_ext = substr(strrchr($filename, '.'), 1);
+					$file_type = $_FILES['file']['type'][0];
+					$temp_file = $_FILES['file']['tmp_name'][0];
+					$filesize = $_FILES['file']['size'][0] / 1024;// convert from bytes to KB
+
+					if ($file_ext == 'csv') {
+						$max_upload = $this->EE_CSV->get_max_upload_size();// max upload size in KB
+						if ($filesize < $max_upload || true) {
+							$wp_upload_dir = str_replace(array('\\', '/'), '/', wp_upload_dir());
+							$path_to_file = $wp_upload_dir['basedir'] . '/espresso/' . $filename;
+
+							if (move_uploaded_file($temp_file, $path_to_file)) {
+								// convert csv to array
+								$this->csv_array = $this->EE_CSV->import_csv_to_model_data_array($path_to_file);
+
+								// was data successfully stored in an array?
+								if (is_array($this->csv_array)) {
+									$import_what = str_replace('csv_import_', '', $_REQUEST['action']);
+									$import_what = str_replace('_', ' ', ucwords($import_what));
+									$processed_data = $this->csv_array;
+									$this->columns_to_save = false;
+
+									// if any imports require funcky processing, we'll catch them in the switch
+									switch ($_REQUEST['action']) {
+										case "import_events":
+										case "event_list":
+											$import_what = 'Event Details';
+											break;
+
+										case 'groupon_import_csv':
+											$import_what = 'Groupon Codes';
+											$processed_data = $this->process_groupon_codes();
+											break;
+									}
+									// save processed codes to db
+									if ($this->save_csv_data_array_to_db($processed_data, $this->columns_to_save)) {
+										return true;
+									}
+								} else {
+									// no array? must be an error
+									EE_Error::add_error(
+										sprintf(__("No file seems to have been uploaded", "event_espresso")),
+										__FILE__,
+										__FUNCTION__,
+										__LINE__
+									);
+									return false;
+								}
+							} else {
+								EE_Error::add_error(
+									sprintf(__("%s was not successfully uploaded", "event_espresso"), $filename),
+									__FILE__,
+									__FUNCTION__,
+									__LINE__
+								);
+								return false;
+							}
+						} else {
+							EE_Error::add_error(
+								sprintf(
+									__(
+										"%s was too large of a file and could not be uploaded. The max filesize is %s' KB.",
+										"event_espresso"
+									),
+									$filename,
+									$max_upload
+								),
+								__FILE__,
+								__FUNCTION__,
+								__LINE__
+							);
+							return false;
+						}
+					} else {
+						EE_Error::add_error(
+							sprintf(__("%s  had an invalid file extension, not uploaded", "event_espresso"), $filename),
+							__FILE__,
+							__FUNCTION__,
+							__LINE__
+						);
+						return false;
+					}
+				} else {
+					EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
+					return false;
+				}
+			}
+		}
+		return;
+	}
+
+
+	/**
+	 *    Given an array of data (usually from a CSV import) attempts to save that data to the db.
+	 *    If $model_name ISN'T provided, assumes that this is a 3d array, with toplevel keys being model names,
+	 *    next level being numeric indexes adn each value representing a model object, and the last layer down
+	 *    being keys of model fields and their proposed values.
+	 *    If $model_name IS provided, assumes a 2d array of the bottom two layers previously mentioned.
+	 *    If the CSV data says (in the metadata row) that it's from the SAME database,
+	 *    we treat the IDs in the CSV as the normal IDs, and try to update those records. However, if those
+	 *    IDs DON'T exist in the database, they're treated as temporary IDs,
+	 *    which can used elsewhere to refer to the same object. Once an item
+	 *    with a temporary ID gets inserted, we record its mapping from temporary
+	 *    ID to real ID, and use the real ID in place of the temporary ID
+	 *    when that temporary ID was used as a foreign key.
+	 *    If the CSV data says (in the metadata again) that it's from a DIFFERENT database,
+	 *    we treat all the IDs in the CSV as temporary ID- eg, if the CSV specifies an event with
+	 *    ID 1, and the database already has an event with ID 1, we assume that's just a coincidence,
+	 *    and insert a new event, and map it's temporary ID of 1 over to its new real ID.
+	 *    An important exception are non-auto-increment primary keys. If one entry in the
+	 *    CSV file has the same ID as one in the DB, we assume they are meant to be
+	 *    the same item, and instead update the item in the DB with that same ID.
+	 *    Also note, we remember the mappings permanently. So the 2nd, 3rd, and 10000th
+	 *    time you import a CSV from a different site, we remember their mappings, and
+	 * will try to update the item in the DB instead of inserting another item (eg
+	 * if we previously imported an event with temporary ID 1, and then it got a
+	 * real ID of 123, we remember that. So the next time we import an event with
+	 * temporary ID, from the same site, we know that it's real ID is 123, and will
+	 * update that event, instead of adding a new event).
+	 *
+	 * @access public
+	 * @param array $csv_data_array - the array containing the csv data produced from
+	 *                              EE_CSV::import_csv_to_model_data_array()
+	 * @param array $fields_to_save - an array containing the csv column names as keys with the corresponding db table
+	 *                              fields they will be saved to
+	 * @return TRUE on success, FALSE on fail
+	 * @throws \EE_Error
+	 */
+	public function save_csv_data_array_to_db($csv_data_array, $model_name = false)
+	{
+		$success = false;
+		$error = false;
+		// whther to treat this import as if it's data froma different database or not
+		// ie, if it IS from a different database, ignore foreign keys whihf
+		$export_from_site_a_to_b = true;
+		// first level of array is not table information but a table name was passed to the function
+		// array is only two levels deep, so let's fix that by adding a level, else the next steps will fail
+		if ($model_name) {
+			$csv_data_array = array($csv_data_array);
+		}
+		// begin looking through the $csv_data_array, expecting the toplevel key to be the model's name...
+		$old_site_url = 'none-specified';
+		// hanlde metadata
+		if (isset($csv_data_array[ EE_CSV::metadata_header ])) {
+			$csv_metadata = array_shift($csv_data_array[ EE_CSV::metadata_header ]);
+			// ok so its metadata, dont try to save it to ehte db obviously...
+			if (isset($csv_metadata['site_url']) && $csv_metadata['site_url'] == site_url()) {
+				EE_Error::add_attention(
+					sprintf(
+						__(
+							"CSV Data appears to be from the same database, so attempting to update data",
+							"event_espresso"
+						)
+					)
+				);
+				$export_from_site_a_to_b = false;
+			} else {
+				$old_site_url = isset($csv_metadata['site_url']) ? $csv_metadata['site_url'] : $old_site_url;
+				EE_Error::add_attention(
+					sprintf(
+						__(
+							"CSV Data appears to be from a different database (%s instead of %s), so we assume IDs in the CSV data DO NOT correspond to IDs in this database",
+							"event_espresso"
+						),
+						$old_site_url,
+						site_url()
+					)
+				);
+			};
+			unset($csv_data_array[ EE_CSV::metadata_header ]);
+		}
+		/**
+		 * @var $old_db_to_new_db_mapping 2d array: toplevel keys being model names, bottom-level keys being the original key, and
+		 * the value will be the newly-inserted ID.
+		 * If we have already imported data from the same website via CSV, it shoudl be kept in this wp option
+		 */
+		$old_db_to_new_db_mapping = get_option('ee_id_mapping_from' . sanitize_title($old_site_url), array());
+		if ($old_db_to_new_db_mapping) {
+			EE_Error::add_attention(
+				sprintf(
+					__(
+						"We noticed you have imported data via CSV from %s before. Because of this, IDs in your CSV have been mapped to their new IDs in %s",
+						"event_espresso"
+					),
+					$old_site_url,
+					site_url()
+				)
+			);
+		}
+		$old_db_to_new_db_mapping = $this->save_data_rows_to_db(
+			$csv_data_array,
+			$export_from_site_a_to_b,
+			$old_db_to_new_db_mapping
+		);
+
+		// save the mapping from old db to new db in case they try re-importing the same data from the same website again
+		update_option('ee_id_mapping_from' . sanitize_title($old_site_url), $old_db_to_new_db_mapping);
+
+		if ($this->_total_updates > 0) {
+			EE_Error::add_success(
+				sprintf(
+					__("%s existing records in the database were updated.", "event_espresso"),
+					$this->_total_updates
+				)
+			);
+			$success = true;
+		}
+		if ($this->_total_inserts > 0) {
+			EE_Error::add_success(
+				sprintf(__("%s new records were added to the database.", "event_espresso"), $this->_total_inserts)
+			);
+			$success = true;
+		}
+
+		if ($this->_total_update_errors > 0) {
+			EE_Error::add_error(
+				sprintf(
+					__(
+						"'One or more errors occurred, and a total of %s existing records in the database were <strong>not</strong> updated.'",
+						"event_espresso"
+					),
+					$this->_total_update_errors
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$error = true;
+		}
+		if ($this->_total_insert_errors > 0) {
+			EE_Error::add_error(
+				sprintf(
+					__(
+						"One or more errors occurred, and a total of %s new records were <strong>not</strong> added to the database.'",
+						"event_espresso"
+					),
+					$this->_total_insert_errors
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$error = true;
+		}
+
+		// lastly, we need to update the datetime and ticket sold amounts
+		// as those may have been affected by this
+		EEM_Ticket::instance()->update_tickets_sold(EEM_Ticket::instance()->get_all());
+
+		// if there was at least one success and absolutely no errors
+		if ($success && ! $error) {
+			return true;
+		} else {
+			return false;
+		}
+	}
+
+
+	/**
+	 * Processes the array of data, given the knowledge that it's from the same database or a different one,
+	 * and the mapping from temporary IDs to real IDs.
+	 * If the data is from a different database, we treat the primary keys and their corresponding
+	 * foreign keys as "temp Ids", basically identifiers that get mapped to real primary keys
+	 * in the real target database. As items are inserted, their temporary primary keys
+	 * are mapped to the real IDs in the target database. Also, before doing any update or
+	 * insert, we replace all the temp ID which are foreign keys with their mapped real IDs.
+	 * An exception: string primary keys are treated as real IDs, or else we'd need to
+	 * dynamically generate new string primary keys which would be very awkard for the country table etc.
+	 * Also, models with no primary key are strange too. We combine use their primar key INDEX (a
+	 * combination of fields) to create a unique string identifying the row and store
+	 * those in the mapping.
+	 *
+	 * If the data is from the same database, we usually treat primary keys as real IDs.
+	 * An exception is if there is nothing in the database for that ID. If that's the case,
+	 * we need to insert a new row for that ID, and then map from the non-existent ID
+	 * to the newly-inserted real ID.
+	 *
+	 * @param type $csv_data_array
+	 * @param type $export_from_site_a_to_b
+	 * @param type $old_db_to_new_db_mapping
+	 * @return array updated $old_db_to_new_db_mapping
+	 */
+	public function save_data_rows_to_db($csv_data_array, $export_from_site_a_to_b, $old_db_to_new_db_mapping)
+	{
+		foreach ($csv_data_array as $model_name_in_csv_data => $model_data_from_import) {
+			// now check that assumption was correct. If
+			if (EE_Registry::instance()->is_model_name($model_name_in_csv_data)) {
+				$model_name = $model_name_in_csv_data;
+			} else {
+				// no table info in the array and no table name passed to the function?? FAIL
+				EE_Error::add_error(
+					__(
+						'No table information was specified and/or found, therefore the import could not be completed',
+						'event_espresso'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+				return false;
+			}
+			/* @var $model EEM_Base */
+			$model = EE_Registry::instance()->load_model($model_name);
+
+			// so without further ado, scanning all the data provided for primary keys and their inital values
+			foreach ($model_data_from_import as $model_object_data) {
+				// before we do ANYTHING, make sure the csv row wasn't just completely blank
+				$row_is_completely_empty = true;
+				foreach ($model_object_data as $field) {
+					if ($field) {
+						$row_is_completely_empty = false;
+					}
+				}
+				if ($row_is_completely_empty) {
+					continue;
+				}
+				// find the PK in the row of data (or a combined key if
+				// there is no primary key)
+				if ($model->has_primary_key_field()) {
+					$id_in_csv = $model_object_data[ $model->primary_key_name() ];
+				} else {
+					$id_in_csv = $model->get_index_primary_key_string($model_object_data);
+				}
+
+
+				$model_object_data = $this->_replace_temp_ids_with_mappings(
+					$model_object_data,
+					$model,
+					$old_db_to_new_db_mapping,
+					$export_from_site_a_to_b
+				);
+				// now we need to decide if we're going to add a new model object given the $model_object_data,
+				// or just update.
+				if ($export_from_site_a_to_b) {
+					$what_to_do = $this->_decide_whether_to_insert_or_update_given_data_from_other_db(
+						$id_in_csv,
+						$model_object_data,
+						$model,
+						$old_db_to_new_db_mapping
+					);
+				} else {// this is just a re-import
+					$what_to_do = $this->_decide_whether_to_insert_or_update_given_data_from_same_db(
+						$id_in_csv,
+						$model_object_data,
+						$model,
+						$old_db_to_new_db_mapping
+					);
+				}
+				if ($what_to_do == self::do_nothing) {
+					continue;
+				}
+
+				// double-check we actually want to insert, if that's what we're planning
+				// based on whether this item would be unique in the DB or not
+				if ($what_to_do == self::do_insert) {
+					// we're supposed to be inserting. But wait, will this thing
+					// be acceptable if inserted?
+					$conflicting = $model->get_one_conflicting($model_object_data, false);
+					if ($conflicting) {
+						// ok, this item would conflict if inserted. Just update the item that it conflicts with.
+						$what_to_do = self::do_update;
+						// and if this model has a primary key, remember its mapping
+						if ($model->has_primary_key_field()) {
+							$old_db_to_new_db_mapping[ $model_name ][ $id_in_csv ] = $conflicting->ID();
+							$model_object_data[ $model->primary_key_name() ] = $conflicting->ID();
+						} else {
+							// we want to update this conflicting item, instead of inserting a conflicting item
+							// so we need to make sure they match entirely (its possible that they only conflicted on one field, but we need them to match on other fields
+							// for the WHERE conditions in the update). At the time of this comment, there were no models like this
+							foreach ($model->get_combined_primary_key_fields() as $key_field) {
+								$model_object_data[ $key_field->get_name() ] = $conflicting->get(
+									$key_field->get_name()
+								);
+							}
+						}
+					}
+				}
+				if ($what_to_do == self::do_insert) {
+					$old_db_to_new_db_mapping = $this->_insert_from_data_array(
+						$id_in_csv,
+						$model_object_data,
+						$model,
+						$old_db_to_new_db_mapping
+					);
+				} elseif ($what_to_do == self::do_update) {
+					$old_db_to_new_db_mapping = $this->_update_from_data_array(
+						$id_in_csv,
+						$model_object_data,
+						$model,
+						$old_db_to_new_db_mapping
+					);
+				} else {
+					throw new EE_Error(
+						sprintf(
+							__(
+								'Programming error. We shoudl be inserting or updating, but instead we are being told to "%s", whifh is invalid',
+								'event_espresso'
+							),
+							$what_to_do
+						)
+					);
+				}
+			}
+		}
+		return $old_db_to_new_db_mapping;
+	}
+
+
+	/**
+	 * Decides whether or not to insert, given that this data is from another database.
+	 * So, if the primary key of this $model_object_data already exists in the database,
+	 * it's just a coincidence and we should still insert. The only time we should
+	 * update is when we know what it maps to, or there's something that would
+	 * conflict (and we should instead just update that conflicting thing)
+	 *
+	 * @param string   $id_in_csv
+	 * @param array    $model_object_data        by reference so it can be modified
+	 * @param EEM_Base $model
+	 * @param array    $old_db_to_new_db_mapping by reference so it can be modified
+	 * @return string one of the consts on this class that starts with do_*
+	 */
+	protected function _decide_whether_to_insert_or_update_given_data_from_other_db(
+		$id_in_csv,
+		$model_object_data,
+		$model,
+		$old_db_to_new_db_mapping
+	) {
+		$model_name = $model->get_this_model_name();
+		// if it's a site-to-site export-and-import, see if this modelobject's id
+		// in the old data that we know of
+		if (isset($old_db_to_new_db_mapping[ $model_name ][ $id_in_csv ])) {
+			return self::do_update;
+		} else {
+			return self::do_insert;
+		}
+	}
+
+	/**
+	 * If this thing basically already exists in the database, we want to update it;
+	 * otherwise insert it (ie, someone tweaked the CSV file, or the item was
+	 * deleted in the database so it should be re-inserted)
+	 *
+	 * @param type     $id_in_csv
+	 * @param type     $model_object_data
+	 * @param EEM_Base $model
+	 * @param type     $old_db_to_new_db_mapping
+	 * @return
+	 */
+	protected function _decide_whether_to_insert_or_update_given_data_from_same_db(
+		$id_in_csv,
+		$model_object_data,
+		$model
+	) {
+		// in this case, check if this thing ACTUALLY exists in the database
+		if ($model->get_one_conflicting($model_object_data)) {
+			return self::do_update;
+		} else {
+			return self::do_insert;
+		}
+	}
+
+	/**
+	 * Using the $old_db_to_new_db_mapping array, replaces all the temporary IDs
+	 * with their mapped real IDs. Eg, if importing from site A to B, the mapping
+	 * file may indicate that the ID "my_event_id" maps to an actual event ID of 123.
+	 * So this function searches for any event temp Ids called "my_event_id" and
+	 * replaces them with 123.
+	 * Also, if there is no temp ID for the INT foreign keys from another database,
+	 * replaces them with 0 or the field's default.
+	 *
+	 * @param type     $model_object_data
+	 * @param EEM_Base $model
+	 * @param type     $old_db_to_new_db_mapping
+	 * @param boolean  $export_from_site_a_to_b
+	 * @return array updated model object data with temp IDs removed
+	 */
+	protected function _replace_temp_ids_with_mappings(
+		$model_object_data,
+		$model,
+		$old_db_to_new_db_mapping,
+		$export_from_site_a_to_b
+	) {
+		// if this model object's primary key is in the mapping, replace it
+		if ($model->has_primary_key_field() &&
+			$model->get_primary_key_field()->is_auto_increment() &&
+			isset($old_db_to_new_db_mapping[ $model->get_this_model_name() ]) &&
+			isset(
+				$old_db_to_new_db_mapping[ $model->get_this_model_name() ][ $model_object_data[ $model->primary_key_name() ] ]
+			)) {
+			$model_object_data[ $model->primary_key_name() ] = $old_db_to_new_db_mapping[ $model->get_this_model_name(
+			) ][ $model_object_data[ $model->primary_key_name() ] ];
+		}
+
+		try {
+			$model_name_field = $model->get_field_containing_related_model_name();
+			$models_pointed_to_by_model_name_field = $model_name_field->get_model_names_pointed_to();
+		} catch (EE_Error $e) {
+			$model_name_field = null;
+			$models_pointed_to_by_model_name_field = array();
+		}
+		foreach ($model->field_settings(true) as $field_obj) {
+			if ($field_obj instanceof EE_Foreign_Key_Int_Field) {
+				$models_pointed_to = $field_obj->get_model_names_pointed_to();
+				$found_a_mapping = false;
+				foreach ($models_pointed_to as $model_pointed_to_by_fk) {
+					if ($model_name_field) {
+						$value_of_model_name_field = $model_object_data[ $model_name_field->get_name() ];
+						if ($value_of_model_name_field == $model_pointed_to_by_fk) {
+							$model_object_data[ $field_obj->get_name() ] = $this->_find_mapping_in(
+								$model_object_data[ $field_obj->get_name() ],
+								$model_pointed_to_by_fk,
+								$old_db_to_new_db_mapping,
+								$export_from_site_a_to_b
+							);
+							$found_a_mapping = true;
+							break;
+						}
+					} else {
+						$model_object_data[ $field_obj->get_name() ] = $this->_find_mapping_in(
+							$model_object_data[ $field_obj->get_name() ],
+							$model_pointed_to_by_fk,
+							$old_db_to_new_db_mapping,
+							$export_from_site_a_to_b
+						);
+						$found_a_mapping = true;
+					}
+					// once we've found a mapping for this field no need to continue
+					if ($found_a_mapping) {
+						break;
+					}
+				}
+			} else {
+				// it's a string foreign key (which we leave alone, because those are things
+				// like country names, which we'd really rather not make 2 USAs etc (we'd actually
+				// prefer to just update one)
+				// or it's just a regular value that ought to be replaced
+			}
+		}
+		//
+		if ($model instanceof EEM_Term_Taxonomy) {
+			$model_object_data = $this->_handle_split_term_ids($model_object_data);
+		}
+		return $model_object_data;
+	}
+
+	/**
+	 * If the data was exported PRE-4.2, but then imported POST-4.2, then the term_id
+	 * this term-taxonomy refers to may be out-of-date so we need to update it.
+	 * see https://make.wordpress.org/core/2015/02/16/taxonomy-term-splitting-in-4-2-a-developer-guide/
+	 *
+	 * @param type $model_object_data
+	 * @return array new model object data
+	 */
+	protected function _handle_split_term_ids($model_object_data)
+	{
+		if (isset($model_object_data['term_id'])
+			&& isset($model_object_data['taxonomy'])
+			&& apply_filters(
+				'FHEE__EE_Import__handle_split_term_ids__function_exists',
+				function_exists('wp_get_split_term'),
+				$model_object_data
+			)) {
+			$new_term_id = wp_get_split_term($model_object_data['term_id'], $model_object_data['taxonomy']);
+			if ($new_term_id) {
+				$model_object_data['term_id'] = $new_term_id;
+			}
+		}
+		return $model_object_data;
+	}
+
+	/**
+	 * Given the object's ID and its model's name, find it int he mapping data,
+	 * bearing in mind where it came from
+	 *
+	 * @param type   $object_id
+	 * @param string $model_name
+	 * @param array  $old_db_to_new_db_mapping
+	 * @param type   $export_from_site_a_to_b
+	 * @return int
+	 */
+	protected function _find_mapping_in($object_id, $model_name, $old_db_to_new_db_mapping, $export_from_site_a_to_b)
+	{
+		if (isset($old_db_to_new_db_mapping[ $model_name ][ $object_id ])) {
+			return $old_db_to_new_db_mapping[ $model_name ][ $object_id ];
+		} elseif ($object_id == '0' || $object_id == '') {
+			// leave as-is
+			return $object_id;
+		} elseif ($export_from_site_a_to_b) {
+			// we couldn't find a mapping for this, and it's from a different site,
+			// so blank it out
+			return null;
+		} elseif (! $export_from_site_a_to_b) {
+			// we coudln't find a mapping for this, but it's from thsi DB anyway
+			// so let's just leave it as-is
+			return $object_id;
+		}
+	}
+
+	/**
+	 *
+	 * @param type     $id_in_csv
+	 * @param type     $model_object_data
+	 * @param EEM_Base $model
+	 * @param type     $old_db_to_new_db_mapping
+	 * @return array updated $old_db_to_new_db_mapping
+	 */
+	protected function _insert_from_data_array($id_in_csv, $model_object_data, $model, $old_db_to_new_db_mapping)
+	{
+		// remove the primary key, if there is one (we don't want it for inserts OR updates)
+		// we'll put it back in if we need it
+		if ($model->has_primary_key_field() && $model->get_primary_key_field()->is_auto_increment()) {
+			$effective_id = $model_object_data[ $model->primary_key_name() ];
+			unset($model_object_data[ $model->primary_key_name() ]);
+		} else {
+			$effective_id = $model->get_index_primary_key_string($model_object_data);
+		}
+		// the model takes care of validating the CSV's input
+		try {
+			$new_id = $model->insert($model_object_data);
+			if ($new_id) {
+				$old_db_to_new_db_mapping[ $model->get_this_model_name() ][ $id_in_csv ] = $new_id;
+				$this->_total_inserts++;
+				EE_Error::add_success(
+					sprintf(
+						__("Successfully added new %s (with id %s) with csv data %s", "event_espresso"),
+						$model->get_this_model_name(),
+						$new_id,
+						implode(",", $model_object_data)
+					)
+				);
+			} else {
+				$this->_total_insert_errors++;
+				// put the ID used back in there for the error message
+				if ($model->has_primary_key_field()) {
+					$model_object_data[ $model->primary_key_name() ] = $effective_id;
+				}
+				EE_Error::add_error(
+					sprintf(
+						__("Could not insert new %s with the csv data: %s", "event_espresso"),
+						$model->get_this_model_name(),
+						http_build_query($model_object_data)
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+		} catch (EE_Error $e) {
+			$this->_total_insert_errors++;
+			if ($model->has_primary_key_field()) {
+				$model_object_data[ $model->primary_key_name() ] = $effective_id;
+			}
+			EE_Error::add_error(
+				sprintf(
+					__("Could not insert new %s with the csv data: %s because %s", "event_espresso"),
+					$model->get_this_model_name(),
+					implode(",", $model_object_data),
+					$e->getMessage()
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		return $old_db_to_new_db_mapping;
+	}
+
+	/**
+	 * Given the model object data, finds the row to update and updates it
+	 *
+	 * @param string|int $id_in_csv
+	 * @param array      $model_object_data
+	 * @param EEM_Base   $model
+	 * @param array      $old_db_to_new_db_mapping
+	 * @return array updated $old_db_to_new_db_mapping
+	 */
+	protected function _update_from_data_array($id_in_csv, $model_object_data, $model, $old_db_to_new_db_mapping)
+	{
+		try {
+			// let's keep two copies of the model object data:
+			// one for performing an update, one for everthing else
+			$model_object_data_for_update = $model_object_data;
+			if ($model->has_primary_key_field()) {
+				$conditions = array($model->primary_key_name() => $model_object_data[ $model->primary_key_name() ]);
+				// remove the primary key because we shouldn't use it for updating
+				unset($model_object_data_for_update[ $model->primary_key_name() ]);
+			} elseif ($model->get_combined_primary_key_fields() > 1) {
+				$conditions = array();
+				foreach ($model->get_combined_primary_key_fields() as $key_field) {
+					$conditions[ $key_field->get_name() ] = $model_object_data[ $key_field->get_name() ];
+				}
+			} else {
+				$model->primary_key_name(
+				);// this shoudl just throw an exception, explaining that we dont have a primary key (or a combine dkey)
+			}
+
+			$success = $model->update($model_object_data_for_update, array($conditions));
+			if ($success) {
+				$this->_total_updates++;
+				EE_Error::add_success(
+					sprintf(
+						__("Successfully updated %s with csv data %s", "event_espresso"),
+						$model->get_this_model_name(),
+						implode(",", $model_object_data_for_update)
+					)
+				);
+				// we should still record the mapping even though it was an update
+				// because if we were going to insert somethign but it was going to conflict
+				// we would have last-minute decided to update. So we'd like to know what we updated
+				// and so we record what record ended up being updated using the mapping
+				if ($model->has_primary_key_field()) {
+					$new_key_for_mapping = $model_object_data[ $model->primary_key_name() ];
+				} else {
+					// no primary key just a combined key
+					$new_key_for_mapping = $model->get_index_primary_key_string($model_object_data);
+				}
+				$old_db_to_new_db_mapping[ $model->get_this_model_name() ][ $id_in_csv ] = $new_key_for_mapping;
+			} else {
+				$matched_items = $model->get_all(array($conditions));
+				if (! $matched_items) {
+					// no items were matched (so we shouldn't have updated)... but then we should have inserted? what the heck?
+					$this->_total_update_errors++;
+					EE_Error::add_error(
+						sprintf(
+							__(
+								"Could not update %s with the csv data: '%s' for an unknown reason (using WHERE conditions %s)",
+								"event_espresso"
+							),
+							$model->get_this_model_name(),
+							http_build_query($model_object_data),
+							http_build_query($conditions)
+						),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+				} else {
+					$this->_total_updates++;
+					EE_Error::add_success(
+						sprintf(
+							__(
+								"%s with csv data '%s' was found in the database and didn't need updating because all the data is identical.",
+								"event_espresso"
+							),
+							$model->get_this_model_name(),
+							implode(",", $model_object_data)
+						)
+					);
+				}
+			}
+		} catch (EE_Error $e) {
+			$this->_total_update_errors++;
+			$basic_message = sprintf(
+				__("Could not update %s with the csv data: %s because %s", "event_espresso"),
+				$model->get_this_model_name(),
+				implode(",", $model_object_data),
+				$e->getMessage()
+			);
+			$debug_message = $basic_message . ' Stack trace: ' . $e->getTraceAsString();
+			EE_Error::add_error("$basic_message | $debug_message", __FILE__, __FUNCTION__, __LINE__);
+		}
+		return $old_db_to_new_db_mapping;
+	}
+
+	/**
+	 * Gets the number of inserts performed since importer was instantiated or reset
+	 *
+	 * @return int
+	 */
+	public function get_total_inserts()
+	{
+		return $this->_total_inserts;
+	}
+
+	/**
+	 *  Gets the number of insert errors since importer was instantiated or reset
+	 *
+	 * @return int
+	 */
+	public function get_total_insert_errors()
+	{
+		return $this->_total_insert_errors;
+	}
+
+	/**
+	 *  Gets the number of updates performed since importer was instantiated or reset
+	 *
+	 * @return int
+	 */
+	public function get_total_updates()
+	{
+		return $this->_total_updates;
+	}
+
+	/**
+	 *  Gets the number of update errors since importer was instantiated or reset
+	 *
+	 * @return int
+	 */
+	public function get_total_update_errors()
+	{
+		return $this->_total_update_errors;
+	}
 }

Spacing +40 added lines, -40 removed lines

@@ -135,7 +135,7 @@ 
     public function import()
     {
 
-        require_once(EE_CLASSES . 'EE_CSV.class.php');
+        require_once(EE_CLASSES.'EE_CSV.class.php');
         $this->EE_CSV = EE_CSV::instance();
 
         if (isset($_REQUEST['import'])) {
@@ -179,18 +179,18 @@ 
                         break;
                 }
 
-                if (! $error_msg) {
+                if ( ! $error_msg) {
                     $filename = $_FILES['file']['name'][0];
                     $file_ext = substr(strrchr($filename, '.'), 1);
                     $file_type = $_FILES['file']['type'][0];
                     $temp_file = $_FILES['file']['tmp_name'][0];
-                    $filesize = $_FILES['file']['size'][0] / 1024;// convert from bytes to KB
+                    $filesize = $_FILES['file']['size'][0] / 1024; // convert from bytes to KB
 
                     if ($file_ext == 'csv') {
-                        $max_upload = $this->EE_CSV->get_max_upload_size();// max upload size in KB
+                        $max_upload = $this->EE_CSV->get_max_upload_size(); // max upload size in KB
                         if ($filesize < $max_upload || true) {
                             $wp_upload_dir = str_replace(array('\\', '/'), '/', wp_upload_dir());
-                            $path_to_file = $wp_upload_dir['basedir'] . '/espresso/' . $filename;
+                            $path_to_file = $wp_upload_dir['basedir'].'/espresso/'.$filename;
 
                             if (move_uploaded_file($temp_file, $path_to_file)) {
                                 // convert csv to array
@@ -324,8 +324,8 @@ 
         // begin looking through the $csv_data_array, expecting the toplevel key to be the model's name...
         $old_site_url = 'none-specified';
         // hanlde metadata
-        if (isset($csv_data_array[ EE_CSV::metadata_header ])) {
-            $csv_metadata = array_shift($csv_data_array[ EE_CSV::metadata_header ]);
+        if (isset($csv_data_array[EE_CSV::metadata_header])) {
+            $csv_metadata = array_shift($csv_data_array[EE_CSV::metadata_header]);
             // ok so its metadata, dont try to save it to ehte db obviously...
             if (isset($csv_metadata['site_url']) && $csv_metadata['site_url'] == site_url()) {
                 EE_Error::add_attention(
@@ -350,14 +350,14 @@ 
                     )
                 );
             };
-            unset($csv_data_array[ EE_CSV::metadata_header ]);
+            unset($csv_data_array[EE_CSV::metadata_header]);
         }
         /**
          * @var $old_db_to_new_db_mapping 2d array: toplevel keys being model names, bottom-level keys being the original key, and
          * the value will be the newly-inserted ID.
          * If we have already imported data from the same website via CSV, it shoudl be kept in this wp option
          */
-        $old_db_to_new_db_mapping = get_option('ee_id_mapping_from' . sanitize_title($old_site_url), array());
+        $old_db_to_new_db_mapping = get_option('ee_id_mapping_from'.sanitize_title($old_site_url), array());
         if ($old_db_to_new_db_mapping) {
             EE_Error::add_attention(
                 sprintf(
@@ -377,7 +377,7 @@ 
         );
 
         // save the mapping from old db to new db in case they try re-importing the same data from the same website again
-        update_option('ee_id_mapping_from' . sanitize_title($old_site_url), $old_db_to_new_db_mapping);
+        update_option('ee_id_mapping_from'.sanitize_title($old_site_url), $old_db_to_new_db_mapping);
 
         if ($this->_total_updates > 0) {
             EE_Error::add_success(
@@ -500,7 +500,7 @@ 
                 // find the PK in the row of data (or a combined key if
                 // there is no primary key)
                 if ($model->has_primary_key_field()) {
-                    $id_in_csv = $model_object_data[ $model->primary_key_name() ];
+                    $id_in_csv = $model_object_data[$model->primary_key_name()];
                 } else {
                     $id_in_csv = $model->get_index_primary_key_string($model_object_data);
                 }
@@ -544,14 +544,14 @@ 
                         $what_to_do = self::do_update;
                         // and if this model has a primary key, remember its mapping
                         if ($model->has_primary_key_field()) {
-                            $old_db_to_new_db_mapping[ $model_name ][ $id_in_csv ] = $conflicting->ID();
-                            $model_object_data[ $model->primary_key_name() ] = $conflicting->ID();
+                            $old_db_to_new_db_mapping[$model_name][$id_in_csv] = $conflicting->ID();
+                            $model_object_data[$model->primary_key_name()] = $conflicting->ID();
                         } else {
                             // we want to update this conflicting item, instead of inserting a conflicting item
                             // so we need to make sure they match entirely (its possible that they only conflicted on one field, but we need them to match on other fields
                             // for the WHERE conditions in the update). At the time of this comment, there were no models like this
                             foreach ($model->get_combined_primary_key_fields() as $key_field) {
-                                $model_object_data[ $key_field->get_name() ] = $conflicting->get(
+                                $model_object_data[$key_field->get_name()] = $conflicting->get(
                                     $key_field->get_name()
                                 );
                             }
@@ -611,7 +611,7 @@ 
         $model_name = $model->get_this_model_name();
         // if it's a site-to-site export-and-import, see if this modelobject's id
         // in the old data that we know of
-        if (isset($old_db_to_new_db_mapping[ $model_name ][ $id_in_csv ])) {
+        if (isset($old_db_to_new_db_mapping[$model_name][$id_in_csv])) {
             return self::do_update;
         } else {
             return self::do_insert;
@@ -666,12 +666,12 @@ 
         // if this model object's primary key is in the mapping, replace it
         if ($model->has_primary_key_field() &&
             $model->get_primary_key_field()->is_auto_increment() &&
-            isset($old_db_to_new_db_mapping[ $model->get_this_model_name() ]) &&
+            isset($old_db_to_new_db_mapping[$model->get_this_model_name()]) &&
             isset(
-                $old_db_to_new_db_mapping[ $model->get_this_model_name() ][ $model_object_data[ $model->primary_key_name() ] ]
+                $old_db_to_new_db_mapping[$model->get_this_model_name()][$model_object_data[$model->primary_key_name()]]
             )) {
-            $model_object_data[ $model->primary_key_name() ] = $old_db_to_new_db_mapping[ $model->get_this_model_name(
-            ) ][ $model_object_data[ $model->primary_key_name() ] ];
+            $model_object_data[$model->primary_key_name()] = $old_db_to_new_db_mapping[$model->get_this_model_name(
+            )][$model_object_data[$model->primary_key_name()]];
         }
 
         try {
@@ -687,10 +687,10 @@ 
                 $found_a_mapping = false;
                 foreach ($models_pointed_to as $model_pointed_to_by_fk) {
                     if ($model_name_field) {
-                        $value_of_model_name_field = $model_object_data[ $model_name_field->get_name() ];
+                        $value_of_model_name_field = $model_object_data[$model_name_field->get_name()];
                         if ($value_of_model_name_field == $model_pointed_to_by_fk) {
-                            $model_object_data[ $field_obj->get_name() ] = $this->_find_mapping_in(
-                                $model_object_data[ $field_obj->get_name() ],
+                            $model_object_data[$field_obj->get_name()] = $this->_find_mapping_in(
+                                $model_object_data[$field_obj->get_name()],
                                 $model_pointed_to_by_fk,
                                 $old_db_to_new_db_mapping,
                                 $export_from_site_a_to_b
@@ -699,8 +699,8 @@ 
                             break;
                         }
                     } else {
-                        $model_object_data[ $field_obj->get_name() ] = $this->_find_mapping_in(
-                            $model_object_data[ $field_obj->get_name() ],
+                        $model_object_data[$field_obj->get_name()] = $this->_find_mapping_in(
+                            $model_object_data[$field_obj->get_name()],
                             $model_pointed_to_by_fk,
                             $old_db_to_new_db_mapping,
                             $export_from_site_a_to_b
@@ -763,8 +763,8 @@ 
      */
     protected function _find_mapping_in($object_id, $model_name, $old_db_to_new_db_mapping, $export_from_site_a_to_b)
     {
-        if (isset($old_db_to_new_db_mapping[ $model_name ][ $object_id ])) {
-            return $old_db_to_new_db_mapping[ $model_name ][ $object_id ];
+        if (isset($old_db_to_new_db_mapping[$model_name][$object_id])) {
+            return $old_db_to_new_db_mapping[$model_name][$object_id];
         } elseif ($object_id == '0' || $object_id == '') {
             // leave as-is
             return $object_id;
@@ -772,7 +772,7 @@ 
             // we couldn't find a mapping for this, and it's from a different site,
             // so blank it out
             return null;
-        } elseif (! $export_from_site_a_to_b) {
+        } elseif ( ! $export_from_site_a_to_b) {
             // we coudln't find a mapping for this, but it's from thsi DB anyway
             // so let's just leave it as-is
             return $object_id;
@@ -792,8 +792,8 @@ 
         // remove the primary key, if there is one (we don't want it for inserts OR updates)
         // we'll put it back in if we need it
         if ($model->has_primary_key_field() && $model->get_primary_key_field()->is_auto_increment()) {
-            $effective_id = $model_object_data[ $model->primary_key_name() ];
-            unset($model_object_data[ $model->primary_key_name() ]);
+            $effective_id = $model_object_data[$model->primary_key_name()];
+            unset($model_object_data[$model->primary_key_name()]);
         } else {
             $effective_id = $model->get_index_primary_key_string($model_object_data);
         }
@@ -801,7 +801,7 @@ 
         try {
             $new_id = $model->insert($model_object_data);
             if ($new_id) {
-                $old_db_to_new_db_mapping[ $model->get_this_model_name() ][ $id_in_csv ] = $new_id;
+                $old_db_to_new_db_mapping[$model->get_this_model_name()][$id_in_csv] = $new_id;
                 $this->_total_inserts++;
                 EE_Error::add_success(
                     sprintf(
@@ -815,7 +815,7 @@ 
                 $this->_total_insert_errors++;
                 // put the ID used back in there for the error message
                 if ($model->has_primary_key_field()) {
-                    $model_object_data[ $model->primary_key_name() ] = $effective_id;
+                    $model_object_data[$model->primary_key_name()] = $effective_id;
                 }
                 EE_Error::add_error(
                     sprintf(
@@ -831,7 +831,7 @@ 
         } catch (EE_Error $e) {
             $this->_total_insert_errors++;
             if ($model->has_primary_key_field()) {
-                $model_object_data[ $model->primary_key_name() ] = $effective_id;
+                $model_object_data[$model->primary_key_name()] = $effective_id;
             }
             EE_Error::add_error(
                 sprintf(
@@ -864,17 +864,17 @@ 
             // one for performing an update, one for everthing else
             $model_object_data_for_update = $model_object_data;
             if ($model->has_primary_key_field()) {
-                $conditions = array($model->primary_key_name() => $model_object_data[ $model->primary_key_name() ]);
+                $conditions = array($model->primary_key_name() => $model_object_data[$model->primary_key_name()]);
                 // remove the primary key because we shouldn't use it for updating
-                unset($model_object_data_for_update[ $model->primary_key_name() ]);
+                unset($model_object_data_for_update[$model->primary_key_name()]);
             } elseif ($model->get_combined_primary_key_fields() > 1) {
                 $conditions = array();
                 foreach ($model->get_combined_primary_key_fields() as $key_field) {
-                    $conditions[ $key_field->get_name() ] = $model_object_data[ $key_field->get_name() ];
+                    $conditions[$key_field->get_name()] = $model_object_data[$key_field->get_name()];
                 }
             } else {
                 $model->primary_key_name(
-                );// this shoudl just throw an exception, explaining that we dont have a primary key (or a combine dkey)
+                ); // this shoudl just throw an exception, explaining that we dont have a primary key (or a combine dkey)
             }
 
             $success = $model->update($model_object_data_for_update, array($conditions));
@@ -892,15 +892,15 @@ 
                 // we would have last-minute decided to update. So we'd like to know what we updated
                 // and so we record what record ended up being updated using the mapping
                 if ($model->has_primary_key_field()) {
-                    $new_key_for_mapping = $model_object_data[ $model->primary_key_name() ];
+                    $new_key_for_mapping = $model_object_data[$model->primary_key_name()];
                 } else {
                     // no primary key just a combined key
                     $new_key_for_mapping = $model->get_index_primary_key_string($model_object_data);
                 }
-                $old_db_to_new_db_mapping[ $model->get_this_model_name() ][ $id_in_csv ] = $new_key_for_mapping;
+                $old_db_to_new_db_mapping[$model->get_this_model_name()][$id_in_csv] = $new_key_for_mapping;
             } else {
                 $matched_items = $model->get_all(array($conditions));
-                if (! $matched_items) {
+                if ( ! $matched_items) {
                     // no items were matched (so we shouldn't have updated)... but then we should have inserted? what the heck?
                     $this->_total_update_errors++;
                     EE_Error::add_error(
@@ -939,7 +939,7 @@ 
                 implode(",", $model_object_data),
                 $e->getMessage()
             );
-            $debug_message = $basic_message . ' Stack trace: ' . $e->getTraceAsString();
+            $debug_message = $basic_message.' Stack trace: '.$e->getTraceAsString();
             EE_Error::add_error("$basic_message | $debug_message", __FILE__, __FUNCTION__, __LINE__);
         }
         return $old_db_to_new_db_mapping;

core/libraries/plugin_api/EE_Register_Addon.lib.php

Indentation +1161 added lines, -1161 removed lines

@@ -22,1225 +22,1225 @@
 class EE_Register_Addon implements EEI_Plugin_API
 {
 
-    /**
-     * possibly truncated version of the EE core version string
-     *
-     * @var string
-     */
-    protected static $_core_version = '';
+	/**
+	 * possibly truncated version of the EE core version string
+	 *
+	 * @var string
+	 */
+	protected static $_core_version = '';
 
-    /**
-     * Holds values for registered addons
-     *
-     * @var array
-     */
-    protected static $_settings = array();
+	/**
+	 * Holds values for registered addons
+	 *
+	 * @var array
+	 */
+	protected static $_settings = array();
 
-    /**
-     * @var  array $_incompatible_addons keys are addon SLUGS
-     * (first argument passed to EE_Register_Addon::register()), keys are
-     * their MINIMUM VERSION (with all 5 parts. Eg 1.2.3.rc.004).
-     * Generally this should be used sparingly, as we don't want to muddle up
-     * EE core with knowledge of ALL the addons out there.
-     * If you want NO versions of an addon to run with a certain version of core,
-     * it's usually best to define the addon's "min_core_version" as part of its call
-     * to EE_Register_Addon::register(), rather than using this array with a super high value for its
-     * minimum plugin version.
-     * @access    protected
-     */
-    protected static $_incompatible_addons = array(
-        'Multi_Event_Registration' => '2.0.11.rc.002',
-        'Promotions'               => '1.0.0.rc.084',
-    );
+	/**
+	 * @var  array $_incompatible_addons keys are addon SLUGS
+	 * (first argument passed to EE_Register_Addon::register()), keys are
+	 * their MINIMUM VERSION (with all 5 parts. Eg 1.2.3.rc.004).
+	 * Generally this should be used sparingly, as we don't want to muddle up
+	 * EE core with knowledge of ALL the addons out there.
+	 * If you want NO versions of an addon to run with a certain version of core,
+	 * it's usually best to define the addon's "min_core_version" as part of its call
+	 * to EE_Register_Addon::register(), rather than using this array with a super high value for its
+	 * minimum plugin version.
+	 * @access    protected
+	 */
+	protected static $_incompatible_addons = array(
+		'Multi_Event_Registration' => '2.0.11.rc.002',
+		'Promotions'               => '1.0.0.rc.084',
+	);
 
 
-    /**
-     * We should always be comparing core to a version like '4.3.0.rc.000',
-     * not just '4.3.0'.
-     * So if the addon developer doesn't provide that full version string,
-     * fill in the blanks for them
-     *
-     * @param string $min_core_version
-     * @return string always like '4.3.0.rc.000'
-     */
-    protected static function _effective_version($min_core_version)
-    {
-        // versions: 4 . 3 . 1 . p . 123
-        // offsets:    0 . 1 . 2 . 3 . 4
-        $version_parts = explode('.', $min_core_version);
-        // check they specified the micro version (after 2nd period)
-        if (! isset($version_parts[2])) {
-            $version_parts[2] = '0';
-        }
-        // if they didn't specify the 'p', or 'rc' part. Just assume the lowest possible
-        // soon we can assume that's 'rc', but this current version is 'alpha'
-        if (! isset($version_parts[3])) {
-            $version_parts[3] = 'dev';
-        }
-        if (! isset($version_parts[4])) {
-            $version_parts[4] = '000';
-        }
-        return implode('.', $version_parts);
-    }
+	/**
+	 * We should always be comparing core to a version like '4.3.0.rc.000',
+	 * not just '4.3.0'.
+	 * So if the addon developer doesn't provide that full version string,
+	 * fill in the blanks for them
+	 *
+	 * @param string $min_core_version
+	 * @return string always like '4.3.0.rc.000'
+	 */
+	protected static function _effective_version($min_core_version)
+	{
+		// versions: 4 . 3 . 1 . p . 123
+		// offsets:    0 . 1 . 2 . 3 . 4
+		$version_parts = explode('.', $min_core_version);
+		// check they specified the micro version (after 2nd period)
+		if (! isset($version_parts[2])) {
+			$version_parts[2] = '0';
+		}
+		// if they didn't specify the 'p', or 'rc' part. Just assume the lowest possible
+		// soon we can assume that's 'rc', but this current version is 'alpha'
+		if (! isset($version_parts[3])) {
+			$version_parts[3] = 'dev';
+		}
+		if (! isset($version_parts[4])) {
+			$version_parts[4] = '000';
+		}
+		return implode('.', $version_parts);
+	}
 
 
-    /**
-     * Returns whether or not the min core version requirement of the addon is met
-     *
-     * @param string $min_core_version    the minimum core version required by the addon
-     * @param string $actual_core_version the actual core version, optional
-     * @return boolean
-     */
-    public static function _meets_min_core_version_requirement(
-        $min_core_version,
-        $actual_core_version = EVENT_ESPRESSO_VERSION
-    ) {
-        return version_compare(
-            self::_effective_version($actual_core_version),
-            self::_effective_version($min_core_version),
-            '>='
-        );
-    }
+	/**
+	 * Returns whether or not the min core version requirement of the addon is met
+	 *
+	 * @param string $min_core_version    the minimum core version required by the addon
+	 * @param string $actual_core_version the actual core version, optional
+	 * @return boolean
+	 */
+	public static function _meets_min_core_version_requirement(
+		$min_core_version,
+		$actual_core_version = EVENT_ESPRESSO_VERSION
+	) {
+		return version_compare(
+			self::_effective_version($actual_core_version),
+			self::_effective_version($min_core_version),
+			'>='
+		);
+	}
 
 
-    /**
-     * Method for registering new EE_Addons.
-     * Should be called AFTER AHEE__EE_System__load_espresso_addons but BEFORE
-     * AHEE__EE_System___detect_if_activation_or_upgrade__begin in order to register all its components. However, it
-     * may also be called after the 'activate_plugin' action (when an addon is activated), because an activating addon
-     * won't be loaded by WP until after AHEE__EE_System__load_espresso_addons has fired. If its called after
-     * 'activate_plugin', it registers the addon still, but its components are not registered
-     * (they shouldn't be needed anyways, because it's just an activation request and they won't have a chance to do
-     * anything anyways). Instead, it just sets the newly-activated addon's activation indicator wp option and returns
-     * (so that we can detect that the addon has activated on the subsequent request)
-     *
-     * @since    4.3.0
-     * @param string                  $addon_name                       [Required] the EE_Addon's name.
-     * @param  array                  $setup_args                       {
-     *                                                                  An array of arguments provided for registering
-     *                                                                  the message type.
-     * @type  string                  $class_name                       the addon's main file name.
-     *                                                                  If left blank, generated from the addon name,
-     *                                                                  changes something like "calendar" to
-     *                                                                  "EE_Calendar"
-     * @type string                   $min_core_version                 the minimum version of EE Core that the
-     *                                                                  addon will work with. eg "4.8.1.rc.084"
-     * @type string                   $version                          the "software" version for the addon. eg
-     *                                                                  "1.0.0.p" for a first stable release, or
-     *                                                                  "1.0.0.rc.043" for a version in progress
-     * @type string                   $main_file_path                   the full server path to the main file
-     *                                                                  loaded directly by WP
-     * @type DomainInterface $domain                                    child class of
-     *                                                                  EventEspresso\core\domain\DomainBase
-     * @type string                   $domain_fqcn                      Fully Qualified Class Name
-     *                                                                  for the addon's Domain class
-     *                                                                  (see EventEspresso\core\domain\Domain)
-     * @type string                   $admin_path                       full server path to the folder where the
-     *                                                                  addon\'s admin files reside
-     * @type string                   $admin_callback                   a method to be called when the EE Admin is
-     *                                                                  first invoked, can be used for hooking into
-     *                                                                  any admin page
-     * @type string                   $config_section                   the section name for this addon's
-     *                                                                  configuration settings section
-     *                                                                  (defaults to "addons")
-     * @type string                   $config_class                     the class name for this addon's
-     *                                                                  configuration settings object
-     * @type string                   $config_name                      the class name for this addon's
-     *                                                                  configuration settings object
-     * @type string                   $autoloader_paths                 [Required] an array of class names and the full
-     *                                                                  server paths to those files.
-     * @type string                   $autoloader_folders               an array of  "full server paths" for any
-     *                                                                  folders containing classes that might be
-     *                                                                  invoked by the addon
-     * @type string                   $dms_paths                        [Required] an array of full server paths to
-     *                                                                  folders that contain data migration scripts.
-     *                                                                  The key should be the EE_Addon class name that
-     *                                                                  this set of data migration scripts belongs to.
-     *                                                                  If the EE_Addon class is namespaced, then this
-     *                                                                  needs to be the Fully Qualified Class Name
-     * @type string                   $module_paths                     an array of full server paths to any
-     *                                                                  EED_Modules used by the addon
-     * @type string                   $shortcode_paths                  an array of full server paths to folders
-     *                                                                  that contain EES_Shortcodes
-     * @type string                   $widget_paths                     an array of full server paths to folders
-     *                                                                  that contain WP_Widgets
-     * @type string                   $pue_options
-     * @type array                    $capabilities                     an array indexed by role name
-     *                                                                  (i.e administrator,author ) and the values
-     *                                                                  are an array of caps to add to the role.
-     *                                                                  'administrator' => array(
-     *                                                                  'read_addon',
-     *                                                                  'edit_addon',
-     *                                                                  etc.
-     *                                                                  ).
-     * @type EE_Meta_Capability_Map[] $capability_maps                  an array of EE_Meta_Capability_Map object
-     *                                                                  for any addons that need to register any
-     *                                                                  special meta mapped capabilities.  Should
-     *                                                                  be indexed where the key is the
-     *                                                                  EE_Meta_Capability_Map class name and the
-     *                                                                  values are the arguments sent to the class.
-     * @type array                    $model_paths                      array of folders containing DB models
-     * @see      EE_Register_Model
-     * @type array                    $class_paths                      array of folders containing DB classes
-     * @see      EE_Register_Model
-     * @type array                    $model_extension_paths            array of folders containing DB model
-     *                                                                  extensions
-     * @see      EE_Register_Model_Extension
-     * @type array                    $class_extension_paths            array of folders containing DB class
-     *                                                                  extensions
-     * @see      EE_Register_Model_Extension
-     * @type array message_types {
-     *                                                                  An array of message types with the key as
-     *                                                                  the message type name and the values as
-     *                                                                  below:
-     * @type string                   $mtfilename                       [Required] The filename of the message type
-     *                                                                  being registered. This will be the main
-     *                                                                  EE_{Message Type Name}_message_type class.
-     *                                                                  for example:
-     *                                                                  EE_Declined_Registration_message_type.class.php
-     * @type array                    $autoloadpaths                    [Required] An array of paths to add to the
-     *                                                                  messages autoloader for the new message type.
-     * @type array                    $messengers_to_activate_with      An array of messengers that this message
-     *                                                                  type should activate with. Each value in
-     *                                                                  the
-     *                                                                  array
-     *                                                                  should match the name property of a
-     *                                                                  EE_messenger. Optional.
-     * @type array                    $messengers_to_validate_with      An array of messengers that this message
-     *                                                                  type should validate with. Each value in
-     *                                                                  the
-     *                                                                  array
-     *                                                                  should match the name property of an
-     *                                                                  EE_messenger.
-     *                                                                  Optional.
-     *                                                                  }
-     * @type array                    $custom_post_types
-     * @type array                    $custom_taxonomies
-     * @type array                    $payment_method_paths             each element is the folder containing the
-     *                                                                  EE_PMT_Base child class
-     *                                                                  (eg,
-     *                                                                  '/wp-content/plugins/my_plugin/Payomatic/'
-     *                                                                  which contains the files
-     *                                                                  EE_PMT_Payomatic.pm.php)
-     * @type array                    $default_terms
-     * @type array                    $namespace                        {
-     *                                                                  An array with two items for registering the
-     *                                                                  addon's namespace. (If, for some reason, you
-     *                                                                  require additional namespaces,
-     *                                                                  use
-     *                                                                  EventEspresso\core\Psr4Autoloader::addNamespace()
-     *                                                                  directly)
-     * @see      EventEspresso\core\Psr4Autoloader::addNamespace()
-     * @type string                   $FQNS                             the namespace prefix
-     * @type string                   $DIR                              a base directory for class files in the
-     *                                                                  namespace.
-     *                                                                  }
-     *                                                                  }
-     * @type string                   $privacy_policies                 FQNSs (namespaces, each of which contains only
-     *                                                                  privacy policy classes) or FQCNs (specific
-     *                                                                  classnames of privacy policy classes)
-     * @type string                   $personal_data_exporters          FQNSs (namespaces, each of which contains only
-     *                                                                  privacy policy classes) or FQCNs (specific
-     *                                                                  classnames of privacy policy classes)
-     * @type string                   $personal_data_erasers            FQNSs (namespaces, each of which contains only
-     *                                                                  privacy policy classes) or FQCNs (specific
-     *                                                                  classnames of privacy policy classes)
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function register($addon_name = '', $setup_args = array())
-    {
-        // required fields MUST be present, so let's make sure they are.
-        EE_Register_Addon::_verify_parameters($addon_name, $setup_args);
-        // get class name for addon
-        $class_name = EE_Register_Addon::_parse_class_name($addon_name, $setup_args);
-        // setup $_settings array from incoming values.
-        $addon_settings = EE_Register_Addon::_get_addon_settings($class_name, $setup_args);
-        // setup PUE
-        EE_Register_Addon::_parse_pue_options($addon_name, $class_name, $setup_args);
-        // does this addon work with this version of core or WordPress ?
-        if (! EE_Register_Addon::_addon_is_compatible($addon_name, $addon_settings)) {
-            return;
-        }
-        // register namespaces
-        EE_Register_Addon::_setup_namespaces($addon_settings);
-        // check if this is an activation request
-        if (EE_Register_Addon::_addon_activation($addon_name, $addon_settings)) {
-            // dont bother setting up the rest of the addon atm
-            return;
-        }
-        // we need cars
-        EE_Register_Addon::_setup_autoloaders($addon_name);
-        // register new models and extensions
-        EE_Register_Addon::_register_models_and_extensions($addon_name);
-        // setup DMS
-        EE_Register_Addon::_register_data_migration_scripts($addon_name);
-        // if config_class is present let's register config.
-        EE_Register_Addon::_register_config($addon_name);
-        // register admin pages
-        EE_Register_Addon::_register_admin_pages($addon_name);
-        // add to list of modules to be registered
-        EE_Register_Addon::_register_modules($addon_name);
-        // add to list of shortcodes to be registered
-        EE_Register_Addon::_register_shortcodes($addon_name);
-        // add to list of widgets to be registered
-        EE_Register_Addon::_register_widgets($addon_name);
-        // register capability related stuff.
-        EE_Register_Addon::_register_capabilities($addon_name);
-        // any message type to register?
-        EE_Register_Addon::_register_message_types($addon_name);
-        // any custom post type/ custom capabilities or default terms to register
-        EE_Register_Addon::_register_custom_post_types($addon_name);
-        // and any payment methods
-        EE_Register_Addon::_register_payment_methods($addon_name);
-        // and privacy policy generators
-        EE_Register_Addon::registerPrivacyPolicies($addon_name);
-        // and privacy policy generators
-        EE_Register_Addon::registerPersonalDataExporters($addon_name);
-        // and privacy policy generators
-        EE_Register_Addon::registerPersonalDataErasers($addon_name);
-        // load and instantiate main addon class
-        $addon = EE_Register_Addon::_load_and_init_addon_class($addon_name);
-        // delay calling after_registration hook on each addon until after all add-ons have been registered.
-        add_action('AHEE__EE_System__load_espresso_addons__complete', array($addon, 'after_registration'), 999);
-    }
+	/**
+	 * Method for registering new EE_Addons.
+	 * Should be called AFTER AHEE__EE_System__load_espresso_addons but BEFORE
+	 * AHEE__EE_System___detect_if_activation_or_upgrade__begin in order to register all its components. However, it
+	 * may also be called after the 'activate_plugin' action (when an addon is activated), because an activating addon
+	 * won't be loaded by WP until after AHEE__EE_System__load_espresso_addons has fired. If its called after
+	 * 'activate_plugin', it registers the addon still, but its components are not registered
+	 * (they shouldn't be needed anyways, because it's just an activation request and they won't have a chance to do
+	 * anything anyways). Instead, it just sets the newly-activated addon's activation indicator wp option and returns
+	 * (so that we can detect that the addon has activated on the subsequent request)
+	 *
+	 * @since    4.3.0
+	 * @param string                  $addon_name                       [Required] the EE_Addon's name.
+	 * @param  array                  $setup_args                       {
+	 *                                                                  An array of arguments provided for registering
+	 *                                                                  the message type.
+	 * @type  string                  $class_name                       the addon's main file name.
+	 *                                                                  If left blank, generated from the addon name,
+	 *                                                                  changes something like "calendar" to
+	 *                                                                  "EE_Calendar"
+	 * @type string                   $min_core_version                 the minimum version of EE Core that the
+	 *                                                                  addon will work with. eg "4.8.1.rc.084"
+	 * @type string                   $version                          the "software" version for the addon. eg
+	 *                                                                  "1.0.0.p" for a first stable release, or
+	 *                                                                  "1.0.0.rc.043" for a version in progress
+	 * @type string                   $main_file_path                   the full server path to the main file
+	 *                                                                  loaded directly by WP
+	 * @type DomainInterface $domain                                    child class of
+	 *                                                                  EventEspresso\core\domain\DomainBase
+	 * @type string                   $domain_fqcn                      Fully Qualified Class Name
+	 *                                                                  for the addon's Domain class
+	 *                                                                  (see EventEspresso\core\domain\Domain)
+	 * @type string                   $admin_path                       full server path to the folder where the
+	 *                                                                  addon\'s admin files reside
+	 * @type string                   $admin_callback                   a method to be called when the EE Admin is
+	 *                                                                  first invoked, can be used for hooking into
+	 *                                                                  any admin page
+	 * @type string                   $config_section                   the section name for this addon's
+	 *                                                                  configuration settings section
+	 *                                                                  (defaults to "addons")
+	 * @type string                   $config_class                     the class name for this addon's
+	 *                                                                  configuration settings object
+	 * @type string                   $config_name                      the class name for this addon's
+	 *                                                                  configuration settings object
+	 * @type string                   $autoloader_paths                 [Required] an array of class names and the full
+	 *                                                                  server paths to those files.
+	 * @type string                   $autoloader_folders               an array of  "full server paths" for any
+	 *                                                                  folders containing classes that might be
+	 *                                                                  invoked by the addon
+	 * @type string                   $dms_paths                        [Required] an array of full server paths to
+	 *                                                                  folders that contain data migration scripts.
+	 *                                                                  The key should be the EE_Addon class name that
+	 *                                                                  this set of data migration scripts belongs to.
+	 *                                                                  If the EE_Addon class is namespaced, then this
+	 *                                                                  needs to be the Fully Qualified Class Name
+	 * @type string                   $module_paths                     an array of full server paths to any
+	 *                                                                  EED_Modules used by the addon
+	 * @type string                   $shortcode_paths                  an array of full server paths to folders
+	 *                                                                  that contain EES_Shortcodes
+	 * @type string                   $widget_paths                     an array of full server paths to folders
+	 *                                                                  that contain WP_Widgets
+	 * @type string                   $pue_options
+	 * @type array                    $capabilities                     an array indexed by role name
+	 *                                                                  (i.e administrator,author ) and the values
+	 *                                                                  are an array of caps to add to the role.
+	 *                                                                  'administrator' => array(
+	 *                                                                  'read_addon',
+	 *                                                                  'edit_addon',
+	 *                                                                  etc.
+	 *                                                                  ).
+	 * @type EE_Meta_Capability_Map[] $capability_maps                  an array of EE_Meta_Capability_Map object
+	 *                                                                  for any addons that need to register any
+	 *                                                                  special meta mapped capabilities.  Should
+	 *                                                                  be indexed where the key is the
+	 *                                                                  EE_Meta_Capability_Map class name and the
+	 *                                                                  values are the arguments sent to the class.
+	 * @type array                    $model_paths                      array of folders containing DB models
+	 * @see      EE_Register_Model
+	 * @type array                    $class_paths                      array of folders containing DB classes
+	 * @see      EE_Register_Model
+	 * @type array                    $model_extension_paths            array of folders containing DB model
+	 *                                                                  extensions
+	 * @see      EE_Register_Model_Extension
+	 * @type array                    $class_extension_paths            array of folders containing DB class
+	 *                                                                  extensions
+	 * @see      EE_Register_Model_Extension
+	 * @type array message_types {
+	 *                                                                  An array of message types with the key as
+	 *                                                                  the message type name and the values as
+	 *                                                                  below:
+	 * @type string                   $mtfilename                       [Required] The filename of the message type
+	 *                                                                  being registered. This will be the main
+	 *                                                                  EE_{Message Type Name}_message_type class.
+	 *                                                                  for example:
+	 *                                                                  EE_Declined_Registration_message_type.class.php
+	 * @type array                    $autoloadpaths                    [Required] An array of paths to add to the
+	 *                                                                  messages autoloader for the new message type.
+	 * @type array                    $messengers_to_activate_with      An array of messengers that this message
+	 *                                                                  type should activate with. Each value in
+	 *                                                                  the
+	 *                                                                  array
+	 *                                                                  should match the name property of a
+	 *                                                                  EE_messenger. Optional.
+	 * @type array                    $messengers_to_validate_with      An array of messengers that this message
+	 *                                                                  type should validate with. Each value in
+	 *                                                                  the
+	 *                                                                  array
+	 *                                                                  should match the name property of an
+	 *                                                                  EE_messenger.
+	 *                                                                  Optional.
+	 *                                                                  }
+	 * @type array                    $custom_post_types
+	 * @type array                    $custom_taxonomies
+	 * @type array                    $payment_method_paths             each element is the folder containing the
+	 *                                                                  EE_PMT_Base child class
+	 *                                                                  (eg,
+	 *                                                                  '/wp-content/plugins/my_plugin/Payomatic/'
+	 *                                                                  which contains the files
+	 *                                                                  EE_PMT_Payomatic.pm.php)
+	 * @type array                    $default_terms
+	 * @type array                    $namespace                        {
+	 *                                                                  An array with two items for registering the
+	 *                                                                  addon's namespace. (If, for some reason, you
+	 *                                                                  require additional namespaces,
+	 *                                                                  use
+	 *                                                                  EventEspresso\core\Psr4Autoloader::addNamespace()
+	 *                                                                  directly)
+	 * @see      EventEspresso\core\Psr4Autoloader::addNamespace()
+	 * @type string                   $FQNS                             the namespace prefix
+	 * @type string                   $DIR                              a base directory for class files in the
+	 *                                                                  namespace.
+	 *                                                                  }
+	 *                                                                  }
+	 * @type string                   $privacy_policies                 FQNSs (namespaces, each of which contains only
+	 *                                                                  privacy policy classes) or FQCNs (specific
+	 *                                                                  classnames of privacy policy classes)
+	 * @type string                   $personal_data_exporters          FQNSs (namespaces, each of which contains only
+	 *                                                                  privacy policy classes) or FQCNs (specific
+	 *                                                                  classnames of privacy policy classes)
+	 * @type string                   $personal_data_erasers            FQNSs (namespaces, each of which contains only
+	 *                                                                  privacy policy classes) or FQCNs (specific
+	 *                                                                  classnames of privacy policy classes)
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function register($addon_name = '', $setup_args = array())
+	{
+		// required fields MUST be present, so let's make sure they are.
+		EE_Register_Addon::_verify_parameters($addon_name, $setup_args);
+		// get class name for addon
+		$class_name = EE_Register_Addon::_parse_class_name($addon_name, $setup_args);
+		// setup $_settings array from incoming values.
+		$addon_settings = EE_Register_Addon::_get_addon_settings($class_name, $setup_args);
+		// setup PUE
+		EE_Register_Addon::_parse_pue_options($addon_name, $class_name, $setup_args);
+		// does this addon work with this version of core or WordPress ?
+		if (! EE_Register_Addon::_addon_is_compatible($addon_name, $addon_settings)) {
+			return;
+		}
+		// register namespaces
+		EE_Register_Addon::_setup_namespaces($addon_settings);
+		// check if this is an activation request
+		if (EE_Register_Addon::_addon_activation($addon_name, $addon_settings)) {
+			// dont bother setting up the rest of the addon atm
+			return;
+		}
+		// we need cars
+		EE_Register_Addon::_setup_autoloaders($addon_name);
+		// register new models and extensions
+		EE_Register_Addon::_register_models_and_extensions($addon_name);
+		// setup DMS
+		EE_Register_Addon::_register_data_migration_scripts($addon_name);
+		// if config_class is present let's register config.
+		EE_Register_Addon::_register_config($addon_name);
+		// register admin pages
+		EE_Register_Addon::_register_admin_pages($addon_name);
+		// add to list of modules to be registered
+		EE_Register_Addon::_register_modules($addon_name);
+		// add to list of shortcodes to be registered
+		EE_Register_Addon::_register_shortcodes($addon_name);
+		// add to list of widgets to be registered
+		EE_Register_Addon::_register_widgets($addon_name);
+		// register capability related stuff.
+		EE_Register_Addon::_register_capabilities($addon_name);
+		// any message type to register?
+		EE_Register_Addon::_register_message_types($addon_name);
+		// any custom post type/ custom capabilities or default terms to register
+		EE_Register_Addon::_register_custom_post_types($addon_name);
+		// and any payment methods
+		EE_Register_Addon::_register_payment_methods($addon_name);
+		// and privacy policy generators
+		EE_Register_Addon::registerPrivacyPolicies($addon_name);
+		// and privacy policy generators
+		EE_Register_Addon::registerPersonalDataExporters($addon_name);
+		// and privacy policy generators
+		EE_Register_Addon::registerPersonalDataErasers($addon_name);
+		// load and instantiate main addon class
+		$addon = EE_Register_Addon::_load_and_init_addon_class($addon_name);
+		// delay calling after_registration hook on each addon until after all add-ons have been registered.
+		add_action('AHEE__EE_System__load_espresso_addons__complete', array($addon, 'after_registration'), 999);
+	}
 
 
-    /**
-     * @param string $addon_name
-     * @param array  $setup_args
-     * @return void
-     * @throws EE_Error
-     */
-    private static function _verify_parameters($addon_name, array $setup_args)
-    {
-        // required fields MUST be present, so let's make sure they are.
-        if (empty($addon_name) || ! is_array($setup_args)) {
-            throw new EE_Error(
-                __(
-                    'In order to register an EE_Addon with EE_Register_Addon::register(), you must include the "addon_name" (the name of the addon), and an array of arguments.',
-                    'event_espresso'
-                )
-            );
-        }
-        if (! isset($setup_args['main_file_path']) || empty($setup_args['main_file_path'])) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'When registering an addon, you didn\'t provide the "main_file_path", which is the full path to the main file loaded directly by Wordpress. You only provided %s',
-                        'event_espresso'
-                    ),
-                    implode(',', array_keys($setup_args))
-                )
-            );
-        }
-        // check that addon has not already been registered with that name
-        if (isset(self::$_settings[ $addon_name ]) && ! did_action('activate_plugin')) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'An EE_Addon with the name "%s" has already been registered and each EE_Addon requires a unique name.',
-                        'event_espresso'
-                    ),
-                    $addon_name
-                )
-            );
-        }
-    }
+	/**
+	 * @param string $addon_name
+	 * @param array  $setup_args
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private static function _verify_parameters($addon_name, array $setup_args)
+	{
+		// required fields MUST be present, so let's make sure they are.
+		if (empty($addon_name) || ! is_array($setup_args)) {
+			throw new EE_Error(
+				__(
+					'In order to register an EE_Addon with EE_Register_Addon::register(), you must include the "addon_name" (the name of the addon), and an array of arguments.',
+					'event_espresso'
+				)
+			);
+		}
+		if (! isset($setup_args['main_file_path']) || empty($setup_args['main_file_path'])) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'When registering an addon, you didn\'t provide the "main_file_path", which is the full path to the main file loaded directly by Wordpress. You only provided %s',
+						'event_espresso'
+					),
+					implode(',', array_keys($setup_args))
+				)
+			);
+		}
+		// check that addon has not already been registered with that name
+		if (isset(self::$_settings[ $addon_name ]) && ! did_action('activate_plugin')) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'An EE_Addon with the name "%s" has already been registered and each EE_Addon requires a unique name.',
+						'event_espresso'
+					),
+					$addon_name
+				)
+			);
+		}
+	}
 
 
-    /**
-     * @param string $addon_name
-     * @param array  $setup_args
-     * @return string
-     */
-    private static function _parse_class_name($addon_name, array $setup_args)
-    {
-        if (empty($setup_args['class_name'])) {
-            // generate one by first separating name with spaces
-            $class_name = str_replace(array('-', '_'), ' ', trim($addon_name));
-            // capitalize, then replace spaces with underscores
-            $class_name = str_replace(' ', '_', ucwords($class_name));
-        } else {
-            $class_name = $setup_args['class_name'];
-        }
-        // check if classname is fully  qualified or is a legacy classname already prefixed with 'EE_'
-        return strpos($class_name, '\\') || strpos($class_name, 'EE_') === 0
-            ? $class_name
-            : 'EE_' . $class_name;
-    }
+	/**
+	 * @param string $addon_name
+	 * @param array  $setup_args
+	 * @return string
+	 */
+	private static function _parse_class_name($addon_name, array $setup_args)
+	{
+		if (empty($setup_args['class_name'])) {
+			// generate one by first separating name with spaces
+			$class_name = str_replace(array('-', '_'), ' ', trim($addon_name));
+			// capitalize, then replace spaces with underscores
+			$class_name = str_replace(' ', '_', ucwords($class_name));
+		} else {
+			$class_name = $setup_args['class_name'];
+		}
+		// check if classname is fully  qualified or is a legacy classname already prefixed with 'EE_'
+		return strpos($class_name, '\\') || strpos($class_name, 'EE_') === 0
+			? $class_name
+			: 'EE_' . $class_name;
+	}
 
 
-    /**
-     * @param string $class_name
-     * @param array  $setup_args
-     * @return array
-     */
-    private static function _get_addon_settings($class_name, array $setup_args)
-    {
-        // setup $_settings array from incoming values.
-        $addon_settings = array(
-            // generated from the addon name, changes something like "calendar" to "EE_Calendar"
-            'class_name'            => $class_name,
-            // the addon slug for use in URLs, etc
-            'plugin_slug'           => isset($setup_args['plugin_slug'])
-                ? (string) $setup_args['plugin_slug']
-                : '',
-            // page slug to be used when generating the "Settings" link on the WP plugin page
-            'plugin_action_slug'    => isset($setup_args['plugin_action_slug'])
-                ? (string) $setup_args['plugin_action_slug']
-                : '',
-            // the "software" version for the addon
-            'version'               => isset($setup_args['version'])
-                ? (string) $setup_args['version']
-                : '',
-            // the minimum version of EE Core that the addon will work with
-            'min_core_version'      => isset($setup_args['min_core_version'])
-                ? (string) $setup_args['min_core_version']
-                : '',
-            // the minimum version of WordPress that the addon will work with
-            'min_wp_version'        => isset($setup_args['min_wp_version'])
-                ? (string) $setup_args['min_wp_version']
-                : EE_MIN_WP_VER_REQUIRED,
-            // full server path to main file (file loaded directly by WP)
-            'main_file_path'        => isset($setup_args['main_file_path'])
-                ? (string) $setup_args['main_file_path']
-                : '',
-            // instance of \EventEspresso\core\domain\DomainInterface
-            'domain'                => isset($setup_args['domain']) && $setup_args['domain'] instanceof DomainInterface
-                ? $setup_args['domain']
-                : null,
-            // Fully Qualified Class Name for the addon's Domain class
-            'domain_fqcn'           => isset($setup_args['domain_fqcn'])
-                ? (string) $setup_args['domain_fqcn']
-                : '',
-            // path to folder containing files for integrating with the EE core admin and/or setting up EE admin pages
-            'admin_path'            => isset($setup_args['admin_path'])
-                ? (string) $setup_args['admin_path'] : '',
-            // a method to be called when the EE Admin is first invoked, can be used for hooking into any admin page
-            'admin_callback'        => isset($setup_args['admin_callback'])
-                ? (string) $setup_args['admin_callback']
-                : '',
-            // the section name for this addon's configuration settings section (defaults to "addons")
-            'config_section'        => isset($setup_args['config_section'])
-                ? (string) $setup_args['config_section']
-                : 'addons',
-            // the class name for this addon's configuration settings object
-            'config_class'          => isset($setup_args['config_class'])
-                ? (string) $setup_args['config_class'] : '',
-            // the name given to the config for this addons' configuration settings object (optional)
-            'config_name'           => isset($setup_args['config_name'])
-                ? (string) $setup_args['config_name'] : '',
-            // an array of "class names" => "full server paths" for any classes that might be invoked by the addon
-            'autoloader_paths'      => isset($setup_args['autoloader_paths'])
-                ? (array) $setup_args['autoloader_paths']
-                : array(),
-            // an array of  "full server paths" for any folders containing classes that might be invoked by the addon
-            'autoloader_folders'    => isset($setup_args['autoloader_folders'])
-                ? (array) $setup_args['autoloader_folders']
-                : array(),
-            // array of full server paths to any EE_DMS data migration scripts used by the addon.
-            // The key should be the EE_Addon class name that this set of data migration scripts belongs to.
-            // If the EE_Addon class is namespaced, then this needs to be the Fully Qualified Class Name
-            'dms_paths'             => isset($setup_args['dms_paths'])
-                ? (array) $setup_args['dms_paths']
-                : array(),
-            // array of full server paths to any EED_Modules used by the addon
-            'module_paths'          => isset($setup_args['module_paths'])
-                ? (array) $setup_args['module_paths']
-                : array(),
-            // array of full server paths to any EES_Shortcodes used by the addon
-            'shortcode_paths'       => isset($setup_args['shortcode_paths'])
-                ? (array) $setup_args['shortcode_paths']
-                : array(),
-            'shortcode_fqcns'       => isset($setup_args['shortcode_fqcns'])
-                ? (array) $setup_args['shortcode_fqcns']
-                : array(),
-            // array of full server paths to any WP_Widgets used by the addon
-            'widget_paths'          => isset($setup_args['widget_paths'])
-                ? (array) $setup_args['widget_paths']
-                : array(),
-            // array of PUE options used by the addon
-            'pue_options'           => isset($setup_args['pue_options'])
-                ? (array) $setup_args['pue_options']
-                : array(),
-            'message_types'         => isset($setup_args['message_types'])
-                ? (array) $setup_args['message_types']
-                : array(),
-            'capabilities'          => isset($setup_args['capabilities'])
-                ? (array) $setup_args['capabilities']
-                : array(),
-            'capability_maps'       => isset($setup_args['capability_maps'])
-                ? (array) $setup_args['capability_maps']
-                : array(),
-            'model_paths'           => isset($setup_args['model_paths'])
-                ? (array) $setup_args['model_paths']
-                : array(),
-            'class_paths'           => isset($setup_args['class_paths'])
-                ? (array) $setup_args['class_paths']
-                : array(),
-            'model_extension_paths' => isset($setup_args['model_extension_paths'])
-                ? (array) $setup_args['model_extension_paths']
-                : array(),
-            'class_extension_paths' => isset($setup_args['class_extension_paths'])
-                ? (array) $setup_args['class_extension_paths']
-                : array(),
-            'custom_post_types'     => isset($setup_args['custom_post_types'])
-                ? (array) $setup_args['custom_post_types']
-                : array(),
-            'custom_taxonomies'     => isset($setup_args['custom_taxonomies'])
-                ? (array) $setup_args['custom_taxonomies']
-                : array(),
-            'payment_method_paths'  => isset($setup_args['payment_method_paths'])
-                ? (array) $setup_args['payment_method_paths']
-                : array(),
-            'default_terms'         => isset($setup_args['default_terms'])
-                ? (array) $setup_args['default_terms']
-                : array(),
-            // if not empty, inserts a new table row after this plugin's row on the WP Plugins page
-            // that can be used for adding upgrading/marketing info
-            'plugins_page_row'      => isset($setup_args['plugins_page_row'])
-                ? $setup_args['plugins_page_row']
-                : '',
-            'namespace'             => isset(
-                $setup_args['namespace']['FQNS'],
-                $setup_args['namespace']['DIR']
-            )
-                ? (array) $setup_args['namespace']
-                : array(),
-            'privacy_policies'      => isset($setup_args['privacy_policies'])
-                ? (array) $setup_args['privacy_policies']
-                : '',
-        );
-        // if plugin_action_slug is NOT set, but an admin page path IS set,
-        // then let's just use the plugin_slug since that will be used for linking to the admin page
-        $addon_settings['plugin_action_slug'] = empty($addon_settings['plugin_action_slug'])
-                                                && ! empty($addon_settings['admin_path'])
-            ? $addon_settings['plugin_slug']
-            : $addon_settings['plugin_action_slug'];
-        // full server path to main file (file loaded directly by WP)
-        $addon_settings['plugin_basename'] = plugin_basename($addon_settings['main_file_path']);
-        return $addon_settings;
-    }
+	/**
+	 * @param string $class_name
+	 * @param array  $setup_args
+	 * @return array
+	 */
+	private static function _get_addon_settings($class_name, array $setup_args)
+	{
+		// setup $_settings array from incoming values.
+		$addon_settings = array(
+			// generated from the addon name, changes something like "calendar" to "EE_Calendar"
+			'class_name'            => $class_name,
+			// the addon slug for use in URLs, etc
+			'plugin_slug'           => isset($setup_args['plugin_slug'])
+				? (string) $setup_args['plugin_slug']
+				: '',
+			// page slug to be used when generating the "Settings" link on the WP plugin page
+			'plugin_action_slug'    => isset($setup_args['plugin_action_slug'])
+				? (string) $setup_args['plugin_action_slug']
+				: '',
+			// the "software" version for the addon
+			'version'               => isset($setup_args['version'])
+				? (string) $setup_args['version']
+				: '',
+			// the minimum version of EE Core that the addon will work with
+			'min_core_version'      => isset($setup_args['min_core_version'])
+				? (string) $setup_args['min_core_version']
+				: '',
+			// the minimum version of WordPress that the addon will work with
+			'min_wp_version'        => isset($setup_args['min_wp_version'])
+				? (string) $setup_args['min_wp_version']
+				: EE_MIN_WP_VER_REQUIRED,
+			// full server path to main file (file loaded directly by WP)
+			'main_file_path'        => isset($setup_args['main_file_path'])
+				? (string) $setup_args['main_file_path']
+				: '',
+			// instance of \EventEspresso\core\domain\DomainInterface
+			'domain'                => isset($setup_args['domain']) && $setup_args['domain'] instanceof DomainInterface
+				? $setup_args['domain']
+				: null,
+			// Fully Qualified Class Name for the addon's Domain class
+			'domain_fqcn'           => isset($setup_args['domain_fqcn'])
+				? (string) $setup_args['domain_fqcn']
+				: '',
+			// path to folder containing files for integrating with the EE core admin and/or setting up EE admin pages
+			'admin_path'            => isset($setup_args['admin_path'])
+				? (string) $setup_args['admin_path'] : '',
+			// a method to be called when the EE Admin is first invoked, can be used for hooking into any admin page
+			'admin_callback'        => isset($setup_args['admin_callback'])
+				? (string) $setup_args['admin_callback']
+				: '',
+			// the section name for this addon's configuration settings section (defaults to "addons")
+			'config_section'        => isset($setup_args['config_section'])
+				? (string) $setup_args['config_section']
+				: 'addons',
+			// the class name for this addon's configuration settings object
+			'config_class'          => isset($setup_args['config_class'])
+				? (string) $setup_args['config_class'] : '',
+			// the name given to the config for this addons' configuration settings object (optional)
+			'config_name'           => isset($setup_args['config_name'])
+				? (string) $setup_args['config_name'] : '',
+			// an array of "class names" => "full server paths" for any classes that might be invoked by the addon
+			'autoloader_paths'      => isset($setup_args['autoloader_paths'])
+				? (array) $setup_args['autoloader_paths']
+				: array(),
+			// an array of  "full server paths" for any folders containing classes that might be invoked by the addon
+			'autoloader_folders'    => isset($setup_args['autoloader_folders'])
+				? (array) $setup_args['autoloader_folders']
+				: array(),
+			// array of full server paths to any EE_DMS data migration scripts used by the addon.
+			// The key should be the EE_Addon class name that this set of data migration scripts belongs to.
+			// If the EE_Addon class is namespaced, then this needs to be the Fully Qualified Class Name
+			'dms_paths'             => isset($setup_args['dms_paths'])
+				? (array) $setup_args['dms_paths']
+				: array(),
+			// array of full server paths to any EED_Modules used by the addon
+			'module_paths'          => isset($setup_args['module_paths'])
+				? (array) $setup_args['module_paths']
+				: array(),
+			// array of full server paths to any EES_Shortcodes used by the addon
+			'shortcode_paths'       => isset($setup_args['shortcode_paths'])
+				? (array) $setup_args['shortcode_paths']
+				: array(),
+			'shortcode_fqcns'       => isset($setup_args['shortcode_fqcns'])
+				? (array) $setup_args['shortcode_fqcns']
+				: array(),
+			// array of full server paths to any WP_Widgets used by the addon
+			'widget_paths'          => isset($setup_args['widget_paths'])
+				? (array) $setup_args['widget_paths']
+				: array(),
+			// array of PUE options used by the addon
+			'pue_options'           => isset($setup_args['pue_options'])
+				? (array) $setup_args['pue_options']
+				: array(),
+			'message_types'         => isset($setup_args['message_types'])
+				? (array) $setup_args['message_types']
+				: array(),
+			'capabilities'          => isset($setup_args['capabilities'])
+				? (array) $setup_args['capabilities']
+				: array(),
+			'capability_maps'       => isset($setup_args['capability_maps'])
+				? (array) $setup_args['capability_maps']
+				: array(),
+			'model_paths'           => isset($setup_args['model_paths'])
+				? (array) $setup_args['model_paths']
+				: array(),
+			'class_paths'           => isset($setup_args['class_paths'])
+				? (array) $setup_args['class_paths']
+				: array(),
+			'model_extension_paths' => isset($setup_args['model_extension_paths'])
+				? (array) $setup_args['model_extension_paths']
+				: array(),
+			'class_extension_paths' => isset($setup_args['class_extension_paths'])
+				? (array) $setup_args['class_extension_paths']
+				: array(),
+			'custom_post_types'     => isset($setup_args['custom_post_types'])
+				? (array) $setup_args['custom_post_types']
+				: array(),
+			'custom_taxonomies'     => isset($setup_args['custom_taxonomies'])
+				? (array) $setup_args['custom_taxonomies']
+				: array(),
+			'payment_method_paths'  => isset($setup_args['payment_method_paths'])
+				? (array) $setup_args['payment_method_paths']
+				: array(),
+			'default_terms'         => isset($setup_args['default_terms'])
+				? (array) $setup_args['default_terms']
+				: array(),
+			// if not empty, inserts a new table row after this plugin's row on the WP Plugins page
+			// that can be used for adding upgrading/marketing info
+			'plugins_page_row'      => isset($setup_args['plugins_page_row'])
+				? $setup_args['plugins_page_row']
+				: '',
+			'namespace'             => isset(
+				$setup_args['namespace']['FQNS'],
+				$setup_args['namespace']['DIR']
+			)
+				? (array) $setup_args['namespace']
+				: array(),
+			'privacy_policies'      => isset($setup_args['privacy_policies'])
+				? (array) $setup_args['privacy_policies']
+				: '',
+		);
+		// if plugin_action_slug is NOT set, but an admin page path IS set,
+		// then let's just use the plugin_slug since that will be used for linking to the admin page
+		$addon_settings['plugin_action_slug'] = empty($addon_settings['plugin_action_slug'])
+												&& ! empty($addon_settings['admin_path'])
+			? $addon_settings['plugin_slug']
+			: $addon_settings['plugin_action_slug'];
+		// full server path to main file (file loaded directly by WP)
+		$addon_settings['plugin_basename'] = plugin_basename($addon_settings['main_file_path']);
+		return $addon_settings;
+	}
 
 
-    /**
-     * @param string $addon_name
-     * @param array  $addon_settings
-     * @return boolean
-     */
-    private static function _addon_is_compatible($addon_name, array $addon_settings)
-    {
-        global $wp_version;
-        $incompatibility_message = '';
-        // check whether this addon version is compatible with EE core
-        if (isset(EE_Register_Addon::$_incompatible_addons[ $addon_name ])
-            && ! self::_meets_min_core_version_requirement(
-                EE_Register_Addon::$_incompatible_addons[ $addon_name ],
-                $addon_settings['version']
-            )
-        ) {
-            $incompatibility_message = sprintf(
-                __(
-                    '%4$sIMPORTANT!%5$sThe Event Espresso "%1$s" addon is not compatible with this version of Event Espresso.%2$sPlease upgrade your "%1$s" addon to version %3$s or newer to resolve this issue.',
-                    'event_espresso'
-                ),
-                $addon_name,
-                '<br />',
-                EE_Register_Addon::$_incompatible_addons[ $addon_name ],
-                '<span style="font-weight: bold; color: #D54E21;">',
-                '</span><br />'
-            );
-        } elseif (! self::_meets_min_core_version_requirement($addon_settings['min_core_version'], espresso_version())
-        ) {
-            $incompatibility_message = sprintf(
-                __(
-                    '%5$sIMPORTANT!%6$sThe Event Espresso "%1$s" addon requires Event Espresso Core version "%2$s" or higher in order to run.%4$sYour version of Event Espresso Core is currently at "%3$s". Please upgrade Event Espresso Core first and then re-activate "%1$s".',
-                    'event_espresso'
-                ),
-                $addon_name,
-                self::_effective_version($addon_settings['min_core_version']),
-                self::_effective_version(espresso_version()),
-                '<br />',
-                '<span style="font-weight: bold; color: #D54E21;">',
-                '</span><br />'
-            );
-        } elseif (version_compare($wp_version, $addon_settings['min_wp_version'], '<')) {
-            $incompatibility_message = sprintf(
-                __(
-                    '%4$sIMPORTANT!%5$sThe Event Espresso "%1$s" addon requires WordPress version "%2$s" or greater.%3$sPlease update your version of WordPress to use the "%1$s" addon and to keep your site secure.',
-                    'event_espresso'
-                ),
-                $addon_name,
-                $addon_settings['min_wp_version'],
-                '<br />',
-                '<span style="font-weight: bold; color: #D54E21;">',
-                '</span><br />'
-            );
-        }
-        if (! empty($incompatibility_message)) {
-            // remove 'activate' from the REQUEST
-            // so WP doesn't erroneously tell the user the plugin activated fine when it didn't
-            unset($_GET['activate'], $_REQUEST['activate']);
-            if (current_user_can('activate_plugins')) {
-                // show an error message indicating the plugin didn't activate properly
-                EE_Error::add_error($incompatibility_message, __FILE__, __FUNCTION__, __LINE__);
-            }
-            // BAIL FROM THE ADDON REGISTRATION PROCESS
-            return false;
-        }
-        // addon IS compatible
-        return true;
-    }
+	/**
+	 * @param string $addon_name
+	 * @param array  $addon_settings
+	 * @return boolean
+	 */
+	private static function _addon_is_compatible($addon_name, array $addon_settings)
+	{
+		global $wp_version;
+		$incompatibility_message = '';
+		// check whether this addon version is compatible with EE core
+		if (isset(EE_Register_Addon::$_incompatible_addons[ $addon_name ])
+			&& ! self::_meets_min_core_version_requirement(
+				EE_Register_Addon::$_incompatible_addons[ $addon_name ],
+				$addon_settings['version']
+			)
+		) {
+			$incompatibility_message = sprintf(
+				__(
+					'%4$sIMPORTANT!%5$sThe Event Espresso "%1$s" addon is not compatible with this version of Event Espresso.%2$sPlease upgrade your "%1$s" addon to version %3$s or newer to resolve this issue.',
+					'event_espresso'
+				),
+				$addon_name,
+				'<br />',
+				EE_Register_Addon::$_incompatible_addons[ $addon_name ],
+				'<span style="font-weight: bold; color: #D54E21;">',
+				'</span><br />'
+			);
+		} elseif (! self::_meets_min_core_version_requirement($addon_settings['min_core_version'], espresso_version())
+		) {
+			$incompatibility_message = sprintf(
+				__(
+					'%5$sIMPORTANT!%6$sThe Event Espresso "%1$s" addon requires Event Espresso Core version "%2$s" or higher in order to run.%4$sYour version of Event Espresso Core is currently at "%3$s". Please upgrade Event Espresso Core first and then re-activate "%1$s".',
+					'event_espresso'
+				),
+				$addon_name,
+				self::_effective_version($addon_settings['min_core_version']),
+				self::_effective_version(espresso_version()),
+				'<br />',
+				'<span style="font-weight: bold; color: #D54E21;">',
+				'</span><br />'
+			);
+		} elseif (version_compare($wp_version, $addon_settings['min_wp_version'], '<')) {
+			$incompatibility_message = sprintf(
+				__(
+					'%4$sIMPORTANT!%5$sThe Event Espresso "%1$s" addon requires WordPress version "%2$s" or greater.%3$sPlease update your version of WordPress to use the "%1$s" addon and to keep your site secure.',
+					'event_espresso'
+				),
+				$addon_name,
+				$addon_settings['min_wp_version'],
+				'<br />',
+				'<span style="font-weight: bold; color: #D54E21;">',
+				'</span><br />'
+			);
+		}
+		if (! empty($incompatibility_message)) {
+			// remove 'activate' from the REQUEST
+			// so WP doesn't erroneously tell the user the plugin activated fine when it didn't
+			unset($_GET['activate'], $_REQUEST['activate']);
+			if (current_user_can('activate_plugins')) {
+				// show an error message indicating the plugin didn't activate properly
+				EE_Error::add_error($incompatibility_message, __FILE__, __FUNCTION__, __LINE__);
+			}
+			// BAIL FROM THE ADDON REGISTRATION PROCESS
+			return false;
+		}
+		// addon IS compatible
+		return true;
+	}
 
 
-    /**
-     * if plugin update engine is being used for auto-updates,
-     * then let's set that up now before going any further so that ALL addons can be updated
-     * (not needed if PUE is not being used)
-     *
-     * @param string $addon_name
-     * @param string $class_name
-     * @param array  $setup_args
-     * @return void
-     */
-    private static function _parse_pue_options($addon_name, $class_name, array $setup_args)
-    {
-        if (! empty($setup_args['pue_options'])) {
-            self::$_settings[ $addon_name ]['pue_options'] = array(
-                'pue_plugin_slug' => isset($setup_args['pue_options']['pue_plugin_slug'])
-                    ? (string) $setup_args['pue_options']['pue_plugin_slug']
-                    : 'espresso_' . strtolower($class_name),
-                'plugin_basename' => isset($setup_args['pue_options']['plugin_basename'])
-                    ? (string) $setup_args['pue_options']['plugin_basename']
-                    : plugin_basename($setup_args['main_file_path']),
-                'checkPeriod'     => isset($setup_args['pue_options']['checkPeriod'])
-                    ? (string) $setup_args['pue_options']['checkPeriod']
-                    : '24',
-                'use_wp_update'   => isset($setup_args['pue_options']['use_wp_update'])
-                    ? (string) $setup_args['pue_options']['use_wp_update']
-                    : false,
-            );
-            add_action(
-                'AHEE__EE_System__brew_espresso__after_pue_init',
-                array('EE_Register_Addon', 'load_pue_update')
-            );
-        }
-    }
+	/**
+	 * if plugin update engine is being used for auto-updates,
+	 * then let's set that up now before going any further so that ALL addons can be updated
+	 * (not needed if PUE is not being used)
+	 *
+	 * @param string $addon_name
+	 * @param string $class_name
+	 * @param array  $setup_args
+	 * @return void
+	 */
+	private static function _parse_pue_options($addon_name, $class_name, array $setup_args)
+	{
+		if (! empty($setup_args['pue_options'])) {
+			self::$_settings[ $addon_name ]['pue_options'] = array(
+				'pue_plugin_slug' => isset($setup_args['pue_options']['pue_plugin_slug'])
+					? (string) $setup_args['pue_options']['pue_plugin_slug']
+					: 'espresso_' . strtolower($class_name),
+				'plugin_basename' => isset($setup_args['pue_options']['plugin_basename'])
+					? (string) $setup_args['pue_options']['plugin_basename']
+					: plugin_basename($setup_args['main_file_path']),
+				'checkPeriod'     => isset($setup_args['pue_options']['checkPeriod'])
+					? (string) $setup_args['pue_options']['checkPeriod']
+					: '24',
+				'use_wp_update'   => isset($setup_args['pue_options']['use_wp_update'])
+					? (string) $setup_args['pue_options']['use_wp_update']
+					: false,
+			);
+			add_action(
+				'AHEE__EE_System__brew_espresso__after_pue_init',
+				array('EE_Register_Addon', 'load_pue_update')
+			);
+		}
+	}
 
 
-    /**
-     * register namespaces right away before any other files or classes get loaded, but AFTER the version checks
-     *
-     * @param array $addon_settings
-     * @return void
-     */
-    private static function _setup_namespaces(array $addon_settings)
-    {
-        //
-        if (isset(
-            $addon_settings['namespace']['FQNS'],
-            $addon_settings['namespace']['DIR']
-        )) {
-            EE_Psr4AutoloaderInit::psr4_loader()->addNamespace(
-                $addon_settings['namespace']['FQNS'],
-                $addon_settings['namespace']['DIR']
-            );
-        }
-    }
+	/**
+	 * register namespaces right away before any other files or classes get loaded, but AFTER the version checks
+	 *
+	 * @param array $addon_settings
+	 * @return void
+	 */
+	private static function _setup_namespaces(array $addon_settings)
+	{
+		//
+		if (isset(
+			$addon_settings['namespace']['FQNS'],
+			$addon_settings['namespace']['DIR']
+		)) {
+			EE_Psr4AutoloaderInit::psr4_loader()->addNamespace(
+				$addon_settings['namespace']['FQNS'],
+				$addon_settings['namespace']['DIR']
+			);
+		}
+	}
 
 
-    /**
-     * @param string $addon_name
-     * @param array  $addon_settings
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private static function _addon_activation($addon_name, array $addon_settings)
-    {
-        // this is an activation request
-        if (did_action(
-            'activate_plugin'
-        )) {// to find if THIS is the addon that was activated, just check if we have already registered it or not
-            // (as the newly-activated addon wasn't around the first time addons were registered).
-            // Note: the presence of pue_options in the addon registration options will initialize the $_settings
-            // property for the add-on, but the add-on is only partially initialized.  Hence, the additional check.
-            if (! isset(self::$_settings[ $addon_name ])
-                || (isset(self::$_settings[ $addon_name ])
-                    && ! isset(self::$_settings[ $addon_name ]['class_name'])
-                )
-            ) {
-                self::$_settings[ $addon_name ] = $addon_settings;
-                $addon = self::_load_and_init_addon_class($addon_name);
-                $addon->set_activation_indicator_option();
-                // dont bother setting up the rest of the addon.
-                // we know it was just activated and the request will end soon
-            }
-            return true;
-        }
-        // make sure this was called in the right place!
-        if (! did_action('AHEE__EE_System__load_espresso_addons')
-            || did_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin')
-        ) {
-            EE_Error::doing_it_wrong(
-                __METHOD__,
-                sprintf(
-                    __(
-                        'An attempt to register an EE_Addon named "%s" has failed because it was not registered at the correct time.  Please use the "AHEE__EE_System__load_espresso_addons" hook to register addons.',
-                        'event_espresso'
-                    ),
-                    $addon_name
-                ),
-                '4.3.0'
-            );
-        }
-        // make sure addon settings are set correctly without overwriting anything existing
-        if (isset(self::$_settings[ $addon_name ])) {
-            self::$_settings[ $addon_name ] += $addon_settings;
-        } else {
-            self::$_settings[ $addon_name ] = $addon_settings;
-        }
-        return false;
-    }
+	/**
+	 * @param string $addon_name
+	 * @param array  $addon_settings
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private static function _addon_activation($addon_name, array $addon_settings)
+	{
+		// this is an activation request
+		if (did_action(
+			'activate_plugin'
+		)) {// to find if THIS is the addon that was activated, just check if we have already registered it or not
+			// (as the newly-activated addon wasn't around the first time addons were registered).
+			// Note: the presence of pue_options in the addon registration options will initialize the $_settings
+			// property for the add-on, but the add-on is only partially initialized.  Hence, the additional check.
+			if (! isset(self::$_settings[ $addon_name ])
+				|| (isset(self::$_settings[ $addon_name ])
+					&& ! isset(self::$_settings[ $addon_name ]['class_name'])
+				)
+			) {
+				self::$_settings[ $addon_name ] = $addon_settings;
+				$addon = self::_load_and_init_addon_class($addon_name);
+				$addon->set_activation_indicator_option();
+				// dont bother setting up the rest of the addon.
+				// we know it was just activated and the request will end soon
+			}
+			return true;
+		}
+		// make sure this was called in the right place!
+		if (! did_action('AHEE__EE_System__load_espresso_addons')
+			|| did_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin')
+		) {
+			EE_Error::doing_it_wrong(
+				__METHOD__,
+				sprintf(
+					__(
+						'An attempt to register an EE_Addon named "%s" has failed because it was not registered at the correct time.  Please use the "AHEE__EE_System__load_espresso_addons" hook to register addons.',
+						'event_espresso'
+					),
+					$addon_name
+				),
+				'4.3.0'
+			);
+		}
+		// make sure addon settings are set correctly without overwriting anything existing
+		if (isset(self::$_settings[ $addon_name ])) {
+			self::$_settings[ $addon_name ] += $addon_settings;
+		} else {
+			self::$_settings[ $addon_name ] = $addon_settings;
+		}
+		return false;
+	}
 
 
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws EE_Error
-     */
-    private static function _setup_autoloaders($addon_name)
-    {
-        if (! empty(self::$_settings[ $addon_name ]['autoloader_paths'])) {
-            // setup autoloader for single file
-            EEH_Autoloader::instance()->register_autoloader(self::$_settings[ $addon_name ]['autoloader_paths']);
-        }
-        // setup autoloaders for folders
-        if (! empty(self::$_settings[ $addon_name ]['autoloader_folders'])) {
-            foreach ((array) self::$_settings[ $addon_name ]['autoloader_folders'] as $autoloader_folder) {
-                EEH_Autoloader::register_autoloaders_for_each_file_in_folder($autoloader_folder);
-            }
-        }
-    }
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private static function _setup_autoloaders($addon_name)
+	{
+		if (! empty(self::$_settings[ $addon_name ]['autoloader_paths'])) {
+			// setup autoloader for single file
+			EEH_Autoloader::instance()->register_autoloader(self::$_settings[ $addon_name ]['autoloader_paths']);
+		}
+		// setup autoloaders for folders
+		if (! empty(self::$_settings[ $addon_name ]['autoloader_folders'])) {
+			foreach ((array) self::$_settings[ $addon_name ]['autoloader_folders'] as $autoloader_folder) {
+				EEH_Autoloader::register_autoloaders_for_each_file_in_folder($autoloader_folder);
+			}
+		}
+	}
 
 
-    /**
-     * register new models and extensions
-     *
-     * @param string $addon_name
-     * @return void
-     * @throws EE_Error
-     */
-    private static function _register_models_and_extensions($addon_name)
-    {
-        // register new models
-        if (! empty(self::$_settings[ $addon_name ]['model_paths'])
-            || ! empty(self::$_settings[ $addon_name ]['class_paths'])
-        ) {
-            EE_Register_Model::register(
-                $addon_name,
-                array(
-                    'model_paths' => self::$_settings[ $addon_name ]['model_paths'],
-                    'class_paths' => self::$_settings[ $addon_name ]['class_paths'],
-                )
-            );
-        }
-        // register model extensions
-        if (! empty(self::$_settings[ $addon_name ]['model_extension_paths'])
-            || ! empty(self::$_settings[ $addon_name ]['class_extension_paths'])
-        ) {
-            EE_Register_Model_Extensions::register(
-                $addon_name,
-                array(
-                    'model_extension_paths' => self::$_settings[ $addon_name ]['model_extension_paths'],
-                    'class_extension_paths' => self::$_settings[ $addon_name ]['class_extension_paths'],
-                )
-            );
-        }
-    }
+	/**
+	 * register new models and extensions
+	 *
+	 * @param string $addon_name
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private static function _register_models_and_extensions($addon_name)
+	{
+		// register new models
+		if (! empty(self::$_settings[ $addon_name ]['model_paths'])
+			|| ! empty(self::$_settings[ $addon_name ]['class_paths'])
+		) {
+			EE_Register_Model::register(
+				$addon_name,
+				array(
+					'model_paths' => self::$_settings[ $addon_name ]['model_paths'],
+					'class_paths' => self::$_settings[ $addon_name ]['class_paths'],
+				)
+			);
+		}
+		// register model extensions
+		if (! empty(self::$_settings[ $addon_name ]['model_extension_paths'])
+			|| ! empty(self::$_settings[ $addon_name ]['class_extension_paths'])
+		) {
+			EE_Register_Model_Extensions::register(
+				$addon_name,
+				array(
+					'model_extension_paths' => self::$_settings[ $addon_name ]['model_extension_paths'],
+					'class_extension_paths' => self::$_settings[ $addon_name ]['class_extension_paths'],
+				)
+			);
+		}
+	}
 
 
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws EE_Error
-     */
-    private static function _register_data_migration_scripts($addon_name)
-    {
-        // setup DMS
-        if (! empty(self::$_settings[ $addon_name ]['dms_paths'])) {
-            EE_Register_Data_Migration_Scripts::register(
-                $addon_name,
-                array('dms_paths' => self::$_settings[ $addon_name ]['dms_paths'])
-            );
-        }
-    }
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private static function _register_data_migration_scripts($addon_name)
+	{
+		// setup DMS
+		if (! empty(self::$_settings[ $addon_name ]['dms_paths'])) {
+			EE_Register_Data_Migration_Scripts::register(
+				$addon_name,
+				array('dms_paths' => self::$_settings[ $addon_name ]['dms_paths'])
+			);
+		}
+	}
 
 
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws EE_Error
-     */
-    private static function _register_config($addon_name)
-    {
-        // if config_class is present let's register config.
-        if (! empty(self::$_settings[ $addon_name ]['config_class'])) {
-            EE_Register_Config::register(
-                self::$_settings[ $addon_name ]['config_class'],
-                array(
-                    'config_section' => self::$_settings[ $addon_name ]['config_section'],
-                    'config_name'    => self::$_settings[ $addon_name ]['config_name'],
-                )
-            );
-        }
-    }
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private static function _register_config($addon_name)
+	{
+		// if config_class is present let's register config.
+		if (! empty(self::$_settings[ $addon_name ]['config_class'])) {
+			EE_Register_Config::register(
+				self::$_settings[ $addon_name ]['config_class'],
+				array(
+					'config_section' => self::$_settings[ $addon_name ]['config_section'],
+					'config_name'    => self::$_settings[ $addon_name ]['config_name'],
+				)
+			);
+		}
+	}
 
 
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws EE_Error
-     */
-    private static function _register_admin_pages($addon_name)
-    {
-        if (! empty(self::$_settings[ $addon_name ]['admin_path'])) {
-            EE_Register_Admin_Page::register(
-                $addon_name,
-                array('page_path' => self::$_settings[ $addon_name ]['admin_path'])
-            );
-        }
-    }
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private static function _register_admin_pages($addon_name)
+	{
+		if (! empty(self::$_settings[ $addon_name ]['admin_path'])) {
+			EE_Register_Admin_Page::register(
+				$addon_name,
+				array('page_path' => self::$_settings[ $addon_name ]['admin_path'])
+			);
+		}
+	}
 
 
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws EE_Error
-     */
-    private static function _register_modules($addon_name)
-    {
-        if (! empty(self::$_settings[ $addon_name ]['module_paths'])) {
-            EE_Register_Module::register(
-                $addon_name,
-                array('module_paths' => self::$_settings[ $addon_name ]['module_paths'])
-            );
-        }
-    }
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private static function _register_modules($addon_name)
+	{
+		if (! empty(self::$_settings[ $addon_name ]['module_paths'])) {
+			EE_Register_Module::register(
+				$addon_name,
+				array('module_paths' => self::$_settings[ $addon_name ]['module_paths'])
+			);
+		}
+	}
 
 
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws EE_Error
-     */
-    private static function _register_shortcodes($addon_name)
-    {
-        if (! empty(self::$_settings[ $addon_name ]['shortcode_paths'])
-            || ! empty(self::$_settings[ $addon_name ]['shortcode_fqcns'])
-        ) {
-            EE_Register_Shortcode::register(
-                $addon_name,
-                array(
-                    'shortcode_paths' => isset(self::$_settings[ $addon_name ]['shortcode_paths'])
-                        ? self::$_settings[ $addon_name ]['shortcode_paths']
-                        : array(),
-                    'shortcode_fqcns' => isset(self::$_settings[ $addon_name ]['shortcode_fqcns'])
-                        ? self::$_settings[ $addon_name ]['shortcode_fqcns']
-                        : array(),
-                )
-            );
-        }
-    }
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private static function _register_shortcodes($addon_name)
+	{
+		if (! empty(self::$_settings[ $addon_name ]['shortcode_paths'])
+			|| ! empty(self::$_settings[ $addon_name ]['shortcode_fqcns'])
+		) {
+			EE_Register_Shortcode::register(
+				$addon_name,
+				array(
+					'shortcode_paths' => isset(self::$_settings[ $addon_name ]['shortcode_paths'])
+						? self::$_settings[ $addon_name ]['shortcode_paths']
+						: array(),
+					'shortcode_fqcns' => isset(self::$_settings[ $addon_name ]['shortcode_fqcns'])
+						? self::$_settings[ $addon_name ]['shortcode_fqcns']
+						: array(),
+				)
+			);
+		}
+	}
 
 
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws EE_Error
-     */
-    private static function _register_widgets($addon_name)
-    {
-        if (! empty(self::$_settings[ $addon_name ]['widget_paths'])) {
-            EE_Register_Widget::register(
-                $addon_name,
-                array('widget_paths' => self::$_settings[ $addon_name ]['widget_paths'])
-            );
-        }
-    }
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private static function _register_widgets($addon_name)
+	{
+		if (! empty(self::$_settings[ $addon_name ]['widget_paths'])) {
+			EE_Register_Widget::register(
+				$addon_name,
+				array('widget_paths' => self::$_settings[ $addon_name ]['widget_paths'])
+			);
+		}
+	}
 
 
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws EE_Error
-     */
-    private static function _register_capabilities($addon_name)
-    {
-        if (! empty(self::$_settings[ $addon_name ]['capabilities'])) {
-            EE_Register_Capabilities::register(
-                $addon_name,
-                array(
-                    'capabilities'    => self::$_settings[ $addon_name ]['capabilities'],
-                    'capability_maps' => self::$_settings[ $addon_name ]['capability_maps'],
-                )
-            );
-        }
-    }
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private static function _register_capabilities($addon_name)
+	{
+		if (! empty(self::$_settings[ $addon_name ]['capabilities'])) {
+			EE_Register_Capabilities::register(
+				$addon_name,
+				array(
+					'capabilities'    => self::$_settings[ $addon_name ]['capabilities'],
+					'capability_maps' => self::$_settings[ $addon_name ]['capability_maps'],
+				)
+			);
+		}
+	}
 
 
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws EE_Error
-     */
-    private static function _register_message_types($addon_name)
-    {
-        if (! empty(self::$_settings[ $addon_name ]['message_types'])) {
-            add_action(
-                'EE_Brewing_Regular___messages_caf',
-                array('EE_Register_Addon', 'register_message_types')
-            );
-        }
-    }
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private static function _register_message_types($addon_name)
+	{
+		if (! empty(self::$_settings[ $addon_name ]['message_types'])) {
+			add_action(
+				'EE_Brewing_Regular___messages_caf',
+				array('EE_Register_Addon', 'register_message_types')
+			);
+		}
+	}
 
 
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws EE_Error
-     */
-    private static function _register_custom_post_types($addon_name)
-    {
-        if (! empty(self::$_settings[ $addon_name ]['custom_post_types'])
-            || ! empty(self::$_settings[ $addon_name ]['custom_taxonomies'])
-        ) {
-            EE_Register_CPT::register(
-                $addon_name,
-                array(
-                    'cpts'          => self::$_settings[ $addon_name ]['custom_post_types'],
-                    'cts'           => self::$_settings[ $addon_name ]['custom_taxonomies'],
-                    'default_terms' => self::$_settings[ $addon_name ]['default_terms'],
-                )
-            );
-        }
-    }
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private static function _register_custom_post_types($addon_name)
+	{
+		if (! empty(self::$_settings[ $addon_name ]['custom_post_types'])
+			|| ! empty(self::$_settings[ $addon_name ]['custom_taxonomies'])
+		) {
+			EE_Register_CPT::register(
+				$addon_name,
+				array(
+					'cpts'          => self::$_settings[ $addon_name ]['custom_post_types'],
+					'cts'           => self::$_settings[ $addon_name ]['custom_taxonomies'],
+					'default_terms' => self::$_settings[ $addon_name ]['default_terms'],
+				)
+			);
+		}
+	}
 
 
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    private static function _register_payment_methods($addon_name)
-    {
-        if (! empty(self::$_settings[ $addon_name ]['payment_method_paths'])) {
-            EE_Register_Payment_Method::register(
-                $addon_name,
-                array('payment_method_paths' => self::$_settings[ $addon_name ]['payment_method_paths'])
-            );
-        }
-    }
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	private static function _register_payment_methods($addon_name)
+	{
+		if (! empty(self::$_settings[ $addon_name ]['payment_method_paths'])) {
+			EE_Register_Payment_Method::register(
+				$addon_name,
+				array('payment_method_paths' => self::$_settings[ $addon_name ]['payment_method_paths'])
+			);
+		}
+	}
 
 
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    private static function registerPrivacyPolicies($addon_name)
-    {
-        if (! empty(self::$_settings[ $addon_name ]['privacy_policies'])) {
-            EE_Register_Privacy_Policy::register(
-                $addon_name,
-                self::$_settings[ $addon_name ]['privacy_policies']
-            );
-        }
-    }
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	private static function registerPrivacyPolicies($addon_name)
+	{
+		if (! empty(self::$_settings[ $addon_name ]['privacy_policies'])) {
+			EE_Register_Privacy_Policy::register(
+				$addon_name,
+				self::$_settings[ $addon_name ]['privacy_policies']
+			);
+		}
+	}
 
 
-    /**
-     * @param string $addon_name
-     * @return void
-     */
-    private static function registerPersonalDataExporters($addon_name)
-    {
-        if (! empty(self::$_settings[ $addon_name ]['personal_data_exporters'])) {
-            EE_Register_Personal_Data_Eraser::register(
-                $addon_name,
-                self::$_settings[ $addon_name ]['personal_data_exporters']
-            );
-        }
-    }
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 */
+	private static function registerPersonalDataExporters($addon_name)
+	{
+		if (! empty(self::$_settings[ $addon_name ]['personal_data_exporters'])) {
+			EE_Register_Personal_Data_Eraser::register(
+				$addon_name,
+				self::$_settings[ $addon_name ]['personal_data_exporters']
+			);
+		}
+	}
 
 
-    /**
-     * @param string $addon_name
-     * @return void
-     */
-    private static function registerPersonalDataErasers($addon_name)
-    {
-        if (! empty(self::$_settings[ $addon_name ]['personal_data_erasers'])) {
-            EE_Register_Personal_Data_Eraser::register(
-                $addon_name,
-                self::$_settings[ $addon_name ]['personal_data_erasers']
-            );
-        }
-    }
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 */
+	private static function registerPersonalDataErasers($addon_name)
+	{
+		if (! empty(self::$_settings[ $addon_name ]['personal_data_erasers'])) {
+			EE_Register_Personal_Data_Eraser::register(
+				$addon_name,
+				self::$_settings[ $addon_name ]['personal_data_erasers']
+			);
+		}
+	}
 
 
-    /**
-     * Loads and instantiates the EE_Addon class and adds it onto the registry
-     *
-     * @param string $addon_name
-     * @return EE_Addon
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws ReflectionException
-     * @throws EE_Error
-     */
-    private static function _load_and_init_addon_class($addon_name)
-    {
-        $loader = EventEspresso\core\services\loaders\LoaderFactory::getLoader();
-        $addon = $loader->getShared(
-            self::$_settings[ $addon_name ]['class_name'],
-            array('EE_Registry::create(addon)' => true)
-        );
-        // setter inject dep map if required
-        if ($addon instanceof RequiresDependencyMapInterface && $addon->dependencyMap() === null) {
-            $addon->setDependencyMap($loader->getShared('EE_Dependency_Map'));
-        }
-        // setter inject domain if required
-        if ($addon instanceof RequiresDomainInterface
-            && $addon->domain() === null
-        ) {
-            // using supplied Domain object
-            $domain = self::$_settings[ $addon_name ]['domain'] instanceof DomainInterface
-                ? self::$_settings[ $addon_name ]['domain']
-                : null;
-            // or construct one using Domain FQCN
-            if ($domain === null && self::$_settings[ $addon_name ]['domain_fqcn'] !== '') {
-                $domain = $loader->getShared(
-                    self::$_settings[ $addon_name ]['domain_fqcn'],
-                    array(
-                        new EventEspresso\core\domain\values\FilePath(
-                            self::$_settings[ $addon_name ]['main_file_path']
-                        ),
-                        EventEspresso\core\domain\values\Version::fromString(
-                            self::$_settings[ $addon_name ]['version']
-                        ),
-                    )
-                );
-            }
-            if ($domain instanceof DomainInterface) {
-                $addon->setDomain($domain);
-            }
-        }
-        $addon->set_name($addon_name);
-        $addon->set_plugin_slug(self::$_settings[ $addon_name ]['plugin_slug']);
-        $addon->set_plugin_basename(self::$_settings[ $addon_name ]['plugin_basename']);
-        $addon->set_main_plugin_file(self::$_settings[ $addon_name ]['main_file_path']);
-        $addon->set_plugin_action_slug(self::$_settings[ $addon_name ]['plugin_action_slug']);
-        $addon->set_plugins_page_row(self::$_settings[ $addon_name ]['plugins_page_row']);
-        $addon->set_version(self::$_settings[ $addon_name ]['version']);
-        $addon->set_min_core_version(self::_effective_version(self::$_settings[ $addon_name ]['min_core_version']));
-        $addon->set_config_section(self::$_settings[ $addon_name ]['config_section']);
-        $addon->set_config_class(self::$_settings[ $addon_name ]['config_class']);
-        $addon->set_config_name(self::$_settings[ $addon_name ]['config_name']);
-        // unfortunately this can't be hooked in upon construction, because we don't have
-        // the plugin mainfile's path upon construction.
-        register_deactivation_hook($addon->get_main_plugin_file(), array($addon, 'deactivation'));
-        // call any additional admin_callback functions during load_admin_controller hook
-        if (! empty(self::$_settings[ $addon_name ]['admin_callback'])) {
-            add_action(
-                'AHEE__EE_System__load_controllers__load_admin_controllers',
-                array($addon, self::$_settings[ $addon_name ]['admin_callback'])
-            );
-        }
-        return $addon;
-    }
+	/**
+	 * Loads and instantiates the EE_Addon class and adds it onto the registry
+	 *
+	 * @param string $addon_name
+	 * @return EE_Addon
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws ReflectionException
+	 * @throws EE_Error
+	 */
+	private static function _load_and_init_addon_class($addon_name)
+	{
+		$loader = EventEspresso\core\services\loaders\LoaderFactory::getLoader();
+		$addon = $loader->getShared(
+			self::$_settings[ $addon_name ]['class_name'],
+			array('EE_Registry::create(addon)' => true)
+		);
+		// setter inject dep map if required
+		if ($addon instanceof RequiresDependencyMapInterface && $addon->dependencyMap() === null) {
+			$addon->setDependencyMap($loader->getShared('EE_Dependency_Map'));
+		}
+		// setter inject domain if required
+		if ($addon instanceof RequiresDomainInterface
+			&& $addon->domain() === null
+		) {
+			// using supplied Domain object
+			$domain = self::$_settings[ $addon_name ]['domain'] instanceof DomainInterface
+				? self::$_settings[ $addon_name ]['domain']
+				: null;
+			// or construct one using Domain FQCN
+			if ($domain === null && self::$_settings[ $addon_name ]['domain_fqcn'] !== '') {
+				$domain = $loader->getShared(
+					self::$_settings[ $addon_name ]['domain_fqcn'],
+					array(
+						new EventEspresso\core\domain\values\FilePath(
+							self::$_settings[ $addon_name ]['main_file_path']
+						),
+						EventEspresso\core\domain\values\Version::fromString(
+							self::$_settings[ $addon_name ]['version']
+						),
+					)
+				);
+			}
+			if ($domain instanceof DomainInterface) {
+				$addon->setDomain($domain);
+			}
+		}
+		$addon->set_name($addon_name);
+		$addon->set_plugin_slug(self::$_settings[ $addon_name ]['plugin_slug']);
+		$addon->set_plugin_basename(self::$_settings[ $addon_name ]['plugin_basename']);
+		$addon->set_main_plugin_file(self::$_settings[ $addon_name ]['main_file_path']);
+		$addon->set_plugin_action_slug(self::$_settings[ $addon_name ]['plugin_action_slug']);
+		$addon->set_plugins_page_row(self::$_settings[ $addon_name ]['plugins_page_row']);
+		$addon->set_version(self::$_settings[ $addon_name ]['version']);
+		$addon->set_min_core_version(self::_effective_version(self::$_settings[ $addon_name ]['min_core_version']));
+		$addon->set_config_section(self::$_settings[ $addon_name ]['config_section']);
+		$addon->set_config_class(self::$_settings[ $addon_name ]['config_class']);
+		$addon->set_config_name(self::$_settings[ $addon_name ]['config_name']);
+		// unfortunately this can't be hooked in upon construction, because we don't have
+		// the plugin mainfile's path upon construction.
+		register_deactivation_hook($addon->get_main_plugin_file(), array($addon, 'deactivation'));
+		// call any additional admin_callback functions during load_admin_controller hook
+		if (! empty(self::$_settings[ $addon_name ]['admin_callback'])) {
+			add_action(
+				'AHEE__EE_System__load_controllers__load_admin_controllers',
+				array($addon, self::$_settings[ $addon_name ]['admin_callback'])
+			);
+		}
+		return $addon;
+	}
 
 
-    /**
-     *    load_pue_update - Update notifications
-     *
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function load_pue_update()
-    {
-        // load PUE client
-        require_once EE_THIRD_PARTY . 'pue/pue-client.php';
-        $license_server = defined('PUE_UPDATES_ENDPOINT') ? PUE_UPDATES_ENDPOINT : 'https://eventespresso.com';
-        // cycle thru settings
-        foreach (self::$_settings as $settings) {
-            if (! empty($settings['pue_options'])) {
-                // initiate the class and start the plugin update engine!
-                new PluginUpdateEngineChecker(
-                    // host file URL
-                    $license_server,
-                    // plugin slug(s)
-                    array(
-                        'premium'    => array('p' => $settings['pue_options']['pue_plugin_slug']),
-                        'prerelease' => array('beta' => $settings['pue_options']['pue_plugin_slug'] . '-pr'),
-                    ),
-                    // options
-                    array(
-                        'apikey'            => EE_Registry::instance()->NET_CFG->core->site_license_key,
-                        'lang_domain'       => 'event_espresso',
-                        'checkPeriod'       => $settings['pue_options']['checkPeriod'],
-                        'option_key'        => 'ee_site_license_key',
-                        'options_page_slug' => 'event_espresso',
-                        'plugin_basename'   => $settings['pue_options']['plugin_basename'],
-                        // if use_wp_update is TRUE it means you want FREE versions of the plugin to be updated from WP
-                        'use_wp_update'     => $settings['pue_options']['use_wp_update'],
-                    )
-                );
-            }
-        }
-    }
+	/**
+	 *    load_pue_update - Update notifications
+	 *
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function load_pue_update()
+	{
+		// load PUE client
+		require_once EE_THIRD_PARTY . 'pue/pue-client.php';
+		$license_server = defined('PUE_UPDATES_ENDPOINT') ? PUE_UPDATES_ENDPOINT : 'https://eventespresso.com';
+		// cycle thru settings
+		foreach (self::$_settings as $settings) {
+			if (! empty($settings['pue_options'])) {
+				// initiate the class and start the plugin update engine!
+				new PluginUpdateEngineChecker(
+					// host file URL
+					$license_server,
+					// plugin slug(s)
+					array(
+						'premium'    => array('p' => $settings['pue_options']['pue_plugin_slug']),
+						'prerelease' => array('beta' => $settings['pue_options']['pue_plugin_slug'] . '-pr'),
+					),
+					// options
+					array(
+						'apikey'            => EE_Registry::instance()->NET_CFG->core->site_license_key,
+						'lang_domain'       => 'event_espresso',
+						'checkPeriod'       => $settings['pue_options']['checkPeriod'],
+						'option_key'        => 'ee_site_license_key',
+						'options_page_slug' => 'event_espresso',
+						'plugin_basename'   => $settings['pue_options']['plugin_basename'],
+						// if use_wp_update is TRUE it means you want FREE versions of the plugin to be updated from WP
+						'use_wp_update'     => $settings['pue_options']['use_wp_update'],
+					)
+				);
+			}
+		}
+	}
 
 
-    /**
-     * Callback for EE_Brewing_Regular__messages_caf hook used to register message types.
-     *
-     * @since 4.4.0
-     * @return void
-     * @throws EE_Error
-     */
-    public static function register_message_types()
-    {
-        foreach (self::$_settings as $addon_name => $settings) {
-            if (! empty($settings['message_types'])) {
-                foreach ((array) $settings['message_types'] as $message_type => $message_type_settings) {
-                    EE_Register_Message_Type::register($message_type, $message_type_settings);
-                }
-            }
-        }
-    }
+	/**
+	 * Callback for EE_Brewing_Regular__messages_caf hook used to register message types.
+	 *
+	 * @since 4.4.0
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public static function register_message_types()
+	{
+		foreach (self::$_settings as $addon_name => $settings) {
+			if (! empty($settings['message_types'])) {
+				foreach ((array) $settings['message_types'] as $message_type => $message_type_settings) {
+					EE_Register_Message_Type::register($message_type, $message_type_settings);
+				}
+			}
+		}
+	}
 
 
-    /**
-     * This deregisters an addon that was previously registered with a specific addon_name.
-     *
-     * @since    4.3.0
-     * @param string $addon_name the name for the addon that was previously registered
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function deregister($addon_name = null)
-    {
-        if (isset(self::$_settings[ $addon_name ]['class_name'])) {
-            try {
-                do_action('AHEE__EE_Register_Addon__deregister__before', $addon_name);
-                $class_name = self::$_settings[ $addon_name ]['class_name'];
-                if (! empty(self::$_settings[ $addon_name ]['dms_paths'])) {
-                    // setup DMS
-                    EE_Register_Data_Migration_Scripts::deregister($addon_name);
-                }
-                if (! empty(self::$_settings[ $addon_name ]['admin_path'])) {
-                    // register admin page
-                    EE_Register_Admin_Page::deregister($addon_name);
-                }
-                if (! empty(self::$_settings[ $addon_name ]['module_paths'])) {
-                    // add to list of modules to be registered
-                    EE_Register_Module::deregister($addon_name);
-                }
-                if (! empty(self::$_settings[ $addon_name ]['shortcode_paths'])
-                    || ! empty(self::$_settings[ $addon_name ]['shortcode_fqcns'])
-                ) {
-                    // add to list of shortcodes to be registered
-                    EE_Register_Shortcode::deregister($addon_name);
-                }
-                if (! empty(self::$_settings[ $addon_name ]['config_class'])) {
-                    // if config_class present let's register config.
-                    EE_Register_Config::deregister(self::$_settings[ $addon_name ]['config_class']);
-                }
-                if (! empty(self::$_settings[ $addon_name ]['widget_paths'])) {
-                    // add to list of widgets to be registered
-                    EE_Register_Widget::deregister($addon_name);
-                }
-                if (! empty(self::$_settings[ $addon_name ]['model_paths'])
-                    || ! empty(self::$_settings[ $addon_name ]['class_paths'])
-                ) {
-                    // add to list of shortcodes to be registered
-                    EE_Register_Model::deregister($addon_name);
-                }
-                if (! empty(self::$_settings[ $addon_name ]['model_extension_paths'])
-                    || ! empty(self::$_settings[ $addon_name ]['class_extension_paths'])
-                ) {
-                    // add to list of shortcodes to be registered
-                    EE_Register_Model_Extensions::deregister($addon_name);
-                }
-                if (! empty(self::$_settings[ $addon_name ]['message_types'])) {
-                    foreach ((array) self::$_settings[ $addon_name ]['message_types'] as $message_type => $message_type_settings) {
-                        EE_Register_Message_Type::deregister($message_type);
-                    }
-                }
-                // deregister capabilities for addon
-                if (! empty(self::$_settings[ $addon_name ]['capabilities'])
-                    || ! empty(self::$_settings[ $addon_name ]['capability_maps'])
-                ) {
-                    EE_Register_Capabilities::deregister($addon_name);
-                }
-                // deregister custom_post_types for addon
-                if (! empty(self::$_settings[ $addon_name ]['custom_post_types'])) {
-                    EE_Register_CPT::deregister($addon_name);
-                }
-                if (! empty(self::$_settings[ $addon_name ]['payment_method_paths'])) {
-                    EE_Register_Payment_Method::deregister($addon_name);
-                }
-                $addon = EE_Registry::instance()->getAddon($class_name);
-                if ($addon instanceof EE_Addon) {
-                    remove_action(
-                        'deactivate_' . $addon->get_main_plugin_file_basename(),
-                        array($addon, 'deactivation')
-                    );
-                    remove_action(
-                        'AHEE__EE_System__perform_activations_upgrades_and_migrations',
-                        array($addon, 'initialize_db_if_no_migrations_required')
-                    );
-                    // remove `after_registration` call
-                    remove_action(
-                        'AHEE__EE_System__load_espresso_addons__complete',
-                        array($addon, 'after_registration'),
-                        999
-                    );
-                }
-                EE_Registry::instance()->removeAddon($class_name);
-            } catch (OutOfBoundsException $addon_not_yet_registered_exception) {
-                // the add-on was not yet registered in the registry,
-                // so RegistryContainer::__get() throws this exception.
-                // also no need to worry about this or log it,
-                // it's ok to deregister an add-on before its registered in the registry
-            } catch (Exception $e) {
-                new ExceptionLogger($e);
-            }
-            unset(self::$_settings[ $addon_name ]);
-            do_action('AHEE__EE_Register_Addon__deregister__after', $addon_name);
-        }
-    }
+	/**
+	 * This deregisters an addon that was previously registered with a specific addon_name.
+	 *
+	 * @since    4.3.0
+	 * @param string $addon_name the name for the addon that was previously registered
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function deregister($addon_name = null)
+	{
+		if (isset(self::$_settings[ $addon_name ]['class_name'])) {
+			try {
+				do_action('AHEE__EE_Register_Addon__deregister__before', $addon_name);
+				$class_name = self::$_settings[ $addon_name ]['class_name'];
+				if (! empty(self::$_settings[ $addon_name ]['dms_paths'])) {
+					// setup DMS
+					EE_Register_Data_Migration_Scripts::deregister($addon_name);
+				}
+				if (! empty(self::$_settings[ $addon_name ]['admin_path'])) {
+					// register admin page
+					EE_Register_Admin_Page::deregister($addon_name);
+				}
+				if (! empty(self::$_settings[ $addon_name ]['module_paths'])) {
+					// add to list of modules to be registered
+					EE_Register_Module::deregister($addon_name);
+				}
+				if (! empty(self::$_settings[ $addon_name ]['shortcode_paths'])
+					|| ! empty(self::$_settings[ $addon_name ]['shortcode_fqcns'])
+				) {
+					// add to list of shortcodes to be registered
+					EE_Register_Shortcode::deregister($addon_name);
+				}
+				if (! empty(self::$_settings[ $addon_name ]['config_class'])) {
+					// if config_class present let's register config.
+					EE_Register_Config::deregister(self::$_settings[ $addon_name ]['config_class']);
+				}
+				if (! empty(self::$_settings[ $addon_name ]['widget_paths'])) {
+					// add to list of widgets to be registered
+					EE_Register_Widget::deregister($addon_name);
+				}
+				if (! empty(self::$_settings[ $addon_name ]['model_paths'])
+					|| ! empty(self::$_settings[ $addon_name ]['class_paths'])
+				) {
+					// add to list of shortcodes to be registered
+					EE_Register_Model::deregister($addon_name);
+				}
+				if (! empty(self::$_settings[ $addon_name ]['model_extension_paths'])
+					|| ! empty(self::$_settings[ $addon_name ]['class_extension_paths'])
+				) {
+					// add to list of shortcodes to be registered
+					EE_Register_Model_Extensions::deregister($addon_name);
+				}
+				if (! empty(self::$_settings[ $addon_name ]['message_types'])) {
+					foreach ((array) self::$_settings[ $addon_name ]['message_types'] as $message_type => $message_type_settings) {
+						EE_Register_Message_Type::deregister($message_type);
+					}
+				}
+				// deregister capabilities for addon
+				if (! empty(self::$_settings[ $addon_name ]['capabilities'])
+					|| ! empty(self::$_settings[ $addon_name ]['capability_maps'])
+				) {
+					EE_Register_Capabilities::deregister($addon_name);
+				}
+				// deregister custom_post_types for addon
+				if (! empty(self::$_settings[ $addon_name ]['custom_post_types'])) {
+					EE_Register_CPT::deregister($addon_name);
+				}
+				if (! empty(self::$_settings[ $addon_name ]['payment_method_paths'])) {
+					EE_Register_Payment_Method::deregister($addon_name);
+				}
+				$addon = EE_Registry::instance()->getAddon($class_name);
+				if ($addon instanceof EE_Addon) {
+					remove_action(
+						'deactivate_' . $addon->get_main_plugin_file_basename(),
+						array($addon, 'deactivation')
+					);
+					remove_action(
+						'AHEE__EE_System__perform_activations_upgrades_and_migrations',
+						array($addon, 'initialize_db_if_no_migrations_required')
+					);
+					// remove `after_registration` call
+					remove_action(
+						'AHEE__EE_System__load_espresso_addons__complete',
+						array($addon, 'after_registration'),
+						999
+					);
+				}
+				EE_Registry::instance()->removeAddon($class_name);
+			} catch (OutOfBoundsException $addon_not_yet_registered_exception) {
+				// the add-on was not yet registered in the registry,
+				// so RegistryContainer::__get() throws this exception.
+				// also no need to worry about this or log it,
+				// it's ok to deregister an add-on before its registered in the registry
+			} catch (Exception $e) {
+				new ExceptionLogger($e);
+			}
+			unset(self::$_settings[ $addon_name ]);
+			do_action('AHEE__EE_Register_Addon__deregister__after', $addon_name);
+		}
+	}
 }

Spacing +115 added lines, -115 removed lines

@@ -69,15 +69,15 @@ 
         // offsets:    0 . 1 . 2 . 3 . 4
         $version_parts = explode('.', $min_core_version);
         // check they specified the micro version (after 2nd period)
-        if (! isset($version_parts[2])) {
+        if ( ! isset($version_parts[2])) {
             $version_parts[2] = '0';
         }
         // if they didn't specify the 'p', or 'rc' part. Just assume the lowest possible
         // soon we can assume that's 'rc', but this current version is 'alpha'
-        if (! isset($version_parts[3])) {
+        if ( ! isset($version_parts[3])) {
             $version_parts[3] = 'dev';
         }
-        if (! isset($version_parts[4])) {
+        if ( ! isset($version_parts[4])) {
             $version_parts[4] = '000';
         }
         return implode('.', $version_parts);
@@ -264,7 +264,7 @@ 
         // setup PUE
         EE_Register_Addon::_parse_pue_options($addon_name, $class_name, $setup_args);
         // does this addon work with this version of core or WordPress ?
-        if (! EE_Register_Addon::_addon_is_compatible($addon_name, $addon_settings)) {
+        if ( ! EE_Register_Addon::_addon_is_compatible($addon_name, $addon_settings)) {
             return;
         }
         // register namespaces
@@ -328,7 +328,7 @@ 
                 )
             );
         }
-        if (! isset($setup_args['main_file_path']) || empty($setup_args['main_file_path'])) {
+        if ( ! isset($setup_args['main_file_path']) || empty($setup_args['main_file_path'])) {
             throw new EE_Error(
                 sprintf(
                     __(
@@ -340,7 +340,7 @@ 
             );
         }
         // check that addon has not already been registered with that name
-        if (isset(self::$_settings[ $addon_name ]) && ! did_action('activate_plugin')) {
+        if (isset(self::$_settings[$addon_name]) && ! did_action('activate_plugin')) {
             throw new EE_Error(
                 sprintf(
                     __(
@@ -372,7 +372,7 @@ 
         // check if classname is fully  qualified or is a legacy classname already prefixed with 'EE_'
         return strpos($class_name, '\\') || strpos($class_name, 'EE_') === 0
             ? $class_name
-            : 'EE_' . $class_name;
+            : 'EE_'.$class_name;
     }
 
 
@@ -539,9 +539,9 @@ 
         global $wp_version;
         $incompatibility_message = '';
         // check whether this addon version is compatible with EE core
-        if (isset(EE_Register_Addon::$_incompatible_addons[ $addon_name ])
+        if (isset(EE_Register_Addon::$_incompatible_addons[$addon_name])
             && ! self::_meets_min_core_version_requirement(
-                EE_Register_Addon::$_incompatible_addons[ $addon_name ],
+                EE_Register_Addon::$_incompatible_addons[$addon_name],
                 $addon_settings['version']
             )
         ) {
@@ -552,11 +552,11 @@ 
                 ),
                 $addon_name,
                 '<br />',
-                EE_Register_Addon::$_incompatible_addons[ $addon_name ],
+                EE_Register_Addon::$_incompatible_addons[$addon_name],
                 '<span style="font-weight: bold; color: #D54E21;">',
                 '</span><br />'
             );
-        } elseif (! self::_meets_min_core_version_requirement($addon_settings['min_core_version'], espresso_version())
+        } elseif ( ! self::_meets_min_core_version_requirement($addon_settings['min_core_version'], espresso_version())
         ) {
             $incompatibility_message = sprintf(
                 __(
@@ -583,7 +583,7 @@ 
                 '</span><br />'
             );
         }
-        if (! empty($incompatibility_message)) {
+        if ( ! empty($incompatibility_message)) {
             // remove 'activate' from the REQUEST
             // so WP doesn't erroneously tell the user the plugin activated fine when it didn't
             unset($_GET['activate'], $_REQUEST['activate']);
@@ -611,11 +611,11 @@ 
      */
     private static function _parse_pue_options($addon_name, $class_name, array $setup_args)
     {
-        if (! empty($setup_args['pue_options'])) {
-            self::$_settings[ $addon_name ]['pue_options'] = array(
+        if ( ! empty($setup_args['pue_options'])) {
+            self::$_settings[$addon_name]['pue_options'] = array(
                 'pue_plugin_slug' => isset($setup_args['pue_options']['pue_plugin_slug'])
                     ? (string) $setup_args['pue_options']['pue_plugin_slug']
-                    : 'espresso_' . strtolower($class_name),
+                    : 'espresso_'.strtolower($class_name),
                 'plugin_basename' => isset($setup_args['pue_options']['plugin_basename'])
                     ? (string) $setup_args['pue_options']['plugin_basename']
                     : plugin_basename($setup_args['main_file_path']),
@@ -674,12 +674,12 @@ 
             // (as the newly-activated addon wasn't around the first time addons were registered).
             // Note: the presence of pue_options in the addon registration options will initialize the $_settings
             // property for the add-on, but the add-on is only partially initialized.  Hence, the additional check.
-            if (! isset(self::$_settings[ $addon_name ])
-                || (isset(self::$_settings[ $addon_name ])
-                    && ! isset(self::$_settings[ $addon_name ]['class_name'])
+            if ( ! isset(self::$_settings[$addon_name])
+                || (isset(self::$_settings[$addon_name])
+                    && ! isset(self::$_settings[$addon_name]['class_name'])
                 )
             ) {
-                self::$_settings[ $addon_name ] = $addon_settings;
+                self::$_settings[$addon_name] = $addon_settings;
                 $addon = self::_load_and_init_addon_class($addon_name);
                 $addon->set_activation_indicator_option();
                 // dont bother setting up the rest of the addon.
@@ -688,7 +688,7 @@ 
             return true;
         }
         // make sure this was called in the right place!
-        if (! did_action('AHEE__EE_System__load_espresso_addons')
+        if ( ! did_action('AHEE__EE_System__load_espresso_addons')
             || did_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin')
         ) {
             EE_Error::doing_it_wrong(
@@ -704,10 +704,10 @@ 
             );
         }
         // make sure addon settings are set correctly without overwriting anything existing
-        if (isset(self::$_settings[ $addon_name ])) {
-            self::$_settings[ $addon_name ] += $addon_settings;
+        if (isset(self::$_settings[$addon_name])) {
+            self::$_settings[$addon_name] += $addon_settings;
         } else {
-            self::$_settings[ $addon_name ] = $addon_settings;
+            self::$_settings[$addon_name] = $addon_settings;
         }
         return false;
     }
@@ -720,13 +720,13 @@ 
      */
     private static function _setup_autoloaders($addon_name)
     {
-        if (! empty(self::$_settings[ $addon_name ]['autoloader_paths'])) {
+        if ( ! empty(self::$_settings[$addon_name]['autoloader_paths'])) {
             // setup autoloader for single file
-            EEH_Autoloader::instance()->register_autoloader(self::$_settings[ $addon_name ]['autoloader_paths']);
+            EEH_Autoloader::instance()->register_autoloader(self::$_settings[$addon_name]['autoloader_paths']);
         }
         // setup autoloaders for folders
-        if (! empty(self::$_settings[ $addon_name ]['autoloader_folders'])) {
-            foreach ((array) self::$_settings[ $addon_name ]['autoloader_folders'] as $autoloader_folder) {
+        if ( ! empty(self::$_settings[$addon_name]['autoloader_folders'])) {
+            foreach ((array) self::$_settings[$addon_name]['autoloader_folders'] as $autoloader_folder) {
                 EEH_Autoloader::register_autoloaders_for_each_file_in_folder($autoloader_folder);
             }
         }
@@ -743,26 +743,26 @@ 
     private static function _register_models_and_extensions($addon_name)
     {
         // register new models
-        if (! empty(self::$_settings[ $addon_name ]['model_paths'])
-            || ! empty(self::$_settings[ $addon_name ]['class_paths'])
+        if ( ! empty(self::$_settings[$addon_name]['model_paths'])
+            || ! empty(self::$_settings[$addon_name]['class_paths'])
         ) {
             EE_Register_Model::register(
                 $addon_name,
                 array(
-                    'model_paths' => self::$_settings[ $addon_name ]['model_paths'],
-                    'class_paths' => self::$_settings[ $addon_name ]['class_paths'],
+                    'model_paths' => self::$_settings[$addon_name]['model_paths'],
+                    'class_paths' => self::$_settings[$addon_name]['class_paths'],
                 )
             );
         }
         // register model extensions
-        if (! empty(self::$_settings[ $addon_name ]['model_extension_paths'])
-            || ! empty(self::$_settings[ $addon_name ]['class_extension_paths'])
+        if ( ! empty(self::$_settings[$addon_name]['model_extension_paths'])
+            || ! empty(self::$_settings[$addon_name]['class_extension_paths'])
         ) {
             EE_Register_Model_Extensions::register(
                 $addon_name,
                 array(
-                    'model_extension_paths' => self::$_settings[ $addon_name ]['model_extension_paths'],
-                    'class_extension_paths' => self::$_settings[ $addon_name ]['class_extension_paths'],
+                    'model_extension_paths' => self::$_settings[$addon_name]['model_extension_paths'],
+                    'class_extension_paths' => self::$_settings[$addon_name]['class_extension_paths'],
                 )
             );
         }
@@ -777,10 +777,10 @@ 
     private static function _register_data_migration_scripts($addon_name)
     {
         // setup DMS
-        if (! empty(self::$_settings[ $addon_name ]['dms_paths'])) {
+        if ( ! empty(self::$_settings[$addon_name]['dms_paths'])) {
             EE_Register_Data_Migration_Scripts::register(
                 $addon_name,
-                array('dms_paths' => self::$_settings[ $addon_name ]['dms_paths'])
+                array('dms_paths' => self::$_settings[$addon_name]['dms_paths'])
             );
         }
     }
@@ -794,12 +794,12 @@ 
     private static function _register_config($addon_name)
     {
         // if config_class is present let's register config.
-        if (! empty(self::$_settings[ $addon_name ]['config_class'])) {
+        if ( ! empty(self::$_settings[$addon_name]['config_class'])) {
             EE_Register_Config::register(
-                self::$_settings[ $addon_name ]['config_class'],
+                self::$_settings[$addon_name]['config_class'],
                 array(
-                    'config_section' => self::$_settings[ $addon_name ]['config_section'],
-                    'config_name'    => self::$_settings[ $addon_name ]['config_name'],
+                    'config_section' => self::$_settings[$addon_name]['config_section'],
+                    'config_name'    => self::$_settings[$addon_name]['config_name'],
                 )
             );
         }
@@ -813,10 +813,10 @@ 
      */
     private static function _register_admin_pages($addon_name)
     {
-        if (! empty(self::$_settings[ $addon_name ]['admin_path'])) {
+        if ( ! empty(self::$_settings[$addon_name]['admin_path'])) {
             EE_Register_Admin_Page::register(
                 $addon_name,
-                array('page_path' => self::$_settings[ $addon_name ]['admin_path'])
+                array('page_path' => self::$_settings[$addon_name]['admin_path'])
             );
         }
     }
@@ -829,10 +829,10 @@ 
      */
     private static function _register_modules($addon_name)
     {
-        if (! empty(self::$_settings[ $addon_name ]['module_paths'])) {
+        if ( ! empty(self::$_settings[$addon_name]['module_paths'])) {
             EE_Register_Module::register(
                 $addon_name,
-                array('module_paths' => self::$_settings[ $addon_name ]['module_paths'])
+                array('module_paths' => self::$_settings[$addon_name]['module_paths'])
             );
         }
     }
@@ -845,17 +845,17 @@ 
      */
     private static function _register_shortcodes($addon_name)
     {
-        if (! empty(self::$_settings[ $addon_name ]['shortcode_paths'])
-            || ! empty(self::$_settings[ $addon_name ]['shortcode_fqcns'])
+        if ( ! empty(self::$_settings[$addon_name]['shortcode_paths'])
+            || ! empty(self::$_settings[$addon_name]['shortcode_fqcns'])
         ) {
             EE_Register_Shortcode::register(
                 $addon_name,
                 array(
-                    'shortcode_paths' => isset(self::$_settings[ $addon_name ]['shortcode_paths'])
-                        ? self::$_settings[ $addon_name ]['shortcode_paths']
+                    'shortcode_paths' => isset(self::$_settings[$addon_name]['shortcode_paths'])
+                        ? self::$_settings[$addon_name]['shortcode_paths']
                         : array(),
-                    'shortcode_fqcns' => isset(self::$_settings[ $addon_name ]['shortcode_fqcns'])
-                        ? self::$_settings[ $addon_name ]['shortcode_fqcns']
+                    'shortcode_fqcns' => isset(self::$_settings[$addon_name]['shortcode_fqcns'])
+                        ? self::$_settings[$addon_name]['shortcode_fqcns']
                         : array(),
                 )
             );
@@ -870,10 +870,10 @@ 
      */
     private static function _register_widgets($addon_name)
     {
-        if (! empty(self::$_settings[ $addon_name ]['widget_paths'])) {
+        if ( ! empty(self::$_settings[$addon_name]['widget_paths'])) {
             EE_Register_Widget::register(
                 $addon_name,
-                array('widget_paths' => self::$_settings[ $addon_name ]['widget_paths'])
+                array('widget_paths' => self::$_settings[$addon_name]['widget_paths'])
             );
         }
     }
@@ -886,12 +886,12 @@ 
      */
     private static function _register_capabilities($addon_name)
     {
-        if (! empty(self::$_settings[ $addon_name ]['capabilities'])) {
+        if ( ! empty(self::$_settings[$addon_name]['capabilities'])) {
             EE_Register_Capabilities::register(
                 $addon_name,
                 array(
-                    'capabilities'    => self::$_settings[ $addon_name ]['capabilities'],
-                    'capability_maps' => self::$_settings[ $addon_name ]['capability_maps'],
+                    'capabilities'    => self::$_settings[$addon_name]['capabilities'],
+                    'capability_maps' => self::$_settings[$addon_name]['capability_maps'],
                 )
             );
         }
@@ -905,7 +905,7 @@ 
      */
     private static function _register_message_types($addon_name)
     {
-        if (! empty(self::$_settings[ $addon_name ]['message_types'])) {
+        if ( ! empty(self::$_settings[$addon_name]['message_types'])) {
             add_action(
                 'EE_Brewing_Regular___messages_caf',
                 array('EE_Register_Addon', 'register_message_types')
@@ -921,15 +921,15 @@ 
      */
     private static function _register_custom_post_types($addon_name)
     {
-        if (! empty(self::$_settings[ $addon_name ]['custom_post_types'])
-            || ! empty(self::$_settings[ $addon_name ]['custom_taxonomies'])
+        if ( ! empty(self::$_settings[$addon_name]['custom_post_types'])
+            || ! empty(self::$_settings[$addon_name]['custom_taxonomies'])
         ) {
             EE_Register_CPT::register(
                 $addon_name,
                 array(
-                    'cpts'          => self::$_settings[ $addon_name ]['custom_post_types'],
-                    'cts'           => self::$_settings[ $addon_name ]['custom_taxonomies'],
-                    'default_terms' => self::$_settings[ $addon_name ]['default_terms'],
+                    'cpts'          => self::$_settings[$addon_name]['custom_post_types'],
+                    'cts'           => self::$_settings[$addon_name]['custom_taxonomies'],
+                    'default_terms' => self::$_settings[$addon_name]['default_terms'],
                 )
             );
         }
@@ -947,10 +947,10 @@ 
      */
     private static function _register_payment_methods($addon_name)
     {
-        if (! empty(self::$_settings[ $addon_name ]['payment_method_paths'])) {
+        if ( ! empty(self::$_settings[$addon_name]['payment_method_paths'])) {
             EE_Register_Payment_Method::register(
                 $addon_name,
-                array('payment_method_paths' => self::$_settings[ $addon_name ]['payment_method_paths'])
+                array('payment_method_paths' => self::$_settings[$addon_name]['payment_method_paths'])
             );
         }
     }
@@ -967,10 +967,10 @@ 
      */
     private static function registerPrivacyPolicies($addon_name)
     {
-        if (! empty(self::$_settings[ $addon_name ]['privacy_policies'])) {
+        if ( ! empty(self::$_settings[$addon_name]['privacy_policies'])) {
             EE_Register_Privacy_Policy::register(
                 $addon_name,
-                self::$_settings[ $addon_name ]['privacy_policies']
+                self::$_settings[$addon_name]['privacy_policies']
             );
         }
     }
@@ -982,10 +982,10 @@ 
      */
     private static function registerPersonalDataExporters($addon_name)
     {
-        if (! empty(self::$_settings[ $addon_name ]['personal_data_exporters'])) {
+        if ( ! empty(self::$_settings[$addon_name]['personal_data_exporters'])) {
             EE_Register_Personal_Data_Eraser::register(
                 $addon_name,
-                self::$_settings[ $addon_name ]['personal_data_exporters']
+                self::$_settings[$addon_name]['personal_data_exporters']
             );
         }
     }
@@ -997,10 +997,10 @@ 
      */
     private static function registerPersonalDataErasers($addon_name)
     {
-        if (! empty(self::$_settings[ $addon_name ]['personal_data_erasers'])) {
+        if ( ! empty(self::$_settings[$addon_name]['personal_data_erasers'])) {
             EE_Register_Personal_Data_Eraser::register(
                 $addon_name,
-                self::$_settings[ $addon_name ]['personal_data_erasers']
+                self::$_settings[$addon_name]['personal_data_erasers']
             );
         }
     }
@@ -1021,7 +1021,7 @@ 
     {
         $loader = EventEspresso\core\services\loaders\LoaderFactory::getLoader();
         $addon = $loader->getShared(
-            self::$_settings[ $addon_name ]['class_name'],
+            self::$_settings[$addon_name]['class_name'],
             array('EE_Registry::create(addon)' => true)
         );
         // setter inject dep map if required
@@ -1033,19 +1033,19 @@ 
             && $addon->domain() === null
         ) {
             // using supplied Domain object
-            $domain = self::$_settings[ $addon_name ]['domain'] instanceof DomainInterface
-                ? self::$_settings[ $addon_name ]['domain']
+            $domain = self::$_settings[$addon_name]['domain'] instanceof DomainInterface
+                ? self::$_settings[$addon_name]['domain']
                 : null;
             // or construct one using Domain FQCN
-            if ($domain === null && self::$_settings[ $addon_name ]['domain_fqcn'] !== '') {
+            if ($domain === null && self::$_settings[$addon_name]['domain_fqcn'] !== '') {
                 $domain = $loader->getShared(
-                    self::$_settings[ $addon_name ]['domain_fqcn'],
+                    self::$_settings[$addon_name]['domain_fqcn'],
                     array(
                         new EventEspresso\core\domain\values\FilePath(
-                            self::$_settings[ $addon_name ]['main_file_path']
+                            self::$_settings[$addon_name]['main_file_path']
                         ),
                         EventEspresso\core\domain\values\Version::fromString(
-                            self::$_settings[ $addon_name ]['version']
+                            self::$_settings[$addon_name]['version']
                         ),
                     )
                 );
@@ -1055,24 +1055,24 @@ 
             }
         }
         $addon->set_name($addon_name);
-        $addon->set_plugin_slug(self::$_settings[ $addon_name ]['plugin_slug']);
-        $addon->set_plugin_basename(self::$_settings[ $addon_name ]['plugin_basename']);
-        $addon->set_main_plugin_file(self::$_settings[ $addon_name ]['main_file_path']);
-        $addon->set_plugin_action_slug(self::$_settings[ $addon_name ]['plugin_action_slug']);
-        $addon->set_plugins_page_row(self::$_settings[ $addon_name ]['plugins_page_row']);
-        $addon->set_version(self::$_settings[ $addon_name ]['version']);
-        $addon->set_min_core_version(self::_effective_version(self::$_settings[ $addon_name ]['min_core_version']));
-        $addon->set_config_section(self::$_settings[ $addon_name ]['config_section']);
-        $addon->set_config_class(self::$_settings[ $addon_name ]['config_class']);
-        $addon->set_config_name(self::$_settings[ $addon_name ]['config_name']);
+        $addon->set_plugin_slug(self::$_settings[$addon_name]['plugin_slug']);
+        $addon->set_plugin_basename(self::$_settings[$addon_name]['plugin_basename']);
+        $addon->set_main_plugin_file(self::$_settings[$addon_name]['main_file_path']);
+        $addon->set_plugin_action_slug(self::$_settings[$addon_name]['plugin_action_slug']);
+        $addon->set_plugins_page_row(self::$_settings[$addon_name]['plugins_page_row']);
+        $addon->set_version(self::$_settings[$addon_name]['version']);
+        $addon->set_min_core_version(self::_effective_version(self::$_settings[$addon_name]['min_core_version']));
+        $addon->set_config_section(self::$_settings[$addon_name]['config_section']);
+        $addon->set_config_class(self::$_settings[$addon_name]['config_class']);
+        $addon->set_config_name(self::$_settings[$addon_name]['config_name']);
         // unfortunately this can't be hooked in upon construction, because we don't have
         // the plugin mainfile's path upon construction.
         register_deactivation_hook($addon->get_main_plugin_file(), array($addon, 'deactivation'));
         // call any additional admin_callback functions during load_admin_controller hook
-        if (! empty(self::$_settings[ $addon_name ]['admin_callback'])) {
+        if ( ! empty(self::$_settings[$addon_name]['admin_callback'])) {
             add_action(
                 'AHEE__EE_System__load_controllers__load_admin_controllers',
-                array($addon, self::$_settings[ $addon_name ]['admin_callback'])
+                array($addon, self::$_settings[$addon_name]['admin_callback'])
             );
         }
         return $addon;
@@ -1090,11 +1090,11 @@ 
     public static function load_pue_update()
     {
         // load PUE client
-        require_once EE_THIRD_PARTY . 'pue/pue-client.php';
+        require_once EE_THIRD_PARTY.'pue/pue-client.php';
         $license_server = defined('PUE_UPDATES_ENDPOINT') ? PUE_UPDATES_ENDPOINT : 'https://eventespresso.com';
         // cycle thru settings
         foreach (self::$_settings as $settings) {
-            if (! empty($settings['pue_options'])) {
+            if ( ! empty($settings['pue_options'])) {
                 // initiate the class and start the plugin update engine!
                 new PluginUpdateEngineChecker(
                     // host file URL
@@ -1102,7 +1102,7 @@ 
                     // plugin slug(s)
                     array(
                         'premium'    => array('p' => $settings['pue_options']['pue_plugin_slug']),
-                        'prerelease' => array('beta' => $settings['pue_options']['pue_plugin_slug'] . '-pr'),
+                        'prerelease' => array('beta' => $settings['pue_options']['pue_plugin_slug'].'-pr'),
                     ),
                     // options
                     array(
@@ -1131,7 +1131,7 @@ 
     public static function register_message_types()
     {
         foreach (self::$_settings as $addon_name => $settings) {
-            if (! empty($settings['message_types'])) {
+            if ( ! empty($settings['message_types'])) {
                 foreach ((array) $settings['message_types'] as $message_type => $message_type_settings) {
                     EE_Register_Message_Type::register($message_type, $message_type_settings);
                 }
@@ -1153,70 +1153,70 @@ 
      */
     public static function deregister($addon_name = null)
     {
-        if (isset(self::$_settings[ $addon_name ]['class_name'])) {
+        if (isset(self::$_settings[$addon_name]['class_name'])) {
             try {
                 do_action('AHEE__EE_Register_Addon__deregister__before', $addon_name);
-                $class_name = self::$_settings[ $addon_name ]['class_name'];
-                if (! empty(self::$_settings[ $addon_name ]['dms_paths'])) {
+                $class_name = self::$_settings[$addon_name]['class_name'];
+                if ( ! empty(self::$_settings[$addon_name]['dms_paths'])) {
                     // setup DMS
                     EE_Register_Data_Migration_Scripts::deregister($addon_name);
                 }
-                if (! empty(self::$_settings[ $addon_name ]['admin_path'])) {
+                if ( ! empty(self::$_settings[$addon_name]['admin_path'])) {
                     // register admin page
                     EE_Register_Admin_Page::deregister($addon_name);
                 }
-                if (! empty(self::$_settings[ $addon_name ]['module_paths'])) {
+                if ( ! empty(self::$_settings[$addon_name]['module_paths'])) {
                     // add to list of modules to be registered
                     EE_Register_Module::deregister($addon_name);
                 }
-                if (! empty(self::$_settings[ $addon_name ]['shortcode_paths'])
-                    || ! empty(self::$_settings[ $addon_name ]['shortcode_fqcns'])
+                if ( ! empty(self::$_settings[$addon_name]['shortcode_paths'])
+                    || ! empty(self::$_settings[$addon_name]['shortcode_fqcns'])
                 ) {
                     // add to list of shortcodes to be registered
                     EE_Register_Shortcode::deregister($addon_name);
                 }
-                if (! empty(self::$_settings[ $addon_name ]['config_class'])) {
+                if ( ! empty(self::$_settings[$addon_name]['config_class'])) {
                     // if config_class present let's register config.
-                    EE_Register_Config::deregister(self::$_settings[ $addon_name ]['config_class']);
+                    EE_Register_Config::deregister(self::$_settings[$addon_name]['config_class']);
                 }
-                if (! empty(self::$_settings[ $addon_name ]['widget_paths'])) {
+                if ( ! empty(self::$_settings[$addon_name]['widget_paths'])) {
                     // add to list of widgets to be registered
                     EE_Register_Widget::deregister($addon_name);
                 }
-                if (! empty(self::$_settings[ $addon_name ]['model_paths'])
-                    || ! empty(self::$_settings[ $addon_name ]['class_paths'])
+                if ( ! empty(self::$_settings[$addon_name]['model_paths'])
+                    || ! empty(self::$_settings[$addon_name]['class_paths'])
                 ) {
                     // add to list of shortcodes to be registered
                     EE_Register_Model::deregister($addon_name);
                 }
-                if (! empty(self::$_settings[ $addon_name ]['model_extension_paths'])
-                    || ! empty(self::$_settings[ $addon_name ]['class_extension_paths'])
+                if ( ! empty(self::$_settings[$addon_name]['model_extension_paths'])
+                    || ! empty(self::$_settings[$addon_name]['class_extension_paths'])
                 ) {
                     // add to list of shortcodes to be registered
                     EE_Register_Model_Extensions::deregister($addon_name);
                 }
-                if (! empty(self::$_settings[ $addon_name ]['message_types'])) {
-                    foreach ((array) self::$_settings[ $addon_name ]['message_types'] as $message_type => $message_type_settings) {
+                if ( ! empty(self::$_settings[$addon_name]['message_types'])) {
+                    foreach ((array) self::$_settings[$addon_name]['message_types'] as $message_type => $message_type_settings) {
                         EE_Register_Message_Type::deregister($message_type);
                     }
                 }
                 // deregister capabilities for addon
-                if (! empty(self::$_settings[ $addon_name ]['capabilities'])
-                    || ! empty(self::$_settings[ $addon_name ]['capability_maps'])
+                if ( ! empty(self::$_settings[$addon_name]['capabilities'])
+                    || ! empty(self::$_settings[$addon_name]['capability_maps'])
                 ) {
                     EE_Register_Capabilities::deregister($addon_name);
                 }
                 // deregister custom_post_types for addon
-                if (! empty(self::$_settings[ $addon_name ]['custom_post_types'])) {
+                if ( ! empty(self::$_settings[$addon_name]['custom_post_types'])) {
                     EE_Register_CPT::deregister($addon_name);
                 }
-                if (! empty(self::$_settings[ $addon_name ]['payment_method_paths'])) {
+                if ( ! empty(self::$_settings[$addon_name]['payment_method_paths'])) {
                     EE_Register_Payment_Method::deregister($addon_name);
                 }
                 $addon = EE_Registry::instance()->getAddon($class_name);
                 if ($addon instanceof EE_Addon) {
                     remove_action(
-                        'deactivate_' . $addon->get_main_plugin_file_basename(),
+                        'deactivate_'.$addon->get_main_plugin_file_basename(),
                         array($addon, 'deactivation')
                     );
                     remove_action(
@@ -1239,7 +1239,7 @@ 
             } catch (Exception $e) {
                 new ExceptionLogger($e);
             }
-            unset(self::$_settings[ $addon_name ]);
+            unset(self::$_settings[$addon_name]);
             do_action('AHEE__EE_Register_Addon__deregister__after', $addon_name);
         }
     }

core/libraries/form_sections/base/EE_Form_Section_Proper.form.php

Indentation +1524 added lines, -1524 removed lines

@@ -14,1528 +14,1528 @@
 class EE_Form_Section_Proper extends EE_Form_Section_Validatable
 {
 
-    const SUBMITTED_FORM_DATA_SSN_KEY = 'submitted_form_data';
-
-    /**
-     * Subsections
-     *
-     * @var EE_Form_Section_Validatable[]
-     */
-    protected $_subsections = array();
-
-    /**
-     * Strategy for laying out the form
-     *
-     * @var EE_Form_Section_Layout_Base
-     */
-    protected $_layout_strategy;
-
-    /**
-     * Whether or not this form has received and validated a form submission yet
-     *
-     * @var boolean
-     */
-    protected $_received_submission = false;
-
-    /**
-     * message displayed to users upon successful form submission
-     *
-     * @var string
-     */
-    protected $_form_submission_success_message = '';
-
-    /**
-     * message displayed to users upon unsuccessful form submission
-     *
-     * @var string
-     */
-    protected $_form_submission_error_message = '';
-
-    /**
-     * @var array like $_REQUEST
-     */
-    protected $cached_request_data;
-
-    /**
-     * Stores whether this form (and its sub-sections) were found to be valid or not.
-     * Starts off as null, but once the form is validated, it set to either true or false
-     * @var boolean|null
-     */
-    protected $is_valid;
-
-    /**
-     * Stores all the data that will localized for form validation
-     *
-     * @var array
-     */
-    static protected $_js_localization = array();
-
-    /**
-     * whether or not the form's localized validation JS vars have been set
-     *
-     * @type boolean
-     */
-    static protected $_scripts_localized = false;
-
-
-    /**
-     * when constructing a proper form section, calls _construct_finalize on children
-     * so that they know who their parent is, and what name they've been given.
-     *
-     * @param array[] $options_array   {
-     * @type          $subsections     EE_Form_Section_Validatable[] where keys are the section's name
-     * @type          $include         string[] numerically-indexed where values are section names to be included,
-     *                                 and in that order. This is handy if you want
-     *                                 the subsections to be ordered differently than the default, and if you override
-     *                                 which fields are shown
-     * @type          $exclude         string[] values are subsections to be excluded. This is handy if you want
-     *                                 to remove certain default subsections (note: if you specify BOTH 'include' AND
-     *                                 'exclude', the inclusions will be applied first, and the exclusions will exclude
-     *                                 items from that list of inclusions)
-     * @type          $layout_strategy EE_Form_Section_Layout_Base strategy for laying out the form
-     *                                 } @see EE_Form_Section_Validatable::__construct()
-     * @throws EE_Error
-     */
-    public function __construct($options_array = array())
-    {
-        $options_array = (array) apply_filters(
-            'FHEE__EE_Form_Section_Proper___construct__options_array',
-            $options_array,
-            $this
-        );
-        // call parent first, as it may be setting the name
-        parent::__construct($options_array);
-        // if they've included subsections in the constructor, add them now
-        if (isset($options_array['include'])) {
-            // we are going to make sure we ONLY have those subsections to include
-            // AND we are going to make sure they're in that specified order
-            $reordered_subsections = array();
-            foreach ($options_array['include'] as $input_name) {
-                if (isset($this->_subsections[ $input_name ])) {
-                    $reordered_subsections[ $input_name ] = $this->_subsections[ $input_name ];
-                }
-            }
-            $this->_subsections = $reordered_subsections;
-        }
-        if (isset($options_array['exclude'])) {
-            $exclude            = $options_array['exclude'];
-            $this->_subsections = array_diff_key($this->_subsections, array_flip($exclude));
-        }
-        if (isset($options_array['layout_strategy'])) {
-            $this->_layout_strategy = $options_array['layout_strategy'];
-        }
-        if (! $this->_layout_strategy) {
-            $this->_layout_strategy = is_admin() ? new EE_Admin_Two_Column_Layout() : new EE_Two_Column_Layout();
-        }
-        $this->_layout_strategy->_construct_finalize($this);
-        // ok so we are definitely going to want the forms JS,
-        // so enqueue it or remember to enqueue it during wp_enqueue_scripts
-        if (did_action('wp_enqueue_scripts') || did_action('admin_enqueue_scripts')) {
-            // ok so they've constructed this object after when they should have.
-            // just enqueue the generic form scripts and initialize the form immediately in the JS
-            EE_Form_Section_Proper::wp_enqueue_scripts(true);
-        } else {
-            add_action('wp_enqueue_scripts', array('EE_Form_Section_Proper', 'wp_enqueue_scripts'));
-            add_action('admin_enqueue_scripts', array('EE_Form_Section_Proper', 'wp_enqueue_scripts'));
-        }
-        add_action('wp_footer', array($this, 'ensure_scripts_localized'), 1);
-        /**
-         * Gives other plugins a chance to hook in before construct finalize is called.
-         * The form probably doesn't yet have a parent form section.
-         * Since 4.9.32, when this action was introduced, this is the best place to add a subsection onto a form,
-         * assuming you don't care what the form section's name, HTML ID, or HTML name etc are.
-         * Also see AHEE__EE_Form_Section_Proper___construct_finalize__end
-         *
-         * @since 4.9.32
-         * @param EE_Form_Section_Proper $this          before __construct is done, but all of its logic,
-         *                                              except maybe calling _construct_finalize has been done
-         * @param array                  $options_array options passed into the constructor
-         */
-        do_action(
-            'AHEE__EE_Form_Input_Base___construct__before_construct_finalize_called',
-            $this,
-            $options_array
-        );
-        if (isset($options_array['name'])) {
-            $this->_construct_finalize(null, $options_array['name']);
-        }
-    }
-
-
-    /**
-     * Finishes construction given the parent form section and this form section's name
-     *
-     * @param EE_Form_Section_Proper $parent_form_section
-     * @param string                 $name
-     * @throws EE_Error
-     */
-    public function _construct_finalize($parent_form_section, $name)
-    {
-        parent::_construct_finalize($parent_form_section, $name);
-        $this->_set_default_name_if_empty();
-        $this->_set_default_html_id_if_empty();
-        foreach ($this->_subsections as $subsection_name => $subsection) {
-            if ($subsection instanceof EE_Form_Section_Base) {
-                $subsection->_construct_finalize($this, $subsection_name);
-            } else {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            'Subsection "%s" is not an instanceof EE_Form_Section_Base on form "%s". It is a "%s"',
-                            'event_espresso'
-                        ),
-                        $subsection_name,
-                        get_class($this),
-                        $subsection ? get_class($subsection) : esc_html__('NULL', 'event_espresso')
-                    )
-                );
-            }
-        }
-        /**
-         * Action performed just after form has been given a name (and HTML ID etc) and is fully constructed.
-         * If you have code that should modify the form and needs it and its subsections to have a name, HTML ID
-         * (or other attributes derived from the name like the HTML label id, etc), this is where it should be done.
-         * This might only happen just before displaying the form, or just before it receives form submission data.
-         * If you need to modify the form or its subsections before _construct_finalize is called on it (and we've
-         * ensured it has a name, HTML IDs, etc
-         *
-         * @param EE_Form_Section_Proper      $this
-         * @param EE_Form_Section_Proper|null $parent_form_section
-         * @param string                      $name
-         */
-        do_action(
-            'AHEE__EE_Form_Section_Proper___construct_finalize__end',
-            $this,
-            $parent_form_section,
-            $name
-        );
-    }
-
-
-    /**
-     * Gets the layout strategy for this form section
-     *
-     * @return EE_Form_Section_Layout_Base
-     */
-    public function get_layout_strategy()
-    {
-        return $this->_layout_strategy;
-    }
-
-
-    /**
-     * Gets the HTML for a single input for this form section according
-     * to the layout strategy
-     *
-     * @param EE_Form_Input_Base $input
-     * @return string
-     */
-    public function get_html_for_input($input)
-    {
-        return $this->_layout_strategy->layout_input($input);
-    }
-
-
-    /**
-     * was_submitted - checks if form inputs are present in request data
-     * Basically an alias for form_data_present_in() (which is used by both
-     * proper form sections and form inputs)
-     *
-     * @param null $form_data
-     * @return boolean
-     * @throws EE_Error
-     */
-    public function was_submitted($form_data = null)
-    {
-        return $this->form_data_present_in($form_data);
-    }
-
-    /**
-     * Gets the cached request data; but if there is none, or $req_data was set with
-     * something different, refresh the cache, and then return it
-     * @param null $req_data
-     * @return array
-     */
-    protected function getCachedRequest($req_data = null)
-    {
-        if ($this->cached_request_data === null
-            || (
-                $req_data !== null &&
-                $req_data !== $this->cached_request_data
-            )
-        ) {
-            $req_data = apply_filters(
-                'FHEE__EE_Form_Section_Proper__receive_form_submission__req_data',
-                $req_data,
-                $this
-            );
-            if ($req_data === null) {
-                $req_data = array_merge($_GET, $_POST);
-            }
-            $req_data = apply_filters(
-                'FHEE__EE_Form_Section_Proper__receive_form_submission__request_data',
-                $req_data,
-                $this
-            );
-            $this->cached_request_data = (array) $req_data;
-        }
-        return $this->cached_request_data;
-    }
-
-
-    /**
-     * After the form section is initially created, call this to sanitize the data in the submission
-     * which relates to this form section, validate it, and set it as properties on the form.
-     *
-     * @param array|null $req_data should usually be $_POST (the default).
-     *                             However, you CAN supply a different array.
-     *                             Consider using set_defaults() instead however.
-     *                             (If you rendered the form in the page using echo $form_x->get_html()
-     *                             the inputs will have the correct name in the request data for this function
-     *                             to find them and populate the form with them.
-     *                             If you have a flat form (with only input subsections),
-     *                             you can supply a flat array where keys
-     *                             are the form input names and values are their values)
-     * @param boolean    $validate whether or not to perform validation on this data. Default is,
-     *                             of course, to validate that data, and set errors on the invalid values.
-     *                             But if the data has already been validated
-     *                             (eg you validated the data then stored it in the DB)
-     *                             you may want to skip this step.
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function receive_form_submission($req_data = null, $validate = true)
-    {
-        $req_data = $this->getCachedRequest($req_data);
-        $this->_normalize($req_data);
-        if ($validate) {
-            $this->_validate();
-            // if it's invalid, we're going to want to re-display so remember what they submitted
-            if (! $this->is_valid()) {
-                $this->store_submitted_form_data_in_session();
-            }
-        }
-        if ($this->submission_error_message() === '' && ! $this->is_valid()) {
-            $this->set_submission_error_message();
-        }
-        do_action(
-            'AHEE__EE_Form_Section_Proper__receive_form_submission__end',
-            $req_data,
-            $this,
-            $validate
-        );
-    }
-
-
-    /**
-     * caches the originally submitted input values in the session
-     * so that they can be used to repopulate the form if it failed validation
-     *
-     * @return boolean whether or not the data was successfully stored in the session
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    protected function store_submitted_form_data_in_session()
-    {
-        return EE_Registry::instance()->SSN->set_session_data(
-            array(
-                EE_Form_Section_Proper::SUBMITTED_FORM_DATA_SSN_KEY => $this->submitted_values(true),
-            )
-        );
-    }
-
-
-    /**
-     * retrieves the originally submitted input values in the session
-     * so that they can be used to repopulate the form if it failed validation
-     *
-     * @return array
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    protected function get_submitted_form_data_from_session()
-    {
-        $session = EE_Registry::instance()->SSN;
-        if ($session instanceof EE_Session) {
-            return $session->get_session_data(
-                EE_Form_Section_Proper::SUBMITTED_FORM_DATA_SSN_KEY
-            );
-        }
-        return array();
-    }
-
-
-    /**
-     * flushed the originally submitted input values from the session
-     *
-     * @return boolean whether or not the data was successfully removed from the session
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    public static function flush_submitted_form_data_from_session()
-    {
-        return EE_Registry::instance()->SSN->reset_data(
-            array(EE_Form_Section_Proper::SUBMITTED_FORM_DATA_SSN_KEY)
-        );
-    }
-
-
-    /**
-     * Populates this form and its subsections with data from the session.
-     * (Wrapper for EE_Form_Section_Proper::receive_form_submission, so it shows
-     * validation errors when displaying too)
-     * Returns true if the form was populated from the session, false otherwise
-     *
-     * @return boolean
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function populate_from_session()
-    {
-        $form_data_in_session = $this->get_submitted_form_data_from_session();
-        if (empty($form_data_in_session)) {
-            return false;
-        }
-        $this->receive_form_submission($form_data_in_session);
-        add_action('shutdown', array('EE_Form_Section_Proper', 'flush_submitted_form_data_from_session'));
-        if ($this->form_data_present_in($form_data_in_session)) {
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * Populates the default data for the form, given an array where keys are
-     * the input names, and values are their values (preferably normalized to be their
-     * proper PHP types, not all strings... although that should be ok too).
-     * Proper subsections are sub-arrays, the key being the subsection's name, and
-     * the value being an array formatted in teh same way
-     *
-     * @param array $default_data
-     * @throws EE_Error
-     */
-    public function populate_defaults($default_data)
-    {
-        foreach ($this->subsections(false) as $subsection_name => $subsection) {
-            if (isset($default_data[ $subsection_name ])) {
-                if ($subsection instanceof EE_Form_Input_Base) {
-                    $subsection->set_default($default_data[ $subsection_name ]);
-                } elseif ($subsection instanceof EE_Form_Section_Proper) {
-                    $subsection->populate_defaults($default_data[ $subsection_name ]);
-                }
-            }
-        }
-    }
-
-
-    /**
-     * returns true if subsection exists
-     *
-     * @param string $name
-     * @return boolean
-     */
-    public function subsection_exists($name)
-    {
-        return isset($this->_subsections[ $name ]) ? true : false;
-    }
-
-
-    /**
-     * Gets the subsection specified by its name
-     *
-     * @param string  $name
-     * @param boolean $require_construction_to_be_finalized most client code should leave this as TRUE
-     *                                                      so that the inputs will be properly configured.
-     *                                                      However, some client code may be ok
-     *                                                      with construction finalize being called later
-     *                                                      (realizing that the subsections' html names
-     *                                                      might not be set yet, etc.)
-     * @return EE_Form_Section_Base
-     * @throws EE_Error
-     */
-    public function get_subsection($name, $require_construction_to_be_finalized = true)
-    {
-        if ($require_construction_to_be_finalized) {
-            $this->ensure_construct_finalized_called();
-        }
-        return $this->subsection_exists($name) ? $this->_subsections[ $name ] : null;
-    }
-
-
-    /**
-     * Gets all the validatable subsections of this form section
-     *
-     * @return EE_Form_Section_Validatable[]
-     * @throws EE_Error
-     */
-    public function get_validatable_subsections()
-    {
-        $validatable_subsections = array();
-        foreach ($this->subsections() as $name => $obj) {
-            if ($obj instanceof EE_Form_Section_Validatable) {
-                $validatable_subsections[ $name ] = $obj;
-            }
-        }
-        return $validatable_subsections;
-    }
-
-
-    /**
-     * Gets an input by the given name. If not found, or if its not an EE_FOrm_Input_Base child,
-     * throw an EE_Error.
-     *
-     * @param string  $name
-     * @param boolean $require_construction_to_be_finalized most client code should
-     *                                                      leave this as TRUE so that the inputs will be properly
-     *                                                      configured. However, some client code may be ok with
-     *                                                      construction finalize being called later
-     *                                                      (realizing that the subsections' html names might not be
-     *                                                      set yet, etc.)
-     * @return EE_Form_Input_Base
-     * @throws EE_Error
-     */
-    public function get_input($name, $require_construction_to_be_finalized = true)
-    {
-        $subsection = $this->get_subsection(
-            $name,
-            $require_construction_to_be_finalized
-        );
-        if (! $subsection instanceof EE_Form_Input_Base) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        "Subsection '%s' is not an instanceof EE_Form_Input_Base on form '%s'. It is a '%s'",
-                        'event_espresso'
-                    ),
-                    $name,
-                    get_class($this),
-                    $subsection ? get_class($subsection) : esc_html__('NULL', 'event_espresso')
-                )
-            );
-        }
-        return $subsection;
-    }
-
-
-    /**
-     * Like get_input(), gets the proper subsection of the form given the name,
-     * otherwise throws an EE_Error
-     *
-     * @param string  $name
-     * @param boolean $require_construction_to_be_finalized most client code should
-     *                                                      leave this as TRUE so that the inputs will be properly
-     *                                                      configured. However, some client code may be ok with
-     *                                                      construction finalize being called later
-     *                                                      (realizing that the subsections' html names might not be
-     *                                                      set yet, etc.)
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     */
-    public function get_proper_subsection($name, $require_construction_to_be_finalized = true)
-    {
-        $subsection = $this->get_subsection(
-            $name,
-            $require_construction_to_be_finalized
-        );
-        if (! $subsection instanceof EE_Form_Section_Proper) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        "Subsection '%'s is not an instanceof EE_Form_Section_Proper on form '%s'",
-                        'event_espresso'
-                    ),
-                    $name,
-                    get_class($this)
-                )
-            );
-        }
-        return $subsection;
-    }
-
-
-    /**
-     * Gets the value of the specified input. Should be called after receive_form_submission()
-     * or populate_defaults() on the form, where the normalized value on the input is set.
-     *
-     * @param string $name
-     * @return mixed depending on the input's type and its normalization strategy
-     * @throws EE_Error
-     */
-    public function get_input_value($name)
-    {
-        $input = $this->get_input($name);
-        return $input->normalized_value();
-    }
-
-
-    /**
-     * Checks if this form section itself is valid, and then checks its subsections
-     *
-     * @throws EE_Error
-     * @return boolean
-     */
-    public function is_valid()
-    {
-        if ($this->is_valid === null) {
-            if (! $this->has_received_submission()) {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            'You cannot check if a form is valid before receiving the form submission using receive_form_submission',
-                            'event_espresso'
-                        )
-                    )
-                );
-            }
-            if (! parent::is_valid()) {
-                $this->is_valid = false;
-            } else {
-                // ok so no general errors to this entire form section.
-                // so let's check the subsections, but only set errors if that hasn't been done yet
-                $this->is_valid = true;
-                foreach ($this->get_validatable_subsections() as $subsection) {
-                    if (! $subsection->is_valid()) {
-                        $this->is_valid = false;
-                    }
-                }
-            }
-        }
-        return $this->is_valid;
-    }
-
-
-    /**
-     * gets the default name of this form section if none is specified
-     *
-     * @return void
-     */
-    protected function _set_default_name_if_empty()
-    {
-        if (! $this->_name) {
-            $classname    = get_class($this);
-            $default_name = str_replace('EE_', '', $classname);
-            $this->_name  = $default_name;
-        }
-    }
-
-
-    /**
-     * Returns the HTML for the form, except for the form opening and closing tags
-     * (as the form section doesn't know where you necessarily want to send the information to),
-     * and except for a submit button. Enqueues JS and CSS; if called early enough we will
-     * try to enqueue them in the header, otherwise they'll be enqueued in the footer.
-     * Not doing_it_wrong because theoretically this CAN be used properly,
-     * provided its used during "wp_enqueue_scripts", or it doesn't need to enqueue
-     * any CSS.
-     *
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function get_html_and_js()
-    {
-        $this->enqueue_js();
-        return $this->get_html();
-    }
-
-
-    /**
-     * returns HTML for displaying this form section. recursively calls display_section() on all subsections
-     *
-     * @param bool $display_previously_submitted_data
-     * @return string
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    public function get_html($display_previously_submitted_data = true)
-    {
-        $this->ensure_construct_finalized_called();
-        if ($display_previously_submitted_data) {
-            $this->populate_from_session();
-        }
-        return $this->_form_html_filter
-            ? $this->_form_html_filter->filterHtml($this->_layout_strategy->layout_form(), $this)
-            : $this->_layout_strategy->layout_form();
-    }
-
-
-    /**
-     * enqueues JS and CSS for the form.
-     * It is preferred to call this before wp_enqueue_scripts so the
-     * scripts and styles can be put in the header, but if called later
-     * they will be put in the footer (which is OK for JS, but in HTML4 CSS should
-     * only be in the header; but in HTML5 its ok in the body.
-     * See http://stackoverflow.com/questions/4957446/load-external-css-file-in-body-tag.
-     * So if your form enqueues CSS, it's preferred to call this before wp_enqueue_scripts.)
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    public function enqueue_js()
-    {
-        $this->_enqueue_and_localize_form_js();
-        foreach ($this->subsections() as $subsection) {
-            $subsection->enqueue_js();
-        }
-    }
-
-
-    /**
-     * adds a filter so that jquery validate gets enqueued in EE_System::wp_enqueue_scripts().
-     * This must be done BEFORE wp_enqueue_scripts() gets called, which is on
-     * the wp_enqueue_scripts hook.
-     * However, registering the form js and localizing it can happen when we
-     * actually output the form (which is preferred, seeing how teh form's fields
-     * could change until it's actually outputted)
-     *
-     * @param boolean $init_form_validation_automatically whether or not we want the form validation
-     *                                                    to be triggered automatically or not
-     * @return void
-     */
-    public static function wp_enqueue_scripts($init_form_validation_automatically = true)
-    {
-        wp_register_script(
-            'ee_form_section_validation',
-            EE_GLOBAL_ASSETS_URL . 'scripts' . '/form_section_validation.js',
-            array('jquery-validate', 'jquery-ui-datepicker', 'jquery-validate-extra-methods'),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_localize_script(
-            'ee_form_section_validation',
-            'ee_form_section_validation_init',
-            array('init' => $init_form_validation_automatically ? '1' : '0')
-        );
-    }
-
-
-    /**
-     * gets the variables used by form_section_validation.js.
-     * This needs to be called AFTER we've called $this->_enqueue_jquery_validate_script,
-     * but before the wordpress hook wp_loaded
-     *
-     * @throws EE_Error
-     */
-    public function _enqueue_and_localize_form_js()
-    {
-        $this->ensure_construct_finalized_called();
-        // actually, we don't want to localize just yet. There may be other forms on the page.
-        // so we need to add our form section data to a static variable accessible by all form sections
-        // and localize it just before the footer
-        $this->localize_validation_rules();
-        add_action('wp_footer', array('EE_Form_Section_Proper', 'localize_script_for_all_forms'), 2);
-        add_action('admin_footer', array('EE_Form_Section_Proper', 'localize_script_for_all_forms'));
-    }
-
-
-    /**
-     * add our form section data to a static variable accessible by all form sections
-     *
-     * @param bool $return_for_subsection
-     * @return void
-     * @throws EE_Error
-     */
-    public function localize_validation_rules($return_for_subsection = false)
-    {
-        // we only want to localize vars ONCE for the entire form,
-        // so if the form section doesn't have a parent, then it must be the top dog
-        if ($return_for_subsection || ! $this->parent_section()) {
-            EE_Form_Section_Proper::$_js_localization['form_data'][ $this->html_id() ] = array(
-                'form_section_id'  => $this->html_id(true),
-                'validation_rules' => $this->get_jquery_validation_rules(),
-                'other_data'       => $this->get_other_js_data(),
-                'errors'           => $this->subsection_validation_errors_by_html_name(),
-            );
-            EE_Form_Section_Proper::$_scripts_localized                                = true;
-        }
-    }
-
-
-    /**
-     * Gets an array of extra data that will be useful for client-side javascript.
-     * This is primarily data added by inputs and forms in addition to any
-     * scripts they might enqueue
-     *
-     * @param array $form_other_js_data
-     * @return array
-     * @throws EE_Error
-     */
-    public function get_other_js_data($form_other_js_data = array())
-    {
-        foreach ($this->subsections() as $subsection) {
-            $form_other_js_data = $subsection->get_other_js_data($form_other_js_data);
-        }
-        return $form_other_js_data;
-    }
-
-
-    /**
-     * Gets a flat array of inputs for this form section and its subsections.
-     * Keys are their form names, and values are the inputs themselves
-     *
-     * @return EE_Form_Input_Base
-     * @throws EE_Error
-     */
-    public function inputs_in_subsections()
-    {
-        $inputs = array();
-        foreach ($this->subsections() as $subsection) {
-            if ($subsection instanceof EE_Form_Input_Base) {
-                $inputs[ $subsection->html_name() ] = $subsection;
-            } elseif ($subsection instanceof EE_Form_Section_Proper) {
-                $inputs += $subsection->inputs_in_subsections();
-            }
-        }
-        return $inputs;
-    }
-
-
-    /**
-     * Gets a flat array of all the validation errors.
-     * Keys are html names (because those should be unique)
-     * and values are a string of all their validation errors
-     *
-     * @return string[]
-     * @throws EE_Error
-     */
-    public function subsection_validation_errors_by_html_name()
-    {
-        $inputs = $this->inputs();
-        $errors = array();
-        foreach ($inputs as $form_input) {
-            if ($form_input instanceof EE_Form_Input_Base && $form_input->get_validation_errors()) {
-                $errors[ $form_input->html_name() ] = $form_input->get_validation_error_string();
-            }
-        }
-        return $errors;
-    }
-
-
-    /**
-     * passes all the form data required by the JS to the JS, and enqueues the few required JS files.
-     * Should be setup by each form during the _enqueues_and_localize_form_js
-     *
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    public static function localize_script_for_all_forms()
-    {
-        // allow inputs and stuff to hook in their JS and stuff here
-        do_action('AHEE__EE_Form_Section_Proper__localize_script_for_all_forms__begin');
-        EE_Form_Section_Proper::$_js_localization['localized_error_messages'] = EE_Form_Section_Proper::_get_localized_error_messages();
-        $email_validation_level = isset(EE_Registry::instance()->CFG->registration->email_validation_level)
-            ? EE_Registry::instance()->CFG->registration->email_validation_level
-            : 'wp_default';
-        EE_Form_Section_Proper::$_js_localization['email_validation_level']   = $email_validation_level;
-        wp_enqueue_script('ee_form_section_validation');
-        wp_localize_script(
-            'ee_form_section_validation',
-            'ee_form_section_vars',
-            EE_Form_Section_Proper::$_js_localization
-        );
-    }
-
-
-    /**
-     * ensure_scripts_localized
-     *
-     * @throws EE_Error
-     */
-    public function ensure_scripts_localized()
-    {
-        if (! EE_Form_Section_Proper::$_scripts_localized) {
-            $this->_enqueue_and_localize_form_js();
-        }
-    }
-
-
-    /**
-     * Gets the hard-coded validation error messages to be used in the JS. The convention
-     * is that the key here should be the same as the custom validation rule put in the JS file
-     *
-     * @return array keys are custom validation rules, and values are internationalized strings
-     */
-    private static function _get_localized_error_messages()
-    {
-        return array(
-            'validUrl' => esc_html__('This is not a valid absolute URL. Eg, http://domain.com/monkey.jpg', 'event_espresso'),
-            'regex'    => esc_html__('Please check your input', 'event_espresso'),
-        );
-    }
-
-
-    /**
-     * @return array
-     */
-    public static function js_localization()
-    {
-        return self::$_js_localization;
-    }
-
-
-    /**
-     * @return void
-     */
-    public static function reset_js_localization()
-    {
-        self::$_js_localization = array();
-    }
-
-
-    /**
-     * Gets the JS to put inside the jquery validation rules for subsection of this form section.
-     * See parent function for more...
-     *
-     * @return array
-     * @throws EE_Error
-     */
-    public function get_jquery_validation_rules()
-    {
-        $jquery_validation_rules = array();
-        foreach ($this->get_validatable_subsections() as $subsection) {
-            $jquery_validation_rules = array_merge(
-                $jquery_validation_rules,
-                $subsection->get_jquery_validation_rules()
-            );
-        }
-        return $jquery_validation_rules;
-    }
-
-
-    /**
-     * Sanitizes all the data and sets the sanitized value of each field
-     *
-     * @param array $req_data like $_POST
-     * @return void
-     * @throws EE_Error
-     */
-    protected function _normalize($req_data)
-    {
-        $this->_received_submission = true;
-        $this->_validation_errors   = array();
-        foreach ($this->get_validatable_subsections() as $subsection) {
-            try {
-                $subsection->_normalize($req_data);
-            } catch (EE_Validation_Error $e) {
-                $subsection->add_validation_error($e);
-            }
-        }
-    }
-
-
-    /**
-     * Performs validation on this form section and its subsections.
-     * For each subsection,
-     * calls _validate_{subsection_name} on THIS form (if the function exists)
-     * and passes it the subsection, then calls _validate on that subsection.
-     * If you need to perform validation on the form as a whole (considering multiple)
-     * you would be best to override this _validate method,
-     * calling parent::_validate() first.
-     *
-     * @throws EE_Error
-     */
-    protected function _validate()
-    {
-        // reset the cache of whether this form is valid or not- we're re-validating it now
-        $this->is_valid = null;
-        foreach ($this->get_validatable_subsections() as $subsection_name => $subsection) {
-            if (method_exists($this, '_validate_' . $subsection_name)) {
-                call_user_func_array(array($this, '_validate_' . $subsection_name), array($subsection));
-            }
-            $subsection->_validate();
-        }
-    }
-
-
-    /**
-     * Gets all the validated inputs for the form section
-     *
-     * @return array
-     * @throws EE_Error
-     */
-    public function valid_data()
-    {
-        $inputs = array();
-        foreach ($this->subsections() as $subsection_name => $subsection) {
-            if ($subsection instanceof EE_Form_Section_Proper) {
-                $inputs[ $subsection_name ] = $subsection->valid_data();
-            } elseif ($subsection instanceof EE_Form_Input_Base) {
-                $inputs[ $subsection_name ] = $subsection->normalized_value();
-            }
-        }
-        return $inputs;
-    }
-
-
-    /**
-     * Gets all the inputs on this form section
-     *
-     * @return EE_Form_Input_Base[]
-     * @throws EE_Error
-     */
-    public function inputs()
-    {
-        $inputs = array();
-        foreach ($this->subsections() as $subsection_name => $subsection) {
-            if ($subsection instanceof EE_Form_Input_Base) {
-                $inputs[ $subsection_name ] = $subsection;
-            }
-        }
-        return $inputs;
-    }
-
-
-    /**
-     * Gets all the subsections which are a proper form
-     *
-     * @return EE_Form_Section_Proper[]
-     * @throws EE_Error
-     */
-    public function subforms()
-    {
-        $form_sections = array();
-        foreach ($this->subsections() as $name => $obj) {
-            if ($obj instanceof EE_Form_Section_Proper) {
-                $form_sections[ $name ] = $obj;
-            }
-        }
-        return $form_sections;
-    }
-
-
-    /**
-     * Gets all the subsections (inputs, proper subsections, or html-only sections).
-     * Consider using inputs() or subforms()
-     * if you only want form inputs or proper form sections.
-     *
-     * @param boolean $require_construction_to_be_finalized most client code should
-     *                                                      leave this as TRUE so that the inputs will be properly
-     *                                                      configured. However, some client code may be ok with
-     *                                                      construction finalize being called later
-     *                                                      (realizing that the subsections' html names might not be
-     *                                                      set yet, etc.)
-     * @return EE_Form_Section_Proper[]
-     * @throws EE_Error
-     */
-    public function subsections($require_construction_to_be_finalized = true)
-    {
-        if ($require_construction_to_be_finalized) {
-            $this->ensure_construct_finalized_called();
-        }
-        return $this->_subsections;
-    }
-
-
-    /**
-     * Returns whether this form has any subforms or inputs
-     * @return bool
-     */
-    public function hasSubsections()
-    {
-        return ! empty($this->_subsections);
-    }
-
-
-    /**
-     * Returns a simple array where keys are input names, and values are their normalized
-     * values. (Similar to calling get_input_value on inputs)
-     *
-     * @param boolean $include_subform_inputs Whether to include inputs from subforms,
-     *                                        or just this forms' direct children inputs
-     * @param boolean $flatten                Whether to force the results into 1-dimensional array,
-     *                                        or allow multidimensional array
-     * @return array if $flatten is TRUE it will always be a 1-dimensional array
-     *                                        with array keys being input names
-     *                                        (regardless of whether they are from a subsection or not),
-     *                                        and if $flatten is FALSE it can be a multidimensional array
-     *                                        where keys are always subsection names and values are either
-     *                                        the input's normalized value, or an array like the top-level array
-     * @throws EE_Error
-     */
-    public function input_values($include_subform_inputs = false, $flatten = false)
-    {
-        return $this->_input_values(false, $include_subform_inputs, $flatten);
-    }
-
-
-    /**
-     * Similar to EE_Form_Section_Proper::input_values(), except this returns the 'display_value'
-     * of each input. On some inputs (especially radio boxes or checkboxes), the value stored
-     * is not necessarily the value we want to display to users. This creates an array
-     * where keys are the input names, and values are their display values
-     *
-     * @param boolean $include_subform_inputs Whether to include inputs from subforms,
-     *                                        or just this forms' direct children inputs
-     * @param boolean $flatten                Whether to force the results into 1-dimensional array,
-     *                                        or allow multidimensional array
-     * @return array if $flatten is TRUE it will always be a 1-dimensional array
-     *                                        with array keys being input names
-     *                                        (regardless of whether they are from a subsection or not),
-     *                                        and if $flatten is FALSE it can be a multidimensional array
-     *                                        where keys are always subsection names and values are either
-     *                                        the input's normalized value, or an array like the top-level array
-     * @throws EE_Error
-     */
-    public function input_pretty_values($include_subform_inputs = false, $flatten = false)
-    {
-        return $this->_input_values(true, $include_subform_inputs, $flatten);
-    }
-
-
-    /**
-     * Gets the input values from the form
-     *
-     * @param boolean $pretty                 Whether to retrieve the pretty value,
-     *                                        or just the normalized value
-     * @param boolean $include_subform_inputs Whether to include inputs from subforms,
-     *                                        or just this forms' direct children inputs
-     * @param boolean $flatten                Whether to force the results into 1-dimensional array,
-     *                                        or allow multidimensional array
-     * @return array if $flatten is TRUE it will always be a 1-dimensional array with array keys being
-     *                                        input names (regardless of whether they are from a subsection or not),
-     *                                        and if $flatten is FALSE it can be a multidimensional array
-     *                                        where keys are always subsection names and values are either
-     *                                        the input's normalized value, or an array like the top-level array
-     * @throws EE_Error
-     */
-    public function _input_values($pretty = false, $include_subform_inputs = false, $flatten = false)
-    {
-        $input_values = array();
-        foreach ($this->subsections() as $subsection_name => $subsection) {
-            if ($subsection instanceof EE_Form_Input_Base) {
-                $input_values[ $subsection_name ] = $pretty
-                    ? $subsection->pretty_value()
-                    : $subsection->normalized_value();
-            } elseif ($subsection instanceof EE_Form_Section_Proper && $include_subform_inputs) {
-                $subform_input_values = $subsection->_input_values(
-                    $pretty,
-                    $include_subform_inputs,
-                    $flatten
-                );
-                if ($flatten) {
-                    $input_values = array_merge($input_values, $subform_input_values);
-                } else {
-                    $input_values[ $subsection_name ] = $subform_input_values;
-                }
-            }
-        }
-        return $input_values;
-    }
-
-
-    /**
-     * Gets the originally submitted input values from the form
-     *
-     * @param boolean $include_subforms  Whether to include inputs from subforms,
-     *                                   or just this forms' direct children inputs
-     * @return array                     if $flatten is TRUE it will always be a 1-dimensional array
-     *                                   with array keys being input names
-     *                                   (regardless of whether they are from a subsection or not),
-     *                                   and if $flatten is FALSE it can be a multidimensional array
-     *                                   where keys are always subsection names and values are either
-     *                                   the input's normalized value, or an array like the top-level array
-     * @throws EE_Error
-     */
-    public function submitted_values($include_subforms = false)
-    {
-        $submitted_values = array();
-        foreach ($this->subsections() as $subsection) {
-            if ($subsection instanceof EE_Form_Input_Base) {
-                // is this input part of an array of inputs?
-                if (strpos($subsection->html_name(), '[') !== false) {
-                    $full_input_name  = EEH_Array::convert_array_values_to_keys(
-                        explode(
-                            '[',
-                            str_replace(']', '', $subsection->html_name())
-                        ),
-                        $subsection->raw_value()
-                    );
-                    $submitted_values = array_replace_recursive($submitted_values, $full_input_name);
-                } else {
-                    $submitted_values[ $subsection->html_name() ] = $subsection->raw_value();
-                }
-            } elseif ($subsection instanceof EE_Form_Section_Proper && $include_subforms) {
-                $subform_input_values = $subsection->submitted_values($include_subforms);
-                $submitted_values     = array_replace_recursive($submitted_values, $subform_input_values);
-            }
-        }
-        return $submitted_values;
-    }
-
-
-    /**
-     * Indicates whether or not this form has received a submission yet
-     * (ie, had receive_form_submission called on it yet)
-     *
-     * @return boolean
-     * @throws EE_Error
-     */
-    public function has_received_submission()
-    {
-        $this->ensure_construct_finalized_called();
-        return $this->_received_submission;
-    }
-
-
-    /**
-     * Equivalent to passing 'exclude' in the constructor's options array.
-     * Removes the listed inputs from the form
-     *
-     * @param array $inputs_to_exclude values are the input names
-     * @return void
-     */
-    public function exclude(array $inputs_to_exclude = array())
-    {
-        foreach ($inputs_to_exclude as $input_to_exclude_name) {
-            unset($this->_subsections[ $input_to_exclude_name ]);
-        }
-    }
-
-
-    /**
-     * Changes these inputs' display strategy to be EE_Hidden_Display_Strategy.
-     * @param array $inputs_to_hide
-     * @throws EE_Error
-     */
-    public function hide(array $inputs_to_hide = array())
-    {
-        foreach ($inputs_to_hide as $input_to_hide) {
-            $input = $this->get_input($input_to_hide);
-            $input->set_display_strategy(new EE_Hidden_Display_Strategy());
-        }
-    }
-
-
-    /**
-     * add_subsections
-     * Adds the listed subsections to the form section.
-     * If $subsection_name_to_target is provided,
-     * then new subsections are added before or after that subsection,
-     * otherwise to the start or end of the entire subsections array.
-     *
-     * @param EE_Form_Section_Base[] $new_subsections           array of new form subsections
-     *                                                          where keys are their names
-     * @param string                 $subsection_name_to_target an existing for section that $new_subsections
-     *                                                          should be added before or after
-     *                                                          IF $subsection_name_to_target is null,
-     *                                                          then $new_subsections will be added to
-     *                                                          the beginning or end of the entire subsections array
-     * @param boolean                $add_before                whether to add $new_subsections, before or after
-     *                                                          $subsection_name_to_target,
-     *                                                          or if $subsection_name_to_target is null,
-     *                                                          before or after entire subsections array
-     * @return void
-     * @throws EE_Error
-     */
-    public function add_subsections($new_subsections, $subsection_name_to_target = null, $add_before = true)
-    {
-        foreach ($new_subsections as $subsection_name => $subsection) {
-            if (! $subsection instanceof EE_Form_Section_Base) {
-                EE_Error::add_error(
-                    sprintf(
-                        esc_html__(
-                            "Trying to add a %s as a subsection (it was named '%s') to the form section '%s'. It was removed.",
-                            'event_espresso'
-                        ),
-                        get_class($subsection),
-                        $subsection_name,
-                        $this->name()
-                    )
-                );
-                unset($new_subsections[ $subsection_name ]);
-            }
-        }
-        $this->_subsections = EEH_Array::insert_into_array(
-            $this->_subsections,
-            $new_subsections,
-            $subsection_name_to_target,
-            $add_before
-        );
-        if ($this->_construction_finalized) {
-            foreach ($this->_subsections as $name => $subsection) {
-                $subsection->_construct_finalize($this, $name);
-            }
-        }
-    }
-
-
-    /**
-     * @param string $subsection_name
-     * @param bool   $recursive
-     * @return bool
-     */
-    public function has_subsection($subsection_name, $recursive = false)
-    {
-        foreach ($this->_subsections as $name => $subsection) {
-            if ($name === $subsection_name
-                || (
-                    $recursive
-                    && $subsection instanceof EE_Form_Section_Proper
-                    && $subsection->has_subsection($subsection_name, $recursive)
-                )
-            ) {
-                return true;
-            }
-        }
-        return false;
-    }
-
-
-
-    /**
-     * Just gets all validatable subsections to clean their sensitive data
-     *
-     * @throws EE_Error
-     */
-    public function clean_sensitive_data()
-    {
-        foreach ($this->get_validatable_subsections() as $subsection) {
-            $subsection->clean_sensitive_data();
-        }
-    }
-
-
-    /**
-     * Sets the submission error message (aka validation error message for this form section and all sub-sections)
-     * @param string                           $form_submission_error_message
-     * @param EE_Form_Section_Validatable $form_section unused
-     * @throws EE_Error
-     */
-    public function set_submission_error_message(
-        $form_submission_error_message = ''
-    ) {
-        $this->_form_submission_error_message = ! empty($form_submission_error_message)
-            ? $form_submission_error_message
-            : $this->getAllValidationErrorsString();
-    }
-
-
-    /**
-     * Returns the cached error message. A default value is set for this during _validate(),
-     * (called during receive_form_submission) but it can be explicitly set using
-     * set_submission_error_message
-     *
-     * @return string
-     */
-    public function submission_error_message()
-    {
-        return $this->_form_submission_error_message;
-    }
-
-
-    /**
-     * Sets a message to display if the data submitted to the form was valid.
-     * @param string $form_submission_success_message
-     */
-    public function set_submission_success_message($form_submission_success_message = '')
-    {
-        $this->_form_submission_success_message = ! empty($form_submission_success_message)
-            ? $form_submission_success_message
-            : esc_html__('Form submitted successfully', 'event_espresso');
-    }
-
-
-    /**
-     * Gets a message appropriate for display when the form is correctly submitted
-     * @return string
-     */
-    public function submission_success_message()
-    {
-        return $this->_form_submission_success_message;
-    }
-
-
-    /**
-     * Returns the prefix that should be used on child of this form section for
-     * their html names. If this form section itself has a parent, prepends ITS
-     * prefix onto this form section's prefix. Used primarily by
-     * EE_Form_Input_Base::_set_default_html_name_if_empty
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function html_name_prefix()
-    {
-        if ($this->parent_section() instanceof EE_Form_Section_Proper) {
-            return $this->parent_section()->html_name_prefix() . '[' . $this->name() . ']';
-        }
-        return $this->name();
-    }
-
-
-    /**
-     * Gets the name, but first checks _construct_finalize has been called. If not,
-     * calls it (assumes there is no parent and that we want the name to be whatever
-     * was set, which is probably nothing, or the classname)
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function name()
-    {
-        $this->ensure_construct_finalized_called();
-        return parent::name();
-    }
-
-
-    /**
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     */
-    public function parent_section()
-    {
-        $this->ensure_construct_finalized_called();
-        return parent::parent_section();
-    }
-
-
-    /**
-     * make sure construction finalized was called, otherwise children might not be ready
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    public function ensure_construct_finalized_called()
-    {
-        if (! $this->_construction_finalized) {
-            $this->_construct_finalize($this->_parent_section, $this->_name);
-        }
-    }
-
-
-    /**
-     * Checks if any of this form section's inputs, or any of its children's inputs,
-     * are in teh form data. If any are found, returns true. Else false
-     *
-     * @param array $req_data
-     * @return boolean
-     * @throws EE_Error
-     */
-    public function form_data_present_in($req_data = null)
-    {
-        $req_data = $this->getCachedRequest($req_data);
-        foreach ($this->subsections() as $subsection) {
-            if ($subsection instanceof EE_Form_Input_Base) {
-                if ($subsection->form_data_present_in($req_data)) {
-                    return true;
-                }
-            } elseif ($subsection instanceof EE_Form_Section_Proper) {
-                if ($subsection->form_data_present_in($req_data)) {
-                    return true;
-                }
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     * Gets validation errors for this form section and subsections
-     * Similar to EE_Form_Section_Validatable::get_validation_errors() except this
-     * gets the validation errors for ALL subsection
-     *
-     * @return EE_Validation_Error[]
-     * @throws EE_Error
-     */
-    public function get_validation_errors_accumulated()
-    {
-        $validation_errors = $this->get_validation_errors();
-        foreach ($this->get_validatable_subsections() as $subsection) {
-            if ($subsection instanceof EE_Form_Section_Proper) {
-                $validation_errors_on_this_subsection = $subsection->get_validation_errors_accumulated();
-            } else {
-                $validation_errors_on_this_subsection = $subsection->get_validation_errors();
-            }
-            if ($validation_errors_on_this_subsection) {
-                $validation_errors = array_merge($validation_errors, $validation_errors_on_this_subsection);
-            }
-        }
-        return $validation_errors;
-    }
-
-    /**
-     * Fetch validation errors from children and grandchildren and puts them in a single string.
-     * This traverses the form section tree to generate this, but you probably want to instead use
-     * get_form_submission_error_message() which is usually this message cached (or a custom validation error message)
-     *
-     * @return string
-     * @since 4.9.59.p
-     */
-    protected function getAllValidationErrorsString()
-    {
-        $submission_error_messages = array();
-        // bad, bad, bad registrant
-        foreach ($this->get_validation_errors_accumulated() as $validation_error) {
-            if ($validation_error instanceof EE_Validation_Error) {
-                $form_section = $validation_error->get_form_section();
-                if ($form_section instanceof EE_Form_Input_Base) {
-                    $label = $validation_error->get_form_section()->html_label_text();
-                } elseif ($form_section instanceof EE_Form_Section_Validatable) {
-                    $label = $validation_error->get_form_section()->name();
-                } else {
-                    $label = esc_html__('Unknown', 'event_espresso');
-                }
-                $submission_error_messages[] = sprintf(
-                    __('%s : %s', 'event_espresso'),
-                    $label,
-                    $validation_error->getMessage()
-                );
-            }
-        }
-        return implode('<br', $submission_error_messages);
-    }
-
-
-    /**
-     * This isn't just the name of an input, it's a path pointing to an input. The
-     * path is similar to a folder path: slash (/) means to descend into a subsection,
-     * dot-dot-slash (../) means to ascend into the parent section.
-     * After a series of slashes and dot-dot-slashes, there should be the name of an input,
-     * which will be returned.
-     * Eg, if you want the related input to be conditional on a sibling input name 'foobar'
-     * just use 'foobar'. If you want it to be conditional on an aunt/uncle input name
-     * 'baz', use '../baz'. If you want it to be conditional on a cousin input,
-     * the child of 'baz_section' named 'baz_child', use '../baz_section/baz_child'.
-     * Etc
-     *
-     * @param string|false $form_section_path we accept false also because substr( '../', '../' ) = false
-     * @return EE_Form_Section_Base
-     * @throws EE_Error
-     */
-    public function find_section_from_path($form_section_path)
-    {
-        // check if we can find the input from purely going straight up the tree
-        $input = parent::find_section_from_path($form_section_path);
-        if ($input instanceof EE_Form_Section_Base) {
-            return $input;
-        }
-        $next_slash_pos = strpos($form_section_path, '/');
-        if ($next_slash_pos !== false) {
-            $child_section_name = substr($form_section_path, 0, $next_slash_pos);
-            $subpath            = substr($form_section_path, $next_slash_pos + 1);
-        } else {
-            $child_section_name = $form_section_path;
-            $subpath            = '';
-        }
-        $child_section = $this->get_subsection($child_section_name);
-        if ($child_section instanceof EE_Form_Section_Base) {
-            return $child_section->find_section_from_path($subpath);
-        }
-        return null;
-    }
+	const SUBMITTED_FORM_DATA_SSN_KEY = 'submitted_form_data';
+
+	/**
+	 * Subsections
+	 *
+	 * @var EE_Form_Section_Validatable[]
+	 */
+	protected $_subsections = array();
+
+	/**
+	 * Strategy for laying out the form
+	 *
+	 * @var EE_Form_Section_Layout_Base
+	 */
+	protected $_layout_strategy;
+
+	/**
+	 * Whether or not this form has received and validated a form submission yet
+	 *
+	 * @var boolean
+	 */
+	protected $_received_submission = false;
+
+	/**
+	 * message displayed to users upon successful form submission
+	 *
+	 * @var string
+	 */
+	protected $_form_submission_success_message = '';
+
+	/**
+	 * message displayed to users upon unsuccessful form submission
+	 *
+	 * @var string
+	 */
+	protected $_form_submission_error_message = '';
+
+	/**
+	 * @var array like $_REQUEST
+	 */
+	protected $cached_request_data;
+
+	/**
+	 * Stores whether this form (and its sub-sections) were found to be valid or not.
+	 * Starts off as null, but once the form is validated, it set to either true or false
+	 * @var boolean|null
+	 */
+	protected $is_valid;
+
+	/**
+	 * Stores all the data that will localized for form validation
+	 *
+	 * @var array
+	 */
+	static protected $_js_localization = array();
+
+	/**
+	 * whether or not the form's localized validation JS vars have been set
+	 *
+	 * @type boolean
+	 */
+	static protected $_scripts_localized = false;
+
+
+	/**
+	 * when constructing a proper form section, calls _construct_finalize on children
+	 * so that they know who their parent is, and what name they've been given.
+	 *
+	 * @param array[] $options_array   {
+	 * @type          $subsections     EE_Form_Section_Validatable[] where keys are the section's name
+	 * @type          $include         string[] numerically-indexed where values are section names to be included,
+	 *                                 and in that order. This is handy if you want
+	 *                                 the subsections to be ordered differently than the default, and if you override
+	 *                                 which fields are shown
+	 * @type          $exclude         string[] values are subsections to be excluded. This is handy if you want
+	 *                                 to remove certain default subsections (note: if you specify BOTH 'include' AND
+	 *                                 'exclude', the inclusions will be applied first, and the exclusions will exclude
+	 *                                 items from that list of inclusions)
+	 * @type          $layout_strategy EE_Form_Section_Layout_Base strategy for laying out the form
+	 *                                 } @see EE_Form_Section_Validatable::__construct()
+	 * @throws EE_Error
+	 */
+	public function __construct($options_array = array())
+	{
+		$options_array = (array) apply_filters(
+			'FHEE__EE_Form_Section_Proper___construct__options_array',
+			$options_array,
+			$this
+		);
+		// call parent first, as it may be setting the name
+		parent::__construct($options_array);
+		// if they've included subsections in the constructor, add them now
+		if (isset($options_array['include'])) {
+			// we are going to make sure we ONLY have those subsections to include
+			// AND we are going to make sure they're in that specified order
+			$reordered_subsections = array();
+			foreach ($options_array['include'] as $input_name) {
+				if (isset($this->_subsections[ $input_name ])) {
+					$reordered_subsections[ $input_name ] = $this->_subsections[ $input_name ];
+				}
+			}
+			$this->_subsections = $reordered_subsections;
+		}
+		if (isset($options_array['exclude'])) {
+			$exclude            = $options_array['exclude'];
+			$this->_subsections = array_diff_key($this->_subsections, array_flip($exclude));
+		}
+		if (isset($options_array['layout_strategy'])) {
+			$this->_layout_strategy = $options_array['layout_strategy'];
+		}
+		if (! $this->_layout_strategy) {
+			$this->_layout_strategy = is_admin() ? new EE_Admin_Two_Column_Layout() : new EE_Two_Column_Layout();
+		}
+		$this->_layout_strategy->_construct_finalize($this);
+		// ok so we are definitely going to want the forms JS,
+		// so enqueue it or remember to enqueue it during wp_enqueue_scripts
+		if (did_action('wp_enqueue_scripts') || did_action('admin_enqueue_scripts')) {
+			// ok so they've constructed this object after when they should have.
+			// just enqueue the generic form scripts and initialize the form immediately in the JS
+			EE_Form_Section_Proper::wp_enqueue_scripts(true);
+		} else {
+			add_action('wp_enqueue_scripts', array('EE_Form_Section_Proper', 'wp_enqueue_scripts'));
+			add_action('admin_enqueue_scripts', array('EE_Form_Section_Proper', 'wp_enqueue_scripts'));
+		}
+		add_action('wp_footer', array($this, 'ensure_scripts_localized'), 1);
+		/**
+		 * Gives other plugins a chance to hook in before construct finalize is called.
+		 * The form probably doesn't yet have a parent form section.
+		 * Since 4.9.32, when this action was introduced, this is the best place to add a subsection onto a form,
+		 * assuming you don't care what the form section's name, HTML ID, or HTML name etc are.
+		 * Also see AHEE__EE_Form_Section_Proper___construct_finalize__end
+		 *
+		 * @since 4.9.32
+		 * @param EE_Form_Section_Proper $this          before __construct is done, but all of its logic,
+		 *                                              except maybe calling _construct_finalize has been done
+		 * @param array                  $options_array options passed into the constructor
+		 */
+		do_action(
+			'AHEE__EE_Form_Input_Base___construct__before_construct_finalize_called',
+			$this,
+			$options_array
+		);
+		if (isset($options_array['name'])) {
+			$this->_construct_finalize(null, $options_array['name']);
+		}
+	}
+
+
+	/**
+	 * Finishes construction given the parent form section and this form section's name
+	 *
+	 * @param EE_Form_Section_Proper $parent_form_section
+	 * @param string                 $name
+	 * @throws EE_Error
+	 */
+	public function _construct_finalize($parent_form_section, $name)
+	{
+		parent::_construct_finalize($parent_form_section, $name);
+		$this->_set_default_name_if_empty();
+		$this->_set_default_html_id_if_empty();
+		foreach ($this->_subsections as $subsection_name => $subsection) {
+			if ($subsection instanceof EE_Form_Section_Base) {
+				$subsection->_construct_finalize($this, $subsection_name);
+			} else {
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							'Subsection "%s" is not an instanceof EE_Form_Section_Base on form "%s". It is a "%s"',
+							'event_espresso'
+						),
+						$subsection_name,
+						get_class($this),
+						$subsection ? get_class($subsection) : esc_html__('NULL', 'event_espresso')
+					)
+				);
+			}
+		}
+		/**
+		 * Action performed just after form has been given a name (and HTML ID etc) and is fully constructed.
+		 * If you have code that should modify the form and needs it and its subsections to have a name, HTML ID
+		 * (or other attributes derived from the name like the HTML label id, etc), this is where it should be done.
+		 * This might only happen just before displaying the form, or just before it receives form submission data.
+		 * If you need to modify the form or its subsections before _construct_finalize is called on it (and we've
+		 * ensured it has a name, HTML IDs, etc
+		 *
+		 * @param EE_Form_Section_Proper      $this
+		 * @param EE_Form_Section_Proper|null $parent_form_section
+		 * @param string                      $name
+		 */
+		do_action(
+			'AHEE__EE_Form_Section_Proper___construct_finalize__end',
+			$this,
+			$parent_form_section,
+			$name
+		);
+	}
+
+
+	/**
+	 * Gets the layout strategy for this form section
+	 *
+	 * @return EE_Form_Section_Layout_Base
+	 */
+	public function get_layout_strategy()
+	{
+		return $this->_layout_strategy;
+	}
+
+
+	/**
+	 * Gets the HTML for a single input for this form section according
+	 * to the layout strategy
+	 *
+	 * @param EE_Form_Input_Base $input
+	 * @return string
+	 */
+	public function get_html_for_input($input)
+	{
+		return $this->_layout_strategy->layout_input($input);
+	}
+
+
+	/**
+	 * was_submitted - checks if form inputs are present in request data
+	 * Basically an alias for form_data_present_in() (which is used by both
+	 * proper form sections and form inputs)
+	 *
+	 * @param null $form_data
+	 * @return boolean
+	 * @throws EE_Error
+	 */
+	public function was_submitted($form_data = null)
+	{
+		return $this->form_data_present_in($form_data);
+	}
+
+	/**
+	 * Gets the cached request data; but if there is none, or $req_data was set with
+	 * something different, refresh the cache, and then return it
+	 * @param null $req_data
+	 * @return array
+	 */
+	protected function getCachedRequest($req_data = null)
+	{
+		if ($this->cached_request_data === null
+			|| (
+				$req_data !== null &&
+				$req_data !== $this->cached_request_data
+			)
+		) {
+			$req_data = apply_filters(
+				'FHEE__EE_Form_Section_Proper__receive_form_submission__req_data',
+				$req_data,
+				$this
+			);
+			if ($req_data === null) {
+				$req_data = array_merge($_GET, $_POST);
+			}
+			$req_data = apply_filters(
+				'FHEE__EE_Form_Section_Proper__receive_form_submission__request_data',
+				$req_data,
+				$this
+			);
+			$this->cached_request_data = (array) $req_data;
+		}
+		return $this->cached_request_data;
+	}
+
+
+	/**
+	 * After the form section is initially created, call this to sanitize the data in the submission
+	 * which relates to this form section, validate it, and set it as properties on the form.
+	 *
+	 * @param array|null $req_data should usually be $_POST (the default).
+	 *                             However, you CAN supply a different array.
+	 *                             Consider using set_defaults() instead however.
+	 *                             (If you rendered the form in the page using echo $form_x->get_html()
+	 *                             the inputs will have the correct name in the request data for this function
+	 *                             to find them and populate the form with them.
+	 *                             If you have a flat form (with only input subsections),
+	 *                             you can supply a flat array where keys
+	 *                             are the form input names and values are their values)
+	 * @param boolean    $validate whether or not to perform validation on this data. Default is,
+	 *                             of course, to validate that data, and set errors on the invalid values.
+	 *                             But if the data has already been validated
+	 *                             (eg you validated the data then stored it in the DB)
+	 *                             you may want to skip this step.
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function receive_form_submission($req_data = null, $validate = true)
+	{
+		$req_data = $this->getCachedRequest($req_data);
+		$this->_normalize($req_data);
+		if ($validate) {
+			$this->_validate();
+			// if it's invalid, we're going to want to re-display so remember what they submitted
+			if (! $this->is_valid()) {
+				$this->store_submitted_form_data_in_session();
+			}
+		}
+		if ($this->submission_error_message() === '' && ! $this->is_valid()) {
+			$this->set_submission_error_message();
+		}
+		do_action(
+			'AHEE__EE_Form_Section_Proper__receive_form_submission__end',
+			$req_data,
+			$this,
+			$validate
+		);
+	}
+
+
+	/**
+	 * caches the originally submitted input values in the session
+	 * so that they can be used to repopulate the form if it failed validation
+	 *
+	 * @return boolean whether or not the data was successfully stored in the session
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	protected function store_submitted_form_data_in_session()
+	{
+		return EE_Registry::instance()->SSN->set_session_data(
+			array(
+				EE_Form_Section_Proper::SUBMITTED_FORM_DATA_SSN_KEY => $this->submitted_values(true),
+			)
+		);
+	}
+
+
+	/**
+	 * retrieves the originally submitted input values in the session
+	 * so that they can be used to repopulate the form if it failed validation
+	 *
+	 * @return array
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	protected function get_submitted_form_data_from_session()
+	{
+		$session = EE_Registry::instance()->SSN;
+		if ($session instanceof EE_Session) {
+			return $session->get_session_data(
+				EE_Form_Section_Proper::SUBMITTED_FORM_DATA_SSN_KEY
+			);
+		}
+		return array();
+	}
+
+
+	/**
+	 * flushed the originally submitted input values from the session
+	 *
+	 * @return boolean whether or not the data was successfully removed from the session
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	public static function flush_submitted_form_data_from_session()
+	{
+		return EE_Registry::instance()->SSN->reset_data(
+			array(EE_Form_Section_Proper::SUBMITTED_FORM_DATA_SSN_KEY)
+		);
+	}
+
+
+	/**
+	 * Populates this form and its subsections with data from the session.
+	 * (Wrapper for EE_Form_Section_Proper::receive_form_submission, so it shows
+	 * validation errors when displaying too)
+	 * Returns true if the form was populated from the session, false otherwise
+	 *
+	 * @return boolean
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function populate_from_session()
+	{
+		$form_data_in_session = $this->get_submitted_form_data_from_session();
+		if (empty($form_data_in_session)) {
+			return false;
+		}
+		$this->receive_form_submission($form_data_in_session);
+		add_action('shutdown', array('EE_Form_Section_Proper', 'flush_submitted_form_data_from_session'));
+		if ($this->form_data_present_in($form_data_in_session)) {
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * Populates the default data for the form, given an array where keys are
+	 * the input names, and values are their values (preferably normalized to be their
+	 * proper PHP types, not all strings... although that should be ok too).
+	 * Proper subsections are sub-arrays, the key being the subsection's name, and
+	 * the value being an array formatted in teh same way
+	 *
+	 * @param array $default_data
+	 * @throws EE_Error
+	 */
+	public function populate_defaults($default_data)
+	{
+		foreach ($this->subsections(false) as $subsection_name => $subsection) {
+			if (isset($default_data[ $subsection_name ])) {
+				if ($subsection instanceof EE_Form_Input_Base) {
+					$subsection->set_default($default_data[ $subsection_name ]);
+				} elseif ($subsection instanceof EE_Form_Section_Proper) {
+					$subsection->populate_defaults($default_data[ $subsection_name ]);
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * returns true if subsection exists
+	 *
+	 * @param string $name
+	 * @return boolean
+	 */
+	public function subsection_exists($name)
+	{
+		return isset($this->_subsections[ $name ]) ? true : false;
+	}
+
+
+	/**
+	 * Gets the subsection specified by its name
+	 *
+	 * @param string  $name
+	 * @param boolean $require_construction_to_be_finalized most client code should leave this as TRUE
+	 *                                                      so that the inputs will be properly configured.
+	 *                                                      However, some client code may be ok
+	 *                                                      with construction finalize being called later
+	 *                                                      (realizing that the subsections' html names
+	 *                                                      might not be set yet, etc.)
+	 * @return EE_Form_Section_Base
+	 * @throws EE_Error
+	 */
+	public function get_subsection($name, $require_construction_to_be_finalized = true)
+	{
+		if ($require_construction_to_be_finalized) {
+			$this->ensure_construct_finalized_called();
+		}
+		return $this->subsection_exists($name) ? $this->_subsections[ $name ] : null;
+	}
+
+
+	/**
+	 * Gets all the validatable subsections of this form section
+	 *
+	 * @return EE_Form_Section_Validatable[]
+	 * @throws EE_Error
+	 */
+	public function get_validatable_subsections()
+	{
+		$validatable_subsections = array();
+		foreach ($this->subsections() as $name => $obj) {
+			if ($obj instanceof EE_Form_Section_Validatable) {
+				$validatable_subsections[ $name ] = $obj;
+			}
+		}
+		return $validatable_subsections;
+	}
+
+
+	/**
+	 * Gets an input by the given name. If not found, or if its not an EE_FOrm_Input_Base child,
+	 * throw an EE_Error.
+	 *
+	 * @param string  $name
+	 * @param boolean $require_construction_to_be_finalized most client code should
+	 *                                                      leave this as TRUE so that the inputs will be properly
+	 *                                                      configured. However, some client code may be ok with
+	 *                                                      construction finalize being called later
+	 *                                                      (realizing that the subsections' html names might not be
+	 *                                                      set yet, etc.)
+	 * @return EE_Form_Input_Base
+	 * @throws EE_Error
+	 */
+	public function get_input($name, $require_construction_to_be_finalized = true)
+	{
+		$subsection = $this->get_subsection(
+			$name,
+			$require_construction_to_be_finalized
+		);
+		if (! $subsection instanceof EE_Form_Input_Base) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						"Subsection '%s' is not an instanceof EE_Form_Input_Base on form '%s'. It is a '%s'",
+						'event_espresso'
+					),
+					$name,
+					get_class($this),
+					$subsection ? get_class($subsection) : esc_html__('NULL', 'event_espresso')
+				)
+			);
+		}
+		return $subsection;
+	}
+
+
+	/**
+	 * Like get_input(), gets the proper subsection of the form given the name,
+	 * otherwise throws an EE_Error
+	 *
+	 * @param string  $name
+	 * @param boolean $require_construction_to_be_finalized most client code should
+	 *                                                      leave this as TRUE so that the inputs will be properly
+	 *                                                      configured. However, some client code may be ok with
+	 *                                                      construction finalize being called later
+	 *                                                      (realizing that the subsections' html names might not be
+	 *                                                      set yet, etc.)
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 */
+	public function get_proper_subsection($name, $require_construction_to_be_finalized = true)
+	{
+		$subsection = $this->get_subsection(
+			$name,
+			$require_construction_to_be_finalized
+		);
+		if (! $subsection instanceof EE_Form_Section_Proper) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						"Subsection '%'s is not an instanceof EE_Form_Section_Proper on form '%s'",
+						'event_espresso'
+					),
+					$name,
+					get_class($this)
+				)
+			);
+		}
+		return $subsection;
+	}
+
+
+	/**
+	 * Gets the value of the specified input. Should be called after receive_form_submission()
+	 * or populate_defaults() on the form, where the normalized value on the input is set.
+	 *
+	 * @param string $name
+	 * @return mixed depending on the input's type and its normalization strategy
+	 * @throws EE_Error
+	 */
+	public function get_input_value($name)
+	{
+		$input = $this->get_input($name);
+		return $input->normalized_value();
+	}
+
+
+	/**
+	 * Checks if this form section itself is valid, and then checks its subsections
+	 *
+	 * @throws EE_Error
+	 * @return boolean
+	 */
+	public function is_valid()
+	{
+		if ($this->is_valid === null) {
+			if (! $this->has_received_submission()) {
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							'You cannot check if a form is valid before receiving the form submission using receive_form_submission',
+							'event_espresso'
+						)
+					)
+				);
+			}
+			if (! parent::is_valid()) {
+				$this->is_valid = false;
+			} else {
+				// ok so no general errors to this entire form section.
+				// so let's check the subsections, but only set errors if that hasn't been done yet
+				$this->is_valid = true;
+				foreach ($this->get_validatable_subsections() as $subsection) {
+					if (! $subsection->is_valid()) {
+						$this->is_valid = false;
+					}
+				}
+			}
+		}
+		return $this->is_valid;
+	}
+
+
+	/**
+	 * gets the default name of this form section if none is specified
+	 *
+	 * @return void
+	 */
+	protected function _set_default_name_if_empty()
+	{
+		if (! $this->_name) {
+			$classname    = get_class($this);
+			$default_name = str_replace('EE_', '', $classname);
+			$this->_name  = $default_name;
+		}
+	}
+
+
+	/**
+	 * Returns the HTML for the form, except for the form opening and closing tags
+	 * (as the form section doesn't know where you necessarily want to send the information to),
+	 * and except for a submit button. Enqueues JS and CSS; if called early enough we will
+	 * try to enqueue them in the header, otherwise they'll be enqueued in the footer.
+	 * Not doing_it_wrong because theoretically this CAN be used properly,
+	 * provided its used during "wp_enqueue_scripts", or it doesn't need to enqueue
+	 * any CSS.
+	 *
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function get_html_and_js()
+	{
+		$this->enqueue_js();
+		return $this->get_html();
+	}
+
+
+	/**
+	 * returns HTML for displaying this form section. recursively calls display_section() on all subsections
+	 *
+	 * @param bool $display_previously_submitted_data
+	 * @return string
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	public function get_html($display_previously_submitted_data = true)
+	{
+		$this->ensure_construct_finalized_called();
+		if ($display_previously_submitted_data) {
+			$this->populate_from_session();
+		}
+		return $this->_form_html_filter
+			? $this->_form_html_filter->filterHtml($this->_layout_strategy->layout_form(), $this)
+			: $this->_layout_strategy->layout_form();
+	}
+
+
+	/**
+	 * enqueues JS and CSS for the form.
+	 * It is preferred to call this before wp_enqueue_scripts so the
+	 * scripts and styles can be put in the header, but if called later
+	 * they will be put in the footer (which is OK for JS, but in HTML4 CSS should
+	 * only be in the header; but in HTML5 its ok in the body.
+	 * See http://stackoverflow.com/questions/4957446/load-external-css-file-in-body-tag.
+	 * So if your form enqueues CSS, it's preferred to call this before wp_enqueue_scripts.)
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function enqueue_js()
+	{
+		$this->_enqueue_and_localize_form_js();
+		foreach ($this->subsections() as $subsection) {
+			$subsection->enqueue_js();
+		}
+	}
+
+
+	/**
+	 * adds a filter so that jquery validate gets enqueued in EE_System::wp_enqueue_scripts().
+	 * This must be done BEFORE wp_enqueue_scripts() gets called, which is on
+	 * the wp_enqueue_scripts hook.
+	 * However, registering the form js and localizing it can happen when we
+	 * actually output the form (which is preferred, seeing how teh form's fields
+	 * could change until it's actually outputted)
+	 *
+	 * @param boolean $init_form_validation_automatically whether or not we want the form validation
+	 *                                                    to be triggered automatically or not
+	 * @return void
+	 */
+	public static function wp_enqueue_scripts($init_form_validation_automatically = true)
+	{
+		wp_register_script(
+			'ee_form_section_validation',
+			EE_GLOBAL_ASSETS_URL . 'scripts' . '/form_section_validation.js',
+			array('jquery-validate', 'jquery-ui-datepicker', 'jquery-validate-extra-methods'),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_localize_script(
+			'ee_form_section_validation',
+			'ee_form_section_validation_init',
+			array('init' => $init_form_validation_automatically ? '1' : '0')
+		);
+	}
+
+
+	/**
+	 * gets the variables used by form_section_validation.js.
+	 * This needs to be called AFTER we've called $this->_enqueue_jquery_validate_script,
+	 * but before the wordpress hook wp_loaded
+	 *
+	 * @throws EE_Error
+	 */
+	public function _enqueue_and_localize_form_js()
+	{
+		$this->ensure_construct_finalized_called();
+		// actually, we don't want to localize just yet. There may be other forms on the page.
+		// so we need to add our form section data to a static variable accessible by all form sections
+		// and localize it just before the footer
+		$this->localize_validation_rules();
+		add_action('wp_footer', array('EE_Form_Section_Proper', 'localize_script_for_all_forms'), 2);
+		add_action('admin_footer', array('EE_Form_Section_Proper', 'localize_script_for_all_forms'));
+	}
+
+
+	/**
+	 * add our form section data to a static variable accessible by all form sections
+	 *
+	 * @param bool $return_for_subsection
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function localize_validation_rules($return_for_subsection = false)
+	{
+		// we only want to localize vars ONCE for the entire form,
+		// so if the form section doesn't have a parent, then it must be the top dog
+		if ($return_for_subsection || ! $this->parent_section()) {
+			EE_Form_Section_Proper::$_js_localization['form_data'][ $this->html_id() ] = array(
+				'form_section_id'  => $this->html_id(true),
+				'validation_rules' => $this->get_jquery_validation_rules(),
+				'other_data'       => $this->get_other_js_data(),
+				'errors'           => $this->subsection_validation_errors_by_html_name(),
+			);
+			EE_Form_Section_Proper::$_scripts_localized                                = true;
+		}
+	}
+
+
+	/**
+	 * Gets an array of extra data that will be useful for client-side javascript.
+	 * This is primarily data added by inputs and forms in addition to any
+	 * scripts they might enqueue
+	 *
+	 * @param array $form_other_js_data
+	 * @return array
+	 * @throws EE_Error
+	 */
+	public function get_other_js_data($form_other_js_data = array())
+	{
+		foreach ($this->subsections() as $subsection) {
+			$form_other_js_data = $subsection->get_other_js_data($form_other_js_data);
+		}
+		return $form_other_js_data;
+	}
+
+
+	/**
+	 * Gets a flat array of inputs for this form section and its subsections.
+	 * Keys are their form names, and values are the inputs themselves
+	 *
+	 * @return EE_Form_Input_Base
+	 * @throws EE_Error
+	 */
+	public function inputs_in_subsections()
+	{
+		$inputs = array();
+		foreach ($this->subsections() as $subsection) {
+			if ($subsection instanceof EE_Form_Input_Base) {
+				$inputs[ $subsection->html_name() ] = $subsection;
+			} elseif ($subsection instanceof EE_Form_Section_Proper) {
+				$inputs += $subsection->inputs_in_subsections();
+			}
+		}
+		return $inputs;
+	}
+
+
+	/**
+	 * Gets a flat array of all the validation errors.
+	 * Keys are html names (because those should be unique)
+	 * and values are a string of all their validation errors
+	 *
+	 * @return string[]
+	 * @throws EE_Error
+	 */
+	public function subsection_validation_errors_by_html_name()
+	{
+		$inputs = $this->inputs();
+		$errors = array();
+		foreach ($inputs as $form_input) {
+			if ($form_input instanceof EE_Form_Input_Base && $form_input->get_validation_errors()) {
+				$errors[ $form_input->html_name() ] = $form_input->get_validation_error_string();
+			}
+		}
+		return $errors;
+	}
+
+
+	/**
+	 * passes all the form data required by the JS to the JS, and enqueues the few required JS files.
+	 * Should be setup by each form during the _enqueues_and_localize_form_js
+	 *
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	public static function localize_script_for_all_forms()
+	{
+		// allow inputs and stuff to hook in their JS and stuff here
+		do_action('AHEE__EE_Form_Section_Proper__localize_script_for_all_forms__begin');
+		EE_Form_Section_Proper::$_js_localization['localized_error_messages'] = EE_Form_Section_Proper::_get_localized_error_messages();
+		$email_validation_level = isset(EE_Registry::instance()->CFG->registration->email_validation_level)
+			? EE_Registry::instance()->CFG->registration->email_validation_level
+			: 'wp_default';
+		EE_Form_Section_Proper::$_js_localization['email_validation_level']   = $email_validation_level;
+		wp_enqueue_script('ee_form_section_validation');
+		wp_localize_script(
+			'ee_form_section_validation',
+			'ee_form_section_vars',
+			EE_Form_Section_Proper::$_js_localization
+		);
+	}
+
+
+	/**
+	 * ensure_scripts_localized
+	 *
+	 * @throws EE_Error
+	 */
+	public function ensure_scripts_localized()
+	{
+		if (! EE_Form_Section_Proper::$_scripts_localized) {
+			$this->_enqueue_and_localize_form_js();
+		}
+	}
+
+
+	/**
+	 * Gets the hard-coded validation error messages to be used in the JS. The convention
+	 * is that the key here should be the same as the custom validation rule put in the JS file
+	 *
+	 * @return array keys are custom validation rules, and values are internationalized strings
+	 */
+	private static function _get_localized_error_messages()
+	{
+		return array(
+			'validUrl' => esc_html__('This is not a valid absolute URL. Eg, http://domain.com/monkey.jpg', 'event_espresso'),
+			'regex'    => esc_html__('Please check your input', 'event_espresso'),
+		);
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public static function js_localization()
+	{
+		return self::$_js_localization;
+	}
+
+
+	/**
+	 * @return void
+	 */
+	public static function reset_js_localization()
+	{
+		self::$_js_localization = array();
+	}
+
+
+	/**
+	 * Gets the JS to put inside the jquery validation rules for subsection of this form section.
+	 * See parent function for more...
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 */
+	public function get_jquery_validation_rules()
+	{
+		$jquery_validation_rules = array();
+		foreach ($this->get_validatable_subsections() as $subsection) {
+			$jquery_validation_rules = array_merge(
+				$jquery_validation_rules,
+				$subsection->get_jquery_validation_rules()
+			);
+		}
+		return $jquery_validation_rules;
+	}
+
+
+	/**
+	 * Sanitizes all the data and sets the sanitized value of each field
+	 *
+	 * @param array $req_data like $_POST
+	 * @return void
+	 * @throws EE_Error
+	 */
+	protected function _normalize($req_data)
+	{
+		$this->_received_submission = true;
+		$this->_validation_errors   = array();
+		foreach ($this->get_validatable_subsections() as $subsection) {
+			try {
+				$subsection->_normalize($req_data);
+			} catch (EE_Validation_Error $e) {
+				$subsection->add_validation_error($e);
+			}
+		}
+	}
+
+
+	/**
+	 * Performs validation on this form section and its subsections.
+	 * For each subsection,
+	 * calls _validate_{subsection_name} on THIS form (if the function exists)
+	 * and passes it the subsection, then calls _validate on that subsection.
+	 * If you need to perform validation on the form as a whole (considering multiple)
+	 * you would be best to override this _validate method,
+	 * calling parent::_validate() first.
+	 *
+	 * @throws EE_Error
+	 */
+	protected function _validate()
+	{
+		// reset the cache of whether this form is valid or not- we're re-validating it now
+		$this->is_valid = null;
+		foreach ($this->get_validatable_subsections() as $subsection_name => $subsection) {
+			if (method_exists($this, '_validate_' . $subsection_name)) {
+				call_user_func_array(array($this, '_validate_' . $subsection_name), array($subsection));
+			}
+			$subsection->_validate();
+		}
+	}
+
+
+	/**
+	 * Gets all the validated inputs for the form section
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 */
+	public function valid_data()
+	{
+		$inputs = array();
+		foreach ($this->subsections() as $subsection_name => $subsection) {
+			if ($subsection instanceof EE_Form_Section_Proper) {
+				$inputs[ $subsection_name ] = $subsection->valid_data();
+			} elseif ($subsection instanceof EE_Form_Input_Base) {
+				$inputs[ $subsection_name ] = $subsection->normalized_value();
+			}
+		}
+		return $inputs;
+	}
+
+
+	/**
+	 * Gets all the inputs on this form section
+	 *
+	 * @return EE_Form_Input_Base[]
+	 * @throws EE_Error
+	 */
+	public function inputs()
+	{
+		$inputs = array();
+		foreach ($this->subsections() as $subsection_name => $subsection) {
+			if ($subsection instanceof EE_Form_Input_Base) {
+				$inputs[ $subsection_name ] = $subsection;
+			}
+		}
+		return $inputs;
+	}
+
+
+	/**
+	 * Gets all the subsections which are a proper form
+	 *
+	 * @return EE_Form_Section_Proper[]
+	 * @throws EE_Error
+	 */
+	public function subforms()
+	{
+		$form_sections = array();
+		foreach ($this->subsections() as $name => $obj) {
+			if ($obj instanceof EE_Form_Section_Proper) {
+				$form_sections[ $name ] = $obj;
+			}
+		}
+		return $form_sections;
+	}
+
+
+	/**
+	 * Gets all the subsections (inputs, proper subsections, or html-only sections).
+	 * Consider using inputs() or subforms()
+	 * if you only want form inputs or proper form sections.
+	 *
+	 * @param boolean $require_construction_to_be_finalized most client code should
+	 *                                                      leave this as TRUE so that the inputs will be properly
+	 *                                                      configured. However, some client code may be ok with
+	 *                                                      construction finalize being called later
+	 *                                                      (realizing that the subsections' html names might not be
+	 *                                                      set yet, etc.)
+	 * @return EE_Form_Section_Proper[]
+	 * @throws EE_Error
+	 */
+	public function subsections($require_construction_to_be_finalized = true)
+	{
+		if ($require_construction_to_be_finalized) {
+			$this->ensure_construct_finalized_called();
+		}
+		return $this->_subsections;
+	}
+
+
+	/**
+	 * Returns whether this form has any subforms or inputs
+	 * @return bool
+	 */
+	public function hasSubsections()
+	{
+		return ! empty($this->_subsections);
+	}
+
+
+	/**
+	 * Returns a simple array where keys are input names, and values are their normalized
+	 * values. (Similar to calling get_input_value on inputs)
+	 *
+	 * @param boolean $include_subform_inputs Whether to include inputs from subforms,
+	 *                                        or just this forms' direct children inputs
+	 * @param boolean $flatten                Whether to force the results into 1-dimensional array,
+	 *                                        or allow multidimensional array
+	 * @return array if $flatten is TRUE it will always be a 1-dimensional array
+	 *                                        with array keys being input names
+	 *                                        (regardless of whether they are from a subsection or not),
+	 *                                        and if $flatten is FALSE it can be a multidimensional array
+	 *                                        where keys are always subsection names and values are either
+	 *                                        the input's normalized value, or an array like the top-level array
+	 * @throws EE_Error
+	 */
+	public function input_values($include_subform_inputs = false, $flatten = false)
+	{
+		return $this->_input_values(false, $include_subform_inputs, $flatten);
+	}
+
+
+	/**
+	 * Similar to EE_Form_Section_Proper::input_values(), except this returns the 'display_value'
+	 * of each input. On some inputs (especially radio boxes or checkboxes), the value stored
+	 * is not necessarily the value we want to display to users. This creates an array
+	 * where keys are the input names, and values are their display values
+	 *
+	 * @param boolean $include_subform_inputs Whether to include inputs from subforms,
+	 *                                        or just this forms' direct children inputs
+	 * @param boolean $flatten                Whether to force the results into 1-dimensional array,
+	 *                                        or allow multidimensional array
+	 * @return array if $flatten is TRUE it will always be a 1-dimensional array
+	 *                                        with array keys being input names
+	 *                                        (regardless of whether they are from a subsection or not),
+	 *                                        and if $flatten is FALSE it can be a multidimensional array
+	 *                                        where keys are always subsection names and values are either
+	 *                                        the input's normalized value, or an array like the top-level array
+	 * @throws EE_Error
+	 */
+	public function input_pretty_values($include_subform_inputs = false, $flatten = false)
+	{
+		return $this->_input_values(true, $include_subform_inputs, $flatten);
+	}
+
+
+	/**
+	 * Gets the input values from the form
+	 *
+	 * @param boolean $pretty                 Whether to retrieve the pretty value,
+	 *                                        or just the normalized value
+	 * @param boolean $include_subform_inputs Whether to include inputs from subforms,
+	 *                                        or just this forms' direct children inputs
+	 * @param boolean $flatten                Whether to force the results into 1-dimensional array,
+	 *                                        or allow multidimensional array
+	 * @return array if $flatten is TRUE it will always be a 1-dimensional array with array keys being
+	 *                                        input names (regardless of whether they are from a subsection or not),
+	 *                                        and if $flatten is FALSE it can be a multidimensional array
+	 *                                        where keys are always subsection names and values are either
+	 *                                        the input's normalized value, or an array like the top-level array
+	 * @throws EE_Error
+	 */
+	public function _input_values($pretty = false, $include_subform_inputs = false, $flatten = false)
+	{
+		$input_values = array();
+		foreach ($this->subsections() as $subsection_name => $subsection) {
+			if ($subsection instanceof EE_Form_Input_Base) {
+				$input_values[ $subsection_name ] = $pretty
+					? $subsection->pretty_value()
+					: $subsection->normalized_value();
+			} elseif ($subsection instanceof EE_Form_Section_Proper && $include_subform_inputs) {
+				$subform_input_values = $subsection->_input_values(
+					$pretty,
+					$include_subform_inputs,
+					$flatten
+				);
+				if ($flatten) {
+					$input_values = array_merge($input_values, $subform_input_values);
+				} else {
+					$input_values[ $subsection_name ] = $subform_input_values;
+				}
+			}
+		}
+		return $input_values;
+	}
+
+
+	/**
+	 * Gets the originally submitted input values from the form
+	 *
+	 * @param boolean $include_subforms  Whether to include inputs from subforms,
+	 *                                   or just this forms' direct children inputs
+	 * @return array                     if $flatten is TRUE it will always be a 1-dimensional array
+	 *                                   with array keys being input names
+	 *                                   (regardless of whether they are from a subsection or not),
+	 *                                   and if $flatten is FALSE it can be a multidimensional array
+	 *                                   where keys are always subsection names and values are either
+	 *                                   the input's normalized value, or an array like the top-level array
+	 * @throws EE_Error
+	 */
+	public function submitted_values($include_subforms = false)
+	{
+		$submitted_values = array();
+		foreach ($this->subsections() as $subsection) {
+			if ($subsection instanceof EE_Form_Input_Base) {
+				// is this input part of an array of inputs?
+				if (strpos($subsection->html_name(), '[') !== false) {
+					$full_input_name  = EEH_Array::convert_array_values_to_keys(
+						explode(
+							'[',
+							str_replace(']', '', $subsection->html_name())
+						),
+						$subsection->raw_value()
+					);
+					$submitted_values = array_replace_recursive($submitted_values, $full_input_name);
+				} else {
+					$submitted_values[ $subsection->html_name() ] = $subsection->raw_value();
+				}
+			} elseif ($subsection instanceof EE_Form_Section_Proper && $include_subforms) {
+				$subform_input_values = $subsection->submitted_values($include_subforms);
+				$submitted_values     = array_replace_recursive($submitted_values, $subform_input_values);
+			}
+		}
+		return $submitted_values;
+	}
+
+
+	/**
+	 * Indicates whether or not this form has received a submission yet
+	 * (ie, had receive_form_submission called on it yet)
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 */
+	public function has_received_submission()
+	{
+		$this->ensure_construct_finalized_called();
+		return $this->_received_submission;
+	}
+
+
+	/**
+	 * Equivalent to passing 'exclude' in the constructor's options array.
+	 * Removes the listed inputs from the form
+	 *
+	 * @param array $inputs_to_exclude values are the input names
+	 * @return void
+	 */
+	public function exclude(array $inputs_to_exclude = array())
+	{
+		foreach ($inputs_to_exclude as $input_to_exclude_name) {
+			unset($this->_subsections[ $input_to_exclude_name ]);
+		}
+	}
+
+
+	/**
+	 * Changes these inputs' display strategy to be EE_Hidden_Display_Strategy.
+	 * @param array $inputs_to_hide
+	 * @throws EE_Error
+	 */
+	public function hide(array $inputs_to_hide = array())
+	{
+		foreach ($inputs_to_hide as $input_to_hide) {
+			$input = $this->get_input($input_to_hide);
+			$input->set_display_strategy(new EE_Hidden_Display_Strategy());
+		}
+	}
+
+
+	/**
+	 * add_subsections
+	 * Adds the listed subsections to the form section.
+	 * If $subsection_name_to_target is provided,
+	 * then new subsections are added before or after that subsection,
+	 * otherwise to the start or end of the entire subsections array.
+	 *
+	 * @param EE_Form_Section_Base[] $new_subsections           array of new form subsections
+	 *                                                          where keys are their names
+	 * @param string                 $subsection_name_to_target an existing for section that $new_subsections
+	 *                                                          should be added before or after
+	 *                                                          IF $subsection_name_to_target is null,
+	 *                                                          then $new_subsections will be added to
+	 *                                                          the beginning or end of the entire subsections array
+	 * @param boolean                $add_before                whether to add $new_subsections, before or after
+	 *                                                          $subsection_name_to_target,
+	 *                                                          or if $subsection_name_to_target is null,
+	 *                                                          before or after entire subsections array
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function add_subsections($new_subsections, $subsection_name_to_target = null, $add_before = true)
+	{
+		foreach ($new_subsections as $subsection_name => $subsection) {
+			if (! $subsection instanceof EE_Form_Section_Base) {
+				EE_Error::add_error(
+					sprintf(
+						esc_html__(
+							"Trying to add a %s as a subsection (it was named '%s') to the form section '%s'. It was removed.",
+							'event_espresso'
+						),
+						get_class($subsection),
+						$subsection_name,
+						$this->name()
+					)
+				);
+				unset($new_subsections[ $subsection_name ]);
+			}
+		}
+		$this->_subsections = EEH_Array::insert_into_array(
+			$this->_subsections,
+			$new_subsections,
+			$subsection_name_to_target,
+			$add_before
+		);
+		if ($this->_construction_finalized) {
+			foreach ($this->_subsections as $name => $subsection) {
+				$subsection->_construct_finalize($this, $name);
+			}
+		}
+	}
+
+
+	/**
+	 * @param string $subsection_name
+	 * @param bool   $recursive
+	 * @return bool
+	 */
+	public function has_subsection($subsection_name, $recursive = false)
+	{
+		foreach ($this->_subsections as $name => $subsection) {
+			if ($name === $subsection_name
+				|| (
+					$recursive
+					&& $subsection instanceof EE_Form_Section_Proper
+					&& $subsection->has_subsection($subsection_name, $recursive)
+				)
+			) {
+				return true;
+			}
+		}
+		return false;
+	}
+
+
+
+	/**
+	 * Just gets all validatable subsections to clean their sensitive data
+	 *
+	 * @throws EE_Error
+	 */
+	public function clean_sensitive_data()
+	{
+		foreach ($this->get_validatable_subsections() as $subsection) {
+			$subsection->clean_sensitive_data();
+		}
+	}
+
+
+	/**
+	 * Sets the submission error message (aka validation error message for this form section and all sub-sections)
+	 * @param string                           $form_submission_error_message
+	 * @param EE_Form_Section_Validatable $form_section unused
+	 * @throws EE_Error
+	 */
+	public function set_submission_error_message(
+		$form_submission_error_message = ''
+	) {
+		$this->_form_submission_error_message = ! empty($form_submission_error_message)
+			? $form_submission_error_message
+			: $this->getAllValidationErrorsString();
+	}
+
+
+	/**
+	 * Returns the cached error message. A default value is set for this during _validate(),
+	 * (called during receive_form_submission) but it can be explicitly set using
+	 * set_submission_error_message
+	 *
+	 * @return string
+	 */
+	public function submission_error_message()
+	{
+		return $this->_form_submission_error_message;
+	}
+
+
+	/**
+	 * Sets a message to display if the data submitted to the form was valid.
+	 * @param string $form_submission_success_message
+	 */
+	public function set_submission_success_message($form_submission_success_message = '')
+	{
+		$this->_form_submission_success_message = ! empty($form_submission_success_message)
+			? $form_submission_success_message
+			: esc_html__('Form submitted successfully', 'event_espresso');
+	}
+
+
+	/**
+	 * Gets a message appropriate for display when the form is correctly submitted
+	 * @return string
+	 */
+	public function submission_success_message()
+	{
+		return $this->_form_submission_success_message;
+	}
+
+
+	/**
+	 * Returns the prefix that should be used on child of this form section for
+	 * their html names. If this form section itself has a parent, prepends ITS
+	 * prefix onto this form section's prefix. Used primarily by
+	 * EE_Form_Input_Base::_set_default_html_name_if_empty
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function html_name_prefix()
+	{
+		if ($this->parent_section() instanceof EE_Form_Section_Proper) {
+			return $this->parent_section()->html_name_prefix() . '[' . $this->name() . ']';
+		}
+		return $this->name();
+	}
+
+
+	/**
+	 * Gets the name, but first checks _construct_finalize has been called. If not,
+	 * calls it (assumes there is no parent and that we want the name to be whatever
+	 * was set, which is probably nothing, or the classname)
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function name()
+	{
+		$this->ensure_construct_finalized_called();
+		return parent::name();
+	}
+
+
+	/**
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 */
+	public function parent_section()
+	{
+		$this->ensure_construct_finalized_called();
+		return parent::parent_section();
+	}
+
+
+	/**
+	 * make sure construction finalized was called, otherwise children might not be ready
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function ensure_construct_finalized_called()
+	{
+		if (! $this->_construction_finalized) {
+			$this->_construct_finalize($this->_parent_section, $this->_name);
+		}
+	}
+
+
+	/**
+	 * Checks if any of this form section's inputs, or any of its children's inputs,
+	 * are in teh form data. If any are found, returns true. Else false
+	 *
+	 * @param array $req_data
+	 * @return boolean
+	 * @throws EE_Error
+	 */
+	public function form_data_present_in($req_data = null)
+	{
+		$req_data = $this->getCachedRequest($req_data);
+		foreach ($this->subsections() as $subsection) {
+			if ($subsection instanceof EE_Form_Input_Base) {
+				if ($subsection->form_data_present_in($req_data)) {
+					return true;
+				}
+			} elseif ($subsection instanceof EE_Form_Section_Proper) {
+				if ($subsection->form_data_present_in($req_data)) {
+					return true;
+				}
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 * Gets validation errors for this form section and subsections
+	 * Similar to EE_Form_Section_Validatable::get_validation_errors() except this
+	 * gets the validation errors for ALL subsection
+	 *
+	 * @return EE_Validation_Error[]
+	 * @throws EE_Error
+	 */
+	public function get_validation_errors_accumulated()
+	{
+		$validation_errors = $this->get_validation_errors();
+		foreach ($this->get_validatable_subsections() as $subsection) {
+			if ($subsection instanceof EE_Form_Section_Proper) {
+				$validation_errors_on_this_subsection = $subsection->get_validation_errors_accumulated();
+			} else {
+				$validation_errors_on_this_subsection = $subsection->get_validation_errors();
+			}
+			if ($validation_errors_on_this_subsection) {
+				$validation_errors = array_merge($validation_errors, $validation_errors_on_this_subsection);
+			}
+		}
+		return $validation_errors;
+	}
+
+	/**
+	 * Fetch validation errors from children and grandchildren and puts them in a single string.
+	 * This traverses the form section tree to generate this, but you probably want to instead use
+	 * get_form_submission_error_message() which is usually this message cached (or a custom validation error message)
+	 *
+	 * @return string
+	 * @since 4.9.59.p
+	 */
+	protected function getAllValidationErrorsString()
+	{
+		$submission_error_messages = array();
+		// bad, bad, bad registrant
+		foreach ($this->get_validation_errors_accumulated() as $validation_error) {
+			if ($validation_error instanceof EE_Validation_Error) {
+				$form_section = $validation_error->get_form_section();
+				if ($form_section instanceof EE_Form_Input_Base) {
+					$label = $validation_error->get_form_section()->html_label_text();
+				} elseif ($form_section instanceof EE_Form_Section_Validatable) {
+					$label = $validation_error->get_form_section()->name();
+				} else {
+					$label = esc_html__('Unknown', 'event_espresso');
+				}
+				$submission_error_messages[] = sprintf(
+					__('%s : %s', 'event_espresso'),
+					$label,
+					$validation_error->getMessage()
+				);
+			}
+		}
+		return implode('<br', $submission_error_messages);
+	}
+
+
+	/**
+	 * This isn't just the name of an input, it's a path pointing to an input. The
+	 * path is similar to a folder path: slash (/) means to descend into a subsection,
+	 * dot-dot-slash (../) means to ascend into the parent section.
+	 * After a series of slashes and dot-dot-slashes, there should be the name of an input,
+	 * which will be returned.
+	 * Eg, if you want the related input to be conditional on a sibling input name 'foobar'
+	 * just use 'foobar'. If you want it to be conditional on an aunt/uncle input name
+	 * 'baz', use '../baz'. If you want it to be conditional on a cousin input,
+	 * the child of 'baz_section' named 'baz_child', use '../baz_section/baz_child'.
+	 * Etc
+	 *
+	 * @param string|false $form_section_path we accept false also because substr( '../', '../' ) = false
+	 * @return EE_Form_Section_Base
+	 * @throws EE_Error
+	 */
+	public function find_section_from_path($form_section_path)
+	{
+		// check if we can find the input from purely going straight up the tree
+		$input = parent::find_section_from_path($form_section_path);
+		if ($input instanceof EE_Form_Section_Base) {
+			return $input;
+		}
+		$next_slash_pos = strpos($form_section_path, '/');
+		if ($next_slash_pos !== false) {
+			$child_section_name = substr($form_section_path, 0, $next_slash_pos);
+			$subpath            = substr($form_section_path, $next_slash_pos + 1);
+		} else {
+			$child_section_name = $form_section_path;
+			$subpath            = '';
+		}
+		$child_section = $this->get_subsection($child_section_name);
+		if ($child_section instanceof EE_Form_Section_Base) {
+			return $child_section->find_section_from_path($subpath);
+		}
+		return null;
+	}
 }

Spacing +38 added lines, -38 removed lines

@@ -111,8 +111,8 @@ 
             // AND we are going to make sure they're in that specified order
             $reordered_subsections = array();
             foreach ($options_array['include'] as $input_name) {
-                if (isset($this->_subsections[ $input_name ])) {
-                    $reordered_subsections[ $input_name ] = $this->_subsections[ $input_name ];
+                if (isset($this->_subsections[$input_name])) {
+                    $reordered_subsections[$input_name] = $this->_subsections[$input_name];
                 }
             }
             $this->_subsections = $reordered_subsections;
@@ -124,7 +124,7 @@ 
         if (isset($options_array['layout_strategy'])) {
             $this->_layout_strategy = $options_array['layout_strategy'];
         }
-        if (! $this->_layout_strategy) {
+        if ( ! $this->_layout_strategy) {
             $this->_layout_strategy = is_admin() ? new EE_Admin_Two_Column_Layout() : new EE_Two_Column_Layout();
         }
         $this->_layout_strategy->_construct_finalize($this);
@@ -313,7 +313,7 @@ 
         if ($validate) {
             $this->_validate();
             // if it's invalid, we're going to want to re-display so remember what they submitted
-            if (! $this->is_valid()) {
+            if ( ! $this->is_valid()) {
                 $this->store_submitted_form_data_in_session();
             }
         }
@@ -426,11 +426,11 @@ 
     public function populate_defaults($default_data)
     {
         foreach ($this->subsections(false) as $subsection_name => $subsection) {
-            if (isset($default_data[ $subsection_name ])) {
+            if (isset($default_data[$subsection_name])) {
                 if ($subsection instanceof EE_Form_Input_Base) {
-                    $subsection->set_default($default_data[ $subsection_name ]);
+                    $subsection->set_default($default_data[$subsection_name]);
                 } elseif ($subsection instanceof EE_Form_Section_Proper) {
-                    $subsection->populate_defaults($default_data[ $subsection_name ]);
+                    $subsection->populate_defaults($default_data[$subsection_name]);
                 }
             }
         }
@@ -445,7 +445,7 @@ 
      */
     public function subsection_exists($name)
     {
-        return isset($this->_subsections[ $name ]) ? true : false;
+        return isset($this->_subsections[$name]) ? true : false;
     }
 
 
@@ -467,7 +467,7 @@ 
         if ($require_construction_to_be_finalized) {
             $this->ensure_construct_finalized_called();
         }
-        return $this->subsection_exists($name) ? $this->_subsections[ $name ] : null;
+        return $this->subsection_exists($name) ? $this->_subsections[$name] : null;
     }
 
 
@@ -482,7 +482,7 @@ 
         $validatable_subsections = array();
         foreach ($this->subsections() as $name => $obj) {
             if ($obj instanceof EE_Form_Section_Validatable) {
-                $validatable_subsections[ $name ] = $obj;
+                $validatable_subsections[$name] = $obj;
             }
         }
         return $validatable_subsections;
@@ -509,7 +509,7 @@ 
             $name,
             $require_construction_to_be_finalized
         );
-        if (! $subsection instanceof EE_Form_Input_Base) {
+        if ( ! $subsection instanceof EE_Form_Input_Base) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -546,7 +546,7 @@ 
             $name,
             $require_construction_to_be_finalized
         );
-        if (! $subsection instanceof EE_Form_Section_Proper) {
+        if ( ! $subsection instanceof EE_Form_Section_Proper) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -586,7 +586,7 @@ 
     public function is_valid()
     {
         if ($this->is_valid === null) {
-            if (! $this->has_received_submission()) {
+            if ( ! $this->has_received_submission()) {
                 throw new EE_Error(
                     sprintf(
                         esc_html__(
@@ -596,14 +596,14 @@ 
                     )
                 );
             }
-            if (! parent::is_valid()) {
+            if ( ! parent::is_valid()) {
                 $this->is_valid = false;
             } else {
                 // ok so no general errors to this entire form section.
                 // so let's check the subsections, but only set errors if that hasn't been done yet
                 $this->is_valid = true;
                 foreach ($this->get_validatable_subsections() as $subsection) {
-                    if (! $subsection->is_valid()) {
+                    if ( ! $subsection->is_valid()) {
                         $this->is_valid = false;
                     }
                 }
@@ -620,7 +620,7 @@ 
      */
     protected function _set_default_name_if_empty()
     {
-        if (! $this->_name) {
+        if ( ! $this->_name) {
             $classname    = get_class($this);
             $default_name = str_replace('EE_', '', $classname);
             $this->_name  = $default_name;
@@ -710,7 +710,7 @@ 
     {
         wp_register_script(
             'ee_form_section_validation',
-            EE_GLOBAL_ASSETS_URL . 'scripts' . '/form_section_validation.js',
+            EE_GLOBAL_ASSETS_URL.'scripts'.'/form_section_validation.js',
             array('jquery-validate', 'jquery-ui-datepicker', 'jquery-validate-extra-methods'),
             EVENT_ESPRESSO_VERSION,
             true
@@ -754,13 +754,13 @@ 
         // we only want to localize vars ONCE for the entire form,
         // so if the form section doesn't have a parent, then it must be the top dog
         if ($return_for_subsection || ! $this->parent_section()) {
-            EE_Form_Section_Proper::$_js_localization['form_data'][ $this->html_id() ] = array(
+            EE_Form_Section_Proper::$_js_localization['form_data'][$this->html_id()] = array(
                 'form_section_id'  => $this->html_id(true),
                 'validation_rules' => $this->get_jquery_validation_rules(),
                 'other_data'       => $this->get_other_js_data(),
                 'errors'           => $this->subsection_validation_errors_by_html_name(),
             );
-            EE_Form_Section_Proper::$_scripts_localized                                = true;
+            EE_Form_Section_Proper::$_scripts_localized = true;
         }
     }
 
@@ -795,7 +795,7 @@ 
         $inputs = array();
         foreach ($this->subsections() as $subsection) {
             if ($subsection instanceof EE_Form_Input_Base) {
-                $inputs[ $subsection->html_name() ] = $subsection;
+                $inputs[$subsection->html_name()] = $subsection;
             } elseif ($subsection instanceof EE_Form_Section_Proper) {
                 $inputs += $subsection->inputs_in_subsections();
             }
@@ -818,7 +818,7 @@ 
         $errors = array();
         foreach ($inputs as $form_input) {
             if ($form_input instanceof EE_Form_Input_Base && $form_input->get_validation_errors()) {
-                $errors[ $form_input->html_name() ] = $form_input->get_validation_error_string();
+                $errors[$form_input->html_name()] = $form_input->get_validation_error_string();
             }
         }
         return $errors;
@@ -841,7 +841,7 @@ 
         $email_validation_level = isset(EE_Registry::instance()->CFG->registration->email_validation_level)
             ? EE_Registry::instance()->CFG->registration->email_validation_level
             : 'wp_default';
-        EE_Form_Section_Proper::$_js_localization['email_validation_level']   = $email_validation_level;
+        EE_Form_Section_Proper::$_js_localization['email_validation_level'] = $email_validation_level;
         wp_enqueue_script('ee_form_section_validation');
         wp_localize_script(
             'ee_form_section_validation',
@@ -858,7 +858,7 @@ 
      */
     public function ensure_scripts_localized()
     {
-        if (! EE_Form_Section_Proper::$_scripts_localized) {
+        if ( ! EE_Form_Section_Proper::$_scripts_localized) {
             $this->_enqueue_and_localize_form_js();
         }
     }
@@ -954,8 +954,8 @@ 
         // reset the cache of whether this form is valid or not- we're re-validating it now
         $this->is_valid = null;
         foreach ($this->get_validatable_subsections() as $subsection_name => $subsection) {
-            if (method_exists($this, '_validate_' . $subsection_name)) {
-                call_user_func_array(array($this, '_validate_' . $subsection_name), array($subsection));
+            if (method_exists($this, '_validate_'.$subsection_name)) {
+                call_user_func_array(array($this, '_validate_'.$subsection_name), array($subsection));
             }
             $subsection->_validate();
         }
@@ -973,9 +973,9 @@ 
         $inputs = array();
         foreach ($this->subsections() as $subsection_name => $subsection) {
             if ($subsection instanceof EE_Form_Section_Proper) {
-                $inputs[ $subsection_name ] = $subsection->valid_data();
+                $inputs[$subsection_name] = $subsection->valid_data();
             } elseif ($subsection instanceof EE_Form_Input_Base) {
-                $inputs[ $subsection_name ] = $subsection->normalized_value();
+                $inputs[$subsection_name] = $subsection->normalized_value();
             }
         }
         return $inputs;
@@ -993,7 +993,7 @@ 
         $inputs = array();
         foreach ($this->subsections() as $subsection_name => $subsection) {
             if ($subsection instanceof EE_Form_Input_Base) {
-                $inputs[ $subsection_name ] = $subsection;
+                $inputs[$subsection_name] = $subsection;
             }
         }
         return $inputs;
@@ -1011,7 +1011,7 @@ 
         $form_sections = array();
         foreach ($this->subsections() as $name => $obj) {
             if ($obj instanceof EE_Form_Section_Proper) {
-                $form_sections[ $name ] = $obj;
+                $form_sections[$name] = $obj;
             }
         }
         return $form_sections;
@@ -1118,7 +1118,7 @@ 
         $input_values = array();
         foreach ($this->subsections() as $subsection_name => $subsection) {
             if ($subsection instanceof EE_Form_Input_Base) {
-                $input_values[ $subsection_name ] = $pretty
+                $input_values[$subsection_name] = $pretty
                     ? $subsection->pretty_value()
                     : $subsection->normalized_value();
             } elseif ($subsection instanceof EE_Form_Section_Proper && $include_subform_inputs) {
@@ -1130,7 +1130,7 @@ 
                 if ($flatten) {
                     $input_values = array_merge($input_values, $subform_input_values);
                 } else {
-                    $input_values[ $subsection_name ] = $subform_input_values;
+                    $input_values[$subsection_name] = $subform_input_values;
                 }
             }
         }
@@ -1158,7 +1158,7 @@ 
             if ($subsection instanceof EE_Form_Input_Base) {
                 // is this input part of an array of inputs?
                 if (strpos($subsection->html_name(), '[') !== false) {
-                    $full_input_name  = EEH_Array::convert_array_values_to_keys(
+                    $full_input_name = EEH_Array::convert_array_values_to_keys(
                         explode(
                             '[',
                             str_replace(']', '', $subsection->html_name())
@@ -1167,7 +1167,7 @@ 
                     );
                     $submitted_values = array_replace_recursive($submitted_values, $full_input_name);
                 } else {
-                    $submitted_values[ $subsection->html_name() ] = $subsection->raw_value();
+                    $submitted_values[$subsection->html_name()] = $subsection->raw_value();
                 }
             } elseif ($subsection instanceof EE_Form_Section_Proper && $include_subforms) {
                 $subform_input_values = $subsection->submitted_values($include_subforms);
@@ -1202,7 +1202,7 @@ 
     public function exclude(array $inputs_to_exclude = array())
     {
         foreach ($inputs_to_exclude as $input_to_exclude_name) {
-            unset($this->_subsections[ $input_to_exclude_name ]);
+            unset($this->_subsections[$input_to_exclude_name]);
         }
     }
 
@@ -1245,7 +1245,7 @@ 
     public function add_subsections($new_subsections, $subsection_name_to_target = null, $add_before = true)
     {
         foreach ($new_subsections as $subsection_name => $subsection) {
-            if (! $subsection instanceof EE_Form_Section_Base) {
+            if ( ! $subsection instanceof EE_Form_Section_Base) {
                 EE_Error::add_error(
                     sprintf(
                         esc_html__(
@@ -1257,7 +1257,7 @@ 
                         $this->name()
                     )
                 );
-                unset($new_subsections[ $subsection_name ]);
+                unset($new_subsections[$subsection_name]);
             }
         }
         $this->_subsections = EEH_Array::insert_into_array(
@@ -1372,7 +1372,7 @@ 
     public function html_name_prefix()
     {
         if ($this->parent_section() instanceof EE_Form_Section_Proper) {
-            return $this->parent_section()->html_name_prefix() . '[' . $this->name() . ']';
+            return $this->parent_section()->html_name_prefix().'['.$this->name().']';
         }
         return $this->name();
     }
@@ -1412,7 +1412,7 @@ 
      */
     public function ensure_construct_finalized_called()
     {
-        if (! $this->_construction_finalized) {
+        if ( ! $this->_construction_finalized) {
             $this->_construct_finalize($this->_parent_section, $this->_name);
         }
     }