eventespresso / event-espresso-core

core/EE_Registry.core.php

Indentation +1716 added lines, -1716 removed lines

@@ -22,1720 +22,1720 @@
  */
 class EE_Registry implements ResettableInterface
 {
-    /**
-     * @var EE_Registry $_instance
-     */
-    private static $_instance;
-
-    /**
-     * @var EE_Dependency_Map $_dependency_map
-     */
-    protected $_dependency_map;
-
-    /**
-     * @var Mirror
-     */
-    private $mirror;
-
-    /**
-     * @var ClassInterfaceCache $class_cache
-     */
-    private $class_cache;
-
-    /**
-     * @var array $_class_abbreviations
-     */
-    protected $_class_abbreviations = [];
-
-    /**
-     * @var CommandBusInterface $BUS
-     */
-    public $BUS;
-
-    /**
-     * @var EE_Cart $CART
-     */
-    public $CART;
-
-    /**
-     * @var EE_Config $CFG
-     */
-    public $CFG;
-
-    /**
-     * @var EE_Network_Config $NET_CFG
-     */
-    public $NET_CFG;
-
-    /**
-     * RegistryContainer for storing library classes in
-     *
-     * @var RegistryContainer $LIB
-     */
-    public $LIB;
-
-    /**
-     * @var EE_Request_Handler $REQ
-     * @deprecated 4.10.14.p
-     */
-    public $REQ;
-
-    /**
-     * @var EE_Session $SSN
-     */
-    public $SSN;
-
-    /**
-     * @since 4.5.0
-     * @var EE_Capabilities $CAP
-     */
-    public $CAP;
-
-    /**
-     * @since 4.9.0
-     * @var EE_Message_Resource_Manager $MRM
-     */
-    public $MRM;
-
-    /**
-     * @var Registry $AssetsRegistry
-     */
-    public $AssetsRegistry;
-
-    /**
-     * RegistryContainer for holding addons which have registered themselves to work with EE core
-     *
-     * @var RegistryContainer|EE_Addon[] $addons
-     */
-    public $addons;
-
-    /**
-     * keys are 'short names' (eg Event), values are class names (eg 'EEM_Event')
-     *
-     * @var EEM_Base[] $models
-     */
-    public $models = [];
-
-    /**
-     * @var RegistryContainer|EED_Module[] $modules
-     */
-    public $modules;
-
-    /**
-     * @var RegistryContainer|EES_Shortcode[] $shortcodes
-     */
-    public $shortcodes;
-
-    /**
-     * @var RegistryContainer|WP_Widget[] $widgets
-     */
-    public $widgets;
-
-    /**
-     * this is an array of all implemented model names (i.e. not the parent abstract models, or models
-     * which don't actually fetch items from the DB in the normal way (ie, are not children of EEM_Base)).
-     * Keys are model "short names" (eg "Event") as used in model relations, and values are
-     * classnames (eg "EEM_Event")
-     *
-     * @var array $non_abstract_db_models
-     */
-    public $non_abstract_db_models = [];
-
-    /**
-     * internationalization for JS strings
-     *    usage:   EE_Registry::i18n_js_strings['string_key'] = esc_html__( 'string to translate.', 'event_espresso' );
-     *    in js file:  var translatedString = eei18n.string_key;
-     *
-     * @var array $i18n_js_strings
-     */
-    public static $i18n_js_strings = [];
-
-    /**
-     * $main_file - path to espresso.php
-     *
-     * @var array $main_file
-     */
-    public $main_file;
-
-    /**
-     * array of ReflectionClass objects where the key is the class name
-     *
-     * @deprecated 4.9.62.p
-     * @var ReflectionClass[] $_reflectors
-     */
-    public $_reflectors;
-
-    /**
-     * boolean flag to indicate whether or not to load/save dependencies from/to the cache
-     *
-     * @var boolean $_cache_on
-     */
-    protected $_cache_on = true;
-
-    /**
-     * @var ObjectIdentifier
-     */
-    private $object_identifier;
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @param EE_Dependency_Map|null   $dependency_map
-     * @param Mirror|null              $mirror
-     * @param ClassInterfaceCache|null $class_cache
-     * @param ObjectIdentifier|null    $object_identifier
-     * @return EE_Registry instance
-     */
-    public static function instance(
-        EE_Dependency_Map $dependency_map = null,
-        Mirror $mirror = null,
-        ClassInterfaceCache $class_cache = null,
-        ObjectIdentifier $object_identifier = null
-    ): EE_Registry {
-        // check if class object is instantiated
-        if (
-            ! self::$_instance instanceof EE_Registry
-            && $dependency_map instanceof EE_Dependency_Map
-            && $mirror instanceof Mirror
-            && $class_cache instanceof ClassInterfaceCache
-            && $object_identifier instanceof ObjectIdentifier
-        ) {
-            self::$_instance = new self(
-                $dependency_map,
-                $mirror,
-                $class_cache,
-                $object_identifier
-            );
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * protected constructor to prevent direct creation
-     *
-     * @Constructor
-     * @param EE_Dependency_Map   $dependency_map
-     * @param Mirror              $mirror
-     * @param ClassInterfaceCache $class_cache
-     * @param ObjectIdentifier    $object_identifier
-     */
-    protected function __construct(
-        EE_Dependency_Map $dependency_map,
-        Mirror $mirror,
-        ClassInterfaceCache $class_cache,
-        ObjectIdentifier $object_identifier
-    ) {
-        $this->_dependency_map   = $dependency_map;
-        $this->mirror            = $mirror;
-        $this->class_cache       = $class_cache;
-        $this->object_identifier = $object_identifier;
-        // $registry_container = new RegistryContainer();
-        $this->LIB        = new RegistryContainer();
-        $this->addons     = new RegistryContainer();
-        $this->modules    = new RegistryContainer();
-        $this->shortcodes = new RegistryContainer();
-        $this->widgets    = new RegistryContainer();
-        add_action('EE_Load_Espresso_Core__handle_request__initialize_core_loading', [$this, 'initialize']);
-    }
-
-
-    /**
-     * initialize
-     *
-     * @throws OutOfBoundsException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function initialize()
-    {
-        $this->_class_abbreviations = apply_filters(
-            'FHEE__EE_Registry____construct___class_abbreviations',
-            [
-                'EE_Config'                                       => 'CFG',
-                'EE_Session'                                      => 'SSN',
-                'EE_Capabilities'                                 => 'CAP',
-                'EE_Cart'                                         => 'CART',
-                'EE_Network_Config'                               => 'NET_CFG',
-                'EE_Request_Handler'                              => 'REQ',
-                'EE_Message_Resource_Manager'                     => 'MRM',
-                'EventEspresso\core\services\commands\CommandBus' => 'BUS',
-                'EventEspresso\core\services\assets\Registry'     => 'AssetsRegistry',
-            ]
-        );
-        $this->load_core('Base', [], true);
-        // add our request and response objects to the cache
-        $request_loader = $this->_dependency_map->class_loader(
-            'EventEspresso\core\services\request\Request'
-        );
-        $this->_set_cached_class(
-            $request_loader(),
-            'EventEspresso\core\services\request\Request'
-        );
-        $response_loader = $this->_dependency_map->class_loader(
-            'EventEspresso\core\services\request\Response'
-        );
-        $this->_set_cached_class(
-            $response_loader(),
-            'EventEspresso\core\services\request\Response'
-        );
-        add_action('AHEE__EE_System__set_hooks_for_core', [$this, 'init']);
-    }
-
-
-    /**
-     * @return void
-     */
-    public function init()
-    {
-        // Get current page protocol
-        $protocol = is_ssl() ? 'https://' : 'http://';
-        // Output admin-ajax.php URL with same protocol as current page
-        self::$i18n_js_strings['ajax_url'] = admin_url('admin-ajax.php', $protocol);
-        self::$i18n_js_strings['wp_debug'] = defined('WP_DEBUG') && WP_DEBUG;
-    }
-
-
-    /**
-     * @return array
-     */
-    public static function sanitize_i18n_js_strings(): array
-    {
-        $i18n_js_strings = (array) self::$i18n_js_strings;
-        foreach ($i18n_js_strings as $key => $value) {
-            if (is_scalar($value)) {
-                $i18n_js_strings[ $key ] = html_entity_decode((string) $value, ENT_QUOTES, 'UTF-8');
-            }
-        }
-        return $i18n_js_strings;
-    }
-
-
-    /**
-     * localize_i18n_js_strings
-     *
-     * @return string
-     */
-    public static function localize_i18n_js_strings(): string
-    {
-        $i18n_js_strings = EE_Registry::sanitize_i18n_js_strings();
-        return '/* <![CDATA[ */ var eei18n = ' . wp_json_encode($i18n_js_strings) . '; /* ]]> */';
-    }
-
-
-    /**
-     * @param mixed string | EED_Module $module
-     * @throws OutOfBoundsException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function add_module($module)
-    {
-        if ($module instanceof EED_Module) {
-            $module_class = get_class($module);
-            $this->modules->add($module_class, $module);
-        } else {
-            if (! class_exists('EE_Module_Request_Router', false)) {
-                $this->load_core('Module_Request_Router');
-            }
-            EE_Module_Request_Router::module_factory($module);
-        }
-    }
-
-
-    /**
-     * @param string $module_name
-     * @return mixed EED_Module | NULL
-     */
-    public function get_module(string $module_name = '')
-    {
-        return $this->modules->get($module_name);
-    }
-
-
-    /**
-     * loads core classes - must be singletons
-     *
-     * @param string $class_name - simple class name ie: session
-     * @param mixed  $arguments
-     * @param bool   $load_only
-     * @return bool|null|object
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     */
-    public function load_core(string $class_name, $arguments = [], bool $load_only = false)
-    {
-        $core_paths = (array) apply_filters(
-            'FHEE__EE_Registry__load_core__core_paths',
-            [
-                EE_CORE,
-                EE_ADMIN,
-                EE_CPTS,
-                EE_CORE . 'CPTs/',
-                EE_CORE . 'data_migration_scripts/',
-                EE_CORE . 'request_stack/',
-                EE_CORE . 'middleware/',
-            ]
-        );
-        // retrieve instantiated class
-        return $this->_load(
-            $core_paths,
-            'EE_',
-            $class_name,
-            'core',
-            $arguments,
-            false,
-            true,
-            $load_only
-        );
-    }
-
-
-    /**
-     * loads service classes
-     *
-     * @param string $class_name - simple class name ie: session
-     * @param mixed  $arguments
-     * @param bool   $load_only
-     * @return bool|null|object
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @deprecated  4.10.33.p
-     */
-    public function load_service(string $class_name, $arguments = [], bool $load_only = false)
-    {
-        $service_paths = (array) apply_filters(
-            'FHEE__EE_Registry__load_service__service_paths',
-            [
-                EE_CORE . 'services/',
-            ]
-        );
-        // retrieve instantiated class
-        return $this->_load(
-            $service_paths,
-            'EE_',
-            $class_name,
-            'class',
-            $arguments,
-            false,
-            true,
-            $load_only
-        );
-    }
-
-
-    /**
-     * loads data_migration_scripts
-     *
-     * @param string $class_name - class name for the DMS ie: EE_DMS_Core_4_2_0
-     * @param mixed  $arguments
-     * @return bool|null|object
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     */
-    public function load_dms(string $class_name, $arguments = [])
-    {
-        // retrieve instantiated class
-        return $this->_load(
-            EE_Data_Migration_Manager::instance()->get_data_migration_script_folders(),
-            'EE_DMS_',
-            $class_name,
-            'dms',
-            $arguments,
-            false,
-            false
-        );
-    }
-
-
-    /**
-     * loads object creating classes - must be singletons
-     *
-     * @param string $class_name - simple class name ie: attendee
-     * @param mixed  $arguments  - an array of arguments to pass to the class
-     * @param bool   $from_db    - some classes are instantiated from the db and thus call a different method to
-     *                           instantiate
-     * @param bool   $cache      if you don't want the class to be stored in the internal cache (non-persistent) then
-     *                           set this to FALSE (ie. when instantiating model objects from client in a loop)
-     * @param bool   $load_only  whether or not to just load the file and NOT instantiate, or load AND instantiate
-     *                           (default)
-     * @return bool|null|object
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     */
-    public function load_class(
-        string $class_name,
-        $arguments = [],
-        bool $from_db = false,
-        bool $cache = true,
-        bool $load_only = false
-    ) {
-        $paths = (array) apply_filters(
-            'FHEE__EE_Registry__load_class__paths',
-            [
-                EE_CORE,
-                EE_CLASSES,
-                EE_BUSINESS,
-            ]
-        );
-        // retrieve instantiated class
-        return $this->_load(
-            $paths,
-            'EE_',
-            $class_name,
-            'class',
-            $arguments,
-            $from_db,
-            $cache,
-            $load_only
-        );
-    }
-
-
-    /**
-     * loads helper classes - must be singletons
-     *
-     * @param string $class_name - simple class name ie: price
-     * @param mixed  $arguments
-     * @param bool   $load_only
-     * @return bool|null|object
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     */
-    public function load_helper(string $class_name, $arguments = [], bool $load_only = true)
-    {
-        // todo: add doing_it_wrong() in a few versions after all addons have had calls to this method removed
-        $helper_paths = (array) apply_filters('FHEE__EE_Registry__load_helper__helper_paths', [EE_HELPERS]);
-        // retrieve instantiated class
-        return $this->_load(
-            $helper_paths,
-            'EEH_',
-            $class_name,
-            'helper',
-            $arguments,
-            false,
-            true,
-            $load_only
-        );
-    }
-
-
-    /**
-     * loads core classes - must be singletons
-     *
-     * @param string $class_name - simple class name ie: session
-     * @param mixed  $arguments
-     * @param bool   $load_only
-     * @param bool   $cache      whether to cache the object or not.
-     * @return bool|null|object
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     */
-    public function load_lib(string $class_name, $arguments = [], bool $load_only = false, bool $cache = true)
-    {
-        $paths = [
-            EE_LIBRARIES,
-            EE_LIBRARIES . 'messages/',
-            EE_LIBRARIES . 'shortcodes/',
-            EE_LIBRARIES . 'qtips/',
-            EE_LIBRARIES . 'payment_methods/',
-        ];
-        // retrieve instantiated class
-        return $this->_load(
-            $paths,
-            'EE_',
-            $class_name,
-            'lib',
-            $arguments,
-            false,
-            $cache,
-            $load_only
-        );
-    }
-
-
-    /**
-     * loads model classes - must be singletons
-     *
-     * @param string $class_name - simple class name ie: price
-     * @param mixed  $arguments
-     * @param bool   $load_only
-     * @return bool|null|object
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     */
-    public function load_model(string $class_name, $arguments = [], bool $load_only = false)
-    {
-        $paths = (array) apply_filters(
-            'FHEE__EE_Registry__load_model__paths',
-            [
-                EE_MODELS,
-                EE_CORE,
-            ]
-        );
-        // retrieve instantiated class
-        return $this->_load(
-            $paths,
-            'EEM_',
-            $class_name,
-            'model',
-            $arguments,
-            false,
-            true,
-            $load_only
-        );
-    }
-
-
-    /**
-     * loads model classes - must be singletons
-     *
-     * @param string $class_name - simple class name ie: price
-     * @param mixed  $arguments
-     * @param bool   $load_only
-     * @return bool|null|object
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @deprecated  4.10.33.p
-     */
-    public function load_model_class(string $class_name, $arguments = [], bool $load_only = true)
-    {
-        $paths = [
-            EE_MODELS . 'fields/',
-            EE_MODELS . 'helpers/',
-            EE_MODELS . 'relations/',
-            EE_MODELS . 'strategies/',
-        ];
-        // retrieve instantiated class
-        return $this->_load(
-            $paths,
-            'EE_',
-            $class_name,
-            '',
-            $arguments,
-            false,
-            true,
-            $load_only
-        );
-    }
-
-
-    /**
-     * Determines if $model_name is the name of an actual EE model.
-     *
-     * @param string $model_name like Event, Attendee, Question_Group_Question, etc.
-     * @return boolean
-     */
-    public function is_model_name(string $model_name): bool
-    {
-        return isset($this->models[ $model_name ]);
-    }
-
-
-    /**
-     * generic class loader
-     *
-     * @param string $path_to_file - directory path to file location, not including filename
-     * @param string $file_name    - file name  ie:  my_file.php, including extension
-     * @param string $type         - file type - core? class? helper? model?
-     * @param mixed  $arguments
-     * @param bool   $load_only
-     * @return bool|null|object
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     */
-    public function load_file(
-        string $path_to_file,
-        string $file_name,
-        string $type = '',
-        $arguments = [],
-        bool $load_only = true
-    ) {
-        // retrieve instantiated class
-        return $this->_load(
-            (array) $path_to_file,
-            '',
-            $file_name,
-            $type,
-            $arguments,
-            false,
-            true,
-            $load_only
-        );
-    }
-
-
-    /**
-     * @param string $path_to_file - directory path to file location, not including filename
-     * @param string $class_name   - full class name  ie:  My_Class
-     * @param string $type         - file type - core? class? helper? model?
-     * @param mixed  $arguments
-     * @param bool   $load_only
-     * @return bool|null|object
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @deprecated  4.10.33.p
-     */
-    public function load_addon(
-        string $path_to_file,
-        string $class_name,
-        string $type = 'class',
-        $arguments = [],
-        bool $load_only = false
-    ) {
-        // retrieve instantiated class
-        return $this->_load(
-            (array) $path_to_file,
-            'addon',
-            $class_name,
-            $type,
-            $arguments,
-            false,
-            true,
-            $load_only
-        );
-    }
-
-
-    /**
-     * instantiates, caches, and automatically resolves dependencies
-     * for classes that use a Fully Qualified Class Name.
-     * if the class is not capable of being loaded using PSR-4 autoloading,
-     * then you need to use one of the existing load_*() methods
-     * which can resolve the classname and filepath from the passed arguments
-     *
-     * @param string      $class_name Fully Qualified Class Name
-     * @param array       $arguments  an argument, or array of arguments to pass to the class upon instantiation
-     * @param bool        $cache      whether to cache the instantiated object for reuse
-     * @param bool        $from_db    some classes are instantiated from the db
-     *                                and thus call a different method to instantiate
-     * @param bool        $load_only  if true, will only load the file, but will NOT instantiate an object
-     * @param bool|string $addon      if true, will cache the object in the EE_Registry->$addons array
-     * @return bool|null|mixed     null = failure to load or instantiate class object.
-     *                                object = class loaded and instantiated successfully.
-     *                                bool = fail or success when $load_only is true
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     */
-    public function create(
-        string $class_name = '',
-        array $arguments = [],
-        bool $cache = false,
-        bool $from_db = false,
-        bool $load_only = false,
-        bool $addon = false
-    ) {
-        $class_name   = ltrim($class_name, '\\');
-        $class_name   = $this->class_cache->getFqnForAlias($class_name);
-        $class_exists = $this->loadOrVerifyClassExists($class_name, $arguments);
-        // if a non-FQCN was passed, then
-        // verifyClassExists() might return an object
-        // or it could return null if the class just could not be found anywhere
-        if ($class_exists instanceof $class_name || $class_exists === null) {
-            // either way, return the results
-            return $class_exists;
-        }
-        $class_name = $class_exists;
-        // if we're only loading the class and it already exists, then let's just return true immediately
-        if ($load_only) {
-            return true;
-        }
-        $addon = $addon ? 'addon' : '';
-        // $this->_cache_on is toggled during the recursive loading that can occur with dependency injection
-        // $cache is controlled by individual calls to separate Registry loader methods like load_class()
-        // $load_only is also controlled by individual calls to separate Registry loader methods like load_file()
-        if ($this->_cache_on && $cache) {
-            // return object if it's already cached
-            $cached_class = $this->_get_cached_class($class_name, $addon, $arguments);
-            if ($cached_class !== null) {
-                return $cached_class;
-            }
-        }                                                           // obtain the loader method from the dependency map
-        $loader = $this->_dependency_map->class_loader($class_name);// instantiate the requested object
-        if ($loader instanceof Closure) {
-            $class_obj = $loader($arguments);
-        } else {
-            if ($loader && method_exists($this, $loader)) {
-                $class_obj = $this->{$loader}($class_name, $arguments);
-            } else {
-                $class_obj = $this->_create_object($class_name, $arguments, $addon, $from_db);
-            }
-        }
-        if (($this->_cache_on && $cache) || $this->get_class_abbreviation($class_name, '')) {
-            // save it for later... kinda like gum  { : $
-            $this->_set_cached_class(
-                $class_obj,
-                $class_name,
-                $addon,
-                $from_db,
-                $arguments
-            );
-        }
-        $this->_cache_on = true;
-        return $class_obj;
-    }
-
-
-    /**
-     * Recursively checks that a class exists and potentially attempts to load classes with non-FQCNs
-     *
-     * @param string|mixed $class_name
-     * @param array        $arguments
-     * @param int          $attempt
-     * @return mixed
-     */
-    private function loadOrVerifyClassExists($class_name, array $arguments, int $attempt = 1)
-    {
-        if (is_object($class_name) || class_exists($class_name)) {
-            return $class_name;
-        }
-        switch ($attempt) {
-            case 1:
-                // if it's a FQCN then maybe the class is registered with a preceding \
-                $class_name = strpos($class_name, '\\') !== false
-                    ? '\\' . ltrim($class_name, '\\')
-                    : $class_name;
-                break;
-            case 2:
-                //
-                $loader = $this->_dependency_map->class_loader($class_name);
-                if ($loader && method_exists($this, $loader)) {
-                    return $this->{$loader}($class_name, $arguments);
-                }
-                break;
-            case 3:
-            default:
-                return null;
-        }
-        $attempt++;
-        return $this->loadOrVerifyClassExists($class_name, $arguments, $attempt);
-    }
-
-
-    /**
-     * instantiates, caches, and injects dependencies for classes
-     *
-     * @param array  $file_paths         an array of paths to folders to look in
-     * @param string $class_prefix       EE  or EEM or... ???
-     * @param string $class_name         $class name
-     * @param string $type               file type - core? class? helper? model?
-     * @param mixed  $arguments          an argument or array of arguments to pass to the class upon instantiation
-     * @param bool   $from_db            some classes are instantiated from the db
-     *                                   and thus call a different method to instantiate
-     * @param bool   $cache              whether to cache the instantiated object for reuse
-     * @param bool   $load_only          if true, will only load the file, but will NOT instantiate an object
-     * @return bool|null|object          null   = failure to load or instantiate class object.
-     *                                   object = class loaded and instantiated successfully.
-     *                                   bool   = fail or success when $load_only is true
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws InvalidArgumentException
-     */
-    protected function _load(
-        array $file_paths = [],
-        string $class_prefix = 'EE_',
-        string $class_name = '',
-        string $type = 'class',
-        array $arguments = [],
-        bool $from_db = false,
-        bool $cache = true,
-        bool $load_only = false
-    ) {
-        $class_name = ltrim($class_name, '\\');
-        // strip php file extension
-        $class_name = str_replace('.php', '', trim($class_name));
-        // does the class have a prefix ?
-        if (! empty($class_prefix) && $class_prefix !== 'addon') {
-            // make sure $class_prefix is uppercase
-            $class_prefix = strtoupper(trim($class_prefix));
-            // add class prefix ONCE!!!
-            $class_name = $class_prefix . str_replace($class_prefix, '', $class_name);
-        }
-        $class_name   = $this->class_cache->getFqnForAlias($class_name);
-        $class_exists = class_exists($class_name, false);
-        // if we're only loading the class and it already exists, then let's just return true immediately
-        if ($load_only && $class_exists) {
-            return true;
-        }
-        $arguments = is_array($arguments) ? $arguments : [$arguments];
-        // $this->_cache_on is toggled during the recursive loading that can occur with dependency injection
-        // $cache is controlled by individual calls to separate Registry loader methods like load_class()
-        // $load_only is also controlled by individual calls to separate Registry loader methods like load_file()
-        if ($this->_cache_on && $cache && ! $load_only) {
-            // return object if it's already cached
-            $cached_class = $this->_get_cached_class($class_name, $class_prefix, $arguments);
-            if ($cached_class !== null) {
-                return $cached_class;
-            }
-        }
-        // if the class doesn't already exist.. then we need to try and find the file and load it
-        if (! $class_exists) {
-            // get full path to file
-            $path = $this->_resolve_path($class_name, $type, $file_paths);
-            // load the file
-            $loaded = $this->_require_file($path, $class_name, $type, $file_paths);
-            // if we are only loading a file but NOT instantiating an object
-            // then return boolean for whether class was loaded or not
-            if ($load_only) {
-                return $loaded;
-            }
-            // if an object was expected but loading failed, then return nothing
-            if (! $loaded) {
-                return null;
-            }
-        }
-        // instantiate the requested object
-        $class_obj = $this->_create_object($class_name, $arguments, $type, $from_db);
-        if ($this->_cache_on && $cache) {
-            // save it for later... kinda like gum  { : $
-            $this->_set_cached_class(
-                $class_obj,
-                $class_name,
-                $class_prefix,
-                $from_db,
-                $arguments
-            );
-        }
-        $this->_cache_on = true;
-        return $class_obj;
-    }
-
-
-    /**
-     * @param string $class_name
-     * @param string $default have to specify something, but not anything that will conflict
-     * @return mixed|string
-     */
-    protected function get_class_abbreviation(string $class_name, string $default = 'FANCY_BATMAN_PANTS')
-    {
-        return $this->_class_abbreviations[ $class_name ] ?? $default;
-    }
-
-
-    /**
-     * attempts to find a cached version of the requested class
-     * by looking in the following places:
-     *        $this->{$class_abbreviation}            ie:    $this->CART
-     *        $this->{$class_name}                        ie:    $this->Some_Class
-     *        $this->LIB->{$class_name}                ie:    $this->LIB->Some_Class
-     *        $this->addon->{$class_name}    ie:    $this->addon->Some_Addon_Class
-     *
-     * @param string $class_name
-     * @param string $class_prefix
-     * @param array  $arguments
-     * @return mixed
-     */
-    protected function _get_cached_class(
-        string $class_name,
-        string $class_prefix = '',
-        array $arguments = []
-    ) {
-        if ($class_name === 'EE_Registry') {
-            return $this;
-        }
-        $class_abbreviation = $this->get_class_abbreviation($class_name);
-        // check if class has already been loaded, and return it if it has been
-        if (isset($this->{$class_abbreviation})) {
-            return $this->{$class_abbreviation};
-        }
-        $class_name = str_replace('\\', '_', $class_name);
-        if (isset($this->{$class_name})) {
-            return $this->{$class_name};
-        }
-        if ($class_prefix === 'addon' && $this->addons->has($class_name)) {
-            return $this->addons->get($class_name);
-        }
-        $object_identifier = $this->object_identifier->getIdentifier($class_name, $arguments);
-        if ($this->LIB->has($object_identifier)) {
-            return $this->LIB->get($object_identifier);
-        }
-        foreach ($this->LIB as $key => $object) {
-            if (
-                // request does not contain new arguments and therefore no args identifier
-                ! $this->object_identifier->hasArguments($object_identifier)
-                // but previously cached class with args was found
-                && $this->object_identifier->fqcnMatchesObjectIdentifier($class_name, $key)
-            ) {
-                return $object;
-            }
-        }
-        return null;
-    }
-
-
-    /**
-     * removes a cached version of the requested class
-     *
-     * @param string  $class_name
-     * @param boolean $addon
-     * @param array   $arguments
-     * @return boolean
-     */
-    public function clear_cached_class(
-        string $class_name,
-        bool $addon = false,
-        array $arguments = []
-    ): bool {
-        $class_abbreviation = $this->get_class_abbreviation($class_name);
-        // check if class has already been loaded, and return it if it has been
-        if (isset($this->{$class_abbreviation})) {
-            $this->{$class_abbreviation} = null;
-            return true;
-        }
-        $class_name = str_replace('\\', '_', $class_name);
-        if (isset($this->{$class_name})) {
-            $this->{$class_name} = null;
-            return true;
-        }
-        if ($addon && $this->addons->has($class_name)) {
-            $this->addons->remove($class_name);
-            return true;
-        }
-        $class_name = $this->object_identifier->getIdentifier($class_name, $arguments);
-        if ($this->LIB->has($class_name)) {
-            $this->LIB->remove($class_name);
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * _set_cached_class
-     * attempts to cache the instantiated class locally
-     * in one of the following places, in the following order:
-     *        $this->{class_abbreviation}   ie:    $this->CART
-     *        $this->{$class_name}          ie:    $this->Some_Class
-     *        $this->addon->{$$class_name}    ie:    $this->addon->Some_Addon_Class
-     *        $this->LIB->{$class_name}     ie:    $this->LIB->Some_Class
-     *
-     * @param object $class_obj
-     * @param string $class_name
-     * @param string $class_prefix
-     * @param bool   $from_db
-     * @param array  $arguments
-     * @return void
-     */
-    protected function _set_cached_class(
-        $class_obj,
-        string $class_name,
-        string $class_prefix = '',
-        bool $from_db = false,
-        array $arguments = []
-    ) {
-        if ($class_name === 'EE_Registry' || empty($class_obj)) {
-            return;
-        }
-        // return newly instantiated class
-        $class_abbreviation = $this->get_class_abbreviation($class_name, '');
-        if ($class_abbreviation) {
-            $this->{$class_abbreviation} = $class_obj;
-            return;
-        }
-        $class_name = str_replace('\\', '_', $class_name);
-        if (property_exists($this, $class_name)) {
-            $this->{$class_name} = $class_obj;
-            return;
-        }
-        if ($class_prefix === 'addon') {
-            $this->addons->add($class_name, $class_obj);
-            return;
-        }
-        if (! $from_db) {
-            $class_name = $this->object_identifier->getIdentifier($class_name, $arguments);
-            $this->LIB->add($class_name, $class_obj);
-        }
-    }
-
-
-    /**
-     * attempts to find a full valid filepath for the requested class.
-     * loops thru each of the base paths in the $file_paths array and appends : "{classname} . {file type} . php"
-     * then returns that path if the target file has been found and is readable
-     *
-     * @param string $class_name
-     * @param string $type
-     * @param array  $file_paths
-     * @return string | bool
-     */
-    protected function _resolve_path(string $class_name, string $type = '', array $file_paths = [])
-    {
-        // make sure $file_paths is an array
-        $file_paths = is_array($file_paths)
-            ? $file_paths
-            : [$file_paths];
-        // cycle thru paths
-        foreach ($file_paths as $key => $file_path) {
-            // convert all separators to proper /, if no filepath, then use EE_CLASSES
-            $file_path = $file_path
-                ? str_replace(['/', '\\'], '/', $file_path)
-                : EE_CLASSES;
-            // prep file type
-            $type = ! empty($type)
-                ? trim($type, '.') . '.'
-                : '';
-            // build full file path
-            $file_paths[ $key ] = rtrim($file_path, '/') . '/' . $class_name . '.' . $type . 'php';
-            // does the file exist and can be read ?
-            if (is_readable($file_paths[ $key ])) {
-                return $file_paths[ $key ];
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     * basically just performs a require_once()
-     * but with some error handling
-     *
-     * @param string $path
-     * @param string $class_name
-     * @param string $type
-     * @param array  $file_paths
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _require_file(string $path, string $class_name, string $type = '', array $file_paths = []): bool
-    {
-        $this->resolve_legacy_class_parent($class_name);
-        // don't give up! you gotta...
-        try {
-            // does the file exist and can it be read ?
-            if (! $path) {
-                // just in case the file has already been autoloaded,
-                // but discrepancies in the naming schema are preventing it from
-                // being loaded via one of the EE_Registry::load_*() methods,
-                // then let's try one last hail mary before throwing an exception
-                // and call class_exists() again, but with autoloading turned ON
-                if (class_exists($class_name)) {
-                    return true;
-                }
-                // so sorry, can't find the file
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            'The %1$s file %2$s could not be located or is not readable due to file permissions. Please ensure that the following filepath(s) are correct: %3$s',
-                            'event_espresso'
-                        ),
-                        trim($type, '.'),
-                        $class_name,
-                        '<br />' . implode(',<br />', $file_paths)
-                    )
-                );
-            }
-            // get the file
-            require_once($path);
-            // if the class isn't already declared somewhere
-            if (class_exists($class_name, false) === false) {
-                // so sorry, not a class
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            'The %s file %s does not appear to contain the %s Class.',
-                            'event_espresso'
-                        ),
-                        $type,
-                        $path,
-                        $class_name
-                    )
-                );
-            }
-        } catch (EE_Error $e) {
-            $e->get_error();
-            return false;
-        }
-        return true;
-    }
-
-
-    /**
-     * Some of our legacy classes that extended a parent class would simply use a require() statement
-     * before their class declaration in order to ensure that the parent class was loaded.
-     * This is not ideal, but it's nearly impossible to determine the parent class of a non-namespaced class,
-     * without triggering a fatal error because the parent class has yet to be loaded and therefore doesn't exist.
-     *
-     * @param string $class_name
-     */
-    protected function resolve_legacy_class_parent(string $class_name = '')
-    {
-        try {
-            $legacy_parent_class_map = [
-                'EE_Payment_Processor' => 'core/business/EE_Processor_Base.class.php',
-            ];
-            if (isset($legacy_parent_class_map[ $class_name ])) {
-                require_once EE_PLUGIN_DIR_PATH . $legacy_parent_class_map[ $class_name ];
-            }
-        } catch (Exception $exception) {
-        }
-    }
-
-
-    /**
-     * _create_object
-     * Attempts to instantiate the requested class via any of the
-     * commonly used instantiation methods employed throughout EE.
-     * The priority for instantiation is as follows:
-     *        - abstract classes or any class flagged as "load only" (no instantiation occurs)
-     *        - model objects via their 'new_instance_from_db' method
-     *        - model objects via their 'new_instance' method
-     *        - "singleton" classes" via their 'instance' method
-     *    - standard instantiable classes via their __constructor
-     * Prior to instantiation, if the classname exists in the dependency_map,
-     * then the constructor for the requested class will be examined to determine
-     * if any dependencies exist, and if they can be injected.
-     * If so, then those classes will be added to the array of arguments passed to the constructor
-     *
-     * @param string $class_name
-     * @param array  $arguments
-     * @param string $type
-     * @param bool   $from_db
-     * @return null|object|bool
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     */
-    protected function _create_object(
-        string $class_name,
-        array $arguments = [],
-        string $type = '',
-        bool $from_db = false
-    ) {
-        // create reflection
-        $reflector = $this->mirror->getReflectionClass($class_name);
-        // make sure arguments are an array
-        $arguments = is_array($arguments)
-            ? $arguments
-            : [$arguments];
-        // and if arguments array is numerically and sequentially indexed, then we want it to remain as is,
-        // else wrap it in an additional array so that it doesn't get split into multiple parameters
-        $arguments = $this->_array_is_numerically_and_sequentially_indexed($arguments)
-            ? $arguments
-            : [$arguments];
-        // attempt to inject dependencies ?
-        if ($this->_dependency_map->has($class_name)) {
-            $arguments = $this->_resolve_dependencies($reflector, $class_name, $arguments);
-        }
-        // instantiate the class if possible
-        if ($reflector->isAbstract()) {
-            // nothing to instantiate, loading file was enough
-            // does not throw an exception so $instantiation_mode is unused
-            // $instantiation_mode = "1) no constructor abstract class";
-            return true;
-        }
-        if (
-            empty($arguments)
-            && $this->mirror->getConstructorFromReflection($reflector) === null
-            && $reflector->isInstantiable()
-        ) {
-            // no constructor = static methods only... nothing to instantiate, loading file was enough
-            // $instantiation_mode = "2) no constructor but instantiable";
-            return $reflector->newInstance();
-        }
-        if ($from_db && method_exists($class_name, 'new_instance_from_db')) {
-            // $instantiation_mode = "3) new_instance_from_db()";
-            return call_user_func_array([$class_name, 'new_instance_from_db'], $arguments);
-        }
-        if (method_exists($class_name, 'new_instance')) {
-            // $instantiation_mode = "4) new_instance()";
-            return call_user_func_array([$class_name, 'new_instance'], $arguments);
-        }
-        if (method_exists($class_name, 'instance')) {
-            // $instantiation_mode = "5) instance()";
-            return call_user_func_array([$class_name, 'instance'], $arguments);
-        }
-        if ($reflector->isInstantiable()) {
-            // $instantiation_mode = "6) constructor";
-            return $reflector->newInstanceArgs($arguments);
-        }
-        // heh ? something's not right !
-        throw new EE_Error(
-            sprintf(
-                esc_html__('The %s file %s could not be instantiated.', 'event_espresso'),
-                $type,
-                $class_name
-            )
-        );
-    }
-
-
-    /**
-     * @see http://stackoverflow.com/questions/173400/how-to-check-if-php-array-is-associative-or-sequential
-     * @param array $array
-     * @return bool
-     */
-    protected function _array_is_numerically_and_sequentially_indexed(array $array): bool
-    {
-        return empty($array) || array_keys($array) === range(0, count($array) - 1);
-    }
-
-
-    /**
-     * _resolve_dependencies
-     * examines the constructor for the requested class to determine
-     * if any dependencies exist, and if they can be injected.
-     * If so, then those classes will be added to the array of arguments passed to the constructor
-     * PLZ NOTE: this is achieved by type hinting the constructor params
-     * For example:
-     *        if attempting to load a class "Foo" with the following constructor:
-     *        __construct( Bar $bar_class, Fighter $grohl_class )
-     *        then $bar_class and $grohl_class will be added to the $arguments array,
-     *        but only IF they are NOT already present in the incoming arguments array,
-     *        and the correct classes can be loaded
-     *
-     * @param ReflectionClass $reflector
-     * @param string          $class_name
-     * @param array           $arguments
-     * @return array
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _resolve_dependencies(
-        ReflectionClass $reflector,
-        string $class_name,
-        array $arguments = []
-    ): array {
-        // let's examine the constructor
-        $constructor = $this->mirror->getConstructorFromReflection($reflector);
-        // whu? huh? nothing?
-        if (! $constructor) {
-            return $arguments;
-        }
-        // get constructor parameters
-        $params = $this->mirror->getParametersFromReflection($reflector);
-        // and the keys for the incoming arguments array so that we can compare existing arguments with what is expected
-        $argument_keys = array_keys($arguments);
-        // now loop thru all of the constructors expected parameters
-        foreach ($params as $index => $param) {
-            try {
-                // is this a dependency for a specific class ?
-                $param_class = $this->mirror->getParameterClassName($param, $class_name, $index);
-            } catch (ReflectionException $exception) {
-                // uh-oh... most likely a legacy class that has not been autoloaded
-                // let's try to derive the classname from what we have now
-                // and hope that the property var name is close to the class name
-                $param_class = $param->getName();
-                $param_class = str_replace('_', ' ', $param_class);
-                $param_class = ucwords($param_class);
-                $param_class = str_replace(' ', '_', $param_class);
-            }
-            // BUT WAIT !!! This class may be an alias for something else (or getting replaced at runtime)
-            $param_class = $this->class_cache->isAlias($param_class, $class_name)
-                ? $this->class_cache->getFqnForAlias($param_class, $class_name)
-                : $param_class;
-            // param is not even a class
-            if (
-                ! empty($param_class)
-                && ! class_exists($param_class, false)
-                // and something already exists in the incoming arguments for this param
-                && array_key_exists($index, $argument_keys)
-                && isset($arguments[ $argument_keys[ $index ] ])
-            ) {
-                // so let's skip this argument and move on to the next
-                continue;
-            }
-            // parameter is type hinted as a class
-            if ($param_class !== null) {
-                // parameter exists as an incoming argument, AND it's the correct class
-                if (
-                    array_key_exists($index, $argument_keys)
-                    && isset($arguments[ $argument_keys[ $index ] ])
-                    && $arguments[ $argument_keys[ $index ] ] instanceof $param_class
-                ) {
-                    // skip this argument and move on to the next
-                    continue;
-                }
-                // parameter should be injected
-                if ($this->_dependency_map->has_dependency_for_class($class_name, $param_class)) {
-                    $arguments = $this->_resolve_dependency(
-                        $class_name,
-                        $param_class,
-                        $arguments,
-                        $index
-                    );
-                }
-            }
-            if (empty($arguments[ $index ])) {
-                $default_value = $this->mirror->getParameterDefaultValue(
-                    $param,
-                    $class_name,
-                    $index
-                );
-                // if there's no default value, and the incoming argument is an array (albeit empty), then use that
-                $arguments[ $index ] = $default_value === null
-                                       && isset($arguments[ $index ])
-                                       && is_array($arguments[ $index ])
-                    ? $arguments[ $index ]
-                    : $default_value;
-            }
-        }
-        return $arguments;
-    }
-
-
-    /**
-     * @param string $class_name
-     * @param string $param_class
-     * @param array  $arguments
-     * @param mixed  $index
-     * @return array
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    protected function _resolve_dependency(string $class_name, string $param_class, array $arguments, $index): array
-    {
-        $dependency = null;
-        // should dependency be loaded from cache ?
-        $cache_on = $this->_dependency_map->loading_strategy_for_class_dependency(
-            $class_name,
-            $param_class
-        );
-        $cache_on = $cache_on !== EE_Dependency_Map::load_new_object;
-        // we might have a dependency...
-        // let's MAYBE try and find it in our cache if that's what's been requested
-        $cached_class = $cache_on
-            ? $this->_get_cached_class($param_class)
-            : null;
-        // and grab it if it exists
-        if ($cached_class instanceof $param_class) {
-            $dependency = $cached_class;
-        } elseif ($param_class !== $class_name) {
-            // obtain the loader method from the dependency map
-            $loader = $this->_dependency_map->class_loader($param_class);
-            // is loader a custom closure ?
-            if ($loader instanceof Closure) {
-                $dependency = $loader($arguments);
-            } else {
-                // set the cache on property for the recursive loading call
-                $this->_cache_on = $cache_on;
-                // if not, then let's try and load it via the registry
-                if ($loader && method_exists($this, $loader)) {
-                    $dependency = $this->{$loader}($param_class);
-                } else {
-                    $dependency = LoaderFactory::getLoader()->load(
-                        $param_class,
-                        [],
-                        $cache_on
-                    );
-                }
-            }
-        }
-        // did we successfully find the correct dependency ?
-        if ($dependency instanceof $param_class) {
-            // then let's inject it into the incoming array of arguments at the correct location
-            $arguments[ $index ] = $dependency;
-        }
-        return $arguments;
-    }
-
-
-    /**
-     * call any loader that's been registered in the EE_Dependency_Map::$_class_loaders array
-     *
-     * @param string $classname PLEASE NOTE: the class name needs to match what's registered
-     *                          in the EE_Dependency_Map::$_class_loaders array,
-     *                          including the class prefix, ie: "EE_", "EEM_", "EEH_", etc
-     * @param array  $arguments
-     * @return object
-     */
-    public static function factory(string $classname, array $arguments = [])
-    {
-        $loader = self::instance()->_dependency_map->class_loader($classname);
-        if ($loader instanceof Closure) {
-            return $loader($arguments);
-        }
-        if (method_exists(self::instance(), $loader)) {
-            return self::instance()->{$loader}($classname, $arguments);
-        }
-        return null;
-    }
-
-
-    /**
-     * Gets the addon by its class name
-     *
-     * @param string $class_name
-     * @return EE_Addon
-     */
-    public function getAddon(string $class_name): ?EE_Addon
-    {
-        $class_name = str_replace('\\', '_', $class_name);
-        return $this->addons->{$class_name} ?? null;
-    }
-
-
-    /**
-     * removes the addon from the internal cache
-     *
-     * @param string $class_name
-     * @return void
-     */
-    public function removeAddon(string $class_name)
-    {
-        $class_name = str_replace('\\', '_', $class_name);
-        $this->addons->remove($class_name);
-    }
-
-
-    /**
-     * Gets the addon by its name/slug (not classname. For that, just
-     * use the get_addon() method above
-     *
-     * @param string $name
-     * @return EE_Addon
-     */
-    public function get_addon_by_name(string $name): ?EE_Addon
-    {
-        foreach ($this->addons as $addon) {
-            if ($addon->name() === $name) {
-                return $addon;
-            }
-        }
-        return null;
-    }
-
-
-    /**
-     * Gets an array of all the registered addons, where the keys are their names.
-     * (ie, what each returns for their name() function)
-     * They're already available on EE_Registry::instance()->addons as properties,
-     * where each property's name is the addon's classname,
-     * So if you just want to get the addon by classname,
-     * OR use the get_addon() method above.
-     * PLEASE  NOTE:
-     * addons with Fully Qualified Class Names
-     * have had the namespace separators converted to underscores,
-     * so a classname like Fully\Qualified\ClassName
-     * would have been converted to Fully_Qualified_ClassName
-     *
-     * @return EE_Addon[] where the KEYS are the addon's name()
-     */
-    public function get_addons_by_name(): array
-    {
-        $addons = [];
-        foreach ($this->addons as $addon) {
-            $addons[ $addon->name() ] = $addon;
-        }
-        return $addons;
-    }
-
-
-    /**
-     * Resets the specified model's instance AND makes sure EE_Registry doesn't keep
-     * a stale copy of it around
-     *
-     * @param string $model_name
-     * @return EEM_Base
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function reset_model(string $model_name): ?EEM_Base
-    {
-        $model_class_name = strpos($model_name, 'EEM_') !== 0
-            ? "EEM_$model_name"
-            : $model_name;
-        if (! $this->LIB->has($model_class_name)) {
-            return null;
-        }
-        $model = $this->LIB->get($model_class_name);
-        if (! $model instanceof EEM_Base) {
-            return null;
-        }
-        // get that model reset it and make sure we nuke the old reference to it
-        if ($model instanceof $model_class_name && is_callable([$model_class_name, 'reset'])) {
-            $this->LIB->remove($model_class_name);
-            $this->LIB->add($model_class_name, $model->reset());
-        } else {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__('Model %s does not have a method "reset"', 'event_espresso'),
-                    $model_name
-                )
-            );
-        }
-        return $model;
-    }
-
-
-    /**
-     * Resets the registry.
-     * The criteria for what gets reset is based on what can be shared between sites on the same request when
-     * switch_to_blog is used in a multisite install.  Here is a list of things that are NOT reset.
-     * - $_dependency_map
-     * - $_class_abbreviations
-     * - $NET_CFG (EE_Network_Config): The config is shared network wide so no need to reset.
-     * - $REQ:  Still on the same request so no need to change.
-     * - $CAP: There is no site specific state in the EE_Capability class.
-     * - $SSN: Although ideally, the session should not be shared between site switches, we can't reset it because only
-     * one Session can be active in a single request.  Resetting could resolve in "headers already sent" errors.
-     * - $addons:  In multisite, the state of the addons is something controlled via hooks etc in a normal request.  So
-     *             for now, we won't reset the addons because it could break calls to an add-ons class/methods in the
-     *             switch or on the restore.
-     * - $modules
-     * - $shortcodes
-     * - $widgets
-     *
-     * @param boolean $hard             [deprecated]
-     * @param boolean $reinstantiate    whether to create new instances of EE_Registry's singletons too,
-     *                                  or just reset without re-instantiating (handy to set to FALSE if you're not
-     *                                  sure if you CAN currently reinstantiate the singletons at the moment)
-     * @param bool    $reset_models     Defaults to true.  When false, then the models are not reset.  This is so
-     *                                  client
-     *                                  code instead can just change the model context to a different blog id if
-     *                                  necessary
-     * @return EE_Registry
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function reset(bool $hard = false, bool $reinstantiate = true, bool $reset_models = true): EE_Registry
-    {
-        $instance            = self::instance();
-        $instance->_cache_on = true;
-        // reset some "special" classes
-        EEH_Activation::reset();
-        $hard                     = apply_filters('FHEE__EE_Registry__reset__hard', $hard);
-        $instance->CFG            = EE_Config::reset($hard, $reinstantiate);
-        $instance->CART           = null;
-        $instance->MRM            = null;
-        $instance->AssetsRegistry = LoaderFactory::getLoader()->getShared(
-            'EventEspresso\core\services\assets\Registry'
-        );
-        // messages reset
-        EED_Messages::reset();
-        // handle of objects cached on LIB
-        foreach (['LIB', 'modules'] as $cache) {
-            foreach ($instance->{$cache} as $class_name => $class) {
-                if (self::_reset_and_unset_object($class, $reset_models)) {
-                    unset($instance->{$cache}->{$class_name});
-                }
-            }
-        }
-        return $instance;
-    }
-
-
-    /**
-     * if passed object implements ResettableInterface, then call it's reset() method
-     * if passed object implements InterminableInterface, then return false,
-     * to indicate that it should NOT be cleared from the Registry cache
-     *
-     * @param      $object
-     * @param bool $reset_models
-     * @return bool returns true if cached object should be unset
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private static function _reset_and_unset_object($object, bool $reset_models): bool
-    {
-        if (! is_object($object)) {
-            // don't unset anything that's not an object
-            return false;
-        }
-        if ($object instanceof EED_Module) {
-            $object::reset();
-            // don't unset modules
-            return false;
-        }
-        if ($object instanceof ResettableInterface) {
-            if ($object instanceof EEM_Base) {
-                if ($reset_models) {
-                    $object->reset();
-                    return true;
-                }
-                return false;
-            }
-            $object->reset();
-            return true;
-        }
-        if (! $object instanceof InterminableInterface) {
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * Gets all the custom post type models defined
-     *
-     * @return array keys are model "short names" (Eg "Event") and keys are classnames (eg "EEM_Event")
-     */
-    public function cpt_models(): array
-    {
-        $cpt_models = [];
-        foreach ($this->non_abstract_db_models as $short_name => $classname) {
-            if (is_subclass_of($classname, 'EEM_CPT_Base')) {
-                $cpt_models[ $short_name ] = $classname;
-            }
-        }
-        return $cpt_models;
-    }
-
-
-    /**
-     * @return EE_Config
-     */
-    public static function CFG(): EE_Config
-    {
-        return self::instance()->CFG;
-    }
-
-
-    /**
-     * @param string $class_name
-     * @return ReflectionClass
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @deprecated 4.9.62.p
-     */
-    public function get_ReflectionClass(string $class_name): ReflectionClass
-    {
-        return $this->mirror->getReflectionClass($class_name);
-    }
+	/**
+	 * @var EE_Registry $_instance
+	 */
+	private static $_instance;
+
+	/**
+	 * @var EE_Dependency_Map $_dependency_map
+	 */
+	protected $_dependency_map;
+
+	/**
+	 * @var Mirror
+	 */
+	private $mirror;
+
+	/**
+	 * @var ClassInterfaceCache $class_cache
+	 */
+	private $class_cache;
+
+	/**
+	 * @var array $_class_abbreviations
+	 */
+	protected $_class_abbreviations = [];
+
+	/**
+	 * @var CommandBusInterface $BUS
+	 */
+	public $BUS;
+
+	/**
+	 * @var EE_Cart $CART
+	 */
+	public $CART;
+
+	/**
+	 * @var EE_Config $CFG
+	 */
+	public $CFG;
+
+	/**
+	 * @var EE_Network_Config $NET_CFG
+	 */
+	public $NET_CFG;
+
+	/**
+	 * RegistryContainer for storing library classes in
+	 *
+	 * @var RegistryContainer $LIB
+	 */
+	public $LIB;
+
+	/**
+	 * @var EE_Request_Handler $REQ
+	 * @deprecated 4.10.14.p
+	 */
+	public $REQ;
+
+	/**
+	 * @var EE_Session $SSN
+	 */
+	public $SSN;
+
+	/**
+	 * @since 4.5.0
+	 * @var EE_Capabilities $CAP
+	 */
+	public $CAP;
+
+	/**
+	 * @since 4.9.0
+	 * @var EE_Message_Resource_Manager $MRM
+	 */
+	public $MRM;
+
+	/**
+	 * @var Registry $AssetsRegistry
+	 */
+	public $AssetsRegistry;
+
+	/**
+	 * RegistryContainer for holding addons which have registered themselves to work with EE core
+	 *
+	 * @var RegistryContainer|EE_Addon[] $addons
+	 */
+	public $addons;
+
+	/**
+	 * keys are 'short names' (eg Event), values are class names (eg 'EEM_Event')
+	 *
+	 * @var EEM_Base[] $models
+	 */
+	public $models = [];
+
+	/**
+	 * @var RegistryContainer|EED_Module[] $modules
+	 */
+	public $modules;
+
+	/**
+	 * @var RegistryContainer|EES_Shortcode[] $shortcodes
+	 */
+	public $shortcodes;
+
+	/**
+	 * @var RegistryContainer|WP_Widget[] $widgets
+	 */
+	public $widgets;
+
+	/**
+	 * this is an array of all implemented model names (i.e. not the parent abstract models, or models
+	 * which don't actually fetch items from the DB in the normal way (ie, are not children of EEM_Base)).
+	 * Keys are model "short names" (eg "Event") as used in model relations, and values are
+	 * classnames (eg "EEM_Event")
+	 *
+	 * @var array $non_abstract_db_models
+	 */
+	public $non_abstract_db_models = [];
+
+	/**
+	 * internationalization for JS strings
+	 *    usage:   EE_Registry::i18n_js_strings['string_key'] = esc_html__( 'string to translate.', 'event_espresso' );
+	 *    in js file:  var translatedString = eei18n.string_key;
+	 *
+	 * @var array $i18n_js_strings
+	 */
+	public static $i18n_js_strings = [];
+
+	/**
+	 * $main_file - path to espresso.php
+	 *
+	 * @var array $main_file
+	 */
+	public $main_file;
+
+	/**
+	 * array of ReflectionClass objects where the key is the class name
+	 *
+	 * @deprecated 4.9.62.p
+	 * @var ReflectionClass[] $_reflectors
+	 */
+	public $_reflectors;
+
+	/**
+	 * boolean flag to indicate whether or not to load/save dependencies from/to the cache
+	 *
+	 * @var boolean $_cache_on
+	 */
+	protected $_cache_on = true;
+
+	/**
+	 * @var ObjectIdentifier
+	 */
+	private $object_identifier;
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @param EE_Dependency_Map|null   $dependency_map
+	 * @param Mirror|null              $mirror
+	 * @param ClassInterfaceCache|null $class_cache
+	 * @param ObjectIdentifier|null    $object_identifier
+	 * @return EE_Registry instance
+	 */
+	public static function instance(
+		EE_Dependency_Map $dependency_map = null,
+		Mirror $mirror = null,
+		ClassInterfaceCache $class_cache = null,
+		ObjectIdentifier $object_identifier = null
+	): EE_Registry {
+		// check if class object is instantiated
+		if (
+			! self::$_instance instanceof EE_Registry
+			&& $dependency_map instanceof EE_Dependency_Map
+			&& $mirror instanceof Mirror
+			&& $class_cache instanceof ClassInterfaceCache
+			&& $object_identifier instanceof ObjectIdentifier
+		) {
+			self::$_instance = new self(
+				$dependency_map,
+				$mirror,
+				$class_cache,
+				$object_identifier
+			);
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * protected constructor to prevent direct creation
+	 *
+	 * @Constructor
+	 * @param EE_Dependency_Map   $dependency_map
+	 * @param Mirror              $mirror
+	 * @param ClassInterfaceCache $class_cache
+	 * @param ObjectIdentifier    $object_identifier
+	 */
+	protected function __construct(
+		EE_Dependency_Map $dependency_map,
+		Mirror $mirror,
+		ClassInterfaceCache $class_cache,
+		ObjectIdentifier $object_identifier
+	) {
+		$this->_dependency_map   = $dependency_map;
+		$this->mirror            = $mirror;
+		$this->class_cache       = $class_cache;
+		$this->object_identifier = $object_identifier;
+		// $registry_container = new RegistryContainer();
+		$this->LIB        = new RegistryContainer();
+		$this->addons     = new RegistryContainer();
+		$this->modules    = new RegistryContainer();
+		$this->shortcodes = new RegistryContainer();
+		$this->widgets    = new RegistryContainer();
+		add_action('EE_Load_Espresso_Core__handle_request__initialize_core_loading', [$this, 'initialize']);
+	}
+
+
+	/**
+	 * initialize
+	 *
+	 * @throws OutOfBoundsException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function initialize()
+	{
+		$this->_class_abbreviations = apply_filters(
+			'FHEE__EE_Registry____construct___class_abbreviations',
+			[
+				'EE_Config'                                       => 'CFG',
+				'EE_Session'                                      => 'SSN',
+				'EE_Capabilities'                                 => 'CAP',
+				'EE_Cart'                                         => 'CART',
+				'EE_Network_Config'                               => 'NET_CFG',
+				'EE_Request_Handler'                              => 'REQ',
+				'EE_Message_Resource_Manager'                     => 'MRM',
+				'EventEspresso\core\services\commands\CommandBus' => 'BUS',
+				'EventEspresso\core\services\assets\Registry'     => 'AssetsRegistry',
+			]
+		);
+		$this->load_core('Base', [], true);
+		// add our request and response objects to the cache
+		$request_loader = $this->_dependency_map->class_loader(
+			'EventEspresso\core\services\request\Request'
+		);
+		$this->_set_cached_class(
+			$request_loader(),
+			'EventEspresso\core\services\request\Request'
+		);
+		$response_loader = $this->_dependency_map->class_loader(
+			'EventEspresso\core\services\request\Response'
+		);
+		$this->_set_cached_class(
+			$response_loader(),
+			'EventEspresso\core\services\request\Response'
+		);
+		add_action('AHEE__EE_System__set_hooks_for_core', [$this, 'init']);
+	}
+
+
+	/**
+	 * @return void
+	 */
+	public function init()
+	{
+		// Get current page protocol
+		$protocol = is_ssl() ? 'https://' : 'http://';
+		// Output admin-ajax.php URL with same protocol as current page
+		self::$i18n_js_strings['ajax_url'] = admin_url('admin-ajax.php', $protocol);
+		self::$i18n_js_strings['wp_debug'] = defined('WP_DEBUG') && WP_DEBUG;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public static function sanitize_i18n_js_strings(): array
+	{
+		$i18n_js_strings = (array) self::$i18n_js_strings;
+		foreach ($i18n_js_strings as $key => $value) {
+			if (is_scalar($value)) {
+				$i18n_js_strings[ $key ] = html_entity_decode((string) $value, ENT_QUOTES, 'UTF-8');
+			}
+		}
+		return $i18n_js_strings;
+	}
+
+
+	/**
+	 * localize_i18n_js_strings
+	 *
+	 * @return string
+	 */
+	public static function localize_i18n_js_strings(): string
+	{
+		$i18n_js_strings = EE_Registry::sanitize_i18n_js_strings();
+		return '/* <![CDATA[ */ var eei18n = ' . wp_json_encode($i18n_js_strings) . '; /* ]]> */';
+	}
+
+
+	/**
+	 * @param mixed string | EED_Module $module
+	 * @throws OutOfBoundsException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function add_module($module)
+	{
+		if ($module instanceof EED_Module) {
+			$module_class = get_class($module);
+			$this->modules->add($module_class, $module);
+		} else {
+			if (! class_exists('EE_Module_Request_Router', false)) {
+				$this->load_core('Module_Request_Router');
+			}
+			EE_Module_Request_Router::module_factory($module);
+		}
+	}
+
+
+	/**
+	 * @param string $module_name
+	 * @return mixed EED_Module | NULL
+	 */
+	public function get_module(string $module_name = '')
+	{
+		return $this->modules->get($module_name);
+	}
+
+
+	/**
+	 * loads core classes - must be singletons
+	 *
+	 * @param string $class_name - simple class name ie: session
+	 * @param mixed  $arguments
+	 * @param bool   $load_only
+	 * @return bool|null|object
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 */
+	public function load_core(string $class_name, $arguments = [], bool $load_only = false)
+	{
+		$core_paths = (array) apply_filters(
+			'FHEE__EE_Registry__load_core__core_paths',
+			[
+				EE_CORE,
+				EE_ADMIN,
+				EE_CPTS,
+				EE_CORE . 'CPTs/',
+				EE_CORE . 'data_migration_scripts/',
+				EE_CORE . 'request_stack/',
+				EE_CORE . 'middleware/',
+			]
+		);
+		// retrieve instantiated class
+		return $this->_load(
+			$core_paths,
+			'EE_',
+			$class_name,
+			'core',
+			$arguments,
+			false,
+			true,
+			$load_only
+		);
+	}
+
+
+	/**
+	 * loads service classes
+	 *
+	 * @param string $class_name - simple class name ie: session
+	 * @param mixed  $arguments
+	 * @param bool   $load_only
+	 * @return bool|null|object
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @deprecated  4.10.33.p
+	 */
+	public function load_service(string $class_name, $arguments = [], bool $load_only = false)
+	{
+		$service_paths = (array) apply_filters(
+			'FHEE__EE_Registry__load_service__service_paths',
+			[
+				EE_CORE . 'services/',
+			]
+		);
+		// retrieve instantiated class
+		return $this->_load(
+			$service_paths,
+			'EE_',
+			$class_name,
+			'class',
+			$arguments,
+			false,
+			true,
+			$load_only
+		);
+	}
+
+
+	/**
+	 * loads data_migration_scripts
+	 *
+	 * @param string $class_name - class name for the DMS ie: EE_DMS_Core_4_2_0
+	 * @param mixed  $arguments
+	 * @return bool|null|object
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 */
+	public function load_dms(string $class_name, $arguments = [])
+	{
+		// retrieve instantiated class
+		return $this->_load(
+			EE_Data_Migration_Manager::instance()->get_data_migration_script_folders(),
+			'EE_DMS_',
+			$class_name,
+			'dms',
+			$arguments,
+			false,
+			false
+		);
+	}
+
+
+	/**
+	 * loads object creating classes - must be singletons
+	 *
+	 * @param string $class_name - simple class name ie: attendee
+	 * @param mixed  $arguments  - an array of arguments to pass to the class
+	 * @param bool   $from_db    - some classes are instantiated from the db and thus call a different method to
+	 *                           instantiate
+	 * @param bool   $cache      if you don't want the class to be stored in the internal cache (non-persistent) then
+	 *                           set this to FALSE (ie. when instantiating model objects from client in a loop)
+	 * @param bool   $load_only  whether or not to just load the file and NOT instantiate, or load AND instantiate
+	 *                           (default)
+	 * @return bool|null|object
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 */
+	public function load_class(
+		string $class_name,
+		$arguments = [],
+		bool $from_db = false,
+		bool $cache = true,
+		bool $load_only = false
+	) {
+		$paths = (array) apply_filters(
+			'FHEE__EE_Registry__load_class__paths',
+			[
+				EE_CORE,
+				EE_CLASSES,
+				EE_BUSINESS,
+			]
+		);
+		// retrieve instantiated class
+		return $this->_load(
+			$paths,
+			'EE_',
+			$class_name,
+			'class',
+			$arguments,
+			$from_db,
+			$cache,
+			$load_only
+		);
+	}
+
+
+	/**
+	 * loads helper classes - must be singletons
+	 *
+	 * @param string $class_name - simple class name ie: price
+	 * @param mixed  $arguments
+	 * @param bool   $load_only
+	 * @return bool|null|object
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 */
+	public function load_helper(string $class_name, $arguments = [], bool $load_only = true)
+	{
+		// todo: add doing_it_wrong() in a few versions after all addons have had calls to this method removed
+		$helper_paths = (array) apply_filters('FHEE__EE_Registry__load_helper__helper_paths', [EE_HELPERS]);
+		// retrieve instantiated class
+		return $this->_load(
+			$helper_paths,
+			'EEH_',
+			$class_name,
+			'helper',
+			$arguments,
+			false,
+			true,
+			$load_only
+		);
+	}
+
+
+	/**
+	 * loads core classes - must be singletons
+	 *
+	 * @param string $class_name - simple class name ie: session
+	 * @param mixed  $arguments
+	 * @param bool   $load_only
+	 * @param bool   $cache      whether to cache the object or not.
+	 * @return bool|null|object
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 */
+	public function load_lib(string $class_name, $arguments = [], bool $load_only = false, bool $cache = true)
+	{
+		$paths = [
+			EE_LIBRARIES,
+			EE_LIBRARIES . 'messages/',
+			EE_LIBRARIES . 'shortcodes/',
+			EE_LIBRARIES . 'qtips/',
+			EE_LIBRARIES . 'payment_methods/',
+		];
+		// retrieve instantiated class
+		return $this->_load(
+			$paths,
+			'EE_',
+			$class_name,
+			'lib',
+			$arguments,
+			false,
+			$cache,
+			$load_only
+		);
+	}
+
+
+	/**
+	 * loads model classes - must be singletons
+	 *
+	 * @param string $class_name - simple class name ie: price
+	 * @param mixed  $arguments
+	 * @param bool   $load_only
+	 * @return bool|null|object
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 */
+	public function load_model(string $class_name, $arguments = [], bool $load_only = false)
+	{
+		$paths = (array) apply_filters(
+			'FHEE__EE_Registry__load_model__paths',
+			[
+				EE_MODELS,
+				EE_CORE,
+			]
+		);
+		// retrieve instantiated class
+		return $this->_load(
+			$paths,
+			'EEM_',
+			$class_name,
+			'model',
+			$arguments,
+			false,
+			true,
+			$load_only
+		);
+	}
+
+
+	/**
+	 * loads model classes - must be singletons
+	 *
+	 * @param string $class_name - simple class name ie: price
+	 * @param mixed  $arguments
+	 * @param bool   $load_only
+	 * @return bool|null|object
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @deprecated  4.10.33.p
+	 */
+	public function load_model_class(string $class_name, $arguments = [], bool $load_only = true)
+	{
+		$paths = [
+			EE_MODELS . 'fields/',
+			EE_MODELS . 'helpers/',
+			EE_MODELS . 'relations/',
+			EE_MODELS . 'strategies/',
+		];
+		// retrieve instantiated class
+		return $this->_load(
+			$paths,
+			'EE_',
+			$class_name,
+			'',
+			$arguments,
+			false,
+			true,
+			$load_only
+		);
+	}
+
+
+	/**
+	 * Determines if $model_name is the name of an actual EE model.
+	 *
+	 * @param string $model_name like Event, Attendee, Question_Group_Question, etc.
+	 * @return boolean
+	 */
+	public function is_model_name(string $model_name): bool
+	{
+		return isset($this->models[ $model_name ]);
+	}
+
+
+	/**
+	 * generic class loader
+	 *
+	 * @param string $path_to_file - directory path to file location, not including filename
+	 * @param string $file_name    - file name  ie:  my_file.php, including extension
+	 * @param string $type         - file type - core? class? helper? model?
+	 * @param mixed  $arguments
+	 * @param bool   $load_only
+	 * @return bool|null|object
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 */
+	public function load_file(
+		string $path_to_file,
+		string $file_name,
+		string $type = '',
+		$arguments = [],
+		bool $load_only = true
+	) {
+		// retrieve instantiated class
+		return $this->_load(
+			(array) $path_to_file,
+			'',
+			$file_name,
+			$type,
+			$arguments,
+			false,
+			true,
+			$load_only
+		);
+	}
+
+
+	/**
+	 * @param string $path_to_file - directory path to file location, not including filename
+	 * @param string $class_name   - full class name  ie:  My_Class
+	 * @param string $type         - file type - core? class? helper? model?
+	 * @param mixed  $arguments
+	 * @param bool   $load_only
+	 * @return bool|null|object
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @deprecated  4.10.33.p
+	 */
+	public function load_addon(
+		string $path_to_file,
+		string $class_name,
+		string $type = 'class',
+		$arguments = [],
+		bool $load_only = false
+	) {
+		// retrieve instantiated class
+		return $this->_load(
+			(array) $path_to_file,
+			'addon',
+			$class_name,
+			$type,
+			$arguments,
+			false,
+			true,
+			$load_only
+		);
+	}
+
+
+	/**
+	 * instantiates, caches, and automatically resolves dependencies
+	 * for classes that use a Fully Qualified Class Name.
+	 * if the class is not capable of being loaded using PSR-4 autoloading,
+	 * then you need to use one of the existing load_*() methods
+	 * which can resolve the classname and filepath from the passed arguments
+	 *
+	 * @param string      $class_name Fully Qualified Class Name
+	 * @param array       $arguments  an argument, or array of arguments to pass to the class upon instantiation
+	 * @param bool        $cache      whether to cache the instantiated object for reuse
+	 * @param bool        $from_db    some classes are instantiated from the db
+	 *                                and thus call a different method to instantiate
+	 * @param bool        $load_only  if true, will only load the file, but will NOT instantiate an object
+	 * @param bool|string $addon      if true, will cache the object in the EE_Registry->$addons array
+	 * @return bool|null|mixed     null = failure to load or instantiate class object.
+	 *                                object = class loaded and instantiated successfully.
+	 *                                bool = fail or success when $load_only is true
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 */
+	public function create(
+		string $class_name = '',
+		array $arguments = [],
+		bool $cache = false,
+		bool $from_db = false,
+		bool $load_only = false,
+		bool $addon = false
+	) {
+		$class_name   = ltrim($class_name, '\\');
+		$class_name   = $this->class_cache->getFqnForAlias($class_name);
+		$class_exists = $this->loadOrVerifyClassExists($class_name, $arguments);
+		// if a non-FQCN was passed, then
+		// verifyClassExists() might return an object
+		// or it could return null if the class just could not be found anywhere
+		if ($class_exists instanceof $class_name || $class_exists === null) {
+			// either way, return the results
+			return $class_exists;
+		}
+		$class_name = $class_exists;
+		// if we're only loading the class and it already exists, then let's just return true immediately
+		if ($load_only) {
+			return true;
+		}
+		$addon = $addon ? 'addon' : '';
+		// $this->_cache_on is toggled during the recursive loading that can occur with dependency injection
+		// $cache is controlled by individual calls to separate Registry loader methods like load_class()
+		// $load_only is also controlled by individual calls to separate Registry loader methods like load_file()
+		if ($this->_cache_on && $cache) {
+			// return object if it's already cached
+			$cached_class = $this->_get_cached_class($class_name, $addon, $arguments);
+			if ($cached_class !== null) {
+				return $cached_class;
+			}
+		}                                                           // obtain the loader method from the dependency map
+		$loader = $this->_dependency_map->class_loader($class_name);// instantiate the requested object
+		if ($loader instanceof Closure) {
+			$class_obj = $loader($arguments);
+		} else {
+			if ($loader && method_exists($this, $loader)) {
+				$class_obj = $this->{$loader}($class_name, $arguments);
+			} else {
+				$class_obj = $this->_create_object($class_name, $arguments, $addon, $from_db);
+			}
+		}
+		if (($this->_cache_on && $cache) || $this->get_class_abbreviation($class_name, '')) {
+			// save it for later... kinda like gum  { : $
+			$this->_set_cached_class(
+				$class_obj,
+				$class_name,
+				$addon,
+				$from_db,
+				$arguments
+			);
+		}
+		$this->_cache_on = true;
+		return $class_obj;
+	}
+
+
+	/**
+	 * Recursively checks that a class exists and potentially attempts to load classes with non-FQCNs
+	 *
+	 * @param string|mixed $class_name
+	 * @param array        $arguments
+	 * @param int          $attempt
+	 * @return mixed
+	 */
+	private function loadOrVerifyClassExists($class_name, array $arguments, int $attempt = 1)
+	{
+		if (is_object($class_name) || class_exists($class_name)) {
+			return $class_name;
+		}
+		switch ($attempt) {
+			case 1:
+				// if it's a FQCN then maybe the class is registered with a preceding \
+				$class_name = strpos($class_name, '\\') !== false
+					? '\\' . ltrim($class_name, '\\')
+					: $class_name;
+				break;
+			case 2:
+				//
+				$loader = $this->_dependency_map->class_loader($class_name);
+				if ($loader && method_exists($this, $loader)) {
+					return $this->{$loader}($class_name, $arguments);
+				}
+				break;
+			case 3:
+			default:
+				return null;
+		}
+		$attempt++;
+		return $this->loadOrVerifyClassExists($class_name, $arguments, $attempt);
+	}
+
+
+	/**
+	 * instantiates, caches, and injects dependencies for classes
+	 *
+	 * @param array  $file_paths         an array of paths to folders to look in
+	 * @param string $class_prefix       EE  or EEM or... ???
+	 * @param string $class_name         $class name
+	 * @param string $type               file type - core? class? helper? model?
+	 * @param mixed  $arguments          an argument or array of arguments to pass to the class upon instantiation
+	 * @param bool   $from_db            some classes are instantiated from the db
+	 *                                   and thus call a different method to instantiate
+	 * @param bool   $cache              whether to cache the instantiated object for reuse
+	 * @param bool   $load_only          if true, will only load the file, but will NOT instantiate an object
+	 * @return bool|null|object          null   = failure to load or instantiate class object.
+	 *                                   object = class loaded and instantiated successfully.
+	 *                                   bool   = fail or success when $load_only is true
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidArgumentException
+	 */
+	protected function _load(
+		array $file_paths = [],
+		string $class_prefix = 'EE_',
+		string $class_name = '',
+		string $type = 'class',
+		array $arguments = [],
+		bool $from_db = false,
+		bool $cache = true,
+		bool $load_only = false
+	) {
+		$class_name = ltrim($class_name, '\\');
+		// strip php file extension
+		$class_name = str_replace('.php', '', trim($class_name));
+		// does the class have a prefix ?
+		if (! empty($class_prefix) && $class_prefix !== 'addon') {
+			// make sure $class_prefix is uppercase
+			$class_prefix = strtoupper(trim($class_prefix));
+			// add class prefix ONCE!!!
+			$class_name = $class_prefix . str_replace($class_prefix, '', $class_name);
+		}
+		$class_name   = $this->class_cache->getFqnForAlias($class_name);
+		$class_exists = class_exists($class_name, false);
+		// if we're only loading the class and it already exists, then let's just return true immediately
+		if ($load_only && $class_exists) {
+			return true;
+		}
+		$arguments = is_array($arguments) ? $arguments : [$arguments];
+		// $this->_cache_on is toggled during the recursive loading that can occur with dependency injection
+		// $cache is controlled by individual calls to separate Registry loader methods like load_class()
+		// $load_only is also controlled by individual calls to separate Registry loader methods like load_file()
+		if ($this->_cache_on && $cache && ! $load_only) {
+			// return object if it's already cached
+			$cached_class = $this->_get_cached_class($class_name, $class_prefix, $arguments);
+			if ($cached_class !== null) {
+				return $cached_class;
+			}
+		}
+		// if the class doesn't already exist.. then we need to try and find the file and load it
+		if (! $class_exists) {
+			// get full path to file
+			$path = $this->_resolve_path($class_name, $type, $file_paths);
+			// load the file
+			$loaded = $this->_require_file($path, $class_name, $type, $file_paths);
+			// if we are only loading a file but NOT instantiating an object
+			// then return boolean for whether class was loaded or not
+			if ($load_only) {
+				return $loaded;
+			}
+			// if an object was expected but loading failed, then return nothing
+			if (! $loaded) {
+				return null;
+			}
+		}
+		// instantiate the requested object
+		$class_obj = $this->_create_object($class_name, $arguments, $type, $from_db);
+		if ($this->_cache_on && $cache) {
+			// save it for later... kinda like gum  { : $
+			$this->_set_cached_class(
+				$class_obj,
+				$class_name,
+				$class_prefix,
+				$from_db,
+				$arguments
+			);
+		}
+		$this->_cache_on = true;
+		return $class_obj;
+	}
+
+
+	/**
+	 * @param string $class_name
+	 * @param string $default have to specify something, but not anything that will conflict
+	 * @return mixed|string
+	 */
+	protected function get_class_abbreviation(string $class_name, string $default = 'FANCY_BATMAN_PANTS')
+	{
+		return $this->_class_abbreviations[ $class_name ] ?? $default;
+	}
+
+
+	/**
+	 * attempts to find a cached version of the requested class
+	 * by looking in the following places:
+	 *        $this->{$class_abbreviation}            ie:    $this->CART
+	 *        $this->{$class_name}                        ie:    $this->Some_Class
+	 *        $this->LIB->{$class_name}                ie:    $this->LIB->Some_Class
+	 *        $this->addon->{$class_name}    ie:    $this->addon->Some_Addon_Class
+	 *
+	 * @param string $class_name
+	 * @param string $class_prefix
+	 * @param array  $arguments
+	 * @return mixed
+	 */
+	protected function _get_cached_class(
+		string $class_name,
+		string $class_prefix = '',
+		array $arguments = []
+	) {
+		if ($class_name === 'EE_Registry') {
+			return $this;
+		}
+		$class_abbreviation = $this->get_class_abbreviation($class_name);
+		// check if class has already been loaded, and return it if it has been
+		if (isset($this->{$class_abbreviation})) {
+			return $this->{$class_abbreviation};
+		}
+		$class_name = str_replace('\\', '_', $class_name);
+		if (isset($this->{$class_name})) {
+			return $this->{$class_name};
+		}
+		if ($class_prefix === 'addon' && $this->addons->has($class_name)) {
+			return $this->addons->get($class_name);
+		}
+		$object_identifier = $this->object_identifier->getIdentifier($class_name, $arguments);
+		if ($this->LIB->has($object_identifier)) {
+			return $this->LIB->get($object_identifier);
+		}
+		foreach ($this->LIB as $key => $object) {
+			if (
+				// request does not contain new arguments and therefore no args identifier
+				! $this->object_identifier->hasArguments($object_identifier)
+				// but previously cached class with args was found
+				&& $this->object_identifier->fqcnMatchesObjectIdentifier($class_name, $key)
+			) {
+				return $object;
+			}
+		}
+		return null;
+	}
+
+
+	/**
+	 * removes a cached version of the requested class
+	 *
+	 * @param string  $class_name
+	 * @param boolean $addon
+	 * @param array   $arguments
+	 * @return boolean
+	 */
+	public function clear_cached_class(
+		string $class_name,
+		bool $addon = false,
+		array $arguments = []
+	): bool {
+		$class_abbreviation = $this->get_class_abbreviation($class_name);
+		// check if class has already been loaded, and return it if it has been
+		if (isset($this->{$class_abbreviation})) {
+			$this->{$class_abbreviation} = null;
+			return true;
+		}
+		$class_name = str_replace('\\', '_', $class_name);
+		if (isset($this->{$class_name})) {
+			$this->{$class_name} = null;
+			return true;
+		}
+		if ($addon && $this->addons->has($class_name)) {
+			$this->addons->remove($class_name);
+			return true;
+		}
+		$class_name = $this->object_identifier->getIdentifier($class_name, $arguments);
+		if ($this->LIB->has($class_name)) {
+			$this->LIB->remove($class_name);
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * _set_cached_class
+	 * attempts to cache the instantiated class locally
+	 * in one of the following places, in the following order:
+	 *        $this->{class_abbreviation}   ie:    $this->CART
+	 *        $this->{$class_name}          ie:    $this->Some_Class
+	 *        $this->addon->{$$class_name}    ie:    $this->addon->Some_Addon_Class
+	 *        $this->LIB->{$class_name}     ie:    $this->LIB->Some_Class
+	 *
+	 * @param object $class_obj
+	 * @param string $class_name
+	 * @param string $class_prefix
+	 * @param bool   $from_db
+	 * @param array  $arguments
+	 * @return void
+	 */
+	protected function _set_cached_class(
+		$class_obj,
+		string $class_name,
+		string $class_prefix = '',
+		bool $from_db = false,
+		array $arguments = []
+	) {
+		if ($class_name === 'EE_Registry' || empty($class_obj)) {
+			return;
+		}
+		// return newly instantiated class
+		$class_abbreviation = $this->get_class_abbreviation($class_name, '');
+		if ($class_abbreviation) {
+			$this->{$class_abbreviation} = $class_obj;
+			return;
+		}
+		$class_name = str_replace('\\', '_', $class_name);
+		if (property_exists($this, $class_name)) {
+			$this->{$class_name} = $class_obj;
+			return;
+		}
+		if ($class_prefix === 'addon') {
+			$this->addons->add($class_name, $class_obj);
+			return;
+		}
+		if (! $from_db) {
+			$class_name = $this->object_identifier->getIdentifier($class_name, $arguments);
+			$this->LIB->add($class_name, $class_obj);
+		}
+	}
+
+
+	/**
+	 * attempts to find a full valid filepath for the requested class.
+	 * loops thru each of the base paths in the $file_paths array and appends : "{classname} . {file type} . php"
+	 * then returns that path if the target file has been found and is readable
+	 *
+	 * @param string $class_name
+	 * @param string $type
+	 * @param array  $file_paths
+	 * @return string | bool
+	 */
+	protected function _resolve_path(string $class_name, string $type = '', array $file_paths = [])
+	{
+		// make sure $file_paths is an array
+		$file_paths = is_array($file_paths)
+			? $file_paths
+			: [$file_paths];
+		// cycle thru paths
+		foreach ($file_paths as $key => $file_path) {
+			// convert all separators to proper /, if no filepath, then use EE_CLASSES
+			$file_path = $file_path
+				? str_replace(['/', '\\'], '/', $file_path)
+				: EE_CLASSES;
+			// prep file type
+			$type = ! empty($type)
+				? trim($type, '.') . '.'
+				: '';
+			// build full file path
+			$file_paths[ $key ] = rtrim($file_path, '/') . '/' . $class_name . '.' . $type . 'php';
+			// does the file exist and can be read ?
+			if (is_readable($file_paths[ $key ])) {
+				return $file_paths[ $key ];
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 * basically just performs a require_once()
+	 * but with some error handling
+	 *
+	 * @param string $path
+	 * @param string $class_name
+	 * @param string $type
+	 * @param array  $file_paths
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _require_file(string $path, string $class_name, string $type = '', array $file_paths = []): bool
+	{
+		$this->resolve_legacy_class_parent($class_name);
+		// don't give up! you gotta...
+		try {
+			// does the file exist and can it be read ?
+			if (! $path) {
+				// just in case the file has already been autoloaded,
+				// but discrepancies in the naming schema are preventing it from
+				// being loaded via one of the EE_Registry::load_*() methods,
+				// then let's try one last hail mary before throwing an exception
+				// and call class_exists() again, but with autoloading turned ON
+				if (class_exists($class_name)) {
+					return true;
+				}
+				// so sorry, can't find the file
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							'The %1$s file %2$s could not be located or is not readable due to file permissions. Please ensure that the following filepath(s) are correct: %3$s',
+							'event_espresso'
+						),
+						trim($type, '.'),
+						$class_name,
+						'<br />' . implode(',<br />', $file_paths)
+					)
+				);
+			}
+			// get the file
+			require_once($path);
+			// if the class isn't already declared somewhere
+			if (class_exists($class_name, false) === false) {
+				// so sorry, not a class
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							'The %s file %s does not appear to contain the %s Class.',
+							'event_espresso'
+						),
+						$type,
+						$path,
+						$class_name
+					)
+				);
+			}
+		} catch (EE_Error $e) {
+			$e->get_error();
+			return false;
+		}
+		return true;
+	}
+
+
+	/**
+	 * Some of our legacy classes that extended a parent class would simply use a require() statement
+	 * before their class declaration in order to ensure that the parent class was loaded.
+	 * This is not ideal, but it's nearly impossible to determine the parent class of a non-namespaced class,
+	 * without triggering a fatal error because the parent class has yet to be loaded and therefore doesn't exist.
+	 *
+	 * @param string $class_name
+	 */
+	protected function resolve_legacy_class_parent(string $class_name = '')
+	{
+		try {
+			$legacy_parent_class_map = [
+				'EE_Payment_Processor' => 'core/business/EE_Processor_Base.class.php',
+			];
+			if (isset($legacy_parent_class_map[ $class_name ])) {
+				require_once EE_PLUGIN_DIR_PATH . $legacy_parent_class_map[ $class_name ];
+			}
+		} catch (Exception $exception) {
+		}
+	}
+
+
+	/**
+	 * _create_object
+	 * Attempts to instantiate the requested class via any of the
+	 * commonly used instantiation methods employed throughout EE.
+	 * The priority for instantiation is as follows:
+	 *        - abstract classes or any class flagged as "load only" (no instantiation occurs)
+	 *        - model objects via their 'new_instance_from_db' method
+	 *        - model objects via their 'new_instance' method
+	 *        - "singleton" classes" via their 'instance' method
+	 *    - standard instantiable classes via their __constructor
+	 * Prior to instantiation, if the classname exists in the dependency_map,
+	 * then the constructor for the requested class will be examined to determine
+	 * if any dependencies exist, and if they can be injected.
+	 * If so, then those classes will be added to the array of arguments passed to the constructor
+	 *
+	 * @param string $class_name
+	 * @param array  $arguments
+	 * @param string $type
+	 * @param bool   $from_db
+	 * @return null|object|bool
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 */
+	protected function _create_object(
+		string $class_name,
+		array $arguments = [],
+		string $type = '',
+		bool $from_db = false
+	) {
+		// create reflection
+		$reflector = $this->mirror->getReflectionClass($class_name);
+		// make sure arguments are an array
+		$arguments = is_array($arguments)
+			? $arguments
+			: [$arguments];
+		// and if arguments array is numerically and sequentially indexed, then we want it to remain as is,
+		// else wrap it in an additional array so that it doesn't get split into multiple parameters
+		$arguments = $this->_array_is_numerically_and_sequentially_indexed($arguments)
+			? $arguments
+			: [$arguments];
+		// attempt to inject dependencies ?
+		if ($this->_dependency_map->has($class_name)) {
+			$arguments = $this->_resolve_dependencies($reflector, $class_name, $arguments);
+		}
+		// instantiate the class if possible
+		if ($reflector->isAbstract()) {
+			// nothing to instantiate, loading file was enough
+			// does not throw an exception so $instantiation_mode is unused
+			// $instantiation_mode = "1) no constructor abstract class";
+			return true;
+		}
+		if (
+			empty($arguments)
+			&& $this->mirror->getConstructorFromReflection($reflector) === null
+			&& $reflector->isInstantiable()
+		) {
+			// no constructor = static methods only... nothing to instantiate, loading file was enough
+			// $instantiation_mode = "2) no constructor but instantiable";
+			return $reflector->newInstance();
+		}
+		if ($from_db && method_exists($class_name, 'new_instance_from_db')) {
+			// $instantiation_mode = "3) new_instance_from_db()";
+			return call_user_func_array([$class_name, 'new_instance_from_db'], $arguments);
+		}
+		if (method_exists($class_name, 'new_instance')) {
+			// $instantiation_mode = "4) new_instance()";
+			return call_user_func_array([$class_name, 'new_instance'], $arguments);
+		}
+		if (method_exists($class_name, 'instance')) {
+			// $instantiation_mode = "5) instance()";
+			return call_user_func_array([$class_name, 'instance'], $arguments);
+		}
+		if ($reflector->isInstantiable()) {
+			// $instantiation_mode = "6) constructor";
+			return $reflector->newInstanceArgs($arguments);
+		}
+		// heh ? something's not right !
+		throw new EE_Error(
+			sprintf(
+				esc_html__('The %s file %s could not be instantiated.', 'event_espresso'),
+				$type,
+				$class_name
+			)
+		);
+	}
+
+
+	/**
+	 * @see http://stackoverflow.com/questions/173400/how-to-check-if-php-array-is-associative-or-sequential
+	 * @param array $array
+	 * @return bool
+	 */
+	protected function _array_is_numerically_and_sequentially_indexed(array $array): bool
+	{
+		return empty($array) || array_keys($array) === range(0, count($array) - 1);
+	}
+
+
+	/**
+	 * _resolve_dependencies
+	 * examines the constructor for the requested class to determine
+	 * if any dependencies exist, and if they can be injected.
+	 * If so, then those classes will be added to the array of arguments passed to the constructor
+	 * PLZ NOTE: this is achieved by type hinting the constructor params
+	 * For example:
+	 *        if attempting to load a class "Foo" with the following constructor:
+	 *        __construct( Bar $bar_class, Fighter $grohl_class )
+	 *        then $bar_class and $grohl_class will be added to the $arguments array,
+	 *        but only IF they are NOT already present in the incoming arguments array,
+	 *        and the correct classes can be loaded
+	 *
+	 * @param ReflectionClass $reflector
+	 * @param string          $class_name
+	 * @param array           $arguments
+	 * @return array
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _resolve_dependencies(
+		ReflectionClass $reflector,
+		string $class_name,
+		array $arguments = []
+	): array {
+		// let's examine the constructor
+		$constructor = $this->mirror->getConstructorFromReflection($reflector);
+		// whu? huh? nothing?
+		if (! $constructor) {
+			return $arguments;
+		}
+		// get constructor parameters
+		$params = $this->mirror->getParametersFromReflection($reflector);
+		// and the keys for the incoming arguments array so that we can compare existing arguments with what is expected
+		$argument_keys = array_keys($arguments);
+		// now loop thru all of the constructors expected parameters
+		foreach ($params as $index => $param) {
+			try {
+				// is this a dependency for a specific class ?
+				$param_class = $this->mirror->getParameterClassName($param, $class_name, $index);
+			} catch (ReflectionException $exception) {
+				// uh-oh... most likely a legacy class that has not been autoloaded
+				// let's try to derive the classname from what we have now
+				// and hope that the property var name is close to the class name
+				$param_class = $param->getName();
+				$param_class = str_replace('_', ' ', $param_class);
+				$param_class = ucwords($param_class);
+				$param_class = str_replace(' ', '_', $param_class);
+			}
+			// BUT WAIT !!! This class may be an alias for something else (or getting replaced at runtime)
+			$param_class = $this->class_cache->isAlias($param_class, $class_name)
+				? $this->class_cache->getFqnForAlias($param_class, $class_name)
+				: $param_class;
+			// param is not even a class
+			if (
+				! empty($param_class)
+				&& ! class_exists($param_class, false)
+				// and something already exists in the incoming arguments for this param
+				&& array_key_exists($index, $argument_keys)
+				&& isset($arguments[ $argument_keys[ $index ] ])
+			) {
+				// so let's skip this argument and move on to the next
+				continue;
+			}
+			// parameter is type hinted as a class
+			if ($param_class !== null) {
+				// parameter exists as an incoming argument, AND it's the correct class
+				if (
+					array_key_exists($index, $argument_keys)
+					&& isset($arguments[ $argument_keys[ $index ] ])
+					&& $arguments[ $argument_keys[ $index ] ] instanceof $param_class
+				) {
+					// skip this argument and move on to the next
+					continue;
+				}
+				// parameter should be injected
+				if ($this->_dependency_map->has_dependency_for_class($class_name, $param_class)) {
+					$arguments = $this->_resolve_dependency(
+						$class_name,
+						$param_class,
+						$arguments,
+						$index
+					);
+				}
+			}
+			if (empty($arguments[ $index ])) {
+				$default_value = $this->mirror->getParameterDefaultValue(
+					$param,
+					$class_name,
+					$index
+				);
+				// if there's no default value, and the incoming argument is an array (albeit empty), then use that
+				$arguments[ $index ] = $default_value === null
+									   && isset($arguments[ $index ])
+									   && is_array($arguments[ $index ])
+					? $arguments[ $index ]
+					: $default_value;
+			}
+		}
+		return $arguments;
+	}
+
+
+	/**
+	 * @param string $class_name
+	 * @param string $param_class
+	 * @param array  $arguments
+	 * @param mixed  $index
+	 * @return array
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	protected function _resolve_dependency(string $class_name, string $param_class, array $arguments, $index): array
+	{
+		$dependency = null;
+		// should dependency be loaded from cache ?
+		$cache_on = $this->_dependency_map->loading_strategy_for_class_dependency(
+			$class_name,
+			$param_class
+		);
+		$cache_on = $cache_on !== EE_Dependency_Map::load_new_object;
+		// we might have a dependency...
+		// let's MAYBE try and find it in our cache if that's what's been requested
+		$cached_class = $cache_on
+			? $this->_get_cached_class($param_class)
+			: null;
+		// and grab it if it exists
+		if ($cached_class instanceof $param_class) {
+			$dependency = $cached_class;
+		} elseif ($param_class !== $class_name) {
+			// obtain the loader method from the dependency map
+			$loader = $this->_dependency_map->class_loader($param_class);
+			// is loader a custom closure ?
+			if ($loader instanceof Closure) {
+				$dependency = $loader($arguments);
+			} else {
+				// set the cache on property for the recursive loading call
+				$this->_cache_on = $cache_on;
+				// if not, then let's try and load it via the registry
+				if ($loader && method_exists($this, $loader)) {
+					$dependency = $this->{$loader}($param_class);
+				} else {
+					$dependency = LoaderFactory::getLoader()->load(
+						$param_class,
+						[],
+						$cache_on
+					);
+				}
+			}
+		}
+		// did we successfully find the correct dependency ?
+		if ($dependency instanceof $param_class) {
+			// then let's inject it into the incoming array of arguments at the correct location
+			$arguments[ $index ] = $dependency;
+		}
+		return $arguments;
+	}
+
+
+	/**
+	 * call any loader that's been registered in the EE_Dependency_Map::$_class_loaders array
+	 *
+	 * @param string $classname PLEASE NOTE: the class name needs to match what's registered
+	 *                          in the EE_Dependency_Map::$_class_loaders array,
+	 *                          including the class prefix, ie: "EE_", "EEM_", "EEH_", etc
+	 * @param array  $arguments
+	 * @return object
+	 */
+	public static function factory(string $classname, array $arguments = [])
+	{
+		$loader = self::instance()->_dependency_map->class_loader($classname);
+		if ($loader instanceof Closure) {
+			return $loader($arguments);
+		}
+		if (method_exists(self::instance(), $loader)) {
+			return self::instance()->{$loader}($classname, $arguments);
+		}
+		return null;
+	}
+
+
+	/**
+	 * Gets the addon by its class name
+	 *
+	 * @param string $class_name
+	 * @return EE_Addon
+	 */
+	public function getAddon(string $class_name): ?EE_Addon
+	{
+		$class_name = str_replace('\\', '_', $class_name);
+		return $this->addons->{$class_name} ?? null;
+	}
+
+
+	/**
+	 * removes the addon from the internal cache
+	 *
+	 * @param string $class_name
+	 * @return void
+	 */
+	public function removeAddon(string $class_name)
+	{
+		$class_name = str_replace('\\', '_', $class_name);
+		$this->addons->remove($class_name);
+	}
+
+
+	/**
+	 * Gets the addon by its name/slug (not classname. For that, just
+	 * use the get_addon() method above
+	 *
+	 * @param string $name
+	 * @return EE_Addon
+	 */
+	public function get_addon_by_name(string $name): ?EE_Addon
+	{
+		foreach ($this->addons as $addon) {
+			if ($addon->name() === $name) {
+				return $addon;
+			}
+		}
+		return null;
+	}
+
+
+	/**
+	 * Gets an array of all the registered addons, where the keys are their names.
+	 * (ie, what each returns for their name() function)
+	 * They're already available on EE_Registry::instance()->addons as properties,
+	 * where each property's name is the addon's classname,
+	 * So if you just want to get the addon by classname,
+	 * OR use the get_addon() method above.
+	 * PLEASE  NOTE:
+	 * addons with Fully Qualified Class Names
+	 * have had the namespace separators converted to underscores,
+	 * so a classname like Fully\Qualified\ClassName
+	 * would have been converted to Fully_Qualified_ClassName
+	 *
+	 * @return EE_Addon[] where the KEYS are the addon's name()
+	 */
+	public function get_addons_by_name(): array
+	{
+		$addons = [];
+		foreach ($this->addons as $addon) {
+			$addons[ $addon->name() ] = $addon;
+		}
+		return $addons;
+	}
+
+
+	/**
+	 * Resets the specified model's instance AND makes sure EE_Registry doesn't keep
+	 * a stale copy of it around
+	 *
+	 * @param string $model_name
+	 * @return EEM_Base
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function reset_model(string $model_name): ?EEM_Base
+	{
+		$model_class_name = strpos($model_name, 'EEM_') !== 0
+			? "EEM_$model_name"
+			: $model_name;
+		if (! $this->LIB->has($model_class_name)) {
+			return null;
+		}
+		$model = $this->LIB->get($model_class_name);
+		if (! $model instanceof EEM_Base) {
+			return null;
+		}
+		// get that model reset it and make sure we nuke the old reference to it
+		if ($model instanceof $model_class_name && is_callable([$model_class_name, 'reset'])) {
+			$this->LIB->remove($model_class_name);
+			$this->LIB->add($model_class_name, $model->reset());
+		} else {
+			throw new EE_Error(
+				sprintf(
+					esc_html__('Model %s does not have a method "reset"', 'event_espresso'),
+					$model_name
+				)
+			);
+		}
+		return $model;
+	}
+
+
+	/**
+	 * Resets the registry.
+	 * The criteria for what gets reset is based on what can be shared between sites on the same request when
+	 * switch_to_blog is used in a multisite install.  Here is a list of things that are NOT reset.
+	 * - $_dependency_map
+	 * - $_class_abbreviations
+	 * - $NET_CFG (EE_Network_Config): The config is shared network wide so no need to reset.
+	 * - $REQ:  Still on the same request so no need to change.
+	 * - $CAP: There is no site specific state in the EE_Capability class.
+	 * - $SSN: Although ideally, the session should not be shared between site switches, we can't reset it because only
+	 * one Session can be active in a single request.  Resetting could resolve in "headers already sent" errors.
+	 * - $addons:  In multisite, the state of the addons is something controlled via hooks etc in a normal request.  So
+	 *             for now, we won't reset the addons because it could break calls to an add-ons class/methods in the
+	 *             switch or on the restore.
+	 * - $modules
+	 * - $shortcodes
+	 * - $widgets
+	 *
+	 * @param boolean $hard             [deprecated]
+	 * @param boolean $reinstantiate    whether to create new instances of EE_Registry's singletons too,
+	 *                                  or just reset without re-instantiating (handy to set to FALSE if you're not
+	 *                                  sure if you CAN currently reinstantiate the singletons at the moment)
+	 * @param bool    $reset_models     Defaults to true.  When false, then the models are not reset.  This is so
+	 *                                  client
+	 *                                  code instead can just change the model context to a different blog id if
+	 *                                  necessary
+	 * @return EE_Registry
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function reset(bool $hard = false, bool $reinstantiate = true, bool $reset_models = true): EE_Registry
+	{
+		$instance            = self::instance();
+		$instance->_cache_on = true;
+		// reset some "special" classes
+		EEH_Activation::reset();
+		$hard                     = apply_filters('FHEE__EE_Registry__reset__hard', $hard);
+		$instance->CFG            = EE_Config::reset($hard, $reinstantiate);
+		$instance->CART           = null;
+		$instance->MRM            = null;
+		$instance->AssetsRegistry = LoaderFactory::getLoader()->getShared(
+			'EventEspresso\core\services\assets\Registry'
+		);
+		// messages reset
+		EED_Messages::reset();
+		// handle of objects cached on LIB
+		foreach (['LIB', 'modules'] as $cache) {
+			foreach ($instance->{$cache} as $class_name => $class) {
+				if (self::_reset_and_unset_object($class, $reset_models)) {
+					unset($instance->{$cache}->{$class_name});
+				}
+			}
+		}
+		return $instance;
+	}
+
+
+	/**
+	 * if passed object implements ResettableInterface, then call it's reset() method
+	 * if passed object implements InterminableInterface, then return false,
+	 * to indicate that it should NOT be cleared from the Registry cache
+	 *
+	 * @param      $object
+	 * @param bool $reset_models
+	 * @return bool returns true if cached object should be unset
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private static function _reset_and_unset_object($object, bool $reset_models): bool
+	{
+		if (! is_object($object)) {
+			// don't unset anything that's not an object
+			return false;
+		}
+		if ($object instanceof EED_Module) {
+			$object::reset();
+			// don't unset modules
+			return false;
+		}
+		if ($object instanceof ResettableInterface) {
+			if ($object instanceof EEM_Base) {
+				if ($reset_models) {
+					$object->reset();
+					return true;
+				}
+				return false;
+			}
+			$object->reset();
+			return true;
+		}
+		if (! $object instanceof InterminableInterface) {
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * Gets all the custom post type models defined
+	 *
+	 * @return array keys are model "short names" (Eg "Event") and keys are classnames (eg "EEM_Event")
+	 */
+	public function cpt_models(): array
+	{
+		$cpt_models = [];
+		foreach ($this->non_abstract_db_models as $short_name => $classname) {
+			if (is_subclass_of($classname, 'EEM_CPT_Base')) {
+				$cpt_models[ $short_name ] = $classname;
+			}
+		}
+		return $cpt_models;
+	}
+
+
+	/**
+	 * @return EE_Config
+	 */
+	public static function CFG(): EE_Config
+	{
+		return self::instance()->CFG;
+	}
+
+
+	/**
+	 * @param string $class_name
+	 * @return ReflectionClass
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @deprecated 4.9.62.p
+	 */
+	public function get_ReflectionClass(string $class_name): ReflectionClass
+	{
+		return $this->mirror->getReflectionClass($class_name);
+	}
 }

Spacing +49 added lines, -49 removed lines

@@ -307,7 +307,7 @@ 
         $i18n_js_strings = (array) self::$i18n_js_strings;
         foreach ($i18n_js_strings as $key => $value) {
             if (is_scalar($value)) {
-                $i18n_js_strings[ $key ] = html_entity_decode((string) $value, ENT_QUOTES, 'UTF-8');
+                $i18n_js_strings[$key] = html_entity_decode((string) $value, ENT_QUOTES, 'UTF-8');
             }
         }
         return $i18n_js_strings;
@@ -322,7 +322,7 @@ 
     public static function localize_i18n_js_strings(): string
     {
         $i18n_js_strings = EE_Registry::sanitize_i18n_js_strings();
-        return '/* <![CDATA[ */ var eei18n = ' . wp_json_encode($i18n_js_strings) . '; /* ]]> */';
+        return '/* <![CDATA[ */ var eei18n = '.wp_json_encode($i18n_js_strings).'; /* ]]> */';
     }
 
 
@@ -341,7 +341,7 @@ 
             $module_class = get_class($module);
             $this->modules->add($module_class, $module);
         } else {
-            if (! class_exists('EE_Module_Request_Router', false)) {
+            if ( ! class_exists('EE_Module_Request_Router', false)) {
                 $this->load_core('Module_Request_Router');
             }
             EE_Module_Request_Router::module_factory($module);
@@ -380,10 +380,10 @@ 
                 EE_CORE,
                 EE_ADMIN,
                 EE_CPTS,
-                EE_CORE . 'CPTs/',
-                EE_CORE . 'data_migration_scripts/',
-                EE_CORE . 'request_stack/',
-                EE_CORE . 'middleware/',
+                EE_CORE.'CPTs/',
+                EE_CORE.'data_migration_scripts/',
+                EE_CORE.'request_stack/',
+                EE_CORE.'middleware/',
             ]
         );
         // retrieve instantiated class
@@ -419,7 +419,7 @@ 
         $service_paths = (array) apply_filters(
             'FHEE__EE_Registry__load_service__service_paths',
             [
-                EE_CORE . 'services/',
+                EE_CORE.'services/',
             ]
         );
         // retrieve instantiated class
@@ -559,10 +559,10 @@ 
     {
         $paths = [
             EE_LIBRARIES,
-            EE_LIBRARIES . 'messages/',
-            EE_LIBRARIES . 'shortcodes/',
-            EE_LIBRARIES . 'qtips/',
-            EE_LIBRARIES . 'payment_methods/',
+            EE_LIBRARIES.'messages/',
+            EE_LIBRARIES.'shortcodes/',
+            EE_LIBRARIES.'qtips/',
+            EE_LIBRARIES.'payment_methods/',
         ];
         // retrieve instantiated class
         return $this->_load(
@@ -631,10 +631,10 @@ 
     public function load_model_class(string $class_name, $arguments = [], bool $load_only = true)
     {
         $paths = [
-            EE_MODELS . 'fields/',
-            EE_MODELS . 'helpers/',
-            EE_MODELS . 'relations/',
-            EE_MODELS . 'strategies/',
+            EE_MODELS.'fields/',
+            EE_MODELS.'helpers/',
+            EE_MODELS.'relations/',
+            EE_MODELS.'strategies/',
         ];
         // retrieve instantiated class
         return $this->_load(
@@ -658,7 +658,7 @@ 
      */
     public function is_model_name(string $model_name): bool
     {
-        return isset($this->models[ $model_name ]);
+        return isset($this->models[$model_name]);
     }
 
 
@@ -790,7 +790,7 @@ 
                 return $cached_class;
             }
         }                                                           // obtain the loader method from the dependency map
-        $loader = $this->_dependency_map->class_loader($class_name);// instantiate the requested object
+        $loader = $this->_dependency_map->class_loader($class_name); // instantiate the requested object
         if ($loader instanceof Closure) {
             $class_obj = $loader($arguments);
         } else {
@@ -832,7 +832,7 @@ 
             case 1:
                 // if it's a FQCN then maybe the class is registered with a preceding \
                 $class_name = strpos($class_name, '\\') !== false
-                    ? '\\' . ltrim($class_name, '\\')
+                    ? '\\'.ltrim($class_name, '\\')
                     : $class_name;
                 break;
             case 2:
@@ -886,11 +886,11 @@ 
         // strip php file extension
         $class_name = str_replace('.php', '', trim($class_name));
         // does the class have a prefix ?
-        if (! empty($class_prefix) && $class_prefix !== 'addon') {
+        if ( ! empty($class_prefix) && $class_prefix !== 'addon') {
             // make sure $class_prefix is uppercase
             $class_prefix = strtoupper(trim($class_prefix));
             // add class prefix ONCE!!!
-            $class_name = $class_prefix . str_replace($class_prefix, '', $class_name);
+            $class_name = $class_prefix.str_replace($class_prefix, '', $class_name);
         }
         $class_name   = $this->class_cache->getFqnForAlias($class_name);
         $class_exists = class_exists($class_name, false);
@@ -910,7 +910,7 @@ 
             }
         }
         // if the class doesn't already exist.. then we need to try and find the file and load it
-        if (! $class_exists) {
+        if ( ! $class_exists) {
             // get full path to file
             $path = $this->_resolve_path($class_name, $type, $file_paths);
             // load the file
@@ -921,7 +921,7 @@ 
                 return $loaded;
             }
             // if an object was expected but loading failed, then return nothing
-            if (! $loaded) {
+            if ( ! $loaded) {
                 return null;
             }
         }
@@ -949,7 +949,7 @@ 
      */
     protected function get_class_abbreviation(string $class_name, string $default = 'FANCY_BATMAN_PANTS')
     {
-        return $this->_class_abbreviations[ $class_name ] ?? $default;
+        return $this->_class_abbreviations[$class_name] ?? $default;
     }
 
 
@@ -1082,7 +1082,7 @@ 
             $this->addons->add($class_name, $class_obj);
             return;
         }
-        if (! $from_db) {
+        if ( ! $from_db) {
             $class_name = $this->object_identifier->getIdentifier($class_name, $arguments);
             $this->LIB->add($class_name, $class_obj);
         }
@@ -1113,13 +1113,13 @@ 
                 : EE_CLASSES;
             // prep file type
             $type = ! empty($type)
-                ? trim($type, '.') . '.'
+                ? trim($type, '.').'.'
                 : '';
             // build full file path
-            $file_paths[ $key ] = rtrim($file_path, '/') . '/' . $class_name . '.' . $type . 'php';
+            $file_paths[$key] = rtrim($file_path, '/').'/'.$class_name.'.'.$type.'php';
             // does the file exist and can be read ?
-            if (is_readable($file_paths[ $key ])) {
-                return $file_paths[ $key ];
+            if (is_readable($file_paths[$key])) {
+                return $file_paths[$key];
             }
         }
         return false;
@@ -1144,7 +1144,7 @@ 
         // don't give up! you gotta...
         try {
             // does the file exist and can it be read ?
-            if (! $path) {
+            if ( ! $path) {
                 // just in case the file has already been autoloaded,
                 // but discrepancies in the naming schema are preventing it from
                 // being loaded via one of the EE_Registry::load_*() methods,
@@ -1162,7 +1162,7 @@ 
                         ),
                         trim($type, '.'),
                         $class_name,
-                        '<br />' . implode(',<br />', $file_paths)
+                        '<br />'.implode(',<br />', $file_paths)
                     )
                 );
             }
@@ -1205,8 +1205,8 @@ 
             $legacy_parent_class_map = [
                 'EE_Payment_Processor' => 'core/business/EE_Processor_Base.class.php',
             ];
-            if (isset($legacy_parent_class_map[ $class_name ])) {
-                require_once EE_PLUGIN_DIR_PATH . $legacy_parent_class_map[ $class_name ];
+            if (isset($legacy_parent_class_map[$class_name])) {
+                require_once EE_PLUGIN_DIR_PATH.$legacy_parent_class_map[$class_name];
             }
         } catch (Exception $exception) {
         }
@@ -1344,7 +1344,7 @@ 
         // let's examine the constructor
         $constructor = $this->mirror->getConstructorFromReflection($reflector);
         // whu? huh? nothing?
-        if (! $constructor) {
+        if ( ! $constructor) {
             return $arguments;
         }
         // get constructor parameters
@@ -1375,7 +1375,7 @@ 
                 && ! class_exists($param_class, false)
                 // and something already exists in the incoming arguments for this param
                 && array_key_exists($index, $argument_keys)
-                && isset($arguments[ $argument_keys[ $index ] ])
+                && isset($arguments[$argument_keys[$index]])
             ) {
                 // so let's skip this argument and move on to the next
                 continue;
@@ -1385,8 +1385,8 @@ 
                 // parameter exists as an incoming argument, AND it's the correct class
                 if (
                     array_key_exists($index, $argument_keys)
-                    && isset($arguments[ $argument_keys[ $index ] ])
-                    && $arguments[ $argument_keys[ $index ] ] instanceof $param_class
+                    && isset($arguments[$argument_keys[$index]])
+                    && $arguments[$argument_keys[$index]] instanceof $param_class
                 ) {
                     // skip this argument and move on to the next
                     continue;
@@ -1401,17 +1401,17 @@ 
                     );
                 }
             }
-            if (empty($arguments[ $index ])) {
+            if (empty($arguments[$index])) {
                 $default_value = $this->mirror->getParameterDefaultValue(
                     $param,
                     $class_name,
                     $index
                 );
                 // if there's no default value, and the incoming argument is an array (albeit empty), then use that
-                $arguments[ $index ] = $default_value === null
-                                       && isset($arguments[ $index ])
-                                       && is_array($arguments[ $index ])
-                    ? $arguments[ $index ]
+                $arguments[$index] = $default_value === null
+                                       && isset($arguments[$index])
+                                       && is_array($arguments[$index])
+                    ? $arguments[$index]
                     : $default_value;
             }
         }
@@ -1470,7 +1470,7 @@ 
         // did we successfully find the correct dependency ?
         if ($dependency instanceof $param_class) {
             // then let's inject it into the incoming array of arguments at the correct location
-            $arguments[ $index ] = $dependency;
+            $arguments[$index] = $dependency;
         }
         return $arguments;
     }
@@ -1561,7 +1561,7 @@ 
     {
         $addons = [];
         foreach ($this->addons as $addon) {
-            $addons[ $addon->name() ] = $addon;
+            $addons[$addon->name()] = $addon;
         }
         return $addons;
     }
@@ -1581,11 +1581,11 @@ 
         $model_class_name = strpos($model_name, 'EEM_') !== 0
             ? "EEM_$model_name"
             : $model_name;
-        if (! $this->LIB->has($model_class_name)) {
+        if ( ! $this->LIB->has($model_class_name)) {
             return null;
         }
         $model = $this->LIB->get($model_class_name);
-        if (! $model instanceof EEM_Base) {
+        if ( ! $model instanceof EEM_Base) {
             return null;
         }
         // get that model reset it and make sure we nuke the old reference to it
@@ -1674,7 +1674,7 @@ 
      */
     private static function _reset_and_unset_object($object, bool $reset_models): bool
     {
-        if (! is_object($object)) {
+        if ( ! is_object($object)) {
             // don't unset anything that's not an object
             return false;
         }
@@ -1694,7 +1694,7 @@ 
             $object->reset();
             return true;
         }
-        if (! $object instanceof InterminableInterface) {
+        if ( ! $object instanceof InterminableInterface) {
             return true;
         }
         return false;
@@ -1711,7 +1711,7 @@ 
         $cpt_models = [];
         foreach ($this->non_abstract_db_models as $short_name => $classname) {
             if (is_subclass_of($classname, 'EEM_CPT_Base')) {
-                $cpt_models[ $short_name ] = $classname;
+                $cpt_models[$short_name] = $classname;
             }
         }
         return $cpt_models;

core/helpers/EEH_Form_Fields.helper.php

Indentation +1946 added lines, -1946 removed lines

@@ -27,1973 +27,1973 @@
  */
 class EEH_Form_Fields
 {
-    /**
-     *  Generates HTML for the forms used on admin pages
-     *
-     *
-     * @static
-     * @access public
-     * @param array $input_vars - array of input field details
-     *                          format:
-     *                          $template_form_fields['field-id'] = array(
-     *                          'name' => 'name_attribute',
-     *                          'label' => esc_html__('Field Label', 'event_espresso'), //or false
-     *                          'input' => 'hidden', //field input type can be 'text', 'select', 'textarea', 'hidden',
-     *                          'checkbox', 'wp_editor'
-     *                          'type' => 'int', //what "type" the value is (i.e. string, int etc)
-     *                          'required' => false, //boolean for whether the field is required
-     *                          'validation' => true, //boolean, whether to validate the field (todo)
-     *                          'value' => 'some_value_for_field', //what value is used for field
-     *                          'format' => '%d', //what format the value is (%d, %f, or %s)
-     *                          'db-col' => 'column_in_db' //used to indicate which column the field corresponds with
-     *                          in the db
-     *                          'options' => optiona, optionb || array('value' => 'label', '') //if the input type is
-     *                          "select", this allows you to set the args for the different <option> tags.
-     *                          'tabindex' => 1 //this allows you to set the tabindex for the field.
-     *                          'append_content' => '' //this allows you to send in html content to append to the
-     *                          field.
-     *                          )
-     * @param array $form_id    - used for defining unique identifiers for the form.
-     * @return string
-     * @todo   : at some point we can break this down into other static methods to abstract it a bit better.
-     */
-    public static function get_form_fields($input_vars = [], $form_id = false)
-    {
-
-        if (empty($input_vars)) {
-            EE_Error::add_error(
-                esc_html__('missing required variables for the form field generator', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-
-        $output        = "";
-        $inputs        = [];
-        $hidden_inputs = [];
-
-        // cycle thru inputs
-        foreach ($input_vars as $input_key => $input_value) {
-            $defaults = [
-                'append_content' => '',
-                'css_class'      => '',
-                'cols'           => 80,
-                'db-col'         => 'column_in_db',
-                'format'         => '%d',
-                'input'          => 'hidden',
-                'label'          => esc_html__('No label', 'event_espresso'),
-                'name'           => $input_key,
-                'options'        => [],
-                'required'       => false,
-                'tabindex'       => 0,
-                'rows'           => 10,
-                'type'           => 'int',
-                'validation'     => true,
-                'value'          => 'some_value_for_field',
-            ];
-
-            $input_value = wp_parse_args($input_value, $defaults);
-
-            $append_content = $input_value['append_content'];
-            $css_class      = $input_value['css_class'];
-            $cols           = $input_value['cols'];
-            $label          = $input_value['label'];
-            $name           = $input_value['name'];
-            $options        = $input_value['options'];
-            $required       = $input_value['required'];
-            $tab_index      = $input_value['tabindex'];
-            $rows           = $input_value['rows'];
-            $type           = $input_value['input'];
-            $value          = $input_value['value'];
-
-            $id    = $form_id ? $form_id . '-' . $input_key : $input_key;
-            $class = $required ? 'required ' . $css_class : $css_class;
-
-            // what type of input are we dealing with ?
-            switch ($type) {
-                case 'checkbox':
-                case 'radio':
-                    $field = self::adminMulti($value, $class, $id, $name, $required, $tab_index, $type, 1, $label);
-                    $field .= $append_content ?: '';
-                    break;
-
-                case 'hidden':
-                    $field           = null;
-                    $hidden_inputs[] = self::adminHidden($css_class, $id, $name, $value);
-                    break;
-
-                case 'select':
-                    $options = is_array($options) ? $options : explode(',', $options);
-                    $field   = self::adminLabel($id, $label, $required);
-                    $field   .= self::adminSelect($value, $class, $id, $name, $required, $tab_index, $options);
-                    $field   .= $append_content ?: '';
-                    break;
-
-                case 'textarea':
-                    $field = self::adminLabel($id, $label, $required);
-                    $field .= self::adminTextarea($class, $cols, $id, $name, $required, $rows, $tab_index, $value);
-                    $field .= $append_content ?: '';
-                    break;
-
-                case 'wp_editor':
-                    $label = esc_html($label);
-                    $field = "<h4>{$label}</h4>";
-                    $field .= $append_content ?: '';
-                    $field .= self::adminWpEditor(
-                        $class,
-                        $id,
-                        $name,
-                        $rows,
-                        $tab_index,
-                        $value
-                    );
-                    break;
-
-                default:
-                    $field = self::adminLabel($id, $label, $required);
-                    $field .= self::adminText($class, $id, $name, $required, $tab_index, $value);
-                    $field .= $append_content ?: '';
-            }
-            if ($field) {
-                $inputs[] = $field;
-            }
-        } // end foreach( $input_vars as $input_key => $input_value )
-
-        if (! empty($inputs)) {
-            $glue   = "
+	/**
+	 *  Generates HTML for the forms used on admin pages
+	 *
+	 *
+	 * @static
+	 * @access public
+	 * @param array $input_vars - array of input field details
+	 *                          format:
+	 *                          $template_form_fields['field-id'] = array(
+	 *                          'name' => 'name_attribute',
+	 *                          'label' => esc_html__('Field Label', 'event_espresso'), //or false
+	 *                          'input' => 'hidden', //field input type can be 'text', 'select', 'textarea', 'hidden',
+	 *                          'checkbox', 'wp_editor'
+	 *                          'type' => 'int', //what "type" the value is (i.e. string, int etc)
+	 *                          'required' => false, //boolean for whether the field is required
+	 *                          'validation' => true, //boolean, whether to validate the field (todo)
+	 *                          'value' => 'some_value_for_field', //what value is used for field
+	 *                          'format' => '%d', //what format the value is (%d, %f, or %s)
+	 *                          'db-col' => 'column_in_db' //used to indicate which column the field corresponds with
+	 *                          in the db
+	 *                          'options' => optiona, optionb || array('value' => 'label', '') //if the input type is
+	 *                          "select", this allows you to set the args for the different <option> tags.
+	 *                          'tabindex' => 1 //this allows you to set the tabindex for the field.
+	 *                          'append_content' => '' //this allows you to send in html content to append to the
+	 *                          field.
+	 *                          )
+	 * @param array $form_id    - used for defining unique identifiers for the form.
+	 * @return string
+	 * @todo   : at some point we can break this down into other static methods to abstract it a bit better.
+	 */
+	public static function get_form_fields($input_vars = [], $form_id = false)
+	{
+
+		if (empty($input_vars)) {
+			EE_Error::add_error(
+				esc_html__('missing required variables for the form field generator', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+
+		$output        = "";
+		$inputs        = [];
+		$hidden_inputs = [];
+
+		// cycle thru inputs
+		foreach ($input_vars as $input_key => $input_value) {
+			$defaults = [
+				'append_content' => '',
+				'css_class'      => '',
+				'cols'           => 80,
+				'db-col'         => 'column_in_db',
+				'format'         => '%d',
+				'input'          => 'hidden',
+				'label'          => esc_html__('No label', 'event_espresso'),
+				'name'           => $input_key,
+				'options'        => [],
+				'required'       => false,
+				'tabindex'       => 0,
+				'rows'           => 10,
+				'type'           => 'int',
+				'validation'     => true,
+				'value'          => 'some_value_for_field',
+			];
+
+			$input_value = wp_parse_args($input_value, $defaults);
+
+			$append_content = $input_value['append_content'];
+			$css_class      = $input_value['css_class'];
+			$cols           = $input_value['cols'];
+			$label          = $input_value['label'];
+			$name           = $input_value['name'];
+			$options        = $input_value['options'];
+			$required       = $input_value['required'];
+			$tab_index      = $input_value['tabindex'];
+			$rows           = $input_value['rows'];
+			$type           = $input_value['input'];
+			$value          = $input_value['value'];
+
+			$id    = $form_id ? $form_id . '-' . $input_key : $input_key;
+			$class = $required ? 'required ' . $css_class : $css_class;
+
+			// what type of input are we dealing with ?
+			switch ($type) {
+				case 'checkbox':
+				case 'radio':
+					$field = self::adminMulti($value, $class, $id, $name, $required, $tab_index, $type, 1, $label);
+					$field .= $append_content ?: '';
+					break;
+
+				case 'hidden':
+					$field           = null;
+					$hidden_inputs[] = self::adminHidden($css_class, $id, $name, $value);
+					break;
+
+				case 'select':
+					$options = is_array($options) ? $options : explode(',', $options);
+					$field   = self::adminLabel($id, $label, $required);
+					$field   .= self::adminSelect($value, $class, $id, $name, $required, $tab_index, $options);
+					$field   .= $append_content ?: '';
+					break;
+
+				case 'textarea':
+					$field = self::adminLabel($id, $label, $required);
+					$field .= self::adminTextarea($class, $cols, $id, $name, $required, $rows, $tab_index, $value);
+					$field .= $append_content ?: '';
+					break;
+
+				case 'wp_editor':
+					$label = esc_html($label);
+					$field = "<h4>{$label}</h4>";
+					$field .= $append_content ?: '';
+					$field .= self::adminWpEditor(
+						$class,
+						$id,
+						$name,
+						$rows,
+						$tab_index,
+						$value
+					);
+					break;
+
+				default:
+					$field = self::adminLabel($id, $label, $required);
+					$field .= self::adminText($class, $id, $name, $required, $tab_index, $value);
+					$field .= $append_content ?: '';
+			}
+			if ($field) {
+				$inputs[] = $field;
+			}
+		} // end foreach( $input_vars as $input_key => $input_value )
+
+		if (! empty($inputs)) {
+			$glue   = "
                 </li>
                 <li>
                     ";
-            $inputs = implode($glue, $inputs);
-            $output = "
+			$inputs = implode($glue, $inputs);
+			$output = "
             <ul>
                 <li>
                 {$inputs} 
                 </li>
             </ul>
             ";
-        }
-        return $output . implode("\n", $hidden_inputs);
-    }
-
-
-    /**
-     * form_fields_array
-     * This utility function assembles form fields from a given structured array with field information.
-     * //TODO: This is an alternate generator that we may want to use instead.
-     *
-     * @param array $fields structured array of fields to assemble in the following format:
-     *                      [field_name] => array(
-     *                      ['label'] => 'label for field',
-     *                      ['labels'] => array('label_1', 'label_2'); //optional - if the field type is a multi select
-     *                      type of field you can indicated the labels for each option via this index
-     *                      ['extra_desc'] => 'extra description for the field', //optional
-     *                      ['type'] => 'textarea'|'text'|'wp_editor'|'checkbox'|'radio'|'hidden'|'select', //defaults
-     *                      to text
-     *                      ['value'] => 'value that goes in the field', //(if multi then this is an array of values
-     *                      and the 'default' paramater will be used for what is selected)
-     *                      ['default'] => 'default if the field type is multi (i.e. select or radios or checkboxes)',
-     *                      ['class'] => 'name-of-class(es)-for-input',
-     *                      ['classes'] => array('class_1', 'class_2'); //optional - if the field type is a multi
-     *                      select type of field you can indicate the css class for each option via this index.
-     *                      ['id'] => 'css-id-for-input') //defaults to 'field_name'
-     *                      ['unique_id'] => 1 //defaults to empty string.  This is useful for when the fields
-     *                      generated are going to be used in a loop and you want to make sure that the field
-     *                      identifiers are unique from each other.
-     *                      ['dimensions'] => array(100,300), //defaults to empty array.  This is used by field types
-     *                      such as textarea to indicate cols/rows.
-     *                      ['tabindex'] => '' //this allows you to set the tabindex for the field.
-     *                      ['wpeditor_args'] => array() //if the type of field is wpeditor then this can optionally
-     *                      contain an array of arguments for the editor setup.
-     *
-     * @return array         an array of inputs for form indexed by field name, and in the following structure:
-     *     [field_name] => array( 'label' => '{label_html}', 'field' => '{input_html}'
-     */
-    public static function get_form_fields_array($fields)
-    {
-
-        $form_fields = [];
-        $fields      = (array) $fields;
-
-        foreach ($fields as $field_name => $field_atts) {
-            // defaults:
-            $defaults = [
-                'class'         => '',
-                'classes'       => '',
-                'default'       => '',
-                'dimensions'    => ['10', '5'],
-                'extra_desc'    => '',
-                'id'            => $field_name,
-                'label'         => '',
-                'labels'        => '',
-                'required'      => false,
-                'tabindex'      => 0,
-                'type'          => 'text',
-                'unique_id'     => '',
-                'value'         => '',
-                'wpeditor_args' => [],
-            ];
-            // merge defaults with passed arguments
-            $_fields = wp_parse_args($field_atts, $defaults);
-
-            $class          = $_fields['class'];
-            $classes        = $_fields['classes'];
-            $default        = $_fields['default'];
-            $dims           = $_fields['dimensions'];
-            $extra_desc     = $_fields['extra_desc'];
-            $id             = $_fields['id'];
-            $label          = $_fields['label'];
-            $labels         = $_fields['labels'];
-            $required       = $_fields['required'];
-            $tab_index      = $_fields['tabindex'];
-            $type           = $_fields['type'];
-            $unique_id      = $_fields['unique_id'];
-            $value          = $_fields['value'];
-            $wp_editor_args = $_fields['wpeditor_args'];
-
-            // generate label
-            $label = ! empty($label) ? self::adminLabel($id, $label, $required) : '';
-            // generate field name
-            $name = ! empty($unique_id) ? $field_name . '[' . $unique_id . ']' : $field_name;
-
-            // we determine what we're building based on the type
-            switch ($type) {
-                case 'checkbox':
-                case 'radio':
-                    if (is_array($value)) {
-                        $c_input = '';
-                        foreach ($value as $key => $val) {
-                            $c_input .= self::adminMulti(
-                                $default,
-                                isset($classes[ $key ]) ? $classes[ $key ] : '',
-                                $field_name . '_' . $value,
-                                $name,
-                                $required,
-                                $tab_index,
-                                $type,
-                                $val,
-                                isset($labels[ $key ]) ? $labels[ $key ] : ''
-                            );
-                        }
-                        $field = $c_input;
-                    } else {
-                        $field = self::adminMulti(
-                            $default,
-                            $class,
-                            $id,
-                            $name,
-                            $required,
-                            $tab_index,
-                            $type,
-                            $value,
-                            $_fields['label']
-                        );
-                    }
-                    break;
-
-                case 'hidden':
-                    $field = self::adminHidden($class, $id, $name, $value);
-                    break;
-
-                case 'select':
-                    $options = [];
-                    foreach ($value as $key => $val) {
-                        $options[ $val ] = isset($labels[ $key ]) ? $labels[ $key ] : '';
-                    }
-                    $field = self::adminSelect($default, $class, $id, $name, $required, $tab_index, $options);
-                    break;
-
-                case 'textarea':
-                    $field =
-                        self::adminTextarea($class, $dims[0], $id, $name, $required, $dims[1], $tab_index, $value);
-                    break;
-
-                case 'wp_editor':
-                    $field = self::adminWpEditor(
-                        $class,
-                        $_fields['id'],
-                        $name,
-                        $dims[1],
-                        $tab_index,
-                        $value,
-                        $wp_editor_args
-                    );
-                    break;
-
-                default:
-                    $field = self::adminText($class, $id, $name, $required, $tab_index, $value);
-            }
-
-            $form_fields[ $field_name ] = ['label' => $label, 'field' => $field . $extra_desc];
-        }
-
-        return $form_fields;
-    }
-
-
-    /**
-     * @param string $class
-     * @param string $id
-     * @param string $name
-     * @param string $value
-     * @return string
-     * @since   4.10.14.p
-     */
-    private static function adminHidden($class, $id, $name, $value)
-    {
-        return "
+		}
+		return $output . implode("\n", $hidden_inputs);
+	}
+
+
+	/**
+	 * form_fields_array
+	 * This utility function assembles form fields from a given structured array with field information.
+	 * //TODO: This is an alternate generator that we may want to use instead.
+	 *
+	 * @param array $fields structured array of fields to assemble in the following format:
+	 *                      [field_name] => array(
+	 *                      ['label'] => 'label for field',
+	 *                      ['labels'] => array('label_1', 'label_2'); //optional - if the field type is a multi select
+	 *                      type of field you can indicated the labels for each option via this index
+	 *                      ['extra_desc'] => 'extra description for the field', //optional
+	 *                      ['type'] => 'textarea'|'text'|'wp_editor'|'checkbox'|'radio'|'hidden'|'select', //defaults
+	 *                      to text
+	 *                      ['value'] => 'value that goes in the field', //(if multi then this is an array of values
+	 *                      and the 'default' paramater will be used for what is selected)
+	 *                      ['default'] => 'default if the field type is multi (i.e. select or radios or checkboxes)',
+	 *                      ['class'] => 'name-of-class(es)-for-input',
+	 *                      ['classes'] => array('class_1', 'class_2'); //optional - if the field type is a multi
+	 *                      select type of field you can indicate the css class for each option via this index.
+	 *                      ['id'] => 'css-id-for-input') //defaults to 'field_name'
+	 *                      ['unique_id'] => 1 //defaults to empty string.  This is useful for when the fields
+	 *                      generated are going to be used in a loop and you want to make sure that the field
+	 *                      identifiers are unique from each other.
+	 *                      ['dimensions'] => array(100,300), //defaults to empty array.  This is used by field types
+	 *                      such as textarea to indicate cols/rows.
+	 *                      ['tabindex'] => '' //this allows you to set the tabindex for the field.
+	 *                      ['wpeditor_args'] => array() //if the type of field is wpeditor then this can optionally
+	 *                      contain an array of arguments for the editor setup.
+	 *
+	 * @return array         an array of inputs for form indexed by field name, and in the following structure:
+	 *     [field_name] => array( 'label' => '{label_html}', 'field' => '{input_html}'
+	 */
+	public static function get_form_fields_array($fields)
+	{
+
+		$form_fields = [];
+		$fields      = (array) $fields;
+
+		foreach ($fields as $field_name => $field_atts) {
+			// defaults:
+			$defaults = [
+				'class'         => '',
+				'classes'       => '',
+				'default'       => '',
+				'dimensions'    => ['10', '5'],
+				'extra_desc'    => '',
+				'id'            => $field_name,
+				'label'         => '',
+				'labels'        => '',
+				'required'      => false,
+				'tabindex'      => 0,
+				'type'          => 'text',
+				'unique_id'     => '',
+				'value'         => '',
+				'wpeditor_args' => [],
+			];
+			// merge defaults with passed arguments
+			$_fields = wp_parse_args($field_atts, $defaults);
+
+			$class          = $_fields['class'];
+			$classes        = $_fields['classes'];
+			$default        = $_fields['default'];
+			$dims           = $_fields['dimensions'];
+			$extra_desc     = $_fields['extra_desc'];
+			$id             = $_fields['id'];
+			$label          = $_fields['label'];
+			$labels         = $_fields['labels'];
+			$required       = $_fields['required'];
+			$tab_index      = $_fields['tabindex'];
+			$type           = $_fields['type'];
+			$unique_id      = $_fields['unique_id'];
+			$value          = $_fields['value'];
+			$wp_editor_args = $_fields['wpeditor_args'];
+
+			// generate label
+			$label = ! empty($label) ? self::adminLabel($id, $label, $required) : '';
+			// generate field name
+			$name = ! empty($unique_id) ? $field_name . '[' . $unique_id . ']' : $field_name;
+
+			// we determine what we're building based on the type
+			switch ($type) {
+				case 'checkbox':
+				case 'radio':
+					if (is_array($value)) {
+						$c_input = '';
+						foreach ($value as $key => $val) {
+							$c_input .= self::adminMulti(
+								$default,
+								isset($classes[ $key ]) ? $classes[ $key ] : '',
+								$field_name . '_' . $value,
+								$name,
+								$required,
+								$tab_index,
+								$type,
+								$val,
+								isset($labels[ $key ]) ? $labels[ $key ] : ''
+							);
+						}
+						$field = $c_input;
+					} else {
+						$field = self::adminMulti(
+							$default,
+							$class,
+							$id,
+							$name,
+							$required,
+							$tab_index,
+							$type,
+							$value,
+							$_fields['label']
+						);
+					}
+					break;
+
+				case 'hidden':
+					$field = self::adminHidden($class, $id, $name, $value);
+					break;
+
+				case 'select':
+					$options = [];
+					foreach ($value as $key => $val) {
+						$options[ $val ] = isset($labels[ $key ]) ? $labels[ $key ] : '';
+					}
+					$field = self::adminSelect($default, $class, $id, $name, $required, $tab_index, $options);
+					break;
+
+				case 'textarea':
+					$field =
+						self::adminTextarea($class, $dims[0], $id, $name, $required, $dims[1], $tab_index, $value);
+					break;
+
+				case 'wp_editor':
+					$field = self::adminWpEditor(
+						$class,
+						$_fields['id'],
+						$name,
+						$dims[1],
+						$tab_index,
+						$value,
+						$wp_editor_args
+					);
+					break;
+
+				default:
+					$field = self::adminText($class, $id, $name, $required, $tab_index, $value);
+			}
+
+			$form_fields[ $field_name ] = ['label' => $label, 'field' => $field . $extra_desc];
+		}
+
+		return $form_fields;
+	}
+
+
+	/**
+	 * @param string $class
+	 * @param string $id
+	 * @param string $name
+	 * @param string $value
+	 * @return string
+	 * @since   4.10.14.p
+	 */
+	private static function adminHidden($class, $id, $name, $value)
+	{
+		return "
         <input name='" . esc_attr($name) . "' type='hidden' id='" . esc_attr($id) . "' class='" . esc_attr($class) . "' 
         value='" . esc_attr($value) . "' />";
-    }
-
-
-    /**
-     * @param string $id
-     * @param string $label
-     * @param string $required
-     * @return string
-     * @since   4.10.14.p
-     */
-    private static function adminLabel($id, $label, $required)
-    {
-        $required = filter_var($required, FILTER_VALIDATE_BOOLEAN) ? " <span>*</span>" : '';
-        return "<label for='" . esc_attr($id) . "'>" . esc_html($label) . $required . "</label>";
-    }
-
-
-    /**
-     * @param string $default
-     * @param string $class
-     * @param string $id
-     * @param string $name
-     * @param string $required
-     * @param int    $tab_index
-     * @param string $type
-     * @param string $value
-     * @param string $label
-     * @return string
-     * @since   4.10.14.p
-     */
-    private static function adminMulti($default, $class, $id, $name, $required, $tab_index, $type, $value, $label = '')
-    {
-        $checked   = ! empty($default) && $default == $value ? 'checked ' : '';
-        $required  = filter_var($required, FILTER_VALIDATE_BOOLEAN) ? 'required' : '';
-        $input     = "
+	}
+
+
+	/**
+	 * @param string $id
+	 * @param string $label
+	 * @param string $required
+	 * @return string
+	 * @since   4.10.14.p
+	 */
+	private static function adminLabel($id, $label, $required)
+	{
+		$required = filter_var($required, FILTER_VALIDATE_BOOLEAN) ? " <span>*</span>" : '';
+		return "<label for='" . esc_attr($id) . "'>" . esc_html($label) . $required . "</label>";
+	}
+
+
+	/**
+	 * @param string $default
+	 * @param string $class
+	 * @param string $id
+	 * @param string $name
+	 * @param string $required
+	 * @param int    $tab_index
+	 * @param string $type
+	 * @param string $value
+	 * @param string $label
+	 * @return string
+	 * @since   4.10.14.p
+	 */
+	private static function adminMulti($default, $class, $id, $name, $required, $tab_index, $type, $value, $label = '')
+	{
+		$checked   = ! empty($default) && $default == $value ? 'checked ' : '';
+		$required  = filter_var($required, FILTER_VALIDATE_BOOLEAN) ? 'required' : '';
+		$input     = "
         <input name='" . esc_attr($name) . "[]' type='" . esc_attr($type) . "' id='" . esc_attr($id) . "' class='" . esc_attr($class) . "' value='" . esc_attr($value) . "' {$checked} {$required} tabindex='" . absint($tab_index) . "'/>";
-        if ($label === '') {
-            return $input;
-        }
-        $label = esc_html($label);
-        return "
+		if ($label === '') {
+			return $input;
+		}
+		$label = esc_html($label);
+		return "
         <label for='$id'>
             {$input}
             {$label}
         </label>";
-    }
-
-
-    /**
-     * @param string $default
-     * @param string $class
-     * @param string $id
-     * @param string $name
-     * @param string $required
-     * @param int    $tab_index
-     * @param array  $options
-     * @return string
-     * @since   4.10.14.p
-     */
-    private static function adminSelect($default, $class, $id, $name, $required, $tab_index, $options = [])
-    {
-        $options_array = [];
-        foreach ($options as $value => $label) {
-            $selected        = ! empty($default) && $default == $value ? 'selected' : '';
-            $label           = wp_strip_all_tags($label);
-            $options_array[] = "<option value='" . esc_attr($value) . "' {$selected}>{$label}</option>";
-        }
-        $options_html = implode("\n", $options_array);
-        $required     = filter_var($required, FILTER_VALIDATE_BOOLEAN) ? 'required' : '';
-        return "
+	}
+
+
+	/**
+	 * @param string $default
+	 * @param string $class
+	 * @param string $id
+	 * @param string $name
+	 * @param string $required
+	 * @param int    $tab_index
+	 * @param array  $options
+	 * @return string
+	 * @since   4.10.14.p
+	 */
+	private static function adminSelect($default, $class, $id, $name, $required, $tab_index, $options = [])
+	{
+		$options_array = [];
+		foreach ($options as $value => $label) {
+			$selected        = ! empty($default) && $default == $value ? 'selected' : '';
+			$label           = wp_strip_all_tags($label);
+			$options_array[] = "<option value='" . esc_attr($value) . "' {$selected}>{$label}</option>";
+		}
+		$options_html = implode("\n", $options_array);
+		$required     = filter_var($required, FILTER_VALIDATE_BOOLEAN) ? 'required' : '';
+		return "
         <select name='" . esc_attr($name) . "' id='" . esc_attr($id) . "' class='" . esc_attr($class) . "' {$required} 
         tabindex='" . absint($tab_index) . "'>
             {$options_html}
         </select>";
-    }
-
-
-    /**
-     * @param string $class
-     * @param string $id
-     * @param string $name
-     * @param string $required
-     * @param int    $tab_index
-     * @param string $value
-     * @return string
-     * @since   4.10.14.p
-     */
-    private static function adminText($class, $id, $name, $required, $tab_index, $value)
-    {
-        $required  = filter_var($required, FILTER_VALIDATE_BOOLEAN) ? 'required' : '';
-        return "
+	}
+
+
+	/**
+	 * @param string $class
+	 * @param string $id
+	 * @param string $name
+	 * @param string $required
+	 * @param int    $tab_index
+	 * @param string $value
+	 * @return string
+	 * @since   4.10.14.p
+	 */
+	private static function adminText($class, $id, $name, $required, $tab_index, $value)
+	{
+		$required  = filter_var($required, FILTER_VALIDATE_BOOLEAN) ? 'required' : '';
+		return "
         <input name='" . esc_attr($name) . "' type='text' id='" . esc_attr($id) . "' class='" . esc_attr($class) . "' 
         value='" . esc_attr($value) . "' {$required} tabindex='" . absint($tab_index) . "'/>";
-    }
-
-
-    /**
-     * @param string $class
-     * @param int    $cols
-     * @param string $id
-     * @param string $name
-     * @param string $required
-     * @param int    $rows
-     * @param int    $tab_index
-     * @param string $value
-     * @return string
-     * @since   4.10.14.p
-     */
-    private static function adminTextarea($class, $cols, $id, $name, $required, $rows, $tab_index, $value)
-    {
-        $required  = filter_var($required, FILTER_VALIDATE_BOOLEAN) ? 'required' : '';
-        return "
+	}
+
+
+	/**
+	 * @param string $class
+	 * @param int    $cols
+	 * @param string $id
+	 * @param string $name
+	 * @param string $required
+	 * @param int    $rows
+	 * @param int    $tab_index
+	 * @param string $value
+	 * @return string
+	 * @since   4.10.14.p
+	 */
+	private static function adminTextarea($class, $cols, $id, $name, $required, $rows, $tab_index, $value)
+	{
+		$required  = filter_var($required, FILTER_VALIDATE_BOOLEAN) ? 'required' : '';
+		return "
         <textarea name='" . esc_attr($name) . "' id='" . esc_attr($id) . "' class='" . esc_attr($class) . "' rows='" . absint($rows) . "' cols='" . absint($cols) . "' {$required} tabindex='" . absint($tab_index) . "'>" . esc_textarea($value) . "</textarea>";
-    }
-
-
-    /**
-     * @param string $class
-     * @param string $id
-     * @param string $name
-     * @param int    $rows
-     * @param int    $tab_index
-     * @param string $value
-     * @param array  $wp_editor_args
-     * @return false|string
-     * @since   4.10.14.p
-     */
-    private static function adminWpEditor($class, $id, $name, $rows, $tab_index, $value, $wp_editor_args = [])
-    {
-        $editor_settings = $wp_editor_args + [
-                'textarea_name' => esc_attr($name),
-                'textarea_rows' => absint($rows),
-                'editor_class'  => esc_attr($class),
-                'tabindex'      => absint($tab_index),
-            ];
-        ob_start();
-        wp_editor($value, esc_attr($id), $editor_settings);
-        return ob_get_clean();
-    }
-
-
-    /**
-     * espresso admin page select_input
-     * Turns an array into a select fields
-     *
-     * @static
-     * @access public
-     * @param string  $name       field name
-     * @param array   $values     option values, numbered array starting at 0, where each value is an array with a key
-     *                            'text' (meaning text to display' and 'id' (meaning the internal value) eg:
-     *                            array(1=>array('text'=>'Monday','id'=>1),2=>array('text'=>'Tuesday','id'=>2)...). or
-     *                            as an array of key-value pairs, where the key is to be used for the select input's
-     *                            name, and the value will be the text shown to the user.  Optionally you can also
-     *                            include an additional key of "class" which will add a specific class to the option
-     *                            for that value.
-     * @param string  $default    default value
-     * @param string  $parameters extra parameters
-     * @param string  $class      css class
-     * @param boolean $autosize   whether to autosize the select or not
-     * @return string              html string for the select input
-     */
-    public static function select_input($name, $values, $default = '', $parameters = '', $class = '', $autosize = true)
-    {
-        // if $values was submitted in the wrong format, convert it over
-        if (! empty($values) && (! array_key_exists(0, $values) || ! is_array($values[0]))) {
-            $converted_values = [];
-            foreach ($values as $id => $text) {
-                $converted_values[] = ['id' => $id, 'text' => $text];
-            }
-            $values = $converted_values;
-        }
-
-        $field =
-            '<select id="' . EEH_Formatter::ee_tep_output_string($name)
-            . '" name="' . EEH_Formatter::ee_tep_output_string($name)
-            . '"';
-
-        if (EEH_Formatter::ee_tep_not_null($parameters)) {
-            $field .= ' ' . $parameters;
-        }
-        if ($autosize) {
-            $size = 'med';
-            for ($ii = 0, $ni = sizeof($values); $ii < $ni; $ii++) {
-                if ($values[ $ii ]['text']) {
-                    if (strlen($values[ $ii ]['text']) > 5) {
-                        $size = 'wide';
-                    }
-                }
-            }
-        } else {
-            $size = '';
-        }
-
-        $field .= ' class="' . $class . ' ' . $size . '">';
-
-        if (empty($default) && isset($GLOBALS[ $name ])) {
-            $default = stripslashes($GLOBALS[ $name ]);
-        }
-
-
-        for ($i = 0, $n = sizeof($values); $i < $n; $i++) {
-            $field .= '<option value="' . $values[ $i ]['id'] . '"';
-            if ($default == $values[ $i ]['id']) {
-                $field .= ' selected = "selected"';
-            }
-            if (isset($values[ $i ]['class'])) {
-                $field .= ' class="' . $values[ $i ]['class'] . '"';
-            }
-            $field .= '>' . $values[ $i ]['text'] . '</option>';
-        }
-        $field .= '</select>';
-
-        return $field;
-    }
-
-
-    /**
-     * generate_question_groups_html
-     *
-     * @param array  $question_groups
-     * @param string $group_wrapper
-     * @return string HTML
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function generate_question_groups_html($question_groups = [], $group_wrapper = 'fieldset')
-    {
-
-        $html                            = '';
-        $before_question_group_questions =
-            apply_filters('FHEE__EEH_Form_Fields__generate_question_groups_html__before_question_group_questions', '');
-        $after_question_group_questions  =
-            apply_filters('FHEE__EEH_Form_Fields__generate_question_groups_html__after_question_group_questions', '');
-
-        if (! empty($question_groups)) {
-            // loop thru question groups
-            foreach ($question_groups as $QSG) {
-                // check that questions exist
-                if (! empty($QSG['QSG_questions'])) {
-                    // use fieldsets
-                    $html .= "\n\t"
-                             . '<'
-                             . $group_wrapper
-                             . ' class="espresso-question-group-wrap" id="'
-                             . $QSG['QSG_identifier']
-                             . '">';
-                    // group_name
-                    $html .= $QSG['QSG_show_group_name']
-                        ? "\n\t\t"
-                          . '<h5 class="espresso-question-group-title-h5 section-title">'
-                          . self::prep_answer($QSG['QSG_name'])
-                          . '</h5>'
-                        : '';
-                    // group_desc
-                    $html .= $QSG['QSG_show_group_desc'] && ! empty($QSG['QSG_desc'])
-                        ? '<div class="espresso-question-group-desc-pg">'
-                          . self::prep_answer($QSG['QSG_desc'])
-                          . '</div>'
-                        : '';
-
-                    $html .= $before_question_group_questions;
-                    // loop thru questions
-                    foreach ($QSG['QSG_questions'] as $question) {
-                        $QFI  = new EE_Question_Form_Input(
-                            $question['qst_obj'],
-                            $question['ans_obj'],
-                            $question
-                        );
-                        $html .= self::generate_form_input($QFI);
-                    }
-                    $html .= $after_question_group_questions;
-                    $html .= "\n\t" . '</' . $group_wrapper . '>';
-                }
-            }
-        }
-
-        return $html;
-    }
-
-
-    /**
-     * generate_question_groups_html
-     *
-     * @param array  $question_groups
-     * @param array  $q_meta
-     * @param bool   $from_admin
-     * @param string $group_wrapper
-     * @return string HTML
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function generate_question_groups_html2(
-        $question_groups = [],
-        $q_meta = [],
-        $from_admin = false,
-        $group_wrapper = 'fieldset'
-    ) {
-
-        $html                            = '';
-        $before_question_group_questions =
-            apply_filters('FHEE__EEH_Form_Fields__generate_question_groups_html__before_question_group_questions', '');
-        $after_question_group_questions  =
-            apply_filters('FHEE__EEH_Form_Fields__generate_question_groups_html__after_question_group_questions', '');
-
-        $default_q_meta = [
-            'att_nmbr'    => 1,
-            'ticket_id'   => '',
-            'input_name'  => '',
-            'input_id'    => '',
-            'input_class' => '',
-        ];
-        $q_meta         = array_merge($default_q_meta, $q_meta);
-
-        if (! empty($question_groups)) {
-            // loop thru question groups
-            foreach ($question_groups as $QSG) {
-                if ($QSG instanceof EE_Question_Group) {
-                    // check that questions exist
-
-                    $where = ['QST_deleted' => 0];
-                    if (! $from_admin) {
-                        $where['QST_admin_only'] = 0;
-                    }
-                    $questions =
-                        $QSG->questions([$where, 'order_by' => ['Question_Group_Question.QGQ_order' => 'ASC']]);
-                    if (! empty($questions)) {
-                        // use fieldsets
-                        $html .= "\n\t"
-                                 . '<' . $group_wrapper . ' class="espresso-question-group-wrap" '
-                                 . 'id="' . $QSG->get('QSG_identifier') . '">';
-                        // group_name
-                        if ($QSG->show_group_name()) {
-                            $html .= "\n\t\t"
-                                     . '<h5 class="espresso-question-group-title-h5 section-title">'
-                                     . $QSG->get_pretty('QSG_name')
-                                     . '</h5>';
-                        }
-                        // group_desc
-                        if ($QSG->show_group_desc()) {
-                            $html .= '<div class="espresso-question-group-desc-pg">'
-                                     . $QSG->get_pretty('QSG_desc')
-                                     . '</div>';
-                        }
-
-                        $html .= $before_question_group_questions;
-                        // loop thru questions
-                        foreach ($questions as $QST) {
-                            $qstn_id = $QST->is_system_question() ? $QST->system_ID() : $QST->ID();
-
-                            $answer = null;
-
-                            /** @var RequestInterface $request */
-                            $request      = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-                            $request_qstn = $request->getRequestParam('qstn', [], 'string', true);
-                            if (! empty($request_qstn) && isset($q_meta['input_id']) && isset($q_meta['att_nmbr'])) {
-                                // check for answer in $request_qstn in case we are reprocessing a form after an error
-                                if (isset($request_qstn[ $q_meta['input_id'] ][ $qstn_id ])) {
-                                    $answer = is_array($request_qstn[ $q_meta['input_id'] ][ $qstn_id ])
-                                        ? $request_qstn[ $q_meta['input_id'] ][ $qstn_id ]
-                                        : sanitize_text_field($request_qstn[ $q_meta['input_id'] ][ $qstn_id ]);
-                                }
-                            } elseif (isset($q_meta['attendee']) && $q_meta['attendee']) {
-                                // attendee data from the session
-                                $answer =
-                                    isset($q_meta['attendee'][ $qstn_id ]) ? $q_meta['attendee'][ $qstn_id ] : null;
-                            }
-
-
-                            $QFI  = new EE_Question_Form_Input(
-                                $QST,
-                                EE_Answer::new_instance(
-                                    [
-                                        'ANS_ID'    => 0,
-                                        'QST_ID'    => 0,
-                                        'REG_ID'    => 0,
-                                        'ANS_value' => $answer,
-                                    ]
-                                ),
-                                $q_meta
-                            );
-                            $html .= self::generate_form_input($QFI);
-                        }
-                        $html .= $after_question_group_questions;
-                        $html .= "\n\t" . '</' . $group_wrapper . '>';
-                    }
-                }
-            }
-        }
-        return $html;
-    }
-
-
-    /**
-     * generate_form_input
-     *
-     * @param EE_Question_Form_Input $QFI
-     * @return string HTML
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function generate_form_input(EE_Question_Form_Input $QFI)
-    {
-        if (isset($QFI->QST_admin_only) && $QFI->QST_admin_only && ! is_admin()) {
-            return '';
-        }
-        /** @var RequestInterface $request */
-        $request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-
-        $QFI = self::_load_system_dropdowns($QFI);
-        $QFI = self::_load_specialized_dropdowns($QFI);
-
-        // we also need to verify
-
-        $display_text = $QFI->get('QST_display_text');
-        $input_name   = $QFI->get('QST_input_name');
-        $answer       = $request->getRequestParam($input_name, $QFI->get('ANS_value'));
-        $input_id     = $QFI->get('QST_input_id');
-        $input_class  = $QFI->get('QST_input_class');
-        //      $disabled = $QFI->get('QST_disabled') ? ' disabled="disabled"' : '';
-        $disabled          = $QFI->get('QST_disabled');
-        $required_label    = apply_filters(' FHEE__EEH_Form_Fields__generate_form_input__required_label', '<em>*</em>');
-        $QST_required      = $QFI->get('QST_required');
-        $required          =
-            $QST_required
-                ? ['label' => $required_label, 'class' => 'required needs-value', 'title' => $QST_required]
-                : [];
-        $use_html_entities = $QFI->get_meta('htmlentities');
-        $required_text     =
-            $QFI->get('QST_required_text') != ''
-                ? $QFI->get('QST_required_text')
-                : esc_html__('This field is required', 'event_espresso');
-        $required_text     = $QST_required
-            ? "\n\t\t\t"
-              . '<div class="required-text hidden">'
-              . self::prep_answer($required_text, $use_html_entities)
-              . '</div>'
-            : '';
-        $label_class       = 'espresso-form-input-lbl';
-        $QST_options       = $QFI->options(true, $answer);
-        $options           = is_array($QST_options) ? self::prep_answer_options($QST_options) : [];
-        $system_ID         = $QFI->get('QST_system');
-        $label_b4          = $QFI->get_meta('label_b4');
-        $use_desc_4_label  = $QFI->get_meta('use_desc_4_label');
-
-
-        switch ($QFI->get('QST_type')) {
-            case 'TEXTAREA':
-                return EEH_Form_Fields::textarea(
-                    $display_text,
-                    $answer,
-                    $input_name,
-                    $input_id,
-                    $input_class,
-                    [],
-                    $required,
-                    $required_text,
-                    $label_class,
-                    $disabled,
-                    $system_ID,
-                    $use_html_entities
-                );
-
-            case 'DROPDOWN':
-                return EEH_Form_Fields::select(
-                    $display_text,
-                    $answer,
-                    $options,
-                    $input_name,
-                    $input_id,
-                    $input_class,
-                    $required,
-                    $required_text,
-                    $label_class,
-                    $disabled,
-                    $system_ID,
-                    $use_html_entities,
-                    true
-                );
-
-
-            case 'RADIO_BTN':
-                return EEH_Form_Fields::radio(
-                    $display_text,
-                    $answer,
-                    $options,
-                    $input_name,
-                    $input_id,
-                    $input_class,
-                    $required,
-                    $required_text,
-                    $label_class,
-                    $disabled,
-                    $system_ID,
-                    $use_html_entities,
-                    $label_b4,
-                    $use_desc_4_label
-                );
-
-            case 'CHECKBOX':
-                return EEH_Form_Fields::checkbox(
-                    $display_text,
-                    $answer,
-                    $options,
-                    $input_name,
-                    $input_id,
-                    $input_class,
-                    $required,
-                    $required_text,
-                    $label_class,
-                    $disabled,
-                    $label_b4,
-                    $system_ID,
-                    $use_html_entities
-                );
-
-            case 'DATE':
-                return EEH_Form_Fields::datepicker(
-                    $display_text,
-                    $answer,
-                    $input_name,
-                    $input_id,
-                    $input_class,
-                    $required,
-                    $required_text,
-                    $label_class,
-                    $disabled,
-                    $system_ID,
-                    $use_html_entities
-                );
-
-            case 'TEXT':
-            default:
-                return EEH_Form_Fields::text(
-                    $display_text,
-                    $answer,
-                    $input_name,
-                    $input_id,
-                    $input_class,
-                    $required,
-                    $required_text,
-                    $label_class,
-                    $disabled,
-                    $system_ID,
-                    $use_html_entities
-                );
-        }
-    }
-
-
-    /**
-     * generates HTML for a form text input
-     *
-     * @param string $question    label content
-     * @param string $answer      form input value attribute
-     * @param string $name        form input name attribute
-     * @param string $id          form input css id attribute
-     * @param string $class       form input css class attribute
-     * @param array  $required    'label', 'class', and 'msg' - array of values for required "label" content, css
-     *                            required 'class', and required 'msg' attribute
-     * @param string $label_class css class attribute for the label
-     * @param string $disabled    disabled="disabled" or null
-     * @return string HTML
-     */
-    public static function text(
-        $question = false,
-        $answer = null,
-        $name = false,
-        $id = '',
-        $class = '',
-        $required = false,
-        $required_text = '',
-        $label_class = '',
-        $disabled = false,
-        $system_ID = false,
-        $use_html_entities = true
-    ) {
-        // need these
-        if (! $question || ! $name) {
-            return null;
-        }
-        // prep the answer
-        $answer = is_array($answer) ? '' : self::prep_answer($answer, $use_html_entities);
-        // prep the required array
-        $required = self::prep_required($required);
-        // set disabled tag
-        $disabled = $answer === null || ! $disabled ? '' : ' disabled="disabled"';
-        // ya gots ta have style man!!!
-        $txt_class = is_admin() ? 'regular-text' : 'espresso-text-inp';
-        $class     = empty($class) ? $txt_class : $class;
-        $class     .= ! empty($system_ID) ? ' ' . $system_ID : '';
-        $extra     = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
-
-        $label_html =
-            $required_text
-            . "\n\t\t\t"
-            . '<label for="' . $name . '" class="' . $label_class . '">'
-            . self::prep_question($question)
-            . $required['label']
-            . '</label><br/>';
-        // filter label but ensure required text comes before it
-        $label_html = apply_filters('FHEE__EEH_Form_Fields__label_html', $label_html, $required_text);
-
-        $input_html =
-            "\n\t\t\t"
-            . '<input type="text" name="' . $name . '" id="' . $id . '" '
-            . 'class="' . $class . ' ' . $required['class'] . '" value="' . esc_attr($answer) . '"  '
-            . 'title="' . esc_attr($required['msg']) . '" ' . $disabled . ' ' . $extra . '/>';
-
-        $input_html = apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
-        return $label_html . $input_html;
-    }
-
-
-    /**
-     * generates HTML for a form textarea
-     *
-     * @param string $question    label content
-     * @param string $answer      form input value attribute
-     * @param string $name        form input name attribute
-     * @param string $id          form input css id attribute
-     * @param string $class       form input css class attribute
-     * @param array  $dimensions  array of form input rows and cols attributes : array( 'rows' => 3, 'cols' => 40 )
-     * @param array  $required    'label', 'class', and 'msg' - array of values for required "label" content, css
-     *                            required 'class', and required 'msg' attribute
-     * @param string $label_class css class attribute for the label
-     * @param string $disabled    disabled="disabled" or null
-     * @return string HTML
-     */
-    public static function textarea(
-        $question = false,
-        $answer = null,
-        $name = false,
-        $id = '',
-        $class = '',
-        $dimensions = false,
-        $required = false,
-        $required_text = '',
-        $label_class = '',
-        $disabled = false,
-        $system_ID = false,
-        $use_html_entities = true
-    ) {
-        // need these
-        if (! $question || ! $name) {
-            return null;
-        }
-        // prep the answer
-        $answer = is_array($answer) ? '' : self::prep_answer($answer, $use_html_entities);
-        // prep the required array
-        $required = self::prep_required($required);
-        // make sure $dimensions is an array
-        $dimensions = is_array($dimensions) ? $dimensions : [];
-        // and set some defaults
-        $dimensions = array_merge(['rows' => 3, 'cols' => 40], $dimensions);
-        // set disabled tag
-        $disabled = $answer === null || ! $disabled ? '' : ' disabled="disabled"';
-        // ya gots ta have style man!!!
-        $txt_class = is_admin() ? 'regular-text' : 'espresso-textarea-inp';
-        $class     = empty($class) ? $txt_class : $class;
-        $class     .= ! empty($system_ID) ? ' ' . $system_ID : '';
-        $extra     = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
-
-        $label_html =
-            $required_text
-            . "\n\t\t\t"
-            . '<label for="' . $name . '" class="' . $label_class . '">'
-            . self::prep_question($question)
-            . $required['label']
-            . '</label><br/>';
-        // filter label but ensure required text comes before it
-        $label_html = apply_filters('FHEE__EEH_Form_Fields__label_html', $label_html, $required_text);
-
-        $input_html =
-            "\n\t\t\t"
-            . '<textarea name="' . $name . '" id="' . $id . '" class="' . $class . ' ' . $required['class'] . '" '
-            . 'rows="' . $dimensions['rows'] . '" cols="' . $dimensions['cols'] . '"  '
-            . 'title="' . $required['msg'] . '" ' . $disabled . ' ' . $extra . '>'
-            . esc_textarea($answer)
-            . '</textarea>';
-
-        $input_html = apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
-        return $label_html . $input_html;
-    }
-
-
-    /**
-     * generates HTML for a form select input
-     *
-     * @param string $question    label content
-     * @param string $answer      form input value attribute
-     * @param array  $options     array of answer options where array key = option value and array value = option
-     *                            display text
-     * @param string $name        form input name attribute
-     * @param string $id          form input css id attribute
-     * @param string $class       form input css class attribute
-     * @param array  $required    'label', 'class', and 'msg' - array of values for required "label" content, css
-     *                            required 'class', and required 'msg' attribute
-     * @param string $label_class css class attribute for the label
-     * @param string $disabled    disabled="disabled" or null
-     * @return string HTML
-     */
-    public static function select(
-        $question = false,
-        $answer = null,
-        $options = false,
-        $name = false,
-        $id = '',
-        $class = '',
-        $required = false,
-        $required_text = '',
-        $label_class = '',
-        $disabled = false,
-        $system_ID = false,
-        $use_html_entities = true,
-        $add_please_select_option = false
-    ) {
-
-        // need these
-        if (! $question || ! $name || ! $options || empty($options) || ! is_array($options)) {
-            return null;
-        }
-        // prep the answer
-        $answer =
-            is_array($answer)
-                ? self::prep_answer(array_shift($answer), $use_html_entities)
-                : self::prep_answer(
-                    $answer,
-                    $use_html_entities
-                );
-        // prep the required array
-        $required = self::prep_required($required);
-        // set disabled tag
-        $disabled = $answer === null || ! $disabled ? '' : ' disabled="disabled"';
-        // ya gots ta have style man!!!
-        $txt_class = is_admin() ? 'wide' : 'espresso-select-inp';
-        $class     = empty($class) ? $txt_class : $class;
-        $class     .= ! empty($system_ID) ? ' ' . $system_ID : '';
-        $extra     = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
-
-        $label_html =
-            $required_text
-            . "\n\t\t\t"
-            . '<label for="' . $name . '" class="' . $label_class . '">'
-            . self::prep_question($question)
-            . $required['label']
-            . '</label><br/>';
-        // filter label but ensure required text comes before it
-        $label_html = apply_filters('FHEE__EEH_Form_Fields__label_html', $label_html, $required_text);
-
-        $input_html =
-            "\n\t\t\t"
-            . '<select name="' . $name . '" id="' . $id . '" class="' . $class . ' ' . $required['class'] . '" '
-            . 'title="' . esc_attr($required['msg']) . '"' . $disabled . ' ' . $extra . '>';
-        // recursively count array elements, to determine total number of options
-        $only_option = count($options, 1) == 1;
-        if (! $only_option) {
-            // if there is NO answer set and there are multiple options to choose from, then set the "please select" message as selected
-            $selected   = $answer === null ? ' selected' : '';
-            $input_html .= $add_please_select_option
-                ? "\n\t\t\t\t"
-                  . '<option value=""' . $selected . '>'
-                  . esc_html__(' - please select - ', 'event_espresso')
-                  . '</option>'
-                : '';
-        }
-        foreach ($options as $key => $value) {
-            // if value is an array, then create option groups, else create regular ol' options
-            $input_html .= is_array($value)
-                ? self::_generate_select_option_group(
-                    $key,
-                    $value,
-                    $answer,
-                    $use_html_entities
-                )
-                : self::_generate_select_option(
-                    $value->value(),
-                    $value->desc(),
-                    $answer,
-                    $only_option,
-                    $use_html_entities
-                );
-        }
-
-        $input_html .= "\n\t\t\t" . '</select>';
-
-        $input_html =
-            apply_filters(
-                'FHEE__EEH_Form_Fields__select__before_end_wrapper',
-                $input_html,
-                $question,
-                $answer,
-                $name,
-                $id,
-                $class,
-                $system_ID
-            );
-
-        $input_html = apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
-        return $label_html . $input_html;
-    }
-
-
-    /**
-     *  _generate_select_option_group
-     *
-     *  if  $value for a select box is an array, then the key will be used as the optgroup label
-     *  and the value array will be looped thru and the elements sent to _generate_select_option
-     *
-     * @param mixed   $opt_group
-     * @param mixed   $QSOs
-     * @param mixed   $answer
-     * @param boolean $use_html_entities
-     * @return string
-     */
-    private static function _generate_select_option_group($opt_group, $QSOs, $answer, $use_html_entities = true)
-    {
-        $html = "\n\t\t\t\t" . '<optgroup label="' . self::prep_option_value($opt_group) . '">';
-        foreach ($QSOs as $QSO) {
-            $html .= self::_generate_select_option($QSO->value(), $QSO->desc(), $answer, false, $use_html_entities);
-        }
-        $html .= "\n\t\t\t\t" . '</optgroup>';
-        return $html;
-    }
-
-
-    /**
-     *  _generate_select_option
-     *
-     * @param mixed   $key
-     * @param mixed   $value
-     * @param mixed   $answer
-     * @param int     $only_option
-     * @param boolean $use_html_entities
-     * @return string
-     */
-    private static function _generate_select_option(
-        $key,
-        $value,
-        $answer,
-        $only_option = false,
-        $use_html_entities = true
-    ) {
-        $key      = self::prep_answer($key, $use_html_entities);
-        $value    = self::prep_answer($value, $use_html_entities);
-        $value    = ! empty($value) ? $value : $key;
-        $selected = ($answer == $key || $only_option) ? 'selected' : '';
-        return "\n\t\t\t\t"
-               . '<option value="' . self::prep_option_value($key) . '" ' . $selected . '> '
-               . $value
-               . '&nbsp;&nbsp;&nbsp;</option>';
-    }
-
-
-    /**
-     * generates HTML for form radio button inputs
-     *
-     * @param bool|string $question    label content
-     * @param string      $answer      form input value attribute
-     * @param array|bool  $options     array of answer options where array key = option value and array value = option
-     *                                 display text
-     * @param bool|string $name        form input name attribute
-     * @param string      $id          form input css id attribute
-     * @param string      $class       form input css class attribute
-     * @param array|bool  $required    'label', 'class', and 'msg' - array of values for required "label" content, css
-     *                                 required 'class', and required 'msg' attribute
-     * @param string      $required_text
-     * @param string      $label_class css class attribute for the label
-     * @param bool|string $disabled    disabled="disabled" or null
-     * @param bool        $system_ID
-     * @param bool        $use_html_entities
-     * @param bool        $label_b4
-     * @param bool        $use_desc_4_label
-     * @return string HTML
-     */
-    public static function radio(
-        $question = false,
-        $answer = null,
-        $options = false,
-        $name = false,
-        $id = '',
-        $class = '',
-        $required = false,
-        $required_text = '',
-        $label_class = '',
-        $disabled = false,
-        $system_ID = false,
-        $use_html_entities = true,
-        $label_b4 = false,
-        $use_desc_4_label = false
-    ) {
-        // need these
-        if (! $question || ! $name || ! $options || empty($options) || ! is_array($options)) {
-            return null;
-        }
-        // prep the answer
-        $answer = is_array($answer) ? '' : self::prep_answer($answer, $use_html_entities);
-        // prep the required array
-        $required = self::prep_required($required);
-        // set disabled tag
-        $disabled = $answer === null || ! $disabled ? '' : ' disabled="disabled"';
-        // ya gots ta have style man!!!
-        $radio_class = is_admin() ? 'ee-admin-radio-lbl' : $label_class;
-        $class       = ! empty($class) ? $class : 'espresso-radio-btn-inp';
-        $extra       = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
-
-        $label_html =
-            $required_text
-            . "\n\t\t\t"
-            . '<label class="' . $label_class . '">'
-            . self::prep_question($question)
-            . $required['label']
-            . '</label> ';
-        // filter label but ensure required text comes before it
-        $label_html = apply_filters('FHEE__EEH_Form_Fields__label_html', $label_html, $required_text);
-
-        $input_html =
-            "\n\t\t\t"
-            . '<ul id="' . $id . '-ul" class="espresso-radio-btn-options-ul ' . $label_class . ' ' . $class . '-ul">';
-
-        $class .= ! empty($system_ID) ? ' ' . $system_ID : '';
-        $class .= ! empty($required['class']) ? ' ' . $required['class'] : '';
-
-        foreach ($options as $OPT) {
-            if ($OPT instanceof EE_Question_Option) {
-                $value   = self::prep_option_value($OPT->value());
-                $label   = $use_desc_4_label ? $OPT->desc() : $OPT->value();
-                $size    = $use_desc_4_label
-                    ? self::get_label_size_class($OPT->value() . ' ' . $OPT->desc())
-                    : self::get_label_size_class($OPT->value());
-                $desc    = $OPT->desc();// no self::prep_answer
-                $answer  = is_numeric($value) && empty($answer) ? 0 : $answer;
-                $checked = (string) $value == (string) $answer ? ' checked' : '';
-                $opt     = '-' . sanitize_key($value);
-
-                $input_html .= "\n\t\t\t\t" . '<li' . $size . '>';
-                $input_html .= "\n\t\t\t\t\t" . '<label class="' . $radio_class . ' espresso-radio-btn-lbl">';
-                $input_html .= $label_b4 ? "\n\t\t\t\t\t\t" . '<span>' . $label . '</span>' : '';
-                $input_html .= "\n\t\t\t\t\t\t"
-                               . '<input type="radio" name="' . $name . '" id="' . $id . $opt . '" '
-                               . 'class="' . $class . '" value="' . $value . '" '
-                               . 'title="' . esc_attr($required['msg']) . '" ' . $disabled
-                               . $checked . ' ' . $extra . '/>';
-                $input_html .= ! $label_b4
-                    ? "\n\t\t\t\t\t\t"
-                      . '<span class="espresso-radio-btn-desc">'
-                      . $label
-                      . '</span>'
-                    : '';
-                $input_html .= "\n\t\t\t\t\t" . '</label>';
-                $input_html .= $use_desc_4_label
-                    ? ''
-                    : '<span class="espresso-radio-btn-option-desc small-text grey-text">' . $desc . '</span>';
-                $input_html .= "\n\t\t\t\t" . '</li>';
-            }
-        }
-
-        $input_html .= "\n\t\t\t" . '</ul>';
-
-        $input_html = apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
-        return $label_html . $input_html;
-    }
-
-
-    /**
-     * generates HTML for form checkbox inputs
-     *
-     * @param string $question    label content
-     * @param string $answer      form input value attribute
-     * @param array  $options     array of options where array key = option value and array value = option display text
-     * @param string $name        form input name attribute
-     * @param string $id          form input css id attribute
-     * @param string $class       form input css class attribute
-     * @param array  $required    'label', 'class', and 'msg' - array of values for required "label" content, css
-     *                            required 'class', and required 'msg' attribute
-     * @param string $label_class css class attribute for the label
-     * @param string $disabled    disabled="disabled" or null
-     * @return string HTML
-     */
-    public static function checkbox(
-        $question = false,
-        $answer = null,
-        $options = false,
-        $name = false,
-        $id = '',
-        $class = '',
-        $required = false,
-        $required_text = '',
-        $label_class = '',
-        $disabled = false,
-        $label_b4 = false,
-        $system_ID = false,
-        $use_html_entities = true
-    ) {
-        // need these
-        if (! $question || ! $name || ! $options || empty($options) || ! is_array($options)) {
-            return null;
-        }
-        $answer = maybe_unserialize($answer);
-
-        // prep the answer(s)
-        $answer = is_array($answer) ? $answer : [sanitize_key($answer) => $answer];
-
-        foreach ($answer as $key => $value) {
-            $key            = self::prep_option_value($key);
-            $answer[ $key ] = self::prep_answer($value, $use_html_entities);
-        }
-
-        // prep the required array
-        $required = self::prep_required($required);
-        // set disabled tag
-        $disabled = $answer === null || ! $disabled ? '' : ' disabled="disabled"';
-        // ya gots ta have style man!!!
-        $radio_class = is_admin() ? 'ee-admin-radio-lbl' : $label_class;
-        $class       = empty($class) ? 'espresso-radio-btn-inp' : $class;
-        $extra       = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
-
-        $label_html =
-            $required_text
-            . "\n\t\t\t"
-            . '<label class="' . $label_class . '">'
-            . self::prep_question($question)
-            . $required['label']
-            . '</label> ';
-        // filter label but ensure required text comes before it
-        $label_html = apply_filters('FHEE__EEH_Form_Fields__label_html', $label_html, $required_text);
-
-        $input_html =
-            "\n\t\t\t"
-            . '<ul id="' . $id . '-ul" class="espresso-checkbox-options-ul ' . $label_class . ' ' . $class . '-ul">';
-
-        $class .= ! empty($system_ID) ? ' ' . $system_ID : '';
-        $class .= ! empty($required['class']) ? ' ' . $required['class'] : '';
-
-        foreach ($options as $OPT) {
-            $value = $OPT->value();// self::prep_option_value( $OPT->value() );
-            $size  = self::get_label_size_class($OPT->value() . ' ' . $OPT->desc());
-            $text  = self::prep_answer($OPT->value());
-            $desc  = $OPT->desc();
-            $opt   = '-' . sanitize_key($value);
-
-            $checked = is_array($answer) && in_array($text, $answer) ? ' checked' : '';
-
-            $input_html .= "\n\t\t\t\t" . '<li' . $size . '>';
-            $input_html .= "\n\t\t\t\t\t" . '<label class="' . $radio_class . ' espresso-checkbox-lbl">';
-            $input_html .= $label_b4 ? "\n\t\t\t\t\t\t" . '<span>' . $text . '</span>' : '';
-            $input_html .= "\n\t\t\t\t\t\t"
-                           . '<input type="checkbox" name="' . $name . '[' . $OPT->ID() . ']" '
-                           . 'id="' . $id . $opt . '" class="' . $class . '" value="' . $value . '" '
-                           . 'title="' . esc_attr($required['msg']) . '" ' . $disabled . $checked . ' ' . $extra . '/>';
-            $input_html .= ! $label_b4 ? "\n\t\t\t\t\t\t" . '<span>' . $text . '</span>' : '';
-            $input_html .= "\n\t\t\t\t\t" . '</label>';
-            if (! empty($desc) && $desc != $text) {
-                $input_html .= "\n\t\t\t\t\t"
-                               . ' &nbsp; <br/><div class="espresso-checkbox-option-desc small-text grey-text">'
-                               . $desc
-                               . '</div>';
-            }
-            $input_html .= "\n\t\t\t\t" . '</li>';
-        }
-
-        $input_html .= "\n\t\t\t" . '</ul>';
-
-        $input_html = apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
-        return $label_html . $input_html;
-    }
-
-
-    /**
-     * generates HTML for a form datepicker input
-     *
-     * @param string $question    label content
-     * @param string $answer      form input value attribute
-     * @param string $name        form input name attribute
-     * @param string $id          form input css id attribute
-     * @param string $class       form input css class attribute
-     * @param array  $required    'label', 'class', and 'msg' - array of values for required "label" content, css
-     *                            required 'class', and required 'msg' attribute
-     * @param string $label_class css class attribute for the label
-     * @param string $disabled    disabled="disabled" or null
-     * @return string HTML
-     */
-    public static function datepicker(
-        $question = false,
-        $answer = null,
-        $name = false,
-        $id = '',
-        $class = '',
-        $required = false,
-        $required_text = '',
-        $label_class = '',
-        $disabled = false,
-        $system_ID = false,
-        $use_html_entities = true
-    ) {
-        // need these
-        if (! $question || ! $name) {
-            return null;
-        }
-        // prep the answer
-        $answer = is_array($answer) ? '' : self::prep_answer($answer, $use_html_entities);
-        // prep the required array
-        $required = self::prep_required($required);
-        // set disabled tag
-        $disabled = $answer === null || ! $disabled ? '' : ' disabled="disabled"';
-        // ya gots ta have style man!!!
-        $txt_class = is_admin() ? 'regular-text' : 'espresso-datepicker-inp';
-        $class     = empty($class) ? $txt_class : $class;
-        $class     .= ! empty($system_ID) ? ' ' . $system_ID : '';
-        $extra     = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
-
-        $label_html =
-            $required_text
-            . "\n\t\t\t"
-            . '<label for="' . $name . '" class="' . $label_class . '">'
-            . self::prep_question($question)
-            . $required['label']
-            . '</label><br/>';
-        // filter label but ensure required text comes before it
-        $label_html = apply_filters('FHEE__EEH_Form_Fields__label_html', $label_html, $required_text);
-
-        $input_html =
-            "\n\t\t\t"
-            . '<input type="text" name="' . $name . '" id="' . $id . '" '
-            . 'class="' . $class . ' ' . $required['class'] . ' datepicker" value="' . $answer . '"  '
-            . 'title="' . esc_attr($required['msg']) . '" ' . $disabled . ' ' . $extra . '/>';
-
-        // enqueue scripts
-        wp_register_style(
-            'espresso-ui-theme',
-            EE_GLOBAL_ASSETS_URL . 'css/espresso-ui-theme/jquery-ui-1.10.3.custom.min.css',
-            [],
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_style('espresso-ui-theme');
-        wp_enqueue_script('jquery-ui-datepicker');
-
-        $input_html = apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
-        return $label_html . $input_html;
-    }
-
-
-    /**
-     *  remove_label_keep_required_msg
-     *  this will strip out a form input's label HTML while keeping the required text HTML that MUST be before the label
-     *
-     * @access public
-     * @return     string
-     */
-    public static function remove_label_keep_required_msg($label_html, $required_text)
-    {
-        return $required_text;
-    }
-
-
-    /**
-     * Simply returns the HTML for a hidden input of the given name and value.
-     *
-     * @param string $name
-     * @param string $value
-     * @return string HTML
-     */
-    public static function hidden_input($name, $value, $id = '')
-    {
-        $id = ! empty($id) ? $id : $name;
-        return '<input id="' . $id . '" type="hidden" name="' . $name . '" value="' . $value . '"/>';
-    }
-
-
-    /**
-     * prep_question
-     *
-     * @param string $question
-     * @return string
-     */
-    public static function prep_question($question)
-    {
-        return $question;
-    }
-
-
-    /**
-     *  prep_answer
-     *
-     * @param mixed $answer
-     * @return string
-     */
-    public static function prep_answer($answer, $use_html_entities = true)
-    {
-        // make sure we convert bools first.  Otherwise (bool) false becomes an empty string which is NOT desired,
-        // we want "0".
-        if (is_bool($answer)) {
-            $answer = $answer ? 1 : 0;
-        }
-        $answer = trim(stripslashes(str_replace('&#039;', "'", $answer)));
-        return $use_html_entities ? htmlentities($answer, ENT_QUOTES, 'UTF-8') : $answer;
-    }
-
-
-    /**
-     *  prep_answer_options
-     *
-     * @param array $QSOs array of EE_Question_Option objects
-     * @return array
-     */
-    public static function prep_answer_options($QSOs = [])
-    {
-        $prepped_answer_options = [];
-        if (is_array($QSOs) && ! empty($QSOs)) {
-            foreach ($QSOs as $key => $QSO) {
-                if (! $QSO instanceof EE_Question_Option) {
-                    $QSO = EE_Question_Option::new_instance(
-                        [
-                            'QSO_value' => is_array($QSO) && isset($QSO['id'])
-                                ? (string) $QSO['id']
-                                : (string) $key,
-                            'QSO_desc'  => is_array($QSO) && isset($QSO['text'])
-                                ? (string) $QSO['text']
-                                : (string) $QSO,
-                        ]
-                    );
-                }
-                if ($QSO->opt_group()) {
-                    $prepped_answer_options[ $QSO->opt_group() ][] = $QSO;
-                } else {
-                    $prepped_answer_options[] = $QSO;
-                }
-            }
-        }
-        //      d( $prepped_answer_options );
-        return $prepped_answer_options;
-    }
-
-
-    /**
-     *  prep_option_value
-     *
-     * @param string $option_value
-     * @return string
-     */
-    public static function prep_option_value($option_value)
-    {
-        return esc_attr(trim(stripslashes($option_value)));
-    }
-
-
-    /**
-     *  prep_required
-     *
-     * @param string|array $required
-     * @return array
-     */
-    public static function prep_required($required = [])
-    {
-        // make sure required is an array
-        $required = is_array($required) ? $required : [];
-        // and set some defaults
-        return array_merge(['label' => '', 'class' => '', 'msg' => ''], $required);
-    }
-
-
-    /**
-     *  get_label_size_class
-     *
-     * @param string $value
-     * @return string
-     */
-    public static function get_label_size_class($value = false)
-    {
-        if ($value === false || $value === '') {
-            return ' class="medium-lbl"';
-        }
-        // determine length of option value
-        $val_size = strlen($value);
-        switch ($val_size) {
-            case $val_size < 3:
-                $size = ' class="nano-lbl"';
-                break;
-            case $val_size < 6:
-                $size = ' class="micro-lbl"';
-                break;
-            case $val_size < 12:
-                $size = ' class="tiny-lbl"';
-                break;
-            case $val_size < 25:
-                $size = ' class="small-lbl"';
-                break;
-            case $val_size > 100:
-                $size = ' class="big-lbl"';
-                break;
-            default:
-                $size = ' class="medium-lbl"';
-                break;
-        }
-        return $size;
-    }
-
-
-    /**
-     *  _load_system_dropdowns
-     *
-     * @param EE_Question_Form_Input $QFI
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private static function _load_system_dropdowns($QFI)
-    {
-        $QST_system = $QFI->get('QST_system');
-        switch ($QST_system) {
-            case 'state':
-                $QFI = self::generate_state_dropdown($QFI);
-                break;
-            case 'country':
-                $QFI = self::generate_country_dropdown($QFI);
-                break;
-            case 'admin-state':
-                $QFI = self::generate_state_dropdown($QFI, true);
-                break;
-            case 'admin-country':
-                $QFI = self::generate_country_dropdown($QFI, true);
-                break;
-        }
-        return $QFI;
-    }
-
-
-    /**
-     * This preps dropdowns that are specialized.
-     *
-     * @param EE_Question_Form_Input $QFI
-     *
-     * @return EE_Question_Form_Input
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since  4.6.0
-     */
-    protected static function _load_specialized_dropdowns($QFI)
-    {
-        switch ($QFI->get('QST_type')) {
-            case 'STATE':
-                $QFI = self::generate_state_dropdown($QFI);
-                break;
-            case 'COUNTRY':
-                $QFI = self::generate_country_dropdown($QFI);
-                break;
-        }
-        return $QFI;
-    }
-
-
-    /**
-     *    generate_state_dropdown
-     *
-     * @param EE_Question_Form_Input $QST
-     * @param bool                   $get_all
-     * @return EE_Question_Form_Input
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function generate_state_dropdown($QST, $get_all = false)
-    {
-        $states = $get_all
-            ? EEM_State::instance()->get_all_states()
-            : EEM_State::instance()->get_all_states_of_active_countries();
-        if ($states && count($states) != count($QST->options())) {
-            $QST->set('QST_type', 'DROPDOWN');
-            // if multiple countries, we'll create option groups within the dropdown
-            foreach ($states as $state) {
-                if ($state instanceof EE_State) {
-                    $QSO = EE_Question_Option::new_instance(
-                        [
-                            'QSO_value'   => $state->ID(),
-                            'QSO_desc'    => $state->name(),
-                            'QST_ID'      => $QST->get('QST_ID'),
-                            'QSO_deleted' => false,
-                        ]
-                    );
-                    // set option group
-                    $QSO->set_opt_group($state->country()->name());
-                    // add option to question
-                    $QST->add_temp_option($QSO);
-                }
-            }
-        }
-        return $QST;
-    }
-
-
-    /**
-     *    generate_country_dropdown
-     *
-     * @param      $QST
-     * @param bool $get_all
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @internal param array $question
-     */
-    public static function generate_country_dropdown($QST, $get_all = false)
-    {
-        $countries = $get_all
-            ? EEM_Country::instance()->get_all_countries()
-            : EEM_Country::instance()->get_all_active_countries();
-        if ($countries && count($countries) != count($QST->options())) {
-            $QST->set('QST_type', 'DROPDOWN');
-            // now add countries
-            foreach ($countries as $country) {
-                if ($country instanceof EE_Country) {
-                    $QSO = EE_Question_Option::new_instance(
-                        [
-                            'QSO_value'   => $country->ID(),
-                            'QSO_desc'    => $country->name(),
-                            'QST_ID'      => $QST->get('QST_ID'),
-                            'QSO_deleted' => false,
-                        ]
-                    );
-                    $QST->add_temp_option($QSO);
-                }
-            }
-        }
-        return $QST;
-    }
-
-
-    /**
-     *  generates options for a month dropdown selector with numbers from 01 to 12
-     *
-     * @return array()
-     */
-    public static function two_digit_months_dropdown_options()
-    {
-        $options = [];
-        for ($x = 1; $x <= 12; $x++) {
-            $mm             = str_pad($x, 2, '0', STR_PAD_LEFT);
-            $options[ $mm ] = $mm;
-        }
-        return EEH_Form_Fields::prep_answer_options($options);
-    }
-
-
-    /**
-     *  generates a year dropdown selector with numbers for the next ten years
-     *
-     * @return array
-     */
-    public static function next_decade_two_digit_year_dropdown_options()
-    {
-        $options      = [];
-        $current_year = date('y');
-        $next_decade  = $current_year + 10;
-        for ($x = $current_year; $x <= $next_decade; $x++) {
-            $yy             = str_pad($x, 2, '0', STR_PAD_LEFT);
-            $options[ $yy ] = $yy;
-        }
-        return EEH_Form_Fields::prep_answer_options($options);
-    }
-
-
-    /**
-     * generates a month/year dropdown selector for all registrations matching the given criteria.  Typically used for
-     * list table filter.
-     *
-     * @param string  $cur_date     any currently selected date can be entered here.
-     * @param string  $status       Registration status
-     * @param integer $evt_category Event Category ID if the Event Category filter is selected
-     * @return string                html
-     * @throws EE_Error
-     */
-    public static function generate_registration_months_dropdown($cur_date = '', $status = '', $evt_category = 0)
-    {
-        $_where = [];
-        if (! empty($status)) {
-            $_where['STS_ID'] = $status;
-        }
-
-        if ($evt_category > 0) {
-            $_where['Event.Term_Taxonomy.term_id'] = $evt_category;
-        }
-
-        $regdtts = EEM_Registration::instance()->get_reg_months_and_years($_where);
-
-        // setup vals for select input helper
-        $options = [
-            0 => [
-                'text' => esc_html__('Select a Month/Year', 'event_espresso'),
-                'id'   => '',
-            ],
-        ];
-
-        foreach ($regdtts as $regdtt) {
-            $date      = $regdtt->reg_month . ' ' . $regdtt->reg_year;
-            $options[] = [
-                'text' => $date,
-                'id'   => $date,
-            ];
-        }
-
-        return self::select_input('month_range', $options, $cur_date, '', 'wide');
-    }
-
-
-    /**
-     * generates a month/year dropdown selector for all events matching the given criteria
-     * Typically used for list table filter
-     *
-     * @param string $cur_date          any currently selected date can be entered here.
-     * @param string $status            "view" (i.e. all, today, month, draft)
-     * @param int    $evt_category      category event belongs to
-     * @param string $evt_active_status "upcoming", "expired", "active", or "inactive"
-     * @return string                    html
-     * @throws EE_Error
-     */
-    public static function generate_event_months_dropdown(
-        $cur_date = '',
-        $status = null,
-        $evt_category = null,
-        $evt_active_status = null
-    ) {
-        // determine what post_status our condition will have for the query.
-        // phpcs:disable PSR2.ControlStructures.SwitchDeclaration.TerminatingComment
-        switch ($status) {
-            case 'month':
-            case 'today':
-            case null:
-            case 'all':
-                $where['Event.status'] = ['NOT IN', ['trash']];
-                break;
-            case 'draft':
-                $where['Event.status'] = ['IN', ['draft', 'auto-draft']];
-                break;
-            default:
-                $where['Event.status'] = $status;
-        }
-
-        // phpcs:enable
-
-        // categories?
-
-
-        if (! empty($evt_category)) {
-            $where['Event.Term_Taxonomy.taxonomy'] = 'espresso_event_categories';
-            $where['Event.Term_Taxonomy.term_id']  = $evt_category;
-        }
-
-
-        //      $where['DTT_is_primary'] = 1;
-
-        $DTTS = EEM_Datetime::instance()->get_dtt_months_and_years($where, $evt_active_status);
-
-        // let's setup vals for select input helper
-        $options = [
-            0 => [
-                'text' => esc_html__('Select a Month/Year', 'event_espresso'),
-                'id'   => "",
-            ],
-        ];
-
-
-        // translate month and date
-        global $wp_locale;
-
-        foreach ($DTTS as $DTT) {
-            $localized_date = $wp_locale->get_month($DTT->dtt_month_num) . ' ' . $DTT->dtt_year;
-            $id             = $DTT->dtt_month . ' ' . $DTT->dtt_year;
-            $options[]      = [
-                'text' => $localized_date,
-                'id'   => $id,
-            ];
-        }
-
-
-        return self::select_input('month_range', $options, $cur_date, '', 'wide');
-    }
-
-
-    /**
-     * generates the dropdown selector for event categories
-     * typically used as a filter on list tables.
-     *
-     * @param integer $current_cat currently selected category
-     * @return string               html for dropdown
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function generate_event_category_dropdown($current_cat = -1)
-    {
-        $categories = EEM_Term::instance()->get_all_ee_categories(true);
-        $options    = [
-            '0' => [
-                'text' => esc_html__('All Categories', 'event_espresso'),
-                'id'   => -1,
-            ],
-        ];
-
-        // setup categories for dropdown
-        foreach ($categories as $category) {
-            $options[] = [
-                'text' => $category->get('name'),
-                'id'   => $category->ID(),
-            ];
-        }
-
-        return self::select_input('EVT_CAT', $options, $current_cat);
-    }
-
-
-    /**
-     *    generate a submit button with or without it's own microform
-     *    this is the only way to create buttons that are compatible across all themes
-     *
-     * @access    public
-     * @param string      $url              - the form action
-     * @param string      $ID               - some kind of unique ID, appended with "-sbmt" for the input and "-frm"
-     *                                      for the form
-     * @param string      $class            - css classes (separated by spaces if more than one)
-     * @param string      $text             - what appears on the button
-     * @param string      $nonce_action     - if using nonces
-     * @param bool|string $input_only       - whether to print form header and footer. TRUE returns the input without
-     *                                      the form
-     * @param string      $extra_attributes - any extra attributes that need to be attached to the form input
-     * @return    string
-     */
-    public static function submit_button(
-        $url = '',
-        $ID = '',
-        $class = '',
-        $text = '',
-        $nonce_action = '',
-        $input_only = false,
-        $extra_attributes = ''
-    ) {
-        $btn = '';
-        if (empty($url) || empty($ID)) {
-            return $btn;
-        }
-        $text = ! empty($text) ? $text : esc_html__('Submit', 'event_espresso');
-        $btn  .= '<input id="' . $ID . '-btn" class="' . $class . '" '
-                 . 'type="submit" value="' . $text . '" ' . $extra_attributes . '/>';
-        if (! $input_only) {
-            $btn_frm = '<form id="' . $ID . '-frm" method="POST" action="' . $url . '">';
-            $btn_frm .= ! empty($nonce_action)
-                ? wp_nonce_field($nonce_action, $nonce_action . '_nonce', true, false)
-                : '';
-            $btn_frm .= $btn;
-            $btn_frm .= '</form>';
-            $btn     = $btn_frm;
-            unset($btn_frm);
-        }
-        return $btn;
-    }
+	}
+
+
+	/**
+	 * @param string $class
+	 * @param string $id
+	 * @param string $name
+	 * @param int    $rows
+	 * @param int    $tab_index
+	 * @param string $value
+	 * @param array  $wp_editor_args
+	 * @return false|string
+	 * @since   4.10.14.p
+	 */
+	private static function adminWpEditor($class, $id, $name, $rows, $tab_index, $value, $wp_editor_args = [])
+	{
+		$editor_settings = $wp_editor_args + [
+				'textarea_name' => esc_attr($name),
+				'textarea_rows' => absint($rows),
+				'editor_class'  => esc_attr($class),
+				'tabindex'      => absint($tab_index),
+			];
+		ob_start();
+		wp_editor($value, esc_attr($id), $editor_settings);
+		return ob_get_clean();
+	}
+
+
+	/**
+	 * espresso admin page select_input
+	 * Turns an array into a select fields
+	 *
+	 * @static
+	 * @access public
+	 * @param string  $name       field name
+	 * @param array   $values     option values, numbered array starting at 0, where each value is an array with a key
+	 *                            'text' (meaning text to display' and 'id' (meaning the internal value) eg:
+	 *                            array(1=>array('text'=>'Monday','id'=>1),2=>array('text'=>'Tuesday','id'=>2)...). or
+	 *                            as an array of key-value pairs, where the key is to be used for the select input's
+	 *                            name, and the value will be the text shown to the user.  Optionally you can also
+	 *                            include an additional key of "class" which will add a specific class to the option
+	 *                            for that value.
+	 * @param string  $default    default value
+	 * @param string  $parameters extra parameters
+	 * @param string  $class      css class
+	 * @param boolean $autosize   whether to autosize the select or not
+	 * @return string              html string for the select input
+	 */
+	public static function select_input($name, $values, $default = '', $parameters = '', $class = '', $autosize = true)
+	{
+		// if $values was submitted in the wrong format, convert it over
+		if (! empty($values) && (! array_key_exists(0, $values) || ! is_array($values[0]))) {
+			$converted_values = [];
+			foreach ($values as $id => $text) {
+				$converted_values[] = ['id' => $id, 'text' => $text];
+			}
+			$values = $converted_values;
+		}
+
+		$field =
+			'<select id="' . EEH_Formatter::ee_tep_output_string($name)
+			. '" name="' . EEH_Formatter::ee_tep_output_string($name)
+			. '"';
+
+		if (EEH_Formatter::ee_tep_not_null($parameters)) {
+			$field .= ' ' . $parameters;
+		}
+		if ($autosize) {
+			$size = 'med';
+			for ($ii = 0, $ni = sizeof($values); $ii < $ni; $ii++) {
+				if ($values[ $ii ]['text']) {
+					if (strlen($values[ $ii ]['text']) > 5) {
+						$size = 'wide';
+					}
+				}
+			}
+		} else {
+			$size = '';
+		}
+
+		$field .= ' class="' . $class . ' ' . $size . '">';
+
+		if (empty($default) && isset($GLOBALS[ $name ])) {
+			$default = stripslashes($GLOBALS[ $name ]);
+		}
+
+
+		for ($i = 0, $n = sizeof($values); $i < $n; $i++) {
+			$field .= '<option value="' . $values[ $i ]['id'] . '"';
+			if ($default == $values[ $i ]['id']) {
+				$field .= ' selected = "selected"';
+			}
+			if (isset($values[ $i ]['class'])) {
+				$field .= ' class="' . $values[ $i ]['class'] . '"';
+			}
+			$field .= '>' . $values[ $i ]['text'] . '</option>';
+		}
+		$field .= '</select>';
+
+		return $field;
+	}
+
+
+	/**
+	 * generate_question_groups_html
+	 *
+	 * @param array  $question_groups
+	 * @param string $group_wrapper
+	 * @return string HTML
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function generate_question_groups_html($question_groups = [], $group_wrapper = 'fieldset')
+	{
+
+		$html                            = '';
+		$before_question_group_questions =
+			apply_filters('FHEE__EEH_Form_Fields__generate_question_groups_html__before_question_group_questions', '');
+		$after_question_group_questions  =
+			apply_filters('FHEE__EEH_Form_Fields__generate_question_groups_html__after_question_group_questions', '');
+
+		if (! empty($question_groups)) {
+			// loop thru question groups
+			foreach ($question_groups as $QSG) {
+				// check that questions exist
+				if (! empty($QSG['QSG_questions'])) {
+					// use fieldsets
+					$html .= "\n\t"
+							 . '<'
+							 . $group_wrapper
+							 . ' class="espresso-question-group-wrap" id="'
+							 . $QSG['QSG_identifier']
+							 . '">';
+					// group_name
+					$html .= $QSG['QSG_show_group_name']
+						? "\n\t\t"
+						  . '<h5 class="espresso-question-group-title-h5 section-title">'
+						  . self::prep_answer($QSG['QSG_name'])
+						  . '</h5>'
+						: '';
+					// group_desc
+					$html .= $QSG['QSG_show_group_desc'] && ! empty($QSG['QSG_desc'])
+						? '<div class="espresso-question-group-desc-pg">'
+						  . self::prep_answer($QSG['QSG_desc'])
+						  . '</div>'
+						: '';
+
+					$html .= $before_question_group_questions;
+					// loop thru questions
+					foreach ($QSG['QSG_questions'] as $question) {
+						$QFI  = new EE_Question_Form_Input(
+							$question['qst_obj'],
+							$question['ans_obj'],
+							$question
+						);
+						$html .= self::generate_form_input($QFI);
+					}
+					$html .= $after_question_group_questions;
+					$html .= "\n\t" . '</' . $group_wrapper . '>';
+				}
+			}
+		}
+
+		return $html;
+	}
+
+
+	/**
+	 * generate_question_groups_html
+	 *
+	 * @param array  $question_groups
+	 * @param array  $q_meta
+	 * @param bool   $from_admin
+	 * @param string $group_wrapper
+	 * @return string HTML
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function generate_question_groups_html2(
+		$question_groups = [],
+		$q_meta = [],
+		$from_admin = false,
+		$group_wrapper = 'fieldset'
+	) {
+
+		$html                            = '';
+		$before_question_group_questions =
+			apply_filters('FHEE__EEH_Form_Fields__generate_question_groups_html__before_question_group_questions', '');
+		$after_question_group_questions  =
+			apply_filters('FHEE__EEH_Form_Fields__generate_question_groups_html__after_question_group_questions', '');
+
+		$default_q_meta = [
+			'att_nmbr'    => 1,
+			'ticket_id'   => '',
+			'input_name'  => '',
+			'input_id'    => '',
+			'input_class' => '',
+		];
+		$q_meta         = array_merge($default_q_meta, $q_meta);
+
+		if (! empty($question_groups)) {
+			// loop thru question groups
+			foreach ($question_groups as $QSG) {
+				if ($QSG instanceof EE_Question_Group) {
+					// check that questions exist
+
+					$where = ['QST_deleted' => 0];
+					if (! $from_admin) {
+						$where['QST_admin_only'] = 0;
+					}
+					$questions =
+						$QSG->questions([$where, 'order_by' => ['Question_Group_Question.QGQ_order' => 'ASC']]);
+					if (! empty($questions)) {
+						// use fieldsets
+						$html .= "\n\t"
+								 . '<' . $group_wrapper . ' class="espresso-question-group-wrap" '
+								 . 'id="' . $QSG->get('QSG_identifier') . '">';
+						// group_name
+						if ($QSG->show_group_name()) {
+							$html .= "\n\t\t"
+									 . '<h5 class="espresso-question-group-title-h5 section-title">'
+									 . $QSG->get_pretty('QSG_name')
+									 . '</h5>';
+						}
+						// group_desc
+						if ($QSG->show_group_desc()) {
+							$html .= '<div class="espresso-question-group-desc-pg">'
+									 . $QSG->get_pretty('QSG_desc')
+									 . '</div>';
+						}
+
+						$html .= $before_question_group_questions;
+						// loop thru questions
+						foreach ($questions as $QST) {
+							$qstn_id = $QST->is_system_question() ? $QST->system_ID() : $QST->ID();
+
+							$answer = null;
+
+							/** @var RequestInterface $request */
+							$request      = LoaderFactory::getLoader()->getShared(RequestInterface::class);
+							$request_qstn = $request->getRequestParam('qstn', [], 'string', true);
+							if (! empty($request_qstn) && isset($q_meta['input_id']) && isset($q_meta['att_nmbr'])) {
+								// check for answer in $request_qstn in case we are reprocessing a form after an error
+								if (isset($request_qstn[ $q_meta['input_id'] ][ $qstn_id ])) {
+									$answer = is_array($request_qstn[ $q_meta['input_id'] ][ $qstn_id ])
+										? $request_qstn[ $q_meta['input_id'] ][ $qstn_id ]
+										: sanitize_text_field($request_qstn[ $q_meta['input_id'] ][ $qstn_id ]);
+								}
+							} elseif (isset($q_meta['attendee']) && $q_meta['attendee']) {
+								// attendee data from the session
+								$answer =
+									isset($q_meta['attendee'][ $qstn_id ]) ? $q_meta['attendee'][ $qstn_id ] : null;
+							}
+
+
+							$QFI  = new EE_Question_Form_Input(
+								$QST,
+								EE_Answer::new_instance(
+									[
+										'ANS_ID'    => 0,
+										'QST_ID'    => 0,
+										'REG_ID'    => 0,
+										'ANS_value' => $answer,
+									]
+								),
+								$q_meta
+							);
+							$html .= self::generate_form_input($QFI);
+						}
+						$html .= $after_question_group_questions;
+						$html .= "\n\t" . '</' . $group_wrapper . '>';
+					}
+				}
+			}
+		}
+		return $html;
+	}
+
+
+	/**
+	 * generate_form_input
+	 *
+	 * @param EE_Question_Form_Input $QFI
+	 * @return string HTML
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function generate_form_input(EE_Question_Form_Input $QFI)
+	{
+		if (isset($QFI->QST_admin_only) && $QFI->QST_admin_only && ! is_admin()) {
+			return '';
+		}
+		/** @var RequestInterface $request */
+		$request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
+
+		$QFI = self::_load_system_dropdowns($QFI);
+		$QFI = self::_load_specialized_dropdowns($QFI);
+
+		// we also need to verify
+
+		$display_text = $QFI->get('QST_display_text');
+		$input_name   = $QFI->get('QST_input_name');
+		$answer       = $request->getRequestParam($input_name, $QFI->get('ANS_value'));
+		$input_id     = $QFI->get('QST_input_id');
+		$input_class  = $QFI->get('QST_input_class');
+		//      $disabled = $QFI->get('QST_disabled') ? ' disabled="disabled"' : '';
+		$disabled          = $QFI->get('QST_disabled');
+		$required_label    = apply_filters(' FHEE__EEH_Form_Fields__generate_form_input__required_label', '<em>*</em>');
+		$QST_required      = $QFI->get('QST_required');
+		$required          =
+			$QST_required
+				? ['label' => $required_label, 'class' => 'required needs-value', 'title' => $QST_required]
+				: [];
+		$use_html_entities = $QFI->get_meta('htmlentities');
+		$required_text     =
+			$QFI->get('QST_required_text') != ''
+				? $QFI->get('QST_required_text')
+				: esc_html__('This field is required', 'event_espresso');
+		$required_text     = $QST_required
+			? "\n\t\t\t"
+			  . '<div class="required-text hidden">'
+			  . self::prep_answer($required_text, $use_html_entities)
+			  . '</div>'
+			: '';
+		$label_class       = 'espresso-form-input-lbl';
+		$QST_options       = $QFI->options(true, $answer);
+		$options           = is_array($QST_options) ? self::prep_answer_options($QST_options) : [];
+		$system_ID         = $QFI->get('QST_system');
+		$label_b4          = $QFI->get_meta('label_b4');
+		$use_desc_4_label  = $QFI->get_meta('use_desc_4_label');
+
+
+		switch ($QFI->get('QST_type')) {
+			case 'TEXTAREA':
+				return EEH_Form_Fields::textarea(
+					$display_text,
+					$answer,
+					$input_name,
+					$input_id,
+					$input_class,
+					[],
+					$required,
+					$required_text,
+					$label_class,
+					$disabled,
+					$system_ID,
+					$use_html_entities
+				);
+
+			case 'DROPDOWN':
+				return EEH_Form_Fields::select(
+					$display_text,
+					$answer,
+					$options,
+					$input_name,
+					$input_id,
+					$input_class,
+					$required,
+					$required_text,
+					$label_class,
+					$disabled,
+					$system_ID,
+					$use_html_entities,
+					true
+				);
+
+
+			case 'RADIO_BTN':
+				return EEH_Form_Fields::radio(
+					$display_text,
+					$answer,
+					$options,
+					$input_name,
+					$input_id,
+					$input_class,
+					$required,
+					$required_text,
+					$label_class,
+					$disabled,
+					$system_ID,
+					$use_html_entities,
+					$label_b4,
+					$use_desc_4_label
+				);
+
+			case 'CHECKBOX':
+				return EEH_Form_Fields::checkbox(
+					$display_text,
+					$answer,
+					$options,
+					$input_name,
+					$input_id,
+					$input_class,
+					$required,
+					$required_text,
+					$label_class,
+					$disabled,
+					$label_b4,
+					$system_ID,
+					$use_html_entities
+				);
+
+			case 'DATE':
+				return EEH_Form_Fields::datepicker(
+					$display_text,
+					$answer,
+					$input_name,
+					$input_id,
+					$input_class,
+					$required,
+					$required_text,
+					$label_class,
+					$disabled,
+					$system_ID,
+					$use_html_entities
+				);
+
+			case 'TEXT':
+			default:
+				return EEH_Form_Fields::text(
+					$display_text,
+					$answer,
+					$input_name,
+					$input_id,
+					$input_class,
+					$required,
+					$required_text,
+					$label_class,
+					$disabled,
+					$system_ID,
+					$use_html_entities
+				);
+		}
+	}
+
+
+	/**
+	 * generates HTML for a form text input
+	 *
+	 * @param string $question    label content
+	 * @param string $answer      form input value attribute
+	 * @param string $name        form input name attribute
+	 * @param string $id          form input css id attribute
+	 * @param string $class       form input css class attribute
+	 * @param array  $required    'label', 'class', and 'msg' - array of values for required "label" content, css
+	 *                            required 'class', and required 'msg' attribute
+	 * @param string $label_class css class attribute for the label
+	 * @param string $disabled    disabled="disabled" or null
+	 * @return string HTML
+	 */
+	public static function text(
+		$question = false,
+		$answer = null,
+		$name = false,
+		$id = '',
+		$class = '',
+		$required = false,
+		$required_text = '',
+		$label_class = '',
+		$disabled = false,
+		$system_ID = false,
+		$use_html_entities = true
+	) {
+		// need these
+		if (! $question || ! $name) {
+			return null;
+		}
+		// prep the answer
+		$answer = is_array($answer) ? '' : self::prep_answer($answer, $use_html_entities);
+		// prep the required array
+		$required = self::prep_required($required);
+		// set disabled tag
+		$disabled = $answer === null || ! $disabled ? '' : ' disabled="disabled"';
+		// ya gots ta have style man!!!
+		$txt_class = is_admin() ? 'regular-text' : 'espresso-text-inp';
+		$class     = empty($class) ? $txt_class : $class;
+		$class     .= ! empty($system_ID) ? ' ' . $system_ID : '';
+		$extra     = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
+
+		$label_html =
+			$required_text
+			. "\n\t\t\t"
+			. '<label for="' . $name . '" class="' . $label_class . '">'
+			. self::prep_question($question)
+			. $required['label']
+			. '</label><br/>';
+		// filter label but ensure required text comes before it
+		$label_html = apply_filters('FHEE__EEH_Form_Fields__label_html', $label_html, $required_text);
+
+		$input_html =
+			"\n\t\t\t"
+			. '<input type="text" name="' . $name . '" id="' . $id . '" '
+			. 'class="' . $class . ' ' . $required['class'] . '" value="' . esc_attr($answer) . '"  '
+			. 'title="' . esc_attr($required['msg']) . '" ' . $disabled . ' ' . $extra . '/>';
+
+		$input_html = apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
+		return $label_html . $input_html;
+	}
+
+
+	/**
+	 * generates HTML for a form textarea
+	 *
+	 * @param string $question    label content
+	 * @param string $answer      form input value attribute
+	 * @param string $name        form input name attribute
+	 * @param string $id          form input css id attribute
+	 * @param string $class       form input css class attribute
+	 * @param array  $dimensions  array of form input rows and cols attributes : array( 'rows' => 3, 'cols' => 40 )
+	 * @param array  $required    'label', 'class', and 'msg' - array of values for required "label" content, css
+	 *                            required 'class', and required 'msg' attribute
+	 * @param string $label_class css class attribute for the label
+	 * @param string $disabled    disabled="disabled" or null
+	 * @return string HTML
+	 */
+	public static function textarea(
+		$question = false,
+		$answer = null,
+		$name = false,
+		$id = '',
+		$class = '',
+		$dimensions = false,
+		$required = false,
+		$required_text = '',
+		$label_class = '',
+		$disabled = false,
+		$system_ID = false,
+		$use_html_entities = true
+	) {
+		// need these
+		if (! $question || ! $name) {
+			return null;
+		}
+		// prep the answer
+		$answer = is_array($answer) ? '' : self::prep_answer($answer, $use_html_entities);
+		// prep the required array
+		$required = self::prep_required($required);
+		// make sure $dimensions is an array
+		$dimensions = is_array($dimensions) ? $dimensions : [];
+		// and set some defaults
+		$dimensions = array_merge(['rows' => 3, 'cols' => 40], $dimensions);
+		// set disabled tag
+		$disabled = $answer === null || ! $disabled ? '' : ' disabled="disabled"';
+		// ya gots ta have style man!!!
+		$txt_class = is_admin() ? 'regular-text' : 'espresso-textarea-inp';
+		$class     = empty($class) ? $txt_class : $class;
+		$class     .= ! empty($system_ID) ? ' ' . $system_ID : '';
+		$extra     = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
+
+		$label_html =
+			$required_text
+			. "\n\t\t\t"
+			. '<label for="' . $name . '" class="' . $label_class . '">'
+			. self::prep_question($question)
+			. $required['label']
+			. '</label><br/>';
+		// filter label but ensure required text comes before it
+		$label_html = apply_filters('FHEE__EEH_Form_Fields__label_html', $label_html, $required_text);
+
+		$input_html =
+			"\n\t\t\t"
+			. '<textarea name="' . $name . '" id="' . $id . '" class="' . $class . ' ' . $required['class'] . '" '
+			. 'rows="' . $dimensions['rows'] . '" cols="' . $dimensions['cols'] . '"  '
+			. 'title="' . $required['msg'] . '" ' . $disabled . ' ' . $extra . '>'
+			. esc_textarea($answer)
+			. '</textarea>';
+
+		$input_html = apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
+		return $label_html . $input_html;
+	}
+
+
+	/**
+	 * generates HTML for a form select input
+	 *
+	 * @param string $question    label content
+	 * @param string $answer      form input value attribute
+	 * @param array  $options     array of answer options where array key = option value and array value = option
+	 *                            display text
+	 * @param string $name        form input name attribute
+	 * @param string $id          form input css id attribute
+	 * @param string $class       form input css class attribute
+	 * @param array  $required    'label', 'class', and 'msg' - array of values for required "label" content, css
+	 *                            required 'class', and required 'msg' attribute
+	 * @param string $label_class css class attribute for the label
+	 * @param string $disabled    disabled="disabled" or null
+	 * @return string HTML
+	 */
+	public static function select(
+		$question = false,
+		$answer = null,
+		$options = false,
+		$name = false,
+		$id = '',
+		$class = '',
+		$required = false,
+		$required_text = '',
+		$label_class = '',
+		$disabled = false,
+		$system_ID = false,
+		$use_html_entities = true,
+		$add_please_select_option = false
+	) {
+
+		// need these
+		if (! $question || ! $name || ! $options || empty($options) || ! is_array($options)) {
+			return null;
+		}
+		// prep the answer
+		$answer =
+			is_array($answer)
+				? self::prep_answer(array_shift($answer), $use_html_entities)
+				: self::prep_answer(
+					$answer,
+					$use_html_entities
+				);
+		// prep the required array
+		$required = self::prep_required($required);
+		// set disabled tag
+		$disabled = $answer === null || ! $disabled ? '' : ' disabled="disabled"';
+		// ya gots ta have style man!!!
+		$txt_class = is_admin() ? 'wide' : 'espresso-select-inp';
+		$class     = empty($class) ? $txt_class : $class;
+		$class     .= ! empty($system_ID) ? ' ' . $system_ID : '';
+		$extra     = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
+
+		$label_html =
+			$required_text
+			. "\n\t\t\t"
+			. '<label for="' . $name . '" class="' . $label_class . '">'
+			. self::prep_question($question)
+			. $required['label']
+			. '</label><br/>';
+		// filter label but ensure required text comes before it
+		$label_html = apply_filters('FHEE__EEH_Form_Fields__label_html', $label_html, $required_text);
+
+		$input_html =
+			"\n\t\t\t"
+			. '<select name="' . $name . '" id="' . $id . '" class="' . $class . ' ' . $required['class'] . '" '
+			. 'title="' . esc_attr($required['msg']) . '"' . $disabled . ' ' . $extra . '>';
+		// recursively count array elements, to determine total number of options
+		$only_option = count($options, 1) == 1;
+		if (! $only_option) {
+			// if there is NO answer set and there are multiple options to choose from, then set the "please select" message as selected
+			$selected   = $answer === null ? ' selected' : '';
+			$input_html .= $add_please_select_option
+				? "\n\t\t\t\t"
+				  . '<option value=""' . $selected . '>'
+				  . esc_html__(' - please select - ', 'event_espresso')
+				  . '</option>'
+				: '';
+		}
+		foreach ($options as $key => $value) {
+			// if value is an array, then create option groups, else create regular ol' options
+			$input_html .= is_array($value)
+				? self::_generate_select_option_group(
+					$key,
+					$value,
+					$answer,
+					$use_html_entities
+				)
+				: self::_generate_select_option(
+					$value->value(),
+					$value->desc(),
+					$answer,
+					$only_option,
+					$use_html_entities
+				);
+		}
+
+		$input_html .= "\n\t\t\t" . '</select>';
+
+		$input_html =
+			apply_filters(
+				'FHEE__EEH_Form_Fields__select__before_end_wrapper',
+				$input_html,
+				$question,
+				$answer,
+				$name,
+				$id,
+				$class,
+				$system_ID
+			);
+
+		$input_html = apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
+		return $label_html . $input_html;
+	}
+
+
+	/**
+	 *  _generate_select_option_group
+	 *
+	 *  if  $value for a select box is an array, then the key will be used as the optgroup label
+	 *  and the value array will be looped thru and the elements sent to _generate_select_option
+	 *
+	 * @param mixed   $opt_group
+	 * @param mixed   $QSOs
+	 * @param mixed   $answer
+	 * @param boolean $use_html_entities
+	 * @return string
+	 */
+	private static function _generate_select_option_group($opt_group, $QSOs, $answer, $use_html_entities = true)
+	{
+		$html = "\n\t\t\t\t" . '<optgroup label="' . self::prep_option_value($opt_group) . '">';
+		foreach ($QSOs as $QSO) {
+			$html .= self::_generate_select_option($QSO->value(), $QSO->desc(), $answer, false, $use_html_entities);
+		}
+		$html .= "\n\t\t\t\t" . '</optgroup>';
+		return $html;
+	}
+
+
+	/**
+	 *  _generate_select_option
+	 *
+	 * @param mixed   $key
+	 * @param mixed   $value
+	 * @param mixed   $answer
+	 * @param int     $only_option
+	 * @param boolean $use_html_entities
+	 * @return string
+	 */
+	private static function _generate_select_option(
+		$key,
+		$value,
+		$answer,
+		$only_option = false,
+		$use_html_entities = true
+	) {
+		$key      = self::prep_answer($key, $use_html_entities);
+		$value    = self::prep_answer($value, $use_html_entities);
+		$value    = ! empty($value) ? $value : $key;
+		$selected = ($answer == $key || $only_option) ? 'selected' : '';
+		return "\n\t\t\t\t"
+			   . '<option value="' . self::prep_option_value($key) . '" ' . $selected . '> '
+			   . $value
+			   . '&nbsp;&nbsp;&nbsp;</option>';
+	}
+
+
+	/**
+	 * generates HTML for form radio button inputs
+	 *
+	 * @param bool|string $question    label content
+	 * @param string      $answer      form input value attribute
+	 * @param array|bool  $options     array of answer options where array key = option value and array value = option
+	 *                                 display text
+	 * @param bool|string $name        form input name attribute
+	 * @param string      $id          form input css id attribute
+	 * @param string      $class       form input css class attribute
+	 * @param array|bool  $required    'label', 'class', and 'msg' - array of values for required "label" content, css
+	 *                                 required 'class', and required 'msg' attribute
+	 * @param string      $required_text
+	 * @param string      $label_class css class attribute for the label
+	 * @param bool|string $disabled    disabled="disabled" or null
+	 * @param bool        $system_ID
+	 * @param bool        $use_html_entities
+	 * @param bool        $label_b4
+	 * @param bool        $use_desc_4_label
+	 * @return string HTML
+	 */
+	public static function radio(
+		$question = false,
+		$answer = null,
+		$options = false,
+		$name = false,
+		$id = '',
+		$class = '',
+		$required = false,
+		$required_text = '',
+		$label_class = '',
+		$disabled = false,
+		$system_ID = false,
+		$use_html_entities = true,
+		$label_b4 = false,
+		$use_desc_4_label = false
+	) {
+		// need these
+		if (! $question || ! $name || ! $options || empty($options) || ! is_array($options)) {
+			return null;
+		}
+		// prep the answer
+		$answer = is_array($answer) ? '' : self::prep_answer($answer, $use_html_entities);
+		// prep the required array
+		$required = self::prep_required($required);
+		// set disabled tag
+		$disabled = $answer === null || ! $disabled ? '' : ' disabled="disabled"';
+		// ya gots ta have style man!!!
+		$radio_class = is_admin() ? 'ee-admin-radio-lbl' : $label_class;
+		$class       = ! empty($class) ? $class : 'espresso-radio-btn-inp';
+		$extra       = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
+
+		$label_html =
+			$required_text
+			. "\n\t\t\t"
+			. '<label class="' . $label_class . '">'
+			. self::prep_question($question)
+			. $required['label']
+			. '</label> ';
+		// filter label but ensure required text comes before it
+		$label_html = apply_filters('FHEE__EEH_Form_Fields__label_html', $label_html, $required_text);
+
+		$input_html =
+			"\n\t\t\t"
+			. '<ul id="' . $id . '-ul" class="espresso-radio-btn-options-ul ' . $label_class . ' ' . $class . '-ul">';
+
+		$class .= ! empty($system_ID) ? ' ' . $system_ID : '';
+		$class .= ! empty($required['class']) ? ' ' . $required['class'] : '';
+
+		foreach ($options as $OPT) {
+			if ($OPT instanceof EE_Question_Option) {
+				$value   = self::prep_option_value($OPT->value());
+				$label   = $use_desc_4_label ? $OPT->desc() : $OPT->value();
+				$size    = $use_desc_4_label
+					? self::get_label_size_class($OPT->value() . ' ' . $OPT->desc())
+					: self::get_label_size_class($OPT->value());
+				$desc    = $OPT->desc();// no self::prep_answer
+				$answer  = is_numeric($value) && empty($answer) ? 0 : $answer;
+				$checked = (string) $value == (string) $answer ? ' checked' : '';
+				$opt     = '-' . sanitize_key($value);
+
+				$input_html .= "\n\t\t\t\t" . '<li' . $size . '>';
+				$input_html .= "\n\t\t\t\t\t" . '<label class="' . $radio_class . ' espresso-radio-btn-lbl">';
+				$input_html .= $label_b4 ? "\n\t\t\t\t\t\t" . '<span>' . $label . '</span>' : '';
+				$input_html .= "\n\t\t\t\t\t\t"
+							   . '<input type="radio" name="' . $name . '" id="' . $id . $opt . '" '
+							   . 'class="' . $class . '" value="' . $value . '" '
+							   . 'title="' . esc_attr($required['msg']) . '" ' . $disabled
+							   . $checked . ' ' . $extra . '/>';
+				$input_html .= ! $label_b4
+					? "\n\t\t\t\t\t\t"
+					  . '<span class="espresso-radio-btn-desc">'
+					  . $label
+					  . '</span>'
+					: '';
+				$input_html .= "\n\t\t\t\t\t" . '</label>';
+				$input_html .= $use_desc_4_label
+					? ''
+					: '<span class="espresso-radio-btn-option-desc small-text grey-text">' . $desc . '</span>';
+				$input_html .= "\n\t\t\t\t" . '</li>';
+			}
+		}
+
+		$input_html .= "\n\t\t\t" . '</ul>';
+
+		$input_html = apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
+		return $label_html . $input_html;
+	}
+
+
+	/**
+	 * generates HTML for form checkbox inputs
+	 *
+	 * @param string $question    label content
+	 * @param string $answer      form input value attribute
+	 * @param array  $options     array of options where array key = option value and array value = option display text
+	 * @param string $name        form input name attribute
+	 * @param string $id          form input css id attribute
+	 * @param string $class       form input css class attribute
+	 * @param array  $required    'label', 'class', and 'msg' - array of values for required "label" content, css
+	 *                            required 'class', and required 'msg' attribute
+	 * @param string $label_class css class attribute for the label
+	 * @param string $disabled    disabled="disabled" or null
+	 * @return string HTML
+	 */
+	public static function checkbox(
+		$question = false,
+		$answer = null,
+		$options = false,
+		$name = false,
+		$id = '',
+		$class = '',
+		$required = false,
+		$required_text = '',
+		$label_class = '',
+		$disabled = false,
+		$label_b4 = false,
+		$system_ID = false,
+		$use_html_entities = true
+	) {
+		// need these
+		if (! $question || ! $name || ! $options || empty($options) || ! is_array($options)) {
+			return null;
+		}
+		$answer = maybe_unserialize($answer);
+
+		// prep the answer(s)
+		$answer = is_array($answer) ? $answer : [sanitize_key($answer) => $answer];
+
+		foreach ($answer as $key => $value) {
+			$key            = self::prep_option_value($key);
+			$answer[ $key ] = self::prep_answer($value, $use_html_entities);
+		}
+
+		// prep the required array
+		$required = self::prep_required($required);
+		// set disabled tag
+		$disabled = $answer === null || ! $disabled ? '' : ' disabled="disabled"';
+		// ya gots ta have style man!!!
+		$radio_class = is_admin() ? 'ee-admin-radio-lbl' : $label_class;
+		$class       = empty($class) ? 'espresso-radio-btn-inp' : $class;
+		$extra       = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
+
+		$label_html =
+			$required_text
+			. "\n\t\t\t"
+			. '<label class="' . $label_class . '">'
+			. self::prep_question($question)
+			. $required['label']
+			. '</label> ';
+		// filter label but ensure required text comes before it
+		$label_html = apply_filters('FHEE__EEH_Form_Fields__label_html', $label_html, $required_text);
+
+		$input_html =
+			"\n\t\t\t"
+			. '<ul id="' . $id . '-ul" class="espresso-checkbox-options-ul ' . $label_class . ' ' . $class . '-ul">';
+
+		$class .= ! empty($system_ID) ? ' ' . $system_ID : '';
+		$class .= ! empty($required['class']) ? ' ' . $required['class'] : '';
+
+		foreach ($options as $OPT) {
+			$value = $OPT->value();// self::prep_option_value( $OPT->value() );
+			$size  = self::get_label_size_class($OPT->value() . ' ' . $OPT->desc());
+			$text  = self::prep_answer($OPT->value());
+			$desc  = $OPT->desc();
+			$opt   = '-' . sanitize_key($value);
+
+			$checked = is_array($answer) && in_array($text, $answer) ? ' checked' : '';
+
+			$input_html .= "\n\t\t\t\t" . '<li' . $size . '>';
+			$input_html .= "\n\t\t\t\t\t" . '<label class="' . $radio_class . ' espresso-checkbox-lbl">';
+			$input_html .= $label_b4 ? "\n\t\t\t\t\t\t" . '<span>' . $text . '</span>' : '';
+			$input_html .= "\n\t\t\t\t\t\t"
+						   . '<input type="checkbox" name="' . $name . '[' . $OPT->ID() . ']" '
+						   . 'id="' . $id . $opt . '" class="' . $class . '" value="' . $value . '" '
+						   . 'title="' . esc_attr($required['msg']) . '" ' . $disabled . $checked . ' ' . $extra . '/>';
+			$input_html .= ! $label_b4 ? "\n\t\t\t\t\t\t" . '<span>' . $text . '</span>' : '';
+			$input_html .= "\n\t\t\t\t\t" . '</label>';
+			if (! empty($desc) && $desc != $text) {
+				$input_html .= "\n\t\t\t\t\t"
+							   . ' &nbsp; <br/><div class="espresso-checkbox-option-desc small-text grey-text">'
+							   . $desc
+							   . '</div>';
+			}
+			$input_html .= "\n\t\t\t\t" . '</li>';
+		}
+
+		$input_html .= "\n\t\t\t" . '</ul>';
+
+		$input_html = apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
+		return $label_html . $input_html;
+	}
+
+
+	/**
+	 * generates HTML for a form datepicker input
+	 *
+	 * @param string $question    label content
+	 * @param string $answer      form input value attribute
+	 * @param string $name        form input name attribute
+	 * @param string $id          form input css id attribute
+	 * @param string $class       form input css class attribute
+	 * @param array  $required    'label', 'class', and 'msg' - array of values for required "label" content, css
+	 *                            required 'class', and required 'msg' attribute
+	 * @param string $label_class css class attribute for the label
+	 * @param string $disabled    disabled="disabled" or null
+	 * @return string HTML
+	 */
+	public static function datepicker(
+		$question = false,
+		$answer = null,
+		$name = false,
+		$id = '',
+		$class = '',
+		$required = false,
+		$required_text = '',
+		$label_class = '',
+		$disabled = false,
+		$system_ID = false,
+		$use_html_entities = true
+	) {
+		// need these
+		if (! $question || ! $name) {
+			return null;
+		}
+		// prep the answer
+		$answer = is_array($answer) ? '' : self::prep_answer($answer, $use_html_entities);
+		// prep the required array
+		$required = self::prep_required($required);
+		// set disabled tag
+		$disabled = $answer === null || ! $disabled ? '' : ' disabled="disabled"';
+		// ya gots ta have style man!!!
+		$txt_class = is_admin() ? 'regular-text' : 'espresso-datepicker-inp';
+		$class     = empty($class) ? $txt_class : $class;
+		$class     .= ! empty($system_ID) ? ' ' . $system_ID : '';
+		$extra     = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
+
+		$label_html =
+			$required_text
+			. "\n\t\t\t"
+			. '<label for="' . $name . '" class="' . $label_class . '">'
+			. self::prep_question($question)
+			. $required['label']
+			. '</label><br/>';
+		// filter label but ensure required text comes before it
+		$label_html = apply_filters('FHEE__EEH_Form_Fields__label_html', $label_html, $required_text);
+
+		$input_html =
+			"\n\t\t\t"
+			. '<input type="text" name="' . $name . '" id="' . $id . '" '
+			. 'class="' . $class . ' ' . $required['class'] . ' datepicker" value="' . $answer . '"  '
+			. 'title="' . esc_attr($required['msg']) . '" ' . $disabled . ' ' . $extra . '/>';
+
+		// enqueue scripts
+		wp_register_style(
+			'espresso-ui-theme',
+			EE_GLOBAL_ASSETS_URL . 'css/espresso-ui-theme/jquery-ui-1.10.3.custom.min.css',
+			[],
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_style('espresso-ui-theme');
+		wp_enqueue_script('jquery-ui-datepicker');
+
+		$input_html = apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
+		return $label_html . $input_html;
+	}
+
+
+	/**
+	 *  remove_label_keep_required_msg
+	 *  this will strip out a form input's label HTML while keeping the required text HTML that MUST be before the label
+	 *
+	 * @access public
+	 * @return     string
+	 */
+	public static function remove_label_keep_required_msg($label_html, $required_text)
+	{
+		return $required_text;
+	}
+
+
+	/**
+	 * Simply returns the HTML for a hidden input of the given name and value.
+	 *
+	 * @param string $name
+	 * @param string $value
+	 * @return string HTML
+	 */
+	public static function hidden_input($name, $value, $id = '')
+	{
+		$id = ! empty($id) ? $id : $name;
+		return '<input id="' . $id . '" type="hidden" name="' . $name . '" value="' . $value . '"/>';
+	}
+
+
+	/**
+	 * prep_question
+	 *
+	 * @param string $question
+	 * @return string
+	 */
+	public static function prep_question($question)
+	{
+		return $question;
+	}
+
+
+	/**
+	 *  prep_answer
+	 *
+	 * @param mixed $answer
+	 * @return string
+	 */
+	public static function prep_answer($answer, $use_html_entities = true)
+	{
+		// make sure we convert bools first.  Otherwise (bool) false becomes an empty string which is NOT desired,
+		// we want "0".
+		if (is_bool($answer)) {
+			$answer = $answer ? 1 : 0;
+		}
+		$answer = trim(stripslashes(str_replace('&#039;', "'", $answer)));
+		return $use_html_entities ? htmlentities($answer, ENT_QUOTES, 'UTF-8') : $answer;
+	}
+
+
+	/**
+	 *  prep_answer_options
+	 *
+	 * @param array $QSOs array of EE_Question_Option objects
+	 * @return array
+	 */
+	public static function prep_answer_options($QSOs = [])
+	{
+		$prepped_answer_options = [];
+		if (is_array($QSOs) && ! empty($QSOs)) {
+			foreach ($QSOs as $key => $QSO) {
+				if (! $QSO instanceof EE_Question_Option) {
+					$QSO = EE_Question_Option::new_instance(
+						[
+							'QSO_value' => is_array($QSO) && isset($QSO['id'])
+								? (string) $QSO['id']
+								: (string) $key,
+							'QSO_desc'  => is_array($QSO) && isset($QSO['text'])
+								? (string) $QSO['text']
+								: (string) $QSO,
+						]
+					);
+				}
+				if ($QSO->opt_group()) {
+					$prepped_answer_options[ $QSO->opt_group() ][] = $QSO;
+				} else {
+					$prepped_answer_options[] = $QSO;
+				}
+			}
+		}
+		//      d( $prepped_answer_options );
+		return $prepped_answer_options;
+	}
+
+
+	/**
+	 *  prep_option_value
+	 *
+	 * @param string $option_value
+	 * @return string
+	 */
+	public static function prep_option_value($option_value)
+	{
+		return esc_attr(trim(stripslashes($option_value)));
+	}
+
+
+	/**
+	 *  prep_required
+	 *
+	 * @param string|array $required
+	 * @return array
+	 */
+	public static function prep_required($required = [])
+	{
+		// make sure required is an array
+		$required = is_array($required) ? $required : [];
+		// and set some defaults
+		return array_merge(['label' => '', 'class' => '', 'msg' => ''], $required);
+	}
+
+
+	/**
+	 *  get_label_size_class
+	 *
+	 * @param string $value
+	 * @return string
+	 */
+	public static function get_label_size_class($value = false)
+	{
+		if ($value === false || $value === '') {
+			return ' class="medium-lbl"';
+		}
+		// determine length of option value
+		$val_size = strlen($value);
+		switch ($val_size) {
+			case $val_size < 3:
+				$size = ' class="nano-lbl"';
+				break;
+			case $val_size < 6:
+				$size = ' class="micro-lbl"';
+				break;
+			case $val_size < 12:
+				$size = ' class="tiny-lbl"';
+				break;
+			case $val_size < 25:
+				$size = ' class="small-lbl"';
+				break;
+			case $val_size > 100:
+				$size = ' class="big-lbl"';
+				break;
+			default:
+				$size = ' class="medium-lbl"';
+				break;
+		}
+		return $size;
+	}
+
+
+	/**
+	 *  _load_system_dropdowns
+	 *
+	 * @param EE_Question_Form_Input $QFI
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private static function _load_system_dropdowns($QFI)
+	{
+		$QST_system = $QFI->get('QST_system');
+		switch ($QST_system) {
+			case 'state':
+				$QFI = self::generate_state_dropdown($QFI);
+				break;
+			case 'country':
+				$QFI = self::generate_country_dropdown($QFI);
+				break;
+			case 'admin-state':
+				$QFI = self::generate_state_dropdown($QFI, true);
+				break;
+			case 'admin-country':
+				$QFI = self::generate_country_dropdown($QFI, true);
+				break;
+		}
+		return $QFI;
+	}
+
+
+	/**
+	 * This preps dropdowns that are specialized.
+	 *
+	 * @param EE_Question_Form_Input $QFI
+	 *
+	 * @return EE_Question_Form_Input
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since  4.6.0
+	 */
+	protected static function _load_specialized_dropdowns($QFI)
+	{
+		switch ($QFI->get('QST_type')) {
+			case 'STATE':
+				$QFI = self::generate_state_dropdown($QFI);
+				break;
+			case 'COUNTRY':
+				$QFI = self::generate_country_dropdown($QFI);
+				break;
+		}
+		return $QFI;
+	}
+
+
+	/**
+	 *    generate_state_dropdown
+	 *
+	 * @param EE_Question_Form_Input $QST
+	 * @param bool                   $get_all
+	 * @return EE_Question_Form_Input
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function generate_state_dropdown($QST, $get_all = false)
+	{
+		$states = $get_all
+			? EEM_State::instance()->get_all_states()
+			: EEM_State::instance()->get_all_states_of_active_countries();
+		if ($states && count($states) != count($QST->options())) {
+			$QST->set('QST_type', 'DROPDOWN');
+			// if multiple countries, we'll create option groups within the dropdown
+			foreach ($states as $state) {
+				if ($state instanceof EE_State) {
+					$QSO = EE_Question_Option::new_instance(
+						[
+							'QSO_value'   => $state->ID(),
+							'QSO_desc'    => $state->name(),
+							'QST_ID'      => $QST->get('QST_ID'),
+							'QSO_deleted' => false,
+						]
+					);
+					// set option group
+					$QSO->set_opt_group($state->country()->name());
+					// add option to question
+					$QST->add_temp_option($QSO);
+				}
+			}
+		}
+		return $QST;
+	}
+
+
+	/**
+	 *    generate_country_dropdown
+	 *
+	 * @param      $QST
+	 * @param bool $get_all
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @internal param array $question
+	 */
+	public static function generate_country_dropdown($QST, $get_all = false)
+	{
+		$countries = $get_all
+			? EEM_Country::instance()->get_all_countries()
+			: EEM_Country::instance()->get_all_active_countries();
+		if ($countries && count($countries) != count($QST->options())) {
+			$QST->set('QST_type', 'DROPDOWN');
+			// now add countries
+			foreach ($countries as $country) {
+				if ($country instanceof EE_Country) {
+					$QSO = EE_Question_Option::new_instance(
+						[
+							'QSO_value'   => $country->ID(),
+							'QSO_desc'    => $country->name(),
+							'QST_ID'      => $QST->get('QST_ID'),
+							'QSO_deleted' => false,
+						]
+					);
+					$QST->add_temp_option($QSO);
+				}
+			}
+		}
+		return $QST;
+	}
+
+
+	/**
+	 *  generates options for a month dropdown selector with numbers from 01 to 12
+	 *
+	 * @return array()
+	 */
+	public static function two_digit_months_dropdown_options()
+	{
+		$options = [];
+		for ($x = 1; $x <= 12; $x++) {
+			$mm             = str_pad($x, 2, '0', STR_PAD_LEFT);
+			$options[ $mm ] = $mm;
+		}
+		return EEH_Form_Fields::prep_answer_options($options);
+	}
+
+
+	/**
+	 *  generates a year dropdown selector with numbers for the next ten years
+	 *
+	 * @return array
+	 */
+	public static function next_decade_two_digit_year_dropdown_options()
+	{
+		$options      = [];
+		$current_year = date('y');
+		$next_decade  = $current_year + 10;
+		for ($x = $current_year; $x <= $next_decade; $x++) {
+			$yy             = str_pad($x, 2, '0', STR_PAD_LEFT);
+			$options[ $yy ] = $yy;
+		}
+		return EEH_Form_Fields::prep_answer_options($options);
+	}
+
+
+	/**
+	 * generates a month/year dropdown selector for all registrations matching the given criteria.  Typically used for
+	 * list table filter.
+	 *
+	 * @param string  $cur_date     any currently selected date can be entered here.
+	 * @param string  $status       Registration status
+	 * @param integer $evt_category Event Category ID if the Event Category filter is selected
+	 * @return string                html
+	 * @throws EE_Error
+	 */
+	public static function generate_registration_months_dropdown($cur_date = '', $status = '', $evt_category = 0)
+	{
+		$_where = [];
+		if (! empty($status)) {
+			$_where['STS_ID'] = $status;
+		}
+
+		if ($evt_category > 0) {
+			$_where['Event.Term_Taxonomy.term_id'] = $evt_category;
+		}
+
+		$regdtts = EEM_Registration::instance()->get_reg_months_and_years($_where);
+
+		// setup vals for select input helper
+		$options = [
+			0 => [
+				'text' => esc_html__('Select a Month/Year', 'event_espresso'),
+				'id'   => '',
+			],
+		];
+
+		foreach ($regdtts as $regdtt) {
+			$date      = $regdtt->reg_month . ' ' . $regdtt->reg_year;
+			$options[] = [
+				'text' => $date,
+				'id'   => $date,
+			];
+		}
+
+		return self::select_input('month_range', $options, $cur_date, '', 'wide');
+	}
+
+
+	/**
+	 * generates a month/year dropdown selector for all events matching the given criteria
+	 * Typically used for list table filter
+	 *
+	 * @param string $cur_date          any currently selected date can be entered here.
+	 * @param string $status            "view" (i.e. all, today, month, draft)
+	 * @param int    $evt_category      category event belongs to
+	 * @param string $evt_active_status "upcoming", "expired", "active", or "inactive"
+	 * @return string                    html
+	 * @throws EE_Error
+	 */
+	public static function generate_event_months_dropdown(
+		$cur_date = '',
+		$status = null,
+		$evt_category = null,
+		$evt_active_status = null
+	) {
+		// determine what post_status our condition will have for the query.
+		// phpcs:disable PSR2.ControlStructures.SwitchDeclaration.TerminatingComment
+		switch ($status) {
+			case 'month':
+			case 'today':
+			case null:
+			case 'all':
+				$where['Event.status'] = ['NOT IN', ['trash']];
+				break;
+			case 'draft':
+				$where['Event.status'] = ['IN', ['draft', 'auto-draft']];
+				break;
+			default:
+				$where['Event.status'] = $status;
+		}
+
+		// phpcs:enable
+
+		// categories?
+
+
+		if (! empty($evt_category)) {
+			$where['Event.Term_Taxonomy.taxonomy'] = 'espresso_event_categories';
+			$where['Event.Term_Taxonomy.term_id']  = $evt_category;
+		}
+
+
+		//      $where['DTT_is_primary'] = 1;
+
+		$DTTS = EEM_Datetime::instance()->get_dtt_months_and_years($where, $evt_active_status);
+
+		// let's setup vals for select input helper
+		$options = [
+			0 => [
+				'text' => esc_html__('Select a Month/Year', 'event_espresso'),
+				'id'   => "",
+			],
+		];
+
+
+		// translate month and date
+		global $wp_locale;
+
+		foreach ($DTTS as $DTT) {
+			$localized_date = $wp_locale->get_month($DTT->dtt_month_num) . ' ' . $DTT->dtt_year;
+			$id             = $DTT->dtt_month . ' ' . $DTT->dtt_year;
+			$options[]      = [
+				'text' => $localized_date,
+				'id'   => $id,
+			];
+		}
+
+
+		return self::select_input('month_range', $options, $cur_date, '', 'wide');
+	}
+
+
+	/**
+	 * generates the dropdown selector for event categories
+	 * typically used as a filter on list tables.
+	 *
+	 * @param integer $current_cat currently selected category
+	 * @return string               html for dropdown
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function generate_event_category_dropdown($current_cat = -1)
+	{
+		$categories = EEM_Term::instance()->get_all_ee_categories(true);
+		$options    = [
+			'0' => [
+				'text' => esc_html__('All Categories', 'event_espresso'),
+				'id'   => -1,
+			],
+		];
+
+		// setup categories for dropdown
+		foreach ($categories as $category) {
+			$options[] = [
+				'text' => $category->get('name'),
+				'id'   => $category->ID(),
+			];
+		}
+
+		return self::select_input('EVT_CAT', $options, $current_cat);
+	}
+
+
+	/**
+	 *    generate a submit button with or without it's own microform
+	 *    this is the only way to create buttons that are compatible across all themes
+	 *
+	 * @access    public
+	 * @param string      $url              - the form action
+	 * @param string      $ID               - some kind of unique ID, appended with "-sbmt" for the input and "-frm"
+	 *                                      for the form
+	 * @param string      $class            - css classes (separated by spaces if more than one)
+	 * @param string      $text             - what appears on the button
+	 * @param string      $nonce_action     - if using nonces
+	 * @param bool|string $input_only       - whether to print form header and footer. TRUE returns the input without
+	 *                                      the form
+	 * @param string      $extra_attributes - any extra attributes that need to be attached to the form input
+	 * @return    string
+	 */
+	public static function submit_button(
+		$url = '',
+		$ID = '',
+		$class = '',
+		$text = '',
+		$nonce_action = '',
+		$input_only = false,
+		$extra_attributes = ''
+	) {
+		$btn = '';
+		if (empty($url) || empty($ID)) {
+			return $btn;
+		}
+		$text = ! empty($text) ? $text : esc_html__('Submit', 'event_espresso');
+		$btn  .= '<input id="' . $ID . '-btn" class="' . $class . '" '
+				 . 'type="submit" value="' . $text . '" ' . $extra_attributes . '/>';
+		if (! $input_only) {
+			$btn_frm = '<form id="' . $ID . '-frm" method="POST" action="' . $url . '">';
+			$btn_frm .= ! empty($nonce_action)
+				? wp_nonce_field($nonce_action, $nonce_action . '_nonce', true, false)
+				: '';
+			$btn_frm .= $btn;
+			$btn_frm .= '</form>';
+			$btn     = $btn_frm;
+			unset($btn_frm);
+		}
+		return $btn;
+	}
 }

Spacing +148 added lines, -148 removed lines

@@ -108,8 +108,8 @@ 
             $type           = $input_value['input'];
             $value          = $input_value['value'];
 
-            $id    = $form_id ? $form_id . '-' . $input_key : $input_key;
-            $class = $required ? 'required ' . $css_class : $css_class;
+            $id    = $form_id ? $form_id.'-'.$input_key : $input_key;
+            $class = $required ? 'required '.$css_class : $css_class;
 
             // what type of input are we dealing with ?
             switch ($type) {
@@ -161,8 +161,8 @@ 
             }
         } // end foreach( $input_vars as $input_key => $input_value )
 
-        if (! empty($inputs)) {
-            $glue   = "
+        if ( ! empty($inputs)) {
+            $glue = "
                 </li>
                 <li>
                     ";
@@ -175,7 +175,7 @@ 
             </ul>
             ";
         }
-        return $output . implode("\n", $hidden_inputs);
+        return $output.implode("\n", $hidden_inputs);
     }
 
 
@@ -256,7 +256,7 @@ 
             // generate label
             $label = ! empty($label) ? self::adminLabel($id, $label, $required) : '';
             // generate field name
-            $name = ! empty($unique_id) ? $field_name . '[' . $unique_id . ']' : $field_name;
+            $name = ! empty($unique_id) ? $field_name.'['.$unique_id.']' : $field_name;
 
             // we determine what we're building based on the type
             switch ($type) {
@@ -267,14 +267,14 @@ 
                         foreach ($value as $key => $val) {
                             $c_input .= self::adminMulti(
                                 $default,
-                                isset($classes[ $key ]) ? $classes[ $key ] : '',
-                                $field_name . '_' . $value,
+                                isset($classes[$key]) ? $classes[$key] : '',
+                                $field_name.'_'.$value,
                                 $name,
                                 $required,
                                 $tab_index,
                                 $type,
                                 $val,
-                                isset($labels[ $key ]) ? $labels[ $key ] : ''
+                                isset($labels[$key]) ? $labels[$key] : ''
                             );
                         }
                         $field = $c_input;
@@ -300,7 +300,7 @@ 
                 case 'select':
                     $options = [];
                     foreach ($value as $key => $val) {
-                        $options[ $val ] = isset($labels[ $key ]) ? $labels[ $key ] : '';
+                        $options[$val] = isset($labels[$key]) ? $labels[$key] : '';
                     }
                     $field = self::adminSelect($default, $class, $id, $name, $required, $tab_index, $options);
                     break;
@@ -326,7 +326,7 @@ 
                     $field = self::adminText($class, $id, $name, $required, $tab_index, $value);
             }
 
-            $form_fields[ $field_name ] = ['label' => $label, 'field' => $field . $extra_desc];
+            $form_fields[$field_name] = ['label' => $label, 'field' => $field.$extra_desc];
         }
 
         return $form_fields;
@@ -344,8 +344,8 @@ 
     private static function adminHidden($class, $id, $name, $value)
     {
         return "
-        <input name='" . esc_attr($name) . "' type='hidden' id='" . esc_attr($id) . "' class='" . esc_attr($class) . "' 
-        value='" . esc_attr($value) . "' />";
+        <input name='" . esc_attr($name)."' type='hidden' id='".esc_attr($id)."' class='".esc_attr($class)."' 
+        value='" . esc_attr($value)."' />";
     }
 
 
@@ -359,7 +359,7 @@ 
     private static function adminLabel($id, $label, $required)
     {
         $required = filter_var($required, FILTER_VALIDATE_BOOLEAN) ? " <span>*</span>" : '';
-        return "<label for='" . esc_attr($id) . "'>" . esc_html($label) . $required . "</label>";
+        return "<label for='".esc_attr($id)."'>".esc_html($label).$required."</label>";
     }
 
 
@@ -381,7 +381,7 @@ 
         $checked   = ! empty($default) && $default == $value ? 'checked ' : '';
         $required  = filter_var($required, FILTER_VALIDATE_BOOLEAN) ? 'required' : '';
         $input     = "
-        <input name='" . esc_attr($name) . "[]' type='" . esc_attr($type) . "' id='" . esc_attr($id) . "' class='" . esc_attr($class) . "' value='" . esc_attr($value) . "' {$checked} {$required} tabindex='" . absint($tab_index) . "'/>";
+        <input name='" . esc_attr($name)."[]' type='".esc_attr($type)."' id='".esc_attr($id)."' class='".esc_attr($class)."' value='".esc_attr($value)."' {$checked} {$required} tabindex='".absint($tab_index)."'/>";
         if ($label === '') {
             return $input;
         }
@@ -411,13 +411,13 @@ 
         foreach ($options as $value => $label) {
             $selected        = ! empty($default) && $default == $value ? 'selected' : '';
             $label           = wp_strip_all_tags($label);
-            $options_array[] = "<option value='" . esc_attr($value) . "' {$selected}>{$label}</option>";
+            $options_array[] = "<option value='".esc_attr($value)."' {$selected}>{$label}</option>";
         }
         $options_html = implode("\n", $options_array);
         $required     = filter_var($required, FILTER_VALIDATE_BOOLEAN) ? 'required' : '';
         return "
-        <select name='" . esc_attr($name) . "' id='" . esc_attr($id) . "' class='" . esc_attr($class) . "' {$required} 
-        tabindex='" . absint($tab_index) . "'>
+        <select name='" . esc_attr($name)."' id='".esc_attr($id)."' class='".esc_attr($class)."' {$required} 
+        tabindex='".absint($tab_index)."'>
             {$options_html}
         </select>";
     }
@@ -435,10 +435,10 @@ 
      */
     private static function adminText($class, $id, $name, $required, $tab_index, $value)
     {
-        $required  = filter_var($required, FILTER_VALIDATE_BOOLEAN) ? 'required' : '';
+        $required = filter_var($required, FILTER_VALIDATE_BOOLEAN) ? 'required' : '';
         return "
-        <input name='" . esc_attr($name) . "' type='text' id='" . esc_attr($id) . "' class='" . esc_attr($class) . "' 
-        value='" . esc_attr($value) . "' {$required} tabindex='" . absint($tab_index) . "'/>";
+        <input name='" . esc_attr($name)."' type='text' id='".esc_attr($id)."' class='".esc_attr($class)."' 
+        value='" . esc_attr($value)."' {$required} tabindex='".absint($tab_index)."'/>";
     }
 
 
@@ -456,9 +456,9 @@ 
      */
     private static function adminTextarea($class, $cols, $id, $name, $required, $rows, $tab_index, $value)
     {
-        $required  = filter_var($required, FILTER_VALIDATE_BOOLEAN) ? 'required' : '';
+        $required = filter_var($required, FILTER_VALIDATE_BOOLEAN) ? 'required' : '';
         return "
-        <textarea name='" . esc_attr($name) . "' id='" . esc_attr($id) . "' class='" . esc_attr($class) . "' rows='" . absint($rows) . "' cols='" . absint($cols) . "' {$required} tabindex='" . absint($tab_index) . "'>" . esc_textarea($value) . "</textarea>";
+        <textarea name='" . esc_attr($name)."' id='".esc_attr($id)."' class='".esc_attr($class)."' rows='".absint($rows)."' cols='".absint($cols)."' {$required} tabindex='".absint($tab_index)."'>".esc_textarea($value)."</textarea>";
     }
 
 
@@ -510,7 +510,7 @@ 
     public static function select_input($name, $values, $default = '', $parameters = '', $class = '', $autosize = true)
     {
         // if $values was submitted in the wrong format, convert it over
-        if (! empty($values) && (! array_key_exists(0, $values) || ! is_array($values[0]))) {
+        if ( ! empty($values) && ( ! array_key_exists(0, $values) || ! is_array($values[0]))) {
             $converted_values = [];
             foreach ($values as $id => $text) {
                 $converted_values[] = ['id' => $id, 'text' => $text];
@@ -519,18 +519,18 @@ 
         }
 
         $field =
-            '<select id="' . EEH_Formatter::ee_tep_output_string($name)
-            . '" name="' . EEH_Formatter::ee_tep_output_string($name)
+            '<select id="'.EEH_Formatter::ee_tep_output_string($name)
+            . '" name="'.EEH_Formatter::ee_tep_output_string($name)
             . '"';
 
         if (EEH_Formatter::ee_tep_not_null($parameters)) {
-            $field .= ' ' . $parameters;
+            $field .= ' '.$parameters;
         }
         if ($autosize) {
             $size = 'med';
             for ($ii = 0, $ni = sizeof($values); $ii < $ni; $ii++) {
-                if ($values[ $ii ]['text']) {
-                    if (strlen($values[ $ii ]['text']) > 5) {
+                if ($values[$ii]['text']) {
+                    if (strlen($values[$ii]['text']) > 5) {
                         $size = 'wide';
                     }
                 }
@@ -539,22 +539,22 @@ 
             $size = '';
         }
 
-        $field .= ' class="' . $class . ' ' . $size . '">';
+        $field .= ' class="'.$class.' '.$size.'">';
 
-        if (empty($default) && isset($GLOBALS[ $name ])) {
-            $default = stripslashes($GLOBALS[ $name ]);
+        if (empty($default) && isset($GLOBALS[$name])) {
+            $default = stripslashes($GLOBALS[$name]);
         }
 
 
         for ($i = 0, $n = sizeof($values); $i < $n; $i++) {
-            $field .= '<option value="' . $values[ $i ]['id'] . '"';
-            if ($default == $values[ $i ]['id']) {
+            $field .= '<option value="'.$values[$i]['id'].'"';
+            if ($default == $values[$i]['id']) {
                 $field .= ' selected = "selected"';
             }
-            if (isset($values[ $i ]['class'])) {
-                $field .= ' class="' . $values[ $i ]['class'] . '"';
+            if (isset($values[$i]['class'])) {
+                $field .= ' class="'.$values[$i]['class'].'"';
             }
-            $field .= '>' . $values[ $i ]['text'] . '</option>';
+            $field .= '>'.$values[$i]['text'].'</option>';
         }
         $field .= '</select>';
 
@@ -580,11 +580,11 @@ 
         $after_question_group_questions  =
             apply_filters('FHEE__EEH_Form_Fields__generate_question_groups_html__after_question_group_questions', '');
 
-        if (! empty($question_groups)) {
+        if ( ! empty($question_groups)) {
             // loop thru question groups
             foreach ($question_groups as $QSG) {
                 // check that questions exist
-                if (! empty($QSG['QSG_questions'])) {
+                if ( ! empty($QSG['QSG_questions'])) {
                     // use fieldsets
                     $html .= "\n\t"
                              . '<'
@@ -609,7 +609,7 @@ 
                     $html .= $before_question_group_questions;
                     // loop thru questions
                     foreach ($QSG['QSG_questions'] as $question) {
-                        $QFI  = new EE_Question_Form_Input(
+                        $QFI = new EE_Question_Form_Input(
                             $question['qst_obj'],
                             $question['ans_obj'],
                             $question
@@ -617,7 +617,7 @@ 
                         $html .= self::generate_form_input($QFI);
                     }
                     $html .= $after_question_group_questions;
-                    $html .= "\n\t" . '</' . $group_wrapper . '>';
+                    $html .= "\n\t".'</'.$group_wrapper.'>';
                 }
             }
         }
@@ -657,25 +657,25 @@ 
             'input_id'    => '',
             'input_class' => '',
         ];
-        $q_meta         = array_merge($default_q_meta, $q_meta);
+        $q_meta = array_merge($default_q_meta, $q_meta);
 
-        if (! empty($question_groups)) {
+        if ( ! empty($question_groups)) {
             // loop thru question groups
             foreach ($question_groups as $QSG) {
                 if ($QSG instanceof EE_Question_Group) {
                     // check that questions exist
 
                     $where = ['QST_deleted' => 0];
-                    if (! $from_admin) {
+                    if ( ! $from_admin) {
                         $where['QST_admin_only'] = 0;
                     }
                     $questions =
                         $QSG->questions([$where, 'order_by' => ['Question_Group_Question.QGQ_order' => 'ASC']]);
-                    if (! empty($questions)) {
+                    if ( ! empty($questions)) {
                         // use fieldsets
                         $html .= "\n\t"
-                                 . '<' . $group_wrapper . ' class="espresso-question-group-wrap" '
-                                 . 'id="' . $QSG->get('QSG_identifier') . '">';
+                                 . '<'.$group_wrapper.' class="espresso-question-group-wrap" '
+                                 . 'id="'.$QSG->get('QSG_identifier').'">';
                         // group_name
                         if ($QSG->show_group_name()) {
                             $html .= "\n\t\t"
@@ -700,21 +700,21 @@ 
                             /** @var RequestInterface $request */
                             $request      = LoaderFactory::getLoader()->getShared(RequestInterface::class);
                             $request_qstn = $request->getRequestParam('qstn', [], 'string', true);
-                            if (! empty($request_qstn) && isset($q_meta['input_id']) && isset($q_meta['att_nmbr'])) {
+                            if ( ! empty($request_qstn) && isset($q_meta['input_id']) && isset($q_meta['att_nmbr'])) {
                                 // check for answer in $request_qstn in case we are reprocessing a form after an error
-                                if (isset($request_qstn[ $q_meta['input_id'] ][ $qstn_id ])) {
-                                    $answer = is_array($request_qstn[ $q_meta['input_id'] ][ $qstn_id ])
-                                        ? $request_qstn[ $q_meta['input_id'] ][ $qstn_id ]
-                                        : sanitize_text_field($request_qstn[ $q_meta['input_id'] ][ $qstn_id ]);
+                                if (isset($request_qstn[$q_meta['input_id']][$qstn_id])) {
+                                    $answer = is_array($request_qstn[$q_meta['input_id']][$qstn_id])
+                                        ? $request_qstn[$q_meta['input_id']][$qstn_id]
+                                        : sanitize_text_field($request_qstn[$q_meta['input_id']][$qstn_id]);
                                 }
                             } elseif (isset($q_meta['attendee']) && $q_meta['attendee']) {
                                 // attendee data from the session
                                 $answer =
-                                    isset($q_meta['attendee'][ $qstn_id ]) ? $q_meta['attendee'][ $qstn_id ] : null;
+                                    isset($q_meta['attendee'][$qstn_id]) ? $q_meta['attendee'][$qstn_id] : null;
                             }
 
 
-                            $QFI  = new EE_Question_Form_Input(
+                            $QFI = new EE_Question_Form_Input(
                                 $QST,
                                 EE_Answer::new_instance(
                                     [
@@ -729,7 +729,7 @@ 
                             $html .= self::generate_form_input($QFI);
                         }
                         $html .= $after_question_group_questions;
-                        $html .= "\n\t" . '</' . $group_wrapper . '>';
+                        $html .= "\n\t".'</'.$group_wrapper.'>';
                     }
                 }
             }
@@ -777,7 +777,7 @@ 
             $QFI->get('QST_required_text') != ''
                 ? $QFI->get('QST_required_text')
                 : esc_html__('This field is required', 'event_espresso');
-        $required_text     = $QST_required
+        $required_text = $QST_required
             ? "\n\t\t\t"
               . '<div class="required-text hidden">'
               . self::prep_answer($required_text, $use_html_entities)
@@ -923,7 +923,7 @@ 
         $use_html_entities = true
     ) {
         // need these
-        if (! $question || ! $name) {
+        if ( ! $question || ! $name) {
             return null;
         }
         // prep the answer
@@ -935,13 +935,13 @@ 
         // ya gots ta have style man!!!
         $txt_class = is_admin() ? 'regular-text' : 'espresso-text-inp';
         $class     = empty($class) ? $txt_class : $class;
-        $class     .= ! empty($system_ID) ? ' ' . $system_ID : '';
+        $class     .= ! empty($system_ID) ? ' '.$system_ID : '';
         $extra     = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
 
         $label_html =
             $required_text
             . "\n\t\t\t"
-            . '<label for="' . $name . '" class="' . $label_class . '">'
+            . '<label for="'.$name.'" class="'.$label_class.'">'
             . self::prep_question($question)
             . $required['label']
             . '</label><br/>';
@@ -950,12 +950,12 @@ 
 
         $input_html =
             "\n\t\t\t"
-            . '<input type="text" name="' . $name . '" id="' . $id . '" '
-            . 'class="' . $class . ' ' . $required['class'] . '" value="' . esc_attr($answer) . '"  '
-            . 'title="' . esc_attr($required['msg']) . '" ' . $disabled . ' ' . $extra . '/>';
+            . '<input type="text" name="'.$name.'" id="'.$id.'" '
+            . 'class="'.$class.' '.$required['class'].'" value="'.esc_attr($answer).'"  '
+            . 'title="'.esc_attr($required['msg']).'" '.$disabled.' '.$extra.'/>';
 
         $input_html = apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
-        return $label_html . $input_html;
+        return $label_html.$input_html;
     }
 
 
@@ -989,7 +989,7 @@ 
         $use_html_entities = true
     ) {
         // need these
-        if (! $question || ! $name) {
+        if ( ! $question || ! $name) {
             return null;
         }
         // prep the answer
@@ -1005,13 +1005,13 @@ 
         // ya gots ta have style man!!!
         $txt_class = is_admin() ? 'regular-text' : 'espresso-textarea-inp';
         $class     = empty($class) ? $txt_class : $class;
-        $class     .= ! empty($system_ID) ? ' ' . $system_ID : '';
+        $class     .= ! empty($system_ID) ? ' '.$system_ID : '';
         $extra     = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
 
         $label_html =
             $required_text
             . "\n\t\t\t"
-            . '<label for="' . $name . '" class="' . $label_class . '">'
+            . '<label for="'.$name.'" class="'.$label_class.'">'
             . self::prep_question($question)
             . $required['label']
             . '</label><br/>';
@@ -1020,14 +1020,14 @@ 
 
         $input_html =
             "\n\t\t\t"
-            . '<textarea name="' . $name . '" id="' . $id . '" class="' . $class . ' ' . $required['class'] . '" '
-            . 'rows="' . $dimensions['rows'] . '" cols="' . $dimensions['cols'] . '"  '
-            . 'title="' . $required['msg'] . '" ' . $disabled . ' ' . $extra . '>'
+            . '<textarea name="'.$name.'" id="'.$id.'" class="'.$class.' '.$required['class'].'" '
+            . 'rows="'.$dimensions['rows'].'" cols="'.$dimensions['cols'].'"  '
+            . 'title="'.$required['msg'].'" '.$disabled.' '.$extra.'>'
             . esc_textarea($answer)
             . '</textarea>';
 
         $input_html = apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
-        return $label_html . $input_html;
+        return $label_html.$input_html;
     }
 
 
@@ -1064,7 +1064,7 @@ 
     ) {
 
         // need these
-        if (! $question || ! $name || ! $options || empty($options) || ! is_array($options)) {
+        if ( ! $question || ! $name || ! $options || empty($options) || ! is_array($options)) {
             return null;
         }
         // prep the answer
@@ -1082,13 +1082,13 @@ 
         // ya gots ta have style man!!!
         $txt_class = is_admin() ? 'wide' : 'espresso-select-inp';
         $class     = empty($class) ? $txt_class : $class;
-        $class     .= ! empty($system_ID) ? ' ' . $system_ID : '';
+        $class     .= ! empty($system_ID) ? ' '.$system_ID : '';
         $extra     = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
 
         $label_html =
             $required_text
             . "\n\t\t\t"
-            . '<label for="' . $name . '" class="' . $label_class . '">'
+            . '<label for="'.$name.'" class="'.$label_class.'">'
             . self::prep_question($question)
             . $required['label']
             . '</label><br/>';
@@ -1097,16 +1097,16 @@ 
 
         $input_html =
             "\n\t\t\t"
-            . '<select name="' . $name . '" id="' . $id . '" class="' . $class . ' ' . $required['class'] . '" '
-            . 'title="' . esc_attr($required['msg']) . '"' . $disabled . ' ' . $extra . '>';
+            . '<select name="'.$name.'" id="'.$id.'" class="'.$class.' '.$required['class'].'" '
+            . 'title="'.esc_attr($required['msg']).'"'.$disabled.' '.$extra.'>';
         // recursively count array elements, to determine total number of options
         $only_option = count($options, 1) == 1;
-        if (! $only_option) {
+        if ( ! $only_option) {
             // if there is NO answer set and there are multiple options to choose from, then set the "please select" message as selected
-            $selected   = $answer === null ? ' selected' : '';
+            $selected = $answer === null ? ' selected' : '';
             $input_html .= $add_please_select_option
                 ? "\n\t\t\t\t"
-                  . '<option value=""' . $selected . '>'
+                  . '<option value=""'.$selected.'>'
                   . esc_html__(' - please select - ', 'event_espresso')
                   . '</option>'
                 : '';
@@ -1129,7 +1129,7 @@ 
                 );
         }
 
-        $input_html .= "\n\t\t\t" . '</select>';
+        $input_html .= "\n\t\t\t".'</select>';
 
         $input_html =
             apply_filters(
@@ -1144,7 +1144,7 @@ 
             );
 
         $input_html = apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
-        return $label_html . $input_html;
+        return $label_html.$input_html;
     }
 
 
@@ -1162,11 +1162,11 @@ 
      */
     private static function _generate_select_option_group($opt_group, $QSOs, $answer, $use_html_entities = true)
     {
-        $html = "\n\t\t\t\t" . '<optgroup label="' . self::prep_option_value($opt_group) . '">';
+        $html = "\n\t\t\t\t".'<optgroup label="'.self::prep_option_value($opt_group).'">';
         foreach ($QSOs as $QSO) {
             $html .= self::_generate_select_option($QSO->value(), $QSO->desc(), $answer, false, $use_html_entities);
         }
-        $html .= "\n\t\t\t\t" . '</optgroup>';
+        $html .= "\n\t\t\t\t".'</optgroup>';
         return $html;
     }
 
@@ -1193,7 +1193,7 @@ 
         $value    = ! empty($value) ? $value : $key;
         $selected = ($answer == $key || $only_option) ? 'selected' : '';
         return "\n\t\t\t\t"
-               . '<option value="' . self::prep_option_value($key) . '" ' . $selected . '> '
+               . '<option value="'.self::prep_option_value($key).'" '.$selected.'> '
                . $value
                . '&nbsp;&nbsp;&nbsp;</option>';
     }
@@ -1237,7 +1237,7 @@ 
         $use_desc_4_label = false
     ) {
         // need these
-        if (! $question || ! $name || ! $options || empty($options) || ! is_array($options)) {
+        if ( ! $question || ! $name || ! $options || empty($options) || ! is_array($options)) {
             return null;
         }
         // prep the answer
@@ -1254,7 +1254,7 @@ 
         $label_html =
             $required_text
             . "\n\t\t\t"
-            . '<label class="' . $label_class . '">'
+            . '<label class="'.$label_class.'">'
             . self::prep_question($question)
             . $required['label']
             . '</label> ';
@@ -1263,49 +1263,49 @@ 
 
         $input_html =
             "\n\t\t\t"
-            . '<ul id="' . $id . '-ul" class="espresso-radio-btn-options-ul ' . $label_class . ' ' . $class . '-ul">';
+            . '<ul id="'.$id.'-ul" class="espresso-radio-btn-options-ul '.$label_class.' '.$class.'-ul">';
 
-        $class .= ! empty($system_ID) ? ' ' . $system_ID : '';
-        $class .= ! empty($required['class']) ? ' ' . $required['class'] : '';
+        $class .= ! empty($system_ID) ? ' '.$system_ID : '';
+        $class .= ! empty($required['class']) ? ' '.$required['class'] : '';
 
         foreach ($options as $OPT) {
             if ($OPT instanceof EE_Question_Option) {
                 $value   = self::prep_option_value($OPT->value());
                 $label   = $use_desc_4_label ? $OPT->desc() : $OPT->value();
                 $size    = $use_desc_4_label
-                    ? self::get_label_size_class($OPT->value() . ' ' . $OPT->desc())
+                    ? self::get_label_size_class($OPT->value().' '.$OPT->desc())
                     : self::get_label_size_class($OPT->value());
-                $desc    = $OPT->desc();// no self::prep_answer
+                $desc    = $OPT->desc(); // no self::prep_answer
                 $answer  = is_numeric($value) && empty($answer) ? 0 : $answer;
                 $checked = (string) $value == (string) $answer ? ' checked' : '';
-                $opt     = '-' . sanitize_key($value);
+                $opt     = '-'.sanitize_key($value);
 
-                $input_html .= "\n\t\t\t\t" . '<li' . $size . '>';
-                $input_html .= "\n\t\t\t\t\t" . '<label class="' . $radio_class . ' espresso-radio-btn-lbl">';
-                $input_html .= $label_b4 ? "\n\t\t\t\t\t\t" . '<span>' . $label . '</span>' : '';
+                $input_html .= "\n\t\t\t\t".'<li'.$size.'>';
+                $input_html .= "\n\t\t\t\t\t".'<label class="'.$radio_class.' espresso-radio-btn-lbl">';
+                $input_html .= $label_b4 ? "\n\t\t\t\t\t\t".'<span>'.$label.'</span>' : '';
                 $input_html .= "\n\t\t\t\t\t\t"
-                               . '<input type="radio" name="' . $name . '" id="' . $id . $opt . '" '
-                               . 'class="' . $class . '" value="' . $value . '" '
-                               . 'title="' . esc_attr($required['msg']) . '" ' . $disabled
-                               . $checked . ' ' . $extra . '/>';
+                               . '<input type="radio" name="'.$name.'" id="'.$id.$opt.'" '
+                               . 'class="'.$class.'" value="'.$value.'" '
+                               . 'title="'.esc_attr($required['msg']).'" '.$disabled
+                               . $checked.' '.$extra.'/>';
                 $input_html .= ! $label_b4
                     ? "\n\t\t\t\t\t\t"
                       . '<span class="espresso-radio-btn-desc">'
                       . $label
                       . '</span>'
                     : '';
-                $input_html .= "\n\t\t\t\t\t" . '</label>';
+                $input_html .= "\n\t\t\t\t\t".'</label>';
                 $input_html .= $use_desc_4_label
                     ? ''
-                    : '<span class="espresso-radio-btn-option-desc small-text grey-text">' . $desc . '</span>';
-                $input_html .= "\n\t\t\t\t" . '</li>';
+                    : '<span class="espresso-radio-btn-option-desc small-text grey-text">'.$desc.'</span>';
+                $input_html .= "\n\t\t\t\t".'</li>';
             }
         }
 
-        $input_html .= "\n\t\t\t" . '</ul>';
+        $input_html .= "\n\t\t\t".'</ul>';
 
         $input_html = apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
-        return $label_html . $input_html;
+        return $label_html.$input_html;
     }
 
 
@@ -1340,7 +1340,7 @@ 
         $use_html_entities = true
     ) {
         // need these
-        if (! $question || ! $name || ! $options || empty($options) || ! is_array($options)) {
+        if ( ! $question || ! $name || ! $options || empty($options) || ! is_array($options)) {
             return null;
         }
         $answer = maybe_unserialize($answer);
@@ -1350,7 +1350,7 @@ 
 
         foreach ($answer as $key => $value) {
             $key            = self::prep_option_value($key);
-            $answer[ $key ] = self::prep_answer($value, $use_html_entities);
+            $answer[$key] = self::prep_answer($value, $use_html_entities);
         }
 
         // prep the required array
@@ -1365,7 +1365,7 @@ 
         $label_html =
             $required_text
             . "\n\t\t\t"
-            . '<label class="' . $label_class . '">'
+            . '<label class="'.$label_class.'">'
             . self::prep_question($question)
             . $required['label']
             . '</label> ';
@@ -1374,42 +1374,42 @@ 
 
         $input_html =
             "\n\t\t\t"
-            . '<ul id="' . $id . '-ul" class="espresso-checkbox-options-ul ' . $label_class . ' ' . $class . '-ul">';
+            . '<ul id="'.$id.'-ul" class="espresso-checkbox-options-ul '.$label_class.' '.$class.'-ul">';
 
-        $class .= ! empty($system_ID) ? ' ' . $system_ID : '';
-        $class .= ! empty($required['class']) ? ' ' . $required['class'] : '';
+        $class .= ! empty($system_ID) ? ' '.$system_ID : '';
+        $class .= ! empty($required['class']) ? ' '.$required['class'] : '';
 
         foreach ($options as $OPT) {
-            $value = $OPT->value();// self::prep_option_value( $OPT->value() );
-            $size  = self::get_label_size_class($OPT->value() . ' ' . $OPT->desc());
+            $value = $OPT->value(); // self::prep_option_value( $OPT->value() );
+            $size  = self::get_label_size_class($OPT->value().' '.$OPT->desc());
             $text  = self::prep_answer($OPT->value());
             $desc  = $OPT->desc();
-            $opt   = '-' . sanitize_key($value);
+            $opt   = '-'.sanitize_key($value);
 
             $checked = is_array($answer) && in_array($text, $answer) ? ' checked' : '';
 
-            $input_html .= "\n\t\t\t\t" . '<li' . $size . '>';
-            $input_html .= "\n\t\t\t\t\t" . '<label class="' . $radio_class . ' espresso-checkbox-lbl">';
-            $input_html .= $label_b4 ? "\n\t\t\t\t\t\t" . '<span>' . $text . '</span>' : '';
+            $input_html .= "\n\t\t\t\t".'<li'.$size.'>';
+            $input_html .= "\n\t\t\t\t\t".'<label class="'.$radio_class.' espresso-checkbox-lbl">';
+            $input_html .= $label_b4 ? "\n\t\t\t\t\t\t".'<span>'.$text.'</span>' : '';
             $input_html .= "\n\t\t\t\t\t\t"
-                           . '<input type="checkbox" name="' . $name . '[' . $OPT->ID() . ']" '
-                           . 'id="' . $id . $opt . '" class="' . $class . '" value="' . $value . '" '
-                           . 'title="' . esc_attr($required['msg']) . '" ' . $disabled . $checked . ' ' . $extra . '/>';
-            $input_html .= ! $label_b4 ? "\n\t\t\t\t\t\t" . '<span>' . $text . '</span>' : '';
-            $input_html .= "\n\t\t\t\t\t" . '</label>';
-            if (! empty($desc) && $desc != $text) {
+                           . '<input type="checkbox" name="'.$name.'['.$OPT->ID().']" '
+                           . 'id="'.$id.$opt.'" class="'.$class.'" value="'.$value.'" '
+                           . 'title="'.esc_attr($required['msg']).'" '.$disabled.$checked.' '.$extra.'/>';
+            $input_html .= ! $label_b4 ? "\n\t\t\t\t\t\t".'<span>'.$text.'</span>' : '';
+            $input_html .= "\n\t\t\t\t\t".'</label>';
+            if ( ! empty($desc) && $desc != $text) {
                 $input_html .= "\n\t\t\t\t\t"
                                . ' &nbsp; <br/><div class="espresso-checkbox-option-desc small-text grey-text">'
                                . $desc
                                . '</div>';
             }
-            $input_html .= "\n\t\t\t\t" . '</li>';
+            $input_html .= "\n\t\t\t\t".'</li>';
         }
 
-        $input_html .= "\n\t\t\t" . '</ul>';
+        $input_html .= "\n\t\t\t".'</ul>';
 
         $input_html = apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
-        return $label_html . $input_html;
+        return $label_html.$input_html;
     }
 
 
@@ -1441,7 +1441,7 @@ 
         $use_html_entities = true
     ) {
         // need these
-        if (! $question || ! $name) {
+        if ( ! $question || ! $name) {
             return null;
         }
         // prep the answer
@@ -1453,13 +1453,13 @@ 
         // ya gots ta have style man!!!
         $txt_class = is_admin() ? 'regular-text' : 'espresso-datepicker-inp';
         $class     = empty($class) ? $txt_class : $class;
-        $class     .= ! empty($system_ID) ? ' ' . $system_ID : '';
+        $class     .= ! empty($system_ID) ? ' '.$system_ID : '';
         $extra     = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
 
         $label_html =
             $required_text
             . "\n\t\t\t"
-            . '<label for="' . $name . '" class="' . $label_class . '">'
+            . '<label for="'.$name.'" class="'.$label_class.'">'
             . self::prep_question($question)
             . $required['label']
             . '</label><br/>';
@@ -1468,14 +1468,14 @@ 
 
         $input_html =
             "\n\t\t\t"
-            . '<input type="text" name="' . $name . '" id="' . $id . '" '
-            . 'class="' . $class . ' ' . $required['class'] . ' datepicker" value="' . $answer . '"  '
-            . 'title="' . esc_attr($required['msg']) . '" ' . $disabled . ' ' . $extra . '/>';
+            . '<input type="text" name="'.$name.'" id="'.$id.'" '
+            . 'class="'.$class.' '.$required['class'].' datepicker" value="'.$answer.'"  '
+            . 'title="'.esc_attr($required['msg']).'" '.$disabled.' '.$extra.'/>';
 
         // enqueue scripts
         wp_register_style(
             'espresso-ui-theme',
-            EE_GLOBAL_ASSETS_URL . 'css/espresso-ui-theme/jquery-ui-1.10.3.custom.min.css',
+            EE_GLOBAL_ASSETS_URL.'css/espresso-ui-theme/jquery-ui-1.10.3.custom.min.css',
             [],
             EVENT_ESPRESSO_VERSION
         );
@@ -1483,7 +1483,7 @@ 
         wp_enqueue_script('jquery-ui-datepicker');
 
         $input_html = apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
-        return $label_html . $input_html;
+        return $label_html.$input_html;
     }
 
 
@@ -1510,7 +1510,7 @@ 
     public static function hidden_input($name, $value, $id = '')
     {
         $id = ! empty($id) ? $id : $name;
-        return '<input id="' . $id . '" type="hidden" name="' . $name . '" value="' . $value . '"/>';
+        return '<input id="'.$id.'" type="hidden" name="'.$name.'" value="'.$value.'"/>';
     }
 
 
@@ -1555,7 +1555,7 @@ 
         $prepped_answer_options = [];
         if (is_array($QSOs) && ! empty($QSOs)) {
             foreach ($QSOs as $key => $QSO) {
-                if (! $QSO instanceof EE_Question_Option) {
+                if ( ! $QSO instanceof EE_Question_Option) {
                     $QSO = EE_Question_Option::new_instance(
                         [
                             'QSO_value' => is_array($QSO) && isset($QSO['id'])
@@ -1568,7 +1568,7 @@ 
                     );
                 }
                 if ($QSO->opt_group()) {
-                    $prepped_answer_options[ $QSO->opt_group() ][] = $QSO;
+                    $prepped_answer_options[$QSO->opt_group()][] = $QSO;
                 } else {
                     $prepped_answer_options[] = $QSO;
                 }
@@ -1780,7 +1780,7 @@ 
         $options = [];
         for ($x = 1; $x <= 12; $x++) {
             $mm             = str_pad($x, 2, '0', STR_PAD_LEFT);
-            $options[ $mm ] = $mm;
+            $options[$mm] = $mm;
         }
         return EEH_Form_Fields::prep_answer_options($options);
     }
@@ -1798,7 +1798,7 @@ 
         $next_decade  = $current_year + 10;
         for ($x = $current_year; $x <= $next_decade; $x++) {
             $yy             = str_pad($x, 2, '0', STR_PAD_LEFT);
-            $options[ $yy ] = $yy;
+            $options[$yy] = $yy;
         }
         return EEH_Form_Fields::prep_answer_options($options);
     }
@@ -1817,7 +1817,7 @@ 
     public static function generate_registration_months_dropdown($cur_date = '', $status = '', $evt_category = 0)
     {
         $_where = [];
-        if (! empty($status)) {
+        if ( ! empty($status)) {
             $_where['STS_ID'] = $status;
         }
 
@@ -1836,7 +1836,7 @@ 
         ];
 
         foreach ($regdtts as $regdtt) {
-            $date      = $regdtt->reg_month . ' ' . $regdtt->reg_year;
+            $date      = $regdtt->reg_month.' '.$regdtt->reg_year;
             $options[] = [
                 'text' => $date,
                 'id'   => $date,
@@ -1885,7 +1885,7 @@ 
         // categories?
 
 
-        if (! empty($evt_category)) {
+        if ( ! empty($evt_category)) {
             $where['Event.Term_Taxonomy.taxonomy'] = 'espresso_event_categories';
             $where['Event.Term_Taxonomy.term_id']  = $evt_category;
         }
@@ -1908,8 +1908,8 @@ 
         global $wp_locale;
 
         foreach ($DTTS as $DTT) {
-            $localized_date = $wp_locale->get_month($DTT->dtt_month_num) . ' ' . $DTT->dtt_year;
-            $id             = $DTT->dtt_month . ' ' . $DTT->dtt_year;
+            $localized_date = $wp_locale->get_month($DTT->dtt_month_num).' '.$DTT->dtt_year;
+            $id             = $DTT->dtt_month.' '.$DTT->dtt_year;
             $options[]      = [
                 'text' => $localized_date,
                 'id'   => $id,
@@ -1982,16 +1982,16 @@ 
             return $btn;
         }
         $text = ! empty($text) ? $text : esc_html__('Submit', 'event_espresso');
-        $btn  .= '<input id="' . $ID . '-btn" class="' . $class . '" '
-                 . 'type="submit" value="' . $text . '" ' . $extra_attributes . '/>';
-        if (! $input_only) {
-            $btn_frm = '<form id="' . $ID . '-frm" method="POST" action="' . $url . '">';
+        $btn .= '<input id="'.$ID.'-btn" class="'.$class.'" '
+                 . 'type="submit" value="'.$text.'" '.$extra_attributes.'/>';
+        if ( ! $input_only) {
+            $btn_frm = '<form id="'.$ID.'-frm" method="POST" action="'.$url.'">';
             $btn_frm .= ! empty($nonce_action)
-                ? wp_nonce_field($nonce_action, $nonce_action . '_nonce', true, false)
+                ? wp_nonce_field($nonce_action, $nonce_action.'_nonce', true, false)
                 : '';
             $btn_frm .= $btn;
             $btn_frm .= '</form>';
-            $btn     = $btn_frm;
+            $btn = $btn_frm;
             unset($btn_frm);
         }
         return $btn;

core/libraries/plugin_api/EE_Register_Addon.lib.php

Indentation +1260 added lines, -1260 removed lines

@@ -22,1264 +22,1264 @@
  */
 class EE_Register_Addon implements EEI_Plugin_API
 {
-    /**
-     * 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();
-
-    /**
-     * @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);
-    }
-
-
-    /**
-     * 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 InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function register($addon_name = '', array $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 ?
-        // 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(
-                esc_html__(
-                    '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(
-                    esc_html__(
-                        '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(
-                    esc_html__(
-                        '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 $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(
-                esc_html__(
-                    '%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(
-                esc_html__(
-                    '%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(
-                esc_html__(
-                    '%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
-            /** @var RequestInterface $request */
-            $request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-            $request->unSetRequestParam('activate', true);
-            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__);
-            }
-            unset($_GET['activate'], $_REQUEST['activate']);
-            if (! function_exists('deactivate_plugins')) {
-                require_once ABSPATH . 'wp-admin/includes/plugin.php';
-            }
-            deactivate_plugins(plugin_basename($addon_settings['main_file_path']));
-            // 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')
-            );
-        }
-    }
-
-
-    /**
-     * 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 InvalidArgumentException
-     * @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(
-                    esc_html__(
-                        '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);
-            }
-        }
-    }
-
-
-    /**
-     * 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_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_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_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
-     */
-    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 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
-     */
-    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 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
-     */
-    private static function _load_and_init_addon_class($addon_name)
-    {
-        $addon = LoaderFactory::getLoader()->getShared(
-            self::$_settings[ $addon_name ]['class_name'],
-            array('EE_Registry::create(addon)' => true)
-        );
-        if (! $addon instanceof EE_Addon) {
-            throw new DomainException(
-                sprintf(
-                    esc_html__(
-                        'Failed to instantiate the %1$s class. PLease check that the class exists.',
-                        'event_espresso'
-                    ),
-                    $addon_name
-                )
-            );
-        }
-        // setter inject dep map if required
-        if ($addon->dependencyMap() === null) {
-            $addon->setDependencyMap(LoaderFactory::getLoader()->getShared('EE_Dependency_Map'));
-        }
-        // setter inject domain if required
-        EE_Register_Addon::injectAddonDomain($addon_name, $addon);
-
-        $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']);
-        // setup the add-on's pue_slug if we have one.
-        if (! empty(self::$_settings[ $addon_name ]['pue_options']['pue_plugin_slug'])) {
-            $addon->setPueSlug(self::$_settings[ $addon_name ]['pue_options']['pue_plugin_slug']);
-        }
-        // unfortunately this can't be hooked in upon construction,
-        // because we don't have the plugin's mainfile 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;
-    }
-
-
-    /**
-     * @param string   $addon_name
-     * @param EE_Addon $addon
-     * @since   4.10.13.p
-     */
-    private static function injectAddonDomain($addon_name, EE_Addon $addon)
-    {
-        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 = LoaderFactory::getLoader()->getShared(
-                    self::$_settings[ $addon_name ]['domain_fqcn'],
-                    [
-                        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);
-            }
-        }
-    }
-
-
-    /**
-     *    load_pue_update - Update notifications
-     *
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function load_pue_update()
-    {
-        // PUE client existence
-        if (! is_readable(EE_THIRD_PARTY . 'pue/pue-client.php')) {
-            return;
-        }
-        // 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'])) {
-                continue;
-            }
-            // 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 $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.
-     *
-     * @param string $addon_name the name for the addon that was previously registered
-     * @throws DomainException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     *@since    4.3.0
-     */
-    public static function deregister($addon_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'])) {
-                    // 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);
-                LoaderFactory::getLoader()->remove($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);
-        }
-    }
+	/**
+	 * 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();
+
+	/**
+	 * @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);
+	}
+
+
+	/**
+	 * 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 InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function register($addon_name = '', array $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 ?
+		// 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(
+				esc_html__(
+					'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(
+					esc_html__(
+						'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(
+					esc_html__(
+						'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 $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(
+				esc_html__(
+					'%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(
+				esc_html__(
+					'%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(
+				esc_html__(
+					'%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
+			/** @var RequestInterface $request */
+			$request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
+			$request->unSetRequestParam('activate', true);
+			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__);
+			}
+			unset($_GET['activate'], $_REQUEST['activate']);
+			if (! function_exists('deactivate_plugins')) {
+				require_once ABSPATH . 'wp-admin/includes/plugin.php';
+			}
+			deactivate_plugins(plugin_basename($addon_settings['main_file_path']));
+			// 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')
+			);
+		}
+	}
+
+
+	/**
+	 * 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 InvalidArgumentException
+	 * @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(
+					esc_html__(
+						'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);
+			}
+		}
+	}
+
+
+	/**
+	 * 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_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_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_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
+	 */
+	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 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
+	 */
+	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 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
+	 */
+	private static function _load_and_init_addon_class($addon_name)
+	{
+		$addon = LoaderFactory::getLoader()->getShared(
+			self::$_settings[ $addon_name ]['class_name'],
+			array('EE_Registry::create(addon)' => true)
+		);
+		if (! $addon instanceof EE_Addon) {
+			throw new DomainException(
+				sprintf(
+					esc_html__(
+						'Failed to instantiate the %1$s class. PLease check that the class exists.',
+						'event_espresso'
+					),
+					$addon_name
+				)
+			);
+		}
+		// setter inject dep map if required
+		if ($addon->dependencyMap() === null) {
+			$addon->setDependencyMap(LoaderFactory::getLoader()->getShared('EE_Dependency_Map'));
+		}
+		// setter inject domain if required
+		EE_Register_Addon::injectAddonDomain($addon_name, $addon);
+
+		$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']);
+		// setup the add-on's pue_slug if we have one.
+		if (! empty(self::$_settings[ $addon_name ]['pue_options']['pue_plugin_slug'])) {
+			$addon->setPueSlug(self::$_settings[ $addon_name ]['pue_options']['pue_plugin_slug']);
+		}
+		// unfortunately this can't be hooked in upon construction,
+		// because we don't have the plugin's mainfile 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;
+	}
+
+
+	/**
+	 * @param string   $addon_name
+	 * @param EE_Addon $addon
+	 * @since   4.10.13.p
+	 */
+	private static function injectAddonDomain($addon_name, EE_Addon $addon)
+	{
+		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 = LoaderFactory::getLoader()->getShared(
+					self::$_settings[ $addon_name ]['domain_fqcn'],
+					[
+						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);
+			}
+		}
+	}
+
+
+	/**
+	 *    load_pue_update - Update notifications
+	 *
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function load_pue_update()
+	{
+		// PUE client existence
+		if (! is_readable(EE_THIRD_PARTY . 'pue/pue-client.php')) {
+			return;
+		}
+		// 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'])) {
+				continue;
+			}
+			// 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 $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.
+	 *
+	 * @param string $addon_name the name for the addon that was previously registered
+	 * @throws DomainException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 *@since    4.3.0
+	 */
+	public static function deregister($addon_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'])) {
+					// 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);
+				LoaderFactory::getLoader()->remove($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 +118 added lines, -118 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 @@ 
         EE_Register_Addon::_parse_pue_options($addon_name, $class_name, $setup_args);
         // does this addon work with this version of core or WordPress ?
         // 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(
                     esc_html__(
@@ -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(
                     esc_html__(
@@ -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;
     }
 
 
@@ -538,9 +538,9 @@ 
         $incompatibility_message = '';
         // check whether this addon version is compatible with EE core
         if (
-            isset(EE_Register_Addon::$_incompatible_addons[ $addon_name ])
+            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']
             )
         ) {
@@ -551,7 +551,7 @@ 
                 ),
                 $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 />'
             );
@@ -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
             /** @var RequestInterface $request */
@@ -594,8 +594,8 @@ 
                 EE_Error::add_error($incompatibility_message, __FILE__, __FUNCTION__, __LINE__);
             }
             unset($_GET['activate'], $_REQUEST['activate']);
-            if (! function_exists('deactivate_plugins')) {
-                require_once ABSPATH . 'wp-admin/includes/plugin.php';
+            if ( ! function_exists('deactivate_plugins')) {
+                require_once ABSPATH.'wp-admin/includes/plugin.php';
             }
             deactivate_plugins(plugin_basename($addon_settings['main_file_path']));
             // BAIL FROM THE ADDON REGISTRATION PROCESS
@@ -618,11 +618,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']),
@@ -681,12 +681,12 @@ 
             // 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'])
+                ! 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.
@@ -712,10 +712,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;
     }
@@ -728,13 +728,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);
             }
         }
@@ -752,27 +752,27 @@ 
     {
         // register new models
         if (
-            ! empty(self::$_settings[ $addon_name ]['model_paths'])
-            || ! empty(self::$_settings[ $addon_name ]['class_paths'])
+            ! 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'])
+            ! 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'],
                 )
             );
         }
@@ -787,10 +787,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'])
             );
         }
     }
@@ -804,12 +804,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'],
                 )
             );
         }
@@ -823,10 +823,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'])
             );
         }
     }
@@ -839,10 +839,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'])
             );
         }
     }
@@ -856,16 +856,16 @@ 
     private static function _register_shortcodes($addon_name)
     {
         if (
-            ! empty(self::$_settings[ $addon_name ]['shortcode_paths'])
-            || ! empty(self::$_settings[ $addon_name ]['shortcode_fqcns'])
+            ! 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(),
+                    '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(),
                 )
             );
         }
@@ -879,10 +879,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'])
             );
         }
     }
@@ -895,12 +895,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'],
                 )
             );
         }
@@ -913,7 +913,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')
@@ -930,15 +930,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'])
+            ! 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'],
                 )
             );
         }
@@ -956,10 +956,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'])
             );
         }
     }
@@ -975,10 +975,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']
             );
         }
     }
@@ -990,10 +990,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']
             );
         }
     }
@@ -1005,10 +1005,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']
             );
         }
     }
@@ -1026,10 +1026,10 @@ 
     private static function _load_and_init_addon_class($addon_name)
     {
         $addon = LoaderFactory::getLoader()->getShared(
-            self::$_settings[ $addon_name ]['class_name'],
+            self::$_settings[$addon_name]['class_name'],
             array('EE_Registry::create(addon)' => true)
         );
-        if (! $addon instanceof EE_Addon) {
+        if ( ! $addon instanceof EE_Addon) {
             throw new DomainException(
                 sprintf(
                     esc_html__(
@@ -1048,28 +1048,28 @@ 
         EE_Register_Addon::injectAddonDomain($addon_name, $addon);
 
         $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']);
         // setup the add-on's pue_slug if we have one.
-        if (! empty(self::$_settings[ $addon_name ]['pue_options']['pue_plugin_slug'])) {
-            $addon->setPueSlug(self::$_settings[ $addon_name ]['pue_options']['pue_plugin_slug']);
+        if ( ! empty(self::$_settings[$addon_name]['pue_options']['pue_plugin_slug'])) {
+            $addon->setPueSlug(self::$_settings[$addon_name]['pue_options']['pue_plugin_slug']);
         }
         // unfortunately this can't be hooked in upon construction,
         // because we don't have the plugin's mainfile 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;
@@ -1085,19 +1085,19 @@ 
     {
         if ($addon instanceof RequiresDomainInterface && $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 = LoaderFactory::getLoader()->getShared(
-                    self::$_settings[ $addon_name ]['domain_fqcn'],
+                    self::$_settings[$addon_name]['domain_fqcn'],
                     [
                         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']
                         ),
                     ]
                 );
@@ -1120,11 +1120,11 @@ 
     public static function load_pue_update()
     {
         // PUE client existence
-        if (! is_readable(EE_THIRD_PARTY . 'pue/pue-client.php')) {
+        if ( ! is_readable(EE_THIRD_PARTY.'pue/pue-client.php')) {
             return;
         }
         // 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) {
@@ -1138,7 +1138,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(
@@ -1166,7 +1166,7 @@ 
     public static function register_message_types()
     {
         foreach (self::$_settings as $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);
                 }
@@ -1187,74 +1187,74 @@ 
      */
     public static function deregister($addon_name = '')
     {
-        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'])
+                    ! 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'])
+                    ! 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'])
+                    ! 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'])
+                    ! 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(
@@ -1278,7 +1278,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/admin/EE_Admin_Page.core.php

Indentation +4104 added lines, -4104 removed lines

@@ -18,4180 +18,4180 @@
  */
 abstract class EE_Admin_Page extends EE_Base implements InterminableInterface
 {
-    /**
-     * @var LoaderInterface
-     */
-    protected $loader;
+	/**
+	 * @var LoaderInterface
+	 */
+	protected $loader;
 
-    /**
-     * @var RequestInterface
-     */
-    protected $request;
+	/**
+	 * @var RequestInterface
+	 */
+	protected $request;
 
-    // set in _init_page_props()
-    public $page_slug;
+	// set in _init_page_props()
+	public $page_slug;
 
-    public $page_label;
+	public $page_label;
 
-    public $page_folder;
+	public $page_folder;
 
-    // set in define_page_props()
-    protected $_admin_base_url;
+	// set in define_page_props()
+	protected $_admin_base_url;
 
-    protected $_admin_base_path;
+	protected $_admin_base_path;
 
-    protected $_admin_page_title;
+	protected $_admin_page_title;
 
-    protected $_labels;
+	protected $_labels;
 
 
-    // set early within EE_Admin_Init
-    protected $_wp_page_slug;
+	// set early within EE_Admin_Init
+	protected $_wp_page_slug;
 
-    // navtabs
-    protected $_nav_tabs;
+	// navtabs
+	protected $_nav_tabs;
 
-    protected $_default_nav_tab_name;
+	protected $_default_nav_tab_name;
 
 
-    // template variables (used by templates)
-    protected $_template_path;
+	// template variables (used by templates)
+	protected $_template_path;
 
-    protected $_column_template_path;
+	protected $_column_template_path;
 
-    /**
-     * @var array $_template_args
-     */
-    protected $_template_args = [];
+	/**
+	 * @var array $_template_args
+	 */
+	protected $_template_args = [];
 
-    /**
-     * this will hold the list table object for a given view.
-     *
-     * @var EE_Admin_List_Table $_list_table_object
-     */
-    protected $_list_table_object;
+	/**
+	 * this will hold the list table object for a given view.
+	 *
+	 * @var EE_Admin_List_Table $_list_table_object
+	 */
+	protected $_list_table_object;
 
-    // bools
-    protected $_is_UI_request = null; // this starts at null so we can have no header routes progress through two states.
+	// bools
+	protected $_is_UI_request = null; // this starts at null so we can have no header routes progress through two states.
 
-    protected $_routing;
+	protected $_routing;
 
-    // list table args
-    protected $_view;
+	// list table args
+	protected $_view;
 
-    protected $_views;
+	protected $_views;
 
 
-    // action => method pairs used for routing incoming requests
-    protected $_page_routes;
+	// action => method pairs used for routing incoming requests
+	protected $_page_routes;
 
-    /**
-     * @var array $_page_config
-     */
-    protected $_page_config;
+	/**
+	 * @var array $_page_config
+	 */
+	protected $_page_config;
 
-    /**
-     * the current page route and route config
-     *
-     * @var string $_route
-     */
-    protected $_route;
+	/**
+	 * the current page route and route config
+	 *
+	 * @var string $_route
+	 */
+	protected $_route;
 
-    /**
-     * @var string $_cpt_route
-     */
-    protected $_cpt_route;
+	/**
+	 * @var string $_cpt_route
+	 */
+	protected $_cpt_route;
 
-    /**
-     * @var array $_route_config
-     */
-    protected $_route_config;
+	/**
+	 * @var array $_route_config
+	 */
+	protected $_route_config;
 
-    /**
-     * Used to hold default query args for list table routes to help preserve stickiness of filters for carried out
-     * actions.
-     *
-     * @since 4.6.x
-     * @var array.
-     */
-    protected $_default_route_query_args;
-
-    // set via request page and action args.
-    protected $_current_page;
-
-    protected $_current_view;
-
-    protected $_current_page_view_url;
-
-    /**
-     * unprocessed value for the 'action' request param (default '')
-     *
-     * @var string
-     */
-    protected $raw_req_action = '';
-
-    /**
-     * unprocessed value for the 'page' request param (default '')
-     *
-     * @var string
-     */
-    protected $raw_req_page = '';
-
-    /**
-     * sanitized request action (and nonce)
-     *
-     * @var string
-     */
-    protected $_req_action = '';
-
-    /**
-     * sanitized request action nonce
-     *
-     * @var string
-     */
-    protected $_req_nonce = '';
-
-    /**
-     * @var string
-     */
-    protected $_search_btn_label = '';
-
-    /**
-     * @var string
-     */
-    protected $_search_box_callback = '';
-
-    /**
-     * @var WP_Screen
-     */
-    protected $_current_screen;
-
-    // for holding EE_Admin_Hooks object when needed (set via set_hook_object())
-    protected $_hook_obj;
-
-    // for holding incoming request data
-    protected $_req_data = [];
-
-    // yes / no array for admin form fields
-    protected $_yes_no_values = [];
-
-    // some default things shared by all child classes
-    protected $_default_espresso_metaboxes;
-
-    /**
-     * @var EE_Registry
-     */
-    protected $EE = null;
-
-
-    /**
-     * This is just a property that flags whether the given route is a caffeinated route or not.
-     *
-     * @var boolean
-     */
-    protected $_is_caf = false;
-
-
-    /**
-     * @Constructor
-     * @param bool $routing indicate whether we want to just load the object and handle routing or just load the object.
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function __construct($routing = true)
-    {
-        $this->loader  = LoaderFactory::getLoader();
-        $this->request = $this->loader->getShared(RequestInterface::class);
-        $this->_routing = $routing;
-
-        if (strpos($this->_get_dir(), 'caffeinated') !== false) {
-            $this->_is_caf = true;
-        }
-        $this->_yes_no_values = [
-            ['id' => true, 'text' => esc_html__('Yes', 'event_espresso')],
-            ['id' => false, 'text' => esc_html__('No', 'event_espresso')],
-        ];
-        // set the _req_data property.
-        $this->_req_data = $this->request->requestParams();
-        // set initial page props (child method)
-        $this->_init_page_props();
-        // set global defaults
-        $this->_set_defaults();
-        // set early because incoming requests could be ajax related and we need to register those hooks.
-        $this->_global_ajax_hooks();
-        $this->_ajax_hooks();
-        // other_page_hooks have to be early too.
-        $this->_do_other_page_hooks();
-        // set up page dependencies
-        $this->_before_page_setup();
-        $this->_page_setup();
-        // die();
-    }
-
-
-    /**
-     * _init_page_props
-     * Child classes use to set at least the following properties:
-     * $page_slug.
-     * $page_label.
-     *
-     * @abstract
-     * @return void
-     */
-    abstract protected function _init_page_props();
-
-
-    /**
-     * _ajax_hooks
-     * child classes put all their add_action('wp_ajax_{name_of_hook}') hooks in here.
-     * Note: within the ajax callback methods.
-     *
-     * @abstract
-     * @return void
-     */
-    abstract protected function _ajax_hooks();
-
-
-    /**
-     * _define_page_props
-     * child classes define page properties in here.  Must include at least:
-     * $_admin_base_url = base_url for all admin pages
-     * $_admin_page_title = default admin_page_title for admin pages
-     * $_labels = array of default labels for various automatically generated elements:
-     *    array(
-     *        'buttons' => array(
-     *            'add' => esc_html__('label for add new button'),
-     *            'edit' => esc_html__('label for edit button'),
-     *            'delete' => esc_html__('label for delete button')
-     *            )
-     *        )
-     *
-     * @abstract
-     * @return void
-     */
-    abstract protected function _define_page_props();
-
-
-    /**
-     * _set_page_routes
-     * child classes use this to define the page routes for all subpages handled by the class.  Page routes are
-     * assigned to a action => method pairs in an array and to the $_page_routes property.  Each page route must also
-     * have a 'default' route. Here's the format
-     * $this->_page_routes = array(
-     *        'default' => array(
-     *            'func' => '_default_method_handling_route',
-     *            'args' => array('array','of','args'),
-     *            'noheader' => true, //add this in if this page route is processed before any headers are loaded (i.e.
-     *            ajax request, backend processing)
-     *            'headers_sent_route'=>'headers_route_reference', //add this if noheader=>true, and you want to load a
-     *            headers route after.  The string you enter here should match the defined route reference for a
-     *            headers sent route.
-     *            'capability' => 'route_capability', //indicate a string for minimum capability required to access
-     *            this route.
-     *            'obj_id' => 10 // if this route has an object id, then this can include it (used for capability
-     *            checks).
-     *        ),
-     *        'insert_item' => '_method_for_handling_insert_item' //this can be used if all we need to have is a
-     *        handling method.
-     *        )
-     * )
-     *
-     * @abstract
-     * @return void
-     */
-    abstract protected function _set_page_routes();
-
-
-    /**
-     * _set_page_config
-     * child classes use this to define the _page_config array for all subpages handled by the class. Each key in the
-     * array corresponds to the page_route for the loaded page. Format:
-     * $this->_page_config = array(
-     *        'default' => array(
-     *            'labels' => array(
-     *                'buttons' => array(
-     *                    'add' => esc_html__('label for adding item'),
-     *                    'edit' => esc_html__('label for editing item'),
-     *                    'delete' => esc_html__('label for deleting item')
-     *                ),
-     *                'publishbox' => esc_html__('Localized Title for Publish metabox', 'event_espresso')
-     *            ), //optional an array of custom labels for various automatically generated elements to use on the
-     *            page. If this isn't present then the defaults will be used as set for the $this->_labels in
-     *            _define_page_props() method
-     *            'nav' => array(
-     *                'label' => esc_html__('Label for Tab', 'event_espresso').
-     *                'url' => 'http://someurl', //automatically generated UNLESS you define
-     *                'css_class' => 'css-class', //automatically generated UNLESS you define
-     *                'order' => 10, //required to indicate tab position.
-     *                'persistent' => false //if you want the nav tab to ONLY display when the specific route is
-     *                displayed then add this parameter.
-     *            'list_table' => 'name_of_list_table' //string for list table class to be loaded for this admin_page.
-     *            'metaboxes' => array('metabox1', 'metabox2'), //if present this key indicates we want to load
-     *            metaboxes set for eventespresso admin pages.
-     *            'has_metaboxes' => true, //this boolean flag can simply be used to indicate if the route will have
-     *            metaboxes.  Typically this is used if the 'metaboxes' index is not used because metaboxes are added
-     *            later.  We just use this flag to make sure the necessary js gets enqueued on page load.
-     *            'has_help_popups' => false //defaults(true) //this boolean flag can simply be used to indicate if the
-     *            given route has help popups setup and if it does then we need to make sure thickbox is enqueued.
-     *            'columns' => array(4, 2), //this key triggers the setup of a page that uses columns (metaboxes).  The
-     *            array indicates the max number of columns (4) and the default number of columns on page load (2).
-     *            There is an option in the "screen_options" dropdown that is setup so users can pick what columns they
-     *            want to display.
-     *            'help_tabs' => array( //this is used for adding help tabs to a page
-     *                'tab_id' => array(
-     *                    'title' => 'tab_title',
-     *                    'filename' => 'name_of_file_containing_content', //this is the primary method for setting
-     *                    help tab content.  The fallback if it isn't present is to try a the callback.  Filename
-     *                    should match a file in the admin folder's "help_tabs" dir (ie..
-     *                    events/help_tabs/name_of_file_containing_content.help_tab.php)
-     *                    'callback' => 'callback_method_for_content', //if 'filename' isn't present then system will
-     *                    attempt to use the callback which should match the name of a method in the class
-     *                    ),
-     *                'tab2_id' => array(
-     *                    'title' => 'tab2 title',
-     *                    'filename' => 'file_name_2'
-     *                    'callback' => 'callback_method_for_content',
-     *                 ),
-     *            'help_sidebar' => 'callback_for_sidebar_content', //this is used for setting up the sidebar in the
-     *            help tab area on an admin page. @return void
-     *
-     * @abstract
-     */
-    abstract protected function _set_page_config();
-
-
-    /**
-     * _add_screen_options
-     * Child classes can add any extra wp_screen_options within this method using built-in WP functions/methods for
-     * doing so. Note child classes can also define _add_screen_options_($this->_current_view) to limit screen options
-     * to a particular view.
-     *
-     * @link   http://chrismarslender.com/wp-tutorials/wordpress-screen-options-tutorial/
-     *         see also WP_Screen object documents...
-     * @link   http://codex.wordpress.org/Class_Reference/WP_Screen
-     * @abstract
-     * @return void
-     */
-    abstract protected function _add_screen_options();
-
-
-    /**
-     * _add_feature_pointers
-     * Child classes should use this method for implementing any "feature pointers" (using built-in WP styling js).
-     * Note child classes can also define _add_feature_pointers_($this->_current_view) to limit screen options to a
-     * particular view. Note: this is just a placeholder for now.  Implementation will come down the road See:
-     * WP_Internal_Pointers class in wp-admin/includes/template.php for example (its a final class so can't be
-     * extended) also see:
-     *
-     * @link   http://eamann.com/tech/wordpress-portland/
-     * @abstract
-     * @return void
-     */
-    abstract protected function _add_feature_pointers();
-
-
-    /**
-     * load_scripts_styles
-     * child classes put their wp_enqueue_script and wp_enqueue_style hooks in here for anything they need loaded for
-     * their pages/subpages.  Note this is for all pages/subpages of the system.  You can also load only specific
-     * scripts/styles per view by putting them in a dynamic function in this format
-     * (load_scripts_styles_{$this->_current_view}) which matches your page route (action request arg)
-     *
-     * @abstract
-     * @return void
-     */
-    abstract public function load_scripts_styles();
-
-
-    /**
-     * admin_init
-     * Anything that should be set/executed at 'admin_init' WP hook runtime should be put in here.  This will apply to
-     * all pages/views loaded by child class.
-     *
-     * @abstract
-     * @return void
-     */
-    abstract public function admin_init();
-
-
-    /**
-     * admin_notices
-     * Anything triggered by the 'admin_notices' WP hook should be put in here.  This particular method will apply to
-     * all pages/views loaded by child class.
-     *
-     * @abstract
-     * @return void
-     */
-    abstract public function admin_notices();
-
-
-    /**
-     * admin_footer_scripts
-     * Anything triggered by the 'admin_print_footer_scripts' WP hook should be put in here. This particular method
-     * will apply to all pages/views loaded by child class.
-     *
-     * @return void
-     */
-    abstract public function admin_footer_scripts();
-
-
-    /**
-     * admin_footer
-     * anything triggered by the 'admin_footer' WP action hook should be added to here. This particular method will
-     * apply to all pages/views loaded by child class.
-     *
-     * @return void
-     */
-    public function admin_footer()
-    {
-    }
-
-
-    /**
-     * _global_ajax_hooks
-     * all global add_action('wp_ajax_{name_of_hook}') hooks in here.
-     * Note: within the ajax callback methods.
-     *
-     * @abstract
-     * @return void
-     */
-    protected function _global_ajax_hooks()
-    {
-        // for lazy loading of metabox content
-        add_action('wp_ajax_espresso-ajax-content', [$this, 'ajax_metabox_content'], 10);
-    }
-
-
-    public function ajax_metabox_content()
-    {
-        $content_id  = $this->request->getRequestParam('contentid', '');
-        $content_url = $this->request->getRequestParam('contenturl', '', 'url');
-        self::cached_rss_display($content_id, $content_url);
-        wp_die();
-    }
-
-
-    /**
-     * allows extending classes do something specific before the parent constructor runs _page_setup().
-     *
-     * @return void
-     */
-    protected function _before_page_setup()
-    {
-        // default is to do nothing
-    }
-
-
-    /**
-     * Makes sure any things that need to be loaded early get handled.
-     * We also escape early here if the page requested doesn't match the object.
-     *
-     * @final
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    final protected function _page_setup()
-    {
-        // requires?
-        // admin_init stuff - global - we're setting this REALLY early
-        // so if EE_Admin pages have to hook into other WP pages they can.
-        // But keep in mind, not everything is available from the EE_Admin Page object at this point.
-        add_action('admin_init', [$this, 'admin_init_global'], 5);
-        // next verify if we need to load anything...
-        $this->_current_page = $this->request->getRequestParam('page', '', 'key');
-        $this->_current_page = $this->request->getRequestParam('current_page', $this->_current_page, 'key');
-
-        $this->page_folder   = strtolower(
-            str_replace(['_Admin_Page', 'Extend_'], '', get_class($this))
-        );
-        global $ee_menu_slugs;
-        $ee_menu_slugs = (array) $ee_menu_slugs;
-        if (
-            ! $this->request->isAjax()
-            && (! $this->_current_page || ! isset($ee_menu_slugs[ $this->_current_page ]))
-        ) {
-            return;
-        }
-        // because WP List tables have two duplicate select inputs for choosing bulk actions,
-        // we need to copy the action from the second to the first
-        $action     = $this->request->getRequestParam('action', '-1', 'key');
-        $action2    = $this->request->getRequestParam('action2', '-1', 'key');
-        $action     = $action !== '-1' ? $action : $action2;
-        $req_action = $action !== '-1' ? $action : 'default';
-
-        // if a specific 'route' has been set, and the action is 'default' OR we are doing_ajax
-        // then let's use the route as the action.
-        // This covers cases where we're coming in from a list table that isn't on the default route.
-        $route = $this->request->getRequestParam('route');
-        $this->_req_action = $route && ($req_action === 'default' || $this->request->isAjax())
-            ? $route
-            : $req_action;
-
-        $this->_current_view = $this->_req_action;
-        $this->_req_nonce    = $this->_req_action . '_nonce';
-        $this->_define_page_props();
-        $this->_current_page_view_url = add_query_arg(
-            ['page' => $this->_current_page, 'action' => $this->_current_view],
-            $this->_admin_base_url
-        );
-        // default things
-        $this->_default_espresso_metaboxes = [
-            '_espresso_news_post_box',
-            '_espresso_links_post_box',
-            '_espresso_ratings_request',
-            '_espresso_sponsors_post_box',
-        ];
-        // set page configs
-        $this->_set_page_routes();
-        $this->_set_page_config();
-        // let's include any referrer data in our default_query_args for this route for "stickiness".
-        if ($this->request->requestParamIsSet('wp_referer')) {
-            $wp_referer = $this->request->getRequestParam('wp_referer');
-            if ($wp_referer) {
-                $this->_default_route_query_args['wp_referer'] = $wp_referer;
-            }
-        }
-        // for caffeinated and other extended functionality.
-        //  If there is a _extend_page_config method
-        // then let's run that to modify the all the various page configuration arrays
-        if (method_exists($this, '_extend_page_config')) {
-            $this->_extend_page_config();
-        }
-        // for CPT and other extended functionality.
-        // If there is an _extend_page_config_for_cpt
-        // then let's run that to modify all the various page configuration arrays.
-        if (method_exists($this, '_extend_page_config_for_cpt')) {
-            $this->_extend_page_config_for_cpt();
-        }
-        // filter routes and page_config so addons can add their stuff. Filtering done per class
-        $this->_page_routes = apply_filters(
-            'FHEE__' . get_class($this) . '__page_setup__page_routes',
-            $this->_page_routes,
-            $this
-        );
-        $this->_page_config = apply_filters(
-            'FHEE__' . get_class($this) . '__page_setup__page_config',
-            $this->_page_config,
-            $this
-        );
-        // if AHEE__EE_Admin_Page__route_admin_request_$this->_current_view method is present
-        // then we call it hooked into the AHEE__EE_Admin_Page__route_admin_request action
-        if (method_exists($this, 'AHEE__EE_Admin_Page__route_admin_request_' . $this->_current_view)) {
-            add_action(
-                'AHEE__EE_Admin_Page__route_admin_request',
-                [$this, 'AHEE__EE_Admin_Page__route_admin_request_' . $this->_current_view],
-                10,
-                2
-            );
-        }
-        // next route only if routing enabled
-        if ($this->_routing && ! $this->request->isAjax()) {
-            $this->_verify_routes();
-            // next let's just check user_access and kill if no access
-            $this->check_user_access();
-            if ($this->_is_UI_request) {
-                // admin_init stuff - global, all views for this page class, specific view
-                add_action('admin_init', [$this, 'admin_init'], 10);
-                if (method_exists($this, 'admin_init_' . $this->_current_view)) {
-                    add_action('admin_init', [$this, 'admin_init_' . $this->_current_view], 15);
-                }
-            } else {
-                // hijack regular WP loading and route admin request immediately
-                @ini_set('memory_limit', apply_filters('admin_memory_limit', WP_MAX_MEMORY_LIMIT));
-                $this->route_admin_request();
-            }
-        }
-    }
-
-
-    /**
-     * Provides a way for related child admin pages to load stuff on the loaded admin page.
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    private function _do_other_page_hooks()
-    {
-        $registered_pages = apply_filters('FHEE_do_other_page_hooks_' . $this->page_slug, []);
-        foreach ($registered_pages as $page) {
-            // now let's setup the file name and class that should be present
-            $classname = str_replace('.class.php', '', $page);
-            // autoloaders should take care of loading file
-            if (! class_exists($classname)) {
-                $error_msg[] = sprintf(
-                    esc_html__(
-                        'Something went wrong with loading the %s admin hooks page.',
-                        'event_espresso'
-                    ),
-                    $page
-                );
-                $error_msg[] = $error_msg[0]
-                               . "\r\n"
-                               . sprintf(
-                                   esc_html__(
-                                       'There is no class in place for the %1$s admin hooks page.%2$sMake sure you have %3$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'
-                                   ),
-                                   $page,
-                                   '<br />',
-                                   '<strong>' . $classname . '</strong>'
-                               );
-                throw new EE_Error(implode('||', $error_msg));
-            }
-            // notice we are passing the instance of this class to the hook object.
-            $this->loader->getShared($classname, [$this]);
-        }
-    }
-
-
-    /**
-     * @throws ReflectionException
-     * @throws EE_Error
-     */
-    public function load_page_dependencies()
-    {
-        try {
-            $this->_load_page_dependencies();
-        } catch (EE_Error $e) {
-            $e->get_error();
-        }
-    }
-
-
-    /**
-     * load_page_dependencies
-     * loads things specific to this page class when its loaded.  Really helps with efficiency.
-     *
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _load_page_dependencies()
-    {
-        // let's set the current_screen and screen options to override what WP set
-        $this->_current_screen = get_current_screen();
-        // load admin_notices - global, page class, and view specific
-        add_action('admin_notices', [$this, 'admin_notices_global'], 5);
-        add_action('admin_notices', [$this, 'admin_notices'], 10);
-        if (method_exists($this, 'admin_notices_' . $this->_current_view)) {
-            add_action('admin_notices', [$this, 'admin_notices_' . $this->_current_view], 15);
-        }
-        // load network admin_notices - global, page class, and view specific
-        add_action('network_admin_notices', [$this, 'network_admin_notices_global'], 5);
-        if (method_exists($this, 'network_admin_notices_' . $this->_current_view)) {
-            add_action('network_admin_notices', [$this, 'network_admin_notices_' . $this->_current_view]);
-        }
-        // this will save any per_page screen options if they are present
-        $this->_set_per_page_screen_options();
-        // setup list table properties
-        $this->_set_list_table();
-        // child classes can "register" a metabox to be automatically handled via the _page_config array property.
-        // However in some cases the metaboxes will need to be added within a route handling callback.
-        $this->_add_registered_meta_boxes();
-        $this->_add_screen_columns();
-        // add screen options - global, page child class, and view specific
-        $this->_add_global_screen_options();
-        $this->_add_screen_options();
-        $add_screen_options = "_add_screen_options_{$this->_current_view}";
-        if (method_exists($this, $add_screen_options)) {
-            $this->{$add_screen_options}();
-        }
-        // add help tab(s) - set via page_config and qtips.
-        $this->_add_help_tabs();
-        $this->_add_qtips();
-        // add feature_pointers - global, page child class, and view specific
-        $this->_add_feature_pointers();
-        $this->_add_global_feature_pointers();
-        $add_feature_pointer = "_add_feature_pointer_{$this->_current_view}";
-        if (method_exists($this, $add_feature_pointer)) {
-            $this->{$add_feature_pointer}();
-        }
-        // enqueue scripts/styles - global, page class, and view specific
-        add_action('admin_enqueue_scripts', [$this, 'load_global_scripts_styles'], 5);
-        add_action('admin_enqueue_scripts', [$this, 'load_scripts_styles'], 10);
-        if (method_exists($this, "load_scripts_styles_{$this->_current_view}")) {
-            add_action('admin_enqueue_scripts', [$this, "load_scripts_styles_{$this->_current_view}"], 15);
-        }
-        add_action('admin_enqueue_scripts', [$this, 'admin_footer_scripts_eei18n_js_strings'], 100);
-        // admin_print_footer_scripts - global, page child class, and view specific.
-        // NOTE, despite the name, whenever possible, scripts should NOT be loaded using this.
-        // In most cases that's doing_it_wrong().  But adding hidden container elements etc.
-        // is a good use case. Notice the late priority we're giving these
-        add_action('admin_print_footer_scripts', [$this, 'admin_footer_scripts_global'], 99);
-        add_action('admin_print_footer_scripts', [$this, 'admin_footer_scripts'], 100);
-        if (method_exists($this, "admin_footer_scripts_{$this->_current_view}")) {
-            add_action('admin_print_footer_scripts', [$this, "admin_footer_scripts_{$this->_current_view}"], 101);
-        }
-        // admin footer scripts
-        add_action('admin_footer', [$this, 'admin_footer_global'], 99);
-        add_action('admin_footer', [$this, 'admin_footer'], 100);
-        if (method_exists($this, "admin_footer_{$this->_current_view}")) {
-            add_action('admin_footer', [$this, "admin_footer_{$this->_current_view}"], 101);
-        }
-        do_action('FHEE__EE_Admin_Page___load_page_dependencies__after_load', $this->page_slug);
-        // targeted hook
-        do_action(
-            "FHEE__EE_Admin_Page___load_page_dependencies__after_load__{$this->page_slug}__{$this->_req_action}"
-        );
-    }
-
-
-    /**
-     * _set_defaults
-     * This sets some global defaults for class properties.
-     */
-    private function _set_defaults()
-    {
-        $this->_current_screen       = $this->_admin_page_title = $this->_req_action = $this->_req_nonce = null;
-        $this->_event                = $this->_template_path = $this->_column_template_path = null;
-        $this->_nav_tabs             = $this->_views = $this->_page_routes = [];
-        $this->_page_config          = $this->_default_route_query_args = [];
-        $this->_default_nav_tab_name = 'overview';
-        // init template args
-        $this->_template_args = [
-            'admin_page_header'  => '',
-            'admin_page_content' => '',
-            'post_body_content'  => '',
-            'before_list_table'  => '',
-            'after_list_table'   => '',
-        ];
-    }
-
-
-    /**
-     * route_admin_request
-     *
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @see    _route_admin_request()
-     */
-    public function route_admin_request()
-    {
-        try {
-            $this->_route_admin_request();
-        } catch (EE_Error $e) {
-            $e->get_error();
-        }
-    }
-
-
-    public function set_wp_page_slug($wp_page_slug)
-    {
-        $this->_wp_page_slug = $wp_page_slug;
-        // if in network admin then we need to append "-network" to the page slug. Why? Because that's how WP rolls...
-        if (is_network_admin()) {
-            $this->_wp_page_slug .= '-network';
-        }
-    }
-
-
-    /**
-     * _verify_routes
-     * All this method does is verify the incoming request and make sure that routes exist for it.  We do this early so
-     * we know if we need to drop out.
-     *
-     * @return bool
-     * @throws EE_Error
-     */
-    protected function _verify_routes()
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        if (! $this->_current_page && ! $this->request->isAjax()) {
-            return false;
-        }
-        $this->_route = false;
-        // check that the page_routes array is not empty
-        if (empty($this->_page_routes)) {
-            // user error msg
-            $error_msg = sprintf(
-                esc_html__('No page routes have been set for the %s admin page.', 'event_espresso'),
-                $this->_admin_page_title
-            );
-            // developer error msg
-            $error_msg .= '||' . $error_msg
-                          . esc_html__(
-                              ' Make sure the "set_page_routes()" method exists, and is setting the "_page_routes" array properly.',
-                              'event_espresso'
-                          );
-            throw new EE_Error($error_msg);
-        }
-        // and that the requested page route exists
-        if (array_key_exists($this->_req_action, $this->_page_routes)) {
-            $this->_route        = $this->_page_routes[ $this->_req_action ];
-            $this->_route_config = isset($this->_page_config[ $this->_req_action ])
-                ? $this->_page_config[ $this->_req_action ]
-                : [];
-        } else {
-            // user error msg
-            $error_msg = sprintf(
-                esc_html__(
-                    'The requested page route does not exist for the %s admin page.',
-                    'event_espresso'
-                ),
-                $this->_admin_page_title
-            );
-            // developer error msg
-            $error_msg .= '||' . $error_msg
-                          . sprintf(
-                              esc_html__(
-                                  ' Create a key in the "_page_routes" array named "%s" and set its value to the appropriate method.',
-                                  'event_espresso'
-                              ),
-                              $this->_req_action
-                          );
-            throw new EE_Error($error_msg);
-        }
-        // and that a default route exists
-        if (! array_key_exists('default', $this->_page_routes)) {
-            // user error msg
-            $error_msg = sprintf(
-                esc_html__(
-                    'A default page route has not been set for the % admin page.',
-                    'event_espresso'
-                ),
-                $this->_admin_page_title
-            );
-            // developer error msg
-            $error_msg .= '||' . $error_msg
-                          . esc_html__(
-                              ' Create a key in the "_page_routes" array named "default" and set its value to your default page method.',
-                              'event_espresso'
-                          );
-            throw new EE_Error($error_msg);
-        }
-        // first lets' catch if the UI request has EVER been set.
-        if ($this->_is_UI_request === null) {
-            // lets set if this is a UI request or not.
-            $this->_is_UI_request = ! $this->request->getRequestParam('noheader', false, 'bool');
-            // wait a minute... we might have a noheader in the route array
-            $this->_is_UI_request = ! (
-                is_array($this->_route) && isset($this->_route['noheader']) && $this->_route['noheader']
-            )
-                ? $this->_is_UI_request
-                : false;
-        }
-        $this->_set_current_labels();
-        return true;
-    }
-
-
-    /**
-     * this method simply verifies a given route and makes sure its an actual route available for the loaded page
-     *
-     * @param string $route the route name we're verifying
-     * @return bool we'll throw an exception if this isn't a valid route.
-     * @throws EE_Error
-     */
-    protected function _verify_route($route)
-    {
-        if (array_key_exists($this->_req_action, $this->_page_routes)) {
-            return true;
-        }
-        // user error msg
-        $error_msg = sprintf(
-            esc_html__('The given page route does not exist for the %s admin page.', 'event_espresso'),
-            $this->_admin_page_title
-        );
-        // developer error msg
-        $error_msg .= '||' . $error_msg
-                      . sprintf(
-                          esc_html__(
-                              ' Check the route you are using in your method (%s) and make sure it matches a route set in your "_page_routes" array property',
-                              'event_espresso'
-                          ),
-                          $route
-                      );
-        throw new EE_Error($error_msg);
-    }
-
-
-    /**
-     * perform nonce verification
-     * This method has be encapsulated here so that any ajax requests that bypass normal routes can verify their nonces
-     * using this method (and save retyping!)
-     *
-     * @param string $nonce     The nonce sent
-     * @param string $nonce_ref The nonce reference string (name0)
-     * @return void
-     * @throws EE_Error
-     */
-    protected function _verify_nonce($nonce, $nonce_ref)
-    {
-        // verify nonce against expected value
-        if (! wp_verify_nonce($nonce, $nonce_ref)) {
-            // these are not the droids you are looking for !!!
-            $msg = sprintf(
-                esc_html__('%sNonce Fail.%s', 'event_espresso'),
-                '<a href="https://www.youtube.com/watch?v=56_S0WeTkzs">',
-                '</a>'
-            );
-            if (WP_DEBUG) {
-                $msg .= "\n  ";
-                $msg .= sprintf(
-                    esc_html__(
-                        'In order to dynamically generate nonces for your actions, use the %s::add_query_args_and_nonce() method. May the Nonce be with you!',
-                        'event_espresso'
-                    ),
-                    __CLASS__
-                );
-            }
-            if (! $this->request->isAjax()) {
-                wp_die($msg);
-            }
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            $this->_return_json();
-        }
-    }
-
-
-    /**
-     * _route_admin_request()
-     * Meat and potatoes of the class.  Basically, this dude checks out what's being requested and sees if theres are
-     * some doodads to work the magic and handle the flingjangy. Translation:  Checks if the requested action is listed
-     * in the page routes and then will try to load the corresponding method.
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _route_admin_request()
-    {
-        if (! $this->_is_UI_request) {
-            $this->_verify_routes();
-        }
-        $nonce_check = ! isset($this->_route_config['require_nonce']) || $this->_route_config['require_nonce'];
-        if ($this->_req_action !== 'default' && $nonce_check) {
-            // set nonce from post data
-            $nonce = $this->request->getRequestParam($this->_req_nonce, '');
-            $this->_verify_nonce($nonce, $this->_req_nonce);
-        }
-        // set the nav_tabs array but ONLY if this is  UI_request
-        if ($this->_is_UI_request) {
-            $this->_set_nav_tabs();
-        }
-        // grab callback function
-        $func = is_array($this->_route) ? $this->_route['func'] : $this->_route;
-        // check if callback has args
-        $args      = is_array($this->_route) && isset($this->_route['args']) ? $this->_route['args'] : [];
-        $error_msg = '';
-        // action right before calling route
-        // (hook is something like 'AHEE__Registrations_Admin_Page__route_admin_request')
-        if (! did_action('AHEE__EE_Admin_Page__route_admin_request')) {
-            do_action('AHEE__EE_Admin_Page__route_admin_request', $this->_current_view, $this);
-        }
-        // right before calling the route, let's clean the _wp_http_referer
-        $this->request->unSetRequestParam('_wp_http_referer');
-        $this->request->unSetServerParam('_wp_http_referer');
-        $cleaner_request_uri = remove_query_arg(
-            '_wp_http_referer',
-            wp_unslash($this->request->getServerParam('REQUEST_URI'))
-        );
-        $this->request->setRequestParam('_wp_http_referer', $cleaner_request_uri);
-        $this->request->setServerParam('REQUEST_URI', $cleaner_request_uri);
-        if (! empty($func)) {
-            if (is_array($func)) {
-                [$class, $method] = $func;
-            } elseif (strpos($func, '::') !== false) {
-                [$class, $method] = explode('::', $func);
-            } else {
-                $class  = $this;
-                $method = $func;
-            }
-            if (! (is_object($class) && $class === $this) && ! in_array($this, $args)) {
-                // send along this admin page object for access by addons.
-                $args['admin_page'] = $this;
-            }
-            if (
-                // is it a method on a class that doesn't work?
-                (
-                    (
-                        method_exists($class, $method)
-                        && call_user_func_array([$class, $method], $args) === false
-                    )
-                    && (
-                        // is it a standalone function that doesn't work?
-                        function_exists($method)
-                        && call_user_func_array(
-                            $func,
-                            array_merge(['admin_page' => $this], $args)
-                        ) === false
-                    )
-                )
-                || (
-                    // is it neither a class method NOR a standalone function?
-                    ! method_exists($class, $method)
-                    && ! function_exists($method)
-                )
-            ) {
-                // user error msg
-                $error_msg = esc_html__(
-                    'An error occurred. The  requested page route could not be found.',
-                    'event_espresso'
-                );
-                // developer error msg
-                $error_msg .= '||';
-                $error_msg .= sprintf(
-                    esc_html__(
-                        'Page route "%s" could not be called. Check that the spelling for method names and actions in the "_page_routes" array are all correct.',
-                        'event_espresso'
-                    ),
-                    $method
-                );
-            }
-            if (! empty($error_msg)) {
-                throw new EE_Error($error_msg);
-            }
-        }
-        // if we've routed and this route has a no headers route AND a sent_headers_route,
-        // then we need to reset the routing properties to the new route.
-        // now if UI request is FALSE and noheader is true AND we have a headers_sent_route in the route array then let's set UI_request to true because the no header route has a second func after headers have been sent.
-        if (
-            $this->_is_UI_request === false
-            && is_array($this->_route)
-            && ! empty($this->_route['headers_sent_route'])
-        ) {
-            $this->_reset_routing_properties($this->_route['headers_sent_route']);
-        }
-    }
-
-
-    /**
-     * This method just allows the resetting of page properties in the case where a no headers
-     * route redirects to a headers route in its route config.
-     *
-     * @param string $new_route New (non header) route to redirect to.
-     * @return   void
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @since   4.3.0
-     */
-    protected function _reset_routing_properties($new_route)
-    {
-        $this->_is_UI_request = true;
-        // now we set the current route to whatever the headers_sent_route is set at
-        $this->request->setRequestParam('action', $new_route);
-        // rerun page setup
-        $this->_page_setup();
-    }
-
-
-    /**
-     * _add_query_arg
-     * adds nonce to array of arguments then calls WP add_query_arg function
-     *(internally just uses EEH_URL's function with the same name)
-     *
-     * @param array  $args
-     * @param string $url
-     * @param bool   $sticky                  if true, then the existing Request params will be appended to the
-     *                                        generated url in an associative array indexed by the key 'wp_referer';
-     *                                        Example usage: If the current page is:
-     *                                        http://mydomain.com/wp-admin/admin.php?page=espresso_registrations
-     *                                        &action=default&event_id=20&month_range=March%202015
-     *                                        &_wpnonce=5467821
-     *                                        and you call:
-     *                                        EE_Admin_Page::add_query_args_and_nonce(
-     *                                        array(
-     *                                        'action' => 'resend_something',
-     *                                        'page=>espresso_registrations'
-     *                                        ),
-     *                                        $some_url,
-     *                                        true
-     *                                        );
-     *                                        It will produce a url in this structure:
-     *                                        http://{$some_url}/?page=espresso_registrations&action=resend_something
-     *                                        &wp_referer[action]=default&wp_referer[event_id]=20&wpreferer[
-     *                                        month_range]=March%202015
-     * @param bool   $exclude_nonce           If true, the the nonce will be excluded from the generated nonce.
-     * @return string
-     */
-    public static function add_query_args_and_nonce(
-        $args = [],
-        $url = false,
-        $sticky = false,
-        $exclude_nonce = false
-    ) {
-        // if there is a _wp_http_referer include the values from the request but only if sticky = true
-        if ($sticky) {
-            /** @var RequestInterface $request */
-            $request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-            $request->unSetRequestParams(['_wp_http_referer', 'wp_referer'], true);
-            foreach ($request->requestParams() as $key => $value) {
-                // do not add nonces
-                if (strpos($key, 'nonce') !== false) {
-                    continue;
-                }
-                $args[ 'wp_referer[' . $key . ']' ] = is_string($value) ? htmlspecialchars($value) : $value;
-            }
-        }
-        return EEH_URL::add_query_args_and_nonce($args, $url, $exclude_nonce);
-    }
-
-
-    /**
-     * This returns a generated link that will load the related help tab.
-     *
-     * @param string $help_tab_id the id for the connected help tab
-     * @param string $icon_style  (optional) include css class for the style you want to use for the help icon.
-     * @param string $help_text   (optional) send help text you want to use for the link if default not to be used
-     * @return string              generated link
-     * @uses EEH_Template::get_help_tab_link()
-     */
-    protected function _get_help_tab_link($help_tab_id, $icon_style = '', $help_text = '')
-    {
-        return EEH_Template::get_help_tab_link(
-            $help_tab_id,
-            $this->page_slug,
-            $this->_req_action,
-            $icon_style,
-            $help_text
-        );
-    }
-
-
-    /**
-     * _add_help_tabs
-     * Note child classes define their help tabs within the page_config array.
-     *
-     * @link   http://codex.wordpress.org/Function_Reference/add_help_tab
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    protected function _add_help_tabs()
-    {
-        if (isset($this->_page_config[ $this->_req_action ])) {
-            $config = $this->_page_config[ $this->_req_action ];
-            // let's see if there is a help_sidebar set for the current route and we'll set that up for usage as well.
-            if (is_array($config) && isset($config['help_sidebar'])) {
-                // check that the callback given is valid
-                if (! method_exists($this, $config['help_sidebar'])) {
-                    throw new EE_Error(
-                        sprintf(
-                            esc_html__(
-                                'The _page_config array has a callback set for the "help_sidebar" option.  However the callback given (%s) is not a valid callback.  Doublecheck the spelling and make sure this method exists for the class %s',
-                                'event_espresso'
-                            ),
-                            $config['help_sidebar'],
-                            get_class($this)
-                        )
-                    );
-                }
-                $content = apply_filters(
-                    'FHEE__' . get_class($this) . '__add_help_tabs__help_sidebar',
-                    $this->{$config['help_sidebar']}()
-                );
-                $this->_current_screen->set_help_sidebar($content);
-            }
-            if (! isset($config['help_tabs'])) {
-                return;
-            } //no help tabs for this route
-            foreach ((array) $config['help_tabs'] as $tab_id => $cfg) {
-                // we're here so there ARE help tabs!
-                // make sure we've got what we need
-                if (! isset($cfg['title'])) {
-                    throw new EE_Error(
-                        esc_html__(
-                            'The _page_config array is not set up properly for help tabs.  It is missing a title',
-                            'event_espresso'
-                        )
-                    );
-                }
-                if (! isset($cfg['filename']) && ! isset($cfg['callback']) && ! isset($cfg['content'])) {
-                    throw new EE_Error(
-                        esc_html__(
-                            'The _page_config array is not setup properly for help tabs. It is missing a either a filename reference, or a callback reference or a content reference so there is no way to know the content for the help tab',
-                            'event_espresso'
-                        )
-                    );
-                }
-                // first priority goes to content.
-                if (! empty($cfg['content'])) {
-                    $content = ! empty($cfg['content']) ? $cfg['content'] : null;
-                    // second priority goes to filename
-                } elseif (! empty($cfg['filename'])) {
-                    $file_path = $this->_get_dir() . '/help_tabs/' . $cfg['filename'] . '.help_tab.php';
-                    // it's possible that the file is located on decaf route (and above sets up for caf route, if this is the case then lets check decaf route too)
-                    $file_path = ! is_readable($file_path) ? EE_ADMIN_PAGES
-                                                             . basename($this->_get_dir())
-                                                             . '/help_tabs/'
-                                                             . $cfg['filename']
-                                                             . '.help_tab.php' : $file_path;
-                    // if file is STILL not readable then let's do a EE_Error so its more graceful than a fatal error.
-                    if (! isset($cfg['callback']) && ! is_readable($file_path)) {
-                        EE_Error::add_error(
-                            sprintf(
-                                esc_html__(
-                                    'The filename given for the help tab %s is not a valid file and there is no other configuration for the tab content.  Please check that the string you set for the help tab on this route (%s) is the correct spelling.  The file should be in %s',
-                                    'event_espresso'
-                                ),
-                                $tab_id,
-                                key($config),
-                                $file_path
-                            ),
-                            __FILE__,
-                            __FUNCTION__,
-                            __LINE__
-                        );
-                        return;
-                    }
-                    $template_args['admin_page_obj'] = $this;
-                    $content                         = EEH_Template::display_template(
-                        $file_path,
-                        $template_args,
-                        true
-                    );
-                } else {
-                    $content = '';
-                }
-                // check if callback is valid
-                if (
-                    empty($content)
-                    && (
-                        ! isset($cfg['callback']) || ! method_exists($this, $cfg['callback'])
-                    )
-                ) {
-                    EE_Error::add_error(
-                        sprintf(
-                            esc_html__(
-                                'The callback given for a %s help tab on this page does not content OR a corresponding method for generating the content.  Check the spelling or make sure the method is present.',
-                                'event_espresso'
-                            ),
-                            $cfg['title']
-                        ),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                    return;
-                }
-                // setup config array for help tab method
-                $id  = $this->page_slug . '-' . $this->_req_action . '-' . $tab_id;
-                $_ht = [
-                    'id'       => $id,
-                    'title'    => $cfg['title'],
-                    'callback' => isset($cfg['callback']) && empty($content) ? [$this, $cfg['callback']] : null,
-                    'content'  => $content,
-                ];
-                $this->_current_screen->add_help_tab($_ht);
-            }
-        }
-    }
-
-
-    /**
-     * This simply sets up any qtips that have been defined in the page config
-     *
-     * @return void
-     */
-    protected function _add_qtips()
-    {
-        if (isset($this->_route_config['qtips'])) {
-            $qtips = (array) $this->_route_config['qtips'];
-            // load qtip loader
-            $path = [
-                $this->_get_dir() . '/qtips/',
-                EE_ADMIN_PAGES . basename($this->_get_dir()) . '/qtips/',
-            ];
-            EEH_Qtip_Loader::instance()->register($qtips, $path);
-        }
-    }
-
-
-    /**
-     * _set_nav_tabs
-     * This sets up the nav tabs from the page_routes array.  This method can be overwritten by child classes if you
-     * wish to add additional tabs or modify accordingly.
-     *
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    protected function _set_nav_tabs()
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $i = 0;
-        foreach ($this->_page_config as $slug => $config) {
-            if (! is_array($config) || empty($config['nav'])) {
-                continue;
-            }
-            // no nav tab for this config
-            // check for persistent flag
-            if ($slug !== $this->_req_action && isset($config['nav']['persistent']) && ! $config['nav']['persistent']) {
-                // nav tab is only to appear when route requested.
-                continue;
-            }
-            if (! $this->check_user_access($slug, true)) {
-                // no nav tab because current user does not have access.
-                continue;
-            }
-            $css_class                = isset($config['css_class']) ? $config['css_class'] . ' ' : '';
-            $this->_nav_tabs[ $slug ] = [
-                'url'       => isset($config['nav']['url'])
-                    ? $config['nav']['url']
-                    : self::add_query_args_and_nonce(
-                        ['action' => $slug],
-                        $this->_admin_base_url
-                    ),
-                'link_text' => isset($config['nav']['label'])
-                    ? $config['nav']['label']
-                    : ucwords(
-                        str_replace('_', ' ', $slug)
-                    ),
-                'css_class' => $this->_req_action === $slug ? $css_class . 'nav-tab-active' : $css_class,
-                'order'     => isset($config['nav']['order']) ? $config['nav']['order'] : $i,
-            ];
-            $i++;
-        }
-        // if $this->_nav_tabs is empty then lets set the default
-        if (empty($this->_nav_tabs)) {
-            $this->_nav_tabs[ $this->_default_nav_tab_name ] = [
-                'url'       => $this->_admin_base_url,
-                'link_text' => ucwords(str_replace('_', ' ', $this->_default_nav_tab_name)),
-                'css_class' => 'nav-tab-active',
-                'order'     => 10,
-            ];
-        }
-        // now let's sort the tabs according to order
-        usort($this->_nav_tabs, [$this, '_sort_nav_tabs']);
-    }
-
-
-    /**
-     * _set_current_labels
-     * This method modifies the _labels property with any optional specific labels indicated in the _page_routes
-     * property array
-     *
-     * @return void
-     */
-    private function _set_current_labels()
-    {
-        if (is_array($this->_route_config) && isset($this->_route_config['labels'])) {
-            foreach ($this->_route_config['labels'] as $label => $text) {
-                if (is_array($text)) {
-                    foreach ($text as $sublabel => $subtext) {
-                        $this->_labels[ $label ][ $sublabel ] = $subtext;
-                    }
-                } else {
-                    $this->_labels[ $label ] = $text;
-                }
-            }
-        }
-    }
-
-
-    /**
-     *        verifies user access for this admin page
-     *
-     * @param string $route_to_check if present then the capability for the route matching this string is checked.
-     * @param bool   $verify_only    Default is FALSE which means if user check fails then wp_die().  Otherwise just
-     *                               return false if verify fail.
-     * @return bool
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function check_user_access($route_to_check = '', $verify_only = false)
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $route_to_check = empty($route_to_check) ? $this->_req_action : $route_to_check;
-        $capability     = ! empty($route_to_check) && isset($this->_page_routes[ $route_to_check ])
-                          && is_array(
-                              $this->_page_routes[ $route_to_check ]
-                          )
-                          && ! empty($this->_page_routes[ $route_to_check ]['capability'])
-            ? $this->_page_routes[ $route_to_check ]['capability'] : null;
-        if (empty($capability) && empty($route_to_check)) {
-            $capability = is_array($this->_route) && empty($this->_route['capability']) ? 'manage_options'
-                : $this->_route['capability'];
-        } else {
-            $capability = empty($capability) ? 'manage_options' : $capability;
-        }
-        $id = is_array($this->_route) && ! empty($this->_route['obj_id']) ? $this->_route['obj_id'] : 0;
-        if (
-            ! $this->request->isAjax()
-            && (
-                ! function_exists('is_admin')
-                || ! EE_Registry::instance()->CAP->current_user_can(
-                    $capability,
-                    $this->page_slug
-                    . '_'
-                    . $route_to_check,
-                    $id
-                )
-            )
-        ) {
-            if ($verify_only) {
-                return false;
-            }
-            if (is_user_logged_in()) {
-                wp_die(esc_html__('You do not have access to this route.', 'event_espresso'));
-            } else {
-                return false;
-            }
-        }
-        return true;
-    }
-
-
-    /**
-     * admin_init_global
-     * This runs all the code that we want executed within the WP admin_init hook.
-     * This method executes for ALL EE Admin pages.
-     *
-     * @return void
-     */
-    public function admin_init_global()
-    {
-    }
-
-
-    /**
-     * wp_loaded_global
-     * This runs all the code that we want executed within the WP wp_loaded hook.  This method is optional for an
-     * EE_Admin page and will execute on every EE Admin Page load
-     *
-     * @return void
-     */
-    public function wp_loaded()
-    {
-    }
-
-
-    /**
-     * admin_notices
-     * Anything triggered by the 'admin_notices' WP hook should be put in here.  This particular method will apply on
-     * ALL EE_Admin pages.
-     *
-     * @return void
-     */
-    public function admin_notices_global()
-    {
-        $this->_display_no_javascript_warning();
-        $this->_display_espresso_notices();
-    }
-
-
-    public function network_admin_notices_global()
-    {
-        $this->_display_no_javascript_warning();
-        $this->_display_espresso_notices();
-    }
-
-
-    /**
-     * admin_footer_scripts_global
-     * Anything triggered by the 'admin_print_footer_scripts' WP hook should be put in here. This particular method
-     * will apply on ALL EE_Admin pages.
-     *
-     * @return void
-     */
-    public function admin_footer_scripts_global()
-    {
-        $this->_add_admin_page_ajax_loading_img();
-        $this->_add_admin_page_overlay();
-        // if metaboxes are present we need to add the nonce field
-        if (
-            isset($this->_route_config['metaboxes'])
-            || isset($this->_route_config['list_table'])
-            || (isset($this->_route_config['has_metaboxes']) && $this->_route_config['has_metaboxes'])
-        ) {
-            wp_nonce_field('closedpostboxes', 'closedpostboxesnonce', false);
-            wp_nonce_field('meta-box-order', 'meta-box-order-nonce', false);
-        }
-    }
-
-
-    /**
-     * admin_footer_global
-     * Anything triggered by the wp 'admin_footer' wp hook should be put in here. This particular method will apply on
-     * ALL EE_Admin Pages.
-     *
-     * @return void
-     */
-    public function admin_footer_global()
-    {
-        // dialog container for dialog helper
-        echo '
+	/**
+	 * Used to hold default query args for list table routes to help preserve stickiness of filters for carried out
+	 * actions.
+	 *
+	 * @since 4.6.x
+	 * @var array.
+	 */
+	protected $_default_route_query_args;
+
+	// set via request page and action args.
+	protected $_current_page;
+
+	protected $_current_view;
+
+	protected $_current_page_view_url;
+
+	/**
+	 * unprocessed value for the 'action' request param (default '')
+	 *
+	 * @var string
+	 */
+	protected $raw_req_action = '';
+
+	/**
+	 * unprocessed value for the 'page' request param (default '')
+	 *
+	 * @var string
+	 */
+	protected $raw_req_page = '';
+
+	/**
+	 * sanitized request action (and nonce)
+	 *
+	 * @var string
+	 */
+	protected $_req_action = '';
+
+	/**
+	 * sanitized request action nonce
+	 *
+	 * @var string
+	 */
+	protected $_req_nonce = '';
+
+	/**
+	 * @var string
+	 */
+	protected $_search_btn_label = '';
+
+	/**
+	 * @var string
+	 */
+	protected $_search_box_callback = '';
+
+	/**
+	 * @var WP_Screen
+	 */
+	protected $_current_screen;
+
+	// for holding EE_Admin_Hooks object when needed (set via set_hook_object())
+	protected $_hook_obj;
+
+	// for holding incoming request data
+	protected $_req_data = [];
+
+	// yes / no array for admin form fields
+	protected $_yes_no_values = [];
+
+	// some default things shared by all child classes
+	protected $_default_espresso_metaboxes;
+
+	/**
+	 * @var EE_Registry
+	 */
+	protected $EE = null;
+
+
+	/**
+	 * This is just a property that flags whether the given route is a caffeinated route or not.
+	 *
+	 * @var boolean
+	 */
+	protected $_is_caf = false;
+
+
+	/**
+	 * @Constructor
+	 * @param bool $routing indicate whether we want to just load the object and handle routing or just load the object.
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function __construct($routing = true)
+	{
+		$this->loader  = LoaderFactory::getLoader();
+		$this->request = $this->loader->getShared(RequestInterface::class);
+		$this->_routing = $routing;
+
+		if (strpos($this->_get_dir(), 'caffeinated') !== false) {
+			$this->_is_caf = true;
+		}
+		$this->_yes_no_values = [
+			['id' => true, 'text' => esc_html__('Yes', 'event_espresso')],
+			['id' => false, 'text' => esc_html__('No', 'event_espresso')],
+		];
+		// set the _req_data property.
+		$this->_req_data = $this->request->requestParams();
+		// set initial page props (child method)
+		$this->_init_page_props();
+		// set global defaults
+		$this->_set_defaults();
+		// set early because incoming requests could be ajax related and we need to register those hooks.
+		$this->_global_ajax_hooks();
+		$this->_ajax_hooks();
+		// other_page_hooks have to be early too.
+		$this->_do_other_page_hooks();
+		// set up page dependencies
+		$this->_before_page_setup();
+		$this->_page_setup();
+		// die();
+	}
+
+
+	/**
+	 * _init_page_props
+	 * Child classes use to set at least the following properties:
+	 * $page_slug.
+	 * $page_label.
+	 *
+	 * @abstract
+	 * @return void
+	 */
+	abstract protected function _init_page_props();
+
+
+	/**
+	 * _ajax_hooks
+	 * child classes put all their add_action('wp_ajax_{name_of_hook}') hooks in here.
+	 * Note: within the ajax callback methods.
+	 *
+	 * @abstract
+	 * @return void
+	 */
+	abstract protected function _ajax_hooks();
+
+
+	/**
+	 * _define_page_props
+	 * child classes define page properties in here.  Must include at least:
+	 * $_admin_base_url = base_url for all admin pages
+	 * $_admin_page_title = default admin_page_title for admin pages
+	 * $_labels = array of default labels for various automatically generated elements:
+	 *    array(
+	 *        'buttons' => array(
+	 *            'add' => esc_html__('label for add new button'),
+	 *            'edit' => esc_html__('label for edit button'),
+	 *            'delete' => esc_html__('label for delete button')
+	 *            )
+	 *        )
+	 *
+	 * @abstract
+	 * @return void
+	 */
+	abstract protected function _define_page_props();
+
+
+	/**
+	 * _set_page_routes
+	 * child classes use this to define the page routes for all subpages handled by the class.  Page routes are
+	 * assigned to a action => method pairs in an array and to the $_page_routes property.  Each page route must also
+	 * have a 'default' route. Here's the format
+	 * $this->_page_routes = array(
+	 *        'default' => array(
+	 *            'func' => '_default_method_handling_route',
+	 *            'args' => array('array','of','args'),
+	 *            'noheader' => true, //add this in if this page route is processed before any headers are loaded (i.e.
+	 *            ajax request, backend processing)
+	 *            'headers_sent_route'=>'headers_route_reference', //add this if noheader=>true, and you want to load a
+	 *            headers route after.  The string you enter here should match the defined route reference for a
+	 *            headers sent route.
+	 *            'capability' => 'route_capability', //indicate a string for minimum capability required to access
+	 *            this route.
+	 *            'obj_id' => 10 // if this route has an object id, then this can include it (used for capability
+	 *            checks).
+	 *        ),
+	 *        'insert_item' => '_method_for_handling_insert_item' //this can be used if all we need to have is a
+	 *        handling method.
+	 *        )
+	 * )
+	 *
+	 * @abstract
+	 * @return void
+	 */
+	abstract protected function _set_page_routes();
+
+
+	/**
+	 * _set_page_config
+	 * child classes use this to define the _page_config array for all subpages handled by the class. Each key in the
+	 * array corresponds to the page_route for the loaded page. Format:
+	 * $this->_page_config = array(
+	 *        'default' => array(
+	 *            'labels' => array(
+	 *                'buttons' => array(
+	 *                    'add' => esc_html__('label for adding item'),
+	 *                    'edit' => esc_html__('label for editing item'),
+	 *                    'delete' => esc_html__('label for deleting item')
+	 *                ),
+	 *                'publishbox' => esc_html__('Localized Title for Publish metabox', 'event_espresso')
+	 *            ), //optional an array of custom labels for various automatically generated elements to use on the
+	 *            page. If this isn't present then the defaults will be used as set for the $this->_labels in
+	 *            _define_page_props() method
+	 *            'nav' => array(
+	 *                'label' => esc_html__('Label for Tab', 'event_espresso').
+	 *                'url' => 'http://someurl', //automatically generated UNLESS you define
+	 *                'css_class' => 'css-class', //automatically generated UNLESS you define
+	 *                'order' => 10, //required to indicate tab position.
+	 *                'persistent' => false //if you want the nav tab to ONLY display when the specific route is
+	 *                displayed then add this parameter.
+	 *            'list_table' => 'name_of_list_table' //string for list table class to be loaded for this admin_page.
+	 *            'metaboxes' => array('metabox1', 'metabox2'), //if present this key indicates we want to load
+	 *            metaboxes set for eventespresso admin pages.
+	 *            'has_metaboxes' => true, //this boolean flag can simply be used to indicate if the route will have
+	 *            metaboxes.  Typically this is used if the 'metaboxes' index is not used because metaboxes are added
+	 *            later.  We just use this flag to make sure the necessary js gets enqueued on page load.
+	 *            'has_help_popups' => false //defaults(true) //this boolean flag can simply be used to indicate if the
+	 *            given route has help popups setup and if it does then we need to make sure thickbox is enqueued.
+	 *            'columns' => array(4, 2), //this key triggers the setup of a page that uses columns (metaboxes).  The
+	 *            array indicates the max number of columns (4) and the default number of columns on page load (2).
+	 *            There is an option in the "screen_options" dropdown that is setup so users can pick what columns they
+	 *            want to display.
+	 *            'help_tabs' => array( //this is used for adding help tabs to a page
+	 *                'tab_id' => array(
+	 *                    'title' => 'tab_title',
+	 *                    'filename' => 'name_of_file_containing_content', //this is the primary method for setting
+	 *                    help tab content.  The fallback if it isn't present is to try a the callback.  Filename
+	 *                    should match a file in the admin folder's "help_tabs" dir (ie..
+	 *                    events/help_tabs/name_of_file_containing_content.help_tab.php)
+	 *                    'callback' => 'callback_method_for_content', //if 'filename' isn't present then system will
+	 *                    attempt to use the callback which should match the name of a method in the class
+	 *                    ),
+	 *                'tab2_id' => array(
+	 *                    'title' => 'tab2 title',
+	 *                    'filename' => 'file_name_2'
+	 *                    'callback' => 'callback_method_for_content',
+	 *                 ),
+	 *            'help_sidebar' => 'callback_for_sidebar_content', //this is used for setting up the sidebar in the
+	 *            help tab area on an admin page. @return void
+	 *
+	 * @abstract
+	 */
+	abstract protected function _set_page_config();
+
+
+	/**
+	 * _add_screen_options
+	 * Child classes can add any extra wp_screen_options within this method using built-in WP functions/methods for
+	 * doing so. Note child classes can also define _add_screen_options_($this->_current_view) to limit screen options
+	 * to a particular view.
+	 *
+	 * @link   http://chrismarslender.com/wp-tutorials/wordpress-screen-options-tutorial/
+	 *         see also WP_Screen object documents...
+	 * @link   http://codex.wordpress.org/Class_Reference/WP_Screen
+	 * @abstract
+	 * @return void
+	 */
+	abstract protected function _add_screen_options();
+
+
+	/**
+	 * _add_feature_pointers
+	 * Child classes should use this method for implementing any "feature pointers" (using built-in WP styling js).
+	 * Note child classes can also define _add_feature_pointers_($this->_current_view) to limit screen options to a
+	 * particular view. Note: this is just a placeholder for now.  Implementation will come down the road See:
+	 * WP_Internal_Pointers class in wp-admin/includes/template.php for example (its a final class so can't be
+	 * extended) also see:
+	 *
+	 * @link   http://eamann.com/tech/wordpress-portland/
+	 * @abstract
+	 * @return void
+	 */
+	abstract protected function _add_feature_pointers();
+
+
+	/**
+	 * load_scripts_styles
+	 * child classes put their wp_enqueue_script and wp_enqueue_style hooks in here for anything they need loaded for
+	 * their pages/subpages.  Note this is for all pages/subpages of the system.  You can also load only specific
+	 * scripts/styles per view by putting them in a dynamic function in this format
+	 * (load_scripts_styles_{$this->_current_view}) which matches your page route (action request arg)
+	 *
+	 * @abstract
+	 * @return void
+	 */
+	abstract public function load_scripts_styles();
+
+
+	/**
+	 * admin_init
+	 * Anything that should be set/executed at 'admin_init' WP hook runtime should be put in here.  This will apply to
+	 * all pages/views loaded by child class.
+	 *
+	 * @abstract
+	 * @return void
+	 */
+	abstract public function admin_init();
+
+
+	/**
+	 * admin_notices
+	 * Anything triggered by the 'admin_notices' WP hook should be put in here.  This particular method will apply to
+	 * all pages/views loaded by child class.
+	 *
+	 * @abstract
+	 * @return void
+	 */
+	abstract public function admin_notices();
+
+
+	/**
+	 * admin_footer_scripts
+	 * Anything triggered by the 'admin_print_footer_scripts' WP hook should be put in here. This particular method
+	 * will apply to all pages/views loaded by child class.
+	 *
+	 * @return void
+	 */
+	abstract public function admin_footer_scripts();
+
+
+	/**
+	 * admin_footer
+	 * anything triggered by the 'admin_footer' WP action hook should be added to here. This particular method will
+	 * apply to all pages/views loaded by child class.
+	 *
+	 * @return void
+	 */
+	public function admin_footer()
+	{
+	}
+
+
+	/**
+	 * _global_ajax_hooks
+	 * all global add_action('wp_ajax_{name_of_hook}') hooks in here.
+	 * Note: within the ajax callback methods.
+	 *
+	 * @abstract
+	 * @return void
+	 */
+	protected function _global_ajax_hooks()
+	{
+		// for lazy loading of metabox content
+		add_action('wp_ajax_espresso-ajax-content', [$this, 'ajax_metabox_content'], 10);
+	}
+
+
+	public function ajax_metabox_content()
+	{
+		$content_id  = $this->request->getRequestParam('contentid', '');
+		$content_url = $this->request->getRequestParam('contenturl', '', 'url');
+		self::cached_rss_display($content_id, $content_url);
+		wp_die();
+	}
+
+
+	/**
+	 * allows extending classes do something specific before the parent constructor runs _page_setup().
+	 *
+	 * @return void
+	 */
+	protected function _before_page_setup()
+	{
+		// default is to do nothing
+	}
+
+
+	/**
+	 * Makes sure any things that need to be loaded early get handled.
+	 * We also escape early here if the page requested doesn't match the object.
+	 *
+	 * @final
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	final protected function _page_setup()
+	{
+		// requires?
+		// admin_init stuff - global - we're setting this REALLY early
+		// so if EE_Admin pages have to hook into other WP pages they can.
+		// But keep in mind, not everything is available from the EE_Admin Page object at this point.
+		add_action('admin_init', [$this, 'admin_init_global'], 5);
+		// next verify if we need to load anything...
+		$this->_current_page = $this->request->getRequestParam('page', '', 'key');
+		$this->_current_page = $this->request->getRequestParam('current_page', $this->_current_page, 'key');
+
+		$this->page_folder   = strtolower(
+			str_replace(['_Admin_Page', 'Extend_'], '', get_class($this))
+		);
+		global $ee_menu_slugs;
+		$ee_menu_slugs = (array) $ee_menu_slugs;
+		if (
+			! $this->request->isAjax()
+			&& (! $this->_current_page || ! isset($ee_menu_slugs[ $this->_current_page ]))
+		) {
+			return;
+		}
+		// because WP List tables have two duplicate select inputs for choosing bulk actions,
+		// we need to copy the action from the second to the first
+		$action     = $this->request->getRequestParam('action', '-1', 'key');
+		$action2    = $this->request->getRequestParam('action2', '-1', 'key');
+		$action     = $action !== '-1' ? $action : $action2;
+		$req_action = $action !== '-1' ? $action : 'default';
+
+		// if a specific 'route' has been set, and the action is 'default' OR we are doing_ajax
+		// then let's use the route as the action.
+		// This covers cases where we're coming in from a list table that isn't on the default route.
+		$route = $this->request->getRequestParam('route');
+		$this->_req_action = $route && ($req_action === 'default' || $this->request->isAjax())
+			? $route
+			: $req_action;
+
+		$this->_current_view = $this->_req_action;
+		$this->_req_nonce    = $this->_req_action . '_nonce';
+		$this->_define_page_props();
+		$this->_current_page_view_url = add_query_arg(
+			['page' => $this->_current_page, 'action' => $this->_current_view],
+			$this->_admin_base_url
+		);
+		// default things
+		$this->_default_espresso_metaboxes = [
+			'_espresso_news_post_box',
+			'_espresso_links_post_box',
+			'_espresso_ratings_request',
+			'_espresso_sponsors_post_box',
+		];
+		// set page configs
+		$this->_set_page_routes();
+		$this->_set_page_config();
+		// let's include any referrer data in our default_query_args for this route for "stickiness".
+		if ($this->request->requestParamIsSet('wp_referer')) {
+			$wp_referer = $this->request->getRequestParam('wp_referer');
+			if ($wp_referer) {
+				$this->_default_route_query_args['wp_referer'] = $wp_referer;
+			}
+		}
+		// for caffeinated and other extended functionality.
+		//  If there is a _extend_page_config method
+		// then let's run that to modify the all the various page configuration arrays
+		if (method_exists($this, '_extend_page_config')) {
+			$this->_extend_page_config();
+		}
+		// for CPT and other extended functionality.
+		// If there is an _extend_page_config_for_cpt
+		// then let's run that to modify all the various page configuration arrays.
+		if (method_exists($this, '_extend_page_config_for_cpt')) {
+			$this->_extend_page_config_for_cpt();
+		}
+		// filter routes and page_config so addons can add their stuff. Filtering done per class
+		$this->_page_routes = apply_filters(
+			'FHEE__' . get_class($this) . '__page_setup__page_routes',
+			$this->_page_routes,
+			$this
+		);
+		$this->_page_config = apply_filters(
+			'FHEE__' . get_class($this) . '__page_setup__page_config',
+			$this->_page_config,
+			$this
+		);
+		// if AHEE__EE_Admin_Page__route_admin_request_$this->_current_view method is present
+		// then we call it hooked into the AHEE__EE_Admin_Page__route_admin_request action
+		if (method_exists($this, 'AHEE__EE_Admin_Page__route_admin_request_' . $this->_current_view)) {
+			add_action(
+				'AHEE__EE_Admin_Page__route_admin_request',
+				[$this, 'AHEE__EE_Admin_Page__route_admin_request_' . $this->_current_view],
+				10,
+				2
+			);
+		}
+		// next route only if routing enabled
+		if ($this->_routing && ! $this->request->isAjax()) {
+			$this->_verify_routes();
+			// next let's just check user_access and kill if no access
+			$this->check_user_access();
+			if ($this->_is_UI_request) {
+				// admin_init stuff - global, all views for this page class, specific view
+				add_action('admin_init', [$this, 'admin_init'], 10);
+				if (method_exists($this, 'admin_init_' . $this->_current_view)) {
+					add_action('admin_init', [$this, 'admin_init_' . $this->_current_view], 15);
+				}
+			} else {
+				// hijack regular WP loading and route admin request immediately
+				@ini_set('memory_limit', apply_filters('admin_memory_limit', WP_MAX_MEMORY_LIMIT));
+				$this->route_admin_request();
+			}
+		}
+	}
+
+
+	/**
+	 * Provides a way for related child admin pages to load stuff on the loaded admin page.
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private function _do_other_page_hooks()
+	{
+		$registered_pages = apply_filters('FHEE_do_other_page_hooks_' . $this->page_slug, []);
+		foreach ($registered_pages as $page) {
+			// now let's setup the file name and class that should be present
+			$classname = str_replace('.class.php', '', $page);
+			// autoloaders should take care of loading file
+			if (! class_exists($classname)) {
+				$error_msg[] = sprintf(
+					esc_html__(
+						'Something went wrong with loading the %s admin hooks page.',
+						'event_espresso'
+					),
+					$page
+				);
+				$error_msg[] = $error_msg[0]
+							   . "\r\n"
+							   . sprintf(
+								   esc_html__(
+									   'There is no class in place for the %1$s admin hooks page.%2$sMake sure you have %3$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'
+								   ),
+								   $page,
+								   '<br />',
+								   '<strong>' . $classname . '</strong>'
+							   );
+				throw new EE_Error(implode('||', $error_msg));
+			}
+			// notice we are passing the instance of this class to the hook object.
+			$this->loader->getShared($classname, [$this]);
+		}
+	}
+
+
+	/**
+	 * @throws ReflectionException
+	 * @throws EE_Error
+	 */
+	public function load_page_dependencies()
+	{
+		try {
+			$this->_load_page_dependencies();
+		} catch (EE_Error $e) {
+			$e->get_error();
+		}
+	}
+
+
+	/**
+	 * load_page_dependencies
+	 * loads things specific to this page class when its loaded.  Really helps with efficiency.
+	 *
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _load_page_dependencies()
+	{
+		// let's set the current_screen and screen options to override what WP set
+		$this->_current_screen = get_current_screen();
+		// load admin_notices - global, page class, and view specific
+		add_action('admin_notices', [$this, 'admin_notices_global'], 5);
+		add_action('admin_notices', [$this, 'admin_notices'], 10);
+		if (method_exists($this, 'admin_notices_' . $this->_current_view)) {
+			add_action('admin_notices', [$this, 'admin_notices_' . $this->_current_view], 15);
+		}
+		// load network admin_notices - global, page class, and view specific
+		add_action('network_admin_notices', [$this, 'network_admin_notices_global'], 5);
+		if (method_exists($this, 'network_admin_notices_' . $this->_current_view)) {
+			add_action('network_admin_notices', [$this, 'network_admin_notices_' . $this->_current_view]);
+		}
+		// this will save any per_page screen options if they are present
+		$this->_set_per_page_screen_options();
+		// setup list table properties
+		$this->_set_list_table();
+		// child classes can "register" a metabox to be automatically handled via the _page_config array property.
+		// However in some cases the metaboxes will need to be added within a route handling callback.
+		$this->_add_registered_meta_boxes();
+		$this->_add_screen_columns();
+		// add screen options - global, page child class, and view specific
+		$this->_add_global_screen_options();
+		$this->_add_screen_options();
+		$add_screen_options = "_add_screen_options_{$this->_current_view}";
+		if (method_exists($this, $add_screen_options)) {
+			$this->{$add_screen_options}();
+		}
+		// add help tab(s) - set via page_config and qtips.
+		$this->_add_help_tabs();
+		$this->_add_qtips();
+		// add feature_pointers - global, page child class, and view specific
+		$this->_add_feature_pointers();
+		$this->_add_global_feature_pointers();
+		$add_feature_pointer = "_add_feature_pointer_{$this->_current_view}";
+		if (method_exists($this, $add_feature_pointer)) {
+			$this->{$add_feature_pointer}();
+		}
+		// enqueue scripts/styles - global, page class, and view specific
+		add_action('admin_enqueue_scripts', [$this, 'load_global_scripts_styles'], 5);
+		add_action('admin_enqueue_scripts', [$this, 'load_scripts_styles'], 10);
+		if (method_exists($this, "load_scripts_styles_{$this->_current_view}")) {
+			add_action('admin_enqueue_scripts', [$this, "load_scripts_styles_{$this->_current_view}"], 15);
+		}
+		add_action('admin_enqueue_scripts', [$this, 'admin_footer_scripts_eei18n_js_strings'], 100);
+		// admin_print_footer_scripts - global, page child class, and view specific.
+		// NOTE, despite the name, whenever possible, scripts should NOT be loaded using this.
+		// In most cases that's doing_it_wrong().  But adding hidden container elements etc.
+		// is a good use case. Notice the late priority we're giving these
+		add_action('admin_print_footer_scripts', [$this, 'admin_footer_scripts_global'], 99);
+		add_action('admin_print_footer_scripts', [$this, 'admin_footer_scripts'], 100);
+		if (method_exists($this, "admin_footer_scripts_{$this->_current_view}")) {
+			add_action('admin_print_footer_scripts', [$this, "admin_footer_scripts_{$this->_current_view}"], 101);
+		}
+		// admin footer scripts
+		add_action('admin_footer', [$this, 'admin_footer_global'], 99);
+		add_action('admin_footer', [$this, 'admin_footer'], 100);
+		if (method_exists($this, "admin_footer_{$this->_current_view}")) {
+			add_action('admin_footer', [$this, "admin_footer_{$this->_current_view}"], 101);
+		}
+		do_action('FHEE__EE_Admin_Page___load_page_dependencies__after_load', $this->page_slug);
+		// targeted hook
+		do_action(
+			"FHEE__EE_Admin_Page___load_page_dependencies__after_load__{$this->page_slug}__{$this->_req_action}"
+		);
+	}
+
+
+	/**
+	 * _set_defaults
+	 * This sets some global defaults for class properties.
+	 */
+	private function _set_defaults()
+	{
+		$this->_current_screen       = $this->_admin_page_title = $this->_req_action = $this->_req_nonce = null;
+		$this->_event                = $this->_template_path = $this->_column_template_path = null;
+		$this->_nav_tabs             = $this->_views = $this->_page_routes = [];
+		$this->_page_config          = $this->_default_route_query_args = [];
+		$this->_default_nav_tab_name = 'overview';
+		// init template args
+		$this->_template_args = [
+			'admin_page_header'  => '',
+			'admin_page_content' => '',
+			'post_body_content'  => '',
+			'before_list_table'  => '',
+			'after_list_table'   => '',
+		];
+	}
+
+
+	/**
+	 * route_admin_request
+	 *
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @see    _route_admin_request()
+	 */
+	public function route_admin_request()
+	{
+		try {
+			$this->_route_admin_request();
+		} catch (EE_Error $e) {
+			$e->get_error();
+		}
+	}
+
+
+	public function set_wp_page_slug($wp_page_slug)
+	{
+		$this->_wp_page_slug = $wp_page_slug;
+		// if in network admin then we need to append "-network" to the page slug. Why? Because that's how WP rolls...
+		if (is_network_admin()) {
+			$this->_wp_page_slug .= '-network';
+		}
+	}
+
+
+	/**
+	 * _verify_routes
+	 * All this method does is verify the incoming request and make sure that routes exist for it.  We do this early so
+	 * we know if we need to drop out.
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	protected function _verify_routes()
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		if (! $this->_current_page && ! $this->request->isAjax()) {
+			return false;
+		}
+		$this->_route = false;
+		// check that the page_routes array is not empty
+		if (empty($this->_page_routes)) {
+			// user error msg
+			$error_msg = sprintf(
+				esc_html__('No page routes have been set for the %s admin page.', 'event_espresso'),
+				$this->_admin_page_title
+			);
+			// developer error msg
+			$error_msg .= '||' . $error_msg
+						  . esc_html__(
+							  ' Make sure the "set_page_routes()" method exists, and is setting the "_page_routes" array properly.',
+							  'event_espresso'
+						  );
+			throw new EE_Error($error_msg);
+		}
+		// and that the requested page route exists
+		if (array_key_exists($this->_req_action, $this->_page_routes)) {
+			$this->_route        = $this->_page_routes[ $this->_req_action ];
+			$this->_route_config = isset($this->_page_config[ $this->_req_action ])
+				? $this->_page_config[ $this->_req_action ]
+				: [];
+		} else {
+			// user error msg
+			$error_msg = sprintf(
+				esc_html__(
+					'The requested page route does not exist for the %s admin page.',
+					'event_espresso'
+				),
+				$this->_admin_page_title
+			);
+			// developer error msg
+			$error_msg .= '||' . $error_msg
+						  . sprintf(
+							  esc_html__(
+								  ' Create a key in the "_page_routes" array named "%s" and set its value to the appropriate method.',
+								  'event_espresso'
+							  ),
+							  $this->_req_action
+						  );
+			throw new EE_Error($error_msg);
+		}
+		// and that a default route exists
+		if (! array_key_exists('default', $this->_page_routes)) {
+			// user error msg
+			$error_msg = sprintf(
+				esc_html__(
+					'A default page route has not been set for the % admin page.',
+					'event_espresso'
+				),
+				$this->_admin_page_title
+			);
+			// developer error msg
+			$error_msg .= '||' . $error_msg
+						  . esc_html__(
+							  ' Create a key in the "_page_routes" array named "default" and set its value to your default page method.',
+							  'event_espresso'
+						  );
+			throw new EE_Error($error_msg);
+		}
+		// first lets' catch if the UI request has EVER been set.
+		if ($this->_is_UI_request === null) {
+			// lets set if this is a UI request or not.
+			$this->_is_UI_request = ! $this->request->getRequestParam('noheader', false, 'bool');
+			// wait a minute... we might have a noheader in the route array
+			$this->_is_UI_request = ! (
+				is_array($this->_route) && isset($this->_route['noheader']) && $this->_route['noheader']
+			)
+				? $this->_is_UI_request
+				: false;
+		}
+		$this->_set_current_labels();
+		return true;
+	}
+
+
+	/**
+	 * this method simply verifies a given route and makes sure its an actual route available for the loaded page
+	 *
+	 * @param string $route the route name we're verifying
+	 * @return bool we'll throw an exception if this isn't a valid route.
+	 * @throws EE_Error
+	 */
+	protected function _verify_route($route)
+	{
+		if (array_key_exists($this->_req_action, $this->_page_routes)) {
+			return true;
+		}
+		// user error msg
+		$error_msg = sprintf(
+			esc_html__('The given page route does not exist for the %s admin page.', 'event_espresso'),
+			$this->_admin_page_title
+		);
+		// developer error msg
+		$error_msg .= '||' . $error_msg
+					  . sprintf(
+						  esc_html__(
+							  ' Check the route you are using in your method (%s) and make sure it matches a route set in your "_page_routes" array property',
+							  'event_espresso'
+						  ),
+						  $route
+					  );
+		throw new EE_Error($error_msg);
+	}
+
+
+	/**
+	 * perform nonce verification
+	 * This method has be encapsulated here so that any ajax requests that bypass normal routes can verify their nonces
+	 * using this method (and save retyping!)
+	 *
+	 * @param string $nonce     The nonce sent
+	 * @param string $nonce_ref The nonce reference string (name0)
+	 * @return void
+	 * @throws EE_Error
+	 */
+	protected function _verify_nonce($nonce, $nonce_ref)
+	{
+		// verify nonce against expected value
+		if (! wp_verify_nonce($nonce, $nonce_ref)) {
+			// these are not the droids you are looking for !!!
+			$msg = sprintf(
+				esc_html__('%sNonce Fail.%s', 'event_espresso'),
+				'<a href="https://www.youtube.com/watch?v=56_S0WeTkzs">',
+				'</a>'
+			);
+			if (WP_DEBUG) {
+				$msg .= "\n  ";
+				$msg .= sprintf(
+					esc_html__(
+						'In order to dynamically generate nonces for your actions, use the %s::add_query_args_and_nonce() method. May the Nonce be with you!',
+						'event_espresso'
+					),
+					__CLASS__
+				);
+			}
+			if (! $this->request->isAjax()) {
+				wp_die($msg);
+			}
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			$this->_return_json();
+		}
+	}
+
+
+	/**
+	 * _route_admin_request()
+	 * Meat and potatoes of the class.  Basically, this dude checks out what's being requested and sees if theres are
+	 * some doodads to work the magic and handle the flingjangy. Translation:  Checks if the requested action is listed
+	 * in the page routes and then will try to load the corresponding method.
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _route_admin_request()
+	{
+		if (! $this->_is_UI_request) {
+			$this->_verify_routes();
+		}
+		$nonce_check = ! isset($this->_route_config['require_nonce']) || $this->_route_config['require_nonce'];
+		if ($this->_req_action !== 'default' && $nonce_check) {
+			// set nonce from post data
+			$nonce = $this->request->getRequestParam($this->_req_nonce, '');
+			$this->_verify_nonce($nonce, $this->_req_nonce);
+		}
+		// set the nav_tabs array but ONLY if this is  UI_request
+		if ($this->_is_UI_request) {
+			$this->_set_nav_tabs();
+		}
+		// grab callback function
+		$func = is_array($this->_route) ? $this->_route['func'] : $this->_route;
+		// check if callback has args
+		$args      = is_array($this->_route) && isset($this->_route['args']) ? $this->_route['args'] : [];
+		$error_msg = '';
+		// action right before calling route
+		// (hook is something like 'AHEE__Registrations_Admin_Page__route_admin_request')
+		if (! did_action('AHEE__EE_Admin_Page__route_admin_request')) {
+			do_action('AHEE__EE_Admin_Page__route_admin_request', $this->_current_view, $this);
+		}
+		// right before calling the route, let's clean the _wp_http_referer
+		$this->request->unSetRequestParam('_wp_http_referer');
+		$this->request->unSetServerParam('_wp_http_referer');
+		$cleaner_request_uri = remove_query_arg(
+			'_wp_http_referer',
+			wp_unslash($this->request->getServerParam('REQUEST_URI'))
+		);
+		$this->request->setRequestParam('_wp_http_referer', $cleaner_request_uri);
+		$this->request->setServerParam('REQUEST_URI', $cleaner_request_uri);
+		if (! empty($func)) {
+			if (is_array($func)) {
+				[$class, $method] = $func;
+			} elseif (strpos($func, '::') !== false) {
+				[$class, $method] = explode('::', $func);
+			} else {
+				$class  = $this;
+				$method = $func;
+			}
+			if (! (is_object($class) && $class === $this) && ! in_array($this, $args)) {
+				// send along this admin page object for access by addons.
+				$args['admin_page'] = $this;
+			}
+			if (
+				// is it a method on a class that doesn't work?
+				(
+					(
+						method_exists($class, $method)
+						&& call_user_func_array([$class, $method], $args) === false
+					)
+					&& (
+						// is it a standalone function that doesn't work?
+						function_exists($method)
+						&& call_user_func_array(
+							$func,
+							array_merge(['admin_page' => $this], $args)
+						) === false
+					)
+				)
+				|| (
+					// is it neither a class method NOR a standalone function?
+					! method_exists($class, $method)
+					&& ! function_exists($method)
+				)
+			) {
+				// user error msg
+				$error_msg = esc_html__(
+					'An error occurred. The  requested page route could not be found.',
+					'event_espresso'
+				);
+				// developer error msg
+				$error_msg .= '||';
+				$error_msg .= sprintf(
+					esc_html__(
+						'Page route "%s" could not be called. Check that the spelling for method names and actions in the "_page_routes" array are all correct.',
+						'event_espresso'
+					),
+					$method
+				);
+			}
+			if (! empty($error_msg)) {
+				throw new EE_Error($error_msg);
+			}
+		}
+		// if we've routed and this route has a no headers route AND a sent_headers_route,
+		// then we need to reset the routing properties to the new route.
+		// now if UI request is FALSE and noheader is true AND we have a headers_sent_route in the route array then let's set UI_request to true because the no header route has a second func after headers have been sent.
+		if (
+			$this->_is_UI_request === false
+			&& is_array($this->_route)
+			&& ! empty($this->_route['headers_sent_route'])
+		) {
+			$this->_reset_routing_properties($this->_route['headers_sent_route']);
+		}
+	}
+
+
+	/**
+	 * This method just allows the resetting of page properties in the case where a no headers
+	 * route redirects to a headers route in its route config.
+	 *
+	 * @param string $new_route New (non header) route to redirect to.
+	 * @return   void
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @since   4.3.0
+	 */
+	protected function _reset_routing_properties($new_route)
+	{
+		$this->_is_UI_request = true;
+		// now we set the current route to whatever the headers_sent_route is set at
+		$this->request->setRequestParam('action', $new_route);
+		// rerun page setup
+		$this->_page_setup();
+	}
+
+
+	/**
+	 * _add_query_arg
+	 * adds nonce to array of arguments then calls WP add_query_arg function
+	 *(internally just uses EEH_URL's function with the same name)
+	 *
+	 * @param array  $args
+	 * @param string $url
+	 * @param bool   $sticky                  if true, then the existing Request params will be appended to the
+	 *                                        generated url in an associative array indexed by the key 'wp_referer';
+	 *                                        Example usage: If the current page is:
+	 *                                        http://mydomain.com/wp-admin/admin.php?page=espresso_registrations
+	 *                                        &action=default&event_id=20&month_range=March%202015
+	 *                                        &_wpnonce=5467821
+	 *                                        and you call:
+	 *                                        EE_Admin_Page::add_query_args_and_nonce(
+	 *                                        array(
+	 *                                        'action' => 'resend_something',
+	 *                                        'page=>espresso_registrations'
+	 *                                        ),
+	 *                                        $some_url,
+	 *                                        true
+	 *                                        );
+	 *                                        It will produce a url in this structure:
+	 *                                        http://{$some_url}/?page=espresso_registrations&action=resend_something
+	 *                                        &wp_referer[action]=default&wp_referer[event_id]=20&wpreferer[
+	 *                                        month_range]=March%202015
+	 * @param bool   $exclude_nonce           If true, the the nonce will be excluded from the generated nonce.
+	 * @return string
+	 */
+	public static function add_query_args_and_nonce(
+		$args = [],
+		$url = false,
+		$sticky = false,
+		$exclude_nonce = false
+	) {
+		// if there is a _wp_http_referer include the values from the request but only if sticky = true
+		if ($sticky) {
+			/** @var RequestInterface $request */
+			$request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
+			$request->unSetRequestParams(['_wp_http_referer', 'wp_referer'], true);
+			foreach ($request->requestParams() as $key => $value) {
+				// do not add nonces
+				if (strpos($key, 'nonce') !== false) {
+					continue;
+				}
+				$args[ 'wp_referer[' . $key . ']' ] = is_string($value) ? htmlspecialchars($value) : $value;
+			}
+		}
+		return EEH_URL::add_query_args_and_nonce($args, $url, $exclude_nonce);
+	}
+
+
+	/**
+	 * This returns a generated link that will load the related help tab.
+	 *
+	 * @param string $help_tab_id the id for the connected help tab
+	 * @param string $icon_style  (optional) include css class for the style you want to use for the help icon.
+	 * @param string $help_text   (optional) send help text you want to use for the link if default not to be used
+	 * @return string              generated link
+	 * @uses EEH_Template::get_help_tab_link()
+	 */
+	protected function _get_help_tab_link($help_tab_id, $icon_style = '', $help_text = '')
+	{
+		return EEH_Template::get_help_tab_link(
+			$help_tab_id,
+			$this->page_slug,
+			$this->_req_action,
+			$icon_style,
+			$help_text
+		);
+	}
+
+
+	/**
+	 * _add_help_tabs
+	 * Note child classes define their help tabs within the page_config array.
+	 *
+	 * @link   http://codex.wordpress.org/Function_Reference/add_help_tab
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	protected function _add_help_tabs()
+	{
+		if (isset($this->_page_config[ $this->_req_action ])) {
+			$config = $this->_page_config[ $this->_req_action ];
+			// let's see if there is a help_sidebar set for the current route and we'll set that up for usage as well.
+			if (is_array($config) && isset($config['help_sidebar'])) {
+				// check that the callback given is valid
+				if (! method_exists($this, $config['help_sidebar'])) {
+					throw new EE_Error(
+						sprintf(
+							esc_html__(
+								'The _page_config array has a callback set for the "help_sidebar" option.  However the callback given (%s) is not a valid callback.  Doublecheck the spelling and make sure this method exists for the class %s',
+								'event_espresso'
+							),
+							$config['help_sidebar'],
+							get_class($this)
+						)
+					);
+				}
+				$content = apply_filters(
+					'FHEE__' . get_class($this) . '__add_help_tabs__help_sidebar',
+					$this->{$config['help_sidebar']}()
+				);
+				$this->_current_screen->set_help_sidebar($content);
+			}
+			if (! isset($config['help_tabs'])) {
+				return;
+			} //no help tabs for this route
+			foreach ((array) $config['help_tabs'] as $tab_id => $cfg) {
+				// we're here so there ARE help tabs!
+				// make sure we've got what we need
+				if (! isset($cfg['title'])) {
+					throw new EE_Error(
+						esc_html__(
+							'The _page_config array is not set up properly for help tabs.  It is missing a title',
+							'event_espresso'
+						)
+					);
+				}
+				if (! isset($cfg['filename']) && ! isset($cfg['callback']) && ! isset($cfg['content'])) {
+					throw new EE_Error(
+						esc_html__(
+							'The _page_config array is not setup properly for help tabs. It is missing a either a filename reference, or a callback reference or a content reference so there is no way to know the content for the help tab',
+							'event_espresso'
+						)
+					);
+				}
+				// first priority goes to content.
+				if (! empty($cfg['content'])) {
+					$content = ! empty($cfg['content']) ? $cfg['content'] : null;
+					// second priority goes to filename
+				} elseif (! empty($cfg['filename'])) {
+					$file_path = $this->_get_dir() . '/help_tabs/' . $cfg['filename'] . '.help_tab.php';
+					// it's possible that the file is located on decaf route (and above sets up for caf route, if this is the case then lets check decaf route too)
+					$file_path = ! is_readable($file_path) ? EE_ADMIN_PAGES
+															 . basename($this->_get_dir())
+															 . '/help_tabs/'
+															 . $cfg['filename']
+															 . '.help_tab.php' : $file_path;
+					// if file is STILL not readable then let's do a EE_Error so its more graceful than a fatal error.
+					if (! isset($cfg['callback']) && ! is_readable($file_path)) {
+						EE_Error::add_error(
+							sprintf(
+								esc_html__(
+									'The filename given for the help tab %s is not a valid file and there is no other configuration for the tab content.  Please check that the string you set for the help tab on this route (%s) is the correct spelling.  The file should be in %s',
+									'event_espresso'
+								),
+								$tab_id,
+								key($config),
+								$file_path
+							),
+							__FILE__,
+							__FUNCTION__,
+							__LINE__
+						);
+						return;
+					}
+					$template_args['admin_page_obj'] = $this;
+					$content                         = EEH_Template::display_template(
+						$file_path,
+						$template_args,
+						true
+					);
+				} else {
+					$content = '';
+				}
+				// check if callback is valid
+				if (
+					empty($content)
+					&& (
+						! isset($cfg['callback']) || ! method_exists($this, $cfg['callback'])
+					)
+				) {
+					EE_Error::add_error(
+						sprintf(
+							esc_html__(
+								'The callback given for a %s help tab on this page does not content OR a corresponding method for generating the content.  Check the spelling or make sure the method is present.',
+								'event_espresso'
+							),
+							$cfg['title']
+						),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+					return;
+				}
+				// setup config array for help tab method
+				$id  = $this->page_slug . '-' . $this->_req_action . '-' . $tab_id;
+				$_ht = [
+					'id'       => $id,
+					'title'    => $cfg['title'],
+					'callback' => isset($cfg['callback']) && empty($content) ? [$this, $cfg['callback']] : null,
+					'content'  => $content,
+				];
+				$this->_current_screen->add_help_tab($_ht);
+			}
+		}
+	}
+
+
+	/**
+	 * This simply sets up any qtips that have been defined in the page config
+	 *
+	 * @return void
+	 */
+	protected function _add_qtips()
+	{
+		if (isset($this->_route_config['qtips'])) {
+			$qtips = (array) $this->_route_config['qtips'];
+			// load qtip loader
+			$path = [
+				$this->_get_dir() . '/qtips/',
+				EE_ADMIN_PAGES . basename($this->_get_dir()) . '/qtips/',
+			];
+			EEH_Qtip_Loader::instance()->register($qtips, $path);
+		}
+	}
+
+
+	/**
+	 * _set_nav_tabs
+	 * This sets up the nav tabs from the page_routes array.  This method can be overwritten by child classes if you
+	 * wish to add additional tabs or modify accordingly.
+	 *
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	protected function _set_nav_tabs()
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$i = 0;
+		foreach ($this->_page_config as $slug => $config) {
+			if (! is_array($config) || empty($config['nav'])) {
+				continue;
+			}
+			// no nav tab for this config
+			// check for persistent flag
+			if ($slug !== $this->_req_action && isset($config['nav']['persistent']) && ! $config['nav']['persistent']) {
+				// nav tab is only to appear when route requested.
+				continue;
+			}
+			if (! $this->check_user_access($slug, true)) {
+				// no nav tab because current user does not have access.
+				continue;
+			}
+			$css_class                = isset($config['css_class']) ? $config['css_class'] . ' ' : '';
+			$this->_nav_tabs[ $slug ] = [
+				'url'       => isset($config['nav']['url'])
+					? $config['nav']['url']
+					: self::add_query_args_and_nonce(
+						['action' => $slug],
+						$this->_admin_base_url
+					),
+				'link_text' => isset($config['nav']['label'])
+					? $config['nav']['label']
+					: ucwords(
+						str_replace('_', ' ', $slug)
+					),
+				'css_class' => $this->_req_action === $slug ? $css_class . 'nav-tab-active' : $css_class,
+				'order'     => isset($config['nav']['order']) ? $config['nav']['order'] : $i,
+			];
+			$i++;
+		}
+		// if $this->_nav_tabs is empty then lets set the default
+		if (empty($this->_nav_tabs)) {
+			$this->_nav_tabs[ $this->_default_nav_tab_name ] = [
+				'url'       => $this->_admin_base_url,
+				'link_text' => ucwords(str_replace('_', ' ', $this->_default_nav_tab_name)),
+				'css_class' => 'nav-tab-active',
+				'order'     => 10,
+			];
+		}
+		// now let's sort the tabs according to order
+		usort($this->_nav_tabs, [$this, '_sort_nav_tabs']);
+	}
+
+
+	/**
+	 * _set_current_labels
+	 * This method modifies the _labels property with any optional specific labels indicated in the _page_routes
+	 * property array
+	 *
+	 * @return void
+	 */
+	private function _set_current_labels()
+	{
+		if (is_array($this->_route_config) && isset($this->_route_config['labels'])) {
+			foreach ($this->_route_config['labels'] as $label => $text) {
+				if (is_array($text)) {
+					foreach ($text as $sublabel => $subtext) {
+						$this->_labels[ $label ][ $sublabel ] = $subtext;
+					}
+				} else {
+					$this->_labels[ $label ] = $text;
+				}
+			}
+		}
+	}
+
+
+	/**
+	 *        verifies user access for this admin page
+	 *
+	 * @param string $route_to_check if present then the capability for the route matching this string is checked.
+	 * @param bool   $verify_only    Default is FALSE which means if user check fails then wp_die().  Otherwise just
+	 *                               return false if verify fail.
+	 * @return bool
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function check_user_access($route_to_check = '', $verify_only = false)
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$route_to_check = empty($route_to_check) ? $this->_req_action : $route_to_check;
+		$capability     = ! empty($route_to_check) && isset($this->_page_routes[ $route_to_check ])
+						  && is_array(
+							  $this->_page_routes[ $route_to_check ]
+						  )
+						  && ! empty($this->_page_routes[ $route_to_check ]['capability'])
+			? $this->_page_routes[ $route_to_check ]['capability'] : null;
+		if (empty($capability) && empty($route_to_check)) {
+			$capability = is_array($this->_route) && empty($this->_route['capability']) ? 'manage_options'
+				: $this->_route['capability'];
+		} else {
+			$capability = empty($capability) ? 'manage_options' : $capability;
+		}
+		$id = is_array($this->_route) && ! empty($this->_route['obj_id']) ? $this->_route['obj_id'] : 0;
+		if (
+			! $this->request->isAjax()
+			&& (
+				! function_exists('is_admin')
+				|| ! EE_Registry::instance()->CAP->current_user_can(
+					$capability,
+					$this->page_slug
+					. '_'
+					. $route_to_check,
+					$id
+				)
+			)
+		) {
+			if ($verify_only) {
+				return false;
+			}
+			if (is_user_logged_in()) {
+				wp_die(esc_html__('You do not have access to this route.', 'event_espresso'));
+			} else {
+				return false;
+			}
+		}
+		return true;
+	}
+
+
+	/**
+	 * admin_init_global
+	 * This runs all the code that we want executed within the WP admin_init hook.
+	 * This method executes for ALL EE Admin pages.
+	 *
+	 * @return void
+	 */
+	public function admin_init_global()
+	{
+	}
+
+
+	/**
+	 * wp_loaded_global
+	 * This runs all the code that we want executed within the WP wp_loaded hook.  This method is optional for an
+	 * EE_Admin page and will execute on every EE Admin Page load
+	 *
+	 * @return void
+	 */
+	public function wp_loaded()
+	{
+	}
+
+
+	/**
+	 * admin_notices
+	 * Anything triggered by the 'admin_notices' WP hook should be put in here.  This particular method will apply on
+	 * ALL EE_Admin pages.
+	 *
+	 * @return void
+	 */
+	public function admin_notices_global()
+	{
+		$this->_display_no_javascript_warning();
+		$this->_display_espresso_notices();
+	}
+
+
+	public function network_admin_notices_global()
+	{
+		$this->_display_no_javascript_warning();
+		$this->_display_espresso_notices();
+	}
+
+
+	/**
+	 * admin_footer_scripts_global
+	 * Anything triggered by the 'admin_print_footer_scripts' WP hook should be put in here. This particular method
+	 * will apply on ALL EE_Admin pages.
+	 *
+	 * @return void
+	 */
+	public function admin_footer_scripts_global()
+	{
+		$this->_add_admin_page_ajax_loading_img();
+		$this->_add_admin_page_overlay();
+		// if metaboxes are present we need to add the nonce field
+		if (
+			isset($this->_route_config['metaboxes'])
+			|| isset($this->_route_config['list_table'])
+			|| (isset($this->_route_config['has_metaboxes']) && $this->_route_config['has_metaboxes'])
+		) {
+			wp_nonce_field('closedpostboxes', 'closedpostboxesnonce', false);
+			wp_nonce_field('meta-box-order', 'meta-box-order-nonce', false);
+		}
+	}
+
+
+	/**
+	 * admin_footer_global
+	 * Anything triggered by the wp 'admin_footer' wp hook should be put in here. This particular method will apply on
+	 * ALL EE_Admin Pages.
+	 *
+	 * @return void
+	 */
+	public function admin_footer_global()
+	{
+		// dialog container for dialog helper
+		echo '
         <div class="ee-admin-dialog-container auto-hide hidden">
             <div class="ee-notices"></div>
             <div class="ee-admin-dialog-container-inner-content"></div>
         </div>
         ';
 
-        // current set timezone for timezone js
-        echo '<span id="current_timezone" class="hidden">' . esc_html(EEH_DTT_Helper::get_timezone()) . '</span>';
-    }
-
-
-    /**
-     * This function sees if there is a method for help popup content existing for the given route.  If there is then
-     * we'll use the retrieved array to output the content using the template. For child classes: If you want to have
-     * help popups then in your templates or your content you set "triggers" for the content using the
-     * "_set_help_trigger('help_trigger_id')" where "help_trigger_id" is what you will use later in your custom method
-     * for the help popup content on that page. Then in your Child_Admin_Page class you need to define a help popup
-     * method for the content in the format "_help_popup_content_{route_name}()"  So if you are setting help content
-     * for the
-     * 'edit_event' route you should have a method named "_help_popup_content_edit_route". In your defined
-     * "help_popup_content_..." method.  You must prepare and return an array in the following format array(
-     *    'help_trigger_id' => array(
-     *        'title' => esc_html__('localized title for popup', 'event_espresso'),
-     *        'content' => esc_html__('localized content for popup', 'event_espresso')
-     *    )
-     * );
-     * Then the EE_Admin_Parent will take care of making sure that is setup properly on the correct route.
-     *
-     * @param array $help_array
-     * @param bool  $display
-     * @return string content
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    protected function _set_help_popup_content($help_array = [], $display = false)
-    {
-        $content    = '';
-        $help_array = empty($help_array) ? $this->_get_help_content() : $help_array;
-        // loop through the array and setup content
-        foreach ($help_array as $trigger => $help) {
-            // make sure the array is setup properly
-            if (! isset($help['title']) || ! isset($help['content'])) {
-                throw new EE_Error(
-                    esc_html__(
-                        'Does not look like the popup content array has been setup correctly.  Might want to double check that.  Read the comments for the _get_help_popup_content method found in "EE_Admin_Page" class',
-                        'event_espresso'
-                    )
-                );
-            }
-            // we're good so let's setup the template vars and then assign parsed template content to our content.
-            $template_args = [
-                'help_popup_id'      => $trigger,
-                'help_popup_title'   => $help['title'],
-                'help_popup_content' => $help['content'],
-            ];
-            $content       .= EEH_Template::display_template(
-                EE_ADMIN_TEMPLATE . 'admin_help_popup.template.php',
-                $template_args,
-                true
-            );
-        }
-        if ($display) {
-            echo wp_kses($content, AllowedTags::getWithFormTags());
-            return '';
-        }
-        return $content;
-    }
-
-
-    /**
-     * All this does is retrieve the help content array if set by the EE_Admin_Page child
-     *
-     * @return array properly formatted array for help popup content
-     * @throws EE_Error
-     */
-    private function _get_help_content()
-    {
-        // what is the method we're looking for?
-        $method_name = '_help_popup_content_' . $this->_req_action;
-        // if method doesn't exist let's get out.
-        if (! method_exists($this, $method_name)) {
-            return [];
-        }
-        // k we're good to go let's retrieve the help array
-        $help_array = call_user_func([$this, $method_name]);
-        // make sure we've got an array!
-        if (! is_array($help_array)) {
-            throw new EE_Error(
-                esc_html__(
-                    'Something went wrong with help popup content generation. Expecting an array and well, this ain\'t no array bub.',
-                    'event_espresso'
-                )
-            );
-        }
-        return $help_array;
-    }
-
-
-    /**
-     * EE Admin Pages can use this to set a properly formatted trigger for a help popup.
-     * By default the trigger html is printed.  Otherwise it can be returned if the $display flag is set "false"
-     * See comments made on the _set_help_content method for understanding other parts to the help popup tool.
-     *
-     * @param string  $trigger_id reference for retrieving the trigger content for the popup
-     * @param boolean $display    if false then we return the trigger string
-     * @param array   $dimensions an array of dimensions for the box (array(h,w))
-     * @return string
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    protected function _set_help_trigger($trigger_id, $display = true, $dimensions = ['400', '640'])
-    {
-        if ($this->request->isAjax()) {
-            return '';
-        }
-        // let's check and see if there is any content set for this popup.  If there isn't then we'll include a default title and content so that developers know something needs to be corrected
-        $help_array   = $this->_get_help_content();
-        $help_content = '';
-        if (empty($help_array) || ! isset($help_array[ $trigger_id ])) {
-            $help_array[ $trigger_id ] = [
-                'title'   => esc_html__('Missing Content', 'event_espresso'),
-                'content' => esc_html__(
-                    'A trigger has been set that doesn\'t have any corresponding content. Make sure you have set the help content. (see the "_set_help_popup_content" method in the EE_Admin_Page for instructions.)',
-                    'event_espresso'
-                ),
-            ];
-            $help_content              = $this->_set_help_popup_content($help_array);
-        }
-        // let's setup the trigger
-        $content = '<a class="ee-dialog" href="?height='
-                   . esc_attr($dimensions[0])
-                   . '&width='
-                   . esc_attr($dimensions[1])
-                   . '&inlineId='
-                   . esc_attr($trigger_id)
-                   . '" target="_blank"><span class="question ee-help-popup-question"></span></a>';
-        $content .= $help_content;
-        if ($display) {
-            echo wp_kses($content, AllowedTags::getWithFormTags());
-            return '';
-        }
-        return $content;
-    }
-
-
-    /**
-     * _add_global_screen_options
-     * Add any extra wp_screen_options within this method using built-in WP functions/methods for doing so.
-     * This particular method will add_screen_options on ALL EE_Admin Pages
-     *
-     * @link   http://chrismarslender.com/wp-tutorials/wordpress-screen-options-tutorial/
-     *         see also WP_Screen object documents...
-     * @link   http://codex.wordpress.org/Class_Reference/WP_Screen
-     * @abstract
-     * @return void
-     */
-    private function _add_global_screen_options()
-    {
-    }
-
-
-    /**
-     * _add_global_feature_pointers
-     * This method is used for implementing any "feature pointers" (using built-in WP styling js).
-     * This particular method will implement feature pointers for ALL EE_Admin pages.
-     * Note: this is just a placeholder for now.  Implementation will come down the road
-     *
-     * @see    WP_Internal_Pointers class in wp-admin/includes/template.php for example (its a final class so can't be
-     *         extended) also see:
-     * @link   http://eamann.com/tech/wordpress-portland/
-     * @abstract
-     * @return void
-     */
-    private function _add_global_feature_pointers()
-    {
-    }
-
-
-    /**
-     * load_global_scripts_styles
-     * The scripts and styles enqueued in here will be loaded on every EE Admin page
-     *
-     * @return void
-     */
-    public function load_global_scripts_styles()
-    {
-        /** STYLES **/
-        // add debugging styles
-        if (WP_DEBUG) {
-            add_action('admin_head', [$this, 'add_xdebug_style']);
-        }
-        // register all styles
-        wp_register_style(
-            'espresso-ui-theme',
-            EE_GLOBAL_ASSETS_URL . 'css/espresso-ui-theme/jquery-ui-1.10.3.custom.min.css',
-            [],
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_register_style('ee-admin-css', EE_ADMIN_URL . 'assets/ee-admin-page.css', [], EVENT_ESPRESSO_VERSION);
-        // helpers styles
-        wp_register_style(
-            'ee-text-links',
-            EE_PLUGIN_DIR_URL . 'core/helpers/assets/ee_text_list_helper.css',
-            [],
-            EVENT_ESPRESSO_VERSION
-        );
-        /** SCRIPTS **/
-        // register all scripts
-        wp_register_script(
-            'ee-dialog',
-            EE_ADMIN_URL . 'assets/ee-dialog-helper.js',
-            ['jquery', 'jquery-ui-draggable'],
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_register_script(
-            'ee_admin_js',
-            EE_ADMIN_URL . 'assets/ee-admin-page.js',
-            ['espresso_core', 'ee-parse-uri', 'ee-dialog'],
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_register_script(
-            'jquery-ui-timepicker-addon',
-            EE_GLOBAL_ASSETS_URL . 'scripts/jquery-ui-timepicker-addon.js',
-            ['jquery-ui-datepicker', 'jquery-ui-slider'],
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        // script for sorting tables
-        wp_register_script(
-            'espresso_ajax_table_sorting',
-            EE_ADMIN_URL . 'assets/espresso_ajax_table_sorting.js',
-            ['ee_admin_js', 'jquery-ui-sortable'],
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        // script for parsing uri's
-        wp_register_script(
-            'ee-parse-uri',
-            EE_GLOBAL_ASSETS_URL . 'scripts/parseuri.js',
-            [],
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        // and parsing associative serialized form elements
-        wp_register_script(
-            'ee-serialize-full-array',
-            EE_GLOBAL_ASSETS_URL . 'scripts/jquery.serializefullarray.js',
-            ['jquery'],
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        // helpers scripts
-        wp_register_script(
-            'ee-text-links',
-            EE_PLUGIN_DIR_URL . 'core/helpers/assets/ee_text_list_helper.js',
-            ['jquery'],
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_register_script(
-            'ee-moment-core',
-            EE_GLOBAL_ASSETS_URL . 'moment/moment-with-locales.min.js',
-            [],
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_register_script(
-            'ee-moment',
-            EE_GLOBAL_ASSETS_URL . 'moment/moment-timezone-with-data.min.js',
-            ['ee-moment-core'],
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_register_script(
-            'ee-datepicker',
-            EE_ADMIN_URL . 'assets/ee-datepicker.js',
-            ['jquery-ui-timepicker-addon', 'ee-moment'],
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        // google charts
-        wp_register_script(
-            'google-charts',
-            'https://www.gstatic.com/charts/loader.js',
-            [],
-            EVENT_ESPRESSO_VERSION
-        );
-        // ENQUEUE ALL BASICS BY DEFAULT
-        wp_enqueue_style('ee-admin-css');
-        wp_enqueue_script('ee_admin_js');
-        wp_enqueue_script('ee-accounting');
-        wp_enqueue_script('jquery-validate');
-        // taking care of metaboxes
-        if (
-            empty($this->_cpt_route)
-            && (isset($this->_route_config['metaboxes']) || isset($this->_route_config['has_metaboxes']))
-        ) {
-            wp_enqueue_script('dashboard');
-        }
-        // LOCALIZED DATA
-        // localize script for ajax lazy loading
-        $lazy_loader_container_ids = apply_filters(
-            'FHEE__EE_Admin_Page_Core__load_global_scripts_styles__loader_containers',
-            ['espresso_news_post_box_content']
-        );
-        wp_localize_script('ee_admin_js', 'eeLazyLoadingContainers', $lazy_loader_container_ids);
-        add_filter(
-            'admin_body_class',
-            function ($classes) {
-                if (strpos($classes, 'espresso-admin') === false) {
-                    $classes .= ' espresso-admin';
-                }
-                return $classes;
-            }
-        );
-    }
-
-
-    /**
-     *        admin_footer_scripts_eei18n_js_strings
-     *
-     * @return        void
-     */
-    public function admin_footer_scripts_eei18n_js_strings()
-    {
-        EE_Registry::$i18n_js_strings['ajax_url']       = WP_AJAX_URL;
-        EE_Registry::$i18n_js_strings['confirm_delete'] = wp_strip_all_tags(
-            __(
-                'Are you absolutely sure you want to delete this item?\nThis action will delete ALL DATA associated with this item!!!\nThis can NOT be undone!!!',
-                'event_espresso'
-            )
-        );
-        EE_Registry::$i18n_js_strings['January']        = wp_strip_all_tags(__('January', 'event_espresso'));
-        EE_Registry::$i18n_js_strings['February']       = wp_strip_all_tags(__('February', 'event_espresso'));
-        EE_Registry::$i18n_js_strings['March']          = wp_strip_all_tags(__('March', 'event_espresso'));
-        EE_Registry::$i18n_js_strings['April']          = wp_strip_all_tags(__('April', 'event_espresso'));
-        EE_Registry::$i18n_js_strings['May']            = wp_strip_all_tags(__('May', 'event_espresso'));
-        EE_Registry::$i18n_js_strings['June']           = wp_strip_all_tags(__('June', 'event_espresso'));
-        EE_Registry::$i18n_js_strings['July']           = wp_strip_all_tags(__('July', 'event_espresso'));
-        EE_Registry::$i18n_js_strings['August']         = wp_strip_all_tags(__('August', 'event_espresso'));
-        EE_Registry::$i18n_js_strings['September']      = wp_strip_all_tags(__('September', 'event_espresso'));
-        EE_Registry::$i18n_js_strings['October']        = wp_strip_all_tags(__('October', 'event_espresso'));
-        EE_Registry::$i18n_js_strings['November']       = wp_strip_all_tags(__('November', 'event_espresso'));
-        EE_Registry::$i18n_js_strings['December']       = wp_strip_all_tags(__('December', 'event_espresso'));
-        EE_Registry::$i18n_js_strings['Jan']            = wp_strip_all_tags(__('Jan', 'event_espresso'));
-        EE_Registry::$i18n_js_strings['Feb']            = wp_strip_all_tags(__('Feb', 'event_espresso'));
-        EE_Registry::$i18n_js_strings['Mar']            = wp_strip_all_tags(__('Mar', 'event_espresso'));
-        EE_Registry::$i18n_js_strings['Apr']            = wp_strip_all_tags(__('Apr', 'event_espresso'));
-        EE_Registry::$i18n_js_strings['May']            = wp_strip_all_tags(__('May', 'event_espresso'));
-        EE_Registry::$i18n_js_strings['Jun']            = wp_strip_all_tags(__('Jun', 'event_espresso'));
-        EE_Registry::$i18n_js_strings['Jul']            = wp_strip_all_tags(__('Jul', 'event_espresso'));
-        EE_Registry::$i18n_js_strings['Aug']            = wp_strip_all_tags(__('Aug', 'event_espresso'));
-        EE_Registry::$i18n_js_strings['Sep']            = wp_strip_all_tags(__('Sep', 'event_espresso'));
-        EE_Registry::$i18n_js_strings['Oct']            = wp_strip_all_tags(__('Oct', 'event_espresso'));
-        EE_Registry::$i18n_js_strings['Nov']            = wp_strip_all_tags(__('Nov', 'event_espresso'));
-        EE_Registry::$i18n_js_strings['Dec']            = wp_strip_all_tags(__('Dec', 'event_espresso'));
-        EE_Registry::$i18n_js_strings['Sunday']         = wp_strip_all_tags(__('Sunday', 'event_espresso'));
-        EE_Registry::$i18n_js_strings['Monday']         = wp_strip_all_tags(__('Monday', 'event_espresso'));
-        EE_Registry::$i18n_js_strings['Tuesday']        = wp_strip_all_tags(__('Tuesday', 'event_espresso'));
-        EE_Registry::$i18n_js_strings['Wednesday']      = wp_strip_all_tags(__('Wednesday', 'event_espresso'));
-        EE_Registry::$i18n_js_strings['Thursday']       = wp_strip_all_tags(__('Thursday', 'event_espresso'));
-        EE_Registry::$i18n_js_strings['Friday']         = wp_strip_all_tags(__('Friday', 'event_espresso'));
-        EE_Registry::$i18n_js_strings['Saturday']       = wp_strip_all_tags(__('Saturday', 'event_espresso'));
-        EE_Registry::$i18n_js_strings['Sun']            = wp_strip_all_tags(__('Sun', 'event_espresso'));
-        EE_Registry::$i18n_js_strings['Mon']            = wp_strip_all_tags(__('Mon', 'event_espresso'));
-        EE_Registry::$i18n_js_strings['Tue']            = wp_strip_all_tags(__('Tue', 'event_espresso'));
-        EE_Registry::$i18n_js_strings['Wed']            = wp_strip_all_tags(__('Wed', 'event_espresso'));
-        EE_Registry::$i18n_js_strings['Thu']            = wp_strip_all_tags(__('Thu', 'event_espresso'));
-        EE_Registry::$i18n_js_strings['Fri']            = wp_strip_all_tags(__('Fri', 'event_espresso'));
-        EE_Registry::$i18n_js_strings['Sat']            = wp_strip_all_tags(__('Sat', 'event_espresso'));
-    }
-
-
-    /**
-     *        load enhanced xdebug styles for ppl with failing eyesight
-     *
-     * @return        void
-     */
-    public function add_xdebug_style()
-    {
-        echo '<style>.xdebug-error { font-size:1.5em; }</style>';
-    }
-
-
-    /************************/
-    /** LIST TABLE METHODS **/
-    /************************/
-    /**
-     * this sets up the list table if the current view requires it.
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    protected function _set_list_table()
-    {
-        // first is this a list_table view?
-        if (! isset($this->_route_config['list_table'])) {
-            return;
-        } //not a list_table view so get out.
-        // list table functions are per view specific (because some admin pages might have more than one list table!)
-        $list_table_view = '_set_list_table_views_' . $this->_req_action;
-        if (! method_exists($this, $list_table_view) || $this->{$list_table_view}() === false) {
-            // user error msg
-            $error_msg = esc_html__(
-                'An error occurred. The requested list table views could not be found.',
-                'event_espresso'
-            );
-            // developer error msg
-            $error_msg .= '||'
-                          . sprintf(
-                              esc_html__(
-                                  'List table views for "%s" route could not be setup. Check that you have the corresponding method, "%s" set up for defining list_table_views for this route.',
-                                  'event_espresso'
-                              ),
-                              $this->_req_action,
-                              $list_table_view
-                          );
-            throw new EE_Error($error_msg);
-        }
-        // let's provide the ability to filter the views per PAGE AND ROUTE, per PAGE, and globally
-        $this->_views = apply_filters(
-            'FHEE_list_table_views_' . $this->page_slug . '_' . $this->_req_action,
-            $this->_views
-        );
-        $this->_views = apply_filters('FHEE_list_table_views_' . $this->page_slug, $this->_views);
-        $this->_views = apply_filters('FHEE_list_table_views', $this->_views);
-        $this->_set_list_table_view();
-        $this->_set_list_table_object();
-    }
-
-
-    /**
-     * set current view for List Table
-     *
-     * @return void
-     */
-    protected function _set_list_table_view()
-    {
-        $this->_view = isset($this->_views['in_use']) ? 'in_use' : 'all';
-        $status = $this->request->getRequestParam('status', null, 'key');
-        $this->_view = $status && array_key_exists($status, $this->_views)
-            ? $status
-            : $this->_view;
-    }
-
-
-    /**
-     * _set_list_table_object
-     * WP_List_Table objects need to be loaded fairly early so automatic stuff WP does is taken care of.
-     *
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws InvalidInterfaceException
-     */
-    protected function _set_list_table_object()
-    {
-        if (isset($this->_route_config['list_table'])) {
-            if (! class_exists($this->_route_config['list_table'])) {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            'The %s class defined for the list table does not exist.  Please check the spelling of the class ref in the $_page_config property on %s.',
-                            'event_espresso'
-                        ),
-                        $this->_route_config['list_table'],
-                        get_class($this)
-                    )
-                );
-            }
-            $this->_list_table_object = $this->loader->getShared(
-                $this->_route_config['list_table'],
-                [$this]
-            );
-        }
-    }
-
-
-    /**
-     * get_list_table_view_RLs - get it? View RL ?? VU-RL???  URL ??
-     *
-     * @param array $extra_query_args                     Optional. An array of extra query args to add to the generated
-     *                                                    urls.  The array should be indexed by the view it is being
-     *                                                    added to.
-     * @return array
-     */
-    public function get_list_table_view_RLs($extra_query_args = [])
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        if (empty($this->_views)) {
-            $this->_views = [];
-        }
-        // cycle thru views
-        foreach ($this->_views as $key => $view) {
-            $query_args = [];
-            // check for current view
-            $this->_views[ $key ]['class']               = $this->_view === $view['slug'] ? 'current' : '';
-            $query_args['action']                        = $this->_req_action;
-            $query_args[ $this->_req_action . '_nonce' ] = wp_create_nonce($query_args['action'] . '_nonce');
-            $query_args['status']                        = $view['slug'];
-            // merge any other arguments sent in.
-            if (isset($extra_query_args[ $view['slug'] ])) {
-                $query_args = array_merge($query_args, $extra_query_args[ $view['slug'] ]);
-            }
-            $this->_views[ $key ]['url'] = EE_Admin_Page::add_query_args_and_nonce($query_args, $this->_admin_base_url);
-        }
-        return $this->_views;
-    }
-
-
-    /**
-     * _entries_per_page_dropdown
-     * generates a dropdown box for selecting the number of visible rows in an admin page list table
-     *
-     * @param int $max_entries total number of rows in the table
-     * @return string
-     * @todo   : Note: ideally this should be added to the screen options dropdown as that would be consistent with how
-     *         WP does it.
-     */
-    protected function _entries_per_page_dropdown($max_entries = 0)
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $values   = [10, 25, 50, 100];
-        $per_page = $this->request->getRequestParam('per_page', 10, 'int');
-        if ($max_entries) {
-            $values[] = $max_entries;
-            sort($values);
-        }
-        $entries_per_page_dropdown = '
+		// current set timezone for timezone js
+		echo '<span id="current_timezone" class="hidden">' . esc_html(EEH_DTT_Helper::get_timezone()) . '</span>';
+	}
+
+
+	/**
+	 * This function sees if there is a method for help popup content existing for the given route.  If there is then
+	 * we'll use the retrieved array to output the content using the template. For child classes: If you want to have
+	 * help popups then in your templates or your content you set "triggers" for the content using the
+	 * "_set_help_trigger('help_trigger_id')" where "help_trigger_id" is what you will use later in your custom method
+	 * for the help popup content on that page. Then in your Child_Admin_Page class you need to define a help popup
+	 * method for the content in the format "_help_popup_content_{route_name}()"  So if you are setting help content
+	 * for the
+	 * 'edit_event' route you should have a method named "_help_popup_content_edit_route". In your defined
+	 * "help_popup_content_..." method.  You must prepare and return an array in the following format array(
+	 *    'help_trigger_id' => array(
+	 *        'title' => esc_html__('localized title for popup', 'event_espresso'),
+	 *        'content' => esc_html__('localized content for popup', 'event_espresso')
+	 *    )
+	 * );
+	 * Then the EE_Admin_Parent will take care of making sure that is setup properly on the correct route.
+	 *
+	 * @param array $help_array
+	 * @param bool  $display
+	 * @return string content
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	protected function _set_help_popup_content($help_array = [], $display = false)
+	{
+		$content    = '';
+		$help_array = empty($help_array) ? $this->_get_help_content() : $help_array;
+		// loop through the array and setup content
+		foreach ($help_array as $trigger => $help) {
+			// make sure the array is setup properly
+			if (! isset($help['title']) || ! isset($help['content'])) {
+				throw new EE_Error(
+					esc_html__(
+						'Does not look like the popup content array has been setup correctly.  Might want to double check that.  Read the comments for the _get_help_popup_content method found in "EE_Admin_Page" class',
+						'event_espresso'
+					)
+				);
+			}
+			// we're good so let's setup the template vars and then assign parsed template content to our content.
+			$template_args = [
+				'help_popup_id'      => $trigger,
+				'help_popup_title'   => $help['title'],
+				'help_popup_content' => $help['content'],
+			];
+			$content       .= EEH_Template::display_template(
+				EE_ADMIN_TEMPLATE . 'admin_help_popup.template.php',
+				$template_args,
+				true
+			);
+		}
+		if ($display) {
+			echo wp_kses($content, AllowedTags::getWithFormTags());
+			return '';
+		}
+		return $content;
+	}
+
+
+	/**
+	 * All this does is retrieve the help content array if set by the EE_Admin_Page child
+	 *
+	 * @return array properly formatted array for help popup content
+	 * @throws EE_Error
+	 */
+	private function _get_help_content()
+	{
+		// what is the method we're looking for?
+		$method_name = '_help_popup_content_' . $this->_req_action;
+		// if method doesn't exist let's get out.
+		if (! method_exists($this, $method_name)) {
+			return [];
+		}
+		// k we're good to go let's retrieve the help array
+		$help_array = call_user_func([$this, $method_name]);
+		// make sure we've got an array!
+		if (! is_array($help_array)) {
+			throw new EE_Error(
+				esc_html__(
+					'Something went wrong with help popup content generation. Expecting an array and well, this ain\'t no array bub.',
+					'event_espresso'
+				)
+			);
+		}
+		return $help_array;
+	}
+
+
+	/**
+	 * EE Admin Pages can use this to set a properly formatted trigger for a help popup.
+	 * By default the trigger html is printed.  Otherwise it can be returned if the $display flag is set "false"
+	 * See comments made on the _set_help_content method for understanding other parts to the help popup tool.
+	 *
+	 * @param string  $trigger_id reference for retrieving the trigger content for the popup
+	 * @param boolean $display    if false then we return the trigger string
+	 * @param array   $dimensions an array of dimensions for the box (array(h,w))
+	 * @return string
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	protected function _set_help_trigger($trigger_id, $display = true, $dimensions = ['400', '640'])
+	{
+		if ($this->request->isAjax()) {
+			return '';
+		}
+		// let's check and see if there is any content set for this popup.  If there isn't then we'll include a default title and content so that developers know something needs to be corrected
+		$help_array   = $this->_get_help_content();
+		$help_content = '';
+		if (empty($help_array) || ! isset($help_array[ $trigger_id ])) {
+			$help_array[ $trigger_id ] = [
+				'title'   => esc_html__('Missing Content', 'event_espresso'),
+				'content' => esc_html__(
+					'A trigger has been set that doesn\'t have any corresponding content. Make sure you have set the help content. (see the "_set_help_popup_content" method in the EE_Admin_Page for instructions.)',
+					'event_espresso'
+				),
+			];
+			$help_content              = $this->_set_help_popup_content($help_array);
+		}
+		// let's setup the trigger
+		$content = '<a class="ee-dialog" href="?height='
+				   . esc_attr($dimensions[0])
+				   . '&width='
+				   . esc_attr($dimensions[1])
+				   . '&inlineId='
+				   . esc_attr($trigger_id)
+				   . '" target="_blank"><span class="question ee-help-popup-question"></span></a>';
+		$content .= $help_content;
+		if ($display) {
+			echo wp_kses($content, AllowedTags::getWithFormTags());
+			return '';
+		}
+		return $content;
+	}
+
+
+	/**
+	 * _add_global_screen_options
+	 * Add any extra wp_screen_options within this method using built-in WP functions/methods for doing so.
+	 * This particular method will add_screen_options on ALL EE_Admin Pages
+	 *
+	 * @link   http://chrismarslender.com/wp-tutorials/wordpress-screen-options-tutorial/
+	 *         see also WP_Screen object documents...
+	 * @link   http://codex.wordpress.org/Class_Reference/WP_Screen
+	 * @abstract
+	 * @return void
+	 */
+	private function _add_global_screen_options()
+	{
+	}
+
+
+	/**
+	 * _add_global_feature_pointers
+	 * This method is used for implementing any "feature pointers" (using built-in WP styling js).
+	 * This particular method will implement feature pointers for ALL EE_Admin pages.
+	 * Note: this is just a placeholder for now.  Implementation will come down the road
+	 *
+	 * @see    WP_Internal_Pointers class in wp-admin/includes/template.php for example (its a final class so can't be
+	 *         extended) also see:
+	 * @link   http://eamann.com/tech/wordpress-portland/
+	 * @abstract
+	 * @return void
+	 */
+	private function _add_global_feature_pointers()
+	{
+	}
+
+
+	/**
+	 * load_global_scripts_styles
+	 * The scripts and styles enqueued in here will be loaded on every EE Admin page
+	 *
+	 * @return void
+	 */
+	public function load_global_scripts_styles()
+	{
+		/** STYLES **/
+		// add debugging styles
+		if (WP_DEBUG) {
+			add_action('admin_head', [$this, 'add_xdebug_style']);
+		}
+		// register all styles
+		wp_register_style(
+			'espresso-ui-theme',
+			EE_GLOBAL_ASSETS_URL . 'css/espresso-ui-theme/jquery-ui-1.10.3.custom.min.css',
+			[],
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_register_style('ee-admin-css', EE_ADMIN_URL . 'assets/ee-admin-page.css', [], EVENT_ESPRESSO_VERSION);
+		// helpers styles
+		wp_register_style(
+			'ee-text-links',
+			EE_PLUGIN_DIR_URL . 'core/helpers/assets/ee_text_list_helper.css',
+			[],
+			EVENT_ESPRESSO_VERSION
+		);
+		/** SCRIPTS **/
+		// register all scripts
+		wp_register_script(
+			'ee-dialog',
+			EE_ADMIN_URL . 'assets/ee-dialog-helper.js',
+			['jquery', 'jquery-ui-draggable'],
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_register_script(
+			'ee_admin_js',
+			EE_ADMIN_URL . 'assets/ee-admin-page.js',
+			['espresso_core', 'ee-parse-uri', 'ee-dialog'],
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_register_script(
+			'jquery-ui-timepicker-addon',
+			EE_GLOBAL_ASSETS_URL . 'scripts/jquery-ui-timepicker-addon.js',
+			['jquery-ui-datepicker', 'jquery-ui-slider'],
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		// script for sorting tables
+		wp_register_script(
+			'espresso_ajax_table_sorting',
+			EE_ADMIN_URL . 'assets/espresso_ajax_table_sorting.js',
+			['ee_admin_js', 'jquery-ui-sortable'],
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		// script for parsing uri's
+		wp_register_script(
+			'ee-parse-uri',
+			EE_GLOBAL_ASSETS_URL . 'scripts/parseuri.js',
+			[],
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		// and parsing associative serialized form elements
+		wp_register_script(
+			'ee-serialize-full-array',
+			EE_GLOBAL_ASSETS_URL . 'scripts/jquery.serializefullarray.js',
+			['jquery'],
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		// helpers scripts
+		wp_register_script(
+			'ee-text-links',
+			EE_PLUGIN_DIR_URL . 'core/helpers/assets/ee_text_list_helper.js',
+			['jquery'],
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_register_script(
+			'ee-moment-core',
+			EE_GLOBAL_ASSETS_URL . 'moment/moment-with-locales.min.js',
+			[],
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_register_script(
+			'ee-moment',
+			EE_GLOBAL_ASSETS_URL . 'moment/moment-timezone-with-data.min.js',
+			['ee-moment-core'],
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_register_script(
+			'ee-datepicker',
+			EE_ADMIN_URL . 'assets/ee-datepicker.js',
+			['jquery-ui-timepicker-addon', 'ee-moment'],
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		// google charts
+		wp_register_script(
+			'google-charts',
+			'https://www.gstatic.com/charts/loader.js',
+			[],
+			EVENT_ESPRESSO_VERSION
+		);
+		// ENQUEUE ALL BASICS BY DEFAULT
+		wp_enqueue_style('ee-admin-css');
+		wp_enqueue_script('ee_admin_js');
+		wp_enqueue_script('ee-accounting');
+		wp_enqueue_script('jquery-validate');
+		// taking care of metaboxes
+		if (
+			empty($this->_cpt_route)
+			&& (isset($this->_route_config['metaboxes']) || isset($this->_route_config['has_metaboxes']))
+		) {
+			wp_enqueue_script('dashboard');
+		}
+		// LOCALIZED DATA
+		// localize script for ajax lazy loading
+		$lazy_loader_container_ids = apply_filters(
+			'FHEE__EE_Admin_Page_Core__load_global_scripts_styles__loader_containers',
+			['espresso_news_post_box_content']
+		);
+		wp_localize_script('ee_admin_js', 'eeLazyLoadingContainers', $lazy_loader_container_ids);
+		add_filter(
+			'admin_body_class',
+			function ($classes) {
+				if (strpos($classes, 'espresso-admin') === false) {
+					$classes .= ' espresso-admin';
+				}
+				return $classes;
+			}
+		);
+	}
+
+
+	/**
+	 *        admin_footer_scripts_eei18n_js_strings
+	 *
+	 * @return        void
+	 */
+	public function admin_footer_scripts_eei18n_js_strings()
+	{
+		EE_Registry::$i18n_js_strings['ajax_url']       = WP_AJAX_URL;
+		EE_Registry::$i18n_js_strings['confirm_delete'] = wp_strip_all_tags(
+			__(
+				'Are you absolutely sure you want to delete this item?\nThis action will delete ALL DATA associated with this item!!!\nThis can NOT be undone!!!',
+				'event_espresso'
+			)
+		);
+		EE_Registry::$i18n_js_strings['January']        = wp_strip_all_tags(__('January', 'event_espresso'));
+		EE_Registry::$i18n_js_strings['February']       = wp_strip_all_tags(__('February', 'event_espresso'));
+		EE_Registry::$i18n_js_strings['March']          = wp_strip_all_tags(__('March', 'event_espresso'));
+		EE_Registry::$i18n_js_strings['April']          = wp_strip_all_tags(__('April', 'event_espresso'));
+		EE_Registry::$i18n_js_strings['May']            = wp_strip_all_tags(__('May', 'event_espresso'));
+		EE_Registry::$i18n_js_strings['June']           = wp_strip_all_tags(__('June', 'event_espresso'));
+		EE_Registry::$i18n_js_strings['July']           = wp_strip_all_tags(__('July', 'event_espresso'));
+		EE_Registry::$i18n_js_strings['August']         = wp_strip_all_tags(__('August', 'event_espresso'));
+		EE_Registry::$i18n_js_strings['September']      = wp_strip_all_tags(__('September', 'event_espresso'));
+		EE_Registry::$i18n_js_strings['October']        = wp_strip_all_tags(__('October', 'event_espresso'));
+		EE_Registry::$i18n_js_strings['November']       = wp_strip_all_tags(__('November', 'event_espresso'));
+		EE_Registry::$i18n_js_strings['December']       = wp_strip_all_tags(__('December', 'event_espresso'));
+		EE_Registry::$i18n_js_strings['Jan']            = wp_strip_all_tags(__('Jan', 'event_espresso'));
+		EE_Registry::$i18n_js_strings['Feb']            = wp_strip_all_tags(__('Feb', 'event_espresso'));
+		EE_Registry::$i18n_js_strings['Mar']            = wp_strip_all_tags(__('Mar', 'event_espresso'));
+		EE_Registry::$i18n_js_strings['Apr']            = wp_strip_all_tags(__('Apr', 'event_espresso'));
+		EE_Registry::$i18n_js_strings['May']            = wp_strip_all_tags(__('May', 'event_espresso'));
+		EE_Registry::$i18n_js_strings['Jun']            = wp_strip_all_tags(__('Jun', 'event_espresso'));
+		EE_Registry::$i18n_js_strings['Jul']            = wp_strip_all_tags(__('Jul', 'event_espresso'));
+		EE_Registry::$i18n_js_strings['Aug']            = wp_strip_all_tags(__('Aug', 'event_espresso'));
+		EE_Registry::$i18n_js_strings['Sep']            = wp_strip_all_tags(__('Sep', 'event_espresso'));
+		EE_Registry::$i18n_js_strings['Oct']            = wp_strip_all_tags(__('Oct', 'event_espresso'));
+		EE_Registry::$i18n_js_strings['Nov']            = wp_strip_all_tags(__('Nov', 'event_espresso'));
+		EE_Registry::$i18n_js_strings['Dec']            = wp_strip_all_tags(__('Dec', 'event_espresso'));
+		EE_Registry::$i18n_js_strings['Sunday']         = wp_strip_all_tags(__('Sunday', 'event_espresso'));
+		EE_Registry::$i18n_js_strings['Monday']         = wp_strip_all_tags(__('Monday', 'event_espresso'));
+		EE_Registry::$i18n_js_strings['Tuesday']        = wp_strip_all_tags(__('Tuesday', 'event_espresso'));
+		EE_Registry::$i18n_js_strings['Wednesday']      = wp_strip_all_tags(__('Wednesday', 'event_espresso'));
+		EE_Registry::$i18n_js_strings['Thursday']       = wp_strip_all_tags(__('Thursday', 'event_espresso'));
+		EE_Registry::$i18n_js_strings['Friday']         = wp_strip_all_tags(__('Friday', 'event_espresso'));
+		EE_Registry::$i18n_js_strings['Saturday']       = wp_strip_all_tags(__('Saturday', 'event_espresso'));
+		EE_Registry::$i18n_js_strings['Sun']            = wp_strip_all_tags(__('Sun', 'event_espresso'));
+		EE_Registry::$i18n_js_strings['Mon']            = wp_strip_all_tags(__('Mon', 'event_espresso'));
+		EE_Registry::$i18n_js_strings['Tue']            = wp_strip_all_tags(__('Tue', 'event_espresso'));
+		EE_Registry::$i18n_js_strings['Wed']            = wp_strip_all_tags(__('Wed', 'event_espresso'));
+		EE_Registry::$i18n_js_strings['Thu']            = wp_strip_all_tags(__('Thu', 'event_espresso'));
+		EE_Registry::$i18n_js_strings['Fri']            = wp_strip_all_tags(__('Fri', 'event_espresso'));
+		EE_Registry::$i18n_js_strings['Sat']            = wp_strip_all_tags(__('Sat', 'event_espresso'));
+	}
+
+
+	/**
+	 *        load enhanced xdebug styles for ppl with failing eyesight
+	 *
+	 * @return        void
+	 */
+	public function add_xdebug_style()
+	{
+		echo '<style>.xdebug-error { font-size:1.5em; }</style>';
+	}
+
+
+	/************************/
+	/** LIST TABLE METHODS **/
+	/************************/
+	/**
+	 * this sets up the list table if the current view requires it.
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	protected function _set_list_table()
+	{
+		// first is this a list_table view?
+		if (! isset($this->_route_config['list_table'])) {
+			return;
+		} //not a list_table view so get out.
+		// list table functions are per view specific (because some admin pages might have more than one list table!)
+		$list_table_view = '_set_list_table_views_' . $this->_req_action;
+		if (! method_exists($this, $list_table_view) || $this->{$list_table_view}() === false) {
+			// user error msg
+			$error_msg = esc_html__(
+				'An error occurred. The requested list table views could not be found.',
+				'event_espresso'
+			);
+			// developer error msg
+			$error_msg .= '||'
+						  . sprintf(
+							  esc_html__(
+								  'List table views for "%s" route could not be setup. Check that you have the corresponding method, "%s" set up for defining list_table_views for this route.',
+								  'event_espresso'
+							  ),
+							  $this->_req_action,
+							  $list_table_view
+						  );
+			throw new EE_Error($error_msg);
+		}
+		// let's provide the ability to filter the views per PAGE AND ROUTE, per PAGE, and globally
+		$this->_views = apply_filters(
+			'FHEE_list_table_views_' . $this->page_slug . '_' . $this->_req_action,
+			$this->_views
+		);
+		$this->_views = apply_filters('FHEE_list_table_views_' . $this->page_slug, $this->_views);
+		$this->_views = apply_filters('FHEE_list_table_views', $this->_views);
+		$this->_set_list_table_view();
+		$this->_set_list_table_object();
+	}
+
+
+	/**
+	 * set current view for List Table
+	 *
+	 * @return void
+	 */
+	protected function _set_list_table_view()
+	{
+		$this->_view = isset($this->_views['in_use']) ? 'in_use' : 'all';
+		$status = $this->request->getRequestParam('status', null, 'key');
+		$this->_view = $status && array_key_exists($status, $this->_views)
+			? $status
+			: $this->_view;
+	}
+
+
+	/**
+	 * _set_list_table_object
+	 * WP_List_Table objects need to be loaded fairly early so automatic stuff WP does is taken care of.
+	 *
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _set_list_table_object()
+	{
+		if (isset($this->_route_config['list_table'])) {
+			if (! class_exists($this->_route_config['list_table'])) {
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							'The %s class defined for the list table does not exist.  Please check the spelling of the class ref in the $_page_config property on %s.',
+							'event_espresso'
+						),
+						$this->_route_config['list_table'],
+						get_class($this)
+					)
+				);
+			}
+			$this->_list_table_object = $this->loader->getShared(
+				$this->_route_config['list_table'],
+				[$this]
+			);
+		}
+	}
+
+
+	/**
+	 * get_list_table_view_RLs - get it? View RL ?? VU-RL???  URL ??
+	 *
+	 * @param array $extra_query_args                     Optional. An array of extra query args to add to the generated
+	 *                                                    urls.  The array should be indexed by the view it is being
+	 *                                                    added to.
+	 * @return array
+	 */
+	public function get_list_table_view_RLs($extra_query_args = [])
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		if (empty($this->_views)) {
+			$this->_views = [];
+		}
+		// cycle thru views
+		foreach ($this->_views as $key => $view) {
+			$query_args = [];
+			// check for current view
+			$this->_views[ $key ]['class']               = $this->_view === $view['slug'] ? 'current' : '';
+			$query_args['action']                        = $this->_req_action;
+			$query_args[ $this->_req_action . '_nonce' ] = wp_create_nonce($query_args['action'] . '_nonce');
+			$query_args['status']                        = $view['slug'];
+			// merge any other arguments sent in.
+			if (isset($extra_query_args[ $view['slug'] ])) {
+				$query_args = array_merge($query_args, $extra_query_args[ $view['slug'] ]);
+			}
+			$this->_views[ $key ]['url'] = EE_Admin_Page::add_query_args_and_nonce($query_args, $this->_admin_base_url);
+		}
+		return $this->_views;
+	}
+
+
+	/**
+	 * _entries_per_page_dropdown
+	 * generates a dropdown box for selecting the number of visible rows in an admin page list table
+	 *
+	 * @param int $max_entries total number of rows in the table
+	 * @return string
+	 * @todo   : Note: ideally this should be added to the screen options dropdown as that would be consistent with how
+	 *         WP does it.
+	 */
+	protected function _entries_per_page_dropdown($max_entries = 0)
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$values   = [10, 25, 50, 100];
+		$per_page = $this->request->getRequestParam('per_page', 10, 'int');
+		if ($max_entries) {
+			$values[] = $max_entries;
+			sort($values);
+		}
+		$entries_per_page_dropdown = '
 			<div id="entries-per-page-dv" class="alignleft actions">
 				<label class="hide-if-no-js">
 					Show
 					<select id="entries-per-page-slct" name="entries-per-page-slct">';
-        foreach ($values as $value) {
-            if ($value < $max_entries) {
-                $selected                  = $value === $per_page ? ' selected="' . $per_page . '"' : '';
-                $entries_per_page_dropdown .= '
+		foreach ($values as $value) {
+			if ($value < $max_entries) {
+				$selected                  = $value === $per_page ? ' selected="' . $per_page . '"' : '';
+				$entries_per_page_dropdown .= '
 						<option value="' . $value . '"' . $selected . '>' . $value . '&nbsp;&nbsp;</option>';
-            }
-        }
-        $selected                  = $max_entries === $per_page ? ' selected="' . $per_page . '"' : '';
-        $entries_per_page_dropdown .= '
+			}
+		}
+		$selected                  = $max_entries === $per_page ? ' selected="' . $per_page . '"' : '';
+		$entries_per_page_dropdown .= '
 						<option value="' . $max_entries . '"' . $selected . '>All&nbsp;&nbsp;</option>';
-        $entries_per_page_dropdown .= '
+		$entries_per_page_dropdown .= '
 					</select>
 					entries
 				</label>
 				<input id="entries-per-page-btn" class="button-secondary" type="submit" value="Go" >
 			</div>
 		';
-        return $entries_per_page_dropdown;
-    }
-
-
-    /**
-     *        _set_search_attributes
-     *
-     * @return        void
-     */
-    public function _set_search_attributes()
-    {
-        $this->_template_args['search']['btn_label'] = sprintf(
-            esc_html__('Search %s', 'event_espresso'),
-            empty($this->_search_btn_label) ? $this->page_label
-                : $this->_search_btn_label
-        );
-        $this->_template_args['search']['callback']  = 'search_' . $this->page_slug;
-    }
-
-
-
-    /*** END LIST TABLE METHODS **/
-
-
-    /**
-     * _add_registered_metaboxes
-     *  this loads any registered metaboxes via the 'metaboxes' index in the _page_config property array.
-     *
-     * @link   http://codex.wordpress.org/Function_Reference/add_meta_box
-     * @return void
-     * @throws EE_Error
-     */
-    private function _add_registered_meta_boxes()
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        // we only add meta boxes if the page_route calls for it
-        if (
-            is_array($this->_route_config) && isset($this->_route_config['metaboxes'])
-            && is_array(
-                $this->_route_config['metaboxes']
-            )
-        ) {
-            // this simply loops through the callbacks provided
-            // and checks if there is a corresponding callback registered by the child
-            // if there is then we go ahead and process the metabox loader.
-            foreach ($this->_route_config['metaboxes'] as $metabox_callback) {
-                // first check for Closures
-                if ($metabox_callback instanceof Closure) {
-                    $result = $metabox_callback();
-                } elseif (is_array($metabox_callback) && isset($metabox_callback[0], $metabox_callback[1])) {
-                    $result = call_user_func([$metabox_callback[0], $metabox_callback[1]]);
-                } else {
-                    $result = call_user_func([$this, &$metabox_callback]);
-                }
-                if ($result === false) {
-                    // user error msg
-                    $error_msg = esc_html__(
-                        'An error occurred. The  requested metabox could not be found.',
-                        'event_espresso'
-                    );
-                    // developer error msg
-                    $error_msg .= '||'
-                                  . sprintf(
-                                      esc_html__(
-                                          'The metabox with the string "%s" could not be called. Check that the spelling for method names and actions in the "_page_config[\'metaboxes\']" array are all correct.',
-                                          'event_espresso'
-                                      ),
-                                      $metabox_callback
-                                  );
-                    throw new EE_Error($error_msg);
-                }
-            }
-        }
-    }
-
-
-    /**
-     * _add_screen_columns
-     * This will check the _page_config array and if there is "columns" key index indicated, we'll set the template as
-     * the dynamic column template and we'll setup the column options for the page.
-     *
-     * @return void
-     */
-    private function _add_screen_columns()
-    {
-        if (
-            is_array($this->_route_config)
-            && isset($this->_route_config['columns'])
-            && is_array($this->_route_config['columns'])
-            && count($this->_route_config['columns']) === 2
-        ) {
-            add_screen_option(
-                'layout_columns',
-                [
-                    'max'     => (int) $this->_route_config['columns'][0],
-                    'default' => (int) $this->_route_config['columns'][1],
-                ]
-            );
-            $this->_template_args['num_columns']                 = $this->_route_config['columns'][0];
-            $screen_id                                           = $this->_current_screen->id;
-            $screen_columns                                      = (int) get_user_option("screen_layout_{$screen_id}");
-            $total_columns                                       = ! empty($screen_columns)
-                ? $screen_columns
-                : $this->_route_config['columns'][1];
-            $this->_template_args['current_screen_widget_class'] = 'columns-' . $total_columns;
-            $this->_template_args['current_page']                = $this->_wp_page_slug;
-            $this->_template_args['screen']                      = $this->_current_screen;
-            $this->_column_template_path                         = EE_ADMIN_TEMPLATE
-                                                                   . 'admin_details_metabox_column_wrapper.template.php';
-            // finally if we don't have has_metaboxes set in the route config
-            // let's make sure it IS set other wise the necessary hidden fields for this won't be loaded.
-            $this->_route_config['has_metaboxes'] = true;
-        }
-    }
-
-
-
-    /** GLOBALLY AVAILABLE METABOXES **/
-
-
-    /**
-     * In this section we put any globally available EE metaboxes for all EE Admin pages.  They are called by simply
-     * referencing the callback in the _page_config array property.  This way you can be very specific about what pages
-     * these get loaded on.
-     */
-    private function _espresso_news_post_box()
-    {
-        $news_box_title = apply_filters(
-            'FHEE__EE_Admin_Page___espresso_news_post_box__news_box_title',
-            esc_html__('New @ Event Espresso', 'event_espresso')
-        );
-        add_meta_box(
-            'espresso_news_post_box',
-            $news_box_title,
-            [
-                $this,
-                'espresso_news_post_box',
-            ],
-            $this->_wp_page_slug,
-            'side'
-        );
-    }
-
-
-    /**
-     * Code for setting up espresso ratings request metabox.
-     */
-    protected function _espresso_ratings_request()
-    {
-        if (! apply_filters('FHEE_show_ratings_request_meta_box', true)) {
-            return;
-        }
-        $ratings_box_title = apply_filters(
-            'FHEE__EE_Admin_Page___espresso_news_post_box__news_box_title',
-            esc_html__('Keep Event Espresso Decaf Free', 'event_espresso')
-        );
-        add_meta_box(
-            'espresso_ratings_request',
-            $ratings_box_title,
-            [
-                $this,
-                'espresso_ratings_request',
-            ],
-            $this->_wp_page_slug,
-            'side'
-        );
-    }
-
-
-    /**
-     * Code for setting up espresso ratings request metabox content.
-     *
-     * @throws DomainException
-     */
-    public function espresso_ratings_request()
-    {
-        EEH_Template::display_template(
-            EE_ADMIN_TEMPLATE . 'espresso_ratings_request_content.template.php',
-            []
-        );
-    }
-
-
-    public static function cached_rss_display($rss_id, $url)
-    {
-        $loading   = '<p class="widget-loading hide-if-no-js">'
-                     . esc_html__('Loading&#8230;', 'event_espresso')
-                     . '</p><p class="hide-if-js">'
-                     . esc_html__('This widget requires JavaScript.', 'event_espresso')
-                     . '</p>';
-        $pre       = '<div class="espresso-rss-display">' . "\n\t";
-        $pre       .= '<span id="' . esc_attr($rss_id) . '_url" class="hidden">' . esc_url_raw($url) . '</span>';
-        $post      = '</div>' . "\n";
-        $cache_key = 'ee_rss_' . md5($rss_id);
-        $output    = get_transient($cache_key);
-        if ($output !== false) {
-            echo wp_kses($pre . $output . $post, AllowedTags::getWithFormTags());
-            return true;
-        }
-        if (! (defined('DOING_AJAX') && DOING_AJAX)) {
-            echo wp_kses($pre . $loading . $post, AllowedTags::getWithFormTags());
-            return false;
-        }
-        ob_start();
-        wp_widget_rss_output($url, ['show_date' => 0, 'items' => 5]);
-        set_transient($cache_key, ob_get_flush(), 12 * HOUR_IN_SECONDS);
-        return true;
-    }
-
-
-    public function espresso_news_post_box()
-    {
-        ?>
+		return $entries_per_page_dropdown;
+	}
+
+
+	/**
+	 *        _set_search_attributes
+	 *
+	 * @return        void
+	 */
+	public function _set_search_attributes()
+	{
+		$this->_template_args['search']['btn_label'] = sprintf(
+			esc_html__('Search %s', 'event_espresso'),
+			empty($this->_search_btn_label) ? $this->page_label
+				: $this->_search_btn_label
+		);
+		$this->_template_args['search']['callback']  = 'search_' . $this->page_slug;
+	}
+
+
+
+	/*** END LIST TABLE METHODS **/
+
+
+	/**
+	 * _add_registered_metaboxes
+	 *  this loads any registered metaboxes via the 'metaboxes' index in the _page_config property array.
+	 *
+	 * @link   http://codex.wordpress.org/Function_Reference/add_meta_box
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private function _add_registered_meta_boxes()
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		// we only add meta boxes if the page_route calls for it
+		if (
+			is_array($this->_route_config) && isset($this->_route_config['metaboxes'])
+			&& is_array(
+				$this->_route_config['metaboxes']
+			)
+		) {
+			// this simply loops through the callbacks provided
+			// and checks if there is a corresponding callback registered by the child
+			// if there is then we go ahead and process the metabox loader.
+			foreach ($this->_route_config['metaboxes'] as $metabox_callback) {
+				// first check for Closures
+				if ($metabox_callback instanceof Closure) {
+					$result = $metabox_callback();
+				} elseif (is_array($metabox_callback) && isset($metabox_callback[0], $metabox_callback[1])) {
+					$result = call_user_func([$metabox_callback[0], $metabox_callback[1]]);
+				} else {
+					$result = call_user_func([$this, &$metabox_callback]);
+				}
+				if ($result === false) {
+					// user error msg
+					$error_msg = esc_html__(
+						'An error occurred. The  requested metabox could not be found.',
+						'event_espresso'
+					);
+					// developer error msg
+					$error_msg .= '||'
+								  . sprintf(
+									  esc_html__(
+										  'The metabox with the string "%s" could not be called. Check that the spelling for method names and actions in the "_page_config[\'metaboxes\']" array are all correct.',
+										  'event_espresso'
+									  ),
+									  $metabox_callback
+								  );
+					throw new EE_Error($error_msg);
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * _add_screen_columns
+	 * This will check the _page_config array and if there is "columns" key index indicated, we'll set the template as
+	 * the dynamic column template and we'll setup the column options for the page.
+	 *
+	 * @return void
+	 */
+	private function _add_screen_columns()
+	{
+		if (
+			is_array($this->_route_config)
+			&& isset($this->_route_config['columns'])
+			&& is_array($this->_route_config['columns'])
+			&& count($this->_route_config['columns']) === 2
+		) {
+			add_screen_option(
+				'layout_columns',
+				[
+					'max'     => (int) $this->_route_config['columns'][0],
+					'default' => (int) $this->_route_config['columns'][1],
+				]
+			);
+			$this->_template_args['num_columns']                 = $this->_route_config['columns'][0];
+			$screen_id                                           = $this->_current_screen->id;
+			$screen_columns                                      = (int) get_user_option("screen_layout_{$screen_id}");
+			$total_columns                                       = ! empty($screen_columns)
+				? $screen_columns
+				: $this->_route_config['columns'][1];
+			$this->_template_args['current_screen_widget_class'] = 'columns-' . $total_columns;
+			$this->_template_args['current_page']                = $this->_wp_page_slug;
+			$this->_template_args['screen']                      = $this->_current_screen;
+			$this->_column_template_path                         = EE_ADMIN_TEMPLATE
+																   . 'admin_details_metabox_column_wrapper.template.php';
+			// finally if we don't have has_metaboxes set in the route config
+			// let's make sure it IS set other wise the necessary hidden fields for this won't be loaded.
+			$this->_route_config['has_metaboxes'] = true;
+		}
+	}
+
+
+
+	/** GLOBALLY AVAILABLE METABOXES **/
+
+
+	/**
+	 * In this section we put any globally available EE metaboxes for all EE Admin pages.  They are called by simply
+	 * referencing the callback in the _page_config array property.  This way you can be very specific about what pages
+	 * these get loaded on.
+	 */
+	private function _espresso_news_post_box()
+	{
+		$news_box_title = apply_filters(
+			'FHEE__EE_Admin_Page___espresso_news_post_box__news_box_title',
+			esc_html__('New @ Event Espresso', 'event_espresso')
+		);
+		add_meta_box(
+			'espresso_news_post_box',
+			$news_box_title,
+			[
+				$this,
+				'espresso_news_post_box',
+			],
+			$this->_wp_page_slug,
+			'side'
+		);
+	}
+
+
+	/**
+	 * Code for setting up espresso ratings request metabox.
+	 */
+	protected function _espresso_ratings_request()
+	{
+		if (! apply_filters('FHEE_show_ratings_request_meta_box', true)) {
+			return;
+		}
+		$ratings_box_title = apply_filters(
+			'FHEE__EE_Admin_Page___espresso_news_post_box__news_box_title',
+			esc_html__('Keep Event Espresso Decaf Free', 'event_espresso')
+		);
+		add_meta_box(
+			'espresso_ratings_request',
+			$ratings_box_title,
+			[
+				$this,
+				'espresso_ratings_request',
+			],
+			$this->_wp_page_slug,
+			'side'
+		);
+	}
+
+
+	/**
+	 * Code for setting up espresso ratings request metabox content.
+	 *
+	 * @throws DomainException
+	 */
+	public function espresso_ratings_request()
+	{
+		EEH_Template::display_template(
+			EE_ADMIN_TEMPLATE . 'espresso_ratings_request_content.template.php',
+			[]
+		);
+	}
+
+
+	public static function cached_rss_display($rss_id, $url)
+	{
+		$loading   = '<p class="widget-loading hide-if-no-js">'
+					 . esc_html__('Loading&#8230;', 'event_espresso')
+					 . '</p><p class="hide-if-js">'
+					 . esc_html__('This widget requires JavaScript.', 'event_espresso')
+					 . '</p>';
+		$pre       = '<div class="espresso-rss-display">' . "\n\t";
+		$pre       .= '<span id="' . esc_attr($rss_id) . '_url" class="hidden">' . esc_url_raw($url) . '</span>';
+		$post      = '</div>' . "\n";
+		$cache_key = 'ee_rss_' . md5($rss_id);
+		$output    = get_transient($cache_key);
+		if ($output !== false) {
+			echo wp_kses($pre . $output . $post, AllowedTags::getWithFormTags());
+			return true;
+		}
+		if (! (defined('DOING_AJAX') && DOING_AJAX)) {
+			echo wp_kses($pre . $loading . $post, AllowedTags::getWithFormTags());
+			return false;
+		}
+		ob_start();
+		wp_widget_rss_output($url, ['show_date' => 0, 'items' => 5]);
+		set_transient($cache_key, ob_get_flush(), 12 * HOUR_IN_SECONDS);
+		return true;
+	}
+
+
+	public function espresso_news_post_box()
+	{
+		?>
         <div class="padding">
             <div id="espresso_news_post_box_content" class="infolinks">
                 <?php
-                // Get RSS Feed(s)
-                self::cached_rss_display(
-                    'espresso_news_post_box_content',
-                    esc_url_raw(
-                        apply_filters(
-                            'FHEE__EE_Admin_Page__espresso_news_post_box__feed_url',
-                            'https://eventespresso.com/feed/'
-                        )
-                    )
-                );
-                ?>
+				// Get RSS Feed(s)
+				self::cached_rss_display(
+					'espresso_news_post_box_content',
+					esc_url_raw(
+						apply_filters(
+							'FHEE__EE_Admin_Page__espresso_news_post_box__feed_url',
+							'https://eventespresso.com/feed/'
+						)
+					)
+				);
+				?>
             </div>
             <?php do_action('AHEE__EE_Admin_Page__espresso_news_post_box__after_content'); ?>
         </div>
         <?php
-    }
-
-
-    private function _espresso_links_post_box()
-    {
-        // Hiding until we actually have content to put in here...
-        // add_meta_box('espresso_links_post_box', esc_html__('Helpful Plugin Links', 'event_espresso'), array( $this, 'espresso_links_post_box'), $this->_wp_page_slug, 'side');
-    }
-
-
-    public function espresso_links_post_box()
-    {
-        // Hiding until we actually have content to put in here...
-        // EEH_Template::display_template(
-        //     EE_ADMIN_TEMPLATE . 'admin_general_metabox_contents_espresso_links.template.php'
-        // );
-    }
-
-
-    protected function _espresso_sponsors_post_box()
-    {
-        if (apply_filters('FHEE_show_sponsors_meta_box', true)) {
-            add_meta_box(
-                'espresso_sponsors_post_box',
-                esc_html__('Event Espresso Highlights', 'event_espresso'),
-                [$this, 'espresso_sponsors_post_box'],
-                $this->_wp_page_slug,
-                'side'
-            );
-        }
-    }
-
-
-    public function espresso_sponsors_post_box()
-    {
-        EEH_Template::display_template(
-            EE_ADMIN_TEMPLATE . 'admin_general_metabox_contents_espresso_sponsors.template.php'
-        );
-    }
-
-
-    private function _publish_post_box()
-    {
-        $meta_box_ref = 'espresso_' . $this->page_slug . '_editor_overview';
-        // if there is a array('label' => array('publishbox' => 'some title') ) present in the _page_config array
-        // then we'll use that for the metabox label.
-        // Otherwise we'll just use publish (publishbox itself could be an array of labels indexed by routes)
-        if (! empty($this->_labels['publishbox'])) {
-            $box_label = is_array($this->_labels['publishbox']) ? $this->_labels['publishbox'][ $this->_req_action ]
-                : $this->_labels['publishbox'];
-        } else {
-            $box_label = esc_html__('Publish', 'event_espresso');
-        }
-        $box_label = apply_filters(
-            'FHEE__EE_Admin_Page___publish_post_box__box_label',
-            $box_label,
-            $this->_req_action,
-            $this
-        );
-        add_meta_box(
-            $meta_box_ref,
-            $box_label,
-            [$this, 'editor_overview'],
-            $this->_current_screen->id,
-            'side',
-            'high'
-        );
-    }
-
-
-    public function editor_overview()
-    {
-        // if we have extra content set let's add it in if not make sure its empty
-        $this->_template_args['publish_box_extra_content'] = isset($this->_template_args['publish_box_extra_content'])
-            ? $this->_template_args['publish_box_extra_content']
-            : '';
-        echo EEH_Template::display_template(
-            EE_ADMIN_TEMPLATE . 'admin_details_publish_metabox.template.php',
-            $this->_template_args,
-            true
-        );
-    }
-
-
-    /** end of globally available metaboxes section **/
-
-
-    /**
-     * Public wrapper for the protected method.  Allows plugins/addons to externally call the
-     * protected method.
-     *
-     * @param string $name
-     * @param int    $id
-     * @param bool   $delete
-     * @param string $save_close_redirect_URL
-     * @param bool   $both_btns
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @see   $this->_set_publish_post_box_vars for param details
-     * @since 4.6.0
-     */
-    public function set_publish_post_box_vars(
-        $name = '',
-        $id = 0,
-        $delete = false,
-        $save_close_redirect_URL = '',
-        $both_btns = true
-    ) {
-        $this->_set_publish_post_box_vars(
-            $name,
-            $id,
-            $delete,
-            $save_close_redirect_URL,
-            $both_btns
-        );
-    }
-
-
-    /**
-     * Sets the _template_args arguments used by the _publish_post_box shortcut
-     * Note: currently there is no validation for this.  However if you want the delete button, the
-     * save, and save and close buttons to work properly, then you will want to include a
-     * values for the name and id arguments.
-     *
-     * @param string  $name                       key used for the action ID (i.e. event_id)
-     * @param int     $id                         id attached to the item published
-     * @param string  $delete                     page route callback for the delete action
-     * @param string  $save_close_redirect_URL    custom URL to redirect to after Save & Close has been completed
-     * @param boolean $both_btns                  whether to display BOTH the "Save & Close" and "Save" buttons or just
-     *                                            the Save button
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @todo  Add in validation for name/id arguments.
-     */
-    protected function _set_publish_post_box_vars(
-        $name = '',
-        $id = 0,
-        $delete = '',
-        $save_close_redirect_URL = '',
-        $both_btns = true
-    ) {
-        // if Save & Close, use a custom redirect URL or default to the main page?
-        $save_close_redirect_URL = ! empty($save_close_redirect_URL)
-            ? $save_close_redirect_URL
-            : $this->_admin_base_url;
-        // create the Save & Close and Save buttons
-        $this->_set_save_buttons($both_btns, [], [], $save_close_redirect_URL);
-        // if we have extra content set let's add it in if not make sure its empty
-        $this->_template_args['publish_box_extra_content'] = isset($this->_template_args['publish_box_extra_content'])
-            ? $this->_template_args['publish_box_extra_content']
-            : '';
-        if ($delete && ! empty($id)) {
-            // make sure we have a default if just true is sent.
-            $delete           = ! empty($delete) ? $delete : 'delete';
-            $delete_link_args = [$name => $id];
-            $delete           = $this->get_action_link_or_button(
-                $delete,
-                $delete,
-                $delete_link_args,
-                'submitdelete deletion',
-                '',
-                false
-            );
-        }
-        $this->_template_args['publish_delete_link'] = ! empty($id) ? $delete : '';
-        if (! empty($name) && ! empty($id)) {
-            $hidden_field_arr[ $name ] = [
-                'type'  => 'hidden',
-                'value' => $id,
-            ];
-            $hf                        = $this->_generate_admin_form_fields($hidden_field_arr, 'array');
-        } else {
-            $hf = '';
-        }
-        // add hidden field
-        $this->_template_args['publish_hidden_fields'] = is_array($hf) && ! empty($name)
-            ? $hf[ $name ]['field']
-            : $hf;
-    }
-
-
-    /**
-     * displays an error message to ppl who have javascript disabled
-     *
-     * @return void
-     */
-    private function _display_no_javascript_warning()
-    {
-        ?>
+	}
+
+
+	private function _espresso_links_post_box()
+	{
+		// Hiding until we actually have content to put in here...
+		// add_meta_box('espresso_links_post_box', esc_html__('Helpful Plugin Links', 'event_espresso'), array( $this, 'espresso_links_post_box'), $this->_wp_page_slug, 'side');
+	}
+
+
+	public function espresso_links_post_box()
+	{
+		// Hiding until we actually have content to put in here...
+		// EEH_Template::display_template(
+		//     EE_ADMIN_TEMPLATE . 'admin_general_metabox_contents_espresso_links.template.php'
+		// );
+	}
+
+
+	protected function _espresso_sponsors_post_box()
+	{
+		if (apply_filters('FHEE_show_sponsors_meta_box', true)) {
+			add_meta_box(
+				'espresso_sponsors_post_box',
+				esc_html__('Event Espresso Highlights', 'event_espresso'),
+				[$this, 'espresso_sponsors_post_box'],
+				$this->_wp_page_slug,
+				'side'
+			);
+		}
+	}
+
+
+	public function espresso_sponsors_post_box()
+	{
+		EEH_Template::display_template(
+			EE_ADMIN_TEMPLATE . 'admin_general_metabox_contents_espresso_sponsors.template.php'
+		);
+	}
+
+
+	private function _publish_post_box()
+	{
+		$meta_box_ref = 'espresso_' . $this->page_slug . '_editor_overview';
+		// if there is a array('label' => array('publishbox' => 'some title') ) present in the _page_config array
+		// then we'll use that for the metabox label.
+		// Otherwise we'll just use publish (publishbox itself could be an array of labels indexed by routes)
+		if (! empty($this->_labels['publishbox'])) {
+			$box_label = is_array($this->_labels['publishbox']) ? $this->_labels['publishbox'][ $this->_req_action ]
+				: $this->_labels['publishbox'];
+		} else {
+			$box_label = esc_html__('Publish', 'event_espresso');
+		}
+		$box_label = apply_filters(
+			'FHEE__EE_Admin_Page___publish_post_box__box_label',
+			$box_label,
+			$this->_req_action,
+			$this
+		);
+		add_meta_box(
+			$meta_box_ref,
+			$box_label,
+			[$this, 'editor_overview'],
+			$this->_current_screen->id,
+			'side',
+			'high'
+		);
+	}
+
+
+	public function editor_overview()
+	{
+		// if we have extra content set let's add it in if not make sure its empty
+		$this->_template_args['publish_box_extra_content'] = isset($this->_template_args['publish_box_extra_content'])
+			? $this->_template_args['publish_box_extra_content']
+			: '';
+		echo EEH_Template::display_template(
+			EE_ADMIN_TEMPLATE . 'admin_details_publish_metabox.template.php',
+			$this->_template_args,
+			true
+		);
+	}
+
+
+	/** end of globally available metaboxes section **/
+
+
+	/**
+	 * Public wrapper for the protected method.  Allows plugins/addons to externally call the
+	 * protected method.
+	 *
+	 * @param string $name
+	 * @param int    $id
+	 * @param bool   $delete
+	 * @param string $save_close_redirect_URL
+	 * @param bool   $both_btns
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @see   $this->_set_publish_post_box_vars for param details
+	 * @since 4.6.0
+	 */
+	public function set_publish_post_box_vars(
+		$name = '',
+		$id = 0,
+		$delete = false,
+		$save_close_redirect_URL = '',
+		$both_btns = true
+	) {
+		$this->_set_publish_post_box_vars(
+			$name,
+			$id,
+			$delete,
+			$save_close_redirect_URL,
+			$both_btns
+		);
+	}
+
+
+	/**
+	 * Sets the _template_args arguments used by the _publish_post_box shortcut
+	 * Note: currently there is no validation for this.  However if you want the delete button, the
+	 * save, and save and close buttons to work properly, then you will want to include a
+	 * values for the name and id arguments.
+	 *
+	 * @param string  $name                       key used for the action ID (i.e. event_id)
+	 * @param int     $id                         id attached to the item published
+	 * @param string  $delete                     page route callback for the delete action
+	 * @param string  $save_close_redirect_URL    custom URL to redirect to after Save & Close has been completed
+	 * @param boolean $both_btns                  whether to display BOTH the "Save & Close" and "Save" buttons or just
+	 *                                            the Save button
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @todo  Add in validation for name/id arguments.
+	 */
+	protected function _set_publish_post_box_vars(
+		$name = '',
+		$id = 0,
+		$delete = '',
+		$save_close_redirect_URL = '',
+		$both_btns = true
+	) {
+		// if Save & Close, use a custom redirect URL or default to the main page?
+		$save_close_redirect_URL = ! empty($save_close_redirect_URL)
+			? $save_close_redirect_URL
+			: $this->_admin_base_url;
+		// create the Save & Close and Save buttons
+		$this->_set_save_buttons($both_btns, [], [], $save_close_redirect_URL);
+		// if we have extra content set let's add it in if not make sure its empty
+		$this->_template_args['publish_box_extra_content'] = isset($this->_template_args['publish_box_extra_content'])
+			? $this->_template_args['publish_box_extra_content']
+			: '';
+		if ($delete && ! empty($id)) {
+			// make sure we have a default if just true is sent.
+			$delete           = ! empty($delete) ? $delete : 'delete';
+			$delete_link_args = [$name => $id];
+			$delete           = $this->get_action_link_or_button(
+				$delete,
+				$delete,
+				$delete_link_args,
+				'submitdelete deletion',
+				'',
+				false
+			);
+		}
+		$this->_template_args['publish_delete_link'] = ! empty($id) ? $delete : '';
+		if (! empty($name) && ! empty($id)) {
+			$hidden_field_arr[ $name ] = [
+				'type'  => 'hidden',
+				'value' => $id,
+			];
+			$hf                        = $this->_generate_admin_form_fields($hidden_field_arr, 'array');
+		} else {
+			$hf = '';
+		}
+		// add hidden field
+		$this->_template_args['publish_hidden_fields'] = is_array($hf) && ! empty($name)
+			? $hf[ $name ]['field']
+			: $hf;
+	}
+
+
+	/**
+	 * displays an error message to ppl who have javascript disabled
+	 *
+	 * @return void
+	 */
+	private function _display_no_javascript_warning()
+	{
+		?>
         <noscript>
             <div id="no-js-message" class="error">
                 <p style="font-size:1.3em;">
                     <span style="color:red;"><?php esc_html_e('Warning!', 'event_espresso'); ?></span>
                     <?php esc_html_e(
-                        'Javascript is currently turned off for your browser. Javascript must be enabled in order for all of the features on this page to function properly. Please turn your javascript back on.',
-                        'event_espresso'
-                    ); ?>
+						'Javascript is currently turned off for your browser. Javascript must be enabled in order for all of the features on this page to function properly. Please turn your javascript back on.',
+						'event_espresso'
+					); ?>
                 </p>
             </div>
         </noscript>
         <?php
-    }
-
-
-    /**
-     * displays espresso success and/or error notices
-     *
-     * @return void
-     */
-    protected function _display_espresso_notices()
-    {
-        $notices = $this->_get_transient(true);
-        echo wp_kses(stripslashes($notices), AllowedTags::getWithFormTags());
-    }
-
-
-    /**
-     * spinny things pacify the masses
-     *
-     * @return void
-     */
-    protected function _add_admin_page_ajax_loading_img()
-    {
-        ?>
+	}
+
+
+	/**
+	 * displays espresso success and/or error notices
+	 *
+	 * @return void
+	 */
+	protected function _display_espresso_notices()
+	{
+		$notices = $this->_get_transient(true);
+		echo wp_kses(stripslashes($notices), AllowedTags::getWithFormTags());
+	}
+
+
+	/**
+	 * spinny things pacify the masses
+	 *
+	 * @return void
+	 */
+	protected function _add_admin_page_ajax_loading_img()
+	{
+		?>
         <div id="espresso-ajax-loading" class="ajax-loading-grey">
             <span class="ee-spinner ee-spin"></span><span class="hidden"><?php
-                esc_html_e('loading...', 'event_espresso'); ?></span>
+				esc_html_e('loading...', 'event_espresso'); ?></span>
         </div>
         <?php
-    }
+	}
 
 
-    /**
-     * add admin page overlay for modal boxes
-     *
-     * @return void
-     */
-    protected function _add_admin_page_overlay()
-    {
-        ?>
+	/**
+	 * add admin page overlay for modal boxes
+	 *
+	 * @return void
+	 */
+	protected function _add_admin_page_overlay()
+	{
+		?>
         <div id="espresso-admin-page-overlay-dv" class=""></div>
         <?php
-    }
-
-
-    /**
-     * facade for add_meta_box
-     *
-     * @param string  $action        where the metabox gets displayed
-     * @param string  $title         Title of Metabox (output in metabox header)
-     * @param string  $callback      If not empty and $create_fun is set to false then we'll use a custom callback
-     *                               instead of the one created in here.
-     * @param array   $callback_args an array of args supplied for the metabox
-     * @param string  $column        what metabox column
-     * @param string  $priority      give this metabox a priority (using accepted priorities for wp meta boxes)
-     * @param boolean $create_func   default is true.  Basically we can say we don't WANT to have the runtime function
-     *                               created but just set our own callback for wp's add_meta_box.
-     * @throws DomainException
-     */
-    public function _add_admin_page_meta_box(
-        $action,
-        $title,
-        $callback,
-        $callback_args,
-        $column = 'normal',
-        $priority = 'high',
-        $create_func = true
-    ) {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, $callback);
-        // if we have empty callback args and we want to automatically create the metabox callback then we need to make sure the callback args are generated.
-        if (empty($callback_args) && $create_func) {
-            $callback_args = [
-                'template_path' => $this->_template_path,
-                'template_args' => $this->_template_args,
-            ];
-        }
-        // if $create_func is true (default) then we automatically create the function for displaying the actual meta box.  If false then we take the $callback reference passed through and use it instead (so callers can define their own callback function/method if they wish)
-        $call_back_func = $create_func
-            ? function ($post, $metabox) {
-                do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-                echo EEH_Template::display_template(
-                    $metabox['args']['template_path'],
-                    $metabox['args']['template_args'],
-                    true
-                );
-            }
-            : $callback;
-        add_meta_box(
-            str_replace('_', '-', $action) . '-mbox',
-            $title,
-            $call_back_func,
-            $this->_wp_page_slug,
-            $column,
-            $priority,
-            $callback_args
-        );
-    }
-
-
-    /**
-     * generates HTML wrapper for and admin details page that contains metaboxes in columns
-     *
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    public function display_admin_page_with_metabox_columns()
-    {
-        $this->_template_args['post_body_content']  = $this->_template_args['admin_page_content'];
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            $this->_column_template_path,
-            $this->_template_args,
-            true
-        );
-        // the final wrapper
-        $this->admin_page_wrapper();
-    }
-
-
-    /**
-     * generates  HTML wrapper for an admin details page
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws DomainException
-     */
-    public function display_admin_page_with_sidebar()
-    {
-        $this->_display_admin_page(true);
-    }
-
-
-    /**
-     * generates  HTML wrapper for an admin details page (except no sidebar)
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws DomainException
-     */
-    public function display_admin_page_with_no_sidebar()
-    {
-        $this->_display_admin_page();
-    }
-
-
-    /**
-     * generates HTML wrapper for an EE about admin page (no sidebar)
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws DomainException
-     */
-    public function display_about_admin_page()
-    {
-        $this->_display_admin_page(false, true);
-    }
-
-
-    /**
-     * display_admin_page
-     * contains the code for actually displaying an admin page
-     *
-     * @param boolean $sidebar true with sidebar, false without
-     * @param boolean $about   use the about_admin_wrapper instead of the default.
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    private function _display_admin_page($sidebar = false, $about = false)
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        // custom remove metaboxes hook to add or remove any metaboxes to/from Admin pages.
-        do_action('AHEE__EE_Admin_Page___display_admin_page__modify_metaboxes');
-        // set current wp page slug - looks like: event-espresso_page_event_categories
-        // keep in mind "event-espresso" COULD be something else if the top level menu label has been translated.
-        $this->_template_args['current_page']              = $this->_wp_page_slug;
-        $this->_template_args['admin_page_wrapper_div_id'] = $this->_cpt_route
-            ? 'poststuff'
-            : 'espresso-default-admin';
-        $template_path                                     = $sidebar
-            ? EE_ADMIN_TEMPLATE . 'admin_details_wrapper.template.php'
-            : EE_ADMIN_TEMPLATE . 'admin_details_wrapper_no_sidebar.template.php';
-        if ($this->request->isAjax()) {
-            $template_path = EE_ADMIN_TEMPLATE . 'admin_details_wrapper_no_sidebar_ajax.template.php';
-        }
-        $template_path                                     = ! empty($this->_column_template_path)
-            ? $this->_column_template_path : $template_path;
-        $this->_template_args['post_body_content']         = isset($this->_template_args['admin_page_content'])
-            ? $this->_template_args['admin_page_content']
-            : '';
-        $this->_template_args['before_admin_page_content'] = isset($this->_template_args['before_admin_page_content'])
-            ? $this->_template_args['before_admin_page_content']
-            : '';
-        $this->_template_args['after_admin_page_content']  = isset($this->_template_args['after_admin_page_content'])
-            ? $this->_template_args['after_admin_page_content']
-            : '';
-        $this->_template_args['admin_page_content']        = EEH_Template::display_template(
-            $template_path,
-            $this->_template_args,
-            true
-        );
-        // the final template wrapper
-        $this->admin_page_wrapper($about);
-    }
-
-
-    /**
-     * This is used to display caf preview pages.
-     *
-     * @param string $utm_campaign_source what is the key used for google analytics link
-     * @param bool   $display_sidebar     whether to use the sidebar template or the full template for the page.  TRUE
-     *                                    = SHOW sidebar, FALSE = no sidebar. Default no sidebar.
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @since 4.3.2
-     */
-    public function display_admin_caf_preview_page($utm_campaign_source = '', $display_sidebar = true)
-    {
-        // let's generate a default preview action button if there isn't one already present.
-        $this->_labels['buttons']['buy_now']           = esc_html__(
-            'Upgrade to Event Espresso 4 Right Now',
-            'event_espresso'
-        );
-        $buy_now_url                                   = add_query_arg(
-            [
-                'ee_ver'       => 'ee4',
-                'utm_source'   => 'ee4_plugin_admin',
-                'utm_medium'   => 'link',
-                'utm_campaign' => $utm_campaign_source,
-                'utm_content'  => 'buy_now_button',
-            ],
-            'https://eventespresso.com/pricing/'
-        );
-        $this->_template_args['preview_action_button'] = ! isset($this->_template_args['preview_action_button'])
-            ? $this->get_action_link_or_button(
-                '',
-                'buy_now',
-                [],
-                'button-primary button-large',
-                esc_url_raw($buy_now_url),
-                true
-            )
-            : $this->_template_args['preview_action_button'];
-        $this->_template_args['admin_page_content']    = EEH_Template::display_template(
-            EE_ADMIN_TEMPLATE . 'admin_caf_full_page_preview.template.php',
-            $this->_template_args,
-            true
-        );
-        $this->_display_admin_page($display_sidebar);
-    }
-
-
-    /**
-     * display_admin_list_table_page_with_sidebar
-     * generates HTML wrapper for an admin_page with list_table
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws DomainException
-     */
-    public function display_admin_list_table_page_with_sidebar()
-    {
-        $this->_display_admin_list_table_page(true);
-    }
-
-
-    /**
-     * display_admin_list_table_page_with_no_sidebar
-     * generates HTML wrapper for an admin_page with list_table (but with no sidebar)
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws DomainException
-     */
-    public function display_admin_list_table_page_with_no_sidebar()
-    {
-        $this->_display_admin_list_table_page();
-    }
-
-
-    /**
-     * generates html wrapper for an admin_list_table page
-     *
-     * @param boolean $sidebar whether to display with sidebar or not.
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    private function _display_admin_list_table_page($sidebar = false)
-    {
-        // setup search attributes
-        $this->_set_search_attributes();
-        $this->_template_args['current_page']     = $this->_wp_page_slug;
-        $template_path                            = EE_ADMIN_TEMPLATE . 'admin_list_wrapper.template.php';
-        $this->_template_args['table_url']        = $this->request->isAjax()
-            ? add_query_arg(['noheader' => 'true', 'route' => $this->_req_action], $this->_admin_base_url)
-            : add_query_arg(['route' => $this->_req_action], $this->_admin_base_url);
-        $this->_template_args['list_table']       = $this->_list_table_object;
-        $this->_template_args['current_route']    = $this->_req_action;
-        $this->_template_args['list_table_class'] = get_class($this->_list_table_object);
-        $ajax_sorting_callback                    = $this->_list_table_object->get_ajax_sorting_callback();
-        if (! empty($ajax_sorting_callback)) {
-            $sortable_list_table_form_fields = wp_nonce_field(
-                $ajax_sorting_callback . '_nonce',
-                $ajax_sorting_callback . '_nonce',
-                false,
-                false
-            );
-            $sortable_list_table_form_fields .= '<input type="hidden" id="ajax_table_sort_page" name="ajax_table_sort_page" value="'
-                                                . $this->page_slug
-                                                . '" />';
-            $sortable_list_table_form_fields .= '<input type="hidden" id="ajax_table_sort_action" name="ajax_table_sort_action" value="'
-                                                . $ajax_sorting_callback
-                                                . '" />';
-        } else {
-            $sortable_list_table_form_fields = '';
-        }
-        $this->_template_args['sortable_list_table_form_fields'] = $sortable_list_table_form_fields;
-        $hidden_form_fields                                      =
-            isset($this->_template_args['list_table_hidden_fields'])
-                ? $this->_template_args['list_table_hidden_fields']
-                : '';
-
-        $nonce_ref          = $this->_req_action . '_nonce';
-        $hidden_form_fields .= '
+	}
+
+
+	/**
+	 * facade for add_meta_box
+	 *
+	 * @param string  $action        where the metabox gets displayed
+	 * @param string  $title         Title of Metabox (output in metabox header)
+	 * @param string  $callback      If not empty and $create_fun is set to false then we'll use a custom callback
+	 *                               instead of the one created in here.
+	 * @param array   $callback_args an array of args supplied for the metabox
+	 * @param string  $column        what metabox column
+	 * @param string  $priority      give this metabox a priority (using accepted priorities for wp meta boxes)
+	 * @param boolean $create_func   default is true.  Basically we can say we don't WANT to have the runtime function
+	 *                               created but just set our own callback for wp's add_meta_box.
+	 * @throws DomainException
+	 */
+	public function _add_admin_page_meta_box(
+		$action,
+		$title,
+		$callback,
+		$callback_args,
+		$column = 'normal',
+		$priority = 'high',
+		$create_func = true
+	) {
+		do_action('AHEE_log', __FILE__, __FUNCTION__, $callback);
+		// if we have empty callback args and we want to automatically create the metabox callback then we need to make sure the callback args are generated.
+		if (empty($callback_args) && $create_func) {
+			$callback_args = [
+				'template_path' => $this->_template_path,
+				'template_args' => $this->_template_args,
+			];
+		}
+		// if $create_func is true (default) then we automatically create the function for displaying the actual meta box.  If false then we take the $callback reference passed through and use it instead (so callers can define their own callback function/method if they wish)
+		$call_back_func = $create_func
+			? function ($post, $metabox) {
+				do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+				echo EEH_Template::display_template(
+					$metabox['args']['template_path'],
+					$metabox['args']['template_args'],
+					true
+				);
+			}
+			: $callback;
+		add_meta_box(
+			str_replace('_', '-', $action) . '-mbox',
+			$title,
+			$call_back_func,
+			$this->_wp_page_slug,
+			$column,
+			$priority,
+			$callback_args
+		);
+	}
+
+
+	/**
+	 * generates HTML wrapper for and admin details page that contains metaboxes in columns
+	 *
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	public function display_admin_page_with_metabox_columns()
+	{
+		$this->_template_args['post_body_content']  = $this->_template_args['admin_page_content'];
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(
+			$this->_column_template_path,
+			$this->_template_args,
+			true
+		);
+		// the final wrapper
+		$this->admin_page_wrapper();
+	}
+
+
+	/**
+	 * generates  HTML wrapper for an admin details page
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws DomainException
+	 */
+	public function display_admin_page_with_sidebar()
+	{
+		$this->_display_admin_page(true);
+	}
+
+
+	/**
+	 * generates  HTML wrapper for an admin details page (except no sidebar)
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws DomainException
+	 */
+	public function display_admin_page_with_no_sidebar()
+	{
+		$this->_display_admin_page();
+	}
+
+
+	/**
+	 * generates HTML wrapper for an EE about admin page (no sidebar)
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws DomainException
+	 */
+	public function display_about_admin_page()
+	{
+		$this->_display_admin_page(false, true);
+	}
+
+
+	/**
+	 * display_admin_page
+	 * contains the code for actually displaying an admin page
+	 *
+	 * @param boolean $sidebar true with sidebar, false without
+	 * @param boolean $about   use the about_admin_wrapper instead of the default.
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	private function _display_admin_page($sidebar = false, $about = false)
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		// custom remove metaboxes hook to add or remove any metaboxes to/from Admin pages.
+		do_action('AHEE__EE_Admin_Page___display_admin_page__modify_metaboxes');
+		// set current wp page slug - looks like: event-espresso_page_event_categories
+		// keep in mind "event-espresso" COULD be something else if the top level menu label has been translated.
+		$this->_template_args['current_page']              = $this->_wp_page_slug;
+		$this->_template_args['admin_page_wrapper_div_id'] = $this->_cpt_route
+			? 'poststuff'
+			: 'espresso-default-admin';
+		$template_path                                     = $sidebar
+			? EE_ADMIN_TEMPLATE . 'admin_details_wrapper.template.php'
+			: EE_ADMIN_TEMPLATE . 'admin_details_wrapper_no_sidebar.template.php';
+		if ($this->request->isAjax()) {
+			$template_path = EE_ADMIN_TEMPLATE . 'admin_details_wrapper_no_sidebar_ajax.template.php';
+		}
+		$template_path                                     = ! empty($this->_column_template_path)
+			? $this->_column_template_path : $template_path;
+		$this->_template_args['post_body_content']         = isset($this->_template_args['admin_page_content'])
+			? $this->_template_args['admin_page_content']
+			: '';
+		$this->_template_args['before_admin_page_content'] = isset($this->_template_args['before_admin_page_content'])
+			? $this->_template_args['before_admin_page_content']
+			: '';
+		$this->_template_args['after_admin_page_content']  = isset($this->_template_args['after_admin_page_content'])
+			? $this->_template_args['after_admin_page_content']
+			: '';
+		$this->_template_args['admin_page_content']        = EEH_Template::display_template(
+			$template_path,
+			$this->_template_args,
+			true
+		);
+		// the final template wrapper
+		$this->admin_page_wrapper($about);
+	}
+
+
+	/**
+	 * This is used to display caf preview pages.
+	 *
+	 * @param string $utm_campaign_source what is the key used for google analytics link
+	 * @param bool   $display_sidebar     whether to use the sidebar template or the full template for the page.  TRUE
+	 *                                    = SHOW sidebar, FALSE = no sidebar. Default no sidebar.
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @since 4.3.2
+	 */
+	public function display_admin_caf_preview_page($utm_campaign_source = '', $display_sidebar = true)
+	{
+		// let's generate a default preview action button if there isn't one already present.
+		$this->_labels['buttons']['buy_now']           = esc_html__(
+			'Upgrade to Event Espresso 4 Right Now',
+			'event_espresso'
+		);
+		$buy_now_url                                   = add_query_arg(
+			[
+				'ee_ver'       => 'ee4',
+				'utm_source'   => 'ee4_plugin_admin',
+				'utm_medium'   => 'link',
+				'utm_campaign' => $utm_campaign_source,
+				'utm_content'  => 'buy_now_button',
+			],
+			'https://eventespresso.com/pricing/'
+		);
+		$this->_template_args['preview_action_button'] = ! isset($this->_template_args['preview_action_button'])
+			? $this->get_action_link_or_button(
+				'',
+				'buy_now',
+				[],
+				'button-primary button-large',
+				esc_url_raw($buy_now_url),
+				true
+			)
+			: $this->_template_args['preview_action_button'];
+		$this->_template_args['admin_page_content']    = EEH_Template::display_template(
+			EE_ADMIN_TEMPLATE . 'admin_caf_full_page_preview.template.php',
+			$this->_template_args,
+			true
+		);
+		$this->_display_admin_page($display_sidebar);
+	}
+
+
+	/**
+	 * display_admin_list_table_page_with_sidebar
+	 * generates HTML wrapper for an admin_page with list_table
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws DomainException
+	 */
+	public function display_admin_list_table_page_with_sidebar()
+	{
+		$this->_display_admin_list_table_page(true);
+	}
+
+
+	/**
+	 * display_admin_list_table_page_with_no_sidebar
+	 * generates HTML wrapper for an admin_page with list_table (but with no sidebar)
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws DomainException
+	 */
+	public function display_admin_list_table_page_with_no_sidebar()
+	{
+		$this->_display_admin_list_table_page();
+	}
+
+
+	/**
+	 * generates html wrapper for an admin_list_table page
+	 *
+	 * @param boolean $sidebar whether to display with sidebar or not.
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	private function _display_admin_list_table_page($sidebar = false)
+	{
+		// setup search attributes
+		$this->_set_search_attributes();
+		$this->_template_args['current_page']     = $this->_wp_page_slug;
+		$template_path                            = EE_ADMIN_TEMPLATE . 'admin_list_wrapper.template.php';
+		$this->_template_args['table_url']        = $this->request->isAjax()
+			? add_query_arg(['noheader' => 'true', 'route' => $this->_req_action], $this->_admin_base_url)
+			: add_query_arg(['route' => $this->_req_action], $this->_admin_base_url);
+		$this->_template_args['list_table']       = $this->_list_table_object;
+		$this->_template_args['current_route']    = $this->_req_action;
+		$this->_template_args['list_table_class'] = get_class($this->_list_table_object);
+		$ajax_sorting_callback                    = $this->_list_table_object->get_ajax_sorting_callback();
+		if (! empty($ajax_sorting_callback)) {
+			$sortable_list_table_form_fields = wp_nonce_field(
+				$ajax_sorting_callback . '_nonce',
+				$ajax_sorting_callback . '_nonce',
+				false,
+				false
+			);
+			$sortable_list_table_form_fields .= '<input type="hidden" id="ajax_table_sort_page" name="ajax_table_sort_page" value="'
+												. $this->page_slug
+												. '" />';
+			$sortable_list_table_form_fields .= '<input type="hidden" id="ajax_table_sort_action" name="ajax_table_sort_action" value="'
+												. $ajax_sorting_callback
+												. '" />';
+		} else {
+			$sortable_list_table_form_fields = '';
+		}
+		$this->_template_args['sortable_list_table_form_fields'] = $sortable_list_table_form_fields;
+		$hidden_form_fields                                      =
+			isset($this->_template_args['list_table_hidden_fields'])
+				? $this->_template_args['list_table_hidden_fields']
+				: '';
+
+		$nonce_ref          = $this->_req_action . '_nonce';
+		$hidden_form_fields .= '
             <input type="hidden" name="' . $nonce_ref . '" value="' . wp_create_nonce($nonce_ref) . '">';
 
-        $this->_template_args['list_table_hidden_fields']        = $hidden_form_fields;
-        // display message about search results?
-        $search = $this->request->getRequestParam('s');
-        $this->_template_args['before_list_table'] .= ! empty($search)
-            ? '<p class="ee-search-results">' . sprintf(
-                esc_html__('Displaying search results for the search string: %1$s', 'event_espresso'),
-                trim($search, '%')
-            ) . '</p>'
-            : '';
-        // filter before_list_table template arg
-        $this->_template_args['before_list_table'] = apply_filters(
-            'FHEE__EE_Admin_Page___display_admin_list_table_page__before_list_table__template_arg',
-            $this->_template_args['before_list_table'],
-            $this->page_slug,
-            $this->request->requestParams(),
-            $this->_req_action
-        );
-        // convert to array and filter again
-        // arrays are easier to inject new items in a specific location,
-        // but would not be backwards compatible, so we have to add a new filter
-        $this->_template_args['before_list_table'] = implode(
-            " \n",
-            (array) apply_filters(
-                'FHEE__EE_Admin_Page___display_admin_list_table_page__before_list_table__template_args_array',
-                (array) $this->_template_args['before_list_table'],
-                $this->page_slug,
-                $this->request->requestParams(),
-                $this->_req_action
-            )
-        );
-        // filter after_list_table template arg
-        $this->_template_args['after_list_table'] = apply_filters(
-            'FHEE__EE_Admin_Page___display_admin_list_table_page__after_list_table__template_arg',
-            $this->_template_args['after_list_table'],
-            $this->page_slug,
-            $this->request->requestParams(),
-            $this->_req_action
-        );
-        // convert to array and filter again
-        // arrays are easier to inject new items in a specific location,
-        // but would not be backwards compatible, so we have to add a new filter
-        $this->_template_args['after_list_table']   = implode(
-            " \n",
-            (array) apply_filters(
-                'FHEE__EE_Admin_Page___display_admin_list_table_page__after_list_table__template_args_array',
-                (array) $this->_template_args['after_list_table'],
-                $this->page_slug,
-                $this->request->requestParams(),
-                $this->_req_action
-            )
-        );
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            $template_path,
-            $this->_template_args,
-            true
-        );
-        // the final template wrapper
-        if ($sidebar) {
-            $this->display_admin_page_with_sidebar();
-        } else {
-            $this->display_admin_page_with_no_sidebar();
-        }
-    }
-
-
-    /**
-     * This just prepares a legend using the given items and the admin_details_legend.template.php file and returns the
-     * html string for the legend.
-     * $items are expected in an array in the following format:
-     * $legend_items = array(
-     *        'item_id' => array(
-     *            'icon' => 'http://url_to_icon_being_described.png',
-     *            'desc' => esc_html__('localized description of item');
-     *        )
-     * );
-     *
-     * @param array $items see above for format of array
-     * @return string html string of legend
-     * @throws DomainException
-     */
-    protected function _display_legend($items)
-    {
-        $this->_template_args['items'] = apply_filters(
-            'FHEE__EE_Admin_Page___display_legend__items',
-            (array) $items,
-            $this
-        );
-        return EEH_Template::display_template(
-            EE_ADMIN_TEMPLATE . 'admin_details_legend.template.php',
-            $this->_template_args,
-            true
-        );
-    }
-
-
-    /**
-     * This is used whenever we're DOING_AJAX to return a formatted json array that our calling javascript can expect
-     * The returned json object is created from an array in the following format:
-     * array(
-     *  'error' => FALSE, //(default FALSE), contains any errors and/or exceptions (exceptions return json early),
-     *  'success' => FALSE, //(default FALSE) - contains any special success message.
-     *  'notices' => '', // - contains any EE_Error formatted notices
-     *  'content' => 'string can be html', //this is a string of formatted content (can be html)
-     *  'data' => array() //this can be any key/value pairs that a method returns for later json parsing by the js.
-     *  We're also going to include the template args with every package (so js can pick out any specific template args
-     *  that might be included in here)
-     * )
-     * The json object is populated by whatever is set in the $_template_args property.
-     *
-     * @param bool  $sticky_notices    Used to indicate whether you want to ensure notices are added to a transient
-     *                                 instead of displayed.
-     * @param array $notices_arguments Use this to pass any additional args on to the _process_notices.
-     * @return void
-     * @throws EE_Error
-     */
-    protected function _return_json($sticky_notices = false, $notices_arguments = [])
-    {
-        // make sure any EE_Error notices have been handled.
-        $this->_process_notices($notices_arguments, true, $sticky_notices);
-        $data = isset($this->_template_args['data']) ? $this->_template_args['data'] : [];
-        unset($this->_template_args['data']);
-        $json = [
-            'error'     => isset($this->_template_args['error']) ? $this->_template_args['error'] : false,
-            'success'   => isset($this->_template_args['success']) ? $this->_template_args['success'] : false,
-            'errors'    => isset($this->_template_args['errors']) ? $this->_template_args['errors'] : false,
-            'attention' => isset($this->_template_args['attention']) ? $this->_template_args['attention'] : false,
-            'notices'   => EE_Error::get_notices(),
-            'content'   => isset($this->_template_args['admin_page_content'])
-                ? $this->_template_args['admin_page_content'] : '',
-            'data'      => array_merge($data, ['template_args' => $this->_template_args]),
-            'isEEajax'  => true
-            // special flag so any ajax.Success methods in js can identify this return package as a EEajax package.
-        ];
-        // make sure there are no php errors or headers_sent.  Then we can set correct json header.
-        if (null === error_get_last() || ! headers_sent()) {
-            header('Content-Type: application/json; charset=UTF-8');
-        }
-        echo wp_json_encode($json);
-        exit();
-    }
-
-
-    /**
-     * Simply a wrapper for the protected method so we can call this outside the class (ONLY when doing ajax)
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    public function return_json()
-    {
-        if ($this->request->isAjax()) {
-            $this->_return_json();
-        } else {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__('The public %s method can only be called when DOING_AJAX = TRUE', 'event_espresso'),
-                    __FUNCTION__
-                )
-            );
-        }
-    }
-
-
-    /**
-     * This provides a way for child hook classes to send along themselves by reference so methods/properties within
-     * them can be accessed by EE_Admin_child pages. This is assigned to the $_hook_obj property.
-     *
-     * @param EE_Admin_Hooks $hook_obj This will be the object for the EE_Admin_Hooks child
-     */
-    public function set_hook_object(EE_Admin_Hooks $hook_obj)
-    {
-        $this->_hook_obj = $hook_obj;
-    }
-
-
-    /**
-     *        generates  HTML wrapper with Tabbed nav for an admin page
-     *
-     * @param boolean $about whether to use the special about page wrapper or default.
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    public function admin_page_wrapper($about = false)
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $this->_nav_tabs                                   = $this->_get_main_nav_tabs();
-        $this->_template_args['nav_tabs']                  = $this->_nav_tabs;
-        $this->_template_args['admin_page_title']          = $this->_admin_page_title;
-
-        $this->_template_args['before_admin_page_content'] = apply_filters(
-            "FHEE_before_admin_page_content{$this->_current_page}{$this->_current_view}",
-            isset($this->_template_args['before_admin_page_content'])
-                ? $this->_template_args['before_admin_page_content']
-                : ''
-        );
-
-        $this->_template_args['after_admin_page_content']  = apply_filters(
-            "FHEE_after_admin_page_content{$this->_current_page}{$this->_current_view}",
-            isset($this->_template_args['after_admin_page_content'])
-                ? $this->_template_args['after_admin_page_content']
-                : ''
-        );
-        $this->_template_args['after_admin_page_content']  .= $this->_set_help_popup_content();
-
-        if ($this->request->isAjax()) {
-            $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-                // $template_path,
-                EE_ADMIN_TEMPLATE . 'admin_wrapper_ajax.template.php',
-                $this->_template_args,
-                true
-            );
-            $this->_return_json();
-        }
-        // load settings page wrapper template
-        $template_path = $about
-            ? EE_ADMIN_TEMPLATE . 'about_admin_wrapper.template.php'
-            : EE_ADMIN_TEMPLATE . 'admin_wrapper.template.php';
-
-        EEH_Template::display_template($template_path, $this->_template_args);
-    }
-
-
-    /**
-     * This returns the admin_nav tabs html using the configuration in the _nav_tabs property
-     *
-     * @return string html
-     * @throws EE_Error
-     */
-    protected function _get_main_nav_tabs()
-    {
-        // let's generate the html using the EEH_Tabbed_Content helper.
-        // We do this here so that it's possible for child classes to add in nav tabs dynamically at the last minute
-        // (rather than setting in the page_routes array)
-        return EEH_Tabbed_Content::display_admin_nav_tabs($this->_nav_tabs);
-    }
-
-
-    /**
-     *        sort nav tabs
-     *
-     * @param $a
-     * @param $b
-     * @return int
-     */
-    private function _sort_nav_tabs($a, $b)
-    {
-        if ($a['order'] === $b['order']) {
-            return 0;
-        }
-        return ($a['order'] < $b['order']) ? -1 : 1;
-    }
-
-
-    /**
-     *    generates HTML for the forms used on admin pages
-     *
-     * @param array  $input_vars   - array of input field details
-     * @param string $generator    (options are 'string' or 'array', basically use this to indicate which generator to
-     *                             use)
-     * @param bool   $id
-     * @return array|string
-     * @uses   EEH_Form_Fields::get_form_fields (/helper/EEH_Form_Fields.helper.php)
-     * @uses   EEH_Form_Fields::get_form_fields_array (/helper/EEH_Form_Fields.helper.php)
-     */
-    protected function _generate_admin_form_fields($input_vars = [], $generator = 'string', $id = false)
-    {
-        return $generator === 'string'
-            ? EEH_Form_Fields::get_form_fields($input_vars, $id)
-            : EEH_Form_Fields::get_form_fields_array($input_vars);
-    }
-
-
-    /**
-     * generates the "Save" and "Save & Close" buttons for edit forms
-     *
-     * @param bool             $both     if true then both buttons will be generated.  If false then just the "Save &
-     *                                   Close" button.
-     * @param array            $text     if included, generator will use the given text for the buttons ( array([0] =>
-     *                                   'Save', [1] => 'save & close')
-     * @param array            $actions  if included allows us to set the actions that each button will carry out (i.e.
-     *                                   via the "name" value in the button).  We can also use this to just dump
-     *                                   default actions by submitting some other value.
-     * @param bool|string|null $referrer if false then we just do the default action on save and close.  Other wise it
-     *                                   will use the $referrer string. IF null, then we don't do ANYTHING on save and
-     *                                   close (normal form handling).
-     */
-    protected function _set_save_buttons($both = true, $text = [], $actions = [], $referrer = null)
-    {
-        // make sure $text and $actions are in an array
-        $text          = (array) $text;
-        $actions       = (array) $actions;
-        $referrer_url  = ! empty($referrer) ? $referrer : $this->request->getServerParam('REQUEST_URI');
-        $button_text   = ! empty($text)
-            ? $text
-            : [
-                esc_html__('Save', 'event_espresso'),
-                esc_html__('Save and Close', 'event_espresso'),
-            ];
-        $default_names = ['save', 'save_and_close'];
-        $buttons = '';
-        foreach ($button_text as $key => $button) {
-            $ref     = $default_names[ $key ];
-            $name    = ! empty($actions) ? $actions[ $key ] : $ref;
-            $buttons .= '<input type="submit" class="button-primary ' . $ref . '" '
-                        . 'value="' . $button . '" name="' . $name . '" '
-                        . 'id="' . $this->_current_view . '_' . $ref . '" />';
-            if (! $both) {
-                break;
-            }
-        }
-        // add in a hidden index for the current page (so save and close redirects properly)
-        $buttons .= '<input type="hidden" id="save_and_close_referrer" name="save_and_close_referrer" value="'
-                   . $referrer_url
-                   . '" />';
-        $this->_template_args['save_buttons'] = $buttons;
-    }
-
-
-    /**
-     * Wrapper for the protected function.  Allows plugins/addons to call this to set the form tags.
-     *
-     * @param string $route
-     * @param array  $additional_hidden_fields
-     * @see   $this->_set_add_edit_form_tags() for details on params
-     * @since 4.6.0
-     */
-    public function set_add_edit_form_tags($route = '', $additional_hidden_fields = [])
-    {
-        $this->_set_add_edit_form_tags($route, $additional_hidden_fields);
-    }
-
-
-    /**
-     * set form open and close tags on add/edit pages.
-     *
-     * @param string $route                    the route you want the form to direct to
-     * @param array  $additional_hidden_fields any additional hidden fields required in the form header
-     * @return void
-     */
-    protected function _set_add_edit_form_tags($route = '', $additional_hidden_fields = [])
-    {
-        if (empty($route)) {
-            $user_msg = esc_html__(
-                'An error occurred. No action was set for this page\'s form.',
-                'event_espresso'
-            );
-            $dev_msg  = $user_msg . "\n"
-                        . sprintf(
-                            esc_html__('The $route argument is required for the %s->%s method.', 'event_espresso'),
-                            __FUNCTION__,
-                            __CLASS__
-                        );
-            EE_Error::add_error($user_msg . '||' . $dev_msg, __FILE__, __FUNCTION__, __LINE__);
-        }
-        // open form
-        $this->_template_args['before_admin_page_content'] = '<form name="form" method="post" action="'
-                                                             . $this->_admin_base_url
-                                                             . '" id="'
-                                                             . $route
-                                                             . '_event_form" >';
-        // add nonce
-        $nonce                                             =
-            wp_nonce_field($route . '_nonce', $route . '_nonce', false, false);
-        $this->_template_args['before_admin_page_content'] .= "\n\t" . $nonce;
-        // add REQUIRED form action
-        $hidden_fields = [
-            'action' => ['type' => 'hidden', 'value' => $route],
-        ];
-        // merge arrays
-        $hidden_fields = is_array($additional_hidden_fields)
-            ? array_merge($hidden_fields, $additional_hidden_fields)
-            : $hidden_fields;
-        // generate form fields
-        $form_fields = $this->_generate_admin_form_fields($hidden_fields, 'array');
-        // add fields to form
-        foreach ((array) $form_fields as $form_field) {
-            $this->_template_args['before_admin_page_content'] .= "\n\t" . $form_field['field'];
-        }
-        // close form
-        $this->_template_args['after_admin_page_content'] = '</form>';
-    }
-
-
-    /**
-     * Public Wrapper for _redirect_after_action() method since its
-     * discovered it would be useful for external code to have access.
-     *
-     * @param bool   $success
-     * @param string $what
-     * @param string $action_desc
-     * @param array  $query_args
-     * @param bool   $override_overwrite
-     * @throws EE_Error
-     * @see   EE_Admin_Page::_redirect_after_action() for params.
-     * @since 4.5.0
-     */
-    public function redirect_after_action(
-        $success = false,
-        $what = 'item',
-        $action_desc = 'processed',
-        $query_args = [],
-        $override_overwrite = false
-    ) {
-        $this->_redirect_after_action(
-            $success,
-            $what,
-            $action_desc,
-            $query_args,
-            $override_overwrite
-        );
-    }
-
-
-    /**
-     * Helper method for merging existing request data with the returned redirect url.
-     *
-     * This is typically used for redirects after an action so that if the original view was a filtered view those
-     * filters are still applied.
-     *
-     * @param array $new_route_data
-     * @return array
-     */
-    protected function mergeExistingRequestParamsWithRedirectArgs(array $new_route_data)
-    {
-        foreach ($this->request->requestParams() as $ref => $value) {
-            // unset nonces
-            if (strpos($ref, 'nonce') !== false) {
-                $this->request->unSetRequestParam($ref);
-                continue;
-            }
-            // urlencode values.
-            $value = is_array($value) ? array_map('urlencode', $value) : urlencode($value);
-            $this->request->setRequestParam($ref, $value);
-        }
-        return array_merge($this->request->requestParams(), $new_route_data);
-    }
-
-
-    /**
-     *    _redirect_after_action
-     *
-     * @param int    $success            - whether success was for two or more records, or just one, or none
-     * @param string $what               - what the action was performed on
-     * @param string $action_desc        - what was done ie: updated, deleted, etc
-     * @param array  $query_args         - an array of query_args to be added to the URL to redirect to after the admin
-     *                                   action is completed
-     * @param BOOL   $override_overwrite by default all EE_Error::success messages are overwritten, this allows you to
-     *                                   override this so that they show.
-     * @return void
-     * @throws EE_Error
-     */
-    protected function _redirect_after_action(
-        $success = 0,
-        $what = 'item',
-        $action_desc = 'processed',
-        $query_args = [],
-        $override_overwrite = false
-    ) {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        // class name for actions/filters.
-        $classname = get_class($this);
-        // set redirect url.
-        // Note if there is a "page" index in the $query_args then we go with vanilla admin.php route,
-        // otherwise we go with whatever is set as the _admin_base_url
-        $redirect_url = isset($query_args['page']) ? admin_url('admin.php') : $this->_admin_base_url;
-        $notices      = EE_Error::get_notices(false);
-        // overwrite default success messages //BUT ONLY if overwrite not overridden
-        if (! $override_overwrite || ! empty($notices['errors'])) {
-            EE_Error::overwrite_success();
-        }
-        if (! empty($what) && ! empty($action_desc) && empty($notices['errors'])) {
-            // how many records affected ? more than one record ? or just one ?
-            if ($success > 1) {
-                // set plural msg
-                EE_Error::add_success(
-                    sprintf(
-                        esc_html__('The "%s" have been successfully %s.', 'event_espresso'),
-                        $what,
-                        $action_desc
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            } elseif ($success === 1) {
-                // set singular msg
-                EE_Error::add_success(
-                    sprintf(
-                        esc_html__('The "%s" has been successfully %s.', 'event_espresso'),
-                        $what,
-                        $action_desc
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-        }
-        // check that $query_args isn't something crazy
-        if (! is_array($query_args)) {
-            $query_args = [];
-        }
-        /**
-         * Allow injecting actions before the query_args are modified for possible different
-         * redirections on save and close actions
-         *
-         * @param array $query_args       The original query_args array coming into the
-         *                                method.
-         * @since 4.2.0
-         */
-        do_action(
-            "AHEE__{$classname}___redirect_after_action__before_redirect_modification_{$this->_req_action}",
-            $query_args
-        );
-        // calculate where we're going (if we have a "save and close" button pushed)
-
-        if (
-            $this->request->requestParamIsSet('save_and_close')
-            && $this->request->requestParamIsSet('save_and_close_referrer')
-        ) {
-            // even though we have the save_and_close referrer, we need to parse the url for the action in order to generate a nonce
-            $parsed_url = parse_url($this->request->getRequestParam('save_and_close_referrer', '', 'url'));
-            // regenerate query args array from referrer URL
-            parse_str($parsed_url['query'], $query_args);
-            // correct page and action will be in the query args now
-            $redirect_url = admin_url('admin.php');
-        }
-        // merge any default query_args set in _default_route_query_args property
-        if (! empty($this->_default_route_query_args) && ! $this->_is_UI_request) {
-            $args_to_merge = [];
-            foreach ($this->_default_route_query_args as $query_param => $query_value) {
-                // is there a wp_referer array in our _default_route_query_args property?
-                if ($query_param === 'wp_referer') {
-                    $query_value = (array) $query_value;
-                    foreach ($query_value as $reference => $value) {
-                        if (strpos($reference, 'nonce') !== false) {
-                            continue;
-                        }
-                        // finally we will override any arguments in the referer with
-                        // what might be set on the _default_route_query_args array.
-                        if (isset($this->_default_route_query_args[ $reference ])) {
-                            $args_to_merge[ $reference ] = urlencode($this->_default_route_query_args[ $reference ]);
-                        } else {
-                            $args_to_merge[ $reference ] = urlencode($value);
-                        }
-                    }
-                    continue;
-                }
-                $args_to_merge[ $query_param ] = $query_value;
-            }
-            // now let's merge these arguments but override with what was specifically sent in to the
-            // redirect.
-            $query_args = array_merge($args_to_merge, $query_args);
-        }
-        $this->_process_notices($query_args);
-        // generate redirect url
-        // if redirecting to anything other than the main page, add a nonce
-        if (isset($query_args['action'])) {
-            // manually generate wp_nonce and merge that with the query vars
-            // becuz the wp_nonce_url function wrecks havoc on some vars
-            $query_args['_wpnonce'] = wp_create_nonce($query_args['action'] . '_nonce');
-        }
-        // we're adding some hooks and filters in here for processing any things just before redirects
-        // (example: an admin page has done an insert or update and we want to run something after that).
-        do_action('AHEE_redirect_' . $classname . $this->_req_action, $query_args);
-        $redirect_url = apply_filters(
-            'FHEE_redirect_' . $classname . $this->_req_action,
-            self::add_query_args_and_nonce($query_args, $redirect_url),
-            $query_args
-        );
-        // check if we're doing ajax.  If we are then lets just return the results and js can handle how it wants.
-        if ($this->request->isAjax()) {
-            $default_data                    = [
-                'close'        => true,
-                'redirect_url' => $redirect_url,
-                'where'        => 'main',
-                'what'         => 'append',
-            ];
-            $this->_template_args['success'] = $success;
-            $this->_template_args['data']    = ! empty($this->_template_args['data']) ? array_merge(
-                $default_data,
-                $this->_template_args['data']
-            ) : $default_data;
-            $this->_return_json();
-        }
-        wp_safe_redirect($redirect_url);
-        exit();
-    }
-
-
-    /**
-     * process any notices before redirecting (or returning ajax request)
-     * This method sets the $this->_template_args['notices'] attribute;
-     *
-     * @param array $query_args         any query args that need to be used for notice transient ('action')
-     * @param bool  $skip_route_verify  This is typically used when we are processing notices REALLY early and
-     *                                  page_routes haven't been defined yet.
-     * @param bool  $sticky_notices     This is used to flag that regardless of whether this is doing_ajax or not, we
-     *                                  still save a transient for the notice.
-     * @return void
-     * @throws EE_Error
-     */
-    protected function _process_notices($query_args = [], $skip_route_verify = false, $sticky_notices = true)
-    {
-        // first let's set individual error properties if doing_ajax and the properties aren't already set.
-        if ($this->request->isAjax()) {
-            $notices = EE_Error::get_notices(false);
-            if (empty($this->_template_args['success'])) {
-                $this->_template_args['success'] = isset($notices['success']) ? $notices['success'] : false;
-            }
-            if (empty($this->_template_args['errors'])) {
-                $this->_template_args['errors'] = isset($notices['errors']) ? $notices['errors'] : false;
-            }
-            if (empty($this->_template_args['attention'])) {
-                $this->_template_args['attention'] = isset($notices['attention']) ? $notices['attention'] : false;
-            }
-        }
-        $this->_template_args['notices'] = EE_Error::get_notices();
-        // IF this isn't ajax we need to create a transient for the notices using the route (however, overridden if $sticky_notices == true)
-        if (! $this->request->isAjax() || $sticky_notices) {
-            $route = isset($query_args['action']) ? $query_args['action'] : 'default';
-            $this->_add_transient(
-                $route,
-                $this->_template_args['notices'],
-                true,
-                $skip_route_verify
-            );
-        }
-    }
-
-
-    /**
-     * get_action_link_or_button
-     * returns the button html for adding, editing, or deleting an item (depending on given type)
-     *
-     * @param string $action        use this to indicate which action the url is generated with.
-     * @param string $type          accepted strings must be defined in the $_labels['button'] array(as the key)
-     *                              property.
-     * @param array  $extra_request if the button requires extra params you can include them in $key=>$value pairs.
-     * @param string $class         Use this to give the class for the button. Defaults to 'button-primary'
-     * @param string $base_url      If this is not provided
-     *                              the _admin_base_url will be used as the default for the button base_url.
-     *                              Otherwise this value will be used.
-     * @param bool   $exclude_nonce If true then no nonce will be in the generated button link.
-     * @return string
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function get_action_link_or_button(
-        $action,
-        $type = 'add',
-        $extra_request = [],
-        $class = 'button button--primary',
-        $base_url = '',
-        $exclude_nonce = false
-    ) {
-        // first let's validate the action (if $base_url is FALSE otherwise validation will happen further along)
-        if (empty($base_url) && ! isset($this->_page_routes[ $action ])) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'There is no page route for given action for the button.  This action was given: %s',
-                        'event_espresso'
-                    ),
-                    $action
-                )
-            );
-        }
-        if (! isset($this->_labels['buttons'][ $type ])) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'There is no label for the given button type (%s). Labels are set in the <code>_page_config</code> property.',
-                        'event_espresso'
-                    ),
-                    $type
-                )
-            );
-        }
-        // finally check user access for this button.
-        $has_access = $this->check_user_access($action, true);
-        if (! $has_access) {
-            return '';
-        }
-        $_base_url  = ! $base_url ? $this->_admin_base_url : $base_url;
-        $query_args = [
-            'action' => $action,
-        ];
-        // merge extra_request args but make sure our original action takes precedence and doesn't get overwritten.
-        if (! empty($extra_request)) {
-            $query_args = array_merge($extra_request, $query_args);
-        }
-        $url = self::add_query_args_and_nonce($query_args, $_base_url, false, $exclude_nonce);
-        return EEH_Template::get_button_or_link($url, $this->_labels['buttons'][ $type ], $class);
-    }
-
-
-    /**
-     * _per_page_screen_option
-     * Utility function for adding in a per_page_option in the screen_options_dropdown.
-     *
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    protected function _per_page_screen_option()
-    {
-        $option = 'per_page';
-        $args   = [
-            'label'   => apply_filters(
-                'FHEE__EE_Admin_Page___per_page_screen_options___label',
-                $this->_admin_page_title,
-                $this
-            ),
-            'default' => (int) apply_filters(
-                'FHEE__EE_Admin_Page___per_page_screen_options__default',
-                20
-            ),
-            'option'  => $this->_current_page . '_' . $this->_current_view . '_per_page',
-        ];
-        // ONLY add the screen option if the user has access to it.
-        if ($this->check_user_access($this->_current_view, true)) {
-            add_screen_option($option, $args);
-        }
-    }
-
-
-    /**
-     * set_per_page_screen_option
-     * All this does is make sure that WordPress saves any per_page screen options (if set) for the current page.
-     * we have to do this rather than running inside the 'set-screen-options' hook because it runs earlier than
-     * admin_menu.
-     *
-     * @return void
-     */
-    private function _set_per_page_screen_options()
-    {
-        if ($this->request->requestParamIsSet('wp_screen_options')) {
-            check_admin_referer('screen-options-nonce', 'screenoptionnonce');
-            if (! $user = wp_get_current_user()) {
-                return;
-            }
-            $option = $this->request->getRequestParam('wp_screen_options[option]', '', 'key');
-            if (! $option) {
-                return;
-            }
-            $value  = $this->request->getRequestParam('wp_screen_options[value]', 0, 'int');
-            $map_option = $option;
-            $option     = str_replace('-', '_', $option);
-            switch ($map_option) {
-                case $this->_current_page . '_' . $this->_current_view . '_per_page':
-                    $max_value = apply_filters(
-                        'FHEE__EE_Admin_Page___set_per_page_screen_options__max_value',
-                        999,
-                        $this->_current_page,
-                        $this->_current_view
-                    );
-                    if ($value < 1) {
-                        return;
-                    }
-                    $value = min($value, $max_value);
-                    break;
-                default:
-                    $value = apply_filters(
-                        'FHEE__EE_Admin_Page___set_per_page_screen_options__value',
-                        false,
-                        $option,
-                        $value
-                    );
-                    if (false === $value) {
-                        return;
-                    }
-                    break;
-            }
-            update_user_meta($user->ID, $option, $value);
-            wp_safe_redirect(remove_query_arg(['pagenum', 'apage', 'paged'], wp_get_referer()));
-            exit;
-        }
-    }
-
-
-    /**
-     * This just allows for setting the $_template_args property if it needs to be set outside the object
-     *
-     * @param array $data array that will be assigned to template args.
-     */
-    public function set_template_args($data)
-    {
-        $this->_template_args = array_merge($this->_template_args, (array) $data);
-    }
-
-
-    /**
-     * This makes available the WP transient system for temporarily moving data between routes
-     *
-     * @param string $route             the route that should receive the transient
-     * @param array  $data              the data that gets sent
-     * @param bool   $notices           If this is for notices then we use this to indicate so, otherwise its just a
-     *                                  normal route transient.
-     * @param bool   $skip_route_verify Used to indicate we want to skip route verification.  This is usually ONLY used
-     *                                  when we are adding a transient before page_routes have been defined.
-     * @return void
-     * @throws EE_Error
-     */
-    protected function _add_transient($route, $data, $notices = false, $skip_route_verify = false)
-    {
-        $user_id = get_current_user_id();
-        if (! $skip_route_verify) {
-            $this->_verify_route($route);
-        }
-        // now let's set the string for what kind of transient we're setting
-        $transient = $notices
-            ? 'ee_rte_n_tx_' . $route . '_' . $user_id
-            : 'rte_tx_' . $route . '_' . $user_id;
-        $data      = $notices ? ['notices' => $data] : $data;
-        // is there already a transient for this route?  If there is then let's ADD to that transient
-        $existing = is_multisite() && is_network_admin()
-            ? get_site_transient($transient)
-            : get_transient($transient);
-        if ($existing) {
-            $data = array_merge((array) $data, (array) $existing);
-        }
-        if (is_multisite() && is_network_admin()) {
-            set_site_transient($transient, $data, 8);
-        } else {
-            set_transient($transient, $data, 8);
-        }
-    }
-
-
-    /**
-     * this retrieves the temporary transient that has been set for moving data between routes.
-     *
-     * @param bool   $notices true we get notices transient. False we just return normal route transient
-     * @param string $route
-     * @return mixed data
-     */
-    protected function _get_transient($notices = false, $route = '')
-    {
-        $user_id   = get_current_user_id();
-        $route     = ! $route ? $this->_req_action : $route;
-        $transient = $notices
-            ? 'ee_rte_n_tx_' . $route . '_' . $user_id
-            : 'rte_tx_' . $route . '_' . $user_id;
-        $data      = is_multisite() && is_network_admin()
-            ? get_site_transient($transient)
-            : get_transient($transient);
-        // delete transient after retrieval (just in case it hasn't expired);
-        if (is_multisite() && is_network_admin()) {
-            delete_site_transient($transient);
-        } else {
-            delete_transient($transient);
-        }
-        return $notices && isset($data['notices']) ? $data['notices'] : $data;
-    }
-
-
-    /**
-     * The purpose of this method is just to run garbage collection on any EE transients that might have expired but
-     * would not be called later. This will be assigned to run on a specific EE Admin page. (place the method in the
-     * default route callback on the EE_Admin page you want it run.)
-     *
-     * @return void
-     */
-    protected function _transient_garbage_collection()
-    {
-        global $wpdb;
-        // retrieve all existing transients
-        $query =
-            "SELECT option_name FROM {$wpdb->options} WHERE option_name LIKE '%rte_tx_%' OR option_name LIKE '%rte_n_tx_%'";
-        if ($results = $wpdb->get_results($query)) {
-            foreach ($results as $result) {
-                $transient = str_replace('_transient_', '', $result->option_name);
-                get_transient($transient);
-                if (is_multisite() && is_network_admin()) {
-                    get_site_transient($transient);
-                }
-            }
-        }
-    }
-
-
-    /**
-     * get_view
-     *
-     * @return string content of _view property
-     */
-    public function get_view()
-    {
-        return $this->_view;
-    }
-
-
-    /**
-     * getter for the protected $_views property
-     *
-     * @return array
-     */
-    public function get_views()
-    {
-        return $this->_views;
-    }
-
-
-    /**
-     * get_current_page
-     *
-     * @return string _current_page property value
-     */
-    public function get_current_page()
-    {
-        return $this->_current_page;
-    }
-
-
-    /**
-     * get_current_view
-     *
-     * @return string _current_view property value
-     */
-    public function get_current_view()
-    {
-        return $this->_current_view;
-    }
-
-
-    /**
-     * get_current_screen
-     *
-     * @return object The current WP_Screen object
-     */
-    public function get_current_screen()
-    {
-        return $this->_current_screen;
-    }
-
-
-    /**
-     * get_current_page_view_url
-     *
-     * @return string This returns the url for the current_page_view.
-     */
-    public function get_current_page_view_url()
-    {
-        return $this->_current_page_view_url;
-    }
-
-
-    /**
-     * just returns the Request
-     *
-     * @return RequestInterface
-     */
-    public function get_request()
-    {
-        return $this->request;
-    }
-
-
-    /**
-     * just returns the _req_data property
-     *
-     * @return array
-     */
-    public function get_request_data()
-    {
-        return $this->request->requestParams();
-    }
-
-
-    /**
-     * returns the _req_data protected property
-     *
-     * @return string
-     */
-    public function get_req_action()
-    {
-        return $this->_req_action;
-    }
-
-
-    /**
-     * @return bool  value of $_is_caf property
-     */
-    public function is_caf()
-    {
-        return $this->_is_caf;
-    }
-
-
-    /**
-     * @return mixed
-     */
-    public function default_espresso_metaboxes()
-    {
-        return $this->_default_espresso_metaboxes;
-    }
-
-
-    /**
-     * @return mixed
-     */
-    public function admin_base_url()
-    {
-        return $this->_admin_base_url;
-    }
-
-
-    /**
-     * @return mixed
-     */
-    public function wp_page_slug()
-    {
-        return $this->_wp_page_slug;
-    }
-
-
-    /**
-     * updates  espresso configuration settings
-     *
-     * @param string                   $tab
-     * @param EE_Config_Base|EE_Config $config
-     * @param string                   $file file where error occurred
-     * @param string                   $func function  where error occurred
-     * @param string                   $line line no where error occurred
-     * @return boolean
-     */
-    protected function _update_espresso_configuration($tab, $config, $file = '', $func = '', $line = '')
-    {
-        // remove any options that are NOT going to be saved with the config settings.
-        if (isset($config->core->ee_ueip_optin)) {
-            // TODO: remove the following two lines and make sure values are migrated from 3.1
-            update_option('ee_ueip_optin', $config->core->ee_ueip_optin);
-            update_option('ee_ueip_has_notified', true);
-        }
-        // and save it (note we're also doing the network save here)
-        $net_saved    = ! is_main_site() || EE_Network_Config::instance()->update_config(false, false);
-        $config_saved = EE_Config::instance()->update_espresso_config(false, false);
-        if ($config_saved && $net_saved) {
-            EE_Error::add_success(sprintf(esc_html__('"%s" have been successfully updated.', 'event_espresso'), $tab));
-            return true;
-        }
-        EE_Error::add_error(sprintf(esc_html__('The "%s" were not updated.', 'event_espresso'), $tab), $file, $func, $line);
-        return false;
-    }
-
-
-    /**
-     * Returns an array to be used for EE_FOrm_Fields.helper.php's select_input as the $values argument.
-     *
-     * @return array
-     */
-    public function get_yes_no_values()
-    {
-        return $this->_yes_no_values;
-    }
-
-
-    protected function _get_dir()
-    {
-        $reflector = new ReflectionClass(get_class($this));
-        return dirname($reflector->getFileName());
-    }
-
-
-    /**
-     * A helper for getting a "next link".
-     *
-     * @param string $url   The url to link to
-     * @param string $class The class to use.
-     * @return string
-     */
-    protected function _next_link($url, $class = 'dashicons dashicons-arrow-right')
-    {
-        return '<a class="' . $class . '" href="' . $url . '"></a>';
-    }
-
-
-    /**
-     * A helper for getting a "previous link".
-     *
-     * @param string $url   The url to link to
-     * @param string $class The class to use.
-     * @return string
-     */
-    protected function _previous_link($url, $class = 'dashicons dashicons-arrow-left')
-    {
-        return '<a class="' . $class . '" href="' . $url . '"></a>';
-    }
-
-
-
-
-
-
-
-    // below are some messages related methods that should be available across the EE_Admin system.  Note, these methods are NOT page specific
-
-
-    /**
-     * This processes an request to resend a registration and assumes we have a _REG_ID for doing so. So if the caller
-     * knows that the _REG_ID isn't in the req_data array but CAN obtain it, the caller should ADD the _REG_ID to the
-     * _req_data array.
-     *
-     * @return bool success/fail
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _process_resend_registration()
-    {
-        $this->_template_args['success'] = EED_Messages::process_resend($this->_req_data);
-        do_action(
-            'AHEE__EE_Admin_Page___process_resend_registration',
-            $this->_template_args['success'],
-            $this->request->requestParams()
-        );
-        return $this->_template_args['success'];
-    }
-
-
-    /**
-     * This automatically processes any payment message notifications when manual payment has been applied.
-     *
-     * @param EE_Payment $payment
-     * @return bool success/fail
-     */
-    protected function _process_payment_notification(EE_Payment $payment)
-    {
-        add_filter('FHEE__EE_Payment_Processor__process_registration_payments__display_notifications', '__return_true');
-        do_action('AHEE__EE_Admin_Page___process_admin_payment_notification', $payment);
-        $this->_template_args['success'] = apply_filters(
-            'FHEE__EE_Admin_Page___process_admin_payment_notification__success',
-            false,
-            $payment
-        );
-        return $this->_template_args['success'];
-    }
-
-
-    /**
-     * @param EEM_Base      $entity_model
-     * @param string        $entity_PK_name name of the primary key field used as a request param, ie: id, ID, etc
-     * @param string        $action         one of the EE_Admin_List_Table::ACTION_* constants: delete, restore, trash
-     * @param string        $delete_column  name of the field that denotes whether entity is trashed
-     * @param callable|null $callback       called after entity is trashed, restored, or deleted
-     * @return int|float
-     * @throws EE_Error
-     */
-    protected function trashRestoreDeleteEntities(
-        EEM_Base $entity_model,
-        $entity_PK_name,
-        $action = EE_Admin_List_Table::ACTION_DELETE,
-        $delete_column = '',
-        callable $callback = null
-    ) {
-        $entity_PK      = $entity_model->get_primary_key_field();
-        $entity_PK_name = $entity_PK_name ?: $entity_PK->get_name();
-        $entity_PK_type = $this->resolveEntityFieldDataType($entity_PK);
-        // grab ID if deleting a single entity
-        if ($this->request->requestParamIsSet($entity_PK_name)) {
-            $ID = $this->request->getRequestParam($entity_PK_name, 0, $entity_PK_type);
-            return $this->trashRestoreDeleteEntity($entity_model, $ID, $action, $delete_column, $callback) ? 1 : 0;
-        }
-        // or grab checkbox array if bulk deleting
-        $checkboxes = $this->request->getRequestParam('checkbox', [], $entity_PK_type, true);
-        if (empty($checkboxes)) {
-            return 0;
-        }
-        $success = 0;
-        $IDs     = array_keys($checkboxes);
-        // cycle thru bulk action checkboxes
-        foreach ($IDs as $ID) {
-            // increment $success
-            if ($this->trashRestoreDeleteEntity($entity_model, $ID, $action, $delete_column, $callback)) {
-                $success++;
-            }
-        }
-        $count = (int) count($checkboxes);
-        // if multiple entities were deleted successfully, then $deleted will be full count of deletions,
-        // otherwise it will be a fraction of ( actual deletions / total entities to be deleted )
-        return $success === $count ? $count : $success / $count;
-    }
-
-
-    /**
-     * @param EE_Primary_Key_Field_Base $entity_PK
-     * @return string
-     * @throws EE_Error
-     * @since   4.10.30.p
-     */
-    private function resolveEntityFieldDataType(EE_Primary_Key_Field_Base $entity_PK)
-    {
-        $entity_PK_type = $entity_PK->getSchemaType();
-        switch ($entity_PK_type) {
-            case 'boolean':
-                return 'bool';
-            case 'integer':
-                return 'int';
-            case 'number':
-                return 'float';
-            case 'string':
-                return 'string';
-        }
-        throw new RuntimeException(
-            sprintf(
-                esc_html__(
-                    '"%1$s" is an invalid schema type for the %2$s primary key.',
-                    'event_espresso'
-                ),
-                $entity_PK_type,
-                $entity_PK->get_name()
-            )
-        );
-    }
-
-
-    /**
-     * @param EEM_Base      $entity_model
-     * @param int|string    $entity_ID
-     * @param string        $action        one of the EE_Admin_List_Table::ACTION_* constants: delete, restore, trash
-     * @param string        $delete_column name of the field that denotes whether entity is trashed
-     * @param callable|null $callback      called after entity is trashed, restored, or deleted
-     * @return bool
-     */
-    protected function trashRestoreDeleteEntity(
-        EEM_Base $entity_model,
-        $entity_ID,
-        $action,
-        $delete_column,
-        callable $callback = null
-    ) {
-        $entity_ID = absint($entity_ID);
-        if (! $entity_ID) {
-            $this->trashRestoreDeleteError($action, $entity_model);
-        }
-        $result = 0;
-        try {
-            $entity = $entity_model->get_one_by_ID($entity_ID);
-            if (! $entity instanceof EE_Base_Class) {
-                throw new DomainException(
-                    sprintf(
-                        esc_html__(
-                            'Missing or invalid %1$s entity with ID of "%2$s" returned from db.',
-                            'event_espresso'
-                        ),
-                        str_replace('EEM_', '', $entity_model->get_this_model_name()),
-                        $entity_ID
-                    )
-                );
-            }
-            switch ($action) {
-                case EE_Admin_List_Table::ACTION_DELETE:
-                    $result = (bool) $entity->delete_permanently();
-                    break;
-                case EE_Admin_List_Table::ACTION_RESTORE:
-                    $result = $entity->delete_or_restore(false);
-                    break;
-                case EE_Admin_List_Table::ACTION_TRASH:
-                    $result = $entity->delete_or_restore();
-                    break;
-            }
-        } catch (Exception $exception) {
-            $this->trashRestoreDeleteError($action, $entity_model, $exception);
-        }
-        if (is_callable($callback)) {
-            call_user_func_array($callback, [$entity_model, $entity_ID, $action, $result, $delete_column]);
-        }
-        return $result;
-    }
-
-
-    /**
-     * @param EEM_Base $entity_model
-     * @param string   $delete_column
-     * @since 4.10.30.p
-     */
-    private function validateDeleteColumn(EEM_Base $entity_model, $delete_column)
-    {
-        if (empty($delete_column)) {
-            throw new DomainException(
-                sprintf(
-                    esc_html__(
-                        'You need to specify the name of the "delete column" on the %2$s model, in order to trash or restore an entity.',
-                        'event_espresso'
-                    ),
-                    $entity_model->get_this_model_name()
-                )
-            );
-        }
-        if (! $entity_model->has_field($delete_column)) {
-            throw new DomainException(
-                sprintf(
-                    esc_html__(
-                        'The %1$s field does not exist on the %2$s model.',
-                        'event_espresso'
-                    ),
-                    $delete_column,
-                    $entity_model->get_this_model_name()
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @param EEM_Base       $entity_model
-     * @param Exception|null $exception
-     * @param string         $action
-     * @since 4.10.30.p
-     */
-    private function trashRestoreDeleteError($action, EEM_Base $entity_model, Exception $exception = null)
-    {
-        if ($exception instanceof Exception) {
-            throw new RuntimeException(
-                sprintf(
-                    esc_html__(
-                        'Could not %1$s the %2$s because the following error occurred: %3$s',
-                        'event_espresso'
-                    ),
-                    $action,
-                    $entity_model->get_this_model_name(),
-                    $exception->getMessage()
-                )
-            );
-        }
-        throw new RuntimeException(
-            sprintf(
-                esc_html__(
-                    'Could not %1$s the %2$s because an invalid ID was received.',
-                    'event_espresso'
-                ),
-                $action,
-                $entity_model->get_this_model_name()
-            )
-        );
-    }
+		$this->_template_args['list_table_hidden_fields']        = $hidden_form_fields;
+		// display message about search results?
+		$search = $this->request->getRequestParam('s');
+		$this->_template_args['before_list_table'] .= ! empty($search)
+			? '<p class="ee-search-results">' . sprintf(
+				esc_html__('Displaying search results for the search string: %1$s', 'event_espresso'),
+				trim($search, '%')
+			) . '</p>'
+			: '';
+		// filter before_list_table template arg
+		$this->_template_args['before_list_table'] = apply_filters(
+			'FHEE__EE_Admin_Page___display_admin_list_table_page__before_list_table__template_arg',
+			$this->_template_args['before_list_table'],
+			$this->page_slug,
+			$this->request->requestParams(),
+			$this->_req_action
+		);
+		// convert to array and filter again
+		// arrays are easier to inject new items in a specific location,
+		// but would not be backwards compatible, so we have to add a new filter
+		$this->_template_args['before_list_table'] = implode(
+			" \n",
+			(array) apply_filters(
+				'FHEE__EE_Admin_Page___display_admin_list_table_page__before_list_table__template_args_array',
+				(array) $this->_template_args['before_list_table'],
+				$this->page_slug,
+				$this->request->requestParams(),
+				$this->_req_action
+			)
+		);
+		// filter after_list_table template arg
+		$this->_template_args['after_list_table'] = apply_filters(
+			'FHEE__EE_Admin_Page___display_admin_list_table_page__after_list_table__template_arg',
+			$this->_template_args['after_list_table'],
+			$this->page_slug,
+			$this->request->requestParams(),
+			$this->_req_action
+		);
+		// convert to array and filter again
+		// arrays are easier to inject new items in a specific location,
+		// but would not be backwards compatible, so we have to add a new filter
+		$this->_template_args['after_list_table']   = implode(
+			" \n",
+			(array) apply_filters(
+				'FHEE__EE_Admin_Page___display_admin_list_table_page__after_list_table__template_args_array',
+				(array) $this->_template_args['after_list_table'],
+				$this->page_slug,
+				$this->request->requestParams(),
+				$this->_req_action
+			)
+		);
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(
+			$template_path,
+			$this->_template_args,
+			true
+		);
+		// the final template wrapper
+		if ($sidebar) {
+			$this->display_admin_page_with_sidebar();
+		} else {
+			$this->display_admin_page_with_no_sidebar();
+		}
+	}
+
+
+	/**
+	 * This just prepares a legend using the given items and the admin_details_legend.template.php file and returns the
+	 * html string for the legend.
+	 * $items are expected in an array in the following format:
+	 * $legend_items = array(
+	 *        'item_id' => array(
+	 *            'icon' => 'http://url_to_icon_being_described.png',
+	 *            'desc' => esc_html__('localized description of item');
+	 *        )
+	 * );
+	 *
+	 * @param array $items see above for format of array
+	 * @return string html string of legend
+	 * @throws DomainException
+	 */
+	protected function _display_legend($items)
+	{
+		$this->_template_args['items'] = apply_filters(
+			'FHEE__EE_Admin_Page___display_legend__items',
+			(array) $items,
+			$this
+		);
+		return EEH_Template::display_template(
+			EE_ADMIN_TEMPLATE . 'admin_details_legend.template.php',
+			$this->_template_args,
+			true
+		);
+	}
+
+
+	/**
+	 * This is used whenever we're DOING_AJAX to return a formatted json array that our calling javascript can expect
+	 * The returned json object is created from an array in the following format:
+	 * array(
+	 *  'error' => FALSE, //(default FALSE), contains any errors and/or exceptions (exceptions return json early),
+	 *  'success' => FALSE, //(default FALSE) - contains any special success message.
+	 *  'notices' => '', // - contains any EE_Error formatted notices
+	 *  'content' => 'string can be html', //this is a string of formatted content (can be html)
+	 *  'data' => array() //this can be any key/value pairs that a method returns for later json parsing by the js.
+	 *  We're also going to include the template args with every package (so js can pick out any specific template args
+	 *  that might be included in here)
+	 * )
+	 * The json object is populated by whatever is set in the $_template_args property.
+	 *
+	 * @param bool  $sticky_notices    Used to indicate whether you want to ensure notices are added to a transient
+	 *                                 instead of displayed.
+	 * @param array $notices_arguments Use this to pass any additional args on to the _process_notices.
+	 * @return void
+	 * @throws EE_Error
+	 */
+	protected function _return_json($sticky_notices = false, $notices_arguments = [])
+	{
+		// make sure any EE_Error notices have been handled.
+		$this->_process_notices($notices_arguments, true, $sticky_notices);
+		$data = isset($this->_template_args['data']) ? $this->_template_args['data'] : [];
+		unset($this->_template_args['data']);
+		$json = [
+			'error'     => isset($this->_template_args['error']) ? $this->_template_args['error'] : false,
+			'success'   => isset($this->_template_args['success']) ? $this->_template_args['success'] : false,
+			'errors'    => isset($this->_template_args['errors']) ? $this->_template_args['errors'] : false,
+			'attention' => isset($this->_template_args['attention']) ? $this->_template_args['attention'] : false,
+			'notices'   => EE_Error::get_notices(),
+			'content'   => isset($this->_template_args['admin_page_content'])
+				? $this->_template_args['admin_page_content'] : '',
+			'data'      => array_merge($data, ['template_args' => $this->_template_args]),
+			'isEEajax'  => true
+			// special flag so any ajax.Success methods in js can identify this return package as a EEajax package.
+		];
+		// make sure there are no php errors or headers_sent.  Then we can set correct json header.
+		if (null === error_get_last() || ! headers_sent()) {
+			header('Content-Type: application/json; charset=UTF-8');
+		}
+		echo wp_json_encode($json);
+		exit();
+	}
+
+
+	/**
+	 * Simply a wrapper for the protected method so we can call this outside the class (ONLY when doing ajax)
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function return_json()
+	{
+		if ($this->request->isAjax()) {
+			$this->_return_json();
+		} else {
+			throw new EE_Error(
+				sprintf(
+					esc_html__('The public %s method can only be called when DOING_AJAX = TRUE', 'event_espresso'),
+					__FUNCTION__
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * This provides a way for child hook classes to send along themselves by reference so methods/properties within
+	 * them can be accessed by EE_Admin_child pages. This is assigned to the $_hook_obj property.
+	 *
+	 * @param EE_Admin_Hooks $hook_obj This will be the object for the EE_Admin_Hooks child
+	 */
+	public function set_hook_object(EE_Admin_Hooks $hook_obj)
+	{
+		$this->_hook_obj = $hook_obj;
+	}
+
+
+	/**
+	 *        generates  HTML wrapper with Tabbed nav for an admin page
+	 *
+	 * @param boolean $about whether to use the special about page wrapper or default.
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	public function admin_page_wrapper($about = false)
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$this->_nav_tabs                                   = $this->_get_main_nav_tabs();
+		$this->_template_args['nav_tabs']                  = $this->_nav_tabs;
+		$this->_template_args['admin_page_title']          = $this->_admin_page_title;
+
+		$this->_template_args['before_admin_page_content'] = apply_filters(
+			"FHEE_before_admin_page_content{$this->_current_page}{$this->_current_view}",
+			isset($this->_template_args['before_admin_page_content'])
+				? $this->_template_args['before_admin_page_content']
+				: ''
+		);
+
+		$this->_template_args['after_admin_page_content']  = apply_filters(
+			"FHEE_after_admin_page_content{$this->_current_page}{$this->_current_view}",
+			isset($this->_template_args['after_admin_page_content'])
+				? $this->_template_args['after_admin_page_content']
+				: ''
+		);
+		$this->_template_args['after_admin_page_content']  .= $this->_set_help_popup_content();
+
+		if ($this->request->isAjax()) {
+			$this->_template_args['admin_page_content'] = EEH_Template::display_template(
+				// $template_path,
+				EE_ADMIN_TEMPLATE . 'admin_wrapper_ajax.template.php',
+				$this->_template_args,
+				true
+			);
+			$this->_return_json();
+		}
+		// load settings page wrapper template
+		$template_path = $about
+			? EE_ADMIN_TEMPLATE . 'about_admin_wrapper.template.php'
+			: EE_ADMIN_TEMPLATE . 'admin_wrapper.template.php';
+
+		EEH_Template::display_template($template_path, $this->_template_args);
+	}
+
+
+	/**
+	 * This returns the admin_nav tabs html using the configuration in the _nav_tabs property
+	 *
+	 * @return string html
+	 * @throws EE_Error
+	 */
+	protected function _get_main_nav_tabs()
+	{
+		// let's generate the html using the EEH_Tabbed_Content helper.
+		// We do this here so that it's possible for child classes to add in nav tabs dynamically at the last minute
+		// (rather than setting in the page_routes array)
+		return EEH_Tabbed_Content::display_admin_nav_tabs($this->_nav_tabs);
+	}
+
+
+	/**
+	 *        sort nav tabs
+	 *
+	 * @param $a
+	 * @param $b
+	 * @return int
+	 */
+	private function _sort_nav_tabs($a, $b)
+	{
+		if ($a['order'] === $b['order']) {
+			return 0;
+		}
+		return ($a['order'] < $b['order']) ? -1 : 1;
+	}
+
+
+	/**
+	 *    generates HTML for the forms used on admin pages
+	 *
+	 * @param array  $input_vars   - array of input field details
+	 * @param string $generator    (options are 'string' or 'array', basically use this to indicate which generator to
+	 *                             use)
+	 * @param bool   $id
+	 * @return array|string
+	 * @uses   EEH_Form_Fields::get_form_fields (/helper/EEH_Form_Fields.helper.php)
+	 * @uses   EEH_Form_Fields::get_form_fields_array (/helper/EEH_Form_Fields.helper.php)
+	 */
+	protected function _generate_admin_form_fields($input_vars = [], $generator = 'string', $id = false)
+	{
+		return $generator === 'string'
+			? EEH_Form_Fields::get_form_fields($input_vars, $id)
+			: EEH_Form_Fields::get_form_fields_array($input_vars);
+	}
+
+
+	/**
+	 * generates the "Save" and "Save & Close" buttons for edit forms
+	 *
+	 * @param bool             $both     if true then both buttons will be generated.  If false then just the "Save &
+	 *                                   Close" button.
+	 * @param array            $text     if included, generator will use the given text for the buttons ( array([0] =>
+	 *                                   'Save', [1] => 'save & close')
+	 * @param array            $actions  if included allows us to set the actions that each button will carry out (i.e.
+	 *                                   via the "name" value in the button).  We can also use this to just dump
+	 *                                   default actions by submitting some other value.
+	 * @param bool|string|null $referrer if false then we just do the default action on save and close.  Other wise it
+	 *                                   will use the $referrer string. IF null, then we don't do ANYTHING on save and
+	 *                                   close (normal form handling).
+	 */
+	protected function _set_save_buttons($both = true, $text = [], $actions = [], $referrer = null)
+	{
+		// make sure $text and $actions are in an array
+		$text          = (array) $text;
+		$actions       = (array) $actions;
+		$referrer_url  = ! empty($referrer) ? $referrer : $this->request->getServerParam('REQUEST_URI');
+		$button_text   = ! empty($text)
+			? $text
+			: [
+				esc_html__('Save', 'event_espresso'),
+				esc_html__('Save and Close', 'event_espresso'),
+			];
+		$default_names = ['save', 'save_and_close'];
+		$buttons = '';
+		foreach ($button_text as $key => $button) {
+			$ref     = $default_names[ $key ];
+			$name    = ! empty($actions) ? $actions[ $key ] : $ref;
+			$buttons .= '<input type="submit" class="button-primary ' . $ref . '" '
+						. 'value="' . $button . '" name="' . $name . '" '
+						. 'id="' . $this->_current_view . '_' . $ref . '" />';
+			if (! $both) {
+				break;
+			}
+		}
+		// add in a hidden index for the current page (so save and close redirects properly)
+		$buttons .= '<input type="hidden" id="save_and_close_referrer" name="save_and_close_referrer" value="'
+				   . $referrer_url
+				   . '" />';
+		$this->_template_args['save_buttons'] = $buttons;
+	}
+
+
+	/**
+	 * Wrapper for the protected function.  Allows plugins/addons to call this to set the form tags.
+	 *
+	 * @param string $route
+	 * @param array  $additional_hidden_fields
+	 * @see   $this->_set_add_edit_form_tags() for details on params
+	 * @since 4.6.0
+	 */
+	public function set_add_edit_form_tags($route = '', $additional_hidden_fields = [])
+	{
+		$this->_set_add_edit_form_tags($route, $additional_hidden_fields);
+	}
+
+
+	/**
+	 * set form open and close tags on add/edit pages.
+	 *
+	 * @param string $route                    the route you want the form to direct to
+	 * @param array  $additional_hidden_fields any additional hidden fields required in the form header
+	 * @return void
+	 */
+	protected function _set_add_edit_form_tags($route = '', $additional_hidden_fields = [])
+	{
+		if (empty($route)) {
+			$user_msg = esc_html__(
+				'An error occurred. No action was set for this page\'s form.',
+				'event_espresso'
+			);
+			$dev_msg  = $user_msg . "\n"
+						. sprintf(
+							esc_html__('The $route argument is required for the %s->%s method.', 'event_espresso'),
+							__FUNCTION__,
+							__CLASS__
+						);
+			EE_Error::add_error($user_msg . '||' . $dev_msg, __FILE__, __FUNCTION__, __LINE__);
+		}
+		// open form
+		$this->_template_args['before_admin_page_content'] = '<form name="form" method="post" action="'
+															 . $this->_admin_base_url
+															 . '" id="'
+															 . $route
+															 . '_event_form" >';
+		// add nonce
+		$nonce                                             =
+			wp_nonce_field($route . '_nonce', $route . '_nonce', false, false);
+		$this->_template_args['before_admin_page_content'] .= "\n\t" . $nonce;
+		// add REQUIRED form action
+		$hidden_fields = [
+			'action' => ['type' => 'hidden', 'value' => $route],
+		];
+		// merge arrays
+		$hidden_fields = is_array($additional_hidden_fields)
+			? array_merge($hidden_fields, $additional_hidden_fields)
+			: $hidden_fields;
+		// generate form fields
+		$form_fields = $this->_generate_admin_form_fields($hidden_fields, 'array');
+		// add fields to form
+		foreach ((array) $form_fields as $form_field) {
+			$this->_template_args['before_admin_page_content'] .= "\n\t" . $form_field['field'];
+		}
+		// close form
+		$this->_template_args['after_admin_page_content'] = '</form>';
+	}
+
+
+	/**
+	 * Public Wrapper for _redirect_after_action() method since its
+	 * discovered it would be useful for external code to have access.
+	 *
+	 * @param bool   $success
+	 * @param string $what
+	 * @param string $action_desc
+	 * @param array  $query_args
+	 * @param bool   $override_overwrite
+	 * @throws EE_Error
+	 * @see   EE_Admin_Page::_redirect_after_action() for params.
+	 * @since 4.5.0
+	 */
+	public function redirect_after_action(
+		$success = false,
+		$what = 'item',
+		$action_desc = 'processed',
+		$query_args = [],
+		$override_overwrite = false
+	) {
+		$this->_redirect_after_action(
+			$success,
+			$what,
+			$action_desc,
+			$query_args,
+			$override_overwrite
+		);
+	}
+
+
+	/**
+	 * Helper method for merging existing request data with the returned redirect url.
+	 *
+	 * This is typically used for redirects after an action so that if the original view was a filtered view those
+	 * filters are still applied.
+	 *
+	 * @param array $new_route_data
+	 * @return array
+	 */
+	protected function mergeExistingRequestParamsWithRedirectArgs(array $new_route_data)
+	{
+		foreach ($this->request->requestParams() as $ref => $value) {
+			// unset nonces
+			if (strpos($ref, 'nonce') !== false) {
+				$this->request->unSetRequestParam($ref);
+				continue;
+			}
+			// urlencode values.
+			$value = is_array($value) ? array_map('urlencode', $value) : urlencode($value);
+			$this->request->setRequestParam($ref, $value);
+		}
+		return array_merge($this->request->requestParams(), $new_route_data);
+	}
+
+
+	/**
+	 *    _redirect_after_action
+	 *
+	 * @param int    $success            - whether success was for two or more records, or just one, or none
+	 * @param string $what               - what the action was performed on
+	 * @param string $action_desc        - what was done ie: updated, deleted, etc
+	 * @param array  $query_args         - an array of query_args to be added to the URL to redirect to after the admin
+	 *                                   action is completed
+	 * @param BOOL   $override_overwrite by default all EE_Error::success messages are overwritten, this allows you to
+	 *                                   override this so that they show.
+	 * @return void
+	 * @throws EE_Error
+	 */
+	protected function _redirect_after_action(
+		$success = 0,
+		$what = 'item',
+		$action_desc = 'processed',
+		$query_args = [],
+		$override_overwrite = false
+	) {
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		// class name for actions/filters.
+		$classname = get_class($this);
+		// set redirect url.
+		// Note if there is a "page" index in the $query_args then we go with vanilla admin.php route,
+		// otherwise we go with whatever is set as the _admin_base_url
+		$redirect_url = isset($query_args['page']) ? admin_url('admin.php') : $this->_admin_base_url;
+		$notices      = EE_Error::get_notices(false);
+		// overwrite default success messages //BUT ONLY if overwrite not overridden
+		if (! $override_overwrite || ! empty($notices['errors'])) {
+			EE_Error::overwrite_success();
+		}
+		if (! empty($what) && ! empty($action_desc) && empty($notices['errors'])) {
+			// how many records affected ? more than one record ? or just one ?
+			if ($success > 1) {
+				// set plural msg
+				EE_Error::add_success(
+					sprintf(
+						esc_html__('The "%s" have been successfully %s.', 'event_espresso'),
+						$what,
+						$action_desc
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			} elseif ($success === 1) {
+				// set singular msg
+				EE_Error::add_success(
+					sprintf(
+						esc_html__('The "%s" has been successfully %s.', 'event_espresso'),
+						$what,
+						$action_desc
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+		}
+		// check that $query_args isn't something crazy
+		if (! is_array($query_args)) {
+			$query_args = [];
+		}
+		/**
+		 * Allow injecting actions before the query_args are modified for possible different
+		 * redirections on save and close actions
+		 *
+		 * @param array $query_args       The original query_args array coming into the
+		 *                                method.
+		 * @since 4.2.0
+		 */
+		do_action(
+			"AHEE__{$classname}___redirect_after_action__before_redirect_modification_{$this->_req_action}",
+			$query_args
+		);
+		// calculate where we're going (if we have a "save and close" button pushed)
+
+		if (
+			$this->request->requestParamIsSet('save_and_close')
+			&& $this->request->requestParamIsSet('save_and_close_referrer')
+		) {
+			// even though we have the save_and_close referrer, we need to parse the url for the action in order to generate a nonce
+			$parsed_url = parse_url($this->request->getRequestParam('save_and_close_referrer', '', 'url'));
+			// regenerate query args array from referrer URL
+			parse_str($parsed_url['query'], $query_args);
+			// correct page and action will be in the query args now
+			$redirect_url = admin_url('admin.php');
+		}
+		// merge any default query_args set in _default_route_query_args property
+		if (! empty($this->_default_route_query_args) && ! $this->_is_UI_request) {
+			$args_to_merge = [];
+			foreach ($this->_default_route_query_args as $query_param => $query_value) {
+				// is there a wp_referer array in our _default_route_query_args property?
+				if ($query_param === 'wp_referer') {
+					$query_value = (array) $query_value;
+					foreach ($query_value as $reference => $value) {
+						if (strpos($reference, 'nonce') !== false) {
+							continue;
+						}
+						// finally we will override any arguments in the referer with
+						// what might be set on the _default_route_query_args array.
+						if (isset($this->_default_route_query_args[ $reference ])) {
+							$args_to_merge[ $reference ] = urlencode($this->_default_route_query_args[ $reference ]);
+						} else {
+							$args_to_merge[ $reference ] = urlencode($value);
+						}
+					}
+					continue;
+				}
+				$args_to_merge[ $query_param ] = $query_value;
+			}
+			// now let's merge these arguments but override with what was specifically sent in to the
+			// redirect.
+			$query_args = array_merge($args_to_merge, $query_args);
+		}
+		$this->_process_notices($query_args);
+		// generate redirect url
+		// if redirecting to anything other than the main page, add a nonce
+		if (isset($query_args['action'])) {
+			// manually generate wp_nonce and merge that with the query vars
+			// becuz the wp_nonce_url function wrecks havoc on some vars
+			$query_args['_wpnonce'] = wp_create_nonce($query_args['action'] . '_nonce');
+		}
+		// we're adding some hooks and filters in here for processing any things just before redirects
+		// (example: an admin page has done an insert or update and we want to run something after that).
+		do_action('AHEE_redirect_' . $classname . $this->_req_action, $query_args);
+		$redirect_url = apply_filters(
+			'FHEE_redirect_' . $classname . $this->_req_action,
+			self::add_query_args_and_nonce($query_args, $redirect_url),
+			$query_args
+		);
+		// check if we're doing ajax.  If we are then lets just return the results and js can handle how it wants.
+		if ($this->request->isAjax()) {
+			$default_data                    = [
+				'close'        => true,
+				'redirect_url' => $redirect_url,
+				'where'        => 'main',
+				'what'         => 'append',
+			];
+			$this->_template_args['success'] = $success;
+			$this->_template_args['data']    = ! empty($this->_template_args['data']) ? array_merge(
+				$default_data,
+				$this->_template_args['data']
+			) : $default_data;
+			$this->_return_json();
+		}
+		wp_safe_redirect($redirect_url);
+		exit();
+	}
+
+
+	/**
+	 * process any notices before redirecting (or returning ajax request)
+	 * This method sets the $this->_template_args['notices'] attribute;
+	 *
+	 * @param array $query_args         any query args that need to be used for notice transient ('action')
+	 * @param bool  $skip_route_verify  This is typically used when we are processing notices REALLY early and
+	 *                                  page_routes haven't been defined yet.
+	 * @param bool  $sticky_notices     This is used to flag that regardless of whether this is doing_ajax or not, we
+	 *                                  still save a transient for the notice.
+	 * @return void
+	 * @throws EE_Error
+	 */
+	protected function _process_notices($query_args = [], $skip_route_verify = false, $sticky_notices = true)
+	{
+		// first let's set individual error properties if doing_ajax and the properties aren't already set.
+		if ($this->request->isAjax()) {
+			$notices = EE_Error::get_notices(false);
+			if (empty($this->_template_args['success'])) {
+				$this->_template_args['success'] = isset($notices['success']) ? $notices['success'] : false;
+			}
+			if (empty($this->_template_args['errors'])) {
+				$this->_template_args['errors'] = isset($notices['errors']) ? $notices['errors'] : false;
+			}
+			if (empty($this->_template_args['attention'])) {
+				$this->_template_args['attention'] = isset($notices['attention']) ? $notices['attention'] : false;
+			}
+		}
+		$this->_template_args['notices'] = EE_Error::get_notices();
+		// IF this isn't ajax we need to create a transient for the notices using the route (however, overridden if $sticky_notices == true)
+		if (! $this->request->isAjax() || $sticky_notices) {
+			$route = isset($query_args['action']) ? $query_args['action'] : 'default';
+			$this->_add_transient(
+				$route,
+				$this->_template_args['notices'],
+				true,
+				$skip_route_verify
+			);
+		}
+	}
+
+
+	/**
+	 * get_action_link_or_button
+	 * returns the button html for adding, editing, or deleting an item (depending on given type)
+	 *
+	 * @param string $action        use this to indicate which action the url is generated with.
+	 * @param string $type          accepted strings must be defined in the $_labels['button'] array(as the key)
+	 *                              property.
+	 * @param array  $extra_request if the button requires extra params you can include them in $key=>$value pairs.
+	 * @param string $class         Use this to give the class for the button. Defaults to 'button-primary'
+	 * @param string $base_url      If this is not provided
+	 *                              the _admin_base_url will be used as the default for the button base_url.
+	 *                              Otherwise this value will be used.
+	 * @param bool   $exclude_nonce If true then no nonce will be in the generated button link.
+	 * @return string
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function get_action_link_or_button(
+		$action,
+		$type = 'add',
+		$extra_request = [],
+		$class = 'button button--primary',
+		$base_url = '',
+		$exclude_nonce = false
+	) {
+		// first let's validate the action (if $base_url is FALSE otherwise validation will happen further along)
+		if (empty($base_url) && ! isset($this->_page_routes[ $action ])) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'There is no page route for given action for the button.  This action was given: %s',
+						'event_espresso'
+					),
+					$action
+				)
+			);
+		}
+		if (! isset($this->_labels['buttons'][ $type ])) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'There is no label for the given button type (%s). Labels are set in the <code>_page_config</code> property.',
+						'event_espresso'
+					),
+					$type
+				)
+			);
+		}
+		// finally check user access for this button.
+		$has_access = $this->check_user_access($action, true);
+		if (! $has_access) {
+			return '';
+		}
+		$_base_url  = ! $base_url ? $this->_admin_base_url : $base_url;
+		$query_args = [
+			'action' => $action,
+		];
+		// merge extra_request args but make sure our original action takes precedence and doesn't get overwritten.
+		if (! empty($extra_request)) {
+			$query_args = array_merge($extra_request, $query_args);
+		}
+		$url = self::add_query_args_and_nonce($query_args, $_base_url, false, $exclude_nonce);
+		return EEH_Template::get_button_or_link($url, $this->_labels['buttons'][ $type ], $class);
+	}
+
+
+	/**
+	 * _per_page_screen_option
+	 * Utility function for adding in a per_page_option in the screen_options_dropdown.
+	 *
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	protected function _per_page_screen_option()
+	{
+		$option = 'per_page';
+		$args   = [
+			'label'   => apply_filters(
+				'FHEE__EE_Admin_Page___per_page_screen_options___label',
+				$this->_admin_page_title,
+				$this
+			),
+			'default' => (int) apply_filters(
+				'FHEE__EE_Admin_Page___per_page_screen_options__default',
+				20
+			),
+			'option'  => $this->_current_page . '_' . $this->_current_view . '_per_page',
+		];
+		// ONLY add the screen option if the user has access to it.
+		if ($this->check_user_access($this->_current_view, true)) {
+			add_screen_option($option, $args);
+		}
+	}
+
+
+	/**
+	 * set_per_page_screen_option
+	 * All this does is make sure that WordPress saves any per_page screen options (if set) for the current page.
+	 * we have to do this rather than running inside the 'set-screen-options' hook because it runs earlier than
+	 * admin_menu.
+	 *
+	 * @return void
+	 */
+	private function _set_per_page_screen_options()
+	{
+		if ($this->request->requestParamIsSet('wp_screen_options')) {
+			check_admin_referer('screen-options-nonce', 'screenoptionnonce');
+			if (! $user = wp_get_current_user()) {
+				return;
+			}
+			$option = $this->request->getRequestParam('wp_screen_options[option]', '', 'key');
+			if (! $option) {
+				return;
+			}
+			$value  = $this->request->getRequestParam('wp_screen_options[value]', 0, 'int');
+			$map_option = $option;
+			$option     = str_replace('-', '_', $option);
+			switch ($map_option) {
+				case $this->_current_page . '_' . $this->_current_view . '_per_page':
+					$max_value = apply_filters(
+						'FHEE__EE_Admin_Page___set_per_page_screen_options__max_value',
+						999,
+						$this->_current_page,
+						$this->_current_view
+					);
+					if ($value < 1) {
+						return;
+					}
+					$value = min($value, $max_value);
+					break;
+				default:
+					$value = apply_filters(
+						'FHEE__EE_Admin_Page___set_per_page_screen_options__value',
+						false,
+						$option,
+						$value
+					);
+					if (false === $value) {
+						return;
+					}
+					break;
+			}
+			update_user_meta($user->ID, $option, $value);
+			wp_safe_redirect(remove_query_arg(['pagenum', 'apage', 'paged'], wp_get_referer()));
+			exit;
+		}
+	}
+
+
+	/**
+	 * This just allows for setting the $_template_args property if it needs to be set outside the object
+	 *
+	 * @param array $data array that will be assigned to template args.
+	 */
+	public function set_template_args($data)
+	{
+		$this->_template_args = array_merge($this->_template_args, (array) $data);
+	}
+
+
+	/**
+	 * This makes available the WP transient system for temporarily moving data between routes
+	 *
+	 * @param string $route             the route that should receive the transient
+	 * @param array  $data              the data that gets sent
+	 * @param bool   $notices           If this is for notices then we use this to indicate so, otherwise its just a
+	 *                                  normal route transient.
+	 * @param bool   $skip_route_verify Used to indicate we want to skip route verification.  This is usually ONLY used
+	 *                                  when we are adding a transient before page_routes have been defined.
+	 * @return void
+	 * @throws EE_Error
+	 */
+	protected function _add_transient($route, $data, $notices = false, $skip_route_verify = false)
+	{
+		$user_id = get_current_user_id();
+		if (! $skip_route_verify) {
+			$this->_verify_route($route);
+		}
+		// now let's set the string for what kind of transient we're setting
+		$transient = $notices
+			? 'ee_rte_n_tx_' . $route . '_' . $user_id
+			: 'rte_tx_' . $route . '_' . $user_id;
+		$data      = $notices ? ['notices' => $data] : $data;
+		// is there already a transient for this route?  If there is then let's ADD to that transient
+		$existing = is_multisite() && is_network_admin()
+			? get_site_transient($transient)
+			: get_transient($transient);
+		if ($existing) {
+			$data = array_merge((array) $data, (array) $existing);
+		}
+		if (is_multisite() && is_network_admin()) {
+			set_site_transient($transient, $data, 8);
+		} else {
+			set_transient($transient, $data, 8);
+		}
+	}
+
+
+	/**
+	 * this retrieves the temporary transient that has been set for moving data between routes.
+	 *
+	 * @param bool   $notices true we get notices transient. False we just return normal route transient
+	 * @param string $route
+	 * @return mixed data
+	 */
+	protected function _get_transient($notices = false, $route = '')
+	{
+		$user_id   = get_current_user_id();
+		$route     = ! $route ? $this->_req_action : $route;
+		$transient = $notices
+			? 'ee_rte_n_tx_' . $route . '_' . $user_id
+			: 'rte_tx_' . $route . '_' . $user_id;
+		$data      = is_multisite() && is_network_admin()
+			? get_site_transient($transient)
+			: get_transient($transient);
+		// delete transient after retrieval (just in case it hasn't expired);
+		if (is_multisite() && is_network_admin()) {
+			delete_site_transient($transient);
+		} else {
+			delete_transient($transient);
+		}
+		return $notices && isset($data['notices']) ? $data['notices'] : $data;
+	}
+
+
+	/**
+	 * The purpose of this method is just to run garbage collection on any EE transients that might have expired but
+	 * would not be called later. This will be assigned to run on a specific EE Admin page. (place the method in the
+	 * default route callback on the EE_Admin page you want it run.)
+	 *
+	 * @return void
+	 */
+	protected function _transient_garbage_collection()
+	{
+		global $wpdb;
+		// retrieve all existing transients
+		$query =
+			"SELECT option_name FROM {$wpdb->options} WHERE option_name LIKE '%rte_tx_%' OR option_name LIKE '%rte_n_tx_%'";
+		if ($results = $wpdb->get_results($query)) {
+			foreach ($results as $result) {
+				$transient = str_replace('_transient_', '', $result->option_name);
+				get_transient($transient);
+				if (is_multisite() && is_network_admin()) {
+					get_site_transient($transient);
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * get_view
+	 *
+	 * @return string content of _view property
+	 */
+	public function get_view()
+	{
+		return $this->_view;
+	}
+
+
+	/**
+	 * getter for the protected $_views property
+	 *
+	 * @return array
+	 */
+	public function get_views()
+	{
+		return $this->_views;
+	}
+
+
+	/**
+	 * get_current_page
+	 *
+	 * @return string _current_page property value
+	 */
+	public function get_current_page()
+	{
+		return $this->_current_page;
+	}
+
+
+	/**
+	 * get_current_view
+	 *
+	 * @return string _current_view property value
+	 */
+	public function get_current_view()
+	{
+		return $this->_current_view;
+	}
+
+
+	/**
+	 * get_current_screen
+	 *
+	 * @return object The current WP_Screen object
+	 */
+	public function get_current_screen()
+	{
+		return $this->_current_screen;
+	}
+
+
+	/**
+	 * get_current_page_view_url
+	 *
+	 * @return string This returns the url for the current_page_view.
+	 */
+	public function get_current_page_view_url()
+	{
+		return $this->_current_page_view_url;
+	}
+
+
+	/**
+	 * just returns the Request
+	 *
+	 * @return RequestInterface
+	 */
+	public function get_request()
+	{
+		return $this->request;
+	}
+
+
+	/**
+	 * just returns the _req_data property
+	 *
+	 * @return array
+	 */
+	public function get_request_data()
+	{
+		return $this->request->requestParams();
+	}
+
+
+	/**
+	 * returns the _req_data protected property
+	 *
+	 * @return string
+	 */
+	public function get_req_action()
+	{
+		return $this->_req_action;
+	}
+
+
+	/**
+	 * @return bool  value of $_is_caf property
+	 */
+	public function is_caf()
+	{
+		return $this->_is_caf;
+	}
+
+
+	/**
+	 * @return mixed
+	 */
+	public function default_espresso_metaboxes()
+	{
+		return $this->_default_espresso_metaboxes;
+	}
+
+
+	/**
+	 * @return mixed
+	 */
+	public function admin_base_url()
+	{
+		return $this->_admin_base_url;
+	}
+
+
+	/**
+	 * @return mixed
+	 */
+	public function wp_page_slug()
+	{
+		return $this->_wp_page_slug;
+	}
+
+
+	/**
+	 * updates  espresso configuration settings
+	 *
+	 * @param string                   $tab
+	 * @param EE_Config_Base|EE_Config $config
+	 * @param string                   $file file where error occurred
+	 * @param string                   $func function  where error occurred
+	 * @param string                   $line line no where error occurred
+	 * @return boolean
+	 */
+	protected function _update_espresso_configuration($tab, $config, $file = '', $func = '', $line = '')
+	{
+		// remove any options that are NOT going to be saved with the config settings.
+		if (isset($config->core->ee_ueip_optin)) {
+			// TODO: remove the following two lines and make sure values are migrated from 3.1
+			update_option('ee_ueip_optin', $config->core->ee_ueip_optin);
+			update_option('ee_ueip_has_notified', true);
+		}
+		// and save it (note we're also doing the network save here)
+		$net_saved    = ! is_main_site() || EE_Network_Config::instance()->update_config(false, false);
+		$config_saved = EE_Config::instance()->update_espresso_config(false, false);
+		if ($config_saved && $net_saved) {
+			EE_Error::add_success(sprintf(esc_html__('"%s" have been successfully updated.', 'event_espresso'), $tab));
+			return true;
+		}
+		EE_Error::add_error(sprintf(esc_html__('The "%s" were not updated.', 'event_espresso'), $tab), $file, $func, $line);
+		return false;
+	}
+
+
+	/**
+	 * Returns an array to be used for EE_FOrm_Fields.helper.php's select_input as the $values argument.
+	 *
+	 * @return array
+	 */
+	public function get_yes_no_values()
+	{
+		return $this->_yes_no_values;
+	}
+
+
+	protected function _get_dir()
+	{
+		$reflector = new ReflectionClass(get_class($this));
+		return dirname($reflector->getFileName());
+	}
+
+
+	/**
+	 * A helper for getting a "next link".
+	 *
+	 * @param string $url   The url to link to
+	 * @param string $class The class to use.
+	 * @return string
+	 */
+	protected function _next_link($url, $class = 'dashicons dashicons-arrow-right')
+	{
+		return '<a class="' . $class . '" href="' . $url . '"></a>';
+	}
+
+
+	/**
+	 * A helper for getting a "previous link".
+	 *
+	 * @param string $url   The url to link to
+	 * @param string $class The class to use.
+	 * @return string
+	 */
+	protected function _previous_link($url, $class = 'dashicons dashicons-arrow-left')
+	{
+		return '<a class="' . $class . '" href="' . $url . '"></a>';
+	}
+
+
+
+
+
+
+
+	// below are some messages related methods that should be available across the EE_Admin system.  Note, these methods are NOT page specific
+
+
+	/**
+	 * This processes an request to resend a registration and assumes we have a _REG_ID for doing so. So if the caller
+	 * knows that the _REG_ID isn't in the req_data array but CAN obtain it, the caller should ADD the _REG_ID to the
+	 * _req_data array.
+	 *
+	 * @return bool success/fail
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _process_resend_registration()
+	{
+		$this->_template_args['success'] = EED_Messages::process_resend($this->_req_data);
+		do_action(
+			'AHEE__EE_Admin_Page___process_resend_registration',
+			$this->_template_args['success'],
+			$this->request->requestParams()
+		);
+		return $this->_template_args['success'];
+	}
+
+
+	/**
+	 * This automatically processes any payment message notifications when manual payment has been applied.
+	 *
+	 * @param EE_Payment $payment
+	 * @return bool success/fail
+	 */
+	protected function _process_payment_notification(EE_Payment $payment)
+	{
+		add_filter('FHEE__EE_Payment_Processor__process_registration_payments__display_notifications', '__return_true');
+		do_action('AHEE__EE_Admin_Page___process_admin_payment_notification', $payment);
+		$this->_template_args['success'] = apply_filters(
+			'FHEE__EE_Admin_Page___process_admin_payment_notification__success',
+			false,
+			$payment
+		);
+		return $this->_template_args['success'];
+	}
+
+
+	/**
+	 * @param EEM_Base      $entity_model
+	 * @param string        $entity_PK_name name of the primary key field used as a request param, ie: id, ID, etc
+	 * @param string        $action         one of the EE_Admin_List_Table::ACTION_* constants: delete, restore, trash
+	 * @param string        $delete_column  name of the field that denotes whether entity is trashed
+	 * @param callable|null $callback       called after entity is trashed, restored, or deleted
+	 * @return int|float
+	 * @throws EE_Error
+	 */
+	protected function trashRestoreDeleteEntities(
+		EEM_Base $entity_model,
+		$entity_PK_name,
+		$action = EE_Admin_List_Table::ACTION_DELETE,
+		$delete_column = '',
+		callable $callback = null
+	) {
+		$entity_PK      = $entity_model->get_primary_key_field();
+		$entity_PK_name = $entity_PK_name ?: $entity_PK->get_name();
+		$entity_PK_type = $this->resolveEntityFieldDataType($entity_PK);
+		// grab ID if deleting a single entity
+		if ($this->request->requestParamIsSet($entity_PK_name)) {
+			$ID = $this->request->getRequestParam($entity_PK_name, 0, $entity_PK_type);
+			return $this->trashRestoreDeleteEntity($entity_model, $ID, $action, $delete_column, $callback) ? 1 : 0;
+		}
+		// or grab checkbox array if bulk deleting
+		$checkboxes = $this->request->getRequestParam('checkbox', [], $entity_PK_type, true);
+		if (empty($checkboxes)) {
+			return 0;
+		}
+		$success = 0;
+		$IDs     = array_keys($checkboxes);
+		// cycle thru bulk action checkboxes
+		foreach ($IDs as $ID) {
+			// increment $success
+			if ($this->trashRestoreDeleteEntity($entity_model, $ID, $action, $delete_column, $callback)) {
+				$success++;
+			}
+		}
+		$count = (int) count($checkboxes);
+		// if multiple entities were deleted successfully, then $deleted will be full count of deletions,
+		// otherwise it will be a fraction of ( actual deletions / total entities to be deleted )
+		return $success === $count ? $count : $success / $count;
+	}
+
+
+	/**
+	 * @param EE_Primary_Key_Field_Base $entity_PK
+	 * @return string
+	 * @throws EE_Error
+	 * @since   4.10.30.p
+	 */
+	private function resolveEntityFieldDataType(EE_Primary_Key_Field_Base $entity_PK)
+	{
+		$entity_PK_type = $entity_PK->getSchemaType();
+		switch ($entity_PK_type) {
+			case 'boolean':
+				return 'bool';
+			case 'integer':
+				return 'int';
+			case 'number':
+				return 'float';
+			case 'string':
+				return 'string';
+		}
+		throw new RuntimeException(
+			sprintf(
+				esc_html__(
+					'"%1$s" is an invalid schema type for the %2$s primary key.',
+					'event_espresso'
+				),
+				$entity_PK_type,
+				$entity_PK->get_name()
+			)
+		);
+	}
+
+
+	/**
+	 * @param EEM_Base      $entity_model
+	 * @param int|string    $entity_ID
+	 * @param string        $action        one of the EE_Admin_List_Table::ACTION_* constants: delete, restore, trash
+	 * @param string        $delete_column name of the field that denotes whether entity is trashed
+	 * @param callable|null $callback      called after entity is trashed, restored, or deleted
+	 * @return bool
+	 */
+	protected function trashRestoreDeleteEntity(
+		EEM_Base $entity_model,
+		$entity_ID,
+		$action,
+		$delete_column,
+		callable $callback = null
+	) {
+		$entity_ID = absint($entity_ID);
+		if (! $entity_ID) {
+			$this->trashRestoreDeleteError($action, $entity_model);
+		}
+		$result = 0;
+		try {
+			$entity = $entity_model->get_one_by_ID($entity_ID);
+			if (! $entity instanceof EE_Base_Class) {
+				throw new DomainException(
+					sprintf(
+						esc_html__(
+							'Missing or invalid %1$s entity with ID of "%2$s" returned from db.',
+							'event_espresso'
+						),
+						str_replace('EEM_', '', $entity_model->get_this_model_name()),
+						$entity_ID
+					)
+				);
+			}
+			switch ($action) {
+				case EE_Admin_List_Table::ACTION_DELETE:
+					$result = (bool) $entity->delete_permanently();
+					break;
+				case EE_Admin_List_Table::ACTION_RESTORE:
+					$result = $entity->delete_or_restore(false);
+					break;
+				case EE_Admin_List_Table::ACTION_TRASH:
+					$result = $entity->delete_or_restore();
+					break;
+			}
+		} catch (Exception $exception) {
+			$this->trashRestoreDeleteError($action, $entity_model, $exception);
+		}
+		if (is_callable($callback)) {
+			call_user_func_array($callback, [$entity_model, $entity_ID, $action, $result, $delete_column]);
+		}
+		return $result;
+	}
+
+
+	/**
+	 * @param EEM_Base $entity_model
+	 * @param string   $delete_column
+	 * @since 4.10.30.p
+	 */
+	private function validateDeleteColumn(EEM_Base $entity_model, $delete_column)
+	{
+		if (empty($delete_column)) {
+			throw new DomainException(
+				sprintf(
+					esc_html__(
+						'You need to specify the name of the "delete column" on the %2$s model, in order to trash or restore an entity.',
+						'event_espresso'
+					),
+					$entity_model->get_this_model_name()
+				)
+			);
+		}
+		if (! $entity_model->has_field($delete_column)) {
+			throw new DomainException(
+				sprintf(
+					esc_html__(
+						'The %1$s field does not exist on the %2$s model.',
+						'event_espresso'
+					),
+					$delete_column,
+					$entity_model->get_this_model_name()
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @param EEM_Base       $entity_model
+	 * @param Exception|null $exception
+	 * @param string         $action
+	 * @since 4.10.30.p
+	 */
+	private function trashRestoreDeleteError($action, EEM_Base $entity_model, Exception $exception = null)
+	{
+		if ($exception instanceof Exception) {
+			throw new RuntimeException(
+				sprintf(
+					esc_html__(
+						'Could not %1$s the %2$s because the following error occurred: %3$s',
+						'event_espresso'
+					),
+					$action,
+					$entity_model->get_this_model_name(),
+					$exception->getMessage()
+				)
+			);
+		}
+		throw new RuntimeException(
+			sprintf(
+				esc_html__(
+					'Could not %1$s the %2$s because an invalid ID was received.',
+					'event_espresso'
+				),
+				$action,
+				$entity_model->get_this_model_name()
+			)
+		);
+	}
 }

Spacing +186 added lines, -186 removed lines

@@ -515,7 +515,7 @@ 
         $ee_menu_slugs = (array) $ee_menu_slugs;
         if (
             ! $this->request->isAjax()
-            && (! $this->_current_page || ! isset($ee_menu_slugs[ $this->_current_page ]))
+            && ( ! $this->_current_page || ! isset($ee_menu_slugs[$this->_current_page]))
         ) {
             return;
         }
@@ -535,7 +535,7 @@ 
             : $req_action;
 
         $this->_current_view = $this->_req_action;
-        $this->_req_nonce    = $this->_req_action . '_nonce';
+        $this->_req_nonce    = $this->_req_action.'_nonce';
         $this->_define_page_props();
         $this->_current_page_view_url = add_query_arg(
             ['page' => $this->_current_page, 'action' => $this->_current_view],
@@ -572,21 +572,21 @@ 
         }
         // filter routes and page_config so addons can add their stuff. Filtering done per class
         $this->_page_routes = apply_filters(
-            'FHEE__' . get_class($this) . '__page_setup__page_routes',
+            'FHEE__'.get_class($this).'__page_setup__page_routes',
             $this->_page_routes,
             $this
         );
         $this->_page_config = apply_filters(
-            'FHEE__' . get_class($this) . '__page_setup__page_config',
+            'FHEE__'.get_class($this).'__page_setup__page_config',
             $this->_page_config,
             $this
         );
         // if AHEE__EE_Admin_Page__route_admin_request_$this->_current_view method is present
         // then we call it hooked into the AHEE__EE_Admin_Page__route_admin_request action
-        if (method_exists($this, 'AHEE__EE_Admin_Page__route_admin_request_' . $this->_current_view)) {
+        if (method_exists($this, 'AHEE__EE_Admin_Page__route_admin_request_'.$this->_current_view)) {
             add_action(
                 'AHEE__EE_Admin_Page__route_admin_request',
-                [$this, 'AHEE__EE_Admin_Page__route_admin_request_' . $this->_current_view],
+                [$this, 'AHEE__EE_Admin_Page__route_admin_request_'.$this->_current_view],
                 10,
                 2
             );
@@ -599,8 +599,8 @@ 
             if ($this->_is_UI_request) {
                 // admin_init stuff - global, all views for this page class, specific view
                 add_action('admin_init', [$this, 'admin_init'], 10);
-                if (method_exists($this, 'admin_init_' . $this->_current_view)) {
-                    add_action('admin_init', [$this, 'admin_init_' . $this->_current_view], 15);
+                if (method_exists($this, 'admin_init_'.$this->_current_view)) {
+                    add_action('admin_init', [$this, 'admin_init_'.$this->_current_view], 15);
                 }
             } else {
                 // hijack regular WP loading and route admin request immediately
@@ -619,12 +619,12 @@ 
      */
     private function _do_other_page_hooks()
     {
-        $registered_pages = apply_filters('FHEE_do_other_page_hooks_' . $this->page_slug, []);
+        $registered_pages = apply_filters('FHEE_do_other_page_hooks_'.$this->page_slug, []);
         foreach ($registered_pages as $page) {
             // now let's setup the file name and class that should be present
             $classname = str_replace('.class.php', '', $page);
             // autoloaders should take care of loading file
-            if (! class_exists($classname)) {
+            if ( ! class_exists($classname)) {
                 $error_msg[] = sprintf(
                     esc_html__(
                         'Something went wrong with loading the %s admin hooks page.',
@@ -641,7 +641,7 @@ 
                                    ),
                                    $page,
                                    '<br />',
-                                   '<strong>' . $classname . '</strong>'
+                                   '<strong>'.$classname.'</strong>'
                                );
                 throw new EE_Error(implode('||', $error_msg));
             }
@@ -683,13 +683,13 @@ 
         // load admin_notices - global, page class, and view specific
         add_action('admin_notices', [$this, 'admin_notices_global'], 5);
         add_action('admin_notices', [$this, 'admin_notices'], 10);
-        if (method_exists($this, 'admin_notices_' . $this->_current_view)) {
-            add_action('admin_notices', [$this, 'admin_notices_' . $this->_current_view], 15);
+        if (method_exists($this, 'admin_notices_'.$this->_current_view)) {
+            add_action('admin_notices', [$this, 'admin_notices_'.$this->_current_view], 15);
         }
         // load network admin_notices - global, page class, and view specific
         add_action('network_admin_notices', [$this, 'network_admin_notices_global'], 5);
-        if (method_exists($this, 'network_admin_notices_' . $this->_current_view)) {
-            add_action('network_admin_notices', [$this, 'network_admin_notices_' . $this->_current_view]);
+        if (method_exists($this, 'network_admin_notices_'.$this->_current_view)) {
+            add_action('network_admin_notices', [$this, 'network_admin_notices_'.$this->_current_view]);
         }
         // this will save any per_page screen options if they are present
         $this->_set_per_page_screen_options();
@@ -810,7 +810,7 @@ 
     protected function _verify_routes()
     {
         do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        if (! $this->_current_page && ! $this->request->isAjax()) {
+        if ( ! $this->_current_page && ! $this->request->isAjax()) {
             return false;
         }
         $this->_route = false;
@@ -822,7 +822,7 @@ 
                 $this->_admin_page_title
             );
             // developer error msg
-            $error_msg .= '||' . $error_msg
+            $error_msg .= '||'.$error_msg
                           . esc_html__(
                               ' Make sure the "set_page_routes()" method exists, and is setting the "_page_routes" array properly.',
                               'event_espresso'
@@ -831,9 +831,9 @@ 
         }
         // and that the requested page route exists
         if (array_key_exists($this->_req_action, $this->_page_routes)) {
-            $this->_route        = $this->_page_routes[ $this->_req_action ];
-            $this->_route_config = isset($this->_page_config[ $this->_req_action ])
-                ? $this->_page_config[ $this->_req_action ]
+            $this->_route        = $this->_page_routes[$this->_req_action];
+            $this->_route_config = isset($this->_page_config[$this->_req_action])
+                ? $this->_page_config[$this->_req_action]
                 : [];
         } else {
             // user error msg
@@ -845,7 +845,7 @@ 
                 $this->_admin_page_title
             );
             // developer error msg
-            $error_msg .= '||' . $error_msg
+            $error_msg .= '||'.$error_msg
                           . sprintf(
                               esc_html__(
                                   ' Create a key in the "_page_routes" array named "%s" and set its value to the appropriate method.',
@@ -856,7 +856,7 @@ 
             throw new EE_Error($error_msg);
         }
         // and that a default route exists
-        if (! array_key_exists('default', $this->_page_routes)) {
+        if ( ! array_key_exists('default', $this->_page_routes)) {
             // user error msg
             $error_msg = sprintf(
                 esc_html__(
@@ -866,7 +866,7 @@ 
                 $this->_admin_page_title
             );
             // developer error msg
-            $error_msg .= '||' . $error_msg
+            $error_msg .= '||'.$error_msg
                           . esc_html__(
                               ' Create a key in the "_page_routes" array named "default" and set its value to your default page method.',
                               'event_espresso'
@@ -907,7 +907,7 @@ 
             $this->_admin_page_title
         );
         // developer error msg
-        $error_msg .= '||' . $error_msg
+        $error_msg .= '||'.$error_msg
                       . sprintf(
                           esc_html__(
                               ' Check the route you are using in your method (%s) and make sure it matches a route set in your "_page_routes" array property',
@@ -932,7 +932,7 @@ 
     protected function _verify_nonce($nonce, $nonce_ref)
     {
         // verify nonce against expected value
-        if (! wp_verify_nonce($nonce, $nonce_ref)) {
+        if ( ! wp_verify_nonce($nonce, $nonce_ref)) {
             // these are not the droids you are looking for !!!
             $msg = sprintf(
                 esc_html__('%sNonce Fail.%s', 'event_espresso'),
@@ -949,7 +949,7 @@ 
                     __CLASS__
                 );
             }
-            if (! $this->request->isAjax()) {
+            if ( ! $this->request->isAjax()) {
                 wp_die($msg);
             }
             EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
@@ -973,7 +973,7 @@ 
      */
     protected function _route_admin_request()
     {
-        if (! $this->_is_UI_request) {
+        if ( ! $this->_is_UI_request) {
             $this->_verify_routes();
         }
         $nonce_check = ! isset($this->_route_config['require_nonce']) || $this->_route_config['require_nonce'];
@@ -993,7 +993,7 @@ 
         $error_msg = '';
         // action right before calling route
         // (hook is something like 'AHEE__Registrations_Admin_Page__route_admin_request')
-        if (! did_action('AHEE__EE_Admin_Page__route_admin_request')) {
+        if ( ! did_action('AHEE__EE_Admin_Page__route_admin_request')) {
             do_action('AHEE__EE_Admin_Page__route_admin_request', $this->_current_view, $this);
         }
         // right before calling the route, let's clean the _wp_http_referer
@@ -1005,7 +1005,7 @@ 
         );
         $this->request->setRequestParam('_wp_http_referer', $cleaner_request_uri);
         $this->request->setServerParam('REQUEST_URI', $cleaner_request_uri);
-        if (! empty($func)) {
+        if ( ! empty($func)) {
             if (is_array($func)) {
                 [$class, $method] = $func;
             } elseif (strpos($func, '::') !== false) {
@@ -1014,7 +1014,7 @@ 
                 $class  = $this;
                 $method = $func;
             }
-            if (! (is_object($class) && $class === $this) && ! in_array($this, $args)) {
+            if ( ! (is_object($class) && $class === $this) && ! in_array($this, $args)) {
                 // send along this admin page object for access by addons.
                 $args['admin_page'] = $this;
             }
@@ -1055,7 +1055,7 @@ 
                     $method
                 );
             }
-            if (! empty($error_msg)) {
+            if ( ! empty($error_msg)) {
                 throw new EE_Error($error_msg);
             }
         }
@@ -1140,7 +1140,7 @@ 
                 if (strpos($key, 'nonce') !== false) {
                     continue;
                 }
-                $args[ 'wp_referer[' . $key . ']' ] = is_string($value) ? htmlspecialchars($value) : $value;
+                $args['wp_referer['.$key.']'] = is_string($value) ? htmlspecialchars($value) : $value;
             }
         }
         return EEH_URL::add_query_args_and_nonce($args, $url, $exclude_nonce);
@@ -1179,12 +1179,12 @@ 
      */
     protected function _add_help_tabs()
     {
-        if (isset($this->_page_config[ $this->_req_action ])) {
-            $config = $this->_page_config[ $this->_req_action ];
+        if (isset($this->_page_config[$this->_req_action])) {
+            $config = $this->_page_config[$this->_req_action];
             // let's see if there is a help_sidebar set for the current route and we'll set that up for usage as well.
             if (is_array($config) && isset($config['help_sidebar'])) {
                 // check that the callback given is valid
-                if (! method_exists($this, $config['help_sidebar'])) {
+                if ( ! method_exists($this, $config['help_sidebar'])) {
                     throw new EE_Error(
                         sprintf(
                             esc_html__(
@@ -1197,18 +1197,18 @@ 
                     );
                 }
                 $content = apply_filters(
-                    'FHEE__' . get_class($this) . '__add_help_tabs__help_sidebar',
+                    'FHEE__'.get_class($this).'__add_help_tabs__help_sidebar',
                     $this->{$config['help_sidebar']}()
                 );
                 $this->_current_screen->set_help_sidebar($content);
             }
-            if (! isset($config['help_tabs'])) {
+            if ( ! isset($config['help_tabs'])) {
                 return;
             } //no help tabs for this route
             foreach ((array) $config['help_tabs'] as $tab_id => $cfg) {
                 // we're here so there ARE help tabs!
                 // make sure we've got what we need
-                if (! isset($cfg['title'])) {
+                if ( ! isset($cfg['title'])) {
                     throw new EE_Error(
                         esc_html__(
                             'The _page_config array is not set up properly for help tabs.  It is missing a title',
@@ -1216,7 +1216,7 @@ 
                         )
                     );
                 }
-                if (! isset($cfg['filename']) && ! isset($cfg['callback']) && ! isset($cfg['content'])) {
+                if ( ! isset($cfg['filename']) && ! isset($cfg['callback']) && ! isset($cfg['content'])) {
                     throw new EE_Error(
                         esc_html__(
                             'The _page_config array is not setup properly for help tabs. It is missing a either a filename reference, or a callback reference or a content reference so there is no way to know the content for the help tab',
@@ -1225,11 +1225,11 @@ 
                     );
                 }
                 // first priority goes to content.
-                if (! empty($cfg['content'])) {
+                if ( ! empty($cfg['content'])) {
                     $content = ! empty($cfg['content']) ? $cfg['content'] : null;
                     // second priority goes to filename
-                } elseif (! empty($cfg['filename'])) {
-                    $file_path = $this->_get_dir() . '/help_tabs/' . $cfg['filename'] . '.help_tab.php';
+                } elseif ( ! empty($cfg['filename'])) {
+                    $file_path = $this->_get_dir().'/help_tabs/'.$cfg['filename'].'.help_tab.php';
                     // it's possible that the file is located on decaf route (and above sets up for caf route, if this is the case then lets check decaf route too)
                     $file_path = ! is_readable($file_path) ? EE_ADMIN_PAGES
                                                              . basename($this->_get_dir())
@@ -1237,7 +1237,7 @@ 
                                                              . $cfg['filename']
                                                              . '.help_tab.php' : $file_path;
                     // if file is STILL not readable then let's do a EE_Error so its more graceful than a fatal error.
-                    if (! isset($cfg['callback']) && ! is_readable($file_path)) {
+                    if ( ! isset($cfg['callback']) && ! is_readable($file_path)) {
                         EE_Error::add_error(
                             sprintf(
                                 esc_html__(
@@ -1285,7 +1285,7 @@ 
                     return;
                 }
                 // setup config array for help tab method
-                $id  = $this->page_slug . '-' . $this->_req_action . '-' . $tab_id;
+                $id  = $this->page_slug.'-'.$this->_req_action.'-'.$tab_id;
                 $_ht = [
                     'id'       => $id,
                     'title'    => $cfg['title'],
@@ -1309,8 +1309,8 @@ 
             $qtips = (array) $this->_route_config['qtips'];
             // load qtip loader
             $path = [
-                $this->_get_dir() . '/qtips/',
-                EE_ADMIN_PAGES . basename($this->_get_dir()) . '/qtips/',
+                $this->_get_dir().'/qtips/',
+                EE_ADMIN_PAGES.basename($this->_get_dir()).'/qtips/',
             ];
             EEH_Qtip_Loader::instance()->register($qtips, $path);
         }
@@ -1332,7 +1332,7 @@ 
         do_action('AHEE_log', __FILE__, __FUNCTION__, '');
         $i = 0;
         foreach ($this->_page_config as $slug => $config) {
-            if (! is_array($config) || empty($config['nav'])) {
+            if ( ! is_array($config) || empty($config['nav'])) {
                 continue;
             }
             // no nav tab for this config
@@ -1341,12 +1341,12 @@ 
                 // nav tab is only to appear when route requested.
                 continue;
             }
-            if (! $this->check_user_access($slug, true)) {
+            if ( ! $this->check_user_access($slug, true)) {
                 // no nav tab because current user does not have access.
                 continue;
             }
-            $css_class                = isset($config['css_class']) ? $config['css_class'] . ' ' : '';
-            $this->_nav_tabs[ $slug ] = [
+            $css_class                = isset($config['css_class']) ? $config['css_class'].' ' : '';
+            $this->_nav_tabs[$slug] = [
                 'url'       => isset($config['nav']['url'])
                     ? $config['nav']['url']
                     : self::add_query_args_and_nonce(
@@ -1358,14 +1358,14 @@ 
                     : ucwords(
                         str_replace('_', ' ', $slug)
                     ),
-                'css_class' => $this->_req_action === $slug ? $css_class . 'nav-tab-active' : $css_class,
+                'css_class' => $this->_req_action === $slug ? $css_class.'nav-tab-active' : $css_class,
                 'order'     => isset($config['nav']['order']) ? $config['nav']['order'] : $i,
             ];
             $i++;
         }
         // if $this->_nav_tabs is empty then lets set the default
         if (empty($this->_nav_tabs)) {
-            $this->_nav_tabs[ $this->_default_nav_tab_name ] = [
+            $this->_nav_tabs[$this->_default_nav_tab_name] = [
                 'url'       => $this->_admin_base_url,
                 'link_text' => ucwords(str_replace('_', ' ', $this->_default_nav_tab_name)),
                 'css_class' => 'nav-tab-active',
@@ -1390,10 +1390,10 @@ 
             foreach ($this->_route_config['labels'] as $label => $text) {
                 if (is_array($text)) {
                     foreach ($text as $sublabel => $subtext) {
-                        $this->_labels[ $label ][ $sublabel ] = $subtext;
+                        $this->_labels[$label][$sublabel] = $subtext;
                     }
                 } else {
-                    $this->_labels[ $label ] = $text;
+                    $this->_labels[$label] = $text;
                 }
             }
         }
@@ -1415,12 +1415,12 @@ 
     {
         do_action('AHEE_log', __FILE__, __FUNCTION__, '');
         $route_to_check = empty($route_to_check) ? $this->_req_action : $route_to_check;
-        $capability     = ! empty($route_to_check) && isset($this->_page_routes[ $route_to_check ])
+        $capability     = ! empty($route_to_check) && isset($this->_page_routes[$route_to_check])
                           && is_array(
-                              $this->_page_routes[ $route_to_check ]
+                              $this->_page_routes[$route_to_check]
                           )
-                          && ! empty($this->_page_routes[ $route_to_check ]['capability'])
-            ? $this->_page_routes[ $route_to_check ]['capability'] : null;
+                          && ! empty($this->_page_routes[$route_to_check]['capability'])
+            ? $this->_page_routes[$route_to_check]['capability'] : null;
         if (empty($capability) && empty($route_to_check)) {
             $capability = is_array($this->_route) && empty($this->_route['capability']) ? 'manage_options'
                 : $this->_route['capability'];
@@ -1540,7 +1540,7 @@ 
         ';
 
         // current set timezone for timezone js
-        echo '<span id="current_timezone" class="hidden">' . esc_html(EEH_DTT_Helper::get_timezone()) . '</span>';
+        echo '<span id="current_timezone" class="hidden">'.esc_html(EEH_DTT_Helper::get_timezone()).'</span>';
     }
 
 
@@ -1574,7 +1574,7 @@ 
         // loop through the array and setup content
         foreach ($help_array as $trigger => $help) {
             // make sure the array is setup properly
-            if (! isset($help['title']) || ! isset($help['content'])) {
+            if ( ! isset($help['title']) || ! isset($help['content'])) {
                 throw new EE_Error(
                     esc_html__(
                         'Does not look like the popup content array has been setup correctly.  Might want to double check that.  Read the comments for the _get_help_popup_content method found in "EE_Admin_Page" class',
@@ -1588,8 +1588,8 @@ 
                 'help_popup_title'   => $help['title'],
                 'help_popup_content' => $help['content'],
             ];
-            $content       .= EEH_Template::display_template(
-                EE_ADMIN_TEMPLATE . 'admin_help_popup.template.php',
+            $content .= EEH_Template::display_template(
+                EE_ADMIN_TEMPLATE.'admin_help_popup.template.php',
                 $template_args,
                 true
             );
@@ -1611,15 +1611,15 @@ 
     private function _get_help_content()
     {
         // what is the method we're looking for?
-        $method_name = '_help_popup_content_' . $this->_req_action;
+        $method_name = '_help_popup_content_'.$this->_req_action;
         // if method doesn't exist let's get out.
-        if (! method_exists($this, $method_name)) {
+        if ( ! method_exists($this, $method_name)) {
             return [];
         }
         // k we're good to go let's retrieve the help array
         $help_array = call_user_func([$this, $method_name]);
         // make sure we've got an array!
-        if (! is_array($help_array)) {
+        if ( ! is_array($help_array)) {
             throw new EE_Error(
                 esc_html__(
                     'Something went wrong with help popup content generation. Expecting an array and well, this ain\'t no array bub.',
@@ -1651,15 +1651,15 @@ 
         // let's check and see if there is any content set for this popup.  If there isn't then we'll include a default title and content so that developers know something needs to be corrected
         $help_array   = $this->_get_help_content();
         $help_content = '';
-        if (empty($help_array) || ! isset($help_array[ $trigger_id ])) {
-            $help_array[ $trigger_id ] = [
+        if (empty($help_array) || ! isset($help_array[$trigger_id])) {
+            $help_array[$trigger_id] = [
                 'title'   => esc_html__('Missing Content', 'event_espresso'),
                 'content' => esc_html__(
                     'A trigger has been set that doesn\'t have any corresponding content. Make sure you have set the help content. (see the "_set_help_popup_content" method in the EE_Admin_Page for instructions.)',
                     'event_espresso'
                 ),
             ];
-            $help_content              = $this->_set_help_popup_content($help_array);
+            $help_content = $this->_set_help_popup_content($help_array);
         }
         // let's setup the trigger
         $content = '<a class="ee-dialog" href="?height='
@@ -1727,15 +1727,15 @@ 
         // register all styles
         wp_register_style(
             'espresso-ui-theme',
-            EE_GLOBAL_ASSETS_URL . 'css/espresso-ui-theme/jquery-ui-1.10.3.custom.min.css',
+            EE_GLOBAL_ASSETS_URL.'css/espresso-ui-theme/jquery-ui-1.10.3.custom.min.css',
             [],
             EVENT_ESPRESSO_VERSION
         );
-        wp_register_style('ee-admin-css', EE_ADMIN_URL . 'assets/ee-admin-page.css', [], EVENT_ESPRESSO_VERSION);
+        wp_register_style('ee-admin-css', EE_ADMIN_URL.'assets/ee-admin-page.css', [], EVENT_ESPRESSO_VERSION);
         // helpers styles
         wp_register_style(
             'ee-text-links',
-            EE_PLUGIN_DIR_URL . 'core/helpers/assets/ee_text_list_helper.css',
+            EE_PLUGIN_DIR_URL.'core/helpers/assets/ee_text_list_helper.css',
             [],
             EVENT_ESPRESSO_VERSION
         );
@@ -1743,21 +1743,21 @@ 
         // register all scripts
         wp_register_script(
             'ee-dialog',
-            EE_ADMIN_URL . 'assets/ee-dialog-helper.js',
+            EE_ADMIN_URL.'assets/ee-dialog-helper.js',
             ['jquery', 'jquery-ui-draggable'],
             EVENT_ESPRESSO_VERSION,
             true
         );
         wp_register_script(
             'ee_admin_js',
-            EE_ADMIN_URL . 'assets/ee-admin-page.js',
+            EE_ADMIN_URL.'assets/ee-admin-page.js',
             ['espresso_core', 'ee-parse-uri', 'ee-dialog'],
             EVENT_ESPRESSO_VERSION,
             true
         );
         wp_register_script(
             'jquery-ui-timepicker-addon',
-            EE_GLOBAL_ASSETS_URL . 'scripts/jquery-ui-timepicker-addon.js',
+            EE_GLOBAL_ASSETS_URL.'scripts/jquery-ui-timepicker-addon.js',
             ['jquery-ui-datepicker', 'jquery-ui-slider'],
             EVENT_ESPRESSO_VERSION,
             true
@@ -1765,7 +1765,7 @@ 
         // script for sorting tables
         wp_register_script(
             'espresso_ajax_table_sorting',
-            EE_ADMIN_URL . 'assets/espresso_ajax_table_sorting.js',
+            EE_ADMIN_URL.'assets/espresso_ajax_table_sorting.js',
             ['ee_admin_js', 'jquery-ui-sortable'],
             EVENT_ESPRESSO_VERSION,
             true
@@ -1773,7 +1773,7 @@ 
         // script for parsing uri's
         wp_register_script(
             'ee-parse-uri',
-            EE_GLOBAL_ASSETS_URL . 'scripts/parseuri.js',
+            EE_GLOBAL_ASSETS_URL.'scripts/parseuri.js',
             [],
             EVENT_ESPRESSO_VERSION,
             true
@@ -1781,7 +1781,7 @@ 
         // and parsing associative serialized form elements
         wp_register_script(
             'ee-serialize-full-array',
-            EE_GLOBAL_ASSETS_URL . 'scripts/jquery.serializefullarray.js',
+            EE_GLOBAL_ASSETS_URL.'scripts/jquery.serializefullarray.js',
             ['jquery'],
             EVENT_ESPRESSO_VERSION,
             true
@@ -1789,28 +1789,28 @@ 
         // helpers scripts
         wp_register_script(
             'ee-text-links',
-            EE_PLUGIN_DIR_URL . 'core/helpers/assets/ee_text_list_helper.js',
+            EE_PLUGIN_DIR_URL.'core/helpers/assets/ee_text_list_helper.js',
             ['jquery'],
             EVENT_ESPRESSO_VERSION,
             true
         );
         wp_register_script(
             'ee-moment-core',
-            EE_GLOBAL_ASSETS_URL . 'moment/moment-with-locales.min.js',
+            EE_GLOBAL_ASSETS_URL.'moment/moment-with-locales.min.js',
             [],
             EVENT_ESPRESSO_VERSION,
             true
         );
         wp_register_script(
             'ee-moment',
-            EE_GLOBAL_ASSETS_URL . 'moment/moment-timezone-with-data.min.js',
+            EE_GLOBAL_ASSETS_URL.'moment/moment-timezone-with-data.min.js',
             ['ee-moment-core'],
             EVENT_ESPRESSO_VERSION,
             true
         );
         wp_register_script(
             'ee-datepicker',
-            EE_ADMIN_URL . 'assets/ee-datepicker.js',
+            EE_ADMIN_URL.'assets/ee-datepicker.js',
             ['jquery-ui-timepicker-addon', 'ee-moment'],
             EVENT_ESPRESSO_VERSION,
             true
@@ -1843,7 +1843,7 @@ 
         wp_localize_script('ee_admin_js', 'eeLazyLoadingContainers', $lazy_loader_container_ids);
         add_filter(
             'admin_body_class',
-            function ($classes) {
+            function($classes) {
                 if (strpos($classes, 'espresso-admin') === false) {
                     $classes .= ' espresso-admin';
                 }
@@ -1931,12 +1931,12 @@ 
     protected function _set_list_table()
     {
         // first is this a list_table view?
-        if (! isset($this->_route_config['list_table'])) {
+        if ( ! isset($this->_route_config['list_table'])) {
             return;
         } //not a list_table view so get out.
         // list table functions are per view specific (because some admin pages might have more than one list table!)
-        $list_table_view = '_set_list_table_views_' . $this->_req_action;
-        if (! method_exists($this, $list_table_view) || $this->{$list_table_view}() === false) {
+        $list_table_view = '_set_list_table_views_'.$this->_req_action;
+        if ( ! method_exists($this, $list_table_view) || $this->{$list_table_view}() === false) {
             // user error msg
             $error_msg = esc_html__(
                 'An error occurred. The requested list table views could not be found.',
@@ -1956,10 +1956,10 @@ 
         }
         // let's provide the ability to filter the views per PAGE AND ROUTE, per PAGE, and globally
         $this->_views = apply_filters(
-            'FHEE_list_table_views_' . $this->page_slug . '_' . $this->_req_action,
+            'FHEE_list_table_views_'.$this->page_slug.'_'.$this->_req_action,
             $this->_views
         );
-        $this->_views = apply_filters('FHEE_list_table_views_' . $this->page_slug, $this->_views);
+        $this->_views = apply_filters('FHEE_list_table_views_'.$this->page_slug, $this->_views);
         $this->_views = apply_filters('FHEE_list_table_views', $this->_views);
         $this->_set_list_table_view();
         $this->_set_list_table_object();
@@ -1994,7 +1994,7 @@ 
     protected function _set_list_table_object()
     {
         if (isset($this->_route_config['list_table'])) {
-            if (! class_exists($this->_route_config['list_table'])) {
+            if ( ! class_exists($this->_route_config['list_table'])) {
                 throw new EE_Error(
                     sprintf(
                         esc_html__(
@@ -2032,15 +2032,15 @@ 
         foreach ($this->_views as $key => $view) {
             $query_args = [];
             // check for current view
-            $this->_views[ $key ]['class']               = $this->_view === $view['slug'] ? 'current' : '';
+            $this->_views[$key]['class']               = $this->_view === $view['slug'] ? 'current' : '';
             $query_args['action']                        = $this->_req_action;
-            $query_args[ $this->_req_action . '_nonce' ] = wp_create_nonce($query_args['action'] . '_nonce');
+            $query_args[$this->_req_action.'_nonce'] = wp_create_nonce($query_args['action'].'_nonce');
             $query_args['status']                        = $view['slug'];
             // merge any other arguments sent in.
-            if (isset($extra_query_args[ $view['slug'] ])) {
-                $query_args = array_merge($query_args, $extra_query_args[ $view['slug'] ]);
+            if (isset($extra_query_args[$view['slug']])) {
+                $query_args = array_merge($query_args, $extra_query_args[$view['slug']]);
             }
-            $this->_views[ $key ]['url'] = EE_Admin_Page::add_query_args_and_nonce($query_args, $this->_admin_base_url);
+            $this->_views[$key]['url'] = EE_Admin_Page::add_query_args_and_nonce($query_args, $this->_admin_base_url);
         }
         return $this->_views;
     }
@@ -2071,14 +2071,14 @@ 
 					<select id="entries-per-page-slct" name="entries-per-page-slct">';
         foreach ($values as $value) {
             if ($value < $max_entries) {
-                $selected                  = $value === $per_page ? ' selected="' . $per_page . '"' : '';
+                $selected = $value === $per_page ? ' selected="'.$per_page.'"' : '';
                 $entries_per_page_dropdown .= '
-						<option value="' . $value . '"' . $selected . '>' . $value . '&nbsp;&nbsp;</option>';
+						<option value="' . $value.'"'.$selected.'>'.$value.'&nbsp;&nbsp;</option>';
             }
         }
-        $selected                  = $max_entries === $per_page ? ' selected="' . $per_page . '"' : '';
+        $selected = $max_entries === $per_page ? ' selected="'.$per_page.'"' : '';
         $entries_per_page_dropdown .= '
-						<option value="' . $max_entries . '"' . $selected . '>All&nbsp;&nbsp;</option>';
+						<option value="' . $max_entries.'"'.$selected.'>All&nbsp;&nbsp;</option>';
         $entries_per_page_dropdown .= '
 					</select>
 					entries
@@ -2102,7 +2102,7 @@ 
             empty($this->_search_btn_label) ? $this->page_label
                 : $this->_search_btn_label
         );
-        $this->_template_args['search']['callback']  = 'search_' . $this->page_slug;
+        $this->_template_args['search']['callback'] = 'search_'.$this->page_slug;
     }
 
 
@@ -2190,7 +2190,7 @@ 
             $total_columns                                       = ! empty($screen_columns)
                 ? $screen_columns
                 : $this->_route_config['columns'][1];
-            $this->_template_args['current_screen_widget_class'] = 'columns-' . $total_columns;
+            $this->_template_args['current_screen_widget_class'] = 'columns-'.$total_columns;
             $this->_template_args['current_page']                = $this->_wp_page_slug;
             $this->_template_args['screen']                      = $this->_current_screen;
             $this->_column_template_path                         = EE_ADMIN_TEMPLATE
@@ -2235,7 +2235,7 @@ 
      */
     protected function _espresso_ratings_request()
     {
-        if (! apply_filters('FHEE_show_ratings_request_meta_box', true)) {
+        if ( ! apply_filters('FHEE_show_ratings_request_meta_box', true)) {
             return;
         }
         $ratings_box_title = apply_filters(
@@ -2263,7 +2263,7 @@ 
     public function espresso_ratings_request()
     {
         EEH_Template::display_template(
-            EE_ADMIN_TEMPLATE . 'espresso_ratings_request_content.template.php',
+            EE_ADMIN_TEMPLATE.'espresso_ratings_request_content.template.php',
             []
         );
     }
@@ -2271,22 +2271,22 @@ 
 
     public static function cached_rss_display($rss_id, $url)
     {
-        $loading   = '<p class="widget-loading hide-if-no-js">'
+        $loading = '<p class="widget-loading hide-if-no-js">'
                      . esc_html__('Loading&#8230;', 'event_espresso')
                      . '</p><p class="hide-if-js">'
                      . esc_html__('This widget requires JavaScript.', 'event_espresso')
                      . '</p>';
-        $pre       = '<div class="espresso-rss-display">' . "\n\t";
-        $pre       .= '<span id="' . esc_attr($rss_id) . '_url" class="hidden">' . esc_url_raw($url) . '</span>';
-        $post      = '</div>' . "\n";
-        $cache_key = 'ee_rss_' . md5($rss_id);
+        $pre       = '<div class="espresso-rss-display">'."\n\t";
+        $pre .= '<span id="'.esc_attr($rss_id).'_url" class="hidden">'.esc_url_raw($url).'</span>';
+        $post      = '</div>'."\n";
+        $cache_key = 'ee_rss_'.md5($rss_id);
         $output    = get_transient($cache_key);
         if ($output !== false) {
-            echo wp_kses($pre . $output . $post, AllowedTags::getWithFormTags());
+            echo wp_kses($pre.$output.$post, AllowedTags::getWithFormTags());
             return true;
         }
-        if (! (defined('DOING_AJAX') && DOING_AJAX)) {
-            echo wp_kses($pre . $loading . $post, AllowedTags::getWithFormTags());
+        if ( ! (defined('DOING_AJAX') && DOING_AJAX)) {
+            echo wp_kses($pre.$loading.$post, AllowedTags::getWithFormTags());
             return false;
         }
         ob_start();
@@ -2353,19 +2353,19 @@ 
     public function espresso_sponsors_post_box()
     {
         EEH_Template::display_template(
-            EE_ADMIN_TEMPLATE . 'admin_general_metabox_contents_espresso_sponsors.template.php'
+            EE_ADMIN_TEMPLATE.'admin_general_metabox_contents_espresso_sponsors.template.php'
         );
     }
 
 
     private function _publish_post_box()
     {
-        $meta_box_ref = 'espresso_' . $this->page_slug . '_editor_overview';
+        $meta_box_ref = 'espresso_'.$this->page_slug.'_editor_overview';
         // if there is a array('label' => array('publishbox' => 'some title') ) present in the _page_config array
         // then we'll use that for the metabox label.
         // Otherwise we'll just use publish (publishbox itself could be an array of labels indexed by routes)
-        if (! empty($this->_labels['publishbox'])) {
-            $box_label = is_array($this->_labels['publishbox']) ? $this->_labels['publishbox'][ $this->_req_action ]
+        if ( ! empty($this->_labels['publishbox'])) {
+            $box_label = is_array($this->_labels['publishbox']) ? $this->_labels['publishbox'][$this->_req_action]
                 : $this->_labels['publishbox'];
         } else {
             $box_label = esc_html__('Publish', 'event_espresso');
@@ -2394,7 +2394,7 @@ 
             ? $this->_template_args['publish_box_extra_content']
             : '';
         echo EEH_Template::display_template(
-            EE_ADMIN_TEMPLATE . 'admin_details_publish_metabox.template.php',
+            EE_ADMIN_TEMPLATE.'admin_details_publish_metabox.template.php',
             $this->_template_args,
             true
         );
@@ -2486,18 +2486,18 @@ 
             );
         }
         $this->_template_args['publish_delete_link'] = ! empty($id) ? $delete : '';
-        if (! empty($name) && ! empty($id)) {
-            $hidden_field_arr[ $name ] = [
+        if ( ! empty($name) && ! empty($id)) {
+            $hidden_field_arr[$name] = [
                 'type'  => 'hidden',
                 'value' => $id,
             ];
-            $hf                        = $this->_generate_admin_form_fields($hidden_field_arr, 'array');
+            $hf = $this->_generate_admin_form_fields($hidden_field_arr, 'array');
         } else {
             $hf = '';
         }
         // add hidden field
         $this->_template_args['publish_hidden_fields'] = is_array($hf) && ! empty($name)
-            ? $hf[ $name ]['field']
+            ? $hf[$name]['field']
             : $hf;
     }
 
@@ -2599,7 +2599,7 @@ 
         }
         // if $create_func is true (default) then we automatically create the function for displaying the actual meta box.  If false then we take the $callback reference passed through and use it instead (so callers can define their own callback function/method if they wish)
         $call_back_func = $create_func
-            ? function ($post, $metabox) {
+            ? function($post, $metabox) {
                 do_action('AHEE_log', __FILE__, __FUNCTION__, '');
                 echo EEH_Template::display_template(
                     $metabox['args']['template_path'],
@@ -2609,7 +2609,7 @@ 
             }
             : $callback;
         add_meta_box(
-            str_replace('_', '-', $action) . '-mbox',
+            str_replace('_', '-', $action).'-mbox',
             $title,
             $call_back_func,
             $this->_wp_page_slug,
@@ -2701,9 +2701,9 @@ 
             : 'espresso-default-admin';
         $template_path                                     = $sidebar
             ? EE_ADMIN_TEMPLATE . 'admin_details_wrapper.template.php'
-            : EE_ADMIN_TEMPLATE . 'admin_details_wrapper_no_sidebar.template.php';
+            : EE_ADMIN_TEMPLATE.'admin_details_wrapper_no_sidebar.template.php';
         if ($this->request->isAjax()) {
-            $template_path = EE_ADMIN_TEMPLATE . 'admin_details_wrapper_no_sidebar_ajax.template.php';
+            $template_path = EE_ADMIN_TEMPLATE.'admin_details_wrapper_no_sidebar_ajax.template.php';
         }
         $template_path                                     = ! empty($this->_column_template_path)
             ? $this->_column_template_path : $template_path;
@@ -2743,11 +2743,11 @@ 
     public function display_admin_caf_preview_page($utm_campaign_source = '', $display_sidebar = true)
     {
         // let's generate a default preview action button if there isn't one already present.
-        $this->_labels['buttons']['buy_now']           = esc_html__(
+        $this->_labels['buttons']['buy_now'] = esc_html__(
             'Upgrade to Event Espresso 4 Right Now',
             'event_espresso'
         );
-        $buy_now_url                                   = add_query_arg(
+        $buy_now_url = add_query_arg(
             [
                 'ee_ver'       => 'ee4',
                 'utm_source'   => 'ee4_plugin_admin',
@@ -2767,8 +2767,8 @@ 
                 true
             )
             : $this->_template_args['preview_action_button'];
-        $this->_template_args['admin_page_content']    = EEH_Template::display_template(
-            EE_ADMIN_TEMPLATE . 'admin_caf_full_page_preview.template.php',
+        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
+            EE_ADMIN_TEMPLATE.'admin_caf_full_page_preview.template.php',
             $this->_template_args,
             true
         );
@@ -2817,7 +2817,7 @@ 
         // setup search attributes
         $this->_set_search_attributes();
         $this->_template_args['current_page']     = $this->_wp_page_slug;
-        $template_path                            = EE_ADMIN_TEMPLATE . 'admin_list_wrapper.template.php';
+        $template_path                            = EE_ADMIN_TEMPLATE.'admin_list_wrapper.template.php';
         $this->_template_args['table_url']        = $this->request->isAjax()
             ? add_query_arg(['noheader' => 'true', 'route' => $this->_req_action], $this->_admin_base_url)
             : add_query_arg(['route' => $this->_req_action], $this->_admin_base_url);
@@ -2825,10 +2825,10 @@ 
         $this->_template_args['current_route']    = $this->_req_action;
         $this->_template_args['list_table_class'] = get_class($this->_list_table_object);
         $ajax_sorting_callback                    = $this->_list_table_object->get_ajax_sorting_callback();
-        if (! empty($ajax_sorting_callback)) {
+        if ( ! empty($ajax_sorting_callback)) {
             $sortable_list_table_form_fields = wp_nonce_field(
-                $ajax_sorting_callback . '_nonce',
-                $ajax_sorting_callback . '_nonce',
+                $ajax_sorting_callback.'_nonce',
+                $ajax_sorting_callback.'_nonce',
                 false,
                 false
             );
@@ -2847,18 +2847,18 @@ 
                 ? $this->_template_args['list_table_hidden_fields']
                 : '';
 
-        $nonce_ref          = $this->_req_action . '_nonce';
+        $nonce_ref = $this->_req_action.'_nonce';
         $hidden_form_fields .= '
-            <input type="hidden" name="' . $nonce_ref . '" value="' . wp_create_nonce($nonce_ref) . '">';
+            <input type="hidden" name="' . $nonce_ref.'" value="'.wp_create_nonce($nonce_ref).'">';
 
-        $this->_template_args['list_table_hidden_fields']        = $hidden_form_fields;
+        $this->_template_args['list_table_hidden_fields'] = $hidden_form_fields;
         // display message about search results?
         $search = $this->request->getRequestParam('s');
         $this->_template_args['before_list_table'] .= ! empty($search)
-            ? '<p class="ee-search-results">' . sprintf(
+            ? '<p class="ee-search-results">'.sprintf(
                 esc_html__('Displaying search results for the search string: %1$s', 'event_espresso'),
                 trim($search, '%')
-            ) . '</p>'
+            ).'</p>'
             : '';
         // filter before_list_table template arg
         $this->_template_args['before_list_table'] = apply_filters(
@@ -2892,7 +2892,7 @@ 
         // convert to array and filter again
         // arrays are easier to inject new items in a specific location,
         // but would not be backwards compatible, so we have to add a new filter
-        $this->_template_args['after_list_table']   = implode(
+        $this->_template_args['after_list_table'] = implode(
             " \n",
             (array) apply_filters(
                 'FHEE__EE_Admin_Page___display_admin_list_table_page__after_list_table__template_args_array',
@@ -2939,7 +2939,7 @@ 
             $this
         );
         return EEH_Template::display_template(
-            EE_ADMIN_TEMPLATE . 'admin_details_legend.template.php',
+            EE_ADMIN_TEMPLATE.'admin_details_legend.template.php',
             $this->_template_args,
             true
         );
@@ -3048,18 +3048,18 @@ 
                 : ''
         );
 
-        $this->_template_args['after_admin_page_content']  = apply_filters(
+        $this->_template_args['after_admin_page_content'] = apply_filters(
             "FHEE_after_admin_page_content{$this->_current_page}{$this->_current_view}",
             isset($this->_template_args['after_admin_page_content'])
                 ? $this->_template_args['after_admin_page_content']
                 : ''
         );
-        $this->_template_args['after_admin_page_content']  .= $this->_set_help_popup_content();
+        $this->_template_args['after_admin_page_content'] .= $this->_set_help_popup_content();
 
         if ($this->request->isAjax()) {
             $this->_template_args['admin_page_content'] = EEH_Template::display_template(
                 // $template_path,
-                EE_ADMIN_TEMPLATE . 'admin_wrapper_ajax.template.php',
+                EE_ADMIN_TEMPLATE.'admin_wrapper_ajax.template.php',
                 $this->_template_args,
                 true
             );
@@ -3068,7 +3068,7 @@ 
         // load settings page wrapper template
         $template_path = $about
             ? EE_ADMIN_TEMPLATE . 'about_admin_wrapper.template.php'
-            : EE_ADMIN_TEMPLATE . 'admin_wrapper.template.php';
+            : EE_ADMIN_TEMPLATE.'admin_wrapper.template.php';
 
         EEH_Template::display_template($template_path, $this->_template_args);
     }
@@ -3153,12 +3153,12 @@ 
         $default_names = ['save', 'save_and_close'];
         $buttons = '';
         foreach ($button_text as $key => $button) {
-            $ref     = $default_names[ $key ];
-            $name    = ! empty($actions) ? $actions[ $key ] : $ref;
-            $buttons .= '<input type="submit" class="button-primary ' . $ref . '" '
-                        . 'value="' . $button . '" name="' . $name . '" '
-                        . 'id="' . $this->_current_view . '_' . $ref . '" />';
-            if (! $both) {
+            $ref     = $default_names[$key];
+            $name    = ! empty($actions) ? $actions[$key] : $ref;
+            $buttons .= '<input type="submit" class="button-primary '.$ref.'" '
+                        . 'value="'.$button.'" name="'.$name.'" '
+                        . 'id="'.$this->_current_view.'_'.$ref.'" />';
+            if ( ! $both) {
                 break;
             }
         }
@@ -3198,13 +3198,13 @@ 
                 'An error occurred. No action was set for this page\'s form.',
                 'event_espresso'
             );
-            $dev_msg  = $user_msg . "\n"
+            $dev_msg = $user_msg."\n"
                         . sprintf(
                             esc_html__('The $route argument is required for the %s->%s method.', 'event_espresso'),
                             __FUNCTION__,
                             __CLASS__
                         );
-            EE_Error::add_error($user_msg . '||' . $dev_msg, __FILE__, __FUNCTION__, __LINE__);
+            EE_Error::add_error($user_msg.'||'.$dev_msg, __FILE__, __FUNCTION__, __LINE__);
         }
         // open form
         $this->_template_args['before_admin_page_content'] = '<form name="form" method="post" action="'
@@ -3213,9 +3213,9 @@ 
                                                              . $route
                                                              . '_event_form" >';
         // add nonce
-        $nonce                                             =
-            wp_nonce_field($route . '_nonce', $route . '_nonce', false, false);
-        $this->_template_args['before_admin_page_content'] .= "\n\t" . $nonce;
+        $nonce =
+            wp_nonce_field($route.'_nonce', $route.'_nonce', false, false);
+        $this->_template_args['before_admin_page_content'] .= "\n\t".$nonce;
         // add REQUIRED form action
         $hidden_fields = [
             'action' => ['type' => 'hidden', 'value' => $route],
@@ -3228,7 +3228,7 @@ 
         $form_fields = $this->_generate_admin_form_fields($hidden_fields, 'array');
         // add fields to form
         foreach ((array) $form_fields as $form_field) {
-            $this->_template_args['before_admin_page_content'] .= "\n\t" . $form_field['field'];
+            $this->_template_args['before_admin_page_content'] .= "\n\t".$form_field['field'];
         }
         // close form
         $this->_template_args['after_admin_page_content'] = '</form>';
@@ -3319,10 +3319,10 @@ 
         $redirect_url = isset($query_args['page']) ? admin_url('admin.php') : $this->_admin_base_url;
         $notices      = EE_Error::get_notices(false);
         // overwrite default success messages //BUT ONLY if overwrite not overridden
-        if (! $override_overwrite || ! empty($notices['errors'])) {
+        if ( ! $override_overwrite || ! empty($notices['errors'])) {
             EE_Error::overwrite_success();
         }
-        if (! empty($what) && ! empty($action_desc) && empty($notices['errors'])) {
+        if ( ! empty($what) && ! empty($action_desc) && empty($notices['errors'])) {
             // how many records affected ? more than one record ? or just one ?
             if ($success > 1) {
                 // set plural msg
@@ -3351,7 +3351,7 @@ 
             }
         }
         // check that $query_args isn't something crazy
-        if (! is_array($query_args)) {
+        if ( ! is_array($query_args)) {
             $query_args = [];
         }
         /**
@@ -3380,7 +3380,7 @@ 
             $redirect_url = admin_url('admin.php');
         }
         // merge any default query_args set in _default_route_query_args property
-        if (! empty($this->_default_route_query_args) && ! $this->_is_UI_request) {
+        if ( ! empty($this->_default_route_query_args) && ! $this->_is_UI_request) {
             $args_to_merge = [];
             foreach ($this->_default_route_query_args as $query_param => $query_value) {
                 // is there a wp_referer array in our _default_route_query_args property?
@@ -3392,15 +3392,15 @@ 
                         }
                         // finally we will override any arguments in the referer with
                         // what might be set on the _default_route_query_args array.
-                        if (isset($this->_default_route_query_args[ $reference ])) {
-                            $args_to_merge[ $reference ] = urlencode($this->_default_route_query_args[ $reference ]);
+                        if (isset($this->_default_route_query_args[$reference])) {
+                            $args_to_merge[$reference] = urlencode($this->_default_route_query_args[$reference]);
                         } else {
-                            $args_to_merge[ $reference ] = urlencode($value);
+                            $args_to_merge[$reference] = urlencode($value);
                         }
                     }
                     continue;
                 }
-                $args_to_merge[ $query_param ] = $query_value;
+                $args_to_merge[$query_param] = $query_value;
             }
             // now let's merge these arguments but override with what was specifically sent in to the
             // redirect.
@@ -3412,19 +3412,19 @@ 
         if (isset($query_args['action'])) {
             // manually generate wp_nonce and merge that with the query vars
             // becuz the wp_nonce_url function wrecks havoc on some vars
-            $query_args['_wpnonce'] = wp_create_nonce($query_args['action'] . '_nonce');
+            $query_args['_wpnonce'] = wp_create_nonce($query_args['action'].'_nonce');
         }
         // we're adding some hooks and filters in here for processing any things just before redirects
         // (example: an admin page has done an insert or update and we want to run something after that).
-        do_action('AHEE_redirect_' . $classname . $this->_req_action, $query_args);
+        do_action('AHEE_redirect_'.$classname.$this->_req_action, $query_args);
         $redirect_url = apply_filters(
-            'FHEE_redirect_' . $classname . $this->_req_action,
+            'FHEE_redirect_'.$classname.$this->_req_action,
             self::add_query_args_and_nonce($query_args, $redirect_url),
             $query_args
         );
         // check if we're doing ajax.  If we are then lets just return the results and js can handle how it wants.
         if ($this->request->isAjax()) {
-            $default_data                    = [
+            $default_data = [
                 'close'        => true,
                 'redirect_url' => $redirect_url,
                 'where'        => 'main',
@@ -3471,7 +3471,7 @@ 
         }
         $this->_template_args['notices'] = EE_Error::get_notices();
         // IF this isn't ajax we need to create a transient for the notices using the route (however, overridden if $sticky_notices == true)
-        if (! $this->request->isAjax() || $sticky_notices) {
+        if ( ! $this->request->isAjax() || $sticky_notices) {
             $route = isset($query_args['action']) ? $query_args['action'] : 'default';
             $this->_add_transient(
                 $route,
@@ -3511,7 +3511,7 @@ 
         $exclude_nonce = false
     ) {
         // first let's validate the action (if $base_url is FALSE otherwise validation will happen further along)
-        if (empty($base_url) && ! isset($this->_page_routes[ $action ])) {
+        if (empty($base_url) && ! isset($this->_page_routes[$action])) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -3522,7 +3522,7 @@ 
                 )
             );
         }
-        if (! isset($this->_labels['buttons'][ $type ])) {
+        if ( ! isset($this->_labels['buttons'][$type])) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -3535,7 +3535,7 @@ 
         }
         // finally check user access for this button.
         $has_access = $this->check_user_access($action, true);
-        if (! $has_access) {
+        if ( ! $has_access) {
             return '';
         }
         $_base_url  = ! $base_url ? $this->_admin_base_url : $base_url;
@@ -3543,11 +3543,11 @@ 
             'action' => $action,
         ];
         // merge extra_request args but make sure our original action takes precedence and doesn't get overwritten.
-        if (! empty($extra_request)) {
+        if ( ! empty($extra_request)) {
             $query_args = array_merge($extra_request, $query_args);
         }
         $url = self::add_query_args_and_nonce($query_args, $_base_url, false, $exclude_nonce);
-        return EEH_Template::get_button_or_link($url, $this->_labels['buttons'][ $type ], $class);
+        return EEH_Template::get_button_or_link($url, $this->_labels['buttons'][$type], $class);
     }
 
 
@@ -3573,7 +3573,7 @@ 
                 'FHEE__EE_Admin_Page___per_page_screen_options__default',
                 20
             ),
-            'option'  => $this->_current_page . '_' . $this->_current_view . '_per_page',
+            'option'  => $this->_current_page.'_'.$this->_current_view.'_per_page',
         ];
         // ONLY add the screen option if the user has access to it.
         if ($this->check_user_access($this->_current_view, true)) {
@@ -3594,18 +3594,18 @@ 
     {
         if ($this->request->requestParamIsSet('wp_screen_options')) {
             check_admin_referer('screen-options-nonce', 'screenoptionnonce');
-            if (! $user = wp_get_current_user()) {
+            if ( ! $user = wp_get_current_user()) {
                 return;
             }
             $option = $this->request->getRequestParam('wp_screen_options[option]', '', 'key');
-            if (! $option) {
+            if ( ! $option) {
                 return;
             }
-            $value  = $this->request->getRequestParam('wp_screen_options[value]', 0, 'int');
+            $value = $this->request->getRequestParam('wp_screen_options[value]', 0, 'int');
             $map_option = $option;
             $option     = str_replace('-', '_', $option);
             switch ($map_option) {
-                case $this->_current_page . '_' . $this->_current_view . '_per_page':
+                case $this->_current_page.'_'.$this->_current_view.'_per_page':
                     $max_value = apply_filters(
                         'FHEE__EE_Admin_Page___set_per_page_screen_options__max_value',
                         999,
@@ -3662,13 +3662,13 @@ 
     protected function _add_transient($route, $data, $notices = false, $skip_route_verify = false)
     {
         $user_id = get_current_user_id();
-        if (! $skip_route_verify) {
+        if ( ! $skip_route_verify) {
             $this->_verify_route($route);
         }
         // now let's set the string for what kind of transient we're setting
         $transient = $notices
-            ? 'ee_rte_n_tx_' . $route . '_' . $user_id
-            : 'rte_tx_' . $route . '_' . $user_id;
+            ? 'ee_rte_n_tx_'.$route.'_'.$user_id
+            : 'rte_tx_'.$route.'_'.$user_id;
         $data      = $notices ? ['notices' => $data] : $data;
         // is there already a transient for this route?  If there is then let's ADD to that transient
         $existing = is_multisite() && is_network_admin()
@@ -3697,8 +3697,8 @@ 
         $user_id   = get_current_user_id();
         $route     = ! $route ? $this->_req_action : $route;
         $transient = $notices
-            ? 'ee_rte_n_tx_' . $route . '_' . $user_id
-            : 'rte_tx_' . $route . '_' . $user_id;
+            ? 'ee_rte_n_tx_'.$route.'_'.$user_id
+            : 'rte_tx_'.$route.'_'.$user_id;
         $data      = is_multisite() && is_network_admin()
             ? get_site_transient($transient)
             : get_transient($transient);
@@ -3929,7 +3929,7 @@ 
      */
     protected function _next_link($url, $class = 'dashicons dashicons-arrow-right')
     {
-        return '<a class="' . $class . '" href="' . $url . '"></a>';
+        return '<a class="'.$class.'" href="'.$url.'"></a>';
     }
 
 
@@ -3942,7 +3942,7 @@ 
      */
     protected function _previous_link($url, $class = 'dashicons dashicons-arrow-left')
     {
-        return '<a class="' . $class . '" href="' . $url . '"></a>';
+        return '<a class="'.$class.'" href="'.$url.'"></a>';
     }
 
 
@@ -4090,13 +4090,13 @@ 
         callable $callback = null
     ) {
         $entity_ID = absint($entity_ID);
-        if (! $entity_ID) {
+        if ( ! $entity_ID) {
             $this->trashRestoreDeleteError($action, $entity_model);
         }
         $result = 0;
         try {
             $entity = $entity_model->get_one_by_ID($entity_ID);
-            if (! $entity instanceof EE_Base_Class) {
+            if ( ! $entity instanceof EE_Base_Class) {
                 throw new DomainException(
                     sprintf(
                         esc_html__(
@@ -4147,7 +4147,7 @@ 
                 )
             );
         }
-        if (! $entity_model->has_field($delete_column)) {
+        if ( ! $entity_model->has_field($delete_column)) {
             throw new DomainException(
                 sprintf(
                     esc_html__(

core/EE_Deprecated.core.php

Indentation +1222 added lines, -1222 removed lines

@@ -39,31 +39,31 @@ 
  * @param string $action_or_filter
  */
 function deprecated_espresso_action_or_filter_doing_it_wrong(
-    $deprecated_filter,
-    $replacement,
-    $replacement_location,
-    $version_deprecated,
-    $version_applies,
-    $action_or_filter = 'action'
+	$deprecated_filter,
+	$replacement,
+	$replacement_location,
+	$version_deprecated,
+	$version_applies,
+	$action_or_filter = 'action'
 ) {
-    $action_or_filter = $action_or_filter === 'action'
-        ? esc_html__('action', 'event_espresso')
-        : esc_html__('filter', 'event_espresso');
-    EE_Error::doing_it_wrong(
-        $deprecated_filter,
-        sprintf(
-            esc_html__(
-                'This %1$s is deprecated.  It *may* work as an attempt to build in backwards compatibility.  However, it is recommended to use the following new %1$s: %4$s"%2$s" found in "%3$s"',
-                'event_espresso'
-            ),
-            $action_or_filter,
-            $replacement,
-            $replacement_location,
-            '<br />'
-        ),
-        $version_deprecated,
-        $version_applies
-    );
+	$action_or_filter = $action_or_filter === 'action'
+		? esc_html__('action', 'event_espresso')
+		: esc_html__('filter', 'event_espresso');
+	EE_Error::doing_it_wrong(
+		$deprecated_filter,
+		sprintf(
+			esc_html__(
+				'This %1$s is deprecated.  It *may* work as an attempt to build in backwards compatibility.  However, it is recommended to use the following new %1$s: %4$s"%2$s" found in "%3$s"',
+				'event_espresso'
+			),
+			$action_or_filter,
+			$replacement,
+			$replacement_location,
+			'<br />'
+		),
+		$version_deprecated,
+		$version_applies
+	);
 }
 
 /**
@@ -75,90 +75,90 @@ 
  */
 function ee_deprecated__registration_checkout__button_text($submit_button_text, EE_Checkout $checkout)
 {
-    // list of old filters
-    $deprecated_filters = array(
-        'update_registration_details' => true,
-        'process_payment'             => true,
-        'finalize_registration'       => true,
-        'and_proceed_to_payment'      => true,
-        'proceed_to'                  => true,
-    );
-    // loop thru and call doing_it_wrong() or remove any that aren't being used
-    foreach ($deprecated_filters as $deprecated_filter => $on) {
-        // was this filter called ?
-        if (has_action('FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__' . $deprecated_filter)) {
-            // only display doing_it_wrong() notice to Event Admins during non-AJAX requests
-            if (EE_Registry::instance()->CAP->current_user_can(
-                    'ee_read_ee',
-                    'hide_doing_it_wrong_for_deprecated_SPCO_filter'
-                ) && ! defined('DOING_AJAX')) {
-                EE_Error::doing_it_wrong(
-                    'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__' . $deprecated_filter,
-                    sprintf(
-                        esc_html__(
-                            'The %1$s filter is deprecated.  It *may* work as an attempt to build in backwards compatibility.  However, it is recommended to use the following new filter: %2$s"%3$s" found in "%4$s"',
-                            'event_espresso'
-                        ),
-                        'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__' . $deprecated_filter,
-                        '<br />',
-                        'FHEE__EE_SPCO_Reg_Step__set_submit_button_text___submit_button_text',
-                        '/modules/single_page_checkout/inc/EE_SPCO_Reg_Step.class.php'
-                    ),
-                    '4.6.10'
-                );
-            }
-        } else {
-            unset($deprecated_filters[ $deprecated_filter ]);
-        }
-    }
-    if (! empty($deprecated_filters)) {
-
-        if ($checkout->current_step->slug(
-            ) == 'attendee_information' && $checkout->revisit && isset($deprecated_filters['update_registration_details'])) {
-            $submit_button_text = apply_filters(
-                'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__update_registration_details',
-                $submit_button_text
-            );
-        } elseif ($checkout->current_step->slug(
-            ) == 'payment_options' && $checkout->revisit && isset($deprecated_filters['process_payment'])) {
-            $submit_button_text = apply_filters(
-                'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__process_payment',
-                $submit_button_text
-            );
-        } elseif ($checkout->next_step instanceof EE_SPCO_Reg_Step && $checkout->next_step->slug(
-            ) == 'finalize_registration' && isset($deprecated_filters['finalize_registration'])) {
-            $submit_button_text = apply_filters(
-                'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__finalize_registration',
-                $submit_button_text
-            );
-        }
-        if ($checkout->next_step instanceof EE_SPCO_Reg_Step) {
-            if ($checkout->payment_required() && $checkout->next_step->slug(
-                ) == 'payment_options' && isset($deprecated_filters['and_proceed_to_payment'])) {
-                $submit_button_text .= apply_filters(
-                    'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__and_proceed_to_payment',
-                    $submit_button_text
-                );
-            }
-            if ($checkout->next_step->slug(
-                ) != 'finalize_registration' && ! $checkout->revisit && isset($deprecated_filters['proceed_to'])) {
-                $submit_button_text = apply_filters(
-                                          'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__proceed_to',
-                                          $submit_button_text
-                                      ) . $checkout->next_step->name();
-            }
-        }
-
-    }
-    return $submit_button_text;
+	// list of old filters
+	$deprecated_filters = array(
+		'update_registration_details' => true,
+		'process_payment'             => true,
+		'finalize_registration'       => true,
+		'and_proceed_to_payment'      => true,
+		'proceed_to'                  => true,
+	);
+	// loop thru and call doing_it_wrong() or remove any that aren't being used
+	foreach ($deprecated_filters as $deprecated_filter => $on) {
+		// was this filter called ?
+		if (has_action('FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__' . $deprecated_filter)) {
+			// only display doing_it_wrong() notice to Event Admins during non-AJAX requests
+			if (EE_Registry::instance()->CAP->current_user_can(
+					'ee_read_ee',
+					'hide_doing_it_wrong_for_deprecated_SPCO_filter'
+				) && ! defined('DOING_AJAX')) {
+				EE_Error::doing_it_wrong(
+					'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__' . $deprecated_filter,
+					sprintf(
+						esc_html__(
+							'The %1$s filter is deprecated.  It *may* work as an attempt to build in backwards compatibility.  However, it is recommended to use the following new filter: %2$s"%3$s" found in "%4$s"',
+							'event_espresso'
+						),
+						'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__' . $deprecated_filter,
+						'<br />',
+						'FHEE__EE_SPCO_Reg_Step__set_submit_button_text___submit_button_text',
+						'/modules/single_page_checkout/inc/EE_SPCO_Reg_Step.class.php'
+					),
+					'4.6.10'
+				);
+			}
+		} else {
+			unset($deprecated_filters[ $deprecated_filter ]);
+		}
+	}
+	if (! empty($deprecated_filters)) {
+
+		if ($checkout->current_step->slug(
+			) == 'attendee_information' && $checkout->revisit && isset($deprecated_filters['update_registration_details'])) {
+			$submit_button_text = apply_filters(
+				'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__update_registration_details',
+				$submit_button_text
+			);
+		} elseif ($checkout->current_step->slug(
+			) == 'payment_options' && $checkout->revisit && isset($deprecated_filters['process_payment'])) {
+			$submit_button_text = apply_filters(
+				'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__process_payment',
+				$submit_button_text
+			);
+		} elseif ($checkout->next_step instanceof EE_SPCO_Reg_Step && $checkout->next_step->slug(
+			) == 'finalize_registration' && isset($deprecated_filters['finalize_registration'])) {
+			$submit_button_text = apply_filters(
+				'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__finalize_registration',
+				$submit_button_text
+			);
+		}
+		if ($checkout->next_step instanceof EE_SPCO_Reg_Step) {
+			if ($checkout->payment_required() && $checkout->next_step->slug(
+				) == 'payment_options' && isset($deprecated_filters['and_proceed_to_payment'])) {
+				$submit_button_text .= apply_filters(
+					'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__and_proceed_to_payment',
+					$submit_button_text
+				);
+			}
+			if ($checkout->next_step->slug(
+				) != 'finalize_registration' && ! $checkout->revisit && isset($deprecated_filters['proceed_to'])) {
+				$submit_button_text = apply_filters(
+										  'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__proceed_to',
+										  $submit_button_text
+									  ) . $checkout->next_step->name();
+			}
+		}
+
+	}
+	return $submit_button_text;
 
 }
 
 add_filter(
-    'FHEE__EE_SPCO_Reg_Step__set_submit_button_text___submit_button_text',
-    'ee_deprecated__registration_checkout__button_text',
-    10,
-    2
+	'FHEE__EE_SPCO_Reg_Step__set_submit_button_text___submit_button_text',
+	'ee_deprecated__registration_checkout__button_text',
+	10,
+	2
 );
 
 
@@ -170,54 +170,54 @@ 
  */
 function ee_deprecated_finalize_transaction(EE_Checkout $checkout, $status_updates)
 {
-    $action_ref = null;
-    $action_ref = has_action('AHEE__EE_Transaction__finalize__new_transaction')
-        ? 'AHEE__EE_Transaction__finalize__new_transaction' : $action_ref;
-    $action_ref = has_action('AHEE__EE_Transaction__finalize__all_transaction')
-        ? 'AHEE__EE_Transaction__finalize__all_transaction' : $action_ref;
-    if ($action_ref) {
-
-        EE_Error::doing_it_wrong(
-            $action_ref,
-            sprintf(
-                esc_html__(
-                    'This action is deprecated.  It *may* work as an attempt to build in backwards compatibility.  However, it is recommended to use one of the following new actions: %1$s"%3$s" found in "%2$s" %1$s"%4$s" found in "%2$s" %1$s"%5$s" found in "%2$s" %1$s"%6$s" found in "%2$s"',
-                    'event_espresso'
-                ),
-                '<br />',
-                '/core/business/EE_Transaction_Processor.class.php',
-                'AHEE__EE_Transaction_Processor__finalize',
-                'AHEE__EE_Transaction_Processor__manually_update_registration_statuses',
-                'AHEE__EE_Transaction_Processor__toggle_registration_statuses_for_default_approved_events',
-                'AHEE__EE_Transaction_Processor__toggle_registration_statuses_if_no_monies_owing'
-            ),
-            '4.6.0'
-        );
-        switch ($action_ref) {
-            case 'AHEE__EE_Transaction__finalize__new_transaction' :
-                do_action(
-                    'AHEE__EE_Transaction__finalize__new_transaction',
-                    $checkout->transaction,
-                    $checkout->admin_request
-                );
-                break;
-            case 'AHEE__EE_Transaction__finalize__all_transaction' :
-                do_action(
-                    'AHEE__EE_Transaction__finalize__new_transaction',
-                    $checkout->transaction,
-                    array('new_reg' => ! $checkout->revisit, 'to_approved' => $status_updates),
-                    $checkout->admin_request
-                );
-                break;
-        }
-    }
+	$action_ref = null;
+	$action_ref = has_action('AHEE__EE_Transaction__finalize__new_transaction')
+		? 'AHEE__EE_Transaction__finalize__new_transaction' : $action_ref;
+	$action_ref = has_action('AHEE__EE_Transaction__finalize__all_transaction')
+		? 'AHEE__EE_Transaction__finalize__all_transaction' : $action_ref;
+	if ($action_ref) {
+
+		EE_Error::doing_it_wrong(
+			$action_ref,
+			sprintf(
+				esc_html__(
+					'This action is deprecated.  It *may* work as an attempt to build in backwards compatibility.  However, it is recommended to use one of the following new actions: %1$s"%3$s" found in "%2$s" %1$s"%4$s" found in "%2$s" %1$s"%5$s" found in "%2$s" %1$s"%6$s" found in "%2$s"',
+					'event_espresso'
+				),
+				'<br />',
+				'/core/business/EE_Transaction_Processor.class.php',
+				'AHEE__EE_Transaction_Processor__finalize',
+				'AHEE__EE_Transaction_Processor__manually_update_registration_statuses',
+				'AHEE__EE_Transaction_Processor__toggle_registration_statuses_for_default_approved_events',
+				'AHEE__EE_Transaction_Processor__toggle_registration_statuses_if_no_monies_owing'
+			),
+			'4.6.0'
+		);
+		switch ($action_ref) {
+			case 'AHEE__EE_Transaction__finalize__new_transaction' :
+				do_action(
+					'AHEE__EE_Transaction__finalize__new_transaction',
+					$checkout->transaction,
+					$checkout->admin_request
+				);
+				break;
+			case 'AHEE__EE_Transaction__finalize__all_transaction' :
+				do_action(
+					'AHEE__EE_Transaction__finalize__new_transaction',
+					$checkout->transaction,
+					array('new_reg' => ! $checkout->revisit, 'to_approved' => $status_updates),
+					$checkout->admin_request
+				);
+				break;
+		}
+	}
 }
 
 add_action(
-    'AHEE__EE_SPCO_Reg_Step_Finalize_Registration__process_reg_step__completed',
-    'ee_deprecated_finalize_transaction',
-    10,
-    2
+	'AHEE__EE_SPCO_Reg_Step_Finalize_Registration__process_reg_step__completed',
+	'ee_deprecated_finalize_transaction',
+	10,
+	2
 );
 /**
  * ee_deprecated_finalize_registration
@@ -226,35 +226,35 @@ 
  */
 function ee_deprecated_finalize_registration(EE_Registration $registration)
 {
-    $action_ref = has_action('AHEE__EE_Registration__finalize__update_and_new_reg')
-        ? 'AHEE__EE_Registration__finalize__update_and_new_reg' : null;
-    if ($action_ref) {
-        EE_Error::doing_it_wrong(
-            $action_ref,
-            sprintf(
-                esc_html__(
-                    'This action is deprecated.  It *may* work as an attempt to build in backwards compatibility.  However, it is recommended to use the following new action: %1$s"%3$s" found in "%2$s"',
-                    'event_espresso'
-                ),
-                '<br />',
-                '/core/business/EE_Registration_Processor.class.php',
-                'AHEE__EE_Registration_Processor__trigger_registration_update_notifications'
-            ),
-            '4.6.0'
-        );
-        do_action(
-            'AHEE__EE_Registration__finalize__update_and_new_reg',
-            $registration,
-            (is_admin() && ! (defined('DOING_AJAX') && DOING_AJAX))
-        );
-    }
+	$action_ref = has_action('AHEE__EE_Registration__finalize__update_and_new_reg')
+		? 'AHEE__EE_Registration__finalize__update_and_new_reg' : null;
+	if ($action_ref) {
+		EE_Error::doing_it_wrong(
+			$action_ref,
+			sprintf(
+				esc_html__(
+					'This action is deprecated.  It *may* work as an attempt to build in backwards compatibility.  However, it is recommended to use the following new action: %1$s"%3$s" found in "%2$s"',
+					'event_espresso'
+				),
+				'<br />',
+				'/core/business/EE_Registration_Processor.class.php',
+				'AHEE__EE_Registration_Processor__trigger_registration_update_notifications'
+			),
+			'4.6.0'
+		);
+		do_action(
+			'AHEE__EE_Registration__finalize__update_and_new_reg',
+			$registration,
+			(is_admin() && ! (defined('DOING_AJAX') && DOING_AJAX))
+		);
+	}
 }
 
 add_action(
-    'AHEE__EE_Registration_Processor__trigger_registration_update_notifications',
-    'ee_deprecated_finalize_registration',
-    10,
-    1
+	'AHEE__EE_Registration_Processor__trigger_registration_update_notifications',
+	'ee_deprecated_finalize_registration',
+	10,
+	1
 );
 
 
@@ -264,44 +264,44 @@ 
  */
 function ee_deprecated_hooks()
 {
-    /**
-     * @var          $hooks       array where keys are hook names, and their values are array{
-     * @type string  $version     when deprecated
-     * @type string  $alternative saying what to use instead
-     * @type boolean $still_works whether or not the hook still works
-     *        }
-     */
-    $hooks = array(
-        'AHEE__EE_System___do_setup_validations' => array(
-            'version'     => '4.6.0',
-            'alternative' => esc_html__(
-                'Instead use "AHEE__EEH_Activation__validate_messages_system" which is called after validating messages (done on every new install, upgrade, reactivation, and downgrade)',
-                'event_espresso'
-            ),
-            'still_works' => false,
-        ),
-    );
-    foreach ($hooks as $name => $deprecation_info) {
-        if (has_action($name)) {
-            EE_Error::doing_it_wrong(
-                $name,
-                sprintf(
-                    esc_html__('This filter is deprecated. %1$s%2$s', 'event_espresso'),
-                    $deprecation_info['still_works'] ? esc_html__(
-                        'It *may* work as an attempt to build in backwards compatibility.',
-                        'event_espresso'
-                    ) : esc_html__('It has been completely removed.', 'event_espresso'),
-                    isset($deprecation_info['alternative'])
-                        ? $deprecation_info['alternative']
-                        : esc_html__(
-                        'Please read the current EE4 documentation further or contact Support.',
-                        'event_espresso'
-                    )
-                ),
-                isset($deprecation_info['version']) ? $deprecation_info['version'] : esc_html__('recently', 'event_espresso')
-            );
-        }
-    }
+	/**
+	 * @var          $hooks       array where keys are hook names, and their values are array{
+	 * @type string  $version     when deprecated
+	 * @type string  $alternative saying what to use instead
+	 * @type boolean $still_works whether or not the hook still works
+	 *        }
+	 */
+	$hooks = array(
+		'AHEE__EE_System___do_setup_validations' => array(
+			'version'     => '4.6.0',
+			'alternative' => esc_html__(
+				'Instead use "AHEE__EEH_Activation__validate_messages_system" which is called after validating messages (done on every new install, upgrade, reactivation, and downgrade)',
+				'event_espresso'
+			),
+			'still_works' => false,
+		),
+	);
+	foreach ($hooks as $name => $deprecation_info) {
+		if (has_action($name)) {
+			EE_Error::doing_it_wrong(
+				$name,
+				sprintf(
+					esc_html__('This filter is deprecated. %1$s%2$s', 'event_espresso'),
+					$deprecation_info['still_works'] ? esc_html__(
+						'It *may* work as an attempt to build in backwards compatibility.',
+						'event_espresso'
+					) : esc_html__('It has been completely removed.', 'event_espresso'),
+					isset($deprecation_info['alternative'])
+						? $deprecation_info['alternative']
+						: esc_html__(
+						'Please read the current EE4 documentation further or contact Support.',
+						'event_espresso'
+					)
+				),
+				isset($deprecation_info['version']) ? $deprecation_info['version'] : esc_html__('recently', 'event_espresso')
+			);
+		}
+	}
 }
 
 add_action('AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons', 'ee_deprecated_hooks');
@@ -316,34 +316,34 @@ 
  */
 function ee_deprecated_using_old_registration_admin_custom_questions_form_hooks()
 {
-    $in_use = has_filter('FHEE__Registrations_Admin_Page___update_attendee_registration_form__qstns')
-              || has_action(
-                  'AHEE__Registrations_Admin_Page___save_attendee_registration_form__after_reg_and_attendee_save'
-              );
-    if ($in_use) {
-        $msg = esc_html__(
-            'We detected you are using the filter FHEE__Registrations_Admin_Page___update_attendee_registration_form__qstns or AHEE__Registrations_Admin_Page___save_attendee_registration_form__after_reg_and_attendee_save.'
-            . 'Both of these have been deprecated and should not be used anymore. You should instead use FHEE__EE_Form_Section_Proper___construct__options_array to customize the contents of the form,'
-            . 'use FHEE__EE_Form_Section_Proper__receive_form_submission__req_data to customize the submission data, or AHEE__EE_Form_Section_Proper__receive_form_submission__end '
-            . 'to add other actions after a form submission has been received.',
-            'event_espresso'
-        );
-        EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
-            $msg,
-            '4.8.32.rc.000'
-        );
-        // it seems the doing_it_wrong messages get output during some hidden html tags, so add an error to make sure this gets noticed
-        if (is_admin() && ! defined('DOING_AJAX')) {
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-        }
-    }
-    return $in_use;
+	$in_use = has_filter('FHEE__Registrations_Admin_Page___update_attendee_registration_form__qstns')
+			  || has_action(
+				  'AHEE__Registrations_Admin_Page___save_attendee_registration_form__after_reg_and_attendee_save'
+			  );
+	if ($in_use) {
+		$msg = esc_html__(
+			'We detected you are using the filter FHEE__Registrations_Admin_Page___update_attendee_registration_form__qstns or AHEE__Registrations_Admin_Page___save_attendee_registration_form__after_reg_and_attendee_save.'
+			. 'Both of these have been deprecated and should not be used anymore. You should instead use FHEE__EE_Form_Section_Proper___construct__options_array to customize the contents of the form,'
+			. 'use FHEE__EE_Form_Section_Proper__receive_form_submission__req_data to customize the submission data, or AHEE__EE_Form_Section_Proper__receive_form_submission__end '
+			. 'to add other actions after a form submission has been received.',
+			'event_espresso'
+		);
+		EE_Error::doing_it_wrong(
+			__CLASS__ . '::' . __FUNCTION__,
+			$msg,
+			'4.8.32.rc.000'
+		);
+		// it seems the doing_it_wrong messages get output during some hidden html tags, so add an error to make sure this gets noticed
+		if (is_admin() && ! defined('DOING_AJAX')) {
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+		}
+	}
+	return $in_use;
 }
 
 add_action(
-    'AHEE__Registrations_Admin_Page___registration_details_metabox__start',
-    'ee_deprecated_using_old_registration_admin_custom_questions_form_hooks'
+	'AHEE__Registrations_Admin_Page___registration_details_metabox__start',
+	'ee_deprecated_using_old_registration_admin_custom_questions_form_hooks'
 );
 
 /**
@@ -355,82 +355,82 @@ 
  */
 function ee_deprecated_update_attendee_registration_form_old($admin_page)
 {
-    // check if the old hooks are in use. If not, do the default
-    if (! ee_deprecated_using_old_registration_admin_custom_questions_form_hooks()
-        || ! $admin_page instanceof EE_Admin_Page) {
-        return;
-    }
-    $req_data = $admin_page->get_request_data();
-    $qstns = isset($req_data['qstn']) ? $req_data['qstn'] : false;
-    $REG_ID = isset($req_data['_REG_ID']) ? absint($req_data['_REG_ID']) : false;
-    $qstns = apply_filters('FHEE__Registrations_Admin_Page___update_attendee_registration_form__qstns', $qstns);
-    if (! $REG_ID || ! $qstns) {
-        EE_Error::add_error(
-            esc_html__('An error occurred. No registration ID and/or registration questions were received.', 'event_espresso'),
-            __FILE__,
-            __FUNCTION__,
-            __LINE__
-        );
-    }
-    $success = true;
-
-    // allow others to get in on this awesome fun   :D
-    do_action(
-        'AHEE__Registrations_Admin_Page___save_attendee_registration_form__after_reg_and_attendee_save',
-        $REG_ID,
-        $qstns
-    );
-    // loop thru questions... FINALLY!!!
-
-    foreach ($qstns as $QST_ID => $qstn) {
-        // if $qstn isn't an array then it doesn't already have an answer, so let's create the answer
-        if (! is_array($qstn)) {
-            $set_values = [
-                'QST_ID'    => $QST_ID,
-                'REG_ID'    => $REG_ID,
-                'ANS_value' => $qstn,
-            ];
-            $success    = EEM_Answer::instance()->insert($set_values);
-            continue;
-        }
-
-
-        foreach ($qstn as $ANS_ID => $ANS_value) {
-            // get answer
-            $query_params = array(
-                0 => array(
-                    'ANS_ID' => $ANS_ID,
-                    'REG_ID' => $REG_ID,
-                    'QST_ID' => $QST_ID,
-                ),
-            );
-            $answer = EEM_Answer::instance()->get_one($query_params);
-            // this MAY be an array but NOT have an answer because its multi select.  If so then we need to create the answer
-            if (! $answer instanceof EE_Answer) {
-                $set_values = array(
-                    'QST_ID'    => $QST_ID,
-                    'REG_ID'    => $REG_ID,
-                    'ANS_value' => $qstn,
-                );
-                $success = EEM_Answer::instance()->insert($set_values);
-                continue 2;
-            }
-
-            $answer->set('ANS_value', $ANS_value);
-            $success = $answer->save();
-        }
-    }
-    $what = esc_html__('Registration Form', 'event_espresso');
-    $route = $REG_ID ? array('action' => 'view_registration', '_REG_ID' => $REG_ID) : array('action' => 'default');
-    $admin_page->redirect_after_action($success, $what, esc_html__('updated', 'event_espresso'), $route);
-    exit;
+	// check if the old hooks are in use. If not, do the default
+	if (! ee_deprecated_using_old_registration_admin_custom_questions_form_hooks()
+		|| ! $admin_page instanceof EE_Admin_Page) {
+		return;
+	}
+	$req_data = $admin_page->get_request_data();
+	$qstns = isset($req_data['qstn']) ? $req_data['qstn'] : false;
+	$REG_ID = isset($req_data['_REG_ID']) ? absint($req_data['_REG_ID']) : false;
+	$qstns = apply_filters('FHEE__Registrations_Admin_Page___update_attendee_registration_form__qstns', $qstns);
+	if (! $REG_ID || ! $qstns) {
+		EE_Error::add_error(
+			esc_html__('An error occurred. No registration ID and/or registration questions were received.', 'event_espresso'),
+			__FILE__,
+			__FUNCTION__,
+			__LINE__
+		);
+	}
+	$success = true;
+
+	// allow others to get in on this awesome fun   :D
+	do_action(
+		'AHEE__Registrations_Admin_Page___save_attendee_registration_form__after_reg_and_attendee_save',
+		$REG_ID,
+		$qstns
+	);
+	// loop thru questions... FINALLY!!!
+
+	foreach ($qstns as $QST_ID => $qstn) {
+		// if $qstn isn't an array then it doesn't already have an answer, so let's create the answer
+		if (! is_array($qstn)) {
+			$set_values = [
+				'QST_ID'    => $QST_ID,
+				'REG_ID'    => $REG_ID,
+				'ANS_value' => $qstn,
+			];
+			$success    = EEM_Answer::instance()->insert($set_values);
+			continue;
+		}
+
+
+		foreach ($qstn as $ANS_ID => $ANS_value) {
+			// get answer
+			$query_params = array(
+				0 => array(
+					'ANS_ID' => $ANS_ID,
+					'REG_ID' => $REG_ID,
+					'QST_ID' => $QST_ID,
+				),
+			);
+			$answer = EEM_Answer::instance()->get_one($query_params);
+			// this MAY be an array but NOT have an answer because its multi select.  If so then we need to create the answer
+			if (! $answer instanceof EE_Answer) {
+				$set_values = array(
+					'QST_ID'    => $QST_ID,
+					'REG_ID'    => $REG_ID,
+					'ANS_value' => $qstn,
+				);
+				$success = EEM_Answer::instance()->insert($set_values);
+				continue 2;
+			}
+
+			$answer->set('ANS_value', $ANS_value);
+			$success = $answer->save();
+		}
+	}
+	$what = esc_html__('Registration Form', 'event_espresso');
+	$route = $REG_ID ? array('action' => 'view_registration', '_REG_ID' => $REG_ID) : array('action' => 'default');
+	$admin_page->redirect_after_action($success, $what, esc_html__('updated', 'event_espresso'), $route);
+	exit;
 }
 
 add_action(
-    'AHEE__Registrations_Admin_Page___update_attendee_registration_form__start',
-    'ee_deprecated_update_attendee_registration_form_old',
-    10,
-    1
+	'AHEE__Registrations_Admin_Page___update_attendee_registration_form__start',
+	'ee_deprecated_update_attendee_registration_form_old',
+	10,
+	1
 );
 /**
  * Render the registration admin page's custom questions area in the old fashion
@@ -446,50 +446,50 @@ 
  */
 function ee_deprecated_reg_questions_meta_box_old($do_default_action, $admin_page, $registration)
 {
-    // check if the old hooks are in use. If not, do the default
-    if (! ee_deprecated_using_old_registration_admin_custom_questions_form_hooks()
-        || ! $admin_page instanceof EE_Admin_Page) {
-        return $do_default_action;
-    }
-    add_filter(
-        'FHEE__EEH_Form_Fields__generate_question_groups_html__before_question_group_questions',
-        array($admin_page, 'form_before_question_group'),
-        10,
-        1
-    );
-    add_filter(
-        'FHEE__EEH_Form_Fields__generate_question_groups_html__after_question_group_questions',
-        array($admin_page, 'form_after_question_group'),
-        10,
-        1
-    );
-    add_filter('FHEE__EEH_Form_Fields__label_html', array($admin_page, 'form_form_field_label_wrap'), 10, 1);
-    add_filter('FHEE__EEH_Form_Fields__input_html', array($admin_page, 'form_form_field_input__wrap'), 10, 1);
-
-    $question_groups = EEM_Event::instance()->assemble_array_of_groups_questions_and_options(
-        $registration,
-        $registration->get(
-            'EVT_ID'
-        )
-    );
-
-    EE_Registry::instance()->load_helper('Form_Fields');
-    $template_args = array(
-        'att_questions'             => EEH_Form_Fields::generate_question_groups_html($question_groups),
-        'reg_questions_form_action' => 'edit_registration',
-        'REG_ID'                    => $registration->ID(),
-    );
-    $template_path = REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_reg_questions.template.php';
-    echo EEH_Template::display_template($template_path, $template_args, true);
-    // indicate that we should not do the default admin page code
-    return false;
+	// check if the old hooks are in use. If not, do the default
+	if (! ee_deprecated_using_old_registration_admin_custom_questions_form_hooks()
+		|| ! $admin_page instanceof EE_Admin_Page) {
+		return $do_default_action;
+	}
+	add_filter(
+		'FHEE__EEH_Form_Fields__generate_question_groups_html__before_question_group_questions',
+		array($admin_page, 'form_before_question_group'),
+		10,
+		1
+	);
+	add_filter(
+		'FHEE__EEH_Form_Fields__generate_question_groups_html__after_question_group_questions',
+		array($admin_page, 'form_after_question_group'),
+		10,
+		1
+	);
+	add_filter('FHEE__EEH_Form_Fields__label_html', array($admin_page, 'form_form_field_label_wrap'), 10, 1);
+	add_filter('FHEE__EEH_Form_Fields__input_html', array($admin_page, 'form_form_field_input__wrap'), 10, 1);
+
+	$question_groups = EEM_Event::instance()->assemble_array_of_groups_questions_and_options(
+		$registration,
+		$registration->get(
+			'EVT_ID'
+		)
+	);
+
+	EE_Registry::instance()->load_helper('Form_Fields');
+	$template_args = array(
+		'att_questions'             => EEH_Form_Fields::generate_question_groups_html($question_groups),
+		'reg_questions_form_action' => 'edit_registration',
+		'REG_ID'                    => $registration->ID(),
+	);
+	$template_path = REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_reg_questions.template.php';
+	echo EEH_Template::display_template($template_path, $template_args, true);
+	// indicate that we should not do the default admin page code
+	return false;
 }
 
 add_action(
-    'FHEE__Registrations_Admin_Page___reg_questions_meta_box__do_default',
-    'ee_deprecated_reg_questions_meta_box_old',
-    10,
-    3
+	'FHEE__Registrations_Admin_Page___reg_questions_meta_box__do_default',
+	'ee_deprecated_reg_questions_meta_box_old',
+	10,
+	3
 );
 
 
@@ -506,42 +506,42 @@ 
 class EE_Message_Template_Defaults extends EE_Base
 {
 
-    /**
-     * EE_Message_Template_Defaults constructor.
-     *
-     * @param EE_messages $messages
-     * @param             $messenger_name
-     * @param             $message_type_name
-     * @param int         $GRP_ID
-     * @return EE_Messages_Template_Defaults
-     */
-    public function __construct(
-        EE_messages $messages,
-        $messenger_name,
-        $message_type_name,
-        $GRP_ID = 0
-    ) {
-        EE_Error::doing_it_wrong(
-            __FUNCTION__,
-            esc_html__(
-                'The class EE_Message_Template_Defaults has been deprecated and replaced by EE_Messages_Template_Defaults.',
-                'event_espresso'
-            ),
-            '4.9.0'
-        );
-        /** @var EE_Message_Resource_Manager $message_resource_manager */
-        $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        $messenger = $message_resource_manager->get_messenger($messenger_name);
-        $message_type = $message_resource_manager->get_message_type($message_type_name);
-        return EE_Registry::instance()->load_lib(
-            'Messages_Template_Defaults',
-            array(
-                $messenger,
-                $message_type,
-                $GRP_ID,
-            )
-        );
-    }
+	/**
+	 * EE_Message_Template_Defaults constructor.
+	 *
+	 * @param EE_messages $messages
+	 * @param             $messenger_name
+	 * @param             $message_type_name
+	 * @param int         $GRP_ID
+	 * @return EE_Messages_Template_Defaults
+	 */
+	public function __construct(
+		EE_messages $messages,
+		$messenger_name,
+		$message_type_name,
+		$GRP_ID = 0
+	) {
+		EE_Error::doing_it_wrong(
+			__FUNCTION__,
+			esc_html__(
+				'The class EE_Message_Template_Defaults has been deprecated and replaced by EE_Messages_Template_Defaults.',
+				'event_espresso'
+			),
+			'4.9.0'
+		);
+		/** @var EE_Message_Resource_Manager $message_resource_manager */
+		$message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		$messenger = $message_resource_manager->get_messenger($messenger_name);
+		$message_type = $message_resource_manager->get_message_type($message_type_name);
+		return EE_Registry::instance()->load_lib(
+			'Messages_Template_Defaults',
+			array(
+				$messenger,
+				$message_type,
+				$GRP_ID,
+			)
+		);
+	}
 }
 
 
@@ -559,525 +559,525 @@ 
 class EE_messages
 {
 
-    /** @type EE_messenger[] */
-    protected $_active_messengers = array();
-
-    /** @type array */
-    protected $_active_message_types = array();
-
-    /** @type EE_message_type[] */
-    protected $_installed_message_types = array();
-
-    /** @type EE_messenger */
-    protected $_messenger;
-
-    /** @type EE_message_type */
-    protected $_message_type;
-
-    /** @type array */
-    protected $_contexts = array();
-
-    /** @type EE_Message_Resource_Manager $_message_resource_manager */
-    protected $_message_resource_manager;
-
-
-    /**
-     * EE_messages constructor.
-     *
-     * @deprecated 4.9.0
-     */
-    public function __construct()
-    {
-    }
-
-
-    /**
-     * @param string $method
-     */
-    public function _class_is_deprecated($method)
-    {
-        EE_Error::doing_it_wrong(
-            'EE_messages::' . $method,
-            esc_html__('EE_messages has been deprecated.  Please use EE_Message_Resource_Manager instead.'),
-            '4.9.0',
-            '4.10.0.p'
-        );
-        // Please use EE_Message_Resource_Manager instead
-        $this->_message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-    }
-
-
-    /**
-     * @deprecated 4.9.0
-     * @param string $messenger_name
-     * @return boolean TRUE if it was PREVIOUSLY active, and FALSE if it was previously inactive
-     */
-    public function ensure_messenger_is_active($messenger_name)
-    {
-        // EE_messages has been deprecated
-        $this->_class_is_deprecated(__FUNCTION__);
-        return $this->_message_resource_manager->ensure_messenger_is_active($messenger_name);
-    }
-
-
-    /**
-     * @deprecated 4.9.0
-     * @param string $message_type message type name
-     * @param        $messenger
-     * @return bool true if it got activated (or was active) and false if not.
-     * @throws \EE_Error
-     */
-    public function ensure_message_type_is_active($message_type, $messenger)
-    {
-        // EE_messages has been deprecated
-        $this->_class_is_deprecated(__FUNCTION__);
-        return $this->_message_resource_manager->ensure_message_type_is_active($message_type, $messenger);
-    }
-
-
-    /**
-     * @deprecated 4.9.0
-     * @param string $messenger_name
-     * @param array  $mts_to_activate             (optional) An array of message types to activate with this messenger.
-     *                                             If included we do NOT setup the default message types (assuming they
-     *                                             are already setup.)
-     * @return boolean an array of generated templates or false if nothing generated/activated.
-     */
-    public function activate_messenger($messenger_name, $mts_to_activate = array())
-    {
-        // EE_messages has been deprecated
-        $this->_class_is_deprecated(__FUNCTION__);
-        return $this->_message_resource_manager->activate_messenger($messenger_name, $mts_to_activate);
-    }
-
-
-    /**
-     * @deprecated 4.9.0
-     * @param EE_messenger    $messenger    messenger used in trigger
-     * @param EE_message_type $message_type message type used in trigger
-     *
-     * @return bool true is a generating messenger and can be sent OR FALSE meaning cannot send.
-     */
-    public function is_generating_messenger_and_active(EE_messenger $messenger, EE_message_type $message_type)
-    {
-        // EE_messages has been deprecated
-        $this->_class_is_deprecated(__FUNCTION__);
-        return $this->_message_resource_manager->is_generating_messenger_and_active($messenger, $message_type);
-    }
-
-
-    /**
-     * @deprecated 4.9.0
-     * @param string $messenger
-     * @return EE_messenger | null
-     */
-    public function get_messenger_if_active($messenger)
-    {
-        // EE_messages has been deprecated
-        $this->_class_is_deprecated(__FUNCTION__);
-        return $this->_message_resource_manager->get_active_messenger($messenger);
-    }
-
-
-    /**
-     * @deprecated 4.9.0
-     * @param EE_Message $message
-     * @return array  An array with 'messenger' and 'message_type' as the index and the corresponding valid object if
-     *                  available.
-     *                  Eg. Valid Messenger and Message Type:
-     *                  array(
-     *                  'messenger' => new EE_Email_messenger(),
-     *                  'message_type' => new EE_Registration_Approved_message_type()
-     *                  )
-     *                  Valid Messenger and Invalid Message Type:
-     *                  array(
-     *                  'messenger' => new EE_Email_messenger(),
-     *                  'message_type' => null
-     *                  )
-     */
-    public function validate_for_use(EE_Message $message)
-    {
-        // EE_messages has been deprecated
-        $this->_class_is_deprecated(__FUNCTION__);
-        return array(
-            'messenger'    => $message->messenger_object(),
-            'message_type' => $message->message_type_object(),
-        );
-    }
-
-
-    /**
-     * @deprecated 4.9.0
-     * @param  string $type                 What type of message are we sending (corresponds to message types)
-     * @param  mixed  $vars                 Data being sent for parsing in the message
-     * @param  string $sending_messenger    if included then we ONLY use the specified messenger for delivery.
-     *                                      Otherwise we cycle through all active messengers.
-     * @param string  $generating_messenger if included then this messenger is used for generating the message
-     *                                      templates (but not for sending).
-     * @param string  $context              If included then only a message type for a specific context will be
-     *                                      generated.
-     * @param bool    $send                 Default TRUE.  If false, then this will just return the generated
-     *                                      EE_messages objects which might be used by the trigger to setup a batch
-     *                                      message (typically html messenger uses it).
-     * @return bool
-     */
-    public function send_message(
-        $type,
-        $vars,
-        $sending_messenger = '',
-        $generating_messenger = '',
-        $context = '',
-        $send = true
-    ) {
-        // EE_messages has been deprecated
-        $this->_class_is_deprecated(__FUNCTION__);
-        /** @type EE_Messages_Processor $processor */
-        $processor = EE_Registry::instance()->load_lib('Messages_Processor');
-        $error = false;
-        // try to intelligently determine what method we'll call based on the incoming data.
-        // if generating and sending are different then generate and send immediately.
-        if (! empty($sending_messenger) && $sending_messenger != $generating_messenger && $send) {
-            // in the legacy system, when generating and sending were different, that means all the
-            // vars are already in the request object.  So let's just use that.
-            try {
-                /** @type EE_Message_To_Generate_From_Request $mtg */
-                $mtg = EE_Registry::instance()->load_lib('Message_To_Generate_From_Request');
-                $processor->generate_and_send_now($mtg);
-            } catch (EE_Error $e) {
-                $error_msg = esc_html__(
-                    'Please note that a system message failed to send due to a technical issue.',
-                    'event_espresso'
-                );
-                // add specific message for developers if WP_DEBUG in on
-                $error_msg .= '||' . $e->getMessage();
-                EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
-                $error = true;
-            }
-        } else {
-            $processor->generate_for_all_active_messengers($type, $vars, $send);
-            // let's find out if there were any errors and how many successfully were queued.
-            $count_errors = $processor->get_queue()->count_STS_in_queue(
-                array(EEM_Message::status_failed, EEM_Message::status_debug_only)
-            );
-            $count_queued = $processor->get_queue()->count_STS_in_queue(EEM_Message::status_incomplete);
-            $count_retry = $processor->get_queue()->count_STS_in_queue(EEM_Message::status_retry);
-            $count_errors = $count_errors + $count_retry;
-            if ($count_errors > 0) {
-                $error = true;
-                if ($count_errors > 1 && $count_retry > 1 && $count_queued > 1) {
-                    $message = sprintf(
-                        esc_html__(
-                            'There were %d errors and %d messages successfully queued for generation and sending',
-                            'event_espresso'
-                        ),
-                        $count_errors,
-                        $count_queued
-                    );
-                } elseif ($count_errors > 1 && $count_queued === 1) {
-                    $message = sprintf(
-                        esc_html__(
-                            'There were %d errors and %d message successfully queued for generation.',
-                            'event_espresso'
-                        ),
-                        $count_errors,
-                        $count_queued
-                    );
-                } elseif ($count_errors === 1 && $count_queued > 1) {
-                    $message = sprintf(
-                        esc_html__(
-                            'There was %d error and %d messages successfully queued for generation.',
-                            'event_espresso'
-                        ),
-                        $count_errors,
-                        $count_queued
-                    );
-                } else {
-                    $message = sprintf(
-                        esc_html__(
-                            'There was %d message that failed to be queued for generation.',
-                            'event_espresso'
-                        ),
-                        $count_errors
-                    );
-                }
-                EE_Error::add_error($message, __FILE__, __FUNCTION__, __LINE__);
-            } else {
-                if ($count_queued === 1) {
-                    $message = sprintf(
-                        esc_html__(
-                            '%d message successfully queued for generation.',
-                            'event_espresso'
-                        ),
-                        $count_queued
-                    );
-                } else {
-                    $message = sprintf(
-                        esc_html__(
-                            '%d messages were successfully queued for generation.',
-                            'event_espresso'
-                        ),
-                        $count_queued
-                    );
-                }
-                EE_Error::add_success($message);
-            }
-        }
-        // if no error then return the generated message(s).
-        if (! $error && ! $send) {
-            $generated_queue = $processor->generate_queue(false);
-            // get message and return.
-            $generated_queue->get_message_repository()->rewind();
-            $messages = array();
-            while ($generated_queue->get_message_repository()->valid()) {
-                $message = $generated_queue->get_message_repository()->current();
-                if ($message instanceof EE_Message) {
-                    // set properties that might be expected by add-ons (backward compat)
-                    $message->content = $message->content();
-                    $message->template_pack = $message->get_template_pack();
-                    $message->template_variation = $message->get_template_pack_variation();
-                    $messages[] = $message;
-                }
-                $generated_queue->get_message_repository()->next();
-            }
-            return $messages;
-        }
-        return $error ? false
-            : true; // yeah backwards eh?  Really what we're returning is if there is a total success for all the messages or not.  We'll modify this once we get message recording in place.
-    }
-
-
-    /**
-     * @deprecated 4.9.0
-     * @param  string $type      This should correspond with a valid message type
-     * @param  string $context   This should correspond with a valid context for the message type
-     * @param  string $messenger This should correspond with a valid messenger.
-     * @param bool    $send      true we will do a test send using the messenger delivery, false we just do a regular
-     *                           preview
-     * @return string          The body of the message.
-     */
-    public function preview_message($type, $context, $messenger, $send = false)
-    {
-        // EE_messages has been deprecated
-        $this->_class_is_deprecated(__FUNCTION__);
-        return EED_Messages::preview_message($type, $context, $messenger, $send);
-    }
-
-
-    /**
-     * @since      4.5.0
-     * @deprecated 4.9.0   Moved to EED_Messages Module
-     * @param string   $messenger    a string matching a valid active messenger in the system
-     * @param string   $message_type Although it seems contrary to the name of the method, a message type name is still
-     *                               required to send along the message type to the messenger because this is used for
-     *                               determining what specific variations might be loaded for the generated message.
-     * @param stdClass $message      a stdClass object in the format expected by the messenger.
-     *
-     * @return bool          success or fail.
-     */
-    public function send_message_with_messenger_only($messenger, $message_type, $message)
-    {
-        // EE_messages has been deprecated
-        $this->_class_is_deprecated(__FUNCTION__);
-        // setup for sending to new method.
-        /** @type EE_Messages_Queue $queue */
-        $queue = EE_Registry::instance()->load_lib('Messages_Queue');
-        // make sure we have a proper message object
-        if (! $message instanceof EE_Message && is_object($message) && isset($message->content)) {
-            $msg = EE_Message_Factory::create(
-                array(
-                    'MSG_messenger'    => $messenger,
-                    'MSG_message_type' => $message_type,
-                    'MSG_content'      => $message->content,
-                    'MSG_subject'      => $message->subject,
-                )
-            );
-        } else {
-            $msg = $message;
-        }
-        if (! $msg instanceof EE_Message) {
-            return false;
-        }
-        // make sure any content in a content property (if not empty) is set on the MSG_content.
-        if (! empty($msg->content)) {
-            $msg->set('MSG_content', $msg->content);
-        }
-        $queue->add($msg);
-        return EED_Messages::send_message_with_messenger_only($messenger, $message_type, $queue);
-    }
-
-
-    /**
-     * @deprecated 4.9.0
-     * @param         $messenger
-     * @param  string $message_type message type that the templates are being created for
-     * @param int     $GRP_ID
-     * @param bool    $is_global
-     * @return array|object if creation is successful then we return an array of info, otherwise an error_object is
-     *                      returned.
-     * @throws \EE_Error
-     */
-    public function create_new_templates($messenger, $message_type, $GRP_ID = 0, $is_global = false)
-    {
-        // EE_messages has been deprecated
-        $this->_class_is_deprecated(__FUNCTION__);
-        EE_Registry::instance()->load_helper('MSG_Template');
-        return EEH_MSG_Template::create_new_templates($messenger, $message_type, $GRP_ID, $is_global);
-    }
-
-
-    /**
-     * @deprecated 4.9.0
-     * @param  string $messenger_name    name of EE_messenger
-     * @param  string $message_type_name name of EE_message_type
-     * @return array
-     */
-    public function get_fields($messenger_name, $message_type_name)
-    {
-        // EE_messages has been deprecated
-        $this->_class_is_deprecated(__FUNCTION__);
-        EE_Registry::instance()->load_helper('MSG_Template');
-        return EEH_MSG_Template::get_fields($messenger_name, $message_type_name);
-    }
-
-
-    /**
-     * @deprecated 4.9.0
-     * @access     public
-     * @param string $type                we can indicate just returning installed message types
-     *                                    or messengers (or both) via this parameter.
-     * @param bool   $skip_cache          if true then we skip the cache and retrieve via files.
-     * @return array                    multidimensional array of messenger and message_type objects
-     *                                    (messengers index, and message_type index);
-     */
-    public function get_installed($type = 'all', $skip_cache = false)
-    {
-        // EE_messages has been deprecated
-        $this->_class_is_deprecated(__FUNCTION__);
-        if ($skip_cache) {
-            $this->_message_resource_manager->reset_active_messengers_and_message_types();
-        }
-        switch ($type) {
-            case 'messengers' :
-                return array(
-                    'messenger' => $this->_message_resource_manager->installed_messengers(),
-                );
-                break;
-            case 'message_types' :
-                return array(
-                    'message_type' => $this->_message_resource_manager->installed_message_types(),
-                );
-                break;
-            case 'all' :
-            default :
-                return array(
-                    'messenger'    => $this->_message_resource_manager->installed_messengers(),
-                    'message_type' => $this->_message_resource_manager->installed_message_types(),
-                );
-                break;
-        }
-    }
-
-
-    /**
-     * @deprecated 4.9.0
-     * @return \EE_messenger[]
-     */
-    public function get_active_messengers()
-    {
-        // EE_messages has been deprecated
-        $this->_class_is_deprecated(__FUNCTION__);
-        return $this->_message_resource_manager->active_messengers();
-    }
-
-
-    /**
-     * @deprecated 4.9.0
-     * @return array array of message_type references (string)
-     */
-    public function get_active_message_types()
-    {
-        // EE_messages has been deprecated
-        $this->_class_is_deprecated(__FUNCTION__);
-        return $this->_message_resource_manager->list_of_active_message_types();
-    }
-
-
-    /**
-     * @deprecated 4.9.0
-     * @return EE_message_type[]
-     */
-    public function get_active_message_type_objects()
-    {
-        // EE_messages has been deprecated
-        $this->_class_is_deprecated(__FUNCTION__);
-        return $this->_message_resource_manager->get_active_message_type_objects();
-    }
-
-
-    /**
-     * @deprecated 4.9.0
-     * @since      4.5.0
-     * @param string $messenger The messenger being checked
-     * @return EE_message_type[]    (or empty array if none present)
-     */
-    public function get_active_message_types_per_messenger($messenger)
-    {
-        // EE_messages has been deprecated
-        $this->_class_is_deprecated(__FUNCTION__);
-        return $this->_message_resource_manager->get_active_message_types_for_messenger($messenger);
-    }
-
-
-    /**
-     * @deprecated 4.9.0
-     * @param string $messenger    The string should correspond to the messenger (message types are
-     * @param string $message_type The string should correspond to a message type.
-     * @return EE_message_type|null
-     */
-    public function get_active_message_type($messenger, $message_type)
-    {
-        // EE_messages has been deprecated
-        $this->_class_is_deprecated(__FUNCTION__);
-        return $this->_message_resource_manager->get_active_message_type_for_messenger($messenger, $message_type);
-    }
-
-
-    /**
-     * @deprecated 4.9.0
-     * @return array|\EE_message_type[]
-     */
-    public function get_installed_message_types()
-    {
-        // EE_messages has been deprecated
-        $this->_class_is_deprecated(__FUNCTION__);
-        return $this->_message_resource_manager->installed_message_types();
-    }
-
-
-    /**
-     * @deprecated 4.9.0
-     * @return array
-     */
-    public function get_installed_messengers()
-    {
-        // EE_messages has been deprecated
-        $this->_class_is_deprecated(__FUNCTION__);
-        return $this->_message_resource_manager->installed_messengers();
-    }
-
-
-    /**
-     * @deprecated 4.9.0
-     * @param   bool $slugs_only Whether to return an array of just slugs and labels (true) or all contexts indexed by
-     *                           message type.
-     * @return array
-     */
-    public function get_all_contexts($slugs_only = true)
-    {
-        // EE_messages has been deprecated
-        $this->_class_is_deprecated(__FUNCTION__);
-        return $this->_message_resource_manager->get_all_contexts($slugs_only);
-    }
+	/** @type EE_messenger[] */
+	protected $_active_messengers = array();
+
+	/** @type array */
+	protected $_active_message_types = array();
+
+	/** @type EE_message_type[] */
+	protected $_installed_message_types = array();
+
+	/** @type EE_messenger */
+	protected $_messenger;
+
+	/** @type EE_message_type */
+	protected $_message_type;
+
+	/** @type array */
+	protected $_contexts = array();
+
+	/** @type EE_Message_Resource_Manager $_message_resource_manager */
+	protected $_message_resource_manager;
+
+
+	/**
+	 * EE_messages constructor.
+	 *
+	 * @deprecated 4.9.0
+	 */
+	public function __construct()
+	{
+	}
+
+
+	/**
+	 * @param string $method
+	 */
+	public function _class_is_deprecated($method)
+	{
+		EE_Error::doing_it_wrong(
+			'EE_messages::' . $method,
+			esc_html__('EE_messages has been deprecated.  Please use EE_Message_Resource_Manager instead.'),
+			'4.9.0',
+			'4.10.0.p'
+		);
+		// Please use EE_Message_Resource_Manager instead
+		$this->_message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+	}
+
+
+	/**
+	 * @deprecated 4.9.0
+	 * @param string $messenger_name
+	 * @return boolean TRUE if it was PREVIOUSLY active, and FALSE if it was previously inactive
+	 */
+	public function ensure_messenger_is_active($messenger_name)
+	{
+		// EE_messages has been deprecated
+		$this->_class_is_deprecated(__FUNCTION__);
+		return $this->_message_resource_manager->ensure_messenger_is_active($messenger_name);
+	}
+
+
+	/**
+	 * @deprecated 4.9.0
+	 * @param string $message_type message type name
+	 * @param        $messenger
+	 * @return bool true if it got activated (or was active) and false if not.
+	 * @throws \EE_Error
+	 */
+	public function ensure_message_type_is_active($message_type, $messenger)
+	{
+		// EE_messages has been deprecated
+		$this->_class_is_deprecated(__FUNCTION__);
+		return $this->_message_resource_manager->ensure_message_type_is_active($message_type, $messenger);
+	}
+
+
+	/**
+	 * @deprecated 4.9.0
+	 * @param string $messenger_name
+	 * @param array  $mts_to_activate             (optional) An array of message types to activate with this messenger.
+	 *                                             If included we do NOT setup the default message types (assuming they
+	 *                                             are already setup.)
+	 * @return boolean an array of generated templates or false if nothing generated/activated.
+	 */
+	public function activate_messenger($messenger_name, $mts_to_activate = array())
+	{
+		// EE_messages has been deprecated
+		$this->_class_is_deprecated(__FUNCTION__);
+		return $this->_message_resource_manager->activate_messenger($messenger_name, $mts_to_activate);
+	}
+
+
+	/**
+	 * @deprecated 4.9.0
+	 * @param EE_messenger    $messenger    messenger used in trigger
+	 * @param EE_message_type $message_type message type used in trigger
+	 *
+	 * @return bool true is a generating messenger and can be sent OR FALSE meaning cannot send.
+	 */
+	public function is_generating_messenger_and_active(EE_messenger $messenger, EE_message_type $message_type)
+	{
+		// EE_messages has been deprecated
+		$this->_class_is_deprecated(__FUNCTION__);
+		return $this->_message_resource_manager->is_generating_messenger_and_active($messenger, $message_type);
+	}
+
+
+	/**
+	 * @deprecated 4.9.0
+	 * @param string $messenger
+	 * @return EE_messenger | null
+	 */
+	public function get_messenger_if_active($messenger)
+	{
+		// EE_messages has been deprecated
+		$this->_class_is_deprecated(__FUNCTION__);
+		return $this->_message_resource_manager->get_active_messenger($messenger);
+	}
+
+
+	/**
+	 * @deprecated 4.9.0
+	 * @param EE_Message $message
+	 * @return array  An array with 'messenger' and 'message_type' as the index and the corresponding valid object if
+	 *                  available.
+	 *                  Eg. Valid Messenger and Message Type:
+	 *                  array(
+	 *                  'messenger' => new EE_Email_messenger(),
+	 *                  'message_type' => new EE_Registration_Approved_message_type()
+	 *                  )
+	 *                  Valid Messenger and Invalid Message Type:
+	 *                  array(
+	 *                  'messenger' => new EE_Email_messenger(),
+	 *                  'message_type' => null
+	 *                  )
+	 */
+	public function validate_for_use(EE_Message $message)
+	{
+		// EE_messages has been deprecated
+		$this->_class_is_deprecated(__FUNCTION__);
+		return array(
+			'messenger'    => $message->messenger_object(),
+			'message_type' => $message->message_type_object(),
+		);
+	}
+
+
+	/**
+	 * @deprecated 4.9.0
+	 * @param  string $type                 What type of message are we sending (corresponds to message types)
+	 * @param  mixed  $vars                 Data being sent for parsing in the message
+	 * @param  string $sending_messenger    if included then we ONLY use the specified messenger for delivery.
+	 *                                      Otherwise we cycle through all active messengers.
+	 * @param string  $generating_messenger if included then this messenger is used for generating the message
+	 *                                      templates (but not for sending).
+	 * @param string  $context              If included then only a message type for a specific context will be
+	 *                                      generated.
+	 * @param bool    $send                 Default TRUE.  If false, then this will just return the generated
+	 *                                      EE_messages objects which might be used by the trigger to setup a batch
+	 *                                      message (typically html messenger uses it).
+	 * @return bool
+	 */
+	public function send_message(
+		$type,
+		$vars,
+		$sending_messenger = '',
+		$generating_messenger = '',
+		$context = '',
+		$send = true
+	) {
+		// EE_messages has been deprecated
+		$this->_class_is_deprecated(__FUNCTION__);
+		/** @type EE_Messages_Processor $processor */
+		$processor = EE_Registry::instance()->load_lib('Messages_Processor');
+		$error = false;
+		// try to intelligently determine what method we'll call based on the incoming data.
+		// if generating and sending are different then generate and send immediately.
+		if (! empty($sending_messenger) && $sending_messenger != $generating_messenger && $send) {
+			// in the legacy system, when generating and sending were different, that means all the
+			// vars are already in the request object.  So let's just use that.
+			try {
+				/** @type EE_Message_To_Generate_From_Request $mtg */
+				$mtg = EE_Registry::instance()->load_lib('Message_To_Generate_From_Request');
+				$processor->generate_and_send_now($mtg);
+			} catch (EE_Error $e) {
+				$error_msg = esc_html__(
+					'Please note that a system message failed to send due to a technical issue.',
+					'event_espresso'
+				);
+				// add specific message for developers if WP_DEBUG in on
+				$error_msg .= '||' . $e->getMessage();
+				EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
+				$error = true;
+			}
+		} else {
+			$processor->generate_for_all_active_messengers($type, $vars, $send);
+			// let's find out if there were any errors and how many successfully were queued.
+			$count_errors = $processor->get_queue()->count_STS_in_queue(
+				array(EEM_Message::status_failed, EEM_Message::status_debug_only)
+			);
+			$count_queued = $processor->get_queue()->count_STS_in_queue(EEM_Message::status_incomplete);
+			$count_retry = $processor->get_queue()->count_STS_in_queue(EEM_Message::status_retry);
+			$count_errors = $count_errors + $count_retry;
+			if ($count_errors > 0) {
+				$error = true;
+				if ($count_errors > 1 && $count_retry > 1 && $count_queued > 1) {
+					$message = sprintf(
+						esc_html__(
+							'There were %d errors and %d messages successfully queued for generation and sending',
+							'event_espresso'
+						),
+						$count_errors,
+						$count_queued
+					);
+				} elseif ($count_errors > 1 && $count_queued === 1) {
+					$message = sprintf(
+						esc_html__(
+							'There were %d errors and %d message successfully queued for generation.',
+							'event_espresso'
+						),
+						$count_errors,
+						$count_queued
+					);
+				} elseif ($count_errors === 1 && $count_queued > 1) {
+					$message = sprintf(
+						esc_html__(
+							'There was %d error and %d messages successfully queued for generation.',
+							'event_espresso'
+						),
+						$count_errors,
+						$count_queued
+					);
+				} else {
+					$message = sprintf(
+						esc_html__(
+							'There was %d message that failed to be queued for generation.',
+							'event_espresso'
+						),
+						$count_errors
+					);
+				}
+				EE_Error::add_error($message, __FILE__, __FUNCTION__, __LINE__);
+			} else {
+				if ($count_queued === 1) {
+					$message = sprintf(
+						esc_html__(
+							'%d message successfully queued for generation.',
+							'event_espresso'
+						),
+						$count_queued
+					);
+				} else {
+					$message = sprintf(
+						esc_html__(
+							'%d messages were successfully queued for generation.',
+							'event_espresso'
+						),
+						$count_queued
+					);
+				}
+				EE_Error::add_success($message);
+			}
+		}
+		// if no error then return the generated message(s).
+		if (! $error && ! $send) {
+			$generated_queue = $processor->generate_queue(false);
+			// get message and return.
+			$generated_queue->get_message_repository()->rewind();
+			$messages = array();
+			while ($generated_queue->get_message_repository()->valid()) {
+				$message = $generated_queue->get_message_repository()->current();
+				if ($message instanceof EE_Message) {
+					// set properties that might be expected by add-ons (backward compat)
+					$message->content = $message->content();
+					$message->template_pack = $message->get_template_pack();
+					$message->template_variation = $message->get_template_pack_variation();
+					$messages[] = $message;
+				}
+				$generated_queue->get_message_repository()->next();
+			}
+			return $messages;
+		}
+		return $error ? false
+			: true; // yeah backwards eh?  Really what we're returning is if there is a total success for all the messages or not.  We'll modify this once we get message recording in place.
+	}
+
+
+	/**
+	 * @deprecated 4.9.0
+	 * @param  string $type      This should correspond with a valid message type
+	 * @param  string $context   This should correspond with a valid context for the message type
+	 * @param  string $messenger This should correspond with a valid messenger.
+	 * @param bool    $send      true we will do a test send using the messenger delivery, false we just do a regular
+	 *                           preview
+	 * @return string          The body of the message.
+	 */
+	public function preview_message($type, $context, $messenger, $send = false)
+	{
+		// EE_messages has been deprecated
+		$this->_class_is_deprecated(__FUNCTION__);
+		return EED_Messages::preview_message($type, $context, $messenger, $send);
+	}
+
+
+	/**
+	 * @since      4.5.0
+	 * @deprecated 4.9.0   Moved to EED_Messages Module
+	 * @param string   $messenger    a string matching a valid active messenger in the system
+	 * @param string   $message_type Although it seems contrary to the name of the method, a message type name is still
+	 *                               required to send along the message type to the messenger because this is used for
+	 *                               determining what specific variations might be loaded for the generated message.
+	 * @param stdClass $message      a stdClass object in the format expected by the messenger.
+	 *
+	 * @return bool          success or fail.
+	 */
+	public function send_message_with_messenger_only($messenger, $message_type, $message)
+	{
+		// EE_messages has been deprecated
+		$this->_class_is_deprecated(__FUNCTION__);
+		// setup for sending to new method.
+		/** @type EE_Messages_Queue $queue */
+		$queue = EE_Registry::instance()->load_lib('Messages_Queue');
+		// make sure we have a proper message object
+		if (! $message instanceof EE_Message && is_object($message) && isset($message->content)) {
+			$msg = EE_Message_Factory::create(
+				array(
+					'MSG_messenger'    => $messenger,
+					'MSG_message_type' => $message_type,
+					'MSG_content'      => $message->content,
+					'MSG_subject'      => $message->subject,
+				)
+			);
+		} else {
+			$msg = $message;
+		}
+		if (! $msg instanceof EE_Message) {
+			return false;
+		}
+		// make sure any content in a content property (if not empty) is set on the MSG_content.
+		if (! empty($msg->content)) {
+			$msg->set('MSG_content', $msg->content);
+		}
+		$queue->add($msg);
+		return EED_Messages::send_message_with_messenger_only($messenger, $message_type, $queue);
+	}
+
+
+	/**
+	 * @deprecated 4.9.0
+	 * @param         $messenger
+	 * @param  string $message_type message type that the templates are being created for
+	 * @param int     $GRP_ID
+	 * @param bool    $is_global
+	 * @return array|object if creation is successful then we return an array of info, otherwise an error_object is
+	 *                      returned.
+	 * @throws \EE_Error
+	 */
+	public function create_new_templates($messenger, $message_type, $GRP_ID = 0, $is_global = false)
+	{
+		// EE_messages has been deprecated
+		$this->_class_is_deprecated(__FUNCTION__);
+		EE_Registry::instance()->load_helper('MSG_Template');
+		return EEH_MSG_Template::create_new_templates($messenger, $message_type, $GRP_ID, $is_global);
+	}
+
+
+	/**
+	 * @deprecated 4.9.0
+	 * @param  string $messenger_name    name of EE_messenger
+	 * @param  string $message_type_name name of EE_message_type
+	 * @return array
+	 */
+	public function get_fields($messenger_name, $message_type_name)
+	{
+		// EE_messages has been deprecated
+		$this->_class_is_deprecated(__FUNCTION__);
+		EE_Registry::instance()->load_helper('MSG_Template');
+		return EEH_MSG_Template::get_fields($messenger_name, $message_type_name);
+	}
+
+
+	/**
+	 * @deprecated 4.9.0
+	 * @access     public
+	 * @param string $type                we can indicate just returning installed message types
+	 *                                    or messengers (or both) via this parameter.
+	 * @param bool   $skip_cache          if true then we skip the cache and retrieve via files.
+	 * @return array                    multidimensional array of messenger and message_type objects
+	 *                                    (messengers index, and message_type index);
+	 */
+	public function get_installed($type = 'all', $skip_cache = false)
+	{
+		// EE_messages has been deprecated
+		$this->_class_is_deprecated(__FUNCTION__);
+		if ($skip_cache) {
+			$this->_message_resource_manager->reset_active_messengers_and_message_types();
+		}
+		switch ($type) {
+			case 'messengers' :
+				return array(
+					'messenger' => $this->_message_resource_manager->installed_messengers(),
+				);
+				break;
+			case 'message_types' :
+				return array(
+					'message_type' => $this->_message_resource_manager->installed_message_types(),
+				);
+				break;
+			case 'all' :
+			default :
+				return array(
+					'messenger'    => $this->_message_resource_manager->installed_messengers(),
+					'message_type' => $this->_message_resource_manager->installed_message_types(),
+				);
+				break;
+		}
+	}
+
+
+	/**
+	 * @deprecated 4.9.0
+	 * @return \EE_messenger[]
+	 */
+	public function get_active_messengers()
+	{
+		// EE_messages has been deprecated
+		$this->_class_is_deprecated(__FUNCTION__);
+		return $this->_message_resource_manager->active_messengers();
+	}
+
+
+	/**
+	 * @deprecated 4.9.0
+	 * @return array array of message_type references (string)
+	 */
+	public function get_active_message_types()
+	{
+		// EE_messages has been deprecated
+		$this->_class_is_deprecated(__FUNCTION__);
+		return $this->_message_resource_manager->list_of_active_message_types();
+	}
+
+
+	/**
+	 * @deprecated 4.9.0
+	 * @return EE_message_type[]
+	 */
+	public function get_active_message_type_objects()
+	{
+		// EE_messages has been deprecated
+		$this->_class_is_deprecated(__FUNCTION__);
+		return $this->_message_resource_manager->get_active_message_type_objects();
+	}
+
+
+	/**
+	 * @deprecated 4.9.0
+	 * @since      4.5.0
+	 * @param string $messenger The messenger being checked
+	 * @return EE_message_type[]    (or empty array if none present)
+	 */
+	public function get_active_message_types_per_messenger($messenger)
+	{
+		// EE_messages has been deprecated
+		$this->_class_is_deprecated(__FUNCTION__);
+		return $this->_message_resource_manager->get_active_message_types_for_messenger($messenger);
+	}
+
+
+	/**
+	 * @deprecated 4.9.0
+	 * @param string $messenger    The string should correspond to the messenger (message types are
+	 * @param string $message_type The string should correspond to a message type.
+	 * @return EE_message_type|null
+	 */
+	public function get_active_message_type($messenger, $message_type)
+	{
+		// EE_messages has been deprecated
+		$this->_class_is_deprecated(__FUNCTION__);
+		return $this->_message_resource_manager->get_active_message_type_for_messenger($messenger, $message_type);
+	}
+
+
+	/**
+	 * @deprecated 4.9.0
+	 * @return array|\EE_message_type[]
+	 */
+	public function get_installed_message_types()
+	{
+		// EE_messages has been deprecated
+		$this->_class_is_deprecated(__FUNCTION__);
+		return $this->_message_resource_manager->installed_message_types();
+	}
+
+
+	/**
+	 * @deprecated 4.9.0
+	 * @return array
+	 */
+	public function get_installed_messengers()
+	{
+		// EE_messages has been deprecated
+		$this->_class_is_deprecated(__FUNCTION__);
+		return $this->_message_resource_manager->installed_messengers();
+	}
+
+
+	/**
+	 * @deprecated 4.9.0
+	 * @param   bool $slugs_only Whether to return an array of just slugs and labels (true) or all contexts indexed by
+	 *                           message type.
+	 * @return array
+	 */
+	public function get_all_contexts($slugs_only = true)
+	{
+		// EE_messages has been deprecated
+		$this->_class_is_deprecated(__FUNCTION__);
+		return $this->_message_resource_manager->get_all_contexts($slugs_only);
+	}
 
 
 }
@@ -1136,88 +1136,88 @@ 
 
 
 add_filter(
-    'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__css',
-    function ($event_list_iframe_css) {
-        if (! has_filter('FHEE__EventsArchiveIframe__event_list_iframe__css')) {
-            return $event_list_iframe_css;
-        }
-        deprecated_espresso_action_or_filter_doing_it_wrong(
-            'FHEE__EventsArchiveIframe__event_list_iframe__css',
-            'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__css',
-            '\EventEspresso\modules\events_archive\EventsArchiveIframe::display()',
-            '4.9.14',
-            '5.0.0',
-            'filter'
-        );
-        return apply_filters(
-            'FHEE__EventsArchiveIframe__event_list_iframe__css',
-            $event_list_iframe_css
-        );
-    }
+	'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__css',
+	function ($event_list_iframe_css) {
+		if (! has_filter('FHEE__EventsArchiveIframe__event_list_iframe__css')) {
+			return $event_list_iframe_css;
+		}
+		deprecated_espresso_action_or_filter_doing_it_wrong(
+			'FHEE__EventsArchiveIframe__event_list_iframe__css',
+			'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__css',
+			'\EventEspresso\modules\events_archive\EventsArchiveIframe::display()',
+			'4.9.14',
+			'5.0.0',
+			'filter'
+		);
+		return apply_filters(
+			'FHEE__EventsArchiveIframe__event_list_iframe__css',
+			$event_list_iframe_css
+		);
+	}
 );
 add_filter(
-    'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__js',
-    function ($event_list_iframe_js) {
-        if (! has_filter('FHEE__EED_Ticket_Selector__ticket_selector_iframe__js')) {
-            return $event_list_iframe_js;
-        }
-        deprecated_espresso_action_or_filter_doing_it_wrong(
-            'FHEE__EED_Ticket_Selector__ticket_selector_iframe__js',
-            'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__js',
-            '\EventEspresso\modules\events_archive\EventsArchiveIframe::display()',
-            '4.9.14',
-            '5.0.0',
-            'filter'
-        );
-        return apply_filters(
-            'FHEE__EED_Ticket_Selector__ticket_selector_iframe__js',
-            $event_list_iframe_js
-        );
-    }
+	'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__js',
+	function ($event_list_iframe_js) {
+		if (! has_filter('FHEE__EED_Ticket_Selector__ticket_selector_iframe__js')) {
+			return $event_list_iframe_js;
+		}
+		deprecated_espresso_action_or_filter_doing_it_wrong(
+			'FHEE__EED_Ticket_Selector__ticket_selector_iframe__js',
+			'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__js',
+			'\EventEspresso\modules\events_archive\EventsArchiveIframe::display()',
+			'4.9.14',
+			'5.0.0',
+			'filter'
+		);
+		return apply_filters(
+			'FHEE__EED_Ticket_Selector__ticket_selector_iframe__js',
+			$event_list_iframe_js
+		);
+	}
 );
 add_action(
-    'AHEE__EE_Capabilities__addCaps__complete',
-    function ($capabilities_map) {
-        if (! has_action('AHEE__EE_Capabilities__init_role_caps__complete')) {
-            return;
-        }
-        deprecated_espresso_action_or_filter_doing_it_wrong(
-            'AHEE__EE_Capabilities__init_role_caps__complete',
-            'AHEE__EE_Capabilities__addCaps__complete',
-            '\EE_Capabilities::addCaps()',
-            '4.9.42',
-            '5.0.0'
-        );
-        do_action(
-            'AHEE__EE_Capabilities__init_role_caps__complete',
-            $capabilities_map
-        );
-    }
+	'AHEE__EE_Capabilities__addCaps__complete',
+	function ($capabilities_map) {
+		if (! has_action('AHEE__EE_Capabilities__init_role_caps__complete')) {
+			return;
+		}
+		deprecated_espresso_action_or_filter_doing_it_wrong(
+			'AHEE__EE_Capabilities__init_role_caps__complete',
+			'AHEE__EE_Capabilities__addCaps__complete',
+			'\EE_Capabilities::addCaps()',
+			'4.9.42',
+			'5.0.0'
+		);
+		do_action(
+			'AHEE__EE_Capabilities__init_role_caps__complete',
+			$capabilities_map
+		);
+	}
 );
 
 add_filter(
-    'FHEE_EventEspresso_core_domain_services_commands_attendee_CreateAttendeeCommandHandler__findExistingAttendee__existing_attendee',
-    function($existing_attendee, $registration, $attendee_data) {
-        if ( ! has_filter( 'FHEE_EE_Single_Page_Checkout__save_registration_items__find_existing_attendee' )) {
-            return $existing_attendee;
-        }
-        deprecated_espresso_action_or_filter_doing_it_wrong(
-            'FHEE_EE_Single_Page_Checkout__save_registration_items__find_existing_attendee',
-            'FHEE_EventEspresso_core_domain_services_commands_attendee_CreateAttendeeCommandHandler__findExistingAttendee__existing_attendee',
-            '\EventEspresso\core\domain\services\commands\attendee\CreateAttendeeCommandHandler::findExistingAttendee()',
-            '4.9.34',
-            '5.0.0',
-            'filter'
-        );
-        return apply_filters(
-            'FHEE_EE_Single_Page_Checkout__save_registration_items__find_existing_attendee',
-            $existing_attendee,
-            $registration,
-            $attendee_data
-        );
-    },
-    10,
-    3
+	'FHEE_EventEspresso_core_domain_services_commands_attendee_CreateAttendeeCommandHandler__findExistingAttendee__existing_attendee',
+	function($existing_attendee, $registration, $attendee_data) {
+		if ( ! has_filter( 'FHEE_EE_Single_Page_Checkout__save_registration_items__find_existing_attendee' )) {
+			return $existing_attendee;
+		}
+		deprecated_espresso_action_or_filter_doing_it_wrong(
+			'FHEE_EE_Single_Page_Checkout__save_registration_items__find_existing_attendee',
+			'FHEE_EventEspresso_core_domain_services_commands_attendee_CreateAttendeeCommandHandler__findExistingAttendee__existing_attendee',
+			'\EventEspresso\core\domain\services\commands\attendee\CreateAttendeeCommandHandler::findExistingAttendee()',
+			'4.9.34',
+			'5.0.0',
+			'filter'
+		);
+		return apply_filters(
+			'FHEE_EE_Single_Page_Checkout__save_registration_items__find_existing_attendee',
+			$existing_attendee,
+			$registration,
+			$attendee_data
+		);
+	},
+	10,
+	3
 );
 
 /**
@@ -1228,88 +1228,88 @@ 
 class EE_Event_List_Query extends WP_Query
 {
 
-    private $title;
-
-    private $css_class;
-
-    private $category_slug;
-
-    /**
-     * EE_Event_List_Query constructor.
-     *
-     * @param array $args
-     */
-    public function __construct($args = array())
-    {
-        \EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'Usage is deprecated. Please use \EventEspresso\core\domain\services\wp_queries\EventListQuery instead.',
-                'event_espresso'
-            ),
-            '4.9.27',
-            '5.0.0'
-        );
-        $this->title = isset($args['title']) ? $args['title'] : '';
-        $this->css_class = isset($args['css_class']) ? $args['css_class'] : '';
-        $this->category_slug = isset($args['category_slug']) ? $args['category_slug'] : '';
-        $limit = isset($args['limit']) && absint($args['limit']) ? $args['limit'] : 10;
-        // the current "page" we are viewing
-        $paged = max(1, get_query_var('paged'));
-        // Force these args
-        $args = array_merge(
-            $args,
-            array(
-                'post_type'              => 'espresso_events',
-                'posts_per_page'         => $limit,
-                'update_post_term_cache' => false,
-                'update_post_meta_cache' => false,
-                'paged'                  => $paged,
-                'offset'                 => ($paged - 1) * $limit,
-            )
-        );
-        // run the query
-        parent::__construct($args);
-    }
-
-
-    /**
-     * event_list_title
-     *
-     * @param string $event_list_title
-     * @return string
-     */
-    public function event_list_title($event_list_title = '')
-    {
-        if (! empty($this->title)) {
-            return $this->title;
-        }
-        return $event_list_title;
-    }
-
-
-    /**
-     * event_list_css
-     *
-     * @param string $event_list_css
-     * @return string
-     */
-    public function event_list_css($event_list_css = '')
-    {
-        $event_list_css .= ! empty($event_list_css)
-            ? ' '
-            : '';
-        $event_list_css .= ! empty($this->css_class)
-            ? $this->css_class
-            : '';
-        $event_list_css .= ! empty($event_list_css)
-            ? ' '
-            : '';
-        $event_list_css .= ! empty($this->category_slug)
-            ? $this->category_slug
-            : '';
-        return $event_list_css;
-    }
+	private $title;
+
+	private $css_class;
+
+	private $category_slug;
+
+	/**
+	 * EE_Event_List_Query constructor.
+	 *
+	 * @param array $args
+	 */
+	public function __construct($args = array())
+	{
+		\EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'Usage is deprecated. Please use \EventEspresso\core\domain\services\wp_queries\EventListQuery instead.',
+				'event_espresso'
+			),
+			'4.9.27',
+			'5.0.0'
+		);
+		$this->title = isset($args['title']) ? $args['title'] : '';
+		$this->css_class = isset($args['css_class']) ? $args['css_class'] : '';
+		$this->category_slug = isset($args['category_slug']) ? $args['category_slug'] : '';
+		$limit = isset($args['limit']) && absint($args['limit']) ? $args['limit'] : 10;
+		// the current "page" we are viewing
+		$paged = max(1, get_query_var('paged'));
+		// Force these args
+		$args = array_merge(
+			$args,
+			array(
+				'post_type'              => 'espresso_events',
+				'posts_per_page'         => $limit,
+				'update_post_term_cache' => false,
+				'update_post_meta_cache' => false,
+				'paged'                  => $paged,
+				'offset'                 => ($paged - 1) * $limit,
+			)
+		);
+		// run the query
+		parent::__construct($args);
+	}
+
+
+	/**
+	 * event_list_title
+	 *
+	 * @param string $event_list_title
+	 * @return string
+	 */
+	public function event_list_title($event_list_title = '')
+	{
+		if (! empty($this->title)) {
+			return $this->title;
+		}
+		return $event_list_title;
+	}
+
+
+	/**
+	 * event_list_css
+	 *
+	 * @param string $event_list_css
+	 * @return string
+	 */
+	public function event_list_css($event_list_css = '')
+	{
+		$event_list_css .= ! empty($event_list_css)
+			? ' '
+			: '';
+		$event_list_css .= ! empty($this->css_class)
+			? $this->css_class
+			: '';
+		$event_list_css .= ! empty($event_list_css)
+			? ' '
+			: '';
+		$event_list_css .= ! empty($this->category_slug)
+			? $this->category_slug
+			: '';
+		return $event_list_css;
+	}
 
 }
 
@@ -1326,75 +1326,75 @@ 
 {
 
 
-    /**
-     *    class constructor
-     *
-     * @deprecated 4.9.59.p
-     */
-    public function __construct()
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            sprintf(
-                esc_html__('%1$s has been replaced by %2$s.', 'event_espresso'),
-                __CLASS__,
-                'EventEspresso\core\services\licensing\LicenseServices'
-            ),
-            '4.9.59.p'
-        );
-    }
-
-
-    /**
-     * The purpose of this function is to display information about Event Espresso data collection
-     * and a optin selection for extra data collecting by users.
-     *
-     * @param bool $extra
-     * @return string html.
-     * @deprecated 4.9.59.p
-     */
-    public static function espresso_data_collection_optin_text($extra = true)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            sprintf(
-                esc_html__('%1$s has been replaced by %2$s.', 'event_espresso'),
-                __METHOD__,
-                'EventEspresso\core\domain\services\Stats::optinText'
-            ),
-            '4.9.59.p'
-        );
-        Stats::optinText($extra);
-    }
-
-    /**
-     * This is a handy helper method for retrieving whether there is an update available for the given plugin.
-     *
-     * @param  string $basename Use the equivalent result from plugin_basename() for this param as WP uses that to
-     *                          identify plugins. Defaults to core update
-     * @return boolean           True if update available, false if not.
-     * @deprecated 4.9.59.p
-     */
-    public static function is_update_available($basename = '')
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            sprintf(
-                esc_html__('%1$s has been replaced by %2$s.', 'event_espresso'),
-                __METHOD__,
-                'EventEspresso\core\services\licensing\LicenseService::isUpdateAvailable'
-            ),
-            '4.9.59.p'
-        );
-        return LicenseService::isUpdateAvailable($basename);
-    }
+	/**
+	 *    class constructor
+	 *
+	 * @deprecated 4.9.59.p
+	 */
+	public function __construct()
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			sprintf(
+				esc_html__('%1$s has been replaced by %2$s.', 'event_espresso'),
+				__CLASS__,
+				'EventEspresso\core\services\licensing\LicenseServices'
+			),
+			'4.9.59.p'
+		);
+	}
+
+
+	/**
+	 * The purpose of this function is to display information about Event Espresso data collection
+	 * and a optin selection for extra data collecting by users.
+	 *
+	 * @param bool $extra
+	 * @return string html.
+	 * @deprecated 4.9.59.p
+	 */
+	public static function espresso_data_collection_optin_text($extra = true)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			sprintf(
+				esc_html__('%1$s has been replaced by %2$s.', 'event_espresso'),
+				__METHOD__,
+				'EventEspresso\core\domain\services\Stats::optinText'
+			),
+			'4.9.59.p'
+		);
+		Stats::optinText($extra);
+	}
+
+	/**
+	 * This is a handy helper method for retrieving whether there is an update available for the given plugin.
+	 *
+	 * @param  string $basename Use the equivalent result from plugin_basename() for this param as WP uses that to
+	 *                          identify plugins. Defaults to core update
+	 * @return boolean           True if update available, false if not.
+	 * @deprecated 4.9.59.p
+	 */
+	public static function is_update_available($basename = '')
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			sprintf(
+				esc_html__('%1$s has been replaced by %2$s.', 'event_espresso'),
+				__METHOD__,
+				'EventEspresso\core\services\licensing\LicenseService::isUpdateAvailable'
+			),
+			'4.9.59.p'
+		);
+		return LicenseService::isUpdateAvailable($basename);
+	}
 }
 
 add_filter(
-    'FHEE__EventEspressoBatchRequest__JobHandlers__RegistrationsReport__reg_csv_array',
-    'ee_deprecated_registrations_report_csv_legacy_fields',
-    10,
-    2
+	'FHEE__EventEspressoBatchRequest__JobHandlers__RegistrationsReport__reg_csv_array',
+	'ee_deprecated_registrations_report_csv_legacy_fields',
+	10,
+	2
 );
 /**
  * Filters the CSV row to make it appear like the old labels (which were "$pretty_name[$field_name]").
@@ -1411,96 +1411,96 @@ 
  */
 function ee_deprecated_registrations_report_csv_legacy_fields($csv_row_data, $reg_row)
 {
-    // no need for all this if nobody is using the deprecated filter
-    if (has_filter('FHEE__EE_Export__report_registrations__reg_csv_array')) {
-        EE_Error::doing_it_wrong(
-            __FUNCTION__,
-            sprintf(
-                // EE_Error::doing_it_wrong with escape HTML, so don't escape it twice by doing it here too.
-                _x(
-                    'The filter "%1$s" has been deprecated. Please use "%2$s" instead.',
-                    'The filter "FHEE__EE_Export__report_registrations__reg_csv_array" has been deprecated. Please use "FHEE__EventEspressoBatchRequest__JobHandlers__RegistrationsReport__reg_csv_array" instead.',
-                    'event_espresso'
-                ),
-                'FHEE__EE_Export__report_registrations__reg_csv_array',
-                'FHEE__EventEspressoBatchRequest__JobHandlers__RegistrationsReport__reg_csv_array'
-            ),
-            '4.9.69.p',
-            '4.9.75.p'
-        );
-        // there's code that expected the old csv column headers/labels. Let's oblige. Put it back in the old format!
-        // first: what model fields might be used as column headers? (whose format we need to change)
-        $model_fields = array_merge(
-            EEM_Registration::instance()->field_settings(),
-            EEM_Attendee::instance()->field_settings()
-        );
-        // create an array that uses the legacy column headers/labels.
-        $new_csv_row = array();
-        foreach ($csv_row_data as $label => $value) {
-            $new_label = $label;
-            foreach ($model_fields as $field) {
-                if ($label === EEH_Export::get_column_name_for_field($field)) {
-                    // re-add the old field name
-                    $new_label = $label . '[' . $field->get_name() . ']';
-                    break;
-                }
-            }
-            $new_csv_row[$new_label] = $value;
-        }
-        // before we run it through the deprecated filter, set the method `EEH_Export::get_column_name_for_field()`
-        // to create the old column names, because that's what's in the row temporarily
-        add_filter(
-            'FHEE__EEH_Export__get_column_name_for_field__add_field_name',
-            '__return_true',
-            777
-        );
-        // now, those old filters can be run on this data. Have fun!
-        /**
-         * Deprecated. Use FHEE__EventEspressoBatchRequest__JobHandlers__RegistrationsReport__reg_csv_array instead.
-         *
-         * Filter to change the contents of each row of the registrations report CSV file.
-         * This can be used to add or remote columns from the CSV file, or change their values.                 *
-         * Note: it has this name because originally that's where this filter resided,
-         * and we've left its name as-is for backward compatibility.
-         * Note when using: all rows in the CSV should have the same columns.
-         *
-         * @param array $reg_csv_array keys are column-header names, and values are that columns' value
-         *                             in this row
-         * @param array $reg_row is the row from the database's wp_esp_registration table
-         */
-        $updated_row = apply_filters(
-            'FHEE__EE_Export__report_registrations__reg_csv_array',
-            $new_csv_row,
-            $reg_row
-        );
-
-        // ok now we can revert to normal for EEH_Export::get_column_name_for_field().
-        remove_filter(
-            'FHEE__EEH_Export__get_column_name_for_field__add_field_name',
-            '__return_true',
-            777
-        );
-
-        // great. Now that the old filters are done, we can remove the ugly square brackets from column headers/labels.
-        $updated_and_restored_row = array();
-        foreach ($updated_row as $label => $value) {
-            $matches = array();
-            if (preg_match(
-                    '~([^\[]*)\[(.*)\]~',
-                    $label,
-                    $matches
-                )
-                && isset(
-                    $matches[0],
-                    $matches[1],
-                    $matches[2]
-                )
-            ) {
-                $label = $matches[1];
-            }
-            $updated_and_restored_row[$label] = $value;
-        }
-        $csv_row_data = $updated_and_restored_row;
-    }
-    return $csv_row_data;
+	// no need for all this if nobody is using the deprecated filter
+	if (has_filter('FHEE__EE_Export__report_registrations__reg_csv_array')) {
+		EE_Error::doing_it_wrong(
+			__FUNCTION__,
+			sprintf(
+				// EE_Error::doing_it_wrong with escape HTML, so don't escape it twice by doing it here too.
+				_x(
+					'The filter "%1$s" has been deprecated. Please use "%2$s" instead.',
+					'The filter "FHEE__EE_Export__report_registrations__reg_csv_array" has been deprecated. Please use "FHEE__EventEspressoBatchRequest__JobHandlers__RegistrationsReport__reg_csv_array" instead.',
+					'event_espresso'
+				),
+				'FHEE__EE_Export__report_registrations__reg_csv_array',
+				'FHEE__EventEspressoBatchRequest__JobHandlers__RegistrationsReport__reg_csv_array'
+			),
+			'4.9.69.p',
+			'4.9.75.p'
+		);
+		// there's code that expected the old csv column headers/labels. Let's oblige. Put it back in the old format!
+		// first: what model fields might be used as column headers? (whose format we need to change)
+		$model_fields = array_merge(
+			EEM_Registration::instance()->field_settings(),
+			EEM_Attendee::instance()->field_settings()
+		);
+		// create an array that uses the legacy column headers/labels.
+		$new_csv_row = array();
+		foreach ($csv_row_data as $label => $value) {
+			$new_label = $label;
+			foreach ($model_fields as $field) {
+				if ($label === EEH_Export::get_column_name_for_field($field)) {
+					// re-add the old field name
+					$new_label = $label . '[' . $field->get_name() . ']';
+					break;
+				}
+			}
+			$new_csv_row[$new_label] = $value;
+		}
+		// before we run it through the deprecated filter, set the method `EEH_Export::get_column_name_for_field()`
+		// to create the old column names, because that's what's in the row temporarily
+		add_filter(
+			'FHEE__EEH_Export__get_column_name_for_field__add_field_name',
+			'__return_true',
+			777
+		);
+		// now, those old filters can be run on this data. Have fun!
+		/**
+		 * Deprecated. Use FHEE__EventEspressoBatchRequest__JobHandlers__RegistrationsReport__reg_csv_array instead.
+		 *
+		 * Filter to change the contents of each row of the registrations report CSV file.
+		 * This can be used to add or remote columns from the CSV file, or change their values.                 *
+		 * Note: it has this name because originally that's where this filter resided,
+		 * and we've left its name as-is for backward compatibility.
+		 * Note when using: all rows in the CSV should have the same columns.
+		 *
+		 * @param array $reg_csv_array keys are column-header names, and values are that columns' value
+		 *                             in this row
+		 * @param array $reg_row is the row from the database's wp_esp_registration table
+		 */
+		$updated_row = apply_filters(
+			'FHEE__EE_Export__report_registrations__reg_csv_array',
+			$new_csv_row,
+			$reg_row
+		);
+
+		// ok now we can revert to normal for EEH_Export::get_column_name_for_field().
+		remove_filter(
+			'FHEE__EEH_Export__get_column_name_for_field__add_field_name',
+			'__return_true',
+			777
+		);
+
+		// great. Now that the old filters are done, we can remove the ugly square brackets from column headers/labels.
+		$updated_and_restored_row = array();
+		foreach ($updated_row as $label => $value) {
+			$matches = array();
+			if (preg_match(
+					'~([^\[]*)\[(.*)\]~',
+					$label,
+					$matches
+				)
+				&& isset(
+					$matches[0],
+					$matches[1],
+					$matches[2]
+				)
+			) {
+				$label = $matches[1];
+			}
+			$updated_and_restored_row[$label] = $value;
+		}
+		$csv_row_data = $updated_and_restored_row;
+	}
+	return $csv_row_data;
 }

Spacing +30 added lines, -30 removed lines

@@ -86,20 +86,20 @@ 
     // loop thru and call doing_it_wrong() or remove any that aren't being used
     foreach ($deprecated_filters as $deprecated_filter => $on) {
         // was this filter called ?
-        if (has_action('FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__' . $deprecated_filter)) {
+        if (has_action('FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__'.$deprecated_filter)) {
             // only display doing_it_wrong() notice to Event Admins during non-AJAX requests
             if (EE_Registry::instance()->CAP->current_user_can(
                     'ee_read_ee',
                     'hide_doing_it_wrong_for_deprecated_SPCO_filter'
                 ) && ! defined('DOING_AJAX')) {
                 EE_Error::doing_it_wrong(
-                    'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__' . $deprecated_filter,
+                    'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__'.$deprecated_filter,
                     sprintf(
                         esc_html__(
                             'The %1$s filter is deprecated.  It *may* work as an attempt to build in backwards compatibility.  However, it is recommended to use the following new filter: %2$s"%3$s" found in "%4$s"',
                             'event_espresso'
                         ),
-                        'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__' . $deprecated_filter,
+                        'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__'.$deprecated_filter,
                         '<br />',
                         'FHEE__EE_SPCO_Reg_Step__set_submit_button_text___submit_button_text',
                         '/modules/single_page_checkout/inc/EE_SPCO_Reg_Step.class.php'
@@ -108,10 +108,10 @@ 
                 );
             }
         } else {
-            unset($deprecated_filters[ $deprecated_filter ]);
+            unset($deprecated_filters[$deprecated_filter]);
         }
     }
-    if (! empty($deprecated_filters)) {
+    if ( ! empty($deprecated_filters)) {
 
         if ($checkout->current_step->slug(
             ) == 'attendee_information' && $checkout->revisit && isset($deprecated_filters['update_registration_details'])) {
@@ -145,7 +145,7 @@ 
                 $submit_button_text = apply_filters(
                                           'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__proceed_to',
                                           $submit_button_text
-                                      ) . $checkout->next_step->name();
+                                      ).$checkout->next_step->name();
             }
         }
 
@@ -329,7 +329,7 @@ 
             'event_espresso'
         );
         EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
+            __CLASS__.'::'.__FUNCTION__,
             $msg,
             '4.8.32.rc.000'
         );
@@ -356,7 +356,7 @@ 
 function ee_deprecated_update_attendee_registration_form_old($admin_page)
 {
     // check if the old hooks are in use. If not, do the default
-    if (! ee_deprecated_using_old_registration_admin_custom_questions_form_hooks()
+    if ( ! ee_deprecated_using_old_registration_admin_custom_questions_form_hooks()
         || ! $admin_page instanceof EE_Admin_Page) {
         return;
     }
@@ -364,7 +364,7 @@ 
     $qstns = isset($req_data['qstn']) ? $req_data['qstn'] : false;
     $REG_ID = isset($req_data['_REG_ID']) ? absint($req_data['_REG_ID']) : false;
     $qstns = apply_filters('FHEE__Registrations_Admin_Page___update_attendee_registration_form__qstns', $qstns);
-    if (! $REG_ID || ! $qstns) {
+    if ( ! $REG_ID || ! $qstns) {
         EE_Error::add_error(
             esc_html__('An error occurred. No registration ID and/or registration questions were received.', 'event_espresso'),
             __FILE__,
@@ -384,13 +384,13 @@ 
 
     foreach ($qstns as $QST_ID => $qstn) {
         // if $qstn isn't an array then it doesn't already have an answer, so let's create the answer
-        if (! is_array($qstn)) {
+        if ( ! is_array($qstn)) {
             $set_values = [
                 'QST_ID'    => $QST_ID,
                 'REG_ID'    => $REG_ID,
                 'ANS_value' => $qstn,
             ];
-            $success    = EEM_Answer::instance()->insert($set_values);
+            $success = EEM_Answer::instance()->insert($set_values);
             continue;
         }
 
@@ -406,7 +406,7 @@ 
             );
             $answer = EEM_Answer::instance()->get_one($query_params);
             // this MAY be an array but NOT have an answer because its multi select.  If so then we need to create the answer
-            if (! $answer instanceof EE_Answer) {
+            if ( ! $answer instanceof EE_Answer) {
                 $set_values = array(
                     'QST_ID'    => $QST_ID,
                     'REG_ID'    => $REG_ID,
@@ -447,7 +447,7 @@ 
 function ee_deprecated_reg_questions_meta_box_old($do_default_action, $admin_page, $registration)
 {
     // check if the old hooks are in use. If not, do the default
-    if (! ee_deprecated_using_old_registration_admin_custom_questions_form_hooks()
+    if ( ! ee_deprecated_using_old_registration_admin_custom_questions_form_hooks()
         || ! $admin_page instanceof EE_Admin_Page) {
         return $do_default_action;
     }
@@ -479,7 +479,7 @@ 
         'reg_questions_form_action' => 'edit_registration',
         'REG_ID'                    => $registration->ID(),
     );
-    $template_path = REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_reg_questions.template.php';
+    $template_path = REG_TEMPLATE_PATH.'reg_admin_details_main_meta_box_reg_questions.template.php';
     echo EEH_Template::display_template($template_path, $template_args, true);
     // indicate that we should not do the default admin page code
     return false;
@@ -597,7 +597,7 @@ 
     public function _class_is_deprecated($method)
     {
         EE_Error::doing_it_wrong(
-            'EE_messages::' . $method,
+            'EE_messages::'.$method,
             esc_html__('EE_messages has been deprecated.  Please use EE_Message_Resource_Manager instead.'),
             '4.9.0',
             '4.10.0.p'
@@ -736,7 +736,7 @@ 
         $error = false;
         // try to intelligently determine what method we'll call based on the incoming data.
         // if generating and sending are different then generate and send immediately.
-        if (! empty($sending_messenger) && $sending_messenger != $generating_messenger && $send) {
+        if ( ! empty($sending_messenger) && $sending_messenger != $generating_messenger && $send) {
             // in the legacy system, when generating and sending were different, that means all the
             // vars are already in the request object.  So let's just use that.
             try {
@@ -749,7 +749,7 @@ 
                     'event_espresso'
                 );
                 // add specific message for developers if WP_DEBUG in on
-                $error_msg .= '||' . $e->getMessage();
+                $error_msg .= '||'.$e->getMessage();
                 EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
                 $error = true;
             }
@@ -823,7 +823,7 @@ 
             }
         }
         // if no error then return the generated message(s).
-        if (! $error && ! $send) {
+        if ( ! $error && ! $send) {
             $generated_queue = $processor->generate_queue(false);
             // get message and return.
             $generated_queue->get_message_repository()->rewind();
@@ -882,7 +882,7 @@ 
         /** @type EE_Messages_Queue $queue */
         $queue = EE_Registry::instance()->load_lib('Messages_Queue');
         // make sure we have a proper message object
-        if (! $message instanceof EE_Message && is_object($message) && isset($message->content)) {
+        if ( ! $message instanceof EE_Message && is_object($message) && isset($message->content)) {
             $msg = EE_Message_Factory::create(
                 array(
                     'MSG_messenger'    => $messenger,
@@ -894,11 +894,11 @@ 
         } else {
             $msg = $message;
         }
-        if (! $msg instanceof EE_Message) {
+        if ( ! $msg instanceof EE_Message) {
             return false;
         }
         // make sure any content in a content property (if not empty) is set on the MSG_content.
-        if (! empty($msg->content)) {
+        if ( ! empty($msg->content)) {
             $msg->set('MSG_content', $msg->content);
         }
         $queue->add($msg);
@@ -1137,8 +1137,8 @@ 
 
 add_filter(
     'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__css',
-    function ($event_list_iframe_css) {
-        if (! has_filter('FHEE__EventsArchiveIframe__event_list_iframe__css')) {
+    function($event_list_iframe_css) {
+        if ( ! has_filter('FHEE__EventsArchiveIframe__event_list_iframe__css')) {
             return $event_list_iframe_css;
         }
         deprecated_espresso_action_or_filter_doing_it_wrong(
@@ -1157,8 +1157,8 @@ 
 );
 add_filter(
     'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__js',
-    function ($event_list_iframe_js) {
-        if (! has_filter('FHEE__EED_Ticket_Selector__ticket_selector_iframe__js')) {
+    function($event_list_iframe_js) {
+        if ( ! has_filter('FHEE__EED_Ticket_Selector__ticket_selector_iframe__js')) {
             return $event_list_iframe_js;
         }
         deprecated_espresso_action_or_filter_doing_it_wrong(
@@ -1177,8 +1177,8 @@ 
 );
 add_action(
     'AHEE__EE_Capabilities__addCaps__complete',
-    function ($capabilities_map) {
-        if (! has_action('AHEE__EE_Capabilities__init_role_caps__complete')) {
+    function($capabilities_map) {
+        if ( ! has_action('AHEE__EE_Capabilities__init_role_caps__complete')) {
             return;
         }
         deprecated_espresso_action_or_filter_doing_it_wrong(
@@ -1198,7 +1198,7 @@ 
 add_filter(
     'FHEE_EventEspresso_core_domain_services_commands_attendee_CreateAttendeeCommandHandler__findExistingAttendee__existing_attendee',
     function($existing_attendee, $registration, $attendee_data) {
-        if ( ! has_filter( 'FHEE_EE_Single_Page_Checkout__save_registration_items__find_existing_attendee' )) {
+        if ( ! has_filter('FHEE_EE_Single_Page_Checkout__save_registration_items__find_existing_attendee')) {
             return $existing_attendee;
         }
         deprecated_espresso_action_or_filter_doing_it_wrong(
@@ -1281,7 +1281,7 @@ 
      */
     public function event_list_title($event_list_title = '')
     {
-        if (! empty($this->title)) {
+        if ( ! empty($this->title)) {
             return $this->title;
         }
         return $event_list_title;
@@ -1441,7 +1441,7 @@ 
             foreach ($model_fields as $field) {
                 if ($label === EEH_Export::get_column_name_for_field($field)) {
                     // re-add the old field name
-                    $new_label = $label . '[' . $field->get_name() . ']';
+                    $new_label = $label.'['.$field->get_name().']';
                     break;
                 }
             }

payment_methods/Paypal_Standard/EEG_Paypal_Standard.gateway.php

Indentation +600 added lines, -600 removed lines

@@ -18,605 +18,605 @@
  */
 class EEG_Paypal_Standard extends EE_Offsite_Gateway
 {
-    /**
-     * Name for the wp option used to save the itemized payment
-     */
-    const itemized_payment_option_name = '_itemized_payment';
-
-    protected $_paypal_id;
-
-    protected $_image_url;
-
-    protected $_shipping_details;
-
-    protected $_paypal_shipping;
-
-    protected $_paypal_taxes;
-
-    protected $_gateway_url;
-
-    protected $_currencies_supported = array(
-        'USD',
-        'GBP',
-        'CAD',
-        'AUD',
-        'BRL',
-        'CHF',
-        'CZK',
-        'DKK',
-        'EUR',
-        'HKD',
-        'HUF',
-        'ILS',
-        'JPY',
-        'MXN',
-        'MYR',
-        'NOK',
-        'NZD',
-        'PHP',
-        'PLN',
-        'SEK',
-        'SGD',
-        'THB',
-        'TRY',
-        'TWD',
-        'RUB'
-    );
-
-
-    /**
-     * EEG_Paypal_Standard constructor.
-     *
-     * @return EEG_Paypal_Standard
-     */
-    public function __construct()
-    {
-        $this->set_uses_separate_IPN_request(true);
-        parent::__construct();
-    }
-
-
-    /**
-     * Also sets the gateway url class variable based on whether debug mode is enabled or not.
-     *
-     * @param array $settings_array
-     */
-    public function set_settings($settings_array)
-    {
-        parent::set_settings($settings_array);
-        $this->_gateway_url = $this->_debug_mode
-            ? 'https://www.sandbox.paypal.com/cgi-bin/webscr'
-            : 'https://www.paypal.com/cgi-bin/webscr';
-    }
-
-
-    /**
-     * @param EEI_Payment $payment      the payment to process
-     * @param array       $billing_info but should be empty for this gateway
-     * @param string      $return_url   URL to send the user to after payment on the payment provider's website
-     * @param string      $notify_url   URL to send the instant payment notification
-     * @param string      $cancel_url   URL to send the user to after a cancelled payment attempt
-     *                                  on the payment provider's website
-     * @return EEI_Payment
-     * @throws \EE_Error
-     */
-    public function set_redirection_info(
-        $payment,
-        $billing_info = array(),
-        $return_url = null,
-        $notify_url = null,
-        $cancel_url = null
-    ) {
-        $redirect_args = array();
-        $transaction = $payment->transaction();
-        $gateway_formatter = $this->_get_gateway_formatter();
-        $item_num = 1;
-        /** @type EE_Line_Item $total_line_item */
-        $total_line_item = $transaction->total_line_item();
-
-        $total_discounts_to_cart_total = $transaction->paid();
-        // only itemize the order if we're paying for the rest of the order's amount
-        if (EEH_Money::compare_floats($payment->amount(), $transaction->total(), '==')) {
-            $payment->update_extra_meta(EEG_Paypal_Standard::itemized_payment_option_name, true);
-            // this payment is for the remaining transaction amount,
-            // keep track of exactly how much the itemized order amount equals
-            $itemized_sum = 0;
-            $shipping_previously_added = 0;
-            // so let's show all the line items
-            foreach ($total_line_item->get_items() as $line_item) {
-                if ($line_item instanceof EE_Line_Item) {
-                    // it's some kind of discount
-                    if ($line_item->total() < 0) {
-                        $total_discounts_to_cart_total += abs($line_item->total());
-                        $itemized_sum += $line_item->total();
-                        continue;
-                    }
-                    // dont include shipping again.
-                    if (strpos($line_item->code(), 'paypal_shipping_') === 0) {
-                        $shipping_previously_added = $line_item->total();
-                        continue;
-                    }
-                    $redirect_args[ 'item_name_' . $item_num ] = substr(
-                        $gateway_formatter->formatLineItemName($line_item, $payment),
-                        0,
-                        127
-                    );
-                    $redirect_args[ 'amount_' . $item_num ] = $line_item->unit_price();
-                    $redirect_args[ 'quantity_' . $item_num ] = $line_item->quantity();
-                    // if we're not letting PayPal calculate shipping, tell them its 0
-                    if (! $this->_paypal_shipping) {
-                        $redirect_args[ 'shipping_' . $item_num ] = '0';
-                        $redirect_args[ 'shipping2_' . $item_num ] = '0';
-                    }
-                    $item_num++;
-                    $itemized_sum += $line_item->total();
-                }
-            }
-            $taxes_li = $this->_line_item->get_taxes_subtotal($total_line_item);
-            // ideally itemized sum equals the transaction total. but if not (which is weird)
-            // and the itemized sum is LESS than the transaction total
-            // add another line item
-            // if the itemized sum is MORE than the transaction total,
-            // add the difference it to the discounts
-            $itemized_sum_diff_from_txn_total = round(
-                $transaction->total() - $itemized_sum - $taxes_li->total() - $shipping_previously_added,
-                2
-            );
-            if ($itemized_sum_diff_from_txn_total < 0) {
-                // itemized sum is too big
-                $total_discounts_to_cart_total += abs($itemized_sum_diff_from_txn_total);
-            } elseif ($itemized_sum_diff_from_txn_total > 0) {
-                $redirect_args[ 'item_name_' . $item_num ] = substr(
-                    esc_html__('Other charges', 'event_espresso'),
-                    0,
-                    127
-                );
-                $redirect_args[ 'amount_' . $item_num ] = $gateway_formatter->formatCurrency(
-                    $itemized_sum_diff_from_txn_total
-                );
-                $redirect_args[ 'quantity_' . $item_num ] = 1;
-                $item_num++;
-            }
-            if ($total_discounts_to_cart_total > 0) {
-                $redirect_args['discount_amount_cart'] = $gateway_formatter->formatCurrency(
-                    $total_discounts_to_cart_total
-                );
-            }
-            // add our taxes to the order if we're NOT using PayPal's
-            if (! $this->_paypal_taxes) {
-                $redirect_args['tax_cart'] = $total_line_item->get_total_tax();
-            }
-        } else {
-            $payment->update_extra_meta(EEG_Paypal_Standard::itemized_payment_option_name, false);
-            // partial payment that's not for the remaining amount, so we can't send an itemized list
-            $redirect_args[ 'item_name_' . $item_num ] = substr(
-                $gateway_formatter->formatPartialPaymentLineItemName($payment),
-                0,
-                127
-            );
-            $redirect_args[ 'amount_' . $item_num ] = $payment->amount();
-            $redirect_args[ 'shipping_' . $item_num ] = '0';
-            $redirect_args[ 'shipping2_' . $item_num ] = '0';
-            $redirect_args['tax_cart'] = '0';
-            $item_num++;
-        }
-
-        if ($this->_debug_mode) {
-            $redirect_args[ 'item_name_' . $item_num ] = 'DEBUG INFO (this item only added in sandbox mode';
-            $redirect_args[ 'amount_' . $item_num ] = 0;
-            $redirect_args[ 'on0_' . $item_num ] = 'NOTIFY URL';
-            $redirect_args[ 'os0_' . $item_num ] = $notify_url;
-            $redirect_args[ 'on1_' . $item_num ] = 'RETURN URL';
-            $redirect_args[ 'os1_' . $item_num ] = $return_url;
+	/**
+	 * Name for the wp option used to save the itemized payment
+	 */
+	const itemized_payment_option_name = '_itemized_payment';
+
+	protected $_paypal_id;
+
+	protected $_image_url;
+
+	protected $_shipping_details;
+
+	protected $_paypal_shipping;
+
+	protected $_paypal_taxes;
+
+	protected $_gateway_url;
+
+	protected $_currencies_supported = array(
+		'USD',
+		'GBP',
+		'CAD',
+		'AUD',
+		'BRL',
+		'CHF',
+		'CZK',
+		'DKK',
+		'EUR',
+		'HKD',
+		'HUF',
+		'ILS',
+		'JPY',
+		'MXN',
+		'MYR',
+		'NOK',
+		'NZD',
+		'PHP',
+		'PLN',
+		'SEK',
+		'SGD',
+		'THB',
+		'TRY',
+		'TWD',
+		'RUB'
+	);
+
+
+	/**
+	 * EEG_Paypal_Standard constructor.
+	 *
+	 * @return EEG_Paypal_Standard
+	 */
+	public function __construct()
+	{
+		$this->set_uses_separate_IPN_request(true);
+		parent::__construct();
+	}
+
+
+	/**
+	 * Also sets the gateway url class variable based on whether debug mode is enabled or not.
+	 *
+	 * @param array $settings_array
+	 */
+	public function set_settings($settings_array)
+	{
+		parent::set_settings($settings_array);
+		$this->_gateway_url = $this->_debug_mode
+			? 'https://www.sandbox.paypal.com/cgi-bin/webscr'
+			: 'https://www.paypal.com/cgi-bin/webscr';
+	}
+
+
+	/**
+	 * @param EEI_Payment $payment      the payment to process
+	 * @param array       $billing_info but should be empty for this gateway
+	 * @param string      $return_url   URL to send the user to after payment on the payment provider's website
+	 * @param string      $notify_url   URL to send the instant payment notification
+	 * @param string      $cancel_url   URL to send the user to after a cancelled payment attempt
+	 *                                  on the payment provider's website
+	 * @return EEI_Payment
+	 * @throws \EE_Error
+	 */
+	public function set_redirection_info(
+		$payment,
+		$billing_info = array(),
+		$return_url = null,
+		$notify_url = null,
+		$cancel_url = null
+	) {
+		$redirect_args = array();
+		$transaction = $payment->transaction();
+		$gateway_formatter = $this->_get_gateway_formatter();
+		$item_num = 1;
+		/** @type EE_Line_Item $total_line_item */
+		$total_line_item = $transaction->total_line_item();
+
+		$total_discounts_to_cart_total = $transaction->paid();
+		// only itemize the order if we're paying for the rest of the order's amount
+		if (EEH_Money::compare_floats($payment->amount(), $transaction->total(), '==')) {
+			$payment->update_extra_meta(EEG_Paypal_Standard::itemized_payment_option_name, true);
+			// this payment is for the remaining transaction amount,
+			// keep track of exactly how much the itemized order amount equals
+			$itemized_sum = 0;
+			$shipping_previously_added = 0;
+			// so let's show all the line items
+			foreach ($total_line_item->get_items() as $line_item) {
+				if ($line_item instanceof EE_Line_Item) {
+					// it's some kind of discount
+					if ($line_item->total() < 0) {
+						$total_discounts_to_cart_total += abs($line_item->total());
+						$itemized_sum += $line_item->total();
+						continue;
+					}
+					// dont include shipping again.
+					if (strpos($line_item->code(), 'paypal_shipping_') === 0) {
+						$shipping_previously_added = $line_item->total();
+						continue;
+					}
+					$redirect_args[ 'item_name_' . $item_num ] = substr(
+						$gateway_formatter->formatLineItemName($line_item, $payment),
+						0,
+						127
+					);
+					$redirect_args[ 'amount_' . $item_num ] = $line_item->unit_price();
+					$redirect_args[ 'quantity_' . $item_num ] = $line_item->quantity();
+					// if we're not letting PayPal calculate shipping, tell them its 0
+					if (! $this->_paypal_shipping) {
+						$redirect_args[ 'shipping_' . $item_num ] = '0';
+						$redirect_args[ 'shipping2_' . $item_num ] = '0';
+					}
+					$item_num++;
+					$itemized_sum += $line_item->total();
+				}
+			}
+			$taxes_li = $this->_line_item->get_taxes_subtotal($total_line_item);
+			// ideally itemized sum equals the transaction total. but if not (which is weird)
+			// and the itemized sum is LESS than the transaction total
+			// add another line item
+			// if the itemized sum is MORE than the transaction total,
+			// add the difference it to the discounts
+			$itemized_sum_diff_from_txn_total = round(
+				$transaction->total() - $itemized_sum - $taxes_li->total() - $shipping_previously_added,
+				2
+			);
+			if ($itemized_sum_diff_from_txn_total < 0) {
+				// itemized sum is too big
+				$total_discounts_to_cart_total += abs($itemized_sum_diff_from_txn_total);
+			} elseif ($itemized_sum_diff_from_txn_total > 0) {
+				$redirect_args[ 'item_name_' . $item_num ] = substr(
+					esc_html__('Other charges', 'event_espresso'),
+					0,
+					127
+				);
+				$redirect_args[ 'amount_' . $item_num ] = $gateway_formatter->formatCurrency(
+					$itemized_sum_diff_from_txn_total
+				);
+				$redirect_args[ 'quantity_' . $item_num ] = 1;
+				$item_num++;
+			}
+			if ($total_discounts_to_cart_total > 0) {
+				$redirect_args['discount_amount_cart'] = $gateway_formatter->formatCurrency(
+					$total_discounts_to_cart_total
+				);
+			}
+			// add our taxes to the order if we're NOT using PayPal's
+			if (! $this->_paypal_taxes) {
+				$redirect_args['tax_cart'] = $total_line_item->get_total_tax();
+			}
+		} else {
+			$payment->update_extra_meta(EEG_Paypal_Standard::itemized_payment_option_name, false);
+			// partial payment that's not for the remaining amount, so we can't send an itemized list
+			$redirect_args[ 'item_name_' . $item_num ] = substr(
+				$gateway_formatter->formatPartialPaymentLineItemName($payment),
+				0,
+				127
+			);
+			$redirect_args[ 'amount_' . $item_num ] = $payment->amount();
+			$redirect_args[ 'shipping_' . $item_num ] = '0';
+			$redirect_args[ 'shipping2_' . $item_num ] = '0';
+			$redirect_args['tax_cart'] = '0';
+			$item_num++;
+		}
+
+		if ($this->_debug_mode) {
+			$redirect_args[ 'item_name_' . $item_num ] = 'DEBUG INFO (this item only added in sandbox mode';
+			$redirect_args[ 'amount_' . $item_num ] = 0;
+			$redirect_args[ 'on0_' . $item_num ] = 'NOTIFY URL';
+			$redirect_args[ 'os0_' . $item_num ] = $notify_url;
+			$redirect_args[ 'on1_' . $item_num ] = 'RETURN URL';
+			$redirect_args[ 'os1_' . $item_num ] = $return_url;
 //          $redirect_args['option_index_' . $item_num] = 1; // <-- dunno if this is needed ?
-            $redirect_args[ 'shipping_' . $item_num ] = '0';
-            $redirect_args[ 'shipping2_' . $item_num ] = '0';
-        }
-
-        $redirect_args['business'] = $this->_paypal_id;
-        $redirect_args['return'] = $return_url;
-        $redirect_args['cancel_return'] = $cancel_url;
-        $redirect_args['notify_url'] = $notify_url;
-        $redirect_args['cmd'] = '_cart';
-        $redirect_args['upload'] = 1;
-        $redirect_args['currency_code'] = $payment->currency_code();
-        $redirect_args['rm'] = 2;// makes the user return with method=POST
-        if ($this->_image_url) {
-            $redirect_args['image_url'] = $this->_image_url;
-        }
-        $redirect_args['no_shipping'] = $this->_shipping_details;
-        $redirect_args['bn'] = 'EventEspresso_SP';// EE will blow up if you change this
-
-        $redirect_args = apply_filters("FHEE__EEG_Paypal_Standard__set_redirection_info__arguments", $redirect_args, $this);
-
-        $payment->set_redirect_url($this->_gateway_url);
-        $payment->set_redirect_args($redirect_args);
-        // log the results
-        $this->log(
-            array(
-                'message'     => sprintf(
-                    esc_html__('PayPal payment request initiated.', 'event_espresso')
-                ),
-                'transaction' => $transaction->model_field_array(),
-            ),
-            $payment
-        );
-        return $payment;
-    }
-
-
-    /**
-     * Often used for IPNs. But applies the info in $update_info to the payment.
-     * What is $update_info? Often the contents of $_REQUEST, but not necessarily. Whatever
-     * the payment method passes in.
-     *
-     * @param array $update_info like $_POST
-     * @param EEI_Transaction $transaction
-     * @return \EEI_Payment updated
-     * @throws \EE_Error, IpnException
-     */
-    public function handle_payment_update($update_info, $transaction)
-    {
-        // verify there's payment data that's been sent
-        if (empty($update_info['payment_status']) || empty($update_info['txn_id'])) {
-            // log the results
-            $this->log(
-                array(
-                    'message'     => sprintf(
-                        // @codingStandardsIgnoreStart
-                        esc_html__('PayPal IPN response is missing critical payment data. This may indicate a PDT request and require your PayPal account settings to be corrected.', 'event_espresso')
-                        // @codingStandardsIgnoreEnd
-                    ),
-                    'update_info' => $update_info,
-                ),
-                $transaction
-            );
-            // waaaait... is this a PDT request? (see https://developer.paypal.com/docs/classic/products/payment-data-transfer/)
-            // indicated by the "tx" argument? If so, we don't need it. We'll just use the IPN data when it comes
-            if (isset($update_info['tx'])) {
-                return $transaction->last_payment();
-            } else {
-                return null;
-            }
-        }
-        $payment = $this->_pay_model->get_payment_by_txn_id_chq_nmbr($update_info['txn_id']);
-        if (! $payment instanceof EEI_Payment) {
-            $payment = $transaction->last_payment();
-        }
-        // ok, then validate the IPN. Even if we've already processed this payment,
-        // let PayPal know we don't want to hear from them anymore!
-        if (! $this->validate_ipn($update_info, $payment)) {
-            return $payment;
-        }
-        // kill request here if this is a refund, we don't support them yet (we'd need to adjust the transaction,
-        // registrations, ticket counts, etc)
-        if (
-            (
-                $update_info['payment_status'] === 'Refunded'
-                || $update_info['payment_status'] === 'Partially_Refunded'
-            )
-            && apply_filters('FHEE__EEG_Paypal_Standard__handle_payment_update__kill_refund_request', true)
-        ) {
-            throw new EventEspresso\core\exceptions\IpnException(
-                sprintf(
-                    esc_html__('Event Espresso does not yet support %1$s IPNs from PayPal', 'event_espresso'),
-                    $update_info['payment_status']
-                ),
-                EventEspresso\core\exceptions\IpnException::UNSUPPORTED,
-                null,
-                $payment,
-                $update_info
-            );
-        }
-        // ok, well let's process this payment then!
-        switch ($update_info['payment_status']) {
-            case 'Completed':
-                $status = $this->_pay_model->approved_status();
-                $gateway_response = esc_html__('The payment is approved.', 'event_espresso');
-                break;
-
-            case 'Pending':
-                $status = $this->_pay_model->pending_status();
-                $gateway_response = esc_html__(
-                    'The payment is in progress. Another message will be sent when payment is approved.',
-                    'event_espresso'
-                );
-                break;
-
-            case 'Denied':
-                $status = $this->_pay_model->declined_status();
-                $gateway_response = esc_html__('The payment has been declined.', 'event_espresso');
-                break;
-
-            case 'Expired':
-            case 'Failed':
-                $status = $this->_pay_model->failed_status();
-                $gateway_response = esc_html__('The payment failed for technical reasons or expired.', 'event_espresso');
-                break;
-
-            case 'Refunded':
-            case 'Partially_Refunded':
-                // even though it's a refund, we consider the payment as approved, it just has a negative value
-                $status = $this->_pay_model->approved_status();
-                $gateway_response = esc_html__(
-                    'The payment has been refunded. Please update registrations accordingly.',
-                    'event_espresso'
-                );
-                break;
-
-            case 'Voided':
-            case 'Reversed':
-            case 'Canceled_Reversal':
-            default:
-                $status = $this->_pay_model->cancelled_status();
-                $gateway_response = esc_html__(
-                    'The payment was cancelled, reversed, or voided. Please update registrations accordingly.',
-                    'event_espresso'
-                );
-                break;
-        }
-
-        // check if we've already processed this payment
-        if ($payment instanceof EEI_Payment) {
-            // payment exists. if this has the exact same status and amount, don't bother updating. just return
-            if ($payment->status() === $status && (float) $payment->amount() === (float) $update_info['mc_gross']) {
-                // DUPLICATED IPN! don't bother updating transaction
-                throw new IpnException(
-                    sprintf(
-                        esc_html__(
-                            'It appears we have received a duplicate IPN from PayPal for payment %d',
-                            'event_espresso'
-                        ),
-                        $payment->ID()
-                    ),
-                    IpnException::DUPLICATE,
-                    null,
-                    $payment,
-                    $update_info
-                );
-            } else {
-                // new payment yippee !!!
-                $payment->set_status($status);
-                $payment->set_amount((float) $update_info['mc_gross']);
-                $payment->set_gateway_response($gateway_response);
-                $payment->set_details($update_info);
-                $payment->set_txn_id_chq_nmbr($update_info['txn_id']);
-                $this->log(
-                    array(
-                        'message'  => esc_html__(
-                            'Updated payment either from IPN or as part of POST from PayPal',
-                            'event_espresso'
-                        ),
-                        'url'      => $this->_process_response_url(),
-                        'payment'  => $payment->model_field_array(),
-                        'IPN_data' => $update_info
-                    ),
-                    $payment
-                );
-            }
-        }
-        do_action('FHEE__EEG_Paypal_Standard__handle_payment_update__payment_processed', $payment, $this);
-        return $payment;
-    }
-
-
-    /**
-     * Validate the IPN notification.
-     *
-     * @param array                  $update_info like $_REQUEST
-     * @param EE_Payment|EEI_Payment $payment
-     * @return boolean
-     * @throws \EE_Error
-     */
-    public function validate_ipn($update_info, $payment)
-    {
-        // allow us to skip validating IPNs with PayPal (useful for testing)
-        if (apply_filters('FHEE__EEG_Paypal_Standard__validate_ipn__skip', false)) {
-            return true;
-        }
-        // ...otherwise, we actually don't care what the $update_info is, we need to look
-        // at the request directly because we can't use $update_info because it has issues with quotes
-        // Reading POSTed data directly from $_POST causes serialization issues with array data in the POST.
-        // Instead, read raw POST data from the input stream.
-        // @see https://gist.github.com/xcommerce-gists/3440401
-        $raw_post_data = file_get_contents('php://input');
-        $raw_post_array = explode('&', $raw_post_data);
-        $update_info = array();
-        foreach ($raw_post_array as $keyval) {
-            $keyval = explode('=', $keyval);
-            if (count($keyval) === 2) {
-                $update_info[ $keyval[0] ] = urldecode($keyval[1]);
-            }
-        }
-        // read the IPN message sent from PayPal and prepend 'cmd=_notify-validate'
-        $req = 'cmd=_notify-validate';
-        foreach ($update_info as $key => $value) {
-            $value = urlencode($value);
-            $req .= "&$key=$value";
-        }
-        // HTTP POST the complete, unaltered IPN back to PayPal
-        $response = wp_remote_post(
-            $this->_gateway_url,
-            array(
-                'body'              => $req,
-                'sslverify'         => false,
-                'timeout'           => 60,
-                // make sure to set a site specific unique "user-agent" string since the WordPres default gets declined by PayPal
-                // plz see: https://github.com/websharks/s2member/issues/610
-                'user-agent'        => 'Event Espresso v' . EVENT_ESPRESSO_VERSION . '; ' . home_url(),
-                'httpversion'       => '1.1'
-            )
-        );
-        // then check the response
-        if (
-            array_key_exists('body', $response)
-            && ! is_wp_error($response)
-            && strcmp($response['body'], "VERIFIED") === 0
-        ) {
-            return true;
-        }
-        // huh, something's wack... the IPN didn't validate. We must have replied to the IPN incorrectly,
-        // or their API must have changed: http://www.paypalobjects.com/en_US/ebook/PP_OrderManagement_IntegrationGuide/ipn.html
-        if ($response instanceof WP_Error) {
-            $error_msg = sprintf(
-                esc_html__('WP Error. Code: "%1$s", Message: "%2$s", Data: "%3$s"', 'event_espresso'),
-                $response->get_error_code(),
-                $response->get_error_message(),
-                print_r($response->get_error_data(), true)
-            );
-        } elseif (is_array($response) && isset($response['body'])) {
-            $error_msg = $response['body'];
-        } else {
-            $error_msg = print_r($response, true);
-        }
-        $payment->set_gateway_response(
-            sprintf(
-                esc_html__("IPN Validation failed! Paypal responded with '%s'", "event_espresso"),
-                $error_msg
-            )
-        );
-        $payment->set_details(array('REQUEST' => $update_info, 'VALIDATION_RESPONSE' => $response));
-        $payment->set_status(EEM_Payment::status_id_failed);
-        // log the results
-        $this->log(
-            array(
-                'url'     => $this->_process_response_url(),
-                'message' => $payment->gateway_response(),
-                'details' => $payment->details(),
-            ),
-            $payment
-        );
-        return false;
-    }
-
-
-    /**
-     * _process_response_url
-     * @return string
-     */
-    protected function _process_response_url()
-    {
-        if (isset($_SERVER['HTTP_HOST'], $_SERVER['REQUEST_URI'])) {
-            $url = is_ssl() ? 'https://' : 'http://';
-            $url .= EEH_URL::filter_input_server_url('HTTP_HOST');
-            $url .= EEH_URL::filter_input_server_url();
-        } else {
-            $url = 'unknown';
-        }
-        return $url;
-    }
-
-
-    /**
-     * Updates the transaction and line items based on the payment IPN data from PayPal,
-     * like the taxes or shipping
-     *
-     * @param EEI_Payment $payment
-     * @throws \EE_Error
-     */
-    public function update_txn_based_on_payment($payment)
-    {
-        $update_info = $payment->details();
-        /** @var EE_Transaction $transaction */
-        $transaction = $payment->transaction();
-        $payment_was_itemized = $payment->get_extra_meta(EEG_Paypal_Standard::itemized_payment_option_name, true, false);
-        if (! $transaction) {
-            $this->log(
-                esc_html__(
-                    // @codingStandardsIgnoreStart
-                    'Payment with ID %d has no related transaction, and so update_txn_based_on_payment couldn\'t be executed properly',
-                    // @codingStandardsIgnoreEnd
-                    'event_espresso'
-                ),
-                $payment
-            );
-            return;
-        }
-        if (
-            ! is_array($update_info)
-            || ! isset($update_info['mc_shipping'])
-            || ! isset($update_info['tax'])
-        ) {
-            $this->log(
-                array(
-                    'message' => esc_html__(
-                        // @codingStandardsIgnoreStart
-                        'Could not update transaction based on payment because the payment details have not yet been put on the payment. This normally happens during the IPN or returning from PayPal',
-                        // @codingStandardsIgnoreEnd
-                        'event_espresso'
-                    ),
-                    'url'     => $this->_process_response_url(),
-                    'payment' => $payment->model_field_array()
-                ),
-                $payment
-            );
-            return;
-        }
-        if ($payment->status() !== $this->_pay_model->approved_status()) {
-            $this->log(
-                array(
-                    'message' => esc_html__(
-                        'We shouldn\'t update transactions taxes or shipping data from non-approved payments',
-                        'event_espresso'
-                    ),
-                    'url'     => $this->_process_response_url(),
-                    'payment' => $payment->model_field_array()
-                ),
-                $payment
-            );
-            return;
-        }
-        $grand_total_needs_resaving = false;
-        /** @var EE_Line_Item $transaction_total_line_item */
-        $transaction_total_line_item = $transaction->total_line_item();
-
-        // might paypal have changed the taxes?
-        if ($this->_paypal_taxes && $payment_was_itemized) {
-            // note that we're doing this BEFORE adding shipping;
-            // we actually want PayPal's shipping to remain non-taxable
-            $this->_line_item->set_line_items_taxable($transaction_total_line_item, true, 'paypal_shipping');
-            $this->_line_item->set_total_tax_to(
-                $transaction_total_line_item,
-                (float) $update_info['tax'],
-                esc_html__('Taxes', 'event_espresso'),
-                esc_html__('Calculated by Paypal', 'event_espresso'),
-                'paypal_tax'
-            );
-            $grand_total_needs_resaving = true;
-        }
-
-        $shipping_amount = (float) $update_info['mc_shipping'];
-        // might paypal have added shipping?
-        if ($this->_paypal_shipping && $shipping_amount && $payment_was_itemized) {
-            $this->_line_item->add_unrelated_item(
-                $transaction_total_line_item,
-                sprintf(esc_html__('Shipping for transaction %1$s', 'event_espresso'), $transaction->ID()),
-                $shipping_amount,
-                esc_html__('Shipping charges calculated by Paypal', 'event_espresso'),
-                1,
-                false,
-                'paypal_shipping_' . $transaction->ID()
-            );
-            $grand_total_needs_resaving = true;
-        }
-
-        if ($grand_total_needs_resaving) {
-            $transaction_total_line_item->save_this_and_descendants_to_txn($transaction->ID());
-            /** @var EE_Registration_Processor $registration_processor */
-            $registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
-            $registration_processor->update_registration_final_prices($transaction);
-        }
-        $this->log(
-            array(
-                'message'                     => esc_html__('Updated transaction related to payment', 'event_espresso'),
-                'url'                         => $this->_process_response_url(),
-                'transaction (updated)'       => $transaction->model_field_array(),
-                'payment (updated)'           => $payment->model_field_array(),
-                'use_paypal_shipping'         => $this->_paypal_shipping,
-                'use_paypal_tax'              => $this->_paypal_taxes,
-                'grand_total_needed_resaving' => $grand_total_needs_resaving,
-            ),
-            $payment
-        );
-    }
+			$redirect_args[ 'shipping_' . $item_num ] = '0';
+			$redirect_args[ 'shipping2_' . $item_num ] = '0';
+		}
+
+		$redirect_args['business'] = $this->_paypal_id;
+		$redirect_args['return'] = $return_url;
+		$redirect_args['cancel_return'] = $cancel_url;
+		$redirect_args['notify_url'] = $notify_url;
+		$redirect_args['cmd'] = '_cart';
+		$redirect_args['upload'] = 1;
+		$redirect_args['currency_code'] = $payment->currency_code();
+		$redirect_args['rm'] = 2;// makes the user return with method=POST
+		if ($this->_image_url) {
+			$redirect_args['image_url'] = $this->_image_url;
+		}
+		$redirect_args['no_shipping'] = $this->_shipping_details;
+		$redirect_args['bn'] = 'EventEspresso_SP';// EE will blow up if you change this
+
+		$redirect_args = apply_filters("FHEE__EEG_Paypal_Standard__set_redirection_info__arguments", $redirect_args, $this);
+
+		$payment->set_redirect_url($this->_gateway_url);
+		$payment->set_redirect_args($redirect_args);
+		// log the results
+		$this->log(
+			array(
+				'message'     => sprintf(
+					esc_html__('PayPal payment request initiated.', 'event_espresso')
+				),
+				'transaction' => $transaction->model_field_array(),
+			),
+			$payment
+		);
+		return $payment;
+	}
+
+
+	/**
+	 * Often used for IPNs. But applies the info in $update_info to the payment.
+	 * What is $update_info? Often the contents of $_REQUEST, but not necessarily. Whatever
+	 * the payment method passes in.
+	 *
+	 * @param array $update_info like $_POST
+	 * @param EEI_Transaction $transaction
+	 * @return \EEI_Payment updated
+	 * @throws \EE_Error, IpnException
+	 */
+	public function handle_payment_update($update_info, $transaction)
+	{
+		// verify there's payment data that's been sent
+		if (empty($update_info['payment_status']) || empty($update_info['txn_id'])) {
+			// log the results
+			$this->log(
+				array(
+					'message'     => sprintf(
+						// @codingStandardsIgnoreStart
+						esc_html__('PayPal IPN response is missing critical payment data. This may indicate a PDT request and require your PayPal account settings to be corrected.', 'event_espresso')
+						// @codingStandardsIgnoreEnd
+					),
+					'update_info' => $update_info,
+				),
+				$transaction
+			);
+			// waaaait... is this a PDT request? (see https://developer.paypal.com/docs/classic/products/payment-data-transfer/)
+			// indicated by the "tx" argument? If so, we don't need it. We'll just use the IPN data when it comes
+			if (isset($update_info['tx'])) {
+				return $transaction->last_payment();
+			} else {
+				return null;
+			}
+		}
+		$payment = $this->_pay_model->get_payment_by_txn_id_chq_nmbr($update_info['txn_id']);
+		if (! $payment instanceof EEI_Payment) {
+			$payment = $transaction->last_payment();
+		}
+		// ok, then validate the IPN. Even if we've already processed this payment,
+		// let PayPal know we don't want to hear from them anymore!
+		if (! $this->validate_ipn($update_info, $payment)) {
+			return $payment;
+		}
+		// kill request here if this is a refund, we don't support them yet (we'd need to adjust the transaction,
+		// registrations, ticket counts, etc)
+		if (
+			(
+				$update_info['payment_status'] === 'Refunded'
+				|| $update_info['payment_status'] === 'Partially_Refunded'
+			)
+			&& apply_filters('FHEE__EEG_Paypal_Standard__handle_payment_update__kill_refund_request', true)
+		) {
+			throw new EventEspresso\core\exceptions\IpnException(
+				sprintf(
+					esc_html__('Event Espresso does not yet support %1$s IPNs from PayPal', 'event_espresso'),
+					$update_info['payment_status']
+				),
+				EventEspresso\core\exceptions\IpnException::UNSUPPORTED,
+				null,
+				$payment,
+				$update_info
+			);
+		}
+		// ok, well let's process this payment then!
+		switch ($update_info['payment_status']) {
+			case 'Completed':
+				$status = $this->_pay_model->approved_status();
+				$gateway_response = esc_html__('The payment is approved.', 'event_espresso');
+				break;
+
+			case 'Pending':
+				$status = $this->_pay_model->pending_status();
+				$gateway_response = esc_html__(
+					'The payment is in progress. Another message will be sent when payment is approved.',
+					'event_espresso'
+				);
+				break;
+
+			case 'Denied':
+				$status = $this->_pay_model->declined_status();
+				$gateway_response = esc_html__('The payment has been declined.', 'event_espresso');
+				break;
+
+			case 'Expired':
+			case 'Failed':
+				$status = $this->_pay_model->failed_status();
+				$gateway_response = esc_html__('The payment failed for technical reasons or expired.', 'event_espresso');
+				break;
+
+			case 'Refunded':
+			case 'Partially_Refunded':
+				// even though it's a refund, we consider the payment as approved, it just has a negative value
+				$status = $this->_pay_model->approved_status();
+				$gateway_response = esc_html__(
+					'The payment has been refunded. Please update registrations accordingly.',
+					'event_espresso'
+				);
+				break;
+
+			case 'Voided':
+			case 'Reversed':
+			case 'Canceled_Reversal':
+			default:
+				$status = $this->_pay_model->cancelled_status();
+				$gateway_response = esc_html__(
+					'The payment was cancelled, reversed, or voided. Please update registrations accordingly.',
+					'event_espresso'
+				);
+				break;
+		}
+
+		// check if we've already processed this payment
+		if ($payment instanceof EEI_Payment) {
+			// payment exists. if this has the exact same status and amount, don't bother updating. just return
+			if ($payment->status() === $status && (float) $payment->amount() === (float) $update_info['mc_gross']) {
+				// DUPLICATED IPN! don't bother updating transaction
+				throw new IpnException(
+					sprintf(
+						esc_html__(
+							'It appears we have received a duplicate IPN from PayPal for payment %d',
+							'event_espresso'
+						),
+						$payment->ID()
+					),
+					IpnException::DUPLICATE,
+					null,
+					$payment,
+					$update_info
+				);
+			} else {
+				// new payment yippee !!!
+				$payment->set_status($status);
+				$payment->set_amount((float) $update_info['mc_gross']);
+				$payment->set_gateway_response($gateway_response);
+				$payment->set_details($update_info);
+				$payment->set_txn_id_chq_nmbr($update_info['txn_id']);
+				$this->log(
+					array(
+						'message'  => esc_html__(
+							'Updated payment either from IPN or as part of POST from PayPal',
+							'event_espresso'
+						),
+						'url'      => $this->_process_response_url(),
+						'payment'  => $payment->model_field_array(),
+						'IPN_data' => $update_info
+					),
+					$payment
+				);
+			}
+		}
+		do_action('FHEE__EEG_Paypal_Standard__handle_payment_update__payment_processed', $payment, $this);
+		return $payment;
+	}
+
+
+	/**
+	 * Validate the IPN notification.
+	 *
+	 * @param array                  $update_info like $_REQUEST
+	 * @param EE_Payment|EEI_Payment $payment
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
+	public function validate_ipn($update_info, $payment)
+	{
+		// allow us to skip validating IPNs with PayPal (useful for testing)
+		if (apply_filters('FHEE__EEG_Paypal_Standard__validate_ipn__skip', false)) {
+			return true;
+		}
+		// ...otherwise, we actually don't care what the $update_info is, we need to look
+		// at the request directly because we can't use $update_info because it has issues with quotes
+		// Reading POSTed data directly from $_POST causes serialization issues with array data in the POST.
+		// Instead, read raw POST data from the input stream.
+		// @see https://gist.github.com/xcommerce-gists/3440401
+		$raw_post_data = file_get_contents('php://input');
+		$raw_post_array = explode('&', $raw_post_data);
+		$update_info = array();
+		foreach ($raw_post_array as $keyval) {
+			$keyval = explode('=', $keyval);
+			if (count($keyval) === 2) {
+				$update_info[ $keyval[0] ] = urldecode($keyval[1]);
+			}
+		}
+		// read the IPN message sent from PayPal and prepend 'cmd=_notify-validate'
+		$req = 'cmd=_notify-validate';
+		foreach ($update_info as $key => $value) {
+			$value = urlencode($value);
+			$req .= "&$key=$value";
+		}
+		// HTTP POST the complete, unaltered IPN back to PayPal
+		$response = wp_remote_post(
+			$this->_gateway_url,
+			array(
+				'body'              => $req,
+				'sslverify'         => false,
+				'timeout'           => 60,
+				// make sure to set a site specific unique "user-agent" string since the WordPres default gets declined by PayPal
+				// plz see: https://github.com/websharks/s2member/issues/610
+				'user-agent'        => 'Event Espresso v' . EVENT_ESPRESSO_VERSION . '; ' . home_url(),
+				'httpversion'       => '1.1'
+			)
+		);
+		// then check the response
+		if (
+			array_key_exists('body', $response)
+			&& ! is_wp_error($response)
+			&& strcmp($response['body'], "VERIFIED") === 0
+		) {
+			return true;
+		}
+		// huh, something's wack... the IPN didn't validate. We must have replied to the IPN incorrectly,
+		// or their API must have changed: http://www.paypalobjects.com/en_US/ebook/PP_OrderManagement_IntegrationGuide/ipn.html
+		if ($response instanceof WP_Error) {
+			$error_msg = sprintf(
+				esc_html__('WP Error. Code: "%1$s", Message: "%2$s", Data: "%3$s"', 'event_espresso'),
+				$response->get_error_code(),
+				$response->get_error_message(),
+				print_r($response->get_error_data(), true)
+			);
+		} elseif (is_array($response) && isset($response['body'])) {
+			$error_msg = $response['body'];
+		} else {
+			$error_msg = print_r($response, true);
+		}
+		$payment->set_gateway_response(
+			sprintf(
+				esc_html__("IPN Validation failed! Paypal responded with '%s'", "event_espresso"),
+				$error_msg
+			)
+		);
+		$payment->set_details(array('REQUEST' => $update_info, 'VALIDATION_RESPONSE' => $response));
+		$payment->set_status(EEM_Payment::status_id_failed);
+		// log the results
+		$this->log(
+			array(
+				'url'     => $this->_process_response_url(),
+				'message' => $payment->gateway_response(),
+				'details' => $payment->details(),
+			),
+			$payment
+		);
+		return false;
+	}
+
+
+	/**
+	 * _process_response_url
+	 * @return string
+	 */
+	protected function _process_response_url()
+	{
+		if (isset($_SERVER['HTTP_HOST'], $_SERVER['REQUEST_URI'])) {
+			$url = is_ssl() ? 'https://' : 'http://';
+			$url .= EEH_URL::filter_input_server_url('HTTP_HOST');
+			$url .= EEH_URL::filter_input_server_url();
+		} else {
+			$url = 'unknown';
+		}
+		return $url;
+	}
+
+
+	/**
+	 * Updates the transaction and line items based on the payment IPN data from PayPal,
+	 * like the taxes or shipping
+	 *
+	 * @param EEI_Payment $payment
+	 * @throws \EE_Error
+	 */
+	public function update_txn_based_on_payment($payment)
+	{
+		$update_info = $payment->details();
+		/** @var EE_Transaction $transaction */
+		$transaction = $payment->transaction();
+		$payment_was_itemized = $payment->get_extra_meta(EEG_Paypal_Standard::itemized_payment_option_name, true, false);
+		if (! $transaction) {
+			$this->log(
+				esc_html__(
+					// @codingStandardsIgnoreStart
+					'Payment with ID %d has no related transaction, and so update_txn_based_on_payment couldn\'t be executed properly',
+					// @codingStandardsIgnoreEnd
+					'event_espresso'
+				),
+				$payment
+			);
+			return;
+		}
+		if (
+			! is_array($update_info)
+			|| ! isset($update_info['mc_shipping'])
+			|| ! isset($update_info['tax'])
+		) {
+			$this->log(
+				array(
+					'message' => esc_html__(
+						// @codingStandardsIgnoreStart
+						'Could not update transaction based on payment because the payment details have not yet been put on the payment. This normally happens during the IPN or returning from PayPal',
+						// @codingStandardsIgnoreEnd
+						'event_espresso'
+					),
+					'url'     => $this->_process_response_url(),
+					'payment' => $payment->model_field_array()
+				),
+				$payment
+			);
+			return;
+		}
+		if ($payment->status() !== $this->_pay_model->approved_status()) {
+			$this->log(
+				array(
+					'message' => esc_html__(
+						'We shouldn\'t update transactions taxes or shipping data from non-approved payments',
+						'event_espresso'
+					),
+					'url'     => $this->_process_response_url(),
+					'payment' => $payment->model_field_array()
+				),
+				$payment
+			);
+			return;
+		}
+		$grand_total_needs_resaving = false;
+		/** @var EE_Line_Item $transaction_total_line_item */
+		$transaction_total_line_item = $transaction->total_line_item();
+
+		// might paypal have changed the taxes?
+		if ($this->_paypal_taxes && $payment_was_itemized) {
+			// note that we're doing this BEFORE adding shipping;
+			// we actually want PayPal's shipping to remain non-taxable
+			$this->_line_item->set_line_items_taxable($transaction_total_line_item, true, 'paypal_shipping');
+			$this->_line_item->set_total_tax_to(
+				$transaction_total_line_item,
+				(float) $update_info['tax'],
+				esc_html__('Taxes', 'event_espresso'),
+				esc_html__('Calculated by Paypal', 'event_espresso'),
+				'paypal_tax'
+			);
+			$grand_total_needs_resaving = true;
+		}
+
+		$shipping_amount = (float) $update_info['mc_shipping'];
+		// might paypal have added shipping?
+		if ($this->_paypal_shipping && $shipping_amount && $payment_was_itemized) {
+			$this->_line_item->add_unrelated_item(
+				$transaction_total_line_item,
+				sprintf(esc_html__('Shipping for transaction %1$s', 'event_espresso'), $transaction->ID()),
+				$shipping_amount,
+				esc_html__('Shipping charges calculated by Paypal', 'event_espresso'),
+				1,
+				false,
+				'paypal_shipping_' . $transaction->ID()
+			);
+			$grand_total_needs_resaving = true;
+		}
+
+		if ($grand_total_needs_resaving) {
+			$transaction_total_line_item->save_this_and_descendants_to_txn($transaction->ID());
+			/** @var EE_Registration_Processor $registration_processor */
+			$registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
+			$registration_processor->update_registration_final_prices($transaction);
+		}
+		$this->log(
+			array(
+				'message'                     => esc_html__('Updated transaction related to payment', 'event_espresso'),
+				'url'                         => $this->_process_response_url(),
+				'transaction (updated)'       => $transaction->model_field_array(),
+				'payment (updated)'           => $payment->model_field_array(),
+				'use_paypal_shipping'         => $this->_paypal_shipping,
+				'use_paypal_tax'              => $this->_paypal_taxes,
+				'grand_total_needed_resaving' => $grand_total_needs_resaving,
+			),
+			$payment
+		);
+	}
 }

caffeinated/admin/extend/events/Extend_Events_Admin_Page.core.php

Indentation +1293 added lines, -1293 removed lines

@@ -12,242 +12,242 @@ 
  */
 class Extend_Events_Admin_Page extends Events_Admin_Page
 {
-    /**
-     * Extend_Events_Admin_Page constructor.
-     *
-     * @param bool $routing
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function __construct($routing = true)
-    {
-        parent::__construct($routing);
-        if (! defined('EVENTS_CAF_TEMPLATE_PATH')) {
-            define('EVENTS_CAF_TEMPLATE_PATH', EE_CORE_CAF_ADMIN_EXTEND . 'events/templates/');
-            define('EVENTS_CAF_ASSETS', EE_CORE_CAF_ADMIN_EXTEND . 'events/assets/');
-            define('EVENTS_CAF_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL . 'events/assets/');
-        }
-    }
-
-
-    /**
-     * Sets routes.
-     *
-     * @throws EE_Error
-     */
-    protected function _extend_page_config()
-    {
-        $this->_admin_base_path = EE_CORE_CAF_ADMIN_EXTEND . 'events';
-        // is there a evt_id in the request?
-        $EVT_ID             = $this->request->getRequestParam('EVT_ID', 0, 'int');
-        $EVT_ID             = $this->request->getRequestParam('post', $EVT_ID, 'int');
-        $TKT_ID             = $this->request->getRequestParam('TKT_ID', 0, 'int');
-        $new_page_routes    = [
-            'duplicate_event'          => [
-                'func'       => '_duplicate_event',
-                'capability' => 'ee_edit_event',
-                'obj_id'     => $EVT_ID,
-                'noheader'   => true,
-            ],
-            'ticket_list_table'        => [
-                'func'       => '_tickets_overview_list_table',
-                'capability' => 'ee_read_default_tickets',
-            ],
-            'trash_ticket'             => [
-                'func'       => '_trash_or_restore_ticket',
-                'capability' => 'ee_delete_default_ticket',
-                'obj_id'     => $TKT_ID,
-                'noheader'   => true,
-                'args'       => ['trash' => true],
-            ],
-            'trash_tickets'            => [
-                'func'       => '_trash_or_restore_ticket',
-                'capability' => 'ee_delete_default_tickets',
-                'noheader'   => true,
-                'args'       => ['trash' => true],
-            ],
-            'restore_ticket'           => [
-                'func'       => '_trash_or_restore_ticket',
-                'capability' => 'ee_delete_default_ticket',
-                'obj_id'     => $TKT_ID,
-                'noheader'   => true,
-            ],
-            'restore_tickets'          => [
-                'func'       => '_trash_or_restore_ticket',
-                'capability' => 'ee_delete_default_tickets',
-                'noheader'   => true,
-            ],
-            'delete_ticket'            => [
-                'func'       => '_delete_ticket',
-                'capability' => 'ee_delete_default_ticket',
-                'obj_id'     => $TKT_ID,
-                'noheader'   => true,
-            ],
-            'delete_tickets'           => [
-                'func'       => '_delete_ticket',
-                'capability' => 'ee_delete_default_tickets',
-                'noheader'   => true,
-            ],
-            'import_page'              => [
-                'func'       => '_import_page',
-                'capability' => 'import',
-            ],
-            'import'                   => [
-                'func'       => '_import_events',
-                'capability' => 'import',
-                'noheader'   => true,
-            ],
-            'import_events'            => [
-                'func'       => '_import_events',
-                'capability' => 'import',
-                'noheader'   => true,
-            ],
-            'export_events'            => [
-                'func'       => '_events_export',
-                'capability' => 'export',
-                'noheader'   => true,
-            ],
-            'export_categories'        => [
-                'func'       => '_categories_export',
-                'capability' => 'export',
-                'noheader'   => true,
-            ],
-            'sample_export_file'       => [
-                'func'       => '_sample_export_file',
-                'capability' => 'export',
-                'noheader'   => true,
-            ],
-            'update_template_settings' => [
-                'func'       => '_update_template_settings',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-            ],
-        ];
-        $this->_page_routes = array_merge($this->_page_routes, $new_page_routes);
-        // partial route/config override
-        $this->_page_config['import_events']['metaboxes'] = $this->_default_espresso_metaboxes;
-        $this->_page_config['create_new']['metaboxes'][]  = '_premium_event_editor_meta_boxes';
-        $this->_page_config['create_new']['qtips'][]      = 'EE_Event_Editor_Tips';
-        $this->_page_config['edit']['qtips'][]            = 'EE_Event_Editor_Tips';
-        $this->_page_config['edit']['metaboxes'][]        = '_premium_event_editor_meta_boxes';
-        $this->_page_config['default']['list_table']      = 'Extend_Events_Admin_List_Table';
-        // add tickets tab but only if there are more than one default ticket!
-        $ticket_count = EEM_Ticket::instance()->count_deleted_and_undeleted(
-            [['TKT_is_default' => 1]],
-            'TKT_ID',
-            true
-        );
-        if ($ticket_count > 1) {
-            $new_page_config = [
-                'ticket_list_table' => [
-                    'nav'           => [
-                        'label' => esc_html__('Default Tickets', 'event_espresso'),
-                        'order' => 60,
-                    ],
-                    'list_table'    => 'Tickets_List_Table',
-                    'require_nonce' => false,
-                ],
-            ];
-        }
-        // template settings
-        $new_page_config['template_settings'] = [
-            'nav'           => [
-                'label' => esc_html__('Templates', 'event_espresso'),
-                'order' => 30,
-            ],
-            'metaboxes'     => array_merge($this->_default_espresso_metaboxes, ['_publish_post_box']),
-            'help_tabs'     => [
-                'general_settings_templates_help_tab' => [
-                    'title'    => esc_html__('Templates', 'event_espresso'),
-                    'filename' => 'general_settings_templates',
-                ],
-            ],
-            'require_nonce' => false,
-        ];
-        $this->_page_config                   = array_merge($this->_page_config, $new_page_config);
-        // add filters and actions
-        // modifying _views
-        add_filter(
-            'FHEE_event_datetime_metabox_add_additional_date_time_template',
-            [$this, 'add_additional_datetime_button'],
-            10,
-            2
-        );
-        add_filter(
-            'FHEE_event_datetime_metabox_clone_button_template',
-            [$this, 'add_datetime_clone_button'],
-            10,
-            2
-        );
-        add_filter(
-            'FHEE_event_datetime_metabox_timezones_template',
-            [$this, 'datetime_timezones_template'],
-            10,
-            2
-        );
-        // filters for event list table
-        add_filter('FHEE__Extend_Events_Admin_List_Table__filters', [$this, 'list_table_filters'], 10, 2);
-        add_filter(
-            'FHEE__Events_Admin_List_Table__column_actions__action_links',
-            [$this, 'extra_list_table_actions'],
-            10,
-            2
-        );
-        // legend item
-        add_filter('FHEE__Events_Admin_Page___event_legend_items__items', [$this, 'additional_legend_items']);
-        add_action('admin_init', [$this, 'admin_init']);
-    }
-
-
-    /**
-     * admin_init
-     */
-    public function admin_init()
-    {
-        EE_Registry::$i18n_js_strings = array_merge(
-            EE_Registry::$i18n_js_strings,
-            [
-                'image_confirm'          => esc_html__(
-                    'Do you really want to delete this image? Please remember to update your event to complete the removal.',
-                    'event_espresso'
-                ),
-                'event_starts_on'        => esc_html__('Event Starts on', 'event_espresso'),
-                'event_ends_on'          => esc_html__('Event Ends on', 'event_espresso'),
-                'event_datetime_actions' => esc_html__('Actions', 'event_espresso'),
-                'event_clone_dt_msg'     => esc_html__('Clone this Event Date and Time', 'event_espresso'),
-                'remove_event_dt_msg'    => esc_html__('Remove this Event Time', 'event_espresso'),
-            ]
-        );
-    }
-
-
-    /**
-     * Add per page screen options to the default ticket list table view.
-     */
-    protected function _add_screen_options_ticket_list_table()
-    {
-        $this->_per_page_screen_option();
-    }
-
-
-    /**
-     * @param string $return
-     * @param int    $id
-     * @param string $new_title
-     * @param string $new_slug
-     * @return string
-     */
-    public function extra_permalink_field_buttons($return, $id, $new_title, $new_slug)
-    {
-        $return = parent::extra_permalink_field_buttons($return, $id, $new_title, $new_slug);
-        // make sure this is only when editing
-        if (! empty($id)) {
-            $href   = EE_Admin_Page::add_query_args_and_nonce(
-                ['action' => 'duplicate_event', 'EVT_ID' => $id],
-                $this->_admin_base_url
-            );
-            $title  = esc_attr__('Duplicate Event', 'event_espresso');
-            $return .= '
+	/**
+	 * Extend_Events_Admin_Page constructor.
+	 *
+	 * @param bool $routing
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function __construct($routing = true)
+	{
+		parent::__construct($routing);
+		if (! defined('EVENTS_CAF_TEMPLATE_PATH')) {
+			define('EVENTS_CAF_TEMPLATE_PATH', EE_CORE_CAF_ADMIN_EXTEND . 'events/templates/');
+			define('EVENTS_CAF_ASSETS', EE_CORE_CAF_ADMIN_EXTEND . 'events/assets/');
+			define('EVENTS_CAF_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL . 'events/assets/');
+		}
+	}
+
+
+	/**
+	 * Sets routes.
+	 *
+	 * @throws EE_Error
+	 */
+	protected function _extend_page_config()
+	{
+		$this->_admin_base_path = EE_CORE_CAF_ADMIN_EXTEND . 'events';
+		// is there a evt_id in the request?
+		$EVT_ID             = $this->request->getRequestParam('EVT_ID', 0, 'int');
+		$EVT_ID             = $this->request->getRequestParam('post', $EVT_ID, 'int');
+		$TKT_ID             = $this->request->getRequestParam('TKT_ID', 0, 'int');
+		$new_page_routes    = [
+			'duplicate_event'          => [
+				'func'       => '_duplicate_event',
+				'capability' => 'ee_edit_event',
+				'obj_id'     => $EVT_ID,
+				'noheader'   => true,
+			],
+			'ticket_list_table'        => [
+				'func'       => '_tickets_overview_list_table',
+				'capability' => 'ee_read_default_tickets',
+			],
+			'trash_ticket'             => [
+				'func'       => '_trash_or_restore_ticket',
+				'capability' => 'ee_delete_default_ticket',
+				'obj_id'     => $TKT_ID,
+				'noheader'   => true,
+				'args'       => ['trash' => true],
+			],
+			'trash_tickets'            => [
+				'func'       => '_trash_or_restore_ticket',
+				'capability' => 'ee_delete_default_tickets',
+				'noheader'   => true,
+				'args'       => ['trash' => true],
+			],
+			'restore_ticket'           => [
+				'func'       => '_trash_or_restore_ticket',
+				'capability' => 'ee_delete_default_ticket',
+				'obj_id'     => $TKT_ID,
+				'noheader'   => true,
+			],
+			'restore_tickets'          => [
+				'func'       => '_trash_or_restore_ticket',
+				'capability' => 'ee_delete_default_tickets',
+				'noheader'   => true,
+			],
+			'delete_ticket'            => [
+				'func'       => '_delete_ticket',
+				'capability' => 'ee_delete_default_ticket',
+				'obj_id'     => $TKT_ID,
+				'noheader'   => true,
+			],
+			'delete_tickets'           => [
+				'func'       => '_delete_ticket',
+				'capability' => 'ee_delete_default_tickets',
+				'noheader'   => true,
+			],
+			'import_page'              => [
+				'func'       => '_import_page',
+				'capability' => 'import',
+			],
+			'import'                   => [
+				'func'       => '_import_events',
+				'capability' => 'import',
+				'noheader'   => true,
+			],
+			'import_events'            => [
+				'func'       => '_import_events',
+				'capability' => 'import',
+				'noheader'   => true,
+			],
+			'export_events'            => [
+				'func'       => '_events_export',
+				'capability' => 'export',
+				'noheader'   => true,
+			],
+			'export_categories'        => [
+				'func'       => '_categories_export',
+				'capability' => 'export',
+				'noheader'   => true,
+			],
+			'sample_export_file'       => [
+				'func'       => '_sample_export_file',
+				'capability' => 'export',
+				'noheader'   => true,
+			],
+			'update_template_settings' => [
+				'func'       => '_update_template_settings',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+			],
+		];
+		$this->_page_routes = array_merge($this->_page_routes, $new_page_routes);
+		// partial route/config override
+		$this->_page_config['import_events']['metaboxes'] = $this->_default_espresso_metaboxes;
+		$this->_page_config['create_new']['metaboxes'][]  = '_premium_event_editor_meta_boxes';
+		$this->_page_config['create_new']['qtips'][]      = 'EE_Event_Editor_Tips';
+		$this->_page_config['edit']['qtips'][]            = 'EE_Event_Editor_Tips';
+		$this->_page_config['edit']['metaboxes'][]        = '_premium_event_editor_meta_boxes';
+		$this->_page_config['default']['list_table']      = 'Extend_Events_Admin_List_Table';
+		// add tickets tab but only if there are more than one default ticket!
+		$ticket_count = EEM_Ticket::instance()->count_deleted_and_undeleted(
+			[['TKT_is_default' => 1]],
+			'TKT_ID',
+			true
+		);
+		if ($ticket_count > 1) {
+			$new_page_config = [
+				'ticket_list_table' => [
+					'nav'           => [
+						'label' => esc_html__('Default Tickets', 'event_espresso'),
+						'order' => 60,
+					],
+					'list_table'    => 'Tickets_List_Table',
+					'require_nonce' => false,
+				],
+			];
+		}
+		// template settings
+		$new_page_config['template_settings'] = [
+			'nav'           => [
+				'label' => esc_html__('Templates', 'event_espresso'),
+				'order' => 30,
+			],
+			'metaboxes'     => array_merge($this->_default_espresso_metaboxes, ['_publish_post_box']),
+			'help_tabs'     => [
+				'general_settings_templates_help_tab' => [
+					'title'    => esc_html__('Templates', 'event_espresso'),
+					'filename' => 'general_settings_templates',
+				],
+			],
+			'require_nonce' => false,
+		];
+		$this->_page_config                   = array_merge($this->_page_config, $new_page_config);
+		// add filters and actions
+		// modifying _views
+		add_filter(
+			'FHEE_event_datetime_metabox_add_additional_date_time_template',
+			[$this, 'add_additional_datetime_button'],
+			10,
+			2
+		);
+		add_filter(
+			'FHEE_event_datetime_metabox_clone_button_template',
+			[$this, 'add_datetime_clone_button'],
+			10,
+			2
+		);
+		add_filter(
+			'FHEE_event_datetime_metabox_timezones_template',
+			[$this, 'datetime_timezones_template'],
+			10,
+			2
+		);
+		// filters for event list table
+		add_filter('FHEE__Extend_Events_Admin_List_Table__filters', [$this, 'list_table_filters'], 10, 2);
+		add_filter(
+			'FHEE__Events_Admin_List_Table__column_actions__action_links',
+			[$this, 'extra_list_table_actions'],
+			10,
+			2
+		);
+		// legend item
+		add_filter('FHEE__Events_Admin_Page___event_legend_items__items', [$this, 'additional_legend_items']);
+		add_action('admin_init', [$this, 'admin_init']);
+	}
+
+
+	/**
+	 * admin_init
+	 */
+	public function admin_init()
+	{
+		EE_Registry::$i18n_js_strings = array_merge(
+			EE_Registry::$i18n_js_strings,
+			[
+				'image_confirm'          => esc_html__(
+					'Do you really want to delete this image? Please remember to update your event to complete the removal.',
+					'event_espresso'
+				),
+				'event_starts_on'        => esc_html__('Event Starts on', 'event_espresso'),
+				'event_ends_on'          => esc_html__('Event Ends on', 'event_espresso'),
+				'event_datetime_actions' => esc_html__('Actions', 'event_espresso'),
+				'event_clone_dt_msg'     => esc_html__('Clone this Event Date and Time', 'event_espresso'),
+				'remove_event_dt_msg'    => esc_html__('Remove this Event Time', 'event_espresso'),
+			]
+		);
+	}
+
+
+	/**
+	 * Add per page screen options to the default ticket list table view.
+	 */
+	protected function _add_screen_options_ticket_list_table()
+	{
+		$this->_per_page_screen_option();
+	}
+
+
+	/**
+	 * @param string $return
+	 * @param int    $id
+	 * @param string $new_title
+	 * @param string $new_slug
+	 * @return string
+	 */
+	public function extra_permalink_field_buttons($return, $id, $new_title, $new_slug)
+	{
+		$return = parent::extra_permalink_field_buttons($return, $id, $new_title, $new_slug);
+		// make sure this is only when editing
+		if (! empty($id)) {
+			$href   = EE_Admin_Page::add_query_args_and_nonce(
+				['action' => 'duplicate_event', 'EVT_ID' => $id],
+				$this->_admin_base_url
+			);
+			$title  = esc_attr__('Duplicate Event', 'event_espresso');
+			$return .= '
                 <a href="' . $href . '" 
                    aria-label="' . $title . '" 
                    id="ee-duplicate-event-button" 
@@ -256,1066 +256,1066 @@ 
                 >
                     ' . $title . '
                 </a>';
-        }
-        return $return;
-    }
-
-
-    /**
-     * Set the list table views for the default ticket list table view.
-     */
-    public function _set_list_table_views_ticket_list_table()
-    {
-        $this->_views = [
-            'all'     => [
-                'slug'        => 'all',
-                'label'       => esc_html__('All', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => [
-                    'trash_tickets' => esc_html__('Move to Trash', 'event_espresso'),
-                ],
-            ],
-            'trashed' => [
-                'slug'        => 'trashed',
-                'label'       => esc_html__('Trash', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => [
-                    'restore_tickets' => esc_html__('Restore from Trash', 'event_espresso'),
-                    'delete_tickets'  => esc_html__('Delete Permanently', 'event_espresso'),
-                ],
-            ],
-        ];
-    }
-
-
-    /**
-     * Enqueue scripts and styles for the event editor.
-     */
-    public function load_scripts_styles_edit()
-    {
-        wp_register_script(
-            'ee-event-editor-heartbeat',
-            EVENTS_CAF_ASSETS_URL . 'event-editor-heartbeat.js',
-            ['ee_admin_js', 'heartbeat'],
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_enqueue_script('ee-accounting');
-        // styles
-        wp_enqueue_style('espresso-ui-theme');
-        wp_enqueue_script('event_editor_js');
-        wp_enqueue_script('ee-event-editor-heartbeat');
-    }
-
-
-    /**
-     * Returns template for the additional datetime.
-     *
-     * @param string $template
-     * @param array  $template_args
-     * @return string
-     * @throws DomainException
-     */
-    public function add_additional_datetime_button($template, $template_args)
-    {
-        return EEH_Template::display_template(
-            EVENTS_CAF_TEMPLATE_PATH . 'event_datetime_add_additional_time.template.php',
-            $template_args,
-            true
-        );
-    }
-
-
-    /**
-     * Returns the template for cloning a datetime.
-     *
-     * @param $template
-     * @param $template_args
-     * @return string
-     * @throws DomainException
-     */
-    public function add_datetime_clone_button($template, $template_args)
-    {
-        return EEH_Template::display_template(
-            EVENTS_CAF_TEMPLATE_PATH . 'event_datetime_metabox_clone_button.template.php',
-            $template_args,
-            true
-        );
-    }
-
-
-    /**
-     * Returns the template for datetime timezones.
-     *
-     * @param $template
-     * @param $template_args
-     * @return string
-     * @throws DomainException
-     */
-    public function datetime_timezones_template($template, $template_args)
-    {
-        return EEH_Template::display_template(
-            EVENTS_CAF_TEMPLATE_PATH . 'event_datetime_timezones.template.php',
-            $template_args,
-            true
-        );
-    }
-
-
-    /**
-     * Sets the views for the default list table view.
-     *
-     * @throws EE_Error
-     */
-    protected function _set_list_table_views_default()
-    {
-        parent::_set_list_table_views_default();
-        $new_views    = [
-            'today' => [
-                'slug'        => 'today',
-                'label'       => esc_html__('Today', 'event_espresso'),
-                'count'       => $this->total_events_today(),
-                'bulk_action' => [
-                    'trash_events' => esc_html__('Move to Trash', 'event_espresso'),
-                ],
-            ],
-            'month' => [
-                'slug'        => 'month',
-                'label'       => esc_html__('This Month', 'event_espresso'),
-                'count'       => $this->total_events_this_month(),
-                'bulk_action' => [
-                    'trash_events' => esc_html__('Move to Trash', 'event_espresso'),
-                ],
-            ],
-        ];
-        $this->_views = array_merge($this->_views, $new_views);
-    }
-
-
-    /**
-     * Returns the extra action links for the default list table view.
-     *
-     * @param array    $action_links
-     * @param EE_Event $event
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function extra_list_table_actions(array $action_links, EE_Event $event)
-    {
-        if (
-            EE_Registry::instance()->CAP->current_user_can(
-                'ee_read_registrations',
-                'espresso_registrations_reports',
-                $event->ID()
-            )
-        ) {
-            $reports_query_args = [
-                'action' => 'reports',
-                'EVT_ID' => $event->ID(),
-            ];
-            $reports_link       = EE_Admin_Page::add_query_args_and_nonce($reports_query_args, REG_ADMIN_URL);
-            $action_links[]     = '
+		}
+		return $return;
+	}
+
+
+	/**
+	 * Set the list table views for the default ticket list table view.
+	 */
+	public function _set_list_table_views_ticket_list_table()
+	{
+		$this->_views = [
+			'all'     => [
+				'slug'        => 'all',
+				'label'       => esc_html__('All', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => [
+					'trash_tickets' => esc_html__('Move to Trash', 'event_espresso'),
+				],
+			],
+			'trashed' => [
+				'slug'        => 'trashed',
+				'label'       => esc_html__('Trash', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => [
+					'restore_tickets' => esc_html__('Restore from Trash', 'event_espresso'),
+					'delete_tickets'  => esc_html__('Delete Permanently', 'event_espresso'),
+				],
+			],
+		];
+	}
+
+
+	/**
+	 * Enqueue scripts and styles for the event editor.
+	 */
+	public function load_scripts_styles_edit()
+	{
+		wp_register_script(
+			'ee-event-editor-heartbeat',
+			EVENTS_CAF_ASSETS_URL . 'event-editor-heartbeat.js',
+			['ee_admin_js', 'heartbeat'],
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_enqueue_script('ee-accounting');
+		// styles
+		wp_enqueue_style('espresso-ui-theme');
+		wp_enqueue_script('event_editor_js');
+		wp_enqueue_script('ee-event-editor-heartbeat');
+	}
+
+
+	/**
+	 * Returns template for the additional datetime.
+	 *
+	 * @param string $template
+	 * @param array  $template_args
+	 * @return string
+	 * @throws DomainException
+	 */
+	public function add_additional_datetime_button($template, $template_args)
+	{
+		return EEH_Template::display_template(
+			EVENTS_CAF_TEMPLATE_PATH . 'event_datetime_add_additional_time.template.php',
+			$template_args,
+			true
+		);
+	}
+
+
+	/**
+	 * Returns the template for cloning a datetime.
+	 *
+	 * @param $template
+	 * @param $template_args
+	 * @return string
+	 * @throws DomainException
+	 */
+	public function add_datetime_clone_button($template, $template_args)
+	{
+		return EEH_Template::display_template(
+			EVENTS_CAF_TEMPLATE_PATH . 'event_datetime_metabox_clone_button.template.php',
+			$template_args,
+			true
+		);
+	}
+
+
+	/**
+	 * Returns the template for datetime timezones.
+	 *
+	 * @param $template
+	 * @param $template_args
+	 * @return string
+	 * @throws DomainException
+	 */
+	public function datetime_timezones_template($template, $template_args)
+	{
+		return EEH_Template::display_template(
+			EVENTS_CAF_TEMPLATE_PATH . 'event_datetime_timezones.template.php',
+			$template_args,
+			true
+		);
+	}
+
+
+	/**
+	 * Sets the views for the default list table view.
+	 *
+	 * @throws EE_Error
+	 */
+	protected function _set_list_table_views_default()
+	{
+		parent::_set_list_table_views_default();
+		$new_views    = [
+			'today' => [
+				'slug'        => 'today',
+				'label'       => esc_html__('Today', 'event_espresso'),
+				'count'       => $this->total_events_today(),
+				'bulk_action' => [
+					'trash_events' => esc_html__('Move to Trash', 'event_espresso'),
+				],
+			],
+			'month' => [
+				'slug'        => 'month',
+				'label'       => esc_html__('This Month', 'event_espresso'),
+				'count'       => $this->total_events_this_month(),
+				'bulk_action' => [
+					'trash_events' => esc_html__('Move to Trash', 'event_espresso'),
+				],
+			],
+		];
+		$this->_views = array_merge($this->_views, $new_views);
+	}
+
+
+	/**
+	 * Returns the extra action links for the default list table view.
+	 *
+	 * @param array    $action_links
+	 * @param EE_Event $event
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function extra_list_table_actions(array $action_links, EE_Event $event)
+	{
+		if (
+			EE_Registry::instance()->CAP->current_user_can(
+				'ee_read_registrations',
+				'espresso_registrations_reports',
+				$event->ID()
+			)
+		) {
+			$reports_query_args = [
+				'action' => 'reports',
+				'EVT_ID' => $event->ID(),
+			];
+			$reports_link       = EE_Admin_Page::add_query_args_and_nonce($reports_query_args, REG_ADMIN_URL);
+			$action_links[]     = '
                 <a href="' . $reports_link . '" 
                    aria-label="' . esc_attr__('View Report', 'event_espresso') . '"
                 >
                     <div class="dashicons dashicons-chart-bar"></div>
                 </a>';
-        }
-        if (EE_Registry::instance()->CAP->current_user_can('ee_read_global_messages', 'view_filtered_messages')) {
-            EE_Registry::instance()->load_helper('MSG_Template');
-            $action_links[] = EEH_MSG_Template::get_message_action_link(
-                'see_notifications_for',
-                null,
-                ['EVT_ID' => $event->ID()]
-            );
-        }
-        return $action_links;
-    }
-
-
-    /**
-     * @param $items
-     * @return mixed
-     */
-    public function additional_legend_items($items)
-    {
-        if (
-            EE_Registry::instance()->CAP->current_user_can(
-                'ee_read_registrations',
-                'espresso_registrations_reports'
-            )
-        ) {
-            $items['reports'] = [
-                'class' => 'dashicons dashicons-chart-bar',
-                'desc'  => esc_html__('Event Reports', 'event_espresso'),
-            ];
-        }
-        if (EE_Registry::instance()->CAP->current_user_can('ee_read_global_messages', 'view_filtered_messages')) {
-            $related_for_icon = EEH_MSG_Template::get_message_action_icon('see_notifications_for');
-            if (isset($related_for_icon['css_class']) && isset($related_for_icon['label'])) {
-                $items['view_related_messages'] = [
-                    'class' => $related_for_icon['css_class'],
-                    'desc'  => $related_for_icon['label'],
-                ];
-            }
-        }
-        return $items;
-    }
-
-
-    /**
-     * This is the callback method for the duplicate event route
-     * Method looks for 'EVT_ID' in the request and retrieves that event and its details and duplicates them
-     * into a new event.  We add a hook so that any plugins that add extra event details can hook into this
-     * action.  Note that the dupe will have **DUPLICATE** as its title and slug.
-     * After duplication the redirect is to the new event edit page.
-     *
-     * @return void
-     * @throws EE_Error If EE_Event is not available with given ID
-     * @throws ReflectionException
-     * @access protected
-     */
-    protected function _duplicate_event()
-    {
-        // first make sure the ID for the event is in the request.
-        //  If it isn't then we need to bail and redirect back to overview list table (cause how did we get here?)
-        $EVT_ID = $this->request->getRequestParam('EVT_ID', 0, 'int');
-        if (! $EVT_ID) {
-            EE_Error::add_error(
-                esc_html__(
-                    'In order to duplicate an event an Event ID is required.  None was given.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $this->_redirect_after_action(false, '', '', [], true);
-            return;
-        }
-        // k we've got EVT_ID so let's use that to get the event we'll duplicate
-        $orig_event = EEM_Event::instance()->get_one_by_ID($EVT_ID);
-        if (! $orig_event instanceof EE_Event) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__('An EE_Event object could not be retrieved for the given ID (%s)', 'event_espresso'),
-                    $EVT_ID
-                )
-            );
-        }
-        // k now let's clone the $orig_event before getting relations
-        $new_event = clone $orig_event;
-        // original datetimes
-        $orig_datetimes = $orig_event->get_many_related('Datetime');
-        // other original relations
-        $orig_ven = $orig_event->get_many_related('Venue');
-        // reset the ID and modify other details to make it clear this is a dupe
-        $new_event->set('EVT_ID', 0);
-        $new_name = $new_event->name() . ' ' . esc_html__('**DUPLICATE**', 'event_espresso');
-        $new_event->set('EVT_name', $new_name);
-        $new_event->set(
-            'EVT_slug',
-            wp_unique_post_slug(
-                sanitize_title($orig_event->name()),
-                0,
-                'publish',
-                'espresso_events',
-                0
-            )
-        );
-        $new_event->set('status', 'draft');
-        // duplicate discussion settings
-        $new_event->set('comment_status', $orig_event->get('comment_status'));
-        $new_event->set('ping_status', $orig_event->get('ping_status'));
-        // save the new event
-        $new_event->save();
-        // venues
-        foreach ($orig_ven as $ven) {
-            $new_event->_add_relation_to($ven, 'Venue');
-        }
-        $new_event->save();
-        // now we need to get the question group relations and handle that
-        // first primary question groups
-        $orig_primary_qgs = $orig_event->get_many_related(
-            'Question_Group',
-            [['Event_Question_Group.EQG_primary' => true]]
-        );
-        if (! empty($orig_primary_qgs)) {
-            foreach ($orig_primary_qgs as $obj) {
-                if ($obj instanceof EE_Question_Group) {
-                    $new_event->_add_relation_to($obj, 'Question_Group', ['EQG_primary' => true]);
-                }
-            }
-        }
-        // next additional attendee question groups
-        $orig_additional_qgs = $orig_event->get_many_related(
-            'Question_Group',
-            [['Event_Question_Group.EQG_additional' => true]]
-        );
-        if (! empty($orig_additional_qgs)) {
-            foreach ($orig_additional_qgs as $obj) {
-                if ($obj instanceof EE_Question_Group) {
-                    $new_event->_add_relation_to($obj, 'Question_Group', ['EQG_additional' => true]);
-                }
-            }
-        }
-
-        $new_event->save();
-
-        // k now that we have the new event saved we can loop through the datetimes and start adding relations.
-        $cloned_tickets = [];
-        foreach ($orig_datetimes as $orig_dtt) {
-            if (! $orig_dtt instanceof EE_Datetime) {
-                continue;
-            }
-            $new_dtt      = clone $orig_dtt;
-            $orig_tickets = $orig_dtt->tickets();
-            // save new dtt then add to event
-            $new_dtt->set('DTT_ID', 0);
-            $new_dtt->set('DTT_sold', 0);
-            $new_dtt->set_reserved(0);
-            $new_dtt->save();
-            $new_event->_add_relation_to($new_dtt, 'Datetime');
-            $new_event->save();
-            // now let's get the ticket relations setup.
-            foreach ((array) $orig_tickets as $orig_ticket) {
-                // it's possible a datetime will have no tickets so let's verify we HAVE a ticket first.
-                if (! $orig_ticket instanceof EE_Ticket) {
-                    continue;
-                }
-                // is this ticket archived?  If it is then let's skip
-                if ($orig_ticket->get('TKT_deleted')) {
-                    continue;
-                }
-                // does this original ticket already exist in the clone_tickets cache?
-                //  If so we'll just use the new ticket from it.
-                if (isset($cloned_tickets[ $orig_ticket->ID() ])) {
-                    $new_ticket = $cloned_tickets[ $orig_ticket->ID() ];
-                } else {
-                    $new_ticket = clone $orig_ticket;
-                    // get relations on the $orig_ticket that we need to setup.
-                    $orig_prices = $orig_ticket->prices();
-                    $new_ticket->set('TKT_ID', 0);
-                    $new_ticket->set('TKT_sold', 0);
-                    $new_ticket->set('TKT_reserved', 0);
-                    $new_ticket->save(); // make sure new ticket has ID.
-                    // price relations on new ticket need to be setup.
-                    foreach ($orig_prices as $orig_price) {
-                        $new_price = clone $orig_price;
-                        $new_price->set('PRC_ID', 0);
-                        $new_price->save();
-                        $new_ticket->_add_relation_to($new_price, 'Price');
-                        $new_ticket->save();
-                    }
-
-                    do_action(
-                        'AHEE__Extend_Events_Admin_Page___duplicate_event__duplicate_ticket__after',
-                        $orig_ticket,
-                        $new_ticket,
-                        $orig_prices,
-                        $orig_event,
-                        $orig_dtt,
-                        $new_dtt
-                    );
-                }
-                // k now we can add the new ticket as a relation to the new datetime
-                // and make sure its added to our cached $cloned_tickets array
-                // for use with later datetimes that have the same ticket.
-                $new_dtt->_add_relation_to($new_ticket, 'Ticket');
-                $new_dtt->save();
-                $cloned_tickets[ $orig_ticket->ID() ] = $new_ticket;
-            }
-        }
-        // clone taxonomy information
-        $taxonomies_to_clone_with = apply_filters(
-            'FHEE__Extend_Events_Admin_Page___duplicate_event__taxonomies_to_clone',
-            ['espresso_event_categories', 'espresso_event_type', 'post_tag']
-        );
-        // get terms for original event (notice)
-        $orig_terms = wp_get_object_terms($orig_event->ID(), $taxonomies_to_clone_with);
-        // loop through terms and add them to new event.
-        foreach ($orig_terms as $term) {
-            wp_set_object_terms($new_event->ID(), $term->term_id, $term->taxonomy, true);
-        }
-
-        // duplicate other core WP_Post items for this event.
-        // post thumbnail (feature image).
-        $feature_image_id = get_post_thumbnail_id($orig_event->ID());
-        if ($feature_image_id) {
-            update_post_meta($new_event->ID(), '_thumbnail_id', $feature_image_id);
-        }
-
-        // duplicate page_template setting
-        $page_template = get_post_meta($orig_event->ID(), '_wp_page_template', true);
-        if ($page_template) {
-            update_post_meta($new_event->ID(), '_wp_page_template', $page_template);
-        }
-
-        do_action('AHEE__Extend_Events_Admin_Page___duplicate_event__after', $new_event, $orig_event);
-        // now let's redirect to the edit page for this duplicated event if we have a new event id.
-        if ($new_event->ID()) {
-            $redirect_args = [
-                'post'   => $new_event->ID(),
-                'action' => 'edit',
-            ];
-            EE_Error::add_success(
-                esc_html__(
-                    'Event successfully duplicated.  Please review the details below and make any necessary edits',
-                    'event_espresso'
-                )
-            );
-        } else {
-            $redirect_args = [
-                'action' => 'default',
-            ];
-            EE_Error::add_error(
-                esc_html__('Not able to duplicate event.  Something went wrong.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        $this->_redirect_after_action(false, '', '', $redirect_args, true);
-    }
-
-
-    /**
-     * Generates output for the import page.
-     *
-     * @throws EE_Error
-     */
-    protected function _import_page()
-    {
-        $title = esc_html__('Import', 'event_espresso');
-        $intro = esc_html__(
-            'If you have a previously exported Event Espresso 4 information in a Comma Separated Value (CSV) file format, you can upload the file here: ',
-            'event_espresso'
-        );
-
-        $form_url = EVENTS_ADMIN_URL;
-        $action   = 'import_events';
-        $type     = 'csv';
-
-        $this->_template_args['form'] = EE_Import::instance()->upload_form(
-            $title,
-            $intro,
-            $form_url,
-            $action,
-            $type
-        );
-
-        $this->_template_args['sample_file_link']   = EE_Admin_Page::add_query_args_and_nonce(
-            ['action' => 'sample_export_file'],
-            $this->_admin_base_url
-        );
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            EVENTS_CAF_TEMPLATE_PATH . 'import_page.template.php',
-            $this->_template_args,
-            true
-        );
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    /**
-     * _import_events
-     * This handles displaying the screen and running imports for importing events.
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    protected function _import_events()
-    {
-        require_once(EE_CLASSES . 'EE_Import.class.php');
-        $success = EE_Import::instance()->import();
-        $this->_redirect_after_action(
-            $success,
-            esc_html__('Import File', 'event_espresso'),
-            'ran',
-            ['action' => 'import_page'],
-            true
-        );
-    }
-
-
-    /**
-     * _events_export
-     * Will export all (or just the given event) to a Excel compatible file.
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _events_export()
-    {
-        $EVT_ID = $this->request->getRequestParam('EVT_ID', 0, 'int');
-        $EVT_ID = $this->request->getRequestParam('EVT_IDs', $EVT_ID, 'int');
-        $this->request->mergeRequestParams(
-            [
-                'export' => 'report',
-                'action' => 'all_event_data',
-                'EVT_ID' => $EVT_ID,
-            ]
-        );
-        if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
-            require_once(EE_CLASSES . 'EE_Export.class.php');
-            $EE_Export = EE_Export::instance($this->request->requestParams());
-            $EE_Export->export();
-        }
-    }
-
-
-    /**
-     * handle category exports()
-     *
-     * @return void
-     */
-    protected function _categories_export()
-    {
-        $EVT_ID = $this->request->getRequestParam('EVT_CAT_ID', 0, 'int');
-        $this->request->mergeRequestParams(
-            [
-                'export' => 'report',
-                'action' => 'categories',
-                'EVT_ID' => $EVT_ID,
-            ]
-        );
-        if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
-            require_once(EE_CLASSES . 'EE_Export.class.php');
-            $EE_Export = EE_Export::instance($this->request->requestParams());
-            $EE_Export->export();
-        }
-    }
-
-
-    /**
-     * Creates a sample CSV file for importing
-     */
-    protected function _sample_export_file()
-    {
-        // require_once(EE_CLASSES . 'EE_Export.class.php');
-        EE_Export::instance()->export_sample();
-    }
-
-
-    /*************        Template Settings        *************/
-    /**
-     * Generates template settings page output
-     *
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    protected function _template_settings()
-    {
-        $this->_template_args['values'] = $this->_yes_no_values;
-        /**
-         * Note leaving this filter in for backward compatibility this was moved in 4.6.x
-         * from General_Settings_Admin_Page to here.
-         */
-        $this->_template_args = apply_filters(
-            'FHEE__General_Settings_Admin_Page__template_settings__template_args',
-            $this->_template_args
-        );
-        $this->_set_add_edit_form_tags('update_template_settings');
-        $this->_set_publish_post_box_vars(null, false, false, null, false);
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            EVENTS_CAF_TEMPLATE_PATH . 'template_settings.template.php',
-            $this->_template_args,
-            true
-        );
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    /**
-     * Handler for updating template settings.
-     *
-     * @throws EE_Error
-     */
-    protected function _update_template_settings()
-    {
-        /**
-         * Note leaving this filter in for backward compatibility this was moved in 4.6.x
-         * from General_Settings_Admin_Page to here.
-         */
-        EE_Registry::instance()->CFG->template_settings = apply_filters(
-            'FHEE__General_Settings_Admin_Page__update_template_settings__data',
-            EE_Registry::instance()->CFG->template_settings,
-            $this->request->requestParams()
-        );
-        // update custom post type slugs and detect if we need to flush rewrite rules
-        $old_slug = EE_Registry::instance()->CFG->core->event_cpt_slug;
-
-        $event_cpt_slug = $this->request->getRequestParam('event_cpt_slug');
-
-        EE_Registry::instance()->CFG->core->event_cpt_slug = $event_cpt_slug
-            ? EEH_URL::slugify($event_cpt_slug, 'events')
-            : EE_Registry::instance()->CFG->core->event_cpt_slug;
-
-        $what    = esc_html__('Template Settings', 'event_espresso');
-        $success = $this->_update_espresso_configuration(
-            $what,
-            EE_Registry::instance()->CFG->template_settings,
-            __FILE__,
-            __FUNCTION__,
-            __LINE__
-        );
-        if (EE_Registry::instance()->CFG->core->event_cpt_slug != $old_slug) {
-            /** @var EventEspresso\core\domain\services\custom_post_types\RewriteRules $rewrite_rules */
-            $rewrite_rules = LoaderFactory::getLoader()->getShared(
-                'EventEspresso\core\domain\services\custom_post_types\RewriteRules'
-            );
-            $rewrite_rules->flush();
-        }
-        $this->_redirect_after_action($success, $what, 'updated', ['action' => 'template_settings']);
-    }
-
-
-    /**
-     * _premium_event_editor_meta_boxes
-     * add all metaboxes related to the event_editor
-     *
-     * @access protected
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _premium_event_editor_meta_boxes()
-    {
-        $this->verify_cpt_object();
-        add_meta_box(
-            'espresso_event_editor_event_options',
-            esc_html__('Event Registration Options', 'event_espresso'),
-            [$this, 'registration_options_meta_box'],
-            $this->page_slug,
-            'side',
-            'core'
-        );
-    }
-
-
-    /**
-     * override caf metabox
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function registration_options_meta_box()
-    {
-        $yes_no_values = [
-            ['id' => true, 'text' => esc_html__('Yes', 'event_espresso')],
-            ['id' => false, 'text' => esc_html__('No', 'event_espresso')],
-        ];
-
-        $default_reg_status_values = EEM_Registration::reg_status_array(
-            [
-                EEM_Registration::status_id_cancelled,
-                EEM_Registration::status_id_declined,
-                EEM_Registration::status_id_incomplete,
-                EEM_Registration::status_id_wait_list,
-            ],
-            true
-        );
-
-        $template_args['active_status']    = $this->_cpt_model_obj->pretty_active_status(false);
-        $template_args['_event']           = $this->_cpt_model_obj;
-        $template_args['additional_limit'] = $this->_cpt_model_obj->additional_limit();
-
-        $template_args['default_registration_status']     = EEH_Form_Fields::select_input(
-            'default_reg_status',
-            $default_reg_status_values,
-            $this->_cpt_model_obj->default_registration_status()
-        );
-        $template_args['display_description']             = EEH_Form_Fields::select_input(
-            'display_desc',
-            $yes_no_values,
-            $this->_cpt_model_obj->display_description()
-        );
-        $template_args['display_ticket_selector']         = EEH_Form_Fields::select_input(
-            'display_ticket_selector',
-            $yes_no_values,
-            $this->_cpt_model_obj->display_ticket_selector(),
-            '',
-            '',
-            false
-        );
-        $template_args['EVT_default_registration_status'] = EEH_Form_Fields::select_input(
-            'EVT_default_registration_status',
-            $default_reg_status_values,
-            $this->_cpt_model_obj->default_registration_status()
-        );
-        $template_args['additional_registration_options'] = apply_filters(
-            'FHEE__Events_Admin_Page__registration_options_meta_box__additional_registration_options',
-            '',
-            $template_args,
-            $yes_no_values,
-            $default_reg_status_values
-        );
-        EEH_Template::display_template(
-            EVENTS_CAF_TEMPLATE_PATH . 'event_registration_options.template.php',
-            $template_args
-        );
-    }
-
-
-
-    /**
-     * wp_list_table_mods for caf
-     * ============================
-     */
-    /**
-     * hook into list table filters and provide filters for caffeinated list table
-     *
-     * @param array $old_filters    any existing filters present
-     * @param array $list_table_obj the list table object
-     * @return array                  new filters
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function list_table_filters($old_filters, $list_table_obj)
-    {
-        $filters = [];
-        // first month/year filters
-        $filters[] = $this->espresso_event_months_dropdown();
-        $status    = $this->request->getRequestParam('status');
-        // active status dropdown
-        if ($status !== 'draft') {
-            $filters[] = $this->active_status_dropdown($this->request->getRequestParam('active_status'));
-            $filters[] = $this->venuesDropdown($this->request->getRequestParam('venue'));
-        }
-        // category filter
-        $filters[] = $this->category_dropdown();
-        return array_merge($old_filters, $filters);
-    }
-
-
-    /**
-     * espresso_event_months_dropdown
-     *
-     * @access public
-     * @return string                dropdown listing month/year selections for events.
-     * @throws EE_Error
-     */
-    public function espresso_event_months_dropdown()
-    {
-        // what we need to do is get all PRIMARY datetimes for all events to filter on.
-        // Note we need to include any other filters that are set!
-        return EEH_Form_Fields::generate_event_months_dropdown(
-            $this->request->getRequestParam('month_range'),
-            $this->request->getRequestParam('status'),
-            $this->request->getRequestParam('EVT_CAT', 0, 'int'),
-            $this->request->getRequestParam('active_status')
-        );
-    }
-
-
-    /**
-     * returns a list of "active" statuses on the event
-     *
-     * @param string $current_value whatever the current active status is
-     * @return string
-     */
-    public function active_status_dropdown($current_value = '')
-    {
-        $select_name = 'active_status';
-        $values      = [
-            'none'     => esc_html__('Show Active/Inactive', 'event_espresso'),
-            'active'   => esc_html__('Active', 'event_espresso'),
-            'upcoming' => esc_html__('Upcoming', 'event_espresso'),
-            'expired'  => esc_html__('Expired', 'event_espresso'),
-            'inactive' => esc_html__('Inactive', 'event_espresso'),
-        ];
-
-        return EEH_Form_Fields::select_input($select_name, $values, $current_value, '', 'wide');
-    }
-
-
-    /**
-     * returns a list of "venues"
-     *
-     * @param string $current_value whatever the current active status is
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function venuesDropdown($current_value = '')
-    {
-        $values = [
-            '' => esc_html__('All Venues', 'event_espresso'),
-        ];
-        // populate the list of venues.
-        $venues = EEM_Venue::instance()->get_all(['order_by' => ['VNU_name' => 'ASC']]);
-
-        foreach ($venues as $venue) {
-            $values[ $venue->ID() ] = $venue->name();
-        }
-
-        return EEH_Form_Fields::select_input('venue', $values, $current_value, '', 'wide');
-    }
-
-
-    /**
-     * output a dropdown of the categories for the category filter on the event admin list table
-     *
-     * @access  public
-     * @return string html
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function category_dropdown()
-    {
-        return EEH_Form_Fields::generate_event_category_dropdown(
-            $this->request->getRequestParam('EVT_CAT', -1, 'int')
-        );
-    }
-
-
-    /**
-     * get total number of events today
-     *
-     * @access public
-     * @return int
-     * @throws EE_Error
-     */
-    public function total_events_today()
-    {
-        $start = EEM_Datetime::instance()->convert_datetime_for_query(
-            'DTT_EVT_start',
-            date('Y-m-d') . ' 00:00:00',
-            'Y-m-d H:i:s',
-            'UTC'
-        );
-        $end   = EEM_Datetime::instance()->convert_datetime_for_query(
-            'DTT_EVT_start',
-            date('Y-m-d') . ' 23:59:59',
-            'Y-m-d H:i:s',
-            'UTC'
-        );
-        $where = [
-            'Datetime.DTT_EVT_start' => ['BETWEEN', [$start, $end]],
-        ];
-        return EEM_Event::instance()->count([$where, 'caps' => 'read_admin'], 'EVT_ID', true);
-    }
-
-
-    /**
-     * get total number of events this month
-     *
-     * @access public
-     * @return int
-     * @throws EE_Error
-     */
-    public function total_events_this_month()
-    {
-        // Dates
-        $this_year_r     = date('Y');
-        $this_month_r    = date('m');
-        $days_this_month = date('t');
-        $start           = EEM_Datetime::instance()->convert_datetime_for_query(
-            'DTT_EVT_start',
-            $this_year_r . '-' . $this_month_r . '-01 00:00:00',
-            'Y-m-d H:i:s',
-            'UTC'
-        );
-        $end             = EEM_Datetime::instance()->convert_datetime_for_query(
-            'DTT_EVT_start',
-            $this_year_r . '-' . $this_month_r . '-' . $days_this_month . ' 23:59:59',
-            'Y-m-d H:i:s',
-            'UTC'
-        );
-        $where           = [
-            'Datetime.DTT_EVT_start' => ['BETWEEN', [$start, $end]],
-        ];
-        return EEM_Event::instance()->count([$where, 'caps' => 'read_admin'], 'EVT_ID', true);
-    }
-
-
-    /** DEFAULT TICKETS STUFF **/
-
-    /**
-     * Output default tickets list table view.
-     *
-     * @throws EE_Error
-     */
-    public function _tickets_overview_list_table()
-    {
-        $this->_search_btn_label = esc_html__('Tickets', 'event_espresso');
-        $this->display_admin_list_table_page_with_no_sidebar();
-    }
-
-
-    /**
-     * @param int  $per_page
-     * @param bool $count
-     * @param bool $trashed
-     * @return EE_Soft_Delete_Base_Class[]|int
-     * @throws EE_Error
-     */
-    public function get_default_tickets($per_page = 10, $count = false, $trashed = false)
-    {
-        $orderby = $this->request->getRequestParam('orderby', 'TKT_name');
-        $order   = $this->request->getRequestParam('order', 'ASC');
-        switch ($orderby) {
-            case 'TKT_name':
-                $orderby = ['TKT_name' => $order];
-                break;
-            case 'TKT_price':
-                $orderby = ['TKT_price' => $order];
-                break;
-            case 'TKT_uses':
-                $orderby = ['TKT_uses' => $order];
-                break;
-            case 'TKT_min':
-                $orderby = ['TKT_min' => $order];
-                break;
-            case 'TKT_max':
-                $orderby = ['TKT_max' => $order];
-                break;
-            case 'TKT_qty':
-                $orderby = ['TKT_qty' => $order];
-                break;
-        }
-
-        $current_page = $this->request->getRequestParam('paged', 1, 'int');
-        $per_page     = $this->request->getRequestParam('perpage', $per_page, 'int');
-        $offset       = ($current_page - 1) * $per_page;
-
-        $where = [
-            'TKT_is_default' => 1,
-            'TKT_deleted'    => $trashed,
-        ];
-
-        $search_term = $this->request->getRequestParam('s');
-        if ($search_term) {
-            $search_term = '%' . $search_term . '%';
-            $where['OR'] = [
-                'TKT_name'        => ['LIKE', $search_term],
-                'TKT_description' => ['LIKE', $search_term],
-            ];
-        }
-
-        return $count
-            ? EEM_Ticket::instance()->count_deleted_and_undeleted([$where])
-            : EEM_Ticket::instance()->get_all_deleted_and_undeleted(
-                [
-                    $where,
-                    'order_by' => $orderby,
-                    'limit'    => [$offset, $per_page],
-                    'group_by' => 'TKT_ID',
-                ]
-            );
-    }
-
-
-    /**
-     * @param bool $trash
-     * @throws EE_Error
-     */
-    protected function _trash_or_restore_ticket($trash = false)
-    {
-        $success = 1;
-        $TKT     = EEM_Ticket::instance();
-        // checkboxes?
-        $checkboxes = $this->request->getRequestParam('checkbox', [], 'int', true);
-        if (! empty($checkboxes)) {
-            // if array has more than one element then success message should be plural
-            $success = count($checkboxes) > 1 ? 2 : 1;
-            // cycle thru the boxes
-            $checkboxes = $this->_req_data['checkbox'];
-            foreach (array_keys($checkboxes) as $TKT_ID) {
-                if ($trash) {
-                    if (! $TKT->delete_by_ID($TKT_ID)) {
-                        $success = 0;
-                    }
-                } else {
-                    if (! $TKT->restore_by_ID($TKT_ID)) {
-                        $success = 0;
-                    }
-                }
-            }
-        } else {
-            // grab single id and trash
-            $TKT_ID = $this->request->getRequestParam('TKT_ID', 0, 'int');
-            if ($trash) {
-                if (! $TKT->delete_by_ID($TKT_ID)) {
-                    $success = 0;
-                }
-            } else {
-                if (! $TKT->restore_by_ID($TKT_ID)) {
-                    $success = 0;
-                }
-            }
-        }
-        $action_desc = $trash ? 'moved to the trash' : 'restored';
-        $query_args  = [
-            'action' => 'ticket_list_table',
-            'status' => $trash ? '' : 'trashed',
-        ];
-        $this->_redirect_after_action($success, esc_html__('Tickets', 'event_espresso'), $action_desc, $query_args);
-    }
-
-
-    /**
-     * Handles trashing default ticket.
-     *
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _delete_ticket()
-    {
-        $success = 1;
-        // checkboxes?
-        $checkboxes = $this->request->getRequestParam('checkbox', [], 'int', true);
-        if (! empty($checkboxes)) {
-            // if array has more than one element then success message should be plural
-            $success = count($checkboxes) > 1 ? 2 : 1;
-            // cycle thru the boxes
-            $checkboxes = $this->_req_data['checkbox'];
-            foreach (array_keys($checkboxes) as $TKT_ID) {
-                // delete
-                if (! $this->_delete_the_ticket($TKT_ID)) {
-                    $success = 0;
-                }
-            }
-        } else {
-            // grab single id and trash
-            $TKT_ID = $this->request->getRequestParam('TKT_ID', 0, 'int');
-            if (! $this->_delete_the_ticket($TKT_ID)) {
-                $success = 0;
-            }
-        }
-        $action_desc = 'deleted';
-        $query_args  = [
-            'action' => 'ticket_list_table',
-            'status' => 'trashed',
-        ];
-        // fail safe.  If the default ticket count === 1 then we need to redirect to event overview.
-        if (
-            EEM_Ticket::instance()->count_deleted_and_undeleted(
-                [['TKT_is_default' => 1]],
-                'TKT_ID',
-                true
-            )
-        ) {
-            $query_args = [];
-        }
-        $this->_redirect_after_action($success, esc_html__('Tickets', 'event_espresso'), $action_desc, $query_args);
-    }
-
-
-    /**
-     * @param int $TKT_ID
-     * @return bool|int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _delete_the_ticket($TKT_ID)
-    {
-        $ticket = EEM_Ticket::instance()->get_one_by_ID($TKT_ID);
-        $ticket->_remove_relations('Datetime');
-        // delete all related prices first
-        $ticket->delete_related_permanently('Price');
-        return $ticket->delete_permanently();
-    }
+		}
+		if (EE_Registry::instance()->CAP->current_user_can('ee_read_global_messages', 'view_filtered_messages')) {
+			EE_Registry::instance()->load_helper('MSG_Template');
+			$action_links[] = EEH_MSG_Template::get_message_action_link(
+				'see_notifications_for',
+				null,
+				['EVT_ID' => $event->ID()]
+			);
+		}
+		return $action_links;
+	}
+
+
+	/**
+	 * @param $items
+	 * @return mixed
+	 */
+	public function additional_legend_items($items)
+	{
+		if (
+			EE_Registry::instance()->CAP->current_user_can(
+				'ee_read_registrations',
+				'espresso_registrations_reports'
+			)
+		) {
+			$items['reports'] = [
+				'class' => 'dashicons dashicons-chart-bar',
+				'desc'  => esc_html__('Event Reports', 'event_espresso'),
+			];
+		}
+		if (EE_Registry::instance()->CAP->current_user_can('ee_read_global_messages', 'view_filtered_messages')) {
+			$related_for_icon = EEH_MSG_Template::get_message_action_icon('see_notifications_for');
+			if (isset($related_for_icon['css_class']) && isset($related_for_icon['label'])) {
+				$items['view_related_messages'] = [
+					'class' => $related_for_icon['css_class'],
+					'desc'  => $related_for_icon['label'],
+				];
+			}
+		}
+		return $items;
+	}
+
+
+	/**
+	 * This is the callback method for the duplicate event route
+	 * Method looks for 'EVT_ID' in the request and retrieves that event and its details and duplicates them
+	 * into a new event.  We add a hook so that any plugins that add extra event details can hook into this
+	 * action.  Note that the dupe will have **DUPLICATE** as its title and slug.
+	 * After duplication the redirect is to the new event edit page.
+	 *
+	 * @return void
+	 * @throws EE_Error If EE_Event is not available with given ID
+	 * @throws ReflectionException
+	 * @access protected
+	 */
+	protected function _duplicate_event()
+	{
+		// first make sure the ID for the event is in the request.
+		//  If it isn't then we need to bail and redirect back to overview list table (cause how did we get here?)
+		$EVT_ID = $this->request->getRequestParam('EVT_ID', 0, 'int');
+		if (! $EVT_ID) {
+			EE_Error::add_error(
+				esc_html__(
+					'In order to duplicate an event an Event ID is required.  None was given.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$this->_redirect_after_action(false, '', '', [], true);
+			return;
+		}
+		// k we've got EVT_ID so let's use that to get the event we'll duplicate
+		$orig_event = EEM_Event::instance()->get_one_by_ID($EVT_ID);
+		if (! $orig_event instanceof EE_Event) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__('An EE_Event object could not be retrieved for the given ID (%s)', 'event_espresso'),
+					$EVT_ID
+				)
+			);
+		}
+		// k now let's clone the $orig_event before getting relations
+		$new_event = clone $orig_event;
+		// original datetimes
+		$orig_datetimes = $orig_event->get_many_related('Datetime');
+		// other original relations
+		$orig_ven = $orig_event->get_many_related('Venue');
+		// reset the ID and modify other details to make it clear this is a dupe
+		$new_event->set('EVT_ID', 0);
+		$new_name = $new_event->name() . ' ' . esc_html__('**DUPLICATE**', 'event_espresso');
+		$new_event->set('EVT_name', $new_name);
+		$new_event->set(
+			'EVT_slug',
+			wp_unique_post_slug(
+				sanitize_title($orig_event->name()),
+				0,
+				'publish',
+				'espresso_events',
+				0
+			)
+		);
+		$new_event->set('status', 'draft');
+		// duplicate discussion settings
+		$new_event->set('comment_status', $orig_event->get('comment_status'));
+		$new_event->set('ping_status', $orig_event->get('ping_status'));
+		// save the new event
+		$new_event->save();
+		// venues
+		foreach ($orig_ven as $ven) {
+			$new_event->_add_relation_to($ven, 'Venue');
+		}
+		$new_event->save();
+		// now we need to get the question group relations and handle that
+		// first primary question groups
+		$orig_primary_qgs = $orig_event->get_many_related(
+			'Question_Group',
+			[['Event_Question_Group.EQG_primary' => true]]
+		);
+		if (! empty($orig_primary_qgs)) {
+			foreach ($orig_primary_qgs as $obj) {
+				if ($obj instanceof EE_Question_Group) {
+					$new_event->_add_relation_to($obj, 'Question_Group', ['EQG_primary' => true]);
+				}
+			}
+		}
+		// next additional attendee question groups
+		$orig_additional_qgs = $orig_event->get_many_related(
+			'Question_Group',
+			[['Event_Question_Group.EQG_additional' => true]]
+		);
+		if (! empty($orig_additional_qgs)) {
+			foreach ($orig_additional_qgs as $obj) {
+				if ($obj instanceof EE_Question_Group) {
+					$new_event->_add_relation_to($obj, 'Question_Group', ['EQG_additional' => true]);
+				}
+			}
+		}
+
+		$new_event->save();
+
+		// k now that we have the new event saved we can loop through the datetimes and start adding relations.
+		$cloned_tickets = [];
+		foreach ($orig_datetimes as $orig_dtt) {
+			if (! $orig_dtt instanceof EE_Datetime) {
+				continue;
+			}
+			$new_dtt      = clone $orig_dtt;
+			$orig_tickets = $orig_dtt->tickets();
+			// save new dtt then add to event
+			$new_dtt->set('DTT_ID', 0);
+			$new_dtt->set('DTT_sold', 0);
+			$new_dtt->set_reserved(0);
+			$new_dtt->save();
+			$new_event->_add_relation_to($new_dtt, 'Datetime');
+			$new_event->save();
+			// now let's get the ticket relations setup.
+			foreach ((array) $orig_tickets as $orig_ticket) {
+				// it's possible a datetime will have no tickets so let's verify we HAVE a ticket first.
+				if (! $orig_ticket instanceof EE_Ticket) {
+					continue;
+				}
+				// is this ticket archived?  If it is then let's skip
+				if ($orig_ticket->get('TKT_deleted')) {
+					continue;
+				}
+				// does this original ticket already exist in the clone_tickets cache?
+				//  If so we'll just use the new ticket from it.
+				if (isset($cloned_tickets[ $orig_ticket->ID() ])) {
+					$new_ticket = $cloned_tickets[ $orig_ticket->ID() ];
+				} else {
+					$new_ticket = clone $orig_ticket;
+					// get relations on the $orig_ticket that we need to setup.
+					$orig_prices = $orig_ticket->prices();
+					$new_ticket->set('TKT_ID', 0);
+					$new_ticket->set('TKT_sold', 0);
+					$new_ticket->set('TKT_reserved', 0);
+					$new_ticket->save(); // make sure new ticket has ID.
+					// price relations on new ticket need to be setup.
+					foreach ($orig_prices as $orig_price) {
+						$new_price = clone $orig_price;
+						$new_price->set('PRC_ID', 0);
+						$new_price->save();
+						$new_ticket->_add_relation_to($new_price, 'Price');
+						$new_ticket->save();
+					}
+
+					do_action(
+						'AHEE__Extend_Events_Admin_Page___duplicate_event__duplicate_ticket__after',
+						$orig_ticket,
+						$new_ticket,
+						$orig_prices,
+						$orig_event,
+						$orig_dtt,
+						$new_dtt
+					);
+				}
+				// k now we can add the new ticket as a relation to the new datetime
+				// and make sure its added to our cached $cloned_tickets array
+				// for use with later datetimes that have the same ticket.
+				$new_dtt->_add_relation_to($new_ticket, 'Ticket');
+				$new_dtt->save();
+				$cloned_tickets[ $orig_ticket->ID() ] = $new_ticket;
+			}
+		}
+		// clone taxonomy information
+		$taxonomies_to_clone_with = apply_filters(
+			'FHEE__Extend_Events_Admin_Page___duplicate_event__taxonomies_to_clone',
+			['espresso_event_categories', 'espresso_event_type', 'post_tag']
+		);
+		// get terms for original event (notice)
+		$orig_terms = wp_get_object_terms($orig_event->ID(), $taxonomies_to_clone_with);
+		// loop through terms and add them to new event.
+		foreach ($orig_terms as $term) {
+			wp_set_object_terms($new_event->ID(), $term->term_id, $term->taxonomy, true);
+		}
+
+		// duplicate other core WP_Post items for this event.
+		// post thumbnail (feature image).
+		$feature_image_id = get_post_thumbnail_id($orig_event->ID());
+		if ($feature_image_id) {
+			update_post_meta($new_event->ID(), '_thumbnail_id', $feature_image_id);
+		}
+
+		// duplicate page_template setting
+		$page_template = get_post_meta($orig_event->ID(), '_wp_page_template', true);
+		if ($page_template) {
+			update_post_meta($new_event->ID(), '_wp_page_template', $page_template);
+		}
+
+		do_action('AHEE__Extend_Events_Admin_Page___duplicate_event__after', $new_event, $orig_event);
+		// now let's redirect to the edit page for this duplicated event if we have a new event id.
+		if ($new_event->ID()) {
+			$redirect_args = [
+				'post'   => $new_event->ID(),
+				'action' => 'edit',
+			];
+			EE_Error::add_success(
+				esc_html__(
+					'Event successfully duplicated.  Please review the details below and make any necessary edits',
+					'event_espresso'
+				)
+			);
+		} else {
+			$redirect_args = [
+				'action' => 'default',
+			];
+			EE_Error::add_error(
+				esc_html__('Not able to duplicate event.  Something went wrong.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		$this->_redirect_after_action(false, '', '', $redirect_args, true);
+	}
+
+
+	/**
+	 * Generates output for the import page.
+	 *
+	 * @throws EE_Error
+	 */
+	protected function _import_page()
+	{
+		$title = esc_html__('Import', 'event_espresso');
+		$intro = esc_html__(
+			'If you have a previously exported Event Espresso 4 information in a Comma Separated Value (CSV) file format, you can upload the file here: ',
+			'event_espresso'
+		);
+
+		$form_url = EVENTS_ADMIN_URL;
+		$action   = 'import_events';
+		$type     = 'csv';
+
+		$this->_template_args['form'] = EE_Import::instance()->upload_form(
+			$title,
+			$intro,
+			$form_url,
+			$action,
+			$type
+		);
+
+		$this->_template_args['sample_file_link']   = EE_Admin_Page::add_query_args_and_nonce(
+			['action' => 'sample_export_file'],
+			$this->_admin_base_url
+		);
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(
+			EVENTS_CAF_TEMPLATE_PATH . 'import_page.template.php',
+			$this->_template_args,
+			true
+		);
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	/**
+	 * _import_events
+	 * This handles displaying the screen and running imports for importing events.
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	protected function _import_events()
+	{
+		require_once(EE_CLASSES . 'EE_Import.class.php');
+		$success = EE_Import::instance()->import();
+		$this->_redirect_after_action(
+			$success,
+			esc_html__('Import File', 'event_espresso'),
+			'ran',
+			['action' => 'import_page'],
+			true
+		);
+	}
+
+
+	/**
+	 * _events_export
+	 * Will export all (or just the given event) to a Excel compatible file.
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _events_export()
+	{
+		$EVT_ID = $this->request->getRequestParam('EVT_ID', 0, 'int');
+		$EVT_ID = $this->request->getRequestParam('EVT_IDs', $EVT_ID, 'int');
+		$this->request->mergeRequestParams(
+			[
+				'export' => 'report',
+				'action' => 'all_event_data',
+				'EVT_ID' => $EVT_ID,
+			]
+		);
+		if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
+			require_once(EE_CLASSES . 'EE_Export.class.php');
+			$EE_Export = EE_Export::instance($this->request->requestParams());
+			$EE_Export->export();
+		}
+	}
+
+
+	/**
+	 * handle category exports()
+	 *
+	 * @return void
+	 */
+	protected function _categories_export()
+	{
+		$EVT_ID = $this->request->getRequestParam('EVT_CAT_ID', 0, 'int');
+		$this->request->mergeRequestParams(
+			[
+				'export' => 'report',
+				'action' => 'categories',
+				'EVT_ID' => $EVT_ID,
+			]
+		);
+		if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
+			require_once(EE_CLASSES . 'EE_Export.class.php');
+			$EE_Export = EE_Export::instance($this->request->requestParams());
+			$EE_Export->export();
+		}
+	}
+
+
+	/**
+	 * Creates a sample CSV file for importing
+	 */
+	protected function _sample_export_file()
+	{
+		// require_once(EE_CLASSES . 'EE_Export.class.php');
+		EE_Export::instance()->export_sample();
+	}
+
+
+	/*************        Template Settings        *************/
+	/**
+	 * Generates template settings page output
+	 *
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	protected function _template_settings()
+	{
+		$this->_template_args['values'] = $this->_yes_no_values;
+		/**
+		 * Note leaving this filter in for backward compatibility this was moved in 4.6.x
+		 * from General_Settings_Admin_Page to here.
+		 */
+		$this->_template_args = apply_filters(
+			'FHEE__General_Settings_Admin_Page__template_settings__template_args',
+			$this->_template_args
+		);
+		$this->_set_add_edit_form_tags('update_template_settings');
+		$this->_set_publish_post_box_vars(null, false, false, null, false);
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(
+			EVENTS_CAF_TEMPLATE_PATH . 'template_settings.template.php',
+			$this->_template_args,
+			true
+		);
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	/**
+	 * Handler for updating template settings.
+	 *
+	 * @throws EE_Error
+	 */
+	protected function _update_template_settings()
+	{
+		/**
+		 * Note leaving this filter in for backward compatibility this was moved in 4.6.x
+		 * from General_Settings_Admin_Page to here.
+		 */
+		EE_Registry::instance()->CFG->template_settings = apply_filters(
+			'FHEE__General_Settings_Admin_Page__update_template_settings__data',
+			EE_Registry::instance()->CFG->template_settings,
+			$this->request->requestParams()
+		);
+		// update custom post type slugs and detect if we need to flush rewrite rules
+		$old_slug = EE_Registry::instance()->CFG->core->event_cpt_slug;
+
+		$event_cpt_slug = $this->request->getRequestParam('event_cpt_slug');
+
+		EE_Registry::instance()->CFG->core->event_cpt_slug = $event_cpt_slug
+			? EEH_URL::slugify($event_cpt_slug, 'events')
+			: EE_Registry::instance()->CFG->core->event_cpt_slug;
+
+		$what    = esc_html__('Template Settings', 'event_espresso');
+		$success = $this->_update_espresso_configuration(
+			$what,
+			EE_Registry::instance()->CFG->template_settings,
+			__FILE__,
+			__FUNCTION__,
+			__LINE__
+		);
+		if (EE_Registry::instance()->CFG->core->event_cpt_slug != $old_slug) {
+			/** @var EventEspresso\core\domain\services\custom_post_types\RewriteRules $rewrite_rules */
+			$rewrite_rules = LoaderFactory::getLoader()->getShared(
+				'EventEspresso\core\domain\services\custom_post_types\RewriteRules'
+			);
+			$rewrite_rules->flush();
+		}
+		$this->_redirect_after_action($success, $what, 'updated', ['action' => 'template_settings']);
+	}
+
+
+	/**
+	 * _premium_event_editor_meta_boxes
+	 * add all metaboxes related to the event_editor
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _premium_event_editor_meta_boxes()
+	{
+		$this->verify_cpt_object();
+		add_meta_box(
+			'espresso_event_editor_event_options',
+			esc_html__('Event Registration Options', 'event_espresso'),
+			[$this, 'registration_options_meta_box'],
+			$this->page_slug,
+			'side',
+			'core'
+		);
+	}
+
+
+	/**
+	 * override caf metabox
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function registration_options_meta_box()
+	{
+		$yes_no_values = [
+			['id' => true, 'text' => esc_html__('Yes', 'event_espresso')],
+			['id' => false, 'text' => esc_html__('No', 'event_espresso')],
+		];
+
+		$default_reg_status_values = EEM_Registration::reg_status_array(
+			[
+				EEM_Registration::status_id_cancelled,
+				EEM_Registration::status_id_declined,
+				EEM_Registration::status_id_incomplete,
+				EEM_Registration::status_id_wait_list,
+			],
+			true
+		);
+
+		$template_args['active_status']    = $this->_cpt_model_obj->pretty_active_status(false);
+		$template_args['_event']           = $this->_cpt_model_obj;
+		$template_args['additional_limit'] = $this->_cpt_model_obj->additional_limit();
+
+		$template_args['default_registration_status']     = EEH_Form_Fields::select_input(
+			'default_reg_status',
+			$default_reg_status_values,
+			$this->_cpt_model_obj->default_registration_status()
+		);
+		$template_args['display_description']             = EEH_Form_Fields::select_input(
+			'display_desc',
+			$yes_no_values,
+			$this->_cpt_model_obj->display_description()
+		);
+		$template_args['display_ticket_selector']         = EEH_Form_Fields::select_input(
+			'display_ticket_selector',
+			$yes_no_values,
+			$this->_cpt_model_obj->display_ticket_selector(),
+			'',
+			'',
+			false
+		);
+		$template_args['EVT_default_registration_status'] = EEH_Form_Fields::select_input(
+			'EVT_default_registration_status',
+			$default_reg_status_values,
+			$this->_cpt_model_obj->default_registration_status()
+		);
+		$template_args['additional_registration_options'] = apply_filters(
+			'FHEE__Events_Admin_Page__registration_options_meta_box__additional_registration_options',
+			'',
+			$template_args,
+			$yes_no_values,
+			$default_reg_status_values
+		);
+		EEH_Template::display_template(
+			EVENTS_CAF_TEMPLATE_PATH . 'event_registration_options.template.php',
+			$template_args
+		);
+	}
+
+
+
+	/**
+	 * wp_list_table_mods for caf
+	 * ============================
+	 */
+	/**
+	 * hook into list table filters and provide filters for caffeinated list table
+	 *
+	 * @param array $old_filters    any existing filters present
+	 * @param array $list_table_obj the list table object
+	 * @return array                  new filters
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function list_table_filters($old_filters, $list_table_obj)
+	{
+		$filters = [];
+		// first month/year filters
+		$filters[] = $this->espresso_event_months_dropdown();
+		$status    = $this->request->getRequestParam('status');
+		// active status dropdown
+		if ($status !== 'draft') {
+			$filters[] = $this->active_status_dropdown($this->request->getRequestParam('active_status'));
+			$filters[] = $this->venuesDropdown($this->request->getRequestParam('venue'));
+		}
+		// category filter
+		$filters[] = $this->category_dropdown();
+		return array_merge($old_filters, $filters);
+	}
+
+
+	/**
+	 * espresso_event_months_dropdown
+	 *
+	 * @access public
+	 * @return string                dropdown listing month/year selections for events.
+	 * @throws EE_Error
+	 */
+	public function espresso_event_months_dropdown()
+	{
+		// what we need to do is get all PRIMARY datetimes for all events to filter on.
+		// Note we need to include any other filters that are set!
+		return EEH_Form_Fields::generate_event_months_dropdown(
+			$this->request->getRequestParam('month_range'),
+			$this->request->getRequestParam('status'),
+			$this->request->getRequestParam('EVT_CAT', 0, 'int'),
+			$this->request->getRequestParam('active_status')
+		);
+	}
+
+
+	/**
+	 * returns a list of "active" statuses on the event
+	 *
+	 * @param string $current_value whatever the current active status is
+	 * @return string
+	 */
+	public function active_status_dropdown($current_value = '')
+	{
+		$select_name = 'active_status';
+		$values      = [
+			'none'     => esc_html__('Show Active/Inactive', 'event_espresso'),
+			'active'   => esc_html__('Active', 'event_espresso'),
+			'upcoming' => esc_html__('Upcoming', 'event_espresso'),
+			'expired'  => esc_html__('Expired', 'event_espresso'),
+			'inactive' => esc_html__('Inactive', 'event_espresso'),
+		];
+
+		return EEH_Form_Fields::select_input($select_name, $values, $current_value, '', 'wide');
+	}
+
+
+	/**
+	 * returns a list of "venues"
+	 *
+	 * @param string $current_value whatever the current active status is
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function venuesDropdown($current_value = '')
+	{
+		$values = [
+			'' => esc_html__('All Venues', 'event_espresso'),
+		];
+		// populate the list of venues.
+		$venues = EEM_Venue::instance()->get_all(['order_by' => ['VNU_name' => 'ASC']]);
+
+		foreach ($venues as $venue) {
+			$values[ $venue->ID() ] = $venue->name();
+		}
+
+		return EEH_Form_Fields::select_input('venue', $values, $current_value, '', 'wide');
+	}
+
+
+	/**
+	 * output a dropdown of the categories for the category filter on the event admin list table
+	 *
+	 * @access  public
+	 * @return string html
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function category_dropdown()
+	{
+		return EEH_Form_Fields::generate_event_category_dropdown(
+			$this->request->getRequestParam('EVT_CAT', -1, 'int')
+		);
+	}
+
+
+	/**
+	 * get total number of events today
+	 *
+	 * @access public
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function total_events_today()
+	{
+		$start = EEM_Datetime::instance()->convert_datetime_for_query(
+			'DTT_EVT_start',
+			date('Y-m-d') . ' 00:00:00',
+			'Y-m-d H:i:s',
+			'UTC'
+		);
+		$end   = EEM_Datetime::instance()->convert_datetime_for_query(
+			'DTT_EVT_start',
+			date('Y-m-d') . ' 23:59:59',
+			'Y-m-d H:i:s',
+			'UTC'
+		);
+		$where = [
+			'Datetime.DTT_EVT_start' => ['BETWEEN', [$start, $end]],
+		];
+		return EEM_Event::instance()->count([$where, 'caps' => 'read_admin'], 'EVT_ID', true);
+	}
+
+
+	/**
+	 * get total number of events this month
+	 *
+	 * @access public
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function total_events_this_month()
+	{
+		// Dates
+		$this_year_r     = date('Y');
+		$this_month_r    = date('m');
+		$days_this_month = date('t');
+		$start           = EEM_Datetime::instance()->convert_datetime_for_query(
+			'DTT_EVT_start',
+			$this_year_r . '-' . $this_month_r . '-01 00:00:00',
+			'Y-m-d H:i:s',
+			'UTC'
+		);
+		$end             = EEM_Datetime::instance()->convert_datetime_for_query(
+			'DTT_EVT_start',
+			$this_year_r . '-' . $this_month_r . '-' . $days_this_month . ' 23:59:59',
+			'Y-m-d H:i:s',
+			'UTC'
+		);
+		$where           = [
+			'Datetime.DTT_EVT_start' => ['BETWEEN', [$start, $end]],
+		];
+		return EEM_Event::instance()->count([$where, 'caps' => 'read_admin'], 'EVT_ID', true);
+	}
+
+
+	/** DEFAULT TICKETS STUFF **/
+
+	/**
+	 * Output default tickets list table view.
+	 *
+	 * @throws EE_Error
+	 */
+	public function _tickets_overview_list_table()
+	{
+		$this->_search_btn_label = esc_html__('Tickets', 'event_espresso');
+		$this->display_admin_list_table_page_with_no_sidebar();
+	}
+
+
+	/**
+	 * @param int  $per_page
+	 * @param bool $count
+	 * @param bool $trashed
+	 * @return EE_Soft_Delete_Base_Class[]|int
+	 * @throws EE_Error
+	 */
+	public function get_default_tickets($per_page = 10, $count = false, $trashed = false)
+	{
+		$orderby = $this->request->getRequestParam('orderby', 'TKT_name');
+		$order   = $this->request->getRequestParam('order', 'ASC');
+		switch ($orderby) {
+			case 'TKT_name':
+				$orderby = ['TKT_name' => $order];
+				break;
+			case 'TKT_price':
+				$orderby = ['TKT_price' => $order];
+				break;
+			case 'TKT_uses':
+				$orderby = ['TKT_uses' => $order];
+				break;
+			case 'TKT_min':
+				$orderby = ['TKT_min' => $order];
+				break;
+			case 'TKT_max':
+				$orderby = ['TKT_max' => $order];
+				break;
+			case 'TKT_qty':
+				$orderby = ['TKT_qty' => $order];
+				break;
+		}
+
+		$current_page = $this->request->getRequestParam('paged', 1, 'int');
+		$per_page     = $this->request->getRequestParam('perpage', $per_page, 'int');
+		$offset       = ($current_page - 1) * $per_page;
+
+		$where = [
+			'TKT_is_default' => 1,
+			'TKT_deleted'    => $trashed,
+		];
+
+		$search_term = $this->request->getRequestParam('s');
+		if ($search_term) {
+			$search_term = '%' . $search_term . '%';
+			$where['OR'] = [
+				'TKT_name'        => ['LIKE', $search_term],
+				'TKT_description' => ['LIKE', $search_term],
+			];
+		}
+
+		return $count
+			? EEM_Ticket::instance()->count_deleted_and_undeleted([$where])
+			: EEM_Ticket::instance()->get_all_deleted_and_undeleted(
+				[
+					$where,
+					'order_by' => $orderby,
+					'limit'    => [$offset, $per_page],
+					'group_by' => 'TKT_ID',
+				]
+			);
+	}
+
+
+	/**
+	 * @param bool $trash
+	 * @throws EE_Error
+	 */
+	protected function _trash_or_restore_ticket($trash = false)
+	{
+		$success = 1;
+		$TKT     = EEM_Ticket::instance();
+		// checkboxes?
+		$checkboxes = $this->request->getRequestParam('checkbox', [], 'int', true);
+		if (! empty($checkboxes)) {
+			// if array has more than one element then success message should be plural
+			$success = count($checkboxes) > 1 ? 2 : 1;
+			// cycle thru the boxes
+			$checkboxes = $this->_req_data['checkbox'];
+			foreach (array_keys($checkboxes) as $TKT_ID) {
+				if ($trash) {
+					if (! $TKT->delete_by_ID($TKT_ID)) {
+						$success = 0;
+					}
+				} else {
+					if (! $TKT->restore_by_ID($TKT_ID)) {
+						$success = 0;
+					}
+				}
+			}
+		} else {
+			// grab single id and trash
+			$TKT_ID = $this->request->getRequestParam('TKT_ID', 0, 'int');
+			if ($trash) {
+				if (! $TKT->delete_by_ID($TKT_ID)) {
+					$success = 0;
+				}
+			} else {
+				if (! $TKT->restore_by_ID($TKT_ID)) {
+					$success = 0;
+				}
+			}
+		}
+		$action_desc = $trash ? 'moved to the trash' : 'restored';
+		$query_args  = [
+			'action' => 'ticket_list_table',
+			'status' => $trash ? '' : 'trashed',
+		];
+		$this->_redirect_after_action($success, esc_html__('Tickets', 'event_espresso'), $action_desc, $query_args);
+	}
+
+
+	/**
+	 * Handles trashing default ticket.
+	 *
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _delete_ticket()
+	{
+		$success = 1;
+		// checkboxes?
+		$checkboxes = $this->request->getRequestParam('checkbox', [], 'int', true);
+		if (! empty($checkboxes)) {
+			// if array has more than one element then success message should be plural
+			$success = count($checkboxes) > 1 ? 2 : 1;
+			// cycle thru the boxes
+			$checkboxes = $this->_req_data['checkbox'];
+			foreach (array_keys($checkboxes) as $TKT_ID) {
+				// delete
+				if (! $this->_delete_the_ticket($TKT_ID)) {
+					$success = 0;
+				}
+			}
+		} else {
+			// grab single id and trash
+			$TKT_ID = $this->request->getRequestParam('TKT_ID', 0, 'int');
+			if (! $this->_delete_the_ticket($TKT_ID)) {
+				$success = 0;
+			}
+		}
+		$action_desc = 'deleted';
+		$query_args  = [
+			'action' => 'ticket_list_table',
+			'status' => 'trashed',
+		];
+		// fail safe.  If the default ticket count === 1 then we need to redirect to event overview.
+		if (
+			EEM_Ticket::instance()->count_deleted_and_undeleted(
+				[['TKT_is_default' => 1]],
+				'TKT_ID',
+				true
+			)
+		) {
+			$query_args = [];
+		}
+		$this->_redirect_after_action($success, esc_html__('Tickets', 'event_espresso'), $action_desc, $query_args);
+	}
+
+
+	/**
+	 * @param int $TKT_ID
+	 * @return bool|int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _delete_the_ticket($TKT_ID)
+	{
+		$ticket = EEM_Ticket::instance()->get_one_by_ID($TKT_ID);
+		$ticket->_remove_relations('Datetime');
+		// delete all related prices first
+		$ticket->delete_related_permanently('Price');
+		return $ticket->delete_permanently();
+	}
 }

Spacing +58 added lines, -58 removed lines

@@ -22,10 +22,10 @@ 
     public function __construct($routing = true)
     {
         parent::__construct($routing);
-        if (! defined('EVENTS_CAF_TEMPLATE_PATH')) {
-            define('EVENTS_CAF_TEMPLATE_PATH', EE_CORE_CAF_ADMIN_EXTEND . 'events/templates/');
-            define('EVENTS_CAF_ASSETS', EE_CORE_CAF_ADMIN_EXTEND . 'events/assets/');
-            define('EVENTS_CAF_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL . 'events/assets/');
+        if ( ! defined('EVENTS_CAF_TEMPLATE_PATH')) {
+            define('EVENTS_CAF_TEMPLATE_PATH', EE_CORE_CAF_ADMIN_EXTEND.'events/templates/');
+            define('EVENTS_CAF_ASSETS', EE_CORE_CAF_ADMIN_EXTEND.'events/assets/');
+            define('EVENTS_CAF_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL.'events/assets/');
         }
     }
 
@@ -37,7 +37,7 @@ 
      */
     protected function _extend_page_config()
     {
-        $this->_admin_base_path = EE_CORE_CAF_ADMIN_EXTEND . 'events';
+        $this->_admin_base_path = EE_CORE_CAF_ADMIN_EXTEND.'events';
         // is there a evt_id in the request?
         $EVT_ID             = $this->request->getRequestParam('EVT_ID', 0, 'int');
         $EVT_ID             = $this->request->getRequestParam('post', $EVT_ID, 'int');
@@ -164,7 +164,7 @@ 
             ],
             'require_nonce' => false,
         ];
-        $this->_page_config                   = array_merge($this->_page_config, $new_page_config);
+        $this->_page_config = array_merge($this->_page_config, $new_page_config);
         // add filters and actions
         // modifying _views
         add_filter(
@@ -241,20 +241,20 @@ 
     {
         $return = parent::extra_permalink_field_buttons($return, $id, $new_title, $new_slug);
         // make sure this is only when editing
-        if (! empty($id)) {
-            $href   = EE_Admin_Page::add_query_args_and_nonce(
+        if ( ! empty($id)) {
+            $href = EE_Admin_Page::add_query_args_and_nonce(
                 ['action' => 'duplicate_event', 'EVT_ID' => $id],
                 $this->_admin_base_url
             );
-            $title  = esc_attr__('Duplicate Event', 'event_espresso');
+            $title = esc_attr__('Duplicate Event', 'event_espresso');
             $return .= '
-                <a href="' . $href . '" 
-                   aria-label="' . $title . '" 
+                <a href="' . $href.'" 
+                   aria-label="' . $title.'" 
                    id="ee-duplicate-event-button" 
                    class="button button-small"
                    value="duplicate_event"
                 >
-                    ' . $title . '
+                    ' . $title.'
                 </a>';
         }
         return $return;
@@ -295,7 +295,7 @@ 
     {
         wp_register_script(
             'ee-event-editor-heartbeat',
-            EVENTS_CAF_ASSETS_URL . 'event-editor-heartbeat.js',
+            EVENTS_CAF_ASSETS_URL.'event-editor-heartbeat.js',
             ['ee_admin_js', 'heartbeat'],
             EVENT_ESPRESSO_VERSION,
             true
@@ -319,7 +319,7 @@ 
     public function add_additional_datetime_button($template, $template_args)
     {
         return EEH_Template::display_template(
-            EVENTS_CAF_TEMPLATE_PATH . 'event_datetime_add_additional_time.template.php',
+            EVENTS_CAF_TEMPLATE_PATH.'event_datetime_add_additional_time.template.php',
             $template_args,
             true
         );
@@ -337,7 +337,7 @@ 
     public function add_datetime_clone_button($template, $template_args)
     {
         return EEH_Template::display_template(
-            EVENTS_CAF_TEMPLATE_PATH . 'event_datetime_metabox_clone_button.template.php',
+            EVENTS_CAF_TEMPLATE_PATH.'event_datetime_metabox_clone_button.template.php',
             $template_args,
             true
         );
@@ -355,7 +355,7 @@ 
     public function datetime_timezones_template($template, $template_args)
     {
         return EEH_Template::display_template(
-            EVENTS_CAF_TEMPLATE_PATH . 'event_datetime_timezones.template.php',
+            EVENTS_CAF_TEMPLATE_PATH.'event_datetime_timezones.template.php',
             $template_args,
             true
         );
@@ -370,7 +370,7 @@ 
     protected function _set_list_table_views_default()
     {
         parent::_set_list_table_views_default();
-        $new_views    = [
+        $new_views = [
             'today' => [
                 'slug'        => 'today',
                 'label'       => esc_html__('Today', 'event_espresso'),
@@ -416,8 +416,8 @@ 
             ];
             $reports_link       = EE_Admin_Page::add_query_args_and_nonce($reports_query_args, REG_ADMIN_URL);
             $action_links[]     = '
-                <a href="' . $reports_link . '" 
-                   aria-label="' . esc_attr__('View Report', 'event_espresso') . '"
+                <a href="' . $reports_link.'" 
+                   aria-label="' . esc_attr__('View Report', 'event_espresso').'"
                 >
                     <div class="dashicons dashicons-chart-bar"></div>
                 </a>';
@@ -481,7 +481,7 @@ 
         // first make sure the ID for the event is in the request.
         //  If it isn't then we need to bail and redirect back to overview list table (cause how did we get here?)
         $EVT_ID = $this->request->getRequestParam('EVT_ID', 0, 'int');
-        if (! $EVT_ID) {
+        if ( ! $EVT_ID) {
             EE_Error::add_error(
                 esc_html__(
                     'In order to duplicate an event an Event ID is required.  None was given.',
@@ -496,7 +496,7 @@ 
         }
         // k we've got EVT_ID so let's use that to get the event we'll duplicate
         $orig_event = EEM_Event::instance()->get_one_by_ID($EVT_ID);
-        if (! $orig_event instanceof EE_Event) {
+        if ( ! $orig_event instanceof EE_Event) {
             throw new EE_Error(
                 sprintf(
                     esc_html__('An EE_Event object could not be retrieved for the given ID (%s)', 'event_espresso'),
@@ -512,7 +512,7 @@ 
         $orig_ven = $orig_event->get_many_related('Venue');
         // reset the ID and modify other details to make it clear this is a dupe
         $new_event->set('EVT_ID', 0);
-        $new_name = $new_event->name() . ' ' . esc_html__('**DUPLICATE**', 'event_espresso');
+        $new_name = $new_event->name().' '.esc_html__('**DUPLICATE**', 'event_espresso');
         $new_event->set('EVT_name', $new_name);
         $new_event->set(
             'EVT_slug',
@@ -541,7 +541,7 @@ 
             'Question_Group',
             [['Event_Question_Group.EQG_primary' => true]]
         );
-        if (! empty($orig_primary_qgs)) {
+        if ( ! empty($orig_primary_qgs)) {
             foreach ($orig_primary_qgs as $obj) {
                 if ($obj instanceof EE_Question_Group) {
                     $new_event->_add_relation_to($obj, 'Question_Group', ['EQG_primary' => true]);
@@ -553,7 +553,7 @@ 
             'Question_Group',
             [['Event_Question_Group.EQG_additional' => true]]
         );
-        if (! empty($orig_additional_qgs)) {
+        if ( ! empty($orig_additional_qgs)) {
             foreach ($orig_additional_qgs as $obj) {
                 if ($obj instanceof EE_Question_Group) {
                     $new_event->_add_relation_to($obj, 'Question_Group', ['EQG_additional' => true]);
@@ -566,7 +566,7 @@ 
         // k now that we have the new event saved we can loop through the datetimes and start adding relations.
         $cloned_tickets = [];
         foreach ($orig_datetimes as $orig_dtt) {
-            if (! $orig_dtt instanceof EE_Datetime) {
+            if ( ! $orig_dtt instanceof EE_Datetime) {
                 continue;
             }
             $new_dtt      = clone $orig_dtt;
@@ -581,7 +581,7 @@ 
             // now let's get the ticket relations setup.
             foreach ((array) $orig_tickets as $orig_ticket) {
                 // it's possible a datetime will have no tickets so let's verify we HAVE a ticket first.
-                if (! $orig_ticket instanceof EE_Ticket) {
+                if ( ! $orig_ticket instanceof EE_Ticket) {
                     continue;
                 }
                 // is this ticket archived?  If it is then let's skip
@@ -590,8 +590,8 @@ 
                 }
                 // does this original ticket already exist in the clone_tickets cache?
                 //  If so we'll just use the new ticket from it.
-                if (isset($cloned_tickets[ $orig_ticket->ID() ])) {
-                    $new_ticket = $cloned_tickets[ $orig_ticket->ID() ];
+                if (isset($cloned_tickets[$orig_ticket->ID()])) {
+                    $new_ticket = $cloned_tickets[$orig_ticket->ID()];
                 } else {
                     $new_ticket = clone $orig_ticket;
                     // get relations on the $orig_ticket that we need to setup.
@@ -624,7 +624,7 @@ 
                 // for use with later datetimes that have the same ticket.
                 $new_dtt->_add_relation_to($new_ticket, 'Ticket');
                 $new_dtt->save();
-                $cloned_tickets[ $orig_ticket->ID() ] = $new_ticket;
+                $cloned_tickets[$orig_ticket->ID()] = $new_ticket;
             }
         }
         // clone taxonomy information
@@ -705,12 +705,12 @@ 
             $type
         );
 
-        $this->_template_args['sample_file_link']   = EE_Admin_Page::add_query_args_and_nonce(
+        $this->_template_args['sample_file_link'] = EE_Admin_Page::add_query_args_and_nonce(
             ['action' => 'sample_export_file'],
             $this->_admin_base_url
         );
         $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            EVENTS_CAF_TEMPLATE_PATH . 'import_page.template.php',
+            EVENTS_CAF_TEMPLATE_PATH.'import_page.template.php',
             $this->_template_args,
             true
         );
@@ -727,7 +727,7 @@ 
      */
     protected function _import_events()
     {
-        require_once(EE_CLASSES . 'EE_Import.class.php');
+        require_once(EE_CLASSES.'EE_Import.class.php');
         $success = EE_Import::instance()->import();
         $this->_redirect_after_action(
             $success,
@@ -757,8 +757,8 @@ 
                 'EVT_ID' => $EVT_ID,
             ]
         );
-        if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
-            require_once(EE_CLASSES . 'EE_Export.class.php');
+        if (is_readable(EE_CLASSES.'EE_Export.class.php')) {
+            require_once(EE_CLASSES.'EE_Export.class.php');
             $EE_Export = EE_Export::instance($this->request->requestParams());
             $EE_Export->export();
         }
@@ -780,8 +780,8 @@ 
                 'EVT_ID' => $EVT_ID,
             ]
         );
-        if (is_readable(EE_CLASSES . 'EE_Export.class.php')) {
-            require_once(EE_CLASSES . 'EE_Export.class.php');
+        if (is_readable(EE_CLASSES.'EE_Export.class.php')) {
+            require_once(EE_CLASSES.'EE_Export.class.php');
             $EE_Export = EE_Export::instance($this->request->requestParams());
             $EE_Export->export();
         }
@@ -819,7 +819,7 @@ 
         $this->_set_add_edit_form_tags('update_template_settings');
         $this->_set_publish_post_box_vars(null, false, false, null, false);
         $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            EVENTS_CAF_TEMPLATE_PATH . 'template_settings.template.php',
+            EVENTS_CAF_TEMPLATE_PATH.'template_settings.template.php',
             $this->_template_args,
             true
         );
@@ -922,17 +922,17 @@ 
         $template_args['_event']           = $this->_cpt_model_obj;
         $template_args['additional_limit'] = $this->_cpt_model_obj->additional_limit();
 
-        $template_args['default_registration_status']     = EEH_Form_Fields::select_input(
+        $template_args['default_registration_status'] = EEH_Form_Fields::select_input(
             'default_reg_status',
             $default_reg_status_values,
             $this->_cpt_model_obj->default_registration_status()
         );
-        $template_args['display_description']             = EEH_Form_Fields::select_input(
+        $template_args['display_description'] = EEH_Form_Fields::select_input(
             'display_desc',
             $yes_no_values,
             $this->_cpt_model_obj->display_description()
         );
-        $template_args['display_ticket_selector']         = EEH_Form_Fields::select_input(
+        $template_args['display_ticket_selector'] = EEH_Form_Fields::select_input(
             'display_ticket_selector',
             $yes_no_values,
             $this->_cpt_model_obj->display_ticket_selector(),
@@ -953,7 +953,7 @@ 
             $default_reg_status_values
         );
         EEH_Template::display_template(
-            EVENTS_CAF_TEMPLATE_PATH . 'event_registration_options.template.php',
+            EVENTS_CAF_TEMPLATE_PATH.'event_registration_options.template.php',
             $template_args
         );
     }
@@ -1048,7 +1048,7 @@ 
         $venues = EEM_Venue::instance()->get_all(['order_by' => ['VNU_name' => 'ASC']]);
 
         foreach ($venues as $venue) {
-            $values[ $venue->ID() ] = $venue->name();
+            $values[$venue->ID()] = $venue->name();
         }
 
         return EEH_Form_Fields::select_input('venue', $values, $current_value, '', 'wide');
@@ -1082,13 +1082,13 @@ 
     {
         $start = EEM_Datetime::instance()->convert_datetime_for_query(
             'DTT_EVT_start',
-            date('Y-m-d') . ' 00:00:00',
+            date('Y-m-d').' 00:00:00',
             'Y-m-d H:i:s',
             'UTC'
         );
-        $end   = EEM_Datetime::instance()->convert_datetime_for_query(
+        $end = EEM_Datetime::instance()->convert_datetime_for_query(
             'DTT_EVT_start',
-            date('Y-m-d') . ' 23:59:59',
+            date('Y-m-d').' 23:59:59',
             'Y-m-d H:i:s',
             'UTC'
         );
@@ -1114,17 +1114,17 @@ 
         $days_this_month = date('t');
         $start           = EEM_Datetime::instance()->convert_datetime_for_query(
             'DTT_EVT_start',
-            $this_year_r . '-' . $this_month_r . '-01 00:00:00',
+            $this_year_r.'-'.$this_month_r.'-01 00:00:00',
             'Y-m-d H:i:s',
             'UTC'
         );
-        $end             = EEM_Datetime::instance()->convert_datetime_for_query(
+        $end = EEM_Datetime::instance()->convert_datetime_for_query(
             'DTT_EVT_start',
-            $this_year_r . '-' . $this_month_r . '-' . $days_this_month . ' 23:59:59',
+            $this_year_r.'-'.$this_month_r.'-'.$days_this_month.' 23:59:59',
             'Y-m-d H:i:s',
             'UTC'
         );
-        $where           = [
+        $where = [
             'Datetime.DTT_EVT_start' => ['BETWEEN', [$start, $end]],
         ];
         return EEM_Event::instance()->count([$where, 'caps' => 'read_admin'], 'EVT_ID', true);
@@ -1188,7 +1188,7 @@ 
 
         $search_term = $this->request->getRequestParam('s');
         if ($search_term) {
-            $search_term = '%' . $search_term . '%';
+            $search_term = '%'.$search_term.'%';
             $where['OR'] = [
                 'TKT_name'        => ['LIKE', $search_term],
                 'TKT_description' => ['LIKE', $search_term],
@@ -1218,18 +1218,18 @@ 
         $TKT     = EEM_Ticket::instance();
         // checkboxes?
         $checkboxes = $this->request->getRequestParam('checkbox', [], 'int', true);
-        if (! empty($checkboxes)) {
+        if ( ! empty($checkboxes)) {
             // if array has more than one element then success message should be plural
             $success = count($checkboxes) > 1 ? 2 : 1;
             // cycle thru the boxes
             $checkboxes = $this->_req_data['checkbox'];
             foreach (array_keys($checkboxes) as $TKT_ID) {
                 if ($trash) {
-                    if (! $TKT->delete_by_ID($TKT_ID)) {
+                    if ( ! $TKT->delete_by_ID($TKT_ID)) {
                         $success = 0;
                     }
                 } else {
-                    if (! $TKT->restore_by_ID($TKT_ID)) {
+                    if ( ! $TKT->restore_by_ID($TKT_ID)) {
                         $success = 0;
                     }
                 }
@@ -1238,11 +1238,11 @@ 
             // grab single id and trash
             $TKT_ID = $this->request->getRequestParam('TKT_ID', 0, 'int');
             if ($trash) {
-                if (! $TKT->delete_by_ID($TKT_ID)) {
+                if ( ! $TKT->delete_by_ID($TKT_ID)) {
                     $success = 0;
                 }
             } else {
-                if (! $TKT->restore_by_ID($TKT_ID)) {
+                if ( ! $TKT->restore_by_ID($TKT_ID)) {
                     $success = 0;
                 }
             }
@@ -1267,21 +1267,21 @@ 
         $success = 1;
         // checkboxes?
         $checkboxes = $this->request->getRequestParam('checkbox', [], 'int', true);
-        if (! empty($checkboxes)) {
+        if ( ! empty($checkboxes)) {
             // if array has more than one element then success message should be plural
             $success = count($checkboxes) > 1 ? 2 : 1;
             // cycle thru the boxes
             $checkboxes = $this->_req_data['checkbox'];
             foreach (array_keys($checkboxes) as $TKT_ID) {
                 // delete
-                if (! $this->_delete_the_ticket($TKT_ID)) {
+                if ( ! $this->_delete_the_ticket($TKT_ID)) {
                     $success = 0;
                 }
             }
         } else {
             // grab single id and trash
             $TKT_ID = $this->request->getRequestParam('TKT_ID', 0, 'int');
-            if (! $this->_delete_the_ticket($TKT_ID)) {
+            if ( ! $this->_delete_the_ticket($TKT_ID)) {
                 $success = 0;
             }
         }

caffeinated/admin/extend/registrations/Extend_Registrations_Admin_Page.core.php

Indentation +1220 added lines, -1220 removed lines

@@ -14,1278 +14,1278 @@
  */
 class Extend_Registrations_Admin_Page extends Registrations_Admin_Page
 {
-    /**
-     * This is used to hold the reports template data which is setup early in the request.
-     *
-     * @type array
-     */
-    protected $_reports_template_data = array();
+	/**
+	 * This is used to hold the reports template data which is setup early in the request.
+	 *
+	 * @type array
+	 */
+	protected $_reports_template_data = array();
 
 
-    /**
-     * Extend_Registrations_Admin_Page constructor.
-     *
-     * @param bool $routing
-     */
-    public function __construct($routing = true)
-    {
-        parent::__construct($routing);
-        if (! defined('REG_CAF_TEMPLATE_PATH')) {
-            define('REG_CAF_TEMPLATE_PATH', EE_CORE_CAF_ADMIN_EXTEND . 'registrations/templates/');
-            define('REG_CAF_ASSETS', EE_CORE_CAF_ADMIN_EXTEND . 'registrations/assets/');
-            define('REG_CAF_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL . 'registrations/assets/');
-        }
-    }
+	/**
+	 * Extend_Registrations_Admin_Page constructor.
+	 *
+	 * @param bool $routing
+	 */
+	public function __construct($routing = true)
+	{
+		parent::__construct($routing);
+		if (! defined('REG_CAF_TEMPLATE_PATH')) {
+			define('REG_CAF_TEMPLATE_PATH', EE_CORE_CAF_ADMIN_EXTEND . 'registrations/templates/');
+			define('REG_CAF_ASSETS', EE_CORE_CAF_ADMIN_EXTEND . 'registrations/assets/');
+			define('REG_CAF_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL . 'registrations/assets/');
+		}
+	}
 
 
-    /**
-     * Extending page configuration.
-     */
-    protected function _extend_page_config()
-    {
-        $this->_admin_base_path = EE_CORE_CAF_ADMIN_EXTEND . 'registrations';
-        $reg_id = ! empty($this->_req_data['_REG_ID']) && ! is_array($this->_req_data['_REG_ID'])
-            ? $this->_req_data['_REG_ID']
-            : 0;
-        $new_page_routes = array(
-            'reports'                      => array(
-                'func'       => '_registration_reports',
-                'capability' => 'ee_read_registrations',
-            ),
-            'registration_checkins'        => array(
-                'func'       => '_registration_checkin_list_table',
-                'capability' => 'ee_read_checkins',
-            ),
-            'newsletter_selected_send'     => array(
-                'func'       => '_newsletter_selected_send',
-                'noheader'   => true,
-                'capability' => 'ee_send_message',
-            ),
-            'delete_checkin_rows'          => array(
-                'func'       => '_delete_checkin_rows',
-                'noheader'   => true,
-                'capability' => 'ee_delete_checkins',
-            ),
-            'delete_checkin_row'           => array(
-                'func'       => '_delete_checkin_row',
-                'noheader'   => true,
-                'capability' => 'ee_delete_checkin',
-                'obj_id'     => $reg_id,
-            ),
-            'toggle_checkin_status'        => array(
-                'func'       => '_toggle_checkin_status',
-                'noheader'   => true,
-                'capability' => 'ee_edit_checkin',
-                'obj_id'     => $reg_id,
-            ),
-            'toggle_checkin_status_bulk'   => array(
-                'func'       => '_toggle_checkin_status',
-                'noheader'   => true,
-                'capability' => 'ee_edit_checkins',
-            ),
-            'event_registrations'          => array(
-                'func'       => '_event_registrations_list_table',
-                'capability' => 'ee_read_checkins',
-            ),
-            'registrations_checkin_report' => array(
-                'func'       => '_registrations_checkin_report',
-                'noheader'   => true,
-                'capability' => 'ee_read_registrations',
-            ),
-        );
-        $this->_page_routes = array_merge($this->_page_routes, $new_page_routes);
-        $new_page_config = array(
-            'reports'               => array(
-                'nav'           => array(
-                    'label' => esc_html__('Reports', 'event_espresso'),
-                    'order' => 30,
-                ),
-                'help_tabs'     => array(
-                    'registrations_reports_help_tab' => array(
-                        'title'    => esc_html__('Registration Reports', 'event_espresso'),
-                        'filename' => 'registrations_reports',
-                    ),
-                ),
-                'require_nonce' => false,
-            ),
-            'event_registrations'   => array(
-                'nav'           => array(
-                    'label'      => esc_html__('Event Check-In', 'event_espresso'),
-                    'order'      => 10,
-                    'persistent' => true,
-                ),
-                'help_tabs'     => array(
-                    'registrations_event_checkin_help_tab'                       => array(
-                        'title'    => esc_html__('Registrations Event Check-In', 'event_espresso'),
-                        'filename' => 'registrations_event_checkin',
-                    ),
-                    'registrations_event_checkin_table_column_headings_help_tab' => array(
-                        'title'    => esc_html__('Event Check-In Table Column Headings', 'event_espresso'),
-                        'filename' => 'registrations_event_checkin_table_column_headings',
-                    ),
-                    'registrations_event_checkin_filters_help_tab'               => array(
-                        'title'    => esc_html__('Event Check-In Filters', 'event_espresso'),
-                        'filename' => 'registrations_event_checkin_filters',
-                    ),
-                    'registrations_event_checkin_views_help_tab'                 => array(
-                        'title'    => esc_html__('Event Check-In Views', 'event_espresso'),
-                        'filename' => 'registrations_event_checkin_views',
-                    ),
-                    'registrations_event_checkin_other_help_tab'                 => array(
-                        'title'    => esc_html__('Event Check-In Other', 'event_espresso'),
-                        'filename' => 'registrations_event_checkin_other',
-                    ),
-                ),
-                'qtips'         => array('Registration_List_Table_Tips'),
-                'list_table'    => 'EE_Event_Registrations_List_Table',
-                'metaboxes'     => array(),
-                'require_nonce' => false,
-            ),
-            'registration_checkins' => array(
-                'nav'           => array(
-                    'label'      => esc_html__('Check-In Records', 'event_espresso'),
-                    'order'      => 15,
-                    'persistent' => false,
-                    'url'        => '',
-                ),
-                'list_table'    => 'EE_Registration_CheckIn_List_Table',
-                'metaboxes'     => array(),
-                'require_nonce' => false,
-            ),
-        );
-        $this->_page_config = array_merge($this->_page_config, $new_page_config);
-        $this->_page_config['contact_list']['list_table'] = 'Extend_EE_Attendee_Contact_List_Table';
-        $this->_page_config['default']['list_table'] = 'Extend_EE_Registrations_List_Table';
-    }
+	/**
+	 * Extending page configuration.
+	 */
+	protected function _extend_page_config()
+	{
+		$this->_admin_base_path = EE_CORE_CAF_ADMIN_EXTEND . 'registrations';
+		$reg_id = ! empty($this->_req_data['_REG_ID']) && ! is_array($this->_req_data['_REG_ID'])
+			? $this->_req_data['_REG_ID']
+			: 0;
+		$new_page_routes = array(
+			'reports'                      => array(
+				'func'       => '_registration_reports',
+				'capability' => 'ee_read_registrations',
+			),
+			'registration_checkins'        => array(
+				'func'       => '_registration_checkin_list_table',
+				'capability' => 'ee_read_checkins',
+			),
+			'newsletter_selected_send'     => array(
+				'func'       => '_newsletter_selected_send',
+				'noheader'   => true,
+				'capability' => 'ee_send_message',
+			),
+			'delete_checkin_rows'          => array(
+				'func'       => '_delete_checkin_rows',
+				'noheader'   => true,
+				'capability' => 'ee_delete_checkins',
+			),
+			'delete_checkin_row'           => array(
+				'func'       => '_delete_checkin_row',
+				'noheader'   => true,
+				'capability' => 'ee_delete_checkin',
+				'obj_id'     => $reg_id,
+			),
+			'toggle_checkin_status'        => array(
+				'func'       => '_toggle_checkin_status',
+				'noheader'   => true,
+				'capability' => 'ee_edit_checkin',
+				'obj_id'     => $reg_id,
+			),
+			'toggle_checkin_status_bulk'   => array(
+				'func'       => '_toggle_checkin_status',
+				'noheader'   => true,
+				'capability' => 'ee_edit_checkins',
+			),
+			'event_registrations'          => array(
+				'func'       => '_event_registrations_list_table',
+				'capability' => 'ee_read_checkins',
+			),
+			'registrations_checkin_report' => array(
+				'func'       => '_registrations_checkin_report',
+				'noheader'   => true,
+				'capability' => 'ee_read_registrations',
+			),
+		);
+		$this->_page_routes = array_merge($this->_page_routes, $new_page_routes);
+		$new_page_config = array(
+			'reports'               => array(
+				'nav'           => array(
+					'label' => esc_html__('Reports', 'event_espresso'),
+					'order' => 30,
+				),
+				'help_tabs'     => array(
+					'registrations_reports_help_tab' => array(
+						'title'    => esc_html__('Registration Reports', 'event_espresso'),
+						'filename' => 'registrations_reports',
+					),
+				),
+				'require_nonce' => false,
+			),
+			'event_registrations'   => array(
+				'nav'           => array(
+					'label'      => esc_html__('Event Check-In', 'event_espresso'),
+					'order'      => 10,
+					'persistent' => true,
+				),
+				'help_tabs'     => array(
+					'registrations_event_checkin_help_tab'                       => array(
+						'title'    => esc_html__('Registrations Event Check-In', 'event_espresso'),
+						'filename' => 'registrations_event_checkin',
+					),
+					'registrations_event_checkin_table_column_headings_help_tab' => array(
+						'title'    => esc_html__('Event Check-In Table Column Headings', 'event_espresso'),
+						'filename' => 'registrations_event_checkin_table_column_headings',
+					),
+					'registrations_event_checkin_filters_help_tab'               => array(
+						'title'    => esc_html__('Event Check-In Filters', 'event_espresso'),
+						'filename' => 'registrations_event_checkin_filters',
+					),
+					'registrations_event_checkin_views_help_tab'                 => array(
+						'title'    => esc_html__('Event Check-In Views', 'event_espresso'),
+						'filename' => 'registrations_event_checkin_views',
+					),
+					'registrations_event_checkin_other_help_tab'                 => array(
+						'title'    => esc_html__('Event Check-In Other', 'event_espresso'),
+						'filename' => 'registrations_event_checkin_other',
+					),
+				),
+				'qtips'         => array('Registration_List_Table_Tips'),
+				'list_table'    => 'EE_Event_Registrations_List_Table',
+				'metaboxes'     => array(),
+				'require_nonce' => false,
+			),
+			'registration_checkins' => array(
+				'nav'           => array(
+					'label'      => esc_html__('Check-In Records', 'event_espresso'),
+					'order'      => 15,
+					'persistent' => false,
+					'url'        => '',
+				),
+				'list_table'    => 'EE_Registration_CheckIn_List_Table',
+				'metaboxes'     => array(),
+				'require_nonce' => false,
+			),
+		);
+		$this->_page_config = array_merge($this->_page_config, $new_page_config);
+		$this->_page_config['contact_list']['list_table'] = 'Extend_EE_Attendee_Contact_List_Table';
+		$this->_page_config['default']['list_table'] = 'Extend_EE_Registrations_List_Table';
+	}
 
 
-    /**
-     * Ajax hooks for all routes in this page.
-     */
-    protected function _ajax_hooks()
-    {
-        parent::_ajax_hooks();
-        add_action('wp_ajax_get_newsletter_form_content', array($this, 'get_newsletter_form_content'));
-    }
+	/**
+	 * Ajax hooks for all routes in this page.
+	 */
+	protected function _ajax_hooks()
+	{
+		parent::_ajax_hooks();
+		add_action('wp_ajax_get_newsletter_form_content', array($this, 'get_newsletter_form_content'));
+	}
 
 
-    /**
-     * Global scripts for all routes in this page.
-     */
-    public function load_scripts_styles()
-    {
-        parent::load_scripts_styles();
-        // if newsletter message type is active then let's add filter and load js for it.
-        if (EEH_MSG_Template::is_mt_active('newsletter')) {
-            // enqueue newsletter js
-            wp_enqueue_script(
-                'ee-newsletter-trigger',
-                REG_CAF_ASSETS_URL . 'ee-newsletter-trigger.js',
-                array('ee-dialog'),
-                EVENT_ESPRESSO_VERSION,
-                true
-            );
-            wp_enqueue_style(
-                'ee-newsletter-trigger-css',
-                REG_CAF_ASSETS_URL . 'ee-newsletter-trigger.css',
-                array(),
-                EVENT_ESPRESSO_VERSION
-            );
-            // hook in buttons for newsletter message type trigger.
-            add_action(
-                'AHEE__EE_Admin_List_Table__extra_tablenav__after_bottom_buttons',
-                array($this, 'add_newsletter_action_buttons'),
-                10
-            );
-        }
-    }
+	/**
+	 * Global scripts for all routes in this page.
+	 */
+	public function load_scripts_styles()
+	{
+		parent::load_scripts_styles();
+		// if newsletter message type is active then let's add filter and load js for it.
+		if (EEH_MSG_Template::is_mt_active('newsletter')) {
+			// enqueue newsletter js
+			wp_enqueue_script(
+				'ee-newsletter-trigger',
+				REG_CAF_ASSETS_URL . 'ee-newsletter-trigger.js',
+				array('ee-dialog'),
+				EVENT_ESPRESSO_VERSION,
+				true
+			);
+			wp_enqueue_style(
+				'ee-newsletter-trigger-css',
+				REG_CAF_ASSETS_URL . 'ee-newsletter-trigger.css',
+				array(),
+				EVENT_ESPRESSO_VERSION
+			);
+			// hook in buttons for newsletter message type trigger.
+			add_action(
+				'AHEE__EE_Admin_List_Table__extra_tablenav__after_bottom_buttons',
+				array($this, 'add_newsletter_action_buttons'),
+				10
+			);
+		}
+	}
 
 
-    /**
-     * Scripts and styles for just the reports route.
-     */
-    public function load_scripts_styles_reports()
-    {
-        wp_register_script(
-            'ee-reg-reports-js',
-            REG_CAF_ASSETS_URL . 'ee-registration-admin-reports.js',
-            array('google-charts'),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_enqueue_script('ee-reg-reports-js');
-        $this->_registration_reports_js_setup();
-    }
+	/**
+	 * Scripts and styles for just the reports route.
+	 */
+	public function load_scripts_styles_reports()
+	{
+		wp_register_script(
+			'ee-reg-reports-js',
+			REG_CAF_ASSETS_URL . 'ee-registration-admin-reports.js',
+			array('google-charts'),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_enqueue_script('ee-reg-reports-js');
+		$this->_registration_reports_js_setup();
+	}
 
 
-    /**
-     * Register screen options for event_registrations route.
-     */
-    protected function _add_screen_options_event_registrations()
-    {
-        $this->_per_page_screen_option();
-    }
+	/**
+	 * Register screen options for event_registrations route.
+	 */
+	protected function _add_screen_options_event_registrations()
+	{
+		$this->_per_page_screen_option();
+	}
 
 
-    /**
-     * Register screen options for registration_checkins route
-     */
-    protected function _add_screen_options_registration_checkins()
-    {
-        $page_title = $this->_admin_page_title;
-        $this->_admin_page_title = esc_html__('Check-In Records', 'event_espresso');
-        $this->_per_page_screen_option();
-        $this->_admin_page_title = $page_title;
-    }
+	/**
+	 * Register screen options for registration_checkins route
+	 */
+	protected function _add_screen_options_registration_checkins()
+	{
+		$page_title = $this->_admin_page_title;
+		$this->_admin_page_title = esc_html__('Check-In Records', 'event_espresso');
+		$this->_per_page_screen_option();
+		$this->_admin_page_title = $page_title;
+	}
 
 
-    /**
-     * Set views property for event_registrations route.
-     */
-    protected function _set_list_table_views_event_registrations()
-    {
-        $this->_views = array(
-            'all' => array(
-                'slug'        => 'all',
-                'label'       => esc_html__('All', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => ! isset($this->_req_data['event_id'])
-                    ? array()
-                    : array(
-                        'toggle_checkin_status_bulk' => esc_html__('Toggle Check-In', 'event_espresso'),
-                    ),
-            ),
-        );
-    }
+	/**
+	 * Set views property for event_registrations route.
+	 */
+	protected function _set_list_table_views_event_registrations()
+	{
+		$this->_views = array(
+			'all' => array(
+				'slug'        => 'all',
+				'label'       => esc_html__('All', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => ! isset($this->_req_data['event_id'])
+					? array()
+					: array(
+						'toggle_checkin_status_bulk' => esc_html__('Toggle Check-In', 'event_espresso'),
+					),
+			),
+		);
+	}
 
 
-    /**
-     * Set views property for registration_checkins route.
-     */
-    protected function _set_list_table_views_registration_checkins()
-    {
-        $this->_views = array(
-            'all' => array(
-                'slug'        => 'all',
-                'label'       => esc_html__('All', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => array('delete_checkin_rows' => esc_html__('Delete Check-In Rows', 'event_espresso')),
-            ),
-        );
-    }
+	/**
+	 * Set views property for registration_checkins route.
+	 */
+	protected function _set_list_table_views_registration_checkins()
+	{
+		$this->_views = array(
+			'all' => array(
+				'slug'        => 'all',
+				'label'       => esc_html__('All', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => array('delete_checkin_rows' => esc_html__('Delete Check-In Rows', 'event_espresso')),
+			),
+		);
+	}
 
 
-    /**
-     * callback for ajax action.
-     *
-     * @since 4.3.0
-     * @return void (JSON)
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function get_newsletter_form_content()
-    {
-        // do a nonce check cause we're not coming in from an normal route here.
-        $nonce = isset($this->_req_data['get_newsletter_form_content_nonce']) ? sanitize_text_field(
-            $this->_req_data['get_newsletter_form_content_nonce']
-        ) : '';
-        $nonce_ref = 'get_newsletter_form_content_nonce';
-        $this->_verify_nonce($nonce, $nonce_ref);
-        // let's get the mtp for the incoming MTP_ ID
-        if (! isset($this->_req_data['GRP_ID'])) {
-            EE_Error::add_error(
-                esc_html__(
-                    'There must be something broken with the js or html structure because the required data for getting a message template group is not present (need an GRP_ID).',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $this->_template_args['success'] = false;
-            $this->_template_args['error'] = true;
-            $this->_return_json();
-        }
-        $MTPG = EEM_Message_Template_Group::instance()->get_one_by_ID($this->_req_data['GRP_ID']);
-        if (! $MTPG instanceof EE_Message_Template_Group) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'The GRP_ID given (%d) does not appear to have a corresponding row in the database.',
-                        'event_espresso'
-                    ),
-                    $this->_req_data['GRP_ID']
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $this->_template_args['success'] = false;
-            $this->_template_args['error'] = true;
-            $this->_return_json();
-        }
-        $MTPs = $MTPG->context_templates();
-        $MTPs = $MTPs['attendee'];
-        $template_fields = array();
-        /** @var EE_Message_Template $MTP */
-        foreach ($MTPs as $MTP) {
-            $field = $MTP->get('MTP_template_field');
-            if ($field === 'content') {
-                $content = $MTP->get('MTP_content');
-                if (! empty($content['newsletter_content'])) {
-                    $template_fields['newsletter_content'] = $content['newsletter_content'];
-                }
-                continue;
-            }
-            $template_fields[ $MTP->get('MTP_template_field') ] = $MTP->get('MTP_content');
-        }
-        $this->_template_args['success'] = true;
-        $this->_template_args['error'] = false;
-        $this->_template_args['data'] = array(
-            'batch_message_from'    => isset($template_fields['from'])
-                ? $template_fields['from']
-                : '',
-            'batch_message_subject' => isset($template_fields['subject'])
-                ? $template_fields['subject']
-                : '',
-            'batch_message_content' => isset($template_fields['newsletter_content'])
-                ? $template_fields['newsletter_content']
-                : '',
-        );
-        $this->_return_json();
-    }
+	/**
+	 * callback for ajax action.
+	 *
+	 * @since 4.3.0
+	 * @return void (JSON)
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function get_newsletter_form_content()
+	{
+		// do a nonce check cause we're not coming in from an normal route here.
+		$nonce = isset($this->_req_data['get_newsletter_form_content_nonce']) ? sanitize_text_field(
+			$this->_req_data['get_newsletter_form_content_nonce']
+		) : '';
+		$nonce_ref = 'get_newsletter_form_content_nonce';
+		$this->_verify_nonce($nonce, $nonce_ref);
+		// let's get the mtp for the incoming MTP_ ID
+		if (! isset($this->_req_data['GRP_ID'])) {
+			EE_Error::add_error(
+				esc_html__(
+					'There must be something broken with the js or html structure because the required data for getting a message template group is not present (need an GRP_ID).',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$this->_template_args['success'] = false;
+			$this->_template_args['error'] = true;
+			$this->_return_json();
+		}
+		$MTPG = EEM_Message_Template_Group::instance()->get_one_by_ID($this->_req_data['GRP_ID']);
+		if (! $MTPG instanceof EE_Message_Template_Group) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'The GRP_ID given (%d) does not appear to have a corresponding row in the database.',
+						'event_espresso'
+					),
+					$this->_req_data['GRP_ID']
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$this->_template_args['success'] = false;
+			$this->_template_args['error'] = true;
+			$this->_return_json();
+		}
+		$MTPs = $MTPG->context_templates();
+		$MTPs = $MTPs['attendee'];
+		$template_fields = array();
+		/** @var EE_Message_Template $MTP */
+		foreach ($MTPs as $MTP) {
+			$field = $MTP->get('MTP_template_field');
+			if ($field === 'content') {
+				$content = $MTP->get('MTP_content');
+				if (! empty($content['newsletter_content'])) {
+					$template_fields['newsletter_content'] = $content['newsletter_content'];
+				}
+				continue;
+			}
+			$template_fields[ $MTP->get('MTP_template_field') ] = $MTP->get('MTP_content');
+		}
+		$this->_template_args['success'] = true;
+		$this->_template_args['error'] = false;
+		$this->_template_args['data'] = array(
+			'batch_message_from'    => isset($template_fields['from'])
+				? $template_fields['from']
+				: '',
+			'batch_message_subject' => isset($template_fields['subject'])
+				? $template_fields['subject']
+				: '',
+			'batch_message_content' => isset($template_fields['newsletter_content'])
+				? $template_fields['newsletter_content']
+				: '',
+		);
+		$this->_return_json();
+	}
 
 
-    /**
-     * callback for AHEE__EE_Admin_List_Table__extra_tablenav__after_bottom_buttons action
-     *
-     * @since 4.3.0
-     * @param EE_Admin_List_Table $list_table
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function add_newsletter_action_buttons(EE_Admin_List_Table $list_table)
-    {
-        if (
-            ! EE_Registry::instance()->CAP->current_user_can(
-                'ee_send_message',
-                'espresso_registrations_newsletter_selected_send'
-            )
-        ) {
-            return;
-        }
-        $routes_to_add_to = array(
-            'contact_list',
-            'event_registrations',
-            'default',
-        );
-        if ($this->_current_page === 'espresso_registrations' && in_array($this->_req_action, $routes_to_add_to)) {
-            if (
-                ($this->_req_action === 'event_registrations' && empty($this->_req_data['event_id']))
-                || (isset($this->_req_data['status']) && $this->_req_data['status'] === 'trash')
-            ) {
-                echo '';
-            } else {
-                $button_text = sprintf(
-                    esc_html__('Send Batch Message (%s selected)', 'event_espresso'),
-                    '<span class="send-selected-newsletter-count">0</span>'
-                );
-                echo '<button id="selected-batch-send-trigger" class="button secondary-button">'
-                     . '<span class="dashicons dashicons-email "></span>'
-                     . $button_text
-                     . '</button>';
-                add_action('admin_footer', array($this, 'newsletter_send_form_skeleton'));
-            }
-        }
-    }
+	/**
+	 * callback for AHEE__EE_Admin_List_Table__extra_tablenav__after_bottom_buttons action
+	 *
+	 * @since 4.3.0
+	 * @param EE_Admin_List_Table $list_table
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function add_newsletter_action_buttons(EE_Admin_List_Table $list_table)
+	{
+		if (
+			! EE_Registry::instance()->CAP->current_user_can(
+				'ee_send_message',
+				'espresso_registrations_newsletter_selected_send'
+			)
+		) {
+			return;
+		}
+		$routes_to_add_to = array(
+			'contact_list',
+			'event_registrations',
+			'default',
+		);
+		if ($this->_current_page === 'espresso_registrations' && in_array($this->_req_action, $routes_to_add_to)) {
+			if (
+				($this->_req_action === 'event_registrations' && empty($this->_req_data['event_id']))
+				|| (isset($this->_req_data['status']) && $this->_req_data['status'] === 'trash')
+			) {
+				echo '';
+			} else {
+				$button_text = sprintf(
+					esc_html__('Send Batch Message (%s selected)', 'event_espresso'),
+					'<span class="send-selected-newsletter-count">0</span>'
+				);
+				echo '<button id="selected-batch-send-trigger" class="button secondary-button">'
+					 . '<span class="dashicons dashicons-email "></span>'
+					 . $button_text
+					 . '</button>';
+				add_action('admin_footer', array($this, 'newsletter_send_form_skeleton'));
+			}
+		}
+	}
 
 
-    /**
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function newsletter_send_form_skeleton()
-    {
-        $list_table = $this->_list_table_object;
-        $codes = array();
-        // need to templates for the newsletter message type for the template selector.
-        $values[] = array('text' => esc_html__('Select Template to Use', 'event_espresso'), 'id' => 0);
-        $mtps = EEM_Message_Template_Group::instance()->get_all(
-            array(array('MTP_message_type' => 'newsletter', 'MTP_messenger' => 'email'))
-        );
-        foreach ($mtps as $mtp) {
-            $name = $mtp->name();
-            $values[] = array(
-                'text' => empty($name) ? esc_html__('Global', 'event_espresso') : $name,
-                'id'   => $mtp->ID(),
-            );
-        }
-        // need to get a list of shortcodes that are available for the newsletter message type.
-        $shortcodes = EEH_MSG_Template::get_shortcodes(
-            'newsletter',
-            'email',
-            array(),
-            'attendee',
-            false
-        );
-        foreach ($shortcodes as $field => $shortcode_array) {
-            $available_shortcodes = array();
-            foreach ($shortcode_array as $shortcode => $shortcode_details) {
-                $field_id = $field === '[NEWSLETTER_CONTENT]'
-                    ? 'content'
-                    : $field;
-                $field_id = 'batch-message-' . strtolower($field_id);
-                $available_shortcodes[] = '<span class="js-shortcode-selection" data-value="'
-                                          . $shortcode
-                                          . '" data-linked-input-id="' . $field_id . '">'
-                                          . $shortcode
-                                          . '</span>';
-            }
-            $codes[ $field ] = implode(', ', $available_shortcodes);
-        }
-        $shortcodes = $codes;
-        $form_template = REG_CAF_TEMPLATE_PATH . 'newsletter-send-form.template.php';
-        $form_template_args = array(
-            'form_action'       => admin_url('admin.php?page=espresso_registrations'),
-            'form_route'        => 'newsletter_selected_send',
-            'form_nonce_name'   => 'newsletter_selected_send_nonce',
-            'form_nonce'        => wp_create_nonce('newsletter_selected_send_nonce'),
-            'redirect_back_to'  => $this->_req_action,
-            'ajax_nonce'        => wp_create_nonce('get_newsletter_form_content_nonce'),
-            'template_selector' => EEH_Form_Fields::select_input('newsletter_mtp_selected', $values),
-            'shortcodes'        => $shortcodes,
-            'id_type'           => $list_table instanceof EE_Attendee_Contact_List_Table ? 'contact' : 'registration',
-        );
-        EEH_Template::display_template($form_template, $form_template_args);
-    }
+	/**
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function newsletter_send_form_skeleton()
+	{
+		$list_table = $this->_list_table_object;
+		$codes = array();
+		// need to templates for the newsletter message type for the template selector.
+		$values[] = array('text' => esc_html__('Select Template to Use', 'event_espresso'), 'id' => 0);
+		$mtps = EEM_Message_Template_Group::instance()->get_all(
+			array(array('MTP_message_type' => 'newsletter', 'MTP_messenger' => 'email'))
+		);
+		foreach ($mtps as $mtp) {
+			$name = $mtp->name();
+			$values[] = array(
+				'text' => empty($name) ? esc_html__('Global', 'event_espresso') : $name,
+				'id'   => $mtp->ID(),
+			);
+		}
+		// need to get a list of shortcodes that are available for the newsletter message type.
+		$shortcodes = EEH_MSG_Template::get_shortcodes(
+			'newsletter',
+			'email',
+			array(),
+			'attendee',
+			false
+		);
+		foreach ($shortcodes as $field => $shortcode_array) {
+			$available_shortcodes = array();
+			foreach ($shortcode_array as $shortcode => $shortcode_details) {
+				$field_id = $field === '[NEWSLETTER_CONTENT]'
+					? 'content'
+					: $field;
+				$field_id = 'batch-message-' . strtolower($field_id);
+				$available_shortcodes[] = '<span class="js-shortcode-selection" data-value="'
+										  . $shortcode
+										  . '" data-linked-input-id="' . $field_id . '">'
+										  . $shortcode
+										  . '</span>';
+			}
+			$codes[ $field ] = implode(', ', $available_shortcodes);
+		}
+		$shortcodes = $codes;
+		$form_template = REG_CAF_TEMPLATE_PATH . 'newsletter-send-form.template.php';
+		$form_template_args = array(
+			'form_action'       => admin_url('admin.php?page=espresso_registrations'),
+			'form_route'        => 'newsletter_selected_send',
+			'form_nonce_name'   => 'newsletter_selected_send_nonce',
+			'form_nonce'        => wp_create_nonce('newsletter_selected_send_nonce'),
+			'redirect_back_to'  => $this->_req_action,
+			'ajax_nonce'        => wp_create_nonce('get_newsletter_form_content_nonce'),
+			'template_selector' => EEH_Form_Fields::select_input('newsletter_mtp_selected', $values),
+			'shortcodes'        => $shortcodes,
+			'id_type'           => $list_table instanceof EE_Attendee_Contact_List_Table ? 'contact' : 'registration',
+		);
+		EEH_Template::display_template($form_template, $form_template_args);
+	}
 
 
-    /**
-     * Handles sending selected registrations/contacts a newsletter.
-     *
-     * @since  4.3.0
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _newsletter_selected_send()
-    {
-        $success = true;
-        // first we need to make sure we have a GRP_ID so we know what template we're sending and updating!
-        if (empty($this->_req_data['newsletter_mtp_selected'])) {
-            EE_Error::add_error(
-                esc_html__(
-                    'In order to send a message, a Message Template GRP_ID is needed. It was not provided so messages were not sent.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $success = false;
-        }
-        if ($success) {
-            // update Message template in case there are any changes
-            $Message_Template_Group = EEM_Message_Template_Group::instance()->get_one_by_ID(
-                $this->_req_data['newsletter_mtp_selected']
-            );
-            $Message_Templates = $Message_Template_Group instanceof EE_Message_Template_Group
-                ? $Message_Template_Group->context_templates()
-                : array();
-            if (empty($Message_Templates)) {
-                EE_Error::add_error(
-                    esc_html__(
-                        'Unable to retrieve message template fields from the db. Messages not sent.',
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-            // let's just update the specific fields
-            foreach ($Message_Templates['attendee'] as $Message_Template) {
-                if ($Message_Template instanceof EE_Message_Template) {
-                    $field = $Message_Template->get('MTP_template_field');
-                    $content = $Message_Template->get('MTP_content');
-                    $new_content = $content;
-                    switch ($field) {
-                        case 'from':
-                            $new_content = ! empty($this->_req_data['batch_message']['from'])
-                                ? $this->_req_data['batch_message']['from']
-                                : $content;
-                            break;
-                        case 'subject':
-                            $new_content = ! empty($this->_req_data['batch_message']['subject'])
-                                ? $this->_req_data['batch_message']['subject']
-                                : $content;
-                            break;
-                        case 'content':
-                            $new_content = $content;
-                            $new_content['newsletter_content'] = ! empty($this->_req_data['batch_message']['content'])
-                                ? $this->_req_data['batch_message']['content']
-                                : $content['newsletter_content'];
-                            break;
-                        default:
-                            // continue the foreach loop, we don't want to set $new_content nor save.
-                            continue 2;
-                    }
-                    $Message_Template->set('MTP_content', $new_content);
-                    $Message_Template->save();
-                }
-            }
-            // great fields are updated!  now let's make sure we just have contact objects (EE_Attendee).
-            $id_type = ! empty($this->_req_data['batch_message']['id_type'])
-                ? $this->_req_data['batch_message']['id_type']
-                : 'registration';
-            // id_type will affect how we assemble the ids.
-            $ids = ! empty($this->_req_data['batch_message']['ids'])
-                ? json_decode(stripslashes($this->_req_data['batch_message']['ids']))
-                : array();
-            $registrations_used_for_contact_data = array();
-            // using switch because eventually we'll have other contexts that will be used for generating messages.
-            switch ($id_type) {
-                case 'registration':
-                    $registrations_used_for_contact_data = EEM_Registration::instance()->get_all(
-                        array(
-                            array(
-                                'REG_ID' => array('IN', $ids),
-                            ),
-                        )
-                    );
-                    break;
-                case 'contact':
-                    $registrations_used_for_contact_data = EEM_Registration::instance()
-                                                                           ->get_latest_registration_for_each_of_given_contacts(
-                                                                               $ids
-                                                                           );
-                    break;
-            }
-            do_action_ref_array(
-                'AHEE__Extend_Registrations_Admin_Page___newsletter_selected_send__with_registrations',
-                array(
-                    $registrations_used_for_contact_data,
-                    $Message_Template_Group->ID(),
-                )
-            );
-            // kept for backward compat, internally we no longer use this action.
-            // @deprecated 4.8.36.rc.002
-            $contacts = $id_type === 'registration'
-                ? EEM_Attendee::instance()->get_array_of_contacts_from_reg_ids($ids)
-                : EEM_Attendee::instance()->get_all(array(array('ATT_ID' => array('in', $ids))));
-            do_action_ref_array(
-                'AHEE__Extend_Registrations_Admin_Page___newsletter_selected_send',
-                array(
-                    $contacts,
-                    $Message_Template_Group->ID(),
-                )
-            );
-        }
-        $query_args = array(
-            'action' => ! empty($this->_req_data['redirect_back_to'])
-                ? $this->_req_data['redirect_back_to']
-                : 'default',
-        );
-        $this->_redirect_after_action(false, '', '', $query_args, true);
-    }
+	/**
+	 * Handles sending selected registrations/contacts a newsletter.
+	 *
+	 * @since  4.3.0
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _newsletter_selected_send()
+	{
+		$success = true;
+		// first we need to make sure we have a GRP_ID so we know what template we're sending and updating!
+		if (empty($this->_req_data['newsletter_mtp_selected'])) {
+			EE_Error::add_error(
+				esc_html__(
+					'In order to send a message, a Message Template GRP_ID is needed. It was not provided so messages were not sent.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$success = false;
+		}
+		if ($success) {
+			// update Message template in case there are any changes
+			$Message_Template_Group = EEM_Message_Template_Group::instance()->get_one_by_ID(
+				$this->_req_data['newsletter_mtp_selected']
+			);
+			$Message_Templates = $Message_Template_Group instanceof EE_Message_Template_Group
+				? $Message_Template_Group->context_templates()
+				: array();
+			if (empty($Message_Templates)) {
+				EE_Error::add_error(
+					esc_html__(
+						'Unable to retrieve message template fields from the db. Messages not sent.',
+						'event_espresso'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+			// let's just update the specific fields
+			foreach ($Message_Templates['attendee'] as $Message_Template) {
+				if ($Message_Template instanceof EE_Message_Template) {
+					$field = $Message_Template->get('MTP_template_field');
+					$content = $Message_Template->get('MTP_content');
+					$new_content = $content;
+					switch ($field) {
+						case 'from':
+							$new_content = ! empty($this->_req_data['batch_message']['from'])
+								? $this->_req_data['batch_message']['from']
+								: $content;
+							break;
+						case 'subject':
+							$new_content = ! empty($this->_req_data['batch_message']['subject'])
+								? $this->_req_data['batch_message']['subject']
+								: $content;
+							break;
+						case 'content':
+							$new_content = $content;
+							$new_content['newsletter_content'] = ! empty($this->_req_data['batch_message']['content'])
+								? $this->_req_data['batch_message']['content']
+								: $content['newsletter_content'];
+							break;
+						default:
+							// continue the foreach loop, we don't want to set $new_content nor save.
+							continue 2;
+					}
+					$Message_Template->set('MTP_content', $new_content);
+					$Message_Template->save();
+				}
+			}
+			// great fields are updated!  now let's make sure we just have contact objects (EE_Attendee).
+			$id_type = ! empty($this->_req_data['batch_message']['id_type'])
+				? $this->_req_data['batch_message']['id_type']
+				: 'registration';
+			// id_type will affect how we assemble the ids.
+			$ids = ! empty($this->_req_data['batch_message']['ids'])
+				? json_decode(stripslashes($this->_req_data['batch_message']['ids']))
+				: array();
+			$registrations_used_for_contact_data = array();
+			// using switch because eventually we'll have other contexts that will be used for generating messages.
+			switch ($id_type) {
+				case 'registration':
+					$registrations_used_for_contact_data = EEM_Registration::instance()->get_all(
+						array(
+							array(
+								'REG_ID' => array('IN', $ids),
+							),
+						)
+					);
+					break;
+				case 'contact':
+					$registrations_used_for_contact_data = EEM_Registration::instance()
+																		   ->get_latest_registration_for_each_of_given_contacts(
+																			   $ids
+																		   );
+					break;
+			}
+			do_action_ref_array(
+				'AHEE__Extend_Registrations_Admin_Page___newsletter_selected_send__with_registrations',
+				array(
+					$registrations_used_for_contact_data,
+					$Message_Template_Group->ID(),
+				)
+			);
+			// kept for backward compat, internally we no longer use this action.
+			// @deprecated 4.8.36.rc.002
+			$contacts = $id_type === 'registration'
+				? EEM_Attendee::instance()->get_array_of_contacts_from_reg_ids($ids)
+				: EEM_Attendee::instance()->get_all(array(array('ATT_ID' => array('in', $ids))));
+			do_action_ref_array(
+				'AHEE__Extend_Registrations_Admin_Page___newsletter_selected_send',
+				array(
+					$contacts,
+					$Message_Template_Group->ID(),
+				)
+			);
+		}
+		$query_args = array(
+			'action' => ! empty($this->_req_data['redirect_back_to'])
+				? $this->_req_data['redirect_back_to']
+				: 'default',
+		);
+		$this->_redirect_after_action(false, '', '', $query_args, true);
+	}
 
 
-    /**
-     * This is called when javascript is being enqueued to setup the various data needed for the reports js.
-     * Also $this->{$_reports_template_data} property is set for later usage by the _registration_reports method.
-     */
-    protected function _registration_reports_js_setup()
-    {
-        $this->_reports_template_data['admin_reports'][] = $this->_registrations_per_day_report();
-        $this->_reports_template_data['admin_reports'][] = $this->_registrations_per_event_report();
-    }
+	/**
+	 * This is called when javascript is being enqueued to setup the various data needed for the reports js.
+	 * Also $this->{$_reports_template_data} property is set for later usage by the _registration_reports method.
+	 */
+	protected function _registration_reports_js_setup()
+	{
+		$this->_reports_template_data['admin_reports'][] = $this->_registrations_per_day_report();
+		$this->_reports_template_data['admin_reports'][] = $this->_registrations_per_event_report();
+	}
 
 
-    /**
-     *        generates Business Reports regarding Registrations
-     *
-     * @access protected
-     * @return void
-     * @throws DomainException
-     */
-    protected function _registration_reports()
-    {
-        $template_path = EE_ADMIN_TEMPLATE . 'admin_reports.template.php';
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            $template_path,
-            $this->_reports_template_data,
-            true
-        );
-        // the final template wrapper
-        $this->display_admin_page_with_no_sidebar();
-    }
+	/**
+	 *        generates Business Reports regarding Registrations
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws DomainException
+	 */
+	protected function _registration_reports()
+	{
+		$template_path = EE_ADMIN_TEMPLATE . 'admin_reports.template.php';
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(
+			$template_path,
+			$this->_reports_template_data,
+			true
+		);
+		// the final template wrapper
+		$this->display_admin_page_with_no_sidebar();
+	}
 
 
-    /**
-     * Generates Business Report showing total registrations per day.
-     *
-     * @param string $period The period (acceptable by PHP Datetime constructor) for which the report is generated.
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _registrations_per_day_report($period = '-1 month')
-    {
-        $report_ID = 'reg-admin-registrations-per-day-report-dv';
-        $results = EEM_Registration::instance()->get_registrations_per_day_and_per_status_report($period);
-        $results = (array) $results;
-        $regs = array();
-        $subtitle = '';
-        if ($results) {
-            $column_titles = array();
-            $tracker = 0;
-            foreach ($results as $result) {
-                $report_column_values = array();
-                foreach ($result as $property_name => $property_value) {
-                    $property_value = $property_name === 'Registration_REG_date' ? $property_value
-                        : (int) $property_value;
-                    $report_column_values[] = $property_value;
-                    if ($tracker === 0) {
-                        if ($property_name === 'Registration_REG_date') {
-                            $column_titles[] = esc_html__(
-                                'Date (only days with registrations are shown)',
-                                'event_espresso'
-                            );
-                        } else {
-                            $column_titles[] = EEH_Template::pretty_status($property_name, false, 'sentence');
-                        }
-                    }
-                }
-                $tracker++;
-                $regs[] = $report_column_values;
-            }
-            // make sure the column_titles is pushed to the beginning of the array
-            array_unshift($regs, $column_titles);
-            // setup the date range.
-            $DateTimeZone = new DateTimeZone(EEH_DTT_Helper::get_timezone());
-            $beginning_date = new DateTime("now " . $period, $DateTimeZone);
-            $ending_date = new DateTime("now", $DateTimeZone);
-            $subtitle = sprintf(
-                wp_strip_all_tags(
-                    _x('For the period: %1$s to %2$s', 'Used to give date range', 'event_espresso')
-                ),
-                $beginning_date->format('Y-m-d'),
-                $ending_date->format('Y-m-d')
-            );
-        }
-        $report_title = wp_strip_all_tags(__('Total Registrations per Day', 'event_espresso'));
-        $report_params = array(
-            'title'     => $report_title,
-            'subtitle'  => $subtitle,
-            'id'        => $report_ID,
-            'regs'      => $regs,
-            'noResults' => empty($regs),
-            'noRegsMsg' => sprintf(
-                wp_strip_all_tags(
-                    __(
-                        '%sThere are currently no registration records in the last month for this report.%s',
-                        'event_espresso'
-                    )
-                ),
-                '<h2>' . $report_title . '</h2><p>',
-                '</p>'
-            ),
-        );
-        wp_localize_script('ee-reg-reports-js', 'regPerDay', $report_params);
-        return $report_ID;
-    }
+	/**
+	 * Generates Business Report showing total registrations per day.
+	 *
+	 * @param string $period The period (acceptable by PHP Datetime constructor) for which the report is generated.
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _registrations_per_day_report($period = '-1 month')
+	{
+		$report_ID = 'reg-admin-registrations-per-day-report-dv';
+		$results = EEM_Registration::instance()->get_registrations_per_day_and_per_status_report($period);
+		$results = (array) $results;
+		$regs = array();
+		$subtitle = '';
+		if ($results) {
+			$column_titles = array();
+			$tracker = 0;
+			foreach ($results as $result) {
+				$report_column_values = array();
+				foreach ($result as $property_name => $property_value) {
+					$property_value = $property_name === 'Registration_REG_date' ? $property_value
+						: (int) $property_value;
+					$report_column_values[] = $property_value;
+					if ($tracker === 0) {
+						if ($property_name === 'Registration_REG_date') {
+							$column_titles[] = esc_html__(
+								'Date (only days with registrations are shown)',
+								'event_espresso'
+							);
+						} else {
+							$column_titles[] = EEH_Template::pretty_status($property_name, false, 'sentence');
+						}
+					}
+				}
+				$tracker++;
+				$regs[] = $report_column_values;
+			}
+			// make sure the column_titles is pushed to the beginning of the array
+			array_unshift($regs, $column_titles);
+			// setup the date range.
+			$DateTimeZone = new DateTimeZone(EEH_DTT_Helper::get_timezone());
+			$beginning_date = new DateTime("now " . $period, $DateTimeZone);
+			$ending_date = new DateTime("now", $DateTimeZone);
+			$subtitle = sprintf(
+				wp_strip_all_tags(
+					_x('For the period: %1$s to %2$s', 'Used to give date range', 'event_espresso')
+				),
+				$beginning_date->format('Y-m-d'),
+				$ending_date->format('Y-m-d')
+			);
+		}
+		$report_title = wp_strip_all_tags(__('Total Registrations per Day', 'event_espresso'));
+		$report_params = array(
+			'title'     => $report_title,
+			'subtitle'  => $subtitle,
+			'id'        => $report_ID,
+			'regs'      => $regs,
+			'noResults' => empty($regs),
+			'noRegsMsg' => sprintf(
+				wp_strip_all_tags(
+					__(
+						'%sThere are currently no registration records in the last month for this report.%s',
+						'event_espresso'
+					)
+				),
+				'<h2>' . $report_title . '</h2><p>',
+				'</p>'
+			),
+		);
+		wp_localize_script('ee-reg-reports-js', 'regPerDay', $report_params);
+		return $report_ID;
+	}
 
 
-    /**
-     * Generates Business Report showing total registrations per event.
-     *
-     * @param string $period The period (acceptable by PHP Datetime constructor) for which the report is generated.
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _registrations_per_event_report($period = '-1 month')
-    {
-        $report_ID = 'reg-admin-registrations-per-event-report-dv';
-        $results = EEM_Registration::instance()->get_registrations_per_event_and_per_status_report($period);
-        $results = (array) $results;
-        $regs = array();
-        $subtitle = '';
-        if ($results) {
-            $column_titles = array();
-            $tracker = 0;
-            foreach ($results as $result) {
-                $report_column_values = array();
-                foreach ($result as $property_name => $property_value) {
-                    $property_value = $property_name === 'Registration_Event' ? wp_trim_words(
-                        $property_value,
-                        4,
-                        '...'
-                    ) : (int) $property_value;
-                    $report_column_values[] = $property_value;
-                    if ($tracker === 0) {
-                        if ($property_name === 'Registration_Event') {
-                            $column_titles[] = esc_html__('Event', 'event_espresso');
-                        } else {
-                            $column_titles[] = EEH_Template::pretty_status($property_name, false, 'sentence');
-                        }
-                    }
-                }
-                $tracker++;
-                $regs[] = $report_column_values;
-            }
-            // make sure the column_titles is pushed to the beginning of the array
-            array_unshift($regs, $column_titles);
-            // setup the date range.
-            $DateTimeZone = new DateTimeZone(EEH_DTT_Helper::get_timezone());
-            $beginning_date = new DateTime("now " . $period, $DateTimeZone);
-            $ending_date = new DateTime("now", $DateTimeZone);
-            $subtitle = sprintf(
-                wp_strip_all_tags(
-                    _x('For the period: %1$s to %2$s', 'Used to give date range', 'event_espresso')
-                ),
-                $beginning_date->format('Y-m-d'),
-                $ending_date->format('Y-m-d')
-            );
-        }
-        $report_title = wp_strip_all_tags(__('Total Registrations per Event', 'event_espresso'));
-        $report_params = array(
-            'title'     => $report_title,
-            'subtitle'  => $subtitle,
-            'id'        => $report_ID,
-            'regs'      => $regs,
-            'noResults' => empty($regs),
-            'noRegsMsg' => sprintf(
-                wp_strip_all_tags(
-                    __(
-                        '%sThere are currently no registration records in the last month for this report.%s',
-                        'event_espresso'
-                    )
-                ),
-                '<h2>' . $report_title . '</h2><p>',
-                '</p>'
-            ),
-        );
-        wp_localize_script('ee-reg-reports-js', 'regPerEvent', $report_params);
-        return $report_ID;
-    }
+	/**
+	 * Generates Business Report showing total registrations per event.
+	 *
+	 * @param string $period The period (acceptable by PHP Datetime constructor) for which the report is generated.
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _registrations_per_event_report($period = '-1 month')
+	{
+		$report_ID = 'reg-admin-registrations-per-event-report-dv';
+		$results = EEM_Registration::instance()->get_registrations_per_event_and_per_status_report($period);
+		$results = (array) $results;
+		$regs = array();
+		$subtitle = '';
+		if ($results) {
+			$column_titles = array();
+			$tracker = 0;
+			foreach ($results as $result) {
+				$report_column_values = array();
+				foreach ($result as $property_name => $property_value) {
+					$property_value = $property_name === 'Registration_Event' ? wp_trim_words(
+						$property_value,
+						4,
+						'...'
+					) : (int) $property_value;
+					$report_column_values[] = $property_value;
+					if ($tracker === 0) {
+						if ($property_name === 'Registration_Event') {
+							$column_titles[] = esc_html__('Event', 'event_espresso');
+						} else {
+							$column_titles[] = EEH_Template::pretty_status($property_name, false, 'sentence');
+						}
+					}
+				}
+				$tracker++;
+				$regs[] = $report_column_values;
+			}
+			// make sure the column_titles is pushed to the beginning of the array
+			array_unshift($regs, $column_titles);
+			// setup the date range.
+			$DateTimeZone = new DateTimeZone(EEH_DTT_Helper::get_timezone());
+			$beginning_date = new DateTime("now " . $period, $DateTimeZone);
+			$ending_date = new DateTime("now", $DateTimeZone);
+			$subtitle = sprintf(
+				wp_strip_all_tags(
+					_x('For the period: %1$s to %2$s', 'Used to give date range', 'event_espresso')
+				),
+				$beginning_date->format('Y-m-d'),
+				$ending_date->format('Y-m-d')
+			);
+		}
+		$report_title = wp_strip_all_tags(__('Total Registrations per Event', 'event_espresso'));
+		$report_params = array(
+			'title'     => $report_title,
+			'subtitle'  => $subtitle,
+			'id'        => $report_ID,
+			'regs'      => $regs,
+			'noResults' => empty($regs),
+			'noRegsMsg' => sprintf(
+				wp_strip_all_tags(
+					__(
+						'%sThere are currently no registration records in the last month for this report.%s',
+						'event_espresso'
+					)
+				),
+				'<h2>' . $report_title . '</h2><p>',
+				'</p>'
+			),
+		);
+		wp_localize_script('ee-reg-reports-js', 'regPerEvent', $report_params);
+		return $report_ID;
+	}
 
 
-    /**
-     * generates HTML for the Registration Check-in list table (showing all Check-ins for a specific registration)
-     *
-     * @access protected
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws \EventEspresso\core\exceptions\EntityNotFoundException
-     */
-    protected function _registration_checkin_list_table()
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $reg_id = isset($this->_req_data['_REG_ID']) ? absint($this->_req_data['_REG_ID']) : null;
-        /** @var EE_Registration $registration */
-        $registration = EEM_Registration::instance()->get_one_by_ID($reg_id);
-        if (! $registration instanceof EE_Registration) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__('An error occurred. There is no registration with ID (%d)', 'event_espresso'),
-                    $reg_id
-                )
-            );
-        }
-        $attendee = $registration->attendee();
-        $this->_admin_page_title .= $this->get_action_link_or_button(
-            'new_registration',
-            'add-registrant',
-            array('event_id' => $registration->event_ID()),
-            'add-new-h2'
-        );
-        $checked_in = new CheckinStatusDashicon(EE_Checkin::status_checked_in);
-        $checked_out = new CheckinStatusDashicon(EE_Checkin::status_checked_out);
-        $legend_items = array(
-            'checkin'  => array(
-                'class' => $checked_in->cssClasses(),
-                'desc'  => $checked_in->legendLabel(),
-            ),
-            'checkout' => array(
-                'class' => $checked_out->cssClasses(),
-                'desc'  => $checked_out->legendLabel(),
-            ),
-        );
-        $this->_template_args['after_list_table'] = $this->_display_legend($legend_items);
-        $dtt_id = isset($this->_req_data['DTT_ID']) ? $this->_req_data['DTT_ID'] : null;
-        /** @var EE_Datetime $datetime */
-        $datetime = EEM_Datetime::instance()->get_one_by_ID($dtt_id);
-        $datetime_label = '';
-        if ($datetime instanceof EE_Datetime) {
-            $datetime_label = $datetime->get_dtt_display_name(true);
-            $datetime_label .= ! empty($datetime_label)
-                ? ' (' . $datetime->get_dtt_display_name() . ')'
-                : $datetime->get_dtt_display_name();
-        }
-        $datetime_link = ! empty($dtt_id) && $registration instanceof EE_Registration
-            ? EE_Admin_Page::add_query_args_and_nonce(
-                array(
-                    'action'   => 'event_registrations',
-                    'event_id' => $registration->event_ID(),
-                    'DTT_ID'   => $dtt_id,
-                ),
-                $this->_admin_base_url
-            )
-            : '';
-        $datetime_link = ! empty($datetime_link)
-            ? '<a href="' . $datetime_link . '">'
-              . '<span id="checkin-dtt">'
-              . $datetime_label
-              . '</span></a>'
-            : $datetime_label;
-        $attendee_name = $attendee instanceof EE_Attendee
-            ? $attendee->full_name()
-            : '';
-        $attendee_link = $attendee instanceof EE_Attendee
-            ? $attendee->get_admin_details_link()
-            : '';
-        $attendee_link = ! empty($attendee_link)
-            ? '<a href="' . $attendee->get_admin_details_link() . '"'
-              . ' aria-label="' . esc_html__('Click for attendee details', 'event_espresso') . '">'
-              . '<span id="checkin-attendee-name">'
-              . $attendee_name
-              . '</span></a>'
-            : '';
-        $event_link = $registration->event() instanceof EE_Event
-            ? $registration->event()->get_admin_details_link()
-            : '';
-        $event_link = ! empty($event_link)
-            ? '<a href="' . $event_link . '"'
-              . ' aria-label="' . esc_html__('Click here to edit event.', 'event_espresso') . '">'
-              . '<span id="checkin-event-name">'
-              . $registration->event_name()
-              . '</span>'
-              . '</a>'
-            : '';
-        $this->_template_args['before_list_table'] = ! empty($reg_id) && ! empty($dtt_id)
-            ? '<h2>' . sprintf(
-                esc_html__('Displaying check in records for %1$s for %2$s at the event, %3$s', 'event_espresso'),
-                $attendee_link,
-                $datetime_link,
-                $event_link
-            ) . '</h2>'
-            : '';
-        $this->_template_args['list_table_hidden_fields'] = ! empty($reg_id)
-            ? '<input type="hidden" name="_REG_ID" value="' . $reg_id . '">' : '';
-        $this->_template_args['list_table_hidden_fields'] .= ! empty($dtt_id)
-            ? '<input type="hidden" name="DTT_ID" value="' . $dtt_id . '">' : '';
-        $this->display_admin_list_table_page_with_no_sidebar();
-    }
+	/**
+	 * generates HTML for the Registration Check-in list table (showing all Check-ins for a specific registration)
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws \EventEspresso\core\exceptions\EntityNotFoundException
+	 */
+	protected function _registration_checkin_list_table()
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$reg_id = isset($this->_req_data['_REG_ID']) ? absint($this->_req_data['_REG_ID']) : null;
+		/** @var EE_Registration $registration */
+		$registration = EEM_Registration::instance()->get_one_by_ID($reg_id);
+		if (! $registration instanceof EE_Registration) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__('An error occurred. There is no registration with ID (%d)', 'event_espresso'),
+					$reg_id
+				)
+			);
+		}
+		$attendee = $registration->attendee();
+		$this->_admin_page_title .= $this->get_action_link_or_button(
+			'new_registration',
+			'add-registrant',
+			array('event_id' => $registration->event_ID()),
+			'add-new-h2'
+		);
+		$checked_in = new CheckinStatusDashicon(EE_Checkin::status_checked_in);
+		$checked_out = new CheckinStatusDashicon(EE_Checkin::status_checked_out);
+		$legend_items = array(
+			'checkin'  => array(
+				'class' => $checked_in->cssClasses(),
+				'desc'  => $checked_in->legendLabel(),
+			),
+			'checkout' => array(
+				'class' => $checked_out->cssClasses(),
+				'desc'  => $checked_out->legendLabel(),
+			),
+		);
+		$this->_template_args['after_list_table'] = $this->_display_legend($legend_items);
+		$dtt_id = isset($this->_req_data['DTT_ID']) ? $this->_req_data['DTT_ID'] : null;
+		/** @var EE_Datetime $datetime */
+		$datetime = EEM_Datetime::instance()->get_one_by_ID($dtt_id);
+		$datetime_label = '';
+		if ($datetime instanceof EE_Datetime) {
+			$datetime_label = $datetime->get_dtt_display_name(true);
+			$datetime_label .= ! empty($datetime_label)
+				? ' (' . $datetime->get_dtt_display_name() . ')'
+				: $datetime->get_dtt_display_name();
+		}
+		$datetime_link = ! empty($dtt_id) && $registration instanceof EE_Registration
+			? EE_Admin_Page::add_query_args_and_nonce(
+				array(
+					'action'   => 'event_registrations',
+					'event_id' => $registration->event_ID(),
+					'DTT_ID'   => $dtt_id,
+				),
+				$this->_admin_base_url
+			)
+			: '';
+		$datetime_link = ! empty($datetime_link)
+			? '<a href="' . $datetime_link . '">'
+			  . '<span id="checkin-dtt">'
+			  . $datetime_label
+			  . '</span></a>'
+			: $datetime_label;
+		$attendee_name = $attendee instanceof EE_Attendee
+			? $attendee->full_name()
+			: '';
+		$attendee_link = $attendee instanceof EE_Attendee
+			? $attendee->get_admin_details_link()
+			: '';
+		$attendee_link = ! empty($attendee_link)
+			? '<a href="' . $attendee->get_admin_details_link() . '"'
+			  . ' aria-label="' . esc_html__('Click for attendee details', 'event_espresso') . '">'
+			  . '<span id="checkin-attendee-name">'
+			  . $attendee_name
+			  . '</span></a>'
+			: '';
+		$event_link = $registration->event() instanceof EE_Event
+			? $registration->event()->get_admin_details_link()
+			: '';
+		$event_link = ! empty($event_link)
+			? '<a href="' . $event_link . '"'
+			  . ' aria-label="' . esc_html__('Click here to edit event.', 'event_espresso') . '">'
+			  . '<span id="checkin-event-name">'
+			  . $registration->event_name()
+			  . '</span>'
+			  . '</a>'
+			: '';
+		$this->_template_args['before_list_table'] = ! empty($reg_id) && ! empty($dtt_id)
+			? '<h2>' . sprintf(
+				esc_html__('Displaying check in records for %1$s for %2$s at the event, %3$s', 'event_espresso'),
+				$attendee_link,
+				$datetime_link,
+				$event_link
+			) . '</h2>'
+			: '';
+		$this->_template_args['list_table_hidden_fields'] = ! empty($reg_id)
+			? '<input type="hidden" name="_REG_ID" value="' . $reg_id . '">' : '';
+		$this->_template_args['list_table_hidden_fields'] .= ! empty($dtt_id)
+			? '<input type="hidden" name="DTT_ID" value="' . $dtt_id . '">' : '';
+		$this->display_admin_list_table_page_with_no_sidebar();
+	}
 
 
-    /**
-     * toggle the Check-in status for the given registration (coming from ajax)
-     *
-     * @return void (JSON)
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function toggle_checkin_status()
-    {
-        // first make sure we have the necessary data
-        if (! isset($this->_req_data['_regid'])) {
-            EE_Error::add_error(
-                esc_html__(
-                    'There must be something broken with the html structure because the required data for toggling the Check-in status is not being sent via ajax',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $this->_template_args['success'] = false;
-            $this->_template_args['error'] = true;
-            $this->_return_json();
-        };
-        // do a nonce check cause we're not coming in from an normal route here.
-        $nonce = isset($this->_req_data['checkinnonce']) ? sanitize_text_field($this->_req_data['checkinnonce'])
-            : '';
-        $nonce_ref = 'checkin_nonce';
-        $this->_verify_nonce($nonce, $nonce_ref);
-        // beautiful! Made it this far so let's get the status.
-        $new_status = new CheckinStatusDashicon($this->_toggle_checkin_status());
-        // setup new class to return via ajax
-        $this->_template_args['admin_page_content'] = 'clickable trigger-checkin ' . $new_status->cssClasses();
-        $this->_template_args['success'] = true;
-        $this->_return_json();
-    }
+	/**
+	 * toggle the Check-in status for the given registration (coming from ajax)
+	 *
+	 * @return void (JSON)
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function toggle_checkin_status()
+	{
+		// first make sure we have the necessary data
+		if (! isset($this->_req_data['_regid'])) {
+			EE_Error::add_error(
+				esc_html__(
+					'There must be something broken with the html structure because the required data for toggling the Check-in status is not being sent via ajax',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$this->_template_args['success'] = false;
+			$this->_template_args['error'] = true;
+			$this->_return_json();
+		};
+		// do a nonce check cause we're not coming in from an normal route here.
+		$nonce = isset($this->_req_data['checkinnonce']) ? sanitize_text_field($this->_req_data['checkinnonce'])
+			: '';
+		$nonce_ref = 'checkin_nonce';
+		$this->_verify_nonce($nonce, $nonce_ref);
+		// beautiful! Made it this far so let's get the status.
+		$new_status = new CheckinStatusDashicon($this->_toggle_checkin_status());
+		// setup new class to return via ajax
+		$this->_template_args['admin_page_content'] = 'clickable trigger-checkin ' . $new_status->cssClasses();
+		$this->_template_args['success'] = true;
+		$this->_return_json();
+	}
 
 
-    /**
-     * handles toggling the checkin status for the registration,
-     *
-     * @access protected
-     * @return int|void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _toggle_checkin_status()
-    {
-        // first let's get the query args out of the way for the redirect
-        $query_args = array(
-            'action'   => 'event_registrations',
-            'event_id' => isset($this->_req_data['event_id']) ? $this->_req_data['event_id'] : null,
-            'DTT_ID'   => isset($this->_req_data['DTT_ID']) ? $this->_req_data['DTT_ID'] : null,
-        );
-        $new_status = false;
-        // bulk action check in toggle
-        if (! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
-            // cycle thru checkboxes
-            $checkboxes = $this->_req_data['checkbox'];
-            foreach (array_keys($checkboxes) as $REG_ID) {
-                $DTT_ID = isset($this->_req_data['DTT_ID']) ? $this->_req_data['DTT_ID'] : null;
-                $new_status = $this->_toggle_checkin($REG_ID, $DTT_ID);
-            }
-        } elseif (isset($this->_req_data['_regid'])) {
-            // coming from ajax request
-            $DTT_ID = isset($this->_req_data['dttid']) ? $this->_req_data['dttid'] : null;
-            $query_args['DTT_ID'] = $DTT_ID;
-            $new_status = $this->_toggle_checkin($this->_req_data['_regid'], $DTT_ID);
-        } else {
-            EE_Error::add_error(
-                esc_html__('Missing some required data to toggle the Check-in', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        if (defined('DOING_AJAX')) {
-            return $new_status;
-        }
-        $this->_redirect_after_action(false, '', '', $query_args, true);
-    }
+	/**
+	 * handles toggling the checkin status for the registration,
+	 *
+	 * @access protected
+	 * @return int|void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _toggle_checkin_status()
+	{
+		// first let's get the query args out of the way for the redirect
+		$query_args = array(
+			'action'   => 'event_registrations',
+			'event_id' => isset($this->_req_data['event_id']) ? $this->_req_data['event_id'] : null,
+			'DTT_ID'   => isset($this->_req_data['DTT_ID']) ? $this->_req_data['DTT_ID'] : null,
+		);
+		$new_status = false;
+		// bulk action check in toggle
+		if (! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
+			// cycle thru checkboxes
+			$checkboxes = $this->_req_data['checkbox'];
+			foreach (array_keys($checkboxes) as $REG_ID) {
+				$DTT_ID = isset($this->_req_data['DTT_ID']) ? $this->_req_data['DTT_ID'] : null;
+				$new_status = $this->_toggle_checkin($REG_ID, $DTT_ID);
+			}
+		} elseif (isset($this->_req_data['_regid'])) {
+			// coming from ajax request
+			$DTT_ID = isset($this->_req_data['dttid']) ? $this->_req_data['dttid'] : null;
+			$query_args['DTT_ID'] = $DTT_ID;
+			$new_status = $this->_toggle_checkin($this->_req_data['_regid'], $DTT_ID);
+		} else {
+			EE_Error::add_error(
+				esc_html__('Missing some required data to toggle the Check-in', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		if (defined('DOING_AJAX')) {
+			return $new_status;
+		}
+		$this->_redirect_after_action(false, '', '', $query_args, true);
+	}
 
 
-    /**
-     * This is toggles a single Check-in for the given registration and datetime.
-     *
-     * @param  int $REG_ID The registration we're toggling
-     * @param  int $DTT_ID The datetime we're toggling
-     * @return int The new status toggled to.
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _toggle_checkin($REG_ID, $DTT_ID)
-    {
-        /** @var EE_Registration $REG */
-        $REG = EEM_Registration::instance()->get_one_by_ID($REG_ID);
-        $new_status = $REG->toggle_checkin_status($DTT_ID);
-        if ($new_status !== false) {
-            EE_Error::add_success($REG->get_checkin_msg($DTT_ID));
-        } else {
-            EE_Error::add_error($REG->get_checkin_msg($DTT_ID, true), __FILE__, __FUNCTION__, __LINE__);
-            $new_status = false;
-        }
-        return $new_status;
-    }
+	/**
+	 * This is toggles a single Check-in for the given registration and datetime.
+	 *
+	 * @param  int $REG_ID The registration we're toggling
+	 * @param  int $DTT_ID The datetime we're toggling
+	 * @return int The new status toggled to.
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _toggle_checkin($REG_ID, $DTT_ID)
+	{
+		/** @var EE_Registration $REG */
+		$REG = EEM_Registration::instance()->get_one_by_ID($REG_ID);
+		$new_status = $REG->toggle_checkin_status($DTT_ID);
+		if ($new_status !== false) {
+			EE_Error::add_success($REG->get_checkin_msg($DTT_ID));
+		} else {
+			EE_Error::add_error($REG->get_checkin_msg($DTT_ID, true), __FILE__, __FUNCTION__, __LINE__);
+			$new_status = false;
+		}
+		return $new_status;
+	}
 
 
-    /**
-     * Takes care of deleting multiple EE_Checkin table rows
-     *
-     * @access protected
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _delete_checkin_rows()
-    {
-        $query_args = array(
-            'action'  => 'registration_checkins',
-            'DTT_ID'  => isset($this->_req_data['DTT_ID']) ? $this->_req_data['DTT_ID'] : 0,
-            '_REG_ID' => isset($this->_req_data['_REG_ID']) ? $this->_req_data['_REG_ID'] : 0,
-        );
-        $errors = 0;
-        if (! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
-            $checkboxes = $this->_req_data['checkbox'];
-            foreach (array_keys($checkboxes) as $CHK_ID) {
-                if (! EEM_Checkin::instance()->delete_by_ID($CHK_ID)) {
-                    $errors++;
-                }
-            }
-        } else {
-            EE_Error::add_error(
-                esc_html__(
-                    'So, something went wrong with the bulk delete because there was no data received for instructions on WHAT to delete!',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $this->_redirect_after_action(false, '', '', $query_args, true);
-        }
-        if ($errors > 0) {
-            EE_Error::add_error(
-                sprintf(esc_html__('There were %d records that did not delete successfully', 'event_espresso'), $errors),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        } else {
-            EE_Error::add_success(esc_html__('Records were successfully deleted', 'event_espresso'));
-        }
-        $this->_redirect_after_action(false, '', '', $query_args, true);
-    }
+	/**
+	 * Takes care of deleting multiple EE_Checkin table rows
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _delete_checkin_rows()
+	{
+		$query_args = array(
+			'action'  => 'registration_checkins',
+			'DTT_ID'  => isset($this->_req_data['DTT_ID']) ? $this->_req_data['DTT_ID'] : 0,
+			'_REG_ID' => isset($this->_req_data['_REG_ID']) ? $this->_req_data['_REG_ID'] : 0,
+		);
+		$errors = 0;
+		if (! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
+			$checkboxes = $this->_req_data['checkbox'];
+			foreach (array_keys($checkboxes) as $CHK_ID) {
+				if (! EEM_Checkin::instance()->delete_by_ID($CHK_ID)) {
+					$errors++;
+				}
+			}
+		} else {
+			EE_Error::add_error(
+				esc_html__(
+					'So, something went wrong with the bulk delete because there was no data received for instructions on WHAT to delete!',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$this->_redirect_after_action(false, '', '', $query_args, true);
+		}
+		if ($errors > 0) {
+			EE_Error::add_error(
+				sprintf(esc_html__('There were %d records that did not delete successfully', 'event_espresso'), $errors),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		} else {
+			EE_Error::add_success(esc_html__('Records were successfully deleted', 'event_espresso'));
+		}
+		$this->_redirect_after_action(false, '', '', $query_args, true);
+	}
 
 
-    /**
-     * Deletes a single EE_Checkin row
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _delete_checkin_row()
-    {
-        $query_args = array(
-            'action'  => 'registration_checkins',
-            'DTT_ID'  => isset($this->_req_data['DTT_ID']) ? $this->_req_data['DTT_ID'] : 0,
-            '_REG_ID' => isset($this->_req_data['_REG_ID']) ? $this->_req_data['_REG_ID'] : 0,
-        );
-        if (! empty($this->_req_data['CHK_ID'])) {
-            if (! EEM_Checkin::instance()->delete_by_ID($this->_req_data['CHK_ID'])) {
-                EE_Error::add_error(
-                    esc_html__('Something went wrong and this check-in record was not deleted', 'event_espresso'),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            } else {
-                EE_Error::add_success(esc_html__('Check-In record successfully deleted', 'event_espresso'));
-            }
-        } else {
-            EE_Error::add_error(
-                esc_html__(
-                    'In order to delete a Check-in record, there must be a Check-In ID available. There is not. It is not your fault, there is just a gremlin living in the code',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        $this->_redirect_after_action(false, '', '', $query_args, true);
-    }
+	/**
+	 * Deletes a single EE_Checkin row
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _delete_checkin_row()
+	{
+		$query_args = array(
+			'action'  => 'registration_checkins',
+			'DTT_ID'  => isset($this->_req_data['DTT_ID']) ? $this->_req_data['DTT_ID'] : 0,
+			'_REG_ID' => isset($this->_req_data['_REG_ID']) ? $this->_req_data['_REG_ID'] : 0,
+		);
+		if (! empty($this->_req_data['CHK_ID'])) {
+			if (! EEM_Checkin::instance()->delete_by_ID($this->_req_data['CHK_ID'])) {
+				EE_Error::add_error(
+					esc_html__('Something went wrong and this check-in record was not deleted', 'event_espresso'),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			} else {
+				EE_Error::add_success(esc_html__('Check-In record successfully deleted', 'event_espresso'));
+			}
+		} else {
+			EE_Error::add_error(
+				esc_html__(
+					'In order to delete a Check-in record, there must be a Check-In ID available. There is not. It is not your fault, there is just a gremlin living in the code',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		$this->_redirect_after_action(false, '', '', $query_args, true);
+	}
 
 
-    /**
-     *        generates HTML for the Event Registrations List Table
-     *
-     * @access protected
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _event_registrations_list_table()
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $this->_admin_page_title .= isset($this->_req_data['event_id'])
-            ? $this->get_action_link_or_button(
-                'new_registration',
-                'add-registrant',
-                array('event_id' => $this->_req_data['event_id']),
-                'add-new-h2',
-                '',
-                false
-            )
-            : '';
-        $checked_in = new CheckinStatusDashicon(EE_Checkin::status_checked_in);
-        $checked_out = new CheckinStatusDashicon(EE_Checkin::status_checked_out);
-        $checked_never = new CheckinStatusDashicon(EE_Checkin::status_checked_never);
-        $legend_items = array(
-            'star-icon'        => array(
-                'class' => 'dashicons dashicons-star-filled lt-blue-icon ee-icon-size-8',
-                'desc'  => esc_html__('This Registrant is the Primary Registrant', 'event_espresso'),
-            ),
-            'checkin'          => array(
-                'class' => $checked_in->cssClasses(),
-                'desc'  => $checked_in->legendLabel(),
-            ),
-            'checkout'         => array(
-                'class' => $checked_out->cssClasses(),
-                'desc'  => $checked_out->legendLabel(),
-            ),
-            'nocheckinrecord'  => array(
-                'class' => $checked_never->cssClasses(),
-                'desc'  => $checked_never->legendLabel(),
-            ),
-            'approved_status'  => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_approved,
-                'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_approved, false, 'sentence'),
-            ),
-            'cancelled_status' => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_cancelled,
-                'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_cancelled, false, 'sentence'),
-            ),
-            'declined_status'  => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_declined,
-                'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_declined, false, 'sentence'),
-            ),
-            'not_approved'     => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_not_approved,
-                'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_not_approved, false, 'sentence'),
-            ),
-            'pending_status'   => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_pending_payment,
-                'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_pending_payment, false, 'sentence'),
-            ),
-            'wait_list'        => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_wait_list,
-                'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_wait_list, false, 'sentence'),
-            ),
-        );
-        $this->_template_args['after_list_table'] = $this->_display_legend($legend_items);
-        $event_id = isset($this->_req_data['event_id']) ? $this->_req_data['event_id'] : null;
-        /** @var EE_Event $event */
-        $event = EEM_Event::instance()->get_one_by_ID($event_id);
-        $this->_template_args['before_list_table'] = $event instanceof EE_Event
-            ? '<h2>' . sprintf(
-                esc_html__('Viewing Registrations for Event: %s', 'event_espresso'),
-                EEM_Event::instance()->get_one_by_ID($event_id)->get('EVT_name')
-            ) . '</h2>'
-            : '';
-        // need to get the number of datetimes on the event and set default datetime_id if there is only one datetime on
-        // the event.
-        $DTT_ID = ! empty($this->_req_data['DTT_ID']) ? absint($this->_req_data['DTT_ID']) : 0;
-        $datetime = null;
-        if ($event instanceof EE_Event) {
-            $datetimes_on_event = $event->datetimes();
-            if (count($datetimes_on_event) === 1) {
-                $datetime = reset($datetimes_on_event);
-            }
-        }
-        $datetime = $datetime instanceof EE_Datetime ? $datetime : EEM_Datetime::instance()->get_one_by_ID($DTT_ID);
-        if ($datetime instanceof EE_Datetime && $this->_template_args['before_list_table'] !== '') {
-            $this->_template_args['before_list_table'] = substr($this->_template_args['before_list_table'], 0, -5);
-            $this->_template_args['before_list_table'] .= ' &nbsp;<span class="drk-grey-text">';
-            $this->_template_args['before_list_table'] .= '<span class="dashicons dashicons-calendar"></span>';
-            $this->_template_args['before_list_table'] .= $datetime->name();
-            $this->_template_args['before_list_table'] .= ' ( ' . $datetime->date_and_time_range() . ' )';
-            $this->_template_args['before_list_table'] .= '</span></h2>';
-        }
-        // if no datetime, then we're on the initial view, so let's give some helpful instructions on what the status
-        // column represents
-        if (! $datetime instanceof EE_Datetime) {
-            $this->_template_args['before_list_table'] .= '<br><p class="description">'
-                                                          . esc_html__(
-                                                              'In this view, the check-in status represents the latest check-in record for the registration in that row.',
-                                                              'event_espresso'
-                                                          )
-                                                          . '</p>';
-        }
-        $this->display_admin_list_table_page_with_no_sidebar();
-    }
+	/**
+	 *        generates HTML for the Event Registrations List Table
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _event_registrations_list_table()
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$this->_admin_page_title .= isset($this->_req_data['event_id'])
+			? $this->get_action_link_or_button(
+				'new_registration',
+				'add-registrant',
+				array('event_id' => $this->_req_data['event_id']),
+				'add-new-h2',
+				'',
+				false
+			)
+			: '';
+		$checked_in = new CheckinStatusDashicon(EE_Checkin::status_checked_in);
+		$checked_out = new CheckinStatusDashicon(EE_Checkin::status_checked_out);
+		$checked_never = new CheckinStatusDashicon(EE_Checkin::status_checked_never);
+		$legend_items = array(
+			'star-icon'        => array(
+				'class' => 'dashicons dashicons-star-filled lt-blue-icon ee-icon-size-8',
+				'desc'  => esc_html__('This Registrant is the Primary Registrant', 'event_espresso'),
+			),
+			'checkin'          => array(
+				'class' => $checked_in->cssClasses(),
+				'desc'  => $checked_in->legendLabel(),
+			),
+			'checkout'         => array(
+				'class' => $checked_out->cssClasses(),
+				'desc'  => $checked_out->legendLabel(),
+			),
+			'nocheckinrecord'  => array(
+				'class' => $checked_never->cssClasses(),
+				'desc'  => $checked_never->legendLabel(),
+			),
+			'approved_status'  => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_approved,
+				'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_approved, false, 'sentence'),
+			),
+			'cancelled_status' => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_cancelled,
+				'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_cancelled, false, 'sentence'),
+			),
+			'declined_status'  => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_declined,
+				'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_declined, false, 'sentence'),
+			),
+			'not_approved'     => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_not_approved,
+				'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_not_approved, false, 'sentence'),
+			),
+			'pending_status'   => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_pending_payment,
+				'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_pending_payment, false, 'sentence'),
+			),
+			'wait_list'        => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_wait_list,
+				'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_wait_list, false, 'sentence'),
+			),
+		);
+		$this->_template_args['after_list_table'] = $this->_display_legend($legend_items);
+		$event_id = isset($this->_req_data['event_id']) ? $this->_req_data['event_id'] : null;
+		/** @var EE_Event $event */
+		$event = EEM_Event::instance()->get_one_by_ID($event_id);
+		$this->_template_args['before_list_table'] = $event instanceof EE_Event
+			? '<h2>' . sprintf(
+				esc_html__('Viewing Registrations for Event: %s', 'event_espresso'),
+				EEM_Event::instance()->get_one_by_ID($event_id)->get('EVT_name')
+			) . '</h2>'
+			: '';
+		// need to get the number of datetimes on the event and set default datetime_id if there is only one datetime on
+		// the event.
+		$DTT_ID = ! empty($this->_req_data['DTT_ID']) ? absint($this->_req_data['DTT_ID']) : 0;
+		$datetime = null;
+		if ($event instanceof EE_Event) {
+			$datetimes_on_event = $event->datetimes();
+			if (count($datetimes_on_event) === 1) {
+				$datetime = reset($datetimes_on_event);
+			}
+		}
+		$datetime = $datetime instanceof EE_Datetime ? $datetime : EEM_Datetime::instance()->get_one_by_ID($DTT_ID);
+		if ($datetime instanceof EE_Datetime && $this->_template_args['before_list_table'] !== '') {
+			$this->_template_args['before_list_table'] = substr($this->_template_args['before_list_table'], 0, -5);
+			$this->_template_args['before_list_table'] .= ' &nbsp;<span class="drk-grey-text">';
+			$this->_template_args['before_list_table'] .= '<span class="dashicons dashicons-calendar"></span>';
+			$this->_template_args['before_list_table'] .= $datetime->name();
+			$this->_template_args['before_list_table'] .= ' ( ' . $datetime->date_and_time_range() . ' )';
+			$this->_template_args['before_list_table'] .= '</span></h2>';
+		}
+		// if no datetime, then we're on the initial view, so let's give some helpful instructions on what the status
+		// column represents
+		if (! $datetime instanceof EE_Datetime) {
+			$this->_template_args['before_list_table'] .= '<br><p class="description">'
+														  . esc_html__(
+															  'In this view, the check-in status represents the latest check-in record for the registration in that row.',
+															  'event_espresso'
+														  )
+														  . '</p>';
+		}
+		$this->display_admin_list_table_page_with_no_sidebar();
+	}
 
-    /**
-     * Download the registrations check-in report (same as the normal registration report, but with different where
-     * conditions)
-     *
-     * @return void ends the request by a redirect or download
-     */
-    public function _registrations_checkin_report()
-    {
-        $this->_registrations_report_base('_get_checkin_query_params_from_request');
-    }
+	/**
+	 * Download the registrations check-in report (same as the normal registration report, but with different where
+	 * conditions)
+	 *
+	 * @return void ends the request by a redirect or download
+	 */
+	public function _registrations_checkin_report()
+	{
+		$this->_registrations_report_base('_get_checkin_query_params_from_request');
+	}
 
-    /**
-     * Gets the query params from the request, plus adds a where condition for the registration status,
-     * because on the checkin page we only ever want to see approved and pending-approval registrations
-     *
-     * @param array $request
-     * @param int   $per_page
-     * @param bool  $count
-     * @return array
-     * @throws EE_Error
-     */
-    protected function _get_checkin_query_params_from_request(
-        $request,
-        $per_page = 10,
-        $count = false
-    ) {
-        $query_params = $this->_get_registration_query_parameters($request, $per_page, $count);
-        // unlike the regular registrations list table,
-        $status_ids_array = apply_filters(
-            'FHEE__Extend_Registrations_Admin_Page__get_event_attendees__status_ids_array',
-            array(EEM_Registration::status_id_pending_payment, EEM_Registration::status_id_approved)
-        );
-        $query_params[0]['STS_ID'] = array('IN', $status_ids_array);
-        return $query_params;
-    }
+	/**
+	 * Gets the query params from the request, plus adds a where condition for the registration status,
+	 * because on the checkin page we only ever want to see approved and pending-approval registrations
+	 *
+	 * @param array $request
+	 * @param int   $per_page
+	 * @param bool  $count
+	 * @return array
+	 * @throws EE_Error
+	 */
+	protected function _get_checkin_query_params_from_request(
+		$request,
+		$per_page = 10,
+		$count = false
+	) {
+		$query_params = $this->_get_registration_query_parameters($request, $per_page, $count);
+		// unlike the regular registrations list table,
+		$status_ids_array = apply_filters(
+			'FHEE__Extend_Registrations_Admin_Page__get_event_attendees__status_ids_array',
+			array(EEM_Registration::status_id_pending_payment, EEM_Registration::status_id_approved)
+		);
+		$query_params[0]['STS_ID'] = array('IN', $status_ids_array);
+		return $query_params;
+	}
 
 
-    /**
-     * Gets registrations for an event
-     *
-     * @param int    $per_page
-     * @param bool   $count whether to return count or data.
-     * @param bool   $trash
-     * @param string $orderby
-     * @return EE_Registration[]|int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function get_event_attendees($per_page = 10, $count = false, $trash = false, $orderby = 'ATT_fname')
-    {
-        // set some defaults, these will get overridden if included in the actual request parameters
-        $defaults = [
-            'orderby' => $orderby,
-            'order' => 'ASC',
-        ];
-        if ($trash) {
-            $defaults['status'] = 'trash';
-        }
-        $query_params = $this->_get_checkin_query_params_from_request($defaults, $per_page, $count);
+	/**
+	 * Gets registrations for an event
+	 *
+	 * @param int    $per_page
+	 * @param bool   $count whether to return count or data.
+	 * @param bool   $trash
+	 * @param string $orderby
+	 * @return EE_Registration[]|int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function get_event_attendees($per_page = 10, $count = false, $trash = false, $orderby = 'ATT_fname')
+	{
+		// set some defaults, these will get overridden if included in the actual request parameters
+		$defaults = [
+			'orderby' => $orderby,
+			'order' => 'ASC',
+		];
+		if ($trash) {
+			$defaults['status'] = 'trash';
+		}
+		$query_params = $this->_get_checkin_query_params_from_request($defaults, $per_page, $count);
 
-        /**
-         * Override the default groupby added by EEM_Base so that sorts with multiple order bys work as expected
-         *
-         * @link https://events.codebasehq.com/projects/event-espresso/tickets/10093
-         * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-         *                             or if you have the development copy of EE you can view this at the path:
-         *                             /docs/G--Model-System/model-query-params.md
-         */
-        $query_params['group_by'] = '';
+		/**
+		 * Override the default groupby added by EEM_Base so that sorts with multiple order bys work as expected
+		 *
+		 * @link https://events.codebasehq.com/projects/event-espresso/tickets/10093
+		 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+		 *                             or if you have the development copy of EE you can view this at the path:
+		 *                             /docs/G--Model-System/model-query-params.md
+		 */
+		$query_params['group_by'] = '';
 
-        return $count
-            ? EEM_Registration::instance()->count($query_params)
-            /** @type EE_Registration[] */
-            : EEM_Registration::instance()->get_all($query_params);
-    }
+		return $count
+			? EEM_Registration::instance()->count($query_params)
+			/** @type EE_Registration[] */
+			: EEM_Registration::instance()->get_all($query_params);
+	}
 }

Spacing +49 added lines, -49 removed lines

@@ -30,10 +30,10 @@ 
     public function __construct($routing = true)
     {
         parent::__construct($routing);
-        if (! defined('REG_CAF_TEMPLATE_PATH')) {
-            define('REG_CAF_TEMPLATE_PATH', EE_CORE_CAF_ADMIN_EXTEND . 'registrations/templates/');
-            define('REG_CAF_ASSETS', EE_CORE_CAF_ADMIN_EXTEND . 'registrations/assets/');
-            define('REG_CAF_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL . 'registrations/assets/');
+        if ( ! defined('REG_CAF_TEMPLATE_PATH')) {
+            define('REG_CAF_TEMPLATE_PATH', EE_CORE_CAF_ADMIN_EXTEND.'registrations/templates/');
+            define('REG_CAF_ASSETS', EE_CORE_CAF_ADMIN_EXTEND.'registrations/assets/');
+            define('REG_CAF_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL.'registrations/assets/');
         }
     }
 
@@ -43,7 +43,7 @@ 
      */
     protected function _extend_page_config()
     {
-        $this->_admin_base_path = EE_CORE_CAF_ADMIN_EXTEND . 'registrations';
+        $this->_admin_base_path = EE_CORE_CAF_ADMIN_EXTEND.'registrations';
         $reg_id = ! empty($this->_req_data['_REG_ID']) && ! is_array($this->_req_data['_REG_ID'])
             ? $this->_req_data['_REG_ID']
             : 0;
@@ -180,14 +180,14 @@ 
             // enqueue newsletter js
             wp_enqueue_script(
                 'ee-newsletter-trigger',
-                REG_CAF_ASSETS_URL . 'ee-newsletter-trigger.js',
+                REG_CAF_ASSETS_URL.'ee-newsletter-trigger.js',
                 array('ee-dialog'),
                 EVENT_ESPRESSO_VERSION,
                 true
             );
             wp_enqueue_style(
                 'ee-newsletter-trigger-css',
-                REG_CAF_ASSETS_URL . 'ee-newsletter-trigger.css',
+                REG_CAF_ASSETS_URL.'ee-newsletter-trigger.css',
                 array(),
                 EVENT_ESPRESSO_VERSION
             );
@@ -208,7 +208,7 @@ 
     {
         wp_register_script(
             'ee-reg-reports-js',
-            REG_CAF_ASSETS_URL . 'ee-registration-admin-reports.js',
+            REG_CAF_ASSETS_URL.'ee-registration-admin-reports.js',
             array('google-charts'),
             EVENT_ESPRESSO_VERSION,
             true
@@ -294,7 +294,7 @@ 
         $nonce_ref = 'get_newsletter_form_content_nonce';
         $this->_verify_nonce($nonce, $nonce_ref);
         // let's get the mtp for the incoming MTP_ ID
-        if (! isset($this->_req_data['GRP_ID'])) {
+        if ( ! isset($this->_req_data['GRP_ID'])) {
             EE_Error::add_error(
                 esc_html__(
                     'There must be something broken with the js or html structure because the required data for getting a message template group is not present (need an GRP_ID).',
@@ -309,7 +309,7 @@ 
             $this->_return_json();
         }
         $MTPG = EEM_Message_Template_Group::instance()->get_one_by_ID($this->_req_data['GRP_ID']);
-        if (! $MTPG instanceof EE_Message_Template_Group) {
+        if ( ! $MTPG instanceof EE_Message_Template_Group) {
             EE_Error::add_error(
                 sprintf(
                     esc_html__(
@@ -334,12 +334,12 @@ 
             $field = $MTP->get('MTP_template_field');
             if ($field === 'content') {
                 $content = $MTP->get('MTP_content');
-                if (! empty($content['newsletter_content'])) {
+                if ( ! empty($content['newsletter_content'])) {
                     $template_fields['newsletter_content'] = $content['newsletter_content'];
                 }
                 continue;
             }
-            $template_fields[ $MTP->get('MTP_template_field') ] = $MTP->get('MTP_content');
+            $template_fields[$MTP->get('MTP_template_field')] = $MTP->get('MTP_content');
         }
         $this->_template_args['success'] = true;
         $this->_template_args['error'] = false;
@@ -441,17 +441,17 @@ 
                 $field_id = $field === '[NEWSLETTER_CONTENT]'
                     ? 'content'
                     : $field;
-                $field_id = 'batch-message-' . strtolower($field_id);
+                $field_id = 'batch-message-'.strtolower($field_id);
                 $available_shortcodes[] = '<span class="js-shortcode-selection" data-value="'
                                           . $shortcode
-                                          . '" data-linked-input-id="' . $field_id . '">'
+                                          . '" data-linked-input-id="'.$field_id.'">'
                                           . $shortcode
                                           . '</span>';
             }
-            $codes[ $field ] = implode(', ', $available_shortcodes);
+            $codes[$field] = implode(', ', $available_shortcodes);
         }
         $shortcodes = $codes;
-        $form_template = REG_CAF_TEMPLATE_PATH . 'newsletter-send-form.template.php';
+        $form_template = REG_CAF_TEMPLATE_PATH.'newsletter-send-form.template.php';
         $form_template_args = array(
             'form_action'       => admin_url('admin.php?page=espresso_registrations'),
             'form_route'        => 'newsletter_selected_send',
@@ -619,7 +619,7 @@ 
      */
     protected function _registration_reports()
     {
-        $template_path = EE_ADMIN_TEMPLATE . 'admin_reports.template.php';
+        $template_path = EE_ADMIN_TEMPLATE.'admin_reports.template.php';
         $this->_template_args['admin_page_content'] = EEH_Template::display_template(
             $template_path,
             $this->_reports_template_data,
@@ -674,7 +674,7 @@ 
             array_unshift($regs, $column_titles);
             // setup the date range.
             $DateTimeZone = new DateTimeZone(EEH_DTT_Helper::get_timezone());
-            $beginning_date = new DateTime("now " . $period, $DateTimeZone);
+            $beginning_date = new DateTime("now ".$period, $DateTimeZone);
             $ending_date = new DateTime("now", $DateTimeZone);
             $subtitle = sprintf(
                 wp_strip_all_tags(
@@ -698,7 +698,7 @@ 
                         'event_espresso'
                     )
                 ),
-                '<h2>' . $report_title . '</h2><p>',
+                '<h2>'.$report_title.'</h2><p>',
                 '</p>'
             ),
         );
@@ -751,7 +751,7 @@ 
             array_unshift($regs, $column_titles);
             // setup the date range.
             $DateTimeZone = new DateTimeZone(EEH_DTT_Helper::get_timezone());
-            $beginning_date = new DateTime("now " . $period, $DateTimeZone);
+            $beginning_date = new DateTime("now ".$period, $DateTimeZone);
             $ending_date = new DateTime("now", $DateTimeZone);
             $subtitle = sprintf(
                 wp_strip_all_tags(
@@ -775,7 +775,7 @@ 
                         'event_espresso'
                     )
                 ),
-                '<h2>' . $report_title . '</h2><p>',
+                '<h2>'.$report_title.'</h2><p>',
                 '</p>'
             ),
         );
@@ -801,7 +801,7 @@ 
         $reg_id = isset($this->_req_data['_REG_ID']) ? absint($this->_req_data['_REG_ID']) : null;
         /** @var EE_Registration $registration */
         $registration = EEM_Registration::instance()->get_one_by_ID($reg_id);
-        if (! $registration instanceof EE_Registration) {
+        if ( ! $registration instanceof EE_Registration) {
             throw new EE_Error(
                 sprintf(
                     esc_html__('An error occurred. There is no registration with ID (%d)', 'event_espresso'),
@@ -836,7 +836,7 @@ 
         if ($datetime instanceof EE_Datetime) {
             $datetime_label = $datetime->get_dtt_display_name(true);
             $datetime_label .= ! empty($datetime_label)
-                ? ' (' . $datetime->get_dtt_display_name() . ')'
+                ? ' ('.$datetime->get_dtt_display_name().')'
                 : $datetime->get_dtt_display_name();
         }
         $datetime_link = ! empty($dtt_id) && $registration instanceof EE_Registration
@@ -850,7 +850,7 @@ 
             )
             : '';
         $datetime_link = ! empty($datetime_link)
-            ? '<a href="' . $datetime_link . '">'
+            ? '<a href="'.$datetime_link.'">'
               . '<span id="checkin-dtt">'
               . $datetime_label
               . '</span></a>'
@@ -862,8 +862,8 @@ 
             ? $attendee->get_admin_details_link()
             : '';
         $attendee_link = ! empty($attendee_link)
-            ? '<a href="' . $attendee->get_admin_details_link() . '"'
-              . ' aria-label="' . esc_html__('Click for attendee details', 'event_espresso') . '">'
+            ? '<a href="'.$attendee->get_admin_details_link().'"'
+              . ' aria-label="'.esc_html__('Click for attendee details', 'event_espresso').'">'
               . '<span id="checkin-attendee-name">'
               . $attendee_name
               . '</span></a>'
@@ -872,25 +872,25 @@ 
             ? $registration->event()->get_admin_details_link()
             : '';
         $event_link = ! empty($event_link)
-            ? '<a href="' . $event_link . '"'
-              . ' aria-label="' . esc_html__('Click here to edit event.', 'event_espresso') . '">'
+            ? '<a href="'.$event_link.'"'
+              . ' aria-label="'.esc_html__('Click here to edit event.', 'event_espresso').'">'
               . '<span id="checkin-event-name">'
               . $registration->event_name()
               . '</span>'
               . '</a>'
             : '';
         $this->_template_args['before_list_table'] = ! empty($reg_id) && ! empty($dtt_id)
-            ? '<h2>' . sprintf(
+            ? '<h2>'.sprintf(
                 esc_html__('Displaying check in records for %1$s for %2$s at the event, %3$s', 'event_espresso'),
                 $attendee_link,
                 $datetime_link,
                 $event_link
-            ) . '</h2>'
+            ).'</h2>'
             : '';
         $this->_template_args['list_table_hidden_fields'] = ! empty($reg_id)
-            ? '<input type="hidden" name="_REG_ID" value="' . $reg_id . '">' : '';
+            ? '<input type="hidden" name="_REG_ID" value="'.$reg_id.'">' : '';
         $this->_template_args['list_table_hidden_fields'] .= ! empty($dtt_id)
-            ? '<input type="hidden" name="DTT_ID" value="' . $dtt_id . '">' : '';
+            ? '<input type="hidden" name="DTT_ID" value="'.$dtt_id.'">' : '';
         $this->display_admin_list_table_page_with_no_sidebar();
     }
 
@@ -907,7 +907,7 @@ 
     public function toggle_checkin_status()
     {
         // first make sure we have the necessary data
-        if (! isset($this->_req_data['_regid'])) {
+        if ( ! isset($this->_req_data['_regid'])) {
             EE_Error::add_error(
                 esc_html__(
                     'There must be something broken with the html structure because the required data for toggling the Check-in status is not being sent via ajax',
@@ -929,7 +929,7 @@ 
         // beautiful! Made it this far so let's get the status.
         $new_status = new CheckinStatusDashicon($this->_toggle_checkin_status());
         // setup new class to return via ajax
-        $this->_template_args['admin_page_content'] = 'clickable trigger-checkin ' . $new_status->cssClasses();
+        $this->_template_args['admin_page_content'] = 'clickable trigger-checkin '.$new_status->cssClasses();
         $this->_template_args['success'] = true;
         $this->_return_json();
     }
@@ -955,7 +955,7 @@ 
         );
         $new_status = false;
         // bulk action check in toggle
-        if (! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
+        if ( ! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
             // cycle thru checkboxes
             $checkboxes = $this->_req_data['checkbox'];
             foreach (array_keys($checkboxes) as $REG_ID) {
@@ -1026,10 +1026,10 @@ 
             '_REG_ID' => isset($this->_req_data['_REG_ID']) ? $this->_req_data['_REG_ID'] : 0,
         );
         $errors = 0;
-        if (! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
+        if ( ! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
             $checkboxes = $this->_req_data['checkbox'];
             foreach (array_keys($checkboxes) as $CHK_ID) {
-                if (! EEM_Checkin::instance()->delete_by_ID($CHK_ID)) {
+                if ( ! EEM_Checkin::instance()->delete_by_ID($CHK_ID)) {
                     $errors++;
                 }
             }
@@ -1075,8 +1075,8 @@ 
             'DTT_ID'  => isset($this->_req_data['DTT_ID']) ? $this->_req_data['DTT_ID'] : 0,
             '_REG_ID' => isset($this->_req_data['_REG_ID']) ? $this->_req_data['_REG_ID'] : 0,
         );
-        if (! empty($this->_req_data['CHK_ID'])) {
-            if (! EEM_Checkin::instance()->delete_by_ID($this->_req_data['CHK_ID'])) {
+        if ( ! empty($this->_req_data['CHK_ID'])) {
+            if ( ! EEM_Checkin::instance()->delete_by_ID($this->_req_data['CHK_ID'])) {
                 EE_Error::add_error(
                     esc_html__('Something went wrong and this check-in record was not deleted', 'event_espresso'),
                     __FILE__,
@@ -1145,27 +1145,27 @@ 
                 'desc'  => $checked_never->legendLabel(),
             ),
             'approved_status'  => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_approved,
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Registration::status_id_approved,
                 'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_approved, false, 'sentence'),
             ),
             'cancelled_status' => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_cancelled,
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Registration::status_id_cancelled,
                 'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_cancelled, false, 'sentence'),
             ),
             'declined_status'  => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_declined,
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Registration::status_id_declined,
                 'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_declined, false, 'sentence'),
             ),
             'not_approved'     => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_not_approved,
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Registration::status_id_not_approved,
                 'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_not_approved, false, 'sentence'),
             ),
             'pending_status'   => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_pending_payment,
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Registration::status_id_pending_payment,
                 'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_pending_payment, false, 'sentence'),
             ),
             'wait_list'        => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_wait_list,
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Registration::status_id_wait_list,
                 'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_wait_list, false, 'sentence'),
             ),
         );
@@ -1174,10 +1174,10 @@ 
         /** @var EE_Event $event */
         $event = EEM_Event::instance()->get_one_by_ID($event_id);
         $this->_template_args['before_list_table'] = $event instanceof EE_Event
-            ? '<h2>' . sprintf(
+            ? '<h2>'.sprintf(
                 esc_html__('Viewing Registrations for Event: %s', 'event_espresso'),
                 EEM_Event::instance()->get_one_by_ID($event_id)->get('EVT_name')
-            ) . '</h2>'
+            ).'</h2>'
             : '';
         // need to get the number of datetimes on the event and set default datetime_id if there is only one datetime on
         // the event.
@@ -1195,12 +1195,12 @@ 
             $this->_template_args['before_list_table'] .= ' &nbsp;<span class="drk-grey-text">';
             $this->_template_args['before_list_table'] .= '<span class="dashicons dashicons-calendar"></span>';
             $this->_template_args['before_list_table'] .= $datetime->name();
-            $this->_template_args['before_list_table'] .= ' ( ' . $datetime->date_and_time_range() . ' )';
+            $this->_template_args['before_list_table'] .= ' ( '.$datetime->date_and_time_range().' )';
             $this->_template_args['before_list_table'] .= '</span></h2>';
         }
         // if no datetime, then we're on the initial view, so let's give some helpful instructions on what the status
         // column represents
-        if (! $datetime instanceof EE_Datetime) {
+        if ( ! $datetime instanceof EE_Datetime) {
             $this->_template_args['before_list_table'] .= '<br><p class="description">'
                                                           . esc_html__(
                                                               'In this view, the check-in status represents the latest check-in record for the registration in that row.',

caffeinated/admin/extend/registration_form/Extend_Registration_Form_Admin_Page.core.php

Indentation +1440 added lines, -1440 removed lines

@@ -14,1444 +14,1444 @@
  */
 class Extend_Registration_Form_Admin_Page extends Registration_Form_Admin_Page
 {
-    /**
-     * @param bool $routing indicate whether we want to just load the object and handle routing or just load the object.
-     */
-    public function __construct($routing = true)
-    {
-        define('REGISTRATION_FORM_CAF_ADMIN', EE_CORE_CAF_ADMIN_EXTEND . 'registration_form/');
-        define('REGISTRATION_FORM_CAF_ASSETS_PATH', REGISTRATION_FORM_CAF_ADMIN . 'assets/');
-        define('REGISTRATION_FORM_CAF_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL . 'registration_form/assets/');
-        define('REGISTRATION_FORM_CAF_TEMPLATE_PATH', REGISTRATION_FORM_CAF_ADMIN . 'templates/');
-        define('REGISTRATION_FORM_CAF_TEMPLATE_URL', EE_CORE_CAF_ADMIN_EXTEND_URL . 'registration_form/templates/');
-        parent::__construct($routing);
-    }
-
-
-    /**
-     * @return void
-     */
-    protected function _extend_page_config()
-    {
-        $this->_admin_base_path = REGISTRATION_FORM_CAF_ADMIN;
-        $qst_id = ! empty($this->_req_data['QST_ID']) && ! is_array($this->_req_data['QST_ID'])
-            ? $this->_req_data['QST_ID'] : 0;
-        $qsg_id = ! empty($this->_req_data['QSG_ID']) && ! is_array($this->_req_data['QSG_ID'])
-            ? $this->_req_data['QSG_ID'] : 0;
-
-        $new_page_routes = array(
-            'question_groups'    => array(
-                'func'       => '_question_groups_overview_list_table',
-                'capability' => 'ee_read_question_groups',
-            ),
-            'add_question'       => array(
-                'func'       => '_edit_question',
-                'capability' => 'ee_edit_questions',
-            ),
-            'insert_question'    => array(
-                'func'       => '_insert_or_update_question',
-                'args'       => array('new_question' => true),
-                'capability' => 'ee_edit_questions',
-                'noheader'   => true,
-            ),
-            'duplicate_question' => array(
-                'func'       => '_duplicate_question',
-                'capability' => 'ee_edit_questions',
-                'noheader'   => true,
-            ),
-            'trash_question'     => array(
-                'func'       => '_trash_question',
-                'capability' => 'ee_delete_question',
-                'obj_id'     => $qst_id,
-                'noheader'   => true,
-            ),
-
-            'restore_question' => array(
-                'func'       => '_trash_or_restore_questions',
-                'capability' => 'ee_delete_question',
-                'obj_id'     => $qst_id,
-                'args'       => array('trash' => false),
-                'noheader'   => true,
-            ),
-
-            'delete_question' => array(
-                'func'       => '_delete_question',
-                'capability' => 'ee_delete_question',
-                'obj_id'     => $qst_id,
-                'noheader'   => true,
-            ),
-
-            'trash_questions' => array(
-                'func'       => '_trash_or_restore_questions',
-                'capability' => 'ee_delete_questions',
-                'args'       => array('trash' => true),
-                'noheader'   => true,
-            ),
-
-            'restore_questions' => array(
-                'func'       => '_trash_or_restore_questions',
-                'capability' => 'ee_delete_questions',
-                'args'       => array('trash' => false),
-                'noheader'   => true,
-            ),
-
-            'delete_questions' => array(
-                'func'       => '_delete_questions',
-                'args'       => array(),
-                'capability' => 'ee_delete_questions',
-                'noheader'   => true,
-            ),
-
-            'add_question_group' => array(
-                'func'       => '_edit_question_group',
-                'capability' => 'ee_edit_question_groups',
-            ),
-
-            'edit_question_group' => array(
-                'func'       => '_edit_question_group',
-                'capability' => 'ee_edit_question_group',
-                'obj_id'     => $qsg_id,
-                'args'       => array('edit'),
-            ),
-
-            'delete_question_groups' => array(
-                'func'       => '_delete_question_groups',
-                'capability' => 'ee_delete_question_groups',
-                'noheader'   => true,
-            ),
-
-            'delete_question_group' => array(
-                'func'       => '_delete_question_groups',
-                'capability' => 'ee_delete_question_group',
-                'obj_id'     => $qsg_id,
-                'noheader'   => true,
-            ),
-
-            'trash_question_group' => array(
-                'func'       => '_trash_or_restore_question_groups',
-                'args'       => array('trash' => true),
-                'capability' => 'ee_delete_question_group',
-                'obj_id'     => $qsg_id,
-                'noheader'   => true,
-            ),
-
-            'restore_question_group' => array(
-                'func'       => '_trash_or_restore_question_groups',
-                'args'       => array('trash' => false),
-                'capability' => 'ee_delete_question_group',
-                'obj_id'     => $qsg_id,
-                'noheader'   => true,
-            ),
-
-            'insert_question_group' => array(
-                'func'       => '_insert_or_update_question_group',
-                'args'       => array('new_question_group' => true),
-                'capability' => 'ee_edit_question_groups',
-                'noheader'   => true,
-            ),
-
-            'update_question_group' => array(
-                'func'       => '_insert_or_update_question_group',
-                'args'       => array('new_question_group' => false),
-                'capability' => 'ee_edit_question_group',
-                'obj_id'     => $qsg_id,
-                'noheader'   => true,
-            ),
-
-            'trash_question_groups' => array(
-                'func'       => '_trash_or_restore_question_groups',
-                'args'       => array('trash' => true),
-                'capability' => 'ee_delete_question_groups',
-                'noheader'   => array('trash' => false),
-            ),
-
-            'restore_question_groups' => array(
-                'func'       => '_trash_or_restore_question_groups',
-                'args'       => array('trash' => false),
-                'capability' => 'ee_delete_question_groups',
-                'noheader'   => true,
-            ),
-
-
-            'espresso_update_question_group_order' => array(
-                'func'       => 'update_question_group_order',
-                'capability' => 'ee_edit_question_groups',
-                'noheader'   => true,
-            ),
-
-            'view_reg_form_settings' => array(
-                'func'       => '_reg_form_settings',
-                'capability' => 'manage_options',
-            ),
-
-            'update_reg_form_settings' => array(
-                'func'       => '_update_reg_form_settings',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-            ),
-        );
-        $this->_page_routes = array_merge($this->_page_routes, $new_page_routes);
-
-        $new_page_config = array(
-
-            'question_groups' => array(
-                'nav'           => array(
-                    'label' => esc_html__('Question Groups', 'event_espresso'),
-                    'order' => 20,
-                ),
-                'list_table'    => 'Registration_Form_Question_Groups_Admin_List_Table',
-                'help_tabs'     => array(
-                    'registration_form_question_groups_help_tab'                           => array(
-                        'title'    => esc_html__('Question Groups', 'event_espresso'),
-                        'filename' => 'registration_form_question_groups',
-                    ),
-                    'registration_form_question_groups_table_column_headings_help_tab'     => array(
-                        'title'    => esc_html__('Question Groups Table Column Headings', 'event_espresso'),
-                        'filename' => 'registration_form_question_groups_table_column_headings',
-                    ),
-                    'registration_form_question_groups_views_bulk_actions_search_help_tab' => array(
-                        'title'    => esc_html__('Question Groups Views & Bulk Actions & Search', 'event_espresso'),
-                        'filename' => 'registration_form_question_groups_views_bulk_actions_search',
-                    ),
-                ),
-                'metaboxes'     => $this->_default_espresso_metaboxes,
-                'require_nonce' => false,
-                'qtips'         => array(
-                    'EE_Registration_Form_Tips',
-                ),
-            ),
-
-            'add_question' => array(
-                'nav'           => array(
-                    'label'      => esc_html__('Add Question', 'event_espresso'),
-                    'order'      => 5,
-                    'persistent' => false,
-                ),
-                'metaboxes'     => array_merge($this->_default_espresso_metaboxes, array('_publish_post_box')),
-                'help_tabs'     => array(
-                    'registration_form_add_question_help_tab' => array(
-                        'title'    => esc_html__('Add Question', 'event_espresso'),
-                        'filename' => 'registration_form_add_question',
-                    ),
-                ),
-                'require_nonce' => false,
-            ),
-
-            'add_question_group' => array(
-                'nav'           => array(
-                    'label'      => esc_html__('Add Question Group', 'event_espresso'),
-                    'order'      => 5,
-                    'persistent' => false,
-                ),
-                'metaboxes'     => array_merge($this->_default_espresso_metaboxes, array('_publish_post_box')),
-                'help_tabs'     => array(
-                    'registration_form_add_question_group_help_tab' => array(
-                        'title'    => esc_html__('Add Question Group', 'event_espresso'),
-                        'filename' => 'registration_form_add_question_group',
-                    ),
-                ),
-                'require_nonce' => false,
-            ),
-
-            'edit_question_group' => array(
-                'nav'           => array(
-                    'label'      => esc_html__('Edit Question Group', 'event_espresso'),
-                    'order'      => 5,
-                    'persistent' => false,
-                    'url'        => isset($this->_req_data['question_group_id']) ? add_query_arg(
-                        array('question_group_id' => $this->_req_data['question_group_id']),
-                        $this->_current_page_view_url
-                    ) : $this->_admin_base_url,
-                ),
-                'metaboxes'     => array_merge($this->_default_espresso_metaboxes, array('_publish_post_box')),
-                'help_tabs'     => array(
-                    'registration_form_edit_question_group_help_tab' => array(
-                        'title'    => esc_html__('Edit Question Group', 'event_espresso'),
-                        'filename' => 'registration_form_edit_question_group',
-                    ),
-                ),
-                'require_nonce' => false,
-            ),
-
-            'view_reg_form_settings' => array(
-                'nav'           => array(
-                    'label' => esc_html__('Reg Form Settings', 'event_espresso'),
-                    'order' => 40,
-                ),
-                'labels'        => array(
-                    'publishbox' => esc_html__('Update Settings', 'event_espresso'),
-                ),
-                'metaboxes'     => array_merge($this->_default_espresso_metaboxes, array('_publish_post_box')),
-                'help_tabs'     => array(
-                    'registration_form_reg_form_settings_help_tab' => array(
-                        'title'    => esc_html__('Registration Form Settings', 'event_espresso'),
-                        'filename' => 'registration_form_reg_form_settings',
-                    ),
-                ),
-                'require_nonce' => false,
-            ),
-
-        );
-        $this->_page_config = array_merge($this->_page_config, $new_page_config);
-
-        // change the list table we're going to use so it's the NEW list table!
-        $this->_page_config['default']['list_table'] = 'Extend_Registration_Form_Questions_Admin_List_Table';
-
-
-        // additional labels
-        $new_labels = array(
-            'add_question'          => esc_html__('Add New Question', 'event_espresso'),
-            'delete_question'       => esc_html__('Delete Question', 'event_espresso'),
-            'add_question_group'    => esc_html__('Add New Question Group', 'event_espresso'),
-            'edit_question_group'   => esc_html__('Edit Question Group', 'event_espresso'),
-            'delete_question_group' => esc_html__('Delete Question Group', 'event_espresso'),
-        );
-        $this->_labels['buttons'] = array_merge($this->_labels['buttons'], $new_labels);
-    }
-
-
-    /**
-     * @return void
-     */
-    protected function _ajax_hooks()
-    {
-        add_action('wp_ajax_espresso_update_question_group_order', array($this, 'update_question_group_order'));
-    }
-
-
-    /**
-     * @return void
-     */
-    public function load_scripts_styles_question_groups()
-    {
-        wp_enqueue_script('espresso_ajax_table_sorting');
-    }
-
-
-    /**
-     * @return void
-     */
-    public function load_scripts_styles_add_question_group()
-    {
-        $this->load_scripts_styles_forms();
-        $this->load_sortable_question_script();
-    }
-
-
-    /**
-     * @return void
-     */
-    public function load_scripts_styles_edit_question_group()
-    {
-        $this->load_scripts_styles_forms();
-        $this->load_sortable_question_script();
-    }
-
-
-    /**
-     * registers and enqueues script for questions
-     *
-     * @return void
-     */
-    public function load_sortable_question_script()
-    {
-        wp_register_script(
-            'ee-question-sortable',
-            REGISTRATION_FORM_CAF_ASSETS_URL . 'ee_question_order.js',
-            array('jquery-ui-sortable'),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_enqueue_script('ee-question-sortable');
-    }
-
-
-    /**
-     * @return void
-     */
-    protected function _set_list_table_views_default()
-    {
-        $this->_views = array(
-            'all' => array(
-                'slug'        => 'all',
-                'label'       => esc_html__('View All Questions', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => array(
-                    'trash_questions' => esc_html__('Trash', 'event_espresso'),
-                ),
-            ),
-        );
-
-        if (
-            EE_Registry::instance()->CAP->current_user_can(
-                'ee_delete_questions',
-                'espresso_registration_form_trash_questions'
-            )
-        ) {
-            $this->_views['trash'] = array(
-                'slug'        => 'trash',
-                'label'       => esc_html__('Trash', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => array(
-                    'delete_questions'  => esc_html__('Delete Permanently', 'event_espresso'),
-                    'restore_questions' => esc_html__('Restore', 'event_espresso'),
-                ),
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    protected function _set_list_table_views_question_groups()
-    {
-        $this->_views = array(
-            'all' => array(
-                'slug'        => 'all',
-                'label'       => esc_html__('All', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => array(
-                    'trash_question_groups' => esc_html__('Trash', 'event_espresso'),
-                ),
-            ),
-        );
-
-        if (
-            EE_Registry::instance()->CAP->current_user_can(
-                'ee_delete_question_groups',
-                'espresso_registration_form_trash_question_groups'
-            )
-        ) {
-            $this->_views['trash'] = array(
-                'slug'        => 'trash',
-                'label'       => esc_html__('Trash', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => array(
-                    'delete_question_groups'  => esc_html__('Delete Permanently', 'event_espresso'),
-                    'restore_question_groups' => esc_html__('Restore', 'event_espresso'),
-                ),
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _questions_overview_list_table()
-    {
-        $this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
-            'add_question',
-            'add_question',
-            array(),
-            'add-new-h2'
-        );
-        parent::_questions_overview_list_table();
-    }
-
-
-    /**
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _question_groups_overview_list_table()
-    {
-        $this->_search_btn_label = esc_html__('Question Groups', 'event_espresso');
-        $this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
-            'add_question_group',
-            'add_question_group',
-            array(),
-            'add-new-h2'
-        );
-        $this->display_admin_list_table_page_with_sidebar();
-    }
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _delete_question()
-    {
-        $success = $this->_delete_items($this->_question_model);
-        $this->_redirect_after_action(
-            $success,
-            $this->_question_model->item_name($success),
-            'deleted',
-            array('action' => 'default', 'status' => 'all')
-        );
-    }
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _delete_questions()
-    {
-        $success = $this->_delete_items($this->_question_model);
-        $this->_redirect_after_action(
-            $success,
-            $this->_question_model->item_name($success),
-            'deleted permanently',
-            array('action' => 'default', 'status' => 'trash')
-        );
-    }
-
-
-    /**
-     * Performs the deletion of a single or multiple questions or question groups.
-     *
-     * @param EEM_Soft_Delete_Base $model
-     * @return int number of items deleted permanently
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _delete_items(EEM_Soft_Delete_Base $model)
-    {
-        $success = 0;
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        if (! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
-            // if array has more than one element than success message should be plural
-            $success = count($this->_req_data['checkbox']) > 1 ? 2 : 1;
-            // cycle thru bulk action checkboxes
-            $checkboxes = $this->_req_data['checkbox'];
-            foreach (array_keys($checkboxes) as $ID) {
-                if (! $this->_delete_item($ID, $model)) {
-                    $success = 0;
-                }
-            }
-        } elseif (! empty($this->_req_data['QSG_ID'])) {
-            $success = $this->_delete_item($this->_req_data['QSG_ID'], $model);
-        } elseif (! empty($this->_req_data['QST_ID'])) {
-            $success = $this->_delete_item($this->_req_data['QST_ID'], $model);
-        } else {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        "No Questions or Question Groups were selected for deleting. This error usually shows when you've attempted to delete via bulk action but there were no selections.",
-                        "event_espresso"
-                    )
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        return $success;
-    }
-
-
-    /**
-     * Deletes the specified question (and its associated question options) or question group
-     *
-     * @param int                  $id
-     * @param EEM_Soft_Delete_Base $model
-     * @return boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _delete_item($id, $model)
-    {
-        if ($model instanceof EEM_Question) {
-            EEM_Question_Option::instance()->delete_permanently(array(array('QST_ID' => absint($id))));
-        }
-        return $model->delete_permanently_by_ID(absint($id));
-    }
-
-
-    /******************************    QUESTION GROUPS    ******************************/
-
-
-    /**
-     * @param string $type
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _edit_question_group($type = 'add')
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $ID = isset($this->_req_data['QSG_ID']) && ! empty($this->_req_data['QSG_ID'])
-            ? absint($this->_req_data['QSG_ID'])
-            : false;
-
-        switch ($this->_req_action) {
-            case 'add_question_group':
-                $this->_admin_page_title = esc_html__('Add Question Group', 'event_espresso');
-                break;
-            case 'edit_question_group':
-                $this->_admin_page_title = esc_html__('Edit Question Group', 'event_espresso');
-                break;
-            default:
-                $this->_admin_page_title = ucwords(str_replace('_', ' ', $this->_req_action));
-        }
-        // add ID to title if editing
-        $this->_admin_page_title = $ID ? $this->_admin_page_title . ' # ' . $ID : $this->_admin_page_title;
-        if ($ID) {
-            /** @var EE_Question_Group $questionGroup */
-            $questionGroup = $this->_question_group_model->get_one_by_ID($ID);
-            $additional_hidden_fields = array('QSG_ID' => array('type' => 'hidden', 'value' => $ID));
-            $this->_set_add_edit_form_tags('update_question_group', $additional_hidden_fields);
-        } else {
-            /** @var EE_Question_Group $questionGroup */
-            $questionGroup = EEM_Question_Group::instance()->create_default_object();
-            $questionGroup->set_order_to_latest();
-            $this->_set_add_edit_form_tags('insert_question_group');
-        }
-        $this->_template_args['values'] = $this->_yes_no_values;
-        $this->_template_args['all_questions'] = $questionGroup->questions_in_and_not_in_group();
-        $this->_template_args['QSG_ID'] = $ID ? $ID : true;
-        $this->_template_args['question_group'] = $questionGroup;
-
-        $redirect_URL = add_query_arg(array('action' => 'question_groups'), $this->_admin_base_url);
-        $this->_set_publish_post_box_vars('id', $ID, false, $redirect_URL);
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            REGISTRATION_FORM_CAF_TEMPLATE_PATH . 'question_groups_main_meta_box.template.php',
-            $this->_template_args,
-            true
-        );
-
-        // the details template wrapper
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _delete_question_groups()
-    {
-        $success = $this->_delete_items($this->_question_group_model);
-        $this->_redirect_after_action(
-            $success,
-            $this->_question_group_model->item_name($success),
-            'deleted permanently',
-            array('action' => 'question_groups', 'status' => 'trash')
-        );
-    }
-
-
-    /**
-     * @param bool $new_question_group
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _insert_or_update_question_group($new_question_group = true)
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $set_column_values = $this->_set_column_values_for($this->_question_group_model);
-
-        // make sure identifier is unique
-        $identifier_value = isset($set_column_values['QSG_identifier']) ? $set_column_values['QSG_identifier'] : '';
-        $where_values = ['QSG_identifier' => $set_column_values['QSG_identifier']];
-        if (! $new_question_group && isset($set_column_values['QSG_ID'])) {
-            $where_values['QSG_ID'] = ['!=', $set_column_values['QSG_ID']];
-        }
-        $identifier_exists = ! empty($identifier_value)
-            ? $this->_question_group_model->count([$where_values]) > 0
-            : false;
-        if ($identifier_exists) {
-            $set_column_values['QSG_identifier'] .= uniqid('id', true);
-        }
-
-        if ($new_question_group) {
-            $QSG_ID = $this->_question_group_model->insert($set_column_values);
-            $success = $QSG_ID ? 1 : 0;
-            if ($success === 0) {
-                EE_Error::add_error(
-                    esc_html__('Something went wrong saving the question group.', 'event_espresso'),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-                $this->_redirect_after_action(
-                    false,
-                    '',
-                    '',
-                    array('action' => 'edit_question_group', 'QSG_ID' => $QSG_ID),
-                    true
-                );
-            }
-        } else {
-            $QSG_ID = absint($this->_req_data['QSG_ID']);
-            unset($set_column_values['QSG_ID']);
-            $success = $this->_question_group_model->update($set_column_values, array(array('QSG_ID' => $QSG_ID)));
-        }
-
-        $phone_question_id = EEM_Question::instance()->get_Question_ID_from_system_string(
-            EEM_Attendee::system_question_phone
-        );
-        // update the existing related questions
-        // BUT FIRST...  delete the phone question from the Question_Group_Question
-        // if it is being added to this question group (therefore removed from the existing group)
-        if (isset($this->_req_data['questions'], $this->_req_data['questions'][ $phone_question_id ])) {
-            // delete where QST ID = system phone question ID and Question Group ID is NOT this group
-            EEM_Question_Group_Question::instance()->delete(
-                array(
-                    array(
-                        'QST_ID' => $phone_question_id,
-                        'QSG_ID' => array('!=', $QSG_ID),
-                    ),
-                )
-            );
-        }
-        /** @type EE_Question_Group $question_group */
-        $question_group = $this->_question_group_model->get_one_by_ID($QSG_ID);
-        $questions = $question_group->questions();
-        // make sure system phone question is added to list of questions for this group
-        if (! isset($questions[ $phone_question_id ])) {
-            $questions[ $phone_question_id ] = EEM_Question::instance()->get_one_by_ID($phone_question_id);
-        }
-
-        foreach ($questions as $question_ID => $question) {
-            // first we always check for order.
-            if (! empty($this->_req_data['question_orders'][ $question_ID ])) {
-                // update question order
-                $question_group->update_question_order(
-                    $question_ID,
-                    $this->_req_data['question_orders'][ $question_ID ]
-                );
-            }
-
-            // then we always check if adding or removing.
-            if (isset($this->_req_data['questions'], $this->_req_data['questions'][ $question_ID ])) {
-                $question_group->add_question($question_ID);
-            } else {
-                // not found, remove it (but only if not a system question for the personal group
-                // with the exception of lname system question - we allow removal of it)
-                if (
-                    in_array(
-                        $question->system_ID(),
-                        EEM_Question::instance()->required_system_questions_in_system_question_group(
-                            $question_group->system_group()
-                        )
-                    )
-                ) {
-                    continue;
-                } else {
-                    $question_group->remove_question($question_ID);
-                }
-            }
-        }
-        // save new related questions
-        if (isset($this->_req_data['questions'])) {
-            foreach ($this->_req_data['questions'] as $QST_ID) {
-                $question_group->add_question($QST_ID);
-                if (isset($this->_req_data['question_orders'][ $QST_ID ])) {
-                    $question_group->update_question_order($QST_ID, $this->_req_data['question_orders'][ $QST_ID ]);
-                }
-            }
-        }
-
-        if ($success !== false) {
-            $msg = $new_question_group
-                ? sprintf(
-                    esc_html__('The %s has been created', 'event_espresso'),
-                    $this->_question_group_model->item_name()
-                )
-                : sprintf(
-                    esc_html__(
-                        'The %s has been updated',
-                        'event_espresso'
-                    ),
-                    $this->_question_group_model->item_name()
-                );
-            EE_Error::add_success($msg);
-        }
-        $this->_redirect_after_action(
-            false,
-            '',
-            '',
-            array('action' => 'edit_question_group', 'QSG_ID' => $QSG_ID),
-            true
-        );
-    }
-
-
-    /**
-     * duplicates a question and all its question options and redirects to the new question.
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function _duplicate_question()
-    {
-        $question_ID = (int) $this->_req_data['QST_ID'];
-        $question = EEM_Question::instance()->get_one_by_ID($question_ID);
-        if ($question instanceof EE_Question) {
-            $new_question = $question->duplicate();
-            if ($new_question instanceof EE_Question) {
-                $this->_redirect_after_action(
-                    true,
-                    esc_html__('Question', 'event_espresso'),
-                    esc_html__('Duplicated', 'event_espresso'),
-                    array('action' => 'edit_question', 'QST_ID' => $new_question->ID()),
-                    true
-                );
-            } else {
-                global $wpdb;
-                EE_Error::add_error(
-                    sprintf(
-                        esc_html__(
-                            'Could not duplicate question with ID %1$d because: %2$s',
-                            'event_espresso'
-                        ),
-                        $question_ID,
-                        $wpdb->last_error
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-                $this->_redirect_after_action(false, '', '', array('action' => 'default'), false);
-            }
-        } else {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'Could not duplicate question with ID %d because it didn\'t exist!',
-                        'event_espresso'
-                    ),
-                    $question_ID
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $this->_redirect_after_action(false, '', '', array('action' => 'default'), false);
-        }
-    }
-
-
-    /**
-     * @param bool $trash
-     * @throws EE_Error
-     */
-    protected function _trash_or_restore_question_groups($trash = true)
-    {
-        $this->_trash_or_restore_items($this->_question_group_model, $trash);
-    }
-
-
-    /**
-     *_trash_question
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    protected function _trash_question()
-    {
-        $success = $this->_question_model->delete_by_ID((int) $this->_req_data['QST_ID']);
-        $query_args = array('action' => 'default', 'status' => 'all');
-        $this->_redirect_after_action($success, $this->_question_model->item_name($success), 'trashed', $query_args);
-    }
-
-
-    /**
-     * @param bool $trash
-     * @throws EE_Error
-     */
-    protected function _trash_or_restore_questions($trash = true)
-    {
-        $this->_trash_or_restore_items($this->_question_model, $trash);
-    }
-
-
-    /**
-     * Internally used to delete or restore items, using the request data. Meant to be
-     * flexible between question or question groups
-     *
-     * @param EEM_Soft_Delete_Base $model
-     * @param boolean              $trash whether to trash or restore
-     * @throws EE_Error
-     */
-    private function _trash_or_restore_items(EEM_Soft_Delete_Base $model, $trash = true)
-    {
-
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-
-        $success = 1;
-        // Checkboxes
-        // echo "trash $trash";
-        // var_dump($this->_req_data['checkbox']);die;
-        if (isset($this->_req_data['checkbox'])) {
-            if (! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
-                // if array has more than one element than success message should be plural
-                $success = count($this->_req_data['checkbox']) > 1 ? 2 : 1;
-                // cycle thru bulk action checkboxes
-                $checkboxes = $this->_req_data['checkbox'];
-                foreach (array_keys($checkboxes) as $ID) {
-                    if (! $model->delete_or_restore_by_ID($trash, absint($ID))) {
-                        $success = 0;
-                    }
-                }
-            } else {
-                // grab single id and delete
-                $ID = absint($this->_req_data['checkbox']);
-                if (! $model->delete_or_restore_by_ID($trash, $ID)) {
-                    $success = 0;
-                }
-            }
-        } else {
-            // delete via trash link
-            // grab single id and delete
-            $ID = absint($this->_req_data[ $model->primary_key_name() ]);
-            if (! $model->delete_or_restore_by_ID($trash, $ID)) {
-                $success = 0;
-            }
-        }
-
-
-        $action = $model instanceof EEM_Question ? 'default' : 'question_groups';// strtolower( $model->item_name(2) );
-        // echo "action :$action";
-        // $action = 'questions' ? 'default' : $action;
-        if ($trash) {
-            $action_desc = 'trashed';
-            $status = 'trash';
-        } else {
-            $action_desc = 'restored';
-            $status = 'all';
-        }
-        $this->_redirect_after_action(
-            $success,
-            $model->item_name($success),
-            $action_desc,
-            array('action' => $action, 'status' => $status)
-        );
-    }
-
-
-    /**
-     * @param            $per_page
-     * @param int        $current_page
-     * @param bool|false $count
-     * @return EE_Soft_Delete_Base_Class[]|int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function get_trashed_questions($per_page, $current_page = 1, $count = false)
-    {
-        $query_params = $this->get_query_params(EEM_Question::instance(), $per_page, $current_page);
-
-        if ($count) {
-            // note: this a subclass of EEM_Soft_Delete_Base, so this is actually only getting non-trashed items
-            $where = isset($query_params[0]) ? array($query_params[0]) : array();
-            $results = $this->_question_model->count_deleted($where);
-        } else {
-            // note: this a subclass of EEM_Soft_Delete_Base, so this is actually only getting non-trashed items
-            $results = $this->_question_model->get_all_deleted($query_params);
-        }
-        return $results;
-    }
-
-
-    /**
-     * @param            $per_page
-     * @param int        $current_page
-     * @param bool|false $count
-     * @return EE_Soft_Delete_Base_Class[]|int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function get_question_groups($per_page, $current_page = 1, $count = false)
-    {
-        $questionGroupModel = EEM_Question_Group::instance();
-        $query_params = $this->get_query_params($questionGroupModel, $per_page, $current_page);
-        if ($count) {
-            $where = isset($query_params[0]) ? array($query_params[0]) : array();
-            $results = $questionGroupModel->count($where);
-        } else {
-            $results = $questionGroupModel->get_all($query_params);
-        }
-        return $results;
-    }
-
-
-    /**
-     * @param      $per_page
-     * @param int  $current_page
-     * @param bool $count
-     * @return EE_Soft_Delete_Base_Class[]|int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function get_trashed_question_groups($per_page, $current_page = 1, $count = false)
-    {
-        $questionGroupModel = EEM_Question_Group::instance();
-        $query_params = $this->get_query_params($questionGroupModel, $per_page, $current_page);
-        if ($count) {
-            $where = isset($query_params[0]) ? array($query_params[0]) : array();
-            $query_params['limit'] = null;
-            $results = $questionGroupModel->count_deleted($where);
-        } else {
-            $results = $questionGroupModel->get_all_deleted($query_params);
-        }
-        return $results;
-    }
-
-
-    /**
-     * method for performing updates to question order
-     *
-     * @return void results array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function update_question_group_order()
-    {
-
-        $success = esc_html__('Question group order was updated successfully.', 'event_espresso');
-
-        // grab our row IDs
-        $row_ids = isset($this->_req_data['row_ids']) && ! empty($this->_req_data['row_ids'])
-            ? explode(',', rtrim($this->_req_data['row_ids'], ','))
-            : array();
-
-        $perpage = ! empty($this->_req_data['perpage'])
-            ? (int) $this->_req_data['perpage']
-            : null;
-        $curpage = ! empty($this->_req_data['curpage'])
-            ? (int) $this->_req_data['curpage']
-            : null;
-
-        if (! empty($row_ids)) {
-            // figure out where we start the row_id count at for the current page.
-            $qsgcount = empty($curpage) ? 0 : ($curpage - 1) * $perpage;
-
-            $row_count = count($row_ids);
-            for ($i = 0; $i < $row_count; $i++) {
-                // Update the questions when re-ordering
-                $updated = EEM_Question_Group::instance()->update(
-                    array('QSG_order' => $qsgcount),
-                    array(array('QSG_ID' => $row_ids[ $i ]))
-                );
-                if ($updated === false) {
-                    $success = false;
-                }
-                $qsgcount++;
-            }
-        } else {
-            $success = false;
-        }
-
-        $errors = ! $success
-            ? esc_html__('An error occurred. The question group order was not updated.', 'event_espresso')
-            : false;
-
-        echo wp_json_encode(array('return_data' => false, 'success' => $success, 'errors' => $errors));
-        die();
-    }
-
-
-
-    /***************************************       REGISTRATION SETTINGS       ***************************************/
-
-
-    /**
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _reg_form_settings()
-    {
-        $this->_template_args['values'] = $this->_yes_no_values;
-        add_action(
-            'AHEE__Extend_Registration_Form_Admin_Page___reg_form_settings_template',
-            array($this, 'email_validation_settings_form'),
-            2
-        );
-        add_action(
-            'AHEE__Extend_Registration_Form_Admin_Page___reg_form_settings_template',
-            array($this, 'copy_attendee_info_settings_form'),
-            4
-        );
-        $this->_template_args = (array) apply_filters(
-            'FHEE__Extend_Registration_Form_Admin_Page___reg_form_settings___template_args',
-            $this->_template_args
-        );
-        $this->_set_add_edit_form_tags('update_reg_form_settings');
-        $this->_set_publish_post_box_vars(null, false, false, null, false);
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            REGISTRATION_FORM_CAF_TEMPLATE_PATH . 'reg_form_settings.template.php',
-            $this->_template_args,
-            true
-        );
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _update_reg_form_settings()
-    {
-        EE_Registry::instance()->CFG->registration = $this->update_email_validation_settings_form(
-            EE_Registry::instance()->CFG->registration
-        );
-        EE_Registry::instance()->CFG->registration = $this->update_copy_attendee_info_settings_form(
-            EE_Registry::instance()->CFG->registration
-        );
-        EE_Registry::instance()->CFG->registration = apply_filters(
-            'FHEE__Extend_Registration_Form_Admin_Page___update_reg_form_settings__CFG_registration',
-            EE_Registry::instance()->CFG->registration
-        );
-        $success = $this->_update_espresso_configuration(
-            esc_html__('Registration Form Options', 'event_espresso'),
-            EE_Registry::instance()->CFG,
-            __FILE__,
-            __FUNCTION__,
-            __LINE__
-        );
-        $this->_redirect_after_action(
-            $success,
-            esc_html__('Registration Form Options', 'event_espresso'),
-            'updated',
-            array('action' => 'view_reg_form_settings')
-        );
-    }
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function copy_attendee_info_settings_form()
-    {
-        echo wp_kses($this->_copy_attendee_info_settings_form()->get_html(), AllowedTags::getWithFormTags());
-    }
-
-    /**
-     * _copy_attendee_info_settings_form
-     *
-     * @access protected
-     * @return EE_Form_Section_Proper
-     * @throws \EE_Error
-     */
-    protected function _copy_attendee_info_settings_form()
-    {
-        return new EE_Form_Section_Proper(
-            array(
-                'name'            => 'copy_attendee_info_settings',
-                'html_id'         => 'copy_attendee_info_settings',
-                'layout_strategy' => new EE_Admin_Two_Column_Layout(),
-                'subsections'     => apply_filters(
-                    'FHEE__Extend_Registration_Form_Admin_Page___copy_attendee_info_settings_form__form_subsections',
-                    array(
-                        'copy_attendee_info_hdr'   => new EE_Form_Section_HTML(
-                            EEH_HTML::h2(esc_html__('Copy Attendee Info Settings', 'event_espresso'))
-                        ),
-                        'copy_attendee_info' => new EE_Yes_No_Input(
-                            array(
-                                'html_label_text' => esc_html__(
-                                    'Allow copy #1 attendee info to extra attendees?',
-                                    'event_espresso'
-                                ),
-                                'html_help_text'  => esc_html__(
-                                    'Set to yes if you want to enable the copy of #1 attendee info to extra attendees at Registration Form.',
-                                    'event_espresso'
-                                ),
-                                'default'         => EE_Registry::instance()->CFG->registration->copyAttendeeInfo(),
-                                'required'        => false,
-                                'display_html_label_text' => false,
-                            )
-                        ),
-                    )
-                ),
-            )
-        );
-    }
-
-    /**
-     * @param EE_Registration_Config $EE_Registration_Config
-     * @return EE_Registration_Config
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function update_copy_attendee_info_settings_form(EE_Registration_Config $EE_Registration_Config)
-    {
-        $prev_copy_attendee_info = $EE_Registration_Config->copyAttendeeInfo();
-        try {
-            $copy_attendee_info_settings_form = $this->_copy_attendee_info_settings_form();
-            // if not displaying a form, then check for form submission
-            if ($copy_attendee_info_settings_form->was_submitted()) {
-                // capture form data
-                $copy_attendee_info_settings_form->receive_form_submission();
-                // validate form data
-                if ($copy_attendee_info_settings_form->is_valid()) {
-                    // grab validated data from form
-                    $valid_data = $copy_attendee_info_settings_form->valid_data();
-                    if (isset($valid_data['copy_attendee_info'])) {
-                        $EE_Registration_Config->setCopyAttendeeInfo($valid_data['copy_attendee_info']);
-                    } else {
-                        EE_Error::add_error(
-                            esc_html__(
-                                'Invalid or missing Copy Attendee Info settings. Please refresh the form and try again.',
-                                'event_espresso'
-                            ),
-                            __FILE__,
-                            __FUNCTION__,
-                            __LINE__
-                        );
-                    }
-                } else {
-                    if ($copy_attendee_info_settings_form->submission_error_message() !== '') {
-                        EE_Error::add_error(
-                            $copy_attendee_info_settings_form->submission_error_message(),
-                            __FILE__,
-                            __FUNCTION__,
-                            __LINE__
-                        );
-                    }
-                }
-            }
-        } catch (EE_Error $e) {
-            $e->get_error();
-        }
-        return $EE_Registration_Config;
-    }
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function email_validation_settings_form()
-    {
-        echo wp_kses($this->_email_validation_settings_form()->get_html(), AllowedTags::getWithFormTags());
-    }
-
-
-    /**
-     * _email_validation_settings_form
-     *
-     * @access protected
-     * @return EE_Form_Section_Proper
-     * @throws \EE_Error
-     */
-    protected function _email_validation_settings_form()
-    {
-        return new EE_Form_Section_Proper(
-            array(
-                'name'            => 'email_validation_settings',
-                'html_id'         => 'email_validation_settings',
-                'layout_strategy' => new EE_Admin_Two_Column_Layout(),
-                'subsections'     => apply_filters(
-                    'FHEE__Extend_Registration_Form_Admin_Page___email_validation_settings_form__form_subsections',
-                    array(
-                        'email_validation_hdr'   => new EE_Form_Section_HTML(
-                            EEH_HTML::h2(esc_html__('Email Validation Settings', 'event_espresso'))
-                        ),
-                        'email_validation_level' => new EE_Select_Input(
-                            array(
-                                'basic'      => esc_html__('Basic', 'event_espresso'),
-                                'wp_default' => esc_html__('WordPress Default', 'event_espresso'),
-                                'i18n'       => esc_html__('International', 'event_espresso'),
-                                'i18n_dns'   => esc_html__('International + DNS Check', 'event_espresso'),
-                            ),
-                            array(
-                                'html_label_text' => esc_html__('Email Validation Level', 'event_espresso')
-                                                     . EEH_Template::get_help_tab_link('email_validation_info'),
-                                'html_help_text'  => esc_html__(
-                                    'These levels range from basic validation ( ie: text@text.text ) to more advanced checks against international email addresses (ie: üñîçøðé@example.com ) with additional MX and A record checks to confirm the domain actually exists. More information on on each level can be found within the help section.',
-                                    'event_espresso'
-                                ),
-                                'default'         => isset(
-                                    EE_Registry::instance()->CFG->registration->email_validation_level
-                                )
-                                    ? EE_Registry::instance()->CFG->registration->email_validation_level
-                                    : 'wp_default',
-                                'required'        => false,
-                            )
-                        ),
-                    )
-                ),
-            )
-        );
-    }
-
-
-    /**
-     * @param EE_Registration_Config $EE_Registration_Config
-     * @return EE_Registration_Config
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function update_email_validation_settings_form(EE_Registration_Config $EE_Registration_Config)
-    {
-        $prev_email_validation_level = $EE_Registration_Config->email_validation_level;
-        try {
-            $email_validation_settings_form = $this->_email_validation_settings_form();
-            // if not displaying a form, then check for form submission
-            if ($email_validation_settings_form->was_submitted()) {
-                // capture form data
-                $email_validation_settings_form->receive_form_submission();
-                // validate form data
-                if ($email_validation_settings_form->is_valid()) {
-                    // grab validated data from form
-                    $valid_data = $email_validation_settings_form->valid_data();
-                    if (isset($valid_data['email_validation_level'])) {
-                        $email_validation_level = $valid_data['email_validation_level'];
-                        // now if they want to use international email addresses
-                        if ($email_validation_level === 'i18n' || $email_validation_level === 'i18n_dns') {
-                            // in case we need to reset their email validation level,
-                            // make sure that the previous value wasn't already set to one of the i18n options.
-                            if ($prev_email_validation_level === 'i18n' || $prev_email_validation_level === 'i18n_dns') {
-                                // if so, then reset it back to "basic" since that is the only other option that,
-                                // despite offering poor validation, supports i18n email addresses
-                                $prev_email_validation_level = 'basic';
-                            }
-                            // confirm our i18n email validation will work on the server
-                            if (! $this->_verify_pcre_support($EE_Registration_Config, $email_validation_level)) {
-                                // or reset email validation level to previous value
-                                $email_validation_level = $prev_email_validation_level;
-                            }
-                        }
-                        $EE_Registration_Config->email_validation_level = $email_validation_level;
-                    } else {
-                        EE_Error::add_error(
-                            esc_html__(
-                                'Invalid or missing Email Validation settings. Please refresh the form and try again.',
-                                'event_espresso'
-                            ),
-                            __FILE__,
-                            __FUNCTION__,
-                            __LINE__
-                        );
-                    }
-                } else {
-                    if ($email_validation_settings_form->submission_error_message() !== '') {
-                        EE_Error::add_error(
-                            $email_validation_settings_form->submission_error_message(),
-                            __FILE__,
-                            __FUNCTION__,
-                            __LINE__
-                        );
-                    }
-                }
-            }
-        } catch (EE_Error $e) {
-            $e->get_error();
-        }
-        return $EE_Registration_Config;
-    }
-
-
-    /**
-     * confirms that the server's PHP version has the PCRE module enabled,
-     * and that the PCRE version works with our i18n email validation
-     *
-     * @param EE_Registration_Config $EE_Registration_Config
-     * @param string                 $email_validation_level
-     * @return bool
-     */
-    private function _verify_pcre_support(EE_Registration_Config $EE_Registration_Config, $email_validation_level)
-    {
-        // first check that PCRE is enabled
-        if (! defined('PREG_BAD_UTF8_ERROR')) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'We\'re sorry, but it appears that your server\'s version of PHP was not compiled with PCRE unicode support.%1$sPlease contact your hosting company and ask them whether the PCRE compiled with your version of PHP on your server can be been built with the "--enable-unicode-properties" and "--enable-utf8" configuration switches to enable more complex regex expressions.%1$sIf they are unable, or unwilling to do so, then your server will not support international email addresses using UTF-8 unicode characters. This means you will either have to lower your email validation level to "Basic" or "WordPress Default", or switch to a hosting company that has/can enable PCRE unicode support on the server.',
-                        'event_espresso'
-                    ),
-                    '<br />'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        } else {
-            // PCRE support is enabled, but let's still
-            // perform a test to see if the server will support it.
-            // but first, save the updated validation level to the config,
-            // so that the validation strategy picks it up.
-            // this will get bumped back down if it doesn't work
-            $EE_Registration_Config->email_validation_level = $email_validation_level;
-            try {
-                $email_validator = new EE_Email_Validation_Strategy();
-                $i18n_email_address = apply_filters(
-                    'FHEE__Extend_Registration_Form_Admin_Page__update_email_validation_settings_form__i18n_email_address',
-                    'jägerjürgen@deutschland.com'
-                );
-                $email_validator->validate($i18n_email_address);
-            } catch (Exception $e) {
-                EE_Error::add_error(
-                    sprintf(
-                        esc_html__(
-                            'We\'re sorry, but it appears that your server\'s configuration will not support the "International" or "International + DNS Check" email validation levels.%1$sTo correct this issue, please consult with your hosting company regarding your server\'s PCRE settings.%1$sIt is recommended that your PHP version be configured to use PCRE 8.10 or newer.%1$sMore information regarding PCRE versions and installation can be found here: %2$s',
-                            'event_espresso'
-                        ),
-                        '<br />',
-                        '<a href="http://php.net/manual/en/pcre.installation.php" target="_blank" rel="noopener noreferrer">http://php.net/manual/en/pcre.installation.php</a>'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-                return false;
-            }
-        }
-        return true;
-    }
+	/**
+	 * @param bool $routing indicate whether we want to just load the object and handle routing or just load the object.
+	 */
+	public function __construct($routing = true)
+	{
+		define('REGISTRATION_FORM_CAF_ADMIN', EE_CORE_CAF_ADMIN_EXTEND . 'registration_form/');
+		define('REGISTRATION_FORM_CAF_ASSETS_PATH', REGISTRATION_FORM_CAF_ADMIN . 'assets/');
+		define('REGISTRATION_FORM_CAF_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL . 'registration_form/assets/');
+		define('REGISTRATION_FORM_CAF_TEMPLATE_PATH', REGISTRATION_FORM_CAF_ADMIN . 'templates/');
+		define('REGISTRATION_FORM_CAF_TEMPLATE_URL', EE_CORE_CAF_ADMIN_EXTEND_URL . 'registration_form/templates/');
+		parent::__construct($routing);
+	}
+
+
+	/**
+	 * @return void
+	 */
+	protected function _extend_page_config()
+	{
+		$this->_admin_base_path = REGISTRATION_FORM_CAF_ADMIN;
+		$qst_id = ! empty($this->_req_data['QST_ID']) && ! is_array($this->_req_data['QST_ID'])
+			? $this->_req_data['QST_ID'] : 0;
+		$qsg_id = ! empty($this->_req_data['QSG_ID']) && ! is_array($this->_req_data['QSG_ID'])
+			? $this->_req_data['QSG_ID'] : 0;
+
+		$new_page_routes = array(
+			'question_groups'    => array(
+				'func'       => '_question_groups_overview_list_table',
+				'capability' => 'ee_read_question_groups',
+			),
+			'add_question'       => array(
+				'func'       => '_edit_question',
+				'capability' => 'ee_edit_questions',
+			),
+			'insert_question'    => array(
+				'func'       => '_insert_or_update_question',
+				'args'       => array('new_question' => true),
+				'capability' => 'ee_edit_questions',
+				'noheader'   => true,
+			),
+			'duplicate_question' => array(
+				'func'       => '_duplicate_question',
+				'capability' => 'ee_edit_questions',
+				'noheader'   => true,
+			),
+			'trash_question'     => array(
+				'func'       => '_trash_question',
+				'capability' => 'ee_delete_question',
+				'obj_id'     => $qst_id,
+				'noheader'   => true,
+			),
+
+			'restore_question' => array(
+				'func'       => '_trash_or_restore_questions',
+				'capability' => 'ee_delete_question',
+				'obj_id'     => $qst_id,
+				'args'       => array('trash' => false),
+				'noheader'   => true,
+			),
+
+			'delete_question' => array(
+				'func'       => '_delete_question',
+				'capability' => 'ee_delete_question',
+				'obj_id'     => $qst_id,
+				'noheader'   => true,
+			),
+
+			'trash_questions' => array(
+				'func'       => '_trash_or_restore_questions',
+				'capability' => 'ee_delete_questions',
+				'args'       => array('trash' => true),
+				'noheader'   => true,
+			),
+
+			'restore_questions' => array(
+				'func'       => '_trash_or_restore_questions',
+				'capability' => 'ee_delete_questions',
+				'args'       => array('trash' => false),
+				'noheader'   => true,
+			),
+
+			'delete_questions' => array(
+				'func'       => '_delete_questions',
+				'args'       => array(),
+				'capability' => 'ee_delete_questions',
+				'noheader'   => true,
+			),
+
+			'add_question_group' => array(
+				'func'       => '_edit_question_group',
+				'capability' => 'ee_edit_question_groups',
+			),
+
+			'edit_question_group' => array(
+				'func'       => '_edit_question_group',
+				'capability' => 'ee_edit_question_group',
+				'obj_id'     => $qsg_id,
+				'args'       => array('edit'),
+			),
+
+			'delete_question_groups' => array(
+				'func'       => '_delete_question_groups',
+				'capability' => 'ee_delete_question_groups',
+				'noheader'   => true,
+			),
+
+			'delete_question_group' => array(
+				'func'       => '_delete_question_groups',
+				'capability' => 'ee_delete_question_group',
+				'obj_id'     => $qsg_id,
+				'noheader'   => true,
+			),
+
+			'trash_question_group' => array(
+				'func'       => '_trash_or_restore_question_groups',
+				'args'       => array('trash' => true),
+				'capability' => 'ee_delete_question_group',
+				'obj_id'     => $qsg_id,
+				'noheader'   => true,
+			),
+
+			'restore_question_group' => array(
+				'func'       => '_trash_or_restore_question_groups',
+				'args'       => array('trash' => false),
+				'capability' => 'ee_delete_question_group',
+				'obj_id'     => $qsg_id,
+				'noheader'   => true,
+			),
+
+			'insert_question_group' => array(
+				'func'       => '_insert_or_update_question_group',
+				'args'       => array('new_question_group' => true),
+				'capability' => 'ee_edit_question_groups',
+				'noheader'   => true,
+			),
+
+			'update_question_group' => array(
+				'func'       => '_insert_or_update_question_group',
+				'args'       => array('new_question_group' => false),
+				'capability' => 'ee_edit_question_group',
+				'obj_id'     => $qsg_id,
+				'noheader'   => true,
+			),
+
+			'trash_question_groups' => array(
+				'func'       => '_trash_or_restore_question_groups',
+				'args'       => array('trash' => true),
+				'capability' => 'ee_delete_question_groups',
+				'noheader'   => array('trash' => false),
+			),
+
+			'restore_question_groups' => array(
+				'func'       => '_trash_or_restore_question_groups',
+				'args'       => array('trash' => false),
+				'capability' => 'ee_delete_question_groups',
+				'noheader'   => true,
+			),
+
+
+			'espresso_update_question_group_order' => array(
+				'func'       => 'update_question_group_order',
+				'capability' => 'ee_edit_question_groups',
+				'noheader'   => true,
+			),
+
+			'view_reg_form_settings' => array(
+				'func'       => '_reg_form_settings',
+				'capability' => 'manage_options',
+			),
+
+			'update_reg_form_settings' => array(
+				'func'       => '_update_reg_form_settings',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+			),
+		);
+		$this->_page_routes = array_merge($this->_page_routes, $new_page_routes);
+
+		$new_page_config = array(
+
+			'question_groups' => array(
+				'nav'           => array(
+					'label' => esc_html__('Question Groups', 'event_espresso'),
+					'order' => 20,
+				),
+				'list_table'    => 'Registration_Form_Question_Groups_Admin_List_Table',
+				'help_tabs'     => array(
+					'registration_form_question_groups_help_tab'                           => array(
+						'title'    => esc_html__('Question Groups', 'event_espresso'),
+						'filename' => 'registration_form_question_groups',
+					),
+					'registration_form_question_groups_table_column_headings_help_tab'     => array(
+						'title'    => esc_html__('Question Groups Table Column Headings', 'event_espresso'),
+						'filename' => 'registration_form_question_groups_table_column_headings',
+					),
+					'registration_form_question_groups_views_bulk_actions_search_help_tab' => array(
+						'title'    => esc_html__('Question Groups Views & Bulk Actions & Search', 'event_espresso'),
+						'filename' => 'registration_form_question_groups_views_bulk_actions_search',
+					),
+				),
+				'metaboxes'     => $this->_default_espresso_metaboxes,
+				'require_nonce' => false,
+				'qtips'         => array(
+					'EE_Registration_Form_Tips',
+				),
+			),
+
+			'add_question' => array(
+				'nav'           => array(
+					'label'      => esc_html__('Add Question', 'event_espresso'),
+					'order'      => 5,
+					'persistent' => false,
+				),
+				'metaboxes'     => array_merge($this->_default_espresso_metaboxes, array('_publish_post_box')),
+				'help_tabs'     => array(
+					'registration_form_add_question_help_tab' => array(
+						'title'    => esc_html__('Add Question', 'event_espresso'),
+						'filename' => 'registration_form_add_question',
+					),
+				),
+				'require_nonce' => false,
+			),
+
+			'add_question_group' => array(
+				'nav'           => array(
+					'label'      => esc_html__('Add Question Group', 'event_espresso'),
+					'order'      => 5,
+					'persistent' => false,
+				),
+				'metaboxes'     => array_merge($this->_default_espresso_metaboxes, array('_publish_post_box')),
+				'help_tabs'     => array(
+					'registration_form_add_question_group_help_tab' => array(
+						'title'    => esc_html__('Add Question Group', 'event_espresso'),
+						'filename' => 'registration_form_add_question_group',
+					),
+				),
+				'require_nonce' => false,
+			),
+
+			'edit_question_group' => array(
+				'nav'           => array(
+					'label'      => esc_html__('Edit Question Group', 'event_espresso'),
+					'order'      => 5,
+					'persistent' => false,
+					'url'        => isset($this->_req_data['question_group_id']) ? add_query_arg(
+						array('question_group_id' => $this->_req_data['question_group_id']),
+						$this->_current_page_view_url
+					) : $this->_admin_base_url,
+				),
+				'metaboxes'     => array_merge($this->_default_espresso_metaboxes, array('_publish_post_box')),
+				'help_tabs'     => array(
+					'registration_form_edit_question_group_help_tab' => array(
+						'title'    => esc_html__('Edit Question Group', 'event_espresso'),
+						'filename' => 'registration_form_edit_question_group',
+					),
+				),
+				'require_nonce' => false,
+			),
+
+			'view_reg_form_settings' => array(
+				'nav'           => array(
+					'label' => esc_html__('Reg Form Settings', 'event_espresso'),
+					'order' => 40,
+				),
+				'labels'        => array(
+					'publishbox' => esc_html__('Update Settings', 'event_espresso'),
+				),
+				'metaboxes'     => array_merge($this->_default_espresso_metaboxes, array('_publish_post_box')),
+				'help_tabs'     => array(
+					'registration_form_reg_form_settings_help_tab' => array(
+						'title'    => esc_html__('Registration Form Settings', 'event_espresso'),
+						'filename' => 'registration_form_reg_form_settings',
+					),
+				),
+				'require_nonce' => false,
+			),
+
+		);
+		$this->_page_config = array_merge($this->_page_config, $new_page_config);
+
+		// change the list table we're going to use so it's the NEW list table!
+		$this->_page_config['default']['list_table'] = 'Extend_Registration_Form_Questions_Admin_List_Table';
+
+
+		// additional labels
+		$new_labels = array(
+			'add_question'          => esc_html__('Add New Question', 'event_espresso'),
+			'delete_question'       => esc_html__('Delete Question', 'event_espresso'),
+			'add_question_group'    => esc_html__('Add New Question Group', 'event_espresso'),
+			'edit_question_group'   => esc_html__('Edit Question Group', 'event_espresso'),
+			'delete_question_group' => esc_html__('Delete Question Group', 'event_espresso'),
+		);
+		$this->_labels['buttons'] = array_merge($this->_labels['buttons'], $new_labels);
+	}
+
+
+	/**
+	 * @return void
+	 */
+	protected function _ajax_hooks()
+	{
+		add_action('wp_ajax_espresso_update_question_group_order', array($this, 'update_question_group_order'));
+	}
+
+
+	/**
+	 * @return void
+	 */
+	public function load_scripts_styles_question_groups()
+	{
+		wp_enqueue_script('espresso_ajax_table_sorting');
+	}
+
+
+	/**
+	 * @return void
+	 */
+	public function load_scripts_styles_add_question_group()
+	{
+		$this->load_scripts_styles_forms();
+		$this->load_sortable_question_script();
+	}
+
+
+	/**
+	 * @return void
+	 */
+	public function load_scripts_styles_edit_question_group()
+	{
+		$this->load_scripts_styles_forms();
+		$this->load_sortable_question_script();
+	}
+
+
+	/**
+	 * registers and enqueues script for questions
+	 *
+	 * @return void
+	 */
+	public function load_sortable_question_script()
+	{
+		wp_register_script(
+			'ee-question-sortable',
+			REGISTRATION_FORM_CAF_ASSETS_URL . 'ee_question_order.js',
+			array('jquery-ui-sortable'),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_enqueue_script('ee-question-sortable');
+	}
+
+
+	/**
+	 * @return void
+	 */
+	protected function _set_list_table_views_default()
+	{
+		$this->_views = array(
+			'all' => array(
+				'slug'        => 'all',
+				'label'       => esc_html__('View All Questions', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => array(
+					'trash_questions' => esc_html__('Trash', 'event_espresso'),
+				),
+			),
+		);
+
+		if (
+			EE_Registry::instance()->CAP->current_user_can(
+				'ee_delete_questions',
+				'espresso_registration_form_trash_questions'
+			)
+		) {
+			$this->_views['trash'] = array(
+				'slug'        => 'trash',
+				'label'       => esc_html__('Trash', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => array(
+					'delete_questions'  => esc_html__('Delete Permanently', 'event_espresso'),
+					'restore_questions' => esc_html__('Restore', 'event_espresso'),
+				),
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	protected function _set_list_table_views_question_groups()
+	{
+		$this->_views = array(
+			'all' => array(
+				'slug'        => 'all',
+				'label'       => esc_html__('All', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => array(
+					'trash_question_groups' => esc_html__('Trash', 'event_espresso'),
+				),
+			),
+		);
+
+		if (
+			EE_Registry::instance()->CAP->current_user_can(
+				'ee_delete_question_groups',
+				'espresso_registration_form_trash_question_groups'
+			)
+		) {
+			$this->_views['trash'] = array(
+				'slug'        => 'trash',
+				'label'       => esc_html__('Trash', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => array(
+					'delete_question_groups'  => esc_html__('Delete Permanently', 'event_espresso'),
+					'restore_question_groups' => esc_html__('Restore', 'event_espresso'),
+				),
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _questions_overview_list_table()
+	{
+		$this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
+			'add_question',
+			'add_question',
+			array(),
+			'add-new-h2'
+		);
+		parent::_questions_overview_list_table();
+	}
+
+
+	/**
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _question_groups_overview_list_table()
+	{
+		$this->_search_btn_label = esc_html__('Question Groups', 'event_espresso');
+		$this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
+			'add_question_group',
+			'add_question_group',
+			array(),
+			'add-new-h2'
+		);
+		$this->display_admin_list_table_page_with_sidebar();
+	}
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _delete_question()
+	{
+		$success = $this->_delete_items($this->_question_model);
+		$this->_redirect_after_action(
+			$success,
+			$this->_question_model->item_name($success),
+			'deleted',
+			array('action' => 'default', 'status' => 'all')
+		);
+	}
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _delete_questions()
+	{
+		$success = $this->_delete_items($this->_question_model);
+		$this->_redirect_after_action(
+			$success,
+			$this->_question_model->item_name($success),
+			'deleted permanently',
+			array('action' => 'default', 'status' => 'trash')
+		);
+	}
+
+
+	/**
+	 * Performs the deletion of a single or multiple questions or question groups.
+	 *
+	 * @param EEM_Soft_Delete_Base $model
+	 * @return int number of items deleted permanently
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _delete_items(EEM_Soft_Delete_Base $model)
+	{
+		$success = 0;
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		if (! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
+			// if array has more than one element than success message should be plural
+			$success = count($this->_req_data['checkbox']) > 1 ? 2 : 1;
+			// cycle thru bulk action checkboxes
+			$checkboxes = $this->_req_data['checkbox'];
+			foreach (array_keys($checkboxes) as $ID) {
+				if (! $this->_delete_item($ID, $model)) {
+					$success = 0;
+				}
+			}
+		} elseif (! empty($this->_req_data['QSG_ID'])) {
+			$success = $this->_delete_item($this->_req_data['QSG_ID'], $model);
+		} elseif (! empty($this->_req_data['QST_ID'])) {
+			$success = $this->_delete_item($this->_req_data['QST_ID'], $model);
+		} else {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						"No Questions or Question Groups were selected for deleting. This error usually shows when you've attempted to delete via bulk action but there were no selections.",
+						"event_espresso"
+					)
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		return $success;
+	}
+
+
+	/**
+	 * Deletes the specified question (and its associated question options) or question group
+	 *
+	 * @param int                  $id
+	 * @param EEM_Soft_Delete_Base $model
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _delete_item($id, $model)
+	{
+		if ($model instanceof EEM_Question) {
+			EEM_Question_Option::instance()->delete_permanently(array(array('QST_ID' => absint($id))));
+		}
+		return $model->delete_permanently_by_ID(absint($id));
+	}
+
+
+	/******************************    QUESTION GROUPS    ******************************/
+
+
+	/**
+	 * @param string $type
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _edit_question_group($type = 'add')
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$ID = isset($this->_req_data['QSG_ID']) && ! empty($this->_req_data['QSG_ID'])
+			? absint($this->_req_data['QSG_ID'])
+			: false;
+
+		switch ($this->_req_action) {
+			case 'add_question_group':
+				$this->_admin_page_title = esc_html__('Add Question Group', 'event_espresso');
+				break;
+			case 'edit_question_group':
+				$this->_admin_page_title = esc_html__('Edit Question Group', 'event_espresso');
+				break;
+			default:
+				$this->_admin_page_title = ucwords(str_replace('_', ' ', $this->_req_action));
+		}
+		// add ID to title if editing
+		$this->_admin_page_title = $ID ? $this->_admin_page_title . ' # ' . $ID : $this->_admin_page_title;
+		if ($ID) {
+			/** @var EE_Question_Group $questionGroup */
+			$questionGroup = $this->_question_group_model->get_one_by_ID($ID);
+			$additional_hidden_fields = array('QSG_ID' => array('type' => 'hidden', 'value' => $ID));
+			$this->_set_add_edit_form_tags('update_question_group', $additional_hidden_fields);
+		} else {
+			/** @var EE_Question_Group $questionGroup */
+			$questionGroup = EEM_Question_Group::instance()->create_default_object();
+			$questionGroup->set_order_to_latest();
+			$this->_set_add_edit_form_tags('insert_question_group');
+		}
+		$this->_template_args['values'] = $this->_yes_no_values;
+		$this->_template_args['all_questions'] = $questionGroup->questions_in_and_not_in_group();
+		$this->_template_args['QSG_ID'] = $ID ? $ID : true;
+		$this->_template_args['question_group'] = $questionGroup;
+
+		$redirect_URL = add_query_arg(array('action' => 'question_groups'), $this->_admin_base_url);
+		$this->_set_publish_post_box_vars('id', $ID, false, $redirect_URL);
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(
+			REGISTRATION_FORM_CAF_TEMPLATE_PATH . 'question_groups_main_meta_box.template.php',
+			$this->_template_args,
+			true
+		);
+
+		// the details template wrapper
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _delete_question_groups()
+	{
+		$success = $this->_delete_items($this->_question_group_model);
+		$this->_redirect_after_action(
+			$success,
+			$this->_question_group_model->item_name($success),
+			'deleted permanently',
+			array('action' => 'question_groups', 'status' => 'trash')
+		);
+	}
+
+
+	/**
+	 * @param bool $new_question_group
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _insert_or_update_question_group($new_question_group = true)
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$set_column_values = $this->_set_column_values_for($this->_question_group_model);
+
+		// make sure identifier is unique
+		$identifier_value = isset($set_column_values['QSG_identifier']) ? $set_column_values['QSG_identifier'] : '';
+		$where_values = ['QSG_identifier' => $set_column_values['QSG_identifier']];
+		if (! $new_question_group && isset($set_column_values['QSG_ID'])) {
+			$where_values['QSG_ID'] = ['!=', $set_column_values['QSG_ID']];
+		}
+		$identifier_exists = ! empty($identifier_value)
+			? $this->_question_group_model->count([$where_values]) > 0
+			: false;
+		if ($identifier_exists) {
+			$set_column_values['QSG_identifier'] .= uniqid('id', true);
+		}
+
+		if ($new_question_group) {
+			$QSG_ID = $this->_question_group_model->insert($set_column_values);
+			$success = $QSG_ID ? 1 : 0;
+			if ($success === 0) {
+				EE_Error::add_error(
+					esc_html__('Something went wrong saving the question group.', 'event_espresso'),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+				$this->_redirect_after_action(
+					false,
+					'',
+					'',
+					array('action' => 'edit_question_group', 'QSG_ID' => $QSG_ID),
+					true
+				);
+			}
+		} else {
+			$QSG_ID = absint($this->_req_data['QSG_ID']);
+			unset($set_column_values['QSG_ID']);
+			$success = $this->_question_group_model->update($set_column_values, array(array('QSG_ID' => $QSG_ID)));
+		}
+
+		$phone_question_id = EEM_Question::instance()->get_Question_ID_from_system_string(
+			EEM_Attendee::system_question_phone
+		);
+		// update the existing related questions
+		// BUT FIRST...  delete the phone question from the Question_Group_Question
+		// if it is being added to this question group (therefore removed from the existing group)
+		if (isset($this->_req_data['questions'], $this->_req_data['questions'][ $phone_question_id ])) {
+			// delete where QST ID = system phone question ID and Question Group ID is NOT this group
+			EEM_Question_Group_Question::instance()->delete(
+				array(
+					array(
+						'QST_ID' => $phone_question_id,
+						'QSG_ID' => array('!=', $QSG_ID),
+					),
+				)
+			);
+		}
+		/** @type EE_Question_Group $question_group */
+		$question_group = $this->_question_group_model->get_one_by_ID($QSG_ID);
+		$questions = $question_group->questions();
+		// make sure system phone question is added to list of questions for this group
+		if (! isset($questions[ $phone_question_id ])) {
+			$questions[ $phone_question_id ] = EEM_Question::instance()->get_one_by_ID($phone_question_id);
+		}
+
+		foreach ($questions as $question_ID => $question) {
+			// first we always check for order.
+			if (! empty($this->_req_data['question_orders'][ $question_ID ])) {
+				// update question order
+				$question_group->update_question_order(
+					$question_ID,
+					$this->_req_data['question_orders'][ $question_ID ]
+				);
+			}
+
+			// then we always check if adding or removing.
+			if (isset($this->_req_data['questions'], $this->_req_data['questions'][ $question_ID ])) {
+				$question_group->add_question($question_ID);
+			} else {
+				// not found, remove it (but only if not a system question for the personal group
+				// with the exception of lname system question - we allow removal of it)
+				if (
+					in_array(
+						$question->system_ID(),
+						EEM_Question::instance()->required_system_questions_in_system_question_group(
+							$question_group->system_group()
+						)
+					)
+				) {
+					continue;
+				} else {
+					$question_group->remove_question($question_ID);
+				}
+			}
+		}
+		// save new related questions
+		if (isset($this->_req_data['questions'])) {
+			foreach ($this->_req_data['questions'] as $QST_ID) {
+				$question_group->add_question($QST_ID);
+				if (isset($this->_req_data['question_orders'][ $QST_ID ])) {
+					$question_group->update_question_order($QST_ID, $this->_req_data['question_orders'][ $QST_ID ]);
+				}
+			}
+		}
+
+		if ($success !== false) {
+			$msg = $new_question_group
+				? sprintf(
+					esc_html__('The %s has been created', 'event_espresso'),
+					$this->_question_group_model->item_name()
+				)
+				: sprintf(
+					esc_html__(
+						'The %s has been updated',
+						'event_espresso'
+					),
+					$this->_question_group_model->item_name()
+				);
+			EE_Error::add_success($msg);
+		}
+		$this->_redirect_after_action(
+			false,
+			'',
+			'',
+			array('action' => 'edit_question_group', 'QSG_ID' => $QSG_ID),
+			true
+		);
+	}
+
+
+	/**
+	 * duplicates a question and all its question options and redirects to the new question.
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function _duplicate_question()
+	{
+		$question_ID = (int) $this->_req_data['QST_ID'];
+		$question = EEM_Question::instance()->get_one_by_ID($question_ID);
+		if ($question instanceof EE_Question) {
+			$new_question = $question->duplicate();
+			if ($new_question instanceof EE_Question) {
+				$this->_redirect_after_action(
+					true,
+					esc_html__('Question', 'event_espresso'),
+					esc_html__('Duplicated', 'event_espresso'),
+					array('action' => 'edit_question', 'QST_ID' => $new_question->ID()),
+					true
+				);
+			} else {
+				global $wpdb;
+				EE_Error::add_error(
+					sprintf(
+						esc_html__(
+							'Could not duplicate question with ID %1$d because: %2$s',
+							'event_espresso'
+						),
+						$question_ID,
+						$wpdb->last_error
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+				$this->_redirect_after_action(false, '', '', array('action' => 'default'), false);
+			}
+		} else {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'Could not duplicate question with ID %d because it didn\'t exist!',
+						'event_espresso'
+					),
+					$question_ID
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$this->_redirect_after_action(false, '', '', array('action' => 'default'), false);
+		}
+	}
+
+
+	/**
+	 * @param bool $trash
+	 * @throws EE_Error
+	 */
+	protected function _trash_or_restore_question_groups($trash = true)
+	{
+		$this->_trash_or_restore_items($this->_question_group_model, $trash);
+	}
+
+
+	/**
+	 *_trash_question
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	protected function _trash_question()
+	{
+		$success = $this->_question_model->delete_by_ID((int) $this->_req_data['QST_ID']);
+		$query_args = array('action' => 'default', 'status' => 'all');
+		$this->_redirect_after_action($success, $this->_question_model->item_name($success), 'trashed', $query_args);
+	}
+
+
+	/**
+	 * @param bool $trash
+	 * @throws EE_Error
+	 */
+	protected function _trash_or_restore_questions($trash = true)
+	{
+		$this->_trash_or_restore_items($this->_question_model, $trash);
+	}
+
+
+	/**
+	 * Internally used to delete or restore items, using the request data. Meant to be
+	 * flexible between question or question groups
+	 *
+	 * @param EEM_Soft_Delete_Base $model
+	 * @param boolean              $trash whether to trash or restore
+	 * @throws EE_Error
+	 */
+	private function _trash_or_restore_items(EEM_Soft_Delete_Base $model, $trash = true)
+	{
+
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+
+		$success = 1;
+		// Checkboxes
+		// echo "trash $trash";
+		// var_dump($this->_req_data['checkbox']);die;
+		if (isset($this->_req_data['checkbox'])) {
+			if (! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
+				// if array has more than one element than success message should be plural
+				$success = count($this->_req_data['checkbox']) > 1 ? 2 : 1;
+				// cycle thru bulk action checkboxes
+				$checkboxes = $this->_req_data['checkbox'];
+				foreach (array_keys($checkboxes) as $ID) {
+					if (! $model->delete_or_restore_by_ID($trash, absint($ID))) {
+						$success = 0;
+					}
+				}
+			} else {
+				// grab single id and delete
+				$ID = absint($this->_req_data['checkbox']);
+				if (! $model->delete_or_restore_by_ID($trash, $ID)) {
+					$success = 0;
+				}
+			}
+		} else {
+			// delete via trash link
+			// grab single id and delete
+			$ID = absint($this->_req_data[ $model->primary_key_name() ]);
+			if (! $model->delete_or_restore_by_ID($trash, $ID)) {
+				$success = 0;
+			}
+		}
+
+
+		$action = $model instanceof EEM_Question ? 'default' : 'question_groups';// strtolower( $model->item_name(2) );
+		// echo "action :$action";
+		// $action = 'questions' ? 'default' : $action;
+		if ($trash) {
+			$action_desc = 'trashed';
+			$status = 'trash';
+		} else {
+			$action_desc = 'restored';
+			$status = 'all';
+		}
+		$this->_redirect_after_action(
+			$success,
+			$model->item_name($success),
+			$action_desc,
+			array('action' => $action, 'status' => $status)
+		);
+	}
+
+
+	/**
+	 * @param            $per_page
+	 * @param int        $current_page
+	 * @param bool|false $count
+	 * @return EE_Soft_Delete_Base_Class[]|int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function get_trashed_questions($per_page, $current_page = 1, $count = false)
+	{
+		$query_params = $this->get_query_params(EEM_Question::instance(), $per_page, $current_page);
+
+		if ($count) {
+			// note: this a subclass of EEM_Soft_Delete_Base, so this is actually only getting non-trashed items
+			$where = isset($query_params[0]) ? array($query_params[0]) : array();
+			$results = $this->_question_model->count_deleted($where);
+		} else {
+			// note: this a subclass of EEM_Soft_Delete_Base, so this is actually only getting non-trashed items
+			$results = $this->_question_model->get_all_deleted($query_params);
+		}
+		return $results;
+	}
+
+
+	/**
+	 * @param            $per_page
+	 * @param int        $current_page
+	 * @param bool|false $count
+	 * @return EE_Soft_Delete_Base_Class[]|int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function get_question_groups($per_page, $current_page = 1, $count = false)
+	{
+		$questionGroupModel = EEM_Question_Group::instance();
+		$query_params = $this->get_query_params($questionGroupModel, $per_page, $current_page);
+		if ($count) {
+			$where = isset($query_params[0]) ? array($query_params[0]) : array();
+			$results = $questionGroupModel->count($where);
+		} else {
+			$results = $questionGroupModel->get_all($query_params);
+		}
+		return $results;
+	}
+
+
+	/**
+	 * @param      $per_page
+	 * @param int  $current_page
+	 * @param bool $count
+	 * @return EE_Soft_Delete_Base_Class[]|int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function get_trashed_question_groups($per_page, $current_page = 1, $count = false)
+	{
+		$questionGroupModel = EEM_Question_Group::instance();
+		$query_params = $this->get_query_params($questionGroupModel, $per_page, $current_page);
+		if ($count) {
+			$where = isset($query_params[0]) ? array($query_params[0]) : array();
+			$query_params['limit'] = null;
+			$results = $questionGroupModel->count_deleted($where);
+		} else {
+			$results = $questionGroupModel->get_all_deleted($query_params);
+		}
+		return $results;
+	}
+
+
+	/**
+	 * method for performing updates to question order
+	 *
+	 * @return void results array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function update_question_group_order()
+	{
+
+		$success = esc_html__('Question group order was updated successfully.', 'event_espresso');
+
+		// grab our row IDs
+		$row_ids = isset($this->_req_data['row_ids']) && ! empty($this->_req_data['row_ids'])
+			? explode(',', rtrim($this->_req_data['row_ids'], ','))
+			: array();
+
+		$perpage = ! empty($this->_req_data['perpage'])
+			? (int) $this->_req_data['perpage']
+			: null;
+		$curpage = ! empty($this->_req_data['curpage'])
+			? (int) $this->_req_data['curpage']
+			: null;
+
+		if (! empty($row_ids)) {
+			// figure out where we start the row_id count at for the current page.
+			$qsgcount = empty($curpage) ? 0 : ($curpage - 1) * $perpage;
+
+			$row_count = count($row_ids);
+			for ($i = 0; $i < $row_count; $i++) {
+				// Update the questions when re-ordering
+				$updated = EEM_Question_Group::instance()->update(
+					array('QSG_order' => $qsgcount),
+					array(array('QSG_ID' => $row_ids[ $i ]))
+				);
+				if ($updated === false) {
+					$success = false;
+				}
+				$qsgcount++;
+			}
+		} else {
+			$success = false;
+		}
+
+		$errors = ! $success
+			? esc_html__('An error occurred. The question group order was not updated.', 'event_espresso')
+			: false;
+
+		echo wp_json_encode(array('return_data' => false, 'success' => $success, 'errors' => $errors));
+		die();
+	}
+
+
+
+	/***************************************       REGISTRATION SETTINGS       ***************************************/
+
+
+	/**
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _reg_form_settings()
+	{
+		$this->_template_args['values'] = $this->_yes_no_values;
+		add_action(
+			'AHEE__Extend_Registration_Form_Admin_Page___reg_form_settings_template',
+			array($this, 'email_validation_settings_form'),
+			2
+		);
+		add_action(
+			'AHEE__Extend_Registration_Form_Admin_Page___reg_form_settings_template',
+			array($this, 'copy_attendee_info_settings_form'),
+			4
+		);
+		$this->_template_args = (array) apply_filters(
+			'FHEE__Extend_Registration_Form_Admin_Page___reg_form_settings___template_args',
+			$this->_template_args
+		);
+		$this->_set_add_edit_form_tags('update_reg_form_settings');
+		$this->_set_publish_post_box_vars(null, false, false, null, false);
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(
+			REGISTRATION_FORM_CAF_TEMPLATE_PATH . 'reg_form_settings.template.php',
+			$this->_template_args,
+			true
+		);
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _update_reg_form_settings()
+	{
+		EE_Registry::instance()->CFG->registration = $this->update_email_validation_settings_form(
+			EE_Registry::instance()->CFG->registration
+		);
+		EE_Registry::instance()->CFG->registration = $this->update_copy_attendee_info_settings_form(
+			EE_Registry::instance()->CFG->registration
+		);
+		EE_Registry::instance()->CFG->registration = apply_filters(
+			'FHEE__Extend_Registration_Form_Admin_Page___update_reg_form_settings__CFG_registration',
+			EE_Registry::instance()->CFG->registration
+		);
+		$success = $this->_update_espresso_configuration(
+			esc_html__('Registration Form Options', 'event_espresso'),
+			EE_Registry::instance()->CFG,
+			__FILE__,
+			__FUNCTION__,
+			__LINE__
+		);
+		$this->_redirect_after_action(
+			$success,
+			esc_html__('Registration Form Options', 'event_espresso'),
+			'updated',
+			array('action' => 'view_reg_form_settings')
+		);
+	}
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function copy_attendee_info_settings_form()
+	{
+		echo wp_kses($this->_copy_attendee_info_settings_form()->get_html(), AllowedTags::getWithFormTags());
+	}
+
+	/**
+	 * _copy_attendee_info_settings_form
+	 *
+	 * @access protected
+	 * @return EE_Form_Section_Proper
+	 * @throws \EE_Error
+	 */
+	protected function _copy_attendee_info_settings_form()
+	{
+		return new EE_Form_Section_Proper(
+			array(
+				'name'            => 'copy_attendee_info_settings',
+				'html_id'         => 'copy_attendee_info_settings',
+				'layout_strategy' => new EE_Admin_Two_Column_Layout(),
+				'subsections'     => apply_filters(
+					'FHEE__Extend_Registration_Form_Admin_Page___copy_attendee_info_settings_form__form_subsections',
+					array(
+						'copy_attendee_info_hdr'   => new EE_Form_Section_HTML(
+							EEH_HTML::h2(esc_html__('Copy Attendee Info Settings', 'event_espresso'))
+						),
+						'copy_attendee_info' => new EE_Yes_No_Input(
+							array(
+								'html_label_text' => esc_html__(
+									'Allow copy #1 attendee info to extra attendees?',
+									'event_espresso'
+								),
+								'html_help_text'  => esc_html__(
+									'Set to yes if you want to enable the copy of #1 attendee info to extra attendees at Registration Form.',
+									'event_espresso'
+								),
+								'default'         => EE_Registry::instance()->CFG->registration->copyAttendeeInfo(),
+								'required'        => false,
+								'display_html_label_text' => false,
+							)
+						),
+					)
+				),
+			)
+		);
+	}
+
+	/**
+	 * @param EE_Registration_Config $EE_Registration_Config
+	 * @return EE_Registration_Config
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function update_copy_attendee_info_settings_form(EE_Registration_Config $EE_Registration_Config)
+	{
+		$prev_copy_attendee_info = $EE_Registration_Config->copyAttendeeInfo();
+		try {
+			$copy_attendee_info_settings_form = $this->_copy_attendee_info_settings_form();
+			// if not displaying a form, then check for form submission
+			if ($copy_attendee_info_settings_form->was_submitted()) {
+				// capture form data
+				$copy_attendee_info_settings_form->receive_form_submission();
+				// validate form data
+				if ($copy_attendee_info_settings_form->is_valid()) {
+					// grab validated data from form
+					$valid_data = $copy_attendee_info_settings_form->valid_data();
+					if (isset($valid_data['copy_attendee_info'])) {
+						$EE_Registration_Config->setCopyAttendeeInfo($valid_data['copy_attendee_info']);
+					} else {
+						EE_Error::add_error(
+							esc_html__(
+								'Invalid or missing Copy Attendee Info settings. Please refresh the form and try again.',
+								'event_espresso'
+							),
+							__FILE__,
+							__FUNCTION__,
+							__LINE__
+						);
+					}
+				} else {
+					if ($copy_attendee_info_settings_form->submission_error_message() !== '') {
+						EE_Error::add_error(
+							$copy_attendee_info_settings_form->submission_error_message(),
+							__FILE__,
+							__FUNCTION__,
+							__LINE__
+						);
+					}
+				}
+			}
+		} catch (EE_Error $e) {
+			$e->get_error();
+		}
+		return $EE_Registration_Config;
+	}
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function email_validation_settings_form()
+	{
+		echo wp_kses($this->_email_validation_settings_form()->get_html(), AllowedTags::getWithFormTags());
+	}
+
+
+	/**
+	 * _email_validation_settings_form
+	 *
+	 * @access protected
+	 * @return EE_Form_Section_Proper
+	 * @throws \EE_Error
+	 */
+	protected function _email_validation_settings_form()
+	{
+		return new EE_Form_Section_Proper(
+			array(
+				'name'            => 'email_validation_settings',
+				'html_id'         => 'email_validation_settings',
+				'layout_strategy' => new EE_Admin_Two_Column_Layout(),
+				'subsections'     => apply_filters(
+					'FHEE__Extend_Registration_Form_Admin_Page___email_validation_settings_form__form_subsections',
+					array(
+						'email_validation_hdr'   => new EE_Form_Section_HTML(
+							EEH_HTML::h2(esc_html__('Email Validation Settings', 'event_espresso'))
+						),
+						'email_validation_level' => new EE_Select_Input(
+							array(
+								'basic'      => esc_html__('Basic', 'event_espresso'),
+								'wp_default' => esc_html__('WordPress Default', 'event_espresso'),
+								'i18n'       => esc_html__('International', 'event_espresso'),
+								'i18n_dns'   => esc_html__('International + DNS Check', 'event_espresso'),
+							),
+							array(
+								'html_label_text' => esc_html__('Email Validation Level', 'event_espresso')
+													 . EEH_Template::get_help_tab_link('email_validation_info'),
+								'html_help_text'  => esc_html__(
+									'These levels range from basic validation ( ie: text@text.text ) to more advanced checks against international email addresses (ie: üñîçøðé@example.com ) with additional MX and A record checks to confirm the domain actually exists. More information on on each level can be found within the help section.',
+									'event_espresso'
+								),
+								'default'         => isset(
+									EE_Registry::instance()->CFG->registration->email_validation_level
+								)
+									? EE_Registry::instance()->CFG->registration->email_validation_level
+									: 'wp_default',
+								'required'        => false,
+							)
+						),
+					)
+				),
+			)
+		);
+	}
+
+
+	/**
+	 * @param EE_Registration_Config $EE_Registration_Config
+	 * @return EE_Registration_Config
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function update_email_validation_settings_form(EE_Registration_Config $EE_Registration_Config)
+	{
+		$prev_email_validation_level = $EE_Registration_Config->email_validation_level;
+		try {
+			$email_validation_settings_form = $this->_email_validation_settings_form();
+			// if not displaying a form, then check for form submission
+			if ($email_validation_settings_form->was_submitted()) {
+				// capture form data
+				$email_validation_settings_form->receive_form_submission();
+				// validate form data
+				if ($email_validation_settings_form->is_valid()) {
+					// grab validated data from form
+					$valid_data = $email_validation_settings_form->valid_data();
+					if (isset($valid_data['email_validation_level'])) {
+						$email_validation_level = $valid_data['email_validation_level'];
+						// now if they want to use international email addresses
+						if ($email_validation_level === 'i18n' || $email_validation_level === 'i18n_dns') {
+							// in case we need to reset their email validation level,
+							// make sure that the previous value wasn't already set to one of the i18n options.
+							if ($prev_email_validation_level === 'i18n' || $prev_email_validation_level === 'i18n_dns') {
+								// if so, then reset it back to "basic" since that is the only other option that,
+								// despite offering poor validation, supports i18n email addresses
+								$prev_email_validation_level = 'basic';
+							}
+							// confirm our i18n email validation will work on the server
+							if (! $this->_verify_pcre_support($EE_Registration_Config, $email_validation_level)) {
+								// or reset email validation level to previous value
+								$email_validation_level = $prev_email_validation_level;
+							}
+						}
+						$EE_Registration_Config->email_validation_level = $email_validation_level;
+					} else {
+						EE_Error::add_error(
+							esc_html__(
+								'Invalid or missing Email Validation settings. Please refresh the form and try again.',
+								'event_espresso'
+							),
+							__FILE__,
+							__FUNCTION__,
+							__LINE__
+						);
+					}
+				} else {
+					if ($email_validation_settings_form->submission_error_message() !== '') {
+						EE_Error::add_error(
+							$email_validation_settings_form->submission_error_message(),
+							__FILE__,
+							__FUNCTION__,
+							__LINE__
+						);
+					}
+				}
+			}
+		} catch (EE_Error $e) {
+			$e->get_error();
+		}
+		return $EE_Registration_Config;
+	}
+
+
+	/**
+	 * confirms that the server's PHP version has the PCRE module enabled,
+	 * and that the PCRE version works with our i18n email validation
+	 *
+	 * @param EE_Registration_Config $EE_Registration_Config
+	 * @param string                 $email_validation_level
+	 * @return bool
+	 */
+	private function _verify_pcre_support(EE_Registration_Config $EE_Registration_Config, $email_validation_level)
+	{
+		// first check that PCRE is enabled
+		if (! defined('PREG_BAD_UTF8_ERROR')) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'We\'re sorry, but it appears that your server\'s version of PHP was not compiled with PCRE unicode support.%1$sPlease contact your hosting company and ask them whether the PCRE compiled with your version of PHP on your server can be been built with the "--enable-unicode-properties" and "--enable-utf8" configuration switches to enable more complex regex expressions.%1$sIf they are unable, or unwilling to do so, then your server will not support international email addresses using UTF-8 unicode characters. This means you will either have to lower your email validation level to "Basic" or "WordPress Default", or switch to a hosting company that has/can enable PCRE unicode support on the server.',
+						'event_espresso'
+					),
+					'<br />'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		} else {
+			// PCRE support is enabled, but let's still
+			// perform a test to see if the server will support it.
+			// but first, save the updated validation level to the config,
+			// so that the validation strategy picks it up.
+			// this will get bumped back down if it doesn't work
+			$EE_Registration_Config->email_validation_level = $email_validation_level;
+			try {
+				$email_validator = new EE_Email_Validation_Strategy();
+				$i18n_email_address = apply_filters(
+					'FHEE__Extend_Registration_Form_Admin_Page__update_email_validation_settings_form__i18n_email_address',
+					'jägerjürgen@deutschland.com'
+				);
+				$email_validator->validate($i18n_email_address);
+			} catch (Exception $e) {
+				EE_Error::add_error(
+					sprintf(
+						esc_html__(
+							'We\'re sorry, but it appears that your server\'s configuration will not support the "International" or "International + DNS Check" email validation levels.%1$sTo correct this issue, please consult with your hosting company regarding your server\'s PCRE settings.%1$sIt is recommended that your PHP version be configured to use PCRE 8.10 or newer.%1$sMore information regarding PCRE versions and installation can be found here: %2$s',
+							'event_espresso'
+						),
+						'<br />',
+						'<a href="http://php.net/manual/en/pcre.installation.php" target="_blank" rel="noopener noreferrer">http://php.net/manual/en/pcre.installation.php</a>'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+				return false;
+			}
+		}
+		return true;
+	}
 }

Spacing +34 added lines, -34 removed lines

@@ -19,11 +19,11 @@ 
      */
     public function __construct($routing = true)
     {
-        define('REGISTRATION_FORM_CAF_ADMIN', EE_CORE_CAF_ADMIN_EXTEND . 'registration_form/');
-        define('REGISTRATION_FORM_CAF_ASSETS_PATH', REGISTRATION_FORM_CAF_ADMIN . 'assets/');
-        define('REGISTRATION_FORM_CAF_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL . 'registration_form/assets/');
-        define('REGISTRATION_FORM_CAF_TEMPLATE_PATH', REGISTRATION_FORM_CAF_ADMIN . 'templates/');
-        define('REGISTRATION_FORM_CAF_TEMPLATE_URL', EE_CORE_CAF_ADMIN_EXTEND_URL . 'registration_form/templates/');
+        define('REGISTRATION_FORM_CAF_ADMIN', EE_CORE_CAF_ADMIN_EXTEND.'registration_form/');
+        define('REGISTRATION_FORM_CAF_ASSETS_PATH', REGISTRATION_FORM_CAF_ADMIN.'assets/');
+        define('REGISTRATION_FORM_CAF_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL.'registration_form/assets/');
+        define('REGISTRATION_FORM_CAF_TEMPLATE_PATH', REGISTRATION_FORM_CAF_ADMIN.'templates/');
+        define('REGISTRATION_FORM_CAF_TEMPLATE_URL', EE_CORE_CAF_ADMIN_EXTEND_URL.'registration_form/templates/');
         parent::__construct($routing);
     }
 
@@ -357,7 +357,7 @@ 
     {
         wp_register_script(
             'ee-question-sortable',
-            REGISTRATION_FORM_CAF_ASSETS_URL . 'ee_question_order.js',
+            REGISTRATION_FORM_CAF_ASSETS_URL.'ee_question_order.js',
             array('jquery-ui-sortable'),
             EVENT_ESPRESSO_VERSION,
             true
@@ -445,7 +445,7 @@ 
      */
     protected function _questions_overview_list_table()
     {
-        $this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
+        $this->_admin_page_title .= ' '.$this->get_action_link_or_button(
             'add_question',
             'add_question',
             array(),
@@ -466,7 +466,7 @@ 
     protected function _question_groups_overview_list_table()
     {
         $this->_search_btn_label = esc_html__('Question Groups', 'event_espresso');
-        $this->_admin_page_title .= ' ' . $this->get_action_link_or_button(
+        $this->_admin_page_title .= ' '.$this->get_action_link_or_button(
             'add_question_group',
             'add_question_group',
             array(),
@@ -528,19 +528,19 @@ 
     {
         $success = 0;
         do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        if (! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
+        if ( ! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
             // if array has more than one element than success message should be plural
             $success = count($this->_req_data['checkbox']) > 1 ? 2 : 1;
             // cycle thru bulk action checkboxes
             $checkboxes = $this->_req_data['checkbox'];
             foreach (array_keys($checkboxes) as $ID) {
-                if (! $this->_delete_item($ID, $model)) {
+                if ( ! $this->_delete_item($ID, $model)) {
                     $success = 0;
                 }
             }
-        } elseif (! empty($this->_req_data['QSG_ID'])) {
+        } elseif ( ! empty($this->_req_data['QSG_ID'])) {
             $success = $this->_delete_item($this->_req_data['QSG_ID'], $model);
-        } elseif (! empty($this->_req_data['QST_ID'])) {
+        } elseif ( ! empty($this->_req_data['QST_ID'])) {
             $success = $this->_delete_item($this->_req_data['QST_ID'], $model);
         } else {
             EE_Error::add_error(
@@ -609,7 +609,7 @@ 
                 $this->_admin_page_title = ucwords(str_replace('_', ' ', $this->_req_action));
         }
         // add ID to title if editing
-        $this->_admin_page_title = $ID ? $this->_admin_page_title . ' # ' . $ID : $this->_admin_page_title;
+        $this->_admin_page_title = $ID ? $this->_admin_page_title.' # '.$ID : $this->_admin_page_title;
         if ($ID) {
             /** @var EE_Question_Group $questionGroup */
             $questionGroup = $this->_question_group_model->get_one_by_ID($ID);
@@ -629,7 +629,7 @@ 
         $redirect_URL = add_query_arg(array('action' => 'question_groups'), $this->_admin_base_url);
         $this->_set_publish_post_box_vars('id', $ID, false, $redirect_URL);
         $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            REGISTRATION_FORM_CAF_TEMPLATE_PATH . 'question_groups_main_meta_box.template.php',
+            REGISTRATION_FORM_CAF_TEMPLATE_PATH.'question_groups_main_meta_box.template.php',
             $this->_template_args,
             true
         );
@@ -673,7 +673,7 @@ 
         // make sure identifier is unique
         $identifier_value = isset($set_column_values['QSG_identifier']) ? $set_column_values['QSG_identifier'] : '';
         $where_values = ['QSG_identifier' => $set_column_values['QSG_identifier']];
-        if (! $new_question_group && isset($set_column_values['QSG_ID'])) {
+        if ( ! $new_question_group && isset($set_column_values['QSG_ID'])) {
             $where_values['QSG_ID'] = ['!=', $set_column_values['QSG_ID']];
         }
         $identifier_exists = ! empty($identifier_value)
@@ -713,7 +713,7 @@ 
         // update the existing related questions
         // BUT FIRST...  delete the phone question from the Question_Group_Question
         // if it is being added to this question group (therefore removed from the existing group)
-        if (isset($this->_req_data['questions'], $this->_req_data['questions'][ $phone_question_id ])) {
+        if (isset($this->_req_data['questions'], $this->_req_data['questions'][$phone_question_id])) {
             // delete where QST ID = system phone question ID and Question Group ID is NOT this group
             EEM_Question_Group_Question::instance()->delete(
                 array(
@@ -728,22 +728,22 @@ 
         $question_group = $this->_question_group_model->get_one_by_ID($QSG_ID);
         $questions = $question_group->questions();
         // make sure system phone question is added to list of questions for this group
-        if (! isset($questions[ $phone_question_id ])) {
-            $questions[ $phone_question_id ] = EEM_Question::instance()->get_one_by_ID($phone_question_id);
+        if ( ! isset($questions[$phone_question_id])) {
+            $questions[$phone_question_id] = EEM_Question::instance()->get_one_by_ID($phone_question_id);
         }
 
         foreach ($questions as $question_ID => $question) {
             // first we always check for order.
-            if (! empty($this->_req_data['question_orders'][ $question_ID ])) {
+            if ( ! empty($this->_req_data['question_orders'][$question_ID])) {
                 // update question order
                 $question_group->update_question_order(
                     $question_ID,
-                    $this->_req_data['question_orders'][ $question_ID ]
+                    $this->_req_data['question_orders'][$question_ID]
                 );
             }
 
             // then we always check if adding or removing.
-            if (isset($this->_req_data['questions'], $this->_req_data['questions'][ $question_ID ])) {
+            if (isset($this->_req_data['questions'], $this->_req_data['questions'][$question_ID])) {
                 $question_group->add_question($question_ID);
             } else {
                 // not found, remove it (but only if not a system question for the personal group
@@ -766,8 +766,8 @@ 
         if (isset($this->_req_data['questions'])) {
             foreach ($this->_req_data['questions'] as $QST_ID) {
                 $question_group->add_question($QST_ID);
-                if (isset($this->_req_data['question_orders'][ $QST_ID ])) {
-                    $question_group->update_question_order($QST_ID, $this->_req_data['question_orders'][ $QST_ID ]);
+                if (isset($this->_req_data['question_orders'][$QST_ID])) {
+                    $question_group->update_question_order($QST_ID, $this->_req_data['question_orders'][$QST_ID]);
                 }
             }
         }
@@ -908,34 +908,34 @@ 
         // echo "trash $trash";
         // var_dump($this->_req_data['checkbox']);die;
         if (isset($this->_req_data['checkbox'])) {
-            if (! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
+            if ( ! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
                 // if array has more than one element than success message should be plural
                 $success = count($this->_req_data['checkbox']) > 1 ? 2 : 1;
                 // cycle thru bulk action checkboxes
                 $checkboxes = $this->_req_data['checkbox'];
                 foreach (array_keys($checkboxes) as $ID) {
-                    if (! $model->delete_or_restore_by_ID($trash, absint($ID))) {
+                    if ( ! $model->delete_or_restore_by_ID($trash, absint($ID))) {
                         $success = 0;
                     }
                 }
             } else {
                 // grab single id and delete
                 $ID = absint($this->_req_data['checkbox']);
-                if (! $model->delete_or_restore_by_ID($trash, $ID)) {
+                if ( ! $model->delete_or_restore_by_ID($trash, $ID)) {
                     $success = 0;
                 }
             }
         } else {
             // delete via trash link
             // grab single id and delete
-            $ID = absint($this->_req_data[ $model->primary_key_name() ]);
-            if (! $model->delete_or_restore_by_ID($trash, $ID)) {
+            $ID = absint($this->_req_data[$model->primary_key_name()]);
+            if ( ! $model->delete_or_restore_by_ID($trash, $ID)) {
                 $success = 0;
             }
         }
 
 
-        $action = $model instanceof EEM_Question ? 'default' : 'question_groups';// strtolower( $model->item_name(2) );
+        $action = $model instanceof EEM_Question ? 'default' : 'question_groups'; // strtolower( $model->item_name(2) );
         // echo "action :$action";
         // $action = 'questions' ? 'default' : $action;
         if ($trash) {
@@ -1055,7 +1055,7 @@ 
             ? (int) $this->_req_data['curpage']
             : null;
 
-        if (! empty($row_ids)) {
+        if ( ! empty($row_ids)) {
             // figure out where we start the row_id count at for the current page.
             $qsgcount = empty($curpage) ? 0 : ($curpage - 1) * $perpage;
 
@@ -1064,7 +1064,7 @@ 
                 // Update the questions when re-ordering
                 $updated = EEM_Question_Group::instance()->update(
                     array('QSG_order' => $qsgcount),
-                    array(array('QSG_ID' => $row_ids[ $i ]))
+                    array(array('QSG_ID' => $row_ids[$i]))
                 );
                 if ($updated === false) {
                     $success = false;
@@ -1115,7 +1115,7 @@ 
         $this->_set_add_edit_form_tags('update_reg_form_settings');
         $this->_set_publish_post_box_vars(null, false, false, null, false);
         $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            REGISTRATION_FORM_CAF_TEMPLATE_PATH . 'reg_form_settings.template.php',
+            REGISTRATION_FORM_CAF_TEMPLATE_PATH.'reg_form_settings.template.php',
             $this->_template_args,
             true
         );
@@ -1361,7 +1361,7 @@ 
                                 $prev_email_validation_level = 'basic';
                             }
                             // confirm our i18n email validation will work on the server
-                            if (! $this->_verify_pcre_support($EE_Registration_Config, $email_validation_level)) {
+                            if ( ! $this->_verify_pcre_support($EE_Registration_Config, $email_validation_level)) {
                                 // or reset email validation level to previous value
                                 $email_validation_level = $prev_email_validation_level;
                             }
@@ -1407,7 +1407,7 @@ 
     private function _verify_pcre_support(EE_Registration_Config $EE_Registration_Config, $email_validation_level)
     {
         // first check that PCRE is enabled
-        if (! defined('PREG_BAD_UTF8_ERROR')) {
+        if ( ! defined('PREG_BAD_UTF8_ERROR')) {
             EE_Error::add_error(
                 sprintf(
                     esc_html__(