eventespresso / event-espresso-core

espresso.php

Indentation +107 added lines, -107 removed lines

@@ -37,138 +37,138 @@
  * @since       4.0
  */
 if (function_exists('espresso_version')) {
-    if (! function_exists('espresso_duplicate_plugin_error')) {
-        /**
-         *    espresso_duplicate_plugin_error
-         *    displays if more than one version of EE is activated at the same time.
-         */
-        function espresso_duplicate_plugin_error()
-        {
-            ?>
+	if (! function_exists('espresso_duplicate_plugin_error')) {
+		/**
+		 *    espresso_duplicate_plugin_error
+		 *    displays if more than one version of EE is activated at the same time.
+		 */
+		function espresso_duplicate_plugin_error()
+		{
+			?>
 <div class="error">
     <p>
         <?php
-                    echo esc_html__(
-                        'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.',
-                        'event_espresso'
-                    ); ?>
+					echo esc_html__(
+						'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.',
+						'event_espresso'
+					); ?>
     </p>
 </div>
 <?php
-            espresso_deactivate_plugin(plugin_basename(__FILE__));
-        }
-    }
-    add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
+			espresso_deactivate_plugin(plugin_basename(__FILE__));
+		}
+	}
+	add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
 } else {
-    define('EE_MIN_PHP_VER_REQUIRED', '7.4.0');
-    if (! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
-        /**
-         * espresso_minimum_php_version_error
-         *
-         * @return void
-         */
-        function espresso_minimum_php_version_error()
-        {
-            ?>
+	define('EE_MIN_PHP_VER_REQUIRED', '7.4.0');
+	if (! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
+		/**
+		 * espresso_minimum_php_version_error
+		 *
+		 * @return void
+		 */
+		function espresso_minimum_php_version_error()
+		{
+			?>
 <div class="error">
     <p>
         <?php
-                    printf(
-                        esc_html__(
-                            'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
-                            'event_espresso'
-                        ),
-                        EE_MIN_PHP_VER_REQUIRED,
-                        PHP_VERSION,
-                        '<br/>',
-                        '<a href="https://www.php.net/downloads.php">https://php.net/downloads.php</a>'
-                    );
-        ?>
+					printf(
+						esc_html__(
+							'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
+							'event_espresso'
+						),
+						EE_MIN_PHP_VER_REQUIRED,
+						PHP_VERSION,
+						'<br/>',
+						'<a href="https://www.php.net/downloads.php">https://php.net/downloads.php</a>'
+					);
+		?>
     </p>
 </div>
 <?php
-            espresso_deactivate_plugin(plugin_basename(__FILE__));
-        }
+			espresso_deactivate_plugin(plugin_basename(__FILE__));
+		}
 
-        add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
-    } else {
-        define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
+		add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
+	} else {
+		define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
 
-        require_once __DIR__ . '/vendor/autoload.php';
+		require_once __DIR__ . '/vendor/autoload.php';
 
-        /**
-         * espresso_version
-         * Returns the plugin version
-         *
-         * @return string
-         */
-        function espresso_version(): string
-        {
-            return apply_filters('FHEE__espresso__espresso_version', '5.0.32.rc.000');
-        }
+		/**
+		 * espresso_version
+		 * Returns the plugin version
+		 *
+		 * @return string
+		 */
+		function espresso_version(): string
+		{
+			return apply_filters('FHEE__espresso__espresso_version', '5.0.32.rc.000');
+		}
 
-        /**
-         * espresso_plugin_activation
-         * adds a wp-option to indicate that EE has been activated via the WP admin plugins page
-         */
-        function espresso_plugin_activation()
-        {
-            update_option('ee_espresso_activation', true);
-            update_option('event-espresso-core_allow_tracking', 'no');
-            update_option('event-espresso-core_tracking_notice', 'hide');
-            // Run WP GraphQL activation callback
-            espressoLoadWpGraphQL();
-            graphql_activation_callback();
-        }
+		/**
+		 * espresso_plugin_activation
+		 * adds a wp-option to indicate that EE has been activated via the WP admin plugins page
+		 */
+		function espresso_plugin_activation()
+		{
+			update_option('ee_espresso_activation', true);
+			update_option('event-espresso-core_allow_tracking', 'no');
+			update_option('event-espresso-core_tracking_notice', 'hide');
+			// Run WP GraphQL activation callback
+			espressoLoadWpGraphQL();
+			graphql_activation_callback();
+		}
 
-        register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
+		register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
 
-        /**
-         * espresso_plugin_deactivation
-         */
-        function espresso_plugin_deactivation()
-        {
-            // Run WP GraphQL deactivation callback
-            espressoLoadWpGraphQL();
-            graphql_deactivation_callback();
-            delete_option('event-espresso-core_allow_tracking');
-            delete_option('event-espresso-core_tracking_notice');
-        }
-        register_deactivation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_deactivation');
+		/**
+		 * espresso_plugin_deactivation
+		 */
+		function espresso_plugin_deactivation()
+		{
+			// Run WP GraphQL deactivation callback
+			espressoLoadWpGraphQL();
+			graphql_deactivation_callback();
+			delete_option('event-espresso-core_allow_tracking');
+			delete_option('event-espresso-core_tracking_notice');
+		}
+		register_deactivation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_deactivation');
 
-        require_once __DIR__ . '/core/bootstrap_espresso.php';
-        bootstrap_espresso();
-    }
+		require_once __DIR__ . '/core/bootstrap_espresso.php';
+		bootstrap_espresso();
+	}
 }
 
 if (! function_exists('espresso_deactivate_plugin')) {
-    /**
-     *    deactivate_plugin
-     * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
-     *
-     * @access public
-     * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
-     * @return    void
-     */
-    function espresso_deactivate_plugin(string $plugin_basename = '')
-    {
-        if (! function_exists('deactivate_plugins')) {
-            require_once ABSPATH . 'wp-admin/includes/plugin.php';
-        }
-        unset($_GET['activate'], $_REQUEST['activate']);
-        deactivate_plugins($plugin_basename);
-    }
+	/**
+	 *    deactivate_plugin
+	 * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
+	 *
+	 * @access public
+	 * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
+	 * @return    void
+	 */
+	function espresso_deactivate_plugin(string $plugin_basename = '')
+	{
+		if (! function_exists('deactivate_plugins')) {
+			require_once ABSPATH . 'wp-admin/includes/plugin.php';
+		}
+		unset($_GET['activate'], $_REQUEST['activate']);
+		deactivate_plugins($plugin_basename);
+	}
 }
 
 
 if (! function_exists('espressoLoadWpGraphQL')) {
-    function espressoLoadWpGraphQL()
-    {
-        if (
-            ! class_exists('WPGraphQL')
-            && is_readable(__DIR__ . '/vendor/wp-graphql/wp-graphql/wp-graphql.php')
-        ) {
-            require_once __DIR__ . '/vendor/wp-graphql/wp-graphql/wp-graphql.php';
-        }
-    }
+	function espressoLoadWpGraphQL()
+	{
+		if (
+			! class_exists('WPGraphQL')
+			&& is_readable(__DIR__ . '/vendor/wp-graphql/wp-graphql/wp-graphql.php')
+		) {
+			require_once __DIR__ . '/vendor/wp-graphql/wp-graphql/wp-graphql.php';
+		}
+	}
 }

admin_pages/general_settings/General_Settings_Admin_Page.core.php

Indentation +1463 added lines, -1463 removed lines

