eventespresso / event-espresso-core

core/admin/EE_Admin_Page.core.php

Spacing +184 added lines, -184 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],
@@ -594,21 +594,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
             );
@@ -621,8 +621,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
@@ -641,12 +641,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.',
@@ -663,7 +663,7 @@ 
                                    ),
                                    $page,
                                    '<br />',
-                                   '<strong>' . $classname . '</strong>'
+                                   '<strong>'.$classname.'</strong>'
                                );
                 throw new EE_Error(implode('||', $error_msg));
             }
@@ -705,13 +705,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();
@@ -833,7 +833,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;
@@ -845,7 +845,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'
@@ -854,9 +854,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
@@ -868,7 +868,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.',
@@ -879,7 +879,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__(
@@ -889,7 +889,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'
@@ -930,7 +930,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',
@@ -955,7 +955,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'),
@@ -972,7 +972,7 @@ 
                     __CLASS__
                 );
             }
-            if (! $this->request->isAjax()) {
+            if ( ! $this->request->isAjax()) {
                 wp_die($msg);
             }
             EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
@@ -996,7 +996,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'];
@@ -1016,7 +1016,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
@@ -1027,7 +1027,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) {
@@ -1036,7 +1036,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;
             }
@@ -1077,7 +1077,7 @@ 
                     $method
                 );
             }
-            if (! empty($error_msg)) {
+            if ( ! empty($error_msg)) {
                 throw new EE_Error($error_msg);
             }
         }
@@ -1162,7 +1162,7 @@ 
                 if (strpos($key, 'nonce') !== false) {
                     continue;
                 }
-                $args[ 'wp_referer[' . $key . ']' ] = $value;
+                $args['wp_referer['.$key.']'] = $value;
             }
         }
         return EEH_URL::add_query_args_and_nonce($args, $url, $exclude_nonce);
@@ -1202,8 +1202,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 ])) {
@@ -1226,7 +1226,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__(
@@ -1239,7 +1239,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.
@@ -1247,27 +1247,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',
@@ -1275,7 +1275,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',
@@ -1284,11 +1284,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())
@@ -1296,7 +1296,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__(
@@ -1344,7 +1344,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'],
@@ -1471,8 +1471,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);
         }
@@ -1494,7 +1494,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
@@ -1503,12 +1503,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(
@@ -1520,14 +1520,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',
@@ -1552,10 +1552,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;
                 }
             }
         }
@@ -1577,12 +1577,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'];
@@ -1707,7 +1707,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>';
     }
 
 
@@ -1741,7 +1741,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',
@@ -1755,8 +1755,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
             );
@@ -1778,15 +1778,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.',
@@ -1818,15 +1818,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, false);
+            $help_content = $this->_set_help_popup_content($help_array, false);
         }
         // let's setup the trigger
         $content = '<a class="ee-dialog" href="?height='
@@ -1894,15 +1894,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
         );
@@ -1910,21 +1910,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
@@ -1936,7 +1936,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
@@ -1944,7 +1944,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
@@ -1952,7 +1952,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
@@ -1960,28 +1960,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
@@ -2042,7 +2042,7 @@ 
 
         add_filter(
             'admin_body_class',
-            function ($classes) {
+            function($classes) {
                 if (strpos($classes, 'espresso-admin') === false) {
                     $classes .= ' espresso-admin';
                 }
@@ -2130,12 +2130,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.',
@@ -2155,10 +2155,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();
@@ -2193,7 +2193,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__(
@@ -2231,15 +2231,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;
     }
@@ -2270,14 +2270,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
@@ -2301,7 +2301,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;
     }
 
 
@@ -2389,7 +2389,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
@@ -2434,7 +2434,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(
@@ -2462,7 +2462,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',
             []
         );
     }
@@ -2470,22 +2470,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();
@@ -2552,19 +2552,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');
@@ -2593,7 +2593,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
         );
@@ -2685,18 +2685,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;
     }
 
@@ -2798,7 +2798,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'],
@@ -2808,7 +2808,7 @@ 
             }
             : $callback;
         add_meta_box(
-            str_replace('_', '-', $action) . '-mbox',
+            str_replace('_', '-', $action).'-mbox',
             $title,
             $call_back_func,
             $this->_wp_page_slug,
@@ -2900,9 +2900,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;
@@ -2942,11 +2942,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',
@@ -2966,8 +2966,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
         );
@@ -3016,7 +3016,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);
@@ -3024,10 +3024,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
             );
@@ -3045,20 +3045,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(
@@ -3092,7 +3092,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',
@@ -3139,7 +3139,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,17 +3246,17 @@ 
                 ? $this->_template_args['before_admin_page_content']
                 : ''
         );
-        $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();
         // load settings page wrapper template
         $template_path = ! $this->request->isAjax()
             ? EE_ADMIN_TEMPLATE . 'admin_wrapper.template.php'
-            : EE_ADMIN_TEMPLATE . 'admin_wrapper_ajax.template.php';
+            : EE_ADMIN_TEMPLATE.'admin_wrapper_ajax.template.php';
         // about page?
         $template_path = $about
             ? EE_ADMIN_TEMPLATE . 'about_admin_wrapper.template.php'
@@ -3350,7 +3350,7 @@ 
             : '<input type="hidden" id="save_and_close_referrer" name="save_and_close_referrer" value="'
               . $referrer
               . '" />';
-        $button_text   = ! empty($text)
+        $button_text = ! empty($text)
             ? $text
             : [
                 esc_html__('Save', 'event_espresso'),
@@ -3360,17 +3360,17 @@ 
         // add in a hidden index for the current page (so save and close redirects properly)
         $this->_template_args['save_buttons'] = $referrer_url;
         foreach ($button_text as $key => $button) {
-            $ref                                  = $default_names[ $key ];
+            $ref = $default_names[$key];
             $this->_template_args['save_buttons'] .= '<input type="submit" class="button-primary '
                                                      . $ref
                                                      . '" value="'
                                                      . $button
                                                      . '" name="'
-                                                     . (! empty($actions) ? $actions[ $key ] : $ref)
+                                                     . ( ! empty($actions) ? $actions[$key] : $ref)
                                                      . '" id="'
-                                                     . $this->_current_view . '_' . $ref
+                                                     . $this->_current_view.'_'.$ref
                                                      . '" />';
-            if (! $both) {
+            if ( ! $both) {
                 break;
             }
         }
@@ -3405,13 +3405,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="'
@@ -3420,9 +3420,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],
@@ -3435,7 +3435,7 @@ 
         $form_fields = $this->_generate_admin_form_fields($hidden_fields, 'array');
         // add fields to form
         foreach ((array) $form_fields as $field_name => $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>';
@@ -3526,10 +3526,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
@@ -3558,7 +3558,7 @@ 
             }
         }
         // check that $query_args isn't something crazy
-        if (! is_array($query_args)) {
+        if ( ! is_array($query_args)) {
             $query_args = [];
         }
         /**
@@ -3587,7 +3587,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?
@@ -3599,15 +3599,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.
@@ -3619,19 +3619,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',
@@ -3678,7 +3678,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,
@@ -3718,7 +3718,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__(
@@ -3729,7 +3729,7 @@ 
                 )
             );
         }
-        if (! isset($this->_labels['buttons'][ $type ])) {
+        if ( ! isset($this->_labels['buttons'][$type])) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -3742,7 +3742,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;
@@ -3750,11 +3750,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);
     }
 
 
@@ -3780,7 +3780,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)) {
@@ -3801,18 +3801,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,
@@ -3869,13 +3869,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()
@@ -3904,8 +3904,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);
@@ -4136,7 +4136,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>';
     }
 
 
@@ -4149,7 +4149,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>';
     }
 
 

Indentation +4111 added lines, -4111 removed lines

@@ -18,4187 +18,4187 @@
 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 . ']' ] = $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 . ']' ] = $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'd 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, false);
-        }
-        // 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,
-            false
-        );
-        // 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'd 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, false);
+		}
+		// 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,
+			false
+		);
+		// 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',
-                    urlencode(
-                        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',
+					urlencode(
+						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
-     */
-    private 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
+	 */
+	private 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 get's 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();
-        // load settings page wrapper template
-        $template_path = ! $this->request->isAjax()
-            ? EE_ADMIN_TEMPLATE . 'admin_wrapper.template.php'
-            : EE_ADMIN_TEMPLATE . 'admin_wrapper_ajax.template.php';
-        // about page?
-        $template_path = $about
-            ? EE_ADMIN_TEMPLATE . 'about_admin_wrapper.template.php'
-            : $template_path;
-        if ($this->request->isAjax()) {
-            $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-                $template_path,
-                $this->_template_args,
-                true
-            );
-            $this->_return_json();
-        } else {
-            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 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)
-            ? '<input type="hidden" id="save_and_close_referrer" name="save_and_close_referrer" value="'
-              . $this->request->getServerParam('REQUEST_URI')
-              . '" />'
-            : '<input type="hidden" id="save_and_close_referrer" name="save_and_close_referrer" value="'
-              . $referrer
-              . '" />';
-        $button_text   = ! empty($text)
-            ? $text
-            : [
-                esc_html__('Save', 'event_espresso'),
-                esc_html__('Save and Close', 'event_espresso'),
-            ];
-        $default_names = ['save', 'save_and_close'];
-        // add in a hidden index for the current page (so save and close redirects properly)
-        $this->_template_args['save_buttons'] = $referrer_url;
-        foreach ($button_text as $key => $button) {
-            $ref                                  = $default_names[ $key ];
-            $this->_template_args['save_buttons'] .= '<input type="submit" class="button-primary '
-                                                     . $ref
-                                                     . '" value="'
-                                                     . $button
-                                                     . '" name="'
-                                                     . (! empty($actions) ? $actions[ $key ] : $ref)
-                                                     . '" id="'
-                                                     . $this->_current_view . '_' . $ref
-                                                     . '" />';
-            if (! $both) {
-                break;
-            }
-        }
-    }
-
-
-    /**
-     * 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 $field_name => $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) : true;
-        $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->request->requestParams());
-        do_action(
-            'AHEE__EE_Admin_Page___process_resend_registration',
-            $this->_template_args['success'],
-            $this->request->requestParams()
-        );
-        return $this->_template_args['success'];
-    }
-
-
-    /**
-     * This automatically processes any payment message notifications when manual payment has been applied.
-     *
-     * @param EE_Payment $payment
-     * @return bool success/fail
-     */
-    protected function _process_payment_notification(EE_Payment $payment)
-    {
-        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 get's 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();
+		// load settings page wrapper template
+		$template_path = ! $this->request->isAjax()
+			? EE_ADMIN_TEMPLATE . 'admin_wrapper.template.php'
+			: EE_ADMIN_TEMPLATE . 'admin_wrapper_ajax.template.php';
+		// about page?
+		$template_path = $about
+			? EE_ADMIN_TEMPLATE . 'about_admin_wrapper.template.php'
+			: $template_path;
+		if ($this->request->isAjax()) {
+			$this->_template_args['admin_page_content'] = EEH_Template::display_template(
+				$template_path,
+				$this->_template_args,
+				true
+			);
+			$this->_return_json();
+		} else {
+			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 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)
+			? '<input type="hidden" id="save_and_close_referrer" name="save_and_close_referrer" value="'
+			  . $this->request->getServerParam('REQUEST_URI')
+			  . '" />'
+			: '<input type="hidden" id="save_and_close_referrer" name="save_and_close_referrer" value="'
+			  . $referrer
+			  . '" />';
+		$button_text   = ! empty($text)
+			? $text
+			: [
+				esc_html__('Save', 'event_espresso'),
+				esc_html__('Save and Close', 'event_espresso'),
+			];
+		$default_names = ['save', 'save_and_close'];
+		// add in a hidden index for the current page (so save and close redirects properly)
+		$this->_template_args['save_buttons'] = $referrer_url;
+		foreach ($button_text as $key => $button) {
+			$ref                                  = $default_names[ $key ];
+			$this->_template_args['save_buttons'] .= '<input type="submit" class="button-primary '
+													 . $ref
+													 . '" value="'
+													 . $button
+													 . '" name="'
+													 . (! empty($actions) ? $actions[ $key ] : $ref)
+													 . '" id="'
+													 . $this->_current_view . '_' . $ref
+													 . '" />';
+			if (! $both) {
+				break;
+			}
+		}
+	}
+
+
+	/**
+	 * 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 $field_name => $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) : true;
+		$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->request->requestParams());
+		do_action(
+			'AHEE__EE_Admin_Page___process_resend_registration',
+			$this->_template_args['success'],
+			$this->request->requestParams()
+		);
+		return $this->_template_args['success'];
+	}
+
+
+	/**
+	 * This automatically processes any payment message notifications when manual payment has been applied.
+	 *
+	 * @param EE_Payment $payment
+	 * @return bool success/fail
+	 */
+	protected function _process_payment_notification(EE_Payment $payment)
+	{
+		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'];
+	}
 }

core/services/request/sanitizers/RequestSanitizer.php

Indentation +55 added lines, -55 removed lines

@@ -4,61 +4,61 @@
 
 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, string $type = 'string', bool $is_array = false, string $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, string $type = 'string', bool $is_array = false, string $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   $VID:$
-     */
-    public function sanitizeParam($param, string $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 '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   $VID:$
+	 */
+	public function sanitizeParam($param, string $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 'url':
+				return esc_url_raw($param);
+			case 'string':
+			default:
+				return sanitize_text_field($param);
+		}
+	}
 }

core/db_models/EEM_Country.model.php

Indentation +205 added lines, -205 removed lines

@@ -11,209 +11,209 @@
 class EEM_Country extends EEM_Base
 {
 
-    // private instance of the Attendee object
-    protected static $_instance = null;
-
-    // array of all countries
-    private static $_all_countries = false;
-
-    // array of all active countries
-    private static $_active_countries = false;
-
-
-    /**
-     * Resets the country
-     *
-     * @param string $timezone
-     * @return EEM_Country|EEM_Base|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function reset($timezone = null)
-    {
-        self::$_active_countries = null;
-        self::$_all_countries    = null;
-        return parent::reset($timezone);
-    }
-
-
-    protected function __construct($timezone = '')
-    {
-        $this->singular_item = esc_html__('Country', 'event_espresso');
-        $this->plural_item   = esc_html__('Countries', 'event_espresso');
-
-        $this->_tables = [
-            'Country' => new EE_Primary_Table('esp_country', 'CNT_ISO'),
-        ];
-
-        $this->_fields          = [
-            'Country' => [
-                'CNT_active'      => new EE_Boolean_Field(
-                    'CNT_active',
-                    esc_html__('Country Appears in Dropdown Select Lists', 'event_espresso'),
-                    false,
-                    true
-                ),
-                'CNT_ISO'         => new EE_Primary_Key_String_Field(
-                    'CNT_ISO',
-                    esc_html__('Country ISO Code', 'event_espresso')
-                ),
-                'CNT_ISO3'        => new EE_All_Caps_Text_Field(
-                    'CNT_ISO3',
-                    esc_html__('Country ISO3 Code', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'RGN_ID'          => new EE_Integer_Field(
-                    'RGN_ID',
-                    esc_html__('Region ID', 'event_espresso'),
-                    false,
-                    0
-                ),
-                // should be a foreign key, but no region table exists yet
-                'CNT_name'        => new EE_Plain_Text_Field(
-                    'CNT_name',
-                    esc_html__('Country Name', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'CNT_cur_code'    => new EE_All_Caps_Text_Field(
-                    'CNT_cur_code',
-                    esc_html__('Country Currency Code', 'event_espresso'),
-                    false
-                ),
-                'CNT_cur_single'  => new EE_Plain_Text_Field(
-                    'CNT_cur_single',
-                    esc_html__('Currency Name Singular', 'event_espresso'),
-                    false
-                ),
-                'CNT_cur_plural'  => new EE_Plain_Text_Field(
-                    'CNT_cur_plural',
-                    esc_html__('Currency Name Plural', 'event_espresso'),
-                    false
-                ),
-                'CNT_cur_sign'    => new EE_Plain_Text_Field(
-                    'CNT_cur_sign',
-                    esc_html__('Currency Sign', 'event_espresso'),
-                    false
-                ),
-                'CNT_cur_sign_b4' => new EE_Boolean_Field(
-                    'CNT_cur_sign_b4',
-                    esc_html__('Currency Sign Before Number', 'event_espresso'),
-                    false,
-                    true
-                ),
-                'CNT_cur_dec_plc' => new EE_Integer_Field(
-                    'CNT_cur_dec_plc',
-                    esc_html__('Currency Decimal Places', 'event_espresso'),
-                    false,
-                    2
-                ),
-                'CNT_cur_dec_mrk' => new EE_Plain_Text_Field(
-                    'CNT_cur_dec_mrk',
-                    esc_html__('Currency Decimal Mark', 'event_espresso'),
-                    false,
-                    '.'
-                ),
-                'CNT_cur_thsnds'  => new EE_Plain_Text_Field(
-                    'CNT_cur_thsnds',
-                    esc_html__('Currency Thousands Separator', 'event_espresso'),
-                    false,
-                    ','
-                ),
-                'CNT_tel_code'    => new EE_Plain_Text_Field(
-                    'CNT_tel_code',
-                    esc_html__('Country Telephone Code', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'CNT_is_EU'       => new EE_Boolean_Field(
-                    'CNT_is_EU',
-                    esc_html__('Country is Member of EU', 'event_espresso'),
-                    false,
-                    false
-                ),
-            ],
-        ];
-        $this->_model_relations = [
-            'Attendee' => new EE_Has_Many_Relation(),
-            'State'    => new EE_Has_Many_Relation(),
-            'Venue'    => new EE_Has_Many_Relation(),
-        ];
-        // only anyone to view, but only those with the default role can do anything
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
-
-        parent::__construct($timezone);
-    }
-
-
-    /**
-     * @return EE_Country[]
-     * @throws EE_Error
-     */
-    public function get_all_countries()
-    {
-        if (! self::$_all_countries) {
-            self::$_all_countries = $this->get_all(['order_by' => ['CNT_name' => 'ASC'], 'limit' => [0, 99999]]);
-        }
-        return self::$_all_countries;
-    }
-
-
-    /**
-     * Gets and caches the list of active countries. If you know the list of active countries
-     * has changed during this request, first use EEM_Country::reset() to flush the cache
-     *
-     * @return EE_Country[]
-     * @throws EE_Error
-     */
-    public function get_all_active_countries()
-    {
-        if (! self::$_active_countries) {
-            self::$_active_countries =
-                $this->get_all([['CNT_active' => true], 'order_by' => ['CNT_name' => 'ASC'], 'limit' => [0, 99999]]);
-        }
-        return self::$_active_countries;
-    }
-
-
-    /**
-     * Gets the country's name by its ISO
-     *
-     * @param string $country_ISO
-     * @return string
-     * @throws EE_Error
-     */
-    public function get_country_name_by_ISO($country_ISO)
-    {
-        $countries = $this->get_all_countries();
-        if (isset($countries[ $country_ISO ]) && $countries[ $country_ISO ] instanceof EE_Country) {
-            return $countries[ $country_ISO ]->name();
-        }
-        $names = $this->get_col([['CNT_ISO' => $country_ISO], 'limit' => 1], 'CNT_name');
-        if (is_array($names) && ! empty($names)) {
-            return reset($names);
-        } else {
-            return '';
-        }
-    }
-
-
-    /**
-     * Gets the country's name by its name
-     *
-     * @param string $country_name
-     * @return EE_Country|null
-     * @throws EE_Error
-     */
-    public function getCountryByName($country_name)
-    {
-        $countries = $this->get_all_countries();
-        foreach ($countries as $country) {
-            if ($country instanceof EE_Country && $country->name() === $country_name) {
-                return $country;
-            }
-        }
-        return $this->get_one([['CNT_name' => $country_name]]);
-    }
+	// private instance of the Attendee object
+	protected static $_instance = null;
+
+	// array of all countries
+	private static $_all_countries = false;
+
+	// array of all active countries
+	private static $_active_countries = false;
+
+
+	/**
+	 * Resets the country
+	 *
+	 * @param string $timezone
+	 * @return EEM_Country|EEM_Base|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function reset($timezone = null)
+	{
+		self::$_active_countries = null;
+		self::$_all_countries    = null;
+		return parent::reset($timezone);
+	}
+
+
+	protected function __construct($timezone = '')
+	{
+		$this->singular_item = esc_html__('Country', 'event_espresso');
+		$this->plural_item   = esc_html__('Countries', 'event_espresso');
+
+		$this->_tables = [
+			'Country' => new EE_Primary_Table('esp_country', 'CNT_ISO'),
+		];
+
+		$this->_fields          = [
+			'Country' => [
+				'CNT_active'      => new EE_Boolean_Field(
+					'CNT_active',
+					esc_html__('Country Appears in Dropdown Select Lists', 'event_espresso'),
+					false,
+					true
+				),
+				'CNT_ISO'         => new EE_Primary_Key_String_Field(
+					'CNT_ISO',
+					esc_html__('Country ISO Code', 'event_espresso')
+				),
+				'CNT_ISO3'        => new EE_All_Caps_Text_Field(
+					'CNT_ISO3',
+					esc_html__('Country ISO3 Code', 'event_espresso'),
+					false,
+					''
+				),
+				'RGN_ID'          => new EE_Integer_Field(
+					'RGN_ID',
+					esc_html__('Region ID', 'event_espresso'),
+					false,
+					0
+				),
+				// should be a foreign key, but no region table exists yet
+				'CNT_name'        => new EE_Plain_Text_Field(
+					'CNT_name',
+					esc_html__('Country Name', 'event_espresso'),
+					false,
+					''
+				),
+				'CNT_cur_code'    => new EE_All_Caps_Text_Field(
+					'CNT_cur_code',
+					esc_html__('Country Currency Code', 'event_espresso'),
+					false
+				),
+				'CNT_cur_single'  => new EE_Plain_Text_Field(
+					'CNT_cur_single',
+					esc_html__('Currency Name Singular', 'event_espresso'),
+					false
+				),
+				'CNT_cur_plural'  => new EE_Plain_Text_Field(
+					'CNT_cur_plural',
+					esc_html__('Currency Name Plural', 'event_espresso'),
+					false
+				),
+				'CNT_cur_sign'    => new EE_Plain_Text_Field(
+					'CNT_cur_sign',
+					esc_html__('Currency Sign', 'event_espresso'),
+					false
+				),
+				'CNT_cur_sign_b4' => new EE_Boolean_Field(
+					'CNT_cur_sign_b4',
+					esc_html__('Currency Sign Before Number', 'event_espresso'),
+					false,
+					true
+				),
+				'CNT_cur_dec_plc' => new EE_Integer_Field(
+					'CNT_cur_dec_plc',
+					esc_html__('Currency Decimal Places', 'event_espresso'),
+					false,
+					2
+				),
+				'CNT_cur_dec_mrk' => new EE_Plain_Text_Field(
+					'CNT_cur_dec_mrk',
+					esc_html__('Currency Decimal Mark', 'event_espresso'),
+					false,
+					'.'
+				),
+				'CNT_cur_thsnds'  => new EE_Plain_Text_Field(
+					'CNT_cur_thsnds',
+					esc_html__('Currency Thousands Separator', 'event_espresso'),
+					false,
+					','
+				),
+				'CNT_tel_code'    => new EE_Plain_Text_Field(
+					'CNT_tel_code',
+					esc_html__('Country Telephone Code', 'event_espresso'),
+					false,
+					''
+				),
+				'CNT_is_EU'       => new EE_Boolean_Field(
+					'CNT_is_EU',
+					esc_html__('Country is Member of EU', 'event_espresso'),
+					false,
+					false
+				),
+			],
+		];
+		$this->_model_relations = [
+			'Attendee' => new EE_Has_Many_Relation(),
+			'State'    => new EE_Has_Many_Relation(),
+			'Venue'    => new EE_Has_Many_Relation(),
+		];
+		// only anyone to view, but only those with the default role can do anything
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
+
+		parent::__construct($timezone);
+	}
+
+
+	/**
+	 * @return EE_Country[]
+	 * @throws EE_Error
+	 */
+	public function get_all_countries()
+	{
+		if (! self::$_all_countries) {
+			self::$_all_countries = $this->get_all(['order_by' => ['CNT_name' => 'ASC'], 'limit' => [0, 99999]]);
+		}
+		return self::$_all_countries;
+	}
+
+
+	/**
+	 * Gets and caches the list of active countries. If you know the list of active countries
+	 * has changed during this request, first use EEM_Country::reset() to flush the cache
+	 *
+	 * @return EE_Country[]
+	 * @throws EE_Error
+	 */
+	public function get_all_active_countries()
+	{
+		if (! self::$_active_countries) {
+			self::$_active_countries =
+				$this->get_all([['CNT_active' => true], 'order_by' => ['CNT_name' => 'ASC'], 'limit' => [0, 99999]]);
+		}
+		return self::$_active_countries;
+	}
+
+
+	/**
+	 * Gets the country's name by its ISO
+	 *
+	 * @param string $country_ISO
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function get_country_name_by_ISO($country_ISO)
+	{
+		$countries = $this->get_all_countries();
+		if (isset($countries[ $country_ISO ]) && $countries[ $country_ISO ] instanceof EE_Country) {
+			return $countries[ $country_ISO ]->name();
+		}
+		$names = $this->get_col([['CNT_ISO' => $country_ISO], 'limit' => 1], 'CNT_name');
+		if (is_array($names) && ! empty($names)) {
+			return reset($names);
+		} else {
+			return '';
+		}
+	}
+
+
+	/**
+	 * Gets the country's name by its name
+	 *
+	 * @param string $country_name
+	 * @return EE_Country|null
+	 * @throws EE_Error
+	 */
+	public function getCountryByName($country_name)
+	{
+		$countries = $this->get_all_countries();
+		foreach ($countries as $country) {
+			if ($country instanceof EE_Country && $country->name() === $country_name) {
+				return $country;
+			}
+		}
+		return $this->get_one([['CNT_name' => $country_name]]);
+	}
 }

Spacing +6 added lines, -6 removed lines

@@ -46,7 +46,7 @@ 
             'Country' => new EE_Primary_Table('esp_country', 'CNT_ISO'),
         ];
 
