eventespresso / event-espresso-core

core/admin/EE_Admin_Page.core.php

Indentation +4103 added lines, -4103 removed lines

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

Spacing +186 added lines, -186 removed lines

@@ -536,7 +536,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;
         }
@@ -556,7 +556,7 @@ 
             : $req_action;
 
         $this->_current_view = $this->_req_action;
-        $this->_req_nonce    = $this->_req_action . '_nonce';
+        $this->_req_nonce    = $this->_req_action.'_nonce';
         $this->_define_page_props();
         $this->_current_page_view_url = add_query_arg(
             ['page' => $this->_current_page, 'action' => $this->_current_view],
@@ -593,21 +593,21 @@ 
         }
         // filter routes and page_config so addons can add their stuff. Filtering done per class
         $this->_page_routes = apply_filters(
-            'FHEE__' . get_class($this) . '__page_setup__page_routes',
+            'FHEE__'.get_class($this).'__page_setup__page_routes',
             $this->_page_routes,
             $this
         );
         $this->_page_config = apply_filters(
-            'FHEE__' . get_class($this) . '__page_setup__page_config',
+            'FHEE__'.get_class($this).'__page_setup__page_config',
             $this->_page_config,
             $this
         );
         // if AHEE__EE_Admin_Page__route_admin_request_$this->_current_view method is present
         // then we call it hooked into the AHEE__EE_Admin_Page__route_admin_request action
-        if (method_exists($this, 'AHEE__EE_Admin_Page__route_admin_request_' . $this->_current_view)) {
+        if (method_exists($this, 'AHEE__EE_Admin_Page__route_admin_request_'.$this->_current_view)) {
             add_action(
                 'AHEE__EE_Admin_Page__route_admin_request',
-                [$this, 'AHEE__EE_Admin_Page__route_admin_request_' . $this->_current_view],
+                [$this, 'AHEE__EE_Admin_Page__route_admin_request_'.$this->_current_view],
                 10,
                 2
             );
@@ -620,8 +620,8 @@ 
             if ($this->_is_UI_request) {
                 // admin_init stuff - global, all views for this page class, specific view
                 add_action('admin_init', [$this, 'admin_init'], 10);
-                if (method_exists($this, 'admin_init_' . $this->_current_view)) {
-                    add_action('admin_init', [$this, 'admin_init_' . $this->_current_view], 15);
+                if (method_exists($this, 'admin_init_'.$this->_current_view)) {
+                    add_action('admin_init', [$this, 'admin_init_'.$this->_current_view], 15);
                 }
             } else {
                 // hijack regular WP loading and route admin request immediately
@@ -640,12 +640,12 @@ 
      */
     private function _do_other_page_hooks()
     {
-        $registered_pages = apply_filters('FHEE_do_other_page_hooks_' . $this->page_slug, []);
+        $registered_pages = apply_filters('FHEE_do_other_page_hooks_'.$this->page_slug, []);
         foreach ($registered_pages as $page) {
             // now let's setup the file name and class that should be present
             $classname = str_replace('.class.php', '', $page);
             // autoloaders should take care of loading file
-            if (! class_exists($classname)) {
+            if ( ! class_exists($classname)) {
                 $error_msg[] = sprintf(
                     esc_html__(
                         'Something went wrong with loading the %s admin hooks page.',
@@ -662,7 +662,7 @@ 
                                    ),
                                    $page,
                                    '<br />',
-                                   '<strong>' . $classname . '</strong>'
+                                   '<strong>'.$classname.'</strong>'
                                );
                 throw new EE_Error(implode('||', $error_msg));
             }
@@ -704,13 +704,13 @@ 
         // load admin_notices - global, page class, and view specific
         add_action('admin_notices', [$this, 'admin_notices_global'], 5);
         add_action('admin_notices', [$this, 'admin_notices'], 10);
-        if (method_exists($this, 'admin_notices_' . $this->_current_view)) {
-            add_action('admin_notices', [$this, 'admin_notices_' . $this->_current_view], 15);
+        if (method_exists($this, 'admin_notices_'.$this->_current_view)) {
+            add_action('admin_notices', [$this, 'admin_notices_'.$this->_current_view], 15);
         }
         // load network admin_notices - global, page class, and view specific
         add_action('network_admin_notices', [$this, 'network_admin_notices_global'], 5);
-        if (method_exists($this, 'network_admin_notices_' . $this->_current_view)) {
-            add_action('network_admin_notices', [$this, 'network_admin_notices_' . $this->_current_view]);
+        if (method_exists($this, 'network_admin_notices_'.$this->_current_view)) {
+            add_action('network_admin_notices', [$this, 'network_admin_notices_'.$this->_current_view]);
         }
         // this will save any per_page screen options if they are present
         $this->_set_per_page_screen_options();
@@ -832,7 +832,7 @@ 
     protected function _verify_routes()
     {
         do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        if (! $this->_current_page && ! $this->request->isAjax()) {
+        if ( ! $this->_current_page && ! $this->request->isAjax()) {
             return false;
         }
         $this->_route = false;
@@ -844,7 +844,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'
@@ -853,9 +853,9 @@ 
         }
         // and that the requested page route exists
         if (array_key_exists($this->_req_action, $this->_page_routes)) {
-            $this->_route        = $this->_page_routes[ $this->_req_action ];
-            $this->_route_config = isset($this->_page_config[ $this->_req_action ])
-                ? $this->_page_config[ $this->_req_action ]
+            $this->_route        = $this->_page_routes[$this->_req_action];
+            $this->_route_config = isset($this->_page_config[$this->_req_action])
+                ? $this->_page_config[$this->_req_action]
                 : [];
         } else {
             // user error msg
@@ -867,7 +867,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.',
@@ -878,7 +878,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__(
@@ -888,7 +888,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'
@@ -929,7 +929,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',
@@ -954,7 +954,7 @@ 
     protected function _verify_nonce($nonce, $nonce_ref)
     {
         // verify nonce against expected value
-        if (! wp_verify_nonce($nonce, $nonce_ref)) {
+        if ( ! wp_verify_nonce($nonce, $nonce_ref)) {
             // these are not the droids you are looking for !!!
             $msg = sprintf(
                 esc_html__('%sNonce Fail.%s', 'event_espresso'),
@@ -971,7 +971,7 @@ 
                     __CLASS__
                 );
             }
-            if (! $this->request->isAjax()) {
+            if ( ! $this->request->isAjax()) {
                 wp_die($msg);
             }
             EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
@@ -995,7 +995,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'];
@@ -1015,7 +1015,7 @@ 
         $error_msg = '';
         // action right before calling route
         // (hook is something like 'AHEE__Registrations_Admin_Page__route_admin_request')
-        if (! did_action('AHEE__EE_Admin_Page__route_admin_request')) {
+        if ( ! did_action('AHEE__EE_Admin_Page__route_admin_request')) {
             do_action('AHEE__EE_Admin_Page__route_admin_request', $this->_current_view, $this);
         }
         // right before calling the route, let's clean the _wp_http_referer
@@ -1026,7 +1026,7 @@ 
                 wp_unslash($this->request->getServerParam('REQUEST_URI'))
             )
         );
-        if (! empty($func)) {
+        if ( ! empty($func)) {
             if (is_array($func)) {
                 list($class, $method) = $func;
             } elseif (strpos($func, '::') !== false) {
@@ -1035,7 +1035,7 @@ 
                 $class  = $this;
                 $method = $func;
             }
-            if (! (is_object($class) && $class === $this)) {
+            if ( ! (is_object($class) && $class === $this)) {
                 // send along this admin page object for access by addons.
                 $args['admin_page_object'] = $this;
             }
@@ -1076,7 +1076,7 @@ 
                     $method
                 );
             }
-            if (! empty($error_msg)) {
+            if ( ! empty($error_msg)) {
                 throw new EE_Error($error_msg);
             }
         }
@@ -1161,7 +1161,7 @@ 
                 if (strpos($key, 'nonce') !== false) {
                     continue;
                 }
-                $args[ 'wp_referer[' . $key . ']' ] = htmlspecialchars($value);
+                $args['wp_referer['.$key.']'] = htmlspecialchars($value);
             }
         }
         return EEH_URL::add_query_args_and_nonce($args, $url, $exclude_nonce);
@@ -1201,8 +1201,8 @@ 
     protected function _add_help_tabs()
     {
         $tour_buttons = '';
-        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];
             // disabled temporarily. see: https://github.com/eventespresso/eventsmart.com-website/issues/836
             // is there a help tour for the current route?  if there is let's setup the tour buttons
             // if (isset($this->_help_tour[ $this->_req_action ])) {
@@ -1225,7 +1225,7 @@ 
             // 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__(
@@ -1238,7 +1238,7 @@ 
                     );
                 }
                 $content = apply_filters(
-                    'FHEE__' . get_class($this) . '__add_help_tabs__help_sidebar',
+                    'FHEE__'.get_class($this).'__add_help_tabs__help_sidebar',
                     $this->{$config['help_sidebar']}()
                 );
                 $content .= $tour_buttons; // add help tour buttons.
@@ -1246,27 +1246,27 @@ 
                 $this->_current_screen->set_help_sidebar($content);
             }
             // if we DON'T have config help sidebar and there ARE tour buttons then we'll just add the tour buttons to the sidebar.
-            if (! isset($config['help_sidebar']) && ! empty($tour_buttons)) {
+            if ( ! isset($config['help_sidebar']) && ! empty($tour_buttons)) {
                 $this->_current_screen->set_help_sidebar($tour_buttons);
             }
             // handle if no help_tabs are set so the sidebar will still show for the help tour buttons
-            if (! isset($config['help_tabs']) && ! empty($tour_buttons)) {
+            if ( ! isset($config['help_tabs']) && ! empty($tour_buttons)) {
                 $_ht['id']      = $this->page_slug;
                 $_ht['title']   = esc_html__('Help Tours', 'event_espresso');
                 $_ht['content'] = '<p>'
                                   . esc_html__(
                                       'The buttons to the right allow you to start/restart any help tours available for this page',
                                       'event_espresso'
-                                  ) . '</p>';
+                                  ).'</p>';
                 $this->_current_screen->add_help_tab($_ht);
             }
-            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',
@@ -1274,7 +1274,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',
@@ -1283,11 +1283,11 @@ 
                     );
                 }
                 // first priority goes to content.
-                if (! empty($cfg['content'])) {
+                if ( ! empty($cfg['content'])) {
                     $content = ! empty($cfg['content']) ? $cfg['content'] : null;
                     // second priority goes to filename
-                } elseif (! empty($cfg['filename'])) {
-                    $file_path = $this->_get_dir() . '/help_tabs/' . $cfg['filename'] . '.help_tab.php';
+                } elseif ( ! empty($cfg['filename'])) {
+                    $file_path = $this->_get_dir().'/help_tabs/'.$cfg['filename'].'.help_tab.php';
                     // it's possible that the file is located on decaf route (and above sets up for caf route, if this is the case then lets check decaf route too)
                     $file_path = ! is_readable($file_path) ? EE_ADMIN_PAGES
                                                              . basename($this->_get_dir())
@@ -1295,7 +1295,7 @@ 
                                                              . $cfg['filename']
                                                              . '.help_tab.php' : $file_path;
                     // if file is STILL not readable then let's do a EE_Error so its more graceful than a fatal error.
-                    if (! isset($cfg['callback']) && ! is_readable($file_path)) {
+                    if ( ! isset($cfg['callback']) && ! is_readable($file_path)) {
                         EE_Error::add_error(
                             sprintf(
                                 esc_html__(
@@ -1343,7 +1343,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'],
@@ -1470,8 +1470,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);
         }
@@ -1493,7 +1493,7 @@ 
         do_action('AHEE_log', __FILE__, __FUNCTION__, '');
         $i = 0;
         foreach ($this->_page_config as $slug => $config) {
-            if (! is_array($config) || empty($config['nav'])) {
+            if ( ! is_array($config) || empty($config['nav'])) {
                 continue;
             }
             // no nav tab for this config
@@ -1502,12 +1502,12 @@ 
                 // nav tab is only to appear when route requested.
                 continue;
             }
-            if (! $this->check_user_access($slug, true)) {
+            if ( ! $this->check_user_access($slug, true)) {
                 // no nav tab because current user does not have access.
                 continue;
             }
-            $css_class                = isset($config['css_class']) ? $config['css_class'] . ' ' : '';
-            $this->_nav_tabs[ $slug ] = [
+            $css_class                = isset($config['css_class']) ? $config['css_class'].' ' : '';
+            $this->_nav_tabs[$slug] = [
                 'url'       => isset($config['nav']['url'])
                     ? $config['nav']['url']
                     : self::add_query_args_and_nonce(
@@ -1519,14 +1519,14 @@ 
                     : ucwords(
                         str_replace('_', ' ', $slug)
                     ),
-                'css_class' => $this->_req_action === $slug ? $css_class . 'nav-tab-active' : $css_class,
+                'css_class' => $this->_req_action === $slug ? $css_class.'nav-tab-active' : $css_class,
                 'order'     => isset($config['nav']['order']) ? $config['nav']['order'] : $i,
             ];
             $i++;
         }
         // if $this->_nav_tabs is empty then lets set the default
         if (empty($this->_nav_tabs)) {
-            $this->_nav_tabs[ $this->_default_nav_tab_name ] = [
+            $this->_nav_tabs[$this->_default_nav_tab_name] = [
                 'url'       => $this->_admin_base_url,
                 'link_text' => ucwords(str_replace('_', ' ', $this->_default_nav_tab_name)),
                 'css_class' => 'nav-tab-active',
@@ -1551,10 +1551,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;
                 }
             }
         }
@@ -1576,12 +1576,12 @@ 
     {
         do_action('AHEE_log', __FILE__, __FUNCTION__, '');
         $route_to_check = empty($route_to_check) ? $this->_req_action : $route_to_check;
-        $capability     = ! empty($route_to_check) && isset($this->_page_routes[ $route_to_check ])
+        $capability     = ! empty($route_to_check) && isset($this->_page_routes[$route_to_check])
                           && is_array(
-                              $this->_page_routes[ $route_to_check ]
+                              $this->_page_routes[$route_to_check]
                           )
-                          && ! empty($this->_page_routes[ $route_to_check ]['capability'])
-            ? $this->_page_routes[ $route_to_check ]['capability'] : null;
+                          && ! empty($this->_page_routes[$route_to_check]['capability'])
+            ? $this->_page_routes[$route_to_check]['capability'] : null;
         if (empty($capability) && empty($route_to_check)) {
             $capability = is_array($this->_route) && empty($this->_route['capability']) ? 'manage_options'
                 : $this->_route['capability'];
@@ -1706,7 +1706,7 @@ 
         //     echo implode('<br />', $this->_help_tour[ $this->_req_action ]);
         // }
         // current set timezone for timezone js
-        echo '<span id="current_timezone" class="hidden">' . esc_html(EEH_DTT_Helper::get_timezone()) . '</span>';
+        echo '<span id="current_timezone" class="hidden">'.esc_html(EEH_DTT_Helper::get_timezone()).'</span>';
     }
 
 
@@ -1740,7 +1740,7 @@ 
         // loop through the array and setup content
         foreach ($help_array as $trigger => $help) {
             // make sure the array is setup properly
-            if (! isset($help['title']) || ! isset($help['content'])) {
+            if ( ! isset($help['title']) || ! isset($help['content'])) {
                 throw new EE_Error(
                     esc_html__(
                         'Does not look like the popup content array has been setup correctly.  Might want to double check that.  Read the comments for the _get_help_popup_content method found in "EE_Admin_Page" class',
@@ -1754,8 +1754,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
             );
@@ -1777,15 +1777,15 @@ 
     private function _get_help_content()
     {
         // what is the method we're looking for?
-        $method_name = '_help_popup_content_' . $this->_req_action;
+        $method_name = '_help_popup_content_'.$this->_req_action;
         // if method doesn't exist let's get out.
-        if (! method_exists($this, $method_name)) {
+        if ( ! method_exists($this, $method_name)) {
             return [];
         }
         // k we're good to go let's retrieve the help array
         $help_array = call_user_func([$this, $method_name]);
         // make sure we've got an array!
-        if (! is_array($help_array)) {
+        if ( ! is_array($help_array)) {
             throw new EE_Error(
                 esc_html__(
                     'Something went wrong with help popup content generation. Expecting an array and well, this ain\'t no array bub.',
@@ -1817,15 +1817,15 @@ 
         // let's check and see if there is any content set for this popup.  If there isn't then we'll include a default title and content so that developers know something needs to be corrected
         $help_array   = $this->_get_help_content();
         $help_content = '';
-        if (empty($help_array) || ! isset($help_array[ $trigger_id ])) {
-            $help_array[ $trigger_id ] = [
+        if (empty($help_array) || ! isset($help_array[$trigger_id])) {
+            $help_array[$trigger_id] = [
                 'title'   => esc_html__('Missing Content', 'event_espresso'),
                 'content' => esc_html__(
                     'A trigger has been set that doesn\'t have any corresponding content. Make sure you have set the help content. (see the "_set_help_popup_content" method in the EE_Admin_Page for instructions.)',
                     'event_espresso'
                 ),
             ];
-            $help_content              = $this->_set_help_popup_content($help_array);
+            $help_content = $this->_set_help_popup_content($help_array);
         }
         // let's setup the trigger
         $content = '<a class="ee-dialog" href="?height='
@@ -1893,15 +1893,15 @@ 
         // register all styles
         wp_register_style(
             'espresso-ui-theme',
-            EE_GLOBAL_ASSETS_URL . 'css/espresso-ui-theme/jquery-ui-1.10.3.custom.min.css',
+            EE_GLOBAL_ASSETS_URL.'css/espresso-ui-theme/jquery-ui-1.10.3.custom.min.css',
             [],
             EVENT_ESPRESSO_VERSION
         );
-        wp_register_style('ee-admin-css', EE_ADMIN_URL . 'assets/ee-admin-page.css', [], EVENT_ESPRESSO_VERSION);
+        wp_register_style('ee-admin-css', EE_ADMIN_URL.'assets/ee-admin-page.css', [], EVENT_ESPRESSO_VERSION);
         // helpers styles
         wp_register_style(
             'ee-text-links',
-            EE_PLUGIN_DIR_URL . 'core/helpers/assets/ee_text_list_helper.css',
+            EE_PLUGIN_DIR_URL.'core/helpers/assets/ee_text_list_helper.css',
             [],
             EVENT_ESPRESSO_VERSION
         );
@@ -1909,21 +1909,21 @@ 
         // register all scripts
         wp_register_script(
             'ee-dialog',
-            EE_ADMIN_URL . 'assets/ee-dialog-helper.js',
+            EE_ADMIN_URL.'assets/ee-dialog-helper.js',
             ['jquery', 'jquery-ui-draggable'],
             EVENT_ESPRESSO_VERSION,
             true
         );
         wp_register_script(
             'ee_admin_js',
-            EE_ADMIN_URL . 'assets/ee-admin-page.js',
+            EE_ADMIN_URL.'assets/ee-admin-page.js',
             ['espresso_core', 'ee-parse-uri', 'ee-dialog'],
             EVENT_ESPRESSO_VERSION,
             true
         );
         wp_register_script(
             'jquery-ui-timepicker-addon',
-            EE_GLOBAL_ASSETS_URL . 'scripts/jquery-ui-timepicker-addon.js',
+            EE_GLOBAL_ASSETS_URL.'scripts/jquery-ui-timepicker-addon.js',
             ['jquery-ui-datepicker', 'jquery-ui-slider'],
             EVENT_ESPRESSO_VERSION,
             true
@@ -1935,7 +1935,7 @@ 
         // script for sorting tables
         wp_register_script(
             'espresso_ajax_table_sorting',
-            EE_ADMIN_URL . 'assets/espresso_ajax_table_sorting.js',
+            EE_ADMIN_URL.'assets/espresso_ajax_table_sorting.js',
             ['ee_admin_js', 'jquery-ui-sortable'],
             EVENT_ESPRESSO_VERSION,
             true
@@ -1943,7 +1943,7 @@ 
         // script for parsing uri's
         wp_register_script(
             'ee-parse-uri',
-            EE_GLOBAL_ASSETS_URL . 'scripts/parseuri.js',
+            EE_GLOBAL_ASSETS_URL.'scripts/parseuri.js',
             [],
             EVENT_ESPRESSO_VERSION,
             true
@@ -1951,7 +1951,7 @@ 
         // and parsing associative serialized form elements
         wp_register_script(
             'ee-serialize-full-array',
-            EE_GLOBAL_ASSETS_URL . 'scripts/jquery.serializefullarray.js',
+            EE_GLOBAL_ASSETS_URL.'scripts/jquery.serializefullarray.js',
             ['jquery'],
             EVENT_ESPRESSO_VERSION,
             true
@@ -1959,28 +1959,28 @@ 
         // helpers scripts
         wp_register_script(
             'ee-text-links',
-            EE_PLUGIN_DIR_URL . 'core/helpers/assets/ee_text_list_helper.js',
+            EE_PLUGIN_DIR_URL.'core/helpers/assets/ee_text_list_helper.js',
             ['jquery'],
             EVENT_ESPRESSO_VERSION,
             true
         );
         wp_register_script(
             'ee-moment-core',
-            EE_THIRD_PARTY_URL . 'moment/moment-with-locales.min.js',
+            EE_THIRD_PARTY_URL.'moment/moment-with-locales.min.js',
             [],
             EVENT_ESPRESSO_VERSION,
             true
         );
         wp_register_script(
             'ee-moment',
-            EE_THIRD_PARTY_URL . 'moment/moment-timezone-with-data.min.js',
+            EE_THIRD_PARTY_URL.'moment/moment-timezone-with-data.min.js',
             ['ee-moment-core'],
             EVENT_ESPRESSO_VERSION,
             true
         );
         wp_register_script(
             'ee-datepicker',
-            EE_ADMIN_URL . 'assets/ee-datepicker.js',
+            EE_ADMIN_URL.'assets/ee-datepicker.js',
             ['jquery-ui-timepicker-addon', 'ee-moment'],
             EVENT_ESPRESSO_VERSION,
             true
@@ -2040,7 +2040,7 @@ 
 
         add_filter(
             'admin_body_class',
-            function ($classes) {
+            function($classes) {
                 if (strpos($classes, 'espresso-admin') === false) {
                     $classes .= ' espresso-admin';
                 }
@@ -2128,12 +2128,12 @@ 
     protected function _set_list_table()
     {
         // first is this a list_table view?
-        if (! isset($this->_route_config['list_table'])) {
+        if ( ! isset($this->_route_config['list_table'])) {
             return;
         } //not a list_table view so get out.
         // list table functions are per view specific (because some admin pages might have more than one list table!)
-        $list_table_view = '_set_list_table_views_' . $this->_req_action;
-        if (! method_exists($this, $list_table_view) || $this->{$list_table_view}() === false) {
+        $list_table_view = '_set_list_table_views_'.$this->_req_action;
+        if ( ! method_exists($this, $list_table_view) || $this->{$list_table_view}() === false) {
             // user error msg
             $error_msg = esc_html__(
                 'An error occurred. The requested list table views could not be found.',
@@ -2153,10 +2153,10 @@ 
         }
         // let's provide the ability to filter the views per PAGE AND ROUTE, per PAGE, and globally
         $this->_views = apply_filters(
-            'FHEE_list_table_views_' . $this->page_slug . '_' . $this->_req_action,
+            'FHEE_list_table_views_'.$this->page_slug.'_'.$this->_req_action,
             $this->_views
         );
-        $this->_views = apply_filters('FHEE_list_table_views_' . $this->page_slug, $this->_views);
+        $this->_views = apply_filters('FHEE_list_table_views_'.$this->page_slug, $this->_views);
         $this->_views = apply_filters('FHEE_list_table_views', $this->_views);
         $this->_set_list_table_view();
         $this->_set_list_table_object();
@@ -2191,7 +2191,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__(
@@ -2229,15 +2229,15 @@ 
         foreach ($this->_views as $key => $view) {
             $query_args = [];
             // check for current view
-            $this->_views[ $key ]['class']               = $this->_view === $view['slug'] ? 'current' : '';
+            $this->_views[$key]['class']               = $this->_view === $view['slug'] ? 'current' : '';
             $query_args['action']                        = $this->_req_action;
-            $query_args[ $this->_req_action . '_nonce' ] = wp_create_nonce($query_args['action'] . '_nonce');
+            $query_args[$this->_req_action.'_nonce'] = wp_create_nonce($query_args['action'].'_nonce');
             $query_args['status']                        = $view['slug'];
             // merge any other arguments sent in.
-            if (isset($extra_query_args[ $view['slug'] ])) {
-                $query_args = array_merge($query_args, $extra_query_args[ $view['slug'] ]);
+            if (isset($extra_query_args[$view['slug']])) {
+                $query_args = array_merge($query_args, $extra_query_args[$view['slug']]);
             }
-            $this->_views[ $key ]['url'] = EE_Admin_Page::add_query_args_and_nonce($query_args, $this->_admin_base_url);
+            $this->_views[$key]['url'] = EE_Admin_Page::add_query_args_and_nonce($query_args, $this->_admin_base_url);
         }
         return $this->_views;
     }
@@ -2268,14 +2268,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
@@ -2299,7 +2299,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;
     }
 
 
@@ -2387,7 +2387,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
@@ -2432,7 +2432,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(
@@ -2460,7 +2460,7 @@ 
     public function espresso_ratings_request()
     {
         EEH_Template::display_template(
-            EE_ADMIN_TEMPLATE . 'espresso_ratings_request_content.template.php',
+            EE_ADMIN_TEMPLATE.'espresso_ratings_request_content.template.php',
             []
         );
     }
@@ -2468,22 +2468,22 @@ 
 
     public static function cached_rss_display($rss_id, $url)
     {
-        $loading   = '<p class="widget-loading hide-if-no-js">'
+        $loading = '<p class="widget-loading hide-if-no-js">'
                      . esc_html__('Loading&#8230;', 'event_espresso')
                      . '</p><p class="hide-if-js">'
                      . esc_html__('This widget requires JavaScript.', 'event_espresso')
                      . '</p>';
-        $pre       = '<div class="espresso-rss-display">' . "\n\t";
-        $pre       .= '<span id="' . esc_attr($rss_id) . '_url" class="hidden">' . esc_url_raw($url) . '</span>';
-        $post      = '</div>' . "\n";
-        $cache_key = 'ee_rss_' . md5($rss_id);
+        $pre       = '<div class="espresso-rss-display">'."\n\t";
+        $pre .= '<span id="'.esc_attr($rss_id).'_url" class="hidden">'.esc_url_raw($url).'</span>';
+        $post      = '</div>'."\n";
+        $cache_key = 'ee_rss_'.md5($rss_id);
         $output    = get_transient($cache_key);
         if ($output !== false) {
-            echo $pre . $output . $post; // already escaped
+            echo $pre.$output.$post; // already escaped
             return true;
         }
-        if (! (defined('DOING_AJAX') && DOING_AJAX)) {
-            echo $pre . $loading . $post; // already escaped
+        if ( ! (defined('DOING_AJAX') && DOING_AJAX)) {
+            echo $pre.$loading.$post; // already escaped
             return false;
         }
         ob_start();
@@ -2550,19 +2550,19 @@ 
     public function espresso_sponsors_post_box()
     {
         EEH_Template::display_template(
-            EE_ADMIN_TEMPLATE . 'admin_general_metabox_contents_espresso_sponsors.template.php'
+            EE_ADMIN_TEMPLATE.'admin_general_metabox_contents_espresso_sponsors.template.php'
         );
     }
 
 
     private function _publish_post_box()
     {
-        $meta_box_ref = 'espresso_' . $this->page_slug . '_editor_overview';
+        $meta_box_ref = 'espresso_'.$this->page_slug.'_editor_overview';
         // if there is a array('label' => array('publishbox' => 'some title') ) present in the _page_config array
         // then we'll use that for the metabox label.
         // Otherwise we'll just use publish (publishbox itself could be an array of labels indexed by routes)
-        if (! empty($this->_labels['publishbox'])) {
-            $box_label = is_array($this->_labels['publishbox']) ? $this->_labels['publishbox'][ $this->_req_action ]
+        if ( ! empty($this->_labels['publishbox'])) {
+            $box_label = is_array($this->_labels['publishbox']) ? $this->_labels['publishbox'][$this->_req_action]
                 : $this->_labels['publishbox'];
         } else {
             $box_label = esc_html__('Publish', 'event_espresso');
@@ -2591,7 +2591,7 @@ 
             ? $this->_template_args['publish_box_extra_content']
             : '';
         echo EEH_Template::display_template(
-            EE_ADMIN_TEMPLATE . 'admin_details_publish_metabox.template.php',
+            EE_ADMIN_TEMPLATE.'admin_details_publish_metabox.template.php',
             $this->_template_args,
             true
         );
@@ -2683,18 +2683,18 @@ 
             );
         }
         $this->_template_args['publish_delete_link'] = ! empty($id) ? $delete : '';
-        if (! empty($name) && ! empty($id)) {
-            $hidden_field_arr[ $name ] = [
+        if ( ! empty($name) && ! empty($id)) {
+            $hidden_field_arr[$name] = [
                 'type'  => 'hidden',
                 'value' => $id,
             ];
-            $hf                        = $this->_generate_admin_form_fields($hidden_field_arr, 'array');
+            $hf = $this->_generate_admin_form_fields($hidden_field_arr, 'array');
         } else {
             $hf = '';
         }
         // add hidden field
         $this->_template_args['publish_hidden_fields'] = is_array($hf) && ! empty($name)
-            ? $hf[ $name ]['field']
+            ? $hf[$name]['field']
             : $hf;
     }
 
@@ -2796,7 +2796,7 @@ 
         }
         // if $create_func is true (default) then we automatically create the function for displaying the actual meta box.  If false then we take the $callback reference passed through and use it instead (so callers can define their own callback function/method if they wish)
         $call_back_func = $create_func
-            ? function ($post, $metabox) {
+            ? function($post, $metabox) {
                 do_action('AHEE_log', __FILE__, __FUNCTION__, '');
                 echo EEH_Template::display_template(
                     $metabox['args']['template_path'],
@@ -2806,7 +2806,7 @@ 
             }
             : $callback;
         add_meta_box(
-            str_replace('_', '-', $action) . '-mbox',
+            str_replace('_', '-', $action).'-mbox',
             $title,
             $call_back_func,
             $this->_wp_page_slug,
@@ -2898,9 +2898,9 @@ 
             : 'espresso-default-admin';
         $template_path                                     = $sidebar
             ? EE_ADMIN_TEMPLATE . 'admin_details_wrapper.template.php'
-            : EE_ADMIN_TEMPLATE . 'admin_details_wrapper_no_sidebar.template.php';
+            : EE_ADMIN_TEMPLATE.'admin_details_wrapper_no_sidebar.template.php';
         if ($this->request->isAjax()) {
-            $template_path = EE_ADMIN_TEMPLATE . 'admin_details_wrapper_no_sidebar_ajax.template.php';
+            $template_path = EE_ADMIN_TEMPLATE.'admin_details_wrapper_no_sidebar_ajax.template.php';
         }
         $template_path                                     = ! empty($this->_column_template_path)
             ? $this->_column_template_path : $template_path;
@@ -2940,11 +2940,11 @@ 
     public function display_admin_caf_preview_page($utm_campaign_source = '', $display_sidebar = true)
     {
         // let's generate a default preview action button if there isn't one already present.
-        $this->_labels['buttons']['buy_now']           = esc_html__(
+        $this->_labels['buttons']['buy_now'] = esc_html__(
             'Upgrade to Event Espresso 4 Right Now',
             'event_espresso'
         );
-        $buy_now_url                                   = add_query_arg(
+        $buy_now_url = add_query_arg(
             [
                 'ee_ver'       => 'ee4',
                 'utm_source'   => 'ee4_plugin_admin',
@@ -2964,8 +2964,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
         );
@@ -3014,7 +3014,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);
@@ -3022,10 +3022,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
             );
@@ -3043,20 +3043,20 @@ 
             isset($this->_template_args['list_table_hidden_fields'])
                 ? $this->_template_args['list_table_hidden_fields']
                 : '';
-        $nonce_ref                                               = $this->_req_action . '_nonce';
-        $hidden_form_fields                                      .= '<input type="hidden" name="'
+        $nonce_ref = $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;
+        $this->_template_args['list_table_hidden_fields'] = $hidden_form_fields;
         // display message about search results?
         $search = $this->request->getRequestParam('s');
         $this->_template_args['before_list_table'] .= ! empty($search)
-            ? '<p class="ee-search-results">' . sprintf(
+            ? '<p class="ee-search-results">'.sprintf(
                 esc_html__('Displaying search results for the search string: %1$s', 'event_espresso'),
                 trim($search, '%')
-            ) . '</p>'
+            ).'</p>'
             : '';
         // filter before_list_table template arg
         $this->_template_args['before_list_table'] = apply_filters(
@@ -3090,7 +3090,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',
@@ -3137,7 +3137,7 @@ 
             $this
         );
         return EEH_Template::display_template(
-            EE_ADMIN_TEMPLATE . 'admin_details_legend.template.php',
+            EE_ADMIN_TEMPLATE.'admin_details_legend.template.php',
             $this->_template_args,
             true
         );
@@ -3246,18 +3246,18 @@ 
                 : ''
         );
 
-        $this->_template_args['after_admin_page_content']  = apply_filters(
+        $this->_template_args['after_admin_page_content'] = apply_filters(
             "FHEE_after_admin_page_content{$this->_current_page}{$this->_current_view}",
             isset($this->_template_args['after_admin_page_content'])
                 ? $this->_template_args['after_admin_page_content']
                 : ''
         );
-        $this->_template_args['after_admin_page_content']  .= $this->_set_help_popup_content();
+        $this->_template_args['after_admin_page_content'] .= $this->_set_help_popup_content();
 
         if ($this->request->isAjax()) {
             $this->_template_args['admin_page_content'] = EEH_Template::display_template(
                 // $template_path,
-                EE_ADMIN_TEMPLATE . 'admin_wrapper_ajax.template.php',
+                EE_ADMIN_TEMPLATE.'admin_wrapper_ajax.template.php',
                 $this->_template_args,
                 true
             );
@@ -3266,7 +3266,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);
     }
@@ -3351,12 +3351,12 @@ 
         $default_names = ['save', 'save_and_close'];
         $buttons = '';
         foreach ($button_text as $key => $button) {
-            $ref     = $default_names[ $key ];
-            $name    = ! empty($actions) ? $actions[ $key ] : $ref;
-            $buttons .= '<input type="submit" class="button-primary ' . $ref . '" '
-                        . 'value="' . $button . '" name="' . $name . '" '
-                        . 'id="' . $this->_current_view . '_' . $ref . '" />';
-            if (! $both) {
+            $ref     = $default_names[$key];
+            $name    = ! empty($actions) ? $actions[$key] : $ref;
+            $buttons .= '<input type="submit" class="button-primary '.$ref.'" '
+                        . 'value="'.$button.'" name="'.$name.'" '
+                        . 'id="'.$this->_current_view.'_'.$ref.'" />';
+            if ( ! $both) {
                 break;
             }
         }
@@ -3396,13 +3396,13 @@ 
                 'An error occurred. No action was set for this page\'s form.',
                 'event_espresso'
             );
-            $dev_msg  = $user_msg . "\n"
+            $dev_msg = $user_msg."\n"
                         . sprintf(
                             esc_html__('The $route argument is required for the %s->%s method.', 'event_espresso'),
                             __FUNCTION__,
                             __CLASS__
                         );
-            EE_Error::add_error($user_msg . '||' . $dev_msg, __FILE__, __FUNCTION__, __LINE__);
+            EE_Error::add_error($user_msg.'||'.$dev_msg, __FILE__, __FUNCTION__, __LINE__);
         }
         // open form
         $this->_template_args['before_admin_page_content'] = '<form name="form" method="post" action="'
@@ -3411,9 +3411,9 @@ 
                                                              . $route
                                                              . '_event_form" >';
         // add nonce
-        $nonce                                             =
-            wp_nonce_field($route . '_nonce', $route . '_nonce', false, false);
-        $this->_template_args['before_admin_page_content'] .= "\n\t" . $nonce;
+        $nonce =
+            wp_nonce_field($route.'_nonce', $route.'_nonce', false, false);
+        $this->_template_args['before_admin_page_content'] .= "\n\t".$nonce;
         // add REQUIRED form action
         $hidden_fields = [
             'action' => ['type' => 'hidden', 'value' => $route],
@@ -3426,7 +3426,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>';
@@ -3517,10 +3517,10 @@ 
         $redirect_url = isset($query_args['page']) ? admin_url('admin.php') : $this->_admin_base_url;
         $notices      = EE_Error::get_notices(false);
         // overwrite default success messages //BUT ONLY if overwrite not overridden
-        if (! $override_overwrite || ! empty($notices['errors'])) {
+        if ( ! $override_overwrite || ! empty($notices['errors'])) {
             EE_Error::overwrite_success();
         }
-        if (! empty($what) && ! empty($action_desc) && empty($notices['errors'])) {
+        if ( ! empty($what) && ! empty($action_desc) && empty($notices['errors'])) {
             // how many records affected ? more than one record ? or just one ?
             if ($success > 1) {
                 // set plural msg
@@ -3549,7 +3549,7 @@ 
             }
         }
         // check that $query_args isn't something crazy
-        if (! is_array($query_args)) {
+        if ( ! is_array($query_args)) {
             $query_args = [];
         }
         /**
@@ -3578,7 +3578,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?
@@ -3590,15 +3590,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.
@@ -3610,19 +3610,19 @@ 
         if (isset($query_args['action'])) {
             // manually generate wp_nonce and merge that with the query vars
             // becuz the wp_nonce_url function wrecks havoc on some vars
-            $query_args['_wpnonce'] = wp_create_nonce($query_args['action'] . '_nonce');
+            $query_args['_wpnonce'] = wp_create_nonce($query_args['action'].'_nonce');
         }
         // we're adding some hooks and filters in here for processing any things just before redirects
         // (example: an admin page has done an insert or update and we want to run something after that).
-        do_action('AHEE_redirect_' . $classname . $this->_req_action, $query_args);
+        do_action('AHEE_redirect_'.$classname.$this->_req_action, $query_args);
         $redirect_url = apply_filters(
-            'FHEE_redirect_' . $classname . $this->_req_action,
+            'FHEE_redirect_'.$classname.$this->_req_action,
             self::add_query_args_and_nonce($query_args, $redirect_url),
             $query_args
         );
         // check if we're doing ajax.  If we are then lets just return the results and js can handle how it wants.
         if ($this->request->isAjax()) {
-            $default_data                    = [
+            $default_data = [
                 'close'        => true,
                 'redirect_url' => $redirect_url,
                 'where'        => 'main',
@@ -3669,7 +3669,7 @@ 
         }
         $this->_template_args['notices'] = EE_Error::get_notices();
         // IF this isn't ajax we need to create a transient for the notices using the route (however, overridden if $sticky_notices == true)
-        if (! $this->request->isAjax() || $sticky_notices) {
+        if ( ! $this->request->isAjax() || $sticky_notices) {
             $route = isset($query_args['action']) ? $query_args['action'] : 'default';
             $this->_add_transient(
                 $route,
@@ -3709,7 +3709,7 @@ 
         $exclude_nonce = false
     ) {
         // first let's validate the action (if $base_url is FALSE otherwise validation will happen further along)
-        if (empty($base_url) && ! isset($this->_page_routes[ $action ])) {
+        if (empty($base_url) && ! isset($this->_page_routes[$action])) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -3720,7 +3720,7 @@ 
                 )
             );
         }
-        if (! isset($this->_labels['buttons'][ $type ])) {
+        if ( ! isset($this->_labels['buttons'][$type])) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -3733,7 +3733,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;
@@ -3741,11 +3741,11 @@ 
             'action' => $action,
         ];
         // merge extra_request args but make sure our original action takes precedence and doesn't get overwritten.
-        if (! empty($extra_request)) {
+        if ( ! empty($extra_request)) {
             $query_args = array_merge($extra_request, $query_args);
         }
         $url = self::add_query_args_and_nonce($query_args, $_base_url, false, $exclude_nonce);
-        return EEH_Template::get_button_or_link($url, $this->_labels['buttons'][ $type ], $class);
+        return EEH_Template::get_button_or_link($url, $this->_labels['buttons'][$type], $class);
     }
 
 
@@ -3771,7 +3771,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)) {
@@ -3792,18 +3792,18 @@ 
     {
         if ($this->request->requestParamIsSet('wp_screen_options')) {
             check_admin_referer('screen-options-nonce', 'screenoptionnonce');
-            if (! $user = wp_get_current_user()) {
+            if ( ! $user = wp_get_current_user()) {
                 return;
             }
             $option = $this->request->getRequestParam('wp_screen_options[option]', '', 'key');
-            if (! $option) {
+            if ( ! $option) {
                 return;
             }
-            $value  = $this->request->getRequestParam('wp_screen_options[value]', 0, 'int');
+            $value = $this->request->getRequestParam('wp_screen_options[value]', 0, 'int');
             $map_option = $option;
             $option     = str_replace('-', '_', $option);
             switch ($map_option) {
-                case $this->_current_page . '_' . $this->_current_view . '_per_page':
+                case $this->_current_page.'_'.$this->_current_view.'_per_page':
                     $max_value = apply_filters(
                         'FHEE__EE_Admin_Page___set_per_page_screen_options__max_value',
                         999,
@@ -3860,13 +3860,13 @@ 
     protected function _add_transient($route, $data, $notices = false, $skip_route_verify = false)
     {
         $user_id = get_current_user_id();
-        if (! $skip_route_verify) {
+        if ( ! $skip_route_verify) {
             $this->_verify_route($route);
         }
         // now let's set the string for what kind of transient we're setting
         $transient = $notices
-            ? 'ee_rte_n_tx_' . $route . '_' . $user_id
-            : 'rte_tx_' . $route . '_' . $user_id;
+            ? 'ee_rte_n_tx_'.$route.'_'.$user_id
+            : 'rte_tx_'.$route.'_'.$user_id;
         $data      = $notices ? ['notices' => $data] : $data;
         // is there already a transient for this route?  If there is then let's ADD to that transient
         $existing = is_multisite() && is_network_admin()
@@ -3895,8 +3895,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);
@@ -4127,7 +4127,7 @@ 
      */
     protected function _next_link($url, $class = 'dashicons dashicons-arrow-right')
     {
-        return '<a class="' . $class . '" href="' . $url . '"></a>';
+        return '<a class="'.$class.'" href="'.$url.'"></a>';
     }
 
 
@@ -4140,7 +4140,7 @@ 
      */
     protected function _previous_link($url, $class = 'dashicons dashicons-arrow-left')
     {
-        return '<a class="' . $class . '" href="' . $url . '"></a>';
+        return '<a class="'.$class.'" href="'.$url.'"></a>';
     }
 
 

core/services/request/sanitizers/RequestSanitizer.php

Indentation +57 added lines, -57 removed lines

@@ -4,63 +4,63 @@
 
 class RequestSanitizer
 {
-    /**
-     * Will sanitize the supplied request parameter based on the specified data type
-     *
-     * @param mixed  $param     the supplied request parameter
-     * @param string $type      the specified data type (default: "string")
-     *                          valid values: "bool", "float", "int", "key", "url", or "string"
-     * @param bool   $is_array  if true, then $param will be treated as an array of $type
-     * @param string $delimiter if $param is a CSV like value (ex: 1,2,3,4,5...) then this is the value separator
-     * @return array|bool|float|int|string
-     * @since 4.10.14.p
-     */
-    public function clean($param, $type = 'string', $is_array = false, $delimiter = '')
-    {
-        if ($delimiter !== '' && is_string($param)) {
-            $param = explode($delimiter, $param);
-            // unset the delimiter else this function will recurse forever when we loop over the array of results
-            $delimiter = '';
-        }
-        // check if we are getting an improperly typed array and correct
-        $is_array = $is_array || is_array($param);
-        if ($is_array) {
-            $values = [];
-            foreach ((array) $param as $key => $value) {
-                $values[ $key ] = $this->clean($value, $type, is_array($value), $delimiter);
-            }
-            return $values;
-        }
-        return $this->sanitizeParam($param, $type);
-    }
+	/**
+	 * Will sanitize the supplied request parameter based on the specified data type
+	 *
+	 * @param mixed  $param     the supplied request parameter
+	 * @param string $type      the specified data type (default: "string")
+	 *                          valid values: "bool", "float", "int", "key", "url", or "string"
+	 * @param bool   $is_array  if true, then $param will be treated as an array of $type
+	 * @param string $delimiter if $param is a CSV like value (ex: 1,2,3,4,5...) then this is the value separator
+	 * @return array|bool|float|int|string
+	 * @since 4.10.14.p
+	 */
+	public function clean($param, $type = 'string', $is_array = false, $delimiter = '')
+	{
+		if ($delimiter !== '' && is_string($param)) {
+			$param = explode($delimiter, $param);
+			// unset the delimiter else this function will recurse forever when we loop over the array of results
+			$delimiter = '';
+		}
+		// check if we are getting an improperly typed array and correct
+		$is_array = $is_array || is_array($param);
+		if ($is_array) {
+			$values = [];
+			foreach ((array) $param as $key => $value) {
+				$values[ $key ] = $this->clean($value, $type, is_array($value), $delimiter);
+			}
+			return $values;
+		}
+		return $this->sanitizeParam($param, $type);
+	}
 
 
-    /**
-     * @param mixed  $param
-     * @param string $type
-     * @return array|float|int|mixed|string|string[]|null
-     * @since   4.10.20.p
-     */
-    public function sanitizeParam($param, $type = 'string')
-    {
-        switch ($type) {
-            case 'bool':
-                return filter_var($param, FILTER_VALIDATE_BOOLEAN);
-            case 'float':
-                return (float) $param;
-            case 'fqcn':
-                return preg_replace('[^\\\w\d]', '', $param);
-            case 'int':
-                return (int) $param;
-            case 'key':
-                return sanitize_key($param);
-            case 'title':
-                return sanitize_title($param);
-            case 'url':
-                return esc_url_raw($param);
-            case 'string':
-            default:
-                return sanitize_text_field($param);
-        }
-    }
+	/**
+	 * @param mixed  $param
+	 * @param string $type
+	 * @return array|float|int|mixed|string|string[]|null
+	 * @since   4.10.20.p
+	 */
+	public function sanitizeParam($param, $type = 'string')
+	{
+		switch ($type) {
+			case 'bool':
+				return filter_var($param, FILTER_VALIDATE_BOOLEAN);
+			case 'float':
+				return (float) $param;
+			case 'fqcn':
+				return preg_replace('[^\\\w\d]', '', $param);
+			case 'int':
+				return (int) $param;
+			case 'key':
+				return sanitize_key($param);
+			case 'title':
+				return sanitize_title($param);
+			case 'url':
+				return esc_url_raw($param);
+			case 'string':
+			default:
+				return sanitize_text_field($param);
+		}
+	}
 }

caffeinated/admin/extend/messages/espresso_events_Messages_Hooks_Extend.class.php

Indentation +272 added lines, -272 removed lines

@@ -15,282 +15,282 @@
 class espresso_events_Messages_Hooks_Extend extends espresso_events_Messages_Hooks
 {
 
-    /**
-     * @var Messages_Admin_Page
-     */
-    protected $_page_object;
-
-
-    /**
-     * espresso_events_Messages_Hooks_Extend constructor.
-     *
-     * @param EE_Admin_Page $admin_page
-     * @throws EE_Error
-     */
-    public function __construct(EE_Admin_Page $admin_page)
-    {
-        /**
-         * Add cap restriction ... metaboxes should not show if user does not have the ability to edit_custom_messages
-         */
-        if (
-            ! EE_Registry::instance()->CAP->current_user_can(
-                'ee_edit_messages',
-                'messages_events_editor_metabox'
-            )
-        ) {
-            return;
-        }
-        add_filter(
-            'FHEE__Events_Admin_Page___insert_update_cpt_item__event_update_callbacks',
-            [$this, 'caf_updates'],
-            10
-        );
-        add_action(
-            'AHEE__Extend_Events_Admin_Page___duplicate_event__after',
-            [$this, 'duplicate_custom_message_settings'],
-            10,
-            2
-        );
-        parent::__construct($admin_page);
-    }
-
-
-    /**
-     * extending the properties set in espresso_events_Messages_Hooks
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _extend_properties()
-    {
-        define('EE_MSGS_EXTEND_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL . 'messages/assets/');
-        $this->_ajax_func = ['ee_msgs_create_new_custom' => 'create_new_custom'];
-        $this->_metaboxes = [
-            0 => [
-                'page_route' => ['edit', 'create_new'],
-                'func'       => 'messages_metabox',
-                'label'      => esc_html__('Notifications', 'event_espresso'),
-                'priority'   => 'high',
-            ],
-        ];
-
-        // see explanation for layout in EE_Admin_Hooks
-        $this->_scripts_styles = [
-            'registers' => [
-                'events_msg_admin'     => [
-                    'url'     => EE_MSGS_EXTEND_ASSETS_URL . 'events_messages_admin.js',
-                    'depends' => ['ee-dialog', 'ee-parse-uri', 'ee-serialize-full-array'],
-                ],
-                'events_msg_admin_css' => [
-                    'url'  => EE_MSGS_EXTEND_ASSETS_URL . 'ee_msg_events_admin.css',
-                    'type' => 'css',
-                ],
-            ],
-            'enqueues'  => [
-                'events_msg_admin'     => ['edit', 'create_new'],
-                'events_msg_admin_css' => ['edit', 'create_new'],
-            ],
-        ];
-    }
-
-
-    public function caf_updates($update_callbacks)
-    {
-        $update_callbacks[] = [$this, 'attach_evt_message_templates'];
-        return $update_callbacks;
-    }
-
-
-    /**
-     * Handles attaching Message Templates to the Event on save.
-     *
-     * @param EE_Event $event EE event object
-     * @param array    $data  The request data from the form
-     * @return bool success or fail
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function attach_evt_message_templates($event, $data)
-    {
-        // first we remove all existing relations on the Event for message types.
-        $event->_remove_relations('Message_Template_Group');
-        // now let's just loop through the selected templates and add relations!
-        if (isset($data['event_message_templates_relation'])) {
-            foreach ($data['event_message_templates_relation'] as $grp_ID) {
-                $event->_add_relation_to($grp_ID, 'Message_Template_Group');
-            }
-        }
-        // now save
-        return $event->save();
-    }
-
-
-    /**
-     * @param $event
-     * @param $callback_args
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function messages_metabox($event, $callback_args)
-    {
-        // convert 'evt_id' to 'EVT_ID'
-        $EVT_ID = $this->request->getRequestParam('EVT_ID', 0, 'int');
-        $EVT_ID = $this->request->getRequestParam('post', $EVT_ID, 'int');
-        $EVT_ID = $this->request->getRequestParam('evt_id', $EVT_ID, 'int');
-        $this->request->setRequestParam('EVT_ID', $EVT_ID);
-
-        // get the active messengers (b/c messenger objects have the active message templates)
-        /** @type EE_Message_Resource_Manager $message_resource_manager */
-        $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        $active_messengers        = $message_resource_manager->active_messengers();
-        $tabs                     = [];
-
-        // empty messengers?
-        // Note message types will always have at least one available because every messenger has a default message type
-        // associated with it (payment) if no other message types are selected.
-        if (empty($active_messengers)) {
-            $msg_activate_url = EE_Admin_Page::add_query_args_and_nonce(
-                ['action' => 'settings'],
-                EE_MSG_ADMIN_URL
-            );
-            $error_msg        = sprintf(
-                esc_html__(
-                    'There are no active messengers. So no notifications will go out for %1$sany%2$s events.  You will want to %3$sActivate a Messenger%4$s.',
-                    'event_espresso'
-                ),
-                '<strong>',
-                '</strong>',
-                '<a href="' . $msg_activate_url . '">',
-                '</a>'
-            );
-            $error_content    = '<div class="error"><p>' . $error_msg . '</p></div>';
-            $internal_content = '<div id="messages-error"><p>' . $error_msg . '</p></div>';
-
-            echo $error_content;
-            echo $internal_content;
-            return '';
-        }
-
-        // get content for active messengers
-        foreach ($active_messengers as $name => $messenger) {
-            // first check if there are any active message types for this messenger.
-            $active_mts = $message_resource_manager->get_active_message_types_for_messenger($name);
-            if (empty($active_mts)) {
-                continue;
-            }
-
-            $tab_content = $messenger->get_messenger_admin_page_content(
-                'events',
-                'edit',
-                ['event' => $EVT_ID]
-            );
-
-            if (! empty($tab_content)) {
-                $tabs[ $name ] = $tab_content;
-            }
-        }
-
-
-        // we want this to be tabbed content so let's use the EEH_Tabbed_Content::display helper.
-        $tabbed_content = EEH_Tabbed_Content::display($tabs);
-        if ($tabbed_content instanceof WP_Error) {
-            $tabbed_content = $tabbed_content->get_error_message();
-        }
-
-        $notices = '
+	/**
+	 * @var Messages_Admin_Page
+	 */
+	protected $_page_object;
+
+
+	/**
+	 * espresso_events_Messages_Hooks_Extend constructor.
+	 *
+	 * @param EE_Admin_Page $admin_page
+	 * @throws EE_Error
+	 */
+	public function __construct(EE_Admin_Page $admin_page)
+	{
+		/**
+		 * Add cap restriction ... metaboxes should not show if user does not have the ability to edit_custom_messages
+		 */
+		if (
+			! EE_Registry::instance()->CAP->current_user_can(
+				'ee_edit_messages',
+				'messages_events_editor_metabox'
+			)
+		) {
+			return;
+		}
+		add_filter(
+			'FHEE__Events_Admin_Page___insert_update_cpt_item__event_update_callbacks',
+			[$this, 'caf_updates'],
+			10
+		);
+		add_action(
+			'AHEE__Extend_Events_Admin_Page___duplicate_event__after',
+			[$this, 'duplicate_custom_message_settings'],
+			10,
+			2
+		);
+		parent::__construct($admin_page);
+	}
+
+
+	/**
+	 * extending the properties set in espresso_events_Messages_Hooks
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _extend_properties()
+	{
+		define('EE_MSGS_EXTEND_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL . 'messages/assets/');
+		$this->_ajax_func = ['ee_msgs_create_new_custom' => 'create_new_custom'];
+		$this->_metaboxes = [
+			0 => [
+				'page_route' => ['edit', 'create_new'],
+				'func'       => 'messages_metabox',
+				'label'      => esc_html__('Notifications', 'event_espresso'),
+				'priority'   => 'high',
+			],
+		];
+
+		// see explanation for layout in EE_Admin_Hooks
+		$this->_scripts_styles = [
+			'registers' => [
+				'events_msg_admin'     => [
+					'url'     => EE_MSGS_EXTEND_ASSETS_URL . 'events_messages_admin.js',
+					'depends' => ['ee-dialog', 'ee-parse-uri', 'ee-serialize-full-array'],
+				],
+				'events_msg_admin_css' => [
+					'url'  => EE_MSGS_EXTEND_ASSETS_URL . 'ee_msg_events_admin.css',
+					'type' => 'css',
+				],
+			],
+			'enqueues'  => [
+				'events_msg_admin'     => ['edit', 'create_new'],
+				'events_msg_admin_css' => ['edit', 'create_new'],
+			],
+		];
+	}
+
+
+	public function caf_updates($update_callbacks)
+	{
+		$update_callbacks[] = [$this, 'attach_evt_message_templates'];
+		return $update_callbacks;
+	}
+
+
+	/**
+	 * Handles attaching Message Templates to the Event on save.
+	 *
+	 * @param EE_Event $event EE event object
+	 * @param array    $data  The request data from the form
+	 * @return bool success or fail
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function attach_evt_message_templates($event, $data)
+	{
+		// first we remove all existing relations on the Event for message types.
+		$event->_remove_relations('Message_Template_Group');
+		// now let's just loop through the selected templates and add relations!
+		if (isset($data['event_message_templates_relation'])) {
+			foreach ($data['event_message_templates_relation'] as $grp_ID) {
+				$event->_add_relation_to($grp_ID, 'Message_Template_Group');
+			}
+		}
+		// now save
+		return $event->save();
+	}
+
+
+	/**
+	 * @param $event
+	 * @param $callback_args
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function messages_metabox($event, $callback_args)
+	{
+		// convert 'evt_id' to 'EVT_ID'
+		$EVT_ID = $this->request->getRequestParam('EVT_ID', 0, 'int');
+		$EVT_ID = $this->request->getRequestParam('post', $EVT_ID, 'int');
+		$EVT_ID = $this->request->getRequestParam('evt_id', $EVT_ID, 'int');
+		$this->request->setRequestParam('EVT_ID', $EVT_ID);
+
+		// get the active messengers (b/c messenger objects have the active message templates)
+		/** @type EE_Message_Resource_Manager $message_resource_manager */
+		$message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		$active_messengers        = $message_resource_manager->active_messengers();
+		$tabs                     = [];
+
+		// empty messengers?
+		// Note message types will always have at least one available because every messenger has a default message type
+		// associated with it (payment) if no other message types are selected.
+		if (empty($active_messengers)) {
+			$msg_activate_url = EE_Admin_Page::add_query_args_and_nonce(
+				['action' => 'settings'],
+				EE_MSG_ADMIN_URL
+			);
+			$error_msg        = sprintf(
+				esc_html__(
+					'There are no active messengers. So no notifications will go out for %1$sany%2$s events.  You will want to %3$sActivate a Messenger%4$s.',
+					'event_espresso'
+				),
+				'<strong>',
+				'</strong>',
+				'<a href="' . $msg_activate_url . '">',
+				'</a>'
+			);
+			$error_content    = '<div class="error"><p>' . $error_msg . '</p></div>';
+			$internal_content = '<div id="messages-error"><p>' . $error_msg . '</p></div>';
+
+			echo $error_content;
+			echo $internal_content;
+			return '';
+		}
+
+		// get content for active messengers
+		foreach ($active_messengers as $name => $messenger) {
+			// first check if there are any active message types for this messenger.
+			$active_mts = $message_resource_manager->get_active_message_types_for_messenger($name);
+			if (empty($active_mts)) {
+				continue;
+			}
+
+			$tab_content = $messenger->get_messenger_admin_page_content(
+				'events',
+				'edit',
+				['event' => $EVT_ID]
+			);
+
+			if (! empty($tab_content)) {
+				$tabs[ $name ] = $tab_content;
+			}
+		}
+
+
+		// we want this to be tabbed content so let's use the EEH_Tabbed_Content::display helper.
+		$tabbed_content = EEH_Tabbed_Content::display($tabs);
+		if ($tabbed_content instanceof WP_Error) {
+			$tabbed_content = $tabbed_content->get_error_message();
+		}
+
+		$notices = '
 	<div id="espresso-ajax-loading" class="ajax-loader-grey">
 		<span class="ee-spinner ee-spin"></span>
 		<span class="hidden">' . esc_html__('loading...', 'event_espresso') . '</span>
 	</div>
 	<div class="ee-notices"></div>';
 
-        if (defined('DOING_AJAX')) {
-            return $tabbed_content;
-        }
-
-        do_action('AHEE__espresso_events_Messages_Hooks_Extend__messages_metabox__before_content');
-        echo $notices . '<div class="messages-tabs-content">' . $tabbed_content . '</div>';
-        do_action('AHEE__espresso_events_Messages_Hooks_Extend__messages_metabox__after_content');
-        return '';
-    }
-
-
-    /**
-     * Ajax callback for ee_msgs_create_new_custom ajax request.
-     * Takes incoming GRP_ID and name and description values from ajax request
-     * to create a new custom template based off of the incoming GRP_ID.
-     *
-     * @access public
-     * @return void
-     * @throws EE_Error
-     */
-    public function create_new_custom()
-    {
-        if (! EE_Registry::instance()->CAP->current_user_can('ee_edit_messages', 'create_new_custom_ajax')) {
-            wp_die(esc_html__('You don\'t have privileges to do this action', 'event_espresso'));
-        }
-
-        /** @var RequestInterface $request */
-        $request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-
-        // let's clean up the request data a bit for downstream usage of name and description.
-        $templateName = $this->request->getRequestParam('custom_template_args[MTP_name]', '');
-        $request->setRequestParam('templateName', $templateName);
-        $templateDescription = $this->request->getRequestParam('custom_template_args[MTP_description]', '');
-        $request->setRequestParam('templateDescription', $templateDescription);
-
-        // set EE_Admin_Page object (see method details in EE_Admin_Hooks parent
-        $this->_set_page_object();
-
-        // is this a template switch if so EE_Admin_Page child needs this object
-        $this->_page_object->set_hook_object($this);
-
-        $this->_page_object->add_message_template(
-            $this->request->getRequestParam('messageType', ''),
-            $this->request->getRequestParam('messenger', ''),
-            $this->request->getRequestParam('group_ID', 0, 'int')
-        );
-    }
-
-
-    public function create_new_admin_footer()
-    {
-        $this->edit_admin_footer();
-    }
-
-
-    /**
-     * This is the dynamic method for this class
-     * that will end up hooking into the 'admin_footer' hook on the 'edit_event' route in the events page.
-     *
-     * @return void
-     * @throws DomainException
-     */
-    public function edit_admin_footer()
-    {
-        EEH_Template::display_template(
-            EE_CORE_CAF_ADMIN_EXTEND . 'messages/templates/create_custom_template_form.template.php'
-        );
-    }
-
-
-    /**
-     * Callback for AHEE__Extend_Events_Admin_Page___duplicate_event__after hook used to ensure new events duplicate
-     * the assigned custom message templates.
-     *
-     * @param EE_Event $new_event
-     * @param EE_Event $original_event
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function duplicate_custom_message_settings(EE_Event $new_event, EE_Event $original_event)
-    {
-        $message_template_groups = $original_event->get_many_related('Message_Template_Group');
-        foreach ($message_template_groups as $message_template_group) {
-            $new_event->_add_relation_to($message_template_group, 'Message_Template_Group');
-        }
-        // save new event
-        $new_event->save();
-    }
+		if (defined('DOING_AJAX')) {
+			return $tabbed_content;
+		}
+
+		do_action('AHEE__espresso_events_Messages_Hooks_Extend__messages_metabox__before_content');
+		echo $notices . '<div class="messages-tabs-content">' . $tabbed_content . '</div>';
+		do_action('AHEE__espresso_events_Messages_Hooks_Extend__messages_metabox__after_content');
+		return '';
+	}
+
+
+	/**
+	 * Ajax callback for ee_msgs_create_new_custom ajax request.
+	 * Takes incoming GRP_ID and name and description values from ajax request
+	 * to create a new custom template based off of the incoming GRP_ID.
+	 *
+	 * @access public
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function create_new_custom()
+	{
+		if (! EE_Registry::instance()->CAP->current_user_can('ee_edit_messages', 'create_new_custom_ajax')) {
+			wp_die(esc_html__('You don\'t have privileges to do this action', 'event_espresso'));
+		}
+
+		/** @var RequestInterface $request */
+		$request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
+
+		// let's clean up the request data a bit for downstream usage of name and description.
+		$templateName = $this->request->getRequestParam('custom_template_args[MTP_name]', '');
+		$request->setRequestParam('templateName', $templateName);
+		$templateDescription = $this->request->getRequestParam('custom_template_args[MTP_description]', '');
+		$request->setRequestParam('templateDescription', $templateDescription);
+
+		// set EE_Admin_Page object (see method details in EE_Admin_Hooks parent
+		$this->_set_page_object();
+
+		// is this a template switch if so EE_Admin_Page child needs this object
+		$this->_page_object->set_hook_object($this);
+
+		$this->_page_object->add_message_template(
+			$this->request->getRequestParam('messageType', ''),
+			$this->request->getRequestParam('messenger', ''),
+			$this->request->getRequestParam('group_ID', 0, 'int')
+		);
+	}
+
+
+	public function create_new_admin_footer()
+	{
+		$this->edit_admin_footer();
+	}
+
+
+	/**
+	 * This is the dynamic method for this class
+	 * that will end up hooking into the 'admin_footer' hook on the 'edit_event' route in the events page.
+	 *
+	 * @return void
+	 * @throws DomainException
+	 */
+	public function edit_admin_footer()
+	{
+		EEH_Template::display_template(
+			EE_CORE_CAF_ADMIN_EXTEND . 'messages/templates/create_custom_template_form.template.php'
+		);
+	}
+
+
+	/**
+	 * Callback for AHEE__Extend_Events_Admin_Page___duplicate_event__after hook used to ensure new events duplicate
+	 * the assigned custom message templates.
+	 *
+	 * @param EE_Event $new_event
+	 * @param EE_Event $original_event
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function duplicate_custom_message_settings(EE_Event $new_event, EE_Event $original_event)
+	{
+		$message_template_groups = $original_event->get_many_related('Message_Template_Group');
+		foreach ($message_template_groups as $message_template_group) {
+			$new_event->_add_relation_to($message_template_group, 'Message_Template_Group');
+		}
+		// save new event
+		$new_event->save();
+	}
 }

Spacing +13 added lines, -13 removed lines

@@ -63,7 +63,7 @@ 
      */
     protected function _extend_properties()
     {
-        define('EE_MSGS_EXTEND_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL . 'messages/assets/');
+        define('EE_MSGS_EXTEND_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL.'messages/assets/');
         $this->_ajax_func = ['ee_msgs_create_new_custom' => 'create_new_custom'];
         $this->_metaboxes = [
             0 => [
@@ -78,11 +78,11 @@ 
         $this->_scripts_styles = [
             'registers' => [
                 'events_msg_admin'     => [
-                    'url'     => EE_MSGS_EXTEND_ASSETS_URL . 'events_messages_admin.js',
+                    'url'     => EE_MSGS_EXTEND_ASSETS_URL.'events_messages_admin.js',
                     'depends' => ['ee-dialog', 'ee-parse-uri', 'ee-serialize-full-array'],
                 ],
                 'events_msg_admin_css' => [
-                    'url'  => EE_MSGS_EXTEND_ASSETS_URL . 'ee_msg_events_admin.css',
+                    'url'  => EE_MSGS_EXTEND_ASSETS_URL.'ee_msg_events_admin.css',
                     'type' => 'css',
                 ],
             ],
@@ -154,18 +154,18 @@ 
                 ['action' => 'settings'],
                 EE_MSG_ADMIN_URL
             );
-            $error_msg        = sprintf(
+            $error_msg = sprintf(
                 esc_html__(
                     'There are no active messengers. So no notifications will go out for %1$sany%2$s events.  You will want to %3$sActivate a Messenger%4$s.',
                     'event_espresso'
                 ),
                 '<strong>',
                 '</strong>',
-                '<a href="' . $msg_activate_url . '">',
+                '<a href="'.$msg_activate_url.'">',
                 '</a>'
             );
-            $error_content    = '<div class="error"><p>' . $error_msg . '</p></div>';
-            $internal_content = '<div id="messages-error"><p>' . $error_msg . '</p></div>';
+            $error_content    = '<div class="error"><p>'.$error_msg.'</p></div>';
+            $internal_content = '<div id="messages-error"><p>'.$error_msg.'</p></div>';
 
             echo $error_content;
             echo $internal_content;
@@ -186,8 +186,8 @@ 
                 ['event' => $EVT_ID]
             );
 
-            if (! empty($tab_content)) {
-                $tabs[ $name ] = $tab_content;
+            if ( ! empty($tab_content)) {
+                $tabs[$name] = $tab_content;
             }
         }
 
@@ -201,7 +201,7 @@ 
         $notices = '
 	<div id="espresso-ajax-loading" class="ajax-loader-grey">
 		<span class="ee-spinner ee-spin"></span>
-		<span class="hidden">' . esc_html__('loading...', 'event_espresso') . '</span>
+		<span class="hidden">' . esc_html__('loading...', 'event_espresso').'</span>
 	</div>
 	<div class="ee-notices"></div>';
 
@@ -210,7 +210,7 @@ 
         }
 
         do_action('AHEE__espresso_events_Messages_Hooks_Extend__messages_metabox__before_content');
-        echo $notices . '<div class="messages-tabs-content">' . $tabbed_content . '</div>';
+        echo $notices.'<div class="messages-tabs-content">'.$tabbed_content.'</div>';
         do_action('AHEE__espresso_events_Messages_Hooks_Extend__messages_metabox__after_content');
         return '';
     }
@@ -227,7 +227,7 @@ 
      */
     public function create_new_custom()
     {
-        if (! EE_Registry::instance()->CAP->current_user_can('ee_edit_messages', 'create_new_custom_ajax')) {
+        if ( ! EE_Registry::instance()->CAP->current_user_can('ee_edit_messages', 'create_new_custom_ajax')) {
             wp_die(esc_html__('You don\'t have privileges to do this action', 'event_espresso'));
         }
 
@@ -270,7 +270,7 @@ 
     public function edit_admin_footer()
     {
         EEH_Template::display_template(
-            EE_CORE_CAF_ADMIN_EXTEND . 'messages/templates/create_custom_template_form.template.php'
+            EE_CORE_CAF_ADMIN_EXTEND.'messages/templates/create_custom_template_form.template.php'
         );
     }
 

admin_pages/messages/Messages_Admin_Page.core.php

Indentation +4473 added lines, -4473 removed lines

@@ -17,2642 +17,2642 @@ 
 class Messages_Admin_Page extends EE_Admin_Page
 {
 
-    /**
-     * @var EE_Message_Resource_Manager $_message_resource_manager
-     */
-    protected $_message_resource_manager;
-
-    /**
-     * @var string
-     */
-    protected $_active_message_type_name = '';
-
-    /**
-     * @var string
-     */
-    protected $_active_messenger_name = '';
-
-    /**
-     * @var EE_messenger $_active_messenger
-     */
-    protected $_active_messenger;
-
-    protected $_activate_meta_box_type;
-
-    protected $_current_message_meta_box;
-
-    protected $_current_message_meta_box_object;
-
-    protected $_context_switcher;
-
-    protected $_shortcodes           = [];
-
-    protected $_active_messengers    = [];
-
-    protected $_active_message_types = [];
-
-    /**
-     * @var EE_Message_Template_Group $_message_template_group
-     */
-    protected $_message_template_group;
-
-    protected $_m_mt_settings = [];
-
-
-    /**
-     * This is set via the _set_message_template_group method and holds whatever the template pack for the group is.
-     * IF there is no group then it gets automatically set to the Default template pack.
-     *
-     * @since 4.5.0
-     *
-     * @var EE_Messages_Template_Pack
-     */
-    protected $_template_pack;
-
-
-    /**
-     * This is set via the _set_message_template_group method and holds whatever the template pack variation for the
-     * group is.  If there is no group then it automatically gets set to default.
-     *
-     * @since 4.5.0
-     *
-     * @var string
-     */
-    protected $_variation;
-
-
-    /**
-     * @param bool $routing
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function __construct($routing = true)
-    {
-        // make sure messages autoloader is running
-        EED_Messages::set_autoloaders();
-        parent::__construct($routing);
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _init_page_props()
-    {
-        $this->page_slug        = EE_MSG_PG_SLUG;
-        $this->page_label       = esc_html__('Messages Settings', 'event_espresso');
-        $this->_admin_base_url  = EE_MSG_ADMIN_URL;
-        $this->_admin_base_path = EE_MSG_ADMIN;
-
-        $this->_active_messenger_name    = $this->request->getRequestParam('messenger', '');
-        $this->_active_message_type_name = $this->request->getRequestParam('message_type', '');
-
-        $this->_load_message_resource_manager();
-    }
-
-
-    /**
-     * loads messenger objects into the $_active_messengers property (so we can access the needed methods)
-     *
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     */
-    protected function _load_message_resource_manager()
-    {
-        $this->_message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-    }
-
-
-    /**
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @deprecated 4.9.9.rc.014
-     */
-    public function get_messengers_for_list_table()
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            sprintf(
-                esc_html__(
-                    'This method is no longer in use.  There is no replacement for it. The method was used to generate a set of values for use in creating a messenger filter dropdown which is now generated differently via %s',
-                    'event_espresso'
-                ),
-                'Messages_Admin_Page::get_messengers_select_input()'
-            ),
-            '4.9.9.rc.014'
-        );
-
-        $m_values          = [];
-        $active_messengers = EEM_Message::instance()->get_all(['group_by' => 'MSG_messenger']);
-        // setup messengers for selects
-        $i = 1;
-        foreach ($active_messengers as $active_messenger) {
-            if ($active_messenger instanceof EE_Message) {
-                $m_values[ $i ]['id']   = $active_messenger->messenger();
-                $m_values[ $i ]['text'] = ucwords($active_messenger->messenger_label());
-                $i++;
-            }
-        }
-
-        return $m_values;
-    }
-
-
-    /**
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @deprecated 4.9.9.rc.014
-     */
-    public function get_message_types_for_list_table()
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            sprintf(
-                esc_html__(
-                    'This method is no longer in use.  There is no replacement for it. The method was used to generate a set of values for use in creating a message type filter dropdown which is now generated differently via %s',
-                    'event_espresso'
-                ),
-                'Messages_Admin_Page::get_message_types_select_input()'
-            ),
-            '4.9.9.rc.014'
-        );
-
-        $mt_values       = [];
-        $active_messages = EEM_Message::instance()->get_all(['group_by' => 'MSG_message_type']);
-        $i               = 1;
-        foreach ($active_messages as $active_message) {
-            if ($active_message instanceof EE_Message) {
-                $mt_values[ $i ]['id']   = $active_message->message_type();
-                $mt_values[ $i ]['text'] = ucwords($active_message->message_type_label());
-                $i++;
-            }
-        }
-
-        return $mt_values;
-    }
-
-
-    /**
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @deprecated 4.9.9.rc.014
-     */
-    public function get_contexts_for_message_types_for_list_table()
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            sprintf(
-                esc_html__(
-                    'This method is no longer in use.  There is no replacement for it. The method was used to generate a set of values for use in creating a message type context filter dropdown which is now generated differently via %s',
-                    'event_espresso'
-                ),
-                'Messages_Admin_Page::get_contexts_for_message_types_select_input()'
-            ),
-            '4.9.9.rc.014'
-        );
-
-        $contexts                = [];
-        $active_message_contexts = EEM_Message::instance()->get_all(['group_by' => 'MSG_context']);
-        foreach ($active_message_contexts as $active_message) {
-            if ($active_message instanceof EE_Message) {
-                $message_type = $active_message->message_type_object();
-                if ($message_type instanceof EE_message_type) {
-                    $message_type_contexts = $message_type->get_contexts();
-                    foreach ($message_type_contexts as $context => $context_details) {
-                        $contexts[ $context ] = $context_details['label'];
-                    }
-                }
-            }
-        }
-
-        return $contexts;
-    }
-
-
-    /**
-     * Generate select input with provided messenger options array.
-     *
-     * @param array $messenger_options Array of messengers indexed by messenger slug and values are the messenger
-     *                                 labels.
-     * @return string
-     * @throws EE_Error
-     */
-    public function get_messengers_select_input($messenger_options)
-    {
-        // if empty or just one value then just return an empty string
-        if (
-            empty($messenger_options)
-            || ! is_array($messenger_options)
-            || count($messenger_options) === 1
-        ) {
-            return '';
-        }
-        // merge in default
-        $messenger_options = array_merge(
-            ['none_selected' => esc_html__('Show All Messengers', 'event_espresso')],
-            $messenger_options
-        );
-        $input             = new EE_Select_Input(
-            $messenger_options,
-            [
-                'html_name'  => 'ee_messenger_filter_by',
-                'html_id'    => 'ee_messenger_filter_by',
-                'html_class' => 'wide',
-                'default'    => $this->request->getRequestParam('ee_messenger_filter_by', 'none_selected', 'title'),
-            ]
-        );
-
-        return $input->get_html_for_input();
-    }
-
-
-    /**
-     * Generate select input with provided message type options array.
-     *
-     * @param array $message_type_options Array of message types indexed by message type slug, and values are the
-     *                                    message type labels
-     * @return string
-     * @throws EE_Error
-     */
-    public function get_message_types_select_input($message_type_options)
-    {
-        // if empty or count of options is 1 then just return an empty string
-        if (
-            empty($message_type_options)
-            || ! is_array($message_type_options)
-            || count($message_type_options) === 1
-        ) {
-            return '';
-        }
-        // merge in default
-        $message_type_options = array_merge(
-            ['none_selected' => esc_html__('Show All Message Types', 'event_espresso')],
-            $message_type_options
-        );
-        $input                = new EE_Select_Input(
-            $message_type_options,
-            [
-                'html_name'  => 'ee_message_type_filter_by',
-                'html_id'    => 'ee_message_type_filter_by',
-                'html_class' => 'wide',
-                'default'    => $this->request->getRequestParam('ee_message_type_filter_by', 'none_selected', 'title'),
-            ]
-        );
-
-        return $input->get_html_for_input();
-    }
-
-
-    /**
-     * Generate select input with provide message type contexts array.
-     *
-     * @param array $context_options Array of message type contexts indexed by context slug, and values are the
-     *                               context label.
-     * @return string
-     * @throws EE_Error
-     */
-    public function get_contexts_for_message_types_select_input($context_options)
-    {
-        // if empty or count of options is one then just return empty string
-        if (
-            empty($context_options)
-            || ! is_array($context_options)
-            || count($context_options) === 1
-        ) {
-            return '';
-        }
-        // merge in default
-        $context_options = array_merge(
-            ['none_selected' => esc_html__('Show all Contexts', 'event_espresso')],
-            $context_options
-        );
-        $input           = new EE_Select_Input(
-            $context_options,
-            [
-                'html_name'  => 'ee_context_filter_by',
-                'html_id'    => 'ee_context_filter_by',
-                'html_class' => 'wide',
-                'default'    => $this->request->getRequestParam('ee_context_filter_by', 'none_selected', 'title'),
-            ]
-        );
-
-        return $input->get_html_for_input();
-    }
-
-
-    protected function _ajax_hooks()
-    {
-        add_action('wp_ajax_activate_messenger', [$this, 'activate_messenger_toggle']);
-        add_action('wp_ajax_activate_mt', [$this, 'activate_mt_toggle']);
-        add_action('wp_ajax_ee_msgs_save_settings', [$this, 'save_settings']);
-        add_action('wp_ajax_ee_msgs_update_mt_form', [$this, 'update_mt_form']);
-        add_action('wp_ajax_switch_template_pack', [$this, 'switch_template_pack']);
-        add_action('wp_ajax_toggle_context_template', [$this, 'toggle_context_template']);
-    }
-
-
-    protected function _define_page_props()
-    {
-        $this->_admin_page_title = $this->page_label;
-        $this->_labels           = [
-            'buttons'    => [
-                'add'    => esc_html__('Add New Message Template', 'event_espresso'),
-                'edit'   => esc_html__('Edit Message Template', 'event_espresso'),
-                'delete' => esc_html__('Delete Message Template', 'event_espresso'),
-            ],
-            'publishbox' => esc_html__('Update Actions', 'event_espresso'),
-        ];
-    }
-
-
-    /**
-     *        an array for storing key => value pairs of request actions and their corresponding methods
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _set_page_routes()
-    {
-        $GRP_ID = $this->request->getRequestParam('GRP_ID', 0, 'int');
-        $GRP_ID = $this->request->getRequestParam('id', $GRP_ID, 'int');
-        $MSG_ID = $this->request->getRequestParam('MSG_ID', 0, 'int');
-
-        $this->_page_routes = [
-            'default'                          => [
-                'func'       => '_message_queue_list_table',
-                'capability' => 'ee_read_global_messages',
-            ],
-            'global_mtps'                      => [
-                'func'       => '_ee_default_messages_overview_list_table',
-                'capability' => 'ee_read_global_messages',
-            ],
-            'custom_mtps'                      => [
-                'func'       => '_custom_mtps_preview',
-                'capability' => 'ee_read_messages',
-            ],
-            'add_new_message_template'         => [
-                'func'       => '_add_message_template',
-                'capability' => 'ee_edit_messages',
-                'noheader'   => true,
-            ],
-            'edit_message_template'            => [
-                'func'       => '_edit_message_template',
-                'capability' => 'ee_edit_message',
-                'obj_id'     => $GRP_ID,
-            ],
-            'preview_message'                  => [
-                'func'               => '_preview_message',
-                'capability'         => 'ee_read_message',
-                'obj_id'             => $GRP_ID,
-                'noheader'           => true,
-                'headers_sent_route' => 'display_preview_message',
-            ],
-            'display_preview_message'          => [
-                'func'       => '_display_preview_message',
-                'capability' => 'ee_read_message',
-                'obj_id'     => $GRP_ID,
-            ],
-            'insert_message_template'          => [
-                'func'       => '_insert_or_update_message_template',
-                'capability' => 'ee_edit_messages',
-                'args'       => ['new' => true],
-                'noheader'   => true,
-            ],
-            'update_message_template'          => [
-                'func'       => '_insert_or_update_message_template',
-                'capability' => 'ee_edit_message',
-                'obj_id'     => $GRP_ID,
-                'args'       => ['new' => false],
-                'noheader'   => true,
-            ],
-            'trash_message_template'           => [
-                'func'       => '_trash_or_restore_message_template',
-                'capability' => 'ee_delete_message',
-                'obj_id'     => $GRP_ID,
-                'args'       => ['trash' => true, 'all' => true],
-                'noheader'   => true,
-            ],
-            'trash_message_template_context'   => [
-                'func'       => '_trash_or_restore_message_template',
-                'capability' => 'ee_delete_message',
-                'obj_id'     => $GRP_ID,
-                'args'       => ['trash' => true],
-                'noheader'   => true,
-            ],
-            'restore_message_template'         => [
-                'func'       => '_trash_or_restore_message_template',
-                'capability' => 'ee_delete_message',
-                'obj_id'     => $GRP_ID,
-                'args'       => ['trash' => false, 'all' => true],
-                'noheader'   => true,
-            ],
-            'restore_message_template_context' => [
-                'func'       => '_trash_or_restore_message_template',
-                'capability' => 'ee_delete_message',
-                'obj_id'     => $GRP_ID,
-                'args'       => ['trash' => false],
-                'noheader'   => true,
-            ],
-            'delete_message_template'          => [
-                'func'       => '_delete_message_template',
-                'capability' => 'ee_delete_message',
-                'obj_id'     => $GRP_ID,
-                'noheader'   => true,
-            ],
-            'reset_to_default'                 => [
-                'func'       => '_reset_to_default_template',
-                'capability' => 'ee_edit_message',
-                'obj_id'     => $GRP_ID,
-                'noheader'   => true,
-            ],
-            'settings'                         => [
-                'func'       => '_settings',
-                'capability' => 'manage_options',
-            ],
-            'update_global_settings'           => [
-                'func'       => '_update_global_settings',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-            ],
-            'generate_now'                     => [
-                'func'       => '_generate_now',
-                'capability' => 'ee_send_message',
-                'noheader'   => true,
-            ],
-            'generate_and_send_now'            => [
-                'func'       => '_generate_and_send_now',
-                'capability' => 'ee_send_message',
-                'noheader'   => true,
-            ],
-            'queue_for_resending'              => [
-                'func'       => '_queue_for_resending',
-                'capability' => 'ee_send_message',
-                'noheader'   => true,
-            ],
-            'send_now'                         => [
-                'func'       => '_send_now',
-                'capability' => 'ee_send_message',
-                'noheader'   => true,
-            ],
-            'delete_ee_message'                => [
-                'func'       => '_delete_ee_messages',
-                'capability' => 'ee_delete_messages',
-                'noheader'   => true,
-            ],
-            'delete_ee_messages'               => [
-                'func'       => '_delete_ee_messages',
-                'capability' => 'ee_delete_messages',
-                'noheader'   => true,
-                'obj_id'     => $MSG_ID,
-            ],
-        ];
-    }
-
-
-    protected function _set_page_config()
-    {
-        $this->_page_config = [
-            'default'                  => [
-                'nav'           => [
-                    'label' => esc_html__('Message Activity', 'event_espresso'),
-                    'order' => 10,
-                ],
-                'list_table'    => 'EE_Message_List_Table',
-                // 'qtips' => array( 'EE_Message_List_Table_Tips' ),
-                'require_nonce' => false,
-            ],
-            'global_mtps'              => [
-                'nav'           => [
-                    'label' => esc_html__('Default Message Templates', 'event_espresso'),
-                    'order' => 20,
-                ],
-                'list_table'    => 'Messages_Template_List_Table',
-                'help_tabs'     => [
-                    'messages_overview_help_tab'                                => [
-                        'title'    => esc_html__('Messages Overview', 'event_espresso'),
-                        'filename' => 'messages_overview',
-                    ],
-                    'messages_overview_messages_table_column_headings_help_tab' => [
-                        'title'    => esc_html__('Messages Table Column Headings', 'event_espresso'),
-                        'filename' => 'messages_overview_table_column_headings',
-                    ],
-                    'messages_overview_messages_filters_help_tab'               => [
-                        'title'    => esc_html__('Message Filters', 'event_espresso'),
-                        'filename' => 'messages_overview_filters',
-                    ],
-                    'messages_overview_messages_views_help_tab'                 => [
-                        'title'    => esc_html__('Message Views', 'event_espresso'),
-                        'filename' => 'messages_overview_views',
-                    ],
-                    'message_overview_message_types_help_tab'                   => [
-                        'title'    => esc_html__('Message Types', 'event_espresso'),
-                        'filename' => 'messages_overview_types',
-                    ],
-                    'messages_overview_messengers_help_tab'                     => [
-                        'title'    => esc_html__('Messengers', 'event_espresso'),
-                        'filename' => 'messages_overview_messengers',
-                    ],
-                ],
-                // disabled temporarily. see: https://github.com/eventespresso/eventsmart.com-website/issues/836
-                // 'help_tour'     => array('Messages_Overview_Help_Tour'),
-                'require_nonce' => false,
-            ],
-            'custom_mtps'              => [
-                'nav'           => [
-                    'label' => esc_html__('Custom Message Templates', 'event_espresso'),
-                    'order' => 30,
-                ],
-                'help_tabs'     => [],
-                // disabled temporarily. see: https://github.com/eventespresso/eventsmart.com-website/issues/836
-                // 'help_tour'     => array(),
-                'require_nonce' => false,
-            ],
-            'add_new_message_template' => [
-                'nav'           => [
-                    'label'      => esc_html__('Add New Message Templates', 'event_espresso'),
-                    'order'      => 5,
-                    'persistent' => false,
-                ],
-                'require_nonce' => false,
-            ],
-            'edit_message_template'    => [
-                'labels'        => [
-                    'buttons'    => [
-                        'reset' => esc_html__('Reset Templates', 'event_espresso'),
-                    ],
-                    'publishbox' => esc_html__('Update Actions', 'event_espresso'),
-                ],
-                'nav'           => [
-                    'label'      => esc_html__('Edit Message Templates', 'event_espresso'),
-                    'order'      => 5,
-                    'persistent' => false,
-                    'url'        => '',
-                ],
-                'metaboxes'     => ['_publish_post_box', '_register_edit_meta_boxes'],
-                'has_metaboxes' => true,
-                // disabled temporarily. see: https://github.com/eventespresso/eventsmart.com-website/issues/836
-                // 'help_tour'     => array('Message_Templates_Edit_Help_Tour'),
-                'help_tabs'     => [
-                    'edit_message_template'            => [
-                        'title'    => esc_html__('Message Template Editor', 'event_espresso'),
-                        'callback' => 'edit_message_template_help_tab',
-                    ],
-                    'message_templates_help_tab'       => [
-                        'title'    => esc_html__('Message Templates', 'event_espresso'),
-                        'filename' => 'messages_templates',
-                    ],
-                    'message_template_shortcodes'      => [
-                        'title'    => esc_html__('Message Shortcodes', 'event_espresso'),
-                        'callback' => 'message_template_shortcodes_help_tab',
-                    ],
-                    'message_preview_help_tab'         => [
-                        'title'    => esc_html__('Message Preview', 'event_espresso'),
-                        'filename' => 'messages_preview',
-                    ],
-                    'messages_overview_other_help_tab' => [
-                        'title'    => esc_html__('Messages Other', 'event_espresso'),
-                        'filename' => 'messages_overview_other',
-                    ],
-                ],
-                'require_nonce' => false,
-            ],
-            'display_preview_message'  => [
-                'nav'           => [
-                    'label'      => esc_html__('Message Preview', 'event_espresso'),
-                    'order'      => 5,
-                    'url'        => '',
-                    'persistent' => false,
-                ],
-                'help_tabs'     => [
-                    'preview_message' => [
-                        'title'    => esc_html__('About Previews', 'event_espresso'),
-                        'callback' => 'preview_message_help_tab',
-                    ],
-                ],
-                'require_nonce' => false,
-            ],
-            'settings'                 => [
-                'nav'           => [
-                    'label' => esc_html__('Settings', 'event_espresso'),
-                    'order' => 40,
-                ],
-                'metaboxes'     => ['_messages_settings_metaboxes'],
-                'help_tabs'     => [
-                    'messages_settings_help_tab'               => [
-                        'title'    => esc_html__('Messages Settings', 'event_espresso'),
-                        'filename' => 'messages_settings',
-                    ],
-                    'messages_settings_message_types_help_tab' => [
-                        'title'    => esc_html__('Activating / Deactivating Message Types', 'event_espresso'),
-                        'filename' => 'messages_settings_message_types',
-                    ],
-                    'messages_settings_messengers_help_tab'    => [
-                        'title'    => esc_html__('Activating / Deactivating Messengers', 'event_espresso'),
-                        'filename' => 'messages_settings_messengers',
-                    ],
-                ],
-                // disabled temporarily. see: https://github.com/eventespresso/eventsmart.com-website/issues/836
-                // 'help_tour'     => array('Messages_Settings_Help_Tour'),
-                'require_nonce' => false,
-            ],
-        ];
-    }
-
-
-    protected function _add_screen_options()
-    {
-        // todo
-    }
-
-
-    protected function _add_screen_options_global_mtps()
-    {
-        /**
-         * Note: the reason for the value swap here on $this->_admin_page_title is because $this->_per_page_screen_options
-         * uses the $_admin_page_title property and we want different outputs in the different spots.
-         */
-        $page_title              = $this->_admin_page_title;
-        $this->_admin_page_title = esc_html__('Global Message Templates', 'event_espresso');
-        $this->_per_page_screen_option();
-        $this->_admin_page_title = $page_title;
-    }
-
-
-    protected function _add_screen_options_default()
-    {
-        $this->_admin_page_title = esc_html__('Message Activity', 'event_espresso');
-        $this->_per_page_screen_option();
-    }
-
-
-    // none of the below group are currently used for Messages
-    protected function _add_feature_pointers()
-    {
-    }
-
-
-    public function admin_init()
-    {
-    }
-
-
-    public function admin_notices()
-    {
-    }
-
-
-    public function admin_footer_scripts()
-    {
-    }
-
-
-    public function messages_help_tab()
-    {
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_messages_help_tab.template.php');
-    }
-
-
-    public function messengers_help_tab()
-    {
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_messenger_help_tab.template.php');
-    }
-
-
-    public function message_types_help_tab()
-    {
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_message_type_help_tab.template.php');
-    }
-
-
-    public function messages_overview_help_tab()
-    {
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_overview_help_tab.template.php');
-    }
-
-
-    public function message_templates_help_tab()
-    {
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_message_templates_help_tab.template.php');
-    }
-
-
-    public function edit_message_template_help_tab()
-    {
-        $args['img1'] = '<img src="' . EE_MSG_ASSETS_URL . 'images/editor.png' . '" alt="'
-                        . esc_attr__('Editor Title', 'event_espresso')
-                        . '" />';
-        $args['img2'] = '<img src="' . EE_MSG_ASSETS_URL . 'images/switch-context.png' . '" alt="'
-                        . esc_attr__('Context Switcher and Preview', 'event_espresso')
-                        . '" />';
-        $args['img3'] = '<img class="left" src="' . EE_MSG_ASSETS_URL . 'images/form-fields.png' . '" alt="'
-                        . esc_attr__('Message Template Form Fields', 'event_espresso')
-                        . '" />';
-        $args['img4'] = '<img class="right" src="' . EE_MSG_ASSETS_URL . 'images/shortcodes-metabox.png' . '" alt="'
-                        . esc_attr__('Shortcodes Metabox', 'event_espresso')
-                        . '" />';
-        $args['img5'] = '<img class="right" src="' . EE_MSG_ASSETS_URL . 'images/publish-meta-box.png' . '" alt="'
-                        . esc_attr__('Publish Metabox', 'event_espresso')
-                        . '" />';
-        EEH_Template::display_template(
-            EE_MSG_TEMPLATE_PATH . 'ee_msg_messages_templates_editor_help_tab.template.php',
-            $args
-        );
-    }
-
-
-    /**
-     * @throws ReflectionException
-     * @throws EE_Error
-     */
-    public function message_template_shortcodes_help_tab()
-    {
-        $this->_set_shortcodes();
-        $args['shortcodes'] = $this->_shortcodes;
-        EEH_Template::display_template(
-            EE_MSG_TEMPLATE_PATH . 'ee_msg_messages_shortcodes_help_tab.template.php',
-            $args
-        );
-    }
-
-
-    public function preview_message_help_tab()
-    {
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_preview_help_tab.template.php');
-    }
-
-
-    public function settings_help_tab()
-    {
-        $args['img1'] = '<img class="inline-text" src="' . EE_MSG_ASSETS_URL . 'images/email-tab-active.png'
-                        . '" alt="' . esc_attr__('Active Email Tab', 'event_espresso') . '" />';
-        $args['img2'] = '<img class="inline-text" src="' . EE_MSG_ASSETS_URL . 'images/email-tab-inactive.png'
-                        . '" alt="' . esc_attr__('Inactive Email Tab', 'event_espresso') . '" />';
-        $args['img3'] = '<div class="switch">'
-                        . '<input class="ee-on-off-toggle ee-toggle-round-flat"'
-                        . ' type="checkbox" checked="checked">'
-                        . '<label for="ee-on-off-toggle-on"></label>'
-                        . '</div>';
-        $args['img4'] = '<div class="switch">'
-                        . '<input class="ee-on-off-toggle ee-toggle-round-flat"'
-                        . ' type="checkbox">'
-                        . '<label for="ee-on-off-toggle-on"></label>'
-                        . '</div>';
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_messages_settings_help_tab.template.php', $args);
-    }
-
-
-    public function load_scripts_styles()
-    {
-        wp_register_style('espresso_ee_msg', EE_MSG_ASSETS_URL . 'ee_message_admin.css', EVENT_ESPRESSO_VERSION);
-        wp_enqueue_style('espresso_ee_msg');
-
-        wp_register_script(
-            'ee-messages-settings',
-            EE_MSG_ASSETS_URL . 'ee-messages-settings.js',
-            ['jquery-ui-droppable', 'ee-serialize-full-array'],
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_register_script(
-            'ee-msg-list-table-js',
-            EE_MSG_ASSETS_URL . 'ee_message_admin_list_table.js',
-            ['ee-dialog'],
-            EVENT_ESPRESSO_VERSION
-        );
-    }
-
-
-    public function load_scripts_styles_default()
-    {
-        wp_enqueue_script('ee-msg-list-table-js');
-    }
-
-
-    public function wp_editor_css($mce_css)
-    {
-        // if we're on the edit_message_template route
-        if ($this->_req_action === 'edit_message_template' && $this->_active_messenger instanceof EE_messenger) {
-            $message_type_name = $this->_active_message_type_name;
-
-            // we're going to REPLACE the existing mce css
-            // we need to get the css file location from the active messenger
-            $mce_css = $this->_active_messenger->get_variation(
-                $this->_template_pack,
-                $message_type_name,
-                true,
-                'wpeditor',
-                $this->_variation
-            );
-        }
-
-        return $mce_css;
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function load_scripts_styles_edit_message_template()
-    {
-
-        $this->_set_shortcodes();
-
-        EE_Registry::$i18n_js_strings['confirm_default_reset']        = sprintf(
-            esc_html__(
-                'Are you sure you want to reset the %s %s message templates?  Remember continuing will reset the templates for all contexts in this messenger and message type group.',
-                'event_espresso'
-            ),
-            $this->_message_template_group->messenger_obj()->label['singular'],
-            $this->_message_template_group->message_type_obj()->label['singular']
-        );
-        EE_Registry::$i18n_js_strings['confirm_switch_template_pack'] = esc_html__(
-            'Switching the template pack for a messages template will reset the content for the template so the new layout is loaded.  Any custom content in the existing template will be lost. Are you sure you wish to do this?',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['server_error']                 = esc_html__(
-            'An unknown error occurred on the server while attempting to process your request. Please refresh the page and try again or contact support.',
-            'event_espresso'
-        );
-
-        wp_register_script(
-            'ee_msgs_edit_js',
-            EE_MSG_ASSETS_URL . 'ee_message_editor.js',
-            ['jquery'],
-            EVENT_ESPRESSO_VERSION
-        );
-
-        wp_enqueue_script('ee_admin_js');
-        wp_enqueue_script('ee_msgs_edit_js');
-
-        // add in special css for tiny_mce
-        add_filter('mce_css', [$this, 'wp_editor_css']);
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function load_scripts_styles_display_preview_message()
-    {
-        $this->_set_message_template_group();
-        if ($this->_active_messenger_name) {
-            $this->_active_messenger = $this->_message_resource_manager->get_active_messenger(
-                $this->_active_messenger_name
-            );
-        }
-
-        wp_enqueue_style(
-            'espresso_preview_css',
-            $this->_active_messenger->get_variation(
-                $this->_template_pack,
-                $this->_active_message_type_name,
-                true,
-                'preview',
-                $this->_variation
-            )
-        );
-    }
-
-
-    public function load_scripts_styles_settings()
-    {
-        wp_register_style(
-            'ee-message-settings',
-            EE_MSG_ASSETS_URL . 'ee_message_settings.css',
-            [],
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_style('ee-text-links');
-        wp_enqueue_style('ee-message-settings');
-        wp_enqueue_script('ee-messages-settings');
-    }
-
-
-    /**
-     * set views array for List Table
-     */
-    public function _set_list_table_views_global_mtps()
-    {
-        $this->_views = [
-            'in_use' => [
-                'slug'  => 'in_use',
-                'label' => esc_html__('In Use', 'event_espresso'),
-                'count' => 0,
-            ],
-        ];
-    }
-
-
-    /**
-     * Set views array for the Custom Template List Table
-     */
-    public function _set_list_table_views_custom_mtps()
-    {
-        $this->_set_list_table_views_global_mtps();
-        $this->_views['in_use']['bulk_action'] = [
-            'trash_message_template' => esc_html__('Move to Trash', 'event_espresso'),
-        ];
-    }
-
-
-    /**
-     * set views array for message queue list table
-     *
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function _set_list_table_views_default()
-    {
-        EE_Registry::instance()->load_helper('Template');
-
-        $common_bulk_actions = EE_Registry::instance()->CAP->current_user_can(
-            'ee_send_message',
-            'message_list_table_bulk_actions'
-        )
-            ? [
-                'generate_now'          => esc_html__('Generate Now', 'event_espresso'),
-                'generate_and_send_now' => esc_html__('Generate and Send Now', 'event_espresso'),
-                'queue_for_resending'   => esc_html__('Queue for Resending', 'event_espresso'),
-                'send_now'              => esc_html__('Send Now', 'event_espresso'),
-            ]
-            : [];
-
-        $delete_bulk_action = EE_Registry::instance()->CAP->current_user_can(
-            'ee_delete_messages',
-            'message_list_table_bulk_actions'
-        )
-            ? ['delete_ee_messages' => esc_html__('Delete Messages', 'event_espresso')]
-            : [];
-
-
-        $this->_views = [
-            'all' => [
-                'slug'        => 'all',
-                'label'       => esc_html__('All', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => array_merge($common_bulk_actions, $delete_bulk_action),
-            ],
-        ];
-
-
-        foreach (EEM_Message::instance()->all_statuses() as $status) {
-            if ($status === EEM_Message::status_debug_only && ! EEM_Message::debug()) {
-                continue;
-            }
-            $status_bulk_actions = $common_bulk_actions;
-            // unset bulk actions not applying to status
-            if (! empty($status_bulk_actions)) {
-                switch ($status) {
-                    case EEM_Message::status_idle:
-                    case EEM_Message::status_resend:
-                        $status_bulk_actions['send_now'] = $common_bulk_actions['send_now'];
-                        break;
-
-                    case EEM_Message::status_failed:
-                    case EEM_Message::status_debug_only:
-                    case EEM_Message::status_messenger_executing:
-                        $status_bulk_actions = [];
-                        break;
-
-                    case EEM_Message::status_incomplete:
-                        unset($status_bulk_actions['queue_for_resending'], $status_bulk_actions['send_now']);
-                        break;
-
-                    case EEM_Message::status_retry:
-                    case EEM_Message::status_sent:
-                        unset($status_bulk_actions['generate_now'], $status_bulk_actions['generate_and_send_now']);
-                        break;
-                }
-            }
-
-            // skip adding messenger executing status to views because it will be included with the Failed view.
-            if ($status === EEM_Message::status_messenger_executing) {
-                continue;
-            }
-
-            $this->_views[ strtolower($status) ] = [
-                'slug'        => strtolower($status),
-                'label'       => EEH_Template::pretty_status($status, false, 'sentence'),
-                'count'       => 0,
-                'bulk_action' => array_merge($status_bulk_actions, $delete_bulk_action),
-            ];
-        }
-    }
-
-
-    /**
-     * @throws EE_Error
-     */
-    protected function _ee_default_messages_overview_list_table()
-    {
-        $this->_admin_page_title = esc_html__('Default Message Templates', 'event_espresso');
-        $this->display_admin_list_table_page_with_no_sidebar();
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _message_queue_list_table()
-    {
-        $this->_search_btn_label                   = esc_html__('Message Activity', 'event_espresso');
-        $this->_template_args['per_column']        = 6;
-        $this->_template_args['after_list_table']  = $this->_display_legend($this->_message_legend_items());
-        $this->_template_args['before_list_table'] = '<h3>'
-                                                     . EEM_Message::instance()->get_pretty_label_for_results()
-                                                     . '</h3>';
-        $this->display_admin_list_table_page_with_no_sidebar();
-    }
-
-
-    /**
-     * @throws EE_Error
-     */
-    protected function _message_legend_items()
-    {
-
-        $action_css_classes = EEH_MSG_Template::get_message_action_icons();
-        $action_items       = [];
-
-        foreach ($action_css_classes as $action_item => $action_details) {
-            if ($action_item === 'see_notifications_for') {
-                continue;
-            }
-            $action_items[ $action_item ] = [
-                'class' => $action_details['css_class'],
-                'desc'  => $action_details['label'],
-            ];
-        }
-
-        /** @var array $status_items status legend setup */
-        $status_items = [
-            'sent_status'                => [
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_sent,
-                'desc'  => EEH_Template::pretty_status(EEM_Message::status_sent, false, 'sentence'),
-            ],
-            'idle_status'                => [
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_idle,
-                'desc'  => EEH_Template::pretty_status(EEM_Message::status_idle, false, 'sentence'),
-            ],
-            'failed_status'              => [
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_failed,
-                'desc'  => EEH_Template::pretty_status(EEM_Message::status_failed, false, 'sentence'),
-            ],
-            'messenger_executing_status' => [
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_messenger_executing,
-                'desc'  => EEH_Template::pretty_status(EEM_Message::status_messenger_executing, false, 'sentence'),
-            ],
-            'resend_status'              => [
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_resend,
-                'desc'  => EEH_Template::pretty_status(EEM_Message::status_resend, false, 'sentence'),
-            ],
-            'incomplete_status'          => [
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_incomplete,
-                'desc'  => EEH_Template::pretty_status(EEM_Message::status_incomplete, false, 'sentence'),
-            ],
-            'retry_status'               => [
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_retry,
-                'desc'  => EEH_Template::pretty_status(EEM_Message::status_retry, false, 'sentence'),
-            ],
-        ];
-        if (EEM_Message::debug()) {
-            $status_items['debug_only_status'] = [
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_debug_only,
-                'desc'  => EEH_Template::pretty_status(EEM_Message::status_debug_only, false, 'sentence'),
-            ];
-        }
-
-        return array_merge($action_items, $status_items);
-    }
-
-
-    /**
-     * @throws EE_Error
-     */
-    protected function _custom_mtps_preview()
-    {
-        $this->_admin_page_title              = esc_html__('Custom Message Templates (Preview)', 'event_espresso');
-        $this->_template_args['preview_img']  = '<img src="' . EE_MSG_ASSETS_URL . 'images/custom_mtps_preview.png"'
-                                                . ' alt="' . esc_attr__(
-                                                    'Preview Custom Message Templates screenshot',
-                                                    'event_espresso'
-                                                ) . '" />';
-        $this->_template_args['preview_text'] = '<strong>'
-                                                . esc_html__(
-                                                    'Custom Message Templates is a feature that is only available in the premium version of Event Espresso 4 which is available with a support license purchase on EventEspresso.com. With the Custom Message Templates feature, you are able to create custom message templates and assign them on a per-event basis.',
-                                                    'event_espresso'
-                                                )
-                                                . '</strong>';
-
-        $this->display_admin_caf_preview_page('custom_message_types', false);
-    }
-
-
-    /**
-     * get_message_templates
-     * This gets all the message templates for listing on the overview list.
-     *
-     * @access public
-     * @param int    $per_page the amount of templates groups to show per page
-     * @param string $type     the current _view we're getting templates for
-     * @param bool   $count    return count?
-     * @param bool   $all      disregard any paging info (get all data);
-     * @param bool   $global   whether to return just global (true) or custom templates (false)
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function get_message_templates(
-        $per_page = 10,
-        $type = 'in_use',
-        $count = false,
-        $all = false,
-        $global = true
-    ) {
-
-        $MTP = EEM_Message_Template_Group::instance();
-
-        $orderby = $this->request->getRequestParam('orderby', 'GRP_ID');
-        $this->request->setRequestParam('orderby', $orderby);
-
-        $order        = $this->request->getRequestParam('order', 'ASC');
-        $current_page = $this->request->getRequestParam('paged', 1, 'int');
-        $per_page     = $this->request->getRequestParam('perpage', $per_page, 'int');
-
-        $offset = ($current_page - 1) * $per_page;
-        $limit  = $all ? null : [$offset, $per_page];
-
-        // options will match what is in the _views array property
-        switch ($type) {
-            case 'in_use':
-                $templates = $MTP->get_all_active_message_templates($orderby, $order, $limit, $count, $global, true);
-                break;
-            default:
-                $templates = $MTP->get_all_trashed_grouped_message_templates($orderby, $order, $limit, $count, $global);
-        }
-
-        return $templates;
-    }
-
-
-    /**
-     * filters etc might need a list of installed message_types
-     *
-     * @return array an array of message type objects
-     */
-    public function get_installed_message_types()
-    {
-        $installed_message_types = $this->_message_resource_manager->installed_message_types();
-        $installed               = [];
-
-        foreach ($installed_message_types as $message_type) {
-            $installed[ $message_type->name ] = $message_type;
-        }
-
-        return $installed;
-    }
-
-
-    /**
-     * _add_message_template
-     *
-     * This is used when creating a custom template. All Custom Templates start based off another template.
-     *
-     * @param string $message_type
-     * @param string $messenger
-     * @param string $GRP_ID
-     *
-     * @throws EE_error
-     * @throws ReflectionException
-     */
-    protected function _add_message_template($message_type = '', $messenger = '', $GRP_ID = '')
-    {
-        // set values override any request data
-        $message_type = ! empty($message_type) ? $message_type : $this->_active_message_type_name;
-        $messenger    = ! empty($messenger) ? $messenger : $this->_active_messenger_name;
-        $GRP_ID       = ! empty($GRP_ID) ? $GRP_ID : $this->request->getRequestParam('GRP_ID', 0, 'int');
-
-        // we need messenger and message type.  They should be coming from the event editor. If not here then return error
-        if (empty($message_type) || empty($messenger)) {
-            throw new EE_Error(
-                esc_html__(
-                    'Sorry, but we can\'t create new templates because we\'re missing the messenger or message type',
-                    'event_espresso'
-                )
-            );
-        }
-
-        // we need the GRP_ID for the template being used as the base for the new template
-        if (empty($GRP_ID)) {
-            throw new EE_Error(
-                esc_html__(
-                    'In order to create a custom message template the GRP_ID of the template being used as a base is needed',
-                    'event_espresso'
-                )
-            );
-        }
-
-        // let's just make sure the template gets generated!
-
-        // we need to reassign some variables for what the insert is expecting
-        $this->request->setRequestParam('MTP_messenger', $messenger);
-        $this->request->setRequestParam('MTP_message_type', $message_type);
-        $this->request->setRequestParam('GRP_ID', $GRP_ID);
-
-        $this->_insert_or_update_message_template(true);
-    }
-
-
-    /**
-     * public wrapper for the _add_message_template method
-     *
-     * @param string $message_type     message type slug
-     * @param string $messenger        messenger slug
-     * @param int    $GRP_ID           GRP_ID for the related message template group this new template will be based
-     *                                 off of.
-     * @throws EE_error
-     * @throws ReflectionException
-     */
-    public function add_message_template($message_type, $messenger, $GRP_ID)
-    {
-        $this->_add_message_template($message_type, $messenger, $GRP_ID);
-    }
-
-
-    /**
-     * _edit_message_template
-     *
-     * @access protected
-     * @return void
-     * @throws InvalidIdentifierException
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _edit_message_template()
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $template_fields = '';
-        $sidebar_fields  = '';
-        // we filter the tinyMCE settings to remove the validation since message templates by their nature will not have
-        // valid html in the templates.
-        add_filter('tiny_mce_before_init', [$this, 'filter_tinymce_init'], 10, 2);
-
-        $GRP_ID = $this->request->getRequestParam('id', 0, 'int');
-        $EVT_ID = $this->request->getRequestParam('evt_id', 0, 'int');
-
-        $this->_set_shortcodes(); // this also sets the _message_template property.
-        $message_template_group = $this->_message_template_group;
-        $c_label                = $message_template_group->context_label();
-        $c_config               = $message_template_group->contexts_config();
-
-        reset($c_config);
-        $context = $this->request->getRequestParam('context', key($c_config));
-        $context = strtolower($context);
-
-        $action = empty($GRP_ID) ? 'insert_message_template' : 'update_message_template';
-
-        $edit_message_template_form_url = add_query_arg(
-            ['action' => $action, 'noheader' => true],
-            EE_MSG_ADMIN_URL
-        );
-
-        // set active messenger for this view
-        $this->_active_messenger         = $this->_message_resource_manager->get_active_messenger(
-            $message_template_group->messenger()
-        );
-        $this->_active_message_type_name = $message_template_group->message_type();
-
-
-        // Do we have any validation errors?
-        $validators = $this->_get_transient();
-        $v_fields   = ! empty($validators) ? array_keys($validators) : [];
-
-
-        // we need to assemble the title from Various details
-        $context_label = sprintf(
-            esc_html__('(%s %s)', 'event_espresso'),
-            $c_config[ $context ]['label'],
-            ucwords($c_label['label'])
-        );
-
-        $title = sprintf(
-            esc_html__(' %s %s Template %s', 'event_espresso'),
-            ucwords($message_template_group->messenger_obj()->label['singular']),
-            ucwords($message_template_group->message_type_obj()->label['singular']),
-            $context_label
-        );
-
-        $this->_template_args['GRP_ID']           = $GRP_ID;
-        $this->_template_args['message_template'] = $message_template_group;
-        $this->_template_args['is_extra_fields']  = false;
-
-
-        // let's get EEH_MSG_Template so we can get template form fields
-        $template_field_structure = EEH_MSG_Template::get_fields(
-            $message_template_group->messenger(),
-            $message_template_group->message_type()
-        );
-
-        if (! $template_field_structure) {
-            $template_field_structure = false;
-            $template_fields          = esc_html__(
-                'There was an error in assembling the fields for this display (you should see an error message)',
-                'event_espresso'
-            );
-        }
-
-
-        $message_templates = $message_template_group->context_templates();
-
-
-        // if we have the extra key.. then we need to remove the content index from the template_field_structure as it
-        // will get handled in the "extra" array.
-        if (is_array($template_field_structure[ $context ]) && isset($template_field_structure[ $context ]['extra'])) {
-            foreach ($template_field_structure[ $context ]['extra'] as $reference_field => $new_fields) {
-                unset($template_field_structure[ $context ][ $reference_field ]);
-            }
-        }
-
-        // let's loop through the template_field_structure and actually assemble the input fields!
-        if (! empty($template_field_structure)) {
-            foreach ($template_field_structure[ $context ] as $template_field => $field_setup_array) {
-                // if this is an 'extra' template field then we need to remove any existing fields that are keyed up in
-                // the extra array and reset them.
-                if ($template_field === 'extra') {
-                    $this->_template_args['is_extra_fields'] = true;
-                    foreach ($field_setup_array as $reference_field => $new_fields_array) {
-                        $message_template = $message_templates[ $context ][ $reference_field ];
-                        $content          = $message_template instanceof EE_Message_Template
-                            ? $message_template->get('MTP_content')
-                            : '';
-                        foreach ($new_fields_array as $extra_field => $extra_array) {
-                            // let's verify if we need this extra field via the shortcodes parameter.
-                            $continue = false;
-                            if (isset($extra_array['shortcodes_required'])) {
-                                foreach ((array) $extra_array['shortcodes_required'] as $shortcode) {
-                                    if (! array_key_exists($shortcode, $this->_shortcodes)) {
-                                        $continue = true;
-                                    }
-                                }
-                                if ($continue) {
-                                    continue;
-                                }
-                            }
-
-                            $field_id                                  = $reference_field
-                                                                         . '-'
-                                                                         . $extra_field
-                                                                         . '-content';
-                            $template_form_fields[ $field_id ]         = $extra_array;
-                            $template_form_fields[ $field_id ]['name'] = 'MTP_template_fields['
-                                                                         . $reference_field
-                                                                         . '][content]['
-                                                                         . $extra_field . ']';
-                            $css_class                                 = isset($extra_array['css_class'])
-                                ? $extra_array['css_class']
-                                : '';
-
-                            $template_form_fields[ $field_id ]['css_class'] = ! empty($v_fields)
-                                                                              && in_array($extra_field, $v_fields, true)
-                                                                              && (
-                                                                                  is_array($validators[ $extra_field ])
-                                                                                  && isset($validators[ $extra_field ]['msg'])
-                                                                              )
-                                ? 'validate-error ' . $css_class
-                                : $css_class;
-
-                            $template_form_fields[ $field_id ]['value'] = ! empty($message_templates)
-                                                                          && isset($content[ $extra_field ])
-                                ? $content[ $extra_field ]
-                                : '';
-
-                            // do we have a validation error?  if we do then let's use that value instead
-                            $template_form_fields[ $field_id ]['value'] = isset($validators[ $extra_field ])
-                                ? $validators[ $extra_field ]['value']
-                                : $template_form_fields[ $field_id ]['value'];
-
-
-                            $template_form_fields[ $field_id ]['db-col'] = 'MTP_content';
-
-                            // shortcode selector
-                            $field_name_to_use                                   = $extra_field === 'main'
-                                ? 'content'
-                                : $extra_field;
-                            $template_form_fields[ $field_id ]['append_content'] = $this->_get_shortcode_selector(
-                                $field_name_to_use,
-                                $field_id
-                            );
-                        }
-                        $template_field_MTP_id           = $reference_field . '-MTP_ID';
-                        $template_field_template_name_id = $reference_field . '-name';
-
-                        $template_form_fields[ $template_field_MTP_id ] = [
-                            'name'       => 'MTP_template_fields[' . $reference_field . '][MTP_ID]',
-                            'label'      => null,
-                            'input'      => 'hidden',
-                            'type'       => 'int',
-                            'required'   => false,
-                            'validation' => false,
-                            'value'      => ! empty($message_templates) ? $message_template->ID() : '',
-                            'css_class'  => '',
-                            'format'     => '%d',
-                            'db-col'     => 'MTP_ID',
-                        ];
-
-                        $template_form_fields[ $template_field_template_name_id ] = [
-                            'name'       => 'MTP_template_fields[' . $reference_field . '][name]',
-                            'label'      => null,
-                            'input'      => 'hidden',
-                            'type'       => 'string',
-                            'required'   => false,
-                            'validation' => true,
-                            'value'      => $reference_field,
-                            'css_class'  => '',
-                            'format'     => '%s',
-                            'db-col'     => 'MTP_template_field',
-                        ];
-                    }
-                    continue; // skip the next stuff, we got the necessary fields here for this dataset.
-                } else {
-                    $field_id                                   = $template_field . '-content';
-                    $template_form_fields[ $field_id ]          = $field_setup_array;
-                    $template_form_fields[ $field_id ]['name']  =
-                        'MTP_template_fields[' . $template_field . '][content]';
-                    $message_template                           =
-                        isset($message_templates[ $context ][ $template_field ])
-                            ? $message_templates[ $context ][ $template_field ]
-                            : null;
-                    $template_form_fields[ $field_id ]['value'] = ! empty($message_templates)
-                                                                  && is_array($message_templates[ $context ])
-                                                                  && $message_template instanceof EE_Message_Template
-                        ? $message_template->get('MTP_content')
-                        : '';
-
-                    // do we have a validator error for this field?  if we do then we'll use that value instead
-                    $template_form_fields[ $field_id ]['value'] = isset($validators[ $template_field ])
-                        ? $validators[ $template_field ]['value']
-                        : $template_form_fields[ $field_id ]['value'];
-
-
-                    $template_form_fields[ $field_id ]['db-col']    = 'MTP_content';
-                    $css_class                                      = isset($field_setup_array['css_class'])
-                        ? $field_setup_array['css_class']
-                        : '';
-                    $template_form_fields[ $field_id ]['css_class'] = ! empty($v_fields)
-                                                                      && in_array($template_field, $v_fields, true)
-                                                                      && isset($validators[ $template_field ]['msg'])
-                        ? 'validate-error ' . $css_class
-                        : $css_class;
-
-                    // shortcode selector
-                    $template_form_fields[ $field_id ]['append_content'] = $this->_get_shortcode_selector(
-                        $template_field,
-                        $field_id
-                    );
-                }
-
-                // k took care of content field(s) now let's take care of others.
-
-                $template_field_MTP_id                 = $template_field . '-MTP_ID';
-                $template_field_field_template_name_id = $template_field . '-name';
-
-                // foreach template field there are actually two form fields created
-                $template_form_fields[ $template_field_MTP_id ] = [
-                    'name'       => 'MTP_template_fields[' . $template_field . '][MTP_ID]',
-                    'label'      => null,
-                    'input'      => 'hidden',
-                    'type'       => 'int',
-                    'required'   => false,
-                    'validation' => true,
-                    'value'      => $message_template instanceof EE_Message_Template ? $message_template->ID() : '',
-                    'css_class'  => '',
-                    'format'     => '%d',
-                    'db-col'     => 'MTP_ID',
-                ];
-
-                $template_form_fields[ $template_field_field_template_name_id ] = [
-                    'name'       => 'MTP_template_fields[' . $template_field . '][name]',
-                    'label'      => null,
-                    'input'      => 'hidden',
-                    'type'       => 'string',
-                    'required'   => false,
-                    'validation' => true,
-                    'value'      => $template_field,
-                    'css_class'  => '',
-                    'format'     => '%s',
-                    'db-col'     => 'MTP_template_field',
-                ];
-            }
-
-            // add other fields
-            $template_form_fields['ee-msg-current-context'] = [
-                'name'       => 'MTP_context',
-                'label'      => null,
-                'input'      => 'hidden',
-                'type'       => 'string',
-                'required'   => false,
-                'validation' => true,
-                'value'      => $context,
-                'css_class'  => '',
-                'format'     => '%s',
-                'db-col'     => 'MTP_context',
-            ];
-
-            $template_form_fields['ee-msg-grp-id'] = [
-                'name'       => 'GRP_ID',
-                'label'      => null,
-                'input'      => 'hidden',
-                'type'       => 'int',
-                'required'   => false,
-                'validation' => true,
-                'value'      => $GRP_ID,
-                'css_class'  => '',
-                'format'     => '%d',
-                'db-col'     => 'GRP_ID',
-            ];
-
-            $template_form_fields['ee-msg-messenger'] = [
-                'name'       => 'MTP_messenger',
-                'label'      => null,
-                'input'      => 'hidden',
-                'type'       => 'string',
-                'required'   => false,
-                'validation' => true,
-                'value'      => $message_template_group->messenger(),
-                'css_class'  => '',
-                'format'     => '%s',
-                'db-col'     => 'MTP_messenger',
-            ];
-
-            $template_form_fields['ee-msg-message-type'] = [
-                'name'       => 'MTP_message_type',
-                'label'      => null,
-                'input'      => 'hidden',
-                'type'       => 'string',
-                'required'   => false,
-                'validation' => true,
-                'value'      => $message_template_group->message_type(),
-                'css_class'  => '',
-                'format'     => '%s',
-                'db-col'     => 'MTP_message_type',
-            ];
-
-            $sidebar_form_fields['ee-msg-is-global'] = [
-                'name'       => 'MTP_is_global',
-                'label'      => esc_html__('Global Template', 'event_espresso'),
-                'input'      => 'hidden',
-                'type'       => 'int',
-                'required'   => false,
-                'validation' => true,
-                'value'      => $message_template_group->get('MTP_is_global'),
-                'css_class'  => '',
-                'format'     => '%d',
-                'db-col'     => 'MTP_is_global',
-            ];
-
-            $sidebar_form_fields['ee-msg-is-override'] = [
-                'name'       => 'MTP_is_override',
-                'label'      => esc_html__('Override all custom', 'event_espresso'),
-                'input'      => $message_template_group->is_global() ? 'checkbox' : 'hidden',
-                'type'       => 'int',
-                'required'   => false,
-                'validation' => true,
-                'value'      => $message_template_group->get('MTP_is_override'),
-                'css_class'  => '',
-                'format'     => '%d',
-                'db-col'     => 'MTP_is_override',
-            ];
-
-            $sidebar_form_fields['ee-msg-is-active'] = [
-                'name'       => 'MTP_is_active',
-                'label'      => esc_html__('Active Template', 'event_espresso'),
-                'input'      => 'hidden',
-                'type'       => 'int',
-                'required'   => false,
-                'validation' => true,
-                'value'      => $message_template_group->is_active(),
-                'css_class'  => '',
-                'format'     => '%d',
-                'db-col'     => 'MTP_is_active',
-            ];
-
-            $sidebar_form_fields['ee-msg-deleted'] = [
-                'name'       => 'MTP_deleted',
-                'label'      => null,
-                'input'      => 'hidden',
-                'type'       => 'int',
-                'required'   => false,
-                'validation' => true,
-                'value'      => $message_template_group->get('MTP_deleted'),
-                'css_class'  => '',
-                'format'     => '%d',
-                'db-col'     => 'MTP_deleted',
-            ];
-            $sidebar_form_fields['ee-msg-author']  = [
-                'name'       => 'MTP_user_id',
-                'label'      => esc_html__('Author', 'event_espresso'),
-                'input'      => 'hidden',
-                'type'       => 'int',
-                'required'   => false,
-                'validation' => false,
-                'value'      => $message_template_group->user(),
-                'format'     => '%d',
-                'db-col'     => 'MTP_user_id',
-            ];
-
-            $sidebar_form_fields['ee-msg-route'] = [
-                'name'  => 'action',
-                'input' => 'hidden',
-                'type'  => 'string',
-                'value' => $action,
-            ];
-
-            $sidebar_form_fields['ee-msg-id']        = [
-                'name'  => 'id',
-                'input' => 'hidden',
-                'type'  => 'int',
-                'value' => $GRP_ID,
-            ];
-            $sidebar_form_fields['ee-msg-evt-nonce'] = [
-                'name'  => $action . '_nonce',
-                'input' => 'hidden',
-                'type'  => 'string',
-                'value' => wp_create_nonce($action . '_nonce'),
-            ];
-
-            $template_switch = $this->request->getRequestParam('template_switch');
-            if ($template_switch) {
-                $sidebar_form_fields['ee-msg-template-switch'] = [
-                    'name'  => 'template_switch',
-                    'input' => 'hidden',
-                    'type'  => 'int',
-                    'value' => 1,
-                ];
-            }
-
-
-            $template_fields = $this->_generate_admin_form_fields($template_form_fields);
-            $sidebar_fields  = $this->_generate_admin_form_fields($sidebar_form_fields);
-        } //end if ( !empty($template_field_structure) )
-
-        // set extra content for publish box
-        $this->_template_args['publish_box_extra_content'] = $sidebar_fields;
-        $this->_set_publish_post_box_vars(
-            'id',
-            $GRP_ID,
-            false,
-            add_query_arg(
-                ['action' => 'global_mtps'],
-                $this->_admin_base_url
-            )
-        );
-
-        // add preview button
-        $preview_url    = parent::add_query_args_and_nonce(
-            [
-                'message_type' => $message_template_group->message_type(),
-                'messenger'    => $message_template_group->messenger(),
-                'context'      => $context,
-                'GRP_ID'       => $GRP_ID,
-                'evt_id'       => $EVT_ID,
-                'action'       => 'preview_message',
-            ],
-            $this->_admin_base_url
-        );
-        $preview_button = '<a href="' . $preview_url . '" class="button-secondary messages-preview-button">'
-                          . esc_html__('Preview', 'event_espresso')
-                          . '</a>';
-
-
-        // setup context switcher
-        $context_switcher_args = [
-            'page'    => 'espresso_messages',
-            'action'  => 'edit_message_template',
-            'id'      => $GRP_ID,
-            'evt_id'  => $EVT_ID,
-            'context' => $context,
-            'extra'   => $preview_button,
-        ];
-        $this->_set_context_switcher($message_template_group, $context_switcher_args);
-
-
-        // main box
-        $this->_template_args['template_fields']                         = $template_fields;
-        $this->_template_args['sidebar_box_id']                          = 'details';
-        $this->_template_args['action']                                  = $action;
-        $this->_template_args['context']                                 = $context;
-        $this->_template_args['edit_message_template_form_url']          = $edit_message_template_form_url;
-        $this->_template_args['learn_more_about_message_templates_link'] =
-            $this->_learn_more_about_message_templates_link();
-
-
-        $this->_template_args['before_admin_page_content'] = $this->add_context_switcher();
-        $this->_template_args['before_admin_page_content'] .= $this->add_active_context_element(
-            $message_template_group,
-            $context,
-            $context_label
-        );
-        $this->_template_args['before_admin_page_content'] .= $this->_add_form_element_before();
-        $this->_template_args['after_admin_page_content']  = $this->_add_form_element_after();
-
-        $this->_template_path = $this->_template_args['GRP_ID']
-            ? EE_MSG_TEMPLATE_PATH . 'ee_msg_details_main_edit_meta_box.template.php'
-            : EE_MSG_TEMPLATE_PATH . 'ee_msg_details_main_add_meta_box.template.php';
-
-        // send along EE_Message_Template_Group object for further template use.
-        $this->_template_args['MTP'] = $message_template_group;
-
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            $this->_template_path,
-            $this->_template_args,
-            true
-        );
-
-
-        // finally, let's set the admin_page title
-        $this->_admin_page_title = sprintf(esc_html__('Editing %s', 'event_espresso'), $title);
-
-
-        // we need to take care of setting the shortcodes property for use elsewhere.
-        $this->_set_shortcodes();
-
-
-        // final template wrapper
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    public function filter_tinymce_init($mceInit, $editor_id)
-    {
-        return $mceInit;
-    }
-
-
-    public function add_context_switcher()
-    {
-        return $this->_context_switcher;
-    }
-
-
-    /**
-     * Adds the activation/deactivation toggle for the message template context.
-     *
-     * @param EE_Message_Template_Group $message_template_group
-     * @param string                    $context
-     * @param string                    $context_label
-     * @return string
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidIdentifierException
-     * @throws ReflectionException
-     */
-    protected function add_active_context_element(
-        EE_Message_Template_Group $message_template_group,
-        $context,
-        $context_label
-    ) {
-        $template_args = [
-            'context'                   => $context,
-            'nonce'                     => wp_create_nonce('activate_' . $context . '_toggle_nonce'),
-            'is_active'                 => $message_template_group->is_context_active($context),
-            'on_off_action'             => $message_template_group->is_context_active($context)
-                ? 'context-off'
-                : 'context-on',
-            'context_label'             => str_replace(['(', ')'], '', $context_label),
-            'message_template_group_id' => $message_template_group->ID(),
-        ];
-        return EEH_Template::display_template(
-            EE_MSG_TEMPLATE_PATH . 'ee_msg_editor_active_context_element.template.php',
-            $template_args,
-            true
-        );
-    }
-
-
-    /**
-     * Ajax callback for `toggle_context_template` ajax action.
-     * Handles toggling the message context on or off.
-     *
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidIdentifierException
-     * @throws InvalidInterfaceException
-     */
-    public function toggle_context_template()
-    {
-        $success = true;
-        // check for required data
-        if (
-            ! (
-                $this->request->requestParamIsSet('message_template_group_id')
-                && $this->request->requestParamIsSet('context')
-                && $this->request->requestParamIsSet('status')
-            )
-        ) {
-            EE_Error::add_error(
-                esc_html__('Required data for doing this action is not available.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $success = false;
-        }
-
-        $nonce   = $this->request->getRequestParam('toggle_context_nonce', '');
-        $context = $this->request->getRequestParam('context', '');
-        $status  = $this->request->getRequestParam('status', '');
-
-        $this->_verify_nonce($nonce, "activate_{$context}_toggle_nonce");
-
-        if ($status !== 'off' && $status !== 'on') {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__('The given status (%s) is not valid. Must be "off" or "on"', 'event_espresso'),
-                    $status
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $success = false;
-        }
-        $message_template_group_id = $this->request->getRequestParam('message_template_group_id', 0, 'int');
-        $message_template_group    = EEM_Message_Template_Group::instance()->get_one_by_ID($message_template_group_id);
-        if (! $message_template_group instanceof EE_Message_Template_Group) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'Unable to change the active state because the given id "%1$d" does not match a valid "%2$s"',
-                        'event_espresso'
-                    ),
-                    $message_template_group_id,
-                    'EE_Message_Template_Group'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $success = false;
-        }
-        if ($success) {
-            $success = $status === 'off'
-                ? $message_template_group->deactivate_context($context)
-                : $message_template_group->activate_context($context);
-        }
-        $this->_template_args['success'] = $success;
-        $this->_return_json();
-    }
-
-
-    public function _add_form_element_before()
-    {
-        return '<form method="post" action="'
-               . $this->_template_args['edit_message_template_form_url']
-               . '" id="ee-msg-edit-frm">';
-    }
-
-
-    public function _add_form_element_after()
-    {
-        return '</form>';
-    }
-
-
-    /**
-     * This executes switching the template pack for a message template.
-     *
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @since 4.5.0
-     */
-    public function switch_template_pack()
-    {
-
-        $GRP_ID        = $this->request->getRequestParam('GRP_ID', 0, 'int');
-        $template_pack = $this->request->getRequestParam('template_pack', '');
-
-        // verify we have needed values.
-        if (empty($GRP_ID) || empty($template_pack)) {
-            $this->_template_args['error'] = true;
-            EE_Error::add_error(
-                esc_html__('The required date for switching templates is not available.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        } else {
-            // get template, set the new template_pack and then reset to default
-            /** @var EE_Message_Template_Group $message_template_group */
-            $message_template_group = EEM_Message_Template_Group::instance()->get_one_by_ID($GRP_ID);
-
-            $message_template_group->set_template_pack_name($template_pack);
-            $this->request->setRequestParam('msgr', $message_template_group->messenger());
-            $this->request->setRequestParam('mt', $message_template_group->message_type());
-
-            $query_args = $this->_reset_to_default_template();
-
-            if (empty($query_args['id'])) {
-                EE_Error::add_error(
-                    esc_html__(
-                        'Something went wrong with switching the template pack. Please try again or contact EE support',
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-                $this->_template_args['error'] = true;
-            } else {
-                $template_label       = $message_template_group->get_template_pack()->label;
-                $template_pack_labels = $message_template_group->messenger_obj()->get_supports_labels();
-                EE_Error::add_success(
-                    sprintf(
-                        esc_html__(
-                            'This message template has been successfully switched to use the %1$s %2$s.  Please wait while the page reloads with your new template.',
-                            'event_espresso'
-                        ),
-                        $template_label,
-                        $template_pack_labels->template_pack
-                    )
-                );
-                // generate the redirect url for js.
-                $url = self::add_query_args_and_nonce($query_args, $this->_admin_base_url);
-
-                $this->_template_args['data']['redirect_url'] = $url;
-                $this->_template_args['success']              = true;
-            }
-
-            $this->_return_json();
-        }
-    }
-
-
-    /**
-     * This handles resetting the template for the given messenger/message_type so that users can start from scratch if
-     * they want.
-     *
-     * @access protected
-     * @return array|null
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _reset_to_default_template()
-    {
-
-        $templates    = [];
-        $GRP_ID       = $this->request->getRequestParam('GRP_ID', 0, 'int');
-        $messenger    = $this->request->getRequestParam('msgr');
-        $message_type = $this->request->getRequestParam('mt');
-        // we need to make sure we've got the info we need.
-        if (! ($GRP_ID && $messenger && $message_type)) {
-            EE_Error::add_error(
-                esc_html__(
-                    'In order to reset the template to its default we require the messenger, message type, and message template GRP_ID to know what is being reset.  At least one of these is missing.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-
-        // all templates will be reset to whatever the defaults are
-        // for the global template matching the messenger and message type.
-        $success = ! empty($GRP_ID);
-
-        if ($success) {
-            // let's first determine if the incoming template is a global template,
-            // if it isn't then we need to get the global template matching messenger and message type.
-            // $MTPG = EEM_Message_Template_Group::instance()->get_one_by_ID( $GRP_ID );
-
-
-            // note this is ONLY deleting the template fields (Message Template rows) NOT the message template group.
-            $success = $this->_delete_mtp_permanently($GRP_ID, false);
-
-            if ($success) {
-                // if successfully deleted, lets generate the new ones.
-                // Note. We set GLOBAL to true, because resets on ANY template
-                // will use the related global template defaults for regeneration.
-                // This means that if a custom template is reset it resets to whatever the related global template is.
-                // HOWEVER, we DO keep the template pack and template variation set
-                // for the current custom template when resetting.
-                $templates = $this->_generate_new_templates($messenger, $message_type, $GRP_ID, true);
-            }
-        }
-
-        // any error messages?
-        if (! $success) {
-            EE_Error::add_error(
-                esc_html__(
-                    'Something went wrong with deleting existing templates. Unable to reset to default',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-
-        // all good, let's add a success message!
-        if ($success && ! empty($templates)) {
-            // the info for the template we generated is the first element in the returned array
-            // $templates = $templates[0];
-            EE_Error::overwrite_success();
-            EE_Error::add_success(esc_html__('Templates have been reset to defaults.', 'event_espresso'));
-        }
-
-
-        $query_args = [
-            'id'      => isset($templates[0]['GRP_ID']) ? $templates[0]['GRP_ID'] : null,
-            'context' => isset($templates[0]['MTP_context']) ? $templates[0]['MTP_context'] : null,
-            'action'  => isset($templates[0]['GRP_ID']) ? 'edit_message_template' : 'global_mtps',
-        ];
-
-        // if called via ajax then we return query args otherwise redirect
-        if (defined('DOING_AJAX') && DOING_AJAX) {
-            return $query_args;
-        } else {
-            $this->_redirect_after_action(false, '', '', $query_args, true);
-
-            return null;
-        }
-    }
-
-
-    /**
-     * Retrieve and set the message preview for display.
-     *
-     * @param bool $send if TRUE then we are doing an actual TEST send with the results of the preview.
-     * @return string
-     * @throws ReflectionException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function _preview_message($send = false)
-    {
-        // first make sure we've got the necessary parameters
-        $GRP_ID       = $this->request->getRequestParam('GRP_ID', 0, 'int');
-        if (! ($GRP_ID && $this->_active_messenger_name && $this->_active_message_type_name)) {
-            EE_Error::add_error(
-                esc_html__('Missing necessary parameters for displaying preview', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-
-        $context = $this->request->getRequestParam('context');
-        // get the preview!
-        $preview = EED_Messages::preview_message(
-            $this->_active_message_type_name,
-            $context,
-            $this->_active_messenger_name,
-            $send
-        );
-
-        if ($send) {
-            return $preview;
-        }
-
-        // if we have an evt_id set on the request, use it.
-        $EVT_ID = $this->request->getRequestParam('evt_id', 0, 'int');
-
-        // let's add a button to go back to the edit view
-        $query_args             = [
-            'id'      => $GRP_ID,
-            'evt_id'  => $EVT_ID,
-            'context' => $context,
-            'action'  => 'edit_message_template',
-        ];
-        $go_back_url            = parent::add_query_args_and_nonce($query_args, $this->_admin_base_url);
-        $preview_button         = '<a href="'
-                                  . $go_back_url
-                                  . '" class="button-secondary messages-preview-go-back-button">'
-                                  . esc_html__('Go Back to Edit', 'event_espresso')
-                                  . '</a>';
-        $message_types          = $this->get_installed_message_types();
-        $active_messenger       = $this->_message_resource_manager->get_active_messenger($this->_active_messenger_name);
-        $active_messenger_label = $active_messenger instanceof EE_messenger
-            ? ucwords($active_messenger->label['singular'])
-            : esc_html__('Unknown Messenger', 'event_espresso');
-        // let's provide a helpful title for context
-        $preview_title = sprintf(
-            esc_html__('Viewing Preview for %s %s Message Template', 'event_espresso'),
-            $active_messenger_label,
-            ucwords($message_types[ $this->_active_message_type_name ]->label['singular'])
-        );
-        if (empty($preview)) {
-            $this->noEventsErrorMessage();
-        }
-        // setup display of preview.
-        $this->_admin_page_title                    = $preview_title;
-        $this->_template_args['admin_page_title']   = $preview_title;
-        $this->_template_args['admin_page_content'] = $preview_button . '<br />' . $preview;
-        $this->_template_args['data']['force_json'] = true;
-
-        return '';
-    }
-
-
-    /**
-     * Used to set an error if there are no events available for generating a preview/test send.
-     *
-     * @param bool $test_send Whether the error should be generated for the context of a test send.
-     */
-    protected function noEventsErrorMessage($test_send = false)
-    {
-        $events_url = parent::add_query_args_and_nonce(
-            [
-                'action' => 'default',
-                'page'   => 'espresso_events',
-            ],
-            admin_url('admin.php')
-        );
-        $message    = $test_send
-            ? esc_html__(
-                'A test message could not be sent for this message template because there are no events created yet. The preview system uses actual events for generating the test message. %1$sGo see your events%2$s!',
-                'event_espresso'
-            )
-            : esc_html__(
-                'There is no preview for this message template available because there are no events created yet. The preview system uses actual events for generating the preview. %1$sGo see your events%2$s!',
-                'event_espresso'
-            );
-
-        EE_Error::add_attention(
-            sprintf(
-                $message,
-                "<a href='{$events_url}'>",
-                '</a>'
-            )
-        );
-    }
-
-
-    /**
-     * The initial _preview_message is on a no headers route.  It will optionally call this if necessary otherwise it
-     * gets called automatically.
-     *
-     * @return void
-     * @throws EE_Error
-     * @since 4.5.0
-     *
-     */
-    protected function _display_preview_message()
-    {
-        $this->display_admin_page_with_no_sidebar();
-    }
-
-
-    /**
-     * registers metaboxes that should show up on the "edit_message_template" page
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _register_edit_meta_boxes()
-    {
-        add_meta_box(
-            'mtp_valid_shortcodes',
-            esc_html__('Valid Shortcodes', 'event_espresso'),
-            [$this, 'shortcode_meta_box'],
-            $this->_current_screen->id,
-            'side'
-        );
-        add_meta_box(
-            'mtp_extra_actions',
-            esc_html__('Extra Actions', 'event_espresso'),
-            [$this, 'extra_actions_meta_box'],
-            $this->_current_screen->id,
-            'side',
-            'high'
-        );
-        add_meta_box(
-            'mtp_templates',
-            esc_html__('Template Styles', 'event_espresso'),
-            [$this, 'template_pack_meta_box'],
-            $this->_current_screen->id,
-            'side',
-            'high'
-        );
-    }
-
-
-    /**
-     * metabox content for all template pack and variation selection.
-     *
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @since 4.5.0
-     */
-    public function template_pack_meta_box()
-    {
-        $this->_set_message_template_group();
-
-        $tp_collection = EEH_MSG_Template::get_template_pack_collection();
-
-        $tp_select_values = [];
-
-        foreach ($tp_collection as $tp) {
-            // only include template packs that support this messenger and message type!
-            $supports = $tp->get_supports();
-            if (
-                ! isset($supports[ $this->_message_template_group->messenger() ])
-                || ! in_array(
-                    $this->_message_template_group->message_type(),
-                    $supports[ $this->_message_template_group->messenger() ],
-                    true
-                )
-            ) {
-                // not supported
-                continue;
-            }
-
-            $tp_select_values[] = [
-                'text' => $tp->label,
-                'id'   => $tp->dbref,
-            ];
-        }
-
-        // if empty $tp_select_values then we make sure default is set because EVERY message type should be supported by
-        // the default template pack.  This still allows for the odd template pack to override.
-        if (empty($tp_select_values)) {
-            $tp_select_values[] = [
-                'text' => esc_html__('Default', 'event_espresso'),
-                'id'   => 'default',
-            ];
-        }
-
-        // setup variation select values for the currently selected template.
-        $variations               = $this->_message_template_group->get_template_pack()->get_variations(
-            $this->_message_template_group->messenger(),
-            $this->_message_template_group->message_type()
-        );
-        $variations_select_values = [];
-        foreach ($variations as $variation => $label) {
-            $variations_select_values[] = [
-                'text' => $label,
-                'id'   => $variation,
-            ];
-        }
-
-        $template_pack_labels = $this->_message_template_group->messenger_obj()->get_supports_labels();
-
-        $template_args['template_packs_selector']        = EEH_Form_Fields::select_input(
-            'MTP_template_pack',
-            $tp_select_values,
-            $this->_message_template_group->get_template_pack_name()
-        );
-        $template_args['variations_selector']            = EEH_Form_Fields::select_input(
-            'MTP_template_variation',
-            $variations_select_values,
-            $this->_message_template_group->get_template_pack_variation()
-        );
-        $template_args['template_pack_label']            = $template_pack_labels->template_pack;
-        $template_args['template_variation_label']       = $template_pack_labels->template_variation;
-        $template_args['template_pack_description']      = $template_pack_labels->template_pack_description;
-        $template_args['template_variation_description'] = $template_pack_labels->template_variation_description;
-
-        $template = EE_MSG_TEMPLATE_PATH . 'template_pack_and_variations_metabox.template.php';
-
-        EEH_Template::display_template($template, $template_args);
-    }
-
-
-    /**
-     * This meta box holds any extra actions related to Message Templates
-     * For now, this includes Resetting templates to defaults and sending a test email.
-     *
-     * @access  public
-     * @return void
-     * @throws EE_Error
-     */
-    public function extra_actions_meta_box()
-    {
-        $template_form_fields = [];
-
-        $extra_args = [
-            'msgr'   => $this->_message_template_group->messenger(),
-            'mt'     => $this->_message_template_group->message_type(),
-            'GRP_ID' => $this->_message_template_group->GRP_ID(),
-        ];
-        // first we need to see if there are any fields
-        $fields = $this->_message_template_group->messenger_obj()->get_test_settings_fields();
-
-        if (! empty($fields)) {
-            // yup there be fields
-            foreach ($fields as $field => $config) {
-                $field_id = $this->_message_template_group->messenger() . '_' . $field;
-                $existing = $this->_message_template_group->messenger_obj()->get_existing_test_settings();
-                $default  = isset($config['default']) ? $config['default'] : '';
-                $default  = isset($config['value']) ? $config['value'] : $default;
-
-                // if type is hidden and the value is empty
-                // something may have gone wrong so let's correct with the defaults
-                $fix                = $config['input'] === 'hidden'
-                                      && isset($existing[ $field ])
-                                      && empty($existing[ $field ])
-                    ? $default
-                    : '';
-                $existing[ $field ] = isset($existing[ $field ]) && empty($fix)
-                    ? $existing[ $field ]
-                    : $fix;
-
-                $template_form_fields[ $field_id ] = [
-                    'name'       => 'test_settings_fld[' . $field . ']',
-                    'label'      => $config['label'],
-                    'input'      => $config['input'],
-                    'type'       => $config['type'],
-                    'required'   => $config['required'],
-                    'validation' => $config['validation'],
-                    'value'      => isset($existing[ $field ]) ? $existing[ $field ] : $default,
-                    'css_class'  => $config['css_class'],
-                    'options'    => isset($config['options']) ? $config['options'] : [],
-                    'default'    => $default,
-                    'format'     => $config['format'],
-                ];
-            }
-        }
-
-        $test_settings_html = ! empty($template_form_fields)
-            ? $this->_generate_admin_form_fields($template_form_fields, 'string', 'ee_tst_settings_flds')
-            : '';
-
-        // print out $test_settings_fields
-        if (! empty($test_settings_html)) {
-            $test_settings_html .= '<input type="submit" class="button-primary mtp-test-button alignright" ';
-            $test_settings_html .= 'name="test_button" value="';
-            $test_settings_html .= esc_html__('Test Send', 'event_espresso');
-            $test_settings_html .= '" /><div style="clear:both"></div>';
-        }
-
-        // and button
-        $test_settings_html .= '<p>';
-        $test_settings_html .= esc_html__('Need to reset this message type and start over?', 'event_espresso');
-        $test_settings_html .= '</p>';
-        $test_settings_html .= '<div class="publishing-action alignright resetbutton">';
-        $test_settings_html .= $this->get_action_link_or_button(
-            'reset_to_default',
-            'reset',
-            $extra_args,
-            'button-primary reset-default-button'
-        );
-        $test_settings_html .= '</div><div style="clear:both"></div>';
-        echo $test_settings_html; // already escaped
-    }
-
-
-    /**
-     * This returns the shortcode selector skeleton for a given context and field.
-     *
-     * @param string $field           The name of the field retrieving shortcodes for.
-     * @param string $linked_input_id The css id of the input that the shortcodes get added to.
-     * @return string
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @since 4.9.rc.000
-     */
-    protected function _get_shortcode_selector($field, $linked_input_id)
-    {
-        $template_args = [
-            'shortcodes'      => $this->_get_shortcodes([$field]),
-            'fieldname'       => $field,
-            'linked_input_id' => $linked_input_id,
-        ];
-
-        return EEH_Template::display_template(
-            EE_MSG_TEMPLATE_PATH . 'shortcode_selector_skeleton.template.php',
-            $template_args,
-            true
-        );
-    }
-
-
-    /**
-     * This just takes care of returning the meta box content for shortcodes (only used on the edit message template
-     * page)
-     *
-     * @access public
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function shortcode_meta_box()
-    {
-        $shortcodes = $this->_get_shortcodes([], false);
-        // just make sure the shortcodes property is set
-        // $messenger = $this->_message_template_group->messenger_obj();
-        // now let's set the content depending on the status of the shortcodes array
-        if (empty($shortcodes)) {
-            echo '<p>' . esc_html__('There are no valid shortcodes available', 'event_espresso') . '</p>';
-            return;
-        }
-        ?>
+	/**
+	 * @var EE_Message_Resource_Manager $_message_resource_manager
+	 */
+	protected $_message_resource_manager;
+
+	/**
+	 * @var string
+	 */
+	protected $_active_message_type_name = '';
+
+	/**
+	 * @var string
+	 */
+	protected $_active_messenger_name = '';
+
+	/**
+	 * @var EE_messenger $_active_messenger
+	 */
+	protected $_active_messenger;
+
+	protected $_activate_meta_box_type;
+
+	protected $_current_message_meta_box;
+
+	protected $_current_message_meta_box_object;
+
+	protected $_context_switcher;
+
+	protected $_shortcodes           = [];
+
+	protected $_active_messengers    = [];
+
+	protected $_active_message_types = [];
+
+	/**
+	 * @var EE_Message_Template_Group $_message_template_group
+	 */
+	protected $_message_template_group;
+
+	protected $_m_mt_settings = [];
+
+
+	/**
+	 * This is set via the _set_message_template_group method and holds whatever the template pack for the group is.
+	 * IF there is no group then it gets automatically set to the Default template pack.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @var EE_Messages_Template_Pack
+	 */
+	protected $_template_pack;
+
+
+	/**
+	 * This is set via the _set_message_template_group method and holds whatever the template pack variation for the
+	 * group is.  If there is no group then it automatically gets set to default.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @var string
+	 */
+	protected $_variation;
+
+
+	/**
+	 * @param bool $routing
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function __construct($routing = true)
+	{
+		// make sure messages autoloader is running
+		EED_Messages::set_autoloaders();
+		parent::__construct($routing);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _init_page_props()
+	{
+		$this->page_slug        = EE_MSG_PG_SLUG;
+		$this->page_label       = esc_html__('Messages Settings', 'event_espresso');
+		$this->_admin_base_url  = EE_MSG_ADMIN_URL;
+		$this->_admin_base_path = EE_MSG_ADMIN;
+
+		$this->_active_messenger_name    = $this->request->getRequestParam('messenger', '');
+		$this->_active_message_type_name = $this->request->getRequestParam('message_type', '');
+
+		$this->_load_message_resource_manager();
+	}
+
+
+	/**
+	 * loads messenger objects into the $_active_messengers property (so we can access the needed methods)
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 */
+	protected function _load_message_resource_manager()
+	{
+		$this->_message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+	}
+
+
+	/**
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @deprecated 4.9.9.rc.014
+	 */
+	public function get_messengers_for_list_table()
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			sprintf(
+				esc_html__(
+					'This method is no longer in use.  There is no replacement for it. The method was used to generate a set of values for use in creating a messenger filter dropdown which is now generated differently via %s',
+					'event_espresso'
+				),
+				'Messages_Admin_Page::get_messengers_select_input()'
+			),
+			'4.9.9.rc.014'
+		);
+
+		$m_values          = [];
+		$active_messengers = EEM_Message::instance()->get_all(['group_by' => 'MSG_messenger']);
+		// setup messengers for selects
+		$i = 1;
+		foreach ($active_messengers as $active_messenger) {
+			if ($active_messenger instanceof EE_Message) {
+				$m_values[ $i ]['id']   = $active_messenger->messenger();
+				$m_values[ $i ]['text'] = ucwords($active_messenger->messenger_label());
+				$i++;
+			}
+		}
+
+		return $m_values;
+	}
+
+
+	/**
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @deprecated 4.9.9.rc.014
+	 */
+	public function get_message_types_for_list_table()
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			sprintf(
+				esc_html__(
+					'This method is no longer in use.  There is no replacement for it. The method was used to generate a set of values for use in creating a message type filter dropdown which is now generated differently via %s',
+					'event_espresso'
+				),
+				'Messages_Admin_Page::get_message_types_select_input()'
+			),
+			'4.9.9.rc.014'
+		);
+
+		$mt_values       = [];
+		$active_messages = EEM_Message::instance()->get_all(['group_by' => 'MSG_message_type']);
+		$i               = 1;
+		foreach ($active_messages as $active_message) {
+			if ($active_message instanceof EE_Message) {
+				$mt_values[ $i ]['id']   = $active_message->message_type();
+				$mt_values[ $i ]['text'] = ucwords($active_message->message_type_label());
+				$i++;
+			}
+		}
+
+		return $mt_values;
+	}
+
+
+	/**
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @deprecated 4.9.9.rc.014
+	 */
+	public function get_contexts_for_message_types_for_list_table()
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			sprintf(
+				esc_html__(
+					'This method is no longer in use.  There is no replacement for it. The method was used to generate a set of values for use in creating a message type context filter dropdown which is now generated differently via %s',
+					'event_espresso'
+				),
+				'Messages_Admin_Page::get_contexts_for_message_types_select_input()'
+			),
+			'4.9.9.rc.014'
+		);
+
+		$contexts                = [];
+		$active_message_contexts = EEM_Message::instance()->get_all(['group_by' => 'MSG_context']);
+		foreach ($active_message_contexts as $active_message) {
+			if ($active_message instanceof EE_Message) {
+				$message_type = $active_message->message_type_object();
+				if ($message_type instanceof EE_message_type) {
+					$message_type_contexts = $message_type->get_contexts();
+					foreach ($message_type_contexts as $context => $context_details) {
+						$contexts[ $context ] = $context_details['label'];
+					}
+				}
+			}
+		}
+
+		return $contexts;
+	}
+
+
+	/**
+	 * Generate select input with provided messenger options array.
+	 *
+	 * @param array $messenger_options Array of messengers indexed by messenger slug and values are the messenger
+	 *                                 labels.
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function get_messengers_select_input($messenger_options)
+	{
+		// if empty or just one value then just return an empty string
+		if (
+			empty($messenger_options)
+			|| ! is_array($messenger_options)
+			|| count($messenger_options) === 1
+		) {
+			return '';
+		}
+		// merge in default
+		$messenger_options = array_merge(
+			['none_selected' => esc_html__('Show All Messengers', 'event_espresso')],
+			$messenger_options
+		);
+		$input             = new EE_Select_Input(
+			$messenger_options,
+			[
+				'html_name'  => 'ee_messenger_filter_by',
+				'html_id'    => 'ee_messenger_filter_by',
+				'html_class' => 'wide',
+				'default'    => $this->request->getRequestParam('ee_messenger_filter_by', 'none_selected', 'title'),
+			]
+		);
+
+		return $input->get_html_for_input();
+	}
+
+
+	/**
+	 * Generate select input with provided message type options array.
+	 *
+	 * @param array $message_type_options Array of message types indexed by message type slug, and values are the
+	 *                                    message type labels
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function get_message_types_select_input($message_type_options)
+	{
+		// if empty or count of options is 1 then just return an empty string
+		if (
+			empty($message_type_options)
+			|| ! is_array($message_type_options)
+			|| count($message_type_options) === 1
+		) {
+			return '';
+		}
+		// merge in default
+		$message_type_options = array_merge(
+			['none_selected' => esc_html__('Show All Message Types', 'event_espresso')],
+			$message_type_options
+		);
+		$input                = new EE_Select_Input(
+			$message_type_options,
+			[
+				'html_name'  => 'ee_message_type_filter_by',
+				'html_id'    => 'ee_message_type_filter_by',
+				'html_class' => 'wide',
+				'default'    => $this->request->getRequestParam('ee_message_type_filter_by', 'none_selected', 'title'),
+			]
+		);
+
+		return $input->get_html_for_input();
+	}
+
+
+	/**
+	 * Generate select input with provide message type contexts array.
+	 *
+	 * @param array $context_options Array of message type contexts indexed by context slug, and values are the
+	 *                               context label.
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function get_contexts_for_message_types_select_input($context_options)
+	{
+		// if empty or count of options is one then just return empty string
+		if (
+			empty($context_options)
+			|| ! is_array($context_options)
+			|| count($context_options) === 1
+		) {
+			return '';
+		}
+		// merge in default
+		$context_options = array_merge(
+			['none_selected' => esc_html__('Show all Contexts', 'event_espresso')],
+			$context_options
+		);
+		$input           = new EE_Select_Input(
+			$context_options,
+			[
+				'html_name'  => 'ee_context_filter_by',
+				'html_id'    => 'ee_context_filter_by',
+				'html_class' => 'wide',
+				'default'    => $this->request->getRequestParam('ee_context_filter_by', 'none_selected', 'title'),
+			]
+		);
+
+		return $input->get_html_for_input();
+	}
+
+
+	protected function _ajax_hooks()
+	{
+		add_action('wp_ajax_activate_messenger', [$this, 'activate_messenger_toggle']);
+		add_action('wp_ajax_activate_mt', [$this, 'activate_mt_toggle']);
+		add_action('wp_ajax_ee_msgs_save_settings', [$this, 'save_settings']);
+		add_action('wp_ajax_ee_msgs_update_mt_form', [$this, 'update_mt_form']);
+		add_action('wp_ajax_switch_template_pack', [$this, 'switch_template_pack']);
+		add_action('wp_ajax_toggle_context_template', [$this, 'toggle_context_template']);
+	}
+
+
+	protected function _define_page_props()
+	{
+		$this->_admin_page_title = $this->page_label;
+		$this->_labels           = [
+			'buttons'    => [
+				'add'    => esc_html__('Add New Message Template', 'event_espresso'),
+				'edit'   => esc_html__('Edit Message Template', 'event_espresso'),
+				'delete' => esc_html__('Delete Message Template', 'event_espresso'),
+			],
+			'publishbox' => esc_html__('Update Actions', 'event_espresso'),
+		];
+	}
+
+
+	/**
+	 *        an array for storing key => value pairs of request actions and their corresponding methods
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _set_page_routes()
+	{
+		$GRP_ID = $this->request->getRequestParam('GRP_ID', 0, 'int');
+		$GRP_ID = $this->request->getRequestParam('id', $GRP_ID, 'int');
+		$MSG_ID = $this->request->getRequestParam('MSG_ID', 0, 'int');
+
+		$this->_page_routes = [
+			'default'                          => [
+				'func'       => '_message_queue_list_table',
+				'capability' => 'ee_read_global_messages',
+			],
+			'global_mtps'                      => [
+				'func'       => '_ee_default_messages_overview_list_table',
+				'capability' => 'ee_read_global_messages',
+			],
+			'custom_mtps'                      => [
+				'func'       => '_custom_mtps_preview',
+				'capability' => 'ee_read_messages',
+			],
+			'add_new_message_template'         => [
+				'func'       => '_add_message_template',
+				'capability' => 'ee_edit_messages',
+				'noheader'   => true,
+			],
+			'edit_message_template'            => [
+				'func'       => '_edit_message_template',
+				'capability' => 'ee_edit_message',
+				'obj_id'     => $GRP_ID,
+			],
+			'preview_message'                  => [
+				'func'               => '_preview_message',
+				'capability'         => 'ee_read_message',
+				'obj_id'             => $GRP_ID,
+				'noheader'           => true,
+				'headers_sent_route' => 'display_preview_message',
+			],
+			'display_preview_message'          => [
+				'func'       => '_display_preview_message',
+				'capability' => 'ee_read_message',
+				'obj_id'     => $GRP_ID,
+			],
+			'insert_message_template'          => [
+				'func'       => '_insert_or_update_message_template',
+				'capability' => 'ee_edit_messages',
+				'args'       => ['new' => true],
+				'noheader'   => true,
+			],
+			'update_message_template'          => [
+				'func'       => '_insert_or_update_message_template',
+				'capability' => 'ee_edit_message',
+				'obj_id'     => $GRP_ID,
+				'args'       => ['new' => false],
+				'noheader'   => true,
+			],
+			'trash_message_template'           => [
+				'func'       => '_trash_or_restore_message_template',
+				'capability' => 'ee_delete_message',
+				'obj_id'     => $GRP_ID,
+				'args'       => ['trash' => true, 'all' => true],
+				'noheader'   => true,
+			],
+			'trash_message_template_context'   => [
+				'func'       => '_trash_or_restore_message_template',
+				'capability' => 'ee_delete_message',
+				'obj_id'     => $GRP_ID,
+				'args'       => ['trash' => true],
+				'noheader'   => true,
+			],
+			'restore_message_template'         => [
+				'func'       => '_trash_or_restore_message_template',
+				'capability' => 'ee_delete_message',
+				'obj_id'     => $GRP_ID,
+				'args'       => ['trash' => false, 'all' => true],
+				'noheader'   => true,
+			],
+			'restore_message_template_context' => [
+				'func'       => '_trash_or_restore_message_template',
+				'capability' => 'ee_delete_message',
+				'obj_id'     => $GRP_ID,
+				'args'       => ['trash' => false],
+				'noheader'   => true,
+			],
+			'delete_message_template'          => [
+				'func'       => '_delete_message_template',
+				'capability' => 'ee_delete_message',
+				'obj_id'     => $GRP_ID,
+				'noheader'   => true,
+			],
+			'reset_to_default'                 => [
+				'func'       => '_reset_to_default_template',
+				'capability' => 'ee_edit_message',
+				'obj_id'     => $GRP_ID,
+				'noheader'   => true,
+			],
+			'settings'                         => [
+				'func'       => '_settings',
+				'capability' => 'manage_options',
+			],
+			'update_global_settings'           => [
+				'func'       => '_update_global_settings',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+			],
+			'generate_now'                     => [
+				'func'       => '_generate_now',
+				'capability' => 'ee_send_message',
+				'noheader'   => true,
+			],
+			'generate_and_send_now'            => [
+				'func'       => '_generate_and_send_now',
+				'capability' => 'ee_send_message',
+				'noheader'   => true,
+			],
+			'queue_for_resending'              => [
+				'func'       => '_queue_for_resending',
+				'capability' => 'ee_send_message',
+				'noheader'   => true,
+			],
+			'send_now'                         => [
+				'func'       => '_send_now',
+				'capability' => 'ee_send_message',
+				'noheader'   => true,
+			],
+			'delete_ee_message'                => [
+				'func'       => '_delete_ee_messages',
+				'capability' => 'ee_delete_messages',
+				'noheader'   => true,
+			],
+			'delete_ee_messages'               => [
+				'func'       => '_delete_ee_messages',
+				'capability' => 'ee_delete_messages',
+				'noheader'   => true,
+				'obj_id'     => $MSG_ID,
+			],
+		];
+	}
+
+
+	protected function _set_page_config()
+	{
+		$this->_page_config = [
+			'default'                  => [
+				'nav'           => [
+					'label' => esc_html__('Message Activity', 'event_espresso'),
+					'order' => 10,
+				],
+				'list_table'    => 'EE_Message_List_Table',
+				// 'qtips' => array( 'EE_Message_List_Table_Tips' ),
+				'require_nonce' => false,
+			],
+			'global_mtps'              => [
+				'nav'           => [
+					'label' => esc_html__('Default Message Templates', 'event_espresso'),
+					'order' => 20,
+				],
+				'list_table'    => 'Messages_Template_List_Table',
+				'help_tabs'     => [
+					'messages_overview_help_tab'                                => [
+						'title'    => esc_html__('Messages Overview', 'event_espresso'),
+						'filename' => 'messages_overview',
+					],
+					'messages_overview_messages_table_column_headings_help_tab' => [
+						'title'    => esc_html__('Messages Table Column Headings', 'event_espresso'),
+						'filename' => 'messages_overview_table_column_headings',
+					],
+					'messages_overview_messages_filters_help_tab'               => [
+						'title'    => esc_html__('Message Filters', 'event_espresso'),
+						'filename' => 'messages_overview_filters',
+					],
+					'messages_overview_messages_views_help_tab'                 => [
+						'title'    => esc_html__('Message Views', 'event_espresso'),
+						'filename' => 'messages_overview_views',
+					],
+					'message_overview_message_types_help_tab'                   => [
+						'title'    => esc_html__('Message Types', 'event_espresso'),
+						'filename' => 'messages_overview_types',
+					],
+					'messages_overview_messengers_help_tab'                     => [
+						'title'    => esc_html__('Messengers', 'event_espresso'),
+						'filename' => 'messages_overview_messengers',
+					],
+				],
+				// disabled temporarily. see: https://github.com/eventespresso/eventsmart.com-website/issues/836
+				// 'help_tour'     => array('Messages_Overview_Help_Tour'),
+				'require_nonce' => false,
+			],
+			'custom_mtps'              => [
+				'nav'           => [
+					'label' => esc_html__('Custom Message Templates', 'event_espresso'),
+					'order' => 30,
+				],
+				'help_tabs'     => [],
+				// disabled temporarily. see: https://github.com/eventespresso/eventsmart.com-website/issues/836
+				// 'help_tour'     => array(),
+				'require_nonce' => false,
+			],
+			'add_new_message_template' => [
+				'nav'           => [
+					'label'      => esc_html__('Add New Message Templates', 'event_espresso'),
+					'order'      => 5,
+					'persistent' => false,
+				],
+				'require_nonce' => false,
+			],
+			'edit_message_template'    => [
+				'labels'        => [
+					'buttons'    => [
+						'reset' => esc_html__('Reset Templates', 'event_espresso'),
+					],
+					'publishbox' => esc_html__('Update Actions', 'event_espresso'),
+				],
+				'nav'           => [
+					'label'      => esc_html__('Edit Message Templates', 'event_espresso'),
+					'order'      => 5,
+					'persistent' => false,
+					'url'        => '',
+				],
+				'metaboxes'     => ['_publish_post_box', '_register_edit_meta_boxes'],
+				'has_metaboxes' => true,
+				// disabled temporarily. see: https://github.com/eventespresso/eventsmart.com-website/issues/836
+				// 'help_tour'     => array('Message_Templates_Edit_Help_Tour'),
+				'help_tabs'     => [
+					'edit_message_template'            => [
+						'title'    => esc_html__('Message Template Editor', 'event_espresso'),
+						'callback' => 'edit_message_template_help_tab',
+					],
+					'message_templates_help_tab'       => [
+						'title'    => esc_html__('Message Templates', 'event_espresso'),
+						'filename' => 'messages_templates',
+					],
+					'message_template_shortcodes'      => [
+						'title'    => esc_html__('Message Shortcodes', 'event_espresso'),
+						'callback' => 'message_template_shortcodes_help_tab',
+					],
+					'message_preview_help_tab'         => [
+						'title'    => esc_html__('Message Preview', 'event_espresso'),
+						'filename' => 'messages_preview',
+					],
+					'messages_overview_other_help_tab' => [
+						'title'    => esc_html__('Messages Other', 'event_espresso'),
+						'filename' => 'messages_overview_other',
+					],
+				],
+				'require_nonce' => false,
+			],
+			'display_preview_message'  => [
+				'nav'           => [
+					'label'      => esc_html__('Message Preview', 'event_espresso'),
+					'order'      => 5,
+					'url'        => '',
+					'persistent' => false,
+				],
+				'help_tabs'     => [
+					'preview_message' => [
+						'title'    => esc_html__('About Previews', 'event_espresso'),
+						'callback' => 'preview_message_help_tab',
+					],
+				],
+				'require_nonce' => false,
+			],
+			'settings'                 => [
+				'nav'           => [
+					'label' => esc_html__('Settings', 'event_espresso'),
+					'order' => 40,
+				],
+				'metaboxes'     => ['_messages_settings_metaboxes'],
+				'help_tabs'     => [
+					'messages_settings_help_tab'               => [
+						'title'    => esc_html__('Messages Settings', 'event_espresso'),
+						'filename' => 'messages_settings',
+					],
+					'messages_settings_message_types_help_tab' => [
+						'title'    => esc_html__('Activating / Deactivating Message Types', 'event_espresso'),
+						'filename' => 'messages_settings_message_types',
+					],
+					'messages_settings_messengers_help_tab'    => [
+						'title'    => esc_html__('Activating / Deactivating Messengers', 'event_espresso'),
+						'filename' => 'messages_settings_messengers',
+					],
+				],
+				// disabled temporarily. see: https://github.com/eventespresso/eventsmart.com-website/issues/836
+				// 'help_tour'     => array('Messages_Settings_Help_Tour'),
+				'require_nonce' => false,
+			],
+		];
+	}
+
+
+	protected function _add_screen_options()
+	{
+		// todo
+	}
+
+
+	protected function _add_screen_options_global_mtps()
+	{
+		/**
+		 * Note: the reason for the value swap here on $this->_admin_page_title is because $this->_per_page_screen_options
+		 * uses the $_admin_page_title property and we want different outputs in the different spots.
+		 */
+		$page_title              = $this->_admin_page_title;
+		$this->_admin_page_title = esc_html__('Global Message Templates', 'event_espresso');
+		$this->_per_page_screen_option();
+		$this->_admin_page_title = $page_title;
+	}
+
+
+	protected function _add_screen_options_default()
+	{
+		$this->_admin_page_title = esc_html__('Message Activity', 'event_espresso');
+		$this->_per_page_screen_option();
+	}
+
+
+	// none of the below group are currently used for Messages
+	protected function _add_feature_pointers()
+	{
+	}
+
+
+	public function admin_init()
+	{
+	}
+
+
+	public function admin_notices()
+	{
+	}
+
+
+	public function admin_footer_scripts()
+	{
+	}
+
+
+	public function messages_help_tab()
+	{
+		EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_messages_help_tab.template.php');
+	}
+
+
+	public function messengers_help_tab()
+	{
+		EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_messenger_help_tab.template.php');
+	}
+
+
+	public function message_types_help_tab()
+	{
+		EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_message_type_help_tab.template.php');
+	}
+
+
+	public function messages_overview_help_tab()
+	{
+		EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_overview_help_tab.template.php');
+	}
+
+
+	public function message_templates_help_tab()
+	{
+		EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_message_templates_help_tab.template.php');
+	}
+
+
+	public function edit_message_template_help_tab()
+	{
+		$args['img1'] = '<img src="' . EE_MSG_ASSETS_URL . 'images/editor.png' . '" alt="'
+						. esc_attr__('Editor Title', 'event_espresso')
+						. '" />';
+		$args['img2'] = '<img src="' . EE_MSG_ASSETS_URL . 'images/switch-context.png' . '" alt="'
+						. esc_attr__('Context Switcher and Preview', 'event_espresso')
+						. '" />';
+		$args['img3'] = '<img class="left" src="' . EE_MSG_ASSETS_URL . 'images/form-fields.png' . '" alt="'
+						. esc_attr__('Message Template Form Fields', 'event_espresso')
+						. '" />';
+		$args['img4'] = '<img class="right" src="' . EE_MSG_ASSETS_URL . 'images/shortcodes-metabox.png' . '" alt="'
+						. esc_attr__('Shortcodes Metabox', 'event_espresso')
+						. '" />';
+		$args['img5'] = '<img class="right" src="' . EE_MSG_ASSETS_URL . 'images/publish-meta-box.png' . '" alt="'
+						. esc_attr__('Publish Metabox', 'event_espresso')
+						. '" />';
+		EEH_Template::display_template(
+			EE_MSG_TEMPLATE_PATH . 'ee_msg_messages_templates_editor_help_tab.template.php',
+			$args
+		);
+	}
+
+
+	/**
+	 * @throws ReflectionException
+	 * @throws EE_Error
+	 */
+	public function message_template_shortcodes_help_tab()
+	{
+		$this->_set_shortcodes();
+		$args['shortcodes'] = $this->_shortcodes;
+		EEH_Template::display_template(
+			EE_MSG_TEMPLATE_PATH . 'ee_msg_messages_shortcodes_help_tab.template.php',
+			$args
+		);
+	}
+
+
+	public function preview_message_help_tab()
+	{
+		EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_preview_help_tab.template.php');
+	}
+
+
+	public function settings_help_tab()
+	{
+		$args['img1'] = '<img class="inline-text" src="' . EE_MSG_ASSETS_URL . 'images/email-tab-active.png'
+						. '" alt="' . esc_attr__('Active Email Tab', 'event_espresso') . '" />';
+		$args['img2'] = '<img class="inline-text" src="' . EE_MSG_ASSETS_URL . 'images/email-tab-inactive.png'
+						. '" alt="' . esc_attr__('Inactive Email Tab', 'event_espresso') . '" />';
+		$args['img3'] = '<div class="switch">'
+						. '<input class="ee-on-off-toggle ee-toggle-round-flat"'
+						. ' type="checkbox" checked="checked">'
+						. '<label for="ee-on-off-toggle-on"></label>'
+						. '</div>';
+		$args['img4'] = '<div class="switch">'
+						. '<input class="ee-on-off-toggle ee-toggle-round-flat"'
+						. ' type="checkbox">'
+						. '<label for="ee-on-off-toggle-on"></label>'
+						. '</div>';
+		EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_messages_settings_help_tab.template.php', $args);
+	}
+
+
+	public function load_scripts_styles()
+	{
+		wp_register_style('espresso_ee_msg', EE_MSG_ASSETS_URL . 'ee_message_admin.css', EVENT_ESPRESSO_VERSION);
+		wp_enqueue_style('espresso_ee_msg');
+
+		wp_register_script(
+			'ee-messages-settings',
+			EE_MSG_ASSETS_URL . 'ee-messages-settings.js',
+			['jquery-ui-droppable', 'ee-serialize-full-array'],
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_register_script(
+			'ee-msg-list-table-js',
+			EE_MSG_ASSETS_URL . 'ee_message_admin_list_table.js',
+			['ee-dialog'],
+			EVENT_ESPRESSO_VERSION
+		);
+	}
+
+
+	public function load_scripts_styles_default()
+	{
+		wp_enqueue_script('ee-msg-list-table-js');
+	}
+
+
+	public function wp_editor_css($mce_css)
+	{
+		// if we're on the edit_message_template route
+		if ($this->_req_action === 'edit_message_template' && $this->_active_messenger instanceof EE_messenger) {
+			$message_type_name = $this->_active_message_type_name;
+
+			// we're going to REPLACE the existing mce css
+			// we need to get the css file location from the active messenger
+			$mce_css = $this->_active_messenger->get_variation(
+				$this->_template_pack,
+				$message_type_name,
+				true,
+				'wpeditor',
+				$this->_variation
+			);
+		}
+
+		return $mce_css;
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function load_scripts_styles_edit_message_template()
+	{
+
+		$this->_set_shortcodes();
+
+		EE_Registry::$i18n_js_strings['confirm_default_reset']        = sprintf(
+			esc_html__(
+				'Are you sure you want to reset the %s %s message templates?  Remember continuing will reset the templates for all contexts in this messenger and message type group.',
+				'event_espresso'
+			),
+			$this->_message_template_group->messenger_obj()->label['singular'],
+			$this->_message_template_group->message_type_obj()->label['singular']
+		);
+		EE_Registry::$i18n_js_strings['confirm_switch_template_pack'] = esc_html__(
+			'Switching the template pack for a messages template will reset the content for the template so the new layout is loaded.  Any custom content in the existing template will be lost. Are you sure you wish to do this?',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['server_error']                 = esc_html__(
+			'An unknown error occurred on the server while attempting to process your request. Please refresh the page and try again or contact support.',
+			'event_espresso'
+		);
+
+		wp_register_script(
+			'ee_msgs_edit_js',
+			EE_MSG_ASSETS_URL . 'ee_message_editor.js',
+			['jquery'],
+			EVENT_ESPRESSO_VERSION
+		);
+
+		wp_enqueue_script('ee_admin_js');
+		wp_enqueue_script('ee_msgs_edit_js');
+
+		// add in special css for tiny_mce
+		add_filter('mce_css', [$this, 'wp_editor_css']);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function load_scripts_styles_display_preview_message()
+	{
+		$this->_set_message_template_group();
+		if ($this->_active_messenger_name) {
+			$this->_active_messenger = $this->_message_resource_manager->get_active_messenger(
+				$this->_active_messenger_name
+			);
+		}
+
+		wp_enqueue_style(
+			'espresso_preview_css',
+			$this->_active_messenger->get_variation(
+				$this->_template_pack,
+				$this->_active_message_type_name,
+				true,
+				'preview',
+				$this->_variation
+			)
+		);
+	}
+
+
+	public function load_scripts_styles_settings()
+	{
+		wp_register_style(
+			'ee-message-settings',
+			EE_MSG_ASSETS_URL . 'ee_message_settings.css',
+			[],
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_style('ee-text-links');
+		wp_enqueue_style('ee-message-settings');
+		wp_enqueue_script('ee-messages-settings');
+	}
+
+
+	/**
+	 * set views array for List Table
+	 */
+	public function _set_list_table_views_global_mtps()
+	{
+		$this->_views = [
+			'in_use' => [
+				'slug'  => 'in_use',
+				'label' => esc_html__('In Use', 'event_espresso'),
+				'count' => 0,
+			],
+		];
+	}
+
+
+	/**
+	 * Set views array for the Custom Template List Table
+	 */
+	public function _set_list_table_views_custom_mtps()
+	{
+		$this->_set_list_table_views_global_mtps();
+		$this->_views['in_use']['bulk_action'] = [
+			'trash_message_template' => esc_html__('Move to Trash', 'event_espresso'),
+		];
+	}
+
+
+	/**
+	 * set views array for message queue list table
+	 *
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function _set_list_table_views_default()
+	{
+		EE_Registry::instance()->load_helper('Template');
+
+		$common_bulk_actions = EE_Registry::instance()->CAP->current_user_can(
+			'ee_send_message',
+			'message_list_table_bulk_actions'
+		)
+			? [
+				'generate_now'          => esc_html__('Generate Now', 'event_espresso'),
+				'generate_and_send_now' => esc_html__('Generate and Send Now', 'event_espresso'),
+				'queue_for_resending'   => esc_html__('Queue for Resending', 'event_espresso'),
+				'send_now'              => esc_html__('Send Now', 'event_espresso'),
+			]
+			: [];
+
+		$delete_bulk_action = EE_Registry::instance()->CAP->current_user_can(
+			'ee_delete_messages',
+			'message_list_table_bulk_actions'
+		)
+			? ['delete_ee_messages' => esc_html__('Delete Messages', 'event_espresso')]
+			: [];
+
+
+		$this->_views = [
+			'all' => [
+				'slug'        => 'all',
+				'label'       => esc_html__('All', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => array_merge($common_bulk_actions, $delete_bulk_action),
+			],
+		];
+
+
+		foreach (EEM_Message::instance()->all_statuses() as $status) {
+			if ($status === EEM_Message::status_debug_only && ! EEM_Message::debug()) {
+				continue;
+			}
+			$status_bulk_actions = $common_bulk_actions;
+			// unset bulk actions not applying to status
+			if (! empty($status_bulk_actions)) {
+				switch ($status) {
+					case EEM_Message::status_idle:
+					case EEM_Message::status_resend:
+						$status_bulk_actions['send_now'] = $common_bulk_actions['send_now'];
+						break;
+
+					case EEM_Message::status_failed:
+					case EEM_Message::status_debug_only:
+					case EEM_Message::status_messenger_executing:
+						$status_bulk_actions = [];
+						break;
+
+					case EEM_Message::status_incomplete:
+						unset($status_bulk_actions['queue_for_resending'], $status_bulk_actions['send_now']);
+						break;
+
+					case EEM_Message::status_retry:
+					case EEM_Message::status_sent:
+						unset($status_bulk_actions['generate_now'], $status_bulk_actions['generate_and_send_now']);
+						break;
+				}
+			}
+
+			// skip adding messenger executing status to views because it will be included with the Failed view.
+			if ($status === EEM_Message::status_messenger_executing) {
+				continue;
+			}
+
+			$this->_views[ strtolower($status) ] = [
+				'slug'        => strtolower($status),
+				'label'       => EEH_Template::pretty_status($status, false, 'sentence'),
+				'count'       => 0,
+				'bulk_action' => array_merge($status_bulk_actions, $delete_bulk_action),
+			];
+		}
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 */
+	protected function _ee_default_messages_overview_list_table()
+	{
+		$this->_admin_page_title = esc_html__('Default Message Templates', 'event_espresso');
+		$this->display_admin_list_table_page_with_no_sidebar();
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _message_queue_list_table()
+	{
+		$this->_search_btn_label                   = esc_html__('Message Activity', 'event_espresso');
+		$this->_template_args['per_column']        = 6;
+		$this->_template_args['after_list_table']  = $this->_display_legend($this->_message_legend_items());
+		$this->_template_args['before_list_table'] = '<h3>'
+													 . EEM_Message::instance()->get_pretty_label_for_results()
+													 . '</h3>';
+		$this->display_admin_list_table_page_with_no_sidebar();
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 */
+	protected function _message_legend_items()
+	{
+
+		$action_css_classes = EEH_MSG_Template::get_message_action_icons();
+		$action_items       = [];
+
+		foreach ($action_css_classes as $action_item => $action_details) {
+			if ($action_item === 'see_notifications_for') {
+				continue;
+			}
+			$action_items[ $action_item ] = [
+				'class' => $action_details['css_class'],
+				'desc'  => $action_details['label'],
+			];
+		}
+
+		/** @var array $status_items status legend setup */
+		$status_items = [
+			'sent_status'                => [
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_sent,
+				'desc'  => EEH_Template::pretty_status(EEM_Message::status_sent, false, 'sentence'),
+			],
+			'idle_status'                => [
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_idle,
+				'desc'  => EEH_Template::pretty_status(EEM_Message::status_idle, false, 'sentence'),
+			],
+			'failed_status'              => [
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_failed,
+				'desc'  => EEH_Template::pretty_status(EEM_Message::status_failed, false, 'sentence'),
+			],
+			'messenger_executing_status' => [
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_messenger_executing,
+				'desc'  => EEH_Template::pretty_status(EEM_Message::status_messenger_executing, false, 'sentence'),
+			],
+			'resend_status'              => [
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_resend,
+				'desc'  => EEH_Template::pretty_status(EEM_Message::status_resend, false, 'sentence'),
+			],
+			'incomplete_status'          => [
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_incomplete,
+				'desc'  => EEH_Template::pretty_status(EEM_Message::status_incomplete, false, 'sentence'),
+			],
+			'retry_status'               => [
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_retry,
+				'desc'  => EEH_Template::pretty_status(EEM_Message::status_retry, false, 'sentence'),
+			],
+		];
+		if (EEM_Message::debug()) {
+			$status_items['debug_only_status'] = [
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_debug_only,
+				'desc'  => EEH_Template::pretty_status(EEM_Message::status_debug_only, false, 'sentence'),
+			];
+		}
+
+		return array_merge($action_items, $status_items);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 */
+	protected function _custom_mtps_preview()
+	{
+		$this->_admin_page_title              = esc_html__('Custom Message Templates (Preview)', 'event_espresso');
+		$this->_template_args['preview_img']  = '<img src="' . EE_MSG_ASSETS_URL . 'images/custom_mtps_preview.png"'
+												. ' alt="' . esc_attr__(
+													'Preview Custom Message Templates screenshot',
+													'event_espresso'
+												) . '" />';
+		$this->_template_args['preview_text'] = '<strong>'
+												. esc_html__(
+													'Custom Message Templates is a feature that is only available in the premium version of Event Espresso 4 which is available with a support license purchase on EventEspresso.com. With the Custom Message Templates feature, you are able to create custom message templates and assign them on a per-event basis.',
+													'event_espresso'
+												)
+												. '</strong>';
+
+		$this->display_admin_caf_preview_page('custom_message_types', false);
+	}
+
+
+	/**
+	 * get_message_templates
+	 * This gets all the message templates for listing on the overview list.
+	 *
+	 * @access public
+	 * @param int    $per_page the amount of templates groups to show per page
+	 * @param string $type     the current _view we're getting templates for
+	 * @param bool   $count    return count?
+	 * @param bool   $all      disregard any paging info (get all data);
+	 * @param bool   $global   whether to return just global (true) or custom templates (false)
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function get_message_templates(
+		$per_page = 10,
+		$type = 'in_use',
+		$count = false,
+		$all = false,
+		$global = true
+	) {
+
+		$MTP = EEM_Message_Template_Group::instance();
+
+		$orderby = $this->request->getRequestParam('orderby', 'GRP_ID');
+		$this->request->setRequestParam('orderby', $orderby);
+
+		$order        = $this->request->getRequestParam('order', 'ASC');
+		$current_page = $this->request->getRequestParam('paged', 1, 'int');
+		$per_page     = $this->request->getRequestParam('perpage', $per_page, 'int');
+
+		$offset = ($current_page - 1) * $per_page;
+		$limit  = $all ? null : [$offset, $per_page];
+
+		// options will match what is in the _views array property
+		switch ($type) {
+			case 'in_use':
+				$templates = $MTP->get_all_active_message_templates($orderby, $order, $limit, $count, $global, true);
+				break;
+			default:
+				$templates = $MTP->get_all_trashed_grouped_message_templates($orderby, $order, $limit, $count, $global);
+		}
+
+		return $templates;
+	}
+
+
+	/**
+	 * filters etc might need a list of installed message_types
+	 *
+	 * @return array an array of message type objects
+	 */
+	public function get_installed_message_types()
+	{
+		$installed_message_types = $this->_message_resource_manager->installed_message_types();
+		$installed               = [];
+
+		foreach ($installed_message_types as $message_type) {
+			$installed[ $message_type->name ] = $message_type;
+		}
+
+		return $installed;
+	}
+
+
+	/**
+	 * _add_message_template
+	 *
+	 * This is used when creating a custom template. All Custom Templates start based off another template.
+	 *
+	 * @param string $message_type
+	 * @param string $messenger
+	 * @param string $GRP_ID
+	 *
+	 * @throws EE_error
+	 * @throws ReflectionException
+	 */
+	protected function _add_message_template($message_type = '', $messenger = '', $GRP_ID = '')
+	{
+		// set values override any request data
+		$message_type = ! empty($message_type) ? $message_type : $this->_active_message_type_name;
+		$messenger    = ! empty($messenger) ? $messenger : $this->_active_messenger_name;
+		$GRP_ID       = ! empty($GRP_ID) ? $GRP_ID : $this->request->getRequestParam('GRP_ID', 0, 'int');
+
+		// we need messenger and message type.  They should be coming from the event editor. If not here then return error
+		if (empty($message_type) || empty($messenger)) {
+			throw new EE_Error(
+				esc_html__(
+					'Sorry, but we can\'t create new templates because we\'re missing the messenger or message type',
+					'event_espresso'
+				)
+			);
+		}
+
+		// we need the GRP_ID for the template being used as the base for the new template
+		if (empty($GRP_ID)) {
+			throw new EE_Error(
+				esc_html__(
+					'In order to create a custom message template the GRP_ID of the template being used as a base is needed',
+					'event_espresso'
+				)
+			);
+		}
+
+		// let's just make sure the template gets generated!
+
+		// we need to reassign some variables for what the insert is expecting
+		$this->request->setRequestParam('MTP_messenger', $messenger);
+		$this->request->setRequestParam('MTP_message_type', $message_type);
+		$this->request->setRequestParam('GRP_ID', $GRP_ID);
+
+		$this->_insert_or_update_message_template(true);
+	}
+
+
+	/**
+	 * public wrapper for the _add_message_template method
+	 *
+	 * @param string $message_type     message type slug
+	 * @param string $messenger        messenger slug
+	 * @param int    $GRP_ID           GRP_ID for the related message template group this new template will be based
+	 *                                 off of.
+	 * @throws EE_error
+	 * @throws ReflectionException
+	 */
+	public function add_message_template($message_type, $messenger, $GRP_ID)
+	{
+		$this->_add_message_template($message_type, $messenger, $GRP_ID);
+	}
+
+
+	/**
+	 * _edit_message_template
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws InvalidIdentifierException
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _edit_message_template()
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$template_fields = '';
+		$sidebar_fields  = '';
+		// we filter the tinyMCE settings to remove the validation since message templates by their nature will not have
+		// valid html in the templates.
+		add_filter('tiny_mce_before_init', [$this, 'filter_tinymce_init'], 10, 2);
+
+		$GRP_ID = $this->request->getRequestParam('id', 0, 'int');
+		$EVT_ID = $this->request->getRequestParam('evt_id', 0, 'int');
+
+		$this->_set_shortcodes(); // this also sets the _message_template property.
+		$message_template_group = $this->_message_template_group;
+		$c_label                = $message_template_group->context_label();
+		$c_config               = $message_template_group->contexts_config();
+
+		reset($c_config);
+		$context = $this->request->getRequestParam('context', key($c_config));
+		$context = strtolower($context);
+
+		$action = empty($GRP_ID) ? 'insert_message_template' : 'update_message_template';
+
+		$edit_message_template_form_url = add_query_arg(
+			['action' => $action, 'noheader' => true],
+			EE_MSG_ADMIN_URL
+		);
+
+		// set active messenger for this view
+		$this->_active_messenger         = $this->_message_resource_manager->get_active_messenger(
+			$message_template_group->messenger()
+		);
+		$this->_active_message_type_name = $message_template_group->message_type();
+
+
+		// Do we have any validation errors?
+		$validators = $this->_get_transient();
+		$v_fields   = ! empty($validators) ? array_keys($validators) : [];
+
+
+		// we need to assemble the title from Various details
+		$context_label = sprintf(
+			esc_html__('(%s %s)', 'event_espresso'),
+			$c_config[ $context ]['label'],
+			ucwords($c_label['label'])
+		);
+
+		$title = sprintf(
+			esc_html__(' %s %s Template %s', 'event_espresso'),
+			ucwords($message_template_group->messenger_obj()->label['singular']),
+			ucwords($message_template_group->message_type_obj()->label['singular']),
+			$context_label
+		);
+
+		$this->_template_args['GRP_ID']           = $GRP_ID;
+		$this->_template_args['message_template'] = $message_template_group;
+		$this->_template_args['is_extra_fields']  = false;
+
+
+		// let's get EEH_MSG_Template so we can get template form fields
+		$template_field_structure = EEH_MSG_Template::get_fields(
+			$message_template_group->messenger(),
+			$message_template_group->message_type()
+		);
+
+		if (! $template_field_structure) {
+			$template_field_structure = false;
+			$template_fields          = esc_html__(
+				'There was an error in assembling the fields for this display (you should see an error message)',
+				'event_espresso'
+			);
+		}
+
+
+		$message_templates = $message_template_group->context_templates();
+
+
+		// if we have the extra key.. then we need to remove the content index from the template_field_structure as it
+		// will get handled in the "extra" array.
+		if (is_array($template_field_structure[ $context ]) && isset($template_field_structure[ $context ]['extra'])) {
+			foreach ($template_field_structure[ $context ]['extra'] as $reference_field => $new_fields) {
+				unset($template_field_structure[ $context ][ $reference_field ]);
+			}
+		}
+
+		// let's loop through the template_field_structure and actually assemble the input fields!
+		if (! empty($template_field_structure)) {
+			foreach ($template_field_structure[ $context ] as $template_field => $field_setup_array) {
+				// if this is an 'extra' template field then we need to remove any existing fields that are keyed up in
+				// the extra array and reset them.
+				if ($template_field === 'extra') {
+					$this->_template_args['is_extra_fields'] = true;
+					foreach ($field_setup_array as $reference_field => $new_fields_array) {
+						$message_template = $message_templates[ $context ][ $reference_field ];
+						$content          = $message_template instanceof EE_Message_Template
+							? $message_template->get('MTP_content')
+							: '';
+						foreach ($new_fields_array as $extra_field => $extra_array) {
+							// let's verify if we need this extra field via the shortcodes parameter.
+							$continue = false;
+							if (isset($extra_array['shortcodes_required'])) {
+								foreach ((array) $extra_array['shortcodes_required'] as $shortcode) {
+									if (! array_key_exists($shortcode, $this->_shortcodes)) {
+										$continue = true;
+									}
+								}
+								if ($continue) {
+									continue;
+								}
+							}
+
+							$field_id                                  = $reference_field
+																		 . '-'
+																		 . $extra_field
+																		 . '-content';
+							$template_form_fields[ $field_id ]         = $extra_array;
+							$template_form_fields[ $field_id ]['name'] = 'MTP_template_fields['
+																		 . $reference_field
+																		 . '][content]['
+																		 . $extra_field . ']';
+							$css_class                                 = isset($extra_array['css_class'])
+								? $extra_array['css_class']
+								: '';
+
+							$template_form_fields[ $field_id ]['css_class'] = ! empty($v_fields)
+																			  && in_array($extra_field, $v_fields, true)
+																			  && (
+																				  is_array($validators[ $extra_field ])
+																				  && isset($validators[ $extra_field ]['msg'])
+																			  )
+								? 'validate-error ' . $css_class
+								: $css_class;
+
+							$template_form_fields[ $field_id ]['value'] = ! empty($message_templates)
+																		  && isset($content[ $extra_field ])
+								? $content[ $extra_field ]
+								: '';
+
+							// do we have a validation error?  if we do then let's use that value instead
+							$template_form_fields[ $field_id ]['value'] = isset($validators[ $extra_field ])
+								? $validators[ $extra_field ]['value']
+								: $template_form_fields[ $field_id ]['value'];
+
+
+							$template_form_fields[ $field_id ]['db-col'] = 'MTP_content';
+
+							// shortcode selector
+							$field_name_to_use                                   = $extra_field === 'main'
+								? 'content'
+								: $extra_field;
+							$template_form_fields[ $field_id ]['append_content'] = $this->_get_shortcode_selector(
+								$field_name_to_use,
+								$field_id
+							);
+						}
+						$template_field_MTP_id           = $reference_field . '-MTP_ID';
+						$template_field_template_name_id = $reference_field . '-name';
+
+						$template_form_fields[ $template_field_MTP_id ] = [
+							'name'       => 'MTP_template_fields[' . $reference_field . '][MTP_ID]',
+							'label'      => null,
+							'input'      => 'hidden',
+							'type'       => 'int',
+							'required'   => false,
+							'validation' => false,
+							'value'      => ! empty($message_templates) ? $message_template->ID() : '',
+							'css_class'  => '',
+							'format'     => '%d',
+							'db-col'     => 'MTP_ID',
+						];
+
+						$template_form_fields[ $template_field_template_name_id ] = [
+							'name'       => 'MTP_template_fields[' . $reference_field . '][name]',
+							'label'      => null,
+							'input'      => 'hidden',
+							'type'       => 'string',
+							'required'   => false,
+							'validation' => true,
+							'value'      => $reference_field,
+							'css_class'  => '',
+							'format'     => '%s',
+							'db-col'     => 'MTP_template_field',
+						];
+					}
+					continue; // skip the next stuff, we got the necessary fields here for this dataset.
+				} else {
+					$field_id                                   = $template_field . '-content';
+					$template_form_fields[ $field_id ]          = $field_setup_array;
+					$template_form_fields[ $field_id ]['name']  =
+						'MTP_template_fields[' . $template_field . '][content]';
+					$message_template                           =
+						isset($message_templates[ $context ][ $template_field ])
+							? $message_templates[ $context ][ $template_field ]
+							: null;
+					$template_form_fields[ $field_id ]['value'] = ! empty($message_templates)
+																  && is_array($message_templates[ $context ])
+																  && $message_template instanceof EE_Message_Template
+						? $message_template->get('MTP_content')
+						: '';
+
+					// do we have a validator error for this field?  if we do then we'll use that value instead
+					$template_form_fields[ $field_id ]['value'] = isset($validators[ $template_field ])
+						? $validators[ $template_field ]['value']
+						: $template_form_fields[ $field_id ]['value'];
+
+
+					$template_form_fields[ $field_id ]['db-col']    = 'MTP_content';
+					$css_class                                      = isset($field_setup_array['css_class'])
+						? $field_setup_array['css_class']
+						: '';
+					$template_form_fields[ $field_id ]['css_class'] = ! empty($v_fields)
+																	  && in_array($template_field, $v_fields, true)
+																	  && isset($validators[ $template_field ]['msg'])
+						? 'validate-error ' . $css_class
+						: $css_class;
+
+					// shortcode selector
+					$template_form_fields[ $field_id ]['append_content'] = $this->_get_shortcode_selector(
+						$template_field,
+						$field_id
+					);
+				}
+
+				// k took care of content field(s) now let's take care of others.
+
+				$template_field_MTP_id                 = $template_field . '-MTP_ID';
+				$template_field_field_template_name_id = $template_field . '-name';
+
+				// foreach template field there are actually two form fields created
+				$template_form_fields[ $template_field_MTP_id ] = [
+					'name'       => 'MTP_template_fields[' . $template_field . '][MTP_ID]',
+					'label'      => null,
+					'input'      => 'hidden',
+					'type'       => 'int',
+					'required'   => false,
+					'validation' => true,
+					'value'      => $message_template instanceof EE_Message_Template ? $message_template->ID() : '',
+					'css_class'  => '',
+					'format'     => '%d',
+					'db-col'     => 'MTP_ID',
+				];
+
+				$template_form_fields[ $template_field_field_template_name_id ] = [
+					'name'       => 'MTP_template_fields[' . $template_field . '][name]',
+					'label'      => null,
+					'input'      => 'hidden',
+					'type'       => 'string',
+					'required'   => false,
+					'validation' => true,
+					'value'      => $template_field,
+					'css_class'  => '',
+					'format'     => '%s',
+					'db-col'     => 'MTP_template_field',
+				];
+			}
+
+			// add other fields
+			$template_form_fields['ee-msg-current-context'] = [
+				'name'       => 'MTP_context',
+				'label'      => null,
+				'input'      => 'hidden',
+				'type'       => 'string',
+				'required'   => false,
+				'validation' => true,
+				'value'      => $context,
+				'css_class'  => '',
+				'format'     => '%s',
+				'db-col'     => 'MTP_context',
+			];
+
+			$template_form_fields['ee-msg-grp-id'] = [
+				'name'       => 'GRP_ID',
+				'label'      => null,
+				'input'      => 'hidden',
+				'type'       => 'int',
+				'required'   => false,
+				'validation' => true,
+				'value'      => $GRP_ID,
+				'css_class'  => '',
+				'format'     => '%d',
+				'db-col'     => 'GRP_ID',
+			];
+
+			$template_form_fields['ee-msg-messenger'] = [
+				'name'       => 'MTP_messenger',
+				'label'      => null,
+				'input'      => 'hidden',
+				'type'       => 'string',
+				'required'   => false,
+				'validation' => true,
+				'value'      => $message_template_group->messenger(),
+				'css_class'  => '',
+				'format'     => '%s',
+				'db-col'     => 'MTP_messenger',
+			];
+
+			$template_form_fields['ee-msg-message-type'] = [
+				'name'       => 'MTP_message_type',
+				'label'      => null,
+				'input'      => 'hidden',
+				'type'       => 'string',
+				'required'   => false,
+				'validation' => true,
+				'value'      => $message_template_group->message_type(),
+				'css_class'  => '',
+				'format'     => '%s',
+				'db-col'     => 'MTP_message_type',
+			];
+
+			$sidebar_form_fields['ee-msg-is-global'] = [
+				'name'       => 'MTP_is_global',
+				'label'      => esc_html__('Global Template', 'event_espresso'),
+				'input'      => 'hidden',
+				'type'       => 'int',
+				'required'   => false,
+				'validation' => true,
+				'value'      => $message_template_group->get('MTP_is_global'),
+				'css_class'  => '',
+				'format'     => '%d',
+				'db-col'     => 'MTP_is_global',
+			];
+
+			$sidebar_form_fields['ee-msg-is-override'] = [
+				'name'       => 'MTP_is_override',
+				'label'      => esc_html__('Override all custom', 'event_espresso'),
+				'input'      => $message_template_group->is_global() ? 'checkbox' : 'hidden',
+				'type'       => 'int',
+				'required'   => false,
+				'validation' => true,
+				'value'      => $message_template_group->get('MTP_is_override'),
+				'css_class'  => '',
+				'format'     => '%d',
+				'db-col'     => 'MTP_is_override',
+			];
+
+			$sidebar_form_fields['ee-msg-is-active'] = [
+				'name'       => 'MTP_is_active',
+				'label'      => esc_html__('Active Template', 'event_espresso'),
+				'input'      => 'hidden',
+				'type'       => 'int',
+				'required'   => false,
+				'validation' => true,
+				'value'      => $message_template_group->is_active(),
+				'css_class'  => '',
+				'format'     => '%d',
+				'db-col'     => 'MTP_is_active',
+			];
+
+			$sidebar_form_fields['ee-msg-deleted'] = [
+				'name'       => 'MTP_deleted',
+				'label'      => null,
+				'input'      => 'hidden',
+				'type'       => 'int',
+				'required'   => false,
+				'validation' => true,
+				'value'      => $message_template_group->get('MTP_deleted'),
+				'css_class'  => '',
+				'format'     => '%d',
+				'db-col'     => 'MTP_deleted',
+			];
+			$sidebar_form_fields['ee-msg-author']  = [
+				'name'       => 'MTP_user_id',
+				'label'      => esc_html__('Author', 'event_espresso'),
+				'input'      => 'hidden',
+				'type'       => 'int',
+				'required'   => false,
+				'validation' => false,
+				'value'      => $message_template_group->user(),
+				'format'     => '%d',
+				'db-col'     => 'MTP_user_id',
+			];
+
+			$sidebar_form_fields['ee-msg-route'] = [
+				'name'  => 'action',
+				'input' => 'hidden',
+				'type'  => 'string',
+				'value' => $action,
+			];
+
+			$sidebar_form_fields['ee-msg-id']        = [
+				'name'  => 'id',
+				'input' => 'hidden',
+				'type'  => 'int',
+				'value' => $GRP_ID,
+			];
+			$sidebar_form_fields['ee-msg-evt-nonce'] = [
+				'name'  => $action . '_nonce',
+				'input' => 'hidden',
+				'type'  => 'string',
+				'value' => wp_create_nonce($action . '_nonce'),
+			];
+
+			$template_switch = $this->request->getRequestParam('template_switch');
+			if ($template_switch) {
+				$sidebar_form_fields['ee-msg-template-switch'] = [
+					'name'  => 'template_switch',
+					'input' => 'hidden',
+					'type'  => 'int',
+					'value' => 1,
+				];
+			}
+
+
+			$template_fields = $this->_generate_admin_form_fields($template_form_fields);
+			$sidebar_fields  = $this->_generate_admin_form_fields($sidebar_form_fields);
+		} //end if ( !empty($template_field_structure) )
+
+		// set extra content for publish box
+		$this->_template_args['publish_box_extra_content'] = $sidebar_fields;
+		$this->_set_publish_post_box_vars(
+			'id',
+			$GRP_ID,
+			false,
+			add_query_arg(
+				['action' => 'global_mtps'],
+				$this->_admin_base_url
+			)
+		);
+
+		// add preview button
+		$preview_url    = parent::add_query_args_and_nonce(
+			[
+				'message_type' => $message_template_group->message_type(),
+				'messenger'    => $message_template_group->messenger(),
+				'context'      => $context,
+				'GRP_ID'       => $GRP_ID,
+				'evt_id'       => $EVT_ID,
+				'action'       => 'preview_message',
+			],
+			$this->_admin_base_url
+		);
+		$preview_button = '<a href="' . $preview_url . '" class="button-secondary messages-preview-button">'
+						  . esc_html__('Preview', 'event_espresso')
+						  . '</a>';
+
+
+		// setup context switcher
+		$context_switcher_args = [
+			'page'    => 'espresso_messages',
+			'action'  => 'edit_message_template',
+			'id'      => $GRP_ID,
+			'evt_id'  => $EVT_ID,
+			'context' => $context,
+			'extra'   => $preview_button,
+		];
+		$this->_set_context_switcher($message_template_group, $context_switcher_args);
+
+
+		// main box
+		$this->_template_args['template_fields']                         = $template_fields;
+		$this->_template_args['sidebar_box_id']                          = 'details';
+		$this->_template_args['action']                                  = $action;
+		$this->_template_args['context']                                 = $context;
+		$this->_template_args['edit_message_template_form_url']          = $edit_message_template_form_url;
+		$this->_template_args['learn_more_about_message_templates_link'] =
+			$this->_learn_more_about_message_templates_link();
+
+
+		$this->_template_args['before_admin_page_content'] = $this->add_context_switcher();
+		$this->_template_args['before_admin_page_content'] .= $this->add_active_context_element(
+			$message_template_group,
+			$context,
+			$context_label
+		);
+		$this->_template_args['before_admin_page_content'] .= $this->_add_form_element_before();
+		$this->_template_args['after_admin_page_content']  = $this->_add_form_element_after();
+
+		$this->_template_path = $this->_template_args['GRP_ID']
+			? EE_MSG_TEMPLATE_PATH . 'ee_msg_details_main_edit_meta_box.template.php'
+			: EE_MSG_TEMPLATE_PATH . 'ee_msg_details_main_add_meta_box.template.php';
+
+		// send along EE_Message_Template_Group object for further template use.
+		$this->_template_args['MTP'] = $message_template_group;
+
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(
+			$this->_template_path,
+			$this->_template_args,
+			true
+		);
+
+
+		// finally, let's set the admin_page title
+		$this->_admin_page_title = sprintf(esc_html__('Editing %s', 'event_espresso'), $title);
+
+
+		// we need to take care of setting the shortcodes property for use elsewhere.
+		$this->_set_shortcodes();
+
+
+		// final template wrapper
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	public function filter_tinymce_init($mceInit, $editor_id)
+	{
+		return $mceInit;
+	}
+
+
+	public function add_context_switcher()
+	{
+		return $this->_context_switcher;
+	}
+
+
+	/**
+	 * Adds the activation/deactivation toggle for the message template context.
+	 *
+	 * @param EE_Message_Template_Group $message_template_group
+	 * @param string                    $context
+	 * @param string                    $context_label
+	 * @return string
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidIdentifierException
+	 * @throws ReflectionException
+	 */
+	protected function add_active_context_element(
+		EE_Message_Template_Group $message_template_group,
+		$context,
+		$context_label
+	) {
+		$template_args = [
+			'context'                   => $context,
+			'nonce'                     => wp_create_nonce('activate_' . $context . '_toggle_nonce'),
+			'is_active'                 => $message_template_group->is_context_active($context),
+			'on_off_action'             => $message_template_group->is_context_active($context)
+				? 'context-off'
+				: 'context-on',
+			'context_label'             => str_replace(['(', ')'], '', $context_label),
+			'message_template_group_id' => $message_template_group->ID(),
+		];
+		return EEH_Template::display_template(
+			EE_MSG_TEMPLATE_PATH . 'ee_msg_editor_active_context_element.template.php',
+			$template_args,
+			true
+		);
+	}
+
+
+	/**
+	 * Ajax callback for `toggle_context_template` ajax action.
+	 * Handles toggling the message context on or off.
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidIdentifierException
+	 * @throws InvalidInterfaceException
+	 */
+	public function toggle_context_template()
+	{
+		$success = true;
+		// check for required data
+		if (
+			! (
+				$this->request->requestParamIsSet('message_template_group_id')
+				&& $this->request->requestParamIsSet('context')
+				&& $this->request->requestParamIsSet('status')
+			)
+		) {
+			EE_Error::add_error(
+				esc_html__('Required data for doing this action is not available.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$success = false;
+		}
+
+		$nonce   = $this->request->getRequestParam('toggle_context_nonce', '');
+		$context = $this->request->getRequestParam('context', '');
+		$status  = $this->request->getRequestParam('status', '');
+
+		$this->_verify_nonce($nonce, "activate_{$context}_toggle_nonce");
+
+		if ($status !== 'off' && $status !== 'on') {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__('The given status (%s) is not valid. Must be "off" or "on"', 'event_espresso'),
+					$status
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$success = false;
+		}
+		$message_template_group_id = $this->request->getRequestParam('message_template_group_id', 0, 'int');
+		$message_template_group    = EEM_Message_Template_Group::instance()->get_one_by_ID($message_template_group_id);
+		if (! $message_template_group instanceof EE_Message_Template_Group) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'Unable to change the active state because the given id "%1$d" does not match a valid "%2$s"',
+						'event_espresso'
+					),
+					$message_template_group_id,
+					'EE_Message_Template_Group'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$success = false;
+		}
+		if ($success) {
+			$success = $status === 'off'
+				? $message_template_group->deactivate_context($context)
+				: $message_template_group->activate_context($context);
+		}
+		$this->_template_args['success'] = $success;
+		$this->_return_json();
+	}
+
+
+	public function _add_form_element_before()
+	{
+		return '<form method="post" action="'
+			   . $this->_template_args['edit_message_template_form_url']
+			   . '" id="ee-msg-edit-frm">';
+	}
+
+
+	public function _add_form_element_after()
+	{
+		return '</form>';
+	}
+
+
+	/**
+	 * This executes switching the template pack for a message template.
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @since 4.5.0
+	 */
+	public function switch_template_pack()
+	{
+
+		$GRP_ID        = $this->request->getRequestParam('GRP_ID', 0, 'int');
+		$template_pack = $this->request->getRequestParam('template_pack', '');
+
+		// verify we have needed values.
+		if (empty($GRP_ID) || empty($template_pack)) {
+			$this->_template_args['error'] = true;
+			EE_Error::add_error(
+				esc_html__('The required date for switching templates is not available.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		} else {
+			// get template, set the new template_pack and then reset to default
+			/** @var EE_Message_Template_Group $message_template_group */
+			$message_template_group = EEM_Message_Template_Group::instance()->get_one_by_ID($GRP_ID);
+
+			$message_template_group->set_template_pack_name($template_pack);
+			$this->request->setRequestParam('msgr', $message_template_group->messenger());
+			$this->request->setRequestParam('mt', $message_template_group->message_type());
+
+			$query_args = $this->_reset_to_default_template();
+
+			if (empty($query_args['id'])) {
+				EE_Error::add_error(
+					esc_html__(
+						'Something went wrong with switching the template pack. Please try again or contact EE support',
+						'event_espresso'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+				$this->_template_args['error'] = true;
+			} else {
+				$template_label       = $message_template_group->get_template_pack()->label;
+				$template_pack_labels = $message_template_group->messenger_obj()->get_supports_labels();
+				EE_Error::add_success(
+					sprintf(
+						esc_html__(
+							'This message template has been successfully switched to use the %1$s %2$s.  Please wait while the page reloads with your new template.',
+							'event_espresso'
+						),
+						$template_label,
+						$template_pack_labels->template_pack
+					)
+				);
+				// generate the redirect url for js.
+				$url = self::add_query_args_and_nonce($query_args, $this->_admin_base_url);
+
+				$this->_template_args['data']['redirect_url'] = $url;
+				$this->_template_args['success']              = true;
+			}
+
+			$this->_return_json();
+		}
+	}
+
+
+	/**
+	 * This handles resetting the template for the given messenger/message_type so that users can start from scratch if
+	 * they want.
+	 *
+	 * @access protected
+	 * @return array|null
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _reset_to_default_template()
+	{
+
+		$templates    = [];
+		$GRP_ID       = $this->request->getRequestParam('GRP_ID', 0, 'int');
+		$messenger    = $this->request->getRequestParam('msgr');
+		$message_type = $this->request->getRequestParam('mt');
+		// we need to make sure we've got the info we need.
+		if (! ($GRP_ID && $messenger && $message_type)) {
+			EE_Error::add_error(
+				esc_html__(
+					'In order to reset the template to its default we require the messenger, message type, and message template GRP_ID to know what is being reset.  At least one of these is missing.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+
+		// all templates will be reset to whatever the defaults are
+		// for the global template matching the messenger and message type.
+		$success = ! empty($GRP_ID);
+
+		if ($success) {
+			// let's first determine if the incoming template is a global template,
+			// if it isn't then we need to get the global template matching messenger and message type.
+			// $MTPG = EEM_Message_Template_Group::instance()->get_one_by_ID( $GRP_ID );
+
+
+			// note this is ONLY deleting the template fields (Message Template rows) NOT the message template group.
+			$success = $this->_delete_mtp_permanently($GRP_ID, false);
+
+			if ($success) {
+				// if successfully deleted, lets generate the new ones.
+				// Note. We set GLOBAL to true, because resets on ANY template
+				// will use the related global template defaults for regeneration.
+				// This means that if a custom template is reset it resets to whatever the related global template is.
+				// HOWEVER, we DO keep the template pack and template variation set
+				// for the current custom template when resetting.
+				$templates = $this->_generate_new_templates($messenger, $message_type, $GRP_ID, true);
+			}
+		}
+
+		// any error messages?
+		if (! $success) {
+			EE_Error::add_error(
+				esc_html__(
+					'Something went wrong with deleting existing templates. Unable to reset to default',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+
+		// all good, let's add a success message!
+		if ($success && ! empty($templates)) {
+			// the info for the template we generated is the first element in the returned array
+			// $templates = $templates[0];
+			EE_Error::overwrite_success();
+			EE_Error::add_success(esc_html__('Templates have been reset to defaults.', 'event_espresso'));
+		}
+
+
+		$query_args = [
+			'id'      => isset($templates[0]['GRP_ID']) ? $templates[0]['GRP_ID'] : null,
+			'context' => isset($templates[0]['MTP_context']) ? $templates[0]['MTP_context'] : null,
+			'action'  => isset($templates[0]['GRP_ID']) ? 'edit_message_template' : 'global_mtps',
+		];
+
+		// if called via ajax then we return query args otherwise redirect
+		if (defined('DOING_AJAX') && DOING_AJAX) {
+			return $query_args;
+		} else {
+			$this->_redirect_after_action(false, '', '', $query_args, true);
+
+			return null;
+		}
+	}
+
+
+	/**
+	 * Retrieve and set the message preview for display.
+	 *
+	 * @param bool $send if TRUE then we are doing an actual TEST send with the results of the preview.
+	 * @return string
+	 * @throws ReflectionException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function _preview_message($send = false)
+	{
+		// first make sure we've got the necessary parameters
+		$GRP_ID       = $this->request->getRequestParam('GRP_ID', 0, 'int');
+		if (! ($GRP_ID && $this->_active_messenger_name && $this->_active_message_type_name)) {
+			EE_Error::add_error(
+				esc_html__('Missing necessary parameters for displaying preview', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+
+		$context = $this->request->getRequestParam('context');
+		// get the preview!
+		$preview = EED_Messages::preview_message(
+			$this->_active_message_type_name,
+			$context,
+			$this->_active_messenger_name,
+			$send
+		);
+
+		if ($send) {
+			return $preview;
+		}
+
+		// if we have an evt_id set on the request, use it.
+		$EVT_ID = $this->request->getRequestParam('evt_id', 0, 'int');
+
+		// let's add a button to go back to the edit view
+		$query_args             = [
+			'id'      => $GRP_ID,
+			'evt_id'  => $EVT_ID,
+			'context' => $context,
+			'action'  => 'edit_message_template',
+		];
+		$go_back_url            = parent::add_query_args_and_nonce($query_args, $this->_admin_base_url);
+		$preview_button         = '<a href="'
+								  . $go_back_url
+								  . '" class="button-secondary messages-preview-go-back-button">'
+								  . esc_html__('Go Back to Edit', 'event_espresso')
+								  . '</a>';
+		$message_types          = $this->get_installed_message_types();
+		$active_messenger       = $this->_message_resource_manager->get_active_messenger($this->_active_messenger_name);
+		$active_messenger_label = $active_messenger instanceof EE_messenger
+			? ucwords($active_messenger->label['singular'])
+			: esc_html__('Unknown Messenger', 'event_espresso');
+		// let's provide a helpful title for context
+		$preview_title = sprintf(
+			esc_html__('Viewing Preview for %s %s Message Template', 'event_espresso'),
+			$active_messenger_label,
+			ucwords($message_types[ $this->_active_message_type_name ]->label['singular'])
+		);
+		if (empty($preview)) {
+			$this->noEventsErrorMessage();
+		}
+		// setup display of preview.
+		$this->_admin_page_title                    = $preview_title;
+		$this->_template_args['admin_page_title']   = $preview_title;
+		$this->_template_args['admin_page_content'] = $preview_button . '<br />' . $preview;
+		$this->_template_args['data']['force_json'] = true;
+
+		return '';
+	}
+
+
+	/**
+	 * Used to set an error if there are no events available for generating a preview/test send.
+	 *
+	 * @param bool $test_send Whether the error should be generated for the context of a test send.
+	 */
+	protected function noEventsErrorMessage($test_send = false)
+	{
+		$events_url = parent::add_query_args_and_nonce(
+			[
+				'action' => 'default',
+				'page'   => 'espresso_events',
+			],
+			admin_url('admin.php')
+		);
+		$message    = $test_send
+			? esc_html__(
+				'A test message could not be sent for this message template because there are no events created yet. The preview system uses actual events for generating the test message. %1$sGo see your events%2$s!',
+				'event_espresso'
+			)
+			: esc_html__(
+				'There is no preview for this message template available because there are no events created yet. The preview system uses actual events for generating the preview. %1$sGo see your events%2$s!',
+				'event_espresso'
+			);
+
+		EE_Error::add_attention(
+			sprintf(
+				$message,
+				"<a href='{$events_url}'>",
+				'</a>'
+			)
+		);
+	}
+
+
+	/**
+	 * The initial _preview_message is on a no headers route.  It will optionally call this if necessary otherwise it
+	 * gets called automatically.
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @since 4.5.0
+	 *
+	 */
+	protected function _display_preview_message()
+	{
+		$this->display_admin_page_with_no_sidebar();
+	}
+
+
+	/**
+	 * registers metaboxes that should show up on the "edit_message_template" page
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _register_edit_meta_boxes()
+	{
+		add_meta_box(
+			'mtp_valid_shortcodes',
+			esc_html__('Valid Shortcodes', 'event_espresso'),
+			[$this, 'shortcode_meta_box'],
+			$this->_current_screen->id,
+			'side'
+		);
+		add_meta_box(
+			'mtp_extra_actions',
+			esc_html__('Extra Actions', 'event_espresso'),
+			[$this, 'extra_actions_meta_box'],
+			$this->_current_screen->id,
+			'side',
+			'high'
+		);
+		add_meta_box(
+			'mtp_templates',
+			esc_html__('Template Styles', 'event_espresso'),
+			[$this, 'template_pack_meta_box'],
+			$this->_current_screen->id,
+			'side',
+			'high'
+		);
+	}
+
+
+	/**
+	 * metabox content for all template pack and variation selection.
+	 *
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @since 4.5.0
+	 */
+	public function template_pack_meta_box()
+	{
+		$this->_set_message_template_group();
+
+		$tp_collection = EEH_MSG_Template::get_template_pack_collection();
+
+		$tp_select_values = [];
+
+		foreach ($tp_collection as $tp) {
+			// only include template packs that support this messenger and message type!
+			$supports = $tp->get_supports();
+			if (
+				! isset($supports[ $this->_message_template_group->messenger() ])
+				|| ! in_array(
+					$this->_message_template_group->message_type(),
+					$supports[ $this->_message_template_group->messenger() ],
+					true
+				)
+			) {
+				// not supported
+				continue;
+			}
+
+			$tp_select_values[] = [
+				'text' => $tp->label,
+				'id'   => $tp->dbref,
+			];
+		}
+
+		// if empty $tp_select_values then we make sure default is set because EVERY message type should be supported by
+		// the default template pack.  This still allows for the odd template pack to override.
+		if (empty($tp_select_values)) {
+			$tp_select_values[] = [
+				'text' => esc_html__('Default', 'event_espresso'),
+				'id'   => 'default',
+			];
+		}
+
+		// setup variation select values for the currently selected template.
+		$variations               = $this->_message_template_group->get_template_pack()->get_variations(
+			$this->_message_template_group->messenger(),
+			$this->_message_template_group->message_type()
+		);
+		$variations_select_values = [];
+		foreach ($variations as $variation => $label) {
+			$variations_select_values[] = [
+				'text' => $label,
+				'id'   => $variation,
+			];
+		}
+
+		$template_pack_labels = $this->_message_template_group->messenger_obj()->get_supports_labels();
+
+		$template_args['template_packs_selector']        = EEH_Form_Fields::select_input(
+			'MTP_template_pack',
+			$tp_select_values,
+			$this->_message_template_group->get_template_pack_name()
+		);
+		$template_args['variations_selector']            = EEH_Form_Fields::select_input(
+			'MTP_template_variation',
+			$variations_select_values,
+			$this->_message_template_group->get_template_pack_variation()
+		);
+		$template_args['template_pack_label']            = $template_pack_labels->template_pack;
+		$template_args['template_variation_label']       = $template_pack_labels->template_variation;
+		$template_args['template_pack_description']      = $template_pack_labels->template_pack_description;
+		$template_args['template_variation_description'] = $template_pack_labels->template_variation_description;
+
+		$template = EE_MSG_TEMPLATE_PATH . 'template_pack_and_variations_metabox.template.php';
+
+		EEH_Template::display_template($template, $template_args);
+	}
+
+
+	/**
+	 * This meta box holds any extra actions related to Message Templates
+	 * For now, this includes Resetting templates to defaults and sending a test email.
+	 *
+	 * @access  public
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function extra_actions_meta_box()
+	{
+		$template_form_fields = [];
+
+		$extra_args = [
+			'msgr'   => $this->_message_template_group->messenger(),
+			'mt'     => $this->_message_template_group->message_type(),
+			'GRP_ID' => $this->_message_template_group->GRP_ID(),
+		];
+		// first we need to see if there are any fields
+		$fields = $this->_message_template_group->messenger_obj()->get_test_settings_fields();
+
+		if (! empty($fields)) {
+			// yup there be fields
+			foreach ($fields as $field => $config) {
+				$field_id = $this->_message_template_group->messenger() . '_' . $field;
+				$existing = $this->_message_template_group->messenger_obj()->get_existing_test_settings();
+				$default  = isset($config['default']) ? $config['default'] : '';
+				$default  = isset($config['value']) ? $config['value'] : $default;
+
+				// if type is hidden and the value is empty
+				// something may have gone wrong so let's correct with the defaults
+				$fix                = $config['input'] === 'hidden'
+									  && isset($existing[ $field ])
+									  && empty($existing[ $field ])
+					? $default
+					: '';
+				$existing[ $field ] = isset($existing[ $field ]) && empty($fix)
+					? $existing[ $field ]
+					: $fix;
+
+				$template_form_fields[ $field_id ] = [
+					'name'       => 'test_settings_fld[' . $field . ']',
+					'label'      => $config['label'],
+					'input'      => $config['input'],
+					'type'       => $config['type'],
+					'required'   => $config['required'],
+					'validation' => $config['validation'],
+					'value'      => isset($existing[ $field ]) ? $existing[ $field ] : $default,
+					'css_class'  => $config['css_class'],
+					'options'    => isset($config['options']) ? $config['options'] : [],
+					'default'    => $default,
+					'format'     => $config['format'],
+				];
+			}
+		}
+
+		$test_settings_html = ! empty($template_form_fields)
+			? $this->_generate_admin_form_fields($template_form_fields, 'string', 'ee_tst_settings_flds')
+			: '';
+
+		// print out $test_settings_fields
+		if (! empty($test_settings_html)) {
+			$test_settings_html .= '<input type="submit" class="button-primary mtp-test-button alignright" ';
+			$test_settings_html .= 'name="test_button" value="';
+			$test_settings_html .= esc_html__('Test Send', 'event_espresso');
+			$test_settings_html .= '" /><div style="clear:both"></div>';
+		}
+
+		// and button
+		$test_settings_html .= '<p>';
+		$test_settings_html .= esc_html__('Need to reset this message type and start over?', 'event_espresso');
+		$test_settings_html .= '</p>';
+		$test_settings_html .= '<div class="publishing-action alignright resetbutton">';
+		$test_settings_html .= $this->get_action_link_or_button(
+			'reset_to_default',
+			'reset',
+			$extra_args,
+			'button-primary reset-default-button'
+		);
+		$test_settings_html .= '</div><div style="clear:both"></div>';
+		echo $test_settings_html; // already escaped
+	}
+
+
+	/**
+	 * This returns the shortcode selector skeleton for a given context and field.
+	 *
+	 * @param string $field           The name of the field retrieving shortcodes for.
+	 * @param string $linked_input_id The css id of the input that the shortcodes get added to.
+	 * @return string
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @since 4.9.rc.000
+	 */
+	protected function _get_shortcode_selector($field, $linked_input_id)
+	{
+		$template_args = [
+			'shortcodes'      => $this->_get_shortcodes([$field]),
+			'fieldname'       => $field,
+			'linked_input_id' => $linked_input_id,
+		];
+
+		return EEH_Template::display_template(
+			EE_MSG_TEMPLATE_PATH . 'shortcode_selector_skeleton.template.php',
+			$template_args,
+			true
+		);
+	}
+
+
+	/**
+	 * This just takes care of returning the meta box content for shortcodes (only used on the edit message template
+	 * page)
+	 *
+	 * @access public
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function shortcode_meta_box()
+	{
+		$shortcodes = $this->_get_shortcodes([], false);
+		// just make sure the shortcodes property is set
+		// $messenger = $this->_message_template_group->messenger_obj();
+		// now let's set the content depending on the status of the shortcodes array
+		if (empty($shortcodes)) {
+			echo '<p>' . esc_html__('There are no valid shortcodes available', 'event_espresso') . '</p>';
+			return;
+		}
+		?>
         <div style="float:right; margin-top:10px">
             <?php echo $this->_get_help_tab_link('message_template_shortcodes'); // already escaped
-            ?>
+			?>
         </div>
         <p class="small-text">
             <?php printf(
-                esc_html__(
-                    'You can view the shortcodes usable in your template by clicking the %s icon next to each field.',
-                    'event_espresso'
-                ),
-                '<span class="dashicons dashicons-menu"></span>'
-            ); ?>
+				esc_html__(
+					'You can view the shortcodes usable in your template by clicking the %s icon next to each field.',
+					'event_espresso'
+				),
+				'<span class="dashicons dashicons-menu"></span>'
+			); ?>
         </p>
         <?php
-    }
-
-
-    /**
-     * used to set the $_shortcodes property for when its needed elsewhere.
-     *
-     * @access protected
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _set_shortcodes()
-    {
-
-        // no need to run this if the property is already set
-        if (! empty($this->_shortcodes)) {
-            return;
-        }
-
-        $this->_shortcodes = $this->_get_shortcodes();
-    }
-
-
-    /**
-     * gets all shortcodes for a given template group. (typically used by _set_shortcodes to set the $_shortcodes
-     * property)
-     *
-     * @access  protected
-     * @param array   $fields  include an array of specific field names that you want to be used to get the shortcodes
-     *                         for. Defaults to all (for the given context)
-     * @param boolean $merged  Whether to merge all the shortcodes into one list of unique shortcodes
-     * @return array Shortcodes indexed by fieldname and the an array of shortcode/label pairs OR if merged is
-     *                         true just an array of shortcode/label pairs.
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _get_shortcodes($fields = [], $merged = true)
-    {
-        $this->_set_message_template_group();
-
-        // we need the messenger and message template to retrieve the valid shortcodes array.
-        $GRP_ID = $this->request->getRequestParam('id', 0, 'int');
-        if (empty($GRP_ID)) {
-            return [];
-        }
-        $context = $this->request->getRequestParam(
-            'messenger',
-            key($this->_message_template_group->contexts_config())
-        );
-        return $this->_message_template_group->get_shortcodes($context, $fields, $merged);
-    }
-
-
-    /**
-     * This sets the _message_template property (containing the called message_template object)
-     *
-     * @access protected
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _set_message_template_group()
-    {
-
-        if (! empty($this->_message_template_group)) {
-            return;
-        } //get out if this is already set.
-
-        $GRP_ID = $this->request->getRequestParam('GRP_ID', 0, 'int');
-        $GRP_ID = $this->request->getRequestParam('id', $GRP_ID, 'int');
-
-        // let's get the message templates
-        $MTP = EEM_Message_Template_Group::instance();
-
-        if (empty($GRP_ID)) {
-            $this->_message_template_group = $MTP->create_default_object();
-        } else {
-            $this->_message_template_group = $MTP->get_one_by_ID($GRP_ID);
-        }
-
-        $this->_template_pack = $this->_message_template_group->get_template_pack();
-        $this->_variation     = $this->_message_template_group->get_template_pack_variation();
-    }
-
-
-    /**
-     * sets up a context switcher for edit forms
-     *
-     * @access  protected
-     * @param EE_Message_Template_Group $template_group_object the template group object being displayed on the form
-     * @param array                     $args                  various things the context switcher needs.
-     * @throws EE_Error
-     */
-    protected function _set_context_switcher(EE_Message_Template_Group $template_group_object, $args)
-    {
-        $context_details = $template_group_object->contexts_config();
-        $context_label   = $template_group_object->context_label();
-        ob_start();
-        ?>
+	}
+
+
+	/**
+	 * used to set the $_shortcodes property for when its needed elsewhere.
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _set_shortcodes()
+	{
+
+		// no need to run this if the property is already set
+		if (! empty($this->_shortcodes)) {
+			return;
+		}
+
+		$this->_shortcodes = $this->_get_shortcodes();
+	}
+
+
+	/**
+	 * gets all shortcodes for a given template group. (typically used by _set_shortcodes to set the $_shortcodes
+	 * property)
+	 *
+	 * @access  protected
+	 * @param array   $fields  include an array of specific field names that you want to be used to get the shortcodes
+	 *                         for. Defaults to all (for the given context)
+	 * @param boolean $merged  Whether to merge all the shortcodes into one list of unique shortcodes
+	 * @return array Shortcodes indexed by fieldname and the an array of shortcode/label pairs OR if merged is
+	 *                         true just an array of shortcode/label pairs.
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _get_shortcodes($fields = [], $merged = true)
+	{
+		$this->_set_message_template_group();
+
+		// we need the messenger and message template to retrieve the valid shortcodes array.
+		$GRP_ID = $this->request->getRequestParam('id', 0, 'int');
+		if (empty($GRP_ID)) {
+			return [];
+		}
+		$context = $this->request->getRequestParam(
+			'messenger',
+			key($this->_message_template_group->contexts_config())
+		);
+		return $this->_message_template_group->get_shortcodes($context, $fields, $merged);
+	}
+
+
+	/**
+	 * This sets the _message_template property (containing the called message_template object)
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _set_message_template_group()
+	{
+
+		if (! empty($this->_message_template_group)) {
+			return;
+		} //get out if this is already set.
+
+		$GRP_ID = $this->request->getRequestParam('GRP_ID', 0, 'int');
+		$GRP_ID = $this->request->getRequestParam('id', $GRP_ID, 'int');
+
+		// let's get the message templates
+		$MTP = EEM_Message_Template_Group::instance();
+
+		if (empty($GRP_ID)) {
+			$this->_message_template_group = $MTP->create_default_object();
+		} else {
+			$this->_message_template_group = $MTP->get_one_by_ID($GRP_ID);
+		}
+
+		$this->_template_pack = $this->_message_template_group->get_template_pack();
+		$this->_variation     = $this->_message_template_group->get_template_pack_variation();
+	}
+
+
+	/**
+	 * sets up a context switcher for edit forms
+	 *
+	 * @access  protected
+	 * @param EE_Message_Template_Group $template_group_object the template group object being displayed on the form
+	 * @param array                     $args                  various things the context switcher needs.
+	 * @throws EE_Error
+	 */
+	protected function _set_context_switcher(EE_Message_Template_Group $template_group_object, $args)
+	{
+		$context_details = $template_group_object->contexts_config();
+		$context_label   = $template_group_object->context_label();
+		ob_start();
+		?>
         <div class="ee-msg-switcher-container">
             <form method="get" action="<?php echo esc_url_raw(EE_MSG_ADMIN_URL); ?>" id="ee-msg-context-switcher-frm">
                 <?php
-                foreach ($args as $name => $value) {
-                    if ($name === 'context' || empty($value) || $name === 'extra') {
-                        continue;
-                    }
-                    ?>
+				foreach ($args as $name => $value) {
+					if ($name === 'context' || empty($value) || $name === 'extra') {
+						continue;
+					}
+					?>
                     <input type="hidden"
                            name="<?php echo esc_attr($name); ?>"
                            value="<?php echo esc_attr($value); ?>"
                     />
                     <?php
-                }
-                // setup nonce_url
-                wp_nonce_field($args['action'] . '_nonce', $args['action'] . '_nonce', false);
-                $id = 'ee-' . sanitize_key($context_label['label']) . '-select';
-                ?>
+				}
+				// setup nonce_url
+				wp_nonce_field($args['action'] . '_nonce', $args['action'] . '_nonce', false);
+				$id = 'ee-' . sanitize_key($context_label['label']) . '-select';
+				?>
                 <label for='<?php echo esc_attr($id); ?>' class='screen-reader-text'>
                     <?php esc_html_e('message context options', 'event_espresso'); ?>
                 </label>
                 <select id="<?php echo esc_attr($id); ?>" name="context">
                     <?php
-                    $context_templates = $template_group_object->context_templates();
-                    if (is_array($context_templates)) :
-                        foreach ($context_templates as $context => $template_fields) :
-                            $checked = ($context === $args['context']) ? 'selected="selected"' : '';
-                            ?>
+					$context_templates = $template_group_object->context_templates();
+					if (is_array($context_templates)) :
+						foreach ($context_templates as $context => $template_fields) :
+							$checked = ($context === $args['context']) ? 'selected="selected"' : '';
+							?>
                             <option value="<?php echo esc_attr($context); ?>" <?php echo esc_attr($checked); ?>>
                                 <?php echo $context_details[ $context ]['label']; // already escaped ?>
                             </option>
                         <?php endforeach;
-                    endif; ?>
+					endif; ?>
                 </select>
                 <?php $button_text = sprintf(
-                    esc_html__('Switch %s', 'event_espresso'),
-                    ucwords($context_label['label'])
-                ); ?>
+					esc_html__('Switch %s', 'event_espresso'),
+					ucwords($context_label['label'])
+				); ?>
                 <input class='button-secondary'
                        id="submit-msg-context-switcher-sbmt"
                        type="submit"
@@ -2662,1867 +2662,1867 @@ 
             <?php echo $args['extra']; // already escaped ?>
         </div> <!-- end .ee-msg-switcher-container -->
         <?php
-        $this->_context_switcher = ob_get_clean();
-    }
-
-
-    /**
-     * utility for sanitizing new values coming in.
-     * Note: this is only used when updating a context.
-     *
-     * @access protected
-     *
-     * @param int $index This helps us know which template field to select from the request array.
-     *
-     * @return array
-     */
-    protected function _set_message_template_column_values($index)
-    {
-        return [
-            'MTP_ID'             => $this->request->getRequestParam('MTP_ID', 0, 'int'),
-            'GRP_ID'             => $this->request->getRequestParam('GRP_ID', 0, 'int'),
-            'MTP_user_id'        => $this->request->getRequestParam('MTP_user_id', 0, 'int'),
-            'MTP_messenger'      => strtolower($this->request->getRequestParam('MTP_messenger', '')),
-            'MTP_message_type'   => strtolower($this->request->getRequestParam('MTP_message_type', '')),
-            'MTP_template_field' => strtolower($this->request->getRequestParam("MTP_template_fields[{$index}][name]", '')),
-            'MTP_context'        => strtolower($this->request->getRequestParam('MTP_context', '')),
-            'MTP_content'        => $this->request->getRequestParam(
-                "MTP_template_fields[{$index}][content]",
-                '',
-                'string'
-            ),
-            'MTP_is_global'      => $this->request->getRequestParam('MTP_is_global', 0, 'int'),
-            'MTP_is_override'    => $this->request->getRequestParam('MTP_is_override', 0, 'int'),
-            'MTP_deleted'        => $this->request->getRequestParam('MTP_deleted', 0, 'int'),
-            'MTP_is_active'      => $this->request->getRequestParam('MTP_is_active', 0, 'int'),
-        ];
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _insert_or_update_message_template($new = false)
-    {
-
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $success  = 0;
-        $override = false;
-
-        // setup notices description
-        $messenger_slug = $this->request->getRequestParam('MTP_messenger', '');
-
-        // need the message type and messenger objects to be able to use the labels for the notices
-        $messenger_object = $this->_message_resource_manager->get_messenger($messenger_slug);
-        $messenger_label  = $messenger_object instanceof EE_messenger
-            ? ucwords($messenger_object->label['singular'])
-            : '';
-
-        $message_type_slug   = $this->request->getRequestParam('MTP_message_type', '');
-        $message_type_object = $this->_message_resource_manager->get_message_type($message_type_slug);
-
-        $message_type_label = $message_type_object instanceof EE_message_type
-            ? ucwords($message_type_object->label['singular'])
-            : '';
-
-        $context_slug = $this->request->getRequestParam('MTP_context', '');
-        $context      = ucwords(str_replace('_', ' ', $context_slug));
-
-        $item_desc   = $messenger_label && $message_type_label
-            ? $messenger_label . ' ' . $message_type_label . ' ' . $context . ' '
-            : '';
-        $item_desc   .= 'Message Template';
-        $query_args  = [];
-        $edit_array  = [];
-        $action_desc = '';
-
-        $GRP_ID = $this->request->getRequestParam('GRP_ID', 0, 'int');
-        // if this is "new" then we need to generate the default contexts
-        // for the selected messenger/message_type for user to edit.
-        if ($new) {
-            if ($edit_array = $this->_generate_new_templates($messenger_slug, $message_type_slug, $GRP_ID)) {
-                if (empty($edit_array)) {
-                    $success = 0;
-                } else {
-                    $success    = 1;
-                    $edit_array = $edit_array[0];
-                    $query_args = [
-                        'id'      => $edit_array['GRP_ID'],
-                        'context' => $edit_array['MTP_context'],
-                        'action'  => 'edit_message_template',
-                    ];
-                }
-            }
-            $action_desc = 'created';
-        } else {
-            $MTPG = EEM_Message_Template_Group::instance();
-            $MTP  = EEM_Message_Template::instance();
-
-
-            // run update for each template field in displayed context
-            $template_fields = $this->request->getRequestParam('MTP_template_fields');
-            if (! $template_fields) {
-                EE_Error::add_error(
-                    esc_html__(
-                        'There was a problem saving the template fields from the form because I didn\'t receive any actual template field data.',
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-                $success = 0;
-            } else {
-                // first validate all fields!
-                // this filter allows client code to add its own validation to the template fields as well.
-                // returning an empty array means everything passed validation.
-                // errors in validation should be represented in an array with the following shape:
-                // array(
-                //   'fieldname' => array(
-                //          'msg' => 'error message'
-                //          'value' => 'value for field producing error'
-                // )
-                $custom_validation = (array) apply_filters(
-                    'FHEE__Messages_Admin_Page___insert_or_update_message_template__validates',
-                    [],
-                    $template_fields,
-                    $context_slug,
-                    $messenger_slug,
-                    $message_type_slug
-                );
-
-                $system_validation = $MTPG->validate(
-                    $template_fields,
-                    $context_slug,
-                    $messenger_slug,
-                    $message_type_slug
-                );
-
-                $system_validation = ! is_array($system_validation) && $system_validation ? []
-                    : $system_validation;
-                $validates         = array_merge($custom_validation, $system_validation);
-
-                // if $validate returned error messages (i.e. is_array()) then we need to process them and setup an
-                // appropriate response. HMM, dang this isn't correct, $validates will ALWAYS be an array.
-                //  WE need to make sure there is no actual error messages in validates.
-                if (is_array($validates) && ! empty($validates)) {
-                    // add the transient so when the form loads we know which fields to highlight
-                    $this->_add_transient('edit_message_template', $validates);
-
-                    $success = 0;
-
-                    // setup notices
-                    foreach ($validates as $error) {
-                        if (isset($error['msg'])) {
-                            EE_Error::add_error($error['msg'], __FILE__, __FUNCTION__, __LINE__);
-                        }
-                    }
-                } else {
-                    $set_column_values = [];
-                    foreach ($template_fields as $template_field => $content) {
-                        $set_column_values = $this->_set_message_template_column_values($template_field);
-
-                        $where_cols_n_values = ['MTP_ID' => $content['MTP_ID']];
-                        // if they aren't allowed to use all JS, restrict them to just posty-y tags
-                        if (! current_user_can('unfiltered_html')) {
-                            if (is_array($set_column_values['MTP_content'])) {
-                                foreach ($set_column_values['MTP_content'] as $key => $value) {
-                                    // remove slashes so wp_kses works properly (its wp_kses_stripslashes() function
-                                    // only removes slashes from double-quotes, so attributes using single quotes always
-                                    // appear invalid.) But currently the models expect slashed data, so after wp_kses
-                                    // runs we need to re-slash the data. Sheesh. See
-                                    // https://events.codebasehq.com/projects/event-espresso/tickets/11211#update-47321587
-                                    $set_column_values['MTP_content'][ $key ] = addslashes(
-                                        wp_kses(
-                                            stripslashes($value),
-                                            wp_kses_allowed_html('post')
-                                        )
-                                    );
-                                }
-                            } else {
-                                $set_column_values['MTP_content'] = wp_kses(
-                                    $set_column_values['MTP_content'],
-                                    wp_kses_allowed_html('post')
-                                );
-                            }
-                        }
-                        $message_template_fields = [
-                            'GRP_ID'             => $set_column_values['GRP_ID'],
-                            'MTP_template_field' => $set_column_values['MTP_template_field'],
-                            'MTP_context'        => $set_column_values['MTP_context'],
-                            'MTP_content'        => $set_column_values['MTP_content'],
-                        ];
-                        if ($updated = $MTP->update($message_template_fields, [$where_cols_n_values])) {
-                            if ($updated === false) {
-                                EE_Error::add_error(
-                                    sprintf(
-                                        esc_html__('%s field was NOT updated for some reason', 'event_espresso'),
-                                        $template_field
-                                    ),
-                                    __FILE__,
-                                    __FUNCTION__,
-                                    __LINE__
-                                );
-                            } else {
-                                $success = 1;
-                            }
-                        } else {
-                            // only do this logic if we don't have a MTP_ID for this field
-                            if (empty($content['MTP_ID'])) {
-                                // this has already been through the template field validator and sanitized, so it will be
-                                // safe to insert this field.  Why insert?  This typically happens when we introduce a new
-                                // message template field in a messenger/message type and existing users don't have the
-                                // default setup for it.
-                                // @link https://events.codebasehq.com/projects/event-espresso/tickets/9465
-                                $updated = $MTP->insert($message_template_fields);
-                                if (! $updated || is_wp_error($updated)) {
-                                    EE_Error::add_error(
-                                        sprintf(
-                                            esc_html__('%s field could not be updated.', 'event_espresso'),
-                                            $template_field
-                                        ),
-                                        __FILE__,
-                                        __FUNCTION__,
-                                        __LINE__
-                                    );
-                                    $success = 0;
-                                } else {
-                                    $success = 1;
-                                }
-                            }
-                        }
-                        $action_desc = 'updated';
-                    }
-
-                    // we can use the last set_column_values for the MTPG update (because its the same for all of these specific MTPs)
-                    $mtpg_fields = [
-                        'MTP_user_id'      => $set_column_values['MTP_user_id'],
-                        'MTP_messenger'    => $set_column_values['MTP_messenger'],
-                        'MTP_message_type' => $set_column_values['MTP_message_type'],
-                        'MTP_is_global'    => $set_column_values['MTP_is_global'],
-                        'MTP_is_override'  => $set_column_values['MTP_is_override'],
-                        'MTP_deleted'      => $set_column_values['MTP_deleted'],
-                        'MTP_is_active'    => $set_column_values['MTP_is_active'],
-                        'MTP_name'         => $this->request->getRequestParam('ee_msg_non_global_fields[MTP_name]', ''),
-                        'MTP_description'  => $this->request->getRequestParam(
-                            'ee_msg_non_global_fields[MTP_description]',
-                            ''
-                        ),
-                    ];
-
-                    $mtpg_where = ['GRP_ID' => $set_column_values['GRP_ID']];
-                    $updated    = $MTPG->update($mtpg_fields, [$mtpg_where]);
-
-                    if ($updated === false) {
-                        EE_Error::add_error(
-                            sprintf(
-                                esc_html__(
-                                    'The Message Template Group (%d) was NOT updated for some reason',
-                                    'event_espresso'
-                                ),
-                                $set_column_values['GRP_ID']
-                            ),
-                            __FILE__,
-                            __FUNCTION__,
-                            __LINE__
-                        );
-                    } else {
-                        // k now we need to ensure the template_pack and template_variation fields are set.
-                        $template_pack      = $this->request->getRequestParam('MTP_template_pack', 'default');
-                        $template_variation = $this->request->getRequestParam('MTP_template_variation', 'default');
-
-                        $mtpg_obj = $MTPG->get_one_by_ID($set_column_values['GRP_ID']);
-                        if ($mtpg_obj instanceof EE_Message_Template_Group) {
-                            $mtpg_obj->set_template_pack_name($template_pack);
-                            $mtpg_obj->set_template_pack_variation($template_variation);
-                        }
-                        $success = 1;
-                    }
-                }
-            }
-        }
-
-        // we return things differently if doing ajax
-        if (defined('DOING_AJAX') && DOING_AJAX) {
-            $this->_template_args['success'] = $success;
-            $this->_template_args['error']   = ! $success;
-            $this->_template_args['content'] = '';
-            $this->_template_args['data']    = [
-                'grpID'        => $edit_array['GRP_ID'],
-                'templateName' => $edit_array['template_name'],
-            ];
-            if ($success) {
-                EE_Error::overwrite_success();
-                EE_Error::add_success(
-                    esc_html__(
-                        'The new template has been created and automatically selected for this event.  You can edit the new template by clicking the edit button.  Note before this template is assigned to this event, the event must be saved.',
-                        'event_espresso'
-                    )
-                );
-            }
-
-            $this->_return_json();
-        }
-
-
-        // was a test send triggered?
-        if ($this->request->getRequestParam('test_button', false, 'bool')) {
-            EE_Error::overwrite_success();
-            $this->_do_test_send($context_slug, $messenger_slug, $message_type_slug);
-            $override = true;
-        }
-
-        if (empty($query_args)) {
-            $query_args = [
-                'id'      => $GRP_ID,
-                'context' => $context_slug,
-                'action'  => 'edit_message_template',
-            ];
-        }
-
-        $this->_redirect_after_action($success, $item_desc, $action_desc, $query_args, $override);
-    }
-
-
-    /**
-     * processes a test send request to do an actual messenger delivery test for the given message template being tested
-     *
-     * @param string $context      what context being tested
-     * @param string $messenger    messenger being tested
-     * @param string $message_type message type being tested
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _do_test_send($context, $messenger, $message_type)
-    {
-        // set things up for preview
-        $this->request->setRequestParam('messenger', $messenger);
-        $this->request->setRequestParam('message_type', $message_type);
-        $this->request->setRequestParam('context', $context);
-        $GRP_ID = $this->request->getRequestParam('GRP_ID', 0, 'int');
-        $this->request->setRequestParam('GRP_ID', $GRP_ID);
-
-        $active_messenger  = $this->_message_resource_manager->get_active_messenger($messenger);
-        $test_settings_fld = $this->request->getRequestParam('test_settings_fld', [], 'string', true);
-
-        // let's save any existing fields that might be required by the messenger
-        if (
-            ! empty($test_settings_fld)
-            && $active_messenger instanceof EE_messenger
-            && apply_filters(
-                'FHEE__Messages_Admin_Page__do_test_send__set_existing_test_settings',
-                true,
-                $test_settings_fld,
-                $active_messenger
-            )
-        ) {
-            $active_messenger->set_existing_test_settings($test_settings_fld);
-        }
-
-        /**
-         * Use filter to add additional controls on whether message can send or not
-         */
-        if (
-            apply_filters(
-                'FHEE__Messages_Admin_Page__do_test_send__can_send',
-                true,
-                $context,
-                $this->request->requestParams(),
-                $messenger,
-                $message_type
-            )
-        ) {
-            if (EEM_Event::instance()->count() > 0) {
-                $success = $this->_preview_message(true);
-                if ($success) {
-                    EE_Error::add_success(esc_html__('Test message sent', 'event_espresso'));
-                } else {
-                    EE_Error::add_error(
-                        esc_html__('The test message was not sent', 'event_espresso'),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                }
-            } else {
-                $this->noEventsErrorMessage(true);
-            }
-        }
-    }
-
-
-    /**
-     * _generate_new_templates
-     * This will handle the messenger, message_type selection when "adding a new custom template" for an event and will
-     * automatically create the defaults for the event.  The user would then be redirected to edit the default context
-     * for the event.
-     *
-     *
-     * @param string $messenger      the messenger we are generating templates for
-     * @param array  $message_types  array of message types that the templates are generated for.
-     * @param int    $GRP_ID         If this is a custom template being generated then a GRP_ID needs to be included to
-     *                               indicate the message_template_group being used as the base.
-     *
-     * @param bool   $global
-     *
-     * @return array|bool array of data required for the redirect to the correct edit page or bool if
-     *                               encountering problems.
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _generate_new_templates($messenger, $message_types, $GRP_ID = 0, $global = false)
-    {
-
-        // if no $message_types are given then that's okay... this may be a messenger that just adds shortcodes, so we
-        // just don't generate any templates.
-        if (empty($message_types)) {
-            return true;
-        }
-
-        return EEH_MSG_Template::generate_new_templates($messenger, $message_types, $GRP_ID, $global);
-    }
-
-
-    /**
-     * [_trash_or_restore_message_template]
-     *
-     * @param boolean $trash  whether to move an item to trash/restore (TRUE) or restore it (FALSE)
-     * @param boolean $all    whether this is going to trash/restore all contexts within a template group (TRUE) OR just
-     *                        an individual context (FALSE).
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _trash_or_restore_message_template($trash = true, $all = false)
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $MTP = EEM_Message_Template_Group::instance();
-
-        $success = 1;
-
-        // incoming GRP_IDs
-        if ($all) {
-            // Checkboxes
-            $checkboxes = $this->request->getRequestParam('checkbox', [], 'int', true);
-            if (! empty($checkboxes)) {
-                // if array has more than one element then success message should be plural.
-                // todo: what about nonce?
-                $success = count($checkboxes) > 1 ? 2 : 1;
-
-                // cycle through checkboxes
-                while (list($GRP_ID, $value) = each($checkboxes)) {
-                    $trashed_or_restored = $trash ? $MTP->delete_by_ID($GRP_ID) : $MTP->restore_by_ID($GRP_ID);
-                    if (! $trashed_or_restored) {
-                        $success = 0;
-                    }
-                }
-            } else {
-                // grab single GRP_ID and handle
-                $GRP_ID = $this->request->getRequestParam('id', 0, 'int');
-                if (! empty($GRP_ID)) {
-                    $trashed_or_restored = $trash ? $MTP->delete_by_ID($GRP_ID) : $MTP->restore_by_ID($GRP_ID);
-                    if (! $trashed_or_restored) {
-                        $success = 0;
-                    }
-                } else {
-                    $success = 0;
-                }
-            }
-        }
-
-        $action_desc = $trash
-            ? esc_html__('moved to the trash', 'event_espresso')
-            : esc_html__('restored', 'event_espresso');
-
-        $template_switch = $this->request->getRequestParam('template_switch', false, 'bool');
-        $action_desc     = $template_switch ? esc_html__('switched', 'event_espresso') : $action_desc;
-
-        $item_desc = $all ? _n(
-            'Message Template Group',
-            'Message Template Groups',
-            $success,
-            'event_espresso'
-        ) : _n('Message Template Context', 'Message Template Contexts', $success, 'event_espresso');
-
-        $item_desc = $template_switch
-            ? _n('template', 'templates', $success, 'event_espresso')
-            : $item_desc;
-
-        $this->_redirect_after_action($success, $item_desc, $action_desc, []);
-    }
-
-
-    /**
-     * [_delete_message_template]
-     * NOTE: this handles not only the deletion of the groups but also all the templates belonging to that group.
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _delete_message_template()
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-
-        // checkboxes
-        $checkboxes = $this->request->getRequestParam('checkbox', [], 'int', true);
-        if (! empty($checkboxes)) {
-            // if array has more than one element then success message should be plural
-            $success = count($checkboxes) > 1 ? 2 : 1;
-
-            // cycle through bulk action checkboxes
-            while (list($GRP_ID, $value) = each($checkboxes)) {
-                $success = $this->_delete_mtp_permanently($GRP_ID) ? $success : false;
-            }
-        } else {
-            // grab single grp_id and delete
-            $GRP_ID  = $this->request->getRequestParam('id', 0, 'int');
-            $success = $this->_delete_mtp_permanently($GRP_ID);
-        }
-
-        $this->_redirect_after_action($success, 'Message Templates', 'deleted', []);
-    }
-
-
-    /**
-     * helper for permanently deleting a mtP group and all related message_templates
-     *
-     * @param int  $GRP_ID        The group being deleted
-     * @param bool $include_group whether to delete the Message Template Group as well.
-     * @return bool boolean to indicate the success of the deletes or not.
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws ReflectionException
-     */
-    private function _delete_mtp_permanently($GRP_ID, $include_group = true)
-    {
-        $success = true;
-        $MTPG    = EEM_Message_Template_Group::instance();
-        // first let's GET this group
-        $MTG = $MTPG->get_one_by_ID($GRP_ID);
-        // then delete permanently all the related Message Templates
-        $deleted = $MTG->delete_related_permanently('Message_Template');
-
-        if ($deleted === 0) {
-            $success = false;
-        }
-
-        // now delete permanently this particular group
-
-        if ($include_group && ! $MTG->delete_permanently()) {
-            $success = false;
-        }
-
-        return $success;
-    }
-
-
-    /**
-     *    _learn_more_about_message_templates_link
-     *
-     * @access protected
-     * @return string
-     */
-    protected function _learn_more_about_message_templates_link()
-    {
-        return '<a class="hidden" style="margin:0 20px; cursor:pointer; font-size:12px;" >'
-               . esc_html__('learn more about how message templates works', 'event_espresso')
-               . '</a>';
-    }
-
-
-    /**
-     * Used for setting up messenger/message type activation.  This loads up the initial view.  The rest is handled by
-     * ajax and other routes.
-     *
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    protected function _settings()
-    {
-        $this->_set_m_mt_settings();
-
-        // let's setup the messenger tabs
-        $this->_template_args['admin_page_header'] = EEH_Tabbed_Content::tab_text_links(
-            $this->_m_mt_settings['messenger_tabs'],
-            'messenger_links',
-            '|',
-            $this->request->getRequestParam('selected_messenger', 'email')
-        );
-
-        $this->_template_args['before_admin_page_content'] = '<div class="ui-widget ui-helper-clearfix">';
-        $this->_template_args['after_admin_page_content']  = '</div><!-- end .ui-widget -->';
-
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    /**
-     * This sets the $_m_mt_settings property for when needed (used on the Messages settings page)
-     *
-     * @access protected
-     * @return void
-     * @throws DomainException
-     */
-    protected function _set_m_mt_settings()
-    {
-        // first if this is already set then lets get out no need to regenerate data.
-        if (! empty($this->_m_mt_settings)) {
-            return;
-        }
-
-        // get all installed messengers and message_types
-        $messengers    = $this->_message_resource_manager->installed_messengers();
-        $message_types = $this->_message_resource_manager->installed_message_types();
-
-
-        // assemble the array for the _tab_text_links helper
-
-        foreach ($messengers as $messenger) {
-            $this->_m_mt_settings['messenger_tabs'][ $messenger->name ] = [
-                'label' => ucwords($messenger->label['singular']),
-                'class' => $this->_message_resource_manager->is_messenger_active($messenger->name)
-                    ? 'messenger-active'
-                    : '',
-                'href'  => $messenger->name,
-                'title' => esc_html__('Modify this Messenger', 'event_espresso'),
-                'slug'  => $messenger->name,
-                'obj'   => $messenger,
-            ];
-
-
-            $message_types_for_messenger = $messenger->get_valid_message_types();
-
-            foreach ($message_types as $message_type) {
-                // first we need to verify that this message type is valid with this messenger. Cause if it isn't then
-                // it shouldn't show in either the inactive OR active metabox.
-                if (! in_array($message_type->name, $message_types_for_messenger, true)) {
-                    continue;
-                }
-
-                $a_or_i = $this->_message_resource_manager->is_message_type_active_for_messenger(
-                    $messenger->name,
-                    $message_type->name
-                )
-                    ? 'active'
-                    : 'inactive';
-
-                $this->_m_mt_settings['message_type_tabs'][ $messenger->name ][ $a_or_i ][ $message_type->name ] = [
-                    'label'    => ucwords($message_type->label['singular']),
-                    'class'    => 'message-type-' . $a_or_i,
-                    'slug_id'  => $message_type->name . '-messagetype-' . $messenger->name,
-                    'mt_nonce' => wp_create_nonce($message_type->name . '_nonce'),
-                    'href'     => 'espresso_' . $message_type->name . '_message_type_settings',
-                    'title'    => $a_or_i === 'active'
-                        ? esc_html__('Drag this message type to the Inactive window to deactivate', 'event_espresso')
-                        : esc_html__('Drag this message type to the messenger to activate', 'event_espresso'),
-                    'content'  => $a_or_i === 'active'
-                        ? $this->_message_type_settings_content($message_type, $messenger, true)
-                        : $this->_message_type_settings_content($message_type, $messenger),
-                    'slug'     => $message_type->name,
-                    'active'   => $a_or_i === 'active',
-                    'obj'      => $message_type,
-                ];
-            }
-        }
-    }
-
-
-    /**
-     * This just prepares the content for the message type settings
-     *
-     * @param EE_message_type $message_type The message type object
-     * @param EE_messenger    $messenger    The messenger object
-     * @param boolean         $active       Whether the message type is active or not
-     * @return string html output for the content
-     * @throws DomainException
-     */
-    protected function _message_type_settings_content($message_type, $messenger, $active = false)
-    {
-        // get message type fields
-        $fields                                         = $message_type->get_admin_settings_fields();
-        $settings_template_args['template_form_fields'] = '';
-
-        if (! empty($fields) && $active) {
-            $existing_settings = $message_type->get_existing_admin_settings($messenger->name);
-            foreach ($fields as $fldname => $fldprops) {
-                $field_id                         = $messenger->name . '-' . $message_type->name . '-' . $fldname;
-                $template_form_field[ $field_id ] = [
-                    'name'       => 'message_type_settings[' . $fldname . ']',
-                    'label'      => $fldprops['label'],
-                    'input'      => $fldprops['field_type'],
-                    'type'       => $fldprops['value_type'],
-                    'required'   => $fldprops['required'],
-                    'validation' => $fldprops['validation'],
-                    'value'      => isset($existing_settings[ $fldname ])
-                        ? $existing_settings[ $fldname ]
-                        : $fldprops['default'],
-                    'options'    => isset($fldprops['options'])
-                        ? $fldprops['options']
-                        : [],
-                    'default'    => isset($existing_settings[ $fldname ])
-                        ? $existing_settings[ $fldname ]
-                        : $fldprops['default'],
-                    'css_class'  => 'no-drag',
-                    'format'     => $fldprops['format'],
-                ];
-            }
-
-
-            $settings_template_args['template_form_fields'] = ! empty($template_form_field)
-                ? $this->_generate_admin_form_fields(
-                    $template_form_field,
-                    'string',
-                    'ee_mt_activate_form'
-                )
-                : '';
-        }
-
-        $settings_template_args['description'] = $message_type->description;
-        // we also need some hidden fields
-        $hidden_fields = [
-            'message_type_settings[messenger]' . $message_type->name    => [
-                'type'  => 'hidden',
-                'value' => $messenger->name,
-            ],
-            'message_type_settings[message_type]' . $message_type->name => [
-                'type'  => 'hidden',
-                'value' => $message_type->name,
-            ],
-            'type' . $message_type->name                                => [
-                'type'  => 'hidden',
-                'value' => 'message_type',
-            ],
-        ];
-
-        $settings_template_args['hidden_fields'] = $this->_generate_admin_form_fields(
-            $hidden_fields,
-            'array'
-        );
-        $settings_template_args['show_form']     = empty($settings_template_args['template_form_fields'])
-            ? ' hidden'
-            : '';
-
-
-        $template = EE_MSG_TEMPLATE_PATH . 'ee_msg_mt_settings_content.template.php';
-        return EEH_Template::display_template($template, $settings_template_args, true);
-    }
-
-
-    /**
-     * Generate all the metaboxes for the message types and register them for the messages settings page.
-     *
-     * @access protected
-     * @return void
-     * @throws DomainException
-     */
-    protected function _messages_settings_metaboxes()
-    {
-        $this->_set_m_mt_settings();
-        $m_boxes         = $mt_boxes = [];
-        $m_template_args = $mt_template_args = [];
-
-        $selected_messenger = $this->request->getRequestParam('selected_messenger', 'email');
-
-        if (isset($this->_m_mt_settings['messenger_tabs'])) {
-            foreach ($this->_m_mt_settings['messenger_tabs'] as $messenger => $tab_array) {
-                $is_messenger_active = $this->_message_resource_manager->is_messenger_active($messenger);
-                $hide_on_message     = $is_messenger_active ? '' : 'hidden';
-                $hide_off_message    = $is_messenger_active ? 'hidden' : '';
-
-                // messenger meta boxes
-                $active         = $selected_messenger === $messenger;
-                $active_mt_tabs = isset($this->_m_mt_settings['message_type_tabs'][ $messenger ]['active'])
-                    ? $this->_m_mt_settings['message_type_tabs'][ $messenger ]['active']
-                    : '';
-
-                $m_boxes[ $messenger . '_a_box' ] = sprintf(
-                    esc_html__('%s Settings', 'event_espresso'),
-                    $tab_array['label']
-                );
-
-                $m_template_args[ $messenger . '_a_box' ] = [
-                    'active_message_types'   => ! empty($active_mt_tabs) ? $this->_get_mt_tabs($active_mt_tabs) : '',
-                    'inactive_message_types' => isset(
-                        $this->_m_mt_settings['message_type_tabs'][ $messenger ]['inactive']
-                    )
-                        ? $this->_get_mt_tabs($this->_m_mt_settings['message_type_tabs'][ $messenger ]['inactive'])
-                        : '',
-                    'content'                => $this->_get_messenger_box_content($tab_array['obj']),
-                    'hidden'                 => $active ? '' : ' hidden',
-                    'hide_on_message'        => $hide_on_message,
-                    'messenger'              => $messenger,
-                    'active'                 => $active,
-                ];
-
-                // message type meta boxes
-                // (which is really just the inactive container for each messenger
-                // showing inactive message types for that messenger)
-                $mt_boxes[ $messenger . '_i_box' ]         = esc_html__('Inactive Message Types', 'event_espresso');
-                $mt_template_args[ $messenger . '_i_box' ] = [
-                    'active_message_types'   => ! empty($active_mt_tabs) ? $this->_get_mt_tabs($active_mt_tabs) : '',
-                    'inactive_message_types' => isset(
-                        $this->_m_mt_settings['message_type_tabs'][ $messenger ]['inactive']
-                    )
-                        ? $this->_get_mt_tabs($this->_m_mt_settings['message_type_tabs'][ $messenger ]['inactive'])
-                        : '',
-                    'hidden'                 => $active ? '' : ' hidden',
-                    'hide_on_message'        => $hide_on_message,
-                    'hide_off_message'       => $hide_off_message,
-                    'messenger'              => $messenger,
-                    'active'                 => $active,
-                ];
-            }
-        }
-
-
-        // register messenger metaboxes
-        $m_template_path = EE_MSG_TEMPLATE_PATH . 'ee_msg_details_messenger_mt_meta_box.template.php';
-        foreach ($m_boxes as $box => $label) {
-            $callback_args = ['template_path' => $m_template_path, 'template_args' => $m_template_args[ $box ]];
-            $msgr          = str_replace('_a_box', '', $box);
-            add_meta_box(
-                'espresso_' . $msgr . '_settings',
-                $label,
-                function ($post, $metabox) {
-                    EEH_Template::display_template(
-                        $metabox['args']['template_path'],
-                        $metabox['args']['template_args']
-                    );
-                },
-                $this->_current_screen->id,
-                'normal',
-                'high',
-                $callback_args
-            );
-        }
-
-        // register message type metaboxes
-        $mt_template_path = EE_MSG_TEMPLATE_PATH . 'ee_msg_details_messenger_meta_box.template.php';
-        foreach ($mt_boxes as $box => $label) {
-            $callback_args = [
-                'template_path' => $mt_template_path,
-                'template_args' => $mt_template_args[ $box ],
-            ];
-            $mt            = str_replace('_i_box', '', $box);
-            add_meta_box(
-                'espresso_' . $mt . '_inactive_mts',
-                $label,
-                function ($post, $metabox) {
-                    EEH_Template::display_template(
-                        $metabox['args']['template_path'],
-                        $metabox['args']['template_args']
-                    );
-                },
-                $this->_current_screen->id,
-                'side',
-                'high',
-                $callback_args
-            );
-        }
-
-        // register metabox for global messages settings but only when on the main site.  On single site installs this
-        // will always result in the metabox showing, on multisite installs the metabox will only show on the main site.
-        if (is_main_site()) {
-            add_meta_box(
-                'espresso_global_message_settings',
-                esc_html__('Global Message Settings', 'event_espresso'),
-                [$this, 'global_messages_settings_metabox_content'],
-                $this->_current_screen->id,
-                'normal',
-                'low',
-                []
-            );
-        }
-    }
-
-
-    /**
-     *  This generates the content for the global messages settings metabox.
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function global_messages_settings_metabox_content()
-    {
-        $form = $this->_generate_global_settings_form();
-        // already escaped
-        echo $form->form_open(
-            $this->add_query_args_and_nonce(['action' => 'update_global_settings'], EE_MSG_ADMIN_URL),
-            'POST'
-        );
-        echo $form->get_html();
-        echo $form->form_close();
-    }
-
-
-    /**
-     * This generates and returns the form object for the global messages settings.
-     *
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _generate_global_settings_form()
-    {
-        /** @var EE_Network_Core_Config $network_config */
-        $network_config = EE_Registry::instance()->NET_CFG->core;
-
-        return new EE_Form_Section_Proper(
-            [
-                'name'            => 'global_messages_settings',
-                'html_id'         => 'global_messages_settings',
-                'html_class'      => 'form-table',
-                'layout_strategy' => new EE_Admin_Two_Column_Layout(),
-                'subsections'     => apply_filters(
-                    'FHEE__Messages_Admin_Page__global_messages_settings_metabox_content__form_subsections',
-                    [
-                        'do_messages_on_same_request' => new EE_Select_Input(
-                            [
-                                true  => esc_html__('On the same request', 'event_espresso'),
-                                false => esc_html__('On a separate request', 'event_espresso'),
-                            ],
-                            [
-                                'default'         => $network_config->do_messages_on_same_request,
-                                'html_label_text' => esc_html__(
-                                    'Generate and send all messages:',
-                                    'event_espresso'
-                                ),
-                                'html_help_text'  => esc_html__(
-                                    'By default the messages system uses a more efficient means of processing messages on separate requests and utilizes the wp-cron scheduling system.  This makes things execute faster for people registering for your events.  However, if the wp-cron system is disabled on your site and there is no alternative in place, then you can change this so messages are always executed on the same request.',
-                                    'event_espresso'
-                                ),
-                            ]
-                        ),
-                        'delete_threshold'            => new EE_Select_Input(
-                            [
-                                0  => esc_html__('Forever', 'event_espresso'),
-                                3  => esc_html__('3 Months', 'event_espresso'),
-                                6  => esc_html__('6 Months', 'event_espresso'),
-                                9  => esc_html__('9 Months', 'event_espresso'),
-                                12 => esc_html__('12 Months', 'event_espresso'),
-                                24 => esc_html__('24 Months', 'event_espresso'),
-                                36 => esc_html__('36 Months', 'event_espresso'),
-                            ],
-                            [
-                                'default'         => EE_Registry::instance()->CFG->messages->delete_threshold,
-                                'html_label_text' => esc_html__('Cleanup of old messages:', 'event_espresso'),
-                                'html_help_text'  => esc_html__(
-                                    'You can control how long a record of processed messages is kept via this option.',
-                                    'event_espresso'
-                                ),
-                            ]
-                        ),
-                        'update_settings'             => new EE_Submit_Input(
-                            [
-                                'default'         => esc_html__('Update', 'event_espresso'),
-                                'html_label_text' => '&nbsp',
-                            ]
-                        ),
-                    ]
-                ),
-            ]
-        );
-    }
-
-
-    /**
-     * This handles updating the global settings set on the admin page.
-     *
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     */
-    protected function _update_global_settings()
-    {
-        /** @var EE_Network_Core_Config $network_config */
-        $network_config  = EE_Registry::instance()->NET_CFG->core;
-        $messages_config = EE_Registry::instance()->CFG->messages;
-        $form            = $this->_generate_global_settings_form();
-        if ($form->was_submitted()) {
-            $form->receive_form_submission();
-            if ($form->is_valid()) {
-                $valid_data = $form->valid_data();
-                foreach ($valid_data as $property => $value) {
-                    $setter = 'set_' . $property;
-                    if (method_exists($network_config, $setter)) {
-                        $network_config->{$setter}($value);
-                    } elseif (
-                        property_exists($network_config, $property)
-                        && $network_config->{$property} !== $value
-                    ) {
-                        $network_config->{$property} = $value;
-                    } elseif (
-                        property_exists($messages_config, $property)
-                        && $messages_config->{$property} !== $value
-                    ) {
-                        $messages_config->{$property} = $value;
-                    }
-                }
-                // only update if the form submission was valid!
-                EE_Registry::instance()->NET_CFG->update_config(true, false);
-                EE_Registry::instance()->CFG->update_espresso_config();
-                EE_Error::overwrite_success();
-                EE_Error::add_success(esc_html__('Global message settings were updated', 'event_espresso'));
-            }
-        }
-        $this->_redirect_after_action(0, '', '', ['action' => 'settings'], true);
-    }
-
-
-    /**
-     * this prepares the messenger tabs that can be dragged in and out of messenger boxes to activate/deactivate
-     *
-     * @param array $tab_array This is an array of message type tab details used to generate the tabs
-     * @return string html formatted tabs
-     * @throws DomainException
-     */
-    protected function _get_mt_tabs($tab_array)
-    {
-        $tab_array = (array) $tab_array;
-        $template  = EE_MSG_TEMPLATE_PATH . 'ee_msg_details_mt_settings_tab_item.template.php';
-        $tabs      = '';
-
-        foreach ($tab_array as $tab) {
-            $tabs .= EEH_Template::display_template($template, $tab, true);
-        }
-
-        return $tabs;
-    }
-
-
-    /**
-     * This prepares the content of the messenger meta box admin settings
-     *
-     * @param EE_messenger $messenger The messenger we're setting up content for
-     * @return string html formatted content
-     * @throws DomainException
-     */
-    protected function _get_messenger_box_content(EE_messenger $messenger)
-    {
-
-        $fields                                         = $messenger->get_admin_settings_fields();
-        $settings_template_args['template_form_fields'] = '';
-
-        // is $messenger active?
-        $settings_template_args['active'] = $this->_message_resource_manager->is_messenger_active($messenger->name);
-
-
-        if (! empty($fields)) {
-            $existing_settings = $messenger->get_existing_admin_settings();
-
-            foreach ($fields as $fldname => $fldprops) {
-                $field_id                         = $messenger->name . '-' . $fldname;
-                $template_form_field[ $field_id ] = [
-                    'name'       => 'messenger_settings[' . $field_id . ']',
-                    'label'      => $fldprops['label'],
-                    'input'      => $fldprops['field_type'],
-                    'type'       => $fldprops['value_type'],
-                    'required'   => $fldprops['required'],
-                    'validation' => $fldprops['validation'],
-                    'value'      => isset($existing_settings[ $field_id ])
-                        ? $existing_settings[ $field_id ]
-                        : $fldprops['default'],
-                    'css_class'  => '',
-                    'format'     => $fldprops['format'],
-                ];
-            }
-
-
-            $settings_template_args['template_form_fields'] = ! empty($template_form_field)
-                ? $this->_generate_admin_form_fields($template_form_field, 'string', 'ee_m_activate_form')
-                : '';
-        }
-
-        // we also need some hidden fields
-        $settings_template_args['hidden_fields'] = [
-            'messenger_settings[messenger]' . $messenger->name => [
-                'type'  => 'hidden',
-                'value' => $messenger->name,
-            ],
-            'type' . $messenger->name                          => [
-                'type'  => 'hidden',
-                'value' => 'messenger',
-            ],
-        ];
-
-        // make sure any active message types that are existing are included in the hidden fields
-        if (isset($this->_m_mt_settings['message_type_tabs'][ $messenger->name ]['active'])) {
-            foreach ($this->_m_mt_settings['message_type_tabs'][ $messenger->name ]['active'] as $mt => $values) {
-                $settings_template_args['hidden_fields'][ 'messenger_settings[message_types][' . $mt . ']' ] = [
-                    'type'  => 'hidden',
-                    'value' => $mt,
-                ];
-            }
-        }
-        $settings_template_args['hidden_fields'] = $this->_generate_admin_form_fields(
-            $settings_template_args['hidden_fields'],
-            'array'
-        );
-        $active                                  =
-            $this->_message_resource_manager->is_messenger_active($messenger->name);
-
-        $settings_template_args['messenger']           = $messenger->name;
-        $settings_template_args['description']         = $messenger->description;
-        $settings_template_args['show_hide_edit_form'] = $active ? '' : ' hidden';
-
-
-        $settings_template_args['show_hide_edit_form'] = $this->_message_resource_manager->is_messenger_active(
-            $messenger->name
-        )
-            ? $settings_template_args['show_hide_edit_form']
-            : ' hidden';
-
-        $settings_template_args['show_hide_edit_form'] = empty($settings_template_args['template_form_fields'])
-            ? ' hidden'
-            : $settings_template_args['show_hide_edit_form'];
-
-
-        $settings_template_args['on_off_action'] = $active ? 'messenger-off' : 'messenger-on';
-        $settings_template_args['nonce']         = wp_create_nonce('activate_' . $messenger->name . '_toggle_nonce');
-        $settings_template_args['on_off_status'] = $active;
-        $template                                = EE_MSG_TEMPLATE_PATH . 'ee_msg_m_settings_content.template.php';
-        return EEH_Template::display_template(
-            $template,
-            $settings_template_args,
-            true
-        );
-    }
-
-
-    /**
-     * used by ajax on the messages settings page to activate|deactivate the messenger
-     *
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     */
-    public function activate_messenger_toggle()
-    {
-        $success = true;
-        $this->_prep_default_response_for_messenger_or_message_type_toggle();
-        // let's check that we have required data
-
-        if (! $this->_active_messenger_name) {
-            EE_Error::add_error(
-                esc_html__('Messenger name needed to toggle activation. None given', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $success = false;
-        }
-
-        // do a nonce check here since we're not arriving via a normal route
-        $nonce     = $this->request->getRequestParam('activate_nonce', '');
-        $nonce_ref = "activate_{$this->_active_messenger_name}_toggle_nonce";
-
-        $this->_verify_nonce($nonce, $nonce_ref);
-
-
-        $status = $this->request->getRequestParam('status');
-        if (! $status) {
-            EE_Error::add_error(
-                esc_html__(
-                    'Messenger status needed to know whether activation or deactivation is happening. No status is given',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $success = false;
-        }
-
-        // do check to verify we have a valid status.
-        if ($status !== 'off' && $status !== 'on') {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__('The given status (%s) is not valid. Must be "off" or "on"', 'event_espresso'),
-                    $status
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $success = false;
-        }
-
-        if ($success) {
-            // made it here?  Stop dawdling then!!
-            $success = $status === 'off'
-                ? $this->_deactivate_messenger($this->_active_messenger_name)
-                : $this->_activate_messenger($this->_active_messenger_name);
-        }
-
-        $this->_template_args['success'] = $success;
-
-        // no special instructions so let's just do the json return (which should automatically do all the special stuff).
-        $this->_return_json();
-    }
-
-
-    /**
-     * used by ajax from the messages settings page to activate|deactivate a message type
-     *
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    public function activate_mt_toggle()
-    {
-        $success = true;
-        $this->_prep_default_response_for_messenger_or_message_type_toggle();
-
-        // let's make sure we have the necessary data
-        if (! $this->_active_message_type_name) {
-            EE_Error::add_error(
-                esc_html__('Message Type name needed to toggle activation. None given', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $success = false;
-        }
-
-        if (! $this->_active_messenger_name) {
-            EE_Error::add_error(
-                esc_html__('Messenger name needed to toggle activation. None given', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $success = false;
-        }
-
-        $status = $this->request->getRequestParam('status');
-        if (! $status) {
-            EE_Error::add_error(
-                esc_html__(
-                    'Messenger status needed to know whether activation or deactivation is happening. No status is given',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $success = false;
-        }
-
-
-        // do check to verify we have a valid status.
-        if ($status !== 'activate' && $status !== 'deactivate') {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__('The given status (%s) is not valid. Must be "active" or "inactive"', 'event_espresso'),
-                    $status
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $success = false;
-        }
-
-
-        // do a nonce check here since we're not arriving via a normal route
-        $nonce = $this->request->getRequestParam('mt_nonce', '');
-        $this->_verify_nonce($nonce, "{$this->_active_message_type_name}_nonce");
-
-        if ($success) {
-            // made it here? um, what are you waiting for then?
-            $success = $status === 'deactivate'
-                ? $this->_deactivate_message_type_for_messenger(
-                    $this->_active_messenger_name,
-                    $this->_active_message_type_name
-                )
-                : $this->_activate_message_type_for_messenger(
-                    $this->_active_messenger_name,
-                    $this->_active_message_type_name
-                );
-        }
-
-        $this->_template_args['success'] = $success;
-        $this->_return_json();
-    }
-
-
-    /**
-     * Takes care of processing activating a messenger and preparing the appropriate response.
-     *
-     * @param string $messenger_name The name of the messenger being activated
-     * @return bool
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _activate_messenger($messenger_name)
-    {
-        $active_messenger          = $this->_message_resource_manager->get_messenger($messenger_name);
-        $message_types_to_activate = $active_messenger instanceof EE_Messenger
-            ? $active_messenger->get_default_message_types()
-            : [];
-
-        // ensure is active
-        $this->_message_resource_manager->activate_messenger($active_messenger, $message_types_to_activate);
-
-        // set response_data for reload
-        foreach ($message_types_to_activate as $message_type_name) {
-            $message_type = $this->_message_resource_manager->get_message_type($message_type_name);
-            if (
-                $this->_message_resource_manager->is_message_type_active_for_messenger(
-                    $messenger_name,
-                    $message_type_name
-                )
-                && $message_type instanceof EE_message_type
-            ) {
-                $this->_template_args['data']['active_mts'][] = $message_type_name;
-                if ($message_type->get_admin_settings_fields()) {
-                    $this->_template_args['data']['mt_reload'][] = $message_type_name;
-                }
-            }
-        }
-
-        // add success message for activating messenger
-        return $this->_setup_response_message_for_activating_messenger_with_message_types($active_messenger);
-    }
-
-
-    /**
-     * Takes care of processing deactivating a messenger and preparing the appropriate response.
-     *
-     * @param string $messenger_name The name of the messenger being activated
-     * @return bool
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _deactivate_messenger($messenger_name)
-    {
-        $active_messenger = $this->_message_resource_manager->get_messenger($messenger_name);
-        $this->_message_resource_manager->deactivate_messenger($messenger_name);
-
-        return $this->_setup_response_message_for_deactivating_messenger_with_message_types($active_messenger);
-    }
-
-
-    /**
-     * Takes care of processing activating a message type for a messenger and preparing the appropriate response.
-     *
-     * @param string $messenger_name    The name of the messenger the message type is being activated for.
-     * @param string $message_type_name The name of the message type being activated for the messenger
-     * @return bool
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _activate_message_type_for_messenger($messenger_name, $message_type_name)
-    {
-        $active_messenger         = $this->_message_resource_manager->get_messenger($messenger_name);
-        $message_type_to_activate = $this->_message_resource_manager->get_message_type($message_type_name);
-
-        // ensure is active
-        $this->_message_resource_manager->activate_messenger($active_messenger, $message_type_name);
-
-        // set response for load
-        if (
-            $this->_message_resource_manager->is_message_type_active_for_messenger(
-                $messenger_name,
-                $message_type_name
-            )
-        ) {
-            $this->_template_args['data']['active_mts'][] = $message_type_name;
-            if ($message_type_to_activate->get_admin_settings_fields()) {
-                $this->_template_args['data']['mt_reload'][] = $message_type_name;
-            }
-        }
-
-        return $this->_setup_response_message_for_activating_messenger_with_message_types(
-            $active_messenger,
-            $message_type_to_activate
-        );
-    }
-
-
-    /**
-     * Takes care of processing deactivating a message type for a messenger and preparing the appropriate response.
-     *
-     * @param string $messenger_name    The name of the messenger the message type is being deactivated for.
-     * @param string $message_type_name The name of the message type being deactivated for the messenger
-     * @return bool
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _deactivate_message_type_for_messenger($messenger_name, $message_type_name)
-    {
-        $active_messenger = $this->_message_resource_manager->get_messenger($messenger_name);
-        /** @var EE_message_type $message_type_to_activate This will be present because it can't be toggled if it isn't */
-        $message_type_to_deactivate = $this->_message_resource_manager->get_message_type($message_type_name);
-        $this->_message_resource_manager->deactivate_message_type_for_messenger($message_type_name, $messenger_name);
-
-        return $this->_setup_response_message_for_deactivating_messenger_with_message_types(
-            $active_messenger,
-            $message_type_to_deactivate
-        );
-    }
-
-
-    /**
-     * This just initializes the defaults for activating messenger and message type responses.
-     */
-    protected function _prep_default_response_for_messenger_or_message_type_toggle()
-    {
-        $this->_template_args['data']['active_mts'] = [];
-        $this->_template_args['data']['mt_reload']  = [];
-    }
-
-
-    /**
-     * Setup appropriate response for activating a messenger and/or message types
-     *
-     * @param EE_messenger         $messenger
-     * @param EE_message_type|null $message_type
-     * @return bool
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _setup_response_message_for_activating_messenger_with_message_types(
-        $messenger,
-        EE_Message_Type $message_type = null
-    ) {
-        // if $messenger isn't a valid messenger object then get out.
-        if (! $messenger instanceof EE_Messenger) {
-            EE_Error::add_error(
-                esc_html__('The messenger being activated is not a valid messenger', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        // activated
-        if ($this->_template_args['data']['active_mts']) {
-            EE_Error::overwrite_success();
-            // activated a message type with the messenger
-            if ($message_type instanceof EE_message_type) {
-                EE_Error::add_success(
-                    sprintf(
-                        esc_html__(
-                            '%s message type has been successfully activated with the %s messenger',
-                            'event_espresso'
-                        ),
-                        ucwords($message_type->label['singular']),
-                        ucwords($messenger->label['singular'])
-                    )
-                );
-
-                // if message type was invoice then let's make sure we activate the invoice payment method.
-                if ($message_type->name === 'invoice') {
-                    EE_Registry::instance()->load_lib('Payment_Method_Manager');
-                    $pm = EE_Payment_Method_Manager::instance()->activate_a_payment_method_of_type('Invoice');
-                    if ($pm instanceof EE_Payment_Method) {
-                        EE_Error::add_attention(
-                            esc_html__(
-                                'Activating the invoice message type also automatically activates the invoice payment method.  If you do not wish the invoice payment method to be active, or to change its settings, visit the payment method admin page.',
-                                'event_espresso'
-                            )
-                        );
-                    }
-                }
-                // just toggles the entire messenger
-            } else {
-                EE_Error::add_success(
-                    sprintf(
-                        esc_html__('%s messenger has been successfully activated', 'event_espresso'),
-                        ucwords($messenger->label['singular'])
-                    )
-                );
-            }
-
-            return true;
-
-            // possible error condition. This will happen when our active_mts data is empty because it is validated for actual active
-            // message types after the activation process.  However its possible some messengers don't HAVE any default_message_types
-            // in which case we just give a success message for the messenger being successfully activated.
-        } else {
-            if (! $messenger->get_default_message_types()) {
-                // messenger doesn't have any default message types so still a success.
-                EE_Error::add_success(
-                    sprintf(
-                        esc_html__('%s messenger was successfully activated.', 'event_espresso'),
-                        ucwords($messenger->label['singular'])
-                    )
-                );
-
-                return true;
-            } else {
-                EE_Error::add_error(
-                    $message_type instanceof EE_message_type
-                        ? sprintf(
-                            esc_html__(
-                                '%s message type was not successfully activated with the %s messenger',
-                                'event_espresso'
-                            ),
-                            ucwords($message_type->label['singular']),
-                            ucwords($messenger->label['singular'])
-                        )
-                        : sprintf(
-                            esc_html__('%s messenger was not successfully activated', 'event_espresso'),
-                            ucwords($messenger->label['singular'])
-                        ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-
-                return false;
-            }
-        }
-    }
-
-
-    /**
-     * This sets up the appropriate response for deactivating a messenger and/or message type.
-     *
-     * @param EE_messenger         $messenger
-     * @param EE_message_type|null $message_type
-     * @return bool
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _setup_response_message_for_deactivating_messenger_with_message_types(
-        $messenger,
-        EE_message_type $message_type = null
-    ) {
-        EE_Error::overwrite_success();
-
-        // if $messenger isn't a valid messenger object then get out.
-        if (! $messenger instanceof EE_Messenger) {
-            EE_Error::add_error(
-                esc_html__('The messenger being deactivated is not a valid messenger', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-
-            return false;
-        }
-
-        if ($message_type instanceof EE_message_type) {
-            $message_type_name = $message_type->name;
-            EE_Error::add_success(
-                sprintf(
-                    esc_html__(
-                        '%s message type has been successfully deactivated for the %s messenger.',
-                        'event_espresso'
-                    ),
-                    ucwords($message_type->label['singular']),
-                    ucwords($messenger->label['singular'])
-                )
-            );
-        } else {
-            $message_type_name = '';
-            EE_Error::add_success(
-                sprintf(
-                    esc_html__('%s messenger has been successfully deactivated.', 'event_espresso'),
-                    ucwords($messenger->label['singular'])
-                )
-            );
-        }
-
-        // if messenger was html or message type was invoice then let's make sure we deactivate invoice payment method.
-        if ($messenger->name === 'html' || $message_type_name === 'invoice') {
-            EE_Registry::instance()->load_lib('Payment_Method_Manager');
-            $count_updated = EE_Payment_Method_Manager::instance()->deactivate_payment_method('invoice');
-            if ($count_updated > 0) {
-                $msg = $message_type_name === 'invoice'
-                    ? esc_html__(
-                        'Deactivating the invoice message type also automatically deactivates the invoice payment method. In order for invoices to be generated the invoice message type must be active. If you completed this action by mistake, simply reactivate the invoice message type and then visit the payment methods admin page to reactivate the invoice payment method.',
-                        'event_espresso'
-                    )
-                    : esc_html__(
-                        'Deactivating the html messenger also automatically deactivates the invoice payment method.  In order for invoices to be generated the html messenger must be be active.  If you completed this action by mistake, simply reactivate the html messenger, then visit the payment methods admin page to reactivate the invoice payment method.',
-                        'event_espresso'
-                    );
-                EE_Error::add_attention($msg);
-            }
-        }
-
-        return true;
-    }
-
-
-    /**
-     * handles updating a message type form on messenger activation IF the message type has settings fields. (via ajax)
-     *
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    public function update_mt_form()
-    {
-        if (! $this->_active_messenger_name || ! $this->_active_message_type_name) {
-            EE_Error::add_error(
-                esc_html__('Require message type or messenger to send an updated form', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $this->_return_json();
-        }
-
-        $message_types = $this->get_installed_message_types();
-        $message_type  = $message_types[ $this->_active_message_type_name ];
-        $messenger     = $this->_message_resource_manager->get_active_messenger($this->_active_messenger_name);
-        $content       = $this->_message_type_settings_content($message_type, $messenger, true);
-
-        $this->_template_args['success'] = true;
-        $this->_template_args['content'] = $content;
-        $this->_return_json();
-    }
-
-
-    /**
-     * this handles saving the settings for a messenger or message type
-     *
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    public function save_settings()
-    {
-        $type = $this->request->getRequestParam('type');
-        if (! $type) {
-            EE_Error::add_error(
-                esc_html__(
-                    'Cannot save settings because type is unknown (messenger settings or message type settings?)',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $this->_template_args['error'] = true;
-            $this->_return_json();
-        }
-
-
-        if ($type === 'messenger') {
-            // this should be an array.
-            $settings  = $this->request->getRequestParam('messenger_settings', [], 'string', true);
-            $messenger = $settings['messenger'];
-            // remove messenger and message_types from settings array
-            unset($settings['messenger'], $settings['message_types']);
-            $this->_message_resource_manager->add_settings_for_messenger($messenger, $settings);
-        } elseif ($type === 'message_type') {
-            $settings     = $this->request->getRequestParam('message_type_settings', [], 'string', true);
-            $messenger    = $settings['messenger'];
-            $message_type = $settings['message_type'];
-            // remove messenger and message_types from settings array
-            unset($settings['messenger'], $settings['message_types']);
-            $this->_message_resource_manager->add_settings_for_message_type($messenger, $message_type, $settings);
-        }
-
-        // okay we should have the data all setup.  Now we just update!
-        $success = $this->_message_resource_manager->update_active_messengers_option();
-
-        if ($success) {
-            EE_Error::add_success(esc_html__('Settings updated', 'event_espresso'));
-        } else {
-            EE_Error::add_error(
-                esc_html__('Settings did not get updated', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-
-        $this->_template_args['success'] = $success;
-        $this->_return_json();
-    }
-
-
-
-
-    /**  EE MESSAGE PROCESSING ACTIONS **/
-
-
-    /**
-     * This immediately generates any EE_Message ID's that are selected that are EEM_Message::status_incomplete
-     * However, this does not send immediately, it just queues for sending.
-     *
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @since 4.9.0
-     */
-    protected function _generate_now()
-    {
-        EED_Messages::generate_now($this->_get_msg_ids_from_request());
-        $this->_redirect_after_action(false, '', '', [], true);
-    }
-
-
-    /**
-     * This immediately generates AND sends any EE_Message's selected that are EEM_Message::status_incomplete or that
-     * are EEM_Message::status_resend or EEM_Message::status_idle
-     *
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @since 4.9.0
-     */
-    protected function _generate_and_send_now()
-    {
-        EED_Messages::generate_and_send_now($this->_get_msg_ids_from_request());
-        $this->_redirect_after_action(false, '', '', [], true);
-    }
-
-
-    /**
-     * This queues any EEM_Message::status_sent EE_Message ids in the request for resending.
-     *
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @since 4.9.0
-     */
-    protected function _queue_for_resending()
-    {
-        EED_Messages::queue_for_resending($this->_get_msg_ids_from_request());
-        $this->_redirect_after_action(false, '', '', [], true);
-    }
-
-
-    /**
-     *  This sends immediately any EEM_Message::status_idle or EEM_Message::status_resend messages in the queue
-     *
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @since 4.9.0
-     */
-    protected function _send_now()
-    {
-        EED_Messages::send_now($this->_get_msg_ids_from_request());
-        $this->_redirect_after_action(false, '', '', [], true);
-    }
-
-
-    /**
-     * Deletes EE_messages for IDs in the request.
-     *
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @since 4.9.0
-     */
-    protected function _delete_ee_messages()
-    {
-        $MSG_IDs       = $this->_get_msg_ids_from_request();
-        $deleted_count = 0;
-        foreach ($MSG_IDs as $MSG_ID) {
-            if (EEM_Message::instance()->delete_by_ID($MSG_ID)) {
-                $deleted_count++;
-            }
-        }
-        if ($deleted_count) {
-            EE_Error::add_success(
-                esc_html(
-                    _n(
-                        'Message successfully deleted',
-                        'Messages successfully deleted',
-                        $deleted_count,
-                        'event_espresso'
-                    )
-                )
-            );
-        } else {
-            EE_Error::add_error(
-                _n('The message was not deleted.', 'The messages were not deleted', count($MSG_IDs), 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        $this->_redirect_after_action(false, '', '', [], true);
-    }
-
-
-    /**
-     *  This looks for 'MSG_ID' key in the request and returns an array of MSG_ID's if present.
-     *
-     * @return array
-     * @since 4.9.0
-     */
-    protected function _get_msg_ids_from_request()
-    {
-        $MSG_IDs = $this->request->getRequestParam('MSG_ID', [], 'string', true);
-        if (empty($MSG_IDs)) {
-            return [];
-        }
-        // if 'MSG_ID' was just a single ID (not an array)
-        // then $MSG_IDs will be something like [123] so $MSG_IDs[0] should be 123
-        // otherwise, $MSG_IDs was already an array where message IDs were used as the keys
-        return count($MSG_IDs) === 1 && isset($MSG_IDs[0])
-            ? $MSG_IDs
-            : array_keys($MSG_IDs);
-    }
+		$this->_context_switcher = ob_get_clean();
+	}
+
+
+	/**
+	 * utility for sanitizing new values coming in.
+	 * Note: this is only used when updating a context.
+	 *
+	 * @access protected
+	 *
+	 * @param int $index This helps us know which template field to select from the request array.
+	 *
+	 * @return array
+	 */
+	protected function _set_message_template_column_values($index)
+	{
+		return [
+			'MTP_ID'             => $this->request->getRequestParam('MTP_ID', 0, 'int'),
+			'GRP_ID'             => $this->request->getRequestParam('GRP_ID', 0, 'int'),
+			'MTP_user_id'        => $this->request->getRequestParam('MTP_user_id', 0, 'int'),
+			'MTP_messenger'      => strtolower($this->request->getRequestParam('MTP_messenger', '')),
+			'MTP_message_type'   => strtolower($this->request->getRequestParam('MTP_message_type', '')),
+			'MTP_template_field' => strtolower($this->request->getRequestParam("MTP_template_fields[{$index}][name]", '')),
+			'MTP_context'        => strtolower($this->request->getRequestParam('MTP_context', '')),
+			'MTP_content'        => $this->request->getRequestParam(
+				"MTP_template_fields[{$index}][content]",
+				'',
+				'string'
+			),
+			'MTP_is_global'      => $this->request->getRequestParam('MTP_is_global', 0, 'int'),
+			'MTP_is_override'    => $this->request->getRequestParam('MTP_is_override', 0, 'int'),
+			'MTP_deleted'        => $this->request->getRequestParam('MTP_deleted', 0, 'int'),
+			'MTP_is_active'      => $this->request->getRequestParam('MTP_is_active', 0, 'int'),
+		];
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _insert_or_update_message_template($new = false)
+	{
+
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$success  = 0;
+		$override = false;
+
+		// setup notices description
+		$messenger_slug = $this->request->getRequestParam('MTP_messenger', '');
+
+		// need the message type and messenger objects to be able to use the labels for the notices
+		$messenger_object = $this->_message_resource_manager->get_messenger($messenger_slug);
+		$messenger_label  = $messenger_object instanceof EE_messenger
+			? ucwords($messenger_object->label['singular'])
+			: '';
+
+		$message_type_slug   = $this->request->getRequestParam('MTP_message_type', '');
+		$message_type_object = $this->_message_resource_manager->get_message_type($message_type_slug);
+
+		$message_type_label = $message_type_object instanceof EE_message_type
+			? ucwords($message_type_object->label['singular'])
+			: '';
+
+		$context_slug = $this->request->getRequestParam('MTP_context', '');
+		$context      = ucwords(str_replace('_', ' ', $context_slug));
+
+		$item_desc   = $messenger_label && $message_type_label
+			? $messenger_label . ' ' . $message_type_label . ' ' . $context . ' '
+			: '';
+		$item_desc   .= 'Message Template';
+		$query_args  = [];
+		$edit_array  = [];
+		$action_desc = '';
+
+		$GRP_ID = $this->request->getRequestParam('GRP_ID', 0, 'int');
+		// if this is "new" then we need to generate the default contexts
+		// for the selected messenger/message_type for user to edit.
+		if ($new) {
+			if ($edit_array = $this->_generate_new_templates($messenger_slug, $message_type_slug, $GRP_ID)) {
+				if (empty($edit_array)) {
+					$success = 0;
+				} else {
+					$success    = 1;
+					$edit_array = $edit_array[0];
+					$query_args = [
+						'id'      => $edit_array['GRP_ID'],
+						'context' => $edit_array['MTP_context'],
+						'action'  => 'edit_message_template',
+					];
+				}
+			}
+			$action_desc = 'created';
+		} else {
+			$MTPG = EEM_Message_Template_Group::instance();
+			$MTP  = EEM_Message_Template::instance();
+
+
+			// run update for each template field in displayed context
+			$template_fields = $this->request->getRequestParam('MTP_template_fields');
+			if (! $template_fields) {
+				EE_Error::add_error(
+					esc_html__(
+						'There was a problem saving the template fields from the form because I didn\'t receive any actual template field data.',
+						'event_espresso'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+				$success = 0;
+			} else {
+				// first validate all fields!
+				// this filter allows client code to add its own validation to the template fields as well.
+				// returning an empty array means everything passed validation.
+				// errors in validation should be represented in an array with the following shape:
+				// array(
+				//   'fieldname' => array(
+				//          'msg' => 'error message'
+				//          'value' => 'value for field producing error'
+				// )
+				$custom_validation = (array) apply_filters(
+					'FHEE__Messages_Admin_Page___insert_or_update_message_template__validates',
+					[],
+					$template_fields,
+					$context_slug,
+					$messenger_slug,
+					$message_type_slug
+				);
+
+				$system_validation = $MTPG->validate(
+					$template_fields,
+					$context_slug,
+					$messenger_slug,
+					$message_type_slug
+				);
+
+				$system_validation = ! is_array($system_validation) && $system_validation ? []
+					: $system_validation;
+				$validates         = array_merge($custom_validation, $system_validation);
+
+				// if $validate returned error messages (i.e. is_array()) then we need to process them and setup an
+				// appropriate response. HMM, dang this isn't correct, $validates will ALWAYS be an array.
+				//  WE need to make sure there is no actual error messages in validates.
+				if (is_array($validates) && ! empty($validates)) {
+					// add the transient so when the form loads we know which fields to highlight
+					$this->_add_transient('edit_message_template', $validates);
+
+					$success = 0;
+
+					// setup notices
+					foreach ($validates as $error) {
+						if (isset($error['msg'])) {
+							EE_Error::add_error($error['msg'], __FILE__, __FUNCTION__, __LINE__);
+						}
+					}
+				} else {
+					$set_column_values = [];
+					foreach ($template_fields as $template_field => $content) {
+						$set_column_values = $this->_set_message_template_column_values($template_field);
+
+						$where_cols_n_values = ['MTP_ID' => $content['MTP_ID']];
+						// if they aren't allowed to use all JS, restrict them to just posty-y tags
+						if (! current_user_can('unfiltered_html')) {
+							if (is_array($set_column_values['MTP_content'])) {
+								foreach ($set_column_values['MTP_content'] as $key => $value) {
+									// remove slashes so wp_kses works properly (its wp_kses_stripslashes() function
+									// only removes slashes from double-quotes, so attributes using single quotes always
+									// appear invalid.) But currently the models expect slashed data, so after wp_kses
+									// runs we need to re-slash the data. Sheesh. See
+									// https://events.codebasehq.com/projects/event-espresso/tickets/11211#update-47321587
+									$set_column_values['MTP_content'][ $key ] = addslashes(
+										wp_kses(
+											stripslashes($value),
+											wp_kses_allowed_html('post')
+										)
+									);
+								}
+							} else {
+								$set_column_values['MTP_content'] = wp_kses(
+									$set_column_values['MTP_content'],
+									wp_kses_allowed_html('post')
+								);
+							}
+						}
+						$message_template_fields = [
+							'GRP_ID'             => $set_column_values['GRP_ID'],
+							'MTP_template_field' => $set_column_values['MTP_template_field'],
+							'MTP_context'        => $set_column_values['MTP_context'],
+							'MTP_content'        => $set_column_values['MTP_content'],
+						];
+						if ($updated = $MTP->update($message_template_fields, [$where_cols_n_values])) {
+							if ($updated === false) {
+								EE_Error::add_error(
+									sprintf(
+										esc_html__('%s field was NOT updated for some reason', 'event_espresso'),
+										$template_field
+									),
+									__FILE__,
+									__FUNCTION__,
+									__LINE__
+								);
+							} else {
+								$success = 1;
+							}
+						} else {
+							// only do this logic if we don't have a MTP_ID for this field
+							if (empty($content['MTP_ID'])) {
+								// this has already been through the template field validator and sanitized, so it will be
+								// safe to insert this field.  Why insert?  This typically happens when we introduce a new
+								// message template field in a messenger/message type and existing users don't have the
+								// default setup for it.
+								// @link https://events.codebasehq.com/projects/event-espresso/tickets/9465
+								$updated = $MTP->insert($message_template_fields);
+								if (! $updated || is_wp_error($updated)) {
+									EE_Error::add_error(
+										sprintf(
+											esc_html__('%s field could not be updated.', 'event_espresso'),
+											$template_field
+										),
+										__FILE__,
+										__FUNCTION__,
+										__LINE__
+									);
+									$success = 0;
+								} else {
+									$success = 1;
+								}
+							}
+						}
+						$action_desc = 'updated';
+					}
+
+					// we can use the last set_column_values for the MTPG update (because its the same for all of these specific MTPs)
+					$mtpg_fields = [
+						'MTP_user_id'      => $set_column_values['MTP_user_id'],
+						'MTP_messenger'    => $set_column_values['MTP_messenger'],
+						'MTP_message_type' => $set_column_values['MTP_message_type'],
+						'MTP_is_global'    => $set_column_values['MTP_is_global'],
+						'MTP_is_override'  => $set_column_values['MTP_is_override'],
+						'MTP_deleted'      => $set_column_values['MTP_deleted'],
+						'MTP_is_active'    => $set_column_values['MTP_is_active'],
+						'MTP_name'         => $this->request->getRequestParam('ee_msg_non_global_fields[MTP_name]', ''),
+						'MTP_description'  => $this->request->getRequestParam(
+							'ee_msg_non_global_fields[MTP_description]',
+							''
+						),
+					];
+
+					$mtpg_where = ['GRP_ID' => $set_column_values['GRP_ID']];
+					$updated    = $MTPG->update($mtpg_fields, [$mtpg_where]);
+
+					if ($updated === false) {
+						EE_Error::add_error(
+							sprintf(
+								esc_html__(
+									'The Message Template Group (%d) was NOT updated for some reason',
+									'event_espresso'
+								),
+								$set_column_values['GRP_ID']
+							),
+							__FILE__,
+							__FUNCTION__,
+							__LINE__
+						);
+					} else {
+						// k now we need to ensure the template_pack and template_variation fields are set.
+						$template_pack      = $this->request->getRequestParam('MTP_template_pack', 'default');
+						$template_variation = $this->request->getRequestParam('MTP_template_variation', 'default');
+
+						$mtpg_obj = $MTPG->get_one_by_ID($set_column_values['GRP_ID']);
+						if ($mtpg_obj instanceof EE_Message_Template_Group) {
+							$mtpg_obj->set_template_pack_name($template_pack);
+							$mtpg_obj->set_template_pack_variation($template_variation);
+						}
+						$success = 1;
+					}
+				}
+			}
+		}
+
+		// we return things differently if doing ajax
+		if (defined('DOING_AJAX') && DOING_AJAX) {
+			$this->_template_args['success'] = $success;
+			$this->_template_args['error']   = ! $success;
+			$this->_template_args['content'] = '';
+			$this->_template_args['data']    = [
+				'grpID'        => $edit_array['GRP_ID'],
+				'templateName' => $edit_array['template_name'],
+			];
+			if ($success) {
+				EE_Error::overwrite_success();
+				EE_Error::add_success(
+					esc_html__(
+						'The new template has been created and automatically selected for this event.  You can edit the new template by clicking the edit button.  Note before this template is assigned to this event, the event must be saved.',
+						'event_espresso'
+					)
+				);
+			}
+
+			$this->_return_json();
+		}
+
+
+		// was a test send triggered?
+		if ($this->request->getRequestParam('test_button', false, 'bool')) {
+			EE_Error::overwrite_success();
+			$this->_do_test_send($context_slug, $messenger_slug, $message_type_slug);
+			$override = true;
+		}
+
+		if (empty($query_args)) {
+			$query_args = [
+				'id'      => $GRP_ID,
+				'context' => $context_slug,
+				'action'  => 'edit_message_template',
+			];
+		}
+
+		$this->_redirect_after_action($success, $item_desc, $action_desc, $query_args, $override);
+	}
+
+
+	/**
+	 * processes a test send request to do an actual messenger delivery test for the given message template being tested
+	 *
+	 * @param string $context      what context being tested
+	 * @param string $messenger    messenger being tested
+	 * @param string $message_type message type being tested
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _do_test_send($context, $messenger, $message_type)
+	{
+		// set things up for preview
+		$this->request->setRequestParam('messenger', $messenger);
+		$this->request->setRequestParam('message_type', $message_type);
+		$this->request->setRequestParam('context', $context);
+		$GRP_ID = $this->request->getRequestParam('GRP_ID', 0, 'int');
+		$this->request->setRequestParam('GRP_ID', $GRP_ID);
+
+		$active_messenger  = $this->_message_resource_manager->get_active_messenger($messenger);
+		$test_settings_fld = $this->request->getRequestParam('test_settings_fld', [], 'string', true);
+
+		// let's save any existing fields that might be required by the messenger
+		if (
+			! empty($test_settings_fld)
+			&& $active_messenger instanceof EE_messenger
+			&& apply_filters(
+				'FHEE__Messages_Admin_Page__do_test_send__set_existing_test_settings',
+				true,
+				$test_settings_fld,
+				$active_messenger
+			)
+		) {
+			$active_messenger->set_existing_test_settings($test_settings_fld);
+		}
+
+		/**
+		 * Use filter to add additional controls on whether message can send or not
+		 */
+		if (
+			apply_filters(
+				'FHEE__Messages_Admin_Page__do_test_send__can_send',
+				true,
+				$context,
+				$this->request->requestParams(),
+				$messenger,
+				$message_type
+			)
+		) {
+			if (EEM_Event::instance()->count() > 0) {
+				$success = $this->_preview_message(true);
+				if ($success) {
+					EE_Error::add_success(esc_html__('Test message sent', 'event_espresso'));
+				} else {
+					EE_Error::add_error(
+						esc_html__('The test message was not sent', 'event_espresso'),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+				}
+			} else {
+				$this->noEventsErrorMessage(true);
+			}
+		}
+	}
+
+
+	/**
+	 * _generate_new_templates
+	 * This will handle the messenger, message_type selection when "adding a new custom template" for an event and will
+	 * automatically create the defaults for the event.  The user would then be redirected to edit the default context
+	 * for the event.
+	 *
+	 *
+	 * @param string $messenger      the messenger we are generating templates for
+	 * @param array  $message_types  array of message types that the templates are generated for.
+	 * @param int    $GRP_ID         If this is a custom template being generated then a GRP_ID needs to be included to
+	 *                               indicate the message_template_group being used as the base.
+	 *
+	 * @param bool   $global
+	 *
+	 * @return array|bool array of data required for the redirect to the correct edit page or bool if
+	 *                               encountering problems.
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _generate_new_templates($messenger, $message_types, $GRP_ID = 0, $global = false)
+	{
+
+		// if no $message_types are given then that's okay... this may be a messenger that just adds shortcodes, so we
+		// just don't generate any templates.
+		if (empty($message_types)) {
+			return true;
+		}
+
+		return EEH_MSG_Template::generate_new_templates($messenger, $message_types, $GRP_ID, $global);
+	}
+
+
+	/**
+	 * [_trash_or_restore_message_template]
+	 *
+	 * @param boolean $trash  whether to move an item to trash/restore (TRUE) or restore it (FALSE)
+	 * @param boolean $all    whether this is going to trash/restore all contexts within a template group (TRUE) OR just
+	 *                        an individual context (FALSE).
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _trash_or_restore_message_template($trash = true, $all = false)
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$MTP = EEM_Message_Template_Group::instance();
+
+		$success = 1;
+
+		// incoming GRP_IDs
+		if ($all) {
+			// Checkboxes
+			$checkboxes = $this->request->getRequestParam('checkbox', [], 'int', true);
+			if (! empty($checkboxes)) {
+				// if array has more than one element then success message should be plural.
+				// todo: what about nonce?
+				$success = count($checkboxes) > 1 ? 2 : 1;
+
+				// cycle through checkboxes
+				while (list($GRP_ID, $value) = each($checkboxes)) {
+					$trashed_or_restored = $trash ? $MTP->delete_by_ID($GRP_ID) : $MTP->restore_by_ID($GRP_ID);
+					if (! $trashed_or_restored) {
+						$success = 0;
+					}
+				}
+			} else {
+				// grab single GRP_ID and handle
+				$GRP_ID = $this->request->getRequestParam('id', 0, 'int');
+				if (! empty($GRP_ID)) {
+					$trashed_or_restored = $trash ? $MTP->delete_by_ID($GRP_ID) : $MTP->restore_by_ID($GRP_ID);
+					if (! $trashed_or_restored) {
+						$success = 0;
+					}
+				} else {
+					$success = 0;
+				}
+			}
+		}
+
+		$action_desc = $trash
+			? esc_html__('moved to the trash', 'event_espresso')
+			: esc_html__('restored', 'event_espresso');
+
+		$template_switch = $this->request->getRequestParam('template_switch', false, 'bool');
+		$action_desc     = $template_switch ? esc_html__('switched', 'event_espresso') : $action_desc;
+
+		$item_desc = $all ? _n(
+			'Message Template Group',
+			'Message Template Groups',
+			$success,
+			'event_espresso'
+		) : _n('Message Template Context', 'Message Template Contexts', $success, 'event_espresso');
+
+		$item_desc = $template_switch
+			? _n('template', 'templates', $success, 'event_espresso')
+			: $item_desc;
+
+		$this->_redirect_after_action($success, $item_desc, $action_desc, []);
+	}
+
+
+	/**
+	 * [_delete_message_template]
+	 * NOTE: this handles not only the deletion of the groups but also all the templates belonging to that group.
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _delete_message_template()
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+
+		// checkboxes
+		$checkboxes = $this->request->getRequestParam('checkbox', [], 'int', true);
+		if (! empty($checkboxes)) {
+			// if array has more than one element then success message should be plural
+			$success = count($checkboxes) > 1 ? 2 : 1;
+
+			// cycle through bulk action checkboxes
+			while (list($GRP_ID, $value) = each($checkboxes)) {
+				$success = $this->_delete_mtp_permanently($GRP_ID) ? $success : false;
+			}
+		} else {
+			// grab single grp_id and delete
+			$GRP_ID  = $this->request->getRequestParam('id', 0, 'int');
+			$success = $this->_delete_mtp_permanently($GRP_ID);
+		}
+
+		$this->_redirect_after_action($success, 'Message Templates', 'deleted', []);
+	}
+
+
+	/**
+	 * helper for permanently deleting a mtP group and all related message_templates
+	 *
+	 * @param int  $GRP_ID        The group being deleted
+	 * @param bool $include_group whether to delete the Message Template Group as well.
+	 * @return bool boolean to indicate the success of the deletes or not.
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws ReflectionException
+	 */
+	private function _delete_mtp_permanently($GRP_ID, $include_group = true)
+	{
+		$success = true;
+		$MTPG    = EEM_Message_Template_Group::instance();
+		// first let's GET this group
+		$MTG = $MTPG->get_one_by_ID($GRP_ID);
+		// then delete permanently all the related Message Templates
+		$deleted = $MTG->delete_related_permanently('Message_Template');
+
+		if ($deleted === 0) {
+			$success = false;
+		}
+
+		// now delete permanently this particular group
+
+		if ($include_group && ! $MTG->delete_permanently()) {
+			$success = false;
+		}
+
+		return $success;
+	}
+
+
+	/**
+	 *    _learn_more_about_message_templates_link
+	 *
+	 * @access protected
+	 * @return string
+	 */
+	protected function _learn_more_about_message_templates_link()
+	{
+		return '<a class="hidden" style="margin:0 20px; cursor:pointer; font-size:12px;" >'
+			   . esc_html__('learn more about how message templates works', 'event_espresso')
+			   . '</a>';
+	}
+
+
+	/**
+	 * Used for setting up messenger/message type activation.  This loads up the initial view.  The rest is handled by
+	 * ajax and other routes.
+	 *
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	protected function _settings()
+	{
+		$this->_set_m_mt_settings();
+
+		// let's setup the messenger tabs
+		$this->_template_args['admin_page_header'] = EEH_Tabbed_Content::tab_text_links(
+			$this->_m_mt_settings['messenger_tabs'],
+			'messenger_links',
+			'|',
+			$this->request->getRequestParam('selected_messenger', 'email')
+		);
+
+		$this->_template_args['before_admin_page_content'] = '<div class="ui-widget ui-helper-clearfix">';
+		$this->_template_args['after_admin_page_content']  = '</div><!-- end .ui-widget -->';
+
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	/**
+	 * This sets the $_m_mt_settings property for when needed (used on the Messages settings page)
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws DomainException
+	 */
+	protected function _set_m_mt_settings()
+	{
+		// first if this is already set then lets get out no need to regenerate data.
+		if (! empty($this->_m_mt_settings)) {
+			return;
+		}
+
+		// get all installed messengers and message_types
+		$messengers    = $this->_message_resource_manager->installed_messengers();
+		$message_types = $this->_message_resource_manager->installed_message_types();
+
+
+		// assemble the array for the _tab_text_links helper
+
+		foreach ($messengers as $messenger) {
+			$this->_m_mt_settings['messenger_tabs'][ $messenger->name ] = [
+				'label' => ucwords($messenger->label['singular']),
+				'class' => $this->_message_resource_manager->is_messenger_active($messenger->name)
+					? 'messenger-active'
+					: '',
+				'href'  => $messenger->name,
+				'title' => esc_html__('Modify this Messenger', 'event_espresso'),
+				'slug'  => $messenger->name,
+				'obj'   => $messenger,
+			];
+
+
+			$message_types_for_messenger = $messenger->get_valid_message_types();
+
+			foreach ($message_types as $message_type) {
+				// first we need to verify that this message type is valid with this messenger. Cause if it isn't then
+				// it shouldn't show in either the inactive OR active metabox.
+				if (! in_array($message_type->name, $message_types_for_messenger, true)) {
+					continue;
+				}
+
+				$a_or_i = $this->_message_resource_manager->is_message_type_active_for_messenger(
+					$messenger->name,
+					$message_type->name
+				)
+					? 'active'
+					: 'inactive';
+
+				$this->_m_mt_settings['message_type_tabs'][ $messenger->name ][ $a_or_i ][ $message_type->name ] = [
+					'label'    => ucwords($message_type->label['singular']),
+					'class'    => 'message-type-' . $a_or_i,
+					'slug_id'  => $message_type->name . '-messagetype-' . $messenger->name,
+					'mt_nonce' => wp_create_nonce($message_type->name . '_nonce'),
+					'href'     => 'espresso_' . $message_type->name . '_message_type_settings',
+					'title'    => $a_or_i === 'active'
+						? esc_html__('Drag this message type to the Inactive window to deactivate', 'event_espresso')
+						: esc_html__('Drag this message type to the messenger to activate', 'event_espresso'),
+					'content'  => $a_or_i === 'active'
+						? $this->_message_type_settings_content($message_type, $messenger, true)
+						: $this->_message_type_settings_content($message_type, $messenger),
+					'slug'     => $message_type->name,
+					'active'   => $a_or_i === 'active',
+					'obj'      => $message_type,
+				];
+			}
+		}
+	}
+
+
+	/**
+	 * This just prepares the content for the message type settings
+	 *
+	 * @param EE_message_type $message_type The message type object
+	 * @param EE_messenger    $messenger    The messenger object
+	 * @param boolean         $active       Whether the message type is active or not
+	 * @return string html output for the content
+	 * @throws DomainException
+	 */
+	protected function _message_type_settings_content($message_type, $messenger, $active = false)
+	{
+		// get message type fields
+		$fields                                         = $message_type->get_admin_settings_fields();
+		$settings_template_args['template_form_fields'] = '';
+
+		if (! empty($fields) && $active) {
+			$existing_settings = $message_type->get_existing_admin_settings($messenger->name);
+			foreach ($fields as $fldname => $fldprops) {
+				$field_id                         = $messenger->name . '-' . $message_type->name . '-' . $fldname;
+				$template_form_field[ $field_id ] = [
+					'name'       => 'message_type_settings[' . $fldname . ']',
+					'label'      => $fldprops['label'],
+					'input'      => $fldprops['field_type'],
+					'type'       => $fldprops['value_type'],
+					'required'   => $fldprops['required'],
+					'validation' => $fldprops['validation'],
+					'value'      => isset($existing_settings[ $fldname ])
+						? $existing_settings[ $fldname ]
+						: $fldprops['default'],
+					'options'    => isset($fldprops['options'])
+						? $fldprops['options']
+						: [],
+					'default'    => isset($existing_settings[ $fldname ])
+						? $existing_settings[ $fldname ]
+						: $fldprops['default'],
+					'css_class'  => 'no-drag',
+					'format'     => $fldprops['format'],
+				];
+			}
+
+
+			$settings_template_args['template_form_fields'] = ! empty($template_form_field)
+				? $this->_generate_admin_form_fields(
+					$template_form_field,
+					'string',
+					'ee_mt_activate_form'
+				)
+				: '';
+		}
+
+		$settings_template_args['description'] = $message_type->description;
+		// we also need some hidden fields
+		$hidden_fields = [
+			'message_type_settings[messenger]' . $message_type->name    => [
+				'type'  => 'hidden',
+				'value' => $messenger->name,
+			],
+			'message_type_settings[message_type]' . $message_type->name => [
+				'type'  => 'hidden',
+				'value' => $message_type->name,
+			],
+			'type' . $message_type->name                                => [
+				'type'  => 'hidden',
+				'value' => 'message_type',
+			],
+		];
+
+		$settings_template_args['hidden_fields'] = $this->_generate_admin_form_fields(
+			$hidden_fields,
+			'array'
+		);
+		$settings_template_args['show_form']     = empty($settings_template_args['template_form_fields'])
+			? ' hidden'
+			: '';
+
+
+		$template = EE_MSG_TEMPLATE_PATH . 'ee_msg_mt_settings_content.template.php';
+		return EEH_Template::display_template($template, $settings_template_args, true);
+	}
+
+
+	/**
+	 * Generate all the metaboxes for the message types and register them for the messages settings page.
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws DomainException
+	 */
+	protected function _messages_settings_metaboxes()
+	{
+		$this->_set_m_mt_settings();
+		$m_boxes         = $mt_boxes = [];
+		$m_template_args = $mt_template_args = [];
+
+		$selected_messenger = $this->request->getRequestParam('selected_messenger', 'email');
+
+		if (isset($this->_m_mt_settings['messenger_tabs'])) {
+			foreach ($this->_m_mt_settings['messenger_tabs'] as $messenger => $tab_array) {
+				$is_messenger_active = $this->_message_resource_manager->is_messenger_active($messenger);
+				$hide_on_message     = $is_messenger_active ? '' : 'hidden';
+				$hide_off_message    = $is_messenger_active ? 'hidden' : '';
+
+				// messenger meta boxes
+				$active         = $selected_messenger === $messenger;
+				$active_mt_tabs = isset($this->_m_mt_settings['message_type_tabs'][ $messenger ]['active'])
+					? $this->_m_mt_settings['message_type_tabs'][ $messenger ]['active']
+					: '';
+
+				$m_boxes[ $messenger . '_a_box' ] = sprintf(
+					esc_html__('%s Settings', 'event_espresso'),
+					$tab_array['label']
+				);
+
+				$m_template_args[ $messenger . '_a_box' ] = [
+					'active_message_types'   => ! empty($active_mt_tabs) ? $this->_get_mt_tabs($active_mt_tabs) : '',
+					'inactive_message_types' => isset(
+						$this->_m_mt_settings['message_type_tabs'][ $messenger ]['inactive']
+					)
+						? $this->_get_mt_tabs($this->_m_mt_settings['message_type_tabs'][ $messenger ]['inactive'])
+						: '',
+					'content'                => $this->_get_messenger_box_content($tab_array['obj']),
+					'hidden'                 => $active ? '' : ' hidden',
+					'hide_on_message'        => $hide_on_message,
+					'messenger'              => $messenger,
+					'active'                 => $active,
+				];
+
+				// message type meta boxes
+				// (which is really just the inactive container for each messenger
+				// showing inactive message types for that messenger)
+				$mt_boxes[ $messenger . '_i_box' ]         = esc_html__('Inactive Message Types', 'event_espresso');
+				$mt_template_args[ $messenger . '_i_box' ] = [
+					'active_message_types'   => ! empty($active_mt_tabs) ? $this->_get_mt_tabs($active_mt_tabs) : '',
+					'inactive_message_types' => isset(
+						$this->_m_mt_settings['message_type_tabs'][ $messenger ]['inactive']
+					)
+						? $this->_get_mt_tabs($this->_m_mt_settings['message_type_tabs'][ $messenger ]['inactive'])
+						: '',
+					'hidden'                 => $active ? '' : ' hidden',
+					'hide_on_message'        => $hide_on_message,
+					'hide_off_message'       => $hide_off_message,
+					'messenger'              => $messenger,
+					'active'                 => $active,
+				];
+			}
+		}
+
+
+		// register messenger metaboxes
+		$m_template_path = EE_MSG_TEMPLATE_PATH . 'ee_msg_details_messenger_mt_meta_box.template.php';
+		foreach ($m_boxes as $box => $label) {
+			$callback_args = ['template_path' => $m_template_path, 'template_args' => $m_template_args[ $box ]];
+			$msgr          = str_replace('_a_box', '', $box);
+			add_meta_box(
+				'espresso_' . $msgr . '_settings',
+				$label,
+				function ($post, $metabox) {
+					EEH_Template::display_template(
+						$metabox['args']['template_path'],
+						$metabox['args']['template_args']
+					);
+				},
+				$this->_current_screen->id,
+				'normal',
+				'high',
+				$callback_args
+			);
+		}
+
+		// register message type metaboxes
+		$mt_template_path = EE_MSG_TEMPLATE_PATH . 'ee_msg_details_messenger_meta_box.template.php';
+		foreach ($mt_boxes as $box => $label) {
+			$callback_args = [
+				'template_path' => $mt_template_path,
+				'template_args' => $mt_template_args[ $box ],
+			];
+			$mt            = str_replace('_i_box', '', $box);
+			add_meta_box(
+				'espresso_' . $mt . '_inactive_mts',
+				$label,
+				function ($post, $metabox) {
+					EEH_Template::display_template(
+						$metabox['args']['template_path'],
+						$metabox['args']['template_args']
+					);
+				},
+				$this->_current_screen->id,
+				'side',
+				'high',
+				$callback_args
+			);
+		}
+
+		// register metabox for global messages settings but only when on the main site.  On single site installs this
+		// will always result in the metabox showing, on multisite installs the metabox will only show on the main site.
+		if (is_main_site()) {
+			add_meta_box(
+				'espresso_global_message_settings',
+				esc_html__('Global Message Settings', 'event_espresso'),
+				[$this, 'global_messages_settings_metabox_content'],
+				$this->_current_screen->id,
+				'normal',
+				'low',
+				[]
+			);
+		}
+	}
+
+
+	/**
+	 *  This generates the content for the global messages settings metabox.
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function global_messages_settings_metabox_content()
+	{
+		$form = $this->_generate_global_settings_form();
+		// already escaped
+		echo $form->form_open(
+			$this->add_query_args_and_nonce(['action' => 'update_global_settings'], EE_MSG_ADMIN_URL),
+			'POST'
+		);
+		echo $form->get_html();
+		echo $form->form_close();
+	}
+
+
+	/**
+	 * This generates and returns the form object for the global messages settings.
+	 *
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _generate_global_settings_form()
+	{
+		/** @var EE_Network_Core_Config $network_config */
+		$network_config = EE_Registry::instance()->NET_CFG->core;
+
+		return new EE_Form_Section_Proper(
+			[
+				'name'            => 'global_messages_settings',
+				'html_id'         => 'global_messages_settings',
+				'html_class'      => 'form-table',
+				'layout_strategy' => new EE_Admin_Two_Column_Layout(),
+				'subsections'     => apply_filters(
+					'FHEE__Messages_Admin_Page__global_messages_settings_metabox_content__form_subsections',
+					[
+						'do_messages_on_same_request' => new EE_Select_Input(
+							[
+								true  => esc_html__('On the same request', 'event_espresso'),
+								false => esc_html__('On a separate request', 'event_espresso'),
+							],
+							[
+								'default'         => $network_config->do_messages_on_same_request,
+								'html_label_text' => esc_html__(
+									'Generate and send all messages:',
+									'event_espresso'
+								),
+								'html_help_text'  => esc_html__(
+									'By default the messages system uses a more efficient means of processing messages on separate requests and utilizes the wp-cron scheduling system.  This makes things execute faster for people registering for your events.  However, if the wp-cron system is disabled on your site and there is no alternative in place, then you can change this so messages are always executed on the same request.',
+									'event_espresso'
+								),
+							]
+						),
+						'delete_threshold'            => new EE_Select_Input(
+							[
+								0  => esc_html__('Forever', 'event_espresso'),
+								3  => esc_html__('3 Months', 'event_espresso'),
+								6  => esc_html__('6 Months', 'event_espresso'),
+								9  => esc_html__('9 Months', 'event_espresso'),
+								12 => esc_html__('12 Months', 'event_espresso'),
+								24 => esc_html__('24 Months', 'event_espresso'),
+								36 => esc_html__('36 Months', 'event_espresso'),
+							],
+							[
+								'default'         => EE_Registry::instance()->CFG->messages->delete_threshold,
+								'html_label_text' => esc_html__('Cleanup of old messages:', 'event_espresso'),
+								'html_help_text'  => esc_html__(
+									'You can control how long a record of processed messages is kept via this option.',
+									'event_espresso'
+								),
+							]
+						),
+						'update_settings'             => new EE_Submit_Input(
+							[
+								'default'         => esc_html__('Update', 'event_espresso'),
+								'html_label_text' => '&nbsp',
+							]
+						),
+					]
+				),
+			]
+		);
+	}
+
+
+	/**
+	 * This handles updating the global settings set on the admin page.
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 */
+	protected function _update_global_settings()
+	{
+		/** @var EE_Network_Core_Config $network_config */
+		$network_config  = EE_Registry::instance()->NET_CFG->core;
+		$messages_config = EE_Registry::instance()->CFG->messages;
+		$form            = $this->_generate_global_settings_form();
+		if ($form->was_submitted()) {
+			$form->receive_form_submission();
+			if ($form->is_valid()) {
+				$valid_data = $form->valid_data();
+				foreach ($valid_data as $property => $value) {
+					$setter = 'set_' . $property;
+					if (method_exists($network_config, $setter)) {
+						$network_config->{$setter}($value);
+					} elseif (
+						property_exists($network_config, $property)
+						&& $network_config->{$property} !== $value
+					) {
+						$network_config->{$property} = $value;
+					} elseif (
+						property_exists($messages_config, $property)
+						&& $messages_config->{$property} !== $value
+					) {
+						$messages_config->{$property} = $value;
+					}
+				}
+				// only update if the form submission was valid!
+				EE_Registry::instance()->NET_CFG->update_config(true, false);
+				EE_Registry::instance()->CFG->update_espresso_config();
+				EE_Error::overwrite_success();
+				EE_Error::add_success(esc_html__('Global message settings were updated', 'event_espresso'));
+			}
+		}
+		$this->_redirect_after_action(0, '', '', ['action' => 'settings'], true);
+	}
+
+
+	/**
+	 * this prepares the messenger tabs that can be dragged in and out of messenger boxes to activate/deactivate
+	 *
+	 * @param array $tab_array This is an array of message type tab details used to generate the tabs
+	 * @return string html formatted tabs
+	 * @throws DomainException
+	 */
+	protected function _get_mt_tabs($tab_array)
+	{
+		$tab_array = (array) $tab_array;
+		$template  = EE_MSG_TEMPLATE_PATH . 'ee_msg_details_mt_settings_tab_item.template.php';
+		$tabs      = '';
+
+		foreach ($tab_array as $tab) {
+			$tabs .= EEH_Template::display_template($template, $tab, true);
+		}
+
+		return $tabs;
+	}
+
+
+	/**
+	 * This prepares the content of the messenger meta box admin settings
+	 *
+	 * @param EE_messenger $messenger The messenger we're setting up content for
+	 * @return string html formatted content
+	 * @throws DomainException
+	 */
+	protected function _get_messenger_box_content(EE_messenger $messenger)
+	{
+
+		$fields                                         = $messenger->get_admin_settings_fields();
+		$settings_template_args['template_form_fields'] = '';
+
+		// is $messenger active?
+		$settings_template_args['active'] = $this->_message_resource_manager->is_messenger_active($messenger->name);
+
+
+		if (! empty($fields)) {
+			$existing_settings = $messenger->get_existing_admin_settings();
+
+			foreach ($fields as $fldname => $fldprops) {
+				$field_id                         = $messenger->name . '-' . $fldname;
+				$template_form_field[ $field_id ] = [
+					'name'       => 'messenger_settings[' . $field_id . ']',
+					'label'      => $fldprops['label'],
+					'input'      => $fldprops['field_type'],
+					'type'       => $fldprops['value_type'],
+					'required'   => $fldprops['required'],
+					'validation' => $fldprops['validation'],
+					'value'      => isset($existing_settings[ $field_id ])
+						? $existing_settings[ $field_id ]
+						: $fldprops['default'],
+					'css_class'  => '',
+					'format'     => $fldprops['format'],
+				];
+			}
+
+
+			$settings_template_args['template_form_fields'] = ! empty($template_form_field)
+				? $this->_generate_admin_form_fields($template_form_field, 'string', 'ee_m_activate_form')
+				: '';
+		}
+
+		// we also need some hidden fields
+		$settings_template_args['hidden_fields'] = [
+			'messenger_settings[messenger]' . $messenger->name => [
+				'type'  => 'hidden',
+				'value' => $messenger->name,
+			],
+			'type' . $messenger->name                          => [
+				'type'  => 'hidden',
+				'value' => 'messenger',
+			],
+		];
+
+		// make sure any active message types that are existing are included in the hidden fields
+		if (isset($this->_m_mt_settings['message_type_tabs'][ $messenger->name ]['active'])) {
+			foreach ($this->_m_mt_settings['message_type_tabs'][ $messenger->name ]['active'] as $mt => $values) {
+				$settings_template_args['hidden_fields'][ 'messenger_settings[message_types][' . $mt . ']' ] = [
+					'type'  => 'hidden',
+					'value' => $mt,
+				];
+			}
+		}
+		$settings_template_args['hidden_fields'] = $this->_generate_admin_form_fields(
+			$settings_template_args['hidden_fields'],
+			'array'
+		);
+		$active                                  =
+			$this->_message_resource_manager->is_messenger_active($messenger->name);
+
+		$settings_template_args['messenger']           = $messenger->name;
+		$settings_template_args['description']         = $messenger->description;
+		$settings_template_args['show_hide_edit_form'] = $active ? '' : ' hidden';
+
+
+		$settings_template_args['show_hide_edit_form'] = $this->_message_resource_manager->is_messenger_active(
+			$messenger->name
+		)
+			? $settings_template_args['show_hide_edit_form']
+			: ' hidden';
+
+		$settings_template_args['show_hide_edit_form'] = empty($settings_template_args['template_form_fields'])
+			? ' hidden'
+			: $settings_template_args['show_hide_edit_form'];
+
+
+		$settings_template_args['on_off_action'] = $active ? 'messenger-off' : 'messenger-on';
+		$settings_template_args['nonce']         = wp_create_nonce('activate_' . $messenger->name . '_toggle_nonce');
+		$settings_template_args['on_off_status'] = $active;
+		$template                                = EE_MSG_TEMPLATE_PATH . 'ee_msg_m_settings_content.template.php';
+		return EEH_Template::display_template(
+			$template,
+			$settings_template_args,
+			true
+		);
+	}
+
+
+	/**
+	 * used by ajax on the messages settings page to activate|deactivate the messenger
+	 *
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 */
+	public function activate_messenger_toggle()
+	{
+		$success = true;
+		$this->_prep_default_response_for_messenger_or_message_type_toggle();
+		// let's check that we have required data
+
+		if (! $this->_active_messenger_name) {
+			EE_Error::add_error(
+				esc_html__('Messenger name needed to toggle activation. None given', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$success = false;
+		}
+
+		// do a nonce check here since we're not arriving via a normal route
+		$nonce     = $this->request->getRequestParam('activate_nonce', '');
+		$nonce_ref = "activate_{$this->_active_messenger_name}_toggle_nonce";
+
+		$this->_verify_nonce($nonce, $nonce_ref);
+
+
+		$status = $this->request->getRequestParam('status');
+		if (! $status) {
+			EE_Error::add_error(
+				esc_html__(
+					'Messenger status needed to know whether activation or deactivation is happening. No status is given',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$success = false;
+		}
+
+		// do check to verify we have a valid status.
+		if ($status !== 'off' && $status !== 'on') {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__('The given status (%s) is not valid. Must be "off" or "on"', 'event_espresso'),
+					$status
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$success = false;
+		}
+
+		if ($success) {
+			// made it here?  Stop dawdling then!!
+			$success = $status === 'off'
+				? $this->_deactivate_messenger($this->_active_messenger_name)
+				: $this->_activate_messenger($this->_active_messenger_name);
+		}
+
+		$this->_template_args['success'] = $success;
+
+		// no special instructions so let's just do the json return (which should automatically do all the special stuff).
+		$this->_return_json();
+	}
+
+
+	/**
+	 * used by ajax from the messages settings page to activate|deactivate a message type
+	 *
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	public function activate_mt_toggle()
+	{
+		$success = true;
+		$this->_prep_default_response_for_messenger_or_message_type_toggle();
+
+		// let's make sure we have the necessary data
+		if (! $this->_active_message_type_name) {
+			EE_Error::add_error(
+				esc_html__('Message Type name needed to toggle activation. None given', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$success = false;
+		}
+
+		if (! $this->_active_messenger_name) {
+			EE_Error::add_error(
+				esc_html__('Messenger name needed to toggle activation. None given', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$success = false;
+		}
+
+		$status = $this->request->getRequestParam('status');
+		if (! $status) {
+			EE_Error::add_error(
+				esc_html__(
+					'Messenger status needed to know whether activation or deactivation is happening. No status is given',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$success = false;
+		}
+
+
+		// do check to verify we have a valid status.
+		if ($status !== 'activate' && $status !== 'deactivate') {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__('The given status (%s) is not valid. Must be "active" or "inactive"', 'event_espresso'),
+					$status
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$success = false;
+		}
+
+
+		// do a nonce check here since we're not arriving via a normal route
+		$nonce = $this->request->getRequestParam('mt_nonce', '');
+		$this->_verify_nonce($nonce, "{$this->_active_message_type_name}_nonce");
+
+		if ($success) {
+			// made it here? um, what are you waiting for then?
+			$success = $status === 'deactivate'
+				? $this->_deactivate_message_type_for_messenger(
+					$this->_active_messenger_name,
+					$this->_active_message_type_name
+				)
+				: $this->_activate_message_type_for_messenger(
+					$this->_active_messenger_name,
+					$this->_active_message_type_name
+				);
+		}
+
+		$this->_template_args['success'] = $success;
+		$this->_return_json();
+	}
+
+
+	/**
+	 * Takes care of processing activating a messenger and preparing the appropriate response.
+	 *
+	 * @param string $messenger_name The name of the messenger being activated
+	 * @return bool
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _activate_messenger($messenger_name)
+	{
+		$active_messenger          = $this->_message_resource_manager->get_messenger($messenger_name);
+		$message_types_to_activate = $active_messenger instanceof EE_Messenger
+			? $active_messenger->get_default_message_types()
+			: [];
+
+		// ensure is active
+		$this->_message_resource_manager->activate_messenger($active_messenger, $message_types_to_activate);
+
+		// set response_data for reload
+		foreach ($message_types_to_activate as $message_type_name) {
+			$message_type = $this->_message_resource_manager->get_message_type($message_type_name);
+			if (
+				$this->_message_resource_manager->is_message_type_active_for_messenger(
+					$messenger_name,
+					$message_type_name
+				)
+				&& $message_type instanceof EE_message_type
+			) {
+				$this->_template_args['data']['active_mts'][] = $message_type_name;
+				if ($message_type->get_admin_settings_fields()) {
+					$this->_template_args['data']['mt_reload'][] = $message_type_name;
+				}
+			}
+		}
+
+		// add success message for activating messenger
+		return $this->_setup_response_message_for_activating_messenger_with_message_types($active_messenger);
+	}
+
+
+	/**
+	 * Takes care of processing deactivating a messenger and preparing the appropriate response.
+	 *
+	 * @param string $messenger_name The name of the messenger being activated
+	 * @return bool
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _deactivate_messenger($messenger_name)
+	{
+		$active_messenger = $this->_message_resource_manager->get_messenger($messenger_name);
+		$this->_message_resource_manager->deactivate_messenger($messenger_name);
+
+		return $this->_setup_response_message_for_deactivating_messenger_with_message_types($active_messenger);
+	}
+
+
+	/**
+	 * Takes care of processing activating a message type for a messenger and preparing the appropriate response.
+	 *
+	 * @param string $messenger_name    The name of the messenger the message type is being activated for.
+	 * @param string $message_type_name The name of the message type being activated for the messenger
+	 * @return bool
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _activate_message_type_for_messenger($messenger_name, $message_type_name)
+	{
+		$active_messenger         = $this->_message_resource_manager->get_messenger($messenger_name);
+		$message_type_to_activate = $this->_message_resource_manager->get_message_type($message_type_name);
+
+		// ensure is active
+		$this->_message_resource_manager->activate_messenger($active_messenger, $message_type_name);
+
+		// set response for load
+		if (
+			$this->_message_resource_manager->is_message_type_active_for_messenger(
+				$messenger_name,
+				$message_type_name
+			)
+		) {
+			$this->_template_args['data']['active_mts'][] = $message_type_name;
+			if ($message_type_to_activate->get_admin_settings_fields()) {
+				$this->_template_args['data']['mt_reload'][] = $message_type_name;
+			}
+		}
+
+		return $this->_setup_response_message_for_activating_messenger_with_message_types(
+			$active_messenger,
+			$message_type_to_activate
+		);
+	}
+
+
+	/**
+	 * Takes care of processing deactivating a message type for a messenger and preparing the appropriate response.
+	 *
+	 * @param string $messenger_name    The name of the messenger the message type is being deactivated for.
+	 * @param string $message_type_name The name of the message type being deactivated for the messenger
+	 * @return bool
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _deactivate_message_type_for_messenger($messenger_name, $message_type_name)
+	{
+		$active_messenger = $this->_message_resource_manager->get_messenger($messenger_name);
+		/** @var EE_message_type $message_type_to_activate This will be present because it can't be toggled if it isn't */
+		$message_type_to_deactivate = $this->_message_resource_manager->get_message_type($message_type_name);
+		$this->_message_resource_manager->deactivate_message_type_for_messenger($message_type_name, $messenger_name);
+
+		return $this->_setup_response_message_for_deactivating_messenger_with_message_types(
+			$active_messenger,
+			$message_type_to_deactivate
+		);
+	}
+
+
+	/**
+	 * This just initializes the defaults for activating messenger and message type responses.
+	 */
+	protected function _prep_default_response_for_messenger_or_message_type_toggle()
+	{
+		$this->_template_args['data']['active_mts'] = [];
+		$this->_template_args['data']['mt_reload']  = [];
+	}
+
+
+	/**
+	 * Setup appropriate response for activating a messenger and/or message types
+	 *
+	 * @param EE_messenger         $messenger
+	 * @param EE_message_type|null $message_type
+	 * @return bool
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _setup_response_message_for_activating_messenger_with_message_types(
+		$messenger,
+		EE_Message_Type $message_type = null
+	) {
+		// if $messenger isn't a valid messenger object then get out.
+		if (! $messenger instanceof EE_Messenger) {
+			EE_Error::add_error(
+				esc_html__('The messenger being activated is not a valid messenger', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		// activated
+		if ($this->_template_args['data']['active_mts']) {
+			EE_Error::overwrite_success();
+			// activated a message type with the messenger
+			if ($message_type instanceof EE_message_type) {
+				EE_Error::add_success(
+					sprintf(
+						esc_html__(
+							'%s message type has been successfully activated with the %s messenger',
+							'event_espresso'
+						),
+						ucwords($message_type->label['singular']),
+						ucwords($messenger->label['singular'])
+					)
+				);
+
+				// if message type was invoice then let's make sure we activate the invoice payment method.
+				if ($message_type->name === 'invoice') {
+					EE_Registry::instance()->load_lib('Payment_Method_Manager');
+					$pm = EE_Payment_Method_Manager::instance()->activate_a_payment_method_of_type('Invoice');
+					if ($pm instanceof EE_Payment_Method) {
+						EE_Error::add_attention(
+							esc_html__(
+								'Activating the invoice message type also automatically activates the invoice payment method.  If you do not wish the invoice payment method to be active, or to change its settings, visit the payment method admin page.',
+								'event_espresso'
+							)
+						);
+					}
+				}
+				// just toggles the entire messenger
+			} else {
+				EE_Error::add_success(
+					sprintf(
+						esc_html__('%s messenger has been successfully activated', 'event_espresso'),
+						ucwords($messenger->label['singular'])
+					)
+				);
+			}
+
+			return true;
+
+			// possible error condition. This will happen when our active_mts data is empty because it is validated for actual active
+			// message types after the activation process.  However its possible some messengers don't HAVE any default_message_types
+			// in which case we just give a success message for the messenger being successfully activated.
+		} else {
+			if (! $messenger->get_default_message_types()) {
+				// messenger doesn't have any default message types so still a success.
+				EE_Error::add_success(
+					sprintf(
+						esc_html__('%s messenger was successfully activated.', 'event_espresso'),
+						ucwords($messenger->label['singular'])
+					)
+				);
+
+				return true;
+			} else {
+				EE_Error::add_error(
+					$message_type instanceof EE_message_type
+						? sprintf(
+							esc_html__(
+								'%s message type was not successfully activated with the %s messenger',
+								'event_espresso'
+							),
+							ucwords($message_type->label['singular']),
+							ucwords($messenger->label['singular'])
+						)
+						: sprintf(
+							esc_html__('%s messenger was not successfully activated', 'event_espresso'),
+							ucwords($messenger->label['singular'])
+						),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+
+				return false;
+			}
+		}
+	}
+
+
+	/**
+	 * This sets up the appropriate response for deactivating a messenger and/or message type.
+	 *
+	 * @param EE_messenger         $messenger
+	 * @param EE_message_type|null $message_type
+	 * @return bool
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _setup_response_message_for_deactivating_messenger_with_message_types(
+		$messenger,
+		EE_message_type $message_type = null
+	) {
+		EE_Error::overwrite_success();
+
+		// if $messenger isn't a valid messenger object then get out.
+		if (! $messenger instanceof EE_Messenger) {
+			EE_Error::add_error(
+				esc_html__('The messenger being deactivated is not a valid messenger', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+
+			return false;
+		}
+
+		if ($message_type instanceof EE_message_type) {
+			$message_type_name = $message_type->name;
+			EE_Error::add_success(
+				sprintf(
+					esc_html__(
+						'%s message type has been successfully deactivated for the %s messenger.',
+						'event_espresso'
+					),
+					ucwords($message_type->label['singular']),
+					ucwords($messenger->label['singular'])
+				)
+			);
+		} else {
+			$message_type_name = '';
+			EE_Error::add_success(
+				sprintf(
+					esc_html__('%s messenger has been successfully deactivated.', 'event_espresso'),
+					ucwords($messenger->label['singular'])
+				)
+			);
+		}
+
+		// if messenger was html or message type was invoice then let's make sure we deactivate invoice payment method.
+		if ($messenger->name === 'html' || $message_type_name === 'invoice') {
+			EE_Registry::instance()->load_lib('Payment_Method_Manager');
+			$count_updated = EE_Payment_Method_Manager::instance()->deactivate_payment_method('invoice');
+			if ($count_updated > 0) {
+				$msg = $message_type_name === 'invoice'
+					? esc_html__(
+						'Deactivating the invoice message type also automatically deactivates the invoice payment method. In order for invoices to be generated the invoice message type must be active. If you completed this action by mistake, simply reactivate the invoice message type and then visit the payment methods admin page to reactivate the invoice payment method.',
+						'event_espresso'
+					)
+					: esc_html__(
+						'Deactivating the html messenger also automatically deactivates the invoice payment method.  In order for invoices to be generated the html messenger must be be active.  If you completed this action by mistake, simply reactivate the html messenger, then visit the payment methods admin page to reactivate the invoice payment method.',
+						'event_espresso'
+					);
+				EE_Error::add_attention($msg);
+			}
+		}
+
+		return true;
+	}
+
+
+	/**
+	 * handles updating a message type form on messenger activation IF the message type has settings fields. (via ajax)
+	 *
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	public function update_mt_form()
+	{
+		if (! $this->_active_messenger_name || ! $this->_active_message_type_name) {
+			EE_Error::add_error(
+				esc_html__('Require message type or messenger to send an updated form', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$this->_return_json();
+		}
+
+		$message_types = $this->get_installed_message_types();
+		$message_type  = $message_types[ $this->_active_message_type_name ];
+		$messenger     = $this->_message_resource_manager->get_active_messenger($this->_active_messenger_name);
+		$content       = $this->_message_type_settings_content($message_type, $messenger, true);
+
+		$this->_template_args['success'] = true;
+		$this->_template_args['content'] = $content;
+		$this->_return_json();
+	}
+
+
+	/**
+	 * this handles saving the settings for a messenger or message type
+	 *
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	public function save_settings()
+	{
+		$type = $this->request->getRequestParam('type');
+		if (! $type) {
+			EE_Error::add_error(
+				esc_html__(
+					'Cannot save settings because type is unknown (messenger settings or message type settings?)',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$this->_template_args['error'] = true;
+			$this->_return_json();
+		}
+
+
+		if ($type === 'messenger') {
+			// this should be an array.
+			$settings  = $this->request->getRequestParam('messenger_settings', [], 'string', true);
+			$messenger = $settings['messenger'];
+			// remove messenger and message_types from settings array
+			unset($settings['messenger'], $settings['message_types']);
+			$this->_message_resource_manager->add_settings_for_messenger($messenger, $settings);
+		} elseif ($type === 'message_type') {
+			$settings     = $this->request->getRequestParam('message_type_settings', [], 'string', true);
+			$messenger    = $settings['messenger'];
+			$message_type = $settings['message_type'];
+			// remove messenger and message_types from settings array
+			unset($settings['messenger'], $settings['message_types']);
+			$this->_message_resource_manager->add_settings_for_message_type($messenger, $message_type, $settings);
+		}
+
+		// okay we should have the data all setup.  Now we just update!
+		$success = $this->_message_resource_manager->update_active_messengers_option();
+
+		if ($success) {
+			EE_Error::add_success(esc_html__('Settings updated', 'event_espresso'));
+		} else {
+			EE_Error::add_error(
+				esc_html__('Settings did not get updated', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+
+		$this->_template_args['success'] = $success;
+		$this->_return_json();
+	}
+
+
+
+
+	/**  EE MESSAGE PROCESSING ACTIONS **/
+
+
+	/**
+	 * This immediately generates any EE_Message ID's that are selected that are EEM_Message::status_incomplete
+	 * However, this does not send immediately, it just queues for sending.
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @since 4.9.0
+	 */
+	protected function _generate_now()
+	{
+		EED_Messages::generate_now($this->_get_msg_ids_from_request());
+		$this->_redirect_after_action(false, '', '', [], true);
+	}
+
+
+	/**
+	 * This immediately generates AND sends any EE_Message's selected that are EEM_Message::status_incomplete or that
+	 * are EEM_Message::status_resend or EEM_Message::status_idle
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @since 4.9.0
+	 */
+	protected function _generate_and_send_now()
+	{
+		EED_Messages::generate_and_send_now($this->_get_msg_ids_from_request());
+		$this->_redirect_after_action(false, '', '', [], true);
+	}
+
+
+	/**
+	 * This queues any EEM_Message::status_sent EE_Message ids in the request for resending.
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @since 4.9.0
+	 */
+	protected function _queue_for_resending()
+	{
+		EED_Messages::queue_for_resending($this->_get_msg_ids_from_request());
+		$this->_redirect_after_action(false, '', '', [], true);
+	}
+
+
+	/**
+	 *  This sends immediately any EEM_Message::status_idle or EEM_Message::status_resend messages in the queue
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @since 4.9.0
+	 */
+	protected function _send_now()
+	{
+		EED_Messages::send_now($this->_get_msg_ids_from_request());
+		$this->_redirect_after_action(false, '', '', [], true);
+	}
+
+
+	/**
+	 * Deletes EE_messages for IDs in the request.
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @since 4.9.0
+	 */
+	protected function _delete_ee_messages()
+	{
+		$MSG_IDs       = $this->_get_msg_ids_from_request();
+		$deleted_count = 0;
+		foreach ($MSG_IDs as $MSG_ID) {
+			if (EEM_Message::instance()->delete_by_ID($MSG_ID)) {
+				$deleted_count++;
+			}
+		}
+		if ($deleted_count) {
+			EE_Error::add_success(
+				esc_html(
+					_n(
+						'Message successfully deleted',
+						'Messages successfully deleted',
+						$deleted_count,
+						'event_espresso'
+					)
+				)
+			);
+		} else {
+			EE_Error::add_error(
+				_n('The message was not deleted.', 'The messages were not deleted', count($MSG_IDs), 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		$this->_redirect_after_action(false, '', '', [], true);
+	}
+
+
+	/**
+	 *  This looks for 'MSG_ID' key in the request and returns an array of MSG_ID's if present.
+	 *
+	 * @return array
+	 * @since 4.9.0
+	 */
+	protected function _get_msg_ids_from_request()
+	{
+		$MSG_IDs = $this->request->getRequestParam('MSG_ID', [], 'string', true);
+		if (empty($MSG_IDs)) {
+			return [];
+		}
+		// if 'MSG_ID' was just a single ID (not an array)
+		// then $MSG_IDs will be something like [123] so $MSG_IDs[0] should be 123
+		// otherwise, $MSG_IDs was already an array where message IDs were used as the keys
+		return count($MSG_IDs) === 1 && isset($MSG_IDs[0])
+			? $MSG_IDs
+			: array_keys($MSG_IDs);
+	}
 }

Spacing +224 added lines, -224 removed lines

@@ -155,8 +155,8 @@ 
         $i = 1;
         foreach ($active_messengers as $active_messenger) {
             if ($active_messenger instanceof EE_Message) {
-                $m_values[ $i ]['id']   = $active_messenger->messenger();
-                $m_values[ $i ]['text'] = ucwords($active_messenger->messenger_label());
+                $m_values[$i]['id']   = $active_messenger->messenger();
+                $m_values[$i]['text'] = ucwords($active_messenger->messenger_label());
                 $i++;
             }
         }
@@ -192,8 +192,8 @@ 
         $i               = 1;
         foreach ($active_messages as $active_message) {
             if ($active_message instanceof EE_Message) {
-                $mt_values[ $i ]['id']   = $active_message->message_type();
-                $mt_values[ $i ]['text'] = ucwords($active_message->message_type_label());
+                $mt_values[$i]['id']   = $active_message->message_type();
+                $mt_values[$i]['text'] = ucwords($active_message->message_type_label());
                 $i++;
             }
         }
@@ -232,7 +232,7 @@ 
                 if ($message_type instanceof EE_message_type) {
                     $message_type_contexts = $message_type->get_contexts();
                     foreach ($message_type_contexts as $context => $context_details) {
-                        $contexts[ $context ] = $context_details['label'];
+                        $contexts[$context] = $context_details['label'];
                     }
                 }
             }
@@ -265,7 +265,7 @@ 
             ['none_selected' => esc_html__('Show All Messengers', 'event_espresso')],
             $messenger_options
         );
-        $input             = new EE_Select_Input(
+        $input = new EE_Select_Input(
             $messenger_options,
             [
                 'html_name'  => 'ee_messenger_filter_by',
@@ -302,7 +302,7 @@ 
             ['none_selected' => esc_html__('Show All Message Types', 'event_espresso')],
             $message_type_options
         );
-        $input                = new EE_Select_Input(
+        $input = new EE_Select_Input(
             $message_type_options,
             [
                 'html_name'  => 'ee_message_type_filter_by',
@@ -339,7 +339,7 @@ 
             ['none_selected' => esc_html__('Show all Contexts', 'event_espresso')],
             $context_options
         );
-        $input           = new EE_Select_Input(
+        $input = new EE_Select_Input(
             $context_options,
             [
                 'html_name'  => 'ee_context_filter_by',
@@ -721,53 +721,53 @@ 
 
     public function messages_help_tab()
     {
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_messages_help_tab.template.php');
+        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH.'ee_msg_messages_help_tab.template.php');
     }
 
 
     public function messengers_help_tab()
     {
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_messenger_help_tab.template.php');
+        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH.'ee_msg_messenger_help_tab.template.php');
     }
 
 
     public function message_types_help_tab()
     {
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_message_type_help_tab.template.php');
+        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH.'ee_msg_message_type_help_tab.template.php');
     }
 
 
     public function messages_overview_help_tab()
     {
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_overview_help_tab.template.php');
+        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH.'ee_msg_overview_help_tab.template.php');
     }
 
 
     public function message_templates_help_tab()
     {
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_message_templates_help_tab.template.php');
+        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH.'ee_msg_message_templates_help_tab.template.php');
     }
 
 
     public function edit_message_template_help_tab()
     {
-        $args['img1'] = '<img src="' . EE_MSG_ASSETS_URL . 'images/editor.png' . '" alt="'
+        $args['img1'] = '<img src="'.EE_MSG_ASSETS_URL.'images/editor.png'.'" alt="'
                         . esc_attr__('Editor Title', 'event_espresso')
                         . '" />';
-        $args['img2'] = '<img src="' . EE_MSG_ASSETS_URL . 'images/switch-context.png' . '" alt="'
+        $args['img2'] = '<img src="'.EE_MSG_ASSETS_URL.'images/switch-context.png'.'" alt="'
                         . esc_attr__('Context Switcher and Preview', 'event_espresso')
                         . '" />';
-        $args['img3'] = '<img class="left" src="' . EE_MSG_ASSETS_URL . 'images/form-fields.png' . '" alt="'
+        $args['img3'] = '<img class="left" src="'.EE_MSG_ASSETS_URL.'images/form-fields.png'.'" alt="'
                         . esc_attr__('Message Template Form Fields', 'event_espresso')
                         . '" />';
-        $args['img4'] = '<img class="right" src="' . EE_MSG_ASSETS_URL . 'images/shortcodes-metabox.png' . '" alt="'
+        $args['img4'] = '<img class="right" src="'.EE_MSG_ASSETS_URL.'images/shortcodes-metabox.png'.'" alt="'
                         . esc_attr__('Shortcodes Metabox', 'event_espresso')
                         . '" />';
-        $args['img5'] = '<img class="right" src="' . EE_MSG_ASSETS_URL . 'images/publish-meta-box.png' . '" alt="'
+        $args['img5'] = '<img class="right" src="'.EE_MSG_ASSETS_URL.'images/publish-meta-box.png'.'" alt="'
                         . esc_attr__('Publish Metabox', 'event_espresso')
                         . '" />';
         EEH_Template::display_template(
-            EE_MSG_TEMPLATE_PATH . 'ee_msg_messages_templates_editor_help_tab.template.php',
+            EE_MSG_TEMPLATE_PATH.'ee_msg_messages_templates_editor_help_tab.template.php',
             $args
         );
     }
@@ -782,7 +782,7 @@ 
         $this->_set_shortcodes();
         $args['shortcodes'] = $this->_shortcodes;
         EEH_Template::display_template(
-            EE_MSG_TEMPLATE_PATH . 'ee_msg_messages_shortcodes_help_tab.template.php',
+            EE_MSG_TEMPLATE_PATH.'ee_msg_messages_shortcodes_help_tab.template.php',
             $args
         );
     }
@@ -790,16 +790,16 @@ 
 
     public function preview_message_help_tab()
     {
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_preview_help_tab.template.php');
+        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH.'ee_msg_preview_help_tab.template.php');
     }
 
 
     public function settings_help_tab()
     {
-        $args['img1'] = '<img class="inline-text" src="' . EE_MSG_ASSETS_URL . 'images/email-tab-active.png'
-                        . '" alt="' . esc_attr__('Active Email Tab', 'event_espresso') . '" />';
-        $args['img2'] = '<img class="inline-text" src="' . EE_MSG_ASSETS_URL . 'images/email-tab-inactive.png'
-                        . '" alt="' . esc_attr__('Inactive Email Tab', 'event_espresso') . '" />';
+        $args['img1'] = '<img class="inline-text" src="'.EE_MSG_ASSETS_URL.'images/email-tab-active.png'
+                        . '" alt="'.esc_attr__('Active Email Tab', 'event_espresso').'" />';
+        $args['img2'] = '<img class="inline-text" src="'.EE_MSG_ASSETS_URL.'images/email-tab-inactive.png'
+                        . '" alt="'.esc_attr__('Inactive Email Tab', 'event_espresso').'" />';
         $args['img3'] = '<div class="switch">'
                         . '<input class="ee-on-off-toggle ee-toggle-round-flat"'
                         . ' type="checkbox" checked="checked">'
@@ -810,25 +810,25 @@ 
                         . ' type="checkbox">'
                         . '<label for="ee-on-off-toggle-on"></label>'
                         . '</div>';
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_messages_settings_help_tab.template.php', $args);
+        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH.'ee_msg_messages_settings_help_tab.template.php', $args);
     }
 
 
     public function load_scripts_styles()
     {
-        wp_register_style('espresso_ee_msg', EE_MSG_ASSETS_URL . 'ee_message_admin.css', EVENT_ESPRESSO_VERSION);
+        wp_register_style('espresso_ee_msg', EE_MSG_ASSETS_URL.'ee_message_admin.css', EVENT_ESPRESSO_VERSION);
         wp_enqueue_style('espresso_ee_msg');
 
         wp_register_script(
             'ee-messages-settings',
-            EE_MSG_ASSETS_URL . 'ee-messages-settings.js',
+            EE_MSG_ASSETS_URL.'ee-messages-settings.js',
             ['jquery-ui-droppable', 'ee-serialize-full-array'],
             EVENT_ESPRESSO_VERSION,
             true
         );
         wp_register_script(
             'ee-msg-list-table-js',
-            EE_MSG_ASSETS_URL . 'ee_message_admin_list_table.js',
+            EE_MSG_ASSETS_URL.'ee_message_admin_list_table.js',
             ['ee-dialog'],
             EVENT_ESPRESSO_VERSION
         );
@@ -871,7 +871,7 @@ 
 
         $this->_set_shortcodes();
 
-        EE_Registry::$i18n_js_strings['confirm_default_reset']        = sprintf(
+        EE_Registry::$i18n_js_strings['confirm_default_reset'] = sprintf(
             esc_html__(
                 'Are you sure you want to reset the %s %s message templates?  Remember continuing will reset the templates for all contexts in this messenger and message type group.',
                 'event_espresso'
@@ -883,14 +883,14 @@ 
             'Switching the template pack for a messages template will reset the content for the template so the new layout is loaded.  Any custom content in the existing template will be lost. Are you sure you wish to do this?',
             'event_espresso'
         );
-        EE_Registry::$i18n_js_strings['server_error']                 = esc_html__(
+        EE_Registry::$i18n_js_strings['server_error'] = esc_html__(
             'An unknown error occurred on the server while attempting to process your request. Please refresh the page and try again or contact support.',
             'event_espresso'
         );
 
         wp_register_script(
             'ee_msgs_edit_js',
-            EE_MSG_ASSETS_URL . 'ee_message_editor.js',
+            EE_MSG_ASSETS_URL.'ee_message_editor.js',
             ['jquery'],
             EVENT_ESPRESSO_VERSION
         );
@@ -933,7 +933,7 @@ 
     {
         wp_register_style(
             'ee-message-settings',
-            EE_MSG_ASSETS_URL . 'ee_message_settings.css',
+            EE_MSG_ASSETS_URL.'ee_message_settings.css',
             [],
             EVENT_ESPRESSO_VERSION
         );
@@ -1019,7 +1019,7 @@ 
             }
             $status_bulk_actions = $common_bulk_actions;
             // unset bulk actions not applying to status
-            if (! empty($status_bulk_actions)) {
+            if ( ! empty($status_bulk_actions)) {
                 switch ($status) {
                     case EEM_Message::status_idle:
                     case EEM_Message::status_resend:
@@ -1048,7 +1048,7 @@ 
                 continue;
             }
 
-            $this->_views[ strtolower($status) ] = [
+            $this->_views[strtolower($status)] = [
                 'slug'        => strtolower($status),
                 'label'       => EEH_Template::pretty_status($status, false, 'sentence'),
                 'count'       => 0,
@@ -1097,7 +1097,7 @@ 
             if ($action_item === 'see_notifications_for') {
                 continue;
             }
-            $action_items[ $action_item ] = [
+            $action_items[$action_item] = [
                 'class' => $action_details['css_class'],
                 'desc'  => $action_details['label'],
             ];
@@ -1106,37 +1106,37 @@ 
         /** @var array $status_items status legend setup */
         $status_items = [
             'sent_status'                => [
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_sent,
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Message::status_sent,
                 'desc'  => EEH_Template::pretty_status(EEM_Message::status_sent, false, 'sentence'),
             ],
             'idle_status'                => [
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_idle,
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Message::status_idle,
                 'desc'  => EEH_Template::pretty_status(EEM_Message::status_idle, false, 'sentence'),
             ],
             'failed_status'              => [
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_failed,
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Message::status_failed,
                 'desc'  => EEH_Template::pretty_status(EEM_Message::status_failed, false, 'sentence'),
             ],
             'messenger_executing_status' => [
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_messenger_executing,
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Message::status_messenger_executing,
                 'desc'  => EEH_Template::pretty_status(EEM_Message::status_messenger_executing, false, 'sentence'),
             ],
             'resend_status'              => [
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_resend,
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Message::status_resend,
                 'desc'  => EEH_Template::pretty_status(EEM_Message::status_resend, false, 'sentence'),
             ],
             'incomplete_status'          => [
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_incomplete,
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Message::status_incomplete,
                 'desc'  => EEH_Template::pretty_status(EEM_Message::status_incomplete, false, 'sentence'),
             ],
             'retry_status'               => [
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_retry,
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Message::status_retry,
                 'desc'  => EEH_Template::pretty_status(EEM_Message::status_retry, false, 'sentence'),
             ],
         ];
         if (EEM_Message::debug()) {
             $status_items['debug_only_status'] = [
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_debug_only,
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Message::status_debug_only,
                 'desc'  => EEH_Template::pretty_status(EEM_Message::status_debug_only, false, 'sentence'),
             ];
         }
@@ -1151,11 +1151,11 @@ 
     protected function _custom_mtps_preview()
     {
         $this->_admin_page_title              = esc_html__('Custom Message Templates (Preview)', 'event_espresso');
-        $this->_template_args['preview_img']  = '<img src="' . EE_MSG_ASSETS_URL . 'images/custom_mtps_preview.png"'
-                                                . ' alt="' . esc_attr__(
+        $this->_template_args['preview_img']  = '<img src="'.EE_MSG_ASSETS_URL.'images/custom_mtps_preview.png"'
+                                                . ' alt="'.esc_attr__(
                                                     'Preview Custom Message Templates screenshot',
                                                     'event_espresso'
-                                                ) . '" />';
+                                                ).'" />';
         $this->_template_args['preview_text'] = '<strong>'
                                                 . esc_html__(
                                                     'Custom Message Templates is a feature that is only available in the premium version of Event Espresso 4 which is available with a support license purchase on EventEspresso.com. With the Custom Message Templates feature, you are able to create custom message templates and assign them on a per-event basis.',
@@ -1227,7 +1227,7 @@ 
         $installed               = [];
 
         foreach ($installed_message_types as $message_type) {
-            $installed[ $message_type->name ] = $message_type;
+            $installed[$message_type->name] = $message_type;
         }
 
         return $installed;
@@ -1356,7 +1356,7 @@ 
         // we need to assemble the title from Various details
         $context_label = sprintf(
             esc_html__('(%s %s)', 'event_espresso'),
-            $c_config[ $context ]['label'],
+            $c_config[$context]['label'],
             ucwords($c_label['label'])
         );
 
@@ -1378,7 +1378,7 @@ 
             $message_template_group->message_type()
         );
 
-        if (! $template_field_structure) {
+        if ( ! $template_field_structure) {
             $template_field_structure = false;
             $template_fields          = esc_html__(
                 'There was an error in assembling the fields for this display (you should see an error message)',
@@ -1392,21 +1392,21 @@ 
 
         // if we have the extra key.. then we need to remove the content index from the template_field_structure as it
         // will get handled in the "extra" array.
-        if (is_array($template_field_structure[ $context ]) && isset($template_field_structure[ $context ]['extra'])) {
-            foreach ($template_field_structure[ $context ]['extra'] as $reference_field => $new_fields) {
-                unset($template_field_structure[ $context ][ $reference_field ]);
+        if (is_array($template_field_structure[$context]) && isset($template_field_structure[$context]['extra'])) {
+            foreach ($template_field_structure[$context]['extra'] as $reference_field => $new_fields) {
+                unset($template_field_structure[$context][$reference_field]);
             }
         }
 
         // let's loop through the template_field_structure and actually assemble the input fields!
-        if (! empty($template_field_structure)) {
-            foreach ($template_field_structure[ $context ] as $template_field => $field_setup_array) {
+        if ( ! empty($template_field_structure)) {
+            foreach ($template_field_structure[$context] as $template_field => $field_setup_array) {
                 // if this is an 'extra' template field then we need to remove any existing fields that are keyed up in
                 // the extra array and reset them.
                 if ($template_field === 'extra') {
                     $this->_template_args['is_extra_fields'] = true;
                     foreach ($field_setup_array as $reference_field => $new_fields_array) {
-                        $message_template = $message_templates[ $context ][ $reference_field ];
+                        $message_template = $message_templates[$context][$reference_field];
                         $content          = $message_template instanceof EE_Message_Template
                             ? $message_template->get('MTP_content')
                             : '';
@@ -1415,7 +1415,7 @@ 
                             $continue = false;
                             if (isset($extra_array['shortcodes_required'])) {
                                 foreach ((array) $extra_array['shortcodes_required'] as $shortcode) {
-                                    if (! array_key_exists($shortcode, $this->_shortcodes)) {
+                                    if ( ! array_key_exists($shortcode, $this->_shortcodes)) {
                                         $continue = true;
                                     }
                                 }
@@ -1424,55 +1424,55 @@ 
                                 }
                             }
 
-                            $field_id                                  = $reference_field
+                            $field_id = $reference_field
                                                                          . '-'
                                                                          . $extra_field
                                                                          . '-content';
-                            $template_form_fields[ $field_id ]         = $extra_array;
-                            $template_form_fields[ $field_id ]['name'] = 'MTP_template_fields['
+                            $template_form_fields[$field_id]         = $extra_array;
+                            $template_form_fields[$field_id]['name'] = 'MTP_template_fields['
                                                                          . $reference_field
                                                                          . '][content]['
-                                                                         . $extra_field . ']';
-                            $css_class                                 = isset($extra_array['css_class'])
+                                                                         . $extra_field.']';
+                            $css_class = isset($extra_array['css_class'])
                                 ? $extra_array['css_class']
                                 : '';
 
-                            $template_form_fields[ $field_id ]['css_class'] = ! empty($v_fields)
+                            $template_form_fields[$field_id]['css_class'] = ! empty($v_fields)
                                                                               && in_array($extra_field, $v_fields, true)
                                                                               && (
-                                                                                  is_array($validators[ $extra_field ])
-                                                                                  && isset($validators[ $extra_field ]['msg'])
+                                                                                  is_array($validators[$extra_field])
+                                                                                  && isset($validators[$extra_field]['msg'])
                                                                               )
-                                ? 'validate-error ' . $css_class
+                                ? 'validate-error '.$css_class
                                 : $css_class;
 
-                            $template_form_fields[ $field_id ]['value'] = ! empty($message_templates)
-                                                                          && isset($content[ $extra_field ])
-                                ? $content[ $extra_field ]
+                            $template_form_fields[$field_id]['value'] = ! empty($message_templates)
+                                                                          && isset($content[$extra_field])
+                                ? $content[$extra_field]
                                 : '';
 
                             // do we have a validation error?  if we do then let's use that value instead
-                            $template_form_fields[ $field_id ]['value'] = isset($validators[ $extra_field ])
-                                ? $validators[ $extra_field ]['value']
-                                : $template_form_fields[ $field_id ]['value'];
+                            $template_form_fields[$field_id]['value'] = isset($validators[$extra_field])
+                                ? $validators[$extra_field]['value']
+                                : $template_form_fields[$field_id]['value'];
 
 
-                            $template_form_fields[ $field_id ]['db-col'] = 'MTP_content';
+                            $template_form_fields[$field_id]['db-col'] = 'MTP_content';
 
                             // shortcode selector
                             $field_name_to_use                                   = $extra_field === 'main'
                                 ? 'content'
                                 : $extra_field;
-                            $template_form_fields[ $field_id ]['append_content'] = $this->_get_shortcode_selector(
+                            $template_form_fields[$field_id]['append_content'] = $this->_get_shortcode_selector(
                                 $field_name_to_use,
                                 $field_id
                             );
                         }
-                        $template_field_MTP_id           = $reference_field . '-MTP_ID';
-                        $template_field_template_name_id = $reference_field . '-name';
+                        $template_field_MTP_id           = $reference_field.'-MTP_ID';
+                        $template_field_template_name_id = $reference_field.'-name';
 
-                        $template_form_fields[ $template_field_MTP_id ] = [
-                            'name'       => 'MTP_template_fields[' . $reference_field . '][MTP_ID]',
+                        $template_form_fields[$template_field_MTP_id] = [
+                            'name'       => 'MTP_template_fields['.$reference_field.'][MTP_ID]',
                             'label'      => null,
                             'input'      => 'hidden',
                             'type'       => 'int',
@@ -1484,8 +1484,8 @@ 
                             'db-col'     => 'MTP_ID',
                         ];
 
-                        $template_form_fields[ $template_field_template_name_id ] = [
-                            'name'       => 'MTP_template_fields[' . $reference_field . '][name]',
+                        $template_form_fields[$template_field_template_name_id] = [
+                            'name'       => 'MTP_template_fields['.$reference_field.'][name]',
                             'label'      => null,
                             'input'      => 'hidden',
                             'type'       => 'string',
@@ -1499,38 +1499,38 @@ 
                     }
                     continue; // skip the next stuff, we got the necessary fields here for this dataset.
                 } else {
-                    $field_id                                   = $template_field . '-content';
-                    $template_form_fields[ $field_id ]          = $field_setup_array;
-                    $template_form_fields[ $field_id ]['name']  =
-                        'MTP_template_fields[' . $template_field . '][content]';
+                    $field_id                                   = $template_field.'-content';
+                    $template_form_fields[$field_id]          = $field_setup_array;
+                    $template_form_fields[$field_id]['name']  =
+                        'MTP_template_fields['.$template_field.'][content]';
                     $message_template                           =
-                        isset($message_templates[ $context ][ $template_field ])
-                            ? $message_templates[ $context ][ $template_field ]
+                        isset($message_templates[$context][$template_field])
+                            ? $message_templates[$context][$template_field]
                             : null;
-                    $template_form_fields[ $field_id ]['value'] = ! empty($message_templates)
-                                                                  && is_array($message_templates[ $context ])
+                    $template_form_fields[$field_id]['value'] = ! empty($message_templates)
+                                                                  && is_array($message_templates[$context])
                                                                   && $message_template instanceof EE_Message_Template
                         ? $message_template->get('MTP_content')
                         : '';
 
                     // do we have a validator error for this field?  if we do then we'll use that value instead
-                    $template_form_fields[ $field_id ]['value'] = isset($validators[ $template_field ])
-                        ? $validators[ $template_field ]['value']
-                        : $template_form_fields[ $field_id ]['value'];
+                    $template_form_fields[$field_id]['value'] = isset($validators[$template_field])
+                        ? $validators[$template_field]['value']
+                        : $template_form_fields[$field_id]['value'];
 
 
-                    $template_form_fields[ $field_id ]['db-col']    = 'MTP_content';
+                    $template_form_fields[$field_id]['db-col']    = 'MTP_content';
                     $css_class                                      = isset($field_setup_array['css_class'])
                         ? $field_setup_array['css_class']
                         : '';
-                    $template_form_fields[ $field_id ]['css_class'] = ! empty($v_fields)
+                    $template_form_fields[$field_id]['css_class'] = ! empty($v_fields)
                                                                       && in_array($template_field, $v_fields, true)
-                                                                      && isset($validators[ $template_field ]['msg'])
-                        ? 'validate-error ' . $css_class
+                                                                      && isset($validators[$template_field]['msg'])
+                        ? 'validate-error '.$css_class
                         : $css_class;
 
                     // shortcode selector
-                    $template_form_fields[ $field_id ]['append_content'] = $this->_get_shortcode_selector(
+                    $template_form_fields[$field_id]['append_content'] = $this->_get_shortcode_selector(
                         $template_field,
                         $field_id
                     );
@@ -1538,12 +1538,12 @@ 
 
                 // k took care of content field(s) now let's take care of others.
 
-                $template_field_MTP_id                 = $template_field . '-MTP_ID';
-                $template_field_field_template_name_id = $template_field . '-name';
+                $template_field_MTP_id                 = $template_field.'-MTP_ID';
+                $template_field_field_template_name_id = $template_field.'-name';
 
                 // foreach template field there are actually two form fields created
-                $template_form_fields[ $template_field_MTP_id ] = [
-                    'name'       => 'MTP_template_fields[' . $template_field . '][MTP_ID]',
+                $template_form_fields[$template_field_MTP_id] = [
+                    'name'       => 'MTP_template_fields['.$template_field.'][MTP_ID]',
                     'label'      => null,
                     'input'      => 'hidden',
                     'type'       => 'int',
@@ -1555,8 +1555,8 @@ 
                     'db-col'     => 'MTP_ID',
                 ];
 
-                $template_form_fields[ $template_field_field_template_name_id ] = [
-                    'name'       => 'MTP_template_fields[' . $template_field . '][name]',
+                $template_form_fields[$template_field_field_template_name_id] = [
+                    'name'       => 'MTP_template_fields['.$template_field.'][name]',
                     'label'      => null,
                     'input'      => 'hidden',
                     'type'       => 'string',
@@ -1673,7 +1673,7 @@ 
                 'format'     => '%d',
                 'db-col'     => 'MTP_deleted',
             ];
-            $sidebar_form_fields['ee-msg-author']  = [
+            $sidebar_form_fields['ee-msg-author'] = [
                 'name'       => 'MTP_user_id',
                 'label'      => esc_html__('Author', 'event_espresso'),
                 'input'      => 'hidden',
@@ -1692,17 +1692,17 @@ 
                 'value' => $action,
             ];
 
-            $sidebar_form_fields['ee-msg-id']        = [
+            $sidebar_form_fields['ee-msg-id'] = [
                 'name'  => 'id',
                 'input' => 'hidden',
                 'type'  => 'int',
                 'value' => $GRP_ID,
             ];
             $sidebar_form_fields['ee-msg-evt-nonce'] = [
-                'name'  => $action . '_nonce',
+                'name'  => $action.'_nonce',
                 'input' => 'hidden',
                 'type'  => 'string',
-                'value' => wp_create_nonce($action . '_nonce'),
+                'value' => wp_create_nonce($action.'_nonce'),
             ];
 
             $template_switch = $this->request->getRequestParam('template_switch');
@@ -1733,7 +1733,7 @@ 
         );
 
         // add preview button
-        $preview_url    = parent::add_query_args_and_nonce(
+        $preview_url = parent::add_query_args_and_nonce(
             [
                 'message_type' => $message_template_group->message_type(),
                 'messenger'    => $message_template_group->messenger(),
@@ -1744,7 +1744,7 @@ 
             ],
             $this->_admin_base_url
         );
-        $preview_button = '<a href="' . $preview_url . '" class="button-secondary messages-preview-button">'
+        $preview_button = '<a href="'.$preview_url.'" class="button-secondary messages-preview-button">'
                           . esc_html__('Preview', 'event_espresso')
                           . '</a>';
 
@@ -1778,11 +1778,11 @@ 
             $context_label
         );
         $this->_template_args['before_admin_page_content'] .= $this->_add_form_element_before();
-        $this->_template_args['after_admin_page_content']  = $this->_add_form_element_after();
+        $this->_template_args['after_admin_page_content'] = $this->_add_form_element_after();
 
         $this->_template_path = $this->_template_args['GRP_ID']
             ? EE_MSG_TEMPLATE_PATH . 'ee_msg_details_main_edit_meta_box.template.php'
-            : EE_MSG_TEMPLATE_PATH . 'ee_msg_details_main_add_meta_box.template.php';
+            : EE_MSG_TEMPLATE_PATH.'ee_msg_details_main_add_meta_box.template.php';
 
         // send along EE_Message_Template_Group object for further template use.
         $this->_template_args['MTP'] = $message_template_group;
@@ -1838,7 +1838,7 @@ 
     ) {
         $template_args = [
             'context'                   => $context,
-            'nonce'                     => wp_create_nonce('activate_' . $context . '_toggle_nonce'),
+            'nonce'                     => wp_create_nonce('activate_'.$context.'_toggle_nonce'),
             'is_active'                 => $message_template_group->is_context_active($context),
             'on_off_action'             => $message_template_group->is_context_active($context)
                 ? 'context-off'
@@ -1847,7 +1847,7 @@ 
             'message_template_group_id' => $message_template_group->ID(),
         ];
         return EEH_Template::display_template(
-            EE_MSG_TEMPLATE_PATH . 'ee_msg_editor_active_context_element.template.php',
+            EE_MSG_TEMPLATE_PATH.'ee_msg_editor_active_context_element.template.php',
             $template_args,
             true
         );
@@ -1904,7 +1904,7 @@ 
         }
         $message_template_group_id = $this->request->getRequestParam('message_template_group_id', 0, 'int');
         $message_template_group    = EEM_Message_Template_Group::instance()->get_one_by_ID($message_template_group_id);
-        if (! $message_template_group instanceof EE_Message_Template_Group) {
+        if ( ! $message_template_group instanceof EE_Message_Template_Group) {
             EE_Error::add_error(
                 sprintf(
                     esc_html__(
@@ -2036,7 +2036,7 @@ 
         $messenger    = $this->request->getRequestParam('msgr');
         $message_type = $this->request->getRequestParam('mt');
         // we need to make sure we've got the info we need.
-        if (! ($GRP_ID && $messenger && $message_type)) {
+        if ( ! ($GRP_ID && $messenger && $message_type)) {
             EE_Error::add_error(
                 esc_html__(
                     'In order to reset the template to its default we require the messenger, message type, and message template GRP_ID to know what is being reset.  At least one of these is missing.',
@@ -2073,7 +2073,7 @@ 
         }
 
         // any error messages?
-        if (! $success) {
+        if ( ! $success) {
             EE_Error::add_error(
                 esc_html__(
                     'Something went wrong with deleting existing templates. Unable to reset to default',
@@ -2125,8 +2125,8 @@ 
     public function _preview_message($send = false)
     {
         // first make sure we've got the necessary parameters
-        $GRP_ID       = $this->request->getRequestParam('GRP_ID', 0, 'int');
-        if (! ($GRP_ID && $this->_active_messenger_name && $this->_active_message_type_name)) {
+        $GRP_ID = $this->request->getRequestParam('GRP_ID', 0, 'int');
+        if ( ! ($GRP_ID && $this->_active_messenger_name && $this->_active_message_type_name)) {
             EE_Error::add_error(
                 esc_html__('Missing necessary parameters for displaying preview', 'event_espresso'),
                 __FILE__,
@@ -2152,7 +2152,7 @@ 
         $EVT_ID = $this->request->getRequestParam('evt_id', 0, 'int');
 
         // let's add a button to go back to the edit view
-        $query_args             = [
+        $query_args = [
             'id'      => $GRP_ID,
             'evt_id'  => $EVT_ID,
             'context' => $context,
@@ -2173,7 +2173,7 @@ 
         $preview_title = sprintf(
             esc_html__('Viewing Preview for %s %s Message Template', 'event_espresso'),
             $active_messenger_label,
-            ucwords($message_types[ $this->_active_message_type_name ]->label['singular'])
+            ucwords($message_types[$this->_active_message_type_name]->label['singular'])
         );
         if (empty($preview)) {
             $this->noEventsErrorMessage();
@@ -2181,7 +2181,7 @@ 
         // setup display of preview.
         $this->_admin_page_title                    = $preview_title;
         $this->_template_args['admin_page_title']   = $preview_title;
-        $this->_template_args['admin_page_content'] = $preview_button . '<br />' . $preview;
+        $this->_template_args['admin_page_content'] = $preview_button.'<br />'.$preview;
         $this->_template_args['data']['force_json'] = true;
 
         return '';
@@ -2202,7 +2202,7 @@ 
             ],
             admin_url('admin.php')
         );
-        $message    = $test_send
+        $message = $test_send
             ? esc_html__(
                 'A test message could not be sent for this message template because there are no events created yet. The preview system uses actual events for generating the test message. %1$sGo see your events%2$s!',
                 'event_espresso'
@@ -2295,10 +2295,10 @@ 
             // only include template packs that support this messenger and message type!
             $supports = $tp->get_supports();
             if (
-                ! isset($supports[ $this->_message_template_group->messenger() ])
+                ! isset($supports[$this->_message_template_group->messenger()])
                 || ! in_array(
                     $this->_message_template_group->message_type(),
-                    $supports[ $this->_message_template_group->messenger() ],
+                    $supports[$this->_message_template_group->messenger()],
                     true
                 )
             ) {
@@ -2322,7 +2322,7 @@ 
         }
 
         // setup variation select values for the currently selected template.
-        $variations               = $this->_message_template_group->get_template_pack()->get_variations(
+        $variations = $this->_message_template_group->get_template_pack()->get_variations(
             $this->_message_template_group->messenger(),
             $this->_message_template_group->message_type()
         );
@@ -2336,12 +2336,12 @@ 
 
         $template_pack_labels = $this->_message_template_group->messenger_obj()->get_supports_labels();
 
-        $template_args['template_packs_selector']        = EEH_Form_Fields::select_input(
+        $template_args['template_packs_selector'] = EEH_Form_Fields::select_input(
             'MTP_template_pack',
             $tp_select_values,
             $this->_message_template_group->get_template_pack_name()
         );
-        $template_args['variations_selector']            = EEH_Form_Fields::select_input(
+        $template_args['variations_selector'] = EEH_Form_Fields::select_input(
             'MTP_template_variation',
             $variations_select_values,
             $this->_message_template_group->get_template_pack_variation()
@@ -2351,7 +2351,7 @@ 
         $template_args['template_pack_description']      = $template_pack_labels->template_pack_description;
         $template_args['template_variation_description'] = $template_pack_labels->template_variation_description;
 
-        $template = EE_MSG_TEMPLATE_PATH . 'template_pack_and_variations_metabox.template.php';
+        $template = EE_MSG_TEMPLATE_PATH.'template_pack_and_variations_metabox.template.php';
 
         EEH_Template::display_template($template, $template_args);
     }
@@ -2377,33 +2377,33 @@ 
         // first we need to see if there are any fields
         $fields = $this->_message_template_group->messenger_obj()->get_test_settings_fields();
 
-        if (! empty($fields)) {
+        if ( ! empty($fields)) {
             // yup there be fields
             foreach ($fields as $field => $config) {
-                $field_id = $this->_message_template_group->messenger() . '_' . $field;
+                $field_id = $this->_message_template_group->messenger().'_'.$field;
                 $existing = $this->_message_template_group->messenger_obj()->get_existing_test_settings();
                 $default  = isset($config['default']) ? $config['default'] : '';
                 $default  = isset($config['value']) ? $config['value'] : $default;
 
                 // if type is hidden and the value is empty
                 // something may have gone wrong so let's correct with the defaults
-                $fix                = $config['input'] === 'hidden'
-                                      && isset($existing[ $field ])
-                                      && empty($existing[ $field ])
+                $fix = $config['input'] === 'hidden'
+                                      && isset($existing[$field])
+                                      && empty($existing[$field])
                     ? $default
                     : '';
-                $existing[ $field ] = isset($existing[ $field ]) && empty($fix)
-                    ? $existing[ $field ]
+                $existing[$field] = isset($existing[$field]) && empty($fix)
+                    ? $existing[$field]
                     : $fix;
 
-                $template_form_fields[ $field_id ] = [
-                    'name'       => 'test_settings_fld[' . $field . ']',
+                $template_form_fields[$field_id] = [
+                    'name'       => 'test_settings_fld['.$field.']',
                     'label'      => $config['label'],
                     'input'      => $config['input'],
                     'type'       => $config['type'],
                     'required'   => $config['required'],
                     'validation' => $config['validation'],
-                    'value'      => isset($existing[ $field ]) ? $existing[ $field ] : $default,
+                    'value'      => isset($existing[$field]) ? $existing[$field] : $default,
                     'css_class'  => $config['css_class'],
                     'options'    => isset($config['options']) ? $config['options'] : [],
                     'default'    => $default,
@@ -2417,7 +2417,7 @@ 
             : '';
 
         // print out $test_settings_fields
-        if (! empty($test_settings_html)) {
+        if ( ! empty($test_settings_html)) {
             $test_settings_html .= '<input type="submit" class="button-primary mtp-test-button alignright" ';
             $test_settings_html .= 'name="test_button" value="';
             $test_settings_html .= esc_html__('Test Send', 'event_espresso');
@@ -2463,7 +2463,7 @@ 
         ];
 
         return EEH_Template::display_template(
-            EE_MSG_TEMPLATE_PATH . 'shortcode_selector_skeleton.template.php',
+            EE_MSG_TEMPLATE_PATH.'shortcode_selector_skeleton.template.php',
             $template_args,
             true
         );
@@ -2489,7 +2489,7 @@ 
         // $messenger = $this->_message_template_group->messenger_obj();
         // now let's set the content depending on the status of the shortcodes array
         if (empty($shortcodes)) {
-            echo '<p>' . esc_html__('There are no valid shortcodes available', 'event_espresso') . '</p>';
+            echo '<p>'.esc_html__('There are no valid shortcodes available', 'event_espresso').'</p>';
             return;
         }
         ?>
@@ -2525,7 +2525,7 @@ 
     {
 
         // no need to run this if the property is already set
-        if (! empty($this->_shortcodes)) {
+        if ( ! empty($this->_shortcodes)) {
             return;
         }
 
@@ -2580,7 +2580,7 @@ 
     protected function _set_message_template_group()
     {
 
-        if (! empty($this->_message_template_group)) {
+        if ( ! empty($this->_message_template_group)) {
             return;
         } //get out if this is already set.
 
@@ -2630,8 +2630,8 @@ 
                     <?php
                 }
                 // setup nonce_url
-                wp_nonce_field($args['action'] . '_nonce', $args['action'] . '_nonce', false);
-                $id = 'ee-' . sanitize_key($context_label['label']) . '-select';
+                wp_nonce_field($args['action'].'_nonce', $args['action'].'_nonce', false);
+                $id = 'ee-'.sanitize_key($context_label['label']).'-select';
                 ?>
                 <label for='<?php echo esc_attr($id); ?>' class='screen-reader-text'>
                     <?php esc_html_e('message context options', 'event_espresso'); ?>
@@ -2644,7 +2644,7 @@ 
                             $checked = ($context === $args['context']) ? 'selected="selected"' : '';
                             ?>
                             <option value="<?php echo esc_attr($context); ?>" <?php echo esc_attr($checked); ?>>
-                                <?php echo $context_details[ $context ]['label']; // already escaped ?>
+                                <?php echo $context_details[$context]['label']; // already escaped ?>
                             </option>
                         <?php endforeach;
                     endif; ?>
@@ -2729,10 +2729,10 @@ 
         $context_slug = $this->request->getRequestParam('MTP_context', '');
         $context      = ucwords(str_replace('_', ' ', $context_slug));
 
-        $item_desc   = $messenger_label && $message_type_label
-            ? $messenger_label . ' ' . $message_type_label . ' ' . $context . ' '
+        $item_desc = $messenger_label && $message_type_label
+            ? $messenger_label.' '.$message_type_label.' '.$context.' '
             : '';
-        $item_desc   .= 'Message Template';
+        $item_desc .= 'Message Template';
         $query_args  = [];
         $edit_array  = [];
         $action_desc = '';
@@ -2762,7 +2762,7 @@ 
 
             // run update for each template field in displayed context
             $template_fields = $this->request->getRequestParam('MTP_template_fields');
-            if (! $template_fields) {
+            if ( ! $template_fields) {
                 EE_Error::add_error(
                     esc_html__(
                         'There was a problem saving the template fields from the form because I didn\'t receive any actual template field data.',
@@ -2825,7 +2825,7 @@ 
 
                         $where_cols_n_values = ['MTP_ID' => $content['MTP_ID']];
                         // if they aren't allowed to use all JS, restrict them to just posty-y tags
-                        if (! current_user_can('unfiltered_html')) {
+                        if ( ! current_user_can('unfiltered_html')) {
                             if (is_array($set_column_values['MTP_content'])) {
                                 foreach ($set_column_values['MTP_content'] as $key => $value) {
                                     // remove slashes so wp_kses works properly (its wp_kses_stripslashes() function
@@ -2833,7 +2833,7 @@ 
                                     // appear invalid.) But currently the models expect slashed data, so after wp_kses
                                     // runs we need to re-slash the data. Sheesh. See
                                     // https://events.codebasehq.com/projects/event-espresso/tickets/11211#update-47321587
-                                    $set_column_values['MTP_content'][ $key ] = addslashes(
+                                    $set_column_values['MTP_content'][$key] = addslashes(
                                         wp_kses(
                                             stripslashes($value),
                                             wp_kses_allowed_html('post')
@@ -2876,7 +2876,7 @@ 
                                 // default setup for it.
                                 // @link https://events.codebasehq.com/projects/event-espresso/tickets/9465
                                 $updated = $MTP->insert($message_template_fields);
-                                if (! $updated || is_wp_error($updated)) {
+                                if ( ! $updated || is_wp_error($updated)) {
                                     EE_Error::add_error(
                                         sprintf(
                                             esc_html__('%s field could not be updated.', 'event_espresso'),
@@ -3110,7 +3110,7 @@ 
         if ($all) {
             // Checkboxes
             $checkboxes = $this->request->getRequestParam('checkbox', [], 'int', true);
-            if (! empty($checkboxes)) {
+            if ( ! empty($checkboxes)) {
                 // if array has more than one element then success message should be plural.
                 // todo: what about nonce?
                 $success = count($checkboxes) > 1 ? 2 : 1;
@@ -3118,16 +3118,16 @@ 
                 // cycle through checkboxes
                 while (list($GRP_ID, $value) = each($checkboxes)) {
                     $trashed_or_restored = $trash ? $MTP->delete_by_ID($GRP_ID) : $MTP->restore_by_ID($GRP_ID);
-                    if (! $trashed_or_restored) {
+                    if ( ! $trashed_or_restored) {
                         $success = 0;
                     }
                 }
             } else {
                 // grab single GRP_ID and handle
                 $GRP_ID = $this->request->getRequestParam('id', 0, 'int');
-                if (! empty($GRP_ID)) {
+                if ( ! empty($GRP_ID)) {
                     $trashed_or_restored = $trash ? $MTP->delete_by_ID($GRP_ID) : $MTP->restore_by_ID($GRP_ID);
-                    if (! $trashed_or_restored) {
+                    if ( ! $trashed_or_restored) {
                         $success = 0;
                     }
                 } else {
@@ -3175,7 +3175,7 @@ 
 
         // checkboxes
         $checkboxes = $this->request->getRequestParam('checkbox', [], 'int', true);
-        if (! empty($checkboxes)) {
+        if ( ! empty($checkboxes)) {
             // if array has more than one element then success message should be plural
             $success = count($checkboxes) > 1 ? 2 : 1;
 
@@ -3280,7 +3280,7 @@ 
     protected function _set_m_mt_settings()
     {
         // first if this is already set then lets get out no need to regenerate data.
-        if (! empty($this->_m_mt_settings)) {
+        if ( ! empty($this->_m_mt_settings)) {
             return;
         }
 
@@ -3292,7 +3292,7 @@ 
         // assemble the array for the _tab_text_links helper
 
         foreach ($messengers as $messenger) {
-            $this->_m_mt_settings['messenger_tabs'][ $messenger->name ] = [
+            $this->_m_mt_settings['messenger_tabs'][$messenger->name] = [
                 'label' => ucwords($messenger->label['singular']),
                 'class' => $this->_message_resource_manager->is_messenger_active($messenger->name)
                     ? 'messenger-active'
@@ -3309,7 +3309,7 @@ 
             foreach ($message_types as $message_type) {
                 // first we need to verify that this message type is valid with this messenger. Cause if it isn't then
                 // it shouldn't show in either the inactive OR active metabox.
-                if (! in_array($message_type->name, $message_types_for_messenger, true)) {
+                if ( ! in_array($message_type->name, $message_types_for_messenger, true)) {
                     continue;
                 }
 
@@ -3320,12 +3320,12 @@ 
                     ? 'active'
                     : 'inactive';
 
-                $this->_m_mt_settings['message_type_tabs'][ $messenger->name ][ $a_or_i ][ $message_type->name ] = [
+                $this->_m_mt_settings['message_type_tabs'][$messenger->name][$a_or_i][$message_type->name] = [
                     'label'    => ucwords($message_type->label['singular']),
-                    'class'    => 'message-type-' . $a_or_i,
-                    'slug_id'  => $message_type->name . '-messagetype-' . $messenger->name,
-                    'mt_nonce' => wp_create_nonce($message_type->name . '_nonce'),
-                    'href'     => 'espresso_' . $message_type->name . '_message_type_settings',
+                    'class'    => 'message-type-'.$a_or_i,
+                    'slug_id'  => $message_type->name.'-messagetype-'.$messenger->name,
+                    'mt_nonce' => wp_create_nonce($message_type->name.'_nonce'),
+                    'href'     => 'espresso_'.$message_type->name.'_message_type_settings',
                     'title'    => $a_or_i === 'active'
                         ? esc_html__('Drag this message type to the Inactive window to deactivate', 'event_espresso')
                         : esc_html__('Drag this message type to the messenger to activate', 'event_espresso'),
@@ -3356,25 +3356,25 @@ 
         $fields                                         = $message_type->get_admin_settings_fields();
         $settings_template_args['template_form_fields'] = '';
 
-        if (! empty($fields) && $active) {
+        if ( ! empty($fields) && $active) {
             $existing_settings = $message_type->get_existing_admin_settings($messenger->name);
             foreach ($fields as $fldname => $fldprops) {
-                $field_id                         = $messenger->name . '-' . $message_type->name . '-' . $fldname;
-                $template_form_field[ $field_id ] = [
-                    'name'       => 'message_type_settings[' . $fldname . ']',
+                $field_id                         = $messenger->name.'-'.$message_type->name.'-'.$fldname;
+                $template_form_field[$field_id] = [
+                    'name'       => 'message_type_settings['.$fldname.']',
                     'label'      => $fldprops['label'],
                     'input'      => $fldprops['field_type'],
                     'type'       => $fldprops['value_type'],
                     'required'   => $fldprops['required'],
                     'validation' => $fldprops['validation'],
-                    'value'      => isset($existing_settings[ $fldname ])
-                        ? $existing_settings[ $fldname ]
+                    'value'      => isset($existing_settings[$fldname])
+                        ? $existing_settings[$fldname]
                         : $fldprops['default'],
                     'options'    => isset($fldprops['options'])
                         ? $fldprops['options']
                         : [],
-                    'default'    => isset($existing_settings[ $fldname ])
-                        ? $existing_settings[ $fldname ]
+                    'default'    => isset($existing_settings[$fldname])
+                        ? $existing_settings[$fldname]
                         : $fldprops['default'],
                     'css_class'  => 'no-drag',
                     'format'     => $fldprops['format'],
@@ -3394,15 +3394,15 @@ 
         $settings_template_args['description'] = $message_type->description;
         // we also need some hidden fields
         $hidden_fields = [
-            'message_type_settings[messenger]' . $message_type->name    => [
+            'message_type_settings[messenger]'.$message_type->name    => [
                 'type'  => 'hidden',
                 'value' => $messenger->name,
             ],
-            'message_type_settings[message_type]' . $message_type->name => [
+            'message_type_settings[message_type]'.$message_type->name => [
                 'type'  => 'hidden',
                 'value' => $message_type->name,
             ],
-            'type' . $message_type->name                                => [
+            'type'.$message_type->name                                => [
                 'type'  => 'hidden',
                 'value' => 'message_type',
             ],
@@ -3412,12 +3412,12 @@ 
             $hidden_fields,
             'array'
         );
-        $settings_template_args['show_form']     = empty($settings_template_args['template_form_fields'])
+        $settings_template_args['show_form'] = empty($settings_template_args['template_form_fields'])
             ? ' hidden'
             : '';
 
 
-        $template = EE_MSG_TEMPLATE_PATH . 'ee_msg_mt_settings_content.template.php';
+        $template = EE_MSG_TEMPLATE_PATH.'ee_msg_mt_settings_content.template.php';
         return EEH_Template::display_template($template, $settings_template_args, true);
     }
 
@@ -3445,21 +3445,21 @@ 
 
                 // messenger meta boxes
                 $active         = $selected_messenger === $messenger;
-                $active_mt_tabs = isset($this->_m_mt_settings['message_type_tabs'][ $messenger ]['active'])
-                    ? $this->_m_mt_settings['message_type_tabs'][ $messenger ]['active']
+                $active_mt_tabs = isset($this->_m_mt_settings['message_type_tabs'][$messenger]['active'])
+                    ? $this->_m_mt_settings['message_type_tabs'][$messenger]['active']
                     : '';
 
-                $m_boxes[ $messenger . '_a_box' ] = sprintf(
+                $m_boxes[$messenger.'_a_box'] = sprintf(
                     esc_html__('%s Settings', 'event_espresso'),
                     $tab_array['label']
                 );
 
-                $m_template_args[ $messenger . '_a_box' ] = [
+                $m_template_args[$messenger.'_a_box'] = [
                     'active_message_types'   => ! empty($active_mt_tabs) ? $this->_get_mt_tabs($active_mt_tabs) : '',
                     'inactive_message_types' => isset(
-                        $this->_m_mt_settings['message_type_tabs'][ $messenger ]['inactive']
+                        $this->_m_mt_settings['message_type_tabs'][$messenger]['inactive']
                     )
-                        ? $this->_get_mt_tabs($this->_m_mt_settings['message_type_tabs'][ $messenger ]['inactive'])
+                        ? $this->_get_mt_tabs($this->_m_mt_settings['message_type_tabs'][$messenger]['inactive'])
                         : '',
                     'content'                => $this->_get_messenger_box_content($tab_array['obj']),
                     'hidden'                 => $active ? '' : ' hidden',
@@ -3471,13 +3471,13 @@ 
                 // message type meta boxes
                 // (which is really just the inactive container for each messenger
                 // showing inactive message types for that messenger)
-                $mt_boxes[ $messenger . '_i_box' ]         = esc_html__('Inactive Message Types', 'event_espresso');
-                $mt_template_args[ $messenger . '_i_box' ] = [
+                $mt_boxes[$messenger.'_i_box']         = esc_html__('Inactive Message Types', 'event_espresso');
+                $mt_template_args[$messenger.'_i_box'] = [
                     'active_message_types'   => ! empty($active_mt_tabs) ? $this->_get_mt_tabs($active_mt_tabs) : '',
                     'inactive_message_types' => isset(
-                        $this->_m_mt_settings['message_type_tabs'][ $messenger ]['inactive']
+                        $this->_m_mt_settings['message_type_tabs'][$messenger]['inactive']
                     )
-                        ? $this->_get_mt_tabs($this->_m_mt_settings['message_type_tabs'][ $messenger ]['inactive'])
+                        ? $this->_get_mt_tabs($this->_m_mt_settings['message_type_tabs'][$messenger]['inactive'])
                         : '',
                     'hidden'                 => $active ? '' : ' hidden',
                     'hide_on_message'        => $hide_on_message,
@@ -3490,14 +3490,14 @@ 
 
 
         // register messenger metaboxes
-        $m_template_path = EE_MSG_TEMPLATE_PATH . 'ee_msg_details_messenger_mt_meta_box.template.php';
+        $m_template_path = EE_MSG_TEMPLATE_PATH.'ee_msg_details_messenger_mt_meta_box.template.php';
         foreach ($m_boxes as $box => $label) {
-            $callback_args = ['template_path' => $m_template_path, 'template_args' => $m_template_args[ $box ]];
+            $callback_args = ['template_path' => $m_template_path, 'template_args' => $m_template_args[$box]];
             $msgr          = str_replace('_a_box', '', $box);
             add_meta_box(
-                'espresso_' . $msgr . '_settings',
+                'espresso_'.$msgr.'_settings',
                 $label,
-                function ($post, $metabox) {
+                function($post, $metabox) {
                     EEH_Template::display_template(
                         $metabox['args']['template_path'],
                         $metabox['args']['template_args']
@@ -3511,17 +3511,17 @@ 
         }
 
         // register message type metaboxes
-        $mt_template_path = EE_MSG_TEMPLATE_PATH . 'ee_msg_details_messenger_meta_box.template.php';
+        $mt_template_path = EE_MSG_TEMPLATE_PATH.'ee_msg_details_messenger_meta_box.template.php';
         foreach ($mt_boxes as $box => $label) {
             $callback_args = [
                 'template_path' => $mt_template_path,
-                'template_args' => $mt_template_args[ $box ],
+                'template_args' => $mt_template_args[$box],
             ];
-            $mt            = str_replace('_i_box', '', $box);
+            $mt = str_replace('_i_box', '', $box);
             add_meta_box(
-                'espresso_' . $mt . '_inactive_mts',
+                'espresso_'.$mt.'_inactive_mts',
                 $label,
-                function ($post, $metabox) {
+                function($post, $metabox) {
                     EEH_Template::display_template(
                         $metabox['args']['template_path'],
                         $metabox['args']['template_args']
@@ -3666,7 +3666,7 @@ 
             if ($form->is_valid()) {
                 $valid_data = $form->valid_data();
                 foreach ($valid_data as $property => $value) {
-                    $setter = 'set_' . $property;
+                    $setter = 'set_'.$property;
                     if (method_exists($network_config, $setter)) {
                         $network_config->{$setter}($value);
                     } elseif (
@@ -3702,7 +3702,7 @@ 
     protected function _get_mt_tabs($tab_array)
     {
         $tab_array = (array) $tab_array;
-        $template  = EE_MSG_TEMPLATE_PATH . 'ee_msg_details_mt_settings_tab_item.template.php';
+        $template  = EE_MSG_TEMPLATE_PATH.'ee_msg_details_mt_settings_tab_item.template.php';
         $tabs      = '';
 
         foreach ($tab_array as $tab) {
@@ -3730,20 +3730,20 @@ 
         $settings_template_args['active'] = $this->_message_resource_manager->is_messenger_active($messenger->name);
 
 
-        if (! empty($fields)) {
+        if ( ! empty($fields)) {
             $existing_settings = $messenger->get_existing_admin_settings();
 
             foreach ($fields as $fldname => $fldprops) {
-                $field_id                         = $messenger->name . '-' . $fldname;
-                $template_form_field[ $field_id ] = [
-                    'name'       => 'messenger_settings[' . $field_id . ']',
+                $field_id                         = $messenger->name.'-'.$fldname;
+                $template_form_field[$field_id] = [
+                    'name'       => 'messenger_settings['.$field_id.']',
                     'label'      => $fldprops['label'],
                     'input'      => $fldprops['field_type'],
                     'type'       => $fldprops['value_type'],
                     'required'   => $fldprops['required'],
                     'validation' => $fldprops['validation'],
-                    'value'      => isset($existing_settings[ $field_id ])
-                        ? $existing_settings[ $field_id ]
+                    'value'      => isset($existing_settings[$field_id])
+                        ? $existing_settings[$field_id]
                         : $fldprops['default'],
                     'css_class'  => '',
                     'format'     => $fldprops['format'],
@@ -3758,20 +3758,20 @@ 
 
         // we also need some hidden fields
         $settings_template_args['hidden_fields'] = [
-            'messenger_settings[messenger]' . $messenger->name => [
+            'messenger_settings[messenger]'.$messenger->name => [
                 'type'  => 'hidden',
                 'value' => $messenger->name,
             ],
-            'type' . $messenger->name                          => [
+            'type'.$messenger->name                          => [
                 'type'  => 'hidden',
                 'value' => 'messenger',
             ],
         ];
 
         // make sure any active message types that are existing are included in the hidden fields
-        if (isset($this->_m_mt_settings['message_type_tabs'][ $messenger->name ]['active'])) {
-            foreach ($this->_m_mt_settings['message_type_tabs'][ $messenger->name ]['active'] as $mt => $values) {
-                $settings_template_args['hidden_fields'][ 'messenger_settings[message_types][' . $mt . ']' ] = [
+        if (isset($this->_m_mt_settings['message_type_tabs'][$messenger->name]['active'])) {
+            foreach ($this->_m_mt_settings['message_type_tabs'][$messenger->name]['active'] as $mt => $values) {
+                $settings_template_args['hidden_fields']['messenger_settings[message_types]['.$mt.']'] = [
                     'type'  => 'hidden',
                     'value' => $mt,
                 ];
@@ -3781,7 +3781,7 @@ 
             $settings_template_args['hidden_fields'],
             'array'
         );
-        $active                                  =
+        $active =
             $this->_message_resource_manager->is_messenger_active($messenger->name);
 
         $settings_template_args['messenger']           = $messenger->name;
@@ -3801,9 +3801,9 @@ 
 
 
         $settings_template_args['on_off_action'] = $active ? 'messenger-off' : 'messenger-on';
-        $settings_template_args['nonce']         = wp_create_nonce('activate_' . $messenger->name . '_toggle_nonce');
+        $settings_template_args['nonce']         = wp_create_nonce('activate_'.$messenger->name.'_toggle_nonce');
         $settings_template_args['on_off_status'] = $active;
-        $template                                = EE_MSG_TEMPLATE_PATH . 'ee_msg_m_settings_content.template.php';
+        $template                                = EE_MSG_TEMPLATE_PATH.'ee_msg_m_settings_content.template.php';
         return EEH_Template::display_template(
             $template,
             $settings_template_args,
@@ -3828,7 +3828,7 @@ 
         $this->_prep_default_response_for_messenger_or_message_type_toggle();
         // let's check that we have required data
 
-        if (! $this->_active_messenger_name) {
+        if ( ! $this->_active_messenger_name) {
             EE_Error::add_error(
                 esc_html__('Messenger name needed to toggle activation. None given', 'event_espresso'),
                 __FILE__,
@@ -3846,7 +3846,7 @@ 
 
 
         $status = $this->request->getRequestParam('status');
-        if (! $status) {
+        if ( ! $status) {
             EE_Error::add_error(
                 esc_html__(
                     'Messenger status needed to know whether activation or deactivation is happening. No status is given',
@@ -3903,7 +3903,7 @@ 
         $this->_prep_default_response_for_messenger_or_message_type_toggle();
 
         // let's make sure we have the necessary data
-        if (! $this->_active_message_type_name) {
+        if ( ! $this->_active_message_type_name) {
             EE_Error::add_error(
                 esc_html__('Message Type name needed to toggle activation. None given', 'event_espresso'),
                 __FILE__,
@@ -3913,7 +3913,7 @@ 
             $success = false;
         }
 
-        if (! $this->_active_messenger_name) {
+        if ( ! $this->_active_messenger_name) {
             EE_Error::add_error(
                 esc_html__('Messenger name needed to toggle activation. None given', 'event_espresso'),
                 __FILE__,
@@ -3924,7 +3924,7 @@ 
         }
 
         $status = $this->request->getRequestParam('status');
-        if (! $status) {
+        if ( ! $status) {
             EE_Error::add_error(
                 esc_html__(
                     'Messenger status needed to know whether activation or deactivation is happening. No status is given',
@@ -4136,7 +4136,7 @@ 
         EE_Message_Type $message_type = null
     ) {
         // if $messenger isn't a valid messenger object then get out.
-        if (! $messenger instanceof EE_Messenger) {
+        if ( ! $messenger instanceof EE_Messenger) {
             EE_Error::add_error(
                 esc_html__('The messenger being activated is not a valid messenger', 'event_espresso'),
                 __FILE__,
@@ -4190,7 +4190,7 @@ 
             // message types after the activation process.  However its possible some messengers don't HAVE any default_message_types
             // in which case we just give a success message for the messenger being successfully activated.
         } else {
-            if (! $messenger->get_default_message_types()) {
+            if ( ! $messenger->get_default_message_types()) {
                 // messenger doesn't have any default message types so still a success.
                 EE_Error::add_success(
                     sprintf(
@@ -4246,7 +4246,7 @@ 
         EE_Error::overwrite_success();
 
         // if $messenger isn't a valid messenger object then get out.
-        if (! $messenger instanceof EE_Messenger) {
+        if ( ! $messenger instanceof EE_Messenger) {
             EE_Error::add_error(
                 esc_html__('The messenger being deactivated is not a valid messenger', 'event_espresso'),
                 __FILE__,
@@ -4310,7 +4310,7 @@ 
      */
     public function update_mt_form()
     {
-        if (! $this->_active_messenger_name || ! $this->_active_message_type_name) {
+        if ( ! $this->_active_messenger_name || ! $this->_active_message_type_name) {
             EE_Error::add_error(
                 esc_html__('Require message type or messenger to send an updated form', 'event_espresso'),
                 __FILE__,
@@ -4321,7 +4321,7 @@ 
         }
 
         $message_types = $this->get_installed_message_types();
-        $message_type  = $message_types[ $this->_active_message_type_name ];
+        $message_type  = $message_types[$this->_active_message_type_name];
         $messenger     = $this->_message_resource_manager->get_active_messenger($this->_active_messenger_name);
         $content       = $this->_message_type_settings_content($message_type, $messenger, true);
 
@@ -4340,7 +4340,7 @@ 
     public function save_settings()
     {
         $type = $this->request->getRequestParam('type');
-        if (! $type) {
+        if ( ! $type) {
             EE_Error::add_error(
                 esc_html__(
                     'Cannot save settings because type is unknown (messenger settings or message type settings?)',