@@ -22,1480 +22,1480 @@
  */
 class General_Settings_Admin_Page extends EE_Admin_Page
 {
-    /**
-     * @var EE_Core_Config
-     */
-    public $core_config;
-
-
-    /**
-     * Initialize basic properties.
-     */
-    protected function _init_page_props()
-    {
-        $this->page_slug        = GEN_SET_PG_SLUG;
-        $this->page_label       = GEN_SET_LABEL;
-        $this->_admin_base_url  = GEN_SET_ADMIN_URL;
-        $this->_admin_base_path = GEN_SET_ADMIN;
-
-        $this->core_config = EE_Registry::instance()->CFG->core;
-    }
-
-
-    /**
-     * Set ajax hooks
-     */
-    protected function _ajax_hooks()
-    {
-        add_action('wp_ajax_espresso_display_country_settings', [$this, 'display_country_settings']);
-        add_action('wp_ajax_espresso_display_country_states', [$this, 'display_country_states']);
-        add_action('wp_ajax_espresso_delete_state', [$this, 'delete_state'], 10, 3);
-        add_action('wp_ajax_espresso_add_new_state', [$this, 'add_new_state']);
-    }
-
-
-    /**
-     * More page properties initialization.
-     */
-    protected function _define_page_props()
-    {
-        $this->_admin_page_title = GEN_SET_LABEL;
-        $this->_labels           = ['publishbox' => esc_html__('Update Settings', 'event_espresso')];
-    }
-
-
-    /**
-     * Set page routes property.
-     */
-    protected function _set_page_routes()
-    {
-        $this->_page_routes = [
-            'critical_pages'                => [
-                'func'       => [$this, '_espresso_page_settings'],
-                'capability' => 'manage_options',
-            ],
-            'update_espresso_page_settings' => [
-                'func'       => [$this, '_update_espresso_page_settings'],
-                'capability' => 'manage_options',
-                'noheader'   => true,
-            ],
-            'default'                       => [
-                'func'       => [$this, '_your_organization_settings'],
-                'capability' => 'manage_options',
-            ],
-
-            'update_your_organization_settings' => [
-                'func'       => [$this, '_update_your_organization_settings'],
-                'capability' => 'manage_options',
-                'noheader'   => true,
-            ],
-
-            'admin_option_settings' => [
-                'func'       => [$this, '_admin_option_settings'],
-                'capability' => 'manage_options',
-            ],
-
-            'update_admin_option_settings' => [
-                'func'       => [$this, '_update_admin_option_settings'],
-                'capability' => 'manage_options',
-                'noheader'   => true,
-            ],
-
-            'country_settings' => [
-                'func'       => [$this, '_country_settings'],
-                'capability' => 'manage_options',
-            ],
-
-            'update_country_settings' => [
-                'func'          => [$this, '_update_country_settings'],
-                'capability'    => 'manage_options',
-                'noheader'      => true,
-                'require_nonce' => true,
-            ],
-
-            'display_country_settings' => [
-                'func'       => [$this, 'display_country_settings'],
-                'capability' => 'manage_options',
-                'noheader'   => true,
-            ],
-
-            'add_new_state' => [
-                'func'          => [$this, 'add_new_state'],
-                'capability'    => 'manage_options',
-                'noheader'      => true,
-                'require_nonce' => true,
-            ],
-
-            'delete_state' => [
-                'func'          => [$this, 'delete_state'],
-                'capability'    => 'manage_options',
-                'noheader'      => true,
-                'require_nonce' => true,
-            ],
-
-            'privacy_settings' => [
-                'func'       => [$this, 'privacySettings'],
-                'capability' => 'manage_options',
-            ],
-
-            'update_privacy_settings' => [
-                'func'               => [$this, 'updatePrivacySettings'],
-                'capability'         => 'manage_options',
-                'noheader'           => true,
-                'headers_sent_route' => 'privacy_settings',
-            ],
-
-            'set_font_size'            => [
-                'func'       => [$this, 'setFontSize'],
-                'noheader'   => true,
-            ],
-        ];
-    }
-
-
-    /**
-     * Set page configuration property
-     */
-    protected function _set_page_config()
-    {
-        $this->_page_config = [
-            'critical_pages'        => [
-                'nav'           => [
-                    'label' => esc_html__('Critical Pages', 'event_espresso'),
-                    'icon' => 'dashicons-warning',
-                    'order' => 50,
-                ],
-                'metaboxes'     => array_merge($this->_default_espresso_metaboxes, ['_publish_post_box']),
-                'help_tabs'     => [
-                    'general_settings_critical_pages_help_tab' => [
-                        'title'    => esc_html__('Critical Pages', 'event_espresso'),
-                        'filename' => 'general_settings_critical_pages',
-                    ],
-                ],
-                'require_nonce' => false,
-            ],
-            'default'               => [
-                'nav'           => [
-                    'label' => esc_html__('Your Organization', 'event_espresso'),
-                    'icon' => 'dashicons-admin-home',
-                    'order' => 20,
-                ],
-                'help_tabs'     => [
-                    'general_settings_your_organization_help_tab' => [
-                        'title'    => esc_html__('Your Organization', 'event_espresso'),
-                        'filename' => 'general_settings_your_organization',
-                    ],
-                ],
-                'metaboxes'     => array_merge($this->_default_espresso_metaboxes, ['_publish_post_box']),
-                'require_nonce' => false,
-            ],
-            'admin_option_settings' => [
-                'nav'           => [
-                    'label' => esc_html__('Admin Options', 'event_espresso'),
-                    'icon' => 'dashicons-admin-settings',
-                    'order' => 60,
-                ],
-                'metaboxes'     => array_merge($this->_default_espresso_metaboxes, ['_publish_post_box']),
-                'help_tabs'     => [
-                    'general_settings_admin_options_help_tab' => [
-                        'title'    => esc_html__('Admin Options', 'event_espresso'),
-                        'filename' => 'general_settings_admin_options',
-                    ],
-                ],
-                'require_nonce' => false,
-            ],
-            'country_settings'      => [
-                'nav'           => [
-                    'label' => esc_html__('Countries', 'event_espresso'),
-                    'icon' => 'dashicons-admin-site',
-                    'order' => 70,
-                ],
-                'help_tabs'     => [
-                    'general_settings_countries_help_tab' => [
-                        'title'    => esc_html__('Countries', 'event_espresso'),
-                        'filename' => 'general_settings_countries',
-                    ],
-                ],
-                'require_nonce' => false,
-            ],
-            'privacy_settings'      => [
-                'nav'           => [
-                    'label' => esc_html__('Privacy', 'event_espresso'),
-                    'icon' => 'dashicons-privacy',
-                    'order' => 80,
-                ],
-                'metaboxes'     => array_merge($this->_default_espresso_metaboxes, ['_publish_post_box']),
-                'require_nonce' => false,
-            ],
-        ];
-    }
-
-
-    protected function _add_screen_options()
-    {
-    }
-
-
-    protected function _add_feature_pointers()
-    {
-    }
-
-
-    /**
-     * Enqueue global scripts and styles for all routes in the General Settings Admin Pages.
-     */
-    public function load_scripts_styles()
-    {
-        // styles
-        wp_enqueue_style('espresso-ui-theme');
-        // scripts
-        wp_enqueue_script('ee_admin_js');
-    }
-
-
-    /**
-     * Execute logic running on `admin_init`
-     */
-    public function admin_init()
-    {
-        EE_Registry::$i18n_js_strings['invalid_server_response'] = wp_strip_all_tags(
-            esc_html__(
-                'An error occurred! Your request may have been processed, but a valid response from the server was not received. Please refresh the page and try again.',
-                'event_espresso'
-            )
-        );
-        EE_Registry::$i18n_js_strings['error_occurred']          = wp_strip_all_tags(
-            esc_html__(
-                'An error occurred! Please refresh the page and try again.',
-                'event_espresso'
-            )
-        );
-        EE_Registry::$i18n_js_strings['confirm_delete_state']    = wp_strip_all_tags(
-            esc_html__(
-                'Are you sure you want to delete this State / Province?',
-                'event_espresso'
-            )
-        );
-        EE_Registry::$i18n_js_strings['ajax_url']                = admin_url(
-            'admin-ajax.php?page=espresso_general_settings',
-            is_ssl() ? 'https://' : 'http://'
-        );
-    }
-
-
-    public function admin_notices()
-    {
-    }
-
-
-    public function admin_footer_scripts()
-    {
-    }
-
-
-    /**
-     * Enqueue scripts and styles for the default route.
-     */
-    public function load_scripts_styles_default()
-    {
-        // styles
-        wp_enqueue_style('thickbox');
-        // scripts
-        wp_enqueue_script('media-upload');
-        wp_enqueue_script('thickbox');
-        wp_register_script(
-            'organization_settings',
-            GEN_SET_ASSETS_URL . 'your_organization_settings.js',
-            ['jquery', 'media-upload', 'thickbox'],
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_register_style('organization-css', GEN_SET_ASSETS_URL . 'organization.css', [], EVENT_ESPRESSO_VERSION);
-        wp_enqueue_script('organization_settings');
-        wp_enqueue_style('organization-css');
-        $confirm_image_delete = [
-            'text' => wp_strip_all_tags(
-                esc_html__(
-                    'Do you really want to delete this image? Please remember to save your settings to complete the removal.',
-                    'event_espresso'
-                )
-            ),
-        ];
-        wp_localize_script('organization_settings', 'confirm_image_delete', $confirm_image_delete);
-    }
-
-
-    /**
-     * Enqueue scripts and styles for the country settings route.
-     */
-    public function load_scripts_styles_country_settings()
-    {
-        // scripts
-        wp_register_script(
-            'gen_settings_countries',
-            GEN_SET_ASSETS_URL . 'gen_settings_countries.js',
-            ['ee_admin_js'],
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_register_style('organization-css', GEN_SET_ASSETS_URL . 'organization.css', [], EVENT_ESPRESSO_VERSION);
-        wp_enqueue_script('gen_settings_countries');
-        wp_enqueue_style('organization-css');
-    }
-
-
-    /*************        Espresso Pages        *************/
-    /**
-     * _espresso_page_settings
-     *
-     * @throws EE_Error
-     * @throws DomainException
-     * @throws DomainException
-     * @throws InvalidDataTypeException
-     * @throws InvalidArgumentException
-     */
-    protected function _espresso_page_settings()
-    {
-        // Check to make sure all of the main pages are set up properly,
-        // if not create the default pages and display an admin notice
-        EEH_Activation::verify_default_pages_exist();
-        $this->_transient_garbage_collection();
-
-        $this->_template_args['values'] = $this->_yes_no_values;
-
-        $this->_template_args['reg_page_id']  = $this->core_config->reg_page_id ?? null;
-        $this->_template_args['reg_page_obj'] = isset($this->core_config->reg_page_id)
-            ? get_post($this->core_config->reg_page_id)
-            : false;
-
-        $this->_template_args['txn_page_id']  = $this->core_config->txn_page_id ?? null;
-        $this->_template_args['txn_page_obj'] = isset($this->core_config->txn_page_id)
-            ? get_post($this->core_config->txn_page_id)
-            : false;
-
-        $this->_template_args['thank_you_page_id']  = $this->core_config->thank_you_page_id ?? null;
-        $this->_template_args['thank_you_page_obj'] = isset($this->core_config->thank_you_page_id)
-            ? get_post($this->core_config->thank_you_page_id)
-            : false;
-
-        $this->_template_args['cancel_page_id']  = $this->core_config->cancel_page_id ?? null;
-        $this->_template_args['cancel_page_obj'] = isset($this->core_config->cancel_page_id)
-            ? get_post($this->core_config->cancel_page_id)
-            : false;
-
-        $this->_set_add_edit_form_tags('update_espresso_page_settings');
-        $this->_set_publish_post_box_vars();
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            GEN_SET_TEMPLATE_PATH . 'espresso_page_settings.template.php',
-            $this->_template_args,
-            true
-        );
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    /**
-     * Handler for updating espresso page settings.
-     *
-     * @throws EE_Error
-     */
-    protected function _update_espresso_page_settings()
-    {
-        $this->core_config = EE_Registry::instance()->CFG->core;
-        // capture incoming request data && set page IDs
-        $this->core_config->reg_page_id       = $this->request->getRequestParam(
-            'reg_page_id',
-            $this->core_config->reg_page_id,
-            DataType::INT
-        );
-        $this->core_config->txn_page_id       = $this->request->getRequestParam(
-            'txn_page_id',
-            $this->core_config->txn_page_id,
-            DataType::INT
-        );
-        $this->core_config->thank_you_page_id = $this->request->getRequestParam(
-            'thank_you_page_id',
-            $this->core_config->thank_you_page_id,
-            DataType::INT
-        );
-        $this->core_config->cancel_page_id    = $this->request->getRequestParam(
-            'cancel_page_id',
-            $this->core_config->cancel_page_id,
-            DataType::INT
-        );
-
-        $this->core_config = apply_filters(
-            'FHEE__General_Settings_Admin_Page___update_espresso_page_settings__CFG_core',
-            $this->core_config,
-            $this->request->requestParams()
-        );
-
-        $what = esc_html__('Critical Pages & Shortcodes', 'event_espresso');
-        $this->_redirect_after_action(
-            $this->_update_espresso_configuration(
-                $what,
-                $this->core_config,
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            ),
-            $what,
-            '',
-            [
-                'action' => 'critical_pages',
-            ],
-            true
-        );
-    }
-
-
-    /*************        Your Organization        *************/
-
-
-    /**
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _your_organization_settings()
-    {
-        $this->_template_args['admin_page_content'] = '';
-        try {
-            /** @var OrganizationSettings $organization_settings_form */
-            $organization_settings_form = $this->loader->getShared(OrganizationSettings::class);
-
-            $this->_template_args['admin_page_content'] = EEH_HTML::div(
-                $organization_settings_form->display(),
-                '',
-                'padding'
-            );
-        } catch (Exception $e) {
-            EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
-        }
-        $this->_set_add_edit_form_tags('update_your_organization_settings');
-        $this->_set_publish_post_box_vars();
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    /**
-     * Handler for updating organization settings.
-     *
-     * @throws EE_Error
-     */
-    protected function _update_your_organization_settings()
-    {
-        try {
-            /** @var OrganizationSettings $organization_settings_form */
-            $organization_settings_form = $this->loader->getShared(OrganizationSettings::class);
-
-            $success = $organization_settings_form->process($this->request->requestParams());
-
-            EE_Registry::instance()->CFG = apply_filters(
-                'FHEE__General_Settings_Admin_Page___update_your_organization_settings__CFG',
-                EE_Registry::instance()->CFG
-            );
-        } catch (Exception $e) {
-            EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
-            $success = false;
-        }
-
-        if ($success) {
-            $success = $this->_update_espresso_configuration(
-                esc_html__('Your Organization Settings', 'event_espresso'),
-                EE_Registry::instance()->CFG,
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-
-        $this->_redirect_after_action($success, '', '', ['action' => 'default'], true);
-    }
-
-
-
-    /*************        Admin Options        *************/
-
-
-    /**
-     * _admin_option_settings
-     *
-     * @throws EE_Error
-     * @throws LogicException
-     */
-    protected function _admin_option_settings()
-    {
-        $this->_template_args['admin_page_content'] = '';
-        try {
-            $admin_options_settings_form = new AdminOptionsSettings(EE_Registry::instance());
-            // still need this for the old school form in Extend_General_Settings_Admin_Page
-            $this->_template_args['values'] = $this->_yes_no_values;
-            // also need to account for the do_action that was in the old template
-            $admin_options_settings_form->setTemplateArgs($this->_template_args);
-            $this->_template_args['admin_page_content'] = EEH_HTML::div(
-                $admin_options_settings_form->display(),
-                '',
-                'padding'
-            );
-        } catch (Exception $e) {
-            EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
-        }
-        $this->_set_add_edit_form_tags('update_admin_option_settings');
-        $this->_set_publish_post_box_vars();
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    /**
-     * _update_admin_option_settings
-     *
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidFormSubmissionException
-     * @throws InvalidArgumentException
-     * @throws LogicException
-     */
-    protected function _update_admin_option_settings()
-    {
-        try {
-            $admin_options_settings_form = new AdminOptionsSettings(EE_Registry::instance());
-            $admin_options_settings_form->process(
-                $this->request->getRequestParam(
-                    $admin_options_settings_form->slug(),
-                    [],
-                    DataType::STRING,
-                    true
-                )
-            );
-            EE_Registry::instance()->CFG->admin = apply_filters(
-                'FHEE__General_Settings_Admin_Page___update_admin_option_settings__CFG_admin',
-                EE_Registry::instance()->CFG->admin
-            );
-        } catch (Exception $e) {
-            EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
-        }
-        $this->_redirect_after_action(
-            apply_filters(
-                'FHEE__General_Settings_Admin_Page___update_admin_option_settings__success',
-                $this->_update_espresso_configuration(
-                    esc_html__('Admin Options', 'event_espresso'),
-                    EE_Registry::instance()->CFG->admin,
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                )
-            ),
-            esc_html__('Admin Options', 'event_espresso'),
-            'updated',
-            ['action' => 'admin_option_settings']
-        );
-    }
-
-
-    /*************        Countries        *************/
-
-
-    /**
-     * @param string|null $default
-     * @return string
-     */
-    protected function getCountryISO(?string $default = null): string
-    {
-        $default = $default ?? $this->getCountryIsoForSite();
-        $CNT_ISO = $this->request->getRequestParam('country', $default);
-        $CNT_ISO = $this->request->getRequestParam('CNT_ISO', $CNT_ISO);
-        return strtoupper($CNT_ISO);
-    }
-
-
-    /**
-     * @return string
-     */
-    protected function getCountryIsoForSite(): string
-    {
-        return ! empty(EE_Registry::instance()->CFG->organization->CNT_ISO)
-            ? EE_Registry::instance()->CFG->organization->CNT_ISO
-            : 'US';
-    }
-
-
-    /**
-     * @param string          $CNT_ISO
-     * @param EE_Country|null $country
-     * @return EE_Base_Class|EE_Country
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function verifyOrGetCountryFromIso(string $CNT_ISO, ?EE_Country $country = null)
-    {
-        /** @var EE_Country $country */
-        return $country instanceof EE_Country && $country->ID() === $CNT_ISO
-            ? $country
-            : EEM_Country::instance()->get_one_by_ID($CNT_ISO);
-    }
-
-
-    /**
-     * Output Country Settings view.
-     *
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _country_settings()
-    {
-        $CNT_ISO = $this->getCountryISO();
-
-        $this->_template_args['values']    = $this->_yes_no_values;
-        $this->_template_args['countries'] = new EE_Question_Form_Input(
-            EE_Question::new_instance(
-                [
-                  'QST_ID'           => 0,
-                  'QST_display_text' => esc_html__('Select Country', 'event_espresso'),
-                  'QST_system'       => 'admin-country',
-                ]
-            ),
-            EE_Answer::new_instance(
-                [
-                    'ANS_ID'    => 0,
-                    'ANS_value' => $CNT_ISO,
-                ]
-            ),
-            [
-                'input_id'       => 'country',
-                'input_name'     => 'country',
-                'input_prefix'   => '',
-                'append_qstn_id' => false,
-            ]
-        );
-
-        $country = $this->verifyOrGetCountryFromIso($CNT_ISO);
-        add_filter('FHEE__EEH_Form_Fields__label_html', [$this, 'country_form_field_label_wrap'], 10);
-        add_filter('FHEE__EEH_Form_Fields__input_html', [$this, 'country_form_field_input__wrap'], 10);
-        $this->_template_args['country_details_settings'] = $this->display_country_settings(
-            $country->ID(),
-            $country
-        );
-        $this->_template_args['country_states_settings']  = $this->display_country_states(
-            $country->ID(),
-            $country
-        );
-        $this->_template_args['CNT_name_for_site']        = $country->name();
-
-        $this->_set_add_edit_form_tags('update_country_settings');
-        $this->_set_publish_post_box_vars();
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            GEN_SET_TEMPLATE_PATH . 'countries_settings.template.php',
-            $this->_template_args,
-            true
-        );
-        $this->display_admin_page_with_no_sidebar();
-    }
-
-
-    /**
-     * @param string          $CNT_ISO
-     * @param EE_Country|null $country
-     * @return string
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function display_country_settings(string $CNT_ISO = '', ?EE_Country $country = null): string
-    {
-        $CNT_ISO          = $this->getCountryISO($CNT_ISO);
-        $CNT_ISO_for_site = $this->getCountryIsoForSite();
-
-        if (! $CNT_ISO) {
-            return '';
-        }
-
-        // for ajax
-        remove_all_filters('FHEE__EEH_Form_Fields__label_html');
-        remove_all_filters('FHEE__EEH_Form_Fields__input_html');
-        add_filter('FHEE__EEH_Form_Fields__label_html', [$this, 'country_form_field_label_wrap'], 10, 2);
-        add_filter('FHEE__EEH_Form_Fields__input_html', [$this, 'country_form_field_input__wrap'], 10, 2);
-        $country                                  = $this->verifyOrGetCountryFromIso($CNT_ISO, $country);
-        $CNT_cur_disabled                         = $CNT_ISO !== $CNT_ISO_for_site;
-        $this->_template_args['CNT_cur_disabled'] = $CNT_cur_disabled;
-
-        $country_input_types            = [
-            'CNT_active'      => [
-                'type'             => 'RADIO_BTN',
-                'input_name'       => "cntry[$CNT_ISO]",
-                'class'            => '',
-                'options'          => $this->_yes_no_values,
-                'use_desc_4_label' => true,
-            ],
-            'CNT_ISO'         => [
-                'type'       => 'TEXT',
-                'input_name' => "cntry[$CNT_ISO]",
-                'class'      => 'ee-input-width--small',
-            ],
-            'CNT_ISO3'        => [
-                'type'       => 'TEXT',
-                'input_name' => "cntry[$CNT_ISO]",
-                'class'      => 'ee-input-width--small',
-            ],
-            // 'RGN_ID'          => [
-            //     'type'       => 'TEXT',
-            //     'input_name' => "cntry[$CNT_ISO]",
-            //     'class'      => 'ee-input-width--small',
-            // ],
-            'CNT_name'        => [
-                'type'       => 'TEXT',
-                'input_name' => "cntry[$CNT_ISO]",
-                'class'      => 'ee-input-width--big',
-            ],
-            'CNT_cur_code'    => [
-                'type'       => 'TEXT',
-                'input_name' => "cntry[$CNT_ISO]",
-                'class'      => 'ee-input-width--small',
-                'disabled'   => $CNT_cur_disabled,
-            ],
-            'CNT_cur_single'  => [
-                'type'       => 'TEXT',
-                'input_name' => "cntry[$CNT_ISO]",
-                'class'      => 'ee-input-width--reg',
-                'disabled'   => $CNT_cur_disabled,
-            ],
-            'CNT_cur_plural'  => [
-                'type'       => 'TEXT',
-                'input_name' => "cntry[$CNT_ISO]",
-                'class'      => 'ee-input-width--reg',
-                'disabled'   => $CNT_cur_disabled,
-            ],
-            'CNT_cur_sign'    => [
-                'type'         => 'TEXT',
-                'input_name'   => "cntry[$CNT_ISO]",
-                'class'        => 'ee-input-width--small',
-                'htmlentities' => false,
-                'disabled'     => $CNT_cur_disabled,
-            ],
-            'CNT_cur_sign_b4' => [
-                'type'             => 'RADIO_BTN',
-                'input_name'       => "cntry[$CNT_ISO]",
-                'class'            => '',
-                'options'          => $this->_yes_no_values,
-                'use_desc_4_label' => true,
-                'disabled'         => $CNT_cur_disabled,
-            ],
-            'CNT_cur_dec_plc' => [
-                'type'       => 'RADIO_BTN',
-                'input_name' => "cntry[$CNT_ISO]",
-                'class'      => '',
-                'options'    => [
-                    ['id' => 0, 'text' => ''],
-                    ['id' => 1, 'text' => ''],
-                    ['id' => 2, 'text' => ''],
-                    ['id' => 3, 'text' => ''],
-                ],
-                'disabled'   => $CNT_cur_disabled,
-            ],
-            'CNT_cur_dec_mrk' => [
-                'type'             => 'RADIO_BTN',
-                'input_name'       => "cntry[$CNT_ISO]",
-                'class'            => '',
-                'options'          => [
-                    [
-                        'id'   => ',',
-                        'text' => esc_html__(', (comma)', 'event_espresso'),
-                    ],
-                    ['id' => '.', 'text' => esc_html__('. (decimal)', 'event_espresso')],
-                ],
-                'use_desc_4_label' => true,
-                'disabled'         => $CNT_cur_disabled,
-            ],
-            'CNT_cur_thsnds'  => [
-                'type'             => 'RADIO_BTN',
-                'input_name'       => "cntry[$CNT_ISO]",
-                'class'            => '',
-                'options'          => [
-                    [
-                        'id'   => ',',
-                        'text' => esc_html__(', (comma)', 'event_espresso'),
-                    ],
-                    [
-                        'id'   => '.',
-                        'text' => esc_html__('. (decimal)', 'event_espresso'),
-                    ],
-                    [
-                        'id'   => ' ',
-                        'text' => esc_html__('(space)', 'event_espresso'),
-                    ],
-                    [
-                        'id'   => '_',
-                        'text' => esc_html__('_ (underscore)', 'event_espresso'),
-                    ],
-                    [
-                        'id'   => "'",
-                        'text' => esc_html__("' (apostrophe)", 'event_espresso'),
-                    ],
-                    [
-                        'id'   => "",
-                        'text' => esc_html__(" (nothing)", 'event_espresso'),
-                    ],
-                ],
-                'use_desc_4_label' => true,
-                'disabled'         => $CNT_cur_disabled,
-            ],
-            'CNT_tel_code'    => [
-                'type'       => 'TEXT',
-                'input_name' => "cntry[$CNT_ISO]",
-                'class'      => 'ee-input-width--small',
-            ],
-            'CNT_is_EU'       => [
-                'type'             => 'RADIO_BTN',
-                'input_name'       => "cntry[$CNT_ISO]",
-                'class'            => '',
-                'options'          => $this->_yes_no_values,
-                'use_desc_4_label' => true,
-            ],
-        ];
-        $this->_template_args['inputs'] = EE_Question_Form_Input::generate_question_form_inputs_for_object(
-            $country,
-            $country_input_types
-        );
-        $country_details_settings       = EEH_Template::display_template(
-            GEN_SET_TEMPLATE_PATH . 'country_details_settings.template.php',
-            $this->_template_args,
-            true
-        );
-
-        if (defined('DOING_AJAX')) {
-            $notices = EE_Error::get_notices(false, false, false);
-            echo wp_json_encode(
-                [
-                    'return_data' => $country_details_settings,
-                    'success'     => $notices['success'],
-                    'errors'      => $notices['errors'],
-                ]
-            );
-            die();
-        }
-        return $country_details_settings;
-    }
-
-
-    /**
-     * @param string          $CNT_ISO
-     * @param EE_Country|null $country
-     * @return string
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function display_country_states(string $CNT_ISO = '', ?EE_Country $country = null): string
-    {
-        $CNT_ISO = $this->getCountryISO($CNT_ISO);
-        if (! $CNT_ISO) {
-            return '';
-        }
-        // for ajax
-        remove_all_filters('FHEE__EEH_Form_Fields__label_html');
-        remove_all_filters('FHEE__EEH_Form_Fields__input_html');
-        add_filter('FHEE__EEH_Form_Fields__label_html', [$this, 'state_form_field_label_wrap'], 10, 2);
-        add_filter('FHEE__EEH_Form_Fields__input_html', [$this, 'state_form_field_input__wrap'], 10);
-        $states = EEM_State::instance()->get_all_states_for_these_countries([$CNT_ISO => $CNT_ISO]);
-        if (empty($states)) {
-            /** @var EventEspresso\core\services\address\CountrySubRegionDao $countrySubRegionDao */
-            $countrySubRegionDao = $this->loader->getShared(
-                'EventEspresso\core\services\address\CountrySubRegionDao'
-            );
-            if ($countrySubRegionDao instanceof EventEspresso\core\services\address\CountrySubRegionDao) {
-                $country = $this->verifyOrGetCountryFromIso($CNT_ISO, $country);
-                if ($countrySubRegionDao->saveCountrySubRegions($country)) {
-                    $states = EEM_State::instance()->get_all_states_for_these_countries([$CNT_ISO => $CNT_ISO]);
-                }
-            }
-        }
-        foreach ($states as $STA_ID => $state) {
-            if ($state instanceof EE_State) {
-                $inputs = EE_Question_Form_Input::generate_question_form_inputs_for_object(
-                    $state,
-                    [
-                        'STA_abbrev' => [
-                            'type'             => 'TEXT',
-                            'label'            => esc_html__('Code', 'event_espresso'),
-                            'input_name'       => "states[$STA_ID]",
-                            'class'            => 'ee-input-width--tiny',
-                            'add_mobile_label' => true,
-                        ],
-                        'STA_name'   => [
-                            'type'             => 'TEXT',
-                            'label'            => esc_html__('Name', 'event_espresso'),
-                            'input_name'       => "states[$STA_ID]",
-                            'class'            => 'ee-input-width--big',
-                            'add_mobile_label' => true,
-                        ],
-                        'STA_active' => [
-                            'type'             => 'RADIO_BTN',
-                            'label'            => esc_html__(
-                                'State Appears in Dropdown Select Lists',
-                                'event_espresso'
-                            ),
-                            'input_name'       => "states[$STA_ID]",
-                            'options'          => $this->_yes_no_values,
-                            'use_desc_4_label' => true,
-                            'add_mobile_label' => true,
-                        ],
-                    ]
-                );
-
-                $delete_state_url = EE_Admin_Page::add_query_args_and_nonce(
-                    [
-                        'action'     => 'delete_state',
-                        'STA_ID'     => $STA_ID,
-                        'CNT_ISO'    => $CNT_ISO,
-                        'STA_abbrev' => $state->abbrev(),
-                    ],
-                    GEN_SET_ADMIN_URL
-                );
-
-                $this->_template_args['states'][ $STA_ID ]['inputs']           = $inputs;
-                $this->_template_args['states'][ $STA_ID ]['delete_state_url'] = $delete_state_url;
-            }
-        }
-
-        $this->_template_args['add_new_state_nonce'] = wp_create_nonce('espresso_add_new_state');
-        $this->_template_args['delete_state_nonce'] = wp_create_nonce('espresso_delete_state');
-
-        $state_details_settings = EEH_Template::display_template(
-            GEN_SET_TEMPLATE_PATH . 'state_details_settings.template.php',
-            $this->_template_args,
-            true
-        );
-
-        if (defined('DOING_AJAX')) {
-            $notices = EE_Error::get_notices(false, false, false);
-            echo wp_json_encode(
-                [
-                    'return_data' => $state_details_settings,
-                    'success'     => $notices['success'],
-                    'errors'      => $notices['errors'],
-                ]
-            );
-            die();
-        }
-        return $state_details_settings;
-    }
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function add_new_state()
-    {
-        $this->_verify_nonce();
-        // add_new_state_nonce
-        if (! $this->capabilities->current_user_can('manage_options', __FUNCTION__)) {
-            wp_die(esc_html__('You do not have the required privileges to perform this action', 'event_espresso'));
-        }
-
-        $success = true;
-        $CNT_ISO = $this->getCountryISO('');
-        if (! $CNT_ISO) {
-            EE_Error::add_error(
-                esc_html__('No Country ISO code or an invalid Country ISO code was received.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $success = false;
-        }
-        $STA_abbrev = $this->request->getRequestParam('STA_abbrev');
-        if (! $STA_abbrev) {
-            EE_Error::add_error(
-                esc_html__('No State ISO code or an invalid State ISO code was received.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $success = false;
-        }
-        $STA_name = $this->request->getRequestParam('STA_name');
-        if (! $STA_name) {
-            EE_Error::add_error(
-                esc_html__('No State name or an invalid State name was received.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $success = false;
-        }
-
-        if ($success) {
-            $cols_n_values = [
-                'CNT_ISO'    => $CNT_ISO,
-                'STA_abbrev' => $STA_abbrev,
-                'STA_name'   => $STA_name,
-                'STA_active' => true,
-            ];
-            $success       = EEM_State::instance()->insert($cols_n_values);
-            EE_Error::add_success(esc_html__('The State was added successfully.', 'event_espresso'));
-        }
-
-        if (defined('DOING_AJAX')) {
-            $notices = EE_Error::get_notices(false, false, false);
-            echo wp_json_encode(array_merge($notices, ['return_data' => $CNT_ISO]));
-            die();
-        }
-        $this->_redirect_after_action(
-            $success,
-            esc_html__('State', 'event_espresso'),
-            'added',
-            ['action' => 'country_settings']
-        );
-    }
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function delete_state()
-    {
-        $this->_verify_nonce();
-        if (! $this->capabilities->current_user_can('manage_options', __FUNCTION__)) {
-            wp_die(esc_html__('You do not have the required privileges to perform this action', 'event_espresso'));
-        }
-
-        $CNT_ISO    = $this->getCountryISO();
-        $STA_ID     = $this->request->getRequestParam('STA_ID');
-        $STA_abbrev = $this->request->getRequestParam('STA_abbrev');
-
-        if (! $STA_ID) {
-            EE_Error::add_error(
-                esc_html__('No State ID or an invalid State ID was received.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return;
-        }
-
-        $success = EEM_State::instance()->delete_by_ID($STA_ID);
-        if ($success !== false) {
-            do_action(
-                'AHEE__General_Settings_Admin_Page__delete_state__state_deleted',
-                $CNT_ISO,
-                $STA_ID,
-                ['STA_abbrev' => $STA_abbrev]
-            );
-            EE_Error::add_success(esc_html__('The State was deleted successfully.', 'event_espresso'));
-        }
-        if (defined('DOING_AJAX')) {
-            $notices                = EE_Error::get_notices(false);
-            $notices['return_data'] = true;
-            echo wp_json_encode($notices);
-            die();
-        }
-        $this->_redirect_after_action(
-            $success,
-            esc_html__('State', 'event_espresso'),
-            'deleted',
-            ['action' => 'country_settings']
-        );
-    }
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _update_country_settings()
-    {
-        $CNT_ISO = $this->getCountryISO();
-        if (! $CNT_ISO) {
-            EE_Error::add_error(
-                esc_html__('No Country ISO code or an invalid Country ISO code was received.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return;
-        }
-
-        $country = $this->verifyOrGetCountryFromIso($CNT_ISO);
-
-        $cols_n_values                    = [];
-        $cols_n_values['CNT_ISO3']        = strtoupper(
-            $this->request->getRequestParam(
-                "cntry[$CNT_ISO][CNT_ISO3]",
-                $country->ISO3()
-            )
-        );
-        $cols_n_values['CNT_name']        = $this->request->getRequestParam(
-            "cntry[$CNT_ISO][CNT_name]",
-            $country->name()
-        );
-        $cols_n_values['CNT_cur_code']    = strtoupper(
-            $this->request->getRequestParam(
-                "cntry[$CNT_ISO][CNT_cur_code]",
-                $country->currency_code()
-            )
-        );
-        $cols_n_values['CNT_cur_single']  = $this->request->getRequestParam(
-            "cntry[$CNT_ISO][CNT_cur_single]",
-            $country->currency_name_single()
-        );
-        $cols_n_values['CNT_cur_plural']  = $this->request->getRequestParam(
-            "cntry[$CNT_ISO][CNT_cur_plural]",
-            $country->currency_name_plural()
-        );
-        $cols_n_values['CNT_cur_sign']    = $this->request->getRequestParam(
-            "cntry[$CNT_ISO][CNT_cur_sign]",
-            $country->currency_sign()
-        );
-        $cols_n_values['CNT_cur_sign_b4'] = $this->request->getRequestParam(
-            "cntry[$CNT_ISO][CNT_cur_sign_b4]",
-            $country->currency_sign_before(),
-            DataType::BOOL
-        );
-        $cols_n_values['CNT_cur_dec_plc'] = $this->request->getRequestParam(
-            "cntry[$CNT_ISO][CNT_cur_dec_plc]",
-            $country->currency_decimal_places()
-        );
-        $cols_n_values['CNT_cur_dec_mrk'] = $this->request->getRequestParam(
-            "cntry[$CNT_ISO][CNT_cur_dec_mrk]",
-            $country->currency_decimal_mark()
-        );
-        $cols_n_values['CNT_cur_thsnds']  = $this->request->getRequestParam(
-            "cntry[$CNT_ISO][CNT_cur_thsnds]",
-            $country->currency_thousands_separator()
-        );
-        $cols_n_values['CNT_tel_code']    = $this->request->getRequestParam(
-            "cntry[$CNT_ISO][CNT_tel_code]",
-            $country->telephoneCode()
-        );
-        $cols_n_values['CNT_active']      = $this->request->getRequestParam(
-            "cntry[$CNT_ISO][CNT_active]",
-            $country->isActive(),
-            DataType::BOOL
-        );
-        $cols_n_values['CNT_is_EU']      = $this->request->getRequestParam(
-            "cntry[$CNT_ISO][CNT_is_EU]",
-            $country->isEU(),
-            DataType::BOOL
-        );
-
-        // allow filtering of country data
-        $cols_n_values = apply_filters(
-            'FHEE__General_Settings_Admin_Page___update_country_settings__cols_n_values',
-            $cols_n_values
-        );
-
-        // where values
-        $where_cols_n_values = [['CNT_ISO' => $CNT_ISO]];
-        // run the update
-        $success = EEM_Country::instance()->update($cols_n_values, $where_cols_n_values);
-
-        // allow filtering of states data
-        $states = apply_filters(
-            'FHEE__General_Settings_Admin_Page___update_country_settings__states',
-            $this->request->getRequestParam('states', [], DataType::STRING, true)
-        );
-
-        if (! empty($states) && $success !== false) {
-            // loop thru state data ( looks like : states[75][STA_name] )
-            foreach ($states as $STA_ID => $state) {
-                $cols_n_values = [
-                    'CNT_ISO'    => $CNT_ISO,
-                    'STA_abbrev' => sanitize_text_field($state['STA_abbrev']),
-                    'STA_name'   => sanitize_text_field($state['STA_name']),
-                    'STA_active' => filter_var($state['STA_active'], FILTER_VALIDATE_BOOLEAN),
-                ];
-                // where values
-                $where_cols_n_values = [['STA_ID' => $STA_ID]];
-                // run the update
-                $success = EEM_State::instance()->update($cols_n_values, $where_cols_n_values);
-                if ($success !== false) {
-                    do_action(
-                        'AHEE__General_Settings_Admin_Page__update_country_settings__state_saved',
-                        $CNT_ISO,
-                        $STA_ID,
-                        $cols_n_values
-                    );
-                }
-            }
-        }
-        // check if country being edited matches org option country, and if so, then  update EE_Config with new settings
-        if (
-            isset(EE_Registry::instance()->CFG->organization->CNT_ISO)
-            && $CNT_ISO == EE_Registry::instance()->CFG->organization->CNT_ISO
-        ) {
-            EE_Registry::instance()->CFG->currency = new EE_Currency_Config($CNT_ISO);
-            EE_Registry::instance()->CFG->update_espresso_config();
-        }
-
-        if ($success !== false) {
-            EE_Error::add_success(
-                esc_html__('Country Settings updated successfully.', 'event_espresso')
-            );
-        }
-        $this->_redirect_after_action(
-            $success,
-            '',
-            '',
-            ['action' => 'country_settings', 'country' => $CNT_ISO],
-            true
-        );
-    }
-
-
-    /**
-     * form_form_field_label_wrap
-     *
-     * @param string $label
-     * @return string
-     */
-    public function country_form_field_label_wrap(string $label): string
-    {
-        return '
+	/**
+	 * @var EE_Core_Config
+	 */
+	public $core_config;
+
+
+	/**
+	 * Initialize basic properties.
+	 */
+	protected function _init_page_props()
+	{
+		$this->page_slug        = GEN_SET_PG_SLUG;
+		$this->page_label       = GEN_SET_LABEL;
+		$this->_admin_base_url  = GEN_SET_ADMIN_URL;
+		$this->_admin_base_path = GEN_SET_ADMIN;
+
+		$this->core_config = EE_Registry::instance()->CFG->core;
+	}
+
+
+	/**
+	 * Set ajax hooks
+	 */
+	protected function _ajax_hooks()
+	{
+		add_action('wp_ajax_espresso_display_country_settings', [$this, 'display_country_settings']);
+		add_action('wp_ajax_espresso_display_country_states', [$this, 'display_country_states']);
+		add_action('wp_ajax_espresso_delete_state', [$this, 'delete_state'], 10, 3);
+		add_action('wp_ajax_espresso_add_new_state', [$this, 'add_new_state']);
+	}
+
+
+	/**
+	 * More page properties initialization.
+	 */
+	protected function _define_page_props()
+	{
+		$this->_admin_page_title = GEN_SET_LABEL;
+		$this->_labels           = ['publishbox' => esc_html__('Update Settings', 'event_espresso')];
+	}
+
+
+	/**
+	 * Set page routes property.
+	 */
+	protected function _set_page_routes()
+	{
+		$this->_page_routes = [
+			'critical_pages'                => [
+				'func'       => [$this, '_espresso_page_settings'],
+				'capability' => 'manage_options',
+			],
+			'update_espresso_page_settings' => [
+				'func'       => [$this, '_update_espresso_page_settings'],
+				'capability' => 'manage_options',
+				'noheader'   => true,
+			],
+			'default'                       => [
+				'func'       => [$this, '_your_organization_settings'],
+				'capability' => 'manage_options',
+			],
+
+			'update_your_organization_settings' => [
+				'func'       => [$this, '_update_your_organization_settings'],
+				'capability' => 'manage_options',
+				'noheader'   => true,
+			],
+
+			'admin_option_settings' => [
+				'func'       => [$this, '_admin_option_settings'],
+				'capability' => 'manage_options',
+			],
+
+			'update_admin_option_settings' => [
+				'func'       => [$this, '_update_admin_option_settings'],
+				'capability' => 'manage_options',
+				'noheader'   => true,
+			],
+
+			'country_settings' => [
+				'func'       => [$this, '_country_settings'],
+				'capability' => 'manage_options',
+			],
+
+			'update_country_settings' => [
+				'func'          => [$this, '_update_country_settings'],
+				'capability'    => 'manage_options',
+				'noheader'      => true,
+				'require_nonce' => true,
+			],
+
+			'display_country_settings' => [
+				'func'       => [$this, 'display_country_settings'],
+				'capability' => 'manage_options',
+				'noheader'   => true,
+			],
+
+			'add_new_state' => [
+				'func'          => [$this, 'add_new_state'],
+				'capability'    => 'manage_options',
+				'noheader'      => true,
+				'require_nonce' => true,
+			],
+
+			'delete_state' => [
+				'func'          => [$this, 'delete_state'],
+				'capability'    => 'manage_options',
+				'noheader'      => true,
+				'require_nonce' => true,
+			],
+
+			'privacy_settings' => [
+				'func'       => [$this, 'privacySettings'],
+				'capability' => 'manage_options',
+			],
+
+			'update_privacy_settings' => [
+				'func'               => [$this, 'updatePrivacySettings'],
+				'capability'         => 'manage_options',
+				'noheader'           => true,
+				'headers_sent_route' => 'privacy_settings',
+			],
+
+			'set_font_size'            => [
+				'func'       => [$this, 'setFontSize'],
+				'noheader'   => true,
+			],
+		];
+	}
+
+
+	/**
+	 * Set page configuration property
+	 */
+	protected function _set_page_config()
+	{
+		$this->_page_config = [
+			'critical_pages'        => [
+				'nav'           => [
+					'label' => esc_html__('Critical Pages', 'event_espresso'),
+					'icon' => 'dashicons-warning',
+					'order' => 50,
+				],
+				'metaboxes'     => array_merge($this->_default_espresso_metaboxes, ['_publish_post_box']),
+				'help_tabs'     => [
+					'general_settings_critical_pages_help_tab' => [
+						'title'    => esc_html__('Critical Pages', 'event_espresso'),
+						'filename' => 'general_settings_critical_pages',
+					],
+				],
+				'require_nonce' => false,
+			],
+			'default'               => [
+				'nav'           => [
+					'label' => esc_html__('Your Organization', 'event_espresso'),
+					'icon' => 'dashicons-admin-home',
+					'order' => 20,
+				],
+				'help_tabs'     => [
+					'general_settings_your_organization_help_tab' => [
+						'title'    => esc_html__('Your Organization', 'event_espresso'),
+						'filename' => 'general_settings_your_organization',
+					],
+				],
+				'metaboxes'     => array_merge($this->_default_espresso_metaboxes, ['_publish_post_box']),
+				'require_nonce' => false,
+			],
+			'admin_option_settings' => [
+				'nav'           => [
+					'label' => esc_html__('Admin Options', 'event_espresso'),
+					'icon' => 'dashicons-admin-settings',
+					'order' => 60,
+				],
+				'metaboxes'     => array_merge($this->_default_espresso_metaboxes, ['_publish_post_box']),
+				'help_tabs'     => [
+					'general_settings_admin_options_help_tab' => [
+						'title'    => esc_html__('Admin Options', 'event_espresso'),
+						'filename' => 'general_settings_admin_options',
+					],
+				],
+				'require_nonce' => false,
+			],
+			'country_settings'      => [
+				'nav'           => [
+					'label' => esc_html__('Countries', 'event_espresso'),
+					'icon' => 'dashicons-admin-site',
+					'order' => 70,
+				],
+				'help_tabs'     => [
+					'general_settings_countries_help_tab' => [
+						'title'    => esc_html__('Countries', 'event_espresso'),
+						'filename' => 'general_settings_countries',
+					],
+				],
+				'require_nonce' => false,
+			],
+			'privacy_settings'      => [
+				'nav'           => [
+					'label' => esc_html__('Privacy', 'event_espresso'),
+					'icon' => 'dashicons-privacy',
+					'order' => 80,
+				],
+				'metaboxes'     => array_merge($this->_default_espresso_metaboxes, ['_publish_post_box']),
+				'require_nonce' => false,
+			],
+		];
+	}
+
+
+	protected function _add_screen_options()
+	{
+	}
+
+
+	protected function _add_feature_pointers()
+	{
+	}
+
+
+	/**
+	 * Enqueue global scripts and styles for all routes in the General Settings Admin Pages.
+	 */
+	public function load_scripts_styles()
+	{
+		// styles
+		wp_enqueue_style('espresso-ui-theme');
+		// scripts
+		wp_enqueue_script('ee_admin_js');
+	}
+
+
+	/**
+	 * Execute logic running on `admin_init`
+	 */
+	public function admin_init()
+	{
+		EE_Registry::$i18n_js_strings['invalid_server_response'] = wp_strip_all_tags(
+			esc_html__(
+				'An error occurred! Your request may have been processed, but a valid response from the server was not received. Please refresh the page and try again.',
+				'event_espresso'
+			)
+		);
+		EE_Registry::$i18n_js_strings['error_occurred']          = wp_strip_all_tags(
+			esc_html__(
+				'An error occurred! Please refresh the page and try again.',
+				'event_espresso'
+			)
+		);
+		EE_Registry::$i18n_js_strings['confirm_delete_state']    = wp_strip_all_tags(
+			esc_html__(
+				'Are you sure you want to delete this State / Province?',
+				'event_espresso'
+			)
+		);
+		EE_Registry::$i18n_js_strings['ajax_url']                = admin_url(
+			'admin-ajax.php?page=espresso_general_settings',
+			is_ssl() ? 'https://' : 'http://'
+		);
+	}
+
+
+	public function admin_notices()
+	{
+	}
+
+
+	public function admin_footer_scripts()
+	{
+	}
+
+
+	/**
+	 * Enqueue scripts and styles for the default route.
+	 */
+	public function load_scripts_styles_default()
+	{
+		// styles
+		wp_enqueue_style('thickbox');
+		// scripts
+		wp_enqueue_script('media-upload');
+		wp_enqueue_script('thickbox');
+		wp_register_script(
+			'organization_settings',
+			GEN_SET_ASSETS_URL . 'your_organization_settings.js',
+			['jquery', 'media-upload', 'thickbox'],
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_register_style('organization-css', GEN_SET_ASSETS_URL . 'organization.css', [], EVENT_ESPRESSO_VERSION);
+		wp_enqueue_script('organization_settings');
+		wp_enqueue_style('organization-css');
+		$confirm_image_delete = [
+			'text' => wp_strip_all_tags(
+				esc_html__(
+					'Do you really want to delete this image? Please remember to save your settings to complete the removal.',
+					'event_espresso'
+				)
+			),
+		];
+		wp_localize_script('organization_settings', 'confirm_image_delete', $confirm_image_delete);
+	}
+
+
+	/**
+	 * Enqueue scripts and styles for the country settings route.
+	 */
+	public function load_scripts_styles_country_settings()
+	{
+		// scripts
+		wp_register_script(
+			'gen_settings_countries',
+			GEN_SET_ASSETS_URL . 'gen_settings_countries.js',
+			['ee_admin_js'],
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_register_style('organization-css', GEN_SET_ASSETS_URL . 'organization.css', [], EVENT_ESPRESSO_VERSION);
+		wp_enqueue_script('gen_settings_countries');
+		wp_enqueue_style('organization-css');
+	}
+
+
+	/*************        Espresso Pages        *************/
+	/**
+	 * _espresso_page_settings
+	 *
+	 * @throws EE_Error
+	 * @throws DomainException
+	 * @throws DomainException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidArgumentException
+	 */
+	protected function _espresso_page_settings()
+	{
+		// Check to make sure all of the main pages are set up properly,
+		// if not create the default pages and display an admin notice
+		EEH_Activation::verify_default_pages_exist();
+		$this->_transient_garbage_collection();
+
+		$this->_template_args['values'] = $this->_yes_no_values;
+
+		$this->_template_args['reg_page_id']  = $this->core_config->reg_page_id ?? null;
+		$this->_template_args['reg_page_obj'] = isset($this->core_config->reg_page_id)
+			? get_post($this->core_config->reg_page_id)
+			: false;
+
+		$this->_template_args['txn_page_id']  = $this->core_config->txn_page_id ?? null;
+		$this->_template_args['txn_page_obj'] = isset($this->core_config->txn_page_id)
+			? get_post($this->core_config->txn_page_id)
+			: false;
+
+		$this->_template_args['thank_you_page_id']  = $this->core_config->thank_you_page_id ?? null;
+		$this->_template_args['thank_you_page_obj'] = isset($this->core_config->thank_you_page_id)
+			? get_post($this->core_config->thank_you_page_id)
+			: false;
+
+		$this->_template_args['cancel_page_id']  = $this->core_config->cancel_page_id ?? null;
+		$this->_template_args['cancel_page_obj'] = isset($this->core_config->cancel_page_id)
+			? get_post($this->core_config->cancel_page_id)
+			: false;
+
+		$this->_set_add_edit_form_tags('update_espresso_page_settings');
+		$this->_set_publish_post_box_vars();
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(
+			GEN_SET_TEMPLATE_PATH . 'espresso_page_settings.template.php',
+			$this->_template_args,
+			true
+		);
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	/**
+	 * Handler for updating espresso page settings.
+	 *
+	 * @throws EE_Error
+	 */
+	protected function _update_espresso_page_settings()
+	{
+		$this->core_config = EE_Registry::instance()->CFG->core;
+		// capture incoming request data && set page IDs
+		$this->core_config->reg_page_id       = $this->request->getRequestParam(
+			'reg_page_id',
+			$this->core_config->reg_page_id,
+			DataType::INT
+		);
+		$this->core_config->txn_page_id       = $this->request->getRequestParam(
+			'txn_page_id',
+			$this->core_config->txn_page_id,
+			DataType::INT
+		);
+		$this->core_config->thank_you_page_id = $this->request->getRequestParam(
+			'thank_you_page_id',
+			$this->core_config->thank_you_page_id,
+			DataType::INT
+		);
+		$this->core_config->cancel_page_id    = $this->request->getRequestParam(
+			'cancel_page_id',
+			$this->core_config->cancel_page_id,
+			DataType::INT
+		);
+
+		$this->core_config = apply_filters(
+			'FHEE__General_Settings_Admin_Page___update_espresso_page_settings__CFG_core',
+			$this->core_config,
+			$this->request->requestParams()
+		);
+
+		$what = esc_html__('Critical Pages & Shortcodes', 'event_espresso');
+		$this->_redirect_after_action(
+			$this->_update_espresso_configuration(
+				$what,
+				$this->core_config,
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			),
+			$what,
+			'',
+			[
+				'action' => 'critical_pages',
+			],
+			true
+		);
+	}
+
+
+	/*************        Your Organization        *************/
+
+
+	/**
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _your_organization_settings()
+	{
+		$this->_template_args['admin_page_content'] = '';
+		try {
+			/** @var OrganizationSettings $organization_settings_form */
+			$organization_settings_form = $this->loader->getShared(OrganizationSettings::class);
+
+			$this->_template_args['admin_page_content'] = EEH_HTML::div(
+				$organization_settings_form->display(),
+				'',
+				'padding'
+			);
+		} catch (Exception $e) {
+			EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
+		}
+		$this->_set_add_edit_form_tags('update_your_organization_settings');
+		$this->_set_publish_post_box_vars();
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	/**
+	 * Handler for updating organization settings.
+	 *
+	 * @throws EE_Error
+	 */
+	protected function _update_your_organization_settings()
+	{
+		try {
+			/** @var OrganizationSettings $organization_settings_form */
+			$organization_settings_form = $this->loader->getShared(OrganizationSettings::class);
+
+			$success = $organization_settings_form->process($this->request->requestParams());
+
+			EE_Registry::instance()->CFG = apply_filters(
+				'FHEE__General_Settings_Admin_Page___update_your_organization_settings__CFG',
+				EE_Registry::instance()->CFG
+			);
+		} catch (Exception $e) {
+			EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
+			$success = false;
+		}
+
+		if ($success) {
+			$success = $this->_update_espresso_configuration(
+				esc_html__('Your Organization Settings', 'event_espresso'),
+				EE_Registry::instance()->CFG,
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+
+		$this->_redirect_after_action($success, '', '', ['action' => 'default'], true);
+	}
+
+
+
+	/*************        Admin Options        *************/
+
+
+	/**
+	 * _admin_option_settings
+	 *
+	 * @throws EE_Error
+	 * @throws LogicException
+	 */
+	protected function _admin_option_settings()
+	{
+		$this->_template_args['admin_page_content'] = '';
+		try {
+			$admin_options_settings_form = new AdminOptionsSettings(EE_Registry::instance());
+			// still need this for the old school form in Extend_General_Settings_Admin_Page
+			$this->_template_args['values'] = $this->_yes_no_values;
+			// also need to account for the do_action that was in the old template
+			$admin_options_settings_form->setTemplateArgs($this->_template_args);
+			$this->_template_args['admin_page_content'] = EEH_HTML::div(
+				$admin_options_settings_form->display(),
+				'',
+				'padding'
+			);
+		} catch (Exception $e) {
+			EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
+		}
+		$this->_set_add_edit_form_tags('update_admin_option_settings');
+		$this->_set_publish_post_box_vars();
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	/**
+	 * _update_admin_option_settings
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidFormSubmissionException
+	 * @throws InvalidArgumentException
+	 * @throws LogicException
+	 */
+	protected function _update_admin_option_settings()
+	{
+		try {
+			$admin_options_settings_form = new AdminOptionsSettings(EE_Registry::instance());
+			$admin_options_settings_form->process(
+				$this->request->getRequestParam(
+					$admin_options_settings_form->slug(),
+					[],
+					DataType::STRING,
+					true
+				)
+			);
+			EE_Registry::instance()->CFG->admin = apply_filters(
+				'FHEE__General_Settings_Admin_Page___update_admin_option_settings__CFG_admin',
+				EE_Registry::instance()->CFG->admin
+			);
+		} catch (Exception $e) {
+			EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
+		}
+		$this->_redirect_after_action(
+			apply_filters(
+				'FHEE__General_Settings_Admin_Page___update_admin_option_settings__success',
+				$this->_update_espresso_configuration(
+					esc_html__('Admin Options', 'event_espresso'),
+					EE_Registry::instance()->CFG->admin,
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				)
+			),
+			esc_html__('Admin Options', 'event_espresso'),
+			'updated',
+			['action' => 'admin_option_settings']
+		);
+	}
+
+
+	/*************        Countries        *************/
+
+
+	/**
+	 * @param string|null $default
+	 * @return string
+	 */
+	protected function getCountryISO(?string $default = null): string
+	{
+		$default = $default ?? $this->getCountryIsoForSite();
+		$CNT_ISO = $this->request->getRequestParam('country', $default);
+		$CNT_ISO = $this->request->getRequestParam('CNT_ISO', $CNT_ISO);
+		return strtoupper($CNT_ISO);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	protected function getCountryIsoForSite(): string
+	{
+		return ! empty(EE_Registry::instance()->CFG->organization->CNT_ISO)
+			? EE_Registry::instance()->CFG->organization->CNT_ISO
+			: 'US';
+	}
+
+
+	/**
+	 * @param string          $CNT_ISO
+	 * @param EE_Country|null $country
+	 * @return EE_Base_Class|EE_Country
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function verifyOrGetCountryFromIso(string $CNT_ISO, ?EE_Country $country = null)
+	{
+		/** @var EE_Country $country */
+		return $country instanceof EE_Country && $country->ID() === $CNT_ISO
+			? $country
+			: EEM_Country::instance()->get_one_by_ID($CNT_ISO);
+	}
+
+
+	/**
+	 * Output Country Settings view.
+	 *
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _country_settings()
+	{
+		$CNT_ISO = $this->getCountryISO();
+
+		$this->_template_args['values']    = $this->_yes_no_values;
+		$this->_template_args['countries'] = new EE_Question_Form_Input(
+			EE_Question::new_instance(
+				[
+				  'QST_ID'           => 0,
+				  'QST_display_text' => esc_html__('Select Country', 'event_espresso'),
+				  'QST_system'       => 'admin-country',
+				]
+			),
+			EE_Answer::new_instance(
+				[
+					'ANS_ID'    => 0,
+					'ANS_value' => $CNT_ISO,
+				]
+			),
+			[
+				'input_id'       => 'country',
+				'input_name'     => 'country',
+				'input_prefix'   => '',
+				'append_qstn_id' => false,
+			]
+		);
+
+		$country = $this->verifyOrGetCountryFromIso($CNT_ISO);
+		add_filter('FHEE__EEH_Form_Fields__label_html', [$this, 'country_form_field_label_wrap'], 10);
+		add_filter('FHEE__EEH_Form_Fields__input_html', [$this, 'country_form_field_input__wrap'], 10);
+		$this->_template_args['country_details_settings'] = $this->display_country_settings(
+			$country->ID(),
+			$country
+		);
+		$this->_template_args['country_states_settings']  = $this->display_country_states(
+			$country->ID(),
+			$country
+		);
+		$this->_template_args['CNT_name_for_site']        = $country->name();
+
+		$this->_set_add_edit_form_tags('update_country_settings');
+		$this->_set_publish_post_box_vars();
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(
+			GEN_SET_TEMPLATE_PATH . 'countries_settings.template.php',
+			$this->_template_args,
+			true
+		);
+		$this->display_admin_page_with_no_sidebar();
+	}
+
+
+	/**
+	 * @param string          $CNT_ISO
+	 * @param EE_Country|null $country
+	 * @return string
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function display_country_settings(string $CNT_ISO = '', ?EE_Country $country = null): string
+	{
+		$CNT_ISO          = $this->getCountryISO($CNT_ISO);
+		$CNT_ISO_for_site = $this->getCountryIsoForSite();
+
+		if (! $CNT_ISO) {
+			return '';
+		}
+
+		// for ajax
+		remove_all_filters('FHEE__EEH_Form_Fields__label_html');
+		remove_all_filters('FHEE__EEH_Form_Fields__input_html');
+		add_filter('FHEE__EEH_Form_Fields__label_html', [$this, 'country_form_field_label_wrap'], 10, 2);
+		add_filter('FHEE__EEH_Form_Fields__input_html', [$this, 'country_form_field_input__wrap'], 10, 2);
+		$country                                  = $this->verifyOrGetCountryFromIso($CNT_ISO, $country);
+		$CNT_cur_disabled                         = $CNT_ISO !== $CNT_ISO_for_site;
+		$this->_template_args['CNT_cur_disabled'] = $CNT_cur_disabled;
+
+		$country_input_types            = [
+			'CNT_active'      => [
+				'type'             => 'RADIO_BTN',
+				'input_name'       => "cntry[$CNT_ISO]",
+				'class'            => '',
+				'options'          => $this->_yes_no_values,
+				'use_desc_4_label' => true,
+			],
+			'CNT_ISO'         => [
+				'type'       => 'TEXT',
+				'input_name' => "cntry[$CNT_ISO]",
+				'class'      => 'ee-input-width--small',
+			],
+			'CNT_ISO3'        => [
+				'type'       => 'TEXT',
+				'input_name' => "cntry[$CNT_ISO]",
+				'class'      => 'ee-input-width--small',
+			],
+			// 'RGN_ID'          => [
+			//     'type'       => 'TEXT',
+			//     'input_name' => "cntry[$CNT_ISO]",
+			//     'class'      => 'ee-input-width--small',
+			// ],
+			'CNT_name'        => [
+				'type'       => 'TEXT',
+				'input_name' => "cntry[$CNT_ISO]",
+				'class'      => 'ee-input-width--big',
+			],
+			'CNT_cur_code'    => [
+				'type'       => 'TEXT',
+				'input_name' => "cntry[$CNT_ISO]",
+				'class'      => 'ee-input-width--small',
+				'disabled'   => $CNT_cur_disabled,
+			],
+			'CNT_cur_single'  => [
+				'type'       => 'TEXT',
+				'input_name' => "cntry[$CNT_ISO]",
+				'class'      => 'ee-input-width--reg',
+				'disabled'   => $CNT_cur_disabled,
+			],
+			'CNT_cur_plural'  => [
+				'type'       => 'TEXT',
+				'input_name' => "cntry[$CNT_ISO]",
+				'class'      => 'ee-input-width--reg',
+				'disabled'   => $CNT_cur_disabled,
+			],
+			'CNT_cur_sign'    => [
+				'type'         => 'TEXT',
+				'input_name'   => "cntry[$CNT_ISO]",
+				'class'        => 'ee-input-width--small',
+				'htmlentities' => false,
+				'disabled'     => $CNT_cur_disabled,
+			],
+			'CNT_cur_sign_b4' => [
+				'type'             => 'RADIO_BTN',
+				'input_name'       => "cntry[$CNT_ISO]",
+				'class'            => '',
+				'options'          => $this->_yes_no_values,
+				'use_desc_4_label' => true,
+				'disabled'         => $CNT_cur_disabled,
+			],
+			'CNT_cur_dec_plc' => [
+				'type'       => 'RADIO_BTN',
+				'input_name' => "cntry[$CNT_ISO]",
+				'class'      => '',
+				'options'    => [
+					['id' => 0, 'text' => ''],
+					['id' => 1, 'text' => ''],
+					['id' => 2, 'text' => ''],
+					['id' => 3, 'text' => ''],
+				],
+				'disabled'   => $CNT_cur_disabled,
+			],
+			'CNT_cur_dec_mrk' => [
+				'type'             => 'RADIO_BTN',
+				'input_name'       => "cntry[$CNT_ISO]",
+				'class'            => '',
+				'options'          => [
+					[
+						'id'   => ',',
+						'text' => esc_html__(', (comma)', 'event_espresso'),
+					],
+					['id' => '.', 'text' => esc_html__('. (decimal)', 'event_espresso')],
+				],
+				'use_desc_4_label' => true,
+				'disabled'         => $CNT_cur_disabled,
+			],
+			'CNT_cur_thsnds'  => [
+				'type'             => 'RADIO_BTN',
+				'input_name'       => "cntry[$CNT_ISO]",
+				'class'            => '',
+				'options'          => [
+					[
+						'id'   => ',',
+						'text' => esc_html__(', (comma)', 'event_espresso'),
+					],
+					[
+						'id'   => '.',
+						'text' => esc_html__('. (decimal)', 'event_espresso'),
+					],
+					[
+						'id'   => ' ',
+						'text' => esc_html__('(space)', 'event_espresso'),
+					],
+					[
+						'id'   => '_',
+						'text' => esc_html__('_ (underscore)', 'event_espresso'),
+					],
+					[
+						'id'   => "'",
+						'text' => esc_html__("' (apostrophe)", 'event_espresso'),
+					],
+					[
+						'id'   => "",
+						'text' => esc_html__(" (nothing)", 'event_espresso'),
+					],
+				],
+				'use_desc_4_label' => true,
+				'disabled'         => $CNT_cur_disabled,
+			],
+			'CNT_tel_code'    => [
+				'type'       => 'TEXT',
+				'input_name' => "cntry[$CNT_ISO]",
+				'class'      => 'ee-input-width--small',
+			],
+			'CNT_is_EU'       => [
+				'type'             => 'RADIO_BTN',
+				'input_name'       => "cntry[$CNT_ISO]",
+				'class'            => '',
+				'options'          => $this->_yes_no_values,
+				'use_desc_4_label' => true,
+			],
+		];
+		$this->_template_args['inputs'] = EE_Question_Form_Input::generate_question_form_inputs_for_object(
+			$country,
+			$country_input_types
+		);
+		$country_details_settings       = EEH_Template::display_template(
+			GEN_SET_TEMPLATE_PATH . 'country_details_settings.template.php',
+			$this->_template_args,
+			true
+		);
+
+		if (defined('DOING_AJAX')) {
+			$notices = EE_Error::get_notices(false, false, false);
+			echo wp_json_encode(
+				[
+					'return_data' => $country_details_settings,
+					'success'     => $notices['success'],
+					'errors'      => $notices['errors'],
+				]
+			);
+			die();
+		}
+		return $country_details_settings;
+	}
+
+
+	/**
+	 * @param string          $CNT_ISO
+	 * @param EE_Country|null $country
+	 * @return string
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function display_country_states(string $CNT_ISO = '', ?EE_Country $country = null): string
+	{
+		$CNT_ISO = $this->getCountryISO($CNT_ISO);
+		if (! $CNT_ISO) {
+			return '';
+		}
+		// for ajax
+		remove_all_filters('FHEE__EEH_Form_Fields__label_html');
+		remove_all_filters('FHEE__EEH_Form_Fields__input_html');
+		add_filter('FHEE__EEH_Form_Fields__label_html', [$this, 'state_form_field_label_wrap'], 10, 2);
+		add_filter('FHEE__EEH_Form_Fields__input_html', [$this, 'state_form_field_input__wrap'], 10);
+		$states = EEM_State::instance()->get_all_states_for_these_countries([$CNT_ISO => $CNT_ISO]);
+		if (empty($states)) {
+			/** @var EventEspresso\core\services\address\CountrySubRegionDao $countrySubRegionDao */
+			$countrySubRegionDao = $this->loader->getShared(
+				'EventEspresso\core\services\address\CountrySubRegionDao'
+			);
+			if ($countrySubRegionDao instanceof EventEspresso\core\services\address\CountrySubRegionDao) {
+				$country = $this->verifyOrGetCountryFromIso($CNT_ISO, $country);
+				if ($countrySubRegionDao->saveCountrySubRegions($country)) {
+					$states = EEM_State::instance()->get_all_states_for_these_countries([$CNT_ISO => $CNT_ISO]);
+				}
+			}
+		}
+		foreach ($states as $STA_ID => $state) {
+			if ($state instanceof EE_State) {
+				$inputs = EE_Question_Form_Input::generate_question_form_inputs_for_object(
+					$state,
+					[
+						'STA_abbrev' => [
+							'type'             => 'TEXT',
+							'label'            => esc_html__('Code', 'event_espresso'),
+							'input_name'       => "states[$STA_ID]",
+							'class'            => 'ee-input-width--tiny',
+							'add_mobile_label' => true,
+						],
+						'STA_name'   => [
+							'type'             => 'TEXT',
+							'label'            => esc_html__('Name', 'event_espresso'),
+							'input_name'       => "states[$STA_ID]",
+							'class'            => 'ee-input-width--big',
+							'add_mobile_label' => true,
+						],
+						'STA_active' => [
+							'type'             => 'RADIO_BTN',
+							'label'            => esc_html__(
+								'State Appears in Dropdown Select Lists',
+								'event_espresso'
+							),
+							'input_name'       => "states[$STA_ID]",
+							'options'          => $this->_yes_no_values,
+							'use_desc_4_label' => true,
+							'add_mobile_label' => true,
+						],
+					]
+				);
+
+				$delete_state_url = EE_Admin_Page::add_query_args_and_nonce(
+					[
+						'action'     => 'delete_state',
+						'STA_ID'     => $STA_ID,
+						'CNT_ISO'    => $CNT_ISO,
+						'STA_abbrev' => $state->abbrev(),
+					],
+					GEN_SET_ADMIN_URL
+				);
+
+				$this->_template_args['states'][ $STA_ID ]['inputs']           = $inputs;
+				$this->_template_args['states'][ $STA_ID ]['delete_state_url'] = $delete_state_url;
+			}
+		}
+
+		$this->_template_args['add_new_state_nonce'] = wp_create_nonce('espresso_add_new_state');
+		$this->_template_args['delete_state_nonce'] = wp_create_nonce('espresso_delete_state');
+
+		$state_details_settings = EEH_Template::display_template(
+			GEN_SET_TEMPLATE_PATH . 'state_details_settings.template.php',
+			$this->_template_args,
+			true
+		);
+
+		if (defined('DOING_AJAX')) {
+			$notices = EE_Error::get_notices(false, false, false);
+			echo wp_json_encode(
+				[
+					'return_data' => $state_details_settings,
+					'success'     => $notices['success'],
+					'errors'      => $notices['errors'],
+				]
+			);
+			die();
+		}
+		return $state_details_settings;
+	}
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function add_new_state()
+	{
+		$this->_verify_nonce();
+		// add_new_state_nonce
+		if (! $this->capabilities->current_user_can('manage_options', __FUNCTION__)) {
+			wp_die(esc_html__('You do not have the required privileges to perform this action', 'event_espresso'));
+		}
+
+		$success = true;
+		$CNT_ISO = $this->getCountryISO('');
+		if (! $CNT_ISO) {
+			EE_Error::add_error(
+				esc_html__('No Country ISO code or an invalid Country ISO code was received.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$success = false;
+		}
+		$STA_abbrev = $this->request->getRequestParam('STA_abbrev');
+		if (! $STA_abbrev) {
+			EE_Error::add_error(
+				esc_html__('No State ISO code or an invalid State ISO code was received.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$success = false;
+		}
+		$STA_name = $this->request->getRequestParam('STA_name');
+		if (! $STA_name) {
+			EE_Error::add_error(
+				esc_html__('No State name or an invalid State name was received.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$success = false;
+		}
+
+		if ($success) {
+			$cols_n_values = [
+				'CNT_ISO'    => $CNT_ISO,
+				'STA_abbrev' => $STA_abbrev,
+				'STA_name'   => $STA_name,
+				'STA_active' => true,
+			];
+			$success       = EEM_State::instance()->insert($cols_n_values);
+			EE_Error::add_success(esc_html__('The State was added successfully.', 'event_espresso'));
+		}
+
+		if (defined('DOING_AJAX')) {
+			$notices = EE_Error::get_notices(false, false, false);
+			echo wp_json_encode(array_merge($notices, ['return_data' => $CNT_ISO]));
+			die();
+		}
+		$this->_redirect_after_action(
+			$success,
+			esc_html__('State', 'event_espresso'),
+			'added',
+			['action' => 'country_settings']
+		);
+	}
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function delete_state()
+	{
+		$this->_verify_nonce();
+		if (! $this->capabilities->current_user_can('manage_options', __FUNCTION__)) {
+			wp_die(esc_html__('You do not have the required privileges to perform this action', 'event_espresso'));
+		}
+
+		$CNT_ISO    = $this->getCountryISO();
+		$STA_ID     = $this->request->getRequestParam('STA_ID');
+		$STA_abbrev = $this->request->getRequestParam('STA_abbrev');
+
+		if (! $STA_ID) {
+			EE_Error::add_error(
+				esc_html__('No State ID or an invalid State ID was received.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return;
+		}
+
+		$success = EEM_State::instance()->delete_by_ID($STA_ID);
+		if ($success !== false) {
+			do_action(
+				'AHEE__General_Settings_Admin_Page__delete_state__state_deleted',
+				$CNT_ISO,
+				$STA_ID,
+				['STA_abbrev' => $STA_abbrev]
+			);
+			EE_Error::add_success(esc_html__('The State was deleted successfully.', 'event_espresso'));
+		}
+		if (defined('DOING_AJAX')) {
+			$notices                = EE_Error::get_notices(false);
+			$notices['return_data'] = true;
+			echo wp_json_encode($notices);
+			die();
+		}
+		$this->_redirect_after_action(
+			$success,
+			esc_html__('State', 'event_espresso'),
+			'deleted',
+			['action' => 'country_settings']
+		);
+	}
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _update_country_settings()
+	{
+		$CNT_ISO = $this->getCountryISO();
+		if (! $CNT_ISO) {
+			EE_Error::add_error(
+				esc_html__('No Country ISO code or an invalid Country ISO code was received.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return;
+		}
+
+		$country = $this->verifyOrGetCountryFromIso($CNT_ISO);
+
+		$cols_n_values                    = [];
+		$cols_n_values['CNT_ISO3']        = strtoupper(
+			$this->request->getRequestParam(
+				"cntry[$CNT_ISO][CNT_ISO3]",
+				$country->ISO3()
+			)
+		);
+		$cols_n_values['CNT_name']        = $this->request->getRequestParam(
+			"cntry[$CNT_ISO][CNT_name]",
+			$country->name()
+		);
+		$cols_n_values['CNT_cur_code']    = strtoupper(
+			$this->request->getRequestParam(
+				"cntry[$CNT_ISO][CNT_cur_code]",
+				$country->currency_code()
+			)
+		);
+		$cols_n_values['CNT_cur_single']  = $this->request->getRequestParam(
+			"cntry[$CNT_ISO][CNT_cur_single]",
+			$country->currency_name_single()
+		);
+		$cols_n_values['CNT_cur_plural']  = $this->request->getRequestParam(
+			"cntry[$CNT_ISO][CNT_cur_plural]",
+			$country->currency_name_plural()
+		);
+		$cols_n_values['CNT_cur_sign']    = $this->request->getRequestParam(
+			"cntry[$CNT_ISO][CNT_cur_sign]",
+			$country->currency_sign()
+		);
+		$cols_n_values['CNT_cur_sign_b4'] = $this->request->getRequestParam(
+			"cntry[$CNT_ISO][CNT_cur_sign_b4]",
+			$country->currency_sign_before(),
+			DataType::BOOL
+		);
+		$cols_n_values['CNT_cur_dec_plc'] = $this->request->getRequestParam(
+			"cntry[$CNT_ISO][CNT_cur_dec_plc]",
+			$country->currency_decimal_places()
+		);
+		$cols_n_values['CNT_cur_dec_mrk'] = $this->request->getRequestParam(
+			"cntry[$CNT_ISO][CNT_cur_dec_mrk]",
+			$country->currency_decimal_mark()
+		);
+		$cols_n_values['CNT_cur_thsnds']  = $this->request->getRequestParam(
+			"cntry[$CNT_ISO][CNT_cur_thsnds]",
+			$country->currency_thousands_separator()
+		);
+		$cols_n_values['CNT_tel_code']    = $this->request->getRequestParam(
+			"cntry[$CNT_ISO][CNT_tel_code]",
+			$country->telephoneCode()
+		);
+		$cols_n_values['CNT_active']      = $this->request->getRequestParam(
+			"cntry[$CNT_ISO][CNT_active]",
+			$country->isActive(),
+			DataType::BOOL
+		);
+		$cols_n_values['CNT_is_EU']      = $this->request->getRequestParam(
+			"cntry[$CNT_ISO][CNT_is_EU]",
+			$country->isEU(),
+			DataType::BOOL
+		);
+
+		// allow filtering of country data
+		$cols_n_values = apply_filters(
+			'FHEE__General_Settings_Admin_Page___update_country_settings__cols_n_values',
+			$cols_n_values
+		);
+
+		// where values
+		$where_cols_n_values = [['CNT_ISO' => $CNT_ISO]];
+		// run the update
+		$success = EEM_Country::instance()->update($cols_n_values, $where_cols_n_values);
+
+		// allow filtering of states data
+		$states = apply_filters(
+			'FHEE__General_Settings_Admin_Page___update_country_settings__states',
+			$this->request->getRequestParam('states', [], DataType::STRING, true)
+		);
+
+		if (! empty($states) && $success !== false) {
+			// loop thru state data ( looks like : states[75][STA_name] )
+			foreach ($states as $STA_ID => $state) {
+				$cols_n_values = [
+					'CNT_ISO'    => $CNT_ISO,
+					'STA_abbrev' => sanitize_text_field($state['STA_abbrev']),
+					'STA_name'   => sanitize_text_field($state['STA_name']),
+					'STA_active' => filter_var($state['STA_active'], FILTER_VALIDATE_BOOLEAN),
+				];
+				// where values
+				$where_cols_n_values = [['STA_ID' => $STA_ID]];
+				// run the update
+				$success = EEM_State::instance()->update($cols_n_values, $where_cols_n_values);
+				if ($success !== false) {
+					do_action(
+						'AHEE__General_Settings_Admin_Page__update_country_settings__state_saved',
+						$CNT_ISO,
+						$STA_ID,
+						$cols_n_values
+					);
+				}
+			}
+		}
+		// check if country being edited matches org option country, and if so, then  update EE_Config with new settings
+		if (
+			isset(EE_Registry::instance()->CFG->organization->CNT_ISO)
+			&& $CNT_ISO == EE_Registry::instance()->CFG->organization->CNT_ISO
+		) {
+			EE_Registry::instance()->CFG->currency = new EE_Currency_Config($CNT_ISO);
+			EE_Registry::instance()->CFG->update_espresso_config();
+		}
+
+		if ($success !== false) {
+			EE_Error::add_success(
+				esc_html__('Country Settings updated successfully.', 'event_espresso')
+			);
+		}
+		$this->_redirect_after_action(
+			$success,
+			'',
+			'',
+			['action' => 'country_settings', 'country' => $CNT_ISO],
+			true
+		);
+	}
+
+
+	/**
+	 * form_form_field_label_wrap
+	 *
+	 * @param string $label
+	 * @return string
+	 */
+	public function country_form_field_label_wrap(string $label): string
+	{
+		return '
 			<tr>
 				<th>
 					' . $label . '
 				</th>';
-    }
-
-
-    /**
-     * form_form_field_input__wrap
-     *
-     * @param string $input
-     * @return string
-     */
-    public function country_form_field_input__wrap(string $input): string
-    {
-        return '
+	}
+
+
+	/**
+	 * form_form_field_input__wrap
+	 *
+	 * @param string $input
+	 * @return string
+	 */
+	public function country_form_field_input__wrap(string $input): string
+	{
+		return '
 				<td class="general-settings-country-input-td">
 					' . $input . '
 				</td>
 			</tr>';
-    }
-
-
-    /**
-     * form_form_field_label_wrap
-     *
-     * @param string $label
-     * @param string $required_text
-     * @return string
-     */
-    public function state_form_field_label_wrap(string $label, string $required_text): string
-    {
-        return $required_text;
-    }
-
-
-    /**
-     * form_form_field_input__wrap
-     *
-     * @param string $input
-     * @return string
-     */
-    public function state_form_field_input__wrap(string $input): string
-    {
-        return '
+	}
+
+
+	/**
+	 * form_form_field_label_wrap
+	 *
+	 * @param string $label
+	 * @param string $required_text
+	 * @return string
+	 */
+	public function state_form_field_label_wrap(string $label, string $required_text): string
+	{
+		return $required_text;
+	}
+
+
+	/**
+	 * form_form_field_input__wrap
+	 *
+	 * @param string $input
+	 * @return string
+	 */
+	public function state_form_field_input__wrap(string $input): string
+	{
+		return '
 				<td class="general-settings-country-state-input-td">
 					' . $input . '
 				</td>';
-    }
-
-
-    /***********/
-
-
-    /**
-     * displays edit and view links for critical EE pages
-     *
-     * @param int $ee_page_id
-     * @return string
-     */
-    public static function edit_view_links(int $ee_page_id): string
-    {
-        $edit_url = add_query_arg(
-            ['post' => $ee_page_id, 'action' => 'edit'],
-            admin_url('post.php')
-        );
-        $links    = '<a href="' . esc_url_raw($edit_url) . '" >' . esc_html__('Edit', 'event_espresso') . '</a>';
-        $links    .= ' &nbsp;|&nbsp; ';
-        $links    .= '<a href="' . get_permalink($ee_page_id) . '" >' . esc_html__('View', 'event_espresso') . '</a>';
-
-        return $links;
-    }
-
-
-    /**
-     * displays page and shortcode status for critical EE pages
-     *
-     * @param WP_Post $ee_page
-     * @param string  $shortcode
-     * @return string
-     */
-    public static function page_and_shortcode_status(WP_Post $ee_page, string $shortcode): string
-    {
-        // page status
-        if (isset($ee_page->post_status) && $ee_page->post_status == 'publish') {
-            $pg_class  = 'ee-status-bg--success';
-            $pg_status = sprintf(esc_html__('Page%sStatus%sOK', 'event_espresso'), '&nbsp;', '&nbsp;');
-        } else {
-            $pg_class  = 'ee-status-bg--error';
-            $pg_status = sprintf(esc_html__('Page%sVisibility%sProblem', 'event_espresso'), '&nbsp;', '&nbsp;');
-        }
-
-        // shortcode status
-        if (isset($ee_page->post_content) && strpos($ee_page->post_content, $shortcode) !== false) {
-            $sc_class  = 'ee-status-bg--success';
-            $sc_status = sprintf(esc_html__('Shortcode%sOK', 'event_espresso'), '&nbsp;');
-        } else {
-            $sc_class  = 'ee-status-bg--error';
-            $sc_status = sprintf(esc_html__('Shortcode%sProblem', 'event_espresso'), '&nbsp;');
-        }
-
-        return '
+	}
+
+
+	/***********/
+
+
+	/**
+	 * displays edit and view links for critical EE pages
+	 *
+	 * @param int $ee_page_id
+	 * @return string
+	 */
+	public static function edit_view_links(int $ee_page_id): string
+	{
+		$edit_url = add_query_arg(
+			['post' => $ee_page_id, 'action' => 'edit'],
+			admin_url('post.php')
+		);
+		$links    = '<a href="' . esc_url_raw($edit_url) . '" >' . esc_html__('Edit', 'event_espresso') . '</a>';
+		$links    .= ' &nbsp;|&nbsp; ';
+		$links    .= '<a href="' . get_permalink($ee_page_id) . '" >' . esc_html__('View', 'event_espresso') . '</a>';
+
+		return $links;
+	}
+
+
+	/**
+	 * displays page and shortcode status for critical EE pages
+	 *
+	 * @param WP_Post $ee_page
+	 * @param string  $shortcode
+	 * @return string
+	 */
+	public static function page_and_shortcode_status(WP_Post $ee_page, string $shortcode): string
+	{
+		// page status
+		if (isset($ee_page->post_status) && $ee_page->post_status == 'publish') {
+			$pg_class  = 'ee-status-bg--success';
+			$pg_status = sprintf(esc_html__('Page%sStatus%sOK', 'event_espresso'), '&nbsp;', '&nbsp;');
+		} else {
+			$pg_class  = 'ee-status-bg--error';
+			$pg_status = sprintf(esc_html__('Page%sVisibility%sProblem', 'event_espresso'), '&nbsp;', '&nbsp;');
+		}
+
+		// shortcode status
+		if (isset($ee_page->post_content) && strpos($ee_page->post_content, $shortcode) !== false) {
+			$sc_class  = 'ee-status-bg--success';
+			$sc_status = sprintf(esc_html__('Shortcode%sOK', 'event_espresso'), '&nbsp;');
+		} else {
+			$sc_class  = 'ee-status-bg--error';
+			$sc_status = sprintf(esc_html__('Shortcode%sProblem', 'event_espresso'), '&nbsp;');
+		}
+
+		return '
         <span class="ee-page-status ' . $pg_class . '"><strong>' . $pg_status . '</strong></span>
         <span class="ee-page-status ' . $sc_class . '"><strong>' . $sc_status . '</strong></span>';
-    }
-
-
-    /**
-     * generates a dropdown of all parent pages - copied from WP core
-     *
-     * @param int  $default
-     * @param int  $parent
-     * @param int  $level
-     * @param bool $echo
-     * @return string;
-     */
-    public static function page_settings_dropdown(
-        int $default = 0,
-        int $parent = 0,
-        int $level = 0,
-        bool $echo = true
-    ): string {
-        global $wpdb;
-        $items  = $wpdb->get_results(
-            $wpdb->prepare(
-                "SELECT ID, post_parent, post_title FROM $wpdb->posts WHERE post_parent = %d AND post_type = 'page' AND post_status != 'trash' ORDER BY menu_order",
-                $parent
-            )
-        );
-        $output = '';
-
-        if ($items) {
-            $level = absint($level);
-            foreach ($items as $item) {
-                $ID         = absint($item->ID);
-                $post_title = wp_strip_all_tags($item->post_title);
-                $pad        = str_repeat('&nbsp;', $level * 3);
-                $option     = "\n\t";
-                $option     .= '<option class="level-' . $level . '" ';
-                $option     .= 'value="' . $ID . '" ';
-                $option     .= $ID === absint($default) ? ' selected' : '';
-                $option     .= '>';
-                $option     .= "$pad {$post_title}";
-                $option     .= '</option>';
-                $output     .= $option;
-                ob_start();
-                parent_dropdown($default, $item->ID, $level + 1);
-                $output .= ob_get_clean();
-            }
-        }
-        if ($echo) {
-            echo wp_kses($output, AllowedTags::getWithFormTags());
-            return '';
-        }
-        return $output;
-    }
-
-
-    /**
-     * Loads the scripts for the privacy settings form
-     */
-    public function load_scripts_styles_privacy_settings()
-    {
-        $form_handler = $this->loader->getShared(
-            'EventEspresso\core\domain\services\admin\privacy\forms\PrivacySettingsFormHandler'
-        );
-        $form_handler->enqueueStylesAndScripts();
-    }
-
-
-    /**
-     * display the privacy settings form
-     *
-     * @throws EE_Error
-     */
-    public function privacySettings()
-    {
-        $this->_set_add_edit_form_tags('update_privacy_settings');
-        $this->_set_publish_post_box_vars();
-        $form_handler                               = $this->loader->getShared(
-            'EventEspresso\core\domain\services\admin\privacy\forms\PrivacySettingsFormHandler'
-        );
-        $this->_template_args['admin_page_content'] = EEH_HTML::div(
-            $form_handler->display(),
-            '',
-            'padding'
-        );
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    /**
-     * Update the privacy settings from form data
-     *
-     * @throws EE_Error
-     */
-    public function updatePrivacySettings()
-    {
-        $form_handler = $this->loader->getShared(
-            'EventEspresso\core\domain\services\admin\privacy\forms\PrivacySettingsFormHandler'
-        );
-        $success      = $form_handler->process($this->get_request_data());
-        $this->_redirect_after_action(
-            $success,
-            esc_html__('Registration Form Options', 'event_espresso'),
-            'updated',
-            ['action' => 'privacy_settings']
-        );
-    }
-
-
-    public function setFontSize()
-    {
-        AdminFontSize::setAdminFontSize(
-            $this->request->getRequestParam('font_size', AdminFontSize::FONT_SIZE_DEFAULT)
-        );
-        wp_safe_redirect($this->request->getServerParam('HTTP_REFERER'));
-    }
+	}
+
+
+	/**
+	 * generates a dropdown of all parent pages - copied from WP core
+	 *
+	 * @param int  $default
+	 * @param int  $parent
+	 * @param int  $level
+	 * @param bool $echo
+	 * @return string;
+	 */
+	public static function page_settings_dropdown(
+		int $default = 0,
+		int $parent = 0,
+		int $level = 0,
+		bool $echo = true
+	): string {
+		global $wpdb;
+		$items  = $wpdb->get_results(
+			$wpdb->prepare(
+				"SELECT ID, post_parent, post_title FROM $wpdb->posts WHERE post_parent = %d AND post_type = 'page' AND post_status != 'trash' ORDER BY menu_order",
+				$parent
+			)
+		);
+		$output = '';
+
+		if ($items) {
+			$level = absint($level);
+			foreach ($items as $item) {
+				$ID         = absint($item->ID);
+				$post_title = wp_strip_all_tags($item->post_title);
+				$pad        = str_repeat('&nbsp;', $level * 3);
+				$option     = "\n\t";
+				$option     .= '<option class="level-' . $level . '" ';
+				$option     .= 'value="' . $ID . '" ';
+				$option     .= $ID === absint($default) ? ' selected' : '';
+				$option     .= '>';
+				$option     .= "$pad {$post_title}";
+				$option     .= '</option>';
+				$output     .= $option;
+				ob_start();
+				parent_dropdown($default, $item->ID, $level + 1);
+				$output .= ob_get_clean();
+			}
+		}
+		if ($echo) {
+			echo wp_kses($output, AllowedTags::getWithFormTags());
+			return '';
+		}
+		return $output;
+	}
+
+
+	/**
+	 * Loads the scripts for the privacy settings form
+	 */
+	public function load_scripts_styles_privacy_settings()
+	{
+		$form_handler = $this->loader->getShared(
+			'EventEspresso\core\domain\services\admin\privacy\forms\PrivacySettingsFormHandler'
+		);
+		$form_handler->enqueueStylesAndScripts();
+	}
+
+
+	/**
+	 * display the privacy settings form
+	 *
+	 * @throws EE_Error
+	 */
+	public function privacySettings()
+	{
+		$this->_set_add_edit_form_tags('update_privacy_settings');
+		$this->_set_publish_post_box_vars();
+		$form_handler                               = $this->loader->getShared(
+			'EventEspresso\core\domain\services\admin\privacy\forms\PrivacySettingsFormHandler'
+		);
+		$this->_template_args['admin_page_content'] = EEH_HTML::div(
+			$form_handler->display(),
+			'',
+			'padding'
+		);
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	/**
+	 * Update the privacy settings from form data
+	 *
+	 * @throws EE_Error
+	 */
+	public function updatePrivacySettings()
+	{
+		$form_handler = $this->loader->getShared(
+			'EventEspresso\core\domain\services\admin\privacy\forms\PrivacySettingsFormHandler'
+		);
+		$success      = $form_handler->process($this->get_request_data());
+		$this->_redirect_after_action(
+			$success,
+			esc_html__('Registration Form Options', 'event_espresso'),
+			'updated',
+			['action' => 'privacy_settings']
+		);
+	}
+
+
+	public function setFontSize()
+	{
+		AdminFontSize::setAdminFontSize(
+			$this->request->getRequestParam('font_size', AdminFontSize::FONT_SIZE_DEFAULT)
+		);
+		wp_safe_redirect($this->request->getServerParam('HTTP_REFERER'));
+	}
 }

Spacing +50 added lines, -50 removed lines

@@ -264,19 +264,19 @@ 
                 'event_espresso'
             )
         );
-        EE_Registry::$i18n_js_strings['error_occurred']          = wp_strip_all_tags(
+        EE_Registry::$i18n_js_strings['error_occurred'] = wp_strip_all_tags(
             esc_html__(
                 'An error occurred! Please refresh the page and try again.',
                 'event_espresso'
             )
         );
-        EE_Registry::$i18n_js_strings['confirm_delete_state']    = wp_strip_all_tags(
+        EE_Registry::$i18n_js_strings['confirm_delete_state'] = wp_strip_all_tags(
             esc_html__(
                 'Are you sure you want to delete this State / Province?',
                 'event_espresso'
             )
         );
-        EE_Registry::$i18n_js_strings['ajax_url']                = admin_url(
+        EE_Registry::$i18n_js_strings['ajax_url'] = admin_url(
             'admin-ajax.php?page=espresso_general_settings',
             is_ssl() ? 'https://' : 'http://'
         );
@@ -305,12 +305,12 @@ 
         wp_enqueue_script('thickbox');
         wp_register_script(
             'organization_settings',
-            GEN_SET_ASSETS_URL . 'your_organization_settings.js',
+            GEN_SET_ASSETS_URL.'your_organization_settings.js',
             ['jquery', 'media-upload', 'thickbox'],
             EVENT_ESPRESSO_VERSION,
             true
         );
-        wp_register_style('organization-css', GEN_SET_ASSETS_URL . 'organization.css', [], EVENT_ESPRESSO_VERSION);
+        wp_register_style('organization-css', GEN_SET_ASSETS_URL.'organization.css', [], EVENT_ESPRESSO_VERSION);
         wp_enqueue_script('organization_settings');
         wp_enqueue_style('organization-css');
         $confirm_image_delete = [
@@ -333,12 +333,12 @@ 
         // scripts
         wp_register_script(
             'gen_settings_countries',
-            GEN_SET_ASSETS_URL . 'gen_settings_countries.js',
+            GEN_SET_ASSETS_URL.'gen_settings_countries.js',
             ['ee_admin_js'],
             EVENT_ESPRESSO_VERSION,
             true
         );
-        wp_register_style('organization-css', GEN_SET_ASSETS_URL . 'organization.css', [], EVENT_ESPRESSO_VERSION);
+        wp_register_style('organization-css', GEN_SET_ASSETS_URL.'organization.css', [], EVENT_ESPRESSO_VERSION);
         wp_enqueue_script('gen_settings_countries');
         wp_enqueue_style('organization-css');
     }
@@ -386,7 +386,7 @@ 
         $this->_set_add_edit_form_tags('update_espresso_page_settings');
         $this->_set_publish_post_box_vars();
         $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            GEN_SET_TEMPLATE_PATH . 'espresso_page_settings.template.php',
+            GEN_SET_TEMPLATE_PATH.'espresso_page_settings.template.php',
             $this->_template_args,
             true
         );
@@ -403,12 +403,12 @@ 
     {
         $this->core_config = EE_Registry::instance()->CFG->core;
         // capture incoming request data && set page IDs
-        $this->core_config->reg_page_id       = $this->request->getRequestParam(
+        $this->core_config->reg_page_id = $this->request->getRequestParam(
             'reg_page_id',
             $this->core_config->reg_page_id,
             DataType::INT
         );
-        $this->core_config->txn_page_id       = $this->request->getRequestParam(
+        $this->core_config->txn_page_id = $this->request->getRequestParam(
             'txn_page_id',
             $this->core_config->txn_page_id,
             DataType::INT
@@ -418,7 +418,7 @@ 
             $this->core_config->thank_you_page_id,
             DataType::INT
         );
-        $this->core_config->cancel_page_id    = $this->request->getRequestParam(
+        $this->core_config->cancel_page_id = $this->request->getRequestParam(
             'cancel_page_id',
             $this->core_config->cancel_page_id,
             DataType::INT
@@ -685,16 +685,16 @@ 
             $country->ID(),
             $country
         );
-        $this->_template_args['country_states_settings']  = $this->display_country_states(
+        $this->_template_args['country_states_settings'] = $this->display_country_states(
             $country->ID(),
             $country
         );
-        $this->_template_args['CNT_name_for_site']        = $country->name();
+        $this->_template_args['CNT_name_for_site'] = $country->name();
 
         $this->_set_add_edit_form_tags('update_country_settings');
         $this->_set_publish_post_box_vars();
         $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            GEN_SET_TEMPLATE_PATH . 'countries_settings.template.php',
+            GEN_SET_TEMPLATE_PATH.'countries_settings.template.php',
             $this->_template_args,
             true
         );
@@ -718,7 +718,7 @@ 
         $CNT_ISO          = $this->getCountryISO($CNT_ISO);
         $CNT_ISO_for_site = $this->getCountryIsoForSite();
 
-        if (! $CNT_ISO) {
+        if ( ! $CNT_ISO) {
             return '';
         }
 
@@ -731,7 +731,7 @@ 
         $CNT_cur_disabled                         = $CNT_ISO !== $CNT_ISO_for_site;
         $this->_template_args['CNT_cur_disabled'] = $CNT_cur_disabled;
 
-        $country_input_types            = [
+        $country_input_types = [
             'CNT_active'      => [
                 'type'             => 'RADIO_BTN',
                 'input_name'       => "cntry[$CNT_ISO]",
@@ -868,8 +868,8 @@ 
             $country,
             $country_input_types
         );
-        $country_details_settings       = EEH_Template::display_template(
-            GEN_SET_TEMPLATE_PATH . 'country_details_settings.template.php',
+        $country_details_settings = EEH_Template::display_template(
+            GEN_SET_TEMPLATE_PATH.'country_details_settings.template.php',
             $this->_template_args,
             true
         );
@@ -903,7 +903,7 @@ 
     public function display_country_states(string $CNT_ISO = '', ?EE_Country $country = null): string
     {
         $CNT_ISO = $this->getCountryISO($CNT_ISO);
-        if (! $CNT_ISO) {
+        if ( ! $CNT_ISO) {
             return '';
         }
         // for ajax
@@ -967,8 +967,8 @@ 
                     GEN_SET_ADMIN_URL
                 );
 
-                $this->_template_args['states'][ $STA_ID ]['inputs']           = $inputs;
-                $this->_template_args['states'][ $STA_ID ]['delete_state_url'] = $delete_state_url;
+                $this->_template_args['states'][$STA_ID]['inputs']           = $inputs;
+                $this->_template_args['states'][$STA_ID]['delete_state_url'] = $delete_state_url;
             }
         }
 
@@ -976,7 +976,7 @@ 
         $this->_template_args['delete_state_nonce'] = wp_create_nonce('espresso_delete_state');
 
         $state_details_settings = EEH_Template::display_template(
-            GEN_SET_TEMPLATE_PATH . 'state_details_settings.template.php',
+            GEN_SET_TEMPLATE_PATH.'state_details_settings.template.php',
             $this->_template_args,
             true
         );
@@ -1008,13 +1008,13 @@ 
     {
         $this->_verify_nonce();
         // add_new_state_nonce
-        if (! $this->capabilities->current_user_can('manage_options', __FUNCTION__)) {
+        if ( ! $this->capabilities->current_user_can('manage_options', __FUNCTION__)) {
             wp_die(esc_html__('You do not have the required privileges to perform this action', 'event_espresso'));
         }
 
         $success = true;
         $CNT_ISO = $this->getCountryISO('');
-        if (! $CNT_ISO) {
+        if ( ! $CNT_ISO) {
             EE_Error::add_error(
                 esc_html__('No Country ISO code or an invalid Country ISO code was received.', 'event_espresso'),
                 __FILE__,
@@ -1024,7 +1024,7 @@ 
             $success = false;
         }
         $STA_abbrev = $this->request->getRequestParam('STA_abbrev');
-        if (! $STA_abbrev) {
+        if ( ! $STA_abbrev) {
             EE_Error::add_error(
                 esc_html__('No State ISO code or an invalid State ISO code was received.', 'event_espresso'),
                 __FILE__,
@@ -1034,7 +1034,7 @@ 
             $success = false;
         }
         $STA_name = $this->request->getRequestParam('STA_name');
-        if (! $STA_name) {
+        if ( ! $STA_name) {
             EE_Error::add_error(
                 esc_html__('No State name or an invalid State name was received.', 'event_espresso'),
                 __FILE__,
@@ -1051,7 +1051,7 @@ 
                 'STA_name'   => $STA_name,
                 'STA_active' => true,
             ];
-            $success       = EEM_State::instance()->insert($cols_n_values);
+            $success = EEM_State::instance()->insert($cols_n_values);
             EE_Error::add_success(esc_html__('The State was added successfully.', 'event_espresso'));
         }
 
@@ -1080,7 +1080,7 @@ 
     public function delete_state()
     {
         $this->_verify_nonce();
-        if (! $this->capabilities->current_user_can('manage_options', __FUNCTION__)) {
+        if ( ! $this->capabilities->current_user_can('manage_options', __FUNCTION__)) {
             wp_die(esc_html__('You do not have the required privileges to perform this action', 'event_espresso'));
         }
 
@@ -1088,7 +1088,7 @@ 
         $STA_ID     = $this->request->getRequestParam('STA_ID');
         $STA_abbrev = $this->request->getRequestParam('STA_abbrev');
 
-        if (! $STA_ID) {
+        if ( ! $STA_ID) {
             EE_Error::add_error(
                 esc_html__('No State ID or an invalid State ID was received.', 'event_espresso'),
                 __FILE__,
@@ -1134,7 +1134,7 @@ 
     protected function _update_country_settings()
     {
         $CNT_ISO = $this->getCountryISO();
-        if (! $CNT_ISO) {
+        if ( ! $CNT_ISO) {
             EE_Error::add_error(
                 esc_html__('No Country ISO code or an invalid Country ISO code was received.', 'event_espresso'),
                 __FILE__,
@@ -1153,25 +1153,25 @@ 
                 $country->ISO3()
             )
         );
-        $cols_n_values['CNT_name']        = $this->request->getRequestParam(
+        $cols_n_values['CNT_name'] = $this->request->getRequestParam(
             "cntry[$CNT_ISO][CNT_name]",
             $country->name()
         );
-        $cols_n_values['CNT_cur_code']    = strtoupper(
+        $cols_n_values['CNT_cur_code'] = strtoupper(
             $this->request->getRequestParam(
                 "cntry[$CNT_ISO][CNT_cur_code]",
                 $country->currency_code()
             )
         );
-        $cols_n_values['CNT_cur_single']  = $this->request->getRequestParam(
+        $cols_n_values['CNT_cur_single'] = $this->request->getRequestParam(
             "cntry[$CNT_ISO][CNT_cur_single]",
             $country->currency_name_single()
         );
-        $cols_n_values['CNT_cur_plural']  = $this->request->getRequestParam(
+        $cols_n_values['CNT_cur_plural'] = $this->request->getRequestParam(
             "cntry[$CNT_ISO][CNT_cur_plural]",
             $country->currency_name_plural()
         );
-        $cols_n_values['CNT_cur_sign']    = $this->request->getRequestParam(
+        $cols_n_values['CNT_cur_sign'] = $this->request->getRequestParam(
             "cntry[$CNT_ISO][CNT_cur_sign]",
             $country->currency_sign()
         );
@@ -1188,20 +1188,20 @@ 
             "cntry[$CNT_ISO][CNT_cur_dec_mrk]",
             $country->currency_decimal_mark()
         );
-        $cols_n_values['CNT_cur_thsnds']  = $this->request->getRequestParam(
+        $cols_n_values['CNT_cur_thsnds'] = $this->request->getRequestParam(
             "cntry[$CNT_ISO][CNT_cur_thsnds]",
             $country->currency_thousands_separator()
         );
-        $cols_n_values['CNT_tel_code']    = $this->request->getRequestParam(
+        $cols_n_values['CNT_tel_code'] = $this->request->getRequestParam(
             "cntry[$CNT_ISO][CNT_tel_code]",
             $country->telephoneCode()
         );
-        $cols_n_values['CNT_active']      = $this->request->getRequestParam(
+        $cols_n_values['CNT_active'] = $this->request->getRequestParam(
             "cntry[$CNT_ISO][CNT_active]",
             $country->isActive(),
             DataType::BOOL
         );
-        $cols_n_values['CNT_is_EU']      = $this->request->getRequestParam(
+        $cols_n_values['CNT_is_EU'] = $this->request->getRequestParam(
             "cntry[$CNT_ISO][CNT_is_EU]",
             $country->isEU(),
             DataType::BOOL
@@ -1224,7 +1224,7 @@ 
             $this->request->getRequestParam('states', [], DataType::STRING, true)
         );
 
-        if (! empty($states) && $success !== false) {
+        if ( ! empty($states) && $success !== false) {
             // loop thru state data ( looks like : states[75][STA_name] )
             foreach ($states as $STA_ID => $state) {
                 $cols_n_values = [
@@ -1282,7 +1282,7 @@ 
         return '
 			<tr>
 				<th>
-					' . $label . '
+					' . $label.'
 				</th>';
     }
 
@@ -1297,7 +1297,7 @@ 
     {
         return '
 				<td class="general-settings-country-input-td">
-					' . $input . '
+					' . $input.'
 				</td>
 			</tr>';
     }
@@ -1326,7 +1326,7 @@ 
     {
         return '
 				<td class="general-settings-country-state-input-td">
-					' . $input . '
+					' . $input.'
 				</td>';
     }
 
@@ -1346,9 +1346,9 @@ 
             ['post' => $ee_page_id, 'action' => 'edit'],
             admin_url('post.php')
         );
-        $links    = '<a href="' . esc_url_raw($edit_url) . '" >' . esc_html__('Edit', 'event_espresso') . '</a>';
+        $links = '<a href="'.esc_url_raw($edit_url).'" >'.esc_html__('Edit', 'event_espresso').'</a>';
         $links    .= ' &nbsp;|&nbsp; ';
-        $links    .= '<a href="' . get_permalink($ee_page_id) . '" >' . esc_html__('View', 'event_espresso') . '</a>';
+        $links    .= '<a href="'.get_permalink($ee_page_id).'" >'.esc_html__('View', 'event_espresso').'</a>';
 
         return $links;
     }
@@ -1382,8 +1382,8 @@ 
         }
 
         return '
-        <span class="ee-page-status ' . $pg_class . '"><strong>' . $pg_status . '</strong></span>
-        <span class="ee-page-status ' . $sc_class . '"><strong>' . $sc_status . '</strong></span>';
+        <span class="ee-page-status ' . $pg_class.'"><strong>'.$pg_status.'</strong></span>
+        <span class="ee-page-status ' . $sc_class.'"><strong>'.$sc_status.'</strong></span>';
     }
 
 
@@ -1403,7 +1403,7 @@ 
         bool $echo = true
     ): string {
         global $wpdb;
-        $items  = $wpdb->get_results(
+        $items = $wpdb->get_results(
             $wpdb->prepare(
                 "SELECT ID, post_parent, post_title FROM $wpdb->posts WHERE post_parent = %d AND post_type = 'page' AND post_status != 'trash' ORDER BY menu_order",
                 $parent
@@ -1418,8 +1418,8 @@ 
                 $post_title = wp_strip_all_tags($item->post_title);
                 $pad        = str_repeat('&nbsp;', $level * 3);
                 $option     = "\n\t";
-                $option     .= '<option class="level-' . $level . '" ';
-                $option     .= 'value="' . $ID . '" ';
+                $option     .= '<option class="level-'.$level.'" ';
+                $option     .= 'value="'.$ID.'" ';
                 $option     .= $ID === absint($default) ? ' selected' : '';
                 $option     .= '>';
                 $option     .= "$pad {$post_title}";

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

Indentation +1278 added lines, -1278 removed lines

@@ -16,1289 +16,1289 @@
  */
 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 array $_reports_template_data = [];
-
-
-    /**
-     * Extend_Registrations_Admin_Page constructor.
-     *
-     * @param bool $routing
-     * @throws ReflectionException
-     */
-    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/');
-        }
-    }
-
-
-    protected function _set_page_config()
-    {
-        parent::_set_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                                  = [
-            'reports'                      => [
-                'func'       => [$this, '_registration_reports'],
-                'capability' => 'ee_read_registrations',
-            ],
-            'registration_checkins'        => [
-                'func'       => [$this, '_registration_checkin_list_table'],
-                'capability' => 'ee_read_checkins',
-            ],
-            'newsletter_selected_send'     => [
-                'func'       => [$this, '_newsletter_selected_send'],
-                'noheader'   => true,
-                'capability' => 'ee_send_message',
-            ],
-            'delete_checkin_rows'          => [
-                'func'       => [$this, '_delete_checkin_rows'],
-                'noheader'   => true,
-                'capability' => 'ee_delete_checkins',
-            ],
-            'delete_checkin_row'           => [
-                'func'       => [$this, '_delete_checkin_row'],
-                'noheader'   => true,
-                'capability' => 'ee_delete_checkin',
-                'obj_id'     => $reg_id,
-            ],
-            'toggle_checkin_status'        => [
-                'func'       => [$this, '_toggle_checkin_status'],
-                'noheader'   => true,
-                'capability' => 'ee_edit_checkin',
-                'obj_id'     => $reg_id,
-            ],
-            'toggle_checkin_status_bulk'   => [
-                'func'       => [$this, '_toggle_checkin_status'],
-                'noheader'   => true,
-                'capability' => 'ee_edit_checkins',
-            ],
-            'event_registrations'          => [
-                'func'       => [$this, '_event_registrations_list_table'],
-                'capability' => 'ee_read_checkins',
-            ],
-            'registrations_checkin_report' => [
-                'func'       => [$this, '_registrations_checkin_report'],
-                'noheader'   => true,
-                'capability' => 'ee_read_registrations',
-            ],
-        ];
-        $this->_page_routes                               = array_merge($this->_page_routes, $new_page_routes);
-        $new_page_config                                  = [
-            'reports'               => [
-                'nav'           => [
-                    'label' => esc_html__('Reports', 'event_espresso'),
-                    'icon'  => 'dashicons-chart-bar',
-                    'order' => 30,
-                ],
-                'help_tabs'     => [
-                    'registrations_reports_help_tab' => [
-                        'title'    => esc_html__('Registration Reports', 'event_espresso'),
-                        'filename' => 'registrations_reports',
-                    ],
-                ],
-                'require_nonce' => false,
-            ],
-            'event_registrations'   => [
-                'nav'           => [
-                    'label'      => esc_html__('Event Check-In', 'event_espresso'),
-                    'icon'       => 'dashicons-yes-alt',
-                    'order'      => 10,
-                    'persistent' => true,
-                ],
-                'help_tabs'     => [
-                    'registrations_event_checkin_help_tab'                       => [
-                        'title'    => esc_html__('Registrations Event Check-In', 'event_espresso'),
-                        'filename' => 'registrations_event_checkin',
-                    ],
-                    'registrations_event_checkin_table_column_headings_help_tab' => [
-                        'title'    => esc_html__('Event Check-In Table Column Headings', 'event_espresso'),
-                        'filename' => 'registrations_event_checkin_table_column_headings',
-                    ],
-                    'registrations_event_checkin_filters_help_tab'               => [
-                        'title'    => esc_html__('Event Check-In Filters', 'event_espresso'),
-                        'filename' => 'registrations_event_checkin_filters',
-                    ],
-                    'registrations_event_checkin_views_help_tab'                 => [
-                        'title'    => esc_html__('Event Check-In Views', 'event_espresso'),
-                        'filename' => 'registrations_event_checkin_views',
-                    ],
-                    'registrations_event_checkin_other_help_tab'                 => [
-                        'title'    => esc_html__('Event Check-In Other', 'event_espresso'),
-                        'filename' => 'registrations_event_checkin_other',
-                    ],
-                ],
-                'list_table'    => 'EE_Event_Registrations_List_Table',
-                'metaboxes'     => [],
-                'require_nonce' => false,
-            ],
-            'registration_checkins' => [
-                'nav'           => [
-                    'label'      => esc_html__('Check-In Records', 'event_espresso'),
-                    'icon'       => 'dashicons-list-view',
-                    'order'      => 15,
-                    'persistent' => false,
-                    'url'        => '',
-                ],
-                'list_table'    => 'EE_Registration_CheckIn_List_Table',
-                'metaboxes'     => [],
-                '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', [$this, 'get_newsletter_form_content']);
-        add_action('wp_ajax_toggle_checkin_status', [$this, 'toggle_checkin_status']);
-    }
-
-
-    /**
-     * Global scripts for all routes in this page.
-     *
-     * @throws EE_Error
-     * *@throws ReflectionException
-     */
-    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')) {
-            wp_enqueue_style(
-                'ee_message_shortcodes',
-                EE_MSG_ASSETS_URL . 'ee_message_shortcodes.css',
-                [EspressoLegacyAdminAssetManager::CSS_HANDLE_EE_ADMIN],
-                EVENT_ESPRESSO_VERSION
-            );
-            // enqueue newsletter js
-            wp_enqueue_script(
-                'ee-newsletter-trigger',
-                REG_CAF_ASSETS_URL . 'ee-newsletter-trigger.js',
-                ['ee-dialog'],
-                EVENT_ESPRESSO_VERSION,
-                true
-            );
-            // hook in buttons for newsletter message type trigger.
-            add_action(
-                'AHEE__EE_Admin_List_Table__extra_tablenav__after_bottom_buttons',
-                [$this, 'add_newsletter_action_buttons']
-            );
-        }
-    }
-
-
-    /**
-     * Scripts and styles for just the reports route.
-     *
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function load_scripts_styles_reports()
-    {
-        wp_register_script(
-            'ee-reg-reports-js',
-            REG_CAF_ASSETS_URL . 'ee-registration-admin-reports.js',
-            ['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 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()
-    {
-        $DTT_ID = $this->request->getRequestParam('DTT_ID', 0, DataType::INTEGER);
-        $this->_views = [
-            'all' => [
-                'slug'        => 'all',
-                'label'       => esc_html__('All', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => $DTT_ID
-                    ? ['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 = [
-            'all' => [
-                'slug'        => 'all',
-                'label'       => esc_html__('All', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => ['delete_checkin_rows' => esc_html__('Delete Check-In Rows', 'event_espresso')],
-            ],
-        ];
-    }
-
-
-    /**
-     * callback for ajax action.
-     *
-     * @return void (JSON)
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since 4.3.0
-     */
-    public function get_newsletter_form_content()
-    {
-        if (! $this->capabilities->current_user_can('ee_read_messages', __FUNCTION__)) {
-            wp_die(esc_html__('You do not have the required privileges to perform this action', 'event_espresso'));
-        }
-        // do a nonce check because we're not coming in from a 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 = [];
-        /** @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']    = [
-            'batch_message_from'    => $template_fields['from'] ?? '',
-            'batch_message_subject' => $template_fields['subject'] ?? '',
-            'batch_message_content' => $template_fields['newsletter_content'] ?? '',
-        ];
-        $this->_return_json();
-    }
-
-
-    /**
-     * callback for AHEE__EE_Admin_List_Table__extra_tablenav__after_bottom_buttons action
-     *
-     * @param EE_Admin_List_Table $list_table
-     * @return void
-     * @since 4.3.0
-     */
-    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 = [
-            '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 button--secondary">'
-                    . '<span class="dashicons dashicons-email "></span>'
-                    . $button_text
-                    . '</button>';
-                add_action('admin_footer', [$this, 'newsletter_send_form_skeleton']);
-            }
-        }
-    }
-
-
-    /**
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function newsletter_send_form_skeleton()
-    {
-        $list_table = $this->_list_table_object;
-        $codes      = [];
-        // need to templates for the newsletter message type for the template selector.
-        $values[] = ['text' => esc_html__('Select Template to Use', 'event_espresso'), 'id' => 0];
-        $mtps     = EEM_Message_Template_Group::instance()->get_all(
-            [['MTP_message_type' => 'newsletter', 'MTP_messenger' => 'email']]
-        );
-        foreach ($mtps as $mtp) {
-            $name     = $mtp->name();
-            $values[] = [
-                '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',
-            [],
-            'attendee'
-        );
-
-        foreach ($shortcodes as $field => $shortcode_array) {
-            $available_shortcodes = [];
-            foreach ($shortcode_array as $shortcode => $shortcode_details) {
-                $field_id               = $field === '[NEWSLETTER_CONTENT]'
-                    ? 'content'
-                    : strtolower($field);
-                $field_id               = "batch-message-$field_id";
-                $available_shortcodes[] = '
+	/**
+	 * This is used to hold the reports template data which is setup early in the request.
+	 *
+	 * @type array
+	 */
+	protected array $_reports_template_data = [];
+
+
+	/**
+	 * Extend_Registrations_Admin_Page constructor.
+	 *
+	 * @param bool $routing
+	 * @throws ReflectionException
+	 */
+	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/');
+		}
+	}
+
+
+	protected function _set_page_config()
+	{
+		parent::_set_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                                  = [
+			'reports'                      => [
+				'func'       => [$this, '_registration_reports'],
+				'capability' => 'ee_read_registrations',
+			],
+			'registration_checkins'        => [
+				'func'       => [$this, '_registration_checkin_list_table'],
+				'capability' => 'ee_read_checkins',
+			],
+			'newsletter_selected_send'     => [
+				'func'       => [$this, '_newsletter_selected_send'],
+				'noheader'   => true,
+				'capability' => 'ee_send_message',
+			],
+			'delete_checkin_rows'          => [
+				'func'       => [$this, '_delete_checkin_rows'],
+				'noheader'   => true,
+				'capability' => 'ee_delete_checkins',
+			],
+			'delete_checkin_row'           => [
+				'func'       => [$this, '_delete_checkin_row'],
+				'noheader'   => true,
+				'capability' => 'ee_delete_checkin',
+				'obj_id'     => $reg_id,
+			],
+			'toggle_checkin_status'        => [
+				'func'       => [$this, '_toggle_checkin_status'],
+				'noheader'   => true,
+				'capability' => 'ee_edit_checkin',
+				'obj_id'     => $reg_id,
+			],
+			'toggle_checkin_status_bulk'   => [
+				'func'       => [$this, '_toggle_checkin_status'],
+				'noheader'   => true,
+				'capability' => 'ee_edit_checkins',
+			],
+			'event_registrations'          => [
+				'func'       => [$this, '_event_registrations_list_table'],
+				'capability' => 'ee_read_checkins',
+			],
+			'registrations_checkin_report' => [
+				'func'       => [$this, '_registrations_checkin_report'],
+				'noheader'   => true,
+				'capability' => 'ee_read_registrations',
+			],
+		];
+		$this->_page_routes                               = array_merge($this->_page_routes, $new_page_routes);
+		$new_page_config                                  = [
+			'reports'               => [
+				'nav'           => [
+					'label' => esc_html__('Reports', 'event_espresso'),
+					'icon'  => 'dashicons-chart-bar',
+					'order' => 30,
+				],
+				'help_tabs'     => [
+					'registrations_reports_help_tab' => [
+						'title'    => esc_html__('Registration Reports', 'event_espresso'),
+						'filename' => 'registrations_reports',
+					],
+				],
+				'require_nonce' => false,
+			],
+			'event_registrations'   => [
+				'nav'           => [
+					'label'      => esc_html__('Event Check-In', 'event_espresso'),
+					'icon'       => 'dashicons-yes-alt',
+					'order'      => 10,
+					'persistent' => true,
+				],
+				'help_tabs'     => [
+					'registrations_event_checkin_help_tab'                       => [
+						'title'    => esc_html__('Registrations Event Check-In', 'event_espresso'),
+						'filename' => 'registrations_event_checkin',
+					],
+					'registrations_event_checkin_table_column_headings_help_tab' => [
+						'title'    => esc_html__('Event Check-In Table Column Headings', 'event_espresso'),
+						'filename' => 'registrations_event_checkin_table_column_headings',
+					],
+					'registrations_event_checkin_filters_help_tab'               => [
+						'title'    => esc_html__('Event Check-In Filters', 'event_espresso'),
+						'filename' => 'registrations_event_checkin_filters',
+					],
+					'registrations_event_checkin_views_help_tab'                 => [
+						'title'    => esc_html__('Event Check-In Views', 'event_espresso'),
+						'filename' => 'registrations_event_checkin_views',
+					],
+					'registrations_event_checkin_other_help_tab'                 => [
+						'title'    => esc_html__('Event Check-In Other', 'event_espresso'),
+						'filename' => 'registrations_event_checkin_other',
+					],
+				],
+				'list_table'    => 'EE_Event_Registrations_List_Table',
+				'metaboxes'     => [],
+				'require_nonce' => false,
+			],
+			'registration_checkins' => [
+				'nav'           => [
+					'label'      => esc_html__('Check-In Records', 'event_espresso'),
+					'icon'       => 'dashicons-list-view',
+					'order'      => 15,
+					'persistent' => false,
+					'url'        => '',
+				],
+				'list_table'    => 'EE_Registration_CheckIn_List_Table',
+				'metaboxes'     => [],
+				'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', [$this, 'get_newsletter_form_content']);
+		add_action('wp_ajax_toggle_checkin_status', [$this, 'toggle_checkin_status']);
+	}
+
+
+	/**
+	 * Global scripts for all routes in this page.
+	 *
+	 * @throws EE_Error
+	 * *@throws ReflectionException
+	 */
+	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')) {
+			wp_enqueue_style(
+				'ee_message_shortcodes',
+				EE_MSG_ASSETS_URL . 'ee_message_shortcodes.css',
+				[EspressoLegacyAdminAssetManager::CSS_HANDLE_EE_ADMIN],
+				EVENT_ESPRESSO_VERSION
+			);
+			// enqueue newsletter js
+			wp_enqueue_script(
+				'ee-newsletter-trigger',
+				REG_CAF_ASSETS_URL . 'ee-newsletter-trigger.js',
+				['ee-dialog'],
+				EVENT_ESPRESSO_VERSION,
+				true
+			);
+			// hook in buttons for newsletter message type trigger.
+			add_action(
+				'AHEE__EE_Admin_List_Table__extra_tablenav__after_bottom_buttons',
+				[$this, 'add_newsletter_action_buttons']
+			);
+		}
+	}
+
+
+	/**
+	 * Scripts and styles for just the reports route.
+	 *
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function load_scripts_styles_reports()
+	{
+		wp_register_script(
+			'ee-reg-reports-js',
+			REG_CAF_ASSETS_URL . 'ee-registration-admin-reports.js',
+			['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 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()
+	{
+		$DTT_ID = $this->request->getRequestParam('DTT_ID', 0, DataType::INTEGER);
+		$this->_views = [
+			'all' => [
+				'slug'        => 'all',
+				'label'       => esc_html__('All', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => $DTT_ID
+					? ['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 = [
+			'all' => [
+				'slug'        => 'all',
+				'label'       => esc_html__('All', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => ['delete_checkin_rows' => esc_html__('Delete Check-In Rows', 'event_espresso')],
+			],
+		];
+	}
+
+
+	/**
+	 * callback for ajax action.
+	 *
+	 * @return void (JSON)
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since 4.3.0
+	 */
+	public function get_newsletter_form_content()
+	{
+		if (! $this->capabilities->current_user_can('ee_read_messages', __FUNCTION__)) {
+			wp_die(esc_html__('You do not have the required privileges to perform this action', 'event_espresso'));
+		}
+		// do a nonce check because we're not coming in from a 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 = [];
+		/** @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']    = [
+			'batch_message_from'    => $template_fields['from'] ?? '',
+			'batch_message_subject' => $template_fields['subject'] ?? '',
+			'batch_message_content' => $template_fields['newsletter_content'] ?? '',
+		];
+		$this->_return_json();
+	}
+
+
+	/**
+	 * callback for AHEE__EE_Admin_List_Table__extra_tablenav__after_bottom_buttons action
+	 *
+	 * @param EE_Admin_List_Table $list_table
+	 * @return void
+	 * @since 4.3.0
+	 */
+	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 = [
+			'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 button--secondary">'
+					. '<span class="dashicons dashicons-email "></span>'
+					. $button_text
+					. '</button>';
+				add_action('admin_footer', [$this, 'newsletter_send_form_skeleton']);
+			}
+		}
+	}
+
+
+	/**
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function newsletter_send_form_skeleton()
+	{
+		$list_table = $this->_list_table_object;
+		$codes      = [];
+		// need to templates for the newsletter message type for the template selector.
+		$values[] = ['text' => esc_html__('Select Template to Use', 'event_espresso'), 'id' => 0];
+		$mtps     = EEM_Message_Template_Group::instance()->get_all(
+			[['MTP_message_type' => 'newsletter', 'MTP_messenger' => 'email']]
+		);
+		foreach ($mtps as $mtp) {
+			$name     = $mtp->name();
+			$values[] = [
+				'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',
+			[],
+			'attendee'
+		);
+
+		foreach ($shortcodes as $field => $shortcode_array) {
+			$available_shortcodes = [];
+			foreach ($shortcode_array as $shortcode => $shortcode_details) {
+				$field_id               = $field === '[NEWSLETTER_CONTENT]'
+					? 'content'
+					: strtolower($field);
+				$field_id               = "batch-message-$field_id";
+				$available_shortcodes[] = '
                 <span class="js-shortcode-selection"
                       data-value="' . $shortcode . '"
                       data-linked-input-id="' . $field_id . '"
                 >' . $shortcode . '</span>';
-            }
-            $codes[ $field ] = '<ul><li>' . implode('</li><li>', $available_shortcodes) . '</li></ul>';
-        }
-
-        EEH_Template::display_template(
-            REG_CAF_TEMPLATE_PATH . 'newsletter-send-form.template.php',
-            [
-                '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'        => $codes,
-                'id_type'           => $list_table instanceof EE_Attendee_Contact_List_Table ? 'contact'
-                    : 'registration',
-            ]
-        );
-    }
-
-
-    /**
-     * Handles sending selected registrations/contacts a newsletter.
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since  4.3.0
-     */
-    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()
-                : [];
-            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');
-                    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']))
-                : [];
-            $registrations_used_for_contact_data = [];
-            // 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(
-                        [
-                            [
-                                'REG_ID' => ['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',
-                [
-                    $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([['ATT_ID' => ['in', $ids]]]);
-            do_action_ref_array(
-                'AHEE__Extend_Registrations_Admin_Page___newsletter_selected_send',
-                [
-                    $contacts,
-                    $Message_Template_Group->ID(),
-                ]
-            );
-        }
-        $query_args = [
-            '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.
-     *
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    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
-     *
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    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 ReflectionException
-     * @throws Exception
-     * @throws Exception
-     * @throws Exception
-     */
-    private function _registrations_per_day_report(string $period = '-1 month'): string
-    {
-        $report_ID = 'reg-admin-registrations-per-day-report-dv';
-        $results   = EEM_Registration::instance()->get_registrations_per_day_and_per_status_report($period);
-        $regs      = [];
-        $subtitle  = '';
-        if ($results) {
-            $column_titles = [];
-            $tracker       = 0;
-            foreach ($results as $result) {
-                $report_column_values = [];
-                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 = [
-            '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 ReflectionException
-     * @throws Exception
-     * @throws Exception
-     * @throws Exception
-     */
-    private function _registrations_per_event_report(string $period = '-1 month'): string
-    {
-        $report_ID = 'reg-admin-registrations-per-event-report-dv';
-        $results   = EEM_Registration::instance()->get_registrations_per_event_and_per_status_report($period);
-        $regs      = [];
-        $subtitle  = '';
-        if ($results) {
-            $column_titles = [];
-            $tracker       = 0;
-            foreach ($results as $result) {
-                $report_column_values = [];
-                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 = [
-            '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)
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws ReflectionException
-     */
-    protected function _registration_checkin_list_table()
-    {
-        $REG_ID = $this->request->getRequestParam('_REG_ID', 0, DataType::INTEGER);
-        /** @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',
-            ['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                             = [
-            'checkin'  => [
-                'class' => $checked_in->cssClasses(),
-                'desc'  => $checked_in->legendLabel(),
-            ],
-            'checkout' => [
-                'class' => $checked_out->cssClasses(),
-                'desc'  => $checked_out->legendLabel(),
-            ],
-        ];
-        $this->_template_args['after_list_table'] = $this->_display_legend($legend_items);
-
-        $DTT_ID         = $this->request->getRequestParam('DTT_ID', 0, DataType::INTEGER);
-        $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                                    = ! $DTT_ID
-            ? EE_Admin_Page::add_query_args_and_nonce(
-                [
-                    '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']        = $REG_ID && $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'] = $REG_ID
-            ? '<input type="hidden" name="_REG_ID" value="' . $REG_ID . '">'
-            : '';
-        $this->_template_args['list_table_hidden_fields'] .= $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 ReflectionException
-     */
-    public function toggle_checkin_status()
-    {
-        if (! $this->capabilities->current_user_can('ee_edit_checkins', __FUNCTION__)) {
-            wp_die(esc_html__('You do not have the required privileges to perform this action', 'event_espresso'));
-        }
-        // 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 because we're not coming in from a 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,
-     *
-     * @return int|void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _toggle_checkin_status()
-    {
-        $DTT_ID = $this->request->getRequestParam('DTT_ID', 0, DataType::INTEGER);
-        $DTT_ID = $this->request->getRequestParam('dttid', $DTT_ID, DataType::INTEGER);
-        $DTT_ID = $this->request->getRequestParam('datetime_id', $DTT_ID, DataType::INTEGER);
-        $_REG_ID = $this->request->getRequestParam('_regid', 0, DataType::INTEGER);
-        $checkboxes = $this->request->getRequestParam('checkbox', [], DataType::INTEGER, true);
-
-        $new_status = false;
-        // bulk action check in toggle
-        if (! empty($checkboxes)) {
-            foreach ($checkboxes as $REG_ID) {
-                $new_status = $this->_toggle_checkin($REG_ID, $DTT_ID);
-            }
-        } elseif ($_REG_ID) {
-            $new_status = $this->_toggle_checkin($_REG_ID, $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') && DOING_AJAX) {
-            return $new_status;
-        }
-        $EVT_ID = $this->request->getRequestParam('EVT_ID', 0, DataType::INTEGER);
-        $EVT_ID = $this->request->getRequestParam('event_id', $EVT_ID, DataType::INTEGER);
-        $redirect_args = [
-            'action' => 'event_registrations',
-            'EVT_ID' => $EVT_ID,
-            'DTT_ID' => $DTT_ID,
-        ];
-        $this->_redirect_after_action(false, '', '', $redirect_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 bool|int   the chk_in status toggled to OR false if nothing got changed.
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _toggle_checkin(int $REG_ID, int $DTT_ID)
-    {
-        /** @var EE_Registration $REG */
-        $REG        = EEM_Registration::instance()->get_one_by_ID($REG_ID);
-        if (! $REG instanceof EE_Registration) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__('There is no registration with ID (%d)', 'event_espresso'),
-                    $REG_ID
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        $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
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _delete_checkin_rows()
-    {
-        $query_args = [
-            'action'  => 'registration_checkins',
-            'DTT_ID'  => $this->_req_data['DTT_ID'] ?? 0,
-            '_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 ReflectionException
-     */
-    protected function _delete_checkin_row()
-    {
-        $query_args = [
-            'action'  => 'registration_checkins',
-            'DTT_ID'  => $this->_req_data['DTT_ID'] ?? 0,
-            '_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);
-    }
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     */
-    protected function _event_registrations_list_table()
-    {
-        $EVT_ID                  = $this->request->getRequestParam('EVT_ID', 0, DataType::INTEGER);
-        $this->_admin_page_title .= $EVT_ID
-            ? $this->get_action_link_or_button(
-                'new_registration',
-                'add-registrant',
-                ['event_id' => $EVT_ID],
-                'add-new-h2'
-            )
-            : '';
-
-        $this->_template_args['before_list_table'] = $this->generateListTableHeaderText();
-        $this->_template_args['after_list_table']  = $this->generateListTableLegend();
-
-        $this->display_admin_list_table_page_with_no_sidebar();
-    }
-
-
-    /**
-     * @return string
-     * @since 5.0.24.p
-     */
-    private function generateListTableHeaderText(): string
-    {
-        $header_text                  = '';
-        $admin_page_header_decorators = [
-            'EventEspresso\core\domain\services\admin\registrations\list_table\page_header\AttendeeFilterHeader',
-            'EventEspresso\core\domain\services\admin\registrations\list_table\page_header\EventFilterHeader',
-            'EventEspresso\core\domain\services\admin\registrations\list_table\page_header\DateFilterHeader',
-            'EventEspresso\core\domain\services\admin\registrations\list_table\page_header\TicketFilterHeader',
-        ];
-        foreach ($admin_page_header_decorators as $admin_page_header_decorator) {
-            $filter_header_decorator = $this->loader->getNew($admin_page_header_decorator);
-            $header_text             = $filter_header_decorator->getHeaderText($header_text);
-        }
-        $header_text .= '
+			}
+			$codes[ $field ] = '<ul><li>' . implode('</li><li>', $available_shortcodes) . '</li></ul>';
+		}
+
+		EEH_Template::display_template(
+			REG_CAF_TEMPLATE_PATH . 'newsletter-send-form.template.php',
+			[
+				'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'        => $codes,
+				'id_type'           => $list_table instanceof EE_Attendee_Contact_List_Table ? 'contact'
+					: 'registration',
+			]
+		);
+	}
+
+
+	/**
+	 * Handles sending selected registrations/contacts a newsletter.
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since  4.3.0
+	 */
+	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()
+				: [];
+			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');
+					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']))
+				: [];
+			$registrations_used_for_contact_data = [];
+			// 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(
+						[
+							[
+								'REG_ID' => ['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',
+				[
+					$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([['ATT_ID' => ['in', $ids]]]);
+			do_action_ref_array(
+				'AHEE__Extend_Registrations_Admin_Page___newsletter_selected_send',
+				[
+					$contacts,
+					$Message_Template_Group->ID(),
+				]
+			);
+		}
+		$query_args = [
+			'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.
+	 *
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	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
+	 *
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	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 ReflectionException
+	 * @throws Exception
+	 * @throws Exception
+	 * @throws Exception
+	 */
+	private function _registrations_per_day_report(string $period = '-1 month'): string
+	{
+		$report_ID = 'reg-admin-registrations-per-day-report-dv';
+		$results   = EEM_Registration::instance()->get_registrations_per_day_and_per_status_report($period);
+		$regs      = [];
+		$subtitle  = '';
+		if ($results) {
+			$column_titles = [];
+			$tracker       = 0;
+			foreach ($results as $result) {
+				$report_column_values = [];
+				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 = [
+			'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 ReflectionException
+	 * @throws Exception
+	 * @throws Exception
+	 * @throws Exception
+	 */
+	private function _registrations_per_event_report(string $period = '-1 month'): string
+	{
+		$report_ID = 'reg-admin-registrations-per-event-report-dv';
+		$results   = EEM_Registration::instance()->get_registrations_per_event_and_per_status_report($period);
+		$regs      = [];
+		$subtitle  = '';
+		if ($results) {
+			$column_titles = [];
+			$tracker       = 0;
+			foreach ($results as $result) {
+				$report_column_values = [];
+				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 = [
+			'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)
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws ReflectionException
+	 */
+	protected function _registration_checkin_list_table()
+	{
+		$REG_ID = $this->request->getRequestParam('_REG_ID', 0, DataType::INTEGER);
+		/** @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',
+			['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                             = [
+			'checkin'  => [
+				'class' => $checked_in->cssClasses(),
+				'desc'  => $checked_in->legendLabel(),
+			],
+			'checkout' => [
+				'class' => $checked_out->cssClasses(),
+				'desc'  => $checked_out->legendLabel(),
+			],
+		];
+		$this->_template_args['after_list_table'] = $this->_display_legend($legend_items);
+
+		$DTT_ID         = $this->request->getRequestParam('DTT_ID', 0, DataType::INTEGER);
+		$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                                    = ! $DTT_ID
+			? EE_Admin_Page::add_query_args_and_nonce(
+				[
+					'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']        = $REG_ID && $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'] = $REG_ID
+			? '<input type="hidden" name="_REG_ID" value="' . $REG_ID . '">'
+			: '';
+		$this->_template_args['list_table_hidden_fields'] .= $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 ReflectionException
+	 */
+	public function toggle_checkin_status()
+	{
+		if (! $this->capabilities->current_user_can('ee_edit_checkins', __FUNCTION__)) {
+			wp_die(esc_html__('You do not have the required privileges to perform this action', 'event_espresso'));
+		}
+		// 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 because we're not coming in from a 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,
+	 *
+	 * @return int|void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _toggle_checkin_status()
+	{
+		$DTT_ID = $this->request->getRequestParam('DTT_ID', 0, DataType::INTEGER);
+		$DTT_ID = $this->request->getRequestParam('dttid', $DTT_ID, DataType::INTEGER);
+		$DTT_ID = $this->request->getRequestParam('datetime_id', $DTT_ID, DataType::INTEGER);
+		$_REG_ID = $this->request->getRequestParam('_regid', 0, DataType::INTEGER);
+		$checkboxes = $this->request->getRequestParam('checkbox', [], DataType::INTEGER, true);
+
+		$new_status = false;
+		// bulk action check in toggle
+		if (! empty($checkboxes)) {
+			foreach ($checkboxes as $REG_ID) {
+				$new_status = $this->_toggle_checkin($REG_ID, $DTT_ID);
+			}
+		} elseif ($_REG_ID) {
+			$new_status = $this->_toggle_checkin($_REG_ID, $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') && DOING_AJAX) {
+			return $new_status;
+		}
+		$EVT_ID = $this->request->getRequestParam('EVT_ID', 0, DataType::INTEGER);
+		$EVT_ID = $this->request->getRequestParam('event_id', $EVT_ID, DataType::INTEGER);
+		$redirect_args = [
+			'action' => 'event_registrations',
+			'EVT_ID' => $EVT_ID,
+			'DTT_ID' => $DTT_ID,
+		];
+		$this->_redirect_after_action(false, '', '', $redirect_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 bool|int   the chk_in status toggled to OR false if nothing got changed.
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _toggle_checkin(int $REG_ID, int $DTT_ID)
+	{
+		/** @var EE_Registration $REG */
+		$REG        = EEM_Registration::instance()->get_one_by_ID($REG_ID);
+		if (! $REG instanceof EE_Registration) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__('There is no registration with ID (%d)', 'event_espresso'),
+					$REG_ID
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		$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
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _delete_checkin_rows()
+	{
+		$query_args = [
+			'action'  => 'registration_checkins',
+			'DTT_ID'  => $this->_req_data['DTT_ID'] ?? 0,
+			'_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 ReflectionException
+	 */
+	protected function _delete_checkin_row()
+	{
+		$query_args = [
+			'action'  => 'registration_checkins',
+			'DTT_ID'  => $this->_req_data['DTT_ID'] ?? 0,
+			'_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);
+	}
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 */
+	protected function _event_registrations_list_table()
+	{
+		$EVT_ID                  = $this->request->getRequestParam('EVT_ID', 0, DataType::INTEGER);
+		$this->_admin_page_title .= $EVT_ID
+			? $this->get_action_link_or_button(
+				'new_registration',
+				'add-registrant',
+				['event_id' => $EVT_ID],
+				'add-new-h2'
+			)
+			: '';
+
+		$this->_template_args['before_list_table'] = $this->generateListTableHeaderText();
+		$this->_template_args['after_list_table']  = $this->generateListTableLegend();
+
+		$this->display_admin_list_table_page_with_no_sidebar();
+	}
+
+
+	/**
+	 * @return string
+	 * @since 5.0.24.p
+	 */
+	private function generateListTableHeaderText(): string
+	{
+		$header_text                  = '';
+		$admin_page_header_decorators = [
+			'EventEspresso\core\domain\services\admin\registrations\list_table\page_header\AttendeeFilterHeader',
+			'EventEspresso\core\domain\services\admin\registrations\list_table\page_header\EventFilterHeader',
+			'EventEspresso\core\domain\services\admin\registrations\list_table\page_header\DateFilterHeader',
+			'EventEspresso\core\domain\services\admin\registrations\list_table\page_header\TicketFilterHeader',
+		];
+		foreach ($admin_page_header_decorators as $admin_page_header_decorator) {
+			$filter_header_decorator = $this->loader->getNew($admin_page_header_decorator);
+			$header_text             = $filter_header_decorator->getHeaderText($header_text);
+		}
+		$header_text .= '
             <div class="description ee-status-outline ee-status-bg--info ee-status-outline--fit-content">
                 <strong>' . esc_html__(
-            'In this view, the check-in status represents the latest check-in record for the registration in that row.',
-            'event_espresso'
-        ) . '</strong>
+			'In this view, the check-in status represents the latest check-in record for the registration in that row.',
+			'event_espresso'
+		) . '</strong>
             </div>';
-        return $header_text;
-    }
-
-
-    /**
-     * @return string
-     * @throws EE_Error
-     * @since 5.0.24.p
-     */
-    private function generateListTableLegend(): string
-    {
-        $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);
-        $checkin_invalid = new CheckinStatusDashicon(EE_Checkin::status_invalid);
-
-        $legend_items = [
-            'star-icon'        => [
-                'class' => 'dashicons dashicons-star-filled gold-icon',
-                'desc'  => esc_html__('This Registrant is the Primary Registrant', 'event_espresso'),
-            ],
-            'checkin'          => [
-                'class' => $checked_in->cssClasses(),
-                'desc'  => $checked_in->legendLabel(),
-            ],
-            'checkout'         => [
-                'class' => $checked_out->cssClasses(),
-                'desc'  => $checked_out->legendLabel(),
-            ],
-            'nocheckinrecord'  => [
-                'class' => $checked_never->cssClasses(),
-                'desc'  => $checked_never->legendLabel(),
-            ],
-            'canNotCheckin'    => [
-                'class' => $checkin_invalid->cssClasses(),
-                'desc'  => $checkin_invalid->legendLabel(),
-            ],
-            'approved_status'  => [
-                'class' => 'ee-status-legend ee-status-bg--' . RegStatus::APPROVED,
-                'desc'  => EEH_Template::pretty_status(RegStatus::APPROVED, false, 'sentence'),
-            ],
-            'cancelled_status' => [
-                'class' => 'ee-status-legend ee-status-bg--' . RegStatus::CANCELLED,
-                'desc'  => EEH_Template::pretty_status(RegStatus::CANCELLED, false, 'sentence'),
-            ],
-            'declined_status'  => [
-                'class' => 'ee-status-legend ee-status-bg--' . RegStatus::DECLINED,
-                'desc'  => EEH_Template::pretty_status(RegStatus::DECLINED, false, 'sentence'),
-            ],
-            'not_approved'     => [
-                'class' => 'ee-status-legend ee-status-bg--' . RegStatus::AWAITING_REVIEW,
-                'desc'  => EEH_Template::pretty_status(RegStatus::AWAITING_REVIEW, false, 'sentence'),
-            ],
-            'pending_status'   => [
-                'class' => 'ee-status-legend ee-status-bg--' . RegStatus::PENDING_PAYMENT,
-                'desc'  => EEH_Template::pretty_status(RegStatus::PENDING_PAYMENT, false, 'sentence'),
-            ],
-            'wait_list'        => [
-                'class' => 'ee-status-legend ee-status-bg--' . RegStatus::WAIT_LIST,
-                'desc'  => EEH_Template::pretty_status(RegStatus::WAIT_LIST, false, 'sentence'),
-            ],
-        ];
-        return $this->_display_legend($legend_items);
-    }
-
-
-    /**
-     * 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 $query_params
-     * @param int   $per_page
-     * @param bool  $count
-     * @return array
-     * @throws EE_Error
-     */
-    protected function _get_checkin_query_params_from_request(
-        array $query_params,
-        int $per_page = 10,
-        bool $count = false
-    ): array {
-        $query_params = $this->_get_registration_query_parameters($query_params, $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',
-            [RegStatus::PENDING_PAYMENT, RegStatus::APPROVED]
-        );
-        $query_params[0]['STS_ID'] = ['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 ReflectionException
-     */
-    public function get_event_attendees(
-        int $per_page = 10,
-        bool $count = false,
-        bool $trash = false,
-        string $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'] = '';
-
-        return $count
-            ? EEM_Registration::instance()->count($query_params)
-            /** @type EE_Registration[] */
-            : EEM_Registration::instance()->get_all($query_params);
-    }
+		return $header_text;
+	}
+
+
+	/**
+	 * @return string
+	 * @throws EE_Error
+	 * @since 5.0.24.p
+	 */
+	private function generateListTableLegend(): string
+	{
+		$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);
+		$checkin_invalid = new CheckinStatusDashicon(EE_Checkin::status_invalid);
+
+		$legend_items = [
+			'star-icon'        => [
+				'class' => 'dashicons dashicons-star-filled gold-icon',
+				'desc'  => esc_html__('This Registrant is the Primary Registrant', 'event_espresso'),
+			],
+			'checkin'          => [
+				'class' => $checked_in->cssClasses(),
+				'desc'  => $checked_in->legendLabel(),
+			],
+			'checkout'         => [
+				'class' => $checked_out->cssClasses(),
+				'desc'  => $checked_out->legendLabel(),
+			],
+			'nocheckinrecord'  => [
+				'class' => $checked_never->cssClasses(),
+				'desc'  => $checked_never->legendLabel(),
+			],
+			'canNotCheckin'    => [
+				'class' => $checkin_invalid->cssClasses(),
+				'desc'  => $checkin_invalid->legendLabel(),
+			],
+			'approved_status'  => [
+				'class' => 'ee-status-legend ee-status-bg--' . RegStatus::APPROVED,
+				'desc'  => EEH_Template::pretty_status(RegStatus::APPROVED, false, 'sentence'),
+			],
+			'cancelled_status' => [
+				'class' => 'ee-status-legend ee-status-bg--' . RegStatus::CANCELLED,
+				'desc'  => EEH_Template::pretty_status(RegStatus::CANCELLED, false, 'sentence'),
+			],
+			'declined_status'  => [
+				'class' => 'ee-status-legend ee-status-bg--' . RegStatus::DECLINED,
+				'desc'  => EEH_Template::pretty_status(RegStatus::DECLINED, false, 'sentence'),
+			],
+			'not_approved'     => [
+				'class' => 'ee-status-legend ee-status-bg--' . RegStatus::AWAITING_REVIEW,
+				'desc'  => EEH_Template::pretty_status(RegStatus::AWAITING_REVIEW, false, 'sentence'),
+			],
+			'pending_status'   => [
+				'class' => 'ee-status-legend ee-status-bg--' . RegStatus::PENDING_PAYMENT,
+				'desc'  => EEH_Template::pretty_status(RegStatus::PENDING_PAYMENT, false, 'sentence'),
+			],
+			'wait_list'        => [
+				'class' => 'ee-status-legend ee-status-bg--' . RegStatus::WAIT_LIST,
+				'desc'  => EEH_Template::pretty_status(RegStatus::WAIT_LIST, false, 'sentence'),
+			],
+		];
+		return $this->_display_legend($legend_items);
+	}
+
+
+	/**
+	 * 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 $query_params
+	 * @param int   $per_page
+	 * @param bool  $count
+	 * @return array
+	 * @throws EE_Error
+	 */
+	protected function _get_checkin_query_params_from_request(
+		array $query_params,
+		int $per_page = 10,
+		bool $count = false
+	): array {
+		$query_params = $this->_get_registration_query_parameters($query_params, $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',
+			[RegStatus::PENDING_PAYMENT, RegStatus::APPROVED]
+		);
+		$query_params[0]['STS_ID'] = ['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 ReflectionException
+	 */
+	public function get_event_attendees(
+		int $per_page = 10,
+		bool $count = false,
+		bool $trash = false,
+		string $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'] = '';
+
+		return $count
+			? EEM_Registration::instance()->count($query_params)
+			/** @type EE_Registration[] */
+			: EEM_Registration::instance()->get_all($query_params);
+	}
 }

core/admin/EE_Admin_Page.core.php

Indentation +4237 added lines, -4237 removed lines

@@ -24,4333 +24,4333 @@
  */
 abstract class EE_Admin_Page extends EE_Base implements InterminableInterface
 {
-    protected ?EE_Admin_Config $admin_config       = null;
+	protected ?EE_Admin_Config $admin_config       = null;
 
-    protected ?EE_Admin_Hooks $_hook_obj          = null;
+	protected ?EE_Admin_Hooks $_hook_obj          = null;
 
-    protected ?EE_Admin_List_Table $_list_table_object = null;
+	protected ?EE_Admin_List_Table $_list_table_object = null;
 
-    protected ?EE_Capabilities $capabilities       = null;
+	protected ?EE_Capabilities $capabilities       = null;
 
-    protected ?EE_Registry $EE                 = null;
+	protected ?EE_Registry $EE                 = null;
 
-    protected ?FeatureFlags $feature            = null;
+	protected ?FeatureFlags $feature            = null;
 
-    protected ?LoaderInterface $loader             = null;
+	protected ?LoaderInterface $loader             = null;
 
-    protected ?RequestInterface $request            = null;
+	protected ?RequestInterface $request            = null;
 
-    protected ?WP_Screen $_current_screen    = null;
-
-    /**
-     * @var array
-     * @since 5.0.0.p
-     */
-    private array $publish_post_meta_box_hidden_fields = [];
-
-    /**
-     * some default things shared by all child classes
-     *
-     * @var string[]
-     */
-    protected array $_default_espresso_metaboxes = [
-        '_espresso_news_post_box',
-        '_espresso_links_post_box',
-        '_espresso_ratings_request',
-        '_espresso_sponsors_post_box',
-    ];
-
-    /**
-     * Used to hold default query args for list table routes to help preserve stickiness of filters for carried out
-     * actions.
-     *
-     * @since 4.6.x
-     */
-    protected array $_default_route_query_args = [];
-
-    protected array $_labels                   = [];
-
-    protected array $_nav_tabs                 = [];
-
-    protected array $_page_config              = [];
-
-    /**
-     * action => method pairs used for routing incoming requests
-     *
-     * @var array
-     */
-    protected array $_page_routes   = [];
-
-    protected array $_req_data      = [];
-
-    protected array $_route_config  = [];
-
-    protected array $_template_args = [];
-
-    protected array $_views         = [];
-
-    /**
-     * yes / no array for admin form fields
-     *
-     * @var array|array[]
-     */
-    protected array $_yes_no_values = [];
-
-    /**
-     * this starts at null so we can have no header routes progress through two states.
-     */
-    protected ?bool $_is_UI_request = null;
-
-    /**
-     * flags whether the given route is a caffeinated route or not.
-     */
-    protected bool $_is_caf        = false;
-
-    protected bool $_routing       = false;
-
-    /**
-     * whether initializePage() has run
-     *
-     * @var bool
-     */
-    protected bool $initialized = false;
-
-
-    protected string $_admin_base_path      = '';
-
-    protected string $_admin_base_url       = '';
-
-    protected string $_admin_page_title     = '';
-
-    protected string $_column_template_path = '';
-
-    protected bool $_cpt_route            = false;
-
-    /**
-     * set via request page and action args.
-     */
-    protected string $_current_page          = '';
-
-    protected string $_current_page_view_url = '';
-
-    protected string $_current_view          = '';
-
-    protected string $_default_nav_tab_name  = 'overview';
-
-    /**
-     * sanitized request action
-     */
-    protected string $_req_action = '';
-
-    /**
-     * sanitized request action nonce
-     */
-    protected string $_req_nonce        = '';
-
-    protected string $_search_btn_label = '';
-
-    protected string $_template_path    = '';
-
-    protected string $_view             = '';
-
-    /**
-     * set early within EE_Admin_Init
-     *
-     * @var string
-     */
-    protected string $_wp_page_slug = '';
-
-    /**
-     * if the current class is an admin page extension, like: Extend_Events_Admin_Page,
-     * then this would be the parent classname: Events_Admin_Page
-     *
-     * @var string
-     */
-    public string $base_class_name = '';
-
-    public string $class_name      = '';
-
-    /**
-     * unprocessed value for the 'action' request param (default '')
-     *
-     * @var string
-     */
-    protected string $raw_req_action = '';
-
-    /**
-     * unprocessed value for the 'page' request param (default '')
-     *
-     * @var string
-     */
-    protected string $raw_req_page = '';
-
-    public string $page_folder  = '';
-
-    public string $page_label   = '';
-
-    public string $page_slug    = '';
-
-
-    /**
-     * the current page route and route config
-     *
-     * @var array|callable|string|null
-     */
-    protected $_route = null;
-
-
-    /**
-     * @Constructor
-     * @param bool $routing indicate whether we want to just load the object and handle routing or just load the object.
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function __construct($routing = true)
-    {
-        $this->_routing = $routing;
-
-        $this->loader       = LoaderFactory::getLoader();
-        $this->admin_config = $this->loader->getShared(EE_Admin_Config::class);
-        $this->feature      = $this->loader->getShared(FeatureFlags::class);
-        $this->request      = $this->loader->getShared(RequestInterface::class);
-        $this->capabilities = $this->loader->getShared(EE_Capabilities::class);
-
-        $this->class_name      = get_class($this);
-        $this->base_class_name = strpos($this->class_name, 'Extend_') === 0
-            ? str_replace('Extend_', '', $this->class_name)
-            : '';
-
-        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();
-    }
-
-
-    /**
-     * @return EE_Admin_Config
-     */
-    public function adminConfig(): EE_Admin_Config
-    {
-        return $this->admin_config;
-    }
-
-
-    public function capabilities(): EE_Capabilities
-    {
-        if (! $this->capabilities instanceof EE_Capabilities) {
-            $this->capabilities = $this->loader->getShared(EE_Capabilities::class);
-        }
-        return $this->capabilities;
-    }
-
-
-    /**
-     * @return FeatureFlags
-     */
-    public function feature(): FeatureFlags
-    {
-        return $this->feature;
-    }
-
-
-    /**
-     * This logic used to be in the constructor, but that caused a chicken <--> egg scenario
-     * for child classes that needed to set properties prior to these methods getting called,
-     * but also needed the parent class to have its construction completed as well.
-     * Bottom line is that constructors should ONLY be used for setting initial properties
-     * and any complex initialization logic should only run after instantiation is complete.
-     * This method gets called immediately after construction from within
-     *      EE_Admin_Page_Init::_initialize_admin_page()
-     *
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws Throwable
-     * @since 5.0.0.p
-     */
-    public function initializePage()
-    {
-        if ($this->initialized) {
-            return;
-        }
-        // 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.
-        if ($this->request->isAjax()) {
-            $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();
-        $this->initialized = true;
-    }
-
-
-    /**
-     * _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 an 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 set up 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 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 (it's 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()
-    {
-    }
+	protected ?WP_Screen $_current_screen    = null;
 
+	/**
+	 * @var array
+	 * @since 5.0.0.p
+	 */
+	private array $publish_post_meta_box_hidden_fields = [];
 
-    /**
-     * _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']);
-
-        add_action(
-            'wp_ajax_espresso_hide_status_change_notice',
-            [$this, 'hideStatusChangeNotice']
-        );
-        add_action(
-            'wp_ajax_nopriv_espresso_hide_status_change_notice',
-            [$this, 'hideStatusChangeNotice']
-        );
-    }
-
-
-    public function ajax_metabox_content()
-    {
-        $content_id  = $this->request->getRequestParam('contentid', '');
-        $content_url = $this->request->getRequestParam('contenturl', '', DataType::URL);
-        EE_Admin_Page::cached_rss_display($content_id, $content_url);
-        wp_die();
-    }
-
-
-    public function hideStatusChangeNotice()
-    {
-        $response = [];
-        try {
-            /** @var StatusChangeNotice $status_change_notice */
-            $status_change_notice = $this->loader->getShared(
-                'EventEspresso\core\domain\services\admin\notices\status_change\StatusChangeNotice'
-            );
-            $response['success']  = $status_change_notice->dismiss() > -1;
-        } catch (Exception $exception) {
-            $response['errors'] = $exception->getMessage();
-        }
-        wp_send_json($response);
-    }
+	/**
+	 * some default things shared by all child classes
+	 *
+	 * @var string[]
+	 */
+	protected array $_default_espresso_metaboxes = [
+		'_espresso_news_post_box',
+		'_espresso_links_post_box',
+		'_espresso_ratings_request',
+		'_espresso_sponsors_post_box',
+	];
 
+	/**
+	 * Used to hold default query args for list table routes to help preserve stickiness of filters for carried out
+	 * actions.
+	 *
+	 * @since 4.6.x
+	 */
+	protected array $_default_route_query_args = [];
 
-    /**
-     * 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
-    }
+	protected array $_labels                   = [];
 
+	protected array $_nav_tabs                 = [];
 
-    /**
-     * 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
-     * @throws Throwable
-     */
-    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', '', DataType::KEY);
-        $this->_current_page = $this->request->getRequestParam('current_page', $this->_current_page, DataType::KEY);
-        $this->page_folder   = strtolower(
-            str_replace(['_Admin_Page', 'Extend_'], '', $this->class_name)
-        );
-        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', DataType::KEY);
-        $action2    = $this->request->getRequestParam('action2', '-1', DataType::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');
-        $route = $route !== '-1' ? $route : 'default';
-        $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
-        );
-        // 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 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__' . $this->class_name . '__page_setup__page_routes',
-            $this->_page_routes,
-            $this
-        );
-        $this->_page_config = apply_filters(
-            'FHEE__' . $this->class_name . '__page_setup__page_config',
-            $this->_page_config,
-            $this
-        );
-        if ($this->base_class_name !== '') {
-            $this->_page_routes = apply_filters(
-                'FHEE__' . $this->base_class_name . '__page_setup__page_routes',
-                $this->_page_routes,
-                $this
-            );
-            $this->_page_config = apply_filters(
-                'FHEE__' . $this->base_class_name . '__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']);
-                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();
-            }
-        }
-    }
+	protected array $_page_config              = [];
 
+	/**
+	 * action => method pairs used for routing incoming requests
+	 *
+	 * @var array
+	 */
+	protected array $_page_routes   = [];
 
-    /**
-     * 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 set up 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));
-            }
-            // don't load the same class twice
-            static $loaded = [];
-            if (in_array($classname, $loaded, true)) {
-                continue;
-            }
-            $loaded[] = $classname;
-            // notice we are passing the instance of this class to the hook object.
-            $this->loader->getShared($classname, [$this]);
-        }
-    }
+	protected array $_req_data      = [];
 
+	protected array $_route_config  = [];
 
-    /**
-     * @throws ReflectionException
-     * @throws EE_Error
-     */
-    public function load_page_dependencies()
-    {
-        try {
-            $this->_load_page_dependencies();
-        } catch (EE_Error $e) {
-            $e->get_error();
-        }
-    }
+	protected array $_template_args = [];
 
+	protected array $_views         = [];
 
-    /**
-     * load_page_dependencies
-     * loads things specific to this page class when it's loaded.  Really helps with efficiency.
-     *
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    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']);
-        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.
-        add_action('add_meta_boxes', [$this, 'addRegisteredMetaBoxes'], 99);
-        // hack because promos admin was loading the edited promotion object in the metaboxes callback
-        // which should NOT be generated on non-UI requests like POST updates/inserts
-        if (
-            $this->class_name === 'Promotions_Admin_Page'
-            && ($this->_req_action === 'edit' || $this->_req_action === 'create_new')
-        ) {
-            $this->addRegisteredMetaBoxes();
-        }
-        $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, 'admin_footer_scripts_eei18n_js_strings'], 1);
-        add_action('admin_enqueue_scripts', [$this, 'load_global_scripts_styles'], 5);
-        add_action('admin_enqueue_scripts', [$this, 'load_scripts_styles']);
-        if (method_exists($this, "load_scripts_styles_$this->_current_view")) {
-            add_action('admin_enqueue_scripts', [$this, "load_scripts_styles_$this->_current_view"], 15);
-        }
-        // 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"
-        );
-    }
+	/**
+	 * yes / no array for admin form fields
+	 *
+	 * @var array|array[]
+	 */
+	protected array $_yes_no_values = [];
 
+	/**
+	 * this starts at null so we can have no header routes progress through two states.
+	 */
+	protected ?bool $_is_UI_request = null;
 
-    /**
-     * _set_defaults
-     * This sets some global defaults for class properties.
-     */
-    private function _set_defaults()
-    {
-        // init template args
-        $this->set_template_args(
-            [
-                'admin_page_header'  => '',
-                'admin_page_content' => '',
-                'post_body_content'  => '',
-                'before_list_table'  => '',
-                'after_list_table'   => '',
-            ]
-        );
-    }
+	/**
+	 * flags whether the given route is a caffeinated route or not.
+	 */
+	protected bool $_is_caf        = false;
 
+	protected bool $_routing       = false;
 
-    /**
-     * route_admin_request
-     *
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws Throwable
-     * @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';
-        }
-    }
+	/**
+	 * whether initializePage() has run
+	 *
+	 * @var bool
+	 */
+	protected bool $initialized = false;
 
 
-    /**
-     * _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(): bool
-    {
-        if (! $this->_current_page && ! $this->request->isAjax()) {
-            return 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);
-        }
-        // route 'editpost' routes to CPT 'edit' routes
-        $alt_edit_route = $this instanceof EE_Admin_Page_CPT ? $this->cpt_editpost_route : 'edit';
-        if (
-            $this->_req_action === 'editpost'
-            && ! isset($this->_page_routes['editpost'])
-            && isset($this->_page_routes[ $alt_edit_route ])
-        ) {
-            $this->_req_action = $alt_edit_route;
-        }
-        // 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 = $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) {
-            // let's set if this is a UI request or not.
-            $this->_is_UI_request = ! $this->request->getRequestParam('noheader', false, DataType::BOOL);
-            // wait a minute... we might have a noheader in the route array
-            $this->_is_UI_request = ! (isset($this->_route['noheader']) && $this->_route['noheader'])
-                ? $this->_is_UI_request
-                : false;
-        }
-        $this->_set_current_labels();
-        return true;
-    }
+	protected string $_admin_base_path      = '';
 
+	protected string $_admin_base_url       = '';
 
-    /**
-     * this method simply verifies a given route and makes sure it's 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(string $route): bool
-    {
-        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);
-    }
+	protected string $_admin_page_title     = '';
 
+	protected string $_column_template_path = '';
 
-    /**
-     * 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
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _verify_nonce(string $nonce = '', string $nonce_ref = '')
-    {
-        $nonce = $nonce ?: $this->request->getRequestParam($this->_req_nonce, '');
-        $nonce_ref = $nonce_ref ?: $this->_req_action;
-        // 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();
-        }
-    }
+	protected bool $_cpt_route            = false;
 
+	/**
+	 * set via request page and action args.
+	 */
+	protected string $_current_page          = '';
 
-    /**
-     * _route_admin_request()
-     * Meat and potatoes of the class.  Basically, this dude checks out what's being requested and sees if there 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
-     * @throws Throwable
-     */
-    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 = $this->_route['func'] ?? $this->_route;
-        // check if callback has args
-        $args = $this->_route['args'] ?? [];
-
-        // 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);
-        }
-        // strip _wp_http_referer from the server REQUEST_URI
-        // else it grows in length on every submission due to recursion,
-        // ultimately causing a "Request-URI Too Large" error
-        $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, true);
-        $this->request->setServerParam('REQUEST_URI', $cleaner_request_uri, true);
-        $route_callback = [];
-        if (! empty($func)) {
-            if (is_array($func) && is_callable($func)) {
-                $route_callback = $func;
-            } elseif (is_string($func)) {
-                if (strpos($func, '::') !== false) {
-                    $route_callback = explode('::', $func);
-                } elseif (method_exists($this, $func)) {
-                    $route_callback = [$this, $func];
-                } else {
-                    $route_callback = $func;
-                }
-            }
-            [$class, $method] = $route_callback;
-            // is it neither a class method NOR a standalone function?
-            if (! is_callable($route_callback)) {
-                // 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
-                );
-                throw new DomainException($error_msg);
-            }
-            if ($class !== $this && ! in_array($this, $args)) {
-                // send along this admin page object for access by addons.
-                $args['admin_page'] = $this;
-            }
-
-            call_user_func_array($route_callback, $args);
-        }
-        // 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']);
-        }
-    }
+	protected string $_current_page_view_url = '';
 
+	protected string $_current_view          = '';
 
-    /**
-     * 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
-     * @throws Throwable
-     * @since   4.3.0
-     */
-    protected function _reset_routing_properties(string $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();
-    }
+	protected string $_default_nav_tab_name  = 'overview';
 
+	/**
+	 * sanitized request action
+	 */
+	protected string $_req_action = '';
+
+	/**
+	 * sanitized request action nonce
+	 */
+	protected string $_req_nonce        = '';
+
+	protected string $_search_btn_label = '';
+
+	protected string $_template_path    = '';
+
+	protected string $_view             = '';
 
-    /**
-     * _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 nonce will be excluded from the generated nonce.
-     * @param int    $context
-     * @return string
-     */
-    public static function add_query_args_and_nonce(
-        array $args = [],
-        string $url = '',
-        bool $sticky = false,
-        bool $exclude_nonce = false,
-        int $context = EEH_URL::CONTEXT_NONE
-    ): string {
-        // 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);
-            $request->unSetServerParam('_wp_http_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, $context);
-    }
+	/**
+	 * set early within EE_Admin_Init
+	 *
+	 * @var string
+	 */
+	protected string $_wp_page_slug = '';
 
+	/**
+	 * if the current class is an admin page extension, like: Extend_Events_Admin_Page,
+	 * then this would be the parent classname: Events_Admin_Page
+	 *
+	 * @var string
+	 */
+	public string $base_class_name = '';
 
-    /**
-     * 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(string $help_tab_id, string $icon_style = '', string $help_text = ''): string
-    {
-        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
-     * @throws ReflectionException
-     */
-    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.  Double check the spelling and make sure this method exists for the class %s',
-                                'event_espresso'
-                            ),
-                            $config['help_sidebar'],
-                            $this->class_name
-                        )
-                    );
-                }
-                $content = apply_filters(
-                    'FHEE__' . $this->class_name . '__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 = $cfg['content'];
-                    // 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 an 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
-     * @throws ReflectionException
-     * @throws EE_Error
-     */
-    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);
-        }
-    }
+	public string $class_name      = '';
 
-
-    /**
-     * _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()
-    {
-        $i        = 0;
-        $only_tab = count($this->_page_config) < 2;
-        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 = $config['css_class'] ?? '';
-            $css_class .= $only_tab ? ' ee-only-tab' : '';
-            $css_class .= " ee-nav-tab__$slug";
-
-            $this->_nav_tabs[ $slug ] = [
-                'url'       => $config['nav']['url'] ?? EE_Admin_Page::add_query_args_and_nonce(
-                    ['action' => $slug],
-                    $this->_admin_base_url
-                ),
-                'link_text' => $this->navTabLabel($config['nav'], $slug),
-                'css_class' => $this->_req_action === $slug ? $css_class . ' nav-tab-active' : $css_class,
-                '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']);
-    }
-
-
-    private function navTabLabel(array $nav_tab, string $slug): string
-    {
-        $label = $nav_tab['label'] ?? ucwords(str_replace('_', ' ', $slug));
-        $icon  = $nav_tab['icon'] ?? null;
-        $icon  = $icon ? '<span class="dashicons ' . $icon . '"></span>' : '';
-        return '
+	/**
+	 * unprocessed value for the 'action' request param (default '')
+	 *
+	 * @var string
+	 */
+	protected string $raw_req_action = '';
+
+	/**
+	 * unprocessed value for the 'page' request param (default '')
+	 *
+	 * @var string
+	 */
+	protected string $raw_req_page = '';
+
+	public string $page_folder  = '';
+
+	public string $page_label   = '';
+
+	public string $page_slug    = '';
+
+
+	/**
+	 * the current page route and route config
+	 *
+	 * @var array|callable|string|null
+	 */
+	protected $_route = null;
+
+
+	/**
+	 * @Constructor
+	 * @param bool $routing indicate whether we want to just load the object and handle routing or just load the object.
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function __construct($routing = true)
+	{
+		$this->_routing = $routing;
+
+		$this->loader       = LoaderFactory::getLoader();
+		$this->admin_config = $this->loader->getShared(EE_Admin_Config::class);
+		$this->feature      = $this->loader->getShared(FeatureFlags::class);
+		$this->request      = $this->loader->getShared(RequestInterface::class);
+		$this->capabilities = $this->loader->getShared(EE_Capabilities::class);
+
+		$this->class_name      = get_class($this);
+		$this->base_class_name = strpos($this->class_name, 'Extend_') === 0
+			? str_replace('Extend_', '', $this->class_name)
+			: '';
+
+		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();
+	}
+
+
+	/**
+	 * @return EE_Admin_Config
+	 */
+	public function adminConfig(): EE_Admin_Config
+	{
+		return $this->admin_config;
+	}
+
+
+	public function capabilities(): EE_Capabilities
+	{
+		if (! $this->capabilities instanceof EE_Capabilities) {
+			$this->capabilities = $this->loader->getShared(EE_Capabilities::class);
+		}
+		return $this->capabilities;
+	}
+
+
+	/**
+	 * @return FeatureFlags
+	 */
+	public function feature(): FeatureFlags
+	{
+		return $this->feature;
+	}
+
+
+	/**
+	 * This logic used to be in the constructor, but that caused a chicken <--> egg scenario
+	 * for child classes that needed to set properties prior to these methods getting called,
+	 * but also needed the parent class to have its construction completed as well.
+	 * Bottom line is that constructors should ONLY be used for setting initial properties
+	 * and any complex initialization logic should only run after instantiation is complete.
+	 * This method gets called immediately after construction from within
+	 *      EE_Admin_Page_Init::_initialize_admin_page()
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws Throwable
+	 * @since 5.0.0.p
+	 */
+	public function initializePage()
+	{
+		if ($this->initialized) {
+			return;
+		}
+		// 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.
+		if ($this->request->isAjax()) {
+			$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();
+		$this->initialized = true;
+	}
+
+
+	/**
+	 * _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 an 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 set up 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 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 (it's 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']);
+
+		add_action(
+			'wp_ajax_espresso_hide_status_change_notice',
+			[$this, 'hideStatusChangeNotice']
+		);
+		add_action(
+			'wp_ajax_nopriv_espresso_hide_status_change_notice',
+			[$this, 'hideStatusChangeNotice']
+		);
+	}
+
+
+	public function ajax_metabox_content()
+	{
+		$content_id  = $this->request->getRequestParam('contentid', '');
+		$content_url = $this->request->getRequestParam('contenturl', '', DataType::URL);
+		EE_Admin_Page::cached_rss_display($content_id, $content_url);
+		wp_die();
+	}
+
+
+	public function hideStatusChangeNotice()
+	{
+		$response = [];
+		try {
+			/** @var StatusChangeNotice $status_change_notice */
+			$status_change_notice = $this->loader->getShared(
+				'EventEspresso\core\domain\services\admin\notices\status_change\StatusChangeNotice'
+			);
+			$response['success']  = $status_change_notice->dismiss() > -1;
+		} catch (Exception $exception) {
+			$response['errors'] = $exception->getMessage();
+		}
+		wp_send_json($response);
+	}
+
+
+	/**
+	 * 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
+	 * @throws Throwable
+	 */
+	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', '', DataType::KEY);
+		$this->_current_page = $this->request->getRequestParam('current_page', $this->_current_page, DataType::KEY);
+		$this->page_folder   = strtolower(
+			str_replace(['_Admin_Page', 'Extend_'], '', $this->class_name)
+		);
+		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', DataType::KEY);
+		$action2    = $this->request->getRequestParam('action2', '-1', DataType::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');
+		$route = $route !== '-1' ? $route : 'default';
+		$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
+		);
+		// 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 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__' . $this->class_name . '__page_setup__page_routes',
+			$this->_page_routes,
+			$this
+		);
+		$this->_page_config = apply_filters(
+			'FHEE__' . $this->class_name . '__page_setup__page_config',
+			$this->_page_config,
+			$this
+		);
+		if ($this->base_class_name !== '') {
+			$this->_page_routes = apply_filters(
+				'FHEE__' . $this->base_class_name . '__page_setup__page_routes',
+				$this->_page_routes,
+				$this
+			);
+			$this->_page_config = apply_filters(
+				'FHEE__' . $this->base_class_name . '__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']);
+				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 set up 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));
+			}
+			// don't load the same class twice
+			static $loaded = [];
+			if (in_array($classname, $loaded, true)) {
+				continue;
+			}
+			$loaded[] = $classname;
+			// 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 it's loaded.  Really helps with efficiency.
+	 *
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	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']);
+		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.
+		add_action('add_meta_boxes', [$this, 'addRegisteredMetaBoxes'], 99);
+		// hack because promos admin was loading the edited promotion object in the metaboxes callback
+		// which should NOT be generated on non-UI requests like POST updates/inserts
+		if (
+			$this->class_name === 'Promotions_Admin_Page'
+			&& ($this->_req_action === 'edit' || $this->_req_action === 'create_new')
+		) {
+			$this->addRegisteredMetaBoxes();
+		}
+		$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, 'admin_footer_scripts_eei18n_js_strings'], 1);
+		add_action('admin_enqueue_scripts', [$this, 'load_global_scripts_styles'], 5);
+		add_action('admin_enqueue_scripts', [$this, 'load_scripts_styles']);
+		if (method_exists($this, "load_scripts_styles_$this->_current_view")) {
+			add_action('admin_enqueue_scripts', [$this, "load_scripts_styles_$this->_current_view"], 15);
+		}
+		// 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()
+	{
+		// init template args
+		$this->set_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
+	 * @throws Throwable
+	 * @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(): bool
+	{
+		if (! $this->_current_page && ! $this->request->isAjax()) {
+			return 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);
+		}
+		// route 'editpost' routes to CPT 'edit' routes
+		$alt_edit_route = $this instanceof EE_Admin_Page_CPT ? $this->cpt_editpost_route : 'edit';
+		if (
+			$this->_req_action === 'editpost'
+			&& ! isset($this->_page_routes['editpost'])
+			&& isset($this->_page_routes[ $alt_edit_route ])
+		) {
+			$this->_req_action = $alt_edit_route;
+		}
+		// 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 = $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) {
+			// let's set if this is a UI request or not.
+			$this->_is_UI_request = ! $this->request->getRequestParam('noheader', false, DataType::BOOL);
+			// wait a minute... we might have a noheader in the route array
+			$this->_is_UI_request = ! (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 it's 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(string $route): bool
+	{
+		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
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _verify_nonce(string $nonce = '', string $nonce_ref = '')
+	{
+		$nonce = $nonce ?: $this->request->getRequestParam($this->_req_nonce, '');
+		$nonce_ref = $nonce_ref ?: $this->_req_action;
+		// 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 there 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
+	 * @throws Throwable
+	 */
+	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 = $this->_route['func'] ?? $this->_route;
+		// check if callback has args
+		$args = $this->_route['args'] ?? [];
+
+		// 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);
+		}
+		// strip _wp_http_referer from the server REQUEST_URI
+		// else it grows in length on every submission due to recursion,
+		// ultimately causing a "Request-URI Too Large" error
+		$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, true);
+		$this->request->setServerParam('REQUEST_URI', $cleaner_request_uri, true);
+		$route_callback = [];
+		if (! empty($func)) {
+			if (is_array($func) && is_callable($func)) {
+				$route_callback = $func;
+			} elseif (is_string($func)) {
+				if (strpos($func, '::') !== false) {
+					$route_callback = explode('::', $func);
+				} elseif (method_exists($this, $func)) {
+					$route_callback = [$this, $func];
+				} else {
+					$route_callback = $func;
+				}
+			}
+			[$class, $method] = $route_callback;
+			// is it neither a class method NOR a standalone function?
+			if (! is_callable($route_callback)) {
+				// 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
+				);
+				throw new DomainException($error_msg);
+			}
+			if ($class !== $this && ! in_array($this, $args)) {
+				// send along this admin page object for access by addons.
+				$args['admin_page'] = $this;
+			}
+
+			call_user_func_array($route_callback, $args);
+		}
+		// 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
+	 * @throws Throwable
+	 * @since   4.3.0
+	 */
+	protected function _reset_routing_properties(string $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 nonce will be excluded from the generated nonce.
+	 * @param int    $context
+	 * @return string
+	 */
+	public static function add_query_args_and_nonce(
+		array $args = [],
+		string $url = '',
+		bool $sticky = false,
+		bool $exclude_nonce = false,
+		int $context = EEH_URL::CONTEXT_NONE
+	): string {
+		// 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);
+			$request->unSetServerParam('_wp_http_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, $context);
+	}
+
+
+	/**
+	 * 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(string $help_tab_id, string $icon_style = '', string $help_text = ''): string
+	{
+		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
+	 * @throws ReflectionException
+	 */
+	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.  Double check the spelling and make sure this method exists for the class %s',
+								'event_espresso'
+							),
+							$config['help_sidebar'],
+							$this->class_name
+						)
+					);
+				}
+				$content = apply_filters(
+					'FHEE__' . $this->class_name . '__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 = $cfg['content'];
+					// 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 an 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
+	 * @throws ReflectionException
+	 * @throws EE_Error
+	 */
+	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()
+	{
+		$i        = 0;
+		$only_tab = count($this->_page_config) < 2;
+		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 = $config['css_class'] ?? '';
+			$css_class .= $only_tab ? ' ee-only-tab' : '';
+			$css_class .= " ee-nav-tab__$slug";
+
+			$this->_nav_tabs[ $slug ] = [
+				'url'       => $config['nav']['url'] ?? EE_Admin_Page::add_query_args_and_nonce(
+					['action' => $slug],
+					$this->_admin_base_url
+				),
+				'link_text' => $this->navTabLabel($config['nav'], $slug),
+				'css_class' => $this->_req_action === $slug ? $css_class . ' nav-tab-active' : $css_class,
+				'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']);
+	}
+
+
+	private function navTabLabel(array $nav_tab, string $slug): string
+	{
+		$label = $nav_tab['label'] ?? ucwords(str_replace('_', ' ', $slug));
+		$icon  = $nav_tab['icon'] ?? null;
+		$icon  = $icon ? '<span class="dashicons ' . $icon . '"></span>' : '';
+		return '
             <span class="ee-admin-screen-tab__label">
                 ' . $icon . '
                 <span class="ee-nav-label__text">' . $label . '</span>
             </span>';
-    }
-
-
-    /**
-     * _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 (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(string $route_to_check = '', bool $verify_only = false): bool
-    {
-        // if no route_to_check is passed in then use the current route set via _req_action
-        $action = $route_to_check ?: $this->_req_action;
-        $capability = ! empty($this->_page_routes[ $action ]['capability'])
-            ? $this->_page_routes[ $action ]['capability']
-            : null;
-
-        if (empty($capability)) {
-            $capability = empty($route_to_check) && ! empty($this->_route['capability'])
-                ? $this->_route['capability']
-                : 'manage_options';
-        }
-
-        $id = $this->_route['obj_id'] ?? 0;
-
-        if (
-            ! $this->request->isAjax()
-            && (
-                ! function_exists('is_admin')
-                || ! $this->capabilities->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'));
-            }
-            return false;
-        }
-        return true;
-    }
-
-
-    /**
-     * @param string                 $box_id
-     * @param string                 $title
-     * @param callable|string|null   $callback
-     * @param string|array|WP_Screen $screen
-     * @param string                 $context       Post edit screen contexts include 'normal', 'side', and 'advanced'.
-     *                                              Comments screen contexts include 'normal' and 'side'.
-     *                                              Menus meta boxes (accordion sections) all use the 'side' context.
-     * @param string                 $priority      Accepts 'high', 'core', 'default', or 'low'.
-     * @param array|null             $callback_args
-     */
-    protected function addMetaBox(
-        string $box_id,
-        string $title,
-        $callback,
-        $screen,
-        string $context = 'normal',
-        string $priority = 'default',
-        ?array $callback_args = null
-    ) {
-        if (! (is_callable($callback) || ! function_exists($callback))) {
-            return;
-        }
-
-        add_meta_box($box_id, $title, $callback, $screen, $context, $priority, $callback_args);
-        add_filter(
-            "postbox_classes_{$this->_wp_page_slug}_$box_id",
-            function ($classes) {
-                $classes[] = 'ee-admin-container';
-                return $classes;
-            }
-        );
-    }
-
-
-    /**
-     * 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 '
+	}
+
+
+	/**
+	 * _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 (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(string $route_to_check = '', bool $verify_only = false): bool
+	{
+		// if no route_to_check is passed in then use the current route set via _req_action
+		$action = $route_to_check ?: $this->_req_action;
+		$capability = ! empty($this->_page_routes[ $action ]['capability'])
+			? $this->_page_routes[ $action ]['capability']
+			: null;
+
+		if (empty($capability)) {
+			$capability = empty($route_to_check) && ! empty($this->_route['capability'])
+				? $this->_route['capability']
+				: 'manage_options';
+		}
+
+		$id = $this->_route['obj_id'] ?? 0;
+
+		if (
+			! $this->request->isAjax()
+			&& (
+				! function_exists('is_admin')
+				|| ! $this->capabilities->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'));
+			}
+			return false;
+		}
+		return true;
+	}
+
+
+	/**
+	 * @param string                 $box_id
+	 * @param string                 $title
+	 * @param callable|string|null   $callback
+	 * @param string|array|WP_Screen $screen
+	 * @param string                 $context       Post edit screen contexts include 'normal', 'side', and 'advanced'.
+	 *                                              Comments screen contexts include 'normal' and 'side'.
+	 *                                              Menus meta boxes (accordion sections) all use the 'side' context.
+	 * @param string                 $priority      Accepts 'high', 'core', 'default', or 'low'.
+	 * @param array|null             $callback_args
+	 */
+	protected function addMetaBox(
+		string $box_id,
+		string $title,
+		$callback,
+		$screen,
+		string $context = 'normal',
+		string $priority = 'default',
+		?array $callback_args = null
+	) {
+		if (! (is_callable($callback) || ! function_exists($callback))) {
+			return;
+		}
+
+		add_meta_box($box_id, $title, $callback, $screen, $context, $priority, $callback_args);
+		add_filter(
+			"postbox_classes_{$this->_wp_page_slug}_$box_id",
+			function ($classes) {
+				$classes[] = 'ee-admin-container';
+				return $classes;
+			}
+		);
+	}
+
+
+	/**
+	 * 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>
         <span id="current_timezone" class="hidden">' . esc_html(EEH_DTT_Helper::get_timezone()) . '</span>
         <input type="hidden" id="espresso_admin_current_page" value="' . esc_attr($this->_current_page) . '"/>';
-    }
-
-
-    /**
-     * 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 set up 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(array $help_array = [], bool $display = false): string
-    {
-        $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 set up properly
-            if (! isset($help['title'], $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 set up 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(): array
-    {
-        // 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 = $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 bool   $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(string $trigger_id, bool $display = true, array $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);
-        }
-        $height   = esc_attr($dimensions[0]) ?? 400;
-        $width    = esc_attr($dimensions[1]) ?? 640;
-        $inlineId = esc_attr($trigger_id);
-        // let's setup the trigger
-        $content = "
+	}
+
+
+	/**
+	 * 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 set up 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(array $help_array = [], bool $display = false): string
+	{
+		$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 set up properly
+			if (! isset($help['title'], $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 set up 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(): array
+	{
+		// 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 = $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 bool   $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(string $trigger_id, bool $display = true, array $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);
+		}
+		$height   = esc_attr($dimensions[0]) ?? 400;
+		$width    = esc_attr($dimensions[1]) ?? 640;
+		$inlineId = esc_attr($trigger_id);
+		// let's setup the trigger
+		$content = "
         <a class='ee-dialog' href='?height=$height&width=$width&inlineId=$inlineId' 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 (it's 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()
-    {
-        // add debugging styles
-        if (WP_DEBUG) {
-            add_action('admin_head', [$this, 'add_xdebug_style']);
-        }
-        // taking care of metaboxes
-        if (
-            empty($this->_cpt_route)
-            && (isset($this->_route_config['metaboxes']) || isset($this->_route_config['has_metaboxes']))
-        ) {
-            wp_enqueue_script('dashboard');
-        }
-
-        wp_enqueue_script(JqueryAssetManager::JS_HANDLE_JQUERY_UI_TOUCH_PUNCH);
-        wp_enqueue_script(EspressoLegacyAdminAssetManager::JS_HANDLE_EE_ADMIN);
-        // LOCALIZED DATA
-        // localize script for ajax lazy loading
-        wp_localize_script(
-            EspressoLegacyAdminAssetManager::JS_HANDLE_EE_ADMIN,
-            'eeLazyLoadingContainers',
-            apply_filters(
-                'FHEE__EE_Admin_Page_Core__load_global_scripts_styles__loader_containers',
-                ['espresso_news_post_box_content']
-            )
-        );
-        StatusChangeNotice::loadAssets();
-
-        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['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'
-            )
-        );
-        // now add months and days of the week
-        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
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    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)) {
-            // 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);
-        }
-        $this->{$list_table_view}();
-        // 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, DataType::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'],
-                        $this->class_name
-                    )
-                );
-            }
-            $this->_list_table_object = $this->loader->getShared(
-                $this->_route_config['list_table'],
-                [
-                    $this,
-                    LoaderFactory::getShared(AdminListTableFilters::class),
-                ]
-            );
-        }
-    }
-
-
-    /**
-     * 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(array $extra_query_args = []): array
-    {
-        $extra_query_args = apply_filters(
-            'FHEE__EE_Admin_Page__get_list_table_view_RLs__extra_query_args',
-            $extra_query_args,
-            $this
-        );
-        $action_nonce = "{$this->_req_action}_nonce";
-        $nonce = wp_create_nonce($action_nonce);
-        // cycle thru views
-        foreach ($this->_views as $key => $view) {
-            $query_args = [];
-            if ( ! isset($this->_views[ $key ]['class'])) {
-                $this->_views[ $key ]['class'] = '';
-            }
-            // check for current view
-            $this->_views[ $key ]['class'] .= $this->_view === $view['slug'] ? ' current' : '';
-            $query_args['action']          = $this->_req_action;
-            $query_args[ $action_nonce ]   = $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;
-    }
-
-
-    /**
-     * 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(int $max_entries = 0): string
-    {
-        $values   = [10, 25, 50, 100];
-        $per_page = $this->request->getRequestParam('per_page', 10, DataType::INT);
-        if ($max_entries) {
-            $values[] = $max_entries;
-            sort($values);
-        }
-        $entries_per_page_dropdown = '
+		$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 (it's 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()
+	{
+		// add debugging styles
+		if (WP_DEBUG) {
+			add_action('admin_head', [$this, 'add_xdebug_style']);
+		}
+		// taking care of metaboxes
+		if (
+			empty($this->_cpt_route)
+			&& (isset($this->_route_config['metaboxes']) || isset($this->_route_config['has_metaboxes']))
+		) {
+			wp_enqueue_script('dashboard');
+		}
+
+		wp_enqueue_script(JqueryAssetManager::JS_HANDLE_JQUERY_UI_TOUCH_PUNCH);
+		wp_enqueue_script(EspressoLegacyAdminAssetManager::JS_HANDLE_EE_ADMIN);
+		// LOCALIZED DATA
+		// localize script for ajax lazy loading
+		wp_localize_script(
+			EspressoLegacyAdminAssetManager::JS_HANDLE_EE_ADMIN,
+			'eeLazyLoadingContainers',
+			apply_filters(
+				'FHEE__EE_Admin_Page_Core__load_global_scripts_styles__loader_containers',
+				['espresso_news_post_box_content']
+			)
+		);
+		StatusChangeNotice::loadAssets();
+
+		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['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'
+			)
+		);
+		// now add months and days of the week
+		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
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	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)) {
+			// 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);
+		}
+		$this->{$list_table_view}();
+		// 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, DataType::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'],
+						$this->class_name
+					)
+				);
+			}
+			$this->_list_table_object = $this->loader->getShared(
+				$this->_route_config['list_table'],
+				[
+					$this,
+					LoaderFactory::getShared(AdminListTableFilters::class),
+				]
+			);
+		}
+	}
+
+
+	/**
+	 * 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(array $extra_query_args = []): array
+	{
+		$extra_query_args = apply_filters(
+			'FHEE__EE_Admin_Page__get_list_table_view_RLs__extra_query_args',
+			$extra_query_args,
+			$this
+		);
+		$action_nonce = "{$this->_req_action}_nonce";
+		$nonce = wp_create_nonce($action_nonce);
+		// cycle thru views
+		foreach ($this->_views as $key => $view) {
+			$query_args = [];
+			if ( ! isset($this->_views[ $key ]['class'])) {
+				$this->_views[ $key ]['class'] = '';
+			}
+			// check for current view
+			$this->_views[ $key ]['class'] .= $this->_view === $view['slug'] ? ' current' : '';
+			$query_args['action']          = $this->_req_action;
+			$query_args[ $action_nonce ]   = $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;
+	}
+
+
+	/**
+	 * 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(int $max_entries = 0): string
+	{
+		$values   = [10, 25, 50, 100];
+		$per_page = $this->request->getRequestParam('per_page', 10, DataType::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 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 **/
-
-    /**
-     * @return void
-     * @throws EE_Error
-     */
-    public function addRegisteredMetaBoxes()
-    {
-        remove_action('add_meta_boxes', [$this, 'addRegisteredMetaBoxes'], 99);
-        $this->_add_registered_meta_boxes();
-    }
-
-
-    /**
-     * _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()
-    {
-        // we only add meta boxes if the page_route calls for it
-        if (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 $key => $metabox_callback) {
-                // first check for Closures
-                if ($metabox_callback instanceof Closure) {
-                    $result = $metabox_callback();
-                } elseif (is_callable($metabox_callback)) {
-                    $result = call_user_func($metabox_callback);
-                } elseif (method_exists($this, $metabox_callback)) {
-                    $result = $this->{$metabox_callback}();
-                } else {
-                    $result = false;
-                }
-                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);
-                }
-                unset($this->_route_config['metaboxes'][ $key ]);
-            }
-        }
-    }
-
-
-    /**
-     * _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 set up the column options for the page.
-     *
-     * @return void
-     */
-    private function _add_screen_columns()
-    {
-        if (
-            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 otherwise 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')
-        );
-        $this->addMetaBox(
-            'espresso_news_post_box',
-            $news_box_title,
-            [
-                $this,
-                'espresso_news_post_box',
-            ],
-            $this->_wp_page_slug,
-            'side',
-            'low'
-        );
-    }
-
-
-    /**
-     * 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')
-        );
-        $this->addMetaBox(
-            '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(string $rss_id, string $url): bool
-    {
-        $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 **/
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function addRegisteredMetaBoxes()
+	{
+		remove_action('add_meta_boxes', [$this, 'addRegisteredMetaBoxes'], 99);
+		$this->_add_registered_meta_boxes();
+	}
+
+
+	/**
+	 * _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()
+	{
+		// we only add meta boxes if the page_route calls for it
+		if (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 $key => $metabox_callback) {
+				// first check for Closures
+				if ($metabox_callback instanceof Closure) {
+					$result = $metabox_callback();
+				} elseif (is_callable($metabox_callback)) {
+					$result = call_user_func($metabox_callback);
+				} elseif (method_exists($this, $metabox_callback)) {
+					$result = $this->{$metabox_callback}();
+				} else {
+					$result = false;
+				}
+				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);
+				}
+				unset($this->_route_config['metaboxes'][ $key ]);
+			}
+		}
+	}
+
+
+	/**
+	 * _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 set up the column options for the page.
+	 *
+	 * @return void
+	 */
+	private function _add_screen_columns()
+	{
+		if (
+			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 otherwise 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')
+		);
+		$this->addMetaBox(
+			'espresso_news_post_box',
+			$news_box_title,
+			[
+				$this,
+				'espresso_news_post_box',
+			],
+			$this->_wp_page_slug,
+			'side',
+			'low'
+		);
+	}
+
+
+	/**
+	 * 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')
+		);
+		$this->addMetaBox(
+			'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(string $rss_id, string $url): bool
+	{
+		$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)
-                EE_Admin_Page::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)
+				EE_Admin_Page::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...
-        // $this->addMetaBox('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)) {
-            $this->addMetaBox(
-                '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'
-        );
-    }
-
-
-    /**
-     * if there is [ 'label' => [ '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)
-     *
-     * @return string
-     * @since   5.0.0.p
-     */
-    protected function getPublishBoxTitle(): string
-    {
-        $publish_box_title = esc_html__('Publish', 'event_espresso');
-        if (! empty($this->_labels['publishbox'])) {
-            if (is_array($this->_labels['publishbox'])) {
-                $publish_box_title = $this->_labels['publishbox'][ $this->_req_action ] ?? $publish_box_title;
-            } else {
-                $publish_box_title = $this->_labels['publishbox'];
-            }
-        }
-        return apply_filters(
-            'FHEE__EE_Admin_Page___publish_post_box__box_label',
-            $publish_box_title,
-            $this->_req_action,
-            $this
-        );
-    }
-
-
-    /**
-     * @throws EE_Error
-     */
-    private function _publish_post_box()
-    {
-        $title = $this->getPublishBoxTitle();
-        if (empty($this->_template_args['save_buttons'])) {
-            $this->_set_publish_post_box_vars(sanitize_key($title), "espresso_{$this->page_slug}_editor_overview");
-        } else {
-            $this->addPublishPostMetaBoxHiddenFields(
-                sanitize_key($title),
-                ['type' => 'hidden', 'value' => "espresso_{$this->page_slug}_editor_overview"]
-            );
-        }
-        $this->addMetaBox(
-            "espresso_{$this->page_slug}_editor_overview",
-            $title,
-            [$this, 'editor_overview'],
-            $this->_current_screen->id,
-            'side',
-            'high'
-        );
-    }
-
-
-    public function editor_overview()
-    {
-        /**
-         * @var string $publish_box_extra_content
-         * @var string $publish_hidden_fields
-         * @var string $publish_delete_link
-         * @var string $save_buttons
-         */
-        // if we have extra content set let's add it in if not make sure its empty
-        $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 **/
-
-
-    /**
-     * 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|null $name                     key used for the action ID (i.e. event_id)
-     * @param int|string  $id                       id attached to the item published
-     * @param string|null $delete                   page route callback for the delete action
-     * @param string|null $save_close_redirect_URL  custom URL to redirect to after Save & Close has been completed
-     * @param bool        $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(
-        ?string $name = '',
-        $id = 0,
-        ?string $delete = '',
-        ?string $save_close_redirect_URL = '',
-        bool $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'] = $this->_template_args['publish_box_extra_content'] ?? '';
-        if ($delete && ! empty($id) && empty($this->_template_args['publish_delete_link'])) {
-            // make sure we have a default if just true is sent.
-            $delete                                      = ! empty($delete) ? $delete : 'delete';
-            $this->_template_args['publish_delete_link'] = $this->get_action_link_or_button(
-                $delete,
-                $delete,
-                [$name => $id],
-                'submitdelete deletion button button--outline button--caution'
-            );
-        }
-        if (! isset($this->_template_args['publish_delete_link'])) {
-            $this->_template_args['publish_delete_link'] = '';
-        }
-        if (! empty($name) && ! empty($id)) {
-            $this->addPublishPostMetaBoxHiddenFields($name, ['type' => 'hidden', 'value' => $id]);
-        }
-        $hidden_fields = $this->_generate_admin_form_fields($this->publish_post_meta_box_hidden_fields, 'array');
-        // add hidden fields
-        $this->_template_args['publish_hidden_fields'] = $this->_template_args['publish_hidden_fields'] ?? '';
-        foreach ($hidden_fields as $hidden_field) {
-            $this->_template_args['publish_hidden_fields'] .= $hidden_field['field'] ?? '';
-        }
-    }
-
-
-    /**
-     * @param string|null $name
-     * @param int|string  $id
-     * @param string|null $delete
-     * @param string|null $save_close_redirect_URL
-     * @param bool        $both_btns
-     * @throws EE_Error
-     */
-    public function set_publish_post_box_vars(
-        ?string $name = '',
-        $id = 0,
-        ?string $delete = '',
-        ?string $save_close_redirect_URL = '',
-        bool $both_btns = false
-    ) {
-        $this->_set_publish_post_box_vars($name, $id, $delete, $save_close_redirect_URL, $both_btns);
-    }
-
-
-    protected function addPublishPostMetaBoxHiddenFields(string $field_name, array $field_attributes)
-    {
-        $this->publish_post_meta_box_hidden_fields[ $field_name ] = $field_attributes;
-    }
-
-
-    /**
-     * 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...
+		// $this->addMetaBox('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)) {
+			$this->addMetaBox(
+				'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'
+		);
+	}
+
+
+	/**
+	 * if there is [ 'label' => [ '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)
+	 *
+	 * @return string
+	 * @since   5.0.0.p
+	 */
+	protected function getPublishBoxTitle(): string
+	{
+		$publish_box_title = esc_html__('Publish', 'event_espresso');
+		if (! empty($this->_labels['publishbox'])) {
+			if (is_array($this->_labels['publishbox'])) {
+				$publish_box_title = $this->_labels['publishbox'][ $this->_req_action ] ?? $publish_box_title;
+			} else {
+				$publish_box_title = $this->_labels['publishbox'];
+			}
+		}
+		return apply_filters(
+			'FHEE__EE_Admin_Page___publish_post_box__box_label',
+			$publish_box_title,
+			$this->_req_action,
+			$this
+		);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 */
+	private function _publish_post_box()
+	{
+		$title = $this->getPublishBoxTitle();
+		if (empty($this->_template_args['save_buttons'])) {
+			$this->_set_publish_post_box_vars(sanitize_key($title), "espresso_{$this->page_slug}_editor_overview");
+		} else {
+			$this->addPublishPostMetaBoxHiddenFields(
+				sanitize_key($title),
+				['type' => 'hidden', 'value' => "espresso_{$this->page_slug}_editor_overview"]
+			);
+		}
+		$this->addMetaBox(
+			"espresso_{$this->page_slug}_editor_overview",
+			$title,
+			[$this, 'editor_overview'],
+			$this->_current_screen->id,
+			'side',
+			'high'
+		);
+	}
+
+
+	public function editor_overview()
+	{
+		/**
+		 * @var string $publish_box_extra_content
+		 * @var string $publish_hidden_fields
+		 * @var string $publish_delete_link
+		 * @var string $save_buttons
+		 */
+		// if we have extra content set let's add it in if not make sure its empty
+		$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 **/
+
+
+	/**
+	 * 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|null $name                     key used for the action ID (i.e. event_id)
+	 * @param int|string  $id                       id attached to the item published
+	 * @param string|null $delete                   page route callback for the delete action
+	 * @param string|null $save_close_redirect_URL  custom URL to redirect to after Save & Close has been completed
+	 * @param bool        $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(
+		?string $name = '',
+		$id = 0,
+		?string $delete = '',
+		?string $save_close_redirect_URL = '',
+		bool $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'] = $this->_template_args['publish_box_extra_content'] ?? '';
+		if ($delete && ! empty($id) && empty($this->_template_args['publish_delete_link'])) {
+			// make sure we have a default if just true is sent.
+			$delete                                      = ! empty($delete) ? $delete : 'delete';
+			$this->_template_args['publish_delete_link'] = $this->get_action_link_or_button(
+				$delete,
+				$delete,
+				[$name => $id],
+				'submitdelete deletion button button--outline button--caution'
+			);
+		}
+		if (! isset($this->_template_args['publish_delete_link'])) {
+			$this->_template_args['publish_delete_link'] = '';
+		}
+		if (! empty($name) && ! empty($id)) {
+			$this->addPublishPostMetaBoxHiddenFields($name, ['type' => 'hidden', 'value' => $id]);
+		}
+		$hidden_fields = $this->_generate_admin_form_fields($this->publish_post_meta_box_hidden_fields, 'array');
+		// add hidden fields
+		$this->_template_args['publish_hidden_fields'] = $this->_template_args['publish_hidden_fields'] ?? '';
+		foreach ($hidden_fields as $hidden_field) {
+			$this->_template_args['publish_hidden_fields'] .= $hidden_field['field'] ?? '';
+		}
+	}
+
+
+	/**
+	 * @param string|null $name
+	 * @param int|string  $id
+	 * @param string|null $delete
+	 * @param string|null $save_close_redirect_URL
+	 * @param bool        $both_btns
+	 * @throws EE_Error
+	 */
+	public function set_publish_post_box_vars(
+		?string $name = '',
+		$id = 0,
+		?string $delete = '',
+		?string $save_close_redirect_URL = '',
+		bool $both_btns = false
+	) {
+		$this->_set_publish_post_box_vars($name, $id, $delete, $save_close_redirect_URL, $both_btns);
+	}
+
+
+	protected function addPublishPostMetaBoxHiddenFields(string $field_name, array $field_attributes)
+	{
+		$this->publish_post_meta_box_hidden_fields[ $field_name ] = $field_attributes;
+	}
+
+
+	/**
+	 * 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 = (array) $this->_get_transient(true);
-        foreach ($notices as $notice) {
-            echo $notice ? stripslashes($notice) : '';
-        }
-    }
-
-
-    /**
-     * 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 = (array) $this->_get_transient(true);
+		foreach ($notices as $notice) {
+			echo $notice ? stripslashes($notice) : '';
+		}
+	}
+
+
+	/**
+	 * 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 $this->addMetaBox()
-     *
-     * @param string   $action        where the metabox gets displayed
-     * @param string   $title         Title of Metabox (output in metabox header)
-     * @param callable $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 bool     $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(
-        string $action,
-        string $title,
-        callable $callback,
-        array $callback_args,
-        string $column = 'normal',
-        string $priority = 'high',
-        bool $create_func = true
-    ) {
-        // 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
-            ? static function ($post, $metabox) {
-                echo EEH_Template::display_template(
-                    $metabox['args']['template_path'],
-                    $metabox['args']['template_args'],
-                    true
-                );
-            }
-            : $callback;
-        $this->addMetaBox(
-            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
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    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 DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    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 DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    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 DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    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 bool $sidebar true with sidebar, false without
-     * @param bool $about   use the About admin wrapper instead of the default.
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _display_admin_page(bool $sidebar = false, bool $about = false): void
-    {
-        // 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.
-        $post_body_content = $this->_template_args['before_admin_page_content'] ?? '';
-
-        $this->_template_args['add_page_frame'] = $this->_req_action !== 'system_status'
-                                                  && $this->_req_action !== 'data_reset'
-                                                  && $this->_wp_page_slug !== 'event-espresso_page_espresso_packages'
-                                                  && strpos($post_body_content, 'wp-list-table') === false;
-
-        $this->_template_args['current_page']                 = $this->_wp_page_slug;
-        $this->_template_args['admin_page_wrapper_div_id']    = $this->_cpt_route
-            ? 'poststuff'
-            : 'espresso-default-admin';
-        $this->_template_args['admin_page_wrapper_div_class'] = str_replace(
-            'event-espresso_page_espresso_',
-            '',
-            $this->_wp_page_slug
-        ) . ' ' . $this->_req_action . '-route';
-
-        $template_path = $sidebar
-            ? EE_ADMIN_TEMPLATE . 'admin_details_wrapper.template.php'
-            : EE_ADMIN_TEMPLATE . 'admin_details_wrapper_no_sidebar.template.php';
-
-        $this->_template_args['is_ajax'] = $this->request->isAjax();
-        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']         = $this->_template_args['admin_page_content'] ?? '';
-        $this->_template_args['before_admin_page_content'] = $post_body_content;
-        $this->_template_args['after_admin_page_content']  = $this->_template_args['after_admin_page_content'] ?? '';
-
-        // ensure $post_type and $post are set
-        // to prevent WooCommerce from blowing things up if not using CPT
-        global $post_type, $post;
-        $this->_template_args['post_type'] = $post_type ?? '';
-        $this->_template_args['post']  = $post ?? new WP_Post((object) [ 'ID' => 0, 'filter' => 'raw' ]);
-
-        $this->_template_args['post_body_content'] = EEH_Template::display_template(
-            EE_ADMIN_TEMPLATE . 'admin_details_wrapper_post_body_content.template.php',
-            $this->_template_args,
-            true
-        );
-
-        $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(string $utm_campaign_source = '', bool $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 button--primary button--big',
-                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 DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    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 DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    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 bool $sidebar whether to display with sidebar or not.
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _display_admin_list_table_page(bool $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 = $this->_template_args['list_table_hidden_fields'] ?? '';
-
-        $nonce_ref          = $this->_req_action . '_nonce';
-        $hidden_form_fields .= '
+	}
+
+
+	/**
+	 * facade for $this->addMetaBox()
+	 *
+	 * @param string   $action        where the metabox gets displayed
+	 * @param string   $title         Title of Metabox (output in metabox header)
+	 * @param callable $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 bool     $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(
+		string $action,
+		string $title,
+		callable $callback,
+		array $callback_args,
+		string $column = 'normal',
+		string $priority = 'high',
+		bool $create_func = true
+	) {
+		// 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
+			? static function ($post, $metabox) {
+				echo EEH_Template::display_template(
+					$metabox['args']['template_path'],
+					$metabox['args']['template_args'],
+					true
+				);
+			}
+			: $callback;
+		$this->addMetaBox(
+			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
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	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 DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	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 DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	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 DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	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 bool $sidebar true with sidebar, false without
+	 * @param bool $about   use the About admin wrapper instead of the default.
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _display_admin_page(bool $sidebar = false, bool $about = false): void
+	{
+		// 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.
+		$post_body_content = $this->_template_args['before_admin_page_content'] ?? '';
+
+		$this->_template_args['add_page_frame'] = $this->_req_action !== 'system_status'
+												  && $this->_req_action !== 'data_reset'
+												  && $this->_wp_page_slug !== 'event-espresso_page_espresso_packages'
+												  && strpos($post_body_content, 'wp-list-table') === false;
+
+		$this->_template_args['current_page']                 = $this->_wp_page_slug;
+		$this->_template_args['admin_page_wrapper_div_id']    = $this->_cpt_route
+			? 'poststuff'
+			: 'espresso-default-admin';
+		$this->_template_args['admin_page_wrapper_div_class'] = str_replace(
+			'event-espresso_page_espresso_',
+			'',
+			$this->_wp_page_slug
+		) . ' ' . $this->_req_action . '-route';
+
+		$template_path = $sidebar
+			? EE_ADMIN_TEMPLATE . 'admin_details_wrapper.template.php'
+			: EE_ADMIN_TEMPLATE . 'admin_details_wrapper_no_sidebar.template.php';
+
+		$this->_template_args['is_ajax'] = $this->request->isAjax();
+		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']         = $this->_template_args['admin_page_content'] ?? '';
+		$this->_template_args['before_admin_page_content'] = $post_body_content;
+		$this->_template_args['after_admin_page_content']  = $this->_template_args['after_admin_page_content'] ?? '';
+
+		// ensure $post_type and $post are set
+		// to prevent WooCommerce from blowing things up if not using CPT
+		global $post_type, $post;
+		$this->_template_args['post_type'] = $post_type ?? '';
+		$this->_template_args['post']  = $post ?? new WP_Post((object) [ 'ID' => 0, 'filter' => 'raw' ]);
+
+		$this->_template_args['post_body_content'] = EEH_Template::display_template(
+			EE_ADMIN_TEMPLATE . 'admin_details_wrapper_post_body_content.template.php',
+			$this->_template_args,
+			true
+		);
+
+		$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(string $utm_campaign_source = '', bool $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 button--primary button--big',
+				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 DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	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 DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	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 bool $sidebar whether to display with sidebar or not.
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _display_admin_list_table_page(bool $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 = $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(array $items): string
-    {
-        $this->_template_args['items'] = (array) apply_filters(
-            'FHEE__EE_Admin_Page___display_legend__items',
-            $items,
-            $this
-        );
-        /** @var StatusChangeNotice $status_change_notice */
-        $status_change_notice                         = $this->loader->getShared(
-            'EventEspresso\core\domain\services\admin\notices\status_change\StatusChangeNotice'
-        );
-        $this->_template_args['status_change_notice'] = $status_change_notice->display(
-            '__admin-legend',
-            $this->page_slug
-        );
-        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
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _return_json(bool $sticky_notices = false, array $notices_arguments = [])
-    {
-        // make sure any EE_Error notices have been handled.
-        $this->_process_notices($notices_arguments, true, $sticky_notices);
-        $data = $this->_template_args['data'] ?? [];
-        unset($this->_template_args['data']);
-        $json = [
-            'error'     => $this->_template_args['error'] ?? false,
-            'success'   => $this->_template_args['success'] ?? false,
-            'errors'    => $this->_template_args['errors'] ?? false,
-            'attention' => $this->_template_args['attention'] ?? false,
-            'notices'   => EE_Error::get_notices(),
-            '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
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    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
-     * @deprecated  5.0.8.p
-     */
-    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 bool $about whether to use the special about page wrapper or default.
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function admin_page_wrapper(bool $about = false)
-    {
-        $this->_template_args['nav_tabs']         = $this->_get_main_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",
-            $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",
-            $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(): string
-    {
-        // 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, $this->page_slug);
-    }
-
-
-    /**
-     *        sort nav tabs
-     *
-     * @param array $a
-     * @param array $b
-     * @return int
-     */
-    private function _sort_nav_tabs(array $a, array $b): int
-    {
-        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  indicates which generator to use: options are 'string' or 'array'
-     * @param string $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(
-        array $input_vars = [],
-        string $generator = 'string',
-        string $id = ''
-    ) {
-        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.  Otherwise 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(bool $both = true, array $text = [], array $actions = [], $referrer = null)
-    {
-        $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 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(string $route = '', array $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(string $route = '', array $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
-        $action                                            = $this->_admin_base_url;
-        $this->_template_args['before_admin_page_content'] = "
+		$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(array $items): string
+	{
+		$this->_template_args['items'] = (array) apply_filters(
+			'FHEE__EE_Admin_Page___display_legend__items',
+			$items,
+			$this
+		);
+		/** @var StatusChangeNotice $status_change_notice */
+		$status_change_notice                         = $this->loader->getShared(
+			'EventEspresso\core\domain\services\admin\notices\status_change\StatusChangeNotice'
+		);
+		$this->_template_args['status_change_notice'] = $status_change_notice->display(
+			'__admin-legend',
+			$this->page_slug
+		);
+		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
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _return_json(bool $sticky_notices = false, array $notices_arguments = [])
+	{
+		// make sure any EE_Error notices have been handled.
+		$this->_process_notices($notices_arguments, true, $sticky_notices);
+		$data = $this->_template_args['data'] ?? [];
+		unset($this->_template_args['data']);
+		$json = [
+			'error'     => $this->_template_args['error'] ?? false,
+			'success'   => $this->_template_args['success'] ?? false,
+			'errors'    => $this->_template_args['errors'] ?? false,
+			'attention' => $this->_template_args['attention'] ?? false,
+			'notices'   => EE_Error::get_notices(),
+			'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
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	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
+	 * @deprecated  5.0.8.p
+	 */
+	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 bool $about whether to use the special about page wrapper or default.
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function admin_page_wrapper(bool $about = false)
+	{
+		$this->_template_args['nav_tabs']         = $this->_get_main_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",
+			$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",
+			$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(): string
+	{
+		// 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, $this->page_slug);
+	}
+
+
+	/**
+	 *        sort nav tabs
+	 *
+	 * @param array $a
+	 * @param array $b
+	 * @return int
+	 */
+	private function _sort_nav_tabs(array $a, array $b): int
+	{
+		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  indicates which generator to use: options are 'string' or 'array'
+	 * @param string $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(
+		array $input_vars = [],
+		string $generator = 'string',
+		string $id = ''
+	) {
+		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.  Otherwise 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(bool $both = true, array $text = [], array $actions = [], $referrer = null)
+	{
+		$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 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(string $route = '', array $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(string $route = '', array $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
+		$action                                            = $this->_admin_base_url;
+		$this->_template_args['before_admin_page_content'] = "
             <form name='form' method='post' action='$action' id='{$route}_event_form' class='ee-admin-page-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|int $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,
-        string $what = 'item',
-        string $action_desc = 'processed',
-        array $query_args = [],
-        bool $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): array
-    {
-        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);
-    }
-
-
-    /**
-     * @param int|float|string $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
-     * @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
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _redirect_after_action(
-        $success = 0,
-        string $what = 'item',
-        string $action_desc = 'processed',
-        array $query_args = [],
-        bool $override_overwrite = false
-    ) {
-        $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 (! $override_overwrite && ! empty($what) && ! empty($action_desc) && empty($notices['errors'])) {
-            // how many records affected ? more than one record ? or just one ?
-            EE_Error::add_success(
-                sprintf(
-                    esc_html(
-                        _n(
-                            'The "%1$s" has been successfully %2$s.',
-                            'The "%1$s" have been successfully %2$s.',
-                            $success,
-                            'event_espresso'
-                        )
-                    ),
-                    $what,
-                    $action_desc
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        // check that $query_args isn't something crazy
-        $query_args = 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__{$this->class_name}___redirect_after_action__before_redirect_modification_$this->_req_action",
-            $query_args
-        );
-        // 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;
-        // 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', '', DataType::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_' . $this->class_name . $this->_req_action, $query_args);
-        $redirect_url = apply_filters(
-            'FHEE_redirect_' . $this->class_name . $this->_req_action,
-            EE_Admin_Page::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
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _process_notices(
-        array $query_args = [],
-        bool $skip_route_verify = false,
-        bool $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'] = $notices['success'] ?? false;
-            }
-            if (empty($this->_template_args['errors'])) {
-                $this->_template_args['errors'] = $notices['errors'] ?? false;
-            }
-            if (empty($this->_template_args['attention'])) {
-                $this->_template_args['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 = $query_args['action'] ?? 'default';
-            $this->_add_transient(
-                $route,
-                (array) $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(
-        string $action,
-        string $type = 'add',
-        array $extra_request = [],
-        string $class = 'button button--primary',
-        string $base_url = '',
-        bool $exclude_nonce = false
-    ): string {
-        // 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 = EE_Admin_Page::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]', '', DataType::KEY);
-            if (! $option) {
-                return;
-            }
-            $value      = $this->request->getRequestParam('wp_screen_options[value]', 0, DataType::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(array $data)
-    {
-        $this->_template_args = array_merge($this->_template_args, $data);
-    }
-
-
-    public function setAdminPageTitle(string $title)
-    {
-        $this->_admin_page_title = sanitize_text_field($title);
-    }
-
-
-    /**
-     * 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 it's 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(
-        string $route,
-        array $data,
-        bool $notices = false,
-        bool $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($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(bool $notices = false, string $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(): string
-    {
-        return $this->_view;
-    }
-
-
-    /**
-     * getter for the protected $_views property
-     *
-     * @return array
-     */
-    public function get_views(): array
-    {
-        return $this->_views;
-    }
-
-
-    /**
-     * @param array $views
-     * @return void
-     * @since 5.0.13.p
-     */
-    public function updateViews(array $views)
-    {
-        $this->_views = array_merge($this->_views, $views);
-    }
-
-
-    /**
-    /**
-     * get_current_page
-     *
-     * @return string _current_page property value
-     */
-    public function get_current_page(): string
-    {
-        return $this->_current_page;
-    }
-
-
-    /**
-     * get_current_view
-     *
-     * @return string _current_view property value
-     */
-    public function get_current_view(): string
-    {
-        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(): string
-    {
-        return $this->_current_page_view_url;
-    }
-
-
-    /**
-     * just returns the Request
-     *
-     * @return RequestInterface
-     */
-    public function get_request(): ?RequestInterface
-    {
-        return $this->request;
-    }
-
-
-    /**
-     * just returns the _req_data property
-     *
-     * @return array
-     */
-    public function get_request_data(): array
-    {
-        return $this->request->requestParams();
-    }
-
-
-    /**
-     * returns the _req_data protected property
-     *
-     * @return string
-     */
-    public function get_req_action(): string
-    {
-        return $this->_req_action;
-    }
-
-
-    /**
-     * @return bool  value of $_is_caf property
-     */
-    public function is_caf(): bool
-    {
-        return $this->_is_caf;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function default_espresso_metaboxes(): array
-    {
-        return $this->_default_espresso_metaboxes;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function admin_base_url(): string
-    {
-        return $this->_admin_base_url;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function wp_page_slug(): string
-    {
-        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 bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _update_espresso_configuration(
-        string $tab,
-        $config,
-        string $file = '',
-        string $func = '',
-        string $line = ''
-    ): bool {
-        // 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(): array
-    {
-        return $this->_yes_no_values;
-    }
-
-
-    /**
-     * @return string
-     * @throws ReflectionException
-     * @since 5.0.0.p
-     */
-    protected function _get_dir(): string
-    {
-        $reflector = new ReflectionClass($this->class_name);
-        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(string $url, string $class = 'dashicons dashicons-arrow-right'): string
-    {
-        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(string $url, string $class = 'dashicons dashicons-arrow-left'): string
-    {
-        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 a 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(): bool
-    {
-        $this->_template_args['success'] = EED_Messages::process_resend($this->request->requestParams());
-        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): bool
-    {
-        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,
-        string $entity_PK_name,
-        string $action = EE_Admin_List_Table::ACTION_DELETE,
-        string $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): string
-    {
-        $entity_PK_type = $entity_PK->getSchemaType();
-        switch ($entity_PK_type) {
-            case 'boolean':
-                return DataType::BOOL;
-            case 'integer':
-                return DataType::INT;
-            case 'number':
-                return DataType::FLOAT;
-            case 'string':
-                return DataType::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,
-        string $action,
-        string $delete_column,
-        ?callable $callback = null
-    ): bool {
-        $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, string $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(string $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()
-            )
-        );
-    }
+		// 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|int $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,
+		string $what = 'item',
+		string $action_desc = 'processed',
+		array $query_args = [],
+		bool $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): array
+	{
+		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);
+	}
+
+
+	/**
+	 * @param int|float|string $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
+	 * @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
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _redirect_after_action(
+		$success = 0,
+		string $what = 'item',
+		string $action_desc = 'processed',
+		array $query_args = [],
+		bool $override_overwrite = false
+	) {
+		$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 (! $override_overwrite && ! empty($what) && ! empty($action_desc) && empty($notices['errors'])) {
+			// how many records affected ? more than one record ? or just one ?
+			EE_Error::add_success(
+				sprintf(
+					esc_html(
+						_n(
+							'The "%1$s" has been successfully %2$s.',
+							'The "%1$s" have been successfully %2$s.',
+							$success,
+							'event_espresso'
+						)
+					),
+					$what,
+					$action_desc
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		// check that $query_args isn't something crazy
+		$query_args = 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__{$this->class_name}___redirect_after_action__before_redirect_modification_$this->_req_action",
+			$query_args
+		);
+		// 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;
+		// 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', '', DataType::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_' . $this->class_name . $this->_req_action, $query_args);
+		$redirect_url = apply_filters(
+			'FHEE_redirect_' . $this->class_name . $this->_req_action,
+			EE_Admin_Page::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
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _process_notices(
+		array $query_args = [],
+		bool $skip_route_verify = false,
+		bool $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'] = $notices['success'] ?? false;
+			}
+			if (empty($this->_template_args['errors'])) {
+				$this->_template_args['errors'] = $notices['errors'] ?? false;
+			}
+			if (empty($this->_template_args['attention'])) {
+				$this->_template_args['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 = $query_args['action'] ?? 'default';
+			$this->_add_transient(
+				$route,
+				(array) $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(
+		string $action,
+		string $type = 'add',
+		array $extra_request = [],
+		string $class = 'button button--primary',
+		string $base_url = '',
+		bool $exclude_nonce = false
+	): string {
+		// 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 = EE_Admin_Page::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]', '', DataType::KEY);
+			if (! $option) {
+				return;
+			}
+			$value      = $this->request->getRequestParam('wp_screen_options[value]', 0, DataType::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(array $data)
+	{
+		$this->_template_args = array_merge($this->_template_args, $data);
+	}
+
+
+	public function setAdminPageTitle(string $title)
+	{
+		$this->_admin_page_title = sanitize_text_field($title);
+	}
+
+
+	/**
+	 * 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 it's 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(
+		string $route,
+		array $data,
+		bool $notices = false,
+		bool $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($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(bool $notices = false, string $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(): string
+	{
+		return $this->_view;
+	}
+
+
+	/**
+	 * getter for the protected $_views property
+	 *
+	 * @return array
+	 */
+	public function get_views(): array
+	{
+		return $this->_views;
+	}
+
+
+	/**
+	 * @param array $views
+	 * @return void
+	 * @since 5.0.13.p
+	 */
+	public function updateViews(array $views)
+	{
+		$this->_views = array_merge($this->_views, $views);
+	}
+
+
+	/**
+    /**
+	 * get_current_page
+	 *
+	 * @return string _current_page property value
+	 */
+	public function get_current_page(): string
+	{
+		return $this->_current_page;
+	}
+
+
+	/**
+	 * get_current_view
+	 *
+	 * @return string _current_view property value
+	 */
+	public function get_current_view(): string
+	{
+		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(): string
+	{
+		return $this->_current_page_view_url;
+	}
+
+
+	/**
+	 * just returns the Request
+	 *
+	 * @return RequestInterface
+	 */
+	public function get_request(): ?RequestInterface
+	{
+		return $this->request;
+	}
+
+
+	/**
+	 * just returns the _req_data property
+	 *
+	 * @return array
+	 */
+	public function get_request_data(): array
+	{
+		return $this->request->requestParams();
+	}
+
+
+	/**
+	 * returns the _req_data protected property
+	 *
+	 * @return string
+	 */
+	public function get_req_action(): string
+	{
+		return $this->_req_action;
+	}
+
+
+	/**
+	 * @return bool  value of $_is_caf property
+	 */
+	public function is_caf(): bool
+	{
+		return $this->_is_caf;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function default_espresso_metaboxes(): array
+	{
+		return $this->_default_espresso_metaboxes;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function admin_base_url(): string
+	{
+		return $this->_admin_base_url;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function wp_page_slug(): string
+	{
+		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 bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _update_espresso_configuration(
+		string $tab,
+		$config,
+		string $file = '',
+		string $func = '',
+		string $line = ''
+	): bool {
+		// 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(): array
+	{
+		return $this->_yes_no_values;
+	}
+
+
+	/**
+	 * @return string
+	 * @throws ReflectionException
+	 * @since 5.0.0.p
+	 */
+	protected function _get_dir(): string
+	{
+		$reflector = new ReflectionClass($this->class_name);
+		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(string $url, string $class = 'dashicons dashicons-arrow-right'): string
+	{
+		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(string $url, string $class = 'dashicons dashicons-arrow-left'): string
+	{
+		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 a 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(): bool
+	{
+		$this->_template_args['success'] = EED_Messages::process_resend($this->request->requestParams());
+		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): bool
+	{
+		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,
+		string $entity_PK_name,
+		string $action = EE_Admin_List_Table::ACTION_DELETE,
+		string $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): string
+	{
+		$entity_PK_type = $entity_PK->getSchemaType();
+		switch ($entity_PK_type) {
+			case 'boolean':
+				return DataType::BOOL;
+			case 'integer':
+				return DataType::INT;
+			case 'number':
+				return DataType::FLOAT;
+			case 'string':
+				return DataType::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,
+		string $action,
+		string $delete_column,
+		?callable $callback = null
+	): bool {
+		$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, string $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(string $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 +185 added lines, -185 removed lines

@@ -24,23 +24,23 @@ 
  */
 abstract class EE_Admin_Page extends EE_Base implements InterminableInterface
 {
-    protected ?EE_Admin_Config $admin_config       = null;
+    protected ?EE_Admin_Config $admin_config = null;
 
-    protected ?EE_Admin_Hooks $_hook_obj          = null;
+    protected ?EE_Admin_Hooks $_hook_obj = null;
 
     protected ?EE_Admin_List_Table $_list_table_object = null;
 
-    protected ?EE_Capabilities $capabilities       = null;
+    protected ?EE_Capabilities $capabilities = null;
 
-    protected ?EE_Registry $EE                 = null;
+    protected ?EE_Registry $EE = null;
 
-    protected ?FeatureFlags $feature            = null;
+    protected ?FeatureFlags $feature = null;
 
-    protected ?LoaderInterface $loader             = null;
+    protected ?LoaderInterface $loader = null;
 
-    protected ?RequestInterface $request            = null;
+    protected ?RequestInterface $request = null;
 
-    protected ?WP_Screen $_current_screen    = null;
+    protected ?WP_Screen $_current_screen = null;
 
     /**
      * @var array
@@ -124,7 +124,7 @@ 
 
     protected string $_column_template_path = '';
 
-    protected bool $_cpt_route            = false;
+    protected bool $_cpt_route = false;
 
     /**
      * set via request page and action args.
@@ -245,7 +245,7 @@ 
 
     public function capabilities(): EE_Capabilities
     {
-        if (! $this->capabilities instanceof EE_Capabilities) {
+        if ( ! $this->capabilities instanceof EE_Capabilities) {
             $this->capabilities = $this->loader->getShared(EE_Capabilities::class);
         }
         return $this->capabilities;
@@ -609,7 +609,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;
         }
@@ -629,7 +629,7 @@ 
             ? $route
             : $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],
@@ -653,33 +653,33 @@ 
         }
         // filter routes and page_config so addons can add their stuff. Filtering done per class
         $this->_page_routes = apply_filters(
-            'FHEE__' . $this->class_name . '__page_setup__page_routes',
+            'FHEE__'.$this->class_name.'__page_setup__page_routes',
             $this->_page_routes,
             $this
         );
         $this->_page_config = apply_filters(
-            'FHEE__' . $this->class_name . '__page_setup__page_config',
+            'FHEE__'.$this->class_name.'__page_setup__page_config',
             $this->_page_config,
             $this
         );
         if ($this->base_class_name !== '') {
             $this->_page_routes = apply_filters(
-                'FHEE__' . $this->base_class_name . '__page_setup__page_routes',
+                'FHEE__'.$this->base_class_name.'__page_setup__page_routes',
                 $this->_page_routes,
                 $this
             );
             $this->_page_config = apply_filters(
-                'FHEE__' . $this->base_class_name . '__page_setup__page_config',
+                'FHEE__'.$this->base_class_name.'__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
             );
@@ -692,8 +692,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']);
-                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
@@ -712,12 +712,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 set up 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.',
@@ -734,7 +734,7 @@ 
                                    ),
                                    $page,
                                    '<br />',
-                                   '<strong>' . $classname . '</strong>'
+                                   '<strong>'.$classname.'</strong>'
                                );
                 throw new EE_Error(implode('||', $error_msg));
             }
@@ -783,13 +783,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']);
-        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();
@@ -915,7 +915,7 @@ 
      */
     protected function _verify_routes(): bool
     {
-        if (! $this->_current_page && ! $this->request->isAjax()) {
+        if ( ! $this->_current_page && ! $this->request->isAjax()) {
             return false;
         }
         // check that the page_routes array is not empty
@@ -926,7 +926,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'
@@ -938,14 +938,14 @@ 
         if (
             $this->_req_action === 'editpost'
             && ! isset($this->_page_routes['editpost'])
-            && isset($this->_page_routes[ $alt_edit_route ])
+            && isset($this->_page_routes[$alt_edit_route])
         ) {
             $this->_req_action = $alt_edit_route;
         }
         // 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 = $this->_page_config[ $this->_req_action ] ?? [];
+            $this->_route        = $this->_page_routes[$this->_req_action];
+            $this->_route_config = $this->_page_config[$this->_req_action] ?? [];
         } else {
             // user error msg
             $error_msg = sprintf(
@@ -956,7 +956,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.',
@@ -967,7 +967,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__(
@@ -977,7 +977,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'
@@ -1017,7 +1017,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',
@@ -1047,7 +1047,7 @@ 
         $nonce = $nonce ?: $this->request->getRequestParam($this->_req_nonce, '');
         $nonce_ref = $nonce_ref ?: $this->_req_action;
         // 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'),
@@ -1064,7 +1064,7 @@ 
                     __CLASS__
                 );
             }
-            if (! $this->request->isAjax()) {
+            if ( ! $this->request->isAjax()) {
                 wp_die($msg);
             }
             EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
@@ -1089,7 +1089,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'];
@@ -1109,7 +1109,7 @@ 
 
         // 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);
         }
         // strip _wp_http_referer from the server REQUEST_URI
@@ -1124,7 +1124,7 @@ 
         $this->request->setRequestParam('_wp_http_referer', $cleaner_request_uri, true);
         $this->request->setServerParam('REQUEST_URI', $cleaner_request_uri, true);
         $route_callback = [];
-        if (! empty($func)) {
+        if ( ! empty($func)) {
             if (is_array($func) && is_callable($func)) {
                 $route_callback = $func;
             } elseif (is_string($func)) {
@@ -1138,7 +1138,7 @@ 
             }
             [$class, $method] = $route_callback;
             // is it neither a class method NOR a standalone function?
-            if (! is_callable($route_callback)) {
+            if ( ! is_callable($route_callback)) {
                 // user error msg
                 $error_msg = esc_html__(
                     'An error occurred. The  requested page route could not be found.',
@@ -1247,7 +1247,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, $context);
@@ -1287,12 +1287,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__(
@@ -1305,18 +1305,18 @@ 
                     );
                 }
                 $content = apply_filters(
-                    'FHEE__' . $this->class_name . '__add_help_tabs__help_sidebar',
+                    'FHEE__'.$this->class_name.'__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',
@@ -1324,7 +1324,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',
@@ -1333,11 +1333,11 @@ 
                     );
                 }
                 // first priority goes to content.
-                if (! empty($cfg['content'])) {
+                if ( ! empty($cfg['content'])) {
                     $content = $cfg['content'];
                     // 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())
@@ -1345,7 +1345,7 @@ 
                                                              . $cfg['filename']
                                                              . '.help_tab.php' : $file_path;
                     // if file is STILL not readable then let's do an 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__(
@@ -1393,7 +1393,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'],
@@ -1419,8 +1419,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);
         }
@@ -1442,7 +1442,7 @@ 
         $i        = 0;
         $only_tab = count($this->_page_config) < 2;
         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
@@ -1451,7 +1451,7 @@ 
                 // 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;
             }
@@ -1459,20 +1459,20 @@ 
             $css_class .= $only_tab ? ' ee-only-tab' : '';
             $css_class .= " ee-nav-tab__$slug";
 
-            $this->_nav_tabs[ $slug ] = [
+            $this->_nav_tabs[$slug] = [
                 'url'       => $config['nav']['url'] ?? EE_Admin_Page::add_query_args_and_nonce(
                     ['action' => $slug],
                     $this->_admin_base_url
                 ),
                 'link_text' => $this->navTabLabel($config['nav'], $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'     => $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',
@@ -1488,11 +1488,11 @@ 
     {
         $label = $nav_tab['label'] ?? ucwords(str_replace('_', ' ', $slug));
         $icon  = $nav_tab['icon'] ?? null;
-        $icon  = $icon ? '<span class="dashicons ' . $icon . '"></span>' : '';
+        $icon  = $icon ? '<span class="dashicons '.$icon.'"></span>' : '';
         return '
             <span class="ee-admin-screen-tab__label">
-                ' . $icon . '
-                <span class="ee-nav-label__text">' . $label . '</span>
+                ' . $icon.'
+                <span class="ee-nav-label__text">' . $label.'</span>
             </span>';
     }
 
@@ -1510,10 +1510,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;
                 }
             }
         }
@@ -1535,8 +1535,8 @@ 
     {
         // if no route_to_check is passed in then use the current route set via _req_action
         $action = $route_to_check ?: $this->_req_action;
-        $capability = ! empty($this->_page_routes[ $action ]['capability'])
-            ? $this->_page_routes[ $action ]['capability']
+        $capability = ! empty($this->_page_routes[$action]['capability'])
+            ? $this->_page_routes[$action]['capability']
             : null;
 
         if (empty($capability)) {
@@ -1586,14 +1586,14 @@ 
         string $priority = 'default',
         ?array $callback_args = null
     ) {
-        if (! (is_callable($callback) || ! function_exists($callback))) {
+        if ( ! (is_callable($callback) || ! function_exists($callback))) {
             return;
         }
 
         add_meta_box($box_id, $title, $callback, $screen, $context, $priority, $callback_args);
         add_filter(
             "postbox_classes_{$this->_wp_page_slug}_$box_id",
-            function ($classes) {
+            function($classes) {
                 $classes[] = 'ee-admin-container';
                 return $classes;
             }
@@ -1684,8 +1684,8 @@ 
             <div class="ee-notices"></div>
             <div class="ee-admin-dialog-container-inner-content"></div>
         </div>
-        <span id="current_timezone" class="hidden">' . esc_html(EEH_DTT_Helper::get_timezone()) . '</span>
-        <input type="hidden" id="espresso_admin_current_page" value="' . esc_attr($this->_current_page) . '"/>';
+        <span id="current_timezone" class="hidden">' . esc_html(EEH_DTT_Helper::get_timezone()).'</span>
+        <input type="hidden" id="espresso_admin_current_page" value="' . esc_attr($this->_current_page).'"/>';
     }
 
 
@@ -1719,7 +1719,7 @@ 
         // loop through the array and setup content
         foreach ($help_array as $trigger => $help) {
             // make sure the array is set up properly
-            if (! isset($help['title'], $help['content'])) {
+            if ( ! isset($help['title'], $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',
@@ -1733,8 +1733,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
             );
@@ -1756,15 +1756,15 @@ 
     private function _get_help_content(): array
     {
         // 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 = $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.',
@@ -1796,15 +1796,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);
         }
         $height   = esc_attr($dimensions[0]) ?? 400;
         $width    = esc_attr($dimensions[1]) ?? 640;
@@ -1892,7 +1892,7 @@ 
 
         add_filter(
             'admin_body_class',
-            function ($classes) {
+            function($classes) {
                 if (strpos($classes, 'espresso-admin') === false) {
                     $classes .= ' espresso-admin';
                 }
@@ -1983,12 +1983,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)) {
+        $list_table_view = '_set_list_table_views_'.$this->_req_action;
+        if ( ! method_exists($this, $list_table_view)) {
             // user error msg
             $error_msg = esc_html__(
                 'An error occurred. The requested list table views could not be found.',
@@ -2009,10 +2009,10 @@ 
         $this->{$list_table_view}();
         // 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();
@@ -2047,7 +2047,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__(
@@ -2090,19 +2090,19 @@ 
         // cycle thru views
         foreach ($this->_views as $key => $view) {
             $query_args = [];
-            if ( ! isset($this->_views[ $key ]['class'])) {
-                $this->_views[ $key ]['class'] = '';
+            if ( ! isset($this->_views[$key]['class'])) {
+                $this->_views[$key]['class'] = '';
             }
             // 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[ $action_nonce ]   = $nonce;
+            $query_args[$action_nonce]   = $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;
     }
@@ -2131,14 +2131,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
@@ -2162,7 +2162,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;
     }
 
 
@@ -2223,7 +2223,7 @@ 
                                   );
                     throw new EE_Error($error_msg);
                 }
-                unset($this->_route_config['metaboxes'][ $key ]);
+                unset($this->_route_config['metaboxes'][$key]);
             }
         }
     }
@@ -2256,7 +2256,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
@@ -2302,7 +2302,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(
@@ -2329,28 +2329,28 @@ 
      */
     public function espresso_ratings_request()
     {
-        EEH_Template::display_template(EE_ADMIN_TEMPLATE . 'espresso_ratings_request_content.template.php');
+        EEH_Template::display_template(EE_ADMIN_TEMPLATE.'espresso_ratings_request_content.template.php');
     }
 
 
     public static function cached_rss_display(string $rss_id, string $url): bool
     {
-        $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();
@@ -2417,7 +2417,7 @@ 
     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'
         );
     }
 
@@ -2434,9 +2434,9 @@ 
     protected function getPublishBoxTitle(): string
     {
         $publish_box_title = esc_html__('Publish', 'event_espresso');
-        if (! empty($this->_labels['publishbox'])) {
+        if ( ! empty($this->_labels['publishbox'])) {
             if (is_array($this->_labels['publishbox'])) {
-                $publish_box_title = $this->_labels['publishbox'][ $this->_req_action ] ?? $publish_box_title;
+                $publish_box_title = $this->_labels['publishbox'][$this->_req_action] ?? $publish_box_title;
             } else {
                 $publish_box_title = $this->_labels['publishbox'];
             }
@@ -2486,7 +2486,7 @@ 
         // if we have extra content set let's add it in if not make sure its empty
         $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',
+            EE_ADMIN_TEMPLATE.'admin_details_publish_metabox.template.php',
             $this->_template_args,
             true
         );
@@ -2539,10 +2539,10 @@ 
                 'submitdelete deletion button button--outline button--caution'
             );
         }
-        if (! isset($this->_template_args['publish_delete_link'])) {
+        if ( ! isset($this->_template_args['publish_delete_link'])) {
             $this->_template_args['publish_delete_link'] = '';
         }
-        if (! empty($name) && ! empty($id)) {
+        if ( ! empty($name) && ! empty($id)) {
             $this->addPublishPostMetaBoxHiddenFields($name, ['type' => 'hidden', 'value' => $id]);
         }
         $hidden_fields = $this->_generate_admin_form_fields($this->publish_post_meta_box_hidden_fields, 'array');
@@ -2575,7 +2575,7 @@ 
 
     protected function addPublishPostMetaBoxHiddenFields(string $field_name, array $field_attributes)
     {
-        $this->publish_post_meta_box_hidden_fields[ $field_name ] = $field_attributes;
+        $this->publish_post_meta_box_hidden_fields[$field_name] = $field_attributes;
     }
 
 
@@ -2677,7 +2677,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
-            ? static function ($post, $metabox) {
+            ? static function($post, $metabox) {
                 echo EEH_Template::display_template(
                     $metabox['args']['template_path'],
                     $metabox['args']['template_args'],
@@ -2686,7 +2686,7 @@ 
             }
             : $callback;
         $this->addMetaBox(
-            str_replace('_', '-', $action) . '-mbox',
+            str_replace('_', '-', $action).'-mbox',
             $title,
             $call_back_func,
             $this->_wp_page_slug,
@@ -2802,15 +2802,15 @@ 
             'event-espresso_page_espresso_',
             '',
             $this->_wp_page_slug
-        ) . ' ' . $this->_req_action . '-route';
+        ).' '.$this->_req_action.'-route';
 
         $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';
 
         $this->_template_args['is_ajax'] = $this->request->isAjax();
         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;
 
@@ -2822,10 +2822,10 @@ 
         // to prevent WooCommerce from blowing things up if not using CPT
         global $post_type, $post;
         $this->_template_args['post_type'] = $post_type ?? '';
-        $this->_template_args['post']  = $post ?? new WP_Post((object) [ 'ID' => 0, 'filter' => 'raw' ]);
+        $this->_template_args['post'] = $post ?? new WP_Post((object) ['ID' => 0, 'filter' => 'raw']);
 
         $this->_template_args['post_body_content'] = EEH_Template::display_template(
-            EE_ADMIN_TEMPLATE . 'admin_details_wrapper_post_body_content.template.php',
+            EE_ADMIN_TEMPLATE.'admin_details_wrapper_post_body_content.template.php',
             $this->_template_args,
             true
         );
@@ -2857,11 +2857,11 @@ 
     public function display_admin_caf_preview_page(string $utm_campaign_source = '', bool $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',
@@ -2881,8 +2881,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
         );
@@ -2940,7 +2940,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);
@@ -2948,10 +2948,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
             );
@@ -2968,18 +2968,18 @@ 
 
         $hidden_form_fields = $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;
         // display message about search results?
-        $search                                    = $this->request->getRequestParam('s');
+        $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(
@@ -3013,7 +3013,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',
@@ -3068,7 +3068,7 @@ 
             $this->page_slug
         );
         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
         );
@@ -3191,7 +3191,7 @@ 
         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
             );
@@ -3200,7 +3200,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);
     }
@@ -3284,12 +3284,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 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 button--primary '.$ref.'" '
+                        . 'value="'.$button.'" name="'.$name.'" '
+                        . 'id="'.$this->_current_view.'_'.$ref.'" />';
+            if ( ! $both) {
                 break;
             }
         }
@@ -3330,13 +3330,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
         $action                                            = $this->_admin_base_url;
@@ -3344,9 +3344,9 @@ 
             <form name='form' method='post' action='$action' id='{$route}_event_form' class='ee-admin-page-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],
@@ -3359,7 +3359,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>';
@@ -3442,10 +3442,10 @@ 
     ) {
         $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 (! $override_overwrite && ! empty($what) && ! empty($action_desc) && empty($notices['errors'])) {
+        if ( ! $override_overwrite && ! empty($what) && ! empty($action_desc) && empty($notices['errors'])) {
             // how many records affected ? more than one record ? or just one ?
             EE_Error::add_success(
                 sprintf(
@@ -3496,7 +3496,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?
@@ -3508,15 +3508,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.
@@ -3528,19 +3528,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_' . $this->class_name . $this->_req_action, $query_args);
+        do_action('AHEE_redirect_'.$this->class_name.$this->_req_action, $query_args);
         $redirect_url = apply_filters(
-            'FHEE_redirect_' . $this->class_name . $this->_req_action,
+            'FHEE_redirect_'.$this->class_name.$this->_req_action,
             EE_Admin_Page::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',
@@ -3593,7 +3593,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 = $query_args['action'] ?? 'default';
             $this->_add_transient(
                 $route,
@@ -3633,7 +3633,7 @@ 
         bool $exclude_nonce = false
     ): string {
         // 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__(
@@ -3644,7 +3644,7 @@ 
                 )
             );
         }
-        if (! isset($this->_labels['buttons'][ $type ])) {
+        if ( ! isset($this->_labels['buttons'][$type])) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -3657,7 +3657,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;
@@ -3665,11 +3665,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 = EE_Admin_Page::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);
     }
 
 
@@ -3695,7 +3695,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)) {
@@ -3716,18 +3716,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]', '', DataType::KEY);
-            if (! $option) {
+            if ( ! $option) {
                 return;
             }
             $value      = $this->request->getRequestParam('wp_screen_options[value]', 0, DataType::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,
@@ -3794,7 +3794,7 @@ 
         bool $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
@@ -3827,8 +3827,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);
@@ -4088,7 +4088,7 @@ 
      */
     protected function _next_link(string $url, string $class = 'dashicons dashicons-arrow-right'): string
     {
-        return '<a class="' . $class . '" href="' . $url . '"></a>';
+        return '<a class="'.$class.'" href="'.$url.'"></a>';
     }
 
 
@@ -4101,7 +4101,7 @@ 
      */
     protected function _previous_link(string $url, string $class = 'dashicons dashicons-arrow-left'): string
     {
-        return '<a class="' . $class . '" href="' . $url . '"></a>';
+        return '<a class="'.$class.'" href="'.$url.'"></a>';
     }
 
 
@@ -4249,13 +4249,13 @@ 
         ?callable $callback = null
     ): bool {
         $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__(
@@ -4306,7 +4306,7 @@ 
                 )
             );
         }
-        if (! $entity_model->has_field($delete_column)) {
+        if ( ! $entity_model->has_field($delete_column)) {
             throw new DomainException(
                 sprintf(
                     esc_html__(

core/libraries/plugin_api/EE_Register_Addon.lib.php

Indentation +1256 added lines, -1256 removed lines

@@ -24,1260 +24,1260 @@
  */
 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 = [];
-
-    /**
-     * @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.
-     */
-    protected static $_incompatible_addons = [
-        'Multi_Event_Registration' => '2.0.11.rc.002',
-        'Promotions'               => '1.0.0.rc.084',
-        'EE_WPUsers'               => '2.1.3.p',
-    ];
-
-    /**
-     * @var LoaderInterface
-     */
-    protected static $loader;
-
-
-    /**
-     * 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(string $min_core_version): string
-    {
-        // 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 bool
-     */
-    public static function _meets_min_core_version_requirement(
-        string $min_core_version,
-        string $actual_core_version = EVENT_ESPRESSO_VERSION
-    ): bool {
-        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)
-     *
-     * @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 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
-     * @return bool
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @since                                                           4.3.0
-     * @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)
-     */
-    public static function register(string $addon_name = '', array $setup_args = []): bool
-    {
-        // $addon_name = basename($addon_name);
-        if (! self::$loader instanceof LoaderInterface) {
-            self::$loader = LoaderFactory::getLoader();
-        }
-        // make sure this was called in the right place!
-        if (
-            ! did_action('activate_plugin')
-            && (
-                ! 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'
-            );
-            return false;
-        }
-        // 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);
-        // allow early addon setup or modification of addon api settings
-        self::$_settings = (array) apply_filters(
-            'FHEE__EE_Register_Addon__register',
-            self::$_settings,
-            $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 false;
-        }
-        // 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 false;
-        }
-        // 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);
-        EE_Register_Addon::registerLicense($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', [$addon, 'after_registration'], 999);
-        return $addon instanceof EE_Addon;
-    }
-
-
-    /**
-     * @param string $addon_name
-     * @param array  $setup_args
-     * @return void
-     * @throws EE_Error
-     */
-    private static function _verify_parameters(string $addon_name, array $setup_args)
-    {
-        // required fields MUST be present, so let's make sure they are.
-        if (empty($addon_name) || empty($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 (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(string $addon_name, array $setup_args): string
-    {
-        if (empty($setup_args['class_name'])) {
-            // generate one by first separating name with spaces
-            $class_name = str_replace(['-', '_'], ' ', 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(string $class_name, array $setup_args): array
-    {
-        // setup $_settings array from incoming values.
-        $addon_settings = [
-            // 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']
-                : sanitize_key($class_name),
-            // 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']
-                : [],
-            // 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 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 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 of full server paths to any EES_Shortcodes used by the addon
-            'shortcode_paths'       => isset($setup_args['shortcode_paths'])
-                ? (array) $setup_args['shortcode_paths']
-                : [],
-            'shortcode_fqcns'       => isset($setup_args['shortcode_fqcns'])
-                ? (array) $setup_args['shortcode_fqcns']
-                : [],
-            // 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']
-                : [],
-            'message_types'         => isset($setup_args['message_types'])
-                ? (array) $setup_args['message_types']
-                : [],
-            'capabilities'          => isset($setup_args['capabilities'])
-                ? (array) $setup_args['capabilities']
-                : [],
-            'capability_maps'       => isset($setup_args['capability_maps'])
-                ? (array) $setup_args['capability_maps']
-                : [],
-            'model_paths'           => isset($setup_args['model_paths'])
-                ? (array) $setup_args['model_paths']
-                : [],
-            'class_paths'           => isset($setup_args['class_paths'])
-                ? (array) $setup_args['class_paths']
-                : [],
-            'model_extension_paths' => isset($setup_args['model_extension_paths'])
-                ? (array) $setup_args['model_extension_paths']
-                : [],
-            'class_extension_paths' => isset($setup_args['class_extension_paths'])
-                ? (array) $setup_args['class_extension_paths']
-                : [],
-            'custom_post_types'     => isset($setup_args['custom_post_types'])
-                ? (array) $setup_args['custom_post_types']
-                : [],
-            'custom_taxonomies'     => isset($setup_args['custom_taxonomies'])
-                ? (array) $setup_args['custom_taxonomies']
-                : [],
-            'payment_method_paths'  => isset($setup_args['payment_method_paths'])
-                ? (array) $setup_args['payment_method_paths']
-                : [],
-            'default_terms'         => isset($setup_args['default_terms'])
-                ? (array) $setup_args['default_terms']
-                : [],
-            // 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'])
-                ? (array) $setup_args['plugins_page_row']
-                : [],
-            'namespace'             => isset(
-                $setup_args['namespace']['FQNS'],
-                $setup_args['namespace']['DIR']
-            )
-                ? (array) $setup_args['namespace']
-                : [],
-            'privacy_policies'      => isset($setup_args['privacy_policies'])
-                ? (array) $setup_args['privacy_policies']
-                : [],
-            'license'               => isset($setup_args['license'])
-                ? (array) $setup_args['license']
-                : [],
-        ];
-        // 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 bool
-     */
-    private static function _addon_is_compatible(string $addon_name, array $addon_settings): bool
-    {
-        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;
-    }
-
-
-    /**
-     * register namespaces right away before any other files or classes get loaded, but AFTER the version checks
-     *
-     * @param array $addon_settings
-     * @return void
-     * @throws EE_Error
-     */
-    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(string $addon_name, array $addon_settings): bool
-    {
-        // 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).
-            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 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(string $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(string $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,
-                [
-                    '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,
-                [
-                    '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(string $addon_name)
-    {
-        // setup DMS
-        if (! empty(self::$_settings[ $addon_name ]['dms_paths'])) {
-            EE_Register_Data_Migration_Scripts::register(
-                $addon_name,
-                ['dms_paths' => self::$_settings[ $addon_name ]['dms_paths']]
-            );
-        }
-    }
-
-
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws EE_Error
-     */
-    private static function _register_config(string $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'],
-                [
-                    '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(string $addon_name)
-    {
-        if (! empty(self::$_settings[ $addon_name ]['admin_path'])) {
-            EE_Register_Admin_Page::register(
-                $addon_name,
-                ['page_path' => self::$_settings[ $addon_name ]['admin_path']]
-            );
-        }
-    }
-
-
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws EE_Error
-     */
-    private static function _register_modules(string $addon_name)
-    {
-        if (! empty(self::$_settings[ $addon_name ]['module_paths'])) {
-            EE_Register_Module::register(
-                $addon_name,
-                ['module_paths' => self::$_settings[ $addon_name ]['module_paths']]
-            );
-        }
-    }
-
-
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws EE_Error
-     */
-    private static function _register_shortcodes(string $addon_name)
-    {
-        if (
-            ! empty(self::$_settings[ $addon_name ]['shortcode_paths'])
-            || ! empty(self::$_settings[ $addon_name ]['shortcode_fqcns'])
-        ) {
-            EE_Register_Shortcode::register(
-                $addon_name,
-                [
-                    'shortcode_paths' => self::$_settings[ $addon_name ]['shortcode_paths'] ?? [],
-                    'shortcode_fqcns' => self::$_settings[ $addon_name ]['shortcode_fqcns'] ?? [],
-                ]
-            );
-        }
-    }
-
-
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws EE_Error
-     */
-    private static function _register_widgets(string $addon_name)
-    {
-        if (! empty(self::$_settings[ $addon_name ]['widget_paths'])) {
-            EE_Register_Widget::register(
-                $addon_name,
-                ['widget_paths' => self::$_settings[ $addon_name ]['widget_paths']]
-            );
-        }
-    }
-
-
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws EE_Error
-     */
-    private static function _register_capabilities(string $addon_name)
-    {
-        if (! empty(self::$_settings[ $addon_name ]['capabilities'])) {
-            EE_Register_Capabilities::register(
-                $addon_name,
-                [
-                    '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(string $addon_name)
-    {
-        if (! empty(self::$_settings[ $addon_name ]['message_types'])) {
-            add_action(
-                'EE_Brewing_Regular___messages_caf',
-                ['EE_Register_Addon', 'register_message_types']
-            );
-        }
-    }
-
-
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws EE_Error
-     */
-    private static function _register_custom_post_types(string $addon_name)
-    {
-        if (
-            ! empty(self::$_settings[ $addon_name ]['custom_post_types'])
-            || ! empty(self::$_settings[ $addon_name ]['custom_taxonomies'])
-        ) {
-            EE_Register_CPT::register(
-                $addon_name,
-                [
-                    '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(string $addon_name)
-    {
-        if (! empty(self::$_settings[ $addon_name ]['payment_method_paths'])) {
-            EE_Register_Payment_Method::register(
-                $addon_name,
-                ['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(string $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(string $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(string $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(string $addon_name): EE_Addon
-    {
-        $addon = self::$loader->getShared(
-            self::$_settings[ $addon_name ]['class_name'],
-            ['EE_Registry::create(addon)' => true]
-        );
-        if (! $addon instanceof EE_Addon) {
-            throw new DomainException(
-                sprintf(
-                    esc_html__('The "%1$s" EE_Addon class failed to instantiate!', 'event_espresso'),
-                    self::$_settings[ $addon_name ]['class_name']
-                )
-            );
-        }
-        // setter inject dep map if required
-        if ($addon->dependencyMap() === null) {
-            $addon->setDependencyMap(self::$loader->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']);
-        do_action(
-            'AHEE__EE_Register_Addon___load_and_init_addon_class',
-            $addon,
-            $addon_name,
-            self::$_settings
-        );
-        // 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(), [$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',
-                [$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(string $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 = self::$loader->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);
-            }
-        }
-    }
-
-
-    /**
-     * @return void
-     * @deprecated 5.0.0.p
-     */
-    public static function load_pue_update()
-    {
-    }
-
-
-    /**
-     * Callback for EE_Brewing_Regular__messages_caf hook used to register message types.
-     *
-     * @return void
-     * @throws EE_Error
-     * @since 4.4.0
-     */
-    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);
-                }
-            }
-        }
-    }
-
-
-    private static function registerLicense($addon_name)
-    {
-        $addon_settings = self::$_settings[ $addon_name ] ?? [];
-        if (empty($addon_settings)) {
-            return;
-        }
-        $license_data = isset($addon_settings['license']) ? (array) $addon_settings['license'] : [];
-        // copy known values from addon settings to license data if anything's missing
-        $license_data += [
-            'main_file_path'   => $addon_settings['main_file_path'] ?? '',
-            'min_core_version' => $addon_settings['min_core_version'] ?? '',
-            'plugin_id'        => 0, // no corresponding value in addon settings
-            'plugin_slug'      => $addon_settings['plugin_slug'] ?? '',
-            'version'          => $addon_settings['version'] ?? '',
-        ];
-        EventEspresso\core\services\licensing\AddonLicense::register($addon_name, $license_data);
-    }
-
-
-    /**
-     * 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(string $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(),
-                        [$addon, 'deactivation']
-                    );
-                    remove_action(
-                        'AHEE__EE_System__perform_activations_upgrades_and_migrations',
-                        [$addon, 'initialize_db_if_no_migrations_required']
-                    );
-                    // remove `after_registration` call
-                    remove_action(
-                        'AHEE__EE_System__load_espresso_addons__complete',
-                        [$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);
-        }
-    }
-
-
-    public static function reset(): void
-    {
-        EE_Register_Addon::$_settings = [];
-    }
-
-
-    public static function resetAll(): void
-    {
-        // EE_Register_Addon::reset();
-        EE_Register_Admin_Page::reset();
-        EE_Register_Capabilities::reset();
-        EE_Register_Config::reset();
-        EE_Register_CPT::reset();
-        EE_Register_Data_Migration_Scripts::reset();
-        EE_Register_Message_Type::reset();
-        EE_Register_Messages_Shortcode_Library::reset();
-        EE_Register_Messages_Template_Pack::reset();
-        EE_Register_Messages_Template_Variations::reset();
-        EE_Register_Model::reset();
-        EE_Register_Model_Extensions::reset();
-        EE_Register_Module::reset();
-        EE_Register_Payment_Method::reset();
-        EE_Register_Personal_Data_Eraser::reset();
-        EE_Register_Personal_Data_Exporter::reset();
-        EE_Register_Privacy_Policy::reset();
-        EE_Register_Shortcode::reset();
-        EE_Register_Widget::reset();
-    }
+	/**
+	 * 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 = [];
+
+	/**
+	 * @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.
+	 */
+	protected static $_incompatible_addons = [
+		'Multi_Event_Registration' => '2.0.11.rc.002',
+		'Promotions'               => '1.0.0.rc.084',
+		'EE_WPUsers'               => '2.1.3.p',
+	];
+
+	/**
+	 * @var LoaderInterface
+	 */
+	protected static $loader;
+
+
+	/**
+	 * 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(string $min_core_version): string
+	{
+		// 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 bool
+	 */
+	public static function _meets_min_core_version_requirement(
+		string $min_core_version,
+		string $actual_core_version = EVENT_ESPRESSO_VERSION
+	): bool {
+		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)
+	 *
+	 * @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 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
+	 * @return bool
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @since                                                           4.3.0
+	 * @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)
+	 */
+	public static function register(string $addon_name = '', array $setup_args = []): bool
+	{
+		// $addon_name = basename($addon_name);
+		if (! self::$loader instanceof LoaderInterface) {
+			self::$loader = LoaderFactory::getLoader();
+		}
+		// make sure this was called in the right place!
+		if (
+			! did_action('activate_plugin')
+			&& (
+				! 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'
+			);
+			return false;
+		}
+		// 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);
+		// allow early addon setup or modification of addon api settings
+		self::$_settings = (array) apply_filters(
+			'FHEE__EE_Register_Addon__register',
+			self::$_settings,
+			$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 false;
+		}
+		// 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 false;
+		}
+		// 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);
+		EE_Register_Addon::registerLicense($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', [$addon, 'after_registration'], 999);
+		return $addon instanceof EE_Addon;
+	}
+
+
+	/**
+	 * @param string $addon_name
+	 * @param array  $setup_args
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private static function _verify_parameters(string $addon_name, array $setup_args)
+	{
+		// required fields MUST be present, so let's make sure they are.
+		if (empty($addon_name) || empty($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 (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(string $addon_name, array $setup_args): string
+	{
+		if (empty($setup_args['class_name'])) {
+			// generate one by first separating name with spaces
+			$class_name = str_replace(['-', '_'], ' ', 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(string $class_name, array $setup_args): array
+	{
+		// setup $_settings array from incoming values.
+		$addon_settings = [
+			// 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']
+				: sanitize_key($class_name),
+			// 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']
+				: [],
+			// 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 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 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 of full server paths to any EES_Shortcodes used by the addon
+			'shortcode_paths'       => isset($setup_args['shortcode_paths'])
+				? (array) $setup_args['shortcode_paths']
+				: [],
+			'shortcode_fqcns'       => isset($setup_args['shortcode_fqcns'])
+				? (array) $setup_args['shortcode_fqcns']
+				: [],
+			// 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']
+				: [],
+			'message_types'         => isset($setup_args['message_types'])
+				? (array) $setup_args['message_types']
+				: [],
+			'capabilities'          => isset($setup_args['capabilities'])
+				? (array) $setup_args['capabilities']
+				: [],
+			'capability_maps'       => isset($setup_args['capability_maps'])
+				? (array) $setup_args['capability_maps']
+				: [],
+			'model_paths'           => isset($setup_args['model_paths'])
+				? (array) $setup_args['model_paths']
+				: [],
+			'class_paths'           => isset($setup_args['class_paths'])
+				? (array) $setup_args['class_paths']
+				: [],
+			'model_extension_paths' => isset($setup_args['model_extension_paths'])
+				? (array) $setup_args['model_extension_paths']
+				: [],
+			'class_extension_paths' => isset($setup_args['class_extension_paths'])
+				? (array) $setup_args['class_extension_paths']
+				: [],
+			'custom_post_types'     => isset($setup_args['custom_post_types'])
+				? (array) $setup_args['custom_post_types']
+				: [],
+			'custom_taxonomies'     => isset($setup_args['custom_taxonomies'])
+				? (array) $setup_args['custom_taxonomies']
+				: [],
+			'payment_method_paths'  => isset($setup_args['payment_method_paths'])
+				? (array) $setup_args['payment_method_paths']
+				: [],
+			'default_terms'         => isset($setup_args['default_terms'])
+				? (array) $setup_args['default_terms']
+				: [],
+			// 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'])
+				? (array) $setup_args['plugins_page_row']
+				: [],
+			'namespace'             => isset(
+				$setup_args['namespace']['FQNS'],
+				$setup_args['namespace']['DIR']
+			)
+				? (array) $setup_args['namespace']
+				: [],
+			'privacy_policies'      => isset($setup_args['privacy_policies'])
+				? (array) $setup_args['privacy_policies']
+				: [],
+			'license'               => isset($setup_args['license'])
+				? (array) $setup_args['license']
+				: [],
+		];
+		// 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 bool
+	 */
+	private static function _addon_is_compatible(string $addon_name, array $addon_settings): bool
+	{
+		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;
+	}
+
+
+	/**
+	 * register namespaces right away before any other files or classes get loaded, but AFTER the version checks
+	 *
+	 * @param array $addon_settings
+	 * @return void
+	 * @throws EE_Error
+	 */
+	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(string $addon_name, array $addon_settings): bool
+	{
+		// 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).
+			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 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(string $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(string $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,
+				[
+					'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,
+				[
+					'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(string $addon_name)
+	{
+		// setup DMS
+		if (! empty(self::$_settings[ $addon_name ]['dms_paths'])) {
+			EE_Register_Data_Migration_Scripts::register(
+				$addon_name,
+				['dms_paths' => self::$_settings[ $addon_name ]['dms_paths']]
+			);
+		}
+	}
+
+
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private static function _register_config(string $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'],
+				[
+					'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(string $addon_name)
+	{
+		if (! empty(self::$_settings[ $addon_name ]['admin_path'])) {
+			EE_Register_Admin_Page::register(
+				$addon_name,
+				['page_path' => self::$_settings[ $addon_name ]['admin_path']]
+			);
+		}
+	}
+
+
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private static function _register_modules(string $addon_name)
+	{
+		if (! empty(self::$_settings[ $addon_name ]['module_paths'])) {
+			EE_Register_Module::register(
+				$addon_name,
+				['module_paths' => self::$_settings[ $addon_name ]['module_paths']]
+			);
+		}
+	}
+
+
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private static function _register_shortcodes(string $addon_name)
+	{
+		if (
+			! empty(self::$_settings[ $addon_name ]['shortcode_paths'])
+			|| ! empty(self::$_settings[ $addon_name ]['shortcode_fqcns'])
+		) {
+			EE_Register_Shortcode::register(
+				$addon_name,
+				[
+					'shortcode_paths' => self::$_settings[ $addon_name ]['shortcode_paths'] ?? [],
+					'shortcode_fqcns' => self::$_settings[ $addon_name ]['shortcode_fqcns'] ?? [],
+				]
+			);
+		}
+	}
+
+
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private static function _register_widgets(string $addon_name)
+	{
+		if (! empty(self::$_settings[ $addon_name ]['widget_paths'])) {
+			EE_Register_Widget::register(
+				$addon_name,
+				['widget_paths' => self::$_settings[ $addon_name ]['widget_paths']]
+			);
+		}
+	}
+
+
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private static function _register_capabilities(string $addon_name)
+	{
+		if (! empty(self::$_settings[ $addon_name ]['capabilities'])) {
+			EE_Register_Capabilities::register(
+				$addon_name,
+				[
+					'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(string $addon_name)
+	{
+		if (! empty(self::$_settings[ $addon_name ]['message_types'])) {
+			add_action(
+				'EE_Brewing_Regular___messages_caf',
+				['EE_Register_Addon', 'register_message_types']
+			);
+		}
+	}
+
+
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private static function _register_custom_post_types(string $addon_name)
+	{
+		if (
+			! empty(self::$_settings[ $addon_name ]['custom_post_types'])
+			|| ! empty(self::$_settings[ $addon_name ]['custom_taxonomies'])
+		) {
+			EE_Register_CPT::register(
+				$addon_name,
+				[
+					'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(string $addon_name)
+	{
+		if (! empty(self::$_settings[ $addon_name ]['payment_method_paths'])) {
+			EE_Register_Payment_Method::register(
+				$addon_name,
+				['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(string $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(string $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(string $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(string $addon_name): EE_Addon
+	{
+		$addon = self::$loader->getShared(
+			self::$_settings[ $addon_name ]['class_name'],
+			['EE_Registry::create(addon)' => true]
+		);
+		if (! $addon instanceof EE_Addon) {
+			throw new DomainException(
+				sprintf(
+					esc_html__('The "%1$s" EE_Addon class failed to instantiate!', 'event_espresso'),
+					self::$_settings[ $addon_name ]['class_name']
+				)
+			);
+		}
+		// setter inject dep map if required
+		if ($addon->dependencyMap() === null) {
+			$addon->setDependencyMap(self::$loader->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']);
+		do_action(
+			'AHEE__EE_Register_Addon___load_and_init_addon_class',
+			$addon,
+			$addon_name,
+			self::$_settings
+		);
+		// 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(), [$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',
+				[$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(string $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 = self::$loader->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);
+			}
+		}
+	}
+
+
+	/**
+	 * @return void
+	 * @deprecated 5.0.0.p
+	 */
+	public static function load_pue_update()
+	{
+	}
+
+
+	/**
+	 * Callback for EE_Brewing_Regular__messages_caf hook used to register message types.
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @since 4.4.0
+	 */
+	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);
+				}
+			}
+		}
+	}
+
+
+	private static function registerLicense($addon_name)
+	{
+		$addon_settings = self::$_settings[ $addon_name ] ?? [];
+		if (empty($addon_settings)) {
+			return;
+		}
+		$license_data = isset($addon_settings['license']) ? (array) $addon_settings['license'] : [];
+		// copy known values from addon settings to license data if anything's missing
+		$license_data += [
+			'main_file_path'   => $addon_settings['main_file_path'] ?? '',
+			'min_core_version' => $addon_settings['min_core_version'] ?? '',
+			'plugin_id'        => 0, // no corresponding value in addon settings
+			'plugin_slug'      => $addon_settings['plugin_slug'] ?? '',
+			'version'          => $addon_settings['version'] ?? '',
+		];
+		EventEspresso\core\services\licensing\AddonLicense::register($addon_name, $license_data);
+	}
+
+
+	/**
+	 * 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(string $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(),
+						[$addon, 'deactivation']
+					);
+					remove_action(
+						'AHEE__EE_System__perform_activations_upgrades_and_migrations',
+						[$addon, 'initialize_db_if_no_migrations_required']
+					);
+					// remove `after_registration` call
+					remove_action(
+						'AHEE__EE_System__load_espresso_addons__complete',
+						[$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);
+		}
+	}
+
+
+	public static function reset(): void
+	{
+		EE_Register_Addon::$_settings = [];
+	}
+
+
+	public static function resetAll(): void
+	{
+		// EE_Register_Addon::reset();
+		EE_Register_Admin_Page::reset();
+		EE_Register_Capabilities::reset();
+		EE_Register_Config::reset();
+		EE_Register_CPT::reset();
+		EE_Register_Data_Migration_Scripts::reset();
+		EE_Register_Message_Type::reset();
+		EE_Register_Messages_Shortcode_Library::reset();
+		EE_Register_Messages_Template_Pack::reset();
+		EE_Register_Messages_Template_Variations::reset();
+		EE_Register_Model::reset();
+		EE_Register_Model_Extensions::reset();
+		EE_Register_Module::reset();
+		EE_Register_Payment_Method::reset();
+		EE_Register_Personal_Data_Eraser::reset();
+		EE_Register_Personal_Data_Exporter::reset();
+		EE_Register_Privacy_Policy::reset();
+		EE_Register_Shortcode::reset();
+		EE_Register_Widget::reset();
+	}
 }