-        $this->_fields          = [
+        $this->_fields = [
             'Country' => [
                 'CNT_active'      => new EE_Boolean_Field(
                     'CNT_active',
@@ -141,7 +141,7 @@ 
             'Venue'    => new EE_Has_Many_Relation(),
         ];
         // only anyone to view, but only those with the default role can do anything
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
+        $this->_cap_restriction_generators[EEM_Base::caps_read] = new EE_Restriction_Generator_Public();
 
         parent::__construct($timezone);
     }
@@ -153,7 +153,7 @@ 
      */
     public function get_all_countries()
     {
-        if (! self::$_all_countries) {
+        if ( ! self::$_all_countries) {
             self::$_all_countries = $this->get_all(['order_by' => ['CNT_name' => 'ASC'], 'limit' => [0, 99999]]);
         }
         return self::$_all_countries;
@@ -169,7 +169,7 @@ 
      */
     public function get_all_active_countries()
     {
-        if (! self::$_active_countries) {
+        if ( ! self::$_active_countries) {
             self::$_active_countries =
                 $this->get_all([['CNT_active' => true], 'order_by' => ['CNT_name' => 'ASC'], 'limit' => [0, 99999]]);
         }
@@ -187,8 +187,8 @@ 
     public function get_country_name_by_ISO($country_ISO)
     {
         $countries = $this->get_all_countries();
-        if (isset($countries[ $country_ISO ]) && $countries[ $country_ISO ] instanceof EE_Country) {
-            return $countries[ $country_ISO ]->name();
+        if (isset($countries[$country_ISO]) && $countries[$country_ISO] instanceof EE_Country) {
+            return $countries[$country_ISO]->name();
         }
         $names = $this->get_col([['CNT_ISO' => $country_ISO], 'limit' => 1], 'CNT_name');
         if (is_array($names) && ! empty($names)) {

modules/ticket_selector/ProcessTicketSelectorPostData.php

Indentation +231 added lines, -231 removed lines

@@ -16,235 +16,235 @@
 class ProcessTicketSelectorPostData
 {
 
-    const DATA_KEY_EVENT_ID      = 'id';
-
-    const DATA_KEY_MAX_ATNDZ     = 'max_atndz';
-
-    const DATA_KEY_QUANTITY      = 'qty';
-
-    const DATA_KEY_RETURN_URL    = 'return_url';
-
-    const DATA_KEY_ROWS          = 'rows';
-
-    const DATA_KEY_TICKET_ID     = 'ticket_id';
-
-    const DATA_KEY_TOTAL_TICKETS = 'total_tickets';
-
-    const INPUT_KEY_EVENT_ID     = 'tkt-slctr-event-id';
-
-    const INPUT_KEY_MAX_ATNDZ    = 'tkt-slctr-max-atndz-';
-
-    const INPUT_KEY_ROWS         = 'tkt-slctr-rows-';
-
-    const INPUT_KEY_QTY          = 'tkt-slctr-qty-';
-
-    const INPUT_KEY_TICKET_ID    = 'tkt-slctr-ticket-id-';
-
-    const INPUT_KEY_RETURN_URL   = 'tkt-slctr-return-url-';
-
-
-    /**
-     * @var int
-     */
-    protected $event_id;
-
-    /**
-     * @var array
-     */
-    protected $inputs_to_clean = [];
-
-    /**
-     * @var array
-     */
-    protected $valid_data = [];
-
-    /**
-     * @var RequestInterface
-     */
-    protected $request;
-
-
-    /**
-     * @param RequestInterface $request
-     */
-    public function __construct(RequestInterface $request)
-    {
-        $this->request         = $request;
-        $this->inputs_to_clean = [
-            self::DATA_KEY_MAX_ATNDZ     => self::INPUT_KEY_MAX_ATNDZ,
-            self::DATA_KEY_ROWS          => self::INPUT_KEY_ROWS,
-            self::DATA_KEY_QUANTITY      => self::INPUT_KEY_QTY,
-            self::DATA_KEY_TOTAL_TICKETS => self::INPUT_KEY_TICKET_ID,
-            self::DATA_KEY_RETURN_URL    => self::INPUT_KEY_RETURN_URL,
-        ];
-    }
-
-
-    /**
-     * @return int
-     * @throws DomainException
-     */
-    public function getEventId(): int
-    {
-        // do we have an event id?
-        if ($this->event_id === null) {
-            $this->event_id = $this->request->getRequestParam(self::INPUT_KEY_EVENT_ID, 0, 'int');
-            if (! $this->event_id) {
-                // $_POST['tkt-slctr-event-id'] was not set ?!?!?!?
-                throw new DomainException(
-                    sprintf(
-                        esc_html__(
-                            'An event id was not provided or was not received.%sPlease click the back button on your browser and try again.',
-                            'event_espresso'
-                        ),
-                        '<br/>'
-                    )
-                );
-            }
-        }
-        // event id is valid
-        return $this->event_id;
-    }
-
-
-    /**
-     * @return array
-     * @throws DomainException
-     */
-    public function validatePostData(): array
-    {
-        // grab valid id
-        $this->valid_data[ self::DATA_KEY_EVENT_ID ] = $this->getEventId();
-        // let's track the total number of tickets ordered.'
-        $this->valid_data[ self:: DATA_KEY_TOTAL_TICKETS ] = 0;
-        // cycle through $inputs_to_clean array
-        foreach ($this->inputs_to_clean as $what => $input_to_clean) {
-            $input_key = "{$input_to_clean}{$this->event_id}";
-            // check for POST data
-            if ($this->request->requestParamIsSet($input_key)) {
-                switch ($what) {
-                    // integers
-                    case self::DATA_KEY_ROWS:
-                    case self::DATA_KEY_MAX_ATNDZ:
-                        $this->processInteger($what, $input_key);
-                        break;
-                    // arrays of integers
-                    case self::DATA_KEY_QUANTITY:
-                        $this->processQuantity($input_key);
-                        break;
-                    // array of integers
-                    case self::DATA_KEY_TOTAL_TICKETS:
-                        $this->processTicketIDs($input_key);
-                        break;
-                    case self::DATA_KEY_RETURN_URL:
-                        $this->processReturnURL($input_key);
-                        break;
-                }
-            }
-        }
-        return $this->valid_data;
-    }
-
-
-    /**
-     * @param string $what
-     * @param string $input_key
-     */
-    protected function processInteger(string $what, string $input_key)
-    {
-        $this->valid_data[ $what ] = $this->request->getRequestParam($input_key, 0, 'int');
-    }
-
-
-    /**
-     * @param string $input_key
-     * @throws DomainException
-     */
-    protected function processQuantity(string $input_key)
-    {
-        // first get number of ticket option rows
-        $rows    = $this->request->getRequestParam(self::INPUT_KEY_ROWS . $this->event_id, 1, 'int');
-        $raw_qty = $this->request->getRequestParam($input_key);
-        // explode integers by the dash if qty is a string
-        $delimiter = is_string($raw_qty) && strpos($raw_qty, '-') ? '-' : '';
-        /** @var array $row_qty */
-        $row_qty = $this->request->getRequestParam($input_key, [], 'int', true, $delimiter);
-        // if qty is coming from a radio button input, then we need to assemble an array of rows
-        if ($delimiter === '-') {
-            $row = isset($row_qty[0]) ? absint($row_qty[0]) : 1;
-            $qty = isset($row_qty[1]) ? absint($row_qty[1]) : 0;
-            // restructure the row qty array so that $row is now the key instead of the first value
-            $row_qty = [$row => $qty];
-            for ($x = 1; $x <= $rows; $x++) {
-                if (! isset($row_qty[ $x ])) {
-                    $row_qty[ $x ] = 0;
-                }
-            }
-        }
-        if (empty($row_qty) || ! is_array($row_qty) || $rows !== count($row_qty)) {
-            throw new DomainException(
-                sprintf(
-                    esc_html__(
-                        'An error occurred while trying to retrieve the ticket selections for the event.%sPlease click the back button on your browser and try again.',
-                        'event_espresso'
-                    ),
-                    '<br/>'
-                )
-            );
-        }
-        ksort($row_qty);
-        // cycle thru values
-        foreach ($row_qty as $qty) {
-            $qty = absint($qty);
-            // sanitize as integers
-            $this->valid_data[ self::DATA_KEY_QUANTITY ][]     = $qty;
-            $this->valid_data[ self:: DATA_KEY_TOTAL_TICKETS ] += $qty;
-        }
-    }
-
-
-    /**
-     * @param string $input_key
-     */
-    protected function processReturnURL(string $input_key)
-    {
-        // grab and sanitize return-url
-        $input_value = $this->request->getRequestParam($input_key, '', 'url');
-        // was the request coming from an iframe ? if so, then:
-        if (strpos($input_value, 'event_list=iframe')) {
-            // get anchor fragment
-            $input_value = explode('#', $input_value);
-            $input_value = end($input_value);
-            // use event list url instead, but append anchor
-            $input_value = EEH_Event_View::event_archive_url() . '#' . $input_value;
-        }
-        $this->valid_data[ self::DATA_KEY_RETURN_URL ] = $input_value;
-    }
-
-
-    /**
-     * @param string $input_key
-     * @throws DomainException
-     */
-    protected function processTicketIDs(string $input_key)
-    {
-        $ticket_ids          = (array) $this->request->getRequestParam($input_key, [], 'int', true);
-        $filtered_ticket_ids = array_filter($ticket_ids);
-        if (empty($filtered_ticket_ids)) {
-            throw new DomainException(
-                sprintf(
-                    esc_html__(
-                        'An error occurred while trying to retrieve the ticket IDs for the event.%sPlease click the back button on your browser and try again.',
-                        'event_espresso'
-                    ),
-                    '<br/>'
-                )
-            );
-        }
-        // cycle thru values
-        foreach ($ticket_ids as $key => $value) {
-            // allow only integers
-            $this->valid_data[ self::DATA_KEY_TICKET_ID ][ $key ] = absint($value);
-        }
-    }
+	const DATA_KEY_EVENT_ID      = 'id';
+
+	const DATA_KEY_MAX_ATNDZ     = 'max_atndz';
+
+	const DATA_KEY_QUANTITY      = 'qty';
+
+	const DATA_KEY_RETURN_URL    = 'return_url';
+
+	const DATA_KEY_ROWS          = 'rows';
+
+	const DATA_KEY_TICKET_ID     = 'ticket_id';
+
+	const DATA_KEY_TOTAL_TICKETS = 'total_tickets';
+
+	const INPUT_KEY_EVENT_ID     = 'tkt-slctr-event-id';
+
+	const INPUT_KEY_MAX_ATNDZ    = 'tkt-slctr-max-atndz-';
+
+	const INPUT_KEY_ROWS         = 'tkt-slctr-rows-';
+
+	const INPUT_KEY_QTY          = 'tkt-slctr-qty-';
+
+	const INPUT_KEY_TICKET_ID    = 'tkt-slctr-ticket-id-';
+
+	const INPUT_KEY_RETURN_URL   = 'tkt-slctr-return-url-';
+
+
+	/**
+	 * @var int
+	 */
+	protected $event_id;
+
+	/**
+	 * @var array
+	 */
+	protected $inputs_to_clean = [];
+
+	/**
+	 * @var array
+	 */
+	protected $valid_data = [];
+
+	/**
+	 * @var RequestInterface
+	 */
+	protected $request;
+
+
+	/**
+	 * @param RequestInterface $request
+	 */
+	public function __construct(RequestInterface $request)
+	{
+		$this->request         = $request;
+		$this->inputs_to_clean = [
+			self::DATA_KEY_MAX_ATNDZ     => self::INPUT_KEY_MAX_ATNDZ,
+			self::DATA_KEY_ROWS          => self::INPUT_KEY_ROWS,
+			self::DATA_KEY_QUANTITY      => self::INPUT_KEY_QTY,
+			self::DATA_KEY_TOTAL_TICKETS => self::INPUT_KEY_TICKET_ID,
+			self::DATA_KEY_RETURN_URL    => self::INPUT_KEY_RETURN_URL,
+		];
+	}
+
+
+	/**
+	 * @return int
+	 * @throws DomainException
+	 */
+	public function getEventId(): int
+	{
+		// do we have an event id?
+		if ($this->event_id === null) {
+			$this->event_id = $this->request->getRequestParam(self::INPUT_KEY_EVENT_ID, 0, 'int');
+			if (! $this->event_id) {
+				// $_POST['tkt-slctr-event-id'] was not set ?!?!?!?
+				throw new DomainException(
+					sprintf(
+						esc_html__(
+							'An event id was not provided or was not received.%sPlease click the back button on your browser and try again.',
+							'event_espresso'
+						),
+						'<br/>'
+					)
+				);
+			}
+		}
+		// event id is valid
+		return $this->event_id;
+	}
+
+
+	/**
+	 * @return array
+	 * @throws DomainException
+	 */
+	public function validatePostData(): array
+	{
+		// grab valid id
+		$this->valid_data[ self::DATA_KEY_EVENT_ID ] = $this->getEventId();
+		// let's track the total number of tickets ordered.'
+		$this->valid_data[ self:: DATA_KEY_TOTAL_TICKETS ] = 0;
+		// cycle through $inputs_to_clean array
+		foreach ($this->inputs_to_clean as $what => $input_to_clean) {
+			$input_key = "{$input_to_clean}{$this->event_id}";
+			// check for POST data
+			if ($this->request->requestParamIsSet($input_key)) {
+				switch ($what) {
+					// integers
+					case self::DATA_KEY_ROWS:
+					case self::DATA_KEY_MAX_ATNDZ:
+						$this->processInteger($what, $input_key);
+						break;
+					// arrays of integers
+					case self::DATA_KEY_QUANTITY:
+						$this->processQuantity($input_key);
+						break;
+					// array of integers
+					case self::DATA_KEY_TOTAL_TICKETS:
+						$this->processTicketIDs($input_key);
+						break;
+					case self::DATA_KEY_RETURN_URL:
+						$this->processReturnURL($input_key);
+						break;
+				}
+			}
+		}
+		return $this->valid_data;
+	}
+
+
+	/**
+	 * @param string $what
+	 * @param string $input_key
+	 */
+	protected function processInteger(string $what, string $input_key)
+	{
+		$this->valid_data[ $what ] = $this->request->getRequestParam($input_key, 0, 'int');
+	}
+
+
+	/**
+	 * @param string $input_key
+	 * @throws DomainException
+	 */
+	protected function processQuantity(string $input_key)
+	{
+		// first get number of ticket option rows
+		$rows    = $this->request->getRequestParam(self::INPUT_KEY_ROWS . $this->event_id, 1, 'int');
+		$raw_qty = $this->request->getRequestParam($input_key);
+		// explode integers by the dash if qty is a string
+		$delimiter = is_string($raw_qty) && strpos($raw_qty, '-') ? '-' : '';
+		/** @var array $row_qty */
+		$row_qty = $this->request->getRequestParam($input_key, [], 'int', true, $delimiter);
+		// if qty is coming from a radio button input, then we need to assemble an array of rows
+		if ($delimiter === '-') {
+			$row = isset($row_qty[0]) ? absint($row_qty[0]) : 1;
+			$qty = isset($row_qty[1]) ? absint($row_qty[1]) : 0;
+			// restructure the row qty array so that $row is now the key instead of the first value
+			$row_qty = [$row => $qty];
+			for ($x = 1; $x <= $rows; $x++) {
+				if (! isset($row_qty[ $x ])) {
+					$row_qty[ $x ] = 0;
+				}
+			}
+		}
+		if (empty($row_qty) || ! is_array($row_qty) || $rows !== count($row_qty)) {
+			throw new DomainException(
+				sprintf(
+					esc_html__(
+						'An error occurred while trying to retrieve the ticket selections for the event.%sPlease click the back button on your browser and try again.',
+						'event_espresso'
+					),
+					'<br/>'
+				)
+			);
+		}
+		ksort($row_qty);
+		// cycle thru values
+		foreach ($row_qty as $qty) {
+			$qty = absint($qty);
+			// sanitize as integers
+			$this->valid_data[ self::DATA_KEY_QUANTITY ][]     = $qty;
+			$this->valid_data[ self:: DATA_KEY_TOTAL_TICKETS ] += $qty;
+		}
+	}
+
+
+	/**
+	 * @param string $input_key
+	 */
+	protected function processReturnURL(string $input_key)
+	{
+		// grab and sanitize return-url
+		$input_value = $this->request->getRequestParam($input_key, '', 'url');
+		// was the request coming from an iframe ? if so, then:
+		if (strpos($input_value, 'event_list=iframe')) {
+			// get anchor fragment
+			$input_value = explode('#', $input_value);
+			$input_value = end($input_value);
+			// use event list url instead, but append anchor
+			$input_value = EEH_Event_View::event_archive_url() . '#' . $input_value;
+		}
+		$this->valid_data[ self::DATA_KEY_RETURN_URL ] = $input_value;
+	}
+
+
+	/**
+	 * @param string $input_key
+	 * @throws DomainException
+	 */
+	protected function processTicketIDs(string $input_key)
+	{
+		$ticket_ids          = (array) $this->request->getRequestParam($input_key, [], 'int', true);
+		$filtered_ticket_ids = array_filter($ticket_ids);
+		if (empty($filtered_ticket_ids)) {
+			throw new DomainException(
+				sprintf(
+					esc_html__(
+						'An error occurred while trying to retrieve the ticket IDs for the event.%sPlease click the back button on your browser and try again.',
+						'event_espresso'
+					),
+					'<br/>'
+				)
+			);
+		}
+		// cycle thru values
+		foreach ($ticket_ids as $key => $value) {
+			// allow only integers
+			$this->valid_data[ self::DATA_KEY_TICKET_ID ][ $key ] = absint($value);
+		}
+	}
 }

Spacing +12 added lines, -12 removed lines

@@ -89,7 +89,7 @@ 
         // do we have an event id?
         if ($this->event_id === null) {
             $this->event_id = $this->request->getRequestParam(self::INPUT_KEY_EVENT_ID, 0, 'int');
-            if (! $this->event_id) {
+            if ( ! $this->event_id) {
                 // $_POST['tkt-slctr-event-id'] was not set ?!?!?!?
                 throw new DomainException(
                     sprintf(
@@ -114,9 +114,9 @@ 
     public function validatePostData(): array
     {
         // grab valid id
-        $this->valid_data[ self::DATA_KEY_EVENT_ID ] = $this->getEventId();
+        $this->valid_data[self::DATA_KEY_EVENT_ID] = $this->getEventId();
         // let's track the total number of tickets ordered.'
-        $this->valid_data[ self:: DATA_KEY_TOTAL_TICKETS ] = 0;
+        $this->valid_data[self:: DATA_KEY_TOTAL_TICKETS] = 0;
         // cycle through $inputs_to_clean array
         foreach ($this->inputs_to_clean as $what => $input_to_clean) {
             $input_key = "{$input_to_clean}{$this->event_id}";
@@ -152,7 +152,7 @@ 
      */
     protected function processInteger(string $what, string $input_key)
     {
-        $this->valid_data[ $what ] = $this->request->getRequestParam($input_key, 0, 'int');
+        $this->valid_data[$what] = $this->request->getRequestParam($input_key, 0, 'int');
     }
 
 
@@ -163,7 +163,7 @@ 
     protected function processQuantity(string $input_key)
     {
         // first get number of ticket option rows
-        $rows    = $this->request->getRequestParam(self::INPUT_KEY_ROWS . $this->event_id, 1, 'int');
+        $rows    = $this->request->getRequestParam(self::INPUT_KEY_ROWS.$this->event_id, 1, 'int');
         $raw_qty = $this->request->getRequestParam($input_key);
         // explode integers by the dash if qty is a string
         $delimiter = is_string($raw_qty) && strpos($raw_qty, '-') ? '-' : '';
@@ -176,8 +176,8 @@ 
             // restructure the row qty array so that $row is now the key instead of the first value
             $row_qty = [$row => $qty];
             for ($x = 1; $x <= $rows; $x++) {
-                if (! isset($row_qty[ $x ])) {
-                    $row_qty[ $x ] = 0;
+                if ( ! isset($row_qty[$x])) {
+                    $row_qty[$x] = 0;
                 }
             }
         }
@@ -197,8 +197,8 @@ 
         foreach ($row_qty as $qty) {
             $qty = absint($qty);
             // sanitize as integers
-            $this->valid_data[ self::DATA_KEY_QUANTITY ][]     = $qty;
-            $this->valid_data[ self:: DATA_KEY_TOTAL_TICKETS ] += $qty;
+            $this->valid_data[self::DATA_KEY_QUANTITY][] = $qty;
+            $this->valid_data[self:: DATA_KEY_TOTAL_TICKETS] += $qty;
         }
     }
 
@@ -216,9 +216,9 @@ 
             $input_value = explode('#', $input_value);
             $input_value = end($input_value);
             // use event list url instead, but append anchor
-            $input_value = EEH_Event_View::event_archive_url() . '#' . $input_value;
+            $input_value = EEH_Event_View::event_archive_url().'#'.$input_value;
         }
-        $this->valid_data[ self::DATA_KEY_RETURN_URL ] = $input_value;
+        $this->valid_data[self::DATA_KEY_RETURN_URL] = $input_value;
     }
 
 
@@ -244,7 +244,7 @@ 
         // cycle thru values
         foreach ($ticket_ids as $key => $value) {
             // allow only integers
-            $this->valid_data[ self::DATA_KEY_TICKET_ID ][ $key ] = absint($value);
+            $this->valid_data[self::DATA_KEY_TICKET_ID][$key] = absint($value);
         }
     }
 }

modules/ticket_selector/ProcessTicketSelector.php

Indentation +375 added lines, -375 removed lines

@@ -34,400 +34,400 @@
 class ProcessTicketSelector
 {
 
-    /**
-     * @var EE_Cart $cart
-     */
-    private $cart;
+	/**
+	 * @var EE_Cart $cart
+	 */
+	private $cart;
 
-    /**
-     * @var EE_Core_Config $core_config
-     */
-    private $core_config;
+	/**
+	 * @var EE_Core_Config $core_config
+	 */
+	private $core_config;
 
-    /**
-     * @var RequestInterface $request
-     */
-    private $request;
+	/**
+	 * @var RequestInterface $request
+	 */
+	private $request;
 
-    /**
-     * @var EE_Session $session
-     */
-    private $session;
+	/**
+	 * @var EE_Session $session
+	 */
+	private $session;
 
-    /**
-     * @var EEM_Ticket $ticket_model
-     */
-    private $ticket_model;
+	/**
+	 * @var EEM_Ticket $ticket_model
+	 */
+	private $ticket_model;
 
-    /**
-     * @var TicketDatetimeAvailabilityTracker $tracker
-     */
-    private $tracker;
+	/**
+	 * @var TicketDatetimeAvailabilityTracker $tracker
+	 */
+	private $tracker;
 
 
-    /**
-     * ProcessTicketSelector constructor.
-     * NOTE: PLZ use the Loader to instantiate this class if need be
-     * so that all dependencies get injected correctly (which will happen automatically)
-     * Null values for parameters are only for backwards compatibility but will be removed later on.
-     *
-     * @param EE_Core_Config                    $core_config
-     * @param RequestInterface                           $request
-     * @param EE_Session                        $session
-     * @param EEM_Ticket                        $ticket_model
-     * @param TicketDatetimeAvailabilityTracker $tracker
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function __construct(
-        EE_Core_Config $core_config = null,
-        RequestInterface $request = null,
-        EE_Session $session = null,
-        EEM_Ticket $ticket_model = null,
-        TicketDatetimeAvailabilityTracker $tracker = null
-    ) {
-        $loader = LoaderFactory::getLoader();
-        $this->core_config = $core_config instanceof EE_Core_Config
-            ? $core_config
-            : $loader->getShared('EE_Core_Config');
-        $this->request = $request instanceof RequestInterface
-            ? $request
-            : $loader->getShared('EventEspresso\core\services\request\Request');
-        $this->session = $session instanceof EE_Session
-            ? $session
-            : $loader->getShared('EE_Session');
-        $this->ticket_model = $ticket_model instanceof EEM_Ticket
-            ? $ticket_model
-            : $loader->getShared('EEM_Ticket');
-        $this->tracker = $tracker instanceof TicketDatetimeAvailabilityTracker
-            ? $tracker
-            : $loader->getShared('EventEspresso\modules\ticket_selector\TicketDatetimeAvailabilityTracker');
-    }
+	/**
+	 * ProcessTicketSelector constructor.
+	 * NOTE: PLZ use the Loader to instantiate this class if need be
+	 * so that all dependencies get injected correctly (which will happen automatically)
+	 * Null values for parameters are only for backwards compatibility but will be removed later on.
+	 *
+	 * @param EE_Core_Config                    $core_config
+	 * @param RequestInterface                           $request
+	 * @param EE_Session                        $session
+	 * @param EEM_Ticket                        $ticket_model
+	 * @param TicketDatetimeAvailabilityTracker $tracker
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function __construct(
+		EE_Core_Config $core_config = null,
+		RequestInterface $request = null,
+		EE_Session $session = null,
+		EEM_Ticket $ticket_model = null,
+		TicketDatetimeAvailabilityTracker $tracker = null
+	) {
+		$loader = LoaderFactory::getLoader();
+		$this->core_config = $core_config instanceof EE_Core_Config
+			? $core_config
+			: $loader->getShared('EE_Core_Config');
+		$this->request = $request instanceof RequestInterface
+			? $request
+			: $loader->getShared('EventEspresso\core\services\request\Request');
+		$this->session = $session instanceof EE_Session
+			? $session
+			: $loader->getShared('EE_Session');
+		$this->ticket_model = $ticket_model instanceof EEM_Ticket
+			? $ticket_model
+			: $loader->getShared('EEM_Ticket');
+		$this->tracker = $tracker instanceof TicketDatetimeAvailabilityTracker
+			? $tracker
+			: $loader->getShared('EventEspresso\modules\ticket_selector\TicketDatetimeAvailabilityTracker');
+	}
 
 
-    /**
-     * cancelTicketSelections
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws ReflectionException
-     */
-    public function cancelTicketSelections()
-    {
-        // check nonce
-        if (! $this->processTicketSelectorNonce('cancel_ticket_selections')) {
-            return false;
-        }
-        $this->session->clear_session(__CLASS__, __FUNCTION__);
-        if ($this->request->requestParamIsSet('event_id')) {
-            EEH_URL::safeRedirectAndExit(
-                EEH_Event_View::event_link_url(
-                    $this->request->getRequestParam('event_id', 0, 'int')
-                )
-            );
-        }
-        EEH_URL::safeRedirectAndExit(
-            site_url('/' . $this->core_config->event_cpt_slug . '/')
-        );
-        return true;
-    }
+	/**
+	 * cancelTicketSelections
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws ReflectionException
+	 */
+	public function cancelTicketSelections()
+	{
+		// check nonce
+		if (! $this->processTicketSelectorNonce('cancel_ticket_selections')) {
+			return false;
+		}
+		$this->session->clear_session(__CLASS__, __FUNCTION__);
+		if ($this->request->requestParamIsSet('event_id')) {
+			EEH_URL::safeRedirectAndExit(
+				EEH_Event_View::event_link_url(
+					$this->request->getRequestParam('event_id', 0, 'int')
+				)
+			);
+		}
+		EEH_URL::safeRedirectAndExit(
+			site_url('/' . $this->core_config->event_cpt_slug . '/')
+		);
+		return true;
+	}
 
 
-    /**
-     * processTicketSelectorNonce
-     *
-     * @param  string $nonce_name
-     * @param string  $id
-     * @return bool
-     */
-    private function processTicketSelectorNonce($nonce_name, $id = '')
-    {
-        $nonce_name_with_id = ! empty($id) ? "{$nonce_name}_nonce_{$id}" : "{$nonce_name}_nonce";
-        if (
-            ! $this->request->isAdmin()
-            && (
-                ! $this->request->requestParamIsSet($nonce_name_with_id)
-                || ! wp_verify_nonce(
-                    $this->request->getRequestParam($nonce_name_with_id),
-                    $nonce_name
-                )
-            )
-        ) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'We\'re sorry but your request failed to pass a security check.%sPlease click the back button on your browser and try again.',
-                        'event_espresso'
-                    ),
-                    '<br/>'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        return true;
-    }
+	/**
+	 * processTicketSelectorNonce
+	 *
+	 * @param  string $nonce_name
+	 * @param string  $id
+	 * @return bool
+	 */
+	private function processTicketSelectorNonce($nonce_name, $id = '')
+	{
+		$nonce_name_with_id = ! empty($id) ? "{$nonce_name}_nonce_{$id}" : "{$nonce_name}_nonce";
+		if (
+			! $this->request->isAdmin()
+			&& (
+				! $this->request->requestParamIsSet($nonce_name_with_id)
+				|| ! wp_verify_nonce(
+					$this->request->getRequestParam($nonce_name_with_id),
+					$nonce_name
+				)
+			)
+		) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'We\'re sorry but your request failed to pass a security check.%sPlease click the back button on your browser and try again.',
+						'event_espresso'
+					),
+					'<br/>'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		return true;
+	}
 
 
-    /**
-     * process_ticket_selections
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function processTicketSelections()
-    {
-        do_action('EED_Ticket_Selector__process_ticket_selections__before');
-        if ($this->request->isBot()) {
-            EEH_URL::safeRedirectAndExit(
-                apply_filters(
-                    'FHEE__EE_Ticket_Selector__process_ticket_selections__bot_redirect_url',
-                    site_url()
-                )
-            );
-        }
-        // we should really only have 1 registration in the works now
-        // (ie, no MER) so unless otherwise requested, clear the session
-        if (apply_filters('FHEE__EE_Ticket_Selector__process_ticket_selections__clear_session', true)) {
-            $this->session->clear_session(__CLASS__, __FUNCTION__);
-        }
-        // validate/sanitize/filter data
-        try {
-            $post_data_validator = new ProcessTicketSelectorPostData($this->request);
-            $valid               = apply_filters(
-                'FHEE__EED_Ticket_Selector__process_ticket_selections__valid_post_data',
-                $post_data_validator->validatePostData()
-            );
-        } catch (Exception $exception) {
-            EE_Error::add_error($exception->getMessage(), __FILE__, __FUNCTION__, __LINE__);
-        }
-        // check total tickets ordered vs max number of attendees that can register
-        if (! empty($valid) && $valid['total_tickets'] > $valid['max_atndz']) {
-            $this->maxAttendeesViolation($valid);
-        } else {
-            // all data appears to be valid
-            if ($this->processSuccessfulCart($this->addTicketsToCart($valid))) {
-                return true;
-            }
-        }
-        // die(); // <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< KILL BEFORE REDIRECT
-        // at this point, just return if registration is being made from admin
-        if ($this->request->isAdmin() || $this->request->isFrontAjax()) {
-            return false;
-        }
-        if ($valid['return_url']) {
-            EEH_URL::safeRedirectAndExit($valid['return_url']);
-        }
-        // do we have an event id?
-        $id = $post_data_validator->getEventId();
-        if ($id) {
-            EEH_URL::safeRedirectAndExit(get_permalink($id));
-        }
-        echo EE_Error::get_notices(); // already escaped
-        return false;
-    }
+	/**
+	 * process_ticket_selections
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function processTicketSelections()
+	{
+		do_action('EED_Ticket_Selector__process_ticket_selections__before');
+		if ($this->request->isBot()) {
+			EEH_URL::safeRedirectAndExit(
+				apply_filters(
+					'FHEE__EE_Ticket_Selector__process_ticket_selections__bot_redirect_url',
+					site_url()
+				)
+			);
+		}
+		// we should really only have 1 registration in the works now
+		// (ie, no MER) so unless otherwise requested, clear the session
+		if (apply_filters('FHEE__EE_Ticket_Selector__process_ticket_selections__clear_session', true)) {
+			$this->session->clear_session(__CLASS__, __FUNCTION__);
+		}
+		// validate/sanitize/filter data
+		try {
+			$post_data_validator = new ProcessTicketSelectorPostData($this->request);
+			$valid               = apply_filters(
+				'FHEE__EED_Ticket_Selector__process_ticket_selections__valid_post_data',
+				$post_data_validator->validatePostData()
+			);
+		} catch (Exception $exception) {
+			EE_Error::add_error($exception->getMessage(), __FILE__, __FUNCTION__, __LINE__);
+		}
+		// check total tickets ordered vs max number of attendees that can register
+		if (! empty($valid) && $valid['total_tickets'] > $valid['max_atndz']) {
+			$this->maxAttendeesViolation($valid);
+		} else {
+			// all data appears to be valid
+			if ($this->processSuccessfulCart($this->addTicketsToCart($valid))) {
+				return true;
+			}
+		}
+		// die(); // <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< KILL BEFORE REDIRECT
+		// at this point, just return if registration is being made from admin
+		if ($this->request->isAdmin() || $this->request->isFrontAjax()) {
+			return false;
+		}
+		if ($valid['return_url']) {
+			EEH_URL::safeRedirectAndExit($valid['return_url']);
+		}
+		// do we have an event id?
+		$id = $post_data_validator->getEventId();
+		if ($id) {
+			EEH_URL::safeRedirectAndExit(get_permalink($id));
+		}
+		echo EE_Error::get_notices(); // already escaped
+		return false;
+	}
 
 
-    /**
-     * @param array $valid
-     */
-    private function maxAttendeesViolation(array $valid)
-    {
-        // ordering too many tickets !!!
-        $total_tickets_string = esc_html(
-            _n(
-                'You have attempted to purchase %s ticket.',
-                'You have attempted to purchase %s tickets.',
-                $valid['total_tickets'],
-                'event_espresso'
-            )
-        );
-        $limit_error_1 = sprintf($total_tickets_string, $valid['total_tickets']);
-        // dev only message
-        $max_attendees_string = esc_html(
-            _n(
-                'The registration limit for this event is %s ticket per registration, therefore the total number of tickets you may purchase at a time can not exceed %s.',
-                'The registration limit for this event is %s tickets per registration, therefore the total number of tickets you may purchase at a time can not exceed %s.',
-                $valid['max_atndz'],
-                'event_espresso'
-            )
-        );
-        $limit_error_2 = sprintf($max_attendees_string, $valid['max_atndz'], $valid['max_atndz']);
-        EE_Error::add_error($limit_error_1 . '<br/>' . $limit_error_2, __FILE__, __FUNCTION__, __LINE__);
-    }
+	/**
+	 * @param array $valid
+	 */
+	private function maxAttendeesViolation(array $valid)
+	{
+		// ordering too many tickets !!!
+		$total_tickets_string = esc_html(
+			_n(
+				'You have attempted to purchase %s ticket.',
+				'You have attempted to purchase %s tickets.',
+				$valid['total_tickets'],
+				'event_espresso'
+			)
+		);
+		$limit_error_1 = sprintf($total_tickets_string, $valid['total_tickets']);
+		// dev only message
+		$max_attendees_string = esc_html(
+			_n(
+				'The registration limit for this event is %s ticket per registration, therefore the total number of tickets you may purchase at a time can not exceed %s.',
+				'The registration limit for this event is %s tickets per registration, therefore the total number of tickets you may purchase at a time can not exceed %s.',
+				$valid['max_atndz'],
+				'event_espresso'
+			)
+		);
+		$limit_error_2 = sprintf($max_attendees_string, $valid['max_atndz'], $valid['max_atndz']);
+		EE_Error::add_error($limit_error_1 . '<br/>' . $limit_error_2, __FILE__, __FUNCTION__, __LINE__);
+	}
 
 
-    /**
-     * @param array $valid
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function addTicketsToCart(array $valid)
-    {
-        $tickets_added = 0;
-        $tickets_selected = false;
-        if (! empty($valid) && $valid['total_tickets'] > 0) {
-            // load cart using factory because we don't want to do so until actually needed
-            $this->cart = CartFactory::getCart();
-            // if the user is an admin that can edit registrations,
-            // then we'll also allow them to add any tickets, even if they are expired
-            $current_user_is_admin = current_user_can('ee_edit_registrations');
-            // cycle thru the number of data rows sent from the event listing
-            for ($x = 0; $x < $valid['rows']; $x++) {
-                // does this row actually contain a ticket quantity?
-                if (isset($valid['qty'][ $x ]) && $valid['qty'][ $x ] > 0) {
-                    // YES we have a ticket quantity
-                    $tickets_selected = true;
-                    $valid_ticket = false;
-                    if (isset($valid['ticket_id'][ $x ])) {
-                        // get ticket via the ticket id we put in the form
-                        $ticket = $this->ticket_model->get_one_by_ID($valid['ticket_id'][ $x ]);
-                        if ($ticket instanceof EE_Ticket && ($ticket->is_on_sale() || $current_user_is_admin)) {
-                            $valid_ticket = true;
-                            $tickets_added += $this->addTicketToCart(
-                                $ticket,
-                                $valid['qty'][ $x ]
-                            );
-                        }
-                    }
-                    if ($valid_ticket !== true) {
-                        // nothing added to cart retrieved
-                        EE_Error::add_error(
-                            sprintf(
-                                esc_html__(
-                                    'A valid ticket could not be retrieved for the event.%sPlease click the back button on your browser and try again.',
-                                    'event_espresso'
-                                ),
-                                '<br/>'
-                            ),
-                            __FILE__,
-                            __FUNCTION__,
-                            __LINE__
-                        );
-                    }
-                    if (EE_Error::has_error()) {
-                        break;
-                    }
-                }
-            }
-        }
-        do_action(
-            'AHEE__EE_Ticket_Selector__process_ticket_selections__after_tickets_added_to_cart',
-            $this->cart,
-            $this
-        );
-        if (! apply_filters('FHEE__EED_Ticket_Selector__process_ticket_selections__tckts_slctd', $tickets_selected)) {
-            // no ticket quantities were selected
-            EE_Error::add_error(
-                esc_html__('You need to select a ticket quantity before you can proceed.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        return $tickets_added;
-    }
+	/**
+	 * @param array $valid
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function addTicketsToCart(array $valid)
+	{
+		$tickets_added = 0;
+		$tickets_selected = false;
+		if (! empty($valid) && $valid['total_tickets'] > 0) {
+			// load cart using factory because we don't want to do so until actually needed
+			$this->cart = CartFactory::getCart();
+			// if the user is an admin that can edit registrations,
+			// then we'll also allow them to add any tickets, even if they are expired
+			$current_user_is_admin = current_user_can('ee_edit_registrations');
+			// cycle thru the number of data rows sent from the event listing
+			for ($x = 0; $x < $valid['rows']; $x++) {
+				// does this row actually contain a ticket quantity?
+				if (isset($valid['qty'][ $x ]) && $valid['qty'][ $x ] > 0) {
+					// YES we have a ticket quantity
+					$tickets_selected = true;
+					$valid_ticket = false;
+					if (isset($valid['ticket_id'][ $x ])) {
+						// get ticket via the ticket id we put in the form
+						$ticket = $this->ticket_model->get_one_by_ID($valid['ticket_id'][ $x ]);
+						if ($ticket instanceof EE_Ticket && ($ticket->is_on_sale() || $current_user_is_admin)) {
+							$valid_ticket = true;
+							$tickets_added += $this->addTicketToCart(
+								$ticket,
+								$valid['qty'][ $x ]
+							);
+						}
+					}
+					if ($valid_ticket !== true) {
+						// nothing added to cart retrieved
+						EE_Error::add_error(
+							sprintf(
+								esc_html__(
+									'A valid ticket could not be retrieved for the event.%sPlease click the back button on your browser and try again.',
+									'event_espresso'
+								),
+								'<br/>'
+							),
+							__FILE__,
+							__FUNCTION__,
+							__LINE__
+						);
+					}
+					if (EE_Error::has_error()) {
+						break;
+					}
+				}
+			}
+		}
+		do_action(
+			'AHEE__EE_Ticket_Selector__process_ticket_selections__after_tickets_added_to_cart',
+			$this->cart,
+			$this
+		);
+		if (! apply_filters('FHEE__EED_Ticket_Selector__process_ticket_selections__tckts_slctd', $tickets_selected)) {
+			// no ticket quantities were selected
+			EE_Error::add_error(
+				esc_html__('You need to select a ticket quantity before you can proceed.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		return $tickets_added;
+	}
 
 
-    /**
-     * adds a ticket to the cart
-     *
-     * @param EE_Ticket $ticket
-     * @param int       $qty
-     * @return bool TRUE on success, FALSE on fail
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    private function addTicketToCart(EE_Ticket $ticket, $qty = 1)
-    {
-        // get the number of spaces left for this datetime ticket
-        $available_spaces = $this->tracker->ticketDatetimeAvailability($ticket);
-        // compare available spaces against the number of tickets being purchased
-        if ($available_spaces >= $qty) {
-            // allow addons to prevent a ticket from being added to cart
-            if (
-                ! apply_filters(
-                    'FHEE__EE_Ticket_Selector___add_ticket_to_cart__allow_add_to_cart',
-                    true,
-                    $ticket,
-                    $qty,
-                    $available_spaces
-                )
-            ) {
-                return false;
-            }
-            $qty = absint(apply_filters('FHEE__EE_Ticket_Selector___add_ticket_to_cart__ticket_qty', $qty, $ticket));
-            // add event to cart
-            if ($this->cart->add_ticket_to_cart($ticket, $qty)) {
-                $this->tracker->recalculateTicketDatetimeAvailability($ticket, $qty);
-                return true;
-            }
-            return false;
-        }
-        $this->tracker->processAvailabilityError($ticket, $qty, $this->cart->all_ticket_quantity_count());
-        return false;
-    }
+	/**
+	 * adds a ticket to the cart
+	 *
+	 * @param EE_Ticket $ticket
+	 * @param int       $qty
+	 * @return bool TRUE on success, FALSE on fail
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	private function addTicketToCart(EE_Ticket $ticket, $qty = 1)
+	{
+		// get the number of spaces left for this datetime ticket
+		$available_spaces = $this->tracker->ticketDatetimeAvailability($ticket);
+		// compare available spaces against the number of tickets being purchased
+		if ($available_spaces >= $qty) {
+			// allow addons to prevent a ticket from being added to cart
+			if (
+				! apply_filters(
+					'FHEE__EE_Ticket_Selector___add_ticket_to_cart__allow_add_to_cart',
+					true,
+					$ticket,
+					$qty,
+					$available_spaces
+				)
+			) {
+				return false;
+			}
+			$qty = absint(apply_filters('FHEE__EE_Ticket_Selector___add_ticket_to_cart__ticket_qty', $qty, $ticket));
+			// add event to cart
+			if ($this->cart->add_ticket_to_cart($ticket, $qty)) {
+				$this->tracker->recalculateTicketDatetimeAvailability($ticket, $qty);
+				return true;
+			}
+			return false;
+		}
+		$this->tracker->processAvailabilityError($ticket, $qty, $this->cart->all_ticket_quantity_count());
+		return false;
+	}
 
 
-    /**
-     * @param $tickets_added
-     * @return bool
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     */
-    private function processSuccessfulCart($tickets_added)
-    {
-        // exit('KILL REDIRECT BEFORE CART UPDATE'); // <<<<<<<<<<<<<<<<< KILL REDIRECT HERE BEFORE CART UPDATE
-        if (apply_filters('FHEE__EED_Ticket_Selector__process_ticket_selections__success', $tickets_added)) {
-            // make sure cart is loaded
-            if (! $this->cart instanceof EE_Cart) {
-                $this->cart = CartFactory::getCart();
-            }
-            do_action(
-                'FHEE__EE_Ticket_Selector__process_ticket_selections__before_redirecting_to_checkout',
-                $this->cart,
-                $this
-            );
-            $this->cart->recalculate_all_cart_totals();
-            $this->cart->save_cart(false);
-            // exit('KILL REDIRECT AFTER CART UPDATE'); // <<<<<<<<  OR HERE TO KILL REDIRECT AFTER CART UPDATE
-            // just return TRUE for registrations being made from admin
-            if ($this->request->isAdmin() || $this->request->isFrontAjax()) {
-                return true;
-            }
-            EEH_URL::safeRedirectAndExit(
-                apply_filters(
-                    'FHEE__EE_Ticket_Selector__process_ticket_selections__success_redirect_url',
-                    $this->core_config->reg_page_url()
-                )
-            );
-        }
-        if (! EE_Error::has_error() && ! EE_Error::has_error(true, 'attention')) {
-            // nothing added to cart
-            EE_Error::add_attention(
-                esc_html__('No tickets were added for the event', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        return false;
-    }
+	/**
+	 * @param $tickets_added
+	 * @return bool
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 */
+	private function processSuccessfulCart($tickets_added)
+	{
+		// exit('KILL REDIRECT BEFORE CART UPDATE'); // <<<<<<<<<<<<<<<<< KILL REDIRECT HERE BEFORE CART UPDATE
+		if (apply_filters('FHEE__EED_Ticket_Selector__process_ticket_selections__success', $tickets_added)) {
+			// make sure cart is loaded
+			if (! $this->cart instanceof EE_Cart) {
+				$this->cart = CartFactory::getCart();
+			}
+			do_action(
+				'FHEE__EE_Ticket_Selector__process_ticket_selections__before_redirecting_to_checkout',
+				$this->cart,
+				$this
+			);
+			$this->cart->recalculate_all_cart_totals();
+			$this->cart->save_cart(false);
+			// exit('KILL REDIRECT AFTER CART UPDATE'); // <<<<<<<<  OR HERE TO KILL REDIRECT AFTER CART UPDATE
+			// just return TRUE for registrations being made from admin
+			if ($this->request->isAdmin() || $this->request->isFrontAjax()) {
+				return true;
+			}
+			EEH_URL::safeRedirectAndExit(
+				apply_filters(
+					'FHEE__EE_Ticket_Selector__process_ticket_selections__success_redirect_url',
+					$this->core_config->reg_page_url()
+				)
+			);
+		}
+		if (! EE_Error::has_error() && ! EE_Error::has_error(true, 'attention')) {
+			// nothing added to cart
+			EE_Error::add_attention(
+				esc_html__('No tickets were added for the event', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		return false;
+	}
 }

Spacing +12 added lines, -12 removed lines

@@ -119,7 +119,7 @@ 
     public function cancelTicketSelections()
     {
         // check nonce
-        if (! $this->processTicketSelectorNonce('cancel_ticket_selections')) {
+        if ( ! $this->processTicketSelectorNonce('cancel_ticket_selections')) {
             return false;
         }
         $this->session->clear_session(__CLASS__, __FUNCTION__);
@@ -131,7 +131,7 @@ 
             );
         }
         EEH_URL::safeRedirectAndExit(
-            site_url('/' . $this->core_config->event_cpt_slug . '/')
+            site_url('/'.$this->core_config->event_cpt_slug.'/')
         );
         return true;
     }
@@ -212,7 +212,7 @@ 
             EE_Error::add_error($exception->getMessage(), __FILE__, __FUNCTION__, __LINE__);
         }
         // check total tickets ordered vs max number of attendees that can register
-        if (! empty($valid) && $valid['total_tickets'] > $valid['max_atndz']) {
+        if ( ! empty($valid) && $valid['total_tickets'] > $valid['max_atndz']) {
             $this->maxAttendeesViolation($valid);
         } else {
             // all data appears to be valid
@@ -263,7 +263,7 @@ 
             )
         );
         $limit_error_2 = sprintf($max_attendees_string, $valid['max_atndz'], $valid['max_atndz']);
-        EE_Error::add_error($limit_error_1 . '<br/>' . $limit_error_2, __FILE__, __FUNCTION__, __LINE__);
+        EE_Error::add_error($limit_error_1.'<br/>'.$limit_error_2, __FILE__, __FUNCTION__, __LINE__);
     }
 
 
@@ -279,7 +279,7 @@ 
     {
         $tickets_added = 0;
         $tickets_selected = false;
-        if (! empty($valid) && $valid['total_tickets'] > 0) {
+        if ( ! empty($valid) && $valid['total_tickets'] > 0) {
             // load cart using factory because we don't want to do so until actually needed
             $this->cart = CartFactory::getCart();
             // if the user is an admin that can edit registrations,
@@ -288,18 +288,18 @@ 
             // cycle thru the number of data rows sent from the event listing
             for ($x = 0; $x < $valid['rows']; $x++) {
                 // does this row actually contain a ticket quantity?
-                if (isset($valid['qty'][ $x ]) && $valid['qty'][ $x ] > 0) {
+                if (isset($valid['qty'][$x]) && $valid['qty'][$x] > 0) {
                     // YES we have a ticket quantity
                     $tickets_selected = true;
                     $valid_ticket = false;
-                    if (isset($valid['ticket_id'][ $x ])) {
+                    if (isset($valid['ticket_id'][$x])) {
                         // get ticket via the ticket id we put in the form
-                        $ticket = $this->ticket_model->get_one_by_ID($valid['ticket_id'][ $x ]);
+                        $ticket = $this->ticket_model->get_one_by_ID($valid['ticket_id'][$x]);
                         if ($ticket instanceof EE_Ticket && ($ticket->is_on_sale() || $current_user_is_admin)) {
                             $valid_ticket = true;
                             $tickets_added += $this->addTicketToCart(
                                 $ticket,
-                                $valid['qty'][ $x ]
+                                $valid['qty'][$x]
                             );
                         }
                     }
@@ -329,7 +329,7 @@ 
             $this->cart,
             $this
         );
-        if (! apply_filters('FHEE__EED_Ticket_Selector__process_ticket_selections__tckts_slctd', $tickets_selected)) {
+        if ( ! apply_filters('FHEE__EED_Ticket_Selector__process_ticket_selections__tckts_slctd', $tickets_selected)) {
             // no ticket quantities were selected
             EE_Error::add_error(
                 esc_html__('You need to select a ticket quantity before you can proceed.', 'event_espresso'),
@@ -397,7 +397,7 @@ 
         // exit('KILL REDIRECT BEFORE CART UPDATE'); // <<<<<<<<<<<<<<<<< KILL REDIRECT HERE BEFORE CART UPDATE
         if (apply_filters('FHEE__EED_Ticket_Selector__process_ticket_selections__success', $tickets_added)) {
             // make sure cart is loaded
-            if (! $this->cart instanceof EE_Cart) {
+            if ( ! $this->cart instanceof EE_Cart) {
                 $this->cart = CartFactory::getCart();
             }
             do_action(
@@ -419,7 +419,7 @@ 
                 )
             );
         }
-        if (! EE_Error::has_error() && ! EE_Error::has_error(true, 'attention')) {
+        if ( ! EE_Error::has_error() && ! EE_Error::has_error(true, 'attention')) {
             // nothing added to cart
             EE_Error::add_attention(
                 esc_html__('No tickets were added for the event', 'event_espresso'),

espresso.php

Indentation +80 added lines, -80 removed lines

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

modules/events_archive/EED_Events_Archive.module.php

Indentation +1102 added lines, -1102 removed lines

@@ -16,1097 +16,1097 @@ 
 class EED_Events_Archive extends EED_Module
 {
 
-    const EVENT_DETAILS_PRIORITY = 100;
-
-    const EVENT_DATETIMES_PRIORITY = 110;
-
-    const EVENT_TICKETS_PRIORITY = 120;
-
-    const EVENT_VENUES_PRIORITY = 130;
-
-
-    public static $espresso_event_list_ID = 0;
-
-    public static $espresso_grid_event_lists = array();
-
-    /**
-     * @type bool $using_get_the_excerpt
-     */
-    protected static $using_get_the_excerpt = false;
-
-    /**
-     * Used to flag when the event list is being called from an external iframe.
-     *
-     * @var bool $iframe
-     */
-    protected static $iframe = false;
-
-    /**
-     * @var EventListIframeEmbedButton $_iframe_embed_button
-     */
-    private static $_iframe_embed_button;
-
-    /**
-     * @type EE_Template_Part_Manager $template_parts
-     */
-    protected $template_parts;
-
-
-    /**
-     * @return EED_Events_Archive
-     */
-    public static function instance()
-    {
-        return parent::get_instance(__CLASS__);
-    }
-
-
-    /**
-     * set_hooks - for hooking into EE Core, other modules, etc
-     *
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function set_hooks()
-    {
-        /** @var EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions $custom_post_type_definitions */
-        $custom_post_type_definitions = LoaderFactory::getLoader()->getShared(
-            'EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions'
-        );
-        $custom_post_types = $custom_post_type_definitions->getDefinitions();
-        EE_Config::register_route(
-            $custom_post_types['espresso_events']['plural_slug'],
-            'Events_Archive',
-            'run'
-        );
-        EE_Config::register_route(
-            'event_list',
-            'Events_Archive',
-            'event_list'
-        );
-        EE_Config::register_route(
-            'iframe',
-            'Events_Archive',
-            'event_list_iframe',
-            'event_list'
-        );
-        add_action('wp_loaded', array('EED_Events_Archive', 'set_definitions'), 2);
-    }
-
-
-    /**
-     *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function set_hooks_admin()
-    {
-        add_action('wp_loaded', array('EED_Events_Archive', 'set_definitions'), 2);
-        // hook into the end of the \EE_Admin_Page::_load_page_dependencies()
-        // to load assets for "espresso_events" page on the "default" route (action)
-        add_action(
-            'FHEE__EE_Admin_Page___load_page_dependencies__after_load__espresso_events__default',
-            array('EED_Events_Archive', 'event_list_iframe_embed_button'),
-            10
-        );
-    }
-
-
-    /**
-     *    set_definitions
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function set_definitions()
-    {
-        define('EVENTS_ARCHIVE_ASSETS_URL', plugin_dir_url(__FILE__) . 'assets/');
-        define('EVENTS_ARCHIVE_TEMPLATES_PATH', str_replace('\\', '/', plugin_dir_path(__FILE__)) . 'templates/');
-    }
-
-
-    /**
-     * set up EE_Events_Archive_Config
-     */
-    protected function set_config()
-    {
-        $this->set_config_section('template_settings');
-        $this->set_config_class('EE_Events_Archive_Config');
-        $this->set_config_name('EED_Events_Archive');
-    }
-
-
-    /**
-     * @return EventListIframeEmbedButton
-     */
-    public static function get_iframe_embed_button()
-    {
-        if (! self::$_iframe_embed_button instanceof EventListIframeEmbedButton) {
-            self::$_iframe_embed_button = new EventListIframeEmbedButton();
-        }
-        return self::$_iframe_embed_button;
-    }
-
-
-    /**
-     * event_list_iframe_embed_button
-     *
-     * @return    void
-     * @throws EE_Error
-     */
-    public static function event_list_iframe_embed_button()
-    {
-        $iframe_embed_button = EED_Events_Archive::get_iframe_embed_button();
-        $iframe_embed_button->addEmbedButton();
-    }
-
-
-    /**
-     *    initialize_template_parts
-     *
-     * @access    public
-     * @param EE_Events_Archive_Config $config
-     * @return EE_Template_Part_Manager
-     */
-    public function initialize_template_parts(EE_Events_Archive_Config $config = null)
-    {
-        $config = $config instanceof EE_Events_Archive_Config ? $config : $this->config();
-        EEH_Autoloader::instance()->register_template_part_autoloaders();
-        $template_parts = new EE_Template_Part_Manager();
-        $template_parts->add_template_part(
-            'tickets',
-            esc_html__('Ticket Selector', 'event_espresso'),
-            'content-espresso_events-tickets.php',
-            $config->display_order_tickets
-        );
-        $template_parts->add_template_part(
-            'datetimes',
-            esc_html__('Dates and Times', 'event_espresso'),
-            'content-espresso_events-datetimes.php',
-            $config->display_order_datetimes
-        );
-        $template_parts->add_template_part(
-            'event',
-            esc_html__('Event Description', 'event_espresso'),
-            'content-espresso_events-details.php',
-            $config->display_order_event
-        );
-        $template_parts->add_template_part(
-            'venue',
-            esc_html__('Venue Information', 'event_espresso'),
-            'content-espresso_events-venues.php',
-            $config->display_order_venue
-        );
-        do_action('AHEE__EED_Event_Archive__initialize_template_parts', $template_parts);
-        return $template_parts;
-    }
-
-
-    /**
-     *    run - initial module setup - this gets called by the EE_Front_Controller if the module route is found in the
-     *    incoming request
-     *
-     * @access    public
-     * @param WP $WP
-     * @return    void
-     */
-    public function run($WP)
-    {
-        do_action('AHEE__EED_Events_Archive__before_run');
-        // ensure valid EE_Events_Archive_Config() object exists
-        $this->set_config();
-        /** @type EE_Events_Archive_Config $config */
-        $config = $this->config();
-        // load other required components
-        $this->load_event_list_assets();
-        // filter the WP posts_join, posts_where, and posts_orderby SQL clauses
-        // add query filters
-        EEH_Event_Query::add_query_filters();
-        // set params that will get used by the filters
-        EEH_Event_Query::set_query_params(
-            '',    // month
-            '',    // category
-            $config->display_expired_events,    // show_expired
-            'start_date',    // orderby
-            'ASC'    // sort
-        );
-        // check what template is loaded
-        add_filter('template_include', array($this, 'template_include'), 999, 1);
-    }
-
-
-    /**
-     * most likely called by the ESPRESSO_EVENTS shortcode which uses this module to do some of it's lifting
-     *
-     * @return    void
-     */
-    public function event_list()
-    {
-        // ensure valid EE_Events_Archive_Config() object exists
-        $this->set_config();
-        // load other required components
-        $this->load_event_list_assets();
-    }
-
-
-    /**
-     * @access    public
-     * @return    void
-     * @throws EE_Error
-     * @throws DomainException
-     */
-    public function event_list_iframe()
-    {
-        EED_Events_Archive::$iframe = true;
-        $event_list_iframe          = new EventsArchiveIframe($this);
-        $event_list_iframe->display();
-    }
-
-
-    /**
-     * @access public
-     * @return string
-     */
-    public static function is_iframe()
-    {
-        return EED_Events_Archive::$iframe;
-    }
-
-
-    /**
-     * @access public
-     * @return string
-     */
-    public static function link_target()
-    {
-        return EED_Events_Archive::$iframe ? ' target="_blank"' : '';
-    }
-
-
-    /**
-     *    template_include
-     *
-     * @access    public
-     * @param string $template
-     * @return    string
-     */
-    public function template_include($template = '')
-    {
-        // don't add content filter for dedicated EE child themes or private posts
-        if (! EEH_Template::is_espresso_theme()) {
-            /** @type EE_Events_Archive_Config $config */
-            $config = $this->config();
-            // add status banner ?
-            if ($config->display_status_banner) {
-                add_filter('the_title', array('EED_Events_Archive', 'the_title'), 100, 2);
-            }
-            // if NOT a custom template
-            if (
-                apply_filters('FHEE__EED_Event_Archive__template_include__allow_custom_selected_template', false)
-                || EE_Registry::instance()
-                              ->load_core('Front_Controller')
-                              ->get_selected_template() !== 'archive-espresso_events.php'
-            ) {
-                // don't display entry meta because the existing theme will take care of that
-                add_filter('FHEE__EED_Events_Archive__template_include__events_list_active', '__return_true');
-                // load functions.php file for the theme (loaded by WP if using child theme)
-                EEH_Template::load_espresso_theme_functions();
-                // because we don't know if the theme is using the_excerpt()
-                add_filter(
-                    'the_excerpt',
-                    array('EED_Events_Archive', 'event_details'),
-                    EED_Events_Archive::EVENT_DETAILS_PRIORITY
-                );
-                // or the_content
-                add_filter(
-                    'the_content',
-                    array('EED_Events_Archive', 'event_details'),
-                    EED_Events_Archive::EVENT_DETAILS_PRIORITY
-                );
-                // and just in case they are running get_the_excerpt() which DESTROYS things
-                add_filter('get_the_excerpt', array('EED_Events_Archive', 'get_the_excerpt'), 1, 1);
-                // don't display entry meta because the existing theme will take care of that
-                add_filter('FHEE__content_espresso_events_details_template__display_entry_meta', '__return_false');
-            }
-        }
-        return $template;
-    }
-
-
-    /**
-     *    get_the_excerpt - kinda hacky, but if a theme is using get_the_excerpt(), then we need to remove our filters
-     *    on the_content()
-     *
-     * @access    public
-     * @param        string $excerpt
-     * @return        string
-     */
-    public static function get_the_excerpt($excerpt = '')
-    {
-        if (post_password_required()) {
-            return $excerpt;
-        }
-        if (apply_filters('FHEE__EED_Events_Archive__get_the_excerpt__theme_uses_get_the_excerpt', false)) {
-            remove_filter(
-                'the_excerpt',
-                array('EED_Events_Archive', 'event_details'),
-                EED_Events_Archive::EVENT_DETAILS_PRIORITY
-            );
-            remove_filter(
-                'the_content',
-                array('EED_Events_Archive', 'event_details'),
-                EED_Events_Archive::EVENT_DETAILS_PRIORITY
-            );
-            $excerpt = EED_Events_Archive::event_details($excerpt);
-        } else {
-            EED_Events_Archive::$using_get_the_excerpt = true;
-            add_filter('wp_trim_excerpt', array('EED_Events_Archive', 'end_get_the_excerpt'), 999, 1);
-        }
-        return $excerpt;
-    }
-
-
-    /**
-     * end_get_the_excerpt
-     *
-     * @access public
-     * @param  string $text
-     * @return string
-     */
-    public static function end_get_the_excerpt($text = '')
-    {
-        EED_Events_Archive::$using_get_the_excerpt = false;
-        return $text;
-    }
-
-
-    /**
-     *    the_title
-     *
-     * @access        public
-     * @param        string $title
-     * @param        string $id
-     * @return        string
-     */
-    public static function the_title($title = '', $id = '')
-    {
-        global $post;
-        if ($post instanceof WP_Post) {
-            return in_the_loop() && $post->ID == $id ? espresso_event_status_banner($post->ID) . $title : $title;
-        }
-        return $title;
-    }
-
-
-    /**
-     *    event_details
-     *
-     * @access    public
-     * @param        string $content
-     * @return        string
-     */
-    public static function event_details($content)
-    {
-        global $post;
-        static $current_post_ID = 0;
-        if (
-            $current_post_ID !== $post->ID
-            && $post->post_type === 'espresso_events'
-            && ! EED_Events_Archive::$using_get_the_excerpt
-            && ! post_password_required()
-            && (
-                apply_filters('FHEE__EES_Espresso_Events__process_shortcode__true', false)
-                || ! apply_filters('FHEE__content_espresso_events__template_loaded', false)
-            )
-        ) {
-            // Set current post ID to prevent showing content twice, but only if headers have definitely been sent.
-            // Reason being is that some plugins, like Yoast, need to run through a copy of the loop early
-            // BEFORE headers are sent in order to examine the post content and generate content for the HTML header.
-            // We want to allow those plugins to still do their thing and have access to our content, but depending on
-            // how your event content is being displayed (shortcode, CPT route, etc), this filter can get applied twice,
-            // so the following allows this filter to be applied multiple times, but only once for real
-            $current_post_ID = did_action('loop_start') ? $post->ID : 0;
-            if (EE_Registry::instance()->CFG->template_settings->EED_Events_Archive->use_sortable_display_order) {
-                $content = EED_Events_Archive::use_sortable_display_order();
-            } else {
-                $content = EED_Events_Archive::use_filterable_display_order();
-            }
-        }
-        return $content;
-    }
-
-
-    /**
-     *    use_sortable_display_order
-     *
-     * @access    protected
-     * @return string
-     */
-    protected static function use_sortable_display_order()
-    {
-        // no further password checks required atm
-        add_filter('FHEE__EED_Events_Archive__event_details__no_post_password_required', '__return_true');
-        // we need to first remove this callback from being applied to the_content() or the_excerpt()
-        // (otherwise it will recurse and blow up the interweb)
-        remove_filter(
-            'the_excerpt',
-            array('EED_Events_Archive', 'event_details'),
-            EED_Events_Archive::EVENT_DETAILS_PRIORITY
-        );
-        remove_filter(
-            'the_content',
-            array('EED_Events_Archive', 'event_details'),
-            EED_Events_Archive::EVENT_DETAILS_PRIORITY
-        );
-        remove_filter('get_the_excerpt', array('EED_Events_Archive', 'get_the_excerpt'), 1);
-        // now add additional content depending on whether event is using the_excerpt() or the_content()
-        EED_Events_Archive::instance()->template_parts = EED_Events_Archive::instance()->initialize_template_parts();
-        $content = EEH_Template::locate_template('content-espresso_events-details.php');
-        $content = EED_Events_Archive::instance()->template_parts->apply_template_part_filters($content);
-        // re-add our main filters (or else the next event won't have them)
-        add_filter(
-            'the_excerpt',
-            array('EED_Events_Archive', 'event_details'),
-            EED_Events_Archive::EVENT_DETAILS_PRIORITY
-        );
-        add_filter(
-            'the_content',
-            array('EED_Events_Archive', 'event_details'),
-            EED_Events_Archive::EVENT_DETAILS_PRIORITY
-        );
-        add_filter('get_the_excerpt', array('EED_Events_Archive', 'get_the_excerpt'), 1, 1);
-        remove_filter(
-            'FHEE__EED_Events_Archive__event_details__no_post_password_required',
-            '__return_true'
-        );
-        return $content;
-    }
-
-
-    /**
-     *    use_filterable_display_order
-     *
-     * @access    protected
-     * @return    string
-     */
-    protected static function use_filterable_display_order()
-    {
-        // we need to first remove this callback from being applied to the_content()
-        // (otherwise it will recurse and blow up the interweb)
-        remove_filter(
-            'the_excerpt',
-            array('EED_Events_Archive', 'event_details'),
-            EED_Events_Archive::EVENT_DETAILS_PRIORITY
-        );
-        remove_filter(
-            'the_content',
-            array('EED_Events_Archive', 'event_details'),
-            EED_Events_Archive::EVENT_DETAILS_PRIORITY
-        );
-        remove_filter('get_the_excerpt', array('EED_Events_Archive', 'get_the_excerpt'), 1);
-        // now add additional content depending on whether event is using the_excerpt() or the_content()
-        EED_Events_Archive::_add_additional_excerpt_filters();
-        EED_Events_Archive::_add_additional_content_filters();
-        do_action('AHEE__EED_Events_Archive__use_filterable_display_order__after_add_filters');
-        // now load our template
-        $content = EEH_Template::locate_template('content-espresso_events-details.php');
-        // re-add our main filters (or else the next event won't have them)
-        add_filter(
-            'the_excerpt',
-            array('EED_Events_Archive', 'event_details'),
-            EED_Events_Archive::EVENT_DETAILS_PRIORITY
-        );
-        add_filter(
-            'the_content',
-            array('EED_Events_Archive', 'event_details'),
-            EED_Events_Archive::EVENT_DETAILS_PRIORITY
-        );
-        add_filter('get_the_excerpt', array('EED_Events_Archive', 'get_the_excerpt'), 1, 1);
-        // but remove the other filters so that they don't get applied to the next post
-        EED_Events_Archive::_remove_additional_events_archive_filters();
-        do_action('AHEE__EED_Events_Archive__use_filterable_display_order__after_remove_filters');
-        // we're not returning the $content directly because the template we are loading uses the_content (or the_excerpt)
-        // return ! empty( $template ) ? $template : $content;
-        return $content;
-    }
-
-
-    /**
-     *    event_datetimes - adds datetimes ABOVE content
-     *
-     * @access    public
-     * @param        string $content
-     * @return        string
-     */
-    public static function event_datetimes($content)
-    {
-        if (post_password_required()) {
-            return $content;
-        }
-        return EEH_Template::locate_template('content-espresso_events-datetimes.php') . $content;
-    }
-
-
-    /**
-     *    event_tickets - adds tickets ABOVE content (which includes datetimes)
-     *
-     * @access    public
-     * @param        string $content
-     * @return        string
-     */
-    public static function event_tickets($content)
-    {
-        if (post_password_required()) {
-            return $content;
-        }
-        return EEH_Template::locate_template('content-espresso_events-tickets.php') . $content;
-    }
-
-
-    /**
-     *    event_venues - adds venues BELOW content
-     *
-     * @access    public
-     * @param    string $content
-     * @return    string
-     */
-    public static function event_venue($content)
-    {
-        return EED_Events_Archive::event_venues($content);
-    }
-
-
-    /**
-     *    event_venues - adds venues BELOW content
-     *
-     * @access    public
-     * @param        string $content
-     * @return        string
-     */
-    public static function event_venues($content)
-    {
-        if (post_password_required()) {
-            return $content;
-        }
-        return $content . EEH_Template::locate_template('content-espresso_events-venues.php');
-    }
-
-
-    /**
-     *    _add_additional_content_filters
-     *
-     * @access    private
-     * @return        void
-     */
-    private static function _add_additional_excerpt_filters()
-    {
-        add_filter(
-            'the_excerpt',
-            array('EED_Events_Archive', 'event_datetimes'),
-            EED_Events_Archive::EVENT_DATETIMES_PRIORITY
-        );
-        add_filter(
-            'the_excerpt',
-            array('EED_Events_Archive', 'event_tickets'),
-            EED_Events_Archive::EVENT_TICKETS_PRIORITY
-        );
-        add_filter(
-            'the_excerpt',
-            array('EED_Events_Archive', 'event_venues'),
-            EED_Events_Archive::EVENT_VENUES_PRIORITY
-        );
-    }
-
-
-    /**
-     *    _add_additional_content_filters
-     *
-     * @access    private
-     * @return        void
-     */
-    private static function _add_additional_content_filters()
-    {
-        add_filter(
-            'the_content',
-            array('EED_Events_Archive', 'event_datetimes'),
-            EED_Events_Archive::EVENT_DATETIMES_PRIORITY
-        );
-        add_filter(
-            'the_content',
-            array('EED_Events_Archive', 'event_tickets'),
-            EED_Events_Archive::EVENT_TICKETS_PRIORITY
-        );
-        add_filter(
-            'the_content',
-            array('EED_Events_Archive', 'event_venues'),
-            EED_Events_Archive::EVENT_VENUES_PRIORITY
-        );
-    }
-
-
-    /**
-     *    _remove_additional_events_archive_filters
-     *
-     * @access    private
-     * @return        void
-     */
-    private static function _remove_additional_events_archive_filters()
-    {
-        remove_filter(
-            'the_excerpt',
-            array('EED_Events_Archive', 'event_datetimes'),
-            EED_Events_Archive::EVENT_DATETIMES_PRIORITY
-        );
-        remove_filter(
-            'the_excerpt',
-            array('EED_Events_Archive', 'event_tickets'),
-            EED_Events_Archive::EVENT_TICKETS_PRIORITY
-        );
-        remove_filter(
-            'the_excerpt',
-            array('EED_Events_Archive', 'event_venues'),
-            EED_Events_Archive::EVENT_VENUES_PRIORITY
-        );
-        remove_filter(
-            'the_content',
-            array('EED_Events_Archive', 'event_datetimes'),
-            EED_Events_Archive::EVENT_DATETIMES_PRIORITY
-        );
-        remove_filter(
-            'the_content',
-            array('EED_Events_Archive', 'event_tickets'),
-            EED_Events_Archive::EVENT_TICKETS_PRIORITY
-        );
-        remove_filter(
-            'the_content',
-            array('EED_Events_Archive', 'event_venues'),
-            EED_Events_Archive::EVENT_VENUES_PRIORITY
-        );
-    }
-
-
-    /**
-     *    remove_all_events_archive_filters
-     *
-     * @access    public
-     * @return        void
-     */
-    public static function remove_all_events_archive_filters()
-    {
-        // remove_filter( 'get_the_excerpt', array( 'EED_Events_Archive', 'get_the_excerpt' ), 1 );
-        remove_filter('the_title', array('EED_Events_Archive', 'the_title'), 1);
-        remove_filter(
-            'the_excerpt',
-            array('EED_Events_Archive', 'event_details'),
-            EED_Events_Archive::EVENT_DETAILS_PRIORITY
-        );
-        remove_filter(
-            'the_excerpt',
-            array('EED_Events_Archive', 'event_datetimes'),
-            EED_Events_Archive::EVENT_DATETIMES_PRIORITY
-        );
-        remove_filter(
-            'the_excerpt',
-            array('EED_Events_Archive', 'event_tickets'),
-            EED_Events_Archive::EVENT_TICKETS_PRIORITY
-        );
-        remove_filter(
-            'the_excerpt',
-            array('EED_Events_Archive', 'event_venues'),
-            EED_Events_Archive::EVENT_VENUES_PRIORITY
-        );
-        remove_filter(
-            'the_content',
-            array('EED_Events_Archive', 'event_details'),
-            EED_Events_Archive::EVENT_DETAILS_PRIORITY
-        );
-        remove_filter(
-            'the_content',
-            array('EED_Events_Archive', 'event_datetimes'),
-            EED_Events_Archive::EVENT_DATETIMES_PRIORITY
-        );
-        remove_filter(
-            'the_content',
-            array('EED_Events_Archive', 'event_tickets'),
-            EED_Events_Archive::EVENT_TICKETS_PRIORITY
-        );
-        remove_filter(
-            'the_content',
-            array('EED_Events_Archive', 'event_venues'),
-            EED_Events_Archive::EVENT_VENUES_PRIORITY
-        );
-        // don't display entry meta because the existing theme will take care of that
-        remove_filter(
-            'FHEE__content_espresso_events_details_template__display_entry_meta',
-            '__return_false'
-        );
-    }
-
-
-    /**
-     *    load_event_list_assets
-     *
-     * @access    public
-     * @return    void
-     */
-    public function load_event_list_assets()
-    {
-        do_action('AHEE__EED_Events_Archive__before_load_assets');
-        add_filter('FHEE_load_EE_Session', '__return_true');
-        add_filter('FHEE__EED_Ticket_Selector__load_tckt_slctr_assets', '__return_true');
-        add_action('wp_enqueue_scripts', array($this, 'wp_enqueue_scripts'), 10);
-        if (EE_Registry::instance()->CFG->map_settings->use_google_maps) {
-            add_action('wp_enqueue_scripts', array('EEH_Maps', 'espresso_google_map_js'), 11);
-        }
-    }
-
-
-    /**
-     *    wp_enqueue_scripts
-     *
-     * @access    public
-     * @return    void
-     */
-    public function wp_enqueue_scripts()
-    {
-        // get some style
-        if (apply_filters('FHEE_enable_default_espresso_css', false)) {
-            // first check uploads folder
-            if (EEH_File::is_readable(get_stylesheet_directory() . $this->theme . '/style.css')) {
-                wp_register_style(
-                    $this->theme,
-                    get_stylesheet_directory_uri() . $this->theme . '/style.css',
-                    array('dashicons', 'espresso_default')
-                );
-            } else {
-            }
-            wp_enqueue_style($this->theme);
-        }
-    }
-
-
-    /**
-     *    template_settings_form
-     *
-     * @access    public
-     * @static
-     * @return    string
-     */
-    public static function template_settings_form()
-    {
-        $template_settings = EE_Registry::instance()->CFG->template_settings;
-        $template_settings->EED_Events_Archive = isset($template_settings->EED_Events_Archive)
-            ? $template_settings->EED_Events_Archive : new EE_Events_Archive_Config();
-        $template_settings->EED_Events_Archive = apply_filters(
-            'FHEE__EED_Events_Archive__template_settings_form__event_list_config',
-            $template_settings->EED_Events_Archive
-        );
-        $events_archive_settings = array(
-            'display_status_banner' => 0,
-            'display_description' => 1,
-            'display_ticket_selector' => 0,
-            'display_datetimes' => 1,
-            'display_venue' => 0,
-            'display_expired_events' => 0,
-        );
-        $events_archive_settings = array_merge(
-            $events_archive_settings,
-            (array) $template_settings->EED_Events_Archive
-        );
-        EEH_Template::display_template(
-            EVENTS_ARCHIVE_TEMPLATES_PATH . 'admin-event-list-settings.template.php',
-            $events_archive_settings
-        );
-    }
-
-
-    /**
-     *    update_template_settings
-     *
-     * @access    public
-     * @param    EE_Template_Config $CFG
-     * @param    array $REQ
-     * @return    EE_Template_Config
-     */
-    public static function update_template_settings($CFG, $REQ)
-    {
-        $CFG->EED_Events_Archive = new EE_Events_Archive_Config();
-        // unless we are resetting the config...
-        if (
-            ! isset($REQ['EED_Events_Archive_reset_event_list_settings'])
-            || absint($REQ['EED_Events_Archive_reset_event_list_settings']) !== 1
-        ) {
-            $CFG->EED_Events_Archive->display_status_banner = isset($REQ['EED_Events_Archive_display_status_banner'])
-                ? absint($REQ['EED_Events_Archive_display_status_banner']) : 0;
-            $CFG->EED_Events_Archive->display_description = isset($REQ['EED_Events_Archive_display_description'])
-                ? absint($REQ['EED_Events_Archive_display_description']) : 1;
-            $CFG->EED_Events_Archive->display_ticket_selector = isset($REQ['EED_Events_Archive_display_ticket_selector'])
-                ? absint($REQ['EED_Events_Archive_display_ticket_selector']) : 0;
-            $CFG->EED_Events_Archive->display_datetimes = isset($REQ['EED_Events_Archive_display_datetimes']) ? absint(
-                $REQ['EED_Events_Archive_display_datetimes']
-            ) : 1;
-            $CFG->EED_Events_Archive->display_venue = isset($REQ['EED_Events_Archive_display_venue']) ? absint(
-                $REQ['EED_Events_Archive_display_venue']
-            ) : 0;
-            $CFG->EED_Events_Archive->display_expired_events = isset($REQ['EED_Events_Archive_display_expired_events'])
-                ? absint($REQ['EED_Events_Archive_display_expired_events']) : 0;
-        }
-        return $CFG;
-    }
-
-
-    /**
-     *    event_list_css
-     *
-     * @access    public
-     * @param string $extra_class
-     * @return    string
-     */
-    public static function event_list_css($extra_class = '')
-    {
-        $event_list_css = ! empty($extra_class) ? array($extra_class) : array();
-        $event_list_css[] = 'espresso-event-list-event';
-        return implode(' ', $event_list_css);
-    }
-
-
-    /**
-     *    event_categories
-     *
-     * @access    public
-     * @return    array
-     */
-    public static function event_categories()
-    {
-        return EE_Registry::instance()->load_model('Term')->get_all_ee_categories();
-    }
-
-
-    /**
-     *    display_description
-     *
-     * @access    public
-     * @param $value
-     * @return    bool
-     */
-    public static function display_description($value)
-    {
-        $config = EE_Registry::instance()->CFG->template_settings->EED_Events_Archive;
-        $display_description = isset($config->display_description) ? $config->display_description : 1;
-        return $display_description === $value ? true : false;
-    }
-
-
-    /**
-     *    display_ticket_selector
-     *
-     * @access    public
-     * @return    bool
-     */
-    public static function display_ticket_selector()
-    {
-        $config = EE_Registry::instance()->CFG->template_settings->EED_Events_Archive;
-        return isset($config->display_ticket_selector) && $config->display_ticket_selector ? true : false;
-    }
-
-
-    /**
-     *    display_venue
-     *
-     * @access    public
-     * @return    bool
-     */
-    public static function display_venue()
-    {
-        $config = EE_Registry::instance()->CFG->template_settings->EED_Events_Archive;
-        return isset($config->display_venue) && $config->display_venue && EEH_Venue_View::venue_name() ? true : false;
-    }
-
-
-    /**
-     *    display_datetimes
-     *
-     * @access    public
-     * @return    bool
-     */
-    public static function display_datetimes()
-    {
-        $config = EE_Registry::instance()->CFG->template_settings->EED_Events_Archive;
-        return isset($config->display_datetimes) && $config->display_datetimes ? true : false;
-    }
-
-
-    /**
-     *    event_list_title
-     *
-     * @access    public
-     * @return    string
-     */
-    public static function event_list_title()
-    {
-        return apply_filters(
-            'FHEE__archive_espresso_events_template__upcoming_events_h1',
-            esc_html__('Upcoming Events', 'event_espresso')
-        );
-    }
-
-
-    // GRAVEYARD
-
-
-    /**
-     * @since 4.4.0
-     */
-    public static function _doing_it_wrong_notice($function = '')
-    {
-        EE_Error::doing_it_wrong(
-            __FUNCTION__,
-            sprintf(
-                esc_html__(
-                    'EED_Events_Archive::%1$s was moved to EEH_Event_Query::%1$s:%2$sPlease update your existing code because the method it calls will be removed in version %3$s',
-                    'event_espresso'
-                ),
-                $function,
-                '<br />',
-                '4.6.0'
-            ),
-            '4.4.0'
-        );
-    }
-
-
-    /**
-     * @deprecated
-     * @since 4.4.0
-     */
-    public function get_post_data()
-    {
-        EEH_Event_Query::set_query_params();
-    }
-
-
-    /**
-     * @deprecated
-     * @since 4.4.0
-     */
-    public function posts_fields($SQL, WP_Query $wp_query)
-    {
-        EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
-        return EEH_Event_Query::posts_fields($SQL, $wp_query);
-    }
-
-
-    /**
-     * @deprecated
-     * @since 4.4.0
-     */
-    public static function posts_fields_sql_for_orderby($orderby_params = array())
-    {
-        EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
-        return EEH_Event_Query::posts_fields_sql_for_orderby($orderby_params);
-    }
-
-
-    /**
-     * @deprecated
-     * @since 4.4.0
-     */
-    public function posts_join($SQL, WP_Query $wp_query)
-    {
-        EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
-        return EEH_Event_Query::posts_join($SQL, $wp_query);
-    }
-
-
-    /**
-     * @deprecated
-     * @since 4.4.0
-     */
-    public static function posts_join_sql_for_terms($join_terms = null)
-    {
-        EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
-        return EEH_Event_Query::posts_join_sql_for_terms($join_terms);
-    }
-
-
-    /**
-     * @deprecated
-     * @since 4.4.0
-     */
-    public static function posts_join_for_orderby($orderby_params = array())
-    {
-        EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
-        return EEH_Event_Query::posts_join_for_orderby($orderby_params);
-    }
-
-
-    /**
-     * @deprecated
-     * @since 4.4.0
-     */
-    public function posts_where($SQL, WP_Query $wp_query)
-    {
-        EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
-        return EEH_Event_Query::posts_where($SQL, $wp_query);
-    }
-
-
-    /**
-     * @deprecated
-     * @since 4.4.0
-     */
-    public static function posts_where_sql_for_show_expired($show_expired = false)
-    {
-        EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
-        return EEH_Event_Query::posts_where_sql_for_show_expired($show_expired);
-    }
-
-
-    /**
-     * @deprecated
-     * @since 4.4.0
-     */
-    public static function posts_where_sql_for_event_category_slug($event_category_slug = null)
-    {
-        EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
-        return EEH_Event_Query::posts_where_sql_for_event_category_slug($event_category_slug);
-    }
-
-
-    /**
-     * @deprecated
-     * @since 4.4.0
-     */
-    public static function posts_where_sql_for_event_list_month($month = null)
-    {
-        EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
-        return EEH_Event_Query::posts_where_sql_for_event_list_month($month);
-    }
-
-
-    /**
-     * @deprecated
-     * @since 4.4.0
-     */
-    public function posts_orderby($SQL, WP_Query $wp_query)
-    {
-        EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
-        return EEH_Event_Query::posts_orderby($SQL, $wp_query);
-    }
-
-
-    /**
-     * @deprecated
-     * @since 4.4.0
-     */
-    public static function posts_orderby_sql($orderby_params = array(), $sort = 'ASC')
-    {
-        EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
-        return EEH_Event_Query::posts_orderby_sql($orderby_params, $sort);
-    }
+	const EVENT_DETAILS_PRIORITY = 100;
+
+	const EVENT_DATETIMES_PRIORITY = 110;
+
+	const EVENT_TICKETS_PRIORITY = 120;
+
+	const EVENT_VENUES_PRIORITY = 130;
+
+
+	public static $espresso_event_list_ID = 0;
+
+	public static $espresso_grid_event_lists = array();
+
+	/**
+	 * @type bool $using_get_the_excerpt
+	 */
+	protected static $using_get_the_excerpt = false;
+
+	/**
+	 * Used to flag when the event list is being called from an external iframe.
+	 *
+	 * @var bool $iframe
+	 */
+	protected static $iframe = false;
+
+	/**
+	 * @var EventListIframeEmbedButton $_iframe_embed_button
+	 */
+	private static $_iframe_embed_button;
+
+	/**
+	 * @type EE_Template_Part_Manager $template_parts
+	 */
+	protected $template_parts;
+
+
+	/**
+	 * @return EED_Events_Archive
+	 */
+	public static function instance()
+	{
+		return parent::get_instance(__CLASS__);
+	}
+
+
+	/**
+	 * set_hooks - for hooking into EE Core, other modules, etc
+	 *
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function set_hooks()
+	{
+		/** @var EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions $custom_post_type_definitions */
+		$custom_post_type_definitions = LoaderFactory::getLoader()->getShared(
+			'EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions'
+		);
+		$custom_post_types = $custom_post_type_definitions->getDefinitions();
+		EE_Config::register_route(
+			$custom_post_types['espresso_events']['plural_slug'],
+			'Events_Archive',
+			'run'
+		);
+		EE_Config::register_route(
+			'event_list',
+			'Events_Archive',
+			'event_list'
+		);
+		EE_Config::register_route(
+			'iframe',
+			'Events_Archive',
+			'event_list_iframe',
+			'event_list'
+		);
+		add_action('wp_loaded', array('EED_Events_Archive', 'set_definitions'), 2);
+	}
+
+
+	/**
+	 *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function set_hooks_admin()
+	{
+		add_action('wp_loaded', array('EED_Events_Archive', 'set_definitions'), 2);
+		// hook into the end of the \EE_Admin_Page::_load_page_dependencies()
+		// to load assets for "espresso_events" page on the "default" route (action)
+		add_action(
+			'FHEE__EE_Admin_Page___load_page_dependencies__after_load__espresso_events__default',
+			array('EED_Events_Archive', 'event_list_iframe_embed_button'),
+			10
+		);
+	}
+
+
+	/**
+	 *    set_definitions
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function set_definitions()
+	{
+		define('EVENTS_ARCHIVE_ASSETS_URL', plugin_dir_url(__FILE__) . 'assets/');
+		define('EVENTS_ARCHIVE_TEMPLATES_PATH', str_replace('\\', '/', plugin_dir_path(__FILE__)) . 'templates/');
+	}
+
+
+	/**
+	 * set up EE_Events_Archive_Config
+	 */
+	protected function set_config()
+	{
+		$this->set_config_section('template_settings');
+		$this->set_config_class('EE_Events_Archive_Config');
+		$this->set_config_name('EED_Events_Archive');
+	}
+
+
+	/**
+	 * @return EventListIframeEmbedButton
+	 */
+	public static function get_iframe_embed_button()
+	{
+		if (! self::$_iframe_embed_button instanceof EventListIframeEmbedButton) {
+			self::$_iframe_embed_button = new EventListIframeEmbedButton();
+		}
+		return self::$_iframe_embed_button;
+	}
+
+
+	/**
+	 * event_list_iframe_embed_button
+	 *
+	 * @return    void
+	 * @throws EE_Error
+	 */
+	public static function event_list_iframe_embed_button()
+	{
+		$iframe_embed_button = EED_Events_Archive::get_iframe_embed_button();
+		$iframe_embed_button->addEmbedButton();
+	}
+
+
+	/**
+	 *    initialize_template_parts
+	 *
+	 * @access    public
+	 * @param EE_Events_Archive_Config $config
+	 * @return EE_Template_Part_Manager
+	 */
+	public function initialize_template_parts(EE_Events_Archive_Config $config = null)
+	{
+		$config = $config instanceof EE_Events_Archive_Config ? $config : $this->config();
+		EEH_Autoloader::instance()->register_template_part_autoloaders();
+		$template_parts = new EE_Template_Part_Manager();
+		$template_parts->add_template_part(
+			'tickets',
+			esc_html__('Ticket Selector', 'event_espresso'),
+			'content-espresso_events-tickets.php',
+			$config->display_order_tickets
+		);
+		$template_parts->add_template_part(
+			'datetimes',
+			esc_html__('Dates and Times', 'event_espresso'),
+			'content-espresso_events-datetimes.php',
+			$config->display_order_datetimes
+		);
+		$template_parts->add_template_part(
+			'event',
+			esc_html__('Event Description', 'event_espresso'),
+			'content-espresso_events-details.php',
+			$config->display_order_event
+		);
+		$template_parts->add_template_part(
+			'venue',
+			esc_html__('Venue Information', 'event_espresso'),
+			'content-espresso_events-venues.php',
+			$config->display_order_venue
+		);
+		do_action('AHEE__EED_Event_Archive__initialize_template_parts', $template_parts);
+		return $template_parts;
+	}
+
+
+	/**
+	 *    run - initial module setup - this gets called by the EE_Front_Controller if the module route is found in the
+	 *    incoming request
+	 *
+	 * @access    public
+	 * @param WP $WP
+	 * @return    void
+	 */
+	public function run($WP)
+	{
+		do_action('AHEE__EED_Events_Archive__before_run');
+		// ensure valid EE_Events_Archive_Config() object exists
+		$this->set_config();
+		/** @type EE_Events_Archive_Config $config */
+		$config = $this->config();
+		// load other required components
+		$this->load_event_list_assets();
+		// filter the WP posts_join, posts_where, and posts_orderby SQL clauses
+		// add query filters
+		EEH_Event_Query::add_query_filters();
+		// set params that will get used by the filters
+		EEH_Event_Query::set_query_params(
+			'',    // month
+			'',    // category
+			$config->display_expired_events,    // show_expired
+			'start_date',    // orderby
+			'ASC'    // sort
+		);
+		// check what template is loaded
+		add_filter('template_include', array($this, 'template_include'), 999, 1);
+	}
+
+
+	/**
+	 * most likely called by the ESPRESSO_EVENTS shortcode which uses this module to do some of it's lifting
+	 *
+	 * @return    void
+	 */
+	public function event_list()
+	{
+		// ensure valid EE_Events_Archive_Config() object exists
+		$this->set_config();
+		// load other required components
+		$this->load_event_list_assets();
+	}
+
+
+	/**
+	 * @access    public
+	 * @return    void
+	 * @throws EE_Error
+	 * @throws DomainException
+	 */
+	public function event_list_iframe()
+	{
+		EED_Events_Archive::$iframe = true;
+		$event_list_iframe          = new EventsArchiveIframe($this);
+		$event_list_iframe->display();
+	}
+
+
+	/**
+	 * @access public
+	 * @return string
+	 */
+	public static function is_iframe()
+	{
+		return EED_Events_Archive::$iframe;
+	}
+
+
+	/**
+	 * @access public
+	 * @return string
+	 */
+	public static function link_target()
+	{
+		return EED_Events_Archive::$iframe ? ' target="_blank"' : '';
+	}
+
+
+	/**
+	 *    template_include
+	 *
+	 * @access    public
+	 * @param string $template
+	 * @return    string
+	 */
+	public function template_include($template = '')
+	{
+		// don't add content filter for dedicated EE child themes or private posts
+		if (! EEH_Template::is_espresso_theme()) {
+			/** @type EE_Events_Archive_Config $config */
+			$config = $this->config();
+			// add status banner ?
+			if ($config->display_status_banner) {
+				add_filter('the_title', array('EED_Events_Archive', 'the_title'), 100, 2);
+			}
+			// if NOT a custom template
+			if (
+				apply_filters('FHEE__EED_Event_Archive__template_include__allow_custom_selected_template', false)
+				|| EE_Registry::instance()
+							  ->load_core('Front_Controller')
+							  ->get_selected_template() !== 'archive-espresso_events.php'
+			) {
+				// don't display entry meta because the existing theme will take care of that
+				add_filter('FHEE__EED_Events_Archive__template_include__events_list_active', '__return_true');
+				// load functions.php file for the theme (loaded by WP if using child theme)
+				EEH_Template::load_espresso_theme_functions();
+				// because we don't know if the theme is using the_excerpt()
+				add_filter(
+					'the_excerpt',
+					array('EED_Events_Archive', 'event_details'),
+					EED_Events_Archive::EVENT_DETAILS_PRIORITY
+				);
+				// or the_content
+				add_filter(
+					'the_content',
+					array('EED_Events_Archive', 'event_details'),
+					EED_Events_Archive::EVENT_DETAILS_PRIORITY
+				);
+				// and just in case they are running get_the_excerpt() which DESTROYS things
+				add_filter('get_the_excerpt', array('EED_Events_Archive', 'get_the_excerpt'), 1, 1);
+				// don't display entry meta because the existing theme will take care of that
+				add_filter('FHEE__content_espresso_events_details_template__display_entry_meta', '__return_false');
+			}
+		}
+		return $template;
+	}
+
+
+	/**
+	 *    get_the_excerpt - kinda hacky, but if a theme is using get_the_excerpt(), then we need to remove our filters
+	 *    on the_content()
+	 *
+	 * @access    public
+	 * @param        string $excerpt
+	 * @return        string
+	 */
+	public static function get_the_excerpt($excerpt = '')
+	{
+		if (post_password_required()) {
+			return $excerpt;
+		}
+		if (apply_filters('FHEE__EED_Events_Archive__get_the_excerpt__theme_uses_get_the_excerpt', false)) {
+			remove_filter(
+				'the_excerpt',
+				array('EED_Events_Archive', 'event_details'),
+				EED_Events_Archive::EVENT_DETAILS_PRIORITY
+			);
+			remove_filter(
+				'the_content',
+				array('EED_Events_Archive', 'event_details'),
+				EED_Events_Archive::EVENT_DETAILS_PRIORITY
+			);
+			$excerpt = EED_Events_Archive::event_details($excerpt);
+		} else {
+			EED_Events_Archive::$using_get_the_excerpt = true;
+			add_filter('wp_trim_excerpt', array('EED_Events_Archive', 'end_get_the_excerpt'), 999, 1);
+		}
+		return $excerpt;
+	}
+
+
+	/**
+	 * end_get_the_excerpt
+	 *
+	 * @access public
+	 * @param  string $text
+	 * @return string
+	 */
+	public static function end_get_the_excerpt($text = '')
+	{
+		EED_Events_Archive::$using_get_the_excerpt = false;
+		return $text;
+	}
+
+
+	/**
+	 *    the_title
+	 *
+	 * @access        public
+	 * @param        string $title
+	 * @param        string $id
+	 * @return        string
+	 */
+	public static function the_title($title = '', $id = '')
+	{
+		global $post;
+		if ($post instanceof WP_Post) {
+			return in_the_loop() && $post->ID == $id ? espresso_event_status_banner($post->ID) . $title : $title;
+		}
+		return $title;
+	}
+
+
+	/**
+	 *    event_details
+	 *
+	 * @access    public
+	 * @param        string $content
+	 * @return        string
+	 */
+	public static function event_details($content)
+	{
+		global $post;
+		static $current_post_ID = 0;
+		if (
+			$current_post_ID !== $post->ID
+			&& $post->post_type === 'espresso_events'
+			&& ! EED_Events_Archive::$using_get_the_excerpt
+			&& ! post_password_required()
+			&& (
+				apply_filters('FHEE__EES_Espresso_Events__process_shortcode__true', false)
+				|| ! apply_filters('FHEE__content_espresso_events__template_loaded', false)
+			)
+		) {
+			// Set current post ID to prevent showing content twice, but only if headers have definitely been sent.
+			// Reason being is that some plugins, like Yoast, need to run through a copy of the loop early
+			// BEFORE headers are sent in order to examine the post content and generate content for the HTML header.
+			// We want to allow those plugins to still do their thing and have access to our content, but depending on
+			// how your event content is being displayed (shortcode, CPT route, etc), this filter can get applied twice,
+			// so the following allows this filter to be applied multiple times, but only once for real
+			$current_post_ID = did_action('loop_start') ? $post->ID : 0;
+			if (EE_Registry::instance()->CFG->template_settings->EED_Events_Archive->use_sortable_display_order) {
+				$content = EED_Events_Archive::use_sortable_display_order();
+			} else {
+				$content = EED_Events_Archive::use_filterable_display_order();
+			}
+		}
+		return $content;
+	}
+
+
+	/**
+	 *    use_sortable_display_order
+	 *
+	 * @access    protected
+	 * @return string
+	 */
+	protected static function use_sortable_display_order()
+	{
+		// no further password checks required atm
+		add_filter('FHEE__EED_Events_Archive__event_details__no_post_password_required', '__return_true');
+		// we need to first remove this callback from being applied to the_content() or the_excerpt()
+		// (otherwise it will recurse and blow up the interweb)
+		remove_filter(
+			'the_excerpt',
+			array('EED_Events_Archive', 'event_details'),
+			EED_Events_Archive::EVENT_DETAILS_PRIORITY
+		);
+		remove_filter(
+			'the_content',
+			array('EED_Events_Archive', 'event_details'),
+			EED_Events_Archive::EVENT_DETAILS_PRIORITY
+		);
+		remove_filter('get_the_excerpt', array('EED_Events_Archive', 'get_the_excerpt'), 1);
+		// now add additional content depending on whether event is using the_excerpt() or the_content()
+		EED_Events_Archive::instance()->template_parts = EED_Events_Archive::instance()->initialize_template_parts();
+		$content = EEH_Template::locate_template('content-espresso_events-details.php');
+		$content = EED_Events_Archive::instance()->template_parts->apply_template_part_filters($content);
+		// re-add our main filters (or else the next event won't have them)
+		add_filter(
+			'the_excerpt',
+			array('EED_Events_Archive', 'event_details'),
+			EED_Events_Archive::EVENT_DETAILS_PRIORITY
+		);
+		add_filter(
+			'the_content',
+			array('EED_Events_Archive', 'event_details'),
+			EED_Events_Archive::EVENT_DETAILS_PRIORITY
+		);
+		add_filter('get_the_excerpt', array('EED_Events_Archive', 'get_the_excerpt'), 1, 1);
+		remove_filter(
+			'FHEE__EED_Events_Archive__event_details__no_post_password_required',
+			'__return_true'
+		);
+		return $content;
+	}
+
+
+	/**
+	 *    use_filterable_display_order
+	 *
+	 * @access    protected
+	 * @return    string
+	 */
+	protected static function use_filterable_display_order()
+	{
+		// we need to first remove this callback from being applied to the_content()
+		// (otherwise it will recurse and blow up the interweb)
+		remove_filter(
+			'the_excerpt',
+			array('EED_Events_Archive', 'event_details'),
+			EED_Events_Archive::EVENT_DETAILS_PRIORITY
+		);
+		remove_filter(
+			'the_content',
+			array('EED_Events_Archive', 'event_details'),
+			EED_Events_Archive::EVENT_DETAILS_PRIORITY
+		);
+		remove_filter('get_the_excerpt', array('EED_Events_Archive', 'get_the_excerpt'), 1);
+		// now add additional content depending on whether event is using the_excerpt() or the_content()
+		EED_Events_Archive::_add_additional_excerpt_filters();
+		EED_Events_Archive::_add_additional_content_filters();
+		do_action('AHEE__EED_Events_Archive__use_filterable_display_order__after_add_filters');
+		// now load our template
+		$content = EEH_Template::locate_template('content-espresso_events-details.php');
+		// re-add our main filters (or else the next event won't have them)
+		add_filter(
+			'the_excerpt',
+			array('EED_Events_Archive', 'event_details'),
+			EED_Events_Archive::EVENT_DETAILS_PRIORITY
+		);
+		add_filter(
+			'the_content',
+			array('EED_Events_Archive', 'event_details'),
+			EED_Events_Archive::EVENT_DETAILS_PRIORITY
+		);
+		add_filter('get_the_excerpt', array('EED_Events_Archive', 'get_the_excerpt'), 1, 1);
+		// but remove the other filters so that they don't get applied to the next post
+		EED_Events_Archive::_remove_additional_events_archive_filters();
+		do_action('AHEE__EED_Events_Archive__use_filterable_display_order__after_remove_filters');
+		// we're not returning the $content directly because the template we are loading uses the_content (or the_excerpt)
+		// return ! empty( $template ) ? $template : $content;
+		return $content;
+	}
+
+
+	/**
+	 *    event_datetimes - adds datetimes ABOVE content
+	 *
+	 * @access    public
+	 * @param        string $content
+	 * @return        string
+	 */
+	public static function event_datetimes($content)
+	{
+		if (post_password_required()) {
+			return $content;
+		}
+		return EEH_Template::locate_template('content-espresso_events-datetimes.php') . $content;
+	}
+
+
+	/**
+	 *    event_tickets - adds tickets ABOVE content (which includes datetimes)
+	 *
+	 * @access    public
+	 * @param        string $content
+	 * @return        string
+	 */
+	public static function event_tickets($content)
+	{
+		if (post_password_required()) {
+			return $content;
+		}
+		return EEH_Template::locate_template('content-espresso_events-tickets.php') . $content;
+	}
+
+
+	/**
+	 *    event_venues - adds venues BELOW content
+	 *
+	 * @access    public
+	 * @param    string $content
+	 * @return    string
+	 */
+	public static function event_venue($content)
+	{
+		return EED_Events_Archive::event_venues($content);
+	}
+
+
+	/**
+	 *    event_venues - adds venues BELOW content
+	 *
+	 * @access    public
+	 * @param        string $content
+	 * @return        string
+	 */
+	public static function event_venues($content)
+	{
+		if (post_password_required()) {
+			return $content;
+		}
+		return $content . EEH_Template::locate_template('content-espresso_events-venues.php');
+	}
+
+
+	/**
+	 *    _add_additional_content_filters
+	 *
+	 * @access    private
+	 * @return        void
+	 */
+	private static function _add_additional_excerpt_filters()
+	{
+		add_filter(
+			'the_excerpt',
+			array('EED_Events_Archive', 'event_datetimes'),
+			EED_Events_Archive::EVENT_DATETIMES_PRIORITY
+		);
+		add_filter(
+			'the_excerpt',
+			array('EED_Events_Archive', 'event_tickets'),
+			EED_Events_Archive::EVENT_TICKETS_PRIORITY
+		);
+		add_filter(
+			'the_excerpt',
+			array('EED_Events_Archive', 'event_venues'),
+			EED_Events_Archive::EVENT_VENUES_PRIORITY
+		);
+	}
+
+
+	/**
+	 *    _add_additional_content_filters
+	 *
+	 * @access    private
+	 * @return        void
+	 */
+	private static function _add_additional_content_filters()
+	{
+		add_filter(
+			'the_content',
+			array('EED_Events_Archive', 'event_datetimes'),
+			EED_Events_Archive::EVENT_DATETIMES_PRIORITY
+		);
+		add_filter(
+			'the_content',
+			array('EED_Events_Archive', 'event_tickets'),
+			EED_Events_Archive::EVENT_TICKETS_PRIORITY
+		);
+		add_filter(
+			'the_content',
+			array('EED_Events_Archive', 'event_venues'),
+			EED_Events_Archive::EVENT_VENUES_PRIORITY
+		);
+	}
+
+
+	/**
+	 *    _remove_additional_events_archive_filters
+	 *
+	 * @access    private
+	 * @return        void
+	 */
+	private static function _remove_additional_events_archive_filters()
+	{
+		remove_filter(
+			'the_excerpt',
+			array('EED_Events_Archive', 'event_datetimes'),
+			EED_Events_Archive::EVENT_DATETIMES_PRIORITY
+		);
+		remove_filter(
+			'the_excerpt',
+			array('EED_Events_Archive', 'event_tickets'),
+			EED_Events_Archive::EVENT_TICKETS_PRIORITY
+		);
+		remove_filter(
+			'the_excerpt',
+			array('EED_Events_Archive', 'event_venues'),
+			EED_Events_Archive::EVENT_VENUES_PRIORITY
+		);
+		remove_filter(
+			'the_content',
+			array('EED_Events_Archive', 'event_datetimes'),
+			EED_Events_Archive::EVENT_DATETIMES_PRIORITY
+		);
+		remove_filter(
+			'the_content',
+			array('EED_Events_Archive', 'event_tickets'),
+			EED_Events_Archive::EVENT_TICKETS_PRIORITY
+		);
+		remove_filter(
+			'the_content',
+			array('EED_Events_Archive', 'event_venues'),
+			EED_Events_Archive::EVENT_VENUES_PRIORITY
+		);
+	}
+
+
+	/**
+	 *    remove_all_events_archive_filters
+	 *
+	 * @access    public
+	 * @return        void
+	 */
+	public static function remove_all_events_archive_filters()
+	{
+		// remove_filter( 'get_the_excerpt', array( 'EED_Events_Archive', 'get_the_excerpt' ), 1 );
+		remove_filter('the_title', array('EED_Events_Archive', 'the_title'), 1);
+		remove_filter(
+			'the_excerpt',
+			array('EED_Events_Archive', 'event_details'),
+			EED_Events_Archive::EVENT_DETAILS_PRIORITY
+		);
+		remove_filter(
+			'the_excerpt',
+			array('EED_Events_Archive', 'event_datetimes'),
+			EED_Events_Archive::EVENT_DATETIMES_PRIORITY
+		);
+		remove_filter(
+			'the_excerpt',
+			array('EED_Events_Archive', 'event_tickets'),
+			EED_Events_Archive::EVENT_TICKETS_PRIORITY
+		);
+		remove_filter(
+			'the_excerpt',
+			array('EED_Events_Archive', 'event_venues'),
+			EED_Events_Archive::EVENT_VENUES_PRIORITY
+		);
+		remove_filter(
+			'the_content',
+			array('EED_Events_Archive', 'event_details'),
+			EED_Events_Archive::EVENT_DETAILS_PRIORITY
+		);
+		remove_filter(
+			'the_content',
+			array('EED_Events_Archive', 'event_datetimes'),
+			EED_Events_Archive::EVENT_DATETIMES_PRIORITY
+		);
+		remove_filter(
+			'the_content',
+			array('EED_Events_Archive', 'event_tickets'),
+			EED_Events_Archive::EVENT_TICKETS_PRIORITY
+		);
+		remove_filter(
+			'the_content',
+			array('EED_Events_Archive', 'event_venues'),
+			EED_Events_Archive::EVENT_VENUES_PRIORITY
+		);
+		// don't display entry meta because the existing theme will take care of that
+		remove_filter(
+			'FHEE__content_espresso_events_details_template__display_entry_meta',
+			'__return_false'
+		);
+	}
+
+
+	/**
+	 *    load_event_list_assets
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public function load_event_list_assets()
+	{
+		do_action('AHEE__EED_Events_Archive__before_load_assets');
+		add_filter('FHEE_load_EE_Session', '__return_true');
+		add_filter('FHEE__EED_Ticket_Selector__load_tckt_slctr_assets', '__return_true');
+		add_action('wp_enqueue_scripts', array($this, 'wp_enqueue_scripts'), 10);
+		if (EE_Registry::instance()->CFG->map_settings->use_google_maps) {
+			add_action('wp_enqueue_scripts', array('EEH_Maps', 'espresso_google_map_js'), 11);
+		}
+	}
+
+
+	/**
+	 *    wp_enqueue_scripts
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public function wp_enqueue_scripts()
+	{
+		// get some style
+		if (apply_filters('FHEE_enable_default_espresso_css', false)) {
+			// first check uploads folder
+			if (EEH_File::is_readable(get_stylesheet_directory() . $this->theme . '/style.css')) {
+				wp_register_style(
+					$this->theme,
+					get_stylesheet_directory_uri() . $this->theme . '/style.css',
+					array('dashicons', 'espresso_default')
+				);
+			} else {
+			}
+			wp_enqueue_style($this->theme);
+		}
+	}
+
+
+	/**
+	 *    template_settings_form
+	 *
+	 * @access    public
+	 * @static
+	 * @return    string
+	 */
+	public static function template_settings_form()
+	{
+		$template_settings = EE_Registry::instance()->CFG->template_settings;
+		$template_settings->EED_Events_Archive = isset($template_settings->EED_Events_Archive)
+			? $template_settings->EED_Events_Archive : new EE_Events_Archive_Config();
+		$template_settings->EED_Events_Archive = apply_filters(
+			'FHEE__EED_Events_Archive__template_settings_form__event_list_config',
+			$template_settings->EED_Events_Archive
+		);
+		$events_archive_settings = array(
+			'display_status_banner' => 0,
+			'display_description' => 1,
+			'display_ticket_selector' => 0,
+			'display_datetimes' => 1,
+			'display_venue' => 0,
+			'display_expired_events' => 0,
+		);
+		$events_archive_settings = array_merge(
+			$events_archive_settings,
+			(array) $template_settings->EED_Events_Archive
+		);
+		EEH_Template::display_template(
+			EVENTS_ARCHIVE_TEMPLATES_PATH . 'admin-event-list-settings.template.php',
+			$events_archive_settings
+		);
+	}
+
+
+	/**
+	 *    update_template_settings
+	 *
+	 * @access    public
+	 * @param    EE_Template_Config $CFG
+	 * @param    array $REQ
+	 * @return    EE_Template_Config
+	 */
+	public static function update_template_settings($CFG, $REQ)
+	{
+		$CFG->EED_Events_Archive = new EE_Events_Archive_Config();
+		// unless we are resetting the config...
+		if (
+			! isset($REQ['EED_Events_Archive_reset_event_list_settings'])
+			|| absint($REQ['EED_Events_Archive_reset_event_list_settings']) !== 1
+		) {
+			$CFG->EED_Events_Archive->display_status_banner = isset($REQ['EED_Events_Archive_display_status_banner'])
+				? absint($REQ['EED_Events_Archive_display_status_banner']) : 0;
+			$CFG->EED_Events_Archive->display_description = isset($REQ['EED_Events_Archive_display_description'])
+				? absint($REQ['EED_Events_Archive_display_description']) : 1;
+			$CFG->EED_Events_Archive->display_ticket_selector = isset($REQ['EED_Events_Archive_display_ticket_selector'])
+				? absint($REQ['EED_Events_Archive_display_ticket_selector']) : 0;
+			$CFG->EED_Events_Archive->display_datetimes = isset($REQ['EED_Events_Archive_display_datetimes']) ? absint(
+				$REQ['EED_Events_Archive_display_datetimes']
+			) : 1;
+			$CFG->EED_Events_Archive->display_venue = isset($REQ['EED_Events_Archive_display_venue']) ? absint(
+				$REQ['EED_Events_Archive_display_venue']
+			) : 0;
+			$CFG->EED_Events_Archive->display_expired_events = isset($REQ['EED_Events_Archive_display_expired_events'])
+				? absint($REQ['EED_Events_Archive_display_expired_events']) : 0;
+		}
+		return $CFG;
+	}
+
+
+	/**
+	 *    event_list_css
+	 *
+	 * @access    public
+	 * @param string $extra_class
+	 * @return    string
+	 */
+	public static function event_list_css($extra_class = '')
+	{
+		$event_list_css = ! empty($extra_class) ? array($extra_class) : array();
+		$event_list_css[] = 'espresso-event-list-event';
+		return implode(' ', $event_list_css);
+	}
+
+
+	/**
+	 *    event_categories
+	 *
+	 * @access    public
+	 * @return    array
+	 */
+	public static function event_categories()
+	{
+		return EE_Registry::instance()->load_model('Term')->get_all_ee_categories();
+	}
+
+
+	/**
+	 *    display_description
+	 *
+	 * @access    public
+	 * @param $value
+	 * @return    bool
+	 */
+	public static function display_description($value)
+	{
+		$config = EE_Registry::instance()->CFG->template_settings->EED_Events_Archive;
+		$display_description = isset($config->display_description) ? $config->display_description : 1;
+		return $display_description === $value ? true : false;
+	}
+
+
+	/**
+	 *    display_ticket_selector
+	 *
+	 * @access    public
+	 * @return    bool
+	 */
+	public static function display_ticket_selector()
+	{
+		$config = EE_Registry::instance()->CFG->template_settings->EED_Events_Archive;
+		return isset($config->display_ticket_selector) && $config->display_ticket_selector ? true : false;
+	}
+
+
+	/**
+	 *    display_venue
+	 *
+	 * @access    public
+	 * @return    bool
+	 */
+	public static function display_venue()
+	{
+		$config = EE_Registry::instance()->CFG->template_settings->EED_Events_Archive;
+		return isset($config->display_venue) && $config->display_venue && EEH_Venue_View::venue_name() ? true : false;
+	}
+
+
+	/**
+	 *    display_datetimes
+	 *
+	 * @access    public
+	 * @return    bool
+	 */
+	public static function display_datetimes()
+	{
+		$config = EE_Registry::instance()->CFG->template_settings->EED_Events_Archive;
+		return isset($config->display_datetimes) && $config->display_datetimes ? true : false;
+	}
+
+
+	/**
+	 *    event_list_title
+	 *
+	 * @access    public
+	 * @return    string
+	 */
+	public static function event_list_title()
+	{
+		return apply_filters(
+			'FHEE__archive_espresso_events_template__upcoming_events_h1',
+			esc_html__('Upcoming Events', 'event_espresso')
+		);
+	}
+
+
+	// GRAVEYARD
+
+
+	/**
+	 * @since 4.4.0
+	 */
+	public static function _doing_it_wrong_notice($function = '')
+	{
+		EE_Error::doing_it_wrong(
+			__FUNCTION__,
+			sprintf(
+				esc_html__(
+					'EED_Events_Archive::%1$s was moved to EEH_Event_Query::%1$s:%2$sPlease update your existing code because the method it calls will be removed in version %3$s',
+					'event_espresso'
+				),
+				$function,
+				'<br />',
+				'4.6.0'
+			),
+			'4.4.0'
+		);
+	}
+
+
+	/**
+	 * @deprecated
+	 * @since 4.4.0
+	 */
+	public function get_post_data()
+	{
+		EEH_Event_Query::set_query_params();
+	}
+
+
+	/**
+	 * @deprecated
+	 * @since 4.4.0
+	 */
+	public function posts_fields($SQL, WP_Query $wp_query)
+	{
+		EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
+		return EEH_Event_Query::posts_fields($SQL, $wp_query);
+	}
+
+
+	/**
+	 * @deprecated
+	 * @since 4.4.0
+	 */
+	public static function posts_fields_sql_for_orderby($orderby_params = array())
+	{
+		EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
+		return EEH_Event_Query::posts_fields_sql_for_orderby($orderby_params);
+	}
+
+
+	/**
+	 * @deprecated
+	 * @since 4.4.0
+	 */
+	public function posts_join($SQL, WP_Query $wp_query)
+	{
+		EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
+		return EEH_Event_Query::posts_join($SQL, $wp_query);
+	}
+
+
+	/**
+	 * @deprecated
+	 * @since 4.4.0
+	 */
+	public static function posts_join_sql_for_terms($join_terms = null)
+	{
+		EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
+		return EEH_Event_Query::posts_join_sql_for_terms($join_terms);
+	}
+
+
+	/**
+	 * @deprecated
+	 * @since 4.4.0
+	 */
+	public static function posts_join_for_orderby($orderby_params = array())
+	{
+		EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
+		return EEH_Event_Query::posts_join_for_orderby($orderby_params);
+	}
+
+
+	/**
+	 * @deprecated
+	 * @since 4.4.0
+	 */
+	public function posts_where($SQL, WP_Query $wp_query)
+	{
+		EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
+		return EEH_Event_Query::posts_where($SQL, $wp_query);
+	}
+
+
+	/**
+	 * @deprecated
+	 * @since 4.4.0
+	 */
+	public static function posts_where_sql_for_show_expired($show_expired = false)
+	{
+		EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
+		return EEH_Event_Query::posts_where_sql_for_show_expired($show_expired);
+	}
+
+
+	/**
+	 * @deprecated
+	 * @since 4.4.0
+	 */
+	public static function posts_where_sql_for_event_category_slug($event_category_slug = null)
+	{
+		EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
+		return EEH_Event_Query::posts_where_sql_for_event_category_slug($event_category_slug);
+	}
+
+
+	/**
+	 * @deprecated
+	 * @since 4.4.0
+	 */
+	public static function posts_where_sql_for_event_list_month($month = null)
+	{
+		EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
+		return EEH_Event_Query::posts_where_sql_for_event_list_month($month);
+	}
+
+
+	/**
+	 * @deprecated
+	 * @since 4.4.0
+	 */
+	public function posts_orderby($SQL, WP_Query $wp_query)
+	{
+		EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
+		return EEH_Event_Query::posts_orderby($SQL, $wp_query);
+	}
+
+
+	/**
+	 * @deprecated
+	 * @since 4.4.0
+	 */
+	public static function posts_orderby_sql($orderby_params = array(), $sort = 'ASC')
+	{
+		EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
+		return EEH_Event_Query::posts_orderby_sql($orderby_params, $sort);
+	}
 }
 
 
@@ -1115,9 +1115,9 @@ 
  */
 function espresso_get_event_list_ID()
 {
-    EED_Events_Archive::$espresso_event_list_ID++;
-    EED_Events_Archive::$espresso_grid_event_lists[] = EED_Events_Archive::$espresso_event_list_ID;
-    return EED_Events_Archive::$espresso_event_list_ID;
+	EED_Events_Archive::$espresso_event_list_ID++;
+	EED_Events_Archive::$espresso_grid_event_lists[] = EED_Events_Archive::$espresso_event_list_ID;
+	return EED_Events_Archive::$espresso_event_list_ID;
 }
 
 /**
@@ -1125,7 +1125,7 @@ 
  */
 function espresso_event_list_title()
 {
-    return EED_Events_Archive::event_list_title();
+	return EED_Events_Archive::event_list_title();
 }
 
 /**
@@ -1134,7 +1134,7 @@ 
  */
 function espresso_event_list_css($extra_class = '')
 {
-    return EED_Events_Archive::event_list_css($extra_class);
+	return EED_Events_Archive::event_list_css($extra_class);
 }
 
 /**
@@ -1142,7 +1142,7 @@ 
  */
 function espresso_get_event_categories()
 {
-    return EED_Events_Archive::event_categories();
+	return EED_Events_Archive::event_categories();
 }
 
 /**
@@ -1150,7 +1150,7 @@ 
  */
 function espresso_display_full_description_in_event_list()
 {
-    return EED_Events_Archive::display_description(2);
+	return EED_Events_Archive::display_description(2);
 }
 
 /**
@@ -1158,7 +1158,7 @@ 
  */
 function espresso_display_excerpt_in_event_list()
 {
-    return EED_Events_Archive::display_description(1);
+	return EED_Events_Archive::display_description(1);
 }
 
 /**
@@ -1166,7 +1166,7 @@ 
  */
 function espresso_display_ticket_selector_in_event_list()
 {
-    return EED_Events_Archive::display_ticket_selector();
+	return EED_Events_Archive::display_ticket_selector();
 }
 
 /**
@@ -1174,7 +1174,7 @@ 
  */
 function espresso_display_venue_in_event_list()
 {
-    return EED_Events_Archive::display_venue();
+	return EED_Events_Archive::display_venue();
 }
 
 /**
@@ -1182,5 +1182,5 @@ 
  */
 function espresso_display_datetimes_in_event_list()
 {
-    return EED_Events_Archive::display_datetimes();
+	return EED_Events_Archive::display_datetimes();
 }

core/EE_System.core.php

Indentation +1310 added lines, -1310 removed lines

@@ -27,1314 +27,1314 @@
 final class EE_System implements ResettableInterface
 {
 
-    /**
-     * indicates this is a 'normal' request. Ie, not activation, nor upgrade, nor activation.
-     * So examples of this would be a normal GET request on the frontend or backend, or a POST, etc
-     */
-    const req_type_normal = 0;
-
-    /**
-     * Indicates this is a brand new installation of EE so we should install
-     * tables and default data etc
-     */
-    const req_type_new_activation = 1;
-
-    /**
-     * we've detected that EE has been reactivated (or EE was activated during maintenance mode,
-     * and we just exited maintenance mode). We MUST check the database is setup properly
-     * and that default data is setup too
-     */
-    const req_type_reactivation = 2;
-
-    /**
-     * indicates that EE has been upgraded since its previous request.
-     * We may have data migration scripts to call and will want to trigger maintenance mode
-     */
-    const req_type_upgrade = 3;
-
-    /**
-     * TODO  will detect that EE has been DOWNGRADED. We probably don't want to run in this case...
-     */
-    const req_type_downgrade = 4;
-
-    /**
-     * @deprecated since version 4.6.0.dev.006
-     * Now whenever a new_activation is detected the request type is still just
-     * new_activation (same for reactivation, upgrade, downgrade etc), but if we'r ein maintenance mode
-     * EE_System::initialize_db_if_no_migrations_required and EE_Addon::initialize_db_if_no_migrations_required
-     * will instead enqueue that EE plugin's db initialization for when we're taken out of maintenance mode.
-     * (Specifically, when the migration manager indicates migrations are finished
-     * EE_Data_Migration_Manager::initialize_db_for_enqueued_ee_plugins() will be called)
-     */
-    const req_type_activation_but_not_installed = 5;
-
-    /**
-     * option prefix for recording the activation history (like core's "espresso_db_update") of addons
-     */
-    const addon_activation_history_option_prefix = 'ee_addon_activation_history_';
-
-    /**
-     * @var EE_System $_instance
-     */
-    private static $_instance;
-
-    /**
-     * @var EE_Registry $registry
-     */
-    private $registry;
-
-    /**
-     * @var LoaderInterface $loader
-     */
-    private $loader;
-
-    /**
-     * @var EE_Capabilities $capabilities
-     */
-    private $capabilities;
-
-    /**
-     * @var RequestInterface $request
-     */
-    private $request;
-
-    /**
-     * @var EE_Maintenance_Mode $maintenance_mode
-     */
-    private $maintenance_mode;
-
-    /**
-     * Stores which type of request this is, options being one of the constants on EE_System starting with req_type_*.
-     * It can be a brand-new activation, a reactivation, an upgrade, a downgrade, or a normal request.
-     *
-     * @var int $_req_type
-     */
-    private $_req_type;
-
-    /**
-     * Whether or not there was a non-micro version change in EE core version during this request
-     *
-     * @var boolean $_major_version_change
-     */
-    private $_major_version_change = false;
-
-    /**
-     * A Context DTO dedicated solely to identifying the current request type.
-     *
-     * @var RequestTypeContextCheckerInterface $request_type
-     */
-    private $request_type;
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @param EE_Registry|null         $registry
-     * @param LoaderInterface|null     $loader
-     * @param RequestInterface|null    $request
-     * @param EE_Maintenance_Mode|null $maintenance_mode
-     * @return EE_System
-     */
-    public static function instance(
-        EE_Registry $registry = null,
-        LoaderInterface $loader = null,
-        RequestInterface $request = null,
-        EE_Maintenance_Mode $maintenance_mode = null
-    ) {
-        // check if class object is instantiated
-        if (! self::$_instance instanceof EE_System) {
-            self::$_instance = new self($registry, $loader, $request, $maintenance_mode);
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * resets the instance and returns it
-     *
-     * @return EE_System
-     */
-    public static function reset()
-    {
-        self::$_instance->_req_type = null;
-        // make sure none of the old hooks are left hanging around
-        remove_all_actions('AHEE__EE_System__perform_activations_upgrades_and_migrations');
-        // we need to reset the migration manager in order for it to detect DMSs properly
-        EE_Data_Migration_Manager::reset();
-        self::instance()->detect_activations_or_upgrades();
-        self::instance()->perform_activations_upgrades_and_migrations();
-        return self::instance();
-    }
-
-
-    /**
-     * sets hooks for running rest of system
-     * provides "AHEE__EE_System__construct__complete" hook for EE Addons to use as their starting point
-     * starting EE Addons from any other point may lead to problems
-     *
-     * @param EE_Registry         $registry
-     * @param LoaderInterface     $loader
-     * @param RequestInterface    $request
-     * @param EE_Maintenance_Mode $maintenance_mode
-     */
-    private function __construct(
-        EE_Registry $registry,
-        LoaderInterface $loader,
-        RequestInterface $request,
-        EE_Maintenance_Mode $maintenance_mode
-    ) {
-        $this->registry = $registry;
-        $this->loader = $loader;
-        $this->request = $request;
-        $this->maintenance_mode = $maintenance_mode;
-        do_action('AHEE__EE_System__construct__begin', $this);
-        add_action(
-            'AHEE__EE_Bootstrap__load_espresso_addons',
-            array($this, 'loadCapabilities'),
-            5
-        );
-        add_action(
-            'AHEE__EE_Bootstrap__load_espresso_addons',
-            array($this, 'loadCommandBus'),
-            7
-        );
-        add_action(
-            'AHEE__EE_Bootstrap__load_espresso_addons',
-            array($this, 'loadPluginApi'),
-            9
-        );
-        // allow addons to load first so that they can register autoloaders, set hooks for running DMS's, etc
-        add_action(
-            'AHEE__EE_Bootstrap__load_espresso_addons',
-            array($this, 'load_espresso_addons')
-        );
-        // when an ee addon is activated, we want to call the core hook(s) again
-        // because the newly-activated addon didn't get a chance to run at all
-        add_action('activate_plugin', array($this, 'load_espresso_addons'), 1);
-        // detect whether install or upgrade
-        add_action(
-            'AHEE__EE_Bootstrap__detect_activations_or_upgrades',
-            array($this, 'detect_activations_or_upgrades'),
-            3
-        );
-        // load EE_Config, EE_Textdomain, etc
-        add_action(
-            'AHEE__EE_Bootstrap__load_core_configuration',
-            array($this, 'load_core_configuration'),
-            5
-        );
-        // load specifications for matching routes to current request
-        add_action(
-            'AHEE__EE_Bootstrap__load_core_configuration',
-            array($this, 'loadRouteMatchSpecifications')
-        );
-        // load EE_Config, EE_Textdomain, etc
-        add_action(
-            'AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets',
-            array($this, 'register_shortcodes_modules_and_widgets'),
-            7
-        );
-        // you wanna get going? I wanna get going... let's get going!
-        add_action(
-            'AHEE__EE_Bootstrap__brew_espresso',
-            array($this, 'brew_espresso'),
-            9
-        );
-        // other housekeeping
-        // exclude EE critical pages from wp_list_pages
-        add_filter(
-            'wp_list_pages_excludes',
-            array($this, 'remove_pages_from_wp_list_pages'),
-            10
-        );
-        // ALL EE Addons should use the following hook point to attach their initial setup too
-        // it's extremely important for EE Addons to register any class autoloaders so that they can be available when the EE_Config loads
-        do_action('AHEE__EE_System__construct__complete', $this);
-    }
-
-
-    /**
-     * load and setup EE_Capabilities
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    public function loadCapabilities()
-    {
-        $this->capabilities = $this->loader->getShared('EE_Capabilities');
-        add_action(
-            'AHEE__EE_Capabilities__init_caps__before_initialization',
-            function () {
-                LoaderFactory::getLoader()->getShared('EE_Payment_Method_Manager');
-            }
-        );
-    }
-
-
-    /**
-     * create and cache the CommandBus, and also add middleware
-     * The CapChecker middleware requires the use of EE_Capabilities
-     * which is why we need to load the CommandBus after Caps are set up
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    public function loadCommandBus()
-    {
-        $this->loader->getShared(
-            'CommandBusInterface',
-            array(
-                null,
-                apply_filters(
-                    'FHEE__EE_Load_Espresso_Core__handle_request__CommandBus_middleware',
-                    array(
-                        $this->loader->getShared('EventEspresso\core\services\commands\middleware\CapChecker'),
-                        $this->loader->getShared('EventEspresso\core\services\commands\middleware\AddActionHook'),
-                    )
-                ),
-            )
-        );
-    }
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     */
-    public function loadPluginApi()
-    {
-        // set autoloaders for all of the classes implementing EEI_Plugin_API
-        // which provide helpers for EE plugin authors to more easily register certain components with EE.
-        EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder(EE_LIBRARIES . 'plugin_api');
-    }
-
-
-    /**
-     * @param string $addon_name
-     * @param string $version_constant
-     * @param string $min_version_required
-     * @param string $load_callback
-     * @param string $plugin_file_constant
-     * @return void
-     */
-    private function deactivateIncompatibleAddon(
-        $addon_name,
-        $version_constant,
-        $min_version_required,
-        $load_callback,
-        $plugin_file_constant
-    ) {
-        if (! defined($version_constant)) {
-            return;
-        }
-        $addon_version = constant($version_constant);
-        if ($addon_version && version_compare($addon_version, $min_version_required, '<')) {
-            remove_action('AHEE__EE_System__load_espresso_addons', $load_callback);
-            if (! function_exists('deactivate_plugins')) {
-                require_once ABSPATH . 'wp-admin/includes/plugin.php';
-            }
-            deactivate_plugins(plugin_basename(constant($plugin_file_constant)));
-            $this->request->unSetRequestParams(['activate', 'activate-multi'], true);
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'We\'re sorry, but the Event Espresso %1$s addon was deactivated because version %2$s or higher is required with this version of Event Espresso core.',
-                        'event_espresso'
-                    ),
-                    $addon_name,
-                    $min_version_required
-                ),
-                __FILE__,
-                __FUNCTION__ . "({$addon_name})",
-                __LINE__
-            );
-            EE_Error::get_notices(false, true);
-        }
-    }
-
-
-    /**
-     * load_espresso_addons
-     * allow addons to load first so that they can set hooks for running DMS's, etc
-     * this is hooked into both:
-     *    'AHEE__EE_Bootstrap__load_core_configuration'
-     *        which runs during the WP 'plugins_loaded' action at priority 5
-     *    and the WP 'activate_plugin' hook point
-     *
-     * @access public
-     * @return void
-     */
-    public function load_espresso_addons()
-    {
-        $this->deactivateIncompatibleAddon(
-            'Wait Lists',
-            'EE_WAIT_LISTS_VERSION',
-            '1.0.0.beta.074',
-            'load_espresso_wait_lists',
-            'EE_WAIT_LISTS_PLUGIN_FILE'
-        );
-        $this->deactivateIncompatibleAddon(
-            'Automated Upcoming Event Notifications',
-            'EE_AUTOMATED_UPCOMING_EVENT_NOTIFICATION_VERSION',
-            '1.0.0.beta.091',
-            'load_espresso_automated_upcoming_event_notification',
-            'EE_AUTOMATED_UPCOMING_EVENT_NOTIFICATION_PLUGIN_FILE'
-        );
-        do_action('AHEE__EE_System__load_espresso_addons');
-        // if the WP API basic auth plugin isn't already loaded, load it now.
-        // We want it for mobile apps. Just include the entire plugin
-        // also, don't load the basic auth when a plugin is getting activated, because
-        // it could be the basic auth plugin, and it doesn't check if its methods are already defined
-        // and causes a fatal error
-        if (
-            ($this->request->isWordPressApi() || $this->request->isApi())
-            && $this->request->getRequestParam('activate') !== 'true'
-            && ! function_exists('json_basic_auth_handler')
-            && ! function_exists('json_basic_auth_error')
-            && ! in_array(
-                $this->request->getRequestParam('action'),
-                array('activate', 'activate-selected'),
-                true
-            )
-        ) {
-            include_once EE_THIRD_PARTY . 'wp-api-basic-auth/basic-auth.php';
-        }
-        do_action('AHEE__EE_System__load_espresso_addons__complete');
-    }
-
-
-    /**
-     * detect_activations_or_upgrades
-     * Checks for activation or upgrade of core first;
-     * then also checks if any registered addons have been activated or upgraded
-     * This is hooked into 'AHEE__EE_Bootstrap__detect_activations_or_upgrades'
-     * which runs during the WP 'plugins_loaded' action at priority 3
-     *
-     * @access public
-     * @return void
-     */
-    public function detect_activations_or_upgrades()
-    {
-        // first off: let's make sure to handle core
-        $this->detect_if_activation_or_upgrade();
-        foreach ($this->registry->addons as $addon) {
-            if ($addon instanceof EE_Addon) {
-                // detect teh request type for that addon
-                $addon->detect_req_type();
-            }
-        }
-    }
-
-
-    /**
-     * detect_if_activation_or_upgrade
-     * Takes care of detecting whether this is a brand new install or code upgrade,
-     * and either setting up the DB or setting up maintenance mode etc.
-     *
-     * @access public
-     * @return void
-     */
-    public function detect_if_activation_or_upgrade()
-    {
-        do_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin');
-        // check if db has been updated, or if its a brand-new installation
-        $espresso_db_update = $this->fix_espresso_db_upgrade_option();
-        $request_type = $this->detect_req_type($espresso_db_update);
-        // EEH_Debug_Tools::printr( $request_type, '$request_type', __FILE__, __LINE__ );
-        switch ($request_type) {
-            case EE_System::req_type_new_activation:
-                do_action('AHEE__EE_System__detect_if_activation_or_upgrade__new_activation');
-                $this->_handle_core_version_change($espresso_db_update);
-                break;
-            case EE_System::req_type_reactivation:
-                do_action('AHEE__EE_System__detect_if_activation_or_upgrade__reactivation');
-                $this->_handle_core_version_change($espresso_db_update);
-                break;
-            case EE_System::req_type_upgrade:
-                do_action('AHEE__EE_System__detect_if_activation_or_upgrade__upgrade');
-                // migrations may be required now that we've upgraded
-                $this->maintenance_mode->set_maintenance_mode_if_db_old();
-                $this->_handle_core_version_change($espresso_db_update);
-                break;
-            case EE_System::req_type_downgrade:
-                do_action('AHEE__EE_System__detect_if_activation_or_upgrade__downgrade');
-                // its possible migrations are no longer required
-                $this->maintenance_mode->set_maintenance_mode_if_db_old();
-                $this->_handle_core_version_change($espresso_db_update);
-                break;
-            case EE_System::req_type_normal:
-            default:
-                break;
-        }
-        do_action('AHEE__EE_System__detect_if_activation_or_upgrade__complete');
-    }
-
-
-    /**
-     * Updates the list of installed versions and sets hooks for
-     * initializing the database later during the request
-     *
-     * @param array $espresso_db_update
-     */
-    private function _handle_core_version_change($espresso_db_update)
-    {
-        $this->update_list_of_installed_versions($espresso_db_update);
-        // get ready to verify the DB is ok (provided we aren't in maintenance mode, of course)
-        add_action(
-            'AHEE__EE_System__perform_activations_upgrades_and_migrations',
-            array($this, 'initialize_db_if_no_migrations_required')
-        );
-    }
-
-
-    /**
-     * standardizes the wp option 'espresso_db_upgrade' which actually stores
-     * information about what versions of EE have been installed and activated,
-     * NOT necessarily the state of the database
-     *
-     * @param mixed $espresso_db_update           the value of the WordPress option.
-     *                                            If not supplied, fetches it from the options table
-     * @return array the correct value of 'espresso_db_upgrade', after saving it, if it needed correction
-     */
-    private function fix_espresso_db_upgrade_option($espresso_db_update = null)
-    {
-        do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__begin', $espresso_db_update);
-        if (! $espresso_db_update) {
-            $espresso_db_update = get_option('espresso_db_update');
-        }
-        // check that option is an array
-        if (! is_array($espresso_db_update)) {
-            // if option is FALSE, then it never existed
-            if ($espresso_db_update === false) {
-                // make $espresso_db_update an array and save option with autoload OFF
-                $espresso_db_update = array();
-                add_option('espresso_db_update', $espresso_db_update, '', 'no');
-            } else {
-                // option is NOT FALSE but also is NOT an array, so make it an array and save it
-                $espresso_db_update = array($espresso_db_update => array());
-                update_option('espresso_db_update', $espresso_db_update);
-            }
-        } else {
-            $corrected_db_update = array();
-            // if IS an array, but is it an array where KEYS are version numbers, and values are arrays?
-            foreach ($espresso_db_update as $should_be_version_string => $should_be_array) {
-                if (is_int($should_be_version_string) && ! is_array($should_be_array)) {
-                    // the key is an int, and the value IS NOT an array
-                    // so it must be numerically-indexed, where values are versions installed...
-                    // fix it!
-                    $version_string = $should_be_array;
-                    $corrected_db_update[ $version_string ] = array('unknown-date');
-                } else {
-                    // ok it checks out
-                    $corrected_db_update[ $should_be_version_string ] = $should_be_array;
-                }
-            }
-            $espresso_db_update = $corrected_db_update;
-            update_option('espresso_db_update', $espresso_db_update);
-        }
-        do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__complete', $espresso_db_update);
-        return $espresso_db_update;
-    }
-
-
-    /**
-     * Does the traditional work of setting up the plugin's database and adding default data.
-     * If migration script/process did not exist, this is what would happen on every activation/reactivation/upgrade.
-     * NOTE: if we're in maintenance mode (which would be the case if we detect there are data
-     * migration scripts that need to be run and a version change happens), enqueues core for database initialization,
-     * so that it will be done when migrations are finished
-     *
-     * @param boolean $initialize_addons_too if true, we double-check addons' database tables etc too;
-     * @param boolean $verify_schema         if true will re-check the database tables have the correct schema.
-     *                                       This is a resource-intensive job
-     *                                       so we prefer to only do it when necessary
-     * @return void
-     * @throws EE_Error
-     */
-    public function initialize_db_if_no_migrations_required($initialize_addons_too = false, $verify_schema = true)
-    {
-        $request_type = $this->detect_req_type();
-        // only initialize system if we're not in maintenance mode.
-        if ($this->maintenance_mode->level() !== EE_Maintenance_Mode::level_2_complete_maintenance) {
-            /** @var EventEspresso\core\domain\services\custom_post_types\RewriteRules $rewrite_rules */
-            $rewrite_rules = $this->loader->getShared(
-                'EventEspresso\core\domain\services\custom_post_types\RewriteRules'
-            );
-            $rewrite_rules->flush();
-            if ($verify_schema) {
-                EEH_Activation::initialize_db_and_folders();
-            }
-            EEH_Activation::initialize_db_content();
-            EEH_Activation::system_initialization();
-            if ($initialize_addons_too) {
-                $this->initialize_addons();
-            }
-        } else {
-            EE_Data_Migration_Manager::instance()->enqueue_db_initialization_for('Core');
-        }
-        if (
-            $request_type === EE_System::req_type_new_activation
-            || $request_type === EE_System::req_type_reactivation
-            || (
-                $request_type === EE_System::req_type_upgrade
-                && $this->is_major_version_change()
-            )
-        ) {
-            add_action('AHEE__EE_System__initialize_last', array($this, 'redirect_to_about_ee'), 9);
-        }
-    }
-
-
-    /**
-     * Initializes the db for all registered addons
-     *
-     * @throws EE_Error
-     */
-    public function initialize_addons()
-    {
-        // foreach registered addon, make sure its db is up-to-date too
-        foreach ($this->registry->addons as $addon) {
-            if ($addon instanceof EE_Addon) {
-                $addon->initialize_db_if_no_migrations_required();
-            }
-        }
-    }
-
-
-    /**
-     * Adds the current code version to the saved wp option which stores a list of all ee versions ever installed.
-     *
-     * @param    array  $version_history
-     * @param    string $current_version_to_add version to be added to the version history
-     * @return    boolean success as to whether or not this option was changed
-     */
-    public function update_list_of_installed_versions($version_history = null, $current_version_to_add = null)
-    {
-        if (! $version_history) {
-            $version_history = $this->fix_espresso_db_upgrade_option($version_history);
-        }
-        if ($current_version_to_add === null) {
-            $current_version_to_add = espresso_version();
-        }
-        $version_history[ $current_version_to_add ][] = date('Y-m-d H:i:s', time());
-        // re-save
-        return update_option('espresso_db_update', $version_history);
-    }
-
-
-    /**
-     * Detects if the current version indicated in the has existed in the list of
-     * previously-installed versions of EE (espresso_db_update). Does NOT modify it (ie, no side-effect)
-     *
-     * @param array $espresso_db_update array from the wp option stored under the name 'espresso_db_update'.
-     *                                  If not supplied, fetches it from the options table.
-     *                                  Also, caches its result so later parts of the code can also know whether
-     *                                  there's been an update or not. This way we can add the current version to
-     *                                  espresso_db_update, but still know if this is a new install or not
-     * @return int one of the constants on EE_System::req_type_
-     */
-    public function detect_req_type($espresso_db_update = null)
-    {
-        if ($this->_req_type === null) {
-            $espresso_db_update = ! empty($espresso_db_update)
-                ? $espresso_db_update
-                : $this->fix_espresso_db_upgrade_option();
-            $this->_req_type = EE_System::detect_req_type_given_activation_history(
-                $espresso_db_update,
-                'ee_espresso_activation',
-                espresso_version()
-            );
-            $this->_major_version_change = $this->_detect_major_version_change($espresso_db_update);
-            $this->request->setIsActivation($this->_req_type !== EE_System::req_type_normal);
-        }
-        return $this->_req_type;
-    }
-
-
-    /**
-     * Returns whether or not there was a non-micro version change (ie, change in either
-     * the first or second number in the version. Eg 4.9.0.rc.001 to 4.10.0.rc.000,
-     * but not 4.9.0.rc.0001 to 4.9.1.rc.0001
-     *
-     * @param $activation_history
-     * @return bool
-     */
-    private function _detect_major_version_change($activation_history)
-    {
-        $previous_version = EE_System::_get_most_recently_active_version_from_activation_history($activation_history);
-        $previous_version_parts = explode('.', $previous_version);
-        $current_version_parts = explode('.', espresso_version());
-        return isset($previous_version_parts[0], $previous_version_parts[1], $current_version_parts[0], $current_version_parts[1])
-               && ($previous_version_parts[0] !== $current_version_parts[0]
-                   || $previous_version_parts[1] !== $current_version_parts[1]
-               );
-    }
-
-
-    /**
-     * Returns true if either the major or minor version of EE changed during this request.
-     * Eg 4.9.0.rc.001 to 4.10.0.rc.000, but not 4.9.0.rc.0001 to 4.9.1.rc.0001
-     *
-     * @return bool
-     */
-    public function is_major_version_change()
-    {
-        return $this->_major_version_change;
-    }
-
-
-    /**
-     * Determines the request type for any ee addon, given three piece of info: the current array of activation
-     * histories (for core that' 'espresso_db_update' wp option); the name of the WordPress option which is temporarily
-     * set upon activation of the plugin (for core it's 'ee_espresso_activation'); and the version that this plugin was
-     * just activated to (for core that will always be espresso_version())
-     *
-     * @param array  $activation_history_for_addon     the option's value which stores the activation history for this
-     *                                                 ee plugin. for core that's 'espresso_db_update'
-     * @param string $activation_indicator_option_name the name of the WordPress option that is temporarily set to
-     *                                                 indicate that this plugin was just activated
-     * @param string $version_to_upgrade_to            the version that was just upgraded to (for core that will be
-     *                                                 espresso_version())
-     * @return int one of the constants on EE_System::req_type_*
-     */
-    public static function detect_req_type_given_activation_history(
-        $activation_history_for_addon,
-        $activation_indicator_option_name,
-        $version_to_upgrade_to
-    ) {
-        $version_is_higher = self::_new_version_is_higher($activation_history_for_addon, $version_to_upgrade_to);
-        if ($activation_history_for_addon) {
-            // it exists, so this isn't a completely new install
-            // check if this version already in that list of previously installed versions
-            if (! isset($activation_history_for_addon[ $version_to_upgrade_to ])) {
-                // it a version we haven't seen before
-                if ($version_is_higher === 1) {
-                    $req_type = EE_System::req_type_upgrade;
-                } else {
-                    $req_type = EE_System::req_type_downgrade;
-                }
-                delete_option($activation_indicator_option_name);
-            } else {
-                // its not an update. maybe a reactivation?
-                if (get_option($activation_indicator_option_name, false)) {
-                    if ($version_is_higher === -1) {
-                        $req_type = EE_System::req_type_downgrade;
-                    } elseif ($version_is_higher === 0) {
-                        // we've seen this version before, but it's an activation. must be a reactivation
-                        $req_type = EE_System::req_type_reactivation;
-                    } else {// $version_is_higher === 1
-                        $req_type = EE_System::req_type_upgrade;
-                    }
-                    delete_option($activation_indicator_option_name);
-                } else {
-                    // we've seen this version before and the activation indicate doesn't show it was just activated
-                    if ($version_is_higher === -1) {
-                        $req_type = EE_System::req_type_downgrade;
-                    } elseif ($version_is_higher === 0) {
-                        // we've seen this version before and it's not an activation. its normal request
-                        $req_type = EE_System::req_type_normal;
-                    } else {// $version_is_higher === 1
-                        $req_type = EE_System::req_type_upgrade;
-                    }
-                }
-            }
-        } else {
-            // brand new install
-            $req_type = EE_System::req_type_new_activation;
-            delete_option($activation_indicator_option_name);
-        }
-        return $req_type;
-    }
-
-
-    /**
-     * Detects if the $version_to_upgrade_to is higher than the most recent version in
-     * the $activation_history_for_addon
-     *
-     * @param array  $activation_history_for_addon (keys are versions, values are arrays of times activated,
-     *                                             sometimes containing 'unknown-date'
-     * @param string $version_to_upgrade_to        (current version)
-     * @return int results of version_compare( $version_to_upgrade_to, $most_recently_active_version ).
-     *                                             ie, -1 if $version_to_upgrade_to is LOWER (downgrade);
-     *                                             0 if $version_to_upgrade_to MATCHES (reactivation or normal request);
-     *                                             1 if $version_to_upgrade_to is HIGHER (upgrade) ;
-     */
-    private static function _new_version_is_higher($activation_history_for_addon, $version_to_upgrade_to)
-    {
-        // find the most recently-activated version
-        $most_recently_active_version =
-            EE_System::_get_most_recently_active_version_from_activation_history($activation_history_for_addon);
-        return version_compare($version_to_upgrade_to, $most_recently_active_version);
-    }
-
-
-    /**
-     * Gets the most recently active version listed in the activation history,
-     * and if none are found (ie, it's a brand new install) returns '0.0.0.dev.000'.
-     *
-     * @param array $activation_history  (keys are versions, values are arrays of times activated,
-     *                                   sometimes containing 'unknown-date'
-     * @return string
-     */
-    private static function _get_most_recently_active_version_from_activation_history($activation_history)
-    {
-        $most_recently_active_version_activation = '1970-01-01 00:00:00';
-        $most_recently_active_version = '0.0.0.dev.000';
-        if (is_array($activation_history)) {
-            foreach ($activation_history as $version => $times_activated) {
-                // check there is a record of when this version was activated. Otherwise,
-                // mark it as unknown
-                if (! $times_activated) {
-                    $times_activated = array('unknown-date');
-                }
-                if (is_string($times_activated)) {
-                    $times_activated = array($times_activated);
-                }
-                foreach ($times_activated as $an_activation) {
-                    if (
-                        $an_activation !== 'unknown-date'
-                        && $an_activation
-                           > $most_recently_active_version_activation
-                    ) {
-                        $most_recently_active_version = $version;
-                        $most_recently_active_version_activation = $an_activation === 'unknown-date'
-                            ? '1970-01-01 00:00:00'
-                            : $an_activation;
-                    }
-                }
-            }
-        }
-        return $most_recently_active_version;
-    }
-
-
-    /**
-     * This redirects to the about EE page after activation
-     *
-     * @return void
-     */
-    public function redirect_to_about_ee()
-    {
-        $notices = EE_Error::get_notices(false);
-        // if current user is an admin and it's not an ajax or rest request
-        if (
-            ! isset($notices['errors'])
-            && $this->request->isAdmin()
-            && apply_filters(
-                'FHEE__EE_System__redirect_to_about_ee__do_redirect',
-                $this->capabilities->current_user_can('manage_options', 'espresso_about_default')
-            )
-        ) {
-            $query_params = array('page' => 'espresso_about');
-            if (EE_System::instance()->detect_req_type() === EE_System::req_type_new_activation) {
-                $query_params['new_activation'] = true;
-            }
-            if (EE_System::instance()->detect_req_type() === EE_System::req_type_reactivation) {
-                $query_params['reactivation'] = true;
-            }
-            $url = add_query_arg($query_params, admin_url('admin.php'));
-            wp_safe_redirect($url);
-            exit();
-        }
-    }
-
-
-    /**
-     * load_core_configuration
-     * this is hooked into 'AHEE__EE_Bootstrap__load_core_configuration'
-     * which runs during the WP 'plugins_loaded' action at priority 5
-     *
-     * @return void
-     * @throws ReflectionException
-     * @throws Exception
-     */
-    public function load_core_configuration()
-    {
-        do_action('AHEE__EE_System__load_core_configuration__begin', $this);
-        $this->loader->getShared('EE_Load_Textdomain');
-        // load textdomain
-        EE_Load_Textdomain::load_textdomain();
-        // load caf stuff a chance to play during the activation process too.
-        $this->_maybe_brew_regular();
-        // load and setup EE_Config and EE_Network_Config
-        $config = $this->loader->getShared('EE_Config');
-        $this->loader->getShared('EE_Network_Config');
-        // setup autoloaders
-        // enable logging?
-        if ($config->admin->use_remote_logging) {
-            $this->loader->getShared('EE_Log');
-        }
-        // check for activation errors
-        $activation_errors = get_option('ee_plugin_activation_errors', false);
-        if ($activation_errors) {
-            EE_Error::add_error($activation_errors, __FILE__, __FUNCTION__, __LINE__);
-            update_option('ee_plugin_activation_errors', false);
-        }
-        // get model names
-        $this->_parse_model_names();
-        // configure custom post type definitions
-        $this->loader->getShared('EventEspresso\core\domain\entities\custom_post_types\CustomTaxonomyDefinitions');
-        $this->loader->getShared('EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions');
-        do_action('AHEE__EE_System__load_core_configuration__complete', $this);
-    }
-
-
-    /**
-     * cycles through all of the models/*.model.php files, and assembles an array of model names
-     *
-     * @return void
-     * @throws ReflectionException
-     */
-    private function _parse_model_names()
-    {
-        // get all the files in the EE_MODELS folder that end in .model.php
-        $models = glob(EE_MODELS . '*.model.php');
-        $model_names = array();
-        $non_abstract_db_models = array();
-        foreach ($models as $model) {
-            // get model classname
-            $classname = EEH_File::get_classname_from_filepath_with_standard_filename($model);
-            $short_name = str_replace('EEM_', '', $classname);
-            $reflectionClass = new ReflectionClass($classname);
-            if ($reflectionClass->isSubclassOf('EEM_Base') && ! $reflectionClass->isAbstract()) {
-                $non_abstract_db_models[ $short_name ] = $classname;
-            }
-            $model_names[ $short_name ] = $classname;
-        }
-        $this->registry->models = apply_filters('FHEE__EE_System__parse_model_names', $model_names);
-        $this->registry->non_abstract_db_models = apply_filters(
-            'FHEE__EE_System__parse_implemented_model_names',
-            $non_abstract_db_models
-        );
-    }
-
-
-    /**
-     * The purpose of this method is to simply check for a file named "caffeinated/brewing_regular.php" for any hooks
-     * that need to be setup before our EE_System launches.
-     *
-     * @return void
-     * @throws DomainException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidClassException
-     * @throws InvalidFilePathException
-     */
-    private function _maybe_brew_regular()
-    {
-        /** @var Domain $domain */
-        $domain = DomainFactory::getShared(
-            new FullyQualifiedName(
-                'EventEspresso\core\domain\Domain'
-            ),
-            array(
-                new FilePath(EVENT_ESPRESSO_MAIN_FILE),
-                Version::fromString(espresso_version()),
-            )
-        );
-        if ($domain->isCaffeinated()) {
-            require_once EE_CAFF_PATH . 'brewing_regular.php';
-        }
-    }
-
-
-    /**
-     * @since 4.9.71.p
-     * @throws Exception
-     */
-    public function loadRouteMatchSpecifications()
-    {
-        try {
-            $this->loader->getShared(
-                'EventEspresso\core\services\route_match\RouteMatchSpecificationManager'
-            );
-        } catch (Exception $exception) {
-            new ExceptionStackTraceDisplay($exception);
-        }
-        do_action('AHEE__EE_System__loadRouteMatchSpecifications');
-    }
-
-
-    /**
-     * register_shortcodes_modules_and_widgets
-     * generate lists of shortcodes and modules, then verify paths and classes
-     * This is hooked into 'AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets'
-     * which runs during the WP 'plugins_loaded' action at priority 7
-     *
-     * @access public
-     * @return void
-     * @throws Exception
-     */
-    public function register_shortcodes_modules_and_widgets()
-    {
-        if ($this->request->isFrontend() || $this->request->isIframe() || $this->request->isAjax()) {
-            // load, register, and add shortcodes the new way
-            $this->loader->getShared('EventEspresso\core\services\shortcodes\ShortcodesManager');
-        }
-        do_action('AHEE__EE_System__register_shortcodes_modules_and_widgets');
-        // check for addons using old hook point
-        if (has_action('AHEE__EE_System__register_shortcodes_modules_and_addons')) {
-            $this->_incompatible_addon_error();
-        }
-    }
-
-
-    /**
-     * _incompatible_addon_error
-     *
-     * @access public
-     * @return void
-     */
-    private function _incompatible_addon_error()
-    {
-        // get array of classes hooking into here
-        $class_names = EEH_Class_Tools::get_class_names_for_all_callbacks_on_hook(
-            'AHEE__EE_System__register_shortcodes_modules_and_addons'
-        );
-        if (! empty($class_names)) {
-            $msg = esc_html__(
-                'The following plugins, addons, or modules appear to be incompatible with this version of Event Espresso and were automatically deactivated to avoid fatal errors:',
-                'event_espresso'
-            );
-            $msg .= '<ul>';
-            foreach ($class_names as $class_name) {
-                $msg .= '<li><b>Event Espresso - '
-                        . str_replace(
-                            array('EE_', 'EEM_', 'EED_', 'EES_', 'EEW_'),
-                            '',
-                            $class_name
-                        ) . '</b></li>';
-            }
-            $msg .= '</ul>';
-            $msg .= esc_html__(
-                'Compatibility issues can be avoided and/or resolved by keeping addons and plugins updated to the latest version.',
-                'event_espresso'
-            );
-            // save list of incompatible addons to wp-options for later use
-            add_option('ee_incompatible_addons', $class_names, '', 'no');
-            if (is_admin()) {
-                EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            }
-        }
-    }
-
-
-    /**
-     * brew_espresso
-     * begins the process of setting hooks for initializing EE in the correct order
-     * This is happening on the 'AHEE__EE_Bootstrap__brew_espresso' hook point
-     * which runs during the WP 'plugins_loaded' action at priority 9
-     *
-     * @return void
-     */
-    public function brew_espresso()
-    {
-        do_action('AHEE__EE_System__brew_espresso__begin', $this);
-        // load some final core systems
-        add_action('init', array($this, 'set_hooks_for_core'), 1);
-        add_action('init', array($this, 'perform_activations_upgrades_and_migrations'), 3);
-        add_action('init', array($this, 'load_CPTs_and_session'), 5);
-        add_action('init', array($this, 'load_controllers'), 7);
-        add_action('init', array($this, 'core_loaded_and_ready'), 9);
-        add_action('init', array($this, 'initialize'), 10);
-        add_action('init', array($this, 'initialize_last'), 100);
-        if (is_admin() && apply_filters('FHEE__EE_System__brew_espresso__load_pue', true)) {
-            // pew pew pew
-            $this->loader->getShared('EventEspresso\core\services\licensing\LicenseService');
-            do_action('AHEE__EE_System__brew_espresso__after_pue_init');
-        }
-        do_action('AHEE__EE_System__brew_espresso__complete', $this);
-    }
-
-
-    /**
-     *    set_hooks_for_core
-     *
-     * @access public
-     * @return    void
-     * @throws EE_Error
-     */
-    public function set_hooks_for_core()
-    {
-        $this->_deactivate_incompatible_addons();
-        do_action('AHEE__EE_System__set_hooks_for_core');
-        $this->loader->getShared('EventEspresso\core\domain\values\session\SessionLifespan');
-        // caps need to be initialized on every request so that capability maps are set.
-        // @see https://events.codebasehq.com/projects/event-espresso/tickets/8674
-        $this->registry->CAP->init_caps();
-    }
-
-
-    /**
-     * Using the information gathered in EE_System::_incompatible_addon_error,
-     * deactivates any addons considered incompatible with the current version of EE
-     */
-    private function _deactivate_incompatible_addons()
-    {
-        $incompatible_addons = get_option('ee_incompatible_addons', array());
-        if (! empty($incompatible_addons)) {
-            $active_plugins = get_option('active_plugins', array());
-            foreach ($active_plugins as $active_plugin) {
-                foreach ($incompatible_addons as $incompatible_addon) {
-                    if (strpos($active_plugin, $incompatible_addon) !== false) {
-                        $this->request->unSetRequestParams(['activate'], true);
-                        espresso_deactivate_plugin($active_plugin);
-                    }
-                }
-            }
-        }
-    }
-
-
-    /**
-     *    perform_activations_upgrades_and_migrations
-     *
-     * @access public
-     * @return    void
-     */
-    public function perform_activations_upgrades_and_migrations()
-    {
-        do_action('AHEE__EE_System__perform_activations_upgrades_and_migrations');
-    }
-
-
-    /**
-     * @return void
-     * @throws DomainException
-     */
-    public function load_CPTs_and_session()
-    {
-        do_action('AHEE__EE_System__load_CPTs_and_session__start');
-        /** @var EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomies $register_custom_taxonomies */
-        $register_custom_taxonomies = $this->loader->getShared(
-            'EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomies'
-        );
-        $register_custom_taxonomies->registerCustomTaxonomies();
-        /** @var EventEspresso\core\domain\services\custom_post_types\RegisterCustomPostTypes $register_custom_post_types */
-        $register_custom_post_types = $this->loader->getShared(
-            'EventEspresso\core\domain\services\custom_post_types\RegisterCustomPostTypes'
-        );
-        $register_custom_post_types->registerCustomPostTypes();
-        /** @var EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomyTerms $register_custom_taxonomy_terms */
-        $register_custom_taxonomy_terms = $this->loader->getShared(
-            'EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomyTerms'
-        );
-        $register_custom_taxonomy_terms->registerCustomTaxonomyTerms();
-        // load legacy Custom Post Types and Taxonomies
-        $this->loader->getShared('EE_Register_CPTs');
-        do_action('AHEE__EE_System__load_CPTs_and_session__complete');
-    }
-
-
-    /**
-     * load_controllers
-     * this is the best place to load any additional controllers that needs access to EE core.
-     * it is expected that all basic core EE systems, that are not dependant on the current request are loaded at this
-     * time
-     *
-     * @access public
-     * @return void
-     */
-    public function load_controllers()
-    {
-        do_action('AHEE__EE_System__load_controllers__start');
-        // let's get it started
-        if (
-            ! $this->maintenance_mode->level()
-            && ($this->request->isFrontend() || $this->request->isFrontAjax())
-        ) {
-            do_action('AHEE__EE_System__load_controllers__load_front_controllers');
-            $this->loader->getShared('EE_Front_Controller');
-        } elseif ($this->request->isAdmin() || $this->request->isAdminAjax()) {
-            do_action('AHEE__EE_System__load_controllers__load_admin_controllers');
-            $this->loader->getShared('EE_Admin');
-        } elseif ($this->request->isWordPressHeartbeat()) {
-            $this->loader->getShared('EventEspresso\core\domain\services\admin\ajax\WordpressHeartbeat');
-        }
-        do_action('AHEE__EE_System__load_controllers__complete');
-    }
-
-
-    /**
-     * core_loaded_and_ready
-     * all of the basic EE core should be loaded at this point and available regardless of M-Mode
-     *
-     * @access public
-     * @return void
-     * @throws Exception
-     */
-    public function core_loaded_and_ready()
-    {
-        if (
-            $this->request->isAdmin()
-            || $this->request->isFrontend()
-            || $this->request->isIframe()
-            || $this->request->isWordPressApi()
-        ) {
-            try {
-                $this->loader->getShared('EventEspresso\core\services\assets\Registry');
-                $this->loader->getShared('EventEspresso\core\domain\services\assets\CoreAssetManager');
-                if ($this->canLoadBlocks()) {
-                    $this->loader->getShared(
-                        'EventEspresso\core\services\editor\BlockRegistrationManager'
-                    );
-                }
-            } catch (Exception $exception) {
-                new ExceptionStackTraceDisplay($exception);
-            }
-        }
-        if (
-            $this->request->isAdmin()
-            || $this->request->isEeAjax()
-            || $this->request->isFrontend()
-        ) {
-            $this->loader->getShared('EE_Session');
-        }
-        // integrate WP_Query with the EE models
-        $this->loader->getShared('EE_CPT_Strategy');
-        // load legacy EE_Request_Handler in case add-ons still need it
-        $this->loader->getShared('EE_Request_Handler');
-        do_action('AHEE__EE_System__core_loaded_and_ready');
-        // always load template tags, because it's faster than checking if it's a front-end request, and many page
-        // builders require these even on the front-end
-        require_once EE_PUBLIC . 'template_tags.php';
-        do_action('AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons');
-    }
-
-
-    /**
-     * initialize
-     * this is the best place to begin initializing client code
-     *
-     * @access public
-     * @return void
-     */
-    public function initialize()
-    {
-        do_action('AHEE__EE_System__initialize');
-    }
-
-
-    /**
-     * initialize_last
-     * this is run really late during the WP init hook point, and ensures that mostly everything else that needs to
-     * initialize has done so
-     *
-     * @access public
-     * @return void
-     */
-    public function initialize_last()
-    {
-        do_action('AHEE__EE_System__initialize_last');
-        /** @var EventEspresso\core\domain\services\custom_post_types\RewriteRules $rewrite_rules */
-        $rewrite_rules = $this->loader->getShared(
-            'EventEspresso\core\domain\services\custom_post_types\RewriteRules'
-        );
-        $rewrite_rules->flushRewriteRules();
-        add_action('admin_bar_init', array($this, 'addEspressoToolbar'));
-        if (
-            ($this->request->isAjax() || $this->request->isAdmin())
-            && $this->maintenance_mode->models_can_query()
-        ) {
-            $this->loader->getShared('EventEspresso\core\services\privacy\export\PersonalDataExporterManager');
-            $this->loader->getShared('EventEspresso\core\services\privacy\erasure\PersonalDataEraserManager');
-        }
-    }
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     */
-    public function addEspressoToolbar()
-    {
-        $this->loader->getShared(
-            'EventEspresso\core\domain\services\admin\AdminToolBar',
-            array($this->registry->CAP)
-        );
-    }
-
-
-    /**
-     * do_not_cache
-     * sets no cache headers and defines no cache constants for WP plugins
-     *
-     * @access public
-     * @return void
-     */
-    public static function do_not_cache()
-    {
-        // set no cache constants
-        if (! defined('DONOTCACHEPAGE')) {
-            define('DONOTCACHEPAGE', true);
-        }
-        if (! defined('DONOTCACHCEOBJECT')) {
-            define('DONOTCACHCEOBJECT', true);
-        }
-        if (! defined('DONOTCACHEDB')) {
-            define('DONOTCACHEDB', true);
-        }
-        // add no cache headers
-        add_action('send_headers', array('EE_System', 'nocache_headers'), 10);
-        // plus a little extra for nginx and Google Chrome
-        add_filter('nocache_headers', array('EE_System', 'extra_nocache_headers'), 10, 1);
-        // prevent browsers from prefetching of the rel='next' link, because it may contain content that interferes with the registration process
-        remove_action('wp_head', 'adjacent_posts_rel_link_wp_head');
-    }
-
-
-    /**
-     *    extra_nocache_headers
-     *
-     * @access    public
-     * @param $headers
-     * @return    array
-     */
-    public static function extra_nocache_headers($headers)
-    {
-        // for NGINX
-        $headers['X-Accel-Expires'] = 0;
-        // plus extra for Google Chrome since it doesn't seem to respect "no-cache", but WILL respect "no-store"
-        $headers['Cache-Control'] = 'no-store, no-cache, must-revalidate, max-age=0';
-        return $headers;
-    }
-
-
-    /**
-     *    nocache_headers
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function nocache_headers()
-    {
-        nocache_headers();
-    }
-
-
-    /**
-     * simply hooks into "wp_list_pages_exclude" filter (for wp_list_pages method) and makes sure EE critical pages are
-     * never returned with the function.
-     *
-     * @param  array $exclude_array any existing pages being excluded are in this array.
-     * @return array
-     */
-    public function remove_pages_from_wp_list_pages($exclude_array)
-    {
-        return array_merge($exclude_array, $this->registry->CFG->core->get_critical_pages_array());
-    }
-
-
-    /**
-     * Return whether blocks can be registered/loaded or not.
-     * @return bool
-     */
-    private function canLoadBlocks()
-    {
-        return apply_filters('FHEE__EE_System__canLoadBlocks', true)
-               && function_exists('register_block_type')
-               // don't load blocks if in the Divi page builder editor context
-               // @see https://github.com/eventespresso/event-espresso-core/issues/814
-               && ! $this->request->getRequestParam('et_fb', false);
-    }
+	/**
+	 * indicates this is a 'normal' request. Ie, not activation, nor upgrade, nor activation.
+	 * So examples of this would be a normal GET request on the frontend or backend, or a POST, etc
+	 */
+	const req_type_normal = 0;
+
+	/**
+	 * Indicates this is a brand new installation of EE so we should install
+	 * tables and default data etc
+	 */
+	const req_type_new_activation = 1;
+
+	/**
+	 * we've detected that EE has been reactivated (or EE was activated during maintenance mode,
+	 * and we just exited maintenance mode). We MUST check the database is setup properly
+	 * and that default data is setup too
+	 */
+	const req_type_reactivation = 2;
+
+	/**
+	 * indicates that EE has been upgraded since its previous request.
+	 * We may have data migration scripts to call and will want to trigger maintenance mode
+	 */
+	const req_type_upgrade = 3;
+
+	/**
+	 * TODO  will detect that EE has been DOWNGRADED. We probably don't want to run in this case...
+	 */
+	const req_type_downgrade = 4;
+
+	/**
+	 * @deprecated since version 4.6.0.dev.006
+	 * Now whenever a new_activation is detected the request type is still just
+	 * new_activation (same for reactivation, upgrade, downgrade etc), but if we'r ein maintenance mode
+	 * EE_System::initialize_db_if_no_migrations_required and EE_Addon::initialize_db_if_no_migrations_required
+	 * will instead enqueue that EE plugin's db initialization for when we're taken out of maintenance mode.
+	 * (Specifically, when the migration manager indicates migrations are finished
+	 * EE_Data_Migration_Manager::initialize_db_for_enqueued_ee_plugins() will be called)
+	 */
+	const req_type_activation_but_not_installed = 5;
+
+	/**
+	 * option prefix for recording the activation history (like core's "espresso_db_update") of addons
+	 */
+	const addon_activation_history_option_prefix = 'ee_addon_activation_history_';
+
+	/**
+	 * @var EE_System $_instance
+	 */
+	private static $_instance;
+
+	/**
+	 * @var EE_Registry $registry
+	 */
+	private $registry;
+
+	/**
+	 * @var LoaderInterface $loader
+	 */
+	private $loader;
+
+	/**
+	 * @var EE_Capabilities $capabilities
+	 */
+	private $capabilities;
+
+	/**
+	 * @var RequestInterface $request
+	 */
+	private $request;
+
+	/**
+	 * @var EE_Maintenance_Mode $maintenance_mode
+	 */
+	private $maintenance_mode;
+
+	/**
+	 * Stores which type of request this is, options being one of the constants on EE_System starting with req_type_*.
+	 * It can be a brand-new activation, a reactivation, an upgrade, a downgrade, or a normal request.
+	 *
+	 * @var int $_req_type
+	 */
+	private $_req_type;
+
+	/**
+	 * Whether or not there was a non-micro version change in EE core version during this request
+	 *
+	 * @var boolean $_major_version_change
+	 */
+	private $_major_version_change = false;
+
+	/**
+	 * A Context DTO dedicated solely to identifying the current request type.
+	 *
+	 * @var RequestTypeContextCheckerInterface $request_type
+	 */
+	private $request_type;
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @param EE_Registry|null         $registry
+	 * @param LoaderInterface|null     $loader
+	 * @param RequestInterface|null    $request
+	 * @param EE_Maintenance_Mode|null $maintenance_mode
+	 * @return EE_System
+	 */
+	public static function instance(
+		EE_Registry $registry = null,
+		LoaderInterface $loader = null,
+		RequestInterface $request = null,
+		EE_Maintenance_Mode $maintenance_mode = null
+	) {
+		// check if class object is instantiated
+		if (! self::$_instance instanceof EE_System) {
+			self::$_instance = new self($registry, $loader, $request, $maintenance_mode);
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * resets the instance and returns it
+	 *
+	 * @return EE_System
+	 */
+	public static function reset()
+	{
+		self::$_instance->_req_type = null;
+		// make sure none of the old hooks are left hanging around
+		remove_all_actions('AHEE__EE_System__perform_activations_upgrades_and_migrations');
+		// we need to reset the migration manager in order for it to detect DMSs properly
+		EE_Data_Migration_Manager::reset();
+		self::instance()->detect_activations_or_upgrades();
+		self::instance()->perform_activations_upgrades_and_migrations();
+		return self::instance();
+	}
+
+
+	/**
+	 * sets hooks for running rest of system
+	 * provides "AHEE__EE_System__construct__complete" hook for EE Addons to use as their starting point
+	 * starting EE Addons from any other point may lead to problems
+	 *
+	 * @param EE_Registry         $registry
+	 * @param LoaderInterface     $loader
+	 * @param RequestInterface    $request
+	 * @param EE_Maintenance_Mode $maintenance_mode
+	 */
+	private function __construct(
+		EE_Registry $registry,
+		LoaderInterface $loader,
+		RequestInterface $request,
+		EE_Maintenance_Mode $maintenance_mode
+	) {
+		$this->registry = $registry;
+		$this->loader = $loader;
+		$this->request = $request;
+		$this->maintenance_mode = $maintenance_mode;
+		do_action('AHEE__EE_System__construct__begin', $this);
+		add_action(
+			'AHEE__EE_Bootstrap__load_espresso_addons',
+			array($this, 'loadCapabilities'),
+			5
+		);
+		add_action(
+			'AHEE__EE_Bootstrap__load_espresso_addons',
+			array($this, 'loadCommandBus'),
+			7
+		);
+		add_action(
+			'AHEE__EE_Bootstrap__load_espresso_addons',
+			array($this, 'loadPluginApi'),
+			9
+		);
+		// allow addons to load first so that they can register autoloaders, set hooks for running DMS's, etc
+		add_action(
+			'AHEE__EE_Bootstrap__load_espresso_addons',
+			array($this, 'load_espresso_addons')
+		);
+		// when an ee addon is activated, we want to call the core hook(s) again
+		// because the newly-activated addon didn't get a chance to run at all
+		add_action('activate_plugin', array($this, 'load_espresso_addons'), 1);
+		// detect whether install or upgrade
+		add_action(
+			'AHEE__EE_Bootstrap__detect_activations_or_upgrades',
+			array($this, 'detect_activations_or_upgrades'),
+			3
+		);
+		// load EE_Config, EE_Textdomain, etc
+		add_action(
+			'AHEE__EE_Bootstrap__load_core_configuration',
+			array($this, 'load_core_configuration'),
+			5
+		);
+		// load specifications for matching routes to current request
+		add_action(
+			'AHEE__EE_Bootstrap__load_core_configuration',
+			array($this, 'loadRouteMatchSpecifications')
+		);
+		// load EE_Config, EE_Textdomain, etc
+		add_action(
+			'AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets',
+			array($this, 'register_shortcodes_modules_and_widgets'),
+			7
+		);
+		// you wanna get going? I wanna get going... let's get going!
+		add_action(
+			'AHEE__EE_Bootstrap__brew_espresso',
+			array($this, 'brew_espresso'),
+			9
+		);
+		// other housekeeping
+		// exclude EE critical pages from wp_list_pages
+		add_filter(
+			'wp_list_pages_excludes',
+			array($this, 'remove_pages_from_wp_list_pages'),
+			10
+		);
+		// ALL EE Addons should use the following hook point to attach their initial setup too
+		// it's extremely important for EE Addons to register any class autoloaders so that they can be available when the EE_Config loads
+		do_action('AHEE__EE_System__construct__complete', $this);
+	}
+
+
+	/**
+	 * load and setup EE_Capabilities
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function loadCapabilities()
+	{
+		$this->capabilities = $this->loader->getShared('EE_Capabilities');
+		add_action(
+			'AHEE__EE_Capabilities__init_caps__before_initialization',
+			function () {
+				LoaderFactory::getLoader()->getShared('EE_Payment_Method_Manager');
+			}
+		);
+	}
+
+
+	/**
+	 * create and cache the CommandBus, and also add middleware
+	 * The CapChecker middleware requires the use of EE_Capabilities
+	 * which is why we need to load the CommandBus after Caps are set up
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function loadCommandBus()
+	{
+		$this->loader->getShared(
+			'CommandBusInterface',
+			array(
+				null,
+				apply_filters(
+					'FHEE__EE_Load_Espresso_Core__handle_request__CommandBus_middleware',
+					array(
+						$this->loader->getShared('EventEspresso\core\services\commands\middleware\CapChecker'),
+						$this->loader->getShared('EventEspresso\core\services\commands\middleware\AddActionHook'),
+					)
+				),
+			)
+		);
+	}
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function loadPluginApi()
+	{
+		// set autoloaders for all of the classes implementing EEI_Plugin_API
+		// which provide helpers for EE plugin authors to more easily register certain components with EE.
+		EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder(EE_LIBRARIES . 'plugin_api');
+	}
+
+
+	/**
+	 * @param string $addon_name
+	 * @param string $version_constant
+	 * @param string $min_version_required
+	 * @param string $load_callback
+	 * @param string $plugin_file_constant
+	 * @return void
+	 */
+	private function deactivateIncompatibleAddon(
+		$addon_name,
+		$version_constant,
+		$min_version_required,
+		$load_callback,
+		$plugin_file_constant
+	) {
+		if (! defined($version_constant)) {
+			return;
+		}
+		$addon_version = constant($version_constant);
+		if ($addon_version && version_compare($addon_version, $min_version_required, '<')) {
+			remove_action('AHEE__EE_System__load_espresso_addons', $load_callback);
+			if (! function_exists('deactivate_plugins')) {
+				require_once ABSPATH . 'wp-admin/includes/plugin.php';
+			}
+			deactivate_plugins(plugin_basename(constant($plugin_file_constant)));
+			$this->request->unSetRequestParams(['activate', 'activate-multi'], true);
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'We\'re sorry, but the Event Espresso %1$s addon was deactivated because version %2$s or higher is required with this version of Event Espresso core.',
+						'event_espresso'
+					),
+					$addon_name,
+					$min_version_required
+				),
+				__FILE__,
+				__FUNCTION__ . "({$addon_name})",
+				__LINE__
+			);
+			EE_Error::get_notices(false, true);
+		}
+	}
+
+
+	/**
+	 * load_espresso_addons
+	 * allow addons to load first so that they can set hooks for running DMS's, etc
+	 * this is hooked into both:
+	 *    'AHEE__EE_Bootstrap__load_core_configuration'
+	 *        which runs during the WP 'plugins_loaded' action at priority 5
+	 *    and the WP 'activate_plugin' hook point
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function load_espresso_addons()
+	{
+		$this->deactivateIncompatibleAddon(
+			'Wait Lists',
+			'EE_WAIT_LISTS_VERSION',
+			'1.0.0.beta.074',
+			'load_espresso_wait_lists',
+			'EE_WAIT_LISTS_PLUGIN_FILE'
+		);
+		$this->deactivateIncompatibleAddon(
+			'Automated Upcoming Event Notifications',
+			'EE_AUTOMATED_UPCOMING_EVENT_NOTIFICATION_VERSION',
+			'1.0.0.beta.091',
+			'load_espresso_automated_upcoming_event_notification',
+			'EE_AUTOMATED_UPCOMING_EVENT_NOTIFICATION_PLUGIN_FILE'
+		);
+		do_action('AHEE__EE_System__load_espresso_addons');
+		// if the WP API basic auth plugin isn't already loaded, load it now.
+		// We want it for mobile apps. Just include the entire plugin
+		// also, don't load the basic auth when a plugin is getting activated, because
+		// it could be the basic auth plugin, and it doesn't check if its methods are already defined
+		// and causes a fatal error
+		if (
+			($this->request->isWordPressApi() || $this->request->isApi())
+			&& $this->request->getRequestParam('activate') !== 'true'
+			&& ! function_exists('json_basic_auth_handler')
+			&& ! function_exists('json_basic_auth_error')
+			&& ! in_array(
+				$this->request->getRequestParam('action'),
+				array('activate', 'activate-selected'),
+				true
+			)
+		) {
+			include_once EE_THIRD_PARTY . 'wp-api-basic-auth/basic-auth.php';
+		}
+		do_action('AHEE__EE_System__load_espresso_addons__complete');
+	}
+
+
+	/**
+	 * detect_activations_or_upgrades
+	 * Checks for activation or upgrade of core first;
+	 * then also checks if any registered addons have been activated or upgraded
+	 * This is hooked into 'AHEE__EE_Bootstrap__detect_activations_or_upgrades'
+	 * which runs during the WP 'plugins_loaded' action at priority 3
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function detect_activations_or_upgrades()
+	{
+		// first off: let's make sure to handle core
+		$this->detect_if_activation_or_upgrade();
+		foreach ($this->registry->addons as $addon) {
+			if ($addon instanceof EE_Addon) {
+				// detect teh request type for that addon
+				$addon->detect_req_type();
+			}
+		}
+	}
+
+
+	/**
+	 * detect_if_activation_or_upgrade
+	 * Takes care of detecting whether this is a brand new install or code upgrade,
+	 * and either setting up the DB or setting up maintenance mode etc.
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function detect_if_activation_or_upgrade()
+	{
+		do_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin');
+		// check if db has been updated, or if its a brand-new installation
+		$espresso_db_update = $this->fix_espresso_db_upgrade_option();
+		$request_type = $this->detect_req_type($espresso_db_update);
+		// EEH_Debug_Tools::printr( $request_type, '$request_type', __FILE__, __LINE__ );
+		switch ($request_type) {
+			case EE_System::req_type_new_activation:
+				do_action('AHEE__EE_System__detect_if_activation_or_upgrade__new_activation');
+				$this->_handle_core_version_change($espresso_db_update);
+				break;
+			case EE_System::req_type_reactivation:
+				do_action('AHEE__EE_System__detect_if_activation_or_upgrade__reactivation');
+				$this->_handle_core_version_change($espresso_db_update);
+				break;
+			case EE_System::req_type_upgrade:
+				do_action('AHEE__EE_System__detect_if_activation_or_upgrade__upgrade');
+				// migrations may be required now that we've upgraded
+				$this->maintenance_mode->set_maintenance_mode_if_db_old();
+				$this->_handle_core_version_change($espresso_db_update);
+				break;
+			case EE_System::req_type_downgrade:
+				do_action('AHEE__EE_System__detect_if_activation_or_upgrade__downgrade');
+				// its possible migrations are no longer required
+				$this->maintenance_mode->set_maintenance_mode_if_db_old();
+				$this->_handle_core_version_change($espresso_db_update);
+				break;
+			case EE_System::req_type_normal:
+			default:
+				break;
+		}
+		do_action('AHEE__EE_System__detect_if_activation_or_upgrade__complete');
+	}
+
+
+	/**
+	 * Updates the list of installed versions and sets hooks for
+	 * initializing the database later during the request
+	 *
+	 * @param array $espresso_db_update
+	 */
+	private function _handle_core_version_change($espresso_db_update)
+	{
+		$this->update_list_of_installed_versions($espresso_db_update);
+		// get ready to verify the DB is ok (provided we aren't in maintenance mode, of course)
+		add_action(
+			'AHEE__EE_System__perform_activations_upgrades_and_migrations',
+			array($this, 'initialize_db_if_no_migrations_required')
+		);
+	}
+
+
+	/**
+	 * standardizes the wp option 'espresso_db_upgrade' which actually stores
+	 * information about what versions of EE have been installed and activated,
+	 * NOT necessarily the state of the database
+	 *
+	 * @param mixed $espresso_db_update           the value of the WordPress option.
+	 *                                            If not supplied, fetches it from the options table
+	 * @return array the correct value of 'espresso_db_upgrade', after saving it, if it needed correction
+	 */
+	private function fix_espresso_db_upgrade_option($espresso_db_update = null)
+	{
+		do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__begin', $espresso_db_update);
+		if (! $espresso_db_update) {
+			$espresso_db_update = get_option('espresso_db_update');
+		}
+		// check that option is an array
+		if (! is_array($espresso_db_update)) {
+			// if option is FALSE, then it never existed
+			if ($espresso_db_update === false) {
+				// make $espresso_db_update an array and save option with autoload OFF
+				$espresso_db_update = array();
+				add_option('espresso_db_update', $espresso_db_update, '', 'no');
+			} else {
+				// option is NOT FALSE but also is NOT an array, so make it an array and save it
+				$espresso_db_update = array($espresso_db_update => array());
+				update_option('espresso_db_update', $espresso_db_update);
+			}
+		} else {
+			$corrected_db_update = array();
+			// if IS an array, but is it an array where KEYS are version numbers, and values are arrays?
+			foreach ($espresso_db_update as $should_be_version_string => $should_be_array) {
+				if (is_int($should_be_version_string) && ! is_array($should_be_array)) {
+					// the key is an int, and the value IS NOT an array
+					// so it must be numerically-indexed, where values are versions installed...
+					// fix it!
+					$version_string = $should_be_array;
+					$corrected_db_update[ $version_string ] = array('unknown-date');
+				} else {
+					// ok it checks out
+					$corrected_db_update[ $should_be_version_string ] = $should_be_array;
+				}
+			}
+			$espresso_db_update = $corrected_db_update;
+			update_option('espresso_db_update', $espresso_db_update);
+		}
+		do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__complete', $espresso_db_update);
+		return $espresso_db_update;
+	}
+
+
+	/**
+	 * Does the traditional work of setting up the plugin's database and adding default data.
+	 * If migration script/process did not exist, this is what would happen on every activation/reactivation/upgrade.
+	 * NOTE: if we're in maintenance mode (which would be the case if we detect there are data
+	 * migration scripts that need to be run and a version change happens), enqueues core for database initialization,
+	 * so that it will be done when migrations are finished
+	 *
+	 * @param boolean $initialize_addons_too if true, we double-check addons' database tables etc too;
+	 * @param boolean $verify_schema         if true will re-check the database tables have the correct schema.
+	 *                                       This is a resource-intensive job
+	 *                                       so we prefer to only do it when necessary
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function initialize_db_if_no_migrations_required($initialize_addons_too = false, $verify_schema = true)
+	{
+		$request_type = $this->detect_req_type();
+		// only initialize system if we're not in maintenance mode.
+		if ($this->maintenance_mode->level() !== EE_Maintenance_Mode::level_2_complete_maintenance) {
+			/** @var EventEspresso\core\domain\services\custom_post_types\RewriteRules $rewrite_rules */
+			$rewrite_rules = $this->loader->getShared(
+				'EventEspresso\core\domain\services\custom_post_types\RewriteRules'
+			);
+			$rewrite_rules->flush();
+			if ($verify_schema) {
+				EEH_Activation::initialize_db_and_folders();
+			}
+			EEH_Activation::initialize_db_content();
+			EEH_Activation::system_initialization();
+			if ($initialize_addons_too) {
+				$this->initialize_addons();
+			}
+		} else {
+			EE_Data_Migration_Manager::instance()->enqueue_db_initialization_for('Core');
+		}
+		if (
+			$request_type === EE_System::req_type_new_activation
+			|| $request_type === EE_System::req_type_reactivation
+			|| (
+				$request_type === EE_System::req_type_upgrade
+				&& $this->is_major_version_change()
+			)
+		) {
+			add_action('AHEE__EE_System__initialize_last', array($this, 'redirect_to_about_ee'), 9);
+		}
+	}
+
+
+	/**
+	 * Initializes the db for all registered addons
+	 *
+	 * @throws EE_Error
+	 */
+	public function initialize_addons()
+	{
+		// foreach registered addon, make sure its db is up-to-date too
+		foreach ($this->registry->addons as $addon) {
+			if ($addon instanceof EE_Addon) {
+				$addon->initialize_db_if_no_migrations_required();
+			}
+		}
+	}
+
+
+	/**
+	 * Adds the current code version to the saved wp option which stores a list of all ee versions ever installed.
+	 *
+	 * @param    array  $version_history
+	 * @param    string $current_version_to_add version to be added to the version history
+	 * @return    boolean success as to whether or not this option was changed
+	 */
+	public function update_list_of_installed_versions($version_history = null, $current_version_to_add = null)
+	{
+		if (! $version_history) {
+			$version_history = $this->fix_espresso_db_upgrade_option($version_history);
+		}
+		if ($current_version_to_add === null) {
+			$current_version_to_add = espresso_version();
+		}
+		$version_history[ $current_version_to_add ][] = date('Y-m-d H:i:s', time());
+		// re-save
+		return update_option('espresso_db_update', $version_history);
+	}
+
+
+	/**
+	 * Detects if the current version indicated in the has existed in the list of
+	 * previously-installed versions of EE (espresso_db_update). Does NOT modify it (ie, no side-effect)
+	 *
+	 * @param array $espresso_db_update array from the wp option stored under the name 'espresso_db_update'.
+	 *                                  If not supplied, fetches it from the options table.
+	 *                                  Also, caches its result so later parts of the code can also know whether
+	 *                                  there's been an update or not. This way we can add the current version to
+	 *                                  espresso_db_update, but still know if this is a new install or not
+	 * @return int one of the constants on EE_System::req_type_
+	 */
+	public function detect_req_type($espresso_db_update = null)
+	{
+		if ($this->_req_type === null) {
+			$espresso_db_update = ! empty($espresso_db_update)
+				? $espresso_db_update
+				: $this->fix_espresso_db_upgrade_option();
+			$this->_req_type = EE_System::detect_req_type_given_activation_history(
+				$espresso_db_update,
+				'ee_espresso_activation',
+				espresso_version()
+			);
+			$this->_major_version_change = $this->_detect_major_version_change($espresso_db_update);
+			$this->request->setIsActivation($this->_req_type !== EE_System::req_type_normal);
+		}
+		return $this->_req_type;
+	}
+
+
+	/**
+	 * Returns whether or not there was a non-micro version change (ie, change in either
+	 * the first or second number in the version. Eg 4.9.0.rc.001 to 4.10.0.rc.000,
+	 * but not 4.9.0.rc.0001 to 4.9.1.rc.0001
+	 *
+	 * @param $activation_history
+	 * @return bool
+	 */
+	private function _detect_major_version_change($activation_history)
+	{
+		$previous_version = EE_System::_get_most_recently_active_version_from_activation_history($activation_history);
+		$previous_version_parts = explode('.', $previous_version);
+		$current_version_parts = explode('.', espresso_version());
+		return isset($previous_version_parts[0], $previous_version_parts[1], $current_version_parts[0], $current_version_parts[1])
+			   && ($previous_version_parts[0] !== $current_version_parts[0]
+				   || $previous_version_parts[1] !== $current_version_parts[1]
+			   );
+	}
+
+
+	/**
+	 * Returns true if either the major or minor version of EE changed during this request.
+	 * Eg 4.9.0.rc.001 to 4.10.0.rc.000, but not 4.9.0.rc.0001 to 4.9.1.rc.0001
+	 *
+	 * @return bool
+	 */
+	public function is_major_version_change()
+	{
+		return $this->_major_version_change;
+	}
+
+
+	/**
+	 * Determines the request type for any ee addon, given three piece of info: the current array of activation
+	 * histories (for core that' 'espresso_db_update' wp option); the name of the WordPress option which is temporarily
+	 * set upon activation of the plugin (for core it's 'ee_espresso_activation'); and the version that this plugin was
+	 * just activated to (for core that will always be espresso_version())
+	 *
+	 * @param array  $activation_history_for_addon     the option's value which stores the activation history for this
+	 *                                                 ee plugin. for core that's 'espresso_db_update'
+	 * @param string $activation_indicator_option_name the name of the WordPress option that is temporarily set to
+	 *                                                 indicate that this plugin was just activated
+	 * @param string $version_to_upgrade_to            the version that was just upgraded to (for core that will be
+	 *                                                 espresso_version())
+	 * @return int one of the constants on EE_System::req_type_*
+	 */
+	public static function detect_req_type_given_activation_history(
+		$activation_history_for_addon,
+		$activation_indicator_option_name,
+		$version_to_upgrade_to
+	) {
+		$version_is_higher = self::_new_version_is_higher($activation_history_for_addon, $version_to_upgrade_to);
+		if ($activation_history_for_addon) {
+			// it exists, so this isn't a completely new install
+			// check if this version already in that list of previously installed versions
+			if (! isset($activation_history_for_addon[ $version_to_upgrade_to ])) {
+				// it a version we haven't seen before
+				if ($version_is_higher === 1) {
+					$req_type = EE_System::req_type_upgrade;
+				} else {
+					$req_type = EE_System::req_type_downgrade;
+				}
+				delete_option($activation_indicator_option_name);
+			} else {
+				// its not an update. maybe a reactivation?
+				if (get_option($activation_indicator_option_name, false)) {
+					if ($version_is_higher === -1) {
+						$req_type = EE_System::req_type_downgrade;
+					} elseif ($version_is_higher === 0) {
+						// we've seen this version before, but it's an activation. must be a reactivation
+						$req_type = EE_System::req_type_reactivation;
+					} else {// $version_is_higher === 1
+						$req_type = EE_System::req_type_upgrade;
+					}
+					delete_option($activation_indicator_option_name);
+				} else {
+					// we've seen this version before and the activation indicate doesn't show it was just activated
+					if ($version_is_higher === -1) {
+						$req_type = EE_System::req_type_downgrade;
+					} elseif ($version_is_higher === 0) {
+						// we've seen this version before and it's not an activation. its normal request
+						$req_type = EE_System::req_type_normal;
+					} else {// $version_is_higher === 1
+						$req_type = EE_System::req_type_upgrade;
+					}
+				}
+			}
+		} else {
+			// brand new install
+			$req_type = EE_System::req_type_new_activation;
+			delete_option($activation_indicator_option_name);
+		}
+		return $req_type;
+	}
+
+
+	/**
+	 * Detects if the $version_to_upgrade_to is higher than the most recent version in
+	 * the $activation_history_for_addon
+	 *
+	 * @param array  $activation_history_for_addon (keys are versions, values are arrays of times activated,
+	 *                                             sometimes containing 'unknown-date'
+	 * @param string $version_to_upgrade_to        (current version)
+	 * @return int results of version_compare( $version_to_upgrade_to, $most_recently_active_version ).
+	 *                                             ie, -1 if $version_to_upgrade_to is LOWER (downgrade);
+	 *                                             0 if $version_to_upgrade_to MATCHES (reactivation or normal request);
+	 *                                             1 if $version_to_upgrade_to is HIGHER (upgrade) ;
+	 */
+	private static function _new_version_is_higher($activation_history_for_addon, $version_to_upgrade_to)
+	{
+		// find the most recently-activated version
+		$most_recently_active_version =
+			EE_System::_get_most_recently_active_version_from_activation_history($activation_history_for_addon);
+		return version_compare($version_to_upgrade_to, $most_recently_active_version);
+	}
+
+
+	/**
+	 * Gets the most recently active version listed in the activation history,
+	 * and if none are found (ie, it's a brand new install) returns '0.0.0.dev.000'.
+	 *
+	 * @param array $activation_history  (keys are versions, values are arrays of times activated,
+	 *                                   sometimes containing 'unknown-date'
+	 * @return string
+	 */
+	private static function _get_most_recently_active_version_from_activation_history($activation_history)
+	{
+		$most_recently_active_version_activation = '1970-01-01 00:00:00';
+		$most_recently_active_version = '0.0.0.dev.000';
+		if (is_array($activation_history)) {
+			foreach ($activation_history as $version => $times_activated) {
+				// check there is a record of when this version was activated. Otherwise,
+				// mark it as unknown
+				if (! $times_activated) {
+					$times_activated = array('unknown-date');
+				}
+				if (is_string($times_activated)) {
+					$times_activated = array($times_activated);
+				}
+				foreach ($times_activated as $an_activation) {
+					if (
+						$an_activation !== 'unknown-date'
+						&& $an_activation
+						   > $most_recently_active_version_activation
+					) {
+						$most_recently_active_version = $version;
+						$most_recently_active_version_activation = $an_activation === 'unknown-date'
+							? '1970-01-01 00:00:00'
+							: $an_activation;
+					}
+				}
+			}
+		}
+		return $most_recently_active_version;
+	}
+
+
+	/**
+	 * This redirects to the about EE page after activation
+	 *
+	 * @return void
+	 */
+	public function redirect_to_about_ee()
+	{
+		$notices = EE_Error::get_notices(false);
+		// if current user is an admin and it's not an ajax or rest request
+		if (
+			! isset($notices['errors'])
+			&& $this->request->isAdmin()
+			&& apply_filters(
+				'FHEE__EE_System__redirect_to_about_ee__do_redirect',
+				$this->capabilities->current_user_can('manage_options', 'espresso_about_default')
+			)
+		) {
+			$query_params = array('page' => 'espresso_about');
+			if (EE_System::instance()->detect_req_type() === EE_System::req_type_new_activation) {
+				$query_params['new_activation'] = true;
+			}
+			if (EE_System::instance()->detect_req_type() === EE_System::req_type_reactivation) {
+				$query_params['reactivation'] = true;
+			}
+			$url = add_query_arg($query_params, admin_url('admin.php'));
+			wp_safe_redirect($url);
+			exit();
+		}
+	}
+
+
+	/**
+	 * load_core_configuration
+	 * this is hooked into 'AHEE__EE_Bootstrap__load_core_configuration'
+	 * which runs during the WP 'plugins_loaded' action at priority 5
+	 *
+	 * @return void
+	 * @throws ReflectionException
+	 * @throws Exception
+	 */
+	public function load_core_configuration()
+	{
+		do_action('AHEE__EE_System__load_core_configuration__begin', $this);
+		$this->loader->getShared('EE_Load_Textdomain');
+		// load textdomain
+		EE_Load_Textdomain::load_textdomain();
+		// load caf stuff a chance to play during the activation process too.
+		$this->_maybe_brew_regular();
+		// load and setup EE_Config and EE_Network_Config
+		$config = $this->loader->getShared('EE_Config');
+		$this->loader->getShared('EE_Network_Config');
+		// setup autoloaders
+		// enable logging?
+		if ($config->admin->use_remote_logging) {
+			$this->loader->getShared('EE_Log');
+		}
+		// check for activation errors
+		$activation_errors = get_option('ee_plugin_activation_errors', false);
+		if ($activation_errors) {
+			EE_Error::add_error($activation_errors, __FILE__, __FUNCTION__, __LINE__);
+			update_option('ee_plugin_activation_errors', false);
+		}
+		// get model names
+		$this->_parse_model_names();
+		// configure custom post type definitions
+		$this->loader->getShared('EventEspresso\core\domain\entities\custom_post_types\CustomTaxonomyDefinitions');
+		$this->loader->getShared('EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions');
+		do_action('AHEE__EE_System__load_core_configuration__complete', $this);
+	}
+
+
+	/**
+	 * cycles through all of the models/*.model.php files, and assembles an array of model names
+	 *
+	 * @return void
+	 * @throws ReflectionException
+	 */
+	private function _parse_model_names()
+	{
+		// get all the files in the EE_MODELS folder that end in .model.php
+		$models = glob(EE_MODELS . '*.model.php');
+		$model_names = array();
+		$non_abstract_db_models = array();
+		foreach ($models as $model) {
+			// get model classname
+			$classname = EEH_File::get_classname_from_filepath_with_standard_filename($model);
+			$short_name = str_replace('EEM_', '', $classname);
+			$reflectionClass = new ReflectionClass($classname);
+			if ($reflectionClass->isSubclassOf('EEM_Base') && ! $reflectionClass->isAbstract()) {
+				$non_abstract_db_models[ $short_name ] = $classname;
+			}
+			$model_names[ $short_name ] = $classname;
+		}
+		$this->registry->models = apply_filters('FHEE__EE_System__parse_model_names', $model_names);
+		$this->registry->non_abstract_db_models = apply_filters(
+			'FHEE__EE_System__parse_implemented_model_names',
+			$non_abstract_db_models
+		);
+	}
+
+
+	/**
+	 * The purpose of this method is to simply check for a file named "caffeinated/brewing_regular.php" for any hooks
+	 * that need to be setup before our EE_System launches.
+	 *
+	 * @return void
+	 * @throws DomainException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidClassException
+	 * @throws InvalidFilePathException
+	 */
+	private function _maybe_brew_regular()
+	{
+		/** @var Domain $domain */
+		$domain = DomainFactory::getShared(
+			new FullyQualifiedName(
+				'EventEspresso\core\domain\Domain'
+			),
+			array(
+				new FilePath(EVENT_ESPRESSO_MAIN_FILE),
+				Version::fromString(espresso_version()),
+			)
+		);
+		if ($domain->isCaffeinated()) {
+			require_once EE_CAFF_PATH . 'brewing_regular.php';
+		}
+	}
+
+
+	/**
+	 * @since 4.9.71.p
+	 * @throws Exception
+	 */
+	public function loadRouteMatchSpecifications()
+	{
+		try {
+			$this->loader->getShared(
+				'EventEspresso\core\services\route_match\RouteMatchSpecificationManager'
+			);
+		} catch (Exception $exception) {
+			new ExceptionStackTraceDisplay($exception);
+		}
+		do_action('AHEE__EE_System__loadRouteMatchSpecifications');
+	}
+
+
+	/**
+	 * register_shortcodes_modules_and_widgets
+	 * generate lists of shortcodes and modules, then verify paths and classes
+	 * This is hooked into 'AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets'
+	 * which runs during the WP 'plugins_loaded' action at priority 7
+	 *
+	 * @access public
+	 * @return void
+	 * @throws Exception
+	 */
+	public function register_shortcodes_modules_and_widgets()
+	{
+		if ($this->request->isFrontend() || $this->request->isIframe() || $this->request->isAjax()) {
+			// load, register, and add shortcodes the new way
+			$this->loader->getShared('EventEspresso\core\services\shortcodes\ShortcodesManager');
+		}
+		do_action('AHEE__EE_System__register_shortcodes_modules_and_widgets');
+		// check for addons using old hook point
+		if (has_action('AHEE__EE_System__register_shortcodes_modules_and_addons')) {
+			$this->_incompatible_addon_error();
+		}
+	}
+
+
+	/**
+	 * _incompatible_addon_error
+	 *
+	 * @access public
+	 * @return void
+	 */
+	private function _incompatible_addon_error()
+	{
+		// get array of classes hooking into here
+		$class_names = EEH_Class_Tools::get_class_names_for_all_callbacks_on_hook(
+			'AHEE__EE_System__register_shortcodes_modules_and_addons'
+		);
+		if (! empty($class_names)) {
+			$msg = esc_html__(
+				'The following plugins, addons, or modules appear to be incompatible with this version of Event Espresso and were automatically deactivated to avoid fatal errors:',
+				'event_espresso'
+			);
+			$msg .= '<ul>';
+			foreach ($class_names as $class_name) {
+				$msg .= '<li><b>Event Espresso - '
+						. str_replace(
+							array('EE_', 'EEM_', 'EED_', 'EES_', 'EEW_'),
+							'',
+							$class_name
+						) . '</b></li>';
+			}
+			$msg .= '</ul>';
+			$msg .= esc_html__(
+				'Compatibility issues can be avoided and/or resolved by keeping addons and plugins updated to the latest version.',
+				'event_espresso'
+			);
+			// save list of incompatible addons to wp-options for later use
+			add_option('ee_incompatible_addons', $class_names, '', 'no');
+			if (is_admin()) {
+				EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			}
+		}
+	}
+
+
+	/**
+	 * brew_espresso
+	 * begins the process of setting hooks for initializing EE in the correct order
+	 * This is happening on the 'AHEE__EE_Bootstrap__brew_espresso' hook point
+	 * which runs during the WP 'plugins_loaded' action at priority 9
+	 *
+	 * @return void
+	 */
+	public function brew_espresso()
+	{
+		do_action('AHEE__EE_System__brew_espresso__begin', $this);
+		// load some final core systems
+		add_action('init', array($this, 'set_hooks_for_core'), 1);
+		add_action('init', array($this, 'perform_activations_upgrades_and_migrations'), 3);
+		add_action('init', array($this, 'load_CPTs_and_session'), 5);
+		add_action('init', array($this, 'load_controllers'), 7);
+		add_action('init', array($this, 'core_loaded_and_ready'), 9);
+		add_action('init', array($this, 'initialize'), 10);
+		add_action('init', array($this, 'initialize_last'), 100);
+		if (is_admin() && apply_filters('FHEE__EE_System__brew_espresso__load_pue', true)) {
+			// pew pew pew
+			$this->loader->getShared('EventEspresso\core\services\licensing\LicenseService');
+			do_action('AHEE__EE_System__brew_espresso__after_pue_init');
+		}
+		do_action('AHEE__EE_System__brew_espresso__complete', $this);
+	}
+
+
+	/**
+	 *    set_hooks_for_core
+	 *
+	 * @access public
+	 * @return    void
+	 * @throws EE_Error
+	 */
+	public function set_hooks_for_core()
+	{
+		$this->_deactivate_incompatible_addons();
+		do_action('AHEE__EE_System__set_hooks_for_core');
+		$this->loader->getShared('EventEspresso\core\domain\values\session\SessionLifespan');
+		// caps need to be initialized on every request so that capability maps are set.
+		// @see https://events.codebasehq.com/projects/event-espresso/tickets/8674
+		$this->registry->CAP->init_caps();
+	}
+
+
+	/**
+	 * Using the information gathered in EE_System::_incompatible_addon_error,
+	 * deactivates any addons considered incompatible with the current version of EE
+	 */
+	private function _deactivate_incompatible_addons()
+	{
+		$incompatible_addons = get_option('ee_incompatible_addons', array());
+		if (! empty($incompatible_addons)) {
+			$active_plugins = get_option('active_plugins', array());
+			foreach ($active_plugins as $active_plugin) {
+				foreach ($incompatible_addons as $incompatible_addon) {
+					if (strpos($active_plugin, $incompatible_addon) !== false) {
+						$this->request->unSetRequestParams(['activate'], true);
+						espresso_deactivate_plugin($active_plugin);
+					}
+				}
+			}
+		}
+	}
+
+
+	/**
+	 *    perform_activations_upgrades_and_migrations
+	 *
+	 * @access public
+	 * @return    void
+	 */
+	public function perform_activations_upgrades_and_migrations()
+	{
+		do_action('AHEE__EE_System__perform_activations_upgrades_and_migrations');
+	}
+
+
+	/**
+	 * @return void
+	 * @throws DomainException
+	 */
+	public function load_CPTs_and_session()
+	{
+		do_action('AHEE__EE_System__load_CPTs_and_session__start');
+		/** @var EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomies $register_custom_taxonomies */
+		$register_custom_taxonomies = $this->loader->getShared(
+			'EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomies'
+		);
+		$register_custom_taxonomies->registerCustomTaxonomies();
+		/** @var EventEspresso\core\domain\services\custom_post_types\RegisterCustomPostTypes $register_custom_post_types */
+		$register_custom_post_types = $this->loader->getShared(
+			'EventEspresso\core\domain\services\custom_post_types\RegisterCustomPostTypes'
+		);
+		$register_custom_post_types->registerCustomPostTypes();
+		/** @var EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomyTerms $register_custom_taxonomy_terms */
+		$register_custom_taxonomy_terms = $this->loader->getShared(
+			'EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomyTerms'
+		);
+		$register_custom_taxonomy_terms->registerCustomTaxonomyTerms();
+		// load legacy Custom Post Types and Taxonomies
+		$this->loader->getShared('EE_Register_CPTs');
+		do_action('AHEE__EE_System__load_CPTs_and_session__complete');
+	}
+
+
+	/**
+	 * load_controllers
+	 * this is the best place to load any additional controllers that needs access to EE core.
+	 * it is expected that all basic core EE systems, that are not dependant on the current request are loaded at this
+	 * time
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function load_controllers()
+	{
+		do_action('AHEE__EE_System__load_controllers__start');
+		// let's get it started
+		if (
+			! $this->maintenance_mode->level()
+			&& ($this->request->isFrontend() || $this->request->isFrontAjax())
+		) {
+			do_action('AHEE__EE_System__load_controllers__load_front_controllers');
+			$this->loader->getShared('EE_Front_Controller');
+		} elseif ($this->request->isAdmin() || $this->request->isAdminAjax()) {
+			do_action('AHEE__EE_System__load_controllers__load_admin_controllers');
+			$this->loader->getShared('EE_Admin');
+		} elseif ($this->request->isWordPressHeartbeat()) {
+			$this->loader->getShared('EventEspresso\core\domain\services\admin\ajax\WordpressHeartbeat');
+		}
+		do_action('AHEE__EE_System__load_controllers__complete');
+	}
+
+
+	/**
+	 * core_loaded_and_ready
+	 * all of the basic EE core should be loaded at this point and available regardless of M-Mode
+	 *
+	 * @access public
+	 * @return void
+	 * @throws Exception
+	 */
+	public function core_loaded_and_ready()
+	{
+		if (
+			$this->request->isAdmin()
+			|| $this->request->isFrontend()
+			|| $this->request->isIframe()
+			|| $this->request->isWordPressApi()
+		) {
+			try {
+				$this->loader->getShared('EventEspresso\core\services\assets\Registry');
+				$this->loader->getShared('EventEspresso\core\domain\services\assets\CoreAssetManager');
+				if ($this->canLoadBlocks()) {
+					$this->loader->getShared(
+						'EventEspresso\core\services\editor\BlockRegistrationManager'
+					);
+				}
+			} catch (Exception $exception) {
+				new ExceptionStackTraceDisplay($exception);
+			}
+		}
+		if (
+			$this->request->isAdmin()
+			|| $this->request->isEeAjax()
+			|| $this->request->isFrontend()
+		) {
+			$this->loader->getShared('EE_Session');
+		}
+		// integrate WP_Query with the EE models
+		$this->loader->getShared('EE_CPT_Strategy');
+		// load legacy EE_Request_Handler in case add-ons still need it
+		$this->loader->getShared('EE_Request_Handler');
+		do_action('AHEE__EE_System__core_loaded_and_ready');
+		// always load template tags, because it's faster than checking if it's a front-end request, and many page
+		// builders require these even on the front-end
+		require_once EE_PUBLIC . 'template_tags.php';
+		do_action('AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons');
+	}
+
+
+	/**
+	 * initialize
+	 * this is the best place to begin initializing client code
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function initialize()
+	{
+		do_action('AHEE__EE_System__initialize');
+	}
+
+
+	/**
+	 * initialize_last
+	 * this is run really late during the WP init hook point, and ensures that mostly everything else that needs to
+	 * initialize has done so
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function initialize_last()
+	{
+		do_action('AHEE__EE_System__initialize_last');
+		/** @var EventEspresso\core\domain\services\custom_post_types\RewriteRules $rewrite_rules */
+		$rewrite_rules = $this->loader->getShared(
+			'EventEspresso\core\domain\services\custom_post_types\RewriteRules'
+		);
+		$rewrite_rules->flushRewriteRules();
+		add_action('admin_bar_init', array($this, 'addEspressoToolbar'));
+		if (
+			($this->request->isAjax() || $this->request->isAdmin())
+			&& $this->maintenance_mode->models_can_query()
+		) {
+			$this->loader->getShared('EventEspresso\core\services\privacy\export\PersonalDataExporterManager');
+			$this->loader->getShared('EventEspresso\core\services\privacy\erasure\PersonalDataEraserManager');
+		}
+	}
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function addEspressoToolbar()
+	{
+		$this->loader->getShared(
+			'EventEspresso\core\domain\services\admin\AdminToolBar',
+			array($this->registry->CAP)
+		);
+	}
+
+
+	/**
+	 * do_not_cache
+	 * sets no cache headers and defines no cache constants for WP plugins
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public static function do_not_cache()
+	{
+		// set no cache constants
+		if (! defined('DONOTCACHEPAGE')) {
+			define('DONOTCACHEPAGE', true);
+		}
+		if (! defined('DONOTCACHCEOBJECT')) {
+			define('DONOTCACHCEOBJECT', true);
+		}
+		if (! defined('DONOTCACHEDB')) {
+			define('DONOTCACHEDB', true);
+		}
+		// add no cache headers
+		add_action('send_headers', array('EE_System', 'nocache_headers'), 10);
+		// plus a little extra for nginx and Google Chrome
+		add_filter('nocache_headers', array('EE_System', 'extra_nocache_headers'), 10, 1);
+		// prevent browsers from prefetching of the rel='next' link, because it may contain content that interferes with the registration process
+		remove_action('wp_head', 'adjacent_posts_rel_link_wp_head');
+	}
+
+
+	/**
+	 *    extra_nocache_headers
+	 *
+	 * @access    public
+	 * @param $headers
+	 * @return    array
+	 */
+	public static function extra_nocache_headers($headers)
+	{
+		// for NGINX
+		$headers['X-Accel-Expires'] = 0;
+		// plus extra for Google Chrome since it doesn't seem to respect "no-cache", but WILL respect "no-store"
+		$headers['Cache-Control'] = 'no-store, no-cache, must-revalidate, max-age=0';
+		return $headers;
+	}
+
+
+	/**
+	 *    nocache_headers
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function nocache_headers()
+	{
+		nocache_headers();
+	}
+
+
+	/**
+	 * simply hooks into "wp_list_pages_exclude" filter (for wp_list_pages method) and makes sure EE critical pages are
+	 * never returned with the function.
+	 *
+	 * @param  array $exclude_array any existing pages being excluded are in this array.
+	 * @return array
+	 */
+	public function remove_pages_from_wp_list_pages($exclude_array)
+	{
+		return array_merge($exclude_array, $this->registry->CFG->core->get_critical_pages_array());
+	}
+
+
+	/**
+	 * Return whether blocks can be registered/loaded or not.
+	 * @return bool
+	 */
+	private function canLoadBlocks()
+	{
+		return apply_filters('FHEE__EE_System__canLoadBlocks', true)
+			   && function_exists('register_block_type')
+			   // don't load blocks if in the Divi page builder editor context
+			   // @see https://github.com/eventespresso/event-espresso-core/issues/814
+			   && ! $this->request->getRequestParam('et_fb', false);
+	}
 }

Spacing +27 added lines, -27 removed lines

@@ -141,7 +141,7 @@ 
         EE_Maintenance_Mode $maintenance_mode = null
     ) {
         // check if class object is instantiated
-        if (! self::$_instance instanceof EE_System) {
+        if ( ! self::$_instance instanceof EE_System) {
             self::$_instance = new self($registry, $loader, $request, $maintenance_mode);
         }
         return self::$_instance;
@@ -263,7 +263,7 @@ 
         $this->capabilities = $this->loader->getShared('EE_Capabilities');
         add_action(
             'AHEE__EE_Capabilities__init_caps__before_initialization',
-            function () {
+            function() {
                 LoaderFactory::getLoader()->getShared('EE_Payment_Method_Manager');
             }
         );
@@ -304,7 +304,7 @@ 
     {
         // set autoloaders for all of the classes implementing EEI_Plugin_API
         // which provide helpers for EE plugin authors to more easily register certain components with EE.
-        EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder(EE_LIBRARIES . 'plugin_api');
+        EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder(EE_LIBRARIES.'plugin_api');
     }
 
 
@@ -323,14 +323,14 @@ 
         $load_callback,
         $plugin_file_constant
     ) {
-        if (! defined($version_constant)) {
+        if ( ! defined($version_constant)) {
             return;
         }
         $addon_version = constant($version_constant);
         if ($addon_version && version_compare($addon_version, $min_version_required, '<')) {
             remove_action('AHEE__EE_System__load_espresso_addons', $load_callback);
-            if (! function_exists('deactivate_plugins')) {
-                require_once ABSPATH . 'wp-admin/includes/plugin.php';
+            if ( ! function_exists('deactivate_plugins')) {
+                require_once ABSPATH.'wp-admin/includes/plugin.php';
             }
             deactivate_plugins(plugin_basename(constant($plugin_file_constant)));
             $this->request->unSetRequestParams(['activate', 'activate-multi'], true);
@@ -344,7 +344,7 @@ 
                     $min_version_required
                 ),
                 __FILE__,
-                __FUNCTION__ . "({$addon_name})",
+                __FUNCTION__."({$addon_name})",
                 __LINE__
             );
             EE_Error::get_notices(false, true);
@@ -396,7 +396,7 @@ 
                 true
             )
         ) {
-            include_once EE_THIRD_PARTY . 'wp-api-basic-auth/basic-auth.php';
+            include_once EE_THIRD_PARTY.'wp-api-basic-auth/basic-auth.php';
         }
         do_action('AHEE__EE_System__load_espresso_addons__complete');
     }
@@ -498,11 +498,11 @@ 
     private function fix_espresso_db_upgrade_option($espresso_db_update = null)
     {
         do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__begin', $espresso_db_update);
-        if (! $espresso_db_update) {
+        if ( ! $espresso_db_update) {
             $espresso_db_update = get_option('espresso_db_update');
         }
         // check that option is an array
-        if (! is_array($espresso_db_update)) {
+        if ( ! is_array($espresso_db_update)) {
             // if option is FALSE, then it never existed
             if ($espresso_db_update === false) {
                 // make $espresso_db_update an array and save option with autoload OFF
@@ -522,10 +522,10 @@ 
                     // so it must be numerically-indexed, where values are versions installed...
                     // fix it!
                     $version_string = $should_be_array;
-                    $corrected_db_update[ $version_string ] = array('unknown-date');
+                    $corrected_db_update[$version_string] = array('unknown-date');
                 } else {
                     // ok it checks out
-                    $corrected_db_update[ $should_be_version_string ] = $should_be_array;
+                    $corrected_db_update[$should_be_version_string] = $should_be_array;
                 }
             }
             $espresso_db_update = $corrected_db_update;
@@ -609,13 +609,13 @@ 
      */
     public function update_list_of_installed_versions($version_history = null, $current_version_to_add = null)
     {
-        if (! $version_history) {
+        if ( ! $version_history) {
             $version_history = $this->fix_espresso_db_upgrade_option($version_history);
         }
         if ($current_version_to_add === null) {
             $current_version_to_add = espresso_version();
         }
-        $version_history[ $current_version_to_add ][] = date('Y-m-d H:i:s', time());
+        $version_history[$current_version_to_add][] = date('Y-m-d H:i:s', time());
         // re-save
         return update_option('espresso_db_update', $version_history);
     }
@@ -705,7 +705,7 @@ 
         if ($activation_history_for_addon) {
             // it exists, so this isn't a completely new install
             // check if this version already in that list of previously installed versions
-            if (! isset($activation_history_for_addon[ $version_to_upgrade_to ])) {
+            if ( ! isset($activation_history_for_addon[$version_to_upgrade_to])) {
                 // it a version we haven't seen before
                 if ($version_is_higher === 1) {
                     $req_type = EE_System::req_type_upgrade;
@@ -783,7 +783,7 @@ 
             foreach ($activation_history as $version => $times_activated) {
                 // check there is a record of when this version was activated. Otherwise,
                 // mark it as unknown
-                if (! $times_activated) {
+                if ( ! $times_activated) {
                     $times_activated = array('unknown-date');
                 }
                 if (is_string($times_activated)) {
@@ -887,7 +887,7 @@ 
     private function _parse_model_names()
     {
         // get all the files in the EE_MODELS folder that end in .model.php
-        $models = glob(EE_MODELS . '*.model.php');
+        $models = glob(EE_MODELS.'*.model.php');
         $model_names = array();
         $non_abstract_db_models = array();
         foreach ($models as $model) {
@@ -896,9 +896,9 @@ 
             $short_name = str_replace('EEM_', '', $classname);
             $reflectionClass = new ReflectionClass($classname);
             if ($reflectionClass->isSubclassOf('EEM_Base') && ! $reflectionClass->isAbstract()) {
-                $non_abstract_db_models[ $short_name ] = $classname;
+                $non_abstract_db_models[$short_name] = $classname;
             }
-            $model_names[ $short_name ] = $classname;
+            $model_names[$short_name] = $classname;
         }
         $this->registry->models = apply_filters('FHEE__EE_System__parse_model_names', $model_names);
         $this->registry->non_abstract_db_models = apply_filters(
@@ -933,7 +933,7 @@ 
             )
         );
         if ($domain->isCaffeinated()) {
-            require_once EE_CAFF_PATH . 'brewing_regular.php';
+            require_once EE_CAFF_PATH.'brewing_regular.php';
         }
     }
 
@@ -991,7 +991,7 @@ 
         $class_names = EEH_Class_Tools::get_class_names_for_all_callbacks_on_hook(
             'AHEE__EE_System__register_shortcodes_modules_and_addons'
         );
-        if (! empty($class_names)) {
+        if ( ! empty($class_names)) {
             $msg = esc_html__(
                 'The following plugins, addons, or modules appear to be incompatible with this version of Event Espresso and were automatically deactivated to avoid fatal errors:',
                 'event_espresso'
@@ -1003,7 +1003,7 @@ 
                             array('EE_', 'EEM_', 'EED_', 'EES_', 'EEW_'),
                             '',
                             $class_name
-                        ) . '</b></li>';
+                        ).'</b></li>';
             }
             $msg .= '</ul>';
             $msg .= esc_html__(
@@ -1072,7 +1072,7 @@ 
     private function _deactivate_incompatible_addons()
     {
         $incompatible_addons = get_option('ee_incompatible_addons', array());
-        if (! empty($incompatible_addons)) {
+        if ( ! empty($incompatible_addons)) {
             $active_plugins = get_option('active_plugins', array());
             foreach ($active_plugins as $active_plugin) {
                 foreach ($incompatible_addons as $incompatible_addon) {
@@ -1197,7 +1197,7 @@ 
         do_action('AHEE__EE_System__core_loaded_and_ready');
         // always load template tags, because it's faster than checking if it's a front-end request, and many page
         // builders require these even on the front-end
-        require_once EE_PUBLIC . 'template_tags.php';
+        require_once EE_PUBLIC.'template_tags.php';
         do_action('AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons');
     }
 
@@ -1265,13 +1265,13 @@ 
     public static function do_not_cache()
     {
         // set no cache constants
-        if (! defined('DONOTCACHEPAGE')) {
+        if ( ! defined('DONOTCACHEPAGE')) {
             define('DONOTCACHEPAGE', true);
         }
-        if (! defined('DONOTCACHCEOBJECT')) {
+        if ( ! defined('DONOTCACHCEOBJECT')) {
             define('DONOTCACHCEOBJECT', true);
         }
-        if (! defined('DONOTCACHEDB')) {
+        if ( ! defined('DONOTCACHEDB')) {
             define('DONOTCACHEDB', true);
         }
         // add no cache headers

core/EE_Registry.core.php

Indentation +1689 added lines, -1689 removed lines

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

Spacing +47 added lines, -47 removed lines

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