eventespresso / event-espresso-core

core/helpers/EEH_Money.helper.php

Indentation +225 added lines, -225 removed lines

@@ -12,241 +12,241 @@
 class EEH_Money extends EEH_Base
 {
 
-    /**
-     * This removes all localized money formatting from the incoming value
-     * Note: uses this site's currency settings for deciding what is considered a
-     * "thousands separator" (usually the character "," )
-     * and what is a "decimal mark" (usually the character ".")
-     *
-     * @param int|float|string $money_value
-     * @param string           $CNT_ISO
-     * @return float
-     * @throws EE_Error
-     */
-    public static function strip_localized_money_formatting($money_value, $CNT_ISO = '')
-    {
-        $currency_config = EEH_Money::get_currency_config($CNT_ISO);
-        $money_value = str_replace(
-            array(
-                $currency_config->thsnds,
-                $currency_config->dec_mrk,
-            ),
-            array(
-                '', // remove thousands separator
-                '.', // convert decimal mark to what PHP expects
-            ),
-            $money_value
-        );
-        $money_value = filter_var(
-            $money_value,
-            FILTER_SANITIZE_NUMBER_FLOAT,
-            FILTER_FLAG_ALLOW_FRACTION
-        );
-        return $money_value;
-    }
+	/**
+	 * This removes all localized money formatting from the incoming value
+	 * Note: uses this site's currency settings for deciding what is considered a
+	 * "thousands separator" (usually the character "," )
+	 * and what is a "decimal mark" (usually the character ".")
+	 *
+	 * @param int|float|string $money_value
+	 * @param string           $CNT_ISO
+	 * @return float
+	 * @throws EE_Error
+	 */
+	public static function strip_localized_money_formatting($money_value, $CNT_ISO = '')
+	{
+		$currency_config = EEH_Money::get_currency_config($CNT_ISO);
+		$money_value = str_replace(
+			array(
+				$currency_config->thsnds,
+				$currency_config->dec_mrk,
+			),
+			array(
+				'', // remove thousands separator
+				'.', // convert decimal mark to what PHP expects
+			),
+			$money_value
+		);
+		$money_value = filter_var(
+			$money_value,
+			FILTER_SANITIZE_NUMBER_FLOAT,
+			FILTER_FLAG_ALLOW_FRACTION
+		);
+		return $money_value;
+	}
 
 
-    /**
-     * This converts an incoming localized money value into a standard float item (to three decimal places)
-     * Only use this if you know the $money_value follows your currency configuration's
-     * settings. Note: this uses this site's currency settings for deciding what is considered a
-     * "thousands separator" (usually the character "," )
-     * and what is a "decimal mark" (usually the character ".")
-     *
-     * @param int|string $money_value
-     * @return float
-     * @throws EE_Error
-     */
-    public static function convert_to_float_from_localized_money($money_value)
-    {
-        // float it! and round to three decimal places
-        return round((float) EEH_Money::strip_localized_money_formatting($money_value), 3);
-    }
+	/**
+	 * This converts an incoming localized money value into a standard float item (to three decimal places)
+	 * Only use this if you know the $money_value follows your currency configuration's
+	 * settings. Note: this uses this site's currency settings for deciding what is considered a
+	 * "thousands separator" (usually the character "," )
+	 * and what is a "decimal mark" (usually the character ".")
+	 *
+	 * @param int|string $money_value
+	 * @return float
+	 * @throws EE_Error
+	 */
+	public static function convert_to_float_from_localized_money($money_value)
+	{
+		// float it! and round to three decimal places
+		return round((float) EEH_Money::strip_localized_money_formatting($money_value), 3);
+	}
 
 
-    /**
-     * For comparing floats. Default operator is '=', but see the $operator below for all options.
-     * This should be used to compare floats instead of normal '==' because floats
-     * are inherently imprecise, and so you can sometimes have two floats that appear to be identical
-     * but actually differ by 0.00000001.
-     *
-     * @see http://biostall.com/php-function-to-compare-floating-point-numbers
-     * @param float  $float1
-     * @param float  $float2
-     * @param string $operator The operator. Valid options are =, <=, <, >=, >, <>, eq, lt, lte, gt, gte, ne
-     * @return bool whether the equation is true or false
-     * @throws EE_Error
-     */
-    public static function compare_floats($float1, $float2, $operator = '=')
-    {
-        // Check numbers to 5 digits of precision
-        $epsilon = 0.00001;
-        $float1 = (float) $float1;
-        $float2 = (float) $float2;
-        switch ($operator) {
-            // equal
-            case '=':
-            case '==':
-            case '===':
-            case 'eq':
-                if (abs($float1 - $float2) < $epsilon) {
-                    return true;
-                }
-                break;
-            // less than
-            case '<':
-            case 'lt':
-                if (abs($float1 - $float2) < $epsilon) {
-                    return false;
-                }
-                if ($float1 < $float2) {
-                    return true;
-                }
-                break;
-            // less than or equal
-            case '<=':
-            case 'lte':
-                if (
-                    self::compare_floats($float1, $float2, '<')
-                    || self::compare_floats($float1, $float2, '=')
-                ) {
-                    return true;
-                }
-                break;
-            // greater than
-            case '>':
-            case 'gt':
-                if (abs($float1 - $float2) < $epsilon) {
-                    return false;
-                }
-                if ($float1 > $float2) {
-                    return true;
-                }
-                break;
-            // greater than or equal
-            case '>=':
-            case 'gte':
-                if (
-                    self::compare_floats($float1, $float2, '>')
-                    || self::compare_floats($float1, $float2, '=')
-                ) {
-                    return true;
-                }
-                break;
-            case '<>':
-            case '!=':
-            case '!==':
-            case 'ne':
-                if (abs($float1 - $float2) > $epsilon) {
-                    return true;
-                }
-                break;
-            default:
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            "Unknown operator %s in EEH_Money::compare_floats()",
-                            'event_espresso'
-                        ),
-                        $operator
-                    )
-                );
-        }
-        return false;
-    }
+	/**
+	 * For comparing floats. Default operator is '=', but see the $operator below for all options.
+	 * This should be used to compare floats instead of normal '==' because floats
+	 * are inherently imprecise, and so you can sometimes have two floats that appear to be identical
+	 * but actually differ by 0.00000001.
+	 *
+	 * @see http://biostall.com/php-function-to-compare-floating-point-numbers
+	 * @param float  $float1
+	 * @param float  $float2
+	 * @param string $operator The operator. Valid options are =, <=, <, >=, >, <>, eq, lt, lte, gt, gte, ne
+	 * @return bool whether the equation is true or false
+	 * @throws EE_Error
+	 */
+	public static function compare_floats($float1, $float2, $operator = '=')
+	{
+		// Check numbers to 5 digits of precision
+		$epsilon = 0.00001;
+		$float1 = (float) $float1;
+		$float2 = (float) $float2;
+		switch ($operator) {
+			// equal
+			case '=':
+			case '==':
+			case '===':
+			case 'eq':
+				if (abs($float1 - $float2) < $epsilon) {
+					return true;
+				}
+				break;
+			// less than
+			case '<':
+			case 'lt':
+				if (abs($float1 - $float2) < $epsilon) {
+					return false;
+				}
+				if ($float1 < $float2) {
+					return true;
+				}
+				break;
+			// less than or equal
+			case '<=':
+			case 'lte':
+				if (
+					self::compare_floats($float1, $float2, '<')
+					|| self::compare_floats($float1, $float2, '=')
+				) {
+					return true;
+				}
+				break;
+			// greater than
+			case '>':
+			case 'gt':
+				if (abs($float1 - $float2) < $epsilon) {
+					return false;
+				}
+				if ($float1 > $float2) {
+					return true;
+				}
+				break;
+			// greater than or equal
+			case '>=':
+			case 'gte':
+				if (
+					self::compare_floats($float1, $float2, '>')
+					|| self::compare_floats($float1, $float2, '=')
+				) {
+					return true;
+				}
+				break;
+			case '<>':
+			case '!=':
+			case '!==':
+			case 'ne':
+				if (abs($float1 - $float2) > $epsilon) {
+					return true;
+				}
+				break;
+			default:
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							"Unknown operator %s in EEH_Money::compare_floats()",
+							'event_espresso'
+						),
+						$operator
+					)
+				);
+		}
+		return false;
+	}
 
 
-    /**
-     * This returns a localized format string suitable for jQplot.
-     *
-     * @param string $CNT_ISO  If this is provided, then will attempt to get the currency settings for the country.
-     *                         Otherwise will use currency settings for current active country on site.
-     * @return string
-     * @throws EE_Error
-     */
-    public static function get_format_for_jqplot($CNT_ISO = '')
-    {
-        // default format
-        $format = 'f';
-        $currency_config = $currency_config = EEH_Money::get_currency_config($CNT_ISO);
-        // first get the decimal place and number of places
-        $format = "%'." . $currency_config->dec_plc . $format;
-        // currency symbol on right side.
-        $format = $currency_config->sign_b4 ? $currency_config->sign . $format : $format . $currency_config->sign;
-        return $format;
-    }
+	/**
+	 * This returns a localized format string suitable for jQplot.
+	 *
+	 * @param string $CNT_ISO  If this is provided, then will attempt to get the currency settings for the country.
+	 *                         Otherwise will use currency settings for current active country on site.
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public static function get_format_for_jqplot($CNT_ISO = '')
+	{
+		// default format
+		$format = 'f';
+		$currency_config = $currency_config = EEH_Money::get_currency_config($CNT_ISO);
+		// first get the decimal place and number of places
+		$format = "%'." . $currency_config->dec_plc . $format;
+		// currency symbol on right side.
+		$format = $currency_config->sign_b4 ? $currency_config->sign . $format : $format . $currency_config->sign;
+		return $format;
+	}
 
 
-    /**
-     * This returns a localized format string suitable for usage with the Google Charts API format param.
-     *
-     * @param string $CNT_ISO  If this is provided, then will attempt to get the currency settings for the country.
-     *                         Otherwise will use currency settings for current active country on site.
-     *                         Note: GoogleCharts uses ICU pattern set
-     *                         (@return array
-     * @throws EE_Error
-     * @see http://icu-project.org/apiref/icu4c/classDecimalFormat.html#_details)
-     */
-    public static function get_format_for_google_charts($CNT_ISO = '')
-    {
-        $currency_config = EEH_Money::get_currency_config($CNT_ISO);
-        $decimal_places_placeholder = str_pad('', $currency_config->dec_plc, '0');
-        // first get the decimal place and number of places
-        $format = '#,##0.' . $decimal_places_placeholder;
-        // currency symbol on right side.
-        $format = $currency_config->sign_b4
-            ? $currency_config->sign . $format
-            : $format
-              . $currency_config->sign;
-        $formatterObject = array(
-            'decimalSymbol'  => $currency_config->dec_mrk,
-            'groupingSymbol' => $currency_config->thsnds,
-            'fractionDigits' => $currency_config->dec_plc,
-        );
-        if ($currency_config->sign_b4) {
-            $formatterObject['prefix'] = $currency_config->sign;
-        } else {
-            $formatterObject['suffix'] = $currency_config->sign;
-        }
-        return array(
-            'format'          => $format,
-            'formatterObject' => $formatterObject,
-        );
-    }
+	/**
+	 * This returns a localized format string suitable for usage with the Google Charts API format param.
+	 *
+	 * @param string $CNT_ISO  If this is provided, then will attempt to get the currency settings for the country.
+	 *                         Otherwise will use currency settings for current active country on site.
+	 *                         Note: GoogleCharts uses ICU pattern set
+	 *                         (@return array
+	 * @throws EE_Error
+	 * @see http://icu-project.org/apiref/icu4c/classDecimalFormat.html#_details)
+	 */
+	public static function get_format_for_google_charts($CNT_ISO = '')
+	{
+		$currency_config = EEH_Money::get_currency_config($CNT_ISO);
+		$decimal_places_placeholder = str_pad('', $currency_config->dec_plc, '0');
+		// first get the decimal place and number of places
+		$format = '#,##0.' . $decimal_places_placeholder;
+		// currency symbol on right side.
+		$format = $currency_config->sign_b4
+			? $currency_config->sign . $format
+			: $format
+			  . $currency_config->sign;
+		$formatterObject = array(
+			'decimalSymbol'  => $currency_config->dec_mrk,
+			'groupingSymbol' => $currency_config->thsnds,
+			'fractionDigits' => $currency_config->dec_plc,
+		);
+		if ($currency_config->sign_b4) {
+			$formatterObject['prefix'] = $currency_config->sign;
+		} else {
+			$formatterObject['suffix'] = $currency_config->sign;
+		}
+		return array(
+			'format'          => $format,
+			'formatterObject' => $formatterObject,
+		);
+	}
 
 
-    /**
-     * @param string $CNT_ISO
-     * @return EE_Currency_Config
-     * @throws EE_Error
-     */
-    public static function get_currency_config($CNT_ISO = '')
-    {
-        // if CNT_ISO passed lets try to get currency settings for it.
-        $currency_config = $CNT_ISO !== ''
-            ? new EE_Currency_Config($CNT_ISO)
-            : null;
-        // default currency settings for site if not set
-        if (! $currency_config instanceof EE_Currency_Config) {
-            $currency_config = EE_Registry::instance()->CFG->currency instanceof EE_Currency_Config
-                ? EE_Registry::instance()->CFG->currency
-                : new EE_Currency_Config();
-        }
-        return $currency_config;
-    }
+	/**
+	 * @param string $CNT_ISO
+	 * @return EE_Currency_Config
+	 * @throws EE_Error
+	 */
+	public static function get_currency_config($CNT_ISO = '')
+	{
+		// if CNT_ISO passed lets try to get currency settings for it.
+		$currency_config = $CNT_ISO !== ''
+			? new EE_Currency_Config($CNT_ISO)
+			: null;
+		// default currency settings for site if not set
+		if (! $currency_config instanceof EE_Currency_Config) {
+			$currency_config = EE_Registry::instance()->CFG->currency instanceof EE_Currency_Config
+				? EE_Registry::instance()->CFG->currency
+				: new EE_Currency_Config();
+		}
+		return $currency_config;
+	}
 
 
-    /**
-     * @param string|null $CNT_ISO
-     * @param bool        $as_decimal if false [default] will return the number of decimal places ex: 1, 2, 3
-     *                                if true, will return the subunits as a decimal fraction ex: .1, .01, .001
-     * @return float
-     * @throws EE_Error
-     * @since $VID:$
-     */
-    public static function getCurrencySubUnits(?string $CNT_ISO = '', bool $as_decimal = false): float
-    {
-        $currency_config = EEH_Money::get_currency_config($CNT_ISO);
-        return $as_decimal ? pow(10, ($currency_config->dec_plc * -1)) : $currency_config->dec_plc;
-    }
+	/**
+	 * @param string|null $CNT_ISO
+	 * @param bool        $as_decimal if false [default] will return the number of decimal places ex: 1, 2, 3
+	 *                                if true, will return the subunits as a decimal fraction ex: .1, .01, .001
+	 * @return float
+	 * @throws EE_Error
+	 * @since $VID:$
+	 */
+	public static function getCurrencySubUnits(?string $CNT_ISO = '', bool $as_decimal = false): float
+	{
+		$currency_config = EEH_Money::get_currency_config($CNT_ISO);
+		return $as_decimal ? pow(10, ($currency_config->dec_plc * -1)) : $currency_config->dec_plc;
+	}
 }

core/helpers/EEH_Template.helper.php

Indentation +996 added lines, -996 removed lines

@@ -6,36 +6,36 @@ 
 use EventEspresso\core\services\request\RequestInterface;
 
 if (! function_exists('espresso_get_template_part')) {
-    /**
-     * espresso_get_template_part
-     * basically a copy of the WordPress get_template_part() function but uses EEH_Template::locate_template() instead, and doesn't add base versions of files
-     * so not a very useful function at all except that it adds familiarity PLUS filtering based off of the entire template part name
-     *
-     * @param string $slug The slug name for the generic template.
-     * @param string $name The name of the specialised template.
-     */
-    function espresso_get_template_part($slug = null, $name = null)
-    {
-        EEH_Template::get_template_part($slug, $name);
-    }
+	/**
+	 * espresso_get_template_part
+	 * basically a copy of the WordPress get_template_part() function but uses EEH_Template::locate_template() instead, and doesn't add base versions of files
+	 * so not a very useful function at all except that it adds familiarity PLUS filtering based off of the entire template part name
+	 *
+	 * @param string $slug The slug name for the generic template.
+	 * @param string $name The name of the specialised template.
+	 */
+	function espresso_get_template_part($slug = null, $name = null)
+	{
+		EEH_Template::get_template_part($slug, $name);
+	}
 }
 
 
 if (! function_exists('espresso_get_object_css_class')) {
-    /**
-     * espresso_get_object_css_class - attempts to generate a css class based on the type of EE object passed
-     *
-     * @param EE_Base_Class $object the EE object the css class is being generated for
-     * @param string        $prefix added to the beginning of the generated class
-     * @param string        $suffix added to the end of the generated class
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    function espresso_get_object_css_class($object = null, $prefix = '', $suffix = '')
-    {
-        return EEH_Template::get_object_css_class($object, $prefix, $suffix);
-    }
+	/**
+	 * espresso_get_object_css_class - attempts to generate a css class based on the type of EE object passed
+	 *
+	 * @param EE_Base_Class $object the EE object the css class is being generated for
+	 * @param string        $prefix added to the beginning of the generated class
+	 * @param string        $suffix added to the end of the generated class
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	function espresso_get_object_css_class($object = null, $prefix = '', $suffix = '')
+	{
+		return EEH_Template::get_object_css_class($object, $prefix, $suffix);
+	}
 }
 
 
@@ -50,710 +50,710 @@ 
 class EEH_Template
 {
 
-    private static $_espresso_themes = [];
-
-
-    /**
-     *    is_espresso_theme - returns TRUE or FALSE on whether the currently active WP theme is an espresso theme
-     *
-     * @return boolean
-     */
-    public static function is_espresso_theme()
-    {
-        return wp_get_theme()->get('TextDomain') === 'event_espresso';
-    }
-
-
-    /**
-     *    load_espresso_theme_functions - if current theme is an espresso theme, or uses ee theme template parts, then
-     *    load its functions.php file ( if not already loaded )
-     *
-     * @return void
-     */
-    public static function load_espresso_theme_functions()
-    {
-        if (! defined('EE_THEME_FUNCTIONS_LOADED')) {
-            if (is_readable(EE_PUBLIC . EE_Config::get_current_theme() . '/functions.php')) {
-                require_once(EE_PUBLIC . EE_Config::get_current_theme() . '/functions.php');
-            }
-        }
-    }
-
-
-    /**
-     *    get_espresso_themes - returns an array of Espresso Child themes located in the /templates/ directory
-     *
-     * @return array
-     */
-    public static function get_espresso_themes()
-    {
-        if (empty(EEH_Template::$_espresso_themes)) {
-            $espresso_themes = glob(EE_PUBLIC . '*', GLOB_ONLYDIR);
-            if (empty($espresso_themes)) {
-                return [];
-            }
-            if (($key = array_search('global_assets', $espresso_themes)) !== false) {
-                unset($espresso_themes[ $key ]);
-            }
-            EEH_Template::$_espresso_themes = [];
-            foreach ($espresso_themes as $espresso_theme) {
-                EEH_Template::$_espresso_themes[ basename($espresso_theme) ] = $espresso_theme;
-            }
-        }
-        return EEH_Template::$_espresso_themes;
-    }
-
-
-    /**
-     * EEH_Template::get_template_part
-     * basically a copy of the WordPress get_template_part() function but uses EEH_Template::locate_template() instead,
-     * and doesn't add base versions of files so not a very useful function at all except that it adds familiarity PLUS
-     * filtering based off of the entire template part name
-     *
-     * @param string $slug The slug name for the generic template.
-     * @param string $name The name of the specialised template.
-     * @param array  $template_args
-     * @param bool   $return_string
-     * @return string        the html output for the formatted money value
-     */
-    public static function get_template_part(
-        $slug = null,
-        $name = null,
-        $template_args = [],
-        $return_string = false
-    ) {
-        do_action("get_template_part_{$slug}-{$name}", $slug, $name);
-        $templates = [];
-        $name      = (string) $name;
-        if ($name != '') {
-            $templates[] = "{$slug}-{$name}.php";
-        }
-        // allow template parts to be turned off via something like:
-        // add_filter( 'FHEE__content_espresso_events_tickets_template__display_datetimes', '__return_false' );
-        if (apply_filters("FHEE__EEH_Template__get_template_part__display__{$slug}_{$name}", true)) {
-            return EEH_Template::locate_template($templates, $template_args, true, $return_string);
-        }
-        return '';
-    }
-
-
-    /**
-     *    locate_template
-     *    locate a template file by looking in the following places, in the following order:
-     *        <server path up to>/wp-content/themes/<current active WordPress theme>/
-     *        <assumed full absolute server path>
-     *        <server path up to>/wp-content/uploads/espresso/templates/<current EE theme>/
-     *        <server path up to>/wp-content/uploads/espresso/templates/
-     *        <server path up to>/wp-content/plugins/<EE4 folder>/public/<current EE theme>/
-     *        <server path up to>/wp-content/plugins/<EE4 folder>/core/templates/<current EE theme>/
-     *        <server path up to>/wp-content/plugins/<EE4 folder>/
-     *    as soon as the template is found in one of these locations, it will be returned or loaded
-     *        Example:
-     *          You are using the WordPress Twenty Sixteen theme,
-     *        and you want to customize the "some-event.template.php" template,
-     *          which is located in the "/relative/path/to/" folder relative to the main EE plugin folder.
-     *          Assuming WP is installed on your server in the "/home/public_html/" folder,
-     *        EEH_Template::locate_template() will look at the following paths in order until the template is found:
-     *        /home/public_html/wp-content/themes/twentysixteen/some-event.template.php
-     *        /relative/path/to/some-event.template.php
-     *        /home/public_html/wp-content/uploads/espresso/templates/Espresso_Arabica_2014/relative/path/to/some-event.template.php
-     *        /home/public_html/wp-content/uploads/espresso/templates/relative/path/to/some-event.template.php
-     *        /home/public_html/wp-content/plugins/event-espresso-core-reg/public/Espresso_Arabica_2014/relative/path/to/some-event.template.php
-     *        /home/public_html/wp-content/plugins/event-espresso-core-reg/core/templates/Espresso_Arabica_2014/relative/path/to/some-event.template.php
-     *        /home/public_html/wp-content/plugins/event-espresso-core-reg/relative/path/to/some-event.template.php
-     *          Had you passed an absolute path to your template that was in some other location,
-     *        ie: "/absolute/path/to/some-event.template.php"
-     *          then the search would have been :
-     *        /home/public_html/wp-content/themes/twentysixteen/some-event.template.php
-     *        /absolute/path/to/some-event.template.php
-     *          and stopped there upon finding it in the second location
-     *
-     * @param array|string $templates       array of template file names including extension (or just a single string)
-     * @param array        $template_args   an array of arguments to be extracted for use in the template
-     * @param boolean      $load            whether to pass the located template path on to the
-     *                                      EEH_Template::display_template() method or simply return it
-     * @param boolean      $return_string   whether to send output immediately to screen, or capture and return as a
-     *                                      string
-     * @param boolean      $check_if_custom If TRUE, this flags this method to return boolean for whether this will
-     *                                      generate a custom template or not. Used in places where you don't actually
-     *                                      load the template, you just want to know if there's a custom version of it.
-     * @return mixed
-     * @throws DomainException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function locate_template(
-        $templates = [],
-        $template_args = [],
-        $load = true,
-        $return_string = true,
-        $check_if_custom = false
-    ) {
-        // first use WP locate_template to check for template in the current theme folder
-        $template_path = locate_template($templates);
-
-        if ($check_if_custom && ! empty($template_path)) {
-            return true;
-        }
-
-        // not in the theme
-        if (empty($template_path)) {
-            // not even a template to look for ?
-            if (empty($templates)) {
-                $loader = LoaderFactory::getLoader();
-                /** @var RequestInterface $request */
-                $request = $loader->getShared(RequestInterface::class);
-                // get post_type
-                $post_type = $request->getRequestParam('post_type');
-                /** @var EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions $custom_post_types */
-                $custom_post_types = $loader->getShared(
-                    'EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions'
-                );
-                // get array of EE Custom Post Types
-                $EE_CPTs = $custom_post_types->getDefinitions();
-                // build template name based on request
-                if (isset($EE_CPTs[ $post_type ])) {
-                    $archive_or_single = is_archive() ? 'archive' : '';
-                    $archive_or_single = is_single() ? 'single' : $archive_or_single;
-                    $templates         = $archive_or_single . '-' . $post_type . '.php';
-                }
-            }
-            // currently active EE template theme
-            $current_theme = EE_Config::get_current_theme();
-
-            // array of paths to folders that may contain templates
-            $template_folder_paths = [
-                // first check the /wp-content/uploads/espresso/templates/(current EE theme)/  folder for an EE theme template file
-                EVENT_ESPRESSO_TEMPLATE_DIR . $current_theme,
-                // then in the root of the /wp-content/uploads/espresso/templates/ folder
-                EVENT_ESPRESSO_TEMPLATE_DIR,
-            ];
-
-            // add core plugin folders for checking only if we're not $check_if_custom
-            if (! $check_if_custom) {
-                $core_paths            = [
-                    // in the  /wp-content/plugins/(EE4 folder)/public/(current EE theme)/ folder within the plugin
-                    EE_PUBLIC . $current_theme,
-                    // in the  /wp-content/plugins/(EE4 folder)/core/templates/(current EE theme)/ folder within the plugin
-                    EE_TEMPLATES . $current_theme,
-                    // or maybe relative from the plugin root: /wp-content/plugins/(EE4 folder)/
-                    EE_PLUGIN_DIR_PATH,
-                ];
-                $template_folder_paths = array_merge($template_folder_paths, $core_paths);
-            }
-
-            // now filter that array
-            $template_folder_paths = apply_filters(
-                'FHEE__EEH_Template__locate_template__template_folder_paths',
-                $template_folder_paths
-            );
-            $templates             = is_array($templates) ? $templates : [$templates];
-            $template_folder_paths =
-                is_array($template_folder_paths) ? $template_folder_paths : [$template_folder_paths];
-            // array to hold all possible template paths
-            $full_template_paths = [];
-            $file_name           = '';
-
-            // loop through $templates
-            foreach ($templates as $template) {
-                // normalize directory separators
-                $template                      = EEH_File::standardise_directory_separators($template);
-                $file_name                     = basename($template);
-                $template_path_minus_file_name = substr($template, 0, (strlen($file_name) * -1));
-                // while looping through all template folder paths
-                foreach ($template_folder_paths as $template_folder_path) {
-                    // normalize directory separators
-                    $template_folder_path = EEH_File::standardise_directory_separators($template_folder_path);
-                    // determine if any common base path exists between the two paths
-                    $common_base_path = EEH_Template::_find_common_base_path(
-                        [$template_folder_path, $template_path_minus_file_name]
-                    );
-                    if ($common_base_path !== '') {
-                        // both paths have a common base, so just tack the filename onto our search path
-                        $resolved_path = EEH_File::end_with_directory_separator($template_folder_path) . $file_name;
-                    } else {
-                        // no common base path, so let's just concatenate
-                        $resolved_path = EEH_File::end_with_directory_separator($template_folder_path) . $template;
-                    }
-                    // build up our template locations array by adding our resolved paths
-                    $full_template_paths[] = $resolved_path;
-                }
-                // if $template is an absolute path, then we'll tack it onto the start of our array so that it gets searched first
-                array_unshift($full_template_paths, $template);
-                // path to the directory of the current theme: /wp-content/themes/(current WP theme)/
-                array_unshift($full_template_paths, get_stylesheet_directory() . '/' . $file_name);
-            }
-            // filter final array of full template paths
-            $full_template_paths = apply_filters(
-                'FHEE__EEH_Template__locate_template__full_template_paths',
-                $full_template_paths,
-                $file_name
-            );
-            // now loop through our final array of template location paths and check each location
-            foreach ((array) $full_template_paths as $full_template_path) {
-                if (is_readable($full_template_path)) {
-                    $template_path = str_replace(['\\', '/'], DIRECTORY_SEPARATOR, $full_template_path);
-                    break;
-                }
-            }
-        }
-
-        // hook that can be used to display the full template path that will be used
-        do_action('AHEE__EEH_Template__locate_template__full_template_path', $template_path);
-
-        // if we got it and you want to see it...
-        if ($template_path && $load && ! $check_if_custom) {
-            if ($return_string) {
-                return EEH_Template::display_template($template_path, $template_args, true);
-            }
-            EEH_Template::display_template($template_path, $template_args);
-        }
-        return $check_if_custom && ! empty($template_path) ? true : $template_path;
-    }
-
-
-    /**
-     * _find_common_base_path
-     * given two paths, this determines if there is a common base path between the two
-     *
-     * @param array $paths
-     * @return string
-     */
-    protected static function _find_common_base_path($paths)
-    {
-        $last_offset      = 0;
-        $common_base_path = '';
-        while (($index = strpos($paths[0], '/', $last_offset)) !== false) {
-            $dir_length = $index - $last_offset + 1;
-            $directory  = substr($paths[0], $last_offset, $dir_length);
-            foreach ($paths as $path) {
-                if (substr($path, $last_offset, $dir_length) != $directory) {
-                    return $common_base_path;
-                }
-            }
-            $common_base_path .= $directory;
-            $last_offset      = $index + 1;
-        }
-        return substr($common_base_path, 0, -1);
-    }
-
-
-    /**
-     * load and display a template
-     *
-     * @param bool|string $template_path    server path to the file to be loaded, including file name and extension
-     * @param array       $template_args    an array of arguments to be extracted for use in the template
-     * @param boolean     $return_string    whether to send output immediately to screen, or capture and return as a
-     *                                      string
-     * @param bool        $throw_exceptions if set to true, will throw an exception if the template is either
-     *                                      not found or is not readable
-     * @return string
-     * @throws DomainException
-     */
-    public static function display_template(
-        $template_path = false,
-        $template_args = [],
-        $return_string = false,
-        $throw_exceptions = false
-    ) {
-
-        /**
-         * These two filters are intended for last minute changes to templates being loaded and/or template arg
-         * modifications.  NOTE... modifying these things can cause breakage as most templates running through
-         * the display_template method are templates we DON'T want modified (usually because of js
-         * dependencies etc).  So unless you know what you are doing, do NOT filter templates or template args
-         * using this.
-         *
-         * @since 4.6.0
-         */
-        $template_path = (string) apply_filters('FHEE__EEH_Template__display_template__template_path', $template_path);
-        $template_args = (array) apply_filters('FHEE__EEH_Template__display_template__template_args', $template_args);
-
-        // you gimme nuttin - YOU GET NUTTIN !!
-        if (! $template_path || ! is_readable($template_path)) {
-            // ignore whether template is accessible ?
-            if ($throw_exceptions) {
-                throw new DomainException(
-                    esc_html__('Invalid, unreadable, or missing file.', 'event_espresso')
-                );
-            }
-            return '';
-        }
-        // if $template_args are not in an array, then make it so
-        if (! is_array($template_args) && ! is_object($template_args)) {
-            $template_args = [$template_args];
-        }
-        extract($template_args, EXTR_SKIP);
-
-        if ($return_string) {
-            // because we want to return a string, we are going to capture the output
-            ob_start();
-            include($template_path);
-            return ob_get_clean();
-        }
-        include($template_path);
-        return '';
-    }
-
-
-    /**
-     * get_object_css_class - attempts to generate a css class based on the type of EE object passed
-     *
-     * @param EE_Base_Class $object the EE object the css class is being generated for
-     * @param string        $prefix added to the beginning of the generated class
-     * @param string        $suffix added to the end of the generated class
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function get_object_css_class($object = null, $prefix = '', $suffix = '')
-    {
-        // in the beginning...
-        $prefix = ! empty($prefix) ? rtrim($prefix, '-') . '-' : '';
-        // da muddle
-        $class = '';
-        // the end
-        $suffix = ! empty($suffix) ? '-' . ltrim($suffix, '-') : '';
-        // is the passed object an EE object ?
-        if ($object instanceof EE_Base_Class) {
-            // grab the exact type of object
-            $obj_class = get_class($object);
-            // depending on the type of object...
-            switch ($obj_class) {
-                // no specifics just yet...
-                default:
-                    $class = strtolower(str_replace('_', '-', $obj_class));
-                    $class .= method_exists($obj_class, 'name') ? '-' . sanitize_title($object->name()) : '';
-            }
-        }
-        return $prefix . $class . $suffix;
-    }
-
-
-    /**
-     * EEH_Template::format_currency
-     * This helper takes a raw float value and formats it according to the default config country currency settings, or
-     * the country currency settings from the supplied country ISO code
-     *
-     * @param float   $amount       raw money value
-     * @param boolean $return_raw   whether to return the formatted float value only with no currency sign or code
-     * @param boolean $display_code whether to display the country code (USD). Default = TRUE
-     * @param string  $CNT_ISO      2 letter ISO code for a country
-     * @param string  $cur_code_span_class
-     * @return string        the html output for the formatted money value
-     */
-    public static function format_currency(
-        $amount = null,
-        $return_raw = false,
-        $display_code = true,
-        $CNT_ISO = '',
-        $cur_code_span_class = 'currency-code'
-    ) {
-        // ensure amount was received
-        if ($amount === null) {
-            $msg = esc_html__('In order to format currency, an amount needs to be passed.', 'event_espresso');
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return '';
-        }
-        // ensure amount is float
-        $amount  = (float) apply_filters('FHEE__EEH_Template__format_currency__raw_amount', (float) $amount);
-        $CNT_ISO = apply_filters('FHEE__EEH_Template__format_currency__CNT_ISO', $CNT_ISO, $amount);
-        // filter raw amount (allows 0.00 to be changed to "free" for example)
-        $amount_formatted = apply_filters('FHEE__EEH_Template__format_currency__amount', $amount, $return_raw);
-        // still a number, or was amount converted to a string like "free" ?
-        if (! is_float($amount_formatted)) {
-            return esc_html($amount_formatted);
-        }
-        try {
-            // was a country ISO code passed ? if so generate currency config object for that country
-            $mny = $CNT_ISO !== '' ? new EE_Currency_Config($CNT_ISO) : null;
-        } catch (Exception $e) {
-            // eat exception
-            $mny = null;
-        }
-        // verify results
-        if (! $mny instanceof EE_Currency_Config) {
-            // set default config country currency settings
-            $mny = EE_Registry::instance()->CFG->currency instanceof EE_Currency_Config
-                ? EE_Registry::instance()->CFG->currency
-                : new EE_Currency_Config();
-        }
-        // format float
-        $amount_formatted = number_format($amount, $mny->dec_plc, $mny->dec_mrk, $mny->thsnds);
-        // add formatting ?
-        if (! $return_raw) {
-            // add currency sign
-            if ($mny->sign_b4) {
-                if ($amount >= 0) {
-                    $amount_formatted = $mny->sign . $amount_formatted;
-                } else {
-                    $amount_formatted = '-' . $mny->sign . str_replace('-', '', $amount_formatted);
-                }
-            } else {
-                $amount_formatted = $amount_formatted . $mny->sign;
-            }
-
-            // filter to allow global setting of display_code
-            $display_code = (bool) apply_filters(
-                'FHEE__EEH_Template__format_currency__display_code',
-                $display_code
-            );
-
-            // add currency code ?
-            $amount_formatted = $display_code
-                ? $amount_formatted . ' <span class="' . $cur_code_span_class . '">(' . $mny->code . ')</span>'
-                : $amount_formatted;
-        }
-        // filter results
-        $amount_formatted = apply_filters(
-            'FHEE__EEH_Template__format_currency__amount_formatted',
-            $amount_formatted,
-            $mny,
-            $return_raw
-        );
-        // clean up vars
-        unset($mny);
-        // return formatted currency amount
-        return $amount_formatted;
-    }
-
-
-    /**
-     * This function is used for outputting the localized label for a given status id in the schema requested (and
-     * possibly plural).  The intended use of this function is only for cases where wanting a label outside of a
-     * related status model or model object (i.e. in documentation etc.)
-     *
-     * @param string  $status_id  Status ID matching a registered status in the esp_status table.  If there is no
-     *                            match, then 'Unknown' will be returned.
-     * @param boolean $plural     Whether to return plural or not
-     * @param string  $schema     'UPPER', 'lower', or 'Sentence'
-     * @return string             The localized label for the status id.
-     * @throws EE_Error
-     */
-    public static function pretty_status($status_id, $plural = false, $schema = 'upper')
-    {
-        $status = EEM_Status::instance()->localized_status(
-            [$status_id => esc_html__('unknown', 'event_espresso')],
-            $plural,
-            $schema
-        );
-        return $status[ $status_id ];
-    }
-
-
-    /**
-     * This helper just returns a button or link for the given parameters
-     *
-     * @param string $url   the url for the link, note that `esc_url` will be called on it
-     * @param string $label What is the label you want displayed for the button
-     * @param string $class what class is used for the button (defaults to 'button--primary')
-     * @param string $icon
-     * @param string $title
-     * @return string the html output for the button
-     */
-    public static function get_button_or_link($url, $label, $class = 'button button--primary', $icon = '', $title = '')
-    {
-        $icon_html = '';
-        if (! empty($icon)) {
-            $dashicons = preg_split("(ee-icon |dashicons )", $icon);
-            $dashicons = array_filter($dashicons);
-            $count     = count($dashicons);
-            $icon_html .= $count > 1 ? '<span class="ee-composite-dashicon">' : '';
-            foreach ($dashicons as $dashicon) {
-                $type      = strpos($dashicon, 'ee-icon') !== false ? 'ee-icon ' : 'dashicons ';
-                $icon_html .= '<span class="' . $type . $dashicon . '"></span>';
-            }
-            $icon_html .= $count > 1 ? '</span>' : '';
-        }
-        // sanitize & escape
-        $id    = sanitize_title_with_dashes($label);
-        $url   = esc_url_raw($url);
-        $class = esc_attr($class);
-        $title = esc_attr($title);
-        $class .= $title ? ' ee-aria-tooltip' : '';
-        $title = $title ? " aria-label='{$title}'" : '';
-        $label = esc_html($label);
-        return "<a id='{$id}' href='{$url}' class='{$class}'{$title}>{$icon_html}{$label}</a>";
-    }
-
-
-    /**
-     * This returns a generated link that will load the related help tab on admin pages.
-     *
-     * @param string      $help_tab_id the id for the connected help tab
-     * @param bool|string $page        The page identifier for the page the help tab is on
-     * @param bool|string $action      The action (route) for the admin page the help tab is on.
-     * @param bool|string $icon_style  (optional) include css class for the style you want to use for the help icon.
-     * @param bool|string $help_text   (optional) send help text you want to use for the link if default not to be used
-     * @return string              generated link
-     */
-    public static function get_help_tab_link(
-        $help_tab_id,
-        $page = false,
-        $action = false,
-        $icon_style = false,
-        $help_text = false
-    ) {
-        global $allowedtags;
-        /** @var RequestInterface $request */
-        $request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-        $page    = $page ?: $request->getRequestParam('page', '', 'key');
-        $action  = $action ?: $request->getRequestParam('action', 'default', 'key');
-
-
-        $help_tab_lnk = $page . '-' . $action . '-' . $help_tab_id;
-        $icon         = ! $icon_style ? ' dashicons-editor-help' : $icon_style;
-        $help_text    = ! $help_text ? '' : $help_text;
-        return '<a id="'
-               . esc_attr($help_tab_lnk)
-               . '" class="ee-clickable dashicons espresso-help-tab-lnk ee-icon-size-22'
-               . esc_attr($icon)
-               . '" title="'
-               . esc_attr__(
-                   'Click to open the \'Help\' tab for more information about this feature.',
-                   'event_espresso'
-               )
-               . '" > '
-               . wp_kses($help_text, $allowedtags)
-               . ' </a>';
-    }
-
-
-    /**
-     * This helper generates the html structure for the jquery joyride plugin with the given params.
-     *
-     * @link http://zurb.com/playground/jquery-joyride-feature-tour-plugin
-     * @see  EE_Admin_Page->_stop_callback() for the construct expected for the $stops param.
-     * @param EE_Help_Tour
-     * @return string         html
-     * @throws EE_Error
-     */
-    public static function help_tour_stops_generator(EE_Help_Tour $tour)
-    {
-        global $allowedtags;
-        $id    = $tour->get_slug();
-        $stops = $tour->get_stops();
-
-        $content = '<ol style="display:none" id="' . esc_attr($id) . '">';
-
-        foreach ($stops as $stop) {
-            $data_id    = ! empty($stop['id'])
-                ? ' data-id="' . esc_attr($stop['id']) . '"'
-                : '';
-
-            $data_class = empty($data_id) && ! empty($stop['class'])
-                ? ' data-class="' . esc_attr($stop['class']) . '"'
-                : '';
-
-            // if container is set to modal then let's make sure we set the options accordingly
-            if (empty($data_id) && empty($data_class)) {
-                $stop['options']['modal']  = true;
-                $stop['options']['expose'] = true;
-            }
-
-            $custom_class  = ! empty($stop['custom_class'])
-                ? ' class="' . esc_attr($stop['custom_class']) . '"'
-                : '';
-            $button_text   = ! empty($stop['button_text'])
-                ? ' data-button="' . esc_html($stop['button_text']) . '"'
-                : '';
-            $inner_content = isset($stop['content']) ? wp_kses($stop['content'], $allowedtags) : '';
-
-            // options
-            if (isset($stop['options']) && is_array($stop['options'])) {
-                $options = ' data-options="';
-                foreach ($stop['options'] as $option => $value) {
-                    $options .= esc_attr($option) . ':' . esc_attr($value) . ';';
-                }
-                $options .= '"';
-            } else {
-                $options = '';
-            }
-
-            // let's put all together
-            $content .= '<li'
-                        . $data_id
-                        . $data_class
-                        . $custom_class
-                        . $button_text
-                        . $options
-                        . '>'
-                        . $inner_content
-                        . '</li>';
-        }
-
-        $content .= '</ol>';
-        return $content;
-    }
-
-
-    /**
-     * This is a helper method to generate a status legend for a given status array.
-     * Note this will only work if the incoming statuses have a key in the EEM_Status->localized_status() methods
-     * status_array.
-     *
-     * @param array  $status_array   array of statuses that will make up the legend. In format:
-     *                               array(
-     *                               'status_item' => 'status_name'
-     *                               )
-     * @param string $active_status  This is used to indicate what the active status is IF that is to be highlighted in
-     *                               the legend.
-     * @return string               html structure for status.
-     * @throws EE_Error
-     */
-    public static function status_legend($status_array, $active_status = '')
-    {
-        if (! is_array($status_array)) {
-            throw new EE_Error(
-                esc_html__(
-                    'The EEH_Template::status_legend helper required the incoming status_array argument to be an array!',
-                    'event_espresso'
-                )
-            );
-        }
-
-        $content = '
+	private static $_espresso_themes = [];
+
+
+	/**
+	 *    is_espresso_theme - returns TRUE or FALSE on whether the currently active WP theme is an espresso theme
+	 *
+	 * @return boolean
+	 */
+	public static function is_espresso_theme()
+	{
+		return wp_get_theme()->get('TextDomain') === 'event_espresso';
+	}
+
+
+	/**
+	 *    load_espresso_theme_functions - if current theme is an espresso theme, or uses ee theme template parts, then
+	 *    load its functions.php file ( if not already loaded )
+	 *
+	 * @return void
+	 */
+	public static function load_espresso_theme_functions()
+	{
+		if (! defined('EE_THEME_FUNCTIONS_LOADED')) {
+			if (is_readable(EE_PUBLIC . EE_Config::get_current_theme() . '/functions.php')) {
+				require_once(EE_PUBLIC . EE_Config::get_current_theme() . '/functions.php');
+			}
+		}
+	}
+
+
+	/**
+	 *    get_espresso_themes - returns an array of Espresso Child themes located in the /templates/ directory
+	 *
+	 * @return array
+	 */
+	public static function get_espresso_themes()
+	{
+		if (empty(EEH_Template::$_espresso_themes)) {
+			$espresso_themes = glob(EE_PUBLIC . '*', GLOB_ONLYDIR);
+			if (empty($espresso_themes)) {
+				return [];
+			}
+			if (($key = array_search('global_assets', $espresso_themes)) !== false) {
+				unset($espresso_themes[ $key ]);
+			}
+			EEH_Template::$_espresso_themes = [];
+			foreach ($espresso_themes as $espresso_theme) {
+				EEH_Template::$_espresso_themes[ basename($espresso_theme) ] = $espresso_theme;
+			}
+		}
+		return EEH_Template::$_espresso_themes;
+	}
+
+
+	/**
+	 * EEH_Template::get_template_part
+	 * basically a copy of the WordPress get_template_part() function but uses EEH_Template::locate_template() instead,
+	 * and doesn't add base versions of files so not a very useful function at all except that it adds familiarity PLUS
+	 * filtering based off of the entire template part name
+	 *
+	 * @param string $slug The slug name for the generic template.
+	 * @param string $name The name of the specialised template.
+	 * @param array  $template_args
+	 * @param bool   $return_string
+	 * @return string        the html output for the formatted money value
+	 */
+	public static function get_template_part(
+		$slug = null,
+		$name = null,
+		$template_args = [],
+		$return_string = false
+	) {
+		do_action("get_template_part_{$slug}-{$name}", $slug, $name);
+		$templates = [];
+		$name      = (string) $name;
+		if ($name != '') {
+			$templates[] = "{$slug}-{$name}.php";
+		}
+		// allow template parts to be turned off via something like:
+		// add_filter( 'FHEE__content_espresso_events_tickets_template__display_datetimes', '__return_false' );
+		if (apply_filters("FHEE__EEH_Template__get_template_part__display__{$slug}_{$name}", true)) {
+			return EEH_Template::locate_template($templates, $template_args, true, $return_string);
+		}
+		return '';
+	}
+
+
+	/**
+	 *    locate_template
+	 *    locate a template file by looking in the following places, in the following order:
+	 *        <server path up to>/wp-content/themes/<current active WordPress theme>/
+	 *        <assumed full absolute server path>
+	 *        <server path up to>/wp-content/uploads/espresso/templates/<current EE theme>/
+	 *        <server path up to>/wp-content/uploads/espresso/templates/
+	 *        <server path up to>/wp-content/plugins/<EE4 folder>/public/<current EE theme>/
+	 *        <server path up to>/wp-content/plugins/<EE4 folder>/core/templates/<current EE theme>/
+	 *        <server path up to>/wp-content/plugins/<EE4 folder>/
+	 *    as soon as the template is found in one of these locations, it will be returned or loaded
+	 *        Example:
+	 *          You are using the WordPress Twenty Sixteen theme,
+	 *        and you want to customize the "some-event.template.php" template,
+	 *          which is located in the "/relative/path/to/" folder relative to the main EE plugin folder.
+	 *          Assuming WP is installed on your server in the "/home/public_html/" folder,
+	 *        EEH_Template::locate_template() will look at the following paths in order until the template is found:
+	 *        /home/public_html/wp-content/themes/twentysixteen/some-event.template.php
+	 *        /relative/path/to/some-event.template.php
+	 *        /home/public_html/wp-content/uploads/espresso/templates/Espresso_Arabica_2014/relative/path/to/some-event.template.php
+	 *        /home/public_html/wp-content/uploads/espresso/templates/relative/path/to/some-event.template.php
+	 *        /home/public_html/wp-content/plugins/event-espresso-core-reg/public/Espresso_Arabica_2014/relative/path/to/some-event.template.php
+	 *        /home/public_html/wp-content/plugins/event-espresso-core-reg/core/templates/Espresso_Arabica_2014/relative/path/to/some-event.template.php
+	 *        /home/public_html/wp-content/plugins/event-espresso-core-reg/relative/path/to/some-event.template.php
+	 *          Had you passed an absolute path to your template that was in some other location,
+	 *        ie: "/absolute/path/to/some-event.template.php"
+	 *          then the search would have been :
+	 *        /home/public_html/wp-content/themes/twentysixteen/some-event.template.php
+	 *        /absolute/path/to/some-event.template.php
+	 *          and stopped there upon finding it in the second location
+	 *
+	 * @param array|string $templates       array of template file names including extension (or just a single string)
+	 * @param array        $template_args   an array of arguments to be extracted for use in the template
+	 * @param boolean      $load            whether to pass the located template path on to the
+	 *                                      EEH_Template::display_template() method or simply return it
+	 * @param boolean      $return_string   whether to send output immediately to screen, or capture and return as a
+	 *                                      string
+	 * @param boolean      $check_if_custom If TRUE, this flags this method to return boolean for whether this will
+	 *                                      generate a custom template or not. Used in places where you don't actually
+	 *                                      load the template, you just want to know if there's a custom version of it.
+	 * @return mixed
+	 * @throws DomainException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function locate_template(
+		$templates = [],
+		$template_args = [],
+		$load = true,
+		$return_string = true,
+		$check_if_custom = false
+	) {
+		// first use WP locate_template to check for template in the current theme folder
+		$template_path = locate_template($templates);
+
+		if ($check_if_custom && ! empty($template_path)) {
+			return true;
+		}
+
+		// not in the theme
+		if (empty($template_path)) {
+			// not even a template to look for ?
+			if (empty($templates)) {
+				$loader = LoaderFactory::getLoader();
+				/** @var RequestInterface $request */
+				$request = $loader->getShared(RequestInterface::class);
+				// get post_type
+				$post_type = $request->getRequestParam('post_type');
+				/** @var EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions $custom_post_types */
+				$custom_post_types = $loader->getShared(
+					'EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions'
+				);
+				// get array of EE Custom Post Types
+				$EE_CPTs = $custom_post_types->getDefinitions();
+				// build template name based on request
+				if (isset($EE_CPTs[ $post_type ])) {
+					$archive_or_single = is_archive() ? 'archive' : '';
+					$archive_or_single = is_single() ? 'single' : $archive_or_single;
+					$templates         = $archive_or_single . '-' . $post_type . '.php';
+				}
+			}
+			// currently active EE template theme
+			$current_theme = EE_Config::get_current_theme();
+
+			// array of paths to folders that may contain templates
+			$template_folder_paths = [
+				// first check the /wp-content/uploads/espresso/templates/(current EE theme)/  folder for an EE theme template file
+				EVENT_ESPRESSO_TEMPLATE_DIR . $current_theme,
+				// then in the root of the /wp-content/uploads/espresso/templates/ folder
+				EVENT_ESPRESSO_TEMPLATE_DIR,
+			];
+
+			// add core plugin folders for checking only if we're not $check_if_custom
+			if (! $check_if_custom) {
+				$core_paths            = [
+					// in the  /wp-content/plugins/(EE4 folder)/public/(current EE theme)/ folder within the plugin
+					EE_PUBLIC . $current_theme,
+					// in the  /wp-content/plugins/(EE4 folder)/core/templates/(current EE theme)/ folder within the plugin
+					EE_TEMPLATES . $current_theme,
+					// or maybe relative from the plugin root: /wp-content/plugins/(EE4 folder)/
+					EE_PLUGIN_DIR_PATH,
+				];
+				$template_folder_paths = array_merge($template_folder_paths, $core_paths);
+			}
+
+			// now filter that array
+			$template_folder_paths = apply_filters(
+				'FHEE__EEH_Template__locate_template__template_folder_paths',
+				$template_folder_paths
+			);
+			$templates             = is_array($templates) ? $templates : [$templates];
+			$template_folder_paths =
+				is_array($template_folder_paths) ? $template_folder_paths : [$template_folder_paths];
+			// array to hold all possible template paths
+			$full_template_paths = [];
+			$file_name           = '';
+
+			// loop through $templates
+			foreach ($templates as $template) {
+				// normalize directory separators
+				$template                      = EEH_File::standardise_directory_separators($template);
+				$file_name                     = basename($template);
+				$template_path_minus_file_name = substr($template, 0, (strlen($file_name) * -1));
+				// while looping through all template folder paths
+				foreach ($template_folder_paths as $template_folder_path) {
+					// normalize directory separators
+					$template_folder_path = EEH_File::standardise_directory_separators($template_folder_path);
+					// determine if any common base path exists between the two paths
+					$common_base_path = EEH_Template::_find_common_base_path(
+						[$template_folder_path, $template_path_minus_file_name]
+					);
+					if ($common_base_path !== '') {
+						// both paths have a common base, so just tack the filename onto our search path
+						$resolved_path = EEH_File::end_with_directory_separator($template_folder_path) . $file_name;
+					} else {
+						// no common base path, so let's just concatenate
+						$resolved_path = EEH_File::end_with_directory_separator($template_folder_path) . $template;
+					}
+					// build up our template locations array by adding our resolved paths
+					$full_template_paths[] = $resolved_path;
+				}
+				// if $template is an absolute path, then we'll tack it onto the start of our array so that it gets searched first
+				array_unshift($full_template_paths, $template);
+				// path to the directory of the current theme: /wp-content/themes/(current WP theme)/
+				array_unshift($full_template_paths, get_stylesheet_directory() . '/' . $file_name);
+			}
+			// filter final array of full template paths
+			$full_template_paths = apply_filters(
+				'FHEE__EEH_Template__locate_template__full_template_paths',
+				$full_template_paths,
+				$file_name
+			);
+			// now loop through our final array of template location paths and check each location
+			foreach ((array) $full_template_paths as $full_template_path) {
+				if (is_readable($full_template_path)) {
+					$template_path = str_replace(['\\', '/'], DIRECTORY_SEPARATOR, $full_template_path);
+					break;
+				}
+			}
+		}
+
+		// hook that can be used to display the full template path that will be used
+		do_action('AHEE__EEH_Template__locate_template__full_template_path', $template_path);
+
+		// if we got it and you want to see it...
+		if ($template_path && $load && ! $check_if_custom) {
+			if ($return_string) {
+				return EEH_Template::display_template($template_path, $template_args, true);
+			}
+			EEH_Template::display_template($template_path, $template_args);
+		}
+		return $check_if_custom && ! empty($template_path) ? true : $template_path;
+	}
+
+
+	/**
+	 * _find_common_base_path
+	 * given two paths, this determines if there is a common base path between the two
+	 *
+	 * @param array $paths
+	 * @return string
+	 */
+	protected static function _find_common_base_path($paths)
+	{
+		$last_offset      = 0;
+		$common_base_path = '';
+		while (($index = strpos($paths[0], '/', $last_offset)) !== false) {
+			$dir_length = $index - $last_offset + 1;
+			$directory  = substr($paths[0], $last_offset, $dir_length);
+			foreach ($paths as $path) {
+				if (substr($path, $last_offset, $dir_length) != $directory) {
+					return $common_base_path;
+				}
+			}
+			$common_base_path .= $directory;
+			$last_offset      = $index + 1;
+		}
+		return substr($common_base_path, 0, -1);
+	}
+
+
+	/**
+	 * load and display a template
+	 *
+	 * @param bool|string $template_path    server path to the file to be loaded, including file name and extension
+	 * @param array       $template_args    an array of arguments to be extracted for use in the template
+	 * @param boolean     $return_string    whether to send output immediately to screen, or capture and return as a
+	 *                                      string
+	 * @param bool        $throw_exceptions if set to true, will throw an exception if the template is either
+	 *                                      not found or is not readable
+	 * @return string
+	 * @throws DomainException
+	 */
+	public static function display_template(
+		$template_path = false,
+		$template_args = [],
+		$return_string = false,
+		$throw_exceptions = false
+	) {
+
+		/**
+		 * These two filters are intended for last minute changes to templates being loaded and/or template arg
+		 * modifications.  NOTE... modifying these things can cause breakage as most templates running through
+		 * the display_template method are templates we DON'T want modified (usually because of js
+		 * dependencies etc).  So unless you know what you are doing, do NOT filter templates or template args
+		 * using this.
+		 *
+		 * @since 4.6.0
+		 */
+		$template_path = (string) apply_filters('FHEE__EEH_Template__display_template__template_path', $template_path);
+		$template_args = (array) apply_filters('FHEE__EEH_Template__display_template__template_args', $template_args);
+
+		// you gimme nuttin - YOU GET NUTTIN !!
+		if (! $template_path || ! is_readable($template_path)) {
+			// ignore whether template is accessible ?
+			if ($throw_exceptions) {
+				throw new DomainException(
+					esc_html__('Invalid, unreadable, or missing file.', 'event_espresso')
+				);
+			}
+			return '';
+		}
+		// if $template_args are not in an array, then make it so
+		if (! is_array($template_args) && ! is_object($template_args)) {
+			$template_args = [$template_args];
+		}
+		extract($template_args, EXTR_SKIP);
+
+		if ($return_string) {
+			// because we want to return a string, we are going to capture the output
+			ob_start();
+			include($template_path);
+			return ob_get_clean();
+		}
+		include($template_path);
+		return '';
+	}
+
+
+	/**
+	 * get_object_css_class - attempts to generate a css class based on the type of EE object passed
+	 *
+	 * @param EE_Base_Class $object the EE object the css class is being generated for
+	 * @param string        $prefix added to the beginning of the generated class
+	 * @param string        $suffix added to the end of the generated class
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function get_object_css_class($object = null, $prefix = '', $suffix = '')
+	{
+		// in the beginning...
+		$prefix = ! empty($prefix) ? rtrim($prefix, '-') . '-' : '';
+		// da muddle
+		$class = '';
+		// the end
+		$suffix = ! empty($suffix) ? '-' . ltrim($suffix, '-') : '';
+		// is the passed object an EE object ?
+		if ($object instanceof EE_Base_Class) {
+			// grab the exact type of object
+			$obj_class = get_class($object);
+			// depending on the type of object...
+			switch ($obj_class) {
+				// no specifics just yet...
+				default:
+					$class = strtolower(str_replace('_', '-', $obj_class));
+					$class .= method_exists($obj_class, 'name') ? '-' . sanitize_title($object->name()) : '';
+			}
+		}
+		return $prefix . $class . $suffix;
+	}
+
+
+	/**
+	 * EEH_Template::format_currency
+	 * This helper takes a raw float value and formats it according to the default config country currency settings, or
+	 * the country currency settings from the supplied country ISO code
+	 *
+	 * @param float   $amount       raw money value
+	 * @param boolean $return_raw   whether to return the formatted float value only with no currency sign or code
+	 * @param boolean $display_code whether to display the country code (USD). Default = TRUE
+	 * @param string  $CNT_ISO      2 letter ISO code for a country
+	 * @param string  $cur_code_span_class
+	 * @return string        the html output for the formatted money value
+	 */
+	public static function format_currency(
+		$amount = null,
+		$return_raw = false,
+		$display_code = true,
+		$CNT_ISO = '',
+		$cur_code_span_class = 'currency-code'
+	) {
+		// ensure amount was received
+		if ($amount === null) {
+			$msg = esc_html__('In order to format currency, an amount needs to be passed.', 'event_espresso');
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return '';
+		}
+		// ensure amount is float
+		$amount  = (float) apply_filters('FHEE__EEH_Template__format_currency__raw_amount', (float) $amount);
+		$CNT_ISO = apply_filters('FHEE__EEH_Template__format_currency__CNT_ISO', $CNT_ISO, $amount);
+		// filter raw amount (allows 0.00 to be changed to "free" for example)
+		$amount_formatted = apply_filters('FHEE__EEH_Template__format_currency__amount', $amount, $return_raw);
+		// still a number, or was amount converted to a string like "free" ?
+		if (! is_float($amount_formatted)) {
+			return esc_html($amount_formatted);
+		}
+		try {
+			// was a country ISO code passed ? if so generate currency config object for that country
+			$mny = $CNT_ISO !== '' ? new EE_Currency_Config($CNT_ISO) : null;
+		} catch (Exception $e) {
+			// eat exception
+			$mny = null;
+		}
+		// verify results
+		if (! $mny instanceof EE_Currency_Config) {
+			// set default config country currency settings
+			$mny = EE_Registry::instance()->CFG->currency instanceof EE_Currency_Config
+				? EE_Registry::instance()->CFG->currency
+				: new EE_Currency_Config();
+		}
+		// format float
+		$amount_formatted = number_format($amount, $mny->dec_plc, $mny->dec_mrk, $mny->thsnds);
+		// add formatting ?
+		if (! $return_raw) {
+			// add currency sign
+			if ($mny->sign_b4) {
+				if ($amount >= 0) {
+					$amount_formatted = $mny->sign . $amount_formatted;
+				} else {
+					$amount_formatted = '-' . $mny->sign . str_replace('-', '', $amount_formatted);
+				}
+			} else {
+				$amount_formatted = $amount_formatted . $mny->sign;
+			}
+
+			// filter to allow global setting of display_code
+			$display_code = (bool) apply_filters(
+				'FHEE__EEH_Template__format_currency__display_code',
+				$display_code
+			);
+
+			// add currency code ?
+			$amount_formatted = $display_code
+				? $amount_formatted . ' <span class="' . $cur_code_span_class . '">(' . $mny->code . ')</span>'
+				: $amount_formatted;
+		}
+		// filter results
+		$amount_formatted = apply_filters(
+			'FHEE__EEH_Template__format_currency__amount_formatted',
+			$amount_formatted,
+			$mny,
+			$return_raw
+		);
+		// clean up vars
+		unset($mny);
+		// return formatted currency amount
+		return $amount_formatted;
+	}
+
+
+	/**
+	 * This function is used for outputting the localized label for a given status id in the schema requested (and
+	 * possibly plural).  The intended use of this function is only for cases where wanting a label outside of a
+	 * related status model or model object (i.e. in documentation etc.)
+	 *
+	 * @param string  $status_id  Status ID matching a registered status in the esp_status table.  If there is no
+	 *                            match, then 'Unknown' will be returned.
+	 * @param boolean $plural     Whether to return plural or not
+	 * @param string  $schema     'UPPER', 'lower', or 'Sentence'
+	 * @return string             The localized label for the status id.
+	 * @throws EE_Error
+	 */
+	public static function pretty_status($status_id, $plural = false, $schema = 'upper')
+	{
+		$status = EEM_Status::instance()->localized_status(
+			[$status_id => esc_html__('unknown', 'event_espresso')],
+			$plural,
+			$schema
+		);
+		return $status[ $status_id ];
+	}
+
+
+	/**
+	 * This helper just returns a button or link for the given parameters
+	 *
+	 * @param string $url   the url for the link, note that `esc_url` will be called on it
+	 * @param string $label What is the label you want displayed for the button
+	 * @param string $class what class is used for the button (defaults to 'button--primary')
+	 * @param string $icon
+	 * @param string $title
+	 * @return string the html output for the button
+	 */
+	public static function get_button_or_link($url, $label, $class = 'button button--primary', $icon = '', $title = '')
+	{
+		$icon_html = '';
+		if (! empty($icon)) {
+			$dashicons = preg_split("(ee-icon |dashicons )", $icon);
+			$dashicons = array_filter($dashicons);
+			$count     = count($dashicons);
+			$icon_html .= $count > 1 ? '<span class="ee-composite-dashicon">' : '';
+			foreach ($dashicons as $dashicon) {
+				$type      = strpos($dashicon, 'ee-icon') !== false ? 'ee-icon ' : 'dashicons ';
+				$icon_html .= '<span class="' . $type . $dashicon . '"></span>';
+			}
+			$icon_html .= $count > 1 ? '</span>' : '';
+		}
+		// sanitize & escape
+		$id    = sanitize_title_with_dashes($label);
+		$url   = esc_url_raw($url);
+		$class = esc_attr($class);
+		$title = esc_attr($title);
+		$class .= $title ? ' ee-aria-tooltip' : '';
+		$title = $title ? " aria-label='{$title}'" : '';
+		$label = esc_html($label);
+		return "<a id='{$id}' href='{$url}' class='{$class}'{$title}>{$icon_html}{$label}</a>";
+	}
+
+
+	/**
+	 * This returns a generated link that will load the related help tab on admin pages.
+	 *
+	 * @param string      $help_tab_id the id for the connected help tab
+	 * @param bool|string $page        The page identifier for the page the help tab is on
+	 * @param bool|string $action      The action (route) for the admin page the help tab is on.
+	 * @param bool|string $icon_style  (optional) include css class for the style you want to use for the help icon.
+	 * @param bool|string $help_text   (optional) send help text you want to use for the link if default not to be used
+	 * @return string              generated link
+	 */
+	public static function get_help_tab_link(
+		$help_tab_id,
+		$page = false,
+		$action = false,
+		$icon_style = false,
+		$help_text = false
+	) {
+		global $allowedtags;
+		/** @var RequestInterface $request */
+		$request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
+		$page    = $page ?: $request->getRequestParam('page', '', 'key');
+		$action  = $action ?: $request->getRequestParam('action', 'default', 'key');
+
+
+		$help_tab_lnk = $page . '-' . $action . '-' . $help_tab_id;
+		$icon         = ! $icon_style ? ' dashicons-editor-help' : $icon_style;
+		$help_text    = ! $help_text ? '' : $help_text;
+		return '<a id="'
+			   . esc_attr($help_tab_lnk)
+			   . '" class="ee-clickable dashicons espresso-help-tab-lnk ee-icon-size-22'
+			   . esc_attr($icon)
+			   . '" title="'
+			   . esc_attr__(
+				   'Click to open the \'Help\' tab for more information about this feature.',
+				   'event_espresso'
+			   )
+			   . '" > '
+			   . wp_kses($help_text, $allowedtags)
+			   . ' </a>';
+	}
+
+
+	/**
+	 * This helper generates the html structure for the jquery joyride plugin with the given params.
+	 *
+	 * @link http://zurb.com/playground/jquery-joyride-feature-tour-plugin
+	 * @see  EE_Admin_Page->_stop_callback() for the construct expected for the $stops param.
+	 * @param EE_Help_Tour
+	 * @return string         html
+	 * @throws EE_Error
+	 */
+	public static function help_tour_stops_generator(EE_Help_Tour $tour)
+	{
+		global $allowedtags;
+		$id    = $tour->get_slug();
+		$stops = $tour->get_stops();
+
+		$content = '<ol style="display:none" id="' . esc_attr($id) . '">';
+
+		foreach ($stops as $stop) {
+			$data_id    = ! empty($stop['id'])
+				? ' data-id="' . esc_attr($stop['id']) . '"'
+				: '';
+
+			$data_class = empty($data_id) && ! empty($stop['class'])
+				? ' data-class="' . esc_attr($stop['class']) . '"'
+				: '';
+
+			// if container is set to modal then let's make sure we set the options accordingly
+			if (empty($data_id) && empty($data_class)) {
+				$stop['options']['modal']  = true;
+				$stop['options']['expose'] = true;
+			}
+
+			$custom_class  = ! empty($stop['custom_class'])
+				? ' class="' . esc_attr($stop['custom_class']) . '"'
+				: '';
+			$button_text   = ! empty($stop['button_text'])
+				? ' data-button="' . esc_html($stop['button_text']) . '"'
+				: '';
+			$inner_content = isset($stop['content']) ? wp_kses($stop['content'], $allowedtags) : '';
+
+			// options
+			if (isset($stop['options']) && is_array($stop['options'])) {
+				$options = ' data-options="';
+				foreach ($stop['options'] as $option => $value) {
+					$options .= esc_attr($option) . ':' . esc_attr($value) . ';';
+				}
+				$options .= '"';
+			} else {
+				$options = '';
+			}
+
+			// let's put all together
+			$content .= '<li'
+						. $data_id
+						. $data_class
+						. $custom_class
+						. $button_text
+						. $options
+						. '>'
+						. $inner_content
+						. '</li>';
+		}
+
+		$content .= '</ol>';
+		return $content;
+	}
+
+
+	/**
+	 * This is a helper method to generate a status legend for a given status array.
+	 * Note this will only work if the incoming statuses have a key in the EEM_Status->localized_status() methods
+	 * status_array.
+	 *
+	 * @param array  $status_array   array of statuses that will make up the legend. In format:
+	 *                               array(
+	 *                               'status_item' => 'status_name'
+	 *                               )
+	 * @param string $active_status  This is used to indicate what the active status is IF that is to be highlighted in
+	 *                               the legend.
+	 * @return string               html structure for status.
+	 * @throws EE_Error
+	 */
+	public static function status_legend($status_array, $active_status = '')
+	{
+		if (! is_array($status_array)) {
+			throw new EE_Error(
+				esc_html__(
+					'The EEH_Template::status_legend helper required the incoming status_array argument to be an array!',
+					'event_espresso'
+				)
+			);
+		}
+
+		$content = '
             <div class="ee-list-table-legend-container">
                 <h4 class="status-legend-title">
                     ' . esc_html__('Status Legend', 'event_espresso') . '
                 </h4>
                 <dl class="ee-list-table-legend">';
 
-        foreach ($status_array as $item => $status) {
-            $active_class = $active_status == $status ? 'class="ee-is-active-status"' : '';
-            $content      .= '
+		foreach ($status_array as $item => $status) {
+			$active_class = $active_status == $status ? 'class="ee-is-active-status"' : '';
+			$content      .= '
                     <dt id="' . esc_attr('ee-legend-item-tooltip-' . $item) . '" ' . $active_class . '>
                         <span class="' . esc_attr('ee-status-legend ee-status-bg--' . $status) . '"></span>
                         <span class="ee-legend-description">
                             ' . EEH_Template::pretty_status($status, false, 'sentence') . '
                         </span>
                     </dt>';
-        }
+		}
 
-        $content .= '
+		$content .= '
                 </dl>
             </div>
 ';
-        return $content;
-    }
-
-
-    /**
-     * Gets HTML for laying out a deeply-nested array (and objects) in a format
-     * that's nice for presenting in the wp admin
-     *
-     * @param mixed $data
-     * @return string
-     */
-    public static function layout_array_as_table($data)
-    {
-        if (is_object($data) || $data instanceof __PHP_Incomplete_Class) {
-            $data = (array) $data;
-        }
-        ob_start();
-        if (is_array($data)) {
-            if (EEH_Array::is_associative_array($data)) { ?>
+		return $content;
+	}
+
+
+	/**
+	 * Gets HTML for laying out a deeply-nested array (and objects) in a format
+	 * that's nice for presenting in the wp admin
+	 *
+	 * @param mixed $data
+	 * @return string
+	 */
+	public static function layout_array_as_table($data)
+	{
+		if (is_object($data) || $data instanceof __PHP_Incomplete_Class) {
+			$data = (array) $data;
+		}
+		ob_start();
+		if (is_array($data)) {
+			if (EEH_Array::is_associative_array($data)) { ?>
                 <table class="widefat">
                     <tbody>
                     <?php foreach ($data as $data_key => $data_values) { ?>
@@ -771,292 +771,292 @@ 
             <?php } else { ?>
                 <ul>
                     <?php
-                    foreach ($data as $datum) {
-                        echo "<li>";
-                        echo self::layout_array_as_table($datum);
-                        echo "</li>";
-                    } ?>
+					foreach ($data as $datum) {
+						echo "<li>";
+						echo self::layout_array_as_table($datum);
+						echo "</li>";
+					} ?>
                 </ul>
             <?php }
-        } else {
-            // simple value
-            echo esc_html($data);
-        }
-        return ob_get_clean();
-    }
-
-
-    /**
-     * wrapper for self::get_paging_html() that simply echos the generated paging html
-     *
-     * @param        $total_items
-     * @param        $current
-     * @param        $per_page
-     * @param        $url
-     * @param bool   $show_num_field
-     * @param string $paged_arg_name
-     * @param array  $items_label
-     * @see   self:get_paging_html() for argument docs.
-     * @since 4.4.0
-     */
-    public static function paging_html(
-        $total_items,
-        $current,
-        $per_page,
-        $url,
-        $show_num_field = true,
-        $paged_arg_name = 'paged',
-        $items_label = []
-    ) {
-        echo self::get_paging_html(
-            $total_items,
-            $current,
-            $per_page,
-            $url,
-            $show_num_field,
-            $paged_arg_name,
-            $items_label
-        );
-    }
-
-
-    /**
-     * A method for generating paging similar to WP_List_Table
-     *
-     * @param integer $total_items      How many total items there are to page.
-     * @param integer $current          What the current page is.
-     * @param integer $per_page         How many items per page.
-     * @param string  $url              What the base url for page links is.
-     * @param boolean $show_num_field   Whether to show the input for changing page number.
-     * @param string  $paged_arg_name   The name of the key for the paged query argument.
-     * @param array   $items_label      An array of singular/plural values for the items label:
-     *                                  array(
-     *                                  'single' => 'item',
-     *                                  'plural' => 'items'
-     *                                  )
-     * @return  string
-     * @since    4.4.0
-     * @see      wp-admin/includes/class-wp-list-table.php WP_List_Table::pagination()
-     */
-    public static function get_paging_html(
-        $total_items,
-        $current,
-        $per_page,
-        $url,
-        $show_num_field = true,
-        $paged_arg_name = 'paged',
-        $items_label = []
-    ) {
-        $page_links     = [];
-        $disable_first  = $disable_last = '';
-        $total_items    = (int) $total_items;
-        $per_page       = (int) $per_page;
-        $current        = (int) $current;
-        $paged_arg_name = empty($paged_arg_name) ? 'paged' : sanitize_key($paged_arg_name);
-
-        // filter items_label
-        $items_label = apply_filters(
-            'FHEE__EEH_Template__get_paging_html__items_label',
-            $items_label
-        );
-
-        if (
-            empty($items_label)
-            || ! is_array($items_label)
-            || ! isset($items_label['single'])
-            || ! isset($items_label['plural'])
-        ) {
-            $items_label = [
-                'single' => esc_html__('1 item', 'event_espresso'),
-                'plural' => esc_html__('%s items', 'event_espresso'),
-            ];
-        } else {
-            $items_label = [
-                'single' => '1 ' . esc_html($items_label['single']),
-                'plural' => '%s ' . esc_html($items_label['plural']),
-            ];
-        }
-
-        $total_pages = ceil($total_items / $per_page);
-
-        if ($total_pages <= 1) {
-            return '';
-        }
-
-        $item_label = $total_items > 1 ? sprintf($items_label['plural'], $total_items) : $items_label['single'];
-
-        $output = '<span class="displaying-num">' . $item_label . '</span>';
-
-        if ($current === 1) {
-            $disable_first = ' disabled';
-        }
-        if ($current == $total_pages) {
-            $disable_last = ' disabled';
-        }
-
-        $page_links[] = sprintf(
-            "<a class='%s' title='%s' href='%s'>%s</a>",
-            'first-page' . $disable_first,
-            esc_attr__('Go to the first page', 'event_espresso'),
-            esc_url_raw(remove_query_arg($paged_arg_name, $url)),
-            '&laquo;'
-        );
-
-        $page_links[] = sprintf(
-            '<a class="%s" title="%s" href="%s">%s</a>',
-            'prev-page' . $disable_first,
-            esc_attr__('Go to the previous page', 'event_espresso'),
-            esc_url_raw(add_query_arg($paged_arg_name, max(1, $current - 1), $url)),
-            '&lsaquo;'
-        );
-
-        if (! $show_num_field) {
-            $html_current_page = $current;
-        } else {
-            $html_current_page = sprintf(
-                "<input class='current-page' title='%s' type='text' name=$paged_arg_name value='%s' size='%d' />",
-                esc_attr__('Current page', 'event_espresso'),
-                esc_attr($current),
-                strlen($total_pages)
-            );
-        }
-
-        $html_total_pages = sprintf(
-            '<span class="total-pages">%s</span>',
-            number_format_i18n($total_pages)
-        );
-        $page_links[]     = sprintf(
-            _x('%3$s%1$s of %2$s%4$s', 'paging', 'event_espresso'),
-            $html_current_page,
-            $html_total_pages,
-            '<span class="paging-input">',
-            '</span>'
-        );
-
-        $page_links[] = sprintf(
-            '<a class="%s" title="%s" href="%s">%s</a>',
-            'next-page' . $disable_last,
-            esc_attr__('Go to the next page', 'event_espresso'),
-            esc_url_raw(add_query_arg($paged_arg_name, min($total_pages, $current + 1), $url)),
-            '&rsaquo;'
-        );
-
-        $page_links[] = sprintf(
-            '<a class="%s" title="%s" href="%s">%s</a>',
-            'last-page' . $disable_last,
-            esc_attr__('Go to the last page', 'event_espresso'),
-            esc_url_raw(add_query_arg($paged_arg_name, $total_pages, $url)),
-            '&raquo;'
-        );
-
-        $output .= "\n" . '<span class="pagination-links">' . join("\n", $page_links) . '</span>';
-        // set page class
-        if ($total_pages) {
-            $page_class = $total_pages < 2 ? ' one-page' : '';
-        } else {
-            $page_class = ' no-pages';
-        }
-
-        return '<div class="tablenav"><div class="tablenav-pages' . $page_class . '">' . $output . '</div></div>';
-    }
-
-
-    /**
-     * @param string $wrap_class
-     * @param string $wrap_id
-     * @return string
-     */
-    public static function powered_by_event_espresso($wrap_class = '', $wrap_id = '', array $query_args = [])
-    {
-        $admin = is_admin() && ! (defined('DOING_AJAX') && DOING_AJAX);
-        if (
-            ! $admin
-            && ! apply_filters(
-                'FHEE__EEH_Template__powered_by_event_espresso__show_reg_footer',
-                EE_Registry::instance()->CFG->admin->show_reg_footer
-            )
-        ) {
-            return '';
-        }
-        $tag        = $admin ? 'span' : 'div';
-        $attributes = ! empty($wrap_id) ? " id=\"{$wrap_id}\"" : '';
-        $wrap_class = $admin ? "{$wrap_class} float-left" : $wrap_class;
-        $attributes .= ! empty($wrap_class)
-            ? " class=\"{$wrap_class} powered-by-event-espresso-credit\""
-            : ' class="powered-by-event-espresso-credit"';
-        $query_args = array_merge(
-            [
-                'ap_id'        => EE_Registry::instance()->CFG->admin->affiliate_id(),
-                'utm_source'   => 'powered_by_event_espresso',
-                'utm_medium'   => 'link',
-                'utm_campaign' => 'powered_by',
-            ],
-            $query_args
-        );
-        $powered_by = apply_filters(
-            'FHEE__EEH_Template__powered_by_event_espresso_text',
-            $admin ? 'Event Espresso - ' . EVENT_ESPRESSO_VERSION : 'Event Espresso'
-        );
-        $url        = add_query_arg($query_args, 'https://eventespresso.com/');
-        $url        = apply_filters('FHEE__EEH_Template__powered_by_event_espresso__url', $url);
-        return (string) apply_filters(
-            'FHEE__EEH_Template__powered_by_event_espresso__html',
-            sprintf(
-                esc_html_x(
-                    '%3$s%1$sOnline event registration and ticketing powered by %2$s%3$s',
-                    'Online event registration and ticketing powered by [link to eventespresso.com]',
-                    'event_espresso'
-                ),
-                "<{$tag}{$attributes}>",
-                "<a href=\"{$url}\" target=\"_blank\" rel=\"nofollow\">{$powered_by}</a></{$tag}>",
-                $admin ? '' : '<br />'
-            ),
-            $wrap_class,
-            $wrap_id
-        );
-    }
-
-
-    /**
-     * @param string $image_name
-     * @return string|null
-     * @since   4.10.14.p
-     */
-    public static function getScreenshotUrl($image_name)
-    {
-        return esc_url_raw(EE_GLOBAL_ASSETS_URL . 'images/screenshots/' . $image_name . '.jpg');
-    }
+		} else {
+			// simple value
+			echo esc_html($data);
+		}
+		return ob_get_clean();
+	}
+
+
+	/**
+	 * wrapper for self::get_paging_html() that simply echos the generated paging html
+	 *
+	 * @param        $total_items
+	 * @param        $current
+	 * @param        $per_page
+	 * @param        $url
+	 * @param bool   $show_num_field
+	 * @param string $paged_arg_name
+	 * @param array  $items_label
+	 * @see   self:get_paging_html() for argument docs.
+	 * @since 4.4.0
+	 */
+	public static function paging_html(
+		$total_items,
+		$current,
+		$per_page,
+		$url,
+		$show_num_field = true,
+		$paged_arg_name = 'paged',
+		$items_label = []
+	) {
+		echo self::get_paging_html(
+			$total_items,
+			$current,
+			$per_page,
+			$url,
+			$show_num_field,
+			$paged_arg_name,
+			$items_label
+		);
+	}
+
+
+	/**
+	 * A method for generating paging similar to WP_List_Table
+	 *
+	 * @param integer $total_items      How many total items there are to page.
+	 * @param integer $current          What the current page is.
+	 * @param integer $per_page         How many items per page.
+	 * @param string  $url              What the base url for page links is.
+	 * @param boolean $show_num_field   Whether to show the input for changing page number.
+	 * @param string  $paged_arg_name   The name of the key for the paged query argument.
+	 * @param array   $items_label      An array of singular/plural values for the items label:
+	 *                                  array(
+	 *                                  'single' => 'item',
+	 *                                  'plural' => 'items'
+	 *                                  )
+	 * @return  string
+	 * @since    4.4.0
+	 * @see      wp-admin/includes/class-wp-list-table.php WP_List_Table::pagination()
+	 */
+	public static function get_paging_html(
+		$total_items,
+		$current,
+		$per_page,
+		$url,
+		$show_num_field = true,
+		$paged_arg_name = 'paged',
+		$items_label = []
+	) {
+		$page_links     = [];
+		$disable_first  = $disable_last = '';
+		$total_items    = (int) $total_items;
+		$per_page       = (int) $per_page;
+		$current        = (int) $current;
+		$paged_arg_name = empty($paged_arg_name) ? 'paged' : sanitize_key($paged_arg_name);
+
+		// filter items_label
+		$items_label = apply_filters(
+			'FHEE__EEH_Template__get_paging_html__items_label',
+			$items_label
+		);
+
+		if (
+			empty($items_label)
+			|| ! is_array($items_label)
+			|| ! isset($items_label['single'])
+			|| ! isset($items_label['plural'])
+		) {
+			$items_label = [
+				'single' => esc_html__('1 item', 'event_espresso'),
+				'plural' => esc_html__('%s items', 'event_espresso'),
+			];
+		} else {
+			$items_label = [
+				'single' => '1 ' . esc_html($items_label['single']),
+				'plural' => '%s ' . esc_html($items_label['plural']),
+			];
+		}
+
+		$total_pages = ceil($total_items / $per_page);
+
+		if ($total_pages <= 1) {
+			return '';
+		}
+
+		$item_label = $total_items > 1 ? sprintf($items_label['plural'], $total_items) : $items_label['single'];
+
+		$output = '<span class="displaying-num">' . $item_label . '</span>';
+
+		if ($current === 1) {
+			$disable_first = ' disabled';
+		}
+		if ($current == $total_pages) {
+			$disable_last = ' disabled';
+		}
+
+		$page_links[] = sprintf(
+			"<a class='%s' title='%s' href='%s'>%s</a>",
+			'first-page' . $disable_first,
+			esc_attr__('Go to the first page', 'event_espresso'),
+			esc_url_raw(remove_query_arg($paged_arg_name, $url)),
+			'&laquo;'
+		);
+
+		$page_links[] = sprintf(
+			'<a class="%s" title="%s" href="%s">%s</a>',
+			'prev-page' . $disable_first,
+			esc_attr__('Go to the previous page', 'event_espresso'),
+			esc_url_raw(add_query_arg($paged_arg_name, max(1, $current - 1), $url)),
+			'&lsaquo;'
+		);
+
+		if (! $show_num_field) {
+			$html_current_page = $current;
+		} else {
+			$html_current_page = sprintf(
+				"<input class='current-page' title='%s' type='text' name=$paged_arg_name value='%s' size='%d' />",
+				esc_attr__('Current page', 'event_espresso'),
+				esc_attr($current),
+				strlen($total_pages)
+			);
+		}
+
+		$html_total_pages = sprintf(
+			'<span class="total-pages">%s</span>',
+			number_format_i18n($total_pages)
+		);
+		$page_links[]     = sprintf(
+			_x('%3$s%1$s of %2$s%4$s', 'paging', 'event_espresso'),
+			$html_current_page,
+			$html_total_pages,
+			'<span class="paging-input">',
+			'</span>'
+		);
+
+		$page_links[] = sprintf(
+			'<a class="%s" title="%s" href="%s">%s</a>',
+			'next-page' . $disable_last,
+			esc_attr__('Go to the next page', 'event_espresso'),
+			esc_url_raw(add_query_arg($paged_arg_name, min($total_pages, $current + 1), $url)),
+			'&rsaquo;'
+		);
+
+		$page_links[] = sprintf(
+			'<a class="%s" title="%s" href="%s">%s</a>',
+			'last-page' . $disable_last,
+			esc_attr__('Go to the last page', 'event_espresso'),
+			esc_url_raw(add_query_arg($paged_arg_name, $total_pages, $url)),
+			'&raquo;'
+		);
+
+		$output .= "\n" . '<span class="pagination-links">' . join("\n", $page_links) . '</span>';
+		// set page class
+		if ($total_pages) {
+			$page_class = $total_pages < 2 ? ' one-page' : '';
+		} else {
+			$page_class = ' no-pages';
+		}
+
+		return '<div class="tablenav"><div class="tablenav-pages' . $page_class . '">' . $output . '</div></div>';
+	}
+
+
+	/**
+	 * @param string $wrap_class
+	 * @param string $wrap_id
+	 * @return string
+	 */
+	public static function powered_by_event_espresso($wrap_class = '', $wrap_id = '', array $query_args = [])
+	{
+		$admin = is_admin() && ! (defined('DOING_AJAX') && DOING_AJAX);
+		if (
+			! $admin
+			&& ! apply_filters(
+				'FHEE__EEH_Template__powered_by_event_espresso__show_reg_footer',
+				EE_Registry::instance()->CFG->admin->show_reg_footer
+			)
+		) {
+			return '';
+		}
+		$tag        = $admin ? 'span' : 'div';
+		$attributes = ! empty($wrap_id) ? " id=\"{$wrap_id}\"" : '';
+		$wrap_class = $admin ? "{$wrap_class} float-left" : $wrap_class;
+		$attributes .= ! empty($wrap_class)
+			? " class=\"{$wrap_class} powered-by-event-espresso-credit\""
+			: ' class="powered-by-event-espresso-credit"';
+		$query_args = array_merge(
+			[
+				'ap_id'        => EE_Registry::instance()->CFG->admin->affiliate_id(),
+				'utm_source'   => 'powered_by_event_espresso',
+				'utm_medium'   => 'link',
+				'utm_campaign' => 'powered_by',
+			],
+			$query_args
+		);
+		$powered_by = apply_filters(
+			'FHEE__EEH_Template__powered_by_event_espresso_text',
+			$admin ? 'Event Espresso - ' . EVENT_ESPRESSO_VERSION : 'Event Espresso'
+		);
+		$url        = add_query_arg($query_args, 'https://eventespresso.com/');
+		$url        = apply_filters('FHEE__EEH_Template__powered_by_event_espresso__url', $url);
+		return (string) apply_filters(
+			'FHEE__EEH_Template__powered_by_event_espresso__html',
+			sprintf(
+				esc_html_x(
+					'%3$s%1$sOnline event registration and ticketing powered by %2$s%3$s',
+					'Online event registration and ticketing powered by [link to eventespresso.com]',
+					'event_espresso'
+				),
+				"<{$tag}{$attributes}>",
+				"<a href=\"{$url}\" target=\"_blank\" rel=\"nofollow\">{$powered_by}</a></{$tag}>",
+				$admin ? '' : '<br />'
+			),
+			$wrap_class,
+			$wrap_id
+		);
+	}
+
+
+	/**
+	 * @param string $image_name
+	 * @return string|null
+	 * @since   4.10.14.p
+	 */
+	public static function getScreenshotUrl($image_name)
+	{
+		return esc_url_raw(EE_GLOBAL_ASSETS_URL . 'images/screenshots/' . $image_name . '.jpg');
+	}
 }
 
 
 if (! function_exists('espresso_pagination')) {
-    /**
-     *    espresso_pagination
-     *
-     * @access    public
-     * @return    void
-     */
-    function espresso_pagination()
-    {
-        global $wp_query;
-        $big        = 999999999; // need an unlikely integer
-        $pagination = paginate_links(
-            [
-                'base'         => str_replace($big, '%#%', esc_url(get_pagenum_link($big))),
-                'format'       => '?paged=%#%',
-                'current'      => max(1, get_query_var('paged')),
-                'total'        => $wp_query->max_num_pages,
-                'show_all'     => true,
-                'end_size'     => 10,
-                'mid_size'     => 6,
-                'prev_next'    => true,
-                'prev_text'    => esc_html__('&lsaquo; PREV', 'event_espresso'),
-                'next_text'    => esc_html__('NEXT &rsaquo;', 'event_espresso'),
-                'type'         => 'plain',
-                'add_args'     => false,
-                'add_fragment' => '',
-            ]
-        );
-        echo ! empty($pagination) ? '<div class="ee-pagination-dv ee-clear-float">' . $pagination . '</div>' : '';
-    }
+	/**
+	 *    espresso_pagination
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	function espresso_pagination()
+	{
+		global $wp_query;
+		$big        = 999999999; // need an unlikely integer
+		$pagination = paginate_links(
+			[
+				'base'         => str_replace($big, '%#%', esc_url(get_pagenum_link($big))),
+				'format'       => '?paged=%#%',
+				'current'      => max(1, get_query_var('paged')),
+				'total'        => $wp_query->max_num_pages,
+				'show_all'     => true,
+				'end_size'     => 10,
+				'mid_size'     => 6,
+				'prev_next'    => true,
+				'prev_text'    => esc_html__('&lsaquo; PREV', 'event_espresso'),
+				'next_text'    => esc_html__('NEXT &rsaquo;', 'event_espresso'),
+				'type'         => 'plain',
+				'add_args'     => false,
+				'add_fragment' => '',
+			]
+		);
+		echo ! empty($pagination) ? '<div class="ee-pagination-dv ee-clear-float">' . $pagination . '</div>' : '';
+	}
 }

Spacing +65 added lines, -65 removed lines

@@ -5,7 +5,7 @@ 
 use EventEspresso\core\services\loaders\LoaderFactory;
 use EventEspresso\core\services\request\RequestInterface;
 
-if (! function_exists('espresso_get_template_part')) {
+if ( ! function_exists('espresso_get_template_part')) {
     /**
      * espresso_get_template_part
      * basically a copy of the WordPress get_template_part() function but uses EEH_Template::locate_template() instead, and doesn't add base versions of files
@@ -21,7 +21,7 @@ 
 }
 
 
-if (! function_exists('espresso_get_object_css_class')) {
+if ( ! function_exists('espresso_get_object_css_class')) {
     /**
      * espresso_get_object_css_class - attempts to generate a css class based on the type of EE object passed
      *
@@ -72,9 +72,9 @@ 
      */
     public static function load_espresso_theme_functions()
     {
-        if (! defined('EE_THEME_FUNCTIONS_LOADED')) {
-            if (is_readable(EE_PUBLIC . EE_Config::get_current_theme() . '/functions.php')) {
-                require_once(EE_PUBLIC . EE_Config::get_current_theme() . '/functions.php');
+        if ( ! defined('EE_THEME_FUNCTIONS_LOADED')) {
+            if (is_readable(EE_PUBLIC.EE_Config::get_current_theme().'/functions.php')) {
+                require_once(EE_PUBLIC.EE_Config::get_current_theme().'/functions.php');
             }
         }
     }
@@ -88,16 +88,16 @@ 
     public static function get_espresso_themes()
     {
         if (empty(EEH_Template::$_espresso_themes)) {
-            $espresso_themes = glob(EE_PUBLIC . '*', GLOB_ONLYDIR);
+            $espresso_themes = glob(EE_PUBLIC.'*', GLOB_ONLYDIR);
             if (empty($espresso_themes)) {
                 return [];
             }
             if (($key = array_search('global_assets', $espresso_themes)) !== false) {
-                unset($espresso_themes[ $key ]);
+                unset($espresso_themes[$key]);
             }
             EEH_Template::$_espresso_themes = [];
             foreach ($espresso_themes as $espresso_theme) {
-                EEH_Template::$_espresso_themes[ basename($espresso_theme) ] = $espresso_theme;
+                EEH_Template::$_espresso_themes[basename($espresso_theme)] = $espresso_theme;
             }
         }
         return EEH_Template::$_espresso_themes;
@@ -213,10 +213,10 @@ 
                 // get array of EE Custom Post Types
                 $EE_CPTs = $custom_post_types->getDefinitions();
                 // build template name based on request
-                if (isset($EE_CPTs[ $post_type ])) {
+                if (isset($EE_CPTs[$post_type])) {
                     $archive_or_single = is_archive() ? 'archive' : '';
                     $archive_or_single = is_single() ? 'single' : $archive_or_single;
-                    $templates         = $archive_or_single . '-' . $post_type . '.php';
+                    $templates         = $archive_or_single.'-'.$post_type.'.php';
                 }
             }
             // currently active EE template theme
@@ -225,18 +225,18 @@ 
             // array of paths to folders that may contain templates
             $template_folder_paths = [
                 // first check the /wp-content/uploads/espresso/templates/(current EE theme)/  folder for an EE theme template file
-                EVENT_ESPRESSO_TEMPLATE_DIR . $current_theme,
+                EVENT_ESPRESSO_TEMPLATE_DIR.$current_theme,
                 // then in the root of the /wp-content/uploads/espresso/templates/ folder
                 EVENT_ESPRESSO_TEMPLATE_DIR,
             ];
 
             // add core plugin folders for checking only if we're not $check_if_custom
-            if (! $check_if_custom) {
-                $core_paths            = [
+            if ( ! $check_if_custom) {
+                $core_paths = [
                     // in the  /wp-content/plugins/(EE4 folder)/public/(current EE theme)/ folder within the plugin
-                    EE_PUBLIC . $current_theme,
+                    EE_PUBLIC.$current_theme,
                     // in the  /wp-content/plugins/(EE4 folder)/core/templates/(current EE theme)/ folder within the plugin
-                    EE_TEMPLATES . $current_theme,
+                    EE_TEMPLATES.$current_theme,
                     // or maybe relative from the plugin root: /wp-content/plugins/(EE4 folder)/
                     EE_PLUGIN_DIR_PATH,
                 ];
@@ -271,10 +271,10 @@ 
                     );
                     if ($common_base_path !== '') {
                         // both paths have a common base, so just tack the filename onto our search path
-                        $resolved_path = EEH_File::end_with_directory_separator($template_folder_path) . $file_name;
+                        $resolved_path = EEH_File::end_with_directory_separator($template_folder_path).$file_name;
                     } else {
                         // no common base path, so let's just concatenate
-                        $resolved_path = EEH_File::end_with_directory_separator($template_folder_path) . $template;
+                        $resolved_path = EEH_File::end_with_directory_separator($template_folder_path).$template;
                     }
                     // build up our template locations array by adding our resolved paths
                     $full_template_paths[] = $resolved_path;
@@ -282,7 +282,7 @@ 
                 // if $template is an absolute path, then we'll tack it onto the start of our array so that it gets searched first
                 array_unshift($full_template_paths, $template);
                 // path to the directory of the current theme: /wp-content/themes/(current WP theme)/
-                array_unshift($full_template_paths, get_stylesheet_directory() . '/' . $file_name);
+                array_unshift($full_template_paths, get_stylesheet_directory().'/'.$file_name);
             }
             // filter final array of full template paths
             $full_template_paths = apply_filters(
@@ -333,7 +333,7 @@ 
                 }
             }
             $common_base_path .= $directory;
-            $last_offset      = $index + 1;
+            $last_offset = $index + 1;
         }
         return substr($common_base_path, 0, -1);
     }
@@ -371,7 +371,7 @@ 
         $template_args = (array) apply_filters('FHEE__EEH_Template__display_template__template_args', $template_args);
 
         // you gimme nuttin - YOU GET NUTTIN !!
-        if (! $template_path || ! is_readable($template_path)) {
+        if ( ! $template_path || ! is_readable($template_path)) {
             // ignore whether template is accessible ?
             if ($throw_exceptions) {
                 throw new DomainException(
@@ -381,7 +381,7 @@ 
             return '';
         }
         // if $template_args are not in an array, then make it so
-        if (! is_array($template_args) && ! is_object($template_args)) {
+        if ( ! is_array($template_args) && ! is_object($template_args)) {
             $template_args = [$template_args];
         }
         extract($template_args, EXTR_SKIP);
@@ -410,11 +410,11 @@ 
     public static function get_object_css_class($object = null, $prefix = '', $suffix = '')
     {
         // in the beginning...
-        $prefix = ! empty($prefix) ? rtrim($prefix, '-') . '-' : '';
+        $prefix = ! empty($prefix) ? rtrim($prefix, '-').'-' : '';
         // da muddle
         $class = '';
         // the end
-        $suffix = ! empty($suffix) ? '-' . ltrim($suffix, '-') : '';
+        $suffix = ! empty($suffix) ? '-'.ltrim($suffix, '-') : '';
         // is the passed object an EE object ?
         if ($object instanceof EE_Base_Class) {
             // grab the exact type of object
@@ -424,10 +424,10 @@ 
                 // no specifics just yet...
                 default:
                     $class = strtolower(str_replace('_', '-', $obj_class));
-                    $class .= method_exists($obj_class, 'name') ? '-' . sanitize_title($object->name()) : '';
+                    $class .= method_exists($obj_class, 'name') ? '-'.sanitize_title($object->name()) : '';
             }
         }
-        return $prefix . $class . $suffix;
+        return $prefix.$class.$suffix;
     }
 
 
@@ -462,7 +462,7 @@ 
         // filter raw amount (allows 0.00 to be changed to "free" for example)
         $amount_formatted = apply_filters('FHEE__EEH_Template__format_currency__amount', $amount, $return_raw);
         // still a number, or was amount converted to a string like "free" ?
-        if (! is_float($amount_formatted)) {
+        if ( ! is_float($amount_formatted)) {
             return esc_html($amount_formatted);
         }
         try {
@@ -473,7 +473,7 @@ 
             $mny = null;
         }
         // verify results
-        if (! $mny instanceof EE_Currency_Config) {
+        if ( ! $mny instanceof EE_Currency_Config) {
             // set default config country currency settings
             $mny = EE_Registry::instance()->CFG->currency instanceof EE_Currency_Config
                 ? EE_Registry::instance()->CFG->currency
@@ -482,16 +482,16 @@ 
         // format float
         $amount_formatted = number_format($amount, $mny->dec_plc, $mny->dec_mrk, $mny->thsnds);
         // add formatting ?
-        if (! $return_raw) {
+        if ( ! $return_raw) {
             // add currency sign
             if ($mny->sign_b4) {
                 if ($amount >= 0) {
-                    $amount_formatted = $mny->sign . $amount_formatted;
+                    $amount_formatted = $mny->sign.$amount_formatted;
                 } else {
-                    $amount_formatted = '-' . $mny->sign . str_replace('-', '', $amount_formatted);
+                    $amount_formatted = '-'.$mny->sign.str_replace('-', '', $amount_formatted);
                 }
             } else {
-                $amount_formatted = $amount_formatted . $mny->sign;
+                $amount_formatted = $amount_formatted.$mny->sign;
             }
 
             // filter to allow global setting of display_code
@@ -502,7 +502,7 @@ 
 
             // add currency code ?
             $amount_formatted = $display_code
-                ? $amount_formatted . ' <span class="' . $cur_code_span_class . '">(' . $mny->code . ')</span>'
+                ? $amount_formatted.' <span class="'.$cur_code_span_class.'">('.$mny->code.')</span>'
                 : $amount_formatted;
         }
         // filter results
@@ -538,7 +538,7 @@ 
             $plural,
             $schema
         );
-        return $status[ $status_id ];
+        return $status[$status_id];
     }
 
 
@@ -555,14 +555,14 @@ 
     public static function get_button_or_link($url, $label, $class = 'button button--primary', $icon = '', $title = '')
     {
         $icon_html = '';
-        if (! empty($icon)) {
+        if ( ! empty($icon)) {
             $dashicons = preg_split("(ee-icon |dashicons )", $icon);
             $dashicons = array_filter($dashicons);
             $count     = count($dashicons);
             $icon_html .= $count > 1 ? '<span class="ee-composite-dashicon">' : '';
             foreach ($dashicons as $dashicon) {
-                $type      = strpos($dashicon, 'ee-icon') !== false ? 'ee-icon ' : 'dashicons ';
-                $icon_html .= '<span class="' . $type . $dashicon . '"></span>';
+                $type = strpos($dashicon, 'ee-icon') !== false ? 'ee-icon ' : 'dashicons ';
+                $icon_html .= '<span class="'.$type.$dashicon.'"></span>';
             }
             $icon_html .= $count > 1 ? '</span>' : '';
         }
@@ -602,7 +602,7 @@ 
         $action  = $action ?: $request->getRequestParam('action', 'default', 'key');
 
 
-        $help_tab_lnk = $page . '-' . $action . '-' . $help_tab_id;
+        $help_tab_lnk = $page.'-'.$action.'-'.$help_tab_id;
         $icon         = ! $icon_style ? ' dashicons-editor-help' : $icon_style;
         $help_text    = ! $help_text ? '' : $help_text;
         return '<a id="'
@@ -635,15 +635,15 @@ 
         $id    = $tour->get_slug();
         $stops = $tour->get_stops();
 
-        $content = '<ol style="display:none" id="' . esc_attr($id) . '">';
+        $content = '<ol style="display:none" id="'.esc_attr($id).'">';
 
         foreach ($stops as $stop) {
-            $data_id    = ! empty($stop['id'])
-                ? ' data-id="' . esc_attr($stop['id']) . '"'
+            $data_id = ! empty($stop['id'])
+                ? ' data-id="'.esc_attr($stop['id']).'"'
                 : '';
 
             $data_class = empty($data_id) && ! empty($stop['class'])
-                ? ' data-class="' . esc_attr($stop['class']) . '"'
+                ? ' data-class="'.esc_attr($stop['class']).'"'
                 : '';
 
             // if container is set to modal then let's make sure we set the options accordingly
@@ -653,10 +653,10 @@ 
             }
 
             $custom_class  = ! empty($stop['custom_class'])
-                ? ' class="' . esc_attr($stop['custom_class']) . '"'
+                ? ' class="'.esc_attr($stop['custom_class']).'"'
                 : '';
             $button_text   = ! empty($stop['button_text'])
-                ? ' data-button="' . esc_html($stop['button_text']) . '"'
+                ? ' data-button="'.esc_html($stop['button_text']).'"'
                 : '';
             $inner_content = isset($stop['content']) ? wp_kses($stop['content'], $allowedtags) : '';
 
@@ -664,7 +664,7 @@ 
             if (isset($stop['options']) && is_array($stop['options'])) {
                 $options = ' data-options="';
                 foreach ($stop['options'] as $option => $value) {
-                    $options .= esc_attr($option) . ':' . esc_attr($value) . ';';
+                    $options .= esc_attr($option).':'.esc_attr($value).';';
                 }
                 $options .= '"';
             } else {
@@ -704,7 +704,7 @@ 
      */
     public static function status_legend($status_array, $active_status = '')
     {
-        if (! is_array($status_array)) {
+        if ( ! is_array($status_array)) {
             throw new EE_Error(
                 esc_html__(
                     'The EEH_Template::status_legend helper required the incoming status_array argument to be an array!',
@@ -716,17 +716,17 @@ 
         $content = '
             <div class="ee-list-table-legend-container">
                 <h4 class="status-legend-title">
-                    ' . esc_html__('Status Legend', 'event_espresso') . '
+                    ' . esc_html__('Status Legend', 'event_espresso').'
                 </h4>
                 <dl class="ee-list-table-legend">';
 
         foreach ($status_array as $item => $status) {
             $active_class = $active_status == $status ? 'class="ee-is-active-status"' : '';
-            $content      .= '
-                    <dt id="' . esc_attr('ee-legend-item-tooltip-' . $item) . '" ' . $active_class . '>
-                        <span class="' . esc_attr('ee-status-legend ee-status-bg--' . $status) . '"></span>
+            $content .= '
+                    <dt id="' . esc_attr('ee-legend-item-tooltip-'.$item).'" '.$active_class.'>
+                        <span class="' . esc_attr('ee-status-legend ee-status-bg--'.$status).'"></span>
                         <span class="ee-legend-description">
-                            ' . EEH_Template::pretty_status($status, false, 'sentence') . '
+                            ' . EEH_Template::pretty_status($status, false, 'sentence').'
                         </span>
                     </dt>';
         }
@@ -872,8 +872,8 @@ 
             ];
         } else {
             $items_label = [
-                'single' => '1 ' . esc_html($items_label['single']),
-                'plural' => '%s ' . esc_html($items_label['plural']),
+                'single' => '1 '.esc_html($items_label['single']),
+                'plural' => '%s '.esc_html($items_label['plural']),
             ];
         }
 
@@ -885,7 +885,7 @@ 
 
         $item_label = $total_items > 1 ? sprintf($items_label['plural'], $total_items) : $items_label['single'];
 
-        $output = '<span class="displaying-num">' . $item_label . '</span>';
+        $output = '<span class="displaying-num">'.$item_label.'</span>';
 
         if ($current === 1) {
             $disable_first = ' disabled';
@@ -896,7 +896,7 @@ 
 
         $page_links[] = sprintf(
             "<a class='%s' title='%s' href='%s'>%s</a>",
-            'first-page' . $disable_first,
+            'first-page'.$disable_first,
             esc_attr__('Go to the first page', 'event_espresso'),
             esc_url_raw(remove_query_arg($paged_arg_name, $url)),
             '&laquo;'
@@ -904,13 +904,13 @@ 
 
         $page_links[] = sprintf(
             '<a class="%s" title="%s" href="%s">%s</a>',
-            'prev-page' . $disable_first,
+            'prev-page'.$disable_first,
             esc_attr__('Go to the previous page', 'event_espresso'),
             esc_url_raw(add_query_arg($paged_arg_name, max(1, $current - 1), $url)),
             '&lsaquo;'
         );
 
-        if (! $show_num_field) {
+        if ( ! $show_num_field) {
             $html_current_page = $current;
         } else {
             $html_current_page = sprintf(
@@ -925,7 +925,7 @@ 
             '<span class="total-pages">%s</span>',
             number_format_i18n($total_pages)
         );
-        $page_links[]     = sprintf(
+        $page_links[] = sprintf(
             _x('%3$s%1$s of %2$s%4$s', 'paging', 'event_espresso'),
             $html_current_page,
             $html_total_pages,
@@ -935,7 +935,7 @@ 
 
         $page_links[] = sprintf(
             '<a class="%s" title="%s" href="%s">%s</a>',
-            'next-page' . $disable_last,
+            'next-page'.$disable_last,
             esc_attr__('Go to the next page', 'event_espresso'),
             esc_url_raw(add_query_arg($paged_arg_name, min($total_pages, $current + 1), $url)),
             '&rsaquo;'
@@ -943,13 +943,13 @@ 
 
         $page_links[] = sprintf(
             '<a class="%s" title="%s" href="%s">%s</a>',
-            'last-page' . $disable_last,
+            'last-page'.$disable_last,
             esc_attr__('Go to the last page', 'event_espresso'),
             esc_url_raw(add_query_arg($paged_arg_name, $total_pages, $url)),
             '&raquo;'
         );
 
-        $output .= "\n" . '<span class="pagination-links">' . join("\n", $page_links) . '</span>';
+        $output .= "\n".'<span class="pagination-links">'.join("\n", $page_links).'</span>';
         // set page class
         if ($total_pages) {
             $page_class = $total_pages < 2 ? ' one-page' : '';
@@ -957,7 +957,7 @@ 
             $page_class = ' no-pages';
         }
 
-        return '<div class="tablenav"><div class="tablenav-pages' . $page_class . '">' . $output . '</div></div>';
+        return '<div class="tablenav"><div class="tablenav-pages'.$page_class.'">'.$output.'</div></div>';
     }
 
 
@@ -995,7 +995,7 @@ 
         );
         $powered_by = apply_filters(
             'FHEE__EEH_Template__powered_by_event_espresso_text',
-            $admin ? 'Event Espresso - ' . EVENT_ESPRESSO_VERSION : 'Event Espresso'
+            $admin ? 'Event Espresso - '.EVENT_ESPRESSO_VERSION : 'Event Espresso'
         );
         $url        = add_query_arg($query_args, 'https://eventespresso.com/');
         $url        = apply_filters('FHEE__EEH_Template__powered_by_event_espresso__url', $url);
@@ -1024,12 +1024,12 @@ 
      */
     public static function getScreenshotUrl($image_name)
     {
-        return esc_url_raw(EE_GLOBAL_ASSETS_URL . 'images/screenshots/' . $image_name . '.jpg');
+        return esc_url_raw(EE_GLOBAL_ASSETS_URL.'images/screenshots/'.$image_name.'.jpg');
     }
 }
 
 
-if (! function_exists('espresso_pagination')) {
+if ( ! function_exists('espresso_pagination')) {
     /**
      *    espresso_pagination
      *
@@ -1057,6 +1057,6 @@ 
                 'add_fragment' => '',
             ]
         );
-        echo ! empty($pagination) ? '<div class="ee-pagination-dv ee-clear-float">' . $pagination . '</div>' : '';
+        echo ! empty($pagination) ? '<div class="ee-pagination-dv ee-clear-float">'.$pagination.'</div>' : '';
     }
 }

core/libraries/iframe_display/IframeEmbedButton.php

Indentation +241 added lines, -241 removed lines

@@ -17,272 +17,272 @@
 {
 
 
-    /**
-     * @var string $iframe_name
-     */
-    private $iframe_name;
+	/**
+	 * @var string $iframe_name
+	 */
+	private $iframe_name;
 
-    /**
-     * @var string $route_name
-     */
-    private $route_name;
+	/**
+	 * @var string $route_name
+	 */
+	private $route_name;
 
-    /**
-     * @var string $slug
-     */
-    private $slug;
+	/**
+	 * @var string $slug
+	 */
+	private $slug;
 
-    /**
-     * @var boolean $append_filterable_content
-     */
-    private $append_filterable_content;
+	/**
+	 * @var boolean $append_filterable_content
+	 */
+	private $append_filterable_content;
 
 
-    /**
-     * IframeEmbedButton constructor.
-     *
-     * @param string $iframe_name i18n name for the iframe. This will be used in HTML
-     * @param string $route_name  the name of the registered route
-     * @param string $slug        URL slug used for the thing the iframe button is being embedded in.
-     *                            will most likely be "event" since that's the only usage atm
-     */
-    public function __construct($iframe_name, $route_name, $slug = 'event')
-    {
-        $this->iframe_name = $iframe_name;
-        $this->route_name = $route_name;
-        $this->slug = $slug;
-    }
+	/**
+	 * IframeEmbedButton constructor.
+	 *
+	 * @param string $iframe_name i18n name for the iframe. This will be used in HTML
+	 * @param string $route_name  the name of the registered route
+	 * @param string $slug        URL slug used for the thing the iframe button is being embedded in.
+	 *                            will most likely be "event" since that's the only usage atm
+	 */
+	public function __construct($iframe_name, $route_name, $slug = 'event')
+	{
+		$this->iframe_name = $iframe_name;
+		$this->route_name = $route_name;
+		$this->slug = $slug;
+	}
 
 
-    /**
-     * Adds an iframe embed code button to the Event editor.
-     */
-    public function addEventEditorIframeEmbedButtonFilter()
-    {
-        // add button for iframe code to event editor.
-        add_filter(
-            'get_sample_permalink_html',
-            array($this, 'appendIframeEmbedButtonToSamplePermalinkHtml'),
-            10,
-            2
-        );
-        add_action(
-            'admin_enqueue_scripts',
-            array($this, 'embedButtonAssets'),
-            10
-        );
-    }
+	/**
+	 * Adds an iframe embed code button to the Event editor.
+	 */
+	public function addEventEditorIframeEmbedButtonFilter()
+	{
+		// add button for iframe code to event editor.
+		add_filter(
+			'get_sample_permalink_html',
+			array($this, 'appendIframeEmbedButtonToSamplePermalinkHtml'),
+			10,
+			2
+		);
+		add_action(
+			'admin_enqueue_scripts',
+			array($this, 'embedButtonAssets'),
+			10
+		);
+	}
 
 
-    /**
-     * @param $permalink_string
-     * @param $id
-     * @return string
-     */
-    public function appendIframeEmbedButtonToSamplePermalinkHtml($permalink_string, $id)
-    {
-        return $this->eventEditorIframeEmbedButton(
-            $permalink_string,
-            $id
-        );
-    }
+	/**
+	 * @param $permalink_string
+	 * @param $id
+	 * @return string
+	 */
+	public function appendIframeEmbedButtonToSamplePermalinkHtml($permalink_string, $id)
+	{
+		return $this->eventEditorIframeEmbedButton(
+			$permalink_string,
+			$id
+		);
+	}
 
 
-    /**
-     * iframe embed code button to the Event editor.
-     *
-     * @param string $permalink_string
-     * @param int    $id
-     * @return string
-     */
-    public function eventEditorIframeEmbedButton(
-        $permalink_string,
-        $id
-    ) {
-        // make sure this is ONLY when editing and the event id has been set.
-        if (! empty($id)) {
-            $post = get_post($id);
-            // if NOT event then let's get out.
-            if ($post->post_type !== 'espresso_events') {
-                return $permalink_string;
-            }
-            $permalink_string .= $this->embedButtonHtml([$this->slug => $id]);
-        }
-        return $permalink_string;
-    }
+	/**
+	 * iframe embed code button to the Event editor.
+	 *
+	 * @param string $permalink_string
+	 * @param int    $id
+	 * @return string
+	 */
+	public function eventEditorIframeEmbedButton(
+		$permalink_string,
+		$id
+	) {
+		// make sure this is ONLY when editing and the event id has been set.
+		if (! empty($id)) {
+			$post = get_post($id);
+			// if NOT event then let's get out.
+			if ($post->post_type !== 'espresso_events') {
+				return $permalink_string;
+			}
+			$permalink_string .= $this->embedButtonHtml([$this->slug => $id]);
+		}
+		return $permalink_string;
+	}
 
 
-    /**
-     * Adds an iframe embed code button via a WP do_action() as determined by the first parameter
-     *
-     * @param string $action name of the WP do_action() to hook into
-     */
-    public function addActionIframeEmbedButton($action)
-    {
-        // add button for iframe code to event editor.
-        add_action(
-            $action,
-            array($this, 'addActionIframeEmbedButtonCallback'),
-            10,
-            2
-        );
-    }
+	/**
+	 * Adds an iframe embed code button via a WP do_action() as determined by the first parameter
+	 *
+	 * @param string $action name of the WP do_action() to hook into
+	 */
+	public function addActionIframeEmbedButton($action)
+	{
+		// add button for iframe code to event editor.
+		add_action(
+			$action,
+			array($this, 'addActionIframeEmbedButtonCallback'),
+			10,
+			2
+		);
+	}
 
 
-    /**
-     * @return void
-     */
-    public function addActionIframeEmbedButtonCallback()
-    {
-        echo $this->embedButtonHtml(); // already escaped
-    }
+	/**
+	 * @return void
+	 */
+	public function addActionIframeEmbedButtonCallback()
+	{
+		echo $this->embedButtonHtml(); // already escaped
+	}
 
 
-    /**
-     * Adds an iframe embed code button via a WP apply_filters() as determined by the first parameter
-     *
-     * @param string $filter     name of the WP apply_filters() to hook into
-     * @param bool   $append     if true, will add iframe embed button to end of content,
-     *                           else if false, will add to the beginning of the content
-     */
-    public function addFilterIframeEmbedButton($filter, $append = true)
-    {
-        $this->append_filterable_content = $append;
-        // add button for iframe code to event editor.
-        add_filter(
-            $filter,
-            array($this, 'addFilterIframeEmbedButtonCallback'),
-            10
-        );
-    }
+	/**
+	 * Adds an iframe embed code button via a WP apply_filters() as determined by the first parameter
+	 *
+	 * @param string $filter     name of the WP apply_filters() to hook into
+	 * @param bool   $append     if true, will add iframe embed button to end of content,
+	 *                           else if false, will add to the beginning of the content
+	 */
+	public function addFilterIframeEmbedButton($filter, $append = true)
+	{
+		$this->append_filterable_content = $append;
+		// add button for iframe code to event editor.
+		add_filter(
+			$filter,
+			array($this, 'addFilterIframeEmbedButtonCallback'),
+			10
+		);
+	}
 
 
-    /**
-     * @param array|string $filterable_content
-     * @return array|string
-     */
-    public function addFilterIframeEmbedButtonCallback($filterable_content)
-    {
-        $embedButtonHtml = $this->embedButtonHtml();
-        if (is_array($filterable_content)) {
-            $filterable_content = $this->append_filterable_content
-                ? $filterable_content + array($this->route_name => $embedButtonHtml)
-                : array($this->route_name => $embedButtonHtml) + $filterable_content;
-        } else {
-            $filterable_content = $this->append_filterable_content
-                ? $filterable_content . $embedButtonHtml
-                : $embedButtonHtml . $filterable_content;
-        }
-        return $filterable_content;
-    }
+	/**
+	 * @param array|string $filterable_content
+	 * @return array|string
+	 */
+	public function addFilterIframeEmbedButtonCallback($filterable_content)
+	{
+		$embedButtonHtml = $this->embedButtonHtml();
+		if (is_array($filterable_content)) {
+			$filterable_content = $this->append_filterable_content
+				? $filterable_content + array($this->route_name => $embedButtonHtml)
+				: array($this->route_name => $embedButtonHtml) + $filterable_content;
+		} else {
+			$filterable_content = $this->append_filterable_content
+				? $filterable_content . $embedButtonHtml
+				: $embedButtonHtml . $filterable_content;
+		}
+		return $filterable_content;
+	}
 
 
-    /**
-     * iframe_embed_html
-     *
-     * @param array  $query_args
-     * @param string $button_class
-     * @return string
-     */
-    public function embedButtonHtml($query_args = array(), $button_class = '')
-    {
-        // incoming args will replace the defaults listed here in the second array (union preserves first array)
-        $query_args = (array) $query_args + array($this->route_name => 'iframe');
-        $query_args = (array) apply_filters(
-            'FHEE__EventEspresso_core_libraries_iframe_display_IframeEmbedButton__embedButtonHtml__query_args',
-            $query_args
-        );
-        // add this route to our localized vars
-        $iframe_module_routes                      = EE_Registry::$i18n_js_strings['iframe_module_routes'] ?? [];
-        $iframe_module_routes[ $this->route_name ] = $this->route_name;
-        EE_Registry::$i18n_js_strings['iframe_module_routes'] = $iframe_module_routes;
-        $route_name = esc_attr($this->route_name);
-        $iframe_url = esc_url_raw(add_query_arg($query_args, site_url()));
+	/**
+	 * iframe_embed_html
+	 *
+	 * @param array  $query_args
+	 * @param string $button_class
+	 * @return string
+	 */
+	public function embedButtonHtml($query_args = array(), $button_class = '')
+	{
+		// incoming args will replace the defaults listed here in the second array (union preserves first array)
+		$query_args = (array) $query_args + array($this->route_name => 'iframe');
+		$query_args = (array) apply_filters(
+			'FHEE__EventEspresso_core_libraries_iframe_display_IframeEmbedButton__embedButtonHtml__query_args',
+			$query_args
+		);
+		// add this route to our localized vars
+		$iframe_module_routes                      = EE_Registry::$i18n_js_strings['iframe_module_routes'] ?? [];
+		$iframe_module_routes[ $this->route_name ] = $this->route_name;
+		EE_Registry::$i18n_js_strings['iframe_module_routes'] = $iframe_module_routes;
+		$route_name = esc_attr($this->route_name);
+		$iframe_url = esc_url_raw(add_query_arg($query_args, site_url()));
 
-        return EEH_HTML::div(
-            EEH_HTML::link(
-                '#',
-                sprintf(esc_html__('Embed %1$s', 'event_espresso'), $this->iframe_name),
-                sprintf(
-                    esc_html__(
-                        'click here to generate code for embedding %1$s iframe into another site.',
-                        'event_espresso'
-                    ),
-                    EEH_Inflector::add_indefinite_article($this->iframe_name)
-                ),
-                $route_name . '-iframe-embed-trigger-js',
-                'iframe-embed-trigger-js button button--small button--secondary ' . esc_attr($button_class),
-                '',
-                ' data-iframe_embed_button="#' . $route_name . '-iframe-js" tabindex="-1"'
-            )
-            ,
-            '',
-            'ee-admin-button-row ee-admin-button-row--align-start'
-        )
-        . EEH_HTML::div(
-            EEH_HTML::div(
-                '<iframe src="' . $iframe_url . '" width="100%" height="100%"></iframe>',
-                '',
-                '',
-                'width:100%; height: 500px;'
-            ),
-            $route_name . '-iframe-js',
-            'iframe-embed-wrapper-js',
-            'display:none;'
-        );
+		return EEH_HTML::div(
+			EEH_HTML::link(
+				'#',
+				sprintf(esc_html__('Embed %1$s', 'event_espresso'), $this->iframe_name),
+				sprintf(
+					esc_html__(
+						'click here to generate code for embedding %1$s iframe into another site.',
+						'event_espresso'
+					),
+					EEH_Inflector::add_indefinite_article($this->iframe_name)
+				),
+				$route_name . '-iframe-embed-trigger-js',
+				'iframe-embed-trigger-js button button--small button--secondary ' . esc_attr($button_class),
+				'',
+				' data-iframe_embed_button="#' . $route_name . '-iframe-js" tabindex="-1"'
+			)
+			,
+			'',
+			'ee-admin-button-row ee-admin-button-row--align-start'
+		)
+		. EEH_HTML::div(
+			EEH_HTML::div(
+				'<iframe src="' . $iframe_url . '" width="100%" height="100%"></iframe>',
+				'',
+				'',
+				'width:100%; height: 500px;'
+			),
+			$route_name . '-iframe-js',
+			'iframe-embed-wrapper-js',
+			'display:none;'
+		);
 }
 
 
-    /**
-     * enqueue iframe button js
-     */
-    public function embedButtonAssets()
-    {
-        EE_Registry::$i18n_js_strings['iframe_embed_title'] = esc_html__(
-            'copy and paste the following into any other site\'s content to display this event:',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['iframe_embed_close_msg'] = esc_html__(
-            'click anywhere outside of this window to close it.',
-            'event_espresso'
-        );
-        wp_register_script(
-            'iframe_embed_button',
-            plugin_dir_url(__FILE__) . 'iframe-embed-button.js',
-            array('ee-dialog'),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_enqueue_script('iframe_embed_button');
-    }
+	/**
+	 * enqueue iframe button js
+	 */
+	public function embedButtonAssets()
+	{
+		EE_Registry::$i18n_js_strings['iframe_embed_title'] = esc_html__(
+			'copy and paste the following into any other site\'s content to display this event:',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['iframe_embed_close_msg'] = esc_html__(
+			'click anywhere outside of this window to close it.',
+			'event_espresso'
+		);
+		wp_register_script(
+			'iframe_embed_button',
+			plugin_dir_url(__FILE__) . 'iframe-embed-button.js',
+			array('ee-dialog'),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_enqueue_script('iframe_embed_button');
+	}
 
 
-    /**
-     * generates embed button sections for admin pages
-     *
-     * @param array $embed_buttons
-     * @return string
-     */
-    public function addIframeEmbedButtonsSection(array $embed_buttons)
-    {
-        $embed_buttons = (array) apply_filters(
-            'FHEE__EventEspresso_core_libraries_iframe_display_IframeEmbedButton__addIframeEmbedButtonsSection__embed_buttons',
-            $embed_buttons
-        );
-        if (empty($embed_buttons)) {
-            return '';
-        }
-        // add button for iframe code to event editor.
-        $html = EEH_HTML::div('', '', 'ee-admin-section ee-iframe-embed-buttons');
-        $html .= EEH_HTML::h3(esc_html__('iFrame Embed Code', 'event_espresso'));
-        $html .= EEH_HTML::p(
-            esc_html__(
-                'Click the following button(s) to generate iframe HTML that will allow you to embed your event content within the content of other websites.',
-                'event_espresso'
-            )
-        );
-        $html .= ' &nbsp; ' . implode(' &nbsp; ', $embed_buttons) . ' ';
-        $html .= EEH_HTML::divx();
-        return $html;
-    }
+	/**
+	 * generates embed button sections for admin pages
+	 *
+	 * @param array $embed_buttons
+	 * @return string
+	 */
+	public function addIframeEmbedButtonsSection(array $embed_buttons)
+	{
+		$embed_buttons = (array) apply_filters(
+			'FHEE__EventEspresso_core_libraries_iframe_display_IframeEmbedButton__addIframeEmbedButtonsSection__embed_buttons',
+			$embed_buttons
+		);
+		if (empty($embed_buttons)) {
+			return '';
+		}
+		// add button for iframe code to event editor.
+		$html = EEH_HTML::div('', '', 'ee-admin-section ee-iframe-embed-buttons');
+		$html .= EEH_HTML::h3(esc_html__('iFrame Embed Code', 'event_espresso'));
+		$html .= EEH_HTML::p(
+			esc_html__(
+				'Click the following button(s) to generate iframe HTML that will allow you to embed your event content within the content of other websites.',
+				'event_espresso'
+			)
+		);
+		$html .= ' &nbsp; ' . implode(' &nbsp; ', $embed_buttons) . ' ';
+		$html .= EEH_HTML::divx();
+		return $html;
+	}
 }

Spacing +11 added lines, -11 removed lines

@@ -100,7 +100,7 @@ 
         $id
     ) {
         // make sure this is ONLY when editing and the event id has been set.
-        if (! empty($id)) {
+        if ( ! empty($id)) {
             $post = get_post($id);
             // if NOT event then let's get out.
             if ($post->post_type !== 'espresso_events') {
@@ -170,8 +170,8 @@ 
                 : array($this->route_name => $embedButtonHtml) + $filterable_content;
         } else {
             $filterable_content = $this->append_filterable_content
-                ? $filterable_content . $embedButtonHtml
-                : $embedButtonHtml . $filterable_content;
+                ? $filterable_content.$embedButtonHtml
+                : $embedButtonHtml.$filterable_content;
         }
         return $filterable_content;
     }
@@ -194,7 +194,7 @@ 
         );
         // add this route to our localized vars
         $iframe_module_routes                      = EE_Registry::$i18n_js_strings['iframe_module_routes'] ?? [];
-        $iframe_module_routes[ $this->route_name ] = $this->route_name;
+        $iframe_module_routes[$this->route_name] = $this->route_name;
         EE_Registry::$i18n_js_strings['iframe_module_routes'] = $iframe_module_routes;
         $route_name = esc_attr($this->route_name);
         $iframe_url = esc_url_raw(add_query_arg($query_args, site_url()));
@@ -210,10 +210,10 @@ 
                     ),
                     EEH_Inflector::add_indefinite_article($this->iframe_name)
                 ),
-                $route_name . '-iframe-embed-trigger-js',
-                'iframe-embed-trigger-js button button--small button--secondary ' . esc_attr($button_class),
+                $route_name.'-iframe-embed-trigger-js',
+                'iframe-embed-trigger-js button button--small button--secondary '.esc_attr($button_class),
                 '',
-                ' data-iframe_embed_button="#' . $route_name . '-iframe-js" tabindex="-1"'
+                ' data-iframe_embed_button="#'.$route_name.'-iframe-js" tabindex="-1"'
             )
             ,
             '',
@@ -221,12 +221,12 @@ 
         )
         . EEH_HTML::div(
             EEH_HTML::div(
-                '<iframe src="' . $iframe_url . '" width="100%" height="100%"></iframe>',
+                '<iframe src="'.$iframe_url.'" width="100%" height="100%"></iframe>',
                 '',
                 '',
                 'width:100%; height: 500px;'
             ),
-            $route_name . '-iframe-js',
+            $route_name.'-iframe-js',
             'iframe-embed-wrapper-js',
             'display:none;'
         );
@@ -248,7 +248,7 @@ 
         );
         wp_register_script(
             'iframe_embed_button',
-            plugin_dir_url(__FILE__) . 'iframe-embed-button.js',
+            plugin_dir_url(__FILE__).'iframe-embed-button.js',
             array('ee-dialog'),
             EVENT_ESPRESSO_VERSION,
             true
@@ -281,7 +281,7 @@ 
                 'event_espresso'
             )
         );
-        $html .= ' &nbsp; ' . implode(' &nbsp; ', $embed_buttons) . ' ';
+        $html .= ' &nbsp; '.implode(' &nbsp; ', $embed_buttons).' ';
         $html .= EEH_HTML::divx();
         return $html;
     }

core/admin/EE_Admin_Page.core.php

Indentation +4162 added lines, -4162 removed lines

@@ -19,4245 +19,4245 @@
  */
 abstract class EE_Admin_Page extends EE_Base implements InterminableInterface
 {
-    /**
-     * @var EE_Admin_Config
-     */
-    protected $admin_config;
+	/**
+	 * @var EE_Admin_Config
+	 */
+	protected $admin_config;
 
-    /**
-     * @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;
 
-    // nav tabs
-    protected $_nav_tabs;
+	// nav tabs
+	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;
 
-    // boolean
-    protected $_is_UI_request; // this starts at null so we can have no header routes progress through two states.
+	// boolean
+	protected $_is_UI_request; // 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;
+	/**
+	 * 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;
+	// set via request page and action args.
+	protected $_current_page;
+
+	protected $_current_view;
 
-    protected $_current_page_view_url;
+	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;
-
-
-    /**
-     * This is just a property that flags whether the given route is a caffeinated route or not.
-     *
-     * @var boolean
-     */
-    protected $_is_caf = false;
-
-    /**
-     * whether or not initializePage() has run
-     *
-     * @var boolean
-     */
-    protected $initialized = false;
-
-    /**
-     * @var FeatureFlags
-     */
-    protected $feature;
-
-
-    /**
-     * @Constructor
-     * @param bool $routing indicate whether we want to just load the object and handle routing or just load the object.
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function __construct($routing = true)
-    {
-        $this->loader = LoaderFactory::getLoader();
-        $this->admin_config = $this->loader->getShared('EE_Admin_Config');
-        $this->feature = $this->loader->getShared(FeatureFlags::class);
-        $this->request = $this->loader->getShared(RequestInterface::class);
-        // routing enabled?
-        $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();
-    }
-
-
-    /**
-     * @return EE_Admin_Config
-     */
-    public function adminConfig(): EE_Admin_Config
-    {
-        return $this->admin_config;
-    }
-
-
-    /**
-     * @return FeatureFlags
-     */
-    public function feature(): FeatureFlags
-    {
-        return $this->feature;
-    }
-
-
-    /**
-     * This logic used to be in the constructor, but that caused a chicken <--> egg scenario
-     * for child classes that needed to set properties prior to these methods getting called,
-     * but also needed the parent class to have its construction completed as well.
-     * Bottom line is that constructors should ONLY be used for setting initial properties
-     * and any complex initialization logic should only run after instantiation is complete.
-     *
-     * This method gets called immediately after construction from within
-     *      EE_Admin_Page_Init::_initialize_admin_page()
-     *
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @since $VID:$
-     */
-    public function initializePage()
-    {
-        if ($this->initialized) {
-            return;
-        }
-        // set initial page props (child method)
-        $this->_init_page_props();
-        // set global defaults
-        $this->_set_defaults();
-        // set early because incoming requests could be ajax related and we need to register those hooks.
-        $this->_global_ajax_hooks();
-        $this->_ajax_hooks();
-        // other_page_hooks have to be early too.
-        $this->_do_other_page_hooks();
-        // set up page dependencies
-        $this->_before_page_setup();
-        $this->_page_setup();
-        $this->initialized = true;
-    }
-
-
-    /**
-     * _init_page_props
-     * Child classes use to set at least the following properties:
-     * $page_slug.
-     * $page_label.
-     *
-     * @abstract
-     * @return void
-     */
-    abstract protected function _init_page_props();
-
-
-    /**
-     * _ajax_hooks
-     * child classes put all their add_action('wp_ajax_{name_of_hook}') hooks in here.
-     * Note: within the ajax callback methods.
-     *
-     * @abstract
-     * @return void
-     */
-    abstract protected function _ajax_hooks();
-
-
-    /**
-     * _define_page_props
-     * child classes define page properties in here.  Must include at least:
-     * $_admin_base_url = base_url for all admin pages
-     * $_admin_page_title = default admin_page_title for admin pages
-     * $_labels = array of default labels for various automatically generated elements:
-     *    array(
-     *        'buttons' => array(
-     *            'add' => esc_html__('label for add new button'),
-     *            'edit' => esc_html__('label for edit button'),
-     *            'delete' => esc_html__('label for delete button')
-     *            )
-     *        )
-     *
-     * @abstract
-     * @return void
-     */
-    abstract protected function _define_page_props();
-
-
-    /**
-     * _set_page_routes
-     * child classes use this to define the page routes for all subpages handled by the class.  Page routes are
-     * assigned to 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);
-
-        add_action(
-            'wp_ajax_espresso_hide_status_change_notice',
-            [$this, 'hideStatusChangeNotice']
-        );
-        add_action(
-            'wp_ajax_nopriv_espresso_hide_status_change_notice',
-            [$this, 'hideStatusChangeNotice']
-        );
-    }
-
-
-    public function ajax_metabox_content()
-    {
-        $content_id  = $this->request->getRequestParam('contentid', '');
-        $content_url = $this->request->getRequestParam('contenturl', '', 'url');
-        EE_Admin_Page::cached_rss_display($content_id, $content_url);
-        wp_die();
-    }
-
-
-    public function hideStatusChangeNotice()
-    {
-        $response = [];
-        try {
-            /** @var EventEspresso\core\admin\StatusChangeNotice $status_change_notice */
-            $status_change_notice = $this->loader->getShared('EventEspresso\core\admin\StatusChangeNotice');
-            $response['success'] = $status_change_notice->dismiss() > -1;
-        } catch (Exception $exception) {
-            $response['errors'] = $exception->getMessage();
-        }
-        echo wp_json_encode($response);
-        exit();
-    }
-
-
-    /**
-     * 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 = $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
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    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 there are
-     * some doodads to work the magic and handle the flingjangy. Translation:  Checks if the requested action is listed
-     * in the page routes and then will try to load the corresponding method.
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    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) && isset($this->_route['func']) ? $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)) {
-                [$class, $method] = $func;
-            } elseif (strpos($func, '::') !== false) {
-                [$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 = '',
-        $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 . ']' ] = is_string($value) ? htmlspecialchars($value) : $value;
-            }
-        }
-        return EEH_URL::add_query_args_and_nonce($args, $url, $exclude_nonce);
-    }
-
-
-    /**
-     * This returns a generated link that will load the related help tab.
-     *
-     * @param string $help_tab_id the id for the connected help tab
-     * @param string $icon_style  (optional) include css class for the style you want to use for the help icon.
-     * @param string $help_text   (optional) send help text you want to use for the link if default not to be used
-     * @return string              generated link
-     * @uses EEH_Template::get_help_tab_link()
-     */
-    protected function _get_help_tab_link($help_tab_id, $icon_style = '', $help_text = '')
-    {
-        return EEH_Template::get_help_tab_link(
-            $help_tab_id,
-            $this->page_slug,
-            $this->_req_action,
-            $icon_style,
-            $help_text
-        );
-    }
-
-
-    /**
-     * _add_help_tabs
-     * Note child classes define their help tabs within the page_config array.
-     *
-     * @link   http://codex.wordpress.org/Function_Reference/add_help_tab
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    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 there ARE tour buttons...
-            if (! empty($tour_buttons)) {
-                // if we DON'T have config help sidebar then we'll just add the tour buttons to the sidebar.
-                if (! isset($config['help_sidebar'])) {
-                    $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'])) {
-                    $_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
-     * @throws ReflectionException
-     */
-    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
-     * @throws ReflectionException
-     * @throws EE_Error
-     */
-    protected function _add_qtips()
-    {
-        if (isset($this->_route_config['qtips'])) {
-            $qtips = (array) $this->_route_config['qtips'];
-            // load qtip loader
-            $path = [
-                $this->_get_dir() . '/qtips/',
-                EE_ADMIN_PAGES . basename($this->_get_dir()) . '/qtips/',
-            ];
-            EEH_Qtip_Loader::instance()->register($qtips, $path);
-        }
-    }
-
-
-    /**
-     * _set_nav_tabs
-     * This sets up the nav tabs from the page_routes array.  This method can be overwritten by child classes if you
-     * wish to add additional tabs or modify accordingly.
-     *
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    protected function _set_nav_tabs()
-    {
-        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']
-                    : EE_Admin_Page::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;
-    }
-
-
-    protected function addMetaBox(
-        $box_id,
-        $title,
-        $callback,
-        $screen,
-        $context = 'normal',
-        $priority = 'default',
-        $callback_args = null
-    ) {
-        add_meta_box($box_id, $title, $callback, $screen, $context, $priority, $callback_args);
-        add_filter(
-            "postbox_classes_{$this->_wp_page_slug}_{$box_id}",
-            function ($classes) {
-                array_push($classes, 'ee-admin-container');
-                return $classes;
-            }
-        );
-    }
-
-
-    /**
-     * admin_init_global
-     * This runs all the code that we want executed within the WP admin_init hook.
-     * This method executes for ALL EE Admin pages.
-     *
-     * @return void
-     */
-    public function admin_init_global()
-    {
-    }
-
-
-    /**
-     * wp_loaded_global
-     * This runs all the code that we want executed within the WP wp_loaded hook.  This method is optional for an
-     * EE_Admin page and will execute on every EE Admin Page load
-     *
-     * @return void
-     */
-    public function wp_loaded()
-    {
-    }
-
-
-    /**
-     * admin_notices
-     * Anything triggered by the 'admin_notices' WP hook should be put in here.  This particular method will apply on
-     * ALL EE_Admin pages.
-     *
-     * @return void
-     */
-    public function admin_notices_global()
-    {
-        $this->_display_no_javascript_warning();
-        $this->_display_espresso_notices();
-    }
-
-
-    public function network_admin_notices_global()
-    {
-        $this->_display_no_javascript_warning();
-        $this->_display_espresso_notices();
-    }
-
-
-    /**
-     * admin_footer_scripts_global
-     * Anything triggered by the 'admin_print_footer_scripts' WP hook should be put in here. This particular method
-     * will apply on ALL EE_Admin pages.
-     *
-     * @return void
-     */
-    public function admin_footer_scripts_global()
-    {
-        $this->_add_admin_page_ajax_loading_img();
-        $this->_add_admin_page_overlay();
-        // if metaboxes are present we need to add the nonce field
-        if (
-            isset($this->_route_config['metaboxes'])
-            || isset($this->_route_config['list_table'])
-            || (isset($this->_route_config['has_metaboxes']) && $this->_route_config['has_metaboxes'])
-        ) {
-            wp_nonce_field('closedpostboxes', 'closedpostboxesnonce', false);
-            wp_nonce_field('meta-box-order', 'meta-box-order-nonce', false);
-        }
-    }
-
-
-    /**
-     * admin_footer_global
-     * Anything triggered by the wp 'admin_footer' wp hook should be put in here.
-     * This particular method will apply on ALL EE_Admin Pages.
-     *
-     * @return void
-     */
-    public function admin_footer_global()
-    {
-        // dialog container for dialog helper
-        echo '
+	/**
+	 * 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;
+
+
+	/**
+	 * This is just a property that flags whether the given route is a caffeinated route or not.
+	 *
+	 * @var boolean
+	 */
+	protected $_is_caf = false;
+
+	/**
+	 * whether or not initializePage() has run
+	 *
+	 * @var boolean
+	 */
+	protected $initialized = false;
+
+	/**
+	 * @var FeatureFlags
+	 */
+	protected $feature;
+
+
+	/**
+	 * @Constructor
+	 * @param bool $routing indicate whether we want to just load the object and handle routing or just load the object.
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function __construct($routing = true)
+	{
+		$this->loader = LoaderFactory::getLoader();
+		$this->admin_config = $this->loader->getShared('EE_Admin_Config');
+		$this->feature = $this->loader->getShared(FeatureFlags::class);
+		$this->request = $this->loader->getShared(RequestInterface::class);
+		// routing enabled?
+		$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();
+	}
+
+
+	/**
+	 * @return EE_Admin_Config
+	 */
+	public function adminConfig(): EE_Admin_Config
+	{
+		return $this->admin_config;
+	}
+
+
+	/**
+	 * @return FeatureFlags
+	 */
+	public function feature(): FeatureFlags
+	{
+		return $this->feature;
+	}
+
+
+	/**
+	 * This logic used to be in the constructor, but that caused a chicken <--> egg scenario
+	 * for child classes that needed to set properties prior to these methods getting called,
+	 * but also needed the parent class to have its construction completed as well.
+	 * Bottom line is that constructors should ONLY be used for setting initial properties
+	 * and any complex initialization logic should only run after instantiation is complete.
+	 *
+	 * This method gets called immediately after construction from within
+	 *      EE_Admin_Page_Init::_initialize_admin_page()
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @since $VID:$
+	 */
+	public function initializePage()
+	{
+		if ($this->initialized) {
+			return;
+		}
+		// set initial page props (child method)
+		$this->_init_page_props();
+		// set global defaults
+		$this->_set_defaults();
+		// set early because incoming requests could be ajax related and we need to register those hooks.
+		$this->_global_ajax_hooks();
+		$this->_ajax_hooks();
+		// other_page_hooks have to be early too.
+		$this->_do_other_page_hooks();
+		// set up page dependencies
+		$this->_before_page_setup();
+		$this->_page_setup();
+		$this->initialized = true;
+	}
+
+
+	/**
+	 * _init_page_props
+	 * Child classes use to set at least the following properties:
+	 * $page_slug.
+	 * $page_label.
+	 *
+	 * @abstract
+	 * @return void
+	 */
+	abstract protected function _init_page_props();
+
+
+	/**
+	 * _ajax_hooks
+	 * child classes put all their add_action('wp_ajax_{name_of_hook}') hooks in here.
+	 * Note: within the ajax callback methods.
+	 *
+	 * @abstract
+	 * @return void
+	 */
+	abstract protected function _ajax_hooks();
+
+
+	/**
+	 * _define_page_props
+	 * child classes define page properties in here.  Must include at least:
+	 * $_admin_base_url = base_url for all admin pages
+	 * $_admin_page_title = default admin_page_title for admin pages
+	 * $_labels = array of default labels for various automatically generated elements:
+	 *    array(
+	 *        'buttons' => array(
+	 *            'add' => esc_html__('label for add new button'),
+	 *            'edit' => esc_html__('label for edit button'),
+	 *            'delete' => esc_html__('label for delete button')
+	 *            )
+	 *        )
+	 *
+	 * @abstract
+	 * @return void
+	 */
+	abstract protected function _define_page_props();
+
+
+	/**
+	 * _set_page_routes
+	 * child classes use this to define the page routes for all subpages handled by the class.  Page routes are
+	 * assigned to 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);
+
+		add_action(
+			'wp_ajax_espresso_hide_status_change_notice',
+			[$this, 'hideStatusChangeNotice']
+		);
+		add_action(
+			'wp_ajax_nopriv_espresso_hide_status_change_notice',
+			[$this, 'hideStatusChangeNotice']
+		);
+	}
+
+
+	public function ajax_metabox_content()
+	{
+		$content_id  = $this->request->getRequestParam('contentid', '');
+		$content_url = $this->request->getRequestParam('contenturl', '', 'url');
+		EE_Admin_Page::cached_rss_display($content_id, $content_url);
+		wp_die();
+	}
+
+
+	public function hideStatusChangeNotice()
+	{
+		$response = [];
+		try {
+			/** @var EventEspresso\core\admin\StatusChangeNotice $status_change_notice */
+			$status_change_notice = $this->loader->getShared('EventEspresso\core\admin\StatusChangeNotice');
+			$response['success'] = $status_change_notice->dismiss() > -1;
+		} catch (Exception $exception) {
+			$response['errors'] = $exception->getMessage();
+		}
+		echo wp_json_encode($response);
+		exit();
+	}
+
+
+	/**
+	 * 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 = $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
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	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 there are
+	 * some doodads to work the magic and handle the flingjangy. Translation:  Checks if the requested action is listed
+	 * in the page routes and then will try to load the corresponding method.
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	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) && isset($this->_route['func']) ? $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)) {
+				[$class, $method] = $func;
+			} elseif (strpos($func, '::') !== false) {
+				[$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 = '',
+		$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 . ']' ] = is_string($value) ? htmlspecialchars($value) : $value;
+			}
+		}
+		return EEH_URL::add_query_args_and_nonce($args, $url, $exclude_nonce);
+	}
+
+
+	/**
+	 * This returns a generated link that will load the related help tab.
+	 *
+	 * @param string $help_tab_id the id for the connected help tab
+	 * @param string $icon_style  (optional) include css class for the style you want to use for the help icon.
+	 * @param string $help_text   (optional) send help text you want to use for the link if default not to be used
+	 * @return string              generated link
+	 * @uses EEH_Template::get_help_tab_link()
+	 */
+	protected function _get_help_tab_link($help_tab_id, $icon_style = '', $help_text = '')
+	{
+		return EEH_Template::get_help_tab_link(
+			$help_tab_id,
+			$this->page_slug,
+			$this->_req_action,
+			$icon_style,
+			$help_text
+		);
+	}
+
+
+	/**
+	 * _add_help_tabs
+	 * Note child classes define their help tabs within the page_config array.
+	 *
+	 * @link   http://codex.wordpress.org/Function_Reference/add_help_tab
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	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 there ARE tour buttons...
+			if (! empty($tour_buttons)) {
+				// if we DON'T have config help sidebar then we'll just add the tour buttons to the sidebar.
+				if (! isset($config['help_sidebar'])) {
+					$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'])) {
+					$_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
+	 * @throws ReflectionException
+	 */
+	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
+	 * @throws ReflectionException
+	 * @throws EE_Error
+	 */
+	protected function _add_qtips()
+	{
+		if (isset($this->_route_config['qtips'])) {
+			$qtips = (array) $this->_route_config['qtips'];
+			// load qtip loader
+			$path = [
+				$this->_get_dir() . '/qtips/',
+				EE_ADMIN_PAGES . basename($this->_get_dir()) . '/qtips/',
+			];
+			EEH_Qtip_Loader::instance()->register($qtips, $path);
+		}
+	}
+
+
+	/**
+	 * _set_nav_tabs
+	 * This sets up the nav tabs from the page_routes array.  This method can be overwritten by child classes if you
+	 * wish to add additional tabs or modify accordingly.
+	 *
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	protected function _set_nav_tabs()
+	{
+		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']
+					: EE_Admin_Page::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;
+	}
+
+
+	protected function addMetaBox(
+		$box_id,
+		$title,
+		$callback,
+		$screen,
+		$context = 'normal',
+		$priority = 'default',
+		$callback_args = null
+	) {
+		add_meta_box($box_id, $title, $callback, $screen, $context, $priority, $callback_args);
+		add_filter(
+			"postbox_classes_{$this->_wp_page_slug}_{$box_id}",
+			function ($classes) {
+				array_push($classes, 'ee-admin-container');
+				return $classes;
+			}
+		);
+	}
+
+
+	/**
+	 * admin_init_global
+	 * This runs all the code that we want executed within the WP admin_init hook.
+	 * This method executes for ALL EE Admin pages.
+	 *
+	 * @return void
+	 */
+	public function admin_init_global()
+	{
+	}
+
+
+	/**
+	 * wp_loaded_global
+	 * This runs all the code that we want executed within the WP wp_loaded hook.  This method is optional for an
+	 * EE_Admin page and will execute on every EE Admin Page load
+	 *
+	 * @return void
+	 */
+	public function wp_loaded()
+	{
+	}
+
+
+	/**
+	 * admin_notices
+	 * Anything triggered by the 'admin_notices' WP hook should be put in here.  This particular method will apply on
+	 * ALL EE_Admin pages.
+	 *
+	 * @return void
+	 */
+	public function admin_notices_global()
+	{
+		$this->_display_no_javascript_warning();
+		$this->_display_espresso_notices();
+	}
+
+
+	public function network_admin_notices_global()
+	{
+		$this->_display_no_javascript_warning();
+		$this->_display_espresso_notices();
+	}
+
+
+	/**
+	 * admin_footer_scripts_global
+	 * Anything triggered by the 'admin_print_footer_scripts' WP hook should be put in here. This particular method
+	 * will apply on ALL EE_Admin pages.
+	 *
+	 * @return void
+	 */
+	public function admin_footer_scripts_global()
+	{
+		$this->_add_admin_page_ajax_loading_img();
+		$this->_add_admin_page_overlay();
+		// if metaboxes are present we need to add the nonce field
+		if (
+			isset($this->_route_config['metaboxes'])
+			|| isset($this->_route_config['list_table'])
+			|| (isset($this->_route_config['has_metaboxes']) && $this->_route_config['has_metaboxes'])
+		) {
+			wp_nonce_field('closedpostboxes', 'closedpostboxesnonce', false);
+			wp_nonce_field('meta-box-order', 'meta-box-order-nonce', false);
+		}
+	}
+
+
+	/**
+	 * admin_footer_global
+	 * Anything triggered by the wp 'admin_footer' wp hook should be put in here.
+	 * This particular method will apply on ALL EE_Admin Pages.
+	 *
+	 * @return void
+	 */
+	public function admin_footer_global()
+	{
+		// dialog container for dialog helper
+		echo '
         <div class="ee-admin-dialog-container auto-hide hidden">
             <div class="ee-notices"></div>
             <div class="ee-admin-dialog-container-inner-content"></div>
         </div>
         ';
 
-        // 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'], $help['content'])) {
-                throw new EE_Error(
-                    esc_html__(
-                        'Does not look like the popup content array has been setup correctly.  Might want to double check that.  Read the comments for the _get_help_popup_content method found in "EE_Admin_Page" class',
-                        'event_espresso'
-                    )
-                );
-            }
-            // we're good so let's setup the template vars and then assign parsed template content to our content.
-            $template_args = [
-                'help_popup_id'      => $trigger,
-                'help_popup_title'   => $help['title'],
-                'help_popup_content' => $help['content'],
-            ];
-            $content       .= EEH_Template::display_template(
-                EE_ADMIN_TEMPLATE . 'admin_help_popup.template.php',
-                $template_args,
-                true
-            );
-        }
-        if ($display) {
-            echo $content; // already escaped
-            return '';
-        }
-        return $content;
-    }
-
-
-    /**
-     * All this does is retrieve the help content array if set by the EE_Admin_Page child
-     *
-     * @return array properly formatted array for help popup content
-     * @throws EE_Error
-     */
-    private function _get_help_content()
-    {
-        // what is the method we're looking for?
-        $method_name = '_help_popup_content_' . $this->_req_action;
-        // if method doesn't exist let's get out.
-        if (! method_exists($this, $method_name)) {
-            return [];
-        }
-        // k we're good to go let's retrieve the help array
-        $help_array = $this->{$method_name}();
-        // make sure we've got an array!
-        if (! is_array($help_array)) {
-            throw new EE_Error(
-                esc_html__(
-                    'Something went wrong with help popup content generation. Expecting an array and well, this ain\'t no array bub.',
-                    'event_espresso'
-                )
-            );
-        }
-        return $help_array;
-    }
-
-
-    /**
-     * EE Admin Pages can use this to set a properly formatted trigger for a help popup.
-     * By default the trigger html is printed.  Otherwise it can be returned if the $display flag is set "false"
-     * See comments made on the _set_help_content method for understanding other parts to the help popup tool.
-     *
-     * @param string  $trigger_id reference for retrieving the trigger content for the popup
-     * @param boolean $display    if false then we return the trigger string
-     * @param array   $dimensions an array of dimensions for the box (array(h,w))
-     * @return string
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    protected function _set_help_trigger($trigger_id, $display = true, $dimensions = ['400', '640'])
-    {
-        if ($this->request->isAjax()) {
-            return '';
-        }
-        // let's check and see if there is any content set for this popup.  If there isn't then we'll include a default title and content so that developers know something needs to be corrected
-        $help_array   = $this->_get_help_content();
-        $help_content = '';
-        if (empty($help_array) || ! isset($help_array[ $trigger_id ])) {
-            $help_array[ $trigger_id ] = [
-                'title'   => esc_html__('Missing Content', 'event_espresso'),
-                'content' => esc_html__(
-                    'A trigger has been set that doesn\'t have any corresponding content. Make sure you have set the help content. (see the "_set_help_popup_content" method in the EE_Admin_Page for instructions.)',
-                    'event_espresso'
-                ),
-            ];
-            $help_content = $this->_set_help_popup_content($help_array);
-        }
-        // let's setup the trigger
-        $content = '<a class="ee-dialog" href="?height='
-                   . esc_attr($dimensions[0])
-                   . '&width='
-                   . esc_attr($dimensions[1])
-                   . '&inlineId='
-                   . esc_attr($trigger_id)
-                   . '" target="_blank"><span class="question ee-help-popup-question"></span></a>';
-        $content .= $help_content;
-        if ($display) {
-            echo $content; // already escaped
-            return '';
-        }
-        return $content;
-    }
-
-
-    /**
-     * _add_global_screen_options
-     * Add any extra wp_screen_options within this method using built-in WP functions/methods for doing so.
-     * This particular method will add_screen_options on ALL EE_Admin Pages
-     *
-     * @link   http://chrismarslender.com/wp-tutorials/wordpress-screen-options-tutorial/
-     *         see also WP_Screen object documents...
-     * @link   http://codex.wordpress.org/Class_Reference/WP_Screen
-     * @abstract
-     * @return void
-     */
-    private function _add_global_screen_options()
-    {
-    }
-
-
-    /**
-     * _add_global_feature_pointers
-     * This method is used for implementing any "feature pointers" (using built-in WP styling js).
-     * This particular method will implement feature pointers for ALL EE_Admin pages.
-     * Note: this is just a placeholder for now.  Implementation will come down the road
-     *
-     * @see    WP_Internal_Pointers class in wp-admin/includes/template.php for example (its a final class so can't be
-     *         extended) also see:
-     * @link   http://eamann.com/tech/wordpress-portland/
-     * @abstract
-     * @return void
-     */
-    private function _add_global_feature_pointers()
-    {
-    }
-
-
-    /**
-     * load_global_scripts_styles
-     * The scripts and styles enqueued in here will be loaded on every EE Admin page
-     *
-     * @return void
-     */
-    public function load_global_scripts_styles()
-    {
-        // add debugging styles
-        if (WP_DEBUG) {
-            add_action('admin_head', [$this, 'add_xdebug_style']);
-        }
-        // taking care of metaboxes
-        if (
-            empty($this->_cpt_route)
-            && (isset($this->_route_config['metaboxes']) || isset($this->_route_config['has_metaboxes']))
-        ) {
-            wp_enqueue_script('dashboard');
-        }
-
-        wp_enqueue_script(EspressoLegacyAdminAssetManager::JS_HANDLE_EE_ADMIN);
-        // LOCALIZED DATA
-        // localize script for ajax lazy loading
-        wp_localize_script(
-            EspressoLegacyAdminAssetManager::JS_HANDLE_EE_ADMIN,
-            'eeLazyLoadingContainers',
-            apply_filters(
-                'FHEE__EE_Admin_Page_Core__load_global_scripts_styles__loader_containers',
-                ['espresso_news_post_box_content']
-            )
-        );
-        // 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
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _set_list_table()
-    {
-        // first is this a list_table view?
-        if (! isset($this->_route_config['list_table'])) {
-            return;
-        } //not a list_table view so get out.
-        // list table functions are per view specific (because some admin pages might have more than one list table!)
-        $list_table_view = '_set_list_table_views_' . $this->_req_action;
-        if (! method_exists($this, $list_table_view) || $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'] ])) {
-                foreach ($extra_query_args[ $view['slug'] ] as $extra_query_arg) {
-                    $query_args[] = $extra_query_arg;
-                }
-            }
-            $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'], $help['content'])) {
+				throw new EE_Error(
+					esc_html__(
+						'Does not look like the popup content array has been setup correctly.  Might want to double check that.  Read the comments for the _get_help_popup_content method found in "EE_Admin_Page" class',
+						'event_espresso'
+					)
+				);
+			}
+			// we're good so let's setup the template vars and then assign parsed template content to our content.
+			$template_args = [
+				'help_popup_id'      => $trigger,
+				'help_popup_title'   => $help['title'],
+				'help_popup_content' => $help['content'],
+			];
+			$content       .= EEH_Template::display_template(
+				EE_ADMIN_TEMPLATE . 'admin_help_popup.template.php',
+				$template_args,
+				true
+			);
+		}
+		if ($display) {
+			echo $content; // already escaped
+			return '';
+		}
+		return $content;
+	}
+
+
+	/**
+	 * All this does is retrieve the help content array if set by the EE_Admin_Page child
+	 *
+	 * @return array properly formatted array for help popup content
+	 * @throws EE_Error
+	 */
+	private function _get_help_content()
+	{
+		// what is the method we're looking for?
+		$method_name = '_help_popup_content_' . $this->_req_action;
+		// if method doesn't exist let's get out.
+		if (! method_exists($this, $method_name)) {
+			return [];
+		}
+		// k we're good to go let's retrieve the help array
+		$help_array = $this->{$method_name}();
+		// make sure we've got an array!
+		if (! is_array($help_array)) {
+			throw new EE_Error(
+				esc_html__(
+					'Something went wrong with help popup content generation. Expecting an array and well, this ain\'t no array bub.',
+					'event_espresso'
+				)
+			);
+		}
+		return $help_array;
+	}
+
+
+	/**
+	 * EE Admin Pages can use this to set a properly formatted trigger for a help popup.
+	 * By default the trigger html is printed.  Otherwise it can be returned if the $display flag is set "false"
+	 * See comments made on the _set_help_content method for understanding other parts to the help popup tool.
+	 *
+	 * @param string  $trigger_id reference for retrieving the trigger content for the popup
+	 * @param boolean $display    if false then we return the trigger string
+	 * @param array   $dimensions an array of dimensions for the box (array(h,w))
+	 * @return string
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	protected function _set_help_trigger($trigger_id, $display = true, $dimensions = ['400', '640'])
+	{
+		if ($this->request->isAjax()) {
+			return '';
+		}
+		// let's check and see if there is any content set for this popup.  If there isn't then we'll include a default title and content so that developers know something needs to be corrected
+		$help_array   = $this->_get_help_content();
+		$help_content = '';
+		if (empty($help_array) || ! isset($help_array[ $trigger_id ])) {
+			$help_array[ $trigger_id ] = [
+				'title'   => esc_html__('Missing Content', 'event_espresso'),
+				'content' => esc_html__(
+					'A trigger has been set that doesn\'t have any corresponding content. Make sure you have set the help content. (see the "_set_help_popup_content" method in the EE_Admin_Page for instructions.)',
+					'event_espresso'
+				),
+			];
+			$help_content = $this->_set_help_popup_content($help_array);
+		}
+		// let's setup the trigger
+		$content = '<a class="ee-dialog" href="?height='
+				   . esc_attr($dimensions[0])
+				   . '&width='
+				   . esc_attr($dimensions[1])
+				   . '&inlineId='
+				   . esc_attr($trigger_id)
+				   . '" target="_blank"><span class="question ee-help-popup-question"></span></a>';
+		$content .= $help_content;
+		if ($display) {
+			echo $content; // already escaped
+			return '';
+		}
+		return $content;
+	}
+
+
+	/**
+	 * _add_global_screen_options
+	 * Add any extra wp_screen_options within this method using built-in WP functions/methods for doing so.
+	 * This particular method will add_screen_options on ALL EE_Admin Pages
+	 *
+	 * @link   http://chrismarslender.com/wp-tutorials/wordpress-screen-options-tutorial/
+	 *         see also WP_Screen object documents...
+	 * @link   http://codex.wordpress.org/Class_Reference/WP_Screen
+	 * @abstract
+	 * @return void
+	 */
+	private function _add_global_screen_options()
+	{
+	}
+
+
+	/**
+	 * _add_global_feature_pointers
+	 * This method is used for implementing any "feature pointers" (using built-in WP styling js).
+	 * This particular method will implement feature pointers for ALL EE_Admin pages.
+	 * Note: this is just a placeholder for now.  Implementation will come down the road
+	 *
+	 * @see    WP_Internal_Pointers class in wp-admin/includes/template.php for example (its a final class so can't be
+	 *         extended) also see:
+	 * @link   http://eamann.com/tech/wordpress-portland/
+	 * @abstract
+	 * @return void
+	 */
+	private function _add_global_feature_pointers()
+	{
+	}
+
+
+	/**
+	 * load_global_scripts_styles
+	 * The scripts and styles enqueued in here will be loaded on every EE Admin page
+	 *
+	 * @return void
+	 */
+	public function load_global_scripts_styles()
+	{
+		// add debugging styles
+		if (WP_DEBUG) {
+			add_action('admin_head', [$this, 'add_xdebug_style']);
+		}
+		// taking care of metaboxes
+		if (
+			empty($this->_cpt_route)
+			&& (isset($this->_route_config['metaboxes']) || isset($this->_route_config['has_metaboxes']))
+		) {
+			wp_enqueue_script('dashboard');
+		}
+
+		wp_enqueue_script(EspressoLegacyAdminAssetManager::JS_HANDLE_EE_ADMIN);
+		// LOCALIZED DATA
+		// localize script for ajax lazy loading
+		wp_localize_script(
+			EspressoLegacyAdminAssetManager::JS_HANDLE_EE_ADMIN,
+			'eeLazyLoadingContainers',
+			apply_filters(
+				'FHEE__EE_Admin_Page_Core__load_global_scripts_styles__loader_containers',
+				['espresso_news_post_box_content']
+			)
+		);
+		// 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
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _set_list_table()
+	{
+		// first is this a list_table view?
+		if (! isset($this->_route_config['list_table'])) {
+			return;
+		} //not a list_table view so get out.
+		// list table functions are per view specific (because some admin pages might have more than one list table!)
+		$list_table_view = '_set_list_table_views_' . $this->_req_action;
+		if (! method_exists($this, $list_table_view) || $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'] ])) {
+				foreach ($extra_query_args[ $view['slug'] ] as $extra_query_arg) {
+					$query_args[] = $extra_query_arg;
+				}
+			}
+			$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 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 = $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')
-        );
-        $this->addMetaBox(
-            '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')
-        );
-        $this->addMetaBox(
-            'espresso_ratings_request',
-            $ratings_box_title,
-            [
-                $this,
-                'espresso_ratings_request',
-            ],
-            $this->_wp_page_slug,
-            'side'
-        );
-    }
-
-
-    /**
-     * Code for setting up espresso ratings request metabox content.
-     *
-     * @throws DomainException
-     */
-    public function espresso_ratings_request()
-    {
-        EEH_Template::display_template(EE_ADMIN_TEMPLATE . 'espresso_ratings_request_content.template.php');
-    }
-
-
-    public static function cached_rss_display($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 = $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')
+		);
+		$this->addMetaBox(
+			'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')
+		);
+		$this->addMetaBox(
+			'espresso_ratings_request',
+			$ratings_box_title,
+			[
+				$this,
+				'espresso_ratings_request',
+			],
+			$this->_wp_page_slug,
+			'side'
+		);
+	}
+
+
+	/**
+	 * Code for setting up espresso ratings request metabox content.
+	 *
+	 * @throws DomainException
+	 */
+	public function espresso_ratings_request()
+	{
+		EEH_Template::display_template(EE_ADMIN_TEMPLATE . 'espresso_ratings_request_content.template.php');
+	}
+
+
+	public static function cached_rss_display($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)
-                EE_Admin_Page::cached_rss_display(
-                    'espresso_news_post_box_content',
-                    esc_url_raw(
-                        apply_filters(
-                            'FHEE__EE_Admin_Page__espresso_news_post_box__feed_url',
-                            'https://eventespresso.com/feed/'
-                        )
-                    )
-                );
-                ?>
+				// Get RSS Feed(s)
+				EE_Admin_Page::cached_rss_display(
+					'espresso_news_post_box_content',
+					esc_url_raw(
+						apply_filters(
+							'FHEE__EE_Admin_Page__espresso_news_post_box__feed_url',
+							'https://eventespresso.com/feed/'
+						)
+					)
+				);
+				?>
             </div>
             <?php do_action('AHEE__EE_Admin_Page__espresso_news_post_box__after_content'); ?>
         </div>
         <?php
-    }
-
-
-    private function _espresso_links_post_box()
-    {
-        // Hiding until we actually have content to put in here...
-        // $this->addMetaBox('espresso_links_post_box', esc_html__('Helpful Plugin Links', 'event_espresso'), array( $this, 'espresso_links_post_box'), $this->_wp_page_slug, 'side');
-    }
-
-
-    public function espresso_links_post_box()
-    {
-        // Hiding until we actually have content to put in here...
-        // EEH_Template::display_template(
-        //     EE_ADMIN_TEMPLATE . 'admin_general_metabox_contents_espresso_links.template.php'
-        // );
-    }
-
-
-    protected function _espresso_sponsors_post_box()
-    {
-        if (apply_filters('FHEE_show_sponsors_meta_box', true)) {
-            $this->addMetaBox(
-                'espresso_sponsors_post_box',
-                esc_html__('Event Espresso Highlights', 'event_espresso'),
-                [$this, 'espresso_sponsors_post_box'],
-                $this->_wp_page_slug,
-                'side'
-            );
-        }
-    }
-
-
-    public function espresso_sponsors_post_box()
-    {
-        EEH_Template::display_template(
-            EE_ADMIN_TEMPLATE . 'admin_general_metabox_contents_espresso_sponsors.template.php'
-        );
-    }
-
-
-    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
-        );
-        $this->addMetaBox(
-            $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'] = $this->_template_args['publish_box_extra_content'] ?? '';
-        $delete_link = '';
-        if ($delete && ! empty($id)) {
-            // make sure we have a default if just true is sent.
-            $delete           = ! empty($delete) ? $delete : 'delete';
-            $delete_link      = $this->get_action_link_or_button(
-                $delete,
-                $delete,
-                [$name => $id],
-                'submitdelete deletion button button--small  button--outline button--caution'
-            );
-        }
-        $this->_template_args['publish_delete_link'] = $delete_link;
-        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...
+		// $this->addMetaBox('espresso_links_post_box', esc_html__('Helpful Plugin Links', 'event_espresso'), array( $this, 'espresso_links_post_box'), $this->_wp_page_slug, 'side');
+	}
+
+
+	public function espresso_links_post_box()
+	{
+		// Hiding until we actually have content to put in here...
+		// EEH_Template::display_template(
+		//     EE_ADMIN_TEMPLATE . 'admin_general_metabox_contents_espresso_links.template.php'
+		// );
+	}
+
+
+	protected function _espresso_sponsors_post_box()
+	{
+		if (apply_filters('FHEE_show_sponsors_meta_box', true)) {
+			$this->addMetaBox(
+				'espresso_sponsors_post_box',
+				esc_html__('Event Espresso Highlights', 'event_espresso'),
+				[$this, 'espresso_sponsors_post_box'],
+				$this->_wp_page_slug,
+				'side'
+			);
+		}
+	}
+
+
+	public function espresso_sponsors_post_box()
+	{
+		EEH_Template::display_template(
+			EE_ADMIN_TEMPLATE . 'admin_general_metabox_contents_espresso_sponsors.template.php'
+		);
+	}
+
+
+	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
+		);
+		$this->addMetaBox(
+			$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'] = $this->_template_args['publish_box_extra_content'] ?? '';
+		$delete_link = '';
+		if ($delete && ! empty($id)) {
+			// make sure we have a default if just true is sent.
+			$delete           = ! empty($delete) ? $delete : 'delete';
+			$delete_link      = $this->get_action_link_or_button(
+				$delete,
+				$delete,
+				[$name => $id],
+				'submitdelete deletion button button--small  button--outline button--caution'
+			);
+		}
+		$this->_template_args['publish_delete_link'] = $delete_link;
+		if (! empty($name) && ! empty($id)) {
+			$hidden_field_arr[ $name ] = [
+				'type'  => 'hidden',
+				'value' => $id,
+			];
+			$hf                        = $this->_generate_admin_form_fields($hidden_field_arr, 'array');
+		} else {
+			$hf = '';
+		}
+		// add hidden field
+		$this->_template_args['publish_hidden_fields'] = is_array($hf) && ! empty($name)
+			? $hf[ $name ]['field']
+			: $hf;
+	}
+
+
+	/**
+	 * displays an error message to ppl who have javascript disabled
+	 *
+	 * @return void
+	 */
+	private function _display_no_javascript_warning()
+	{
+		?>
         <noscript>
             <div id="no-js-message" class="error">
                 <p style="font-size:1.3em;">
                     <span style="color:red;"><?php esc_html_e('Warning!', 'event_espresso'); ?></span>
                     <?php esc_html_e(
-                        'Javascript is currently turned off for your browser. Javascript must be enabled in order for all of the features on this page to function properly. Please turn your javascript back on.',
-                        'event_espresso'
-                    ); ?>
+						'Javascript is currently turned off for your browser. Javascript must be enabled in order for all of the features on this page to function properly. Please turn your javascript back on.',
+						'event_espresso'
+					); ?>
                 </p>
             </div>
         </noscript>
         <?php
-    }
-
-
-    /**
-     * displays espresso success and/or error notices
-     *
-     * @return void
-     */
-    protected function _display_espresso_notices()
-    {
-        $notices = $this->_get_transient(true);
-        echo stripslashes($notices);
-    }
-
-
-    /**
-     * spinny things pacify the masses
-     *
-     * @return void
-     */
-    protected function _add_admin_page_ajax_loading_img()
-    {
-        ?>
+	}
+
+
+	/**
+	 * displays espresso success and/or error notices
+	 *
+	 * @return void
+	 */
+	protected function _display_espresso_notices()
+	{
+		$notices = $this->_get_transient(true);
+		echo stripslashes($notices);
+	}
+
+
+	/**
+	 * spinny things pacify the masses
+	 *
+	 * @return void
+	 */
+	protected function _add_admin_page_ajax_loading_img()
+	{
+		?>
         <div id="espresso-ajax-loading" class="ajax-loading-grey">
             <span class="ee-spinner ee-spin"></span><span class="hidden"><?php
-                esc_html_e('loading...', 'event_espresso'); ?></span>
+				esc_html_e('loading...', 'event_espresso'); ?></span>
         </div>
         <?php
-    }
+	}
 
 
-    /**
-     * add admin page overlay for modal boxes
-     *
-     * @return void
-     */
-    protected function _add_admin_page_overlay()
-    {
-        ?>
+	/**
+	 * add admin page overlay for modal boxes
+	 *
+	 * @return void
+	 */
+	protected function _add_admin_page_overlay()
+	{
+		?>
         <div id="espresso-admin-page-overlay-dv" class=""></div>
         <?php
-    }
-
-
-    /**
-     * facade for $this->addMetaBox()
-     *
-     * @param string  $action        where the metabox gets displayed
-     * @param string  $title         Title of Metabox (output in metabox header)
-     * @param string  $callback      If not empty and $create_fun is set to false then we'll use a custom callback
-     *                               instead of the one created in here.
-     * @param array   $callback_args an array of args supplied for the metabox
-     * @param string  $column        what metabox column
-     * @param string  $priority      give this metabox a priority (using accepted priorities for wp meta boxes)
-     * @param boolean $create_func   default is true.  Basically we can say we don't WANT to have the runtime function
-     *                               created but just set our own callback for wp's add_meta_box.
-     * @throws DomainException
-     */
-    public function _add_admin_page_meta_box(
-        $action,
-        $title,
-        $callback,
-        $callback_args,
-        $column = 'normal',
-        $priority = 'high',
-        $create_func = true
-    ) {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, $callback);
-        // if we have empty callback args and we want to automatically create the metabox callback then we need to make sure the callback args are generated.
-        if (empty($callback_args) && $create_func) {
-            $callback_args = [
-                'template_path' => $this->_template_path,
-                'template_args' => $this->_template_args,
-            ];
-        }
-        // if $create_func is true (default) then we automatically create the function for displaying the actual meta box.  If false then we take the $callback reference passed through and use it instead (so callers can define their own callback function/method if they wish)
-        $call_back_func = $create_func
-            ? static function ($post, $metabox) {
-                do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-                echo EEH_Template::display_template(
-                    $metabox['args']['template_path'],
-                    $metabox['args']['template_args'],
-                    true
-                );
-            }
-            : $callback;
-        $this->addMetaBox(
-            str_replace('_', '-', $action) . '-mbox',
-            $title,
-            $call_back_func,
-            $this->_wp_page_slug,
-            $column,
-            $priority,
-            $callback_args
-        );
-    }
-
-
-    /**
-     * generates HTML wrapper for and admin details page that contains metaboxes in columns
-     *
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function display_admin_page_with_metabox_columns()
-    {
-        $this->_template_args['post_body_content']  = $this->_template_args['admin_page_content'];
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            $this->_column_template_path,
-            $this->_template_args,
-            true
-        );
-        // the final wrapper
-        $this->admin_page_wrapper();
-    }
-
-
-    /**
-     * generates  HTML wrapper for an admin details page
-     *
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function display_admin_page_with_sidebar()
-    {
-        $this->_display_admin_page(true);
-    }
-
-
-    /**
-     * generates  HTML wrapper for an admin details page (except no sidebar)
-     *
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function display_admin_page_with_no_sidebar()
-    {
-        $this->_display_admin_page();
-    }
-
-
-    /**
-     * generates HTML wrapper for an EE about admin page (no sidebar)
-     *
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function display_about_admin_page()
-    {
-        $this->_display_admin_page(false, true);
-    }
-
-
-    /**
-     * display_admin_page
-     * contains the code for actually displaying an admin page
-     *
-     * @param 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
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    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.
-
-        $post_body_content = $this->_template_args['before_admin_page_content'] ?? '';
-
-        $this->_template_args['add_page_frame'] = $this->_req_action !== 'system_status'
-                                                 && $this->_req_action !== 'data_reset'
-                                                 && $this->_wp_page_slug !== 'event-espresso_page_espresso_packages'
-                                                 && strpos($post_body_content, 'wp-list-table') === false;
-
-        $this->_template_args['current_page']              = $this->_wp_page_slug;
-        $this->_template_args['admin_page_wrapper_div_id'] = $this->_cpt_route
-            ? 'poststuff'
-            : 'espresso-default-admin';
-        $this->_template_args['admin_page_wrapper_div_class'] = str_replace(
-            'event-espresso_page_espresso_',
-            '',
-            $this->_wp_page_slug
-        ) . ' ' . $this->_req_action . '-route';
-
-        $template_path = $sidebar
-            ? EE_ADMIN_TEMPLATE . 'admin_details_wrapper.template.php'
-            : EE_ADMIN_TEMPLATE . 'admin_details_wrapper_no_sidebar.template.php';
-        if ($this->request->isAjax()) {
-            $template_path = EE_ADMIN_TEMPLATE . 'admin_details_wrapper_no_sidebar_ajax.template.php';
-        }
-        $template_path = ! empty($this->_column_template_path) ? $this->_column_template_path : $template_path;
-
-        $this->_template_args['post_body_content']         = $this->_template_args['admin_page_content'] ?? '';
-        $this->_template_args['before_admin_page_content'] = $post_body_content;
-        $this->_template_args['after_admin_page_content']  = $this->_template_args['after_admin_page_content'] ?? '';
-        $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 button--primary button--big',
-                esc_url_raw($buy_now_url),
-                true
-            )
-            : $this->_template_args['preview_action_button'];
-        $this->_template_args['admin_page_content']    = EEH_Template::display_template(
-            EE_ADMIN_TEMPLATE . 'admin_caf_full_page_preview.template.php',
-            $this->_template_args,
-            true
-        );
-        $this->_display_admin_page($display_sidebar);
-    }
-
-
-    /**
-     * display_admin_list_table_page_with_sidebar
-     * generates HTML wrapper for an admin_page with list_table
-     *
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function display_admin_list_table_page_with_sidebar()
-    {
-        $this->_display_admin_list_table_page(true);
-    }
-
-
-    /**
-     * display_admin_list_table_page_with_no_sidebar
-     * generates HTML wrapper for an admin_page with list_table (but with no sidebar)
-     *
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function display_admin_list_table_page_with_no_sidebar()
-    {
-        $this->_display_admin_list_table_page();
-    }
-
-
-    /**
-     * generates html wrapper for an admin_list_table page
-     *
-     * @param boolean $sidebar whether to display with sidebar or not.
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _display_admin_list_table_page($sidebar = false)
-    {
-        // setup search attributes
-        $this->_set_search_attributes();
-        $this->_template_args['current_page']     = $this->_wp_page_slug;
-        $template_path                            = EE_ADMIN_TEMPLATE . 'admin_list_wrapper.template.php';
-        $this->_template_args['table_url']        = $this->request->isAjax()
-            ? add_query_arg(['noheader' => 'true', 'route' => $this->_req_action], $this->_admin_base_url)
-            : add_query_arg(['route' => $this->_req_action], $this->_admin_base_url);
-        $this->_template_args['list_table']       = $this->_list_table_object;
-        $this->_template_args['current_route']    = $this->_req_action;
-        $this->_template_args['list_table_class'] = get_class($this->_list_table_object);
-        $ajax_sorting_callback                    = $this->_list_table_object->get_ajax_sorting_callback();
-        if (! empty($ajax_sorting_callback)) {
-            $sortable_list_table_form_fields = wp_nonce_field(
-                $ajax_sorting_callback . '_nonce',
-                $ajax_sorting_callback . '_nonce',
-                false,
-                false
-            );
-            $sortable_list_table_form_fields .= '<input type="hidden" id="ajax_table_sort_page" name="ajax_table_sort_page" value="'
-                                                . $this->page_slug
-                                                . '" />';
-            $sortable_list_table_form_fields .= '<input type="hidden" id="ajax_table_sort_action" name="ajax_table_sort_action" value="'
-                                                . $ajax_sorting_callback
-                                                . '" />';
-        } else {
-            $sortable_list_table_form_fields = '';
-        }
-        $this->_template_args['sortable_list_table_form_fields'] = $sortable_list_table_form_fields;
-
-        $hidden_form_fields = $this->_template_args['list_table_hidden_fields'] ?? '';
-
-        $nonce_ref          = $this->_req_action . '_nonce';
-        $hidden_form_fields .= '
+	}
+
+
+	/**
+	 * facade for $this->addMetaBox()
+	 *
+	 * @param string  $action        where the metabox gets displayed
+	 * @param string  $title         Title of Metabox (output in metabox header)
+	 * @param 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
+			? static function ($post, $metabox) {
+				do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+				echo EEH_Template::display_template(
+					$metabox['args']['template_path'],
+					$metabox['args']['template_args'],
+					true
+				);
+			}
+			: $callback;
+		$this->addMetaBox(
+			str_replace('_', '-', $action) . '-mbox',
+			$title,
+			$call_back_func,
+			$this->_wp_page_slug,
+			$column,
+			$priority,
+			$callback_args
+		);
+	}
+
+
+	/**
+	 * generates HTML wrapper for and admin details page that contains metaboxes in columns
+	 *
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function display_admin_page_with_metabox_columns()
+	{
+		$this->_template_args['post_body_content']  = $this->_template_args['admin_page_content'];
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(
+			$this->_column_template_path,
+			$this->_template_args,
+			true
+		);
+		// the final wrapper
+		$this->admin_page_wrapper();
+	}
+
+
+	/**
+	 * generates  HTML wrapper for an admin details page
+	 *
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function display_admin_page_with_sidebar()
+	{
+		$this->_display_admin_page(true);
+	}
+
+
+	/**
+	 * generates  HTML wrapper for an admin details page (except no sidebar)
+	 *
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function display_admin_page_with_no_sidebar()
+	{
+		$this->_display_admin_page();
+	}
+
+
+	/**
+	 * generates HTML wrapper for an EE about admin page (no sidebar)
+	 *
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function display_about_admin_page()
+	{
+		$this->_display_admin_page(false, true);
+	}
+
+
+	/**
+	 * display_admin_page
+	 * contains the code for actually displaying an admin page
+	 *
+	 * @param 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
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	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.
+
+		$post_body_content = $this->_template_args['before_admin_page_content'] ?? '';
+
+		$this->_template_args['add_page_frame'] = $this->_req_action !== 'system_status'
+												 && $this->_req_action !== 'data_reset'
+												 && $this->_wp_page_slug !== 'event-espresso_page_espresso_packages'
+												 && strpos($post_body_content, 'wp-list-table') === false;
+
+		$this->_template_args['current_page']              = $this->_wp_page_slug;
+		$this->_template_args['admin_page_wrapper_div_id'] = $this->_cpt_route
+			? 'poststuff'
+			: 'espresso-default-admin';
+		$this->_template_args['admin_page_wrapper_div_class'] = str_replace(
+			'event-espresso_page_espresso_',
+			'',
+			$this->_wp_page_slug
+		) . ' ' . $this->_req_action . '-route';
+
+		$template_path = $sidebar
+			? EE_ADMIN_TEMPLATE . 'admin_details_wrapper.template.php'
+			: EE_ADMIN_TEMPLATE . 'admin_details_wrapper_no_sidebar.template.php';
+		if ($this->request->isAjax()) {
+			$template_path = EE_ADMIN_TEMPLATE . 'admin_details_wrapper_no_sidebar_ajax.template.php';
+		}
+		$template_path = ! empty($this->_column_template_path) ? $this->_column_template_path : $template_path;
+
+		$this->_template_args['post_body_content']         = $this->_template_args['admin_page_content'] ?? '';
+		$this->_template_args['before_admin_page_content'] = $post_body_content;
+		$this->_template_args['after_admin_page_content']  = $this->_template_args['after_admin_page_content'] ?? '';
+		$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 button--primary button--big',
+				esc_url_raw($buy_now_url),
+				true
+			)
+			: $this->_template_args['preview_action_button'];
+		$this->_template_args['admin_page_content']    = EEH_Template::display_template(
+			EE_ADMIN_TEMPLATE . 'admin_caf_full_page_preview.template.php',
+			$this->_template_args,
+			true
+		);
+		$this->_display_admin_page($display_sidebar);
+	}
+
+
+	/**
+	 * display_admin_list_table_page_with_sidebar
+	 * generates HTML wrapper for an admin_page with list_table
+	 *
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function display_admin_list_table_page_with_sidebar()
+	{
+		$this->_display_admin_list_table_page(true);
+	}
+
+
+	/**
+	 * display_admin_list_table_page_with_no_sidebar
+	 * generates HTML wrapper for an admin_page with list_table (but with no sidebar)
+	 *
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function display_admin_list_table_page_with_no_sidebar()
+	{
+		$this->_display_admin_list_table_page();
+	}
+
+
+	/**
+	 * generates html wrapper for an admin_list_table page
+	 *
+	 * @param boolean $sidebar whether to display with sidebar or not.
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _display_admin_list_table_page($sidebar = false)
+	{
+		// setup search attributes
+		$this->_set_search_attributes();
+		$this->_template_args['current_page']     = $this->_wp_page_slug;
+		$template_path                            = EE_ADMIN_TEMPLATE . 'admin_list_wrapper.template.php';
+		$this->_template_args['table_url']        = $this->request->isAjax()
+			? add_query_arg(['noheader' => 'true', 'route' => $this->_req_action], $this->_admin_base_url)
+			: add_query_arg(['route' => $this->_req_action], $this->_admin_base_url);
+		$this->_template_args['list_table']       = $this->_list_table_object;
+		$this->_template_args['current_route']    = $this->_req_action;
+		$this->_template_args['list_table_class'] = get_class($this->_list_table_object);
+		$ajax_sorting_callback                    = $this->_list_table_object->get_ajax_sorting_callback();
+		if (! empty($ajax_sorting_callback)) {
+			$sortable_list_table_form_fields = wp_nonce_field(
+				$ajax_sorting_callback . '_nonce',
+				$ajax_sorting_callback . '_nonce',
+				false,
+				false
+			);
+			$sortable_list_table_form_fields .= '<input type="hidden" id="ajax_table_sort_page" name="ajax_table_sort_page" value="'
+												. $this->page_slug
+												. '" />';
+			$sortable_list_table_form_fields .= '<input type="hidden" id="ajax_table_sort_action" name="ajax_table_sort_action" value="'
+												. $ajax_sorting_callback
+												. '" />';
+		} else {
+			$sortable_list_table_form_fields = '';
+		}
+		$this->_template_args['sortable_list_table_form_fields'] = $sortable_list_table_form_fields;
+
+		$hidden_form_fields = $this->_template_args['list_table_hidden_fields'] ?? '';
+
+		$nonce_ref          = $this->_req_action . '_nonce';
+		$hidden_form_fields .= '
             <input type="hidden" name="' . $nonce_ref . '" value="' . wp_create_nonce($nonce_ref) . '">';
 
-        $this->_template_args['list_table_hidden_fields']        = $hidden_form_fields;
-        // display message about search results?
-        $search = $this->request->getRequestParam('s');
-        $this->_template_args['before_list_table'] .= ! empty($search)
-            ? '<p class="ee-search-results">' . sprintf(
-                esc_html__('Displaying search results for the search string: %1$s', 'event_espresso'),
-                trim($search, '%')
-            ) . '</p>'
-            : '';
-        // filter before_list_table template arg
-        $this->_template_args['before_list_table'] = apply_filters(
-            'FHEE__EE_Admin_Page___display_admin_list_table_page__before_list_table__template_arg',
-            $this->_template_args['before_list_table'],
-            $this->page_slug,
-            $this->request->requestParams(),
-            $this->_req_action
-        );
-        // convert to array and filter again
-        // arrays are easier to inject new items in a specific location,
-        // but would not be backwards compatible, so we have to add a new filter
-        $this->_template_args['before_list_table'] = implode(
-            " \n",
-            (array) apply_filters(
-                'FHEE__EE_Admin_Page___display_admin_list_table_page__before_list_table__template_args_array',
-                (array) $this->_template_args['before_list_table'],
-                $this->page_slug,
-                $this->request->requestParams(),
-                $this->_req_action
-            )
-        );
-        // filter after_list_table template arg
-        $this->_template_args['after_list_table'] = apply_filters(
-            'FHEE__EE_Admin_Page___display_admin_list_table_page__after_list_table__template_arg',
-            $this->_template_args['after_list_table'],
-            $this->page_slug,
-            $this->request->requestParams(),
-            $this->_req_action
-        );
-        // convert to array and filter again
-        // arrays are easier to inject new items in a specific location,
-        // but would not be backwards compatible, so we have to add a new filter
-        $this->_template_args['after_list_table']   = implode(
-            " \n",
-            (array) apply_filters(
-                'FHEE__EE_Admin_Page___display_admin_list_table_page__after_list_table__template_args_array',
-                (array) $this->_template_args['after_list_table'],
-                $this->page_slug,
-                $this->request->requestParams(),
-                $this->_req_action
-            )
-        );
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            $template_path,
-            $this->_template_args,
-            true
-        );
-        // the final template wrapper
-        if ($sidebar) {
-            $this->display_admin_page_with_sidebar();
-        } else {
-            $this->display_admin_page_with_no_sidebar();
-        }
-    }
-
-
-    /**
-     * This just prepares a legend using the given items and the admin_details_legend.template.php file and returns the
-     * html string for the legend.
-     * $items are expected in an array in the following format:
-     * $legend_items = array(
-     *        'item_id' => array(
-     *            'icon' => 'http://url_to_icon_being_described.png',
-     *            'desc' => esc_html__('localized description of item');
-     *        )
-     * );
-     *
-     * @param array $items see above for format of array
-     * @return string html string of legend
-     * @throws DomainException
-     */
-    protected function _display_legend($items)
-    {
-        $this->_template_args['items'] = apply_filters(
-            'FHEE__EE_Admin_Page___display_legend__items',
-            (array) $items,
-            $this
-        );
-        /** @var EventEspresso\core\admin\StatusChangeNotice $status_change_notice */
-        $status_change_notice = $this->loader->getShared('EventEspresso\core\admin\StatusChangeNotice');
-        if (! $status_change_notice->isDismissed()) {
-            $this->_template_args['status_change_notice'] = EEH_Template::display_template(
-                EE_ADMIN_TEMPLATE . 'status_change_notice.template.php',
-                [ 'context' => '__admin-legend', 'page_slug' => $this->page_slug ],
-                true
-            );
-        }
-        return EEH_Template::display_template(
-            EE_ADMIN_TEMPLATE . 'admin_details_legend.template.php',
-            $this->_template_args,
-            true
-        );
-    }
-
-
-    /**
-     * This is used whenever we're DOING_AJAX to return a formatted json array that our calling javascript can expect
-     * The returned json object is created from an array in the following format:
-     * array(
-     *  'error' => FALSE, //(default FALSE), contains any errors and/or exceptions (exceptions return json early),
-     *  'success' => FALSE, //(default FALSE) - contains any special success message.
-     *  'notices' => '', // - contains any EE_Error formatted notices
-     *  'content' => 'string can be html', //this is a string of formatted content (can be html)
-     *  'data' => array() //this can be any key/value pairs that a method returns for later json parsing by the js.
-     *  We're also going to include the template args with every package (so js can pick out any specific template args
-     *  that might be included in here)
-     * )
-     * The json object is populated by whatever is set in the $_template_args property.
-     *
-     * @param bool  $sticky_notices    Used to indicate whether you want to ensure notices are added to a transient
-     *                                 instead of displayed.
-     * @param array $notices_arguments Use this to pass any additional args on to the _process_notices.
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _return_json($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
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function return_json()
-    {
-        if ($this->request->isAjax()) {
-            $this->_return_json();
-        } else {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__('The public %s method can only be called when DOING_AJAX = TRUE', 'event_espresso'),
-                    __FUNCTION__
-                )
-            );
-        }
-    }
-
-
-    /**
-     * This provides a way for child hook classes to send along themselves by reference so methods/properties within
-     * them can be accessed by EE_Admin_child pages. This is assigned to the $_hook_obj property.
-     *
-     * @param EE_Admin_Hooks $hook_obj This will be the object for the EE_Admin_Hooks child
-     */
-    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
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function admin_page_wrapper($about = false)
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $this->_nav_tabs                                   = $this->_get_main_nav_tabs();
-        $this->_template_args['nav_tabs']                  = $this->_nav_tabs;
-        $this->_template_args['admin_page_title']          = $this->_admin_page_title;
-
-        $this->_template_args['before_admin_page_content'] = apply_filters(
-            "FHEE_before_admin_page_content{$this->_current_page}{$this->_current_view}",
-            isset($this->_template_args['before_admin_page_content'])
-                ? $this->_template_args['before_admin_page_content']
-                : ''
-        );
-
-        $this->_template_args['after_admin_page_content']  = apply_filters(
-            "FHEE_after_admin_page_content{$this->_current_page}{$this->_current_view}",
-            isset($this->_template_args['after_admin_page_content'])
-                ? $this->_template_args['after_admin_page_content']
-                : ''
-        );
-        $this->_template_args['after_admin_page_content']  .= $this->_set_help_popup_content();
-
-        if ($this->request->isAjax()) {
-            $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-                // $template_path,
-                EE_ADMIN_TEMPLATE . 'admin_wrapper_ajax.template.php',
-                $this->_template_args,
-                true
-            );
-            $this->_return_json();
-        }
-        // load settings page wrapper template
-        $template_path = $about
-            ? EE_ADMIN_TEMPLATE . 'about_admin_wrapper.template.php'
-            : EE_ADMIN_TEMPLATE . 'admin_wrapper.template.php';
-
-        EEH_Template::display_template($template_path, $this->_template_args);
-    }
-
-
-    /**
-     * This returns the admin_nav tabs html using the configuration in the _nav_tabs property
-     *
-     * @return string html
-     * @throws EE_Error
-     */
-    protected function _get_main_nav_tabs()
-    {
-        // let's generate the html using the EEH_Tabbed_Content helper.
-        // We do this here so that it's possible for child classes to add in nav tabs dynamically at the last minute
-        // (rather than setting in the page_routes array)
-        return EEH_Tabbed_Content::display_admin_nav_tabs($this->_nav_tabs);
-    }
-
-
-    /**
-     *        sort nav tabs
-     *
-     * @param $a
-     * @param $b
-     * @return int
-     */
-    private function _sort_nav_tabs($a, $b)
-    {
-        if ($a['order'] === $b['order']) {
-            return 0;
-        }
-        return ($a['order'] < $b['order']) ? -1 : 1;
-    }
-
-
-    /**
-     * generates HTML for the forms used on admin pages
-     *
-     * @param array  $input_vars - array of input field details
-     * @param string $generator  indicates which generator to use: options are 'string' or 'array'
-     * @param bool   $id
-     * @return array|string
-     * @uses   EEH_Form_Fields::get_form_fields (/helper/EEH_Form_Fields.helper.php)
-     * @uses   EEH_Form_Fields::get_form_fields_array (/helper/EEH_Form_Fields.helper.php)
-     */
-    protected function _generate_admin_form_fields($input_vars = [], $generator = 'string', $id = false)
-    {
-        return $generator === 'string'
-            ? EEH_Form_Fields::get_form_fields($input_vars, $id)
-            : EEH_Form_Fields::get_form_fields_array($input_vars);
-    }
-
-
-    /**
-     * generates the "Save" and "Save & Close" buttons for edit forms
-     *
-     * @param bool             $both     if true then both buttons will be generated.  If false then just the "Save &
-     *                                   Close" button.
-     * @param array            $text     if included, generator will use the given text for the buttons ( array([0] =>
-     *                                   'Save', [1] => 'save & close')
-     * @param array            $actions  if included allows us to set the actions that each button will carry out (i.e.
-     *                                   via the "name" value in the button).  We can also use this to just dump
-     *                                   default actions by submitting some other value.
-     * @param bool|string|null $referrer if false then we just do the default action on save and close.  Other wise it
-     *                                   will use the $referrer string. IF null, then we don't do ANYTHING on save and
-     *                                   close (normal form handling).
-     */
-    protected function _set_save_buttons($both = true, $text = [], $actions = [], $referrer = null)
-    {
-        // make sure $text and $actions are in an array
-        $text          = (array) $text;
-        $actions       = (array) $actions;
-        $referrer_url  = ! empty($referrer) ? $referrer : $this->request->getServerParam('REQUEST_URI');
-        $button_text   = ! empty($text)
-            ? $text
-            : [
-                esc_html__('Save', 'event_espresso'),
-                esc_html__('Save and Close', 'event_espresso'),
-            ];
-        $default_names = ['save', 'save_and_close'];
-        $buttons = '';
-        foreach ($button_text as $key => $button) {
-            $ref     = $default_names[ $key ];
-            $name    = ! empty($actions) ? $actions[ $key ] : $ref;
-            $buttons .= '<input type="submit" class="button button--primary ' . $ref . '" '
-                        . 'value="' . $button . '" name="' . $name . '" '
-                        . 'id="' . $this->_current_view . '_' . $ref . '" />';
-            if (! $both) {
-                break;
-            }
-        }
-        // add in a hidden index for the current page (so save and close redirects properly)
-        $buttons .= '<input type="hidden" id="save_and_close_referrer" name="save_and_close_referrer" value="'
-                   . $referrer_url
-                   . '" />';
-        $this->_template_args['save_buttons'] = $buttons;
-    }
-
-
-    /**
-     * Wrapper for the protected function.  Allows plugins/addons to call this to set the form tags.
-     *
-     * @param string $route
-     * @param array  $additional_hidden_fields
-     * @see   $this->_set_add_edit_form_tags() for details on params
-     * @since 4.6.0
-     */
-    public function set_add_edit_form_tags($route = '', $additional_hidden_fields = [])
-    {
-        $this->_set_add_edit_form_tags($route, $additional_hidden_fields);
-    }
-
-
-    /**
-     * set form open and close tags on add/edit pages.
-     *
-     * @param string $route                    the route you want the form to direct to
-     * @param array  $additional_hidden_fields any additional hidden fields required in the form header
-     * @return void
-     */
-    protected function _set_add_edit_form_tags($route = '', $additional_hidden_fields = [])
-    {
-        if (empty($route)) {
-            $user_msg = esc_html__(
-                'An error occurred. No action was set for this page\'s form.',
-                'event_espresso'
-            );
-            $dev_msg  = $user_msg . "\n"
-                        . sprintf(
-                            esc_html__('The $route argument is required for the %s->%s method.', 'event_espresso'),
-                            __FUNCTION__,
-                            __CLASS__
-                        );
-            EE_Error::add_error($user_msg . '||' . $dev_msg, __FILE__, __FUNCTION__, __LINE__);
-        }
-        // open form
-        $action = $this->_admin_base_url;
-        $this->_template_args['before_admin_page_content'] = "
+		$this->_template_args['list_table_hidden_fields']        = $hidden_form_fields;
+		// display message about search results?
+		$search = $this->request->getRequestParam('s');
+		$this->_template_args['before_list_table'] .= ! empty($search)
+			? '<p class="ee-search-results">' . sprintf(
+				esc_html__('Displaying search results for the search string: %1$s', 'event_espresso'),
+				trim($search, '%')
+			) . '</p>'
+			: '';
+		// filter before_list_table template arg
+		$this->_template_args['before_list_table'] = apply_filters(
+			'FHEE__EE_Admin_Page___display_admin_list_table_page__before_list_table__template_arg',
+			$this->_template_args['before_list_table'],
+			$this->page_slug,
+			$this->request->requestParams(),
+			$this->_req_action
+		);
+		// convert to array and filter again
+		// arrays are easier to inject new items in a specific location,
+		// but would not be backwards compatible, so we have to add a new filter
+		$this->_template_args['before_list_table'] = implode(
+			" \n",
+			(array) apply_filters(
+				'FHEE__EE_Admin_Page___display_admin_list_table_page__before_list_table__template_args_array',
+				(array) $this->_template_args['before_list_table'],
+				$this->page_slug,
+				$this->request->requestParams(),
+				$this->_req_action
+			)
+		);
+		// filter after_list_table template arg
+		$this->_template_args['after_list_table'] = apply_filters(
+			'FHEE__EE_Admin_Page___display_admin_list_table_page__after_list_table__template_arg',
+			$this->_template_args['after_list_table'],
+			$this->page_slug,
+			$this->request->requestParams(),
+			$this->_req_action
+		);
+		// convert to array and filter again
+		// arrays are easier to inject new items in a specific location,
+		// but would not be backwards compatible, so we have to add a new filter
+		$this->_template_args['after_list_table']   = implode(
+			" \n",
+			(array) apply_filters(
+				'FHEE__EE_Admin_Page___display_admin_list_table_page__after_list_table__template_args_array',
+				(array) $this->_template_args['after_list_table'],
+				$this->page_slug,
+				$this->request->requestParams(),
+				$this->_req_action
+			)
+		);
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(
+			$template_path,
+			$this->_template_args,
+			true
+		);
+		// the final template wrapper
+		if ($sidebar) {
+			$this->display_admin_page_with_sidebar();
+		} else {
+			$this->display_admin_page_with_no_sidebar();
+		}
+	}
+
+
+	/**
+	 * This just prepares a legend using the given items and the admin_details_legend.template.php file and returns the
+	 * html string for the legend.
+	 * $items are expected in an array in the following format:
+	 * $legend_items = array(
+	 *        'item_id' => array(
+	 *            'icon' => 'http://url_to_icon_being_described.png',
+	 *            'desc' => esc_html__('localized description of item');
+	 *        )
+	 * );
+	 *
+	 * @param array $items see above for format of array
+	 * @return string html string of legend
+	 * @throws DomainException
+	 */
+	protected function _display_legend($items)
+	{
+		$this->_template_args['items'] = apply_filters(
+			'FHEE__EE_Admin_Page___display_legend__items',
+			(array) $items,
+			$this
+		);
+		/** @var EventEspresso\core\admin\StatusChangeNotice $status_change_notice */
+		$status_change_notice = $this->loader->getShared('EventEspresso\core\admin\StatusChangeNotice');
+		if (! $status_change_notice->isDismissed()) {
+			$this->_template_args['status_change_notice'] = EEH_Template::display_template(
+				EE_ADMIN_TEMPLATE . 'status_change_notice.template.php',
+				[ 'context' => '__admin-legend', 'page_slug' => $this->page_slug ],
+				true
+			);
+		}
+		return EEH_Template::display_template(
+			EE_ADMIN_TEMPLATE . 'admin_details_legend.template.php',
+			$this->_template_args,
+			true
+		);
+	}
+
+
+	/**
+	 * This is used whenever we're DOING_AJAX to return a formatted json array that our calling javascript can expect
+	 * The returned json object is created from an array in the following format:
+	 * array(
+	 *  'error' => FALSE, //(default FALSE), contains any errors and/or exceptions (exceptions return json early),
+	 *  'success' => FALSE, //(default FALSE) - contains any special success message.
+	 *  'notices' => '', // - contains any EE_Error formatted notices
+	 *  'content' => 'string can be html', //this is a string of formatted content (can be html)
+	 *  'data' => array() //this can be any key/value pairs that a method returns for later json parsing by the js.
+	 *  We're also going to include the template args with every package (so js can pick out any specific template args
+	 *  that might be included in here)
+	 * )
+	 * The json object is populated by whatever is set in the $_template_args property.
+	 *
+	 * @param bool  $sticky_notices    Used to indicate whether you want to ensure notices are added to a transient
+	 *                                 instead of displayed.
+	 * @param array $notices_arguments Use this to pass any additional args on to the _process_notices.
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _return_json($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
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function return_json()
+	{
+		if ($this->request->isAjax()) {
+			$this->_return_json();
+		} else {
+			throw new EE_Error(
+				sprintf(
+					esc_html__('The public %s method can only be called when DOING_AJAX = TRUE', 'event_espresso'),
+					__FUNCTION__
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * This provides a way for child hook classes to send along themselves by reference so methods/properties within
+	 * them can be accessed by EE_Admin_child pages. This is assigned to the $_hook_obj property.
+	 *
+	 * @param EE_Admin_Hooks $hook_obj This will be the object for the EE_Admin_Hooks child
+	 */
+	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
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function admin_page_wrapper($about = false)
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$this->_nav_tabs                                   = $this->_get_main_nav_tabs();
+		$this->_template_args['nav_tabs']                  = $this->_nav_tabs;
+		$this->_template_args['admin_page_title']          = $this->_admin_page_title;
+
+		$this->_template_args['before_admin_page_content'] = apply_filters(
+			"FHEE_before_admin_page_content{$this->_current_page}{$this->_current_view}",
+			isset($this->_template_args['before_admin_page_content'])
+				? $this->_template_args['before_admin_page_content']
+				: ''
+		);
+
+		$this->_template_args['after_admin_page_content']  = apply_filters(
+			"FHEE_after_admin_page_content{$this->_current_page}{$this->_current_view}",
+			isset($this->_template_args['after_admin_page_content'])
+				? $this->_template_args['after_admin_page_content']
+				: ''
+		);
+		$this->_template_args['after_admin_page_content']  .= $this->_set_help_popup_content();
+
+		if ($this->request->isAjax()) {
+			$this->_template_args['admin_page_content'] = EEH_Template::display_template(
+				// $template_path,
+				EE_ADMIN_TEMPLATE . 'admin_wrapper_ajax.template.php',
+				$this->_template_args,
+				true
+			);
+			$this->_return_json();
+		}
+		// load settings page wrapper template
+		$template_path = $about
+			? EE_ADMIN_TEMPLATE . 'about_admin_wrapper.template.php'
+			: EE_ADMIN_TEMPLATE . 'admin_wrapper.template.php';
+
+		EEH_Template::display_template($template_path, $this->_template_args);
+	}
+
+
+	/**
+	 * This returns the admin_nav tabs html using the configuration in the _nav_tabs property
+	 *
+	 * @return string html
+	 * @throws EE_Error
+	 */
+	protected function _get_main_nav_tabs()
+	{
+		// let's generate the html using the EEH_Tabbed_Content helper.
+		// We do this here so that it's possible for child classes to add in nav tabs dynamically at the last minute
+		// (rather than setting in the page_routes array)
+		return EEH_Tabbed_Content::display_admin_nav_tabs($this->_nav_tabs);
+	}
+
+
+	/**
+	 *        sort nav tabs
+	 *
+	 * @param $a
+	 * @param $b
+	 * @return int
+	 */
+	private function _sort_nav_tabs($a, $b)
+	{
+		if ($a['order'] === $b['order']) {
+			return 0;
+		}
+		return ($a['order'] < $b['order']) ? -1 : 1;
+	}
+
+
+	/**
+	 * generates HTML for the forms used on admin pages
+	 *
+	 * @param array  $input_vars - array of input field details
+	 * @param string $generator  indicates which generator to use: options are 'string' or 'array'
+	 * @param bool   $id
+	 * @return array|string
+	 * @uses   EEH_Form_Fields::get_form_fields (/helper/EEH_Form_Fields.helper.php)
+	 * @uses   EEH_Form_Fields::get_form_fields_array (/helper/EEH_Form_Fields.helper.php)
+	 */
+	protected function _generate_admin_form_fields($input_vars = [], $generator = 'string', $id = false)
+	{
+		return $generator === 'string'
+			? EEH_Form_Fields::get_form_fields($input_vars, $id)
+			: EEH_Form_Fields::get_form_fields_array($input_vars);
+	}
+
+
+	/**
+	 * generates the "Save" and "Save & Close" buttons for edit forms
+	 *
+	 * @param bool             $both     if true then both buttons will be generated.  If false then just the "Save &
+	 *                                   Close" button.
+	 * @param array            $text     if included, generator will use the given text for the buttons ( array([0] =>
+	 *                                   'Save', [1] => 'save & close')
+	 * @param array            $actions  if included allows us to set the actions that each button will carry out (i.e.
+	 *                                   via the "name" value in the button).  We can also use this to just dump
+	 *                                   default actions by submitting some other value.
+	 * @param bool|string|null $referrer if false then we just do the default action on save and close.  Other wise it
+	 *                                   will use the $referrer string. IF null, then we don't do ANYTHING on save and
+	 *                                   close (normal form handling).
+	 */
+	protected function _set_save_buttons($both = true, $text = [], $actions = [], $referrer = null)
+	{
+		// make sure $text and $actions are in an array
+		$text          = (array) $text;
+		$actions       = (array) $actions;
+		$referrer_url  = ! empty($referrer) ? $referrer : $this->request->getServerParam('REQUEST_URI');
+		$button_text   = ! empty($text)
+			? $text
+			: [
+				esc_html__('Save', 'event_espresso'),
+				esc_html__('Save and Close', 'event_espresso'),
+			];
+		$default_names = ['save', 'save_and_close'];
+		$buttons = '';
+		foreach ($button_text as $key => $button) {
+			$ref     = $default_names[ $key ];
+			$name    = ! empty($actions) ? $actions[ $key ] : $ref;
+			$buttons .= '<input type="submit" class="button button--primary ' . $ref . '" '
+						. 'value="' . $button . '" name="' . $name . '" '
+						. 'id="' . $this->_current_view . '_' . $ref . '" />';
+			if (! $both) {
+				break;
+			}
+		}
+		// add in a hidden index for the current page (so save and close redirects properly)
+		$buttons .= '<input type="hidden" id="save_and_close_referrer" name="save_and_close_referrer" value="'
+				   . $referrer_url
+				   . '" />';
+		$this->_template_args['save_buttons'] = $buttons;
+	}
+
+
+	/**
+	 * Wrapper for the protected function.  Allows plugins/addons to call this to set the form tags.
+	 *
+	 * @param string $route
+	 * @param array  $additional_hidden_fields
+	 * @see   $this->_set_add_edit_form_tags() for details on params
+	 * @since 4.6.0
+	 */
+	public function set_add_edit_form_tags($route = '', $additional_hidden_fields = [])
+	{
+		$this->_set_add_edit_form_tags($route, $additional_hidden_fields);
+	}
+
+
+	/**
+	 * set form open and close tags on add/edit pages.
+	 *
+	 * @param string $route                    the route you want the form to direct to
+	 * @param array  $additional_hidden_fields any additional hidden fields required in the form header
+	 * @return void
+	 */
+	protected function _set_add_edit_form_tags($route = '', $additional_hidden_fields = [])
+	{
+		if (empty($route)) {
+			$user_msg = esc_html__(
+				'An error occurred. No action was set for this page\'s form.',
+				'event_espresso'
+			);
+			$dev_msg  = $user_msg . "\n"
+						. sprintf(
+							esc_html__('The $route argument is required for the %s->%s method.', 'event_espresso'),
+							__FUNCTION__,
+							__CLASS__
+						);
+			EE_Error::add_error($user_msg . '||' . $dev_msg, __FILE__, __FUNCTION__, __LINE__);
+		}
+		// open form
+		$action = $this->_admin_base_url;
+		$this->_template_args['before_admin_page_content'] = "
             <form name='form' method='post' action='{$action}' id='{$route}_event_form' class='ee-admin-page-form' >
             ";
-        // add nonce
-        $nonce                                             =
-            wp_nonce_field($route . '_nonce', $route . '_nonce', false, false);
-        $this->_template_args['before_admin_page_content'] .= "\n\t" . $nonce;
-        // add REQUIRED form action
-        $hidden_fields = [
-            'action' => ['type' => 'hidden', 'value' => $route],
-        ];
-        // merge arrays
-        $hidden_fields = is_array($additional_hidden_fields)
-            ? array_merge($hidden_fields, $additional_hidden_fields)
-            : $hidden_fields;
-        // generate form fields
-        $form_fields = $this->_generate_admin_form_fields($hidden_fields, 'array');
-        // add fields to form
-        foreach ((array) $form_fields as $form_field) {
-            $this->_template_args['before_admin_page_content'] .= "\n\t" . $form_field['field'];
-        }
-        // close form
-        $this->_template_args['after_admin_page_content'] = '</form>';
-    }
-
-
-    /**
-     * Public Wrapper for _redirect_after_action() method since its
-     * discovered it would be useful for external code to have access.
-     *
-     * @param bool   $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
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    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,
-            EE_Admin_Page::add_query_args_and_nonce($query_args, $redirect_url),
-            $query_args
-        );
-        // check if we're doing ajax.  If we are then lets just return the results and js can handle how it wants.
-        if ($this->request->isAjax()) {
-            $default_data                    = [
-                'close'        => true,
-                'redirect_url' => $redirect_url,
-                'where'        => 'main',
-                'what'         => 'append',
-            ];
-            $this->_template_args['success'] = $success;
-            $this->_template_args['data']    = ! empty($this->_template_args['data']) ? array_merge(
-                $default_data,
-                $this->_template_args['data']
-            ) : $default_data;
-            $this->_return_json();
-        }
-        wp_safe_redirect($redirect_url);
-        exit();
-    }
-
-
-    /**
-     * process any notices before redirecting (or returning ajax request)
-     * This method sets the $this->_template_args['notices'] attribute;
-     *
-     * @param array $query_args         any query args that need to be used for notice transient ('action')
-     * @param bool  $skip_route_verify  This is typically used when we are processing notices REALLY early and
-     *                                  page_routes haven't been defined yet.
-     * @param bool  $sticky_notices     This is used to flag that regardless of whether this is doing_ajax or not, we
-     *                                  still save a transient for the notice.
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _process_notices($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 = EE_Admin_Page::add_query_args_and_nonce($query_args, $_base_url, false, $exclude_nonce);
-        return EEH_Template::get_button_or_link($url, $this->_labels['buttons'][ $type ], $class);
-    }
-
-
-    /**
-     * _per_page_screen_option
-     * Utility function for adding in a per_page_option in the screen_options_dropdown.
-     *
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    protected function _per_page_screen_option()
-    {
-        $option = 'per_page';
-        $args   = [
-            'label'   => apply_filters(
-                'FHEE__EE_Admin_Page___per_page_screen_options___label',
-                $this->_admin_page_title,
-                $this
-            ),
-            'default' => (int) apply_filters(
-                'FHEE__EE_Admin_Page___per_page_screen_options__default',
-                20
-            ),
-            'option'  => $this->_current_page . '_' . $this->_current_view . '_per_page',
-        ];
-        // ONLY add the screen option if the user has access to it.
-        if ($this->check_user_access($this->_current_view, true)) {
-            add_screen_option($option, $args);
-        }
-    }
-
-
-    /**
-     * set_per_page_screen_option
-     * All this does is make sure that WordPress saves any per_page screen options (if set) for the current page.
-     * we have to do this rather than running inside the 'set-screen-options' hook because it runs earlier than
-     * admin_menu.
-     *
-     * @return void
-     */
-    private function _set_per_page_screen_options()
-    {
-        if ($this->request->requestParamIsSet('wp_screen_options')) {
-            check_admin_referer('screen-options-nonce', 'screenoptionnonce');
-            if (! $user = wp_get_current_user()) {
-                return;
-            }
-            $option = $this->request->getRequestParam('wp_screen_options[option]', '', 'key');
-            if (! $option) {
-                return;
-            }
-            $value  = $this->request->getRequestParam('wp_screen_options[value]', 0, 'int');
-            $map_option = $option;
-            $option     = str_replace('-', '_', $option);
-            switch ($map_option) {
-                case $this->_current_page . '_' . $this->_current_view . '_per_page':
-                    $max_value = apply_filters(
-                        'FHEE__EE_Admin_Page___set_per_page_screen_options__max_value',
-                        999,
-                        $this->_current_page,
-                        $this->_current_view
-                    );
-                    if ($value < 1) {
-                        return;
-                    }
-                    $value = min($value, $max_value);
-                    break;
-                default:
-                    $value = apply_filters(
-                        'FHEE__EE_Admin_Page___set_per_page_screen_options__value',
-                        false,
-                        $option,
-                        $value
-                    );
-                    if (false === $value) {
-                        return;
-                    }
-                    break;
-            }
-            update_user_meta($user->ID, $option, $value);
-            wp_safe_redirect(remove_query_arg(['pagenum', 'apage', 'paged'], wp_get_referer()));
-            exit;
-        }
-    }
-
-
-    /**
-     * This just allows for setting the $_template_args property if it needs to be set outside the object
-     *
-     * @param array $data array that will be assigned to template args.
-     */
-    public function set_template_args($data)
-    {
-        $this->_template_args = array_merge($this->_template_args, (array) $data);
-    }
-
-
-    /**
-     * This makes available the WP transient system for temporarily moving data between routes
-     *
-     * @param string $route             the route that should receive the transient
-     * @param array  $data              the data that gets sent
-     * @param bool   $notices           If this is for notices then we use this to indicate so, otherwise its just a
-     *                                  normal route transient.
-     * @param bool   $skip_route_verify Used to indicate we want to skip route verification.  This is usually ONLY used
-     *                                  when we are adding a transient before page_routes have been defined.
-     * @return void
-     * @throws EE_Error
-     */
-    protected function _add_transient($route, $data, $notices = false, $skip_route_verify = false)
-    {
-        $user_id = get_current_user_id();
-        if (! $skip_route_verify) {
-            $this->_verify_route($route);
-        }
-        // now let's set the string for what kind of transient we're setting
-        $transient = $notices
-            ? 'ee_rte_n_tx_' . $route . '_' . $user_id
-            : 'rte_tx_' . $route . '_' . $user_id;
-        $data      = $notices ? ['notices' => $data] : $data;
-        // is there already a transient for this route?  If there is then let's ADD to that transient
-        $existing = is_multisite() && is_network_admin()
-            ? get_site_transient($transient)
-            : get_transient($transient);
-        if ($existing) {
-            $data = array_merge((array) $data, (array) $existing);
-        }
-        if (is_multisite() && is_network_admin()) {
-            set_site_transient($transient, $data, 8);
-        } else {
-            set_transient($transient, $data, 8);
-        }
-    }
-
-
-    /**
-     * this retrieves the temporary transient that has been set for moving data between routes.
-     *
-     * @param bool   $notices true we get notices transient. False we just return normal route transient
-     * @param string $route
-     * @return mixed data
-     */
-    protected function _get_transient($notices = false, $route = '')
-    {
-        $user_id   = get_current_user_id();
-        $route     = ! $route ? $this->_req_action : $route;
-        $transient = $notices
-            ? 'ee_rte_n_tx_' . $route . '_' . $user_id
-            : 'rte_tx_' . $route . '_' . $user_id;
-        $data      = is_multisite() && is_network_admin()
-            ? get_site_transient($transient)
-            : get_transient($transient);
-        // delete transient after retrieval (just in case it hasn't expired);
-        if (is_multisite() && is_network_admin()) {
-            delete_site_transient($transient);
-        } else {
-            delete_transient($transient);
-        }
-        return $notices && isset($data['notices']) ? $data['notices'] : $data;
-    }
-
-
-    /**
-     * The purpose of this method is just to run garbage collection on any EE transients that might have expired but
-     * would not be called later. This will be assigned to run on a specific EE Admin page. (place the method in the
-     * default route callback on the EE_Admin page you want it run.)
-     *
-     * @return void
-     */
-    protected function _transient_garbage_collection()
-    {
-        global $wpdb;
-        // retrieve all existing transients
-        $query =
-            "SELECT option_name FROM {$wpdb->options} WHERE option_name LIKE '%rte_tx_%' OR option_name LIKE '%rte_n_tx_%'";
-        if ($results = $wpdb->get_results($query)) {
-            foreach ($results as $result) {
-                $transient = str_replace('_transient_', '', $result->option_name);
-                get_transient($transient);
-                if (is_multisite() && is_network_admin()) {
-                    get_site_transient($transient);
-                }
-            }
-        }
-    }
-
-
-    /**
-     * get_view
-     *
-     * @return string content of _view property
-     */
-    public function get_view()
-    {
-        return $this->_view;
-    }
-
-
-    /**
-     * getter for the protected $_views property
-     *
-     * @return array
-     */
-    public function get_views()
-    {
-        return $this->_views;
-    }
-
-
-    /**
-     * get_current_page
-     *
-     * @return string _current_page property value
-     */
-    public function get_current_page()
-    {
-        return $this->_current_page;
-    }
-
-
-    /**
-     * get_current_view
-     *
-     * @return string _current_view property value
-     */
-    public function get_current_view()
-    {
-        return $this->_current_view;
-    }
-
-
-    /**
-     * get_current_screen
-     *
-     * @return object The current WP_Screen object
-     */
-    public function get_current_screen()
-    {
-        return $this->_current_screen;
-    }
-
-
-    /**
-     * get_current_page_view_url
-     *
-     * @return string This returns the url for the current_page_view.
-     */
-    public function get_current_page_view_url()
-    {
-        return $this->_current_page_view_url;
-    }
-
-
-    /**
-     * just returns the Request
-     *
-     * @return RequestInterface
-     */
-    public function get_request()
-    {
-        return $this->request;
-    }
-
-
-    /**
-     * just returns the _req_data property
-     *
-     * @return array
-     */
-    public function get_request_data()
-    {
-        return $this->request->requestParams();
-    }
-
-
-    /**
-     * returns the _req_data protected property
-     *
-     * @return string
-     */
-    public function get_req_action()
-    {
-        return $this->_req_action;
-    }
-
-
-    /**
-     * @return bool  value of $_is_caf property
-     */
-    public function is_caf()
-    {
-        return $this->_is_caf;
-    }
-
-
-    /**
-     * @return mixed
-     */
-    public function default_espresso_metaboxes()
-    {
-        return $this->_default_espresso_metaboxes;
-    }
-
-
-    /**
-     * @return mixed
-     */
-    public function admin_base_url()
-    {
-        return $this->_admin_base_url;
-    }
-
-
-    /**
-     * @return mixed
-     */
-    public function wp_page_slug()
-    {
-        return $this->_wp_page_slug;
-    }
-
-
-    /**
-     * updates  espresso configuration settings
-     *
-     * @param string                   $tab
-     * @param EE_Config_Base|EE_Config $config
-     * @param string                   $file file where error occurred
-     * @param string                   $func function  where error occurred
-     * @param string                   $line line no where error occurred
-     * @return boolean
-     */
-    protected function _update_espresso_configuration($tab, $config, $file = '', $func = '', $line = '')
-    {
-        // remove any options that are NOT going to be saved with the config settings.
-        if (isset($config->core->ee_ueip_optin)) {
-            // TODO: remove the following two lines and make sure values are migrated from 3.1
-            update_option('ee_ueip_optin', $config->core->ee_ueip_optin);
-            update_option('ee_ueip_has_notified', true);
-        }
-        // and save it (note we're also doing the network save here)
-        $net_saved    = ! is_main_site() || EE_Network_Config::instance()->update_config(false, false);
-        $config_saved = EE_Config::instance()->update_espresso_config(false, false);
-        if ($config_saved && $net_saved) {
-            EE_Error::add_success(sprintf(esc_html__('"%s" have been successfully updated.', 'event_espresso'), $tab));
-            return true;
-        }
-        EE_Error::add_error(sprintf(esc_html__('The "%s" were not updated.', 'event_espresso'), $tab), $file, $func, $line);
-        return false;
-    }
-
-
-    /**
-     * Returns an array to be used for EE_FOrm_Fields.helper.php's select_input as the $values argument.
-     *
-     * @return array
-     */
-    public function get_yes_no_values()
-    {
-        return $this->_yes_no_values;
-    }
-
-
-    /**
-     * @return string
-     * @throws ReflectionException
-     * @since $VID:$
-     */
-    protected function _get_dir()
-    {
-        $reflector = new ReflectionClass(get_class($this));
-        return dirname($reflector->getFileName());
-    }
-
-
-    /**
-     * A helper for getting a "next link".
-     *
-     * @param string $url   The url to link to
-     * @param string $class The class to use.
-     * @return string
-     */
-    protected function _next_link($url, $class = 'dashicons dashicons-arrow-right')
-    {
-        return '<a class="' . $class . '" href="' . $url . '"></a>';
-    }
-
-
-    /**
-     * A helper for getting a "previous link".
-     *
-     * @param string $url   The url to link to
-     * @param string $class The class to use.
-     * @return string
-     */
-    protected function _previous_link($url, $class = 'dashicons dashicons-arrow-left')
-    {
-        return '<a class="' . $class . '" href="' . $url . '"></a>';
-    }
-
-
-
-
-
-
-
-    // below are some messages related methods that should be available across the EE_Admin system.  Note, these methods are NOT page specific
-
-
-    /**
-     * This processes an request to resend a registration and assumes we have a _REG_ID for doing so. So if the caller
-     * knows that the _REG_ID isn't in the req_data array but CAN obtain it, the caller should ADD the _REG_ID to the
-     * _req_data array.
-     *
-     * @return bool success/fail
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _process_resend_registration()
-    {
-        $this->_template_args['success'] = EED_Messages::process_resend($this->_req_data);
-        do_action(
-            'AHEE__EE_Admin_Page___process_resend_registration',
-            $this->_template_args['success'],
-            $this->request->requestParams()
-        );
-        return $this->_template_args['success'];
-    }
-
-
-    /**
-     * This automatically processes any payment message notifications when manual payment has been applied.
-     *
-     * @param EE_Payment $payment
-     * @return bool success/fail
-     */
-    protected function _process_payment_notification(EE_Payment $payment)
-    {
-        add_filter('FHEE__EE_Payment_Processor__process_registration_payments__display_notifications', '__return_true');
-        do_action('AHEE__EE_Admin_Page___process_admin_payment_notification', $payment);
-        $this->_template_args['success'] = apply_filters(
-            'FHEE__EE_Admin_Page___process_admin_payment_notification__success',
-            false,
-            $payment
-        );
-        return $this->_template_args['success'];
-    }
+		// add nonce
+		$nonce                                             =
+			wp_nonce_field($route . '_nonce', $route . '_nonce', false, false);
+		$this->_template_args['before_admin_page_content'] .= "\n\t" . $nonce;
+		// add REQUIRED form action
+		$hidden_fields = [
+			'action' => ['type' => 'hidden', 'value' => $route],
+		];
+		// merge arrays
+		$hidden_fields = is_array($additional_hidden_fields)
+			? array_merge($hidden_fields, $additional_hidden_fields)
+			: $hidden_fields;
+		// generate form fields
+		$form_fields = $this->_generate_admin_form_fields($hidden_fields, 'array');
+		// add fields to form
+		foreach ((array) $form_fields as $form_field) {
+			$this->_template_args['before_admin_page_content'] .= "\n\t" . $form_field['field'];
+		}
+		// close form
+		$this->_template_args['after_admin_page_content'] = '</form>';
+	}
+
+
+	/**
+	 * Public Wrapper for _redirect_after_action() method since its
+	 * discovered it would be useful for external code to have access.
+	 *
+	 * @param bool   $success
+	 * @param string $what
+	 * @param string $action_desc
+	 * @param array  $query_args
+	 * @param bool   $override_overwrite
+	 * @throws EE_Error
+	 * @see   EE_Admin_Page::_redirect_after_action() for params.
+	 * @since 4.5.0
+	 */
+	public function redirect_after_action(
+		$success = false,
+		$what = 'item',
+		$action_desc = 'processed',
+		$query_args = [],
+		$override_overwrite = false
+	) {
+		$this->_redirect_after_action(
+			$success,
+			$what,
+			$action_desc,
+			$query_args,
+			$override_overwrite
+		);
+	}
+
+
+	/**
+	 * Helper method for merging existing request data with the returned redirect url.
+	 *
+	 * This is typically used for redirects after an action so that if the original view was a filtered view those
+	 * filters are still applied.
+	 *
+	 * @param array $new_route_data
+	 * @return array
+	 */
+	protected function mergeExistingRequestParamsWithRedirectArgs(array $new_route_data)
+	{
+		foreach ($this->request->requestParams() as $ref => $value) {
+			// unset nonces
+			if (strpos($ref, 'nonce') !== false) {
+				$this->request->unSetRequestParam($ref);
+				continue;
+			}
+			// urlencode values.
+			$value = is_array($value) ? array_map('urlencode', $value) : urlencode($value);
+			$this->request->setRequestParam($ref, $value);
+		}
+		return array_merge($this->request->requestParams(), $new_route_data);
+	}
+
+
+	/**
+	 *    _redirect_after_action
+	 *
+	 * @param int    $success            - whether success was for two or more records, or just one, or none
+	 * @param string $what               - what the action was performed on
+	 * @param string $action_desc        - what was done ie: updated, deleted, etc
+	 * @param array  $query_args         - an array of query_args to be added to the URL to redirect to after the admin
+	 *                                   action is completed
+	 * @param BOOL   $override_overwrite by default all EE_Error::success messages are overwritten, this allows you to
+	 *                                   override this so that they show.
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	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,
+			EE_Admin_Page::add_query_args_and_nonce($query_args, $redirect_url),
+			$query_args
+		);
+		// check if we're doing ajax.  If we are then lets just return the results and js can handle how it wants.
+		if ($this->request->isAjax()) {
+			$default_data                    = [
+				'close'        => true,
+				'redirect_url' => $redirect_url,
+				'where'        => 'main',
+				'what'         => 'append',
+			];
+			$this->_template_args['success'] = $success;
+			$this->_template_args['data']    = ! empty($this->_template_args['data']) ? array_merge(
+				$default_data,
+				$this->_template_args['data']
+			) : $default_data;
+			$this->_return_json();
+		}
+		wp_safe_redirect($redirect_url);
+		exit();
+	}
+
+
+	/**
+	 * process any notices before redirecting (or returning ajax request)
+	 * This method sets the $this->_template_args['notices'] attribute;
+	 *
+	 * @param array $query_args         any query args that need to be used for notice transient ('action')
+	 * @param bool  $skip_route_verify  This is typically used when we are processing notices REALLY early and
+	 *                                  page_routes haven't been defined yet.
+	 * @param bool  $sticky_notices     This is used to flag that regardless of whether this is doing_ajax or not, we
+	 *                                  still save a transient for the notice.
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _process_notices($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 = EE_Admin_Page::add_query_args_and_nonce($query_args, $_base_url, false, $exclude_nonce);
+		return EEH_Template::get_button_or_link($url, $this->_labels['buttons'][ $type ], $class);
+	}
+
+
+	/**
+	 * _per_page_screen_option
+	 * Utility function for adding in a per_page_option in the screen_options_dropdown.
+	 *
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	protected function _per_page_screen_option()
+	{
+		$option = 'per_page';
+		$args   = [
+			'label'   => apply_filters(
+				'FHEE__EE_Admin_Page___per_page_screen_options___label',
+				$this->_admin_page_title,
+				$this
+			),
+			'default' => (int) apply_filters(
+				'FHEE__EE_Admin_Page___per_page_screen_options__default',
+				20
+			),
+			'option'  => $this->_current_page . '_' . $this->_current_view . '_per_page',
+		];
+		// ONLY add the screen option if the user has access to it.
+		if ($this->check_user_access($this->_current_view, true)) {
+			add_screen_option($option, $args);
+		}
+	}
+
+
+	/**
+	 * set_per_page_screen_option
+	 * All this does is make sure that WordPress saves any per_page screen options (if set) for the current page.
+	 * we have to do this rather than running inside the 'set-screen-options' hook because it runs earlier than
+	 * admin_menu.
+	 *
+	 * @return void
+	 */
+	private function _set_per_page_screen_options()
+	{
+		if ($this->request->requestParamIsSet('wp_screen_options')) {
+			check_admin_referer('screen-options-nonce', 'screenoptionnonce');
+			if (! $user = wp_get_current_user()) {
+				return;
+			}
+			$option = $this->request->getRequestParam('wp_screen_options[option]', '', 'key');
+			if (! $option) {
+				return;
+			}
+			$value  = $this->request->getRequestParam('wp_screen_options[value]', 0, 'int');
+			$map_option = $option;
+			$option     = str_replace('-', '_', $option);
+			switch ($map_option) {
+				case $this->_current_page . '_' . $this->_current_view . '_per_page':
+					$max_value = apply_filters(
+						'FHEE__EE_Admin_Page___set_per_page_screen_options__max_value',
+						999,
+						$this->_current_page,
+						$this->_current_view
+					);
+					if ($value < 1) {
+						return;
+					}
+					$value = min($value, $max_value);
+					break;
+				default:
+					$value = apply_filters(
+						'FHEE__EE_Admin_Page___set_per_page_screen_options__value',
+						false,
+						$option,
+						$value
+					);
+					if (false === $value) {
+						return;
+					}
+					break;
+			}
+			update_user_meta($user->ID, $option, $value);
+			wp_safe_redirect(remove_query_arg(['pagenum', 'apage', 'paged'], wp_get_referer()));
+			exit;
+		}
+	}
+
+
+	/**
+	 * This just allows for setting the $_template_args property if it needs to be set outside the object
+	 *
+	 * @param array $data array that will be assigned to template args.
+	 */
+	public function set_template_args($data)
+	{
+		$this->_template_args = array_merge($this->_template_args, (array) $data);
+	}
+
+
+	/**
+	 * This makes available the WP transient system for temporarily moving data between routes
+	 *
+	 * @param string $route             the route that should receive the transient
+	 * @param array  $data              the data that gets sent
+	 * @param bool   $notices           If this is for notices then we use this to indicate so, otherwise its just a
+	 *                                  normal route transient.
+	 * @param bool   $skip_route_verify Used to indicate we want to skip route verification.  This is usually ONLY used
+	 *                                  when we are adding a transient before page_routes have been defined.
+	 * @return void
+	 * @throws EE_Error
+	 */
+	protected function _add_transient($route, $data, $notices = false, $skip_route_verify = false)
+	{
+		$user_id = get_current_user_id();
+		if (! $skip_route_verify) {
+			$this->_verify_route($route);
+		}
+		// now let's set the string for what kind of transient we're setting
+		$transient = $notices
+			? 'ee_rte_n_tx_' . $route . '_' . $user_id
+			: 'rte_tx_' . $route . '_' . $user_id;
+		$data      = $notices ? ['notices' => $data] : $data;
+		// is there already a transient for this route?  If there is then let's ADD to that transient
+		$existing = is_multisite() && is_network_admin()
+			? get_site_transient($transient)
+			: get_transient($transient);
+		if ($existing) {
+			$data = array_merge((array) $data, (array) $existing);
+		}
+		if (is_multisite() && is_network_admin()) {
+			set_site_transient($transient, $data, 8);
+		} else {
+			set_transient($transient, $data, 8);
+		}
+	}
+
+
+	/**
+	 * this retrieves the temporary transient that has been set for moving data between routes.
+	 *
+	 * @param bool   $notices true we get notices transient. False we just return normal route transient
+	 * @param string $route
+	 * @return mixed data
+	 */
+	protected function _get_transient($notices = false, $route = '')
+	{
+		$user_id   = get_current_user_id();
+		$route     = ! $route ? $this->_req_action : $route;
+		$transient = $notices
+			? 'ee_rte_n_tx_' . $route . '_' . $user_id
+			: 'rte_tx_' . $route . '_' . $user_id;
+		$data      = is_multisite() && is_network_admin()
+			? get_site_transient($transient)
+			: get_transient($transient);
+		// delete transient after retrieval (just in case it hasn't expired);
+		if (is_multisite() && is_network_admin()) {
+			delete_site_transient($transient);
+		} else {
+			delete_transient($transient);
+		}
+		return $notices && isset($data['notices']) ? $data['notices'] : $data;
+	}
+
+
+	/**
+	 * The purpose of this method is just to run garbage collection on any EE transients that might have expired but
+	 * would not be called later. This will be assigned to run on a specific EE Admin page. (place the method in the
+	 * default route callback on the EE_Admin page you want it run.)
+	 *
+	 * @return void
+	 */
+	protected function _transient_garbage_collection()
+	{
+		global $wpdb;
+		// retrieve all existing transients
+		$query =
+			"SELECT option_name FROM {$wpdb->options} WHERE option_name LIKE '%rte_tx_%' OR option_name LIKE '%rte_n_tx_%'";
+		if ($results = $wpdb->get_results($query)) {
+			foreach ($results as $result) {
+				$transient = str_replace('_transient_', '', $result->option_name);
+				get_transient($transient);
+				if (is_multisite() && is_network_admin()) {
+					get_site_transient($transient);
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * get_view
+	 *
+	 * @return string content of _view property
+	 */
+	public function get_view()
+	{
+		return $this->_view;
+	}
+
+
+	/**
+	 * getter for the protected $_views property
+	 *
+	 * @return array
+	 */
+	public function get_views()
+	{
+		return $this->_views;
+	}
+
+
+	/**
+	 * get_current_page
+	 *
+	 * @return string _current_page property value
+	 */
+	public function get_current_page()
+	{
+		return $this->_current_page;
+	}
+
+
+	/**
+	 * get_current_view
+	 *
+	 * @return string _current_view property value
+	 */
+	public function get_current_view()
+	{
+		return $this->_current_view;
+	}
+
+
+	/**
+	 * get_current_screen
+	 *
+	 * @return object The current WP_Screen object
+	 */
+	public function get_current_screen()
+	{
+		return $this->_current_screen;
+	}
+
+
+	/**
+	 * get_current_page_view_url
+	 *
+	 * @return string This returns the url for the current_page_view.
+	 */
+	public function get_current_page_view_url()
+	{
+		return $this->_current_page_view_url;
+	}
+
+
+	/**
+	 * just returns the Request
+	 *
+	 * @return RequestInterface
+	 */
+	public function get_request()
+	{
+		return $this->request;
+	}
+
+
+	/**
+	 * just returns the _req_data property
+	 *
+	 * @return array
+	 */
+	public function get_request_data()
+	{
+		return $this->request->requestParams();
+	}
+
+
+	/**
+	 * returns the _req_data protected property
+	 *
+	 * @return string
+	 */
+	public function get_req_action()
+	{
+		return $this->_req_action;
+	}
+
+
+	/**
+	 * @return bool  value of $_is_caf property
+	 */
+	public function is_caf()
+	{
+		return $this->_is_caf;
+	}
+
+
+	/**
+	 * @return mixed
+	 */
+	public function default_espresso_metaboxes()
+	{
+		return $this->_default_espresso_metaboxes;
+	}
+
+
+	/**
+	 * @return mixed
+	 */
+	public function admin_base_url()
+	{
+		return $this->_admin_base_url;
+	}
+
+
+	/**
+	 * @return mixed
+	 */
+	public function wp_page_slug()
+	{
+		return $this->_wp_page_slug;
+	}
+
+
+	/**
+	 * updates  espresso configuration settings
+	 *
+	 * @param string                   $tab
+	 * @param EE_Config_Base|EE_Config $config
+	 * @param string                   $file file where error occurred
+	 * @param string                   $func function  where error occurred
+	 * @param string                   $line line no where error occurred
+	 * @return boolean
+	 */
+	protected function _update_espresso_configuration($tab, $config, $file = '', $func = '', $line = '')
+	{
+		// remove any options that are NOT going to be saved with the config settings.
+		if (isset($config->core->ee_ueip_optin)) {
+			// TODO: remove the following two lines and make sure values are migrated from 3.1
+			update_option('ee_ueip_optin', $config->core->ee_ueip_optin);
+			update_option('ee_ueip_has_notified', true);
+		}
+		// and save it (note we're also doing the network save here)
+		$net_saved    = ! is_main_site() || EE_Network_Config::instance()->update_config(false, false);
+		$config_saved = EE_Config::instance()->update_espresso_config(false, false);
+		if ($config_saved && $net_saved) {
+			EE_Error::add_success(sprintf(esc_html__('"%s" have been successfully updated.', 'event_espresso'), $tab));
+			return true;
+		}
+		EE_Error::add_error(sprintf(esc_html__('The "%s" were not updated.', 'event_espresso'), $tab), $file, $func, $line);
+		return false;
+	}
+
+
+	/**
+	 * Returns an array to be used for EE_FOrm_Fields.helper.php's select_input as the $values argument.
+	 *
+	 * @return array
+	 */
+	public function get_yes_no_values()
+	{
+		return $this->_yes_no_values;
+	}
+
+
+	/**
+	 * @return string
+	 * @throws ReflectionException
+	 * @since $VID:$
+	 */
+	protected function _get_dir()
+	{
+		$reflector = new ReflectionClass(get_class($this));
+		return dirname($reflector->getFileName());
+	}
+
+
+	/**
+	 * A helper for getting a "next link".
+	 *
+	 * @param string $url   The url to link to
+	 * @param string $class The class to use.
+	 * @return string
+	 */
+	protected function _next_link($url, $class = 'dashicons dashicons-arrow-right')
+	{
+		return '<a class="' . $class . '" href="' . $url . '"></a>';
+	}
+
+
+	/**
+	 * A helper for getting a "previous link".
+	 *
+	 * @param string $url   The url to link to
+	 * @param string $class The class to use.
+	 * @return string
+	 */
+	protected function _previous_link($url, $class = 'dashicons dashicons-arrow-left')
+	{
+		return '<a class="' . $class . '" href="' . $url . '"></a>';
+	}
+
+
+
+
+
+
+
+	// below are some messages related methods that should be available across the EE_Admin system.  Note, these methods are NOT page specific
+
+
+	/**
+	 * This processes an request to resend a registration and assumes we have a _REG_ID for doing so. So if the caller
+	 * knows that the _REG_ID isn't in the req_data array but CAN obtain it, the caller should ADD the _REG_ID to the
+	 * _req_data array.
+	 *
+	 * @return bool success/fail
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _process_resend_registration()
+	{
+		$this->_template_args['success'] = EED_Messages::process_resend($this->_req_data);
+		do_action(
+			'AHEE__EE_Admin_Page___process_resend_registration',
+			$this->_template_args['success'],
+			$this->request->requestParams()
+		);
+		return $this->_template_args['success'];
+	}
+
+
+	/**
+	 * This automatically processes any payment message notifications when manual payment has been applied.
+	 *
+	 * @param EE_Payment $payment
+	 * @return bool success/fail
+	 */
+	protected function _process_payment_notification(EE_Payment $payment)
+	{
+		add_filter('FHEE__EE_Payment_Processor__process_registration_payments__display_notifications', '__return_true');
+		do_action('AHEE__EE_Admin_Page___process_admin_payment_notification', $payment);
+		$this->_template_args['success'] = apply_filters(
+			'FHEE__EE_Admin_Page___process_admin_payment_notification__success',
+			false,
+			$payment
+		);
+		return $this->_template_args['success'];
+	}
 }

Spacing +177 added lines, -177 removed lines

@@ -623,7 +623,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;
         }
@@ -643,7 +643,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],
@@ -680,21 +680,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
             );
@@ -707,8 +707,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
@@ -727,12 +727,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.',
@@ -749,7 +749,7 @@ 
                                    ),
                                    $page,
                                    '<br />',
-                                   '<strong>' . $classname . '</strong>'
+                                   '<strong>'.$classname.'</strong>'
                                );
                 throw new EE_Error(implode('||', $error_msg));
             }
@@ -791,13 +791,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();
@@ -919,7 +919,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;
@@ -931,7 +931,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'
@@ -940,8 +940,8 @@ 
         }
         // and that the requested page route exists
         if (array_key_exists($this->_req_action, $this->_page_routes)) {
-            $this->_route        = $this->_page_routes[ $this->_req_action ];
-            $this->_route_config = $this->_page_config[ $this->_req_action ] ?? [];
+            $this->_route        = $this->_page_routes[$this->_req_action];
+            $this->_route_config = $this->_page_config[$this->_req_action] ?? [];
         } else {
             // user error msg
             $error_msg = sprintf(
@@ -952,7 +952,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.',
@@ -963,7 +963,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__(
@@ -973,7 +973,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'
@@ -1015,7 +1015,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',
@@ -1043,7 +1043,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'),
@@ -1060,7 +1060,7 @@ 
                     __CLASS__
                 );
             }
-            if (! $this->request->isAjax()) {
+            if ( ! $this->request->isAjax()) {
                 wp_die($msg);
             }
             EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
@@ -1084,7 +1084,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'];
@@ -1104,7 +1104,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
@@ -1115,7 +1115,7 @@ 
                 wp_unslash($this->request->getServerParam('REQUEST_URI'))
             )
         );
-        if (! empty($func)) {
+        if ( ! empty($func)) {
             if (is_array($func)) {
                 [$class, $method] = $func;
             } elseif (strpos($func, '::') !== false) {
@@ -1124,7 +1124,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;
             }
@@ -1165,7 +1165,7 @@ 
                     $method
                 );
             }
-            if (! empty($error_msg)) {
+            if ( ! empty($error_msg)) {
                 throw new EE_Error($error_msg);
             }
         }
@@ -1250,7 +1250,7 @@ 
                 if (strpos($key, 'nonce') !== false) {
                     continue;
                 }
-                $args[ 'wp_referer[' . $key . ']' ] = is_string($value) ? htmlspecialchars($value) : $value;
+                $args['wp_referer['.$key.']'] = is_string($value) ? htmlspecialchars($value) : $value;
             }
         }
         return EEH_URL::add_query_args_and_nonce($args, $url, $exclude_nonce);
@@ -1291,8 +1291,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 ])) {
@@ -1315,7 +1315,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__(
@@ -1328,7 +1328,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.
@@ -1336,30 +1336,30 @@ 
                 $this->_current_screen->set_help_sidebar($content);
             }
             // if there ARE tour buttons...
-            if (! empty($tour_buttons)) {
+            if ( ! empty($tour_buttons)) {
                 // if we DON'T have config help sidebar then we'll just add the tour buttons to the sidebar.
-                if (! isset($config['help_sidebar'])) {
+                if ( ! isset($config['help_sidebar'])) {
                     $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'])) {
+                if ( ! isset($config['help_tabs'])) {
                     $_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',
@@ -1367,7 +1367,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',
@@ -1376,11 +1376,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())
@@ -1388,7 +1388,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__(
@@ -1436,7 +1436,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'],
@@ -1566,8 +1566,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);
         }
@@ -1589,7 +1589,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
@@ -1598,12 +1598,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']
                     : EE_Admin_Page::add_query_args_and_nonce(
@@ -1615,14 +1615,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',
@@ -1647,10 +1647,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;
                 }
             }
         }
@@ -1672,12 +1672,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'];
@@ -1723,7 +1723,7 @@ 
         add_meta_box($box_id, $title, $callback, $screen, $context, $priority, $callback_args);
         add_filter(
             "postbox_classes_{$this->_wp_page_slug}_{$box_id}",
-            function ($classes) {
+            function($classes) {
                 array_push($classes, 'ee-admin-container');
                 return $classes;
             }
@@ -1822,7 +1822,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>';
     }
 
 
@@ -1856,7 +1856,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'], $help['content'])) {
+            if ( ! isset($help['title'], $help['content'])) {
                 throw new EE_Error(
                     esc_html__(
                         'Does not look like the popup content array has been setup correctly.  Might want to double check that.  Read the comments for the _get_help_popup_content method found in "EE_Admin_Page" class',
@@ -1870,8 +1870,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
             );
@@ -1893,15 +1893,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 = $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.',
@@ -1933,8 +1933,8 @@ 
         // 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.)',
@@ -2053,7 +2053,7 @@ 
 
         add_filter(
             'admin_body_class',
-            function ($classes) {
+            function($classes) {
                 if (strpos($classes, 'espresso-admin') === false) {
                     $classes .= ' espresso-admin';
                 }
@@ -2144,12 +2144,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.',
@@ -2169,10 +2169,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();
@@ -2207,7 +2207,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__(
@@ -2245,17 +2245,17 @@ 
         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'] ])) {
-                foreach ($extra_query_args[ $view['slug'] ] as $extra_query_arg) {
+            if (isset($extra_query_args[$view['slug']])) {
+                foreach ($extra_query_args[$view['slug']] as $extra_query_arg) {
                     $query_args[] = $extra_query_arg;
                 }
             }
-            $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;
     }
@@ -2286,14 +2286,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
@@ -2317,7 +2317,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;
     }
 
 
@@ -2405,7 +2405,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
@@ -2450,7 +2450,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(
@@ -2477,28 +2477,28 @@ 
      */
     public function espresso_ratings_request()
     {
-        EEH_Template::display_template(EE_ADMIN_TEMPLATE . 'espresso_ratings_request_content.template.php');
+        EEH_Template::display_template(EE_ADMIN_TEMPLATE.'espresso_ratings_request_content.template.php');
     }
 
 
     public static function cached_rss_display($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();
@@ -2565,19 +2565,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');
@@ -2606,7 +2606,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
         );
@@ -2694,18 +2694,18 @@ 
             );
         }
         $this->_template_args['publish_delete_link'] = $delete_link;
-        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;
     }
 
@@ -2807,7 +2807,7 @@ 
         }
         // if $create_func is true (default) then we automatically create the function for displaying the actual meta box.  If false then we take the $callback reference passed through and use it instead (so callers can define their own callback function/method if they wish)
         $call_back_func = $create_func
-            ? static function ($post, $metabox) {
+            ? static function($post, $metabox) {
                 do_action('AHEE_log', __FILE__, __FUNCTION__, '');
                 echo EEH_Template::display_template(
                     $metabox['args']['template_path'],
@@ -2817,7 +2817,7 @@ 
             }
             : $callback;
         $this->addMetaBox(
-            str_replace('_', '-', $action) . '-mbox',
+            str_replace('_', '-', $action).'-mbox',
             $title,
             $call_back_func,
             $this->_wp_page_slug,
@@ -2934,13 +2934,13 @@ 
             'event-espresso_page_espresso_',
             '',
             $this->_wp_page_slug
-        ) . ' ' . $this->_req_action . '-route';
+        ).' '.$this->_req_action.'-route';
 
         $template_path = $sidebar
             ? EE_ADMIN_TEMPLATE . 'admin_details_wrapper.template.php'
-            : EE_ADMIN_TEMPLATE . 'admin_details_wrapper_no_sidebar.template.php';
+            : EE_ADMIN_TEMPLATE.'admin_details_wrapper_no_sidebar.template.php';
         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;
 
@@ -2974,11 +2974,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',
@@ -2998,8 +2998,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
         );
@@ -3057,7 +3057,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);
@@ -3065,10 +3065,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
             );
@@ -3085,18 +3085,18 @@ 
 
         $hidden_form_fields = $this->_template_args['list_table_hidden_fields'] ?? '';
 
-        $nonce_ref          = $this->_req_action . '_nonce';
+        $nonce_ref          = $this->_req_action.'_nonce';
         $hidden_form_fields .= '
-            <input type="hidden" name="' . $nonce_ref . '" value="' . wp_create_nonce($nonce_ref) . '">';
+            <input type="hidden" name="' . $nonce_ref.'" value="'.wp_create_nonce($nonce_ref).'">';
 
-        $this->_template_args['list_table_hidden_fields']        = $hidden_form_fields;
+        $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(
@@ -3130,7 +3130,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',
@@ -3178,15 +3178,15 @@ 
         );
         /** @var EventEspresso\core\admin\StatusChangeNotice $status_change_notice */
         $status_change_notice = $this->loader->getShared('EventEspresso\core\admin\StatusChangeNotice');
-        if (! $status_change_notice->isDismissed()) {
+        if ( ! $status_change_notice->isDismissed()) {
             $this->_template_args['status_change_notice'] = EEH_Template::display_template(
-                EE_ADMIN_TEMPLATE . 'status_change_notice.template.php',
-                [ 'context' => '__admin-legend', 'page_slug' => $this->page_slug ],
+                EE_ADMIN_TEMPLATE.'status_change_notice.template.php',
+                ['context' => '__admin-legend', 'page_slug' => $this->page_slug],
                 true
             );
         }
         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
         );
@@ -3304,18 +3304,18 @@ 
                 : ''
         );
 
-        $this->_template_args['after_admin_page_content']  = apply_filters(
+        $this->_template_args['after_admin_page_content'] = apply_filters(
             "FHEE_after_admin_page_content{$this->_current_page}{$this->_current_view}",
             isset($this->_template_args['after_admin_page_content'])
                 ? $this->_template_args['after_admin_page_content']
                 : ''
         );
-        $this->_template_args['after_admin_page_content']  .= $this->_set_help_popup_content();
+        $this->_template_args['after_admin_page_content'] .= $this->_set_help_popup_content();
 
         if ($this->request->isAjax()) {
             $this->_template_args['admin_page_content'] = EEH_Template::display_template(
                 // $template_path,
-                EE_ADMIN_TEMPLATE . 'admin_wrapper_ajax.template.php',
+                EE_ADMIN_TEMPLATE.'admin_wrapper_ajax.template.php',
                 $this->_template_args,
                 true
             );
@@ -3324,7 +3324,7 @@ 
         // load settings page wrapper template
         $template_path = $about
             ? EE_ADMIN_TEMPLATE . 'about_admin_wrapper.template.php'
-            : EE_ADMIN_TEMPLATE . 'admin_wrapper.template.php';
+            : EE_ADMIN_TEMPLATE.'admin_wrapper.template.php';
 
         EEH_Template::display_template($template_path, $this->_template_args);
     }
@@ -3408,12 +3408,12 @@ 
         $default_names = ['save', 'save_and_close'];
         $buttons = '';
         foreach ($button_text as $key => $button) {
-            $ref     = $default_names[ $key ];
-            $name    = ! empty($actions) ? $actions[ $key ] : $ref;
-            $buttons .= '<input type="submit" class="button button--primary ' . $ref . '" '
-                        . 'value="' . $button . '" name="' . $name . '" '
-                        . 'id="' . $this->_current_view . '_' . $ref . '" />';
-            if (! $both) {
+            $ref     = $default_names[$key];
+            $name    = ! empty($actions) ? $actions[$key] : $ref;
+            $buttons .= '<input type="submit" class="button button--primary '.$ref.'" '
+                        . 'value="'.$button.'" name="'.$name.'" '
+                        . 'id="'.$this->_current_view.'_'.$ref.'" />';
+            if ( ! $both) {
                 break;
             }
         }
@@ -3453,13 +3453,13 @@ 
                 'An error occurred. No action was set for this page\'s form.',
                 'event_espresso'
             );
-            $dev_msg  = $user_msg . "\n"
+            $dev_msg = $user_msg."\n"
                         . sprintf(
                             esc_html__('The $route argument is required for the %s->%s method.', 'event_espresso'),
                             __FUNCTION__,
                             __CLASS__
                         );
-            EE_Error::add_error($user_msg . '||' . $dev_msg, __FILE__, __FUNCTION__, __LINE__);
+            EE_Error::add_error($user_msg.'||'.$dev_msg, __FILE__, __FUNCTION__, __LINE__);
         }
         // open form
         $action = $this->_admin_base_url;
@@ -3467,9 +3467,9 @@ 
             <form name='form' method='post' action='{$action}' id='{$route}_event_form' class='ee-admin-page-form' >
             ";
         // add nonce
-        $nonce                                             =
-            wp_nonce_field($route . '_nonce', $route . '_nonce', false, false);
-        $this->_template_args['before_admin_page_content'] .= "\n\t" . $nonce;
+        $nonce =
+            wp_nonce_field($route.'_nonce', $route.'_nonce', false, false);
+        $this->_template_args['before_admin_page_content'] .= "\n\t".$nonce;
         // add REQUIRED form action
         $hidden_fields = [
             'action' => ['type' => 'hidden', 'value' => $route],
@@ -3482,7 +3482,7 @@ 
         $form_fields = $this->_generate_admin_form_fields($hidden_fields, 'array');
         // add fields to form
         foreach ((array) $form_fields as $form_field) {
-            $this->_template_args['before_admin_page_content'] .= "\n\t" . $form_field['field'];
+            $this->_template_args['before_admin_page_content'] .= "\n\t".$form_field['field'];
         }
         // close form
         $this->_template_args['after_admin_page_content'] = '</form>';
@@ -3576,10 +3576,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
@@ -3608,7 +3608,7 @@ 
             }
         }
         // check that $query_args isn't something crazy
-        if (! is_array($query_args)) {
+        if ( ! is_array($query_args)) {
             $query_args = [];
         }
         /**
@@ -3637,7 +3637,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?
@@ -3649,15 +3649,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.
@@ -3669,19 +3669,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,
             EE_Admin_Page::add_query_args_and_nonce($query_args, $redirect_url),
             $query_args
         );
         // check if we're doing ajax.  If we are then lets just return the results and js can handle how it wants.
         if ($this->request->isAjax()) {
-            $default_data                    = [
+            $default_data = [
                 'close'        => true,
                 'redirect_url' => $redirect_url,
                 'where'        => 'main',
@@ -3731,7 +3731,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,
@@ -3771,7 +3771,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__(
@@ -3782,7 +3782,7 @@ 
                 )
             );
         }
-        if (! isset($this->_labels['buttons'][ $type ])) {
+        if ( ! isset($this->_labels['buttons'][$type])) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -3795,7 +3795,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;
@@ -3803,11 +3803,11 @@ 
             'action' => $action,
         ];
         // merge extra_request args but make sure our original action takes precedence and doesn't get overwritten.
-        if (! empty($extra_request)) {
+        if ( ! empty($extra_request)) {
             $query_args = array_merge($extra_request, $query_args);
         }
         $url = EE_Admin_Page::add_query_args_and_nonce($query_args, $_base_url, false, $exclude_nonce);
-        return EEH_Template::get_button_or_link($url, $this->_labels['buttons'][ $type ], $class);
+        return EEH_Template::get_button_or_link($url, $this->_labels['buttons'][$type], $class);
     }
 
 
@@ -3833,7 +3833,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)) {
@@ -3854,18 +3854,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,
@@ -3922,13 +3922,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()
@@ -3957,8 +3957,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);
@@ -4194,7 +4194,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>';
     }
 
 
@@ -4207,7 +4207,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>';
     }
 
 

caffeinated/admin/extend/registrations/EE_Event_Registrations_List_Table.class.php

Indentation +595 added lines, -595 removed lines

@@ -12,350 +12,350 @@ 
  */
 class EE_Event_Registrations_List_Table extends EE_Admin_List_Table
 {
-    /**
-     * @var Extend_Registrations_Admin_Page
-     */
-    protected $_admin_page;
-
-    /**
-     * This property will hold the related Datetimes on an event IF the event id is included in the request.
-     *
-     * @var EE_Datetime[]
-     */
-    protected $_dtts_for_event = [];
-
-    /**
-     * The event if one is specified in the request
-     *
-     * @var EE_Event
-     */
-    protected $_evt = null;
-
-    /**
-     * The DTT_ID if the current view has a specified datetime.
-     *
-     * @var int $_cur_dtt_id
-     */
-    protected $_cur_dtt_id = 0;
-
-
-    /**
-     * EE_Event_Registrations_List_Table constructor.
-     *
-     * @param Registrations_Admin_Page $admin_page
-     */
-    public function __construct($admin_page)
-    {
-        parent::__construct($admin_page);
-    }
-
-
-    /**
-     * @throws EE_Error
-     */
-    protected function _setup_data()
-    {
-        $this->_data = $this->_view !== 'trash'
-            ? $this->_admin_page->get_event_attendees($this->_per_page)
-            : $this->_admin_page->get_event_attendees($this->_per_page, false, true);
-
-        $this->_all_data_count = $this->_view !== 'trash'
-            ? $this->_admin_page->get_event_attendees($this->_per_page, true)
-            : $this->_admin_page->get_event_attendees($this->_per_page, true, true);
-    }
-
-
-    /**
-     * @throws ReflectionException
-     * @throws EE_Error
-     */
-    protected function _set_properties()
-    {
-        $return_url = $this->getReturnUrl();
-        $evt_id     = $this->_req_data['event_id'] ?? null;
-
-        $this->_wp_list_args = [
-            'singular' => esc_html__('registrant', 'event_espresso'),
-            'plural'   => esc_html__('registrants', 'event_espresso'),
-            'ajax'     => true,
-            'screen'   => $this->_admin_page->get_current_screen()->id,
-        ];
-        $columns             = [];
-        $this->_columns      = [
-            '_REG_att_checked_in' => esc_html__('Check In', 'event_espresso'),
-            'ATT_name'            => esc_html__('Registrant', 'event_espresso'),
-            'ATT_email'           => esc_html__('Email Address', 'event_espresso'),
-            'Event'               => esc_html__('Event', 'event_espresso'),
-            'PRC_name'            => esc_html__('TKT Option', 'event_espresso'),
-            '_REG_final_price'    => esc_html__('Price', 'event_espresso'),
-            'TXN_paid'            => esc_html__('Paid', 'event_espresso'),
-            'TXN_total'           => esc_html__('Total', 'event_espresso'),
-        ];
-        // Add/remove columns when an event has been selected
-        if (! empty($evt_id)) {
-            // Render a checkbox column
-            $columns['cb']              = '<input type="checkbox" />';
-            $this->_has_checkbox_column = true;
-            // Remove the 'Event' column
-            unset($this->_columns['Event']);
-        }
-        $this->_columns        = array_merge($columns, $this->_columns);
-        $this->_primary_column = '_REG_att_checked_in';
-        if (
-            ! empty($evt_id)
-            && EE_Registry::instance()->CAP->current_user_can(
-                'ee_read_registrations',
-                'espresso_registrations_registrations_reports',
-                $evt_id
-            )
-        ) {
-            $this->_bottom_buttons = [
-                'report' => [
-                    'route'         => 'registrations_report',
-                    'extra_request' =>
-                        [
-                            'EVT_ID'     => $evt_id,
-                            'return_url' => $return_url,
-                        ],
-                ],
-            ];
-        }
-        $this->_bottom_buttons['report_filtered'] = [
-            'route'         => 'registrations_checkin_report',
-            'extra_request' => [
-                'use_filters' => true,
-                'filters'     => array_merge(
-                    [
-                        'EVT_ID' => $evt_id,
-                    ],
-                    array_diff_key(
-                        $this->_req_data,
-                        array_flip(
-                            [
-                                'page',
-                                'action',
-                                'default_nonce',
-                            ]
-                        )
-                    )
-                ),
-                'return_url'  => $return_url,
-            ],
-        ];
-        $this->_sortable_columns                  = [
-            /**
-             * Allows users to change the default sort if they wish.
-             * Returning a falsey on this filter will result in the default sort to be by firstname rather than last name.
-             *
-             * Note: usual naming conventions for filters aren't followed here so that just one filter can be used to
-             * change the sorts on any list table involving registration contacts.  If you want to only change the filter
-             * for a specific list table you can use the provided reference to this object instance.
-             */
-            'ATT_name' => [
-                'FHEE__EE_Registrations_List_Table___set_properties__default_sort_by_registration_last_name',
-                true,
-                $this,
-            ]
-                ? ['ATT_lname' => true]
-                : ['ATT_fname' => true],
-            'Event'    => ['Event.EVT_name' => false],
-        ];
-        $this->_hidden_columns                    = [];
-        $this->_evt                               = EEM_Event::instance()->get_one_by_ID($evt_id);
-        $this->_dtts_for_event                    =
-            $this->_evt instanceof EE_Event ? $this->_evt->datetimes_ordered() : [];
-    }
-
-
-    /**
-     * @param EE_Registration $item
-     * @return string
-     */
-    protected function _get_row_class($item): string
-    {
-        $class = parent::_get_row_class($item);
-        if ($this->_has_checkbox_column) {
-            $class .= ' has-checkbox-column';
-        }
-        return $class;
-    }
-
-
-    /**
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _get_table_filters(): array
-    {
-        $filters        = $where = [];
-        $current_EVT_ID = isset($this->_req_data['event_id']) ? (int) $this->_req_data['event_id'] : 0;
-        if (empty($this->_dtts_for_event) || count($this->_dtts_for_event) === 1) {
-            // this means we don't have an event so let's setup a filter dropdown for all the events to select
-            // note possible capability restrictions
-            if (! EE_Registry::instance()->CAP->current_user_can('ee_read_private_events', 'get_events')) {
-                $where['status**'] = ['!=', 'private'];
-            }
-            if (! EE_Registry::instance()->CAP->current_user_can('ee_read_others_events', 'get_events')) {
-                $where['EVT_wp_user'] = get_current_user_id();
-            }
-            $events   = EEM_Event::instance()->get_all(
-                [
-                    $where,
-                    'order_by' => ['Datetime.DTT_EVT_start' => 'DESC'],
-                ]
-            );
-            $events[] = [
-                'id'   => 0,
-                'text' => esc_html__(' - select an event - ', 'event_espresso'),
-            ];
-            $checked  = 'checked';
-            /** @var EE_Event $event */
-            foreach ($events as $event) {
-                // any registrations for this event?
-                if (! $event instanceof EE_Event || ! $event->get_count_of_all_registrations()) {
-                    continue;
-                }
-                $events[] = [
-                    'id'    => $event->ID(),
-                    'text'  => apply_filters(
-                        'FHEE__EE_Event_Registrations___get_table_filters__event_name',
-                        $event->get('EVT_name'),
-                        $event
-                    ),
-                    'class' => $event->is_expired() ? 'ee-expired-event' : '',
-                ];
-                if ($event->ID() === $current_EVT_ID && $event->is_expired()) {
-                    $checked = '';
-                }
-            }
-            $event_filter = '<div class="ee-event-filter">';
-            $event_filter .= '<label for="event_id">';
-            $event_filter .= esc_html__('Check-in Status for', 'event_espresso');
-            $event_filter .= '</label>&nbsp;&nbsp;';
-            $event_filter .= EEH_Form_Fields::select_input('event_id', $events, $current_EVT_ID);
-            $event_filter .= '<span class="ee-event-filter-toggle">';
-            $event_filter .= '<label for="js-ee-hide-expired-events">';
-            $event_filter .= '<input type="checkbox" id="js-ee-hide-expired-events" ' . $checked . '>&nbsp;&nbsp;';
-            $event_filter .= esc_html__('Hide Expired Events', 'event_espresso');
-            $event_filter .= '</label>';
-            $event_filter .= '</span>';
-            $event_filter .= '</div>';
-            $filters[]    = $event_filter;
-        }
-        if (! empty($this->_dtts_for_event)) {
-            // DTT datetimes filter
-            $this->_cur_dtt_id = $this->_req_data['DTT_ID'] ?? 0;
-            if (count($this->_dtts_for_event) > 1) {
-                $datetimes[0] = esc_html__('To toggle check-in status, select a datetime.', 'event_espresso');
-                foreach ($this->_dtts_for_event as $datetime) {
-                    $datetime_string              = $datetime->name();
-                    $datetime_string              = ! empty($datetime_string) ? ' (' . $datetime_string . ')' : '';
-                    $datetime_string              =
-                        $datetime->start_date_and_time() . ' - ' . $datetime->end_date_and_time() . $datetime_string;
-                    $datetimes[ $datetime->ID() ] = $datetime_string;
-                }
-                $input     = new EE_Select_Input(
-                    $datetimes,
-                    [
-                        'html_name' => 'DTT_ID',
-                        'html_id'   => 'DTT_ID',
-                        'default'   => $this->_cur_dtt_id,
-                    ]
-                );
-                $filters[] = $input->get_html_for_input();
-                $filters[] = '<input type="hidden" name="event_id" value="' . $current_EVT_ID . '">';
-            }
-        }
-        return $filters;
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _add_view_counts()
-    {
-        $this->_views['all']['count'] = $this->_get_total_event_attendees();
-    }
-
-
-    /**
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _get_total_event_attendees(): int
-    {
-        $EVT_ID       = isset($this->_req_data['event_id']) ? absint($this->_req_data['event_id']) : false;
-        $DTT_ID       = $this->_cur_dtt_id;
-        $query_params = [];
-        if ($EVT_ID) {
-            $query_params[0]['EVT_ID'] = $EVT_ID;
-        }
-        // if DTT is included we only show for that datetime.  Otherwise we're showing for all datetimes (the event).
-        if ($DTT_ID) {
-            $query_params[0]['Ticket.Datetime.DTT_ID'] = $DTT_ID;
-        }
-        $status_ids_array          = apply_filters(
-            'FHEE__Extend_Registrations_Admin_Page__get_event_attendees__status_ids_array',
-            [EEM_Registration::status_id_pending_payment, EEM_Registration::status_id_approved]
-        );
-        $query_params[0]['STS_ID'] = ['IN', $status_ids_array];
-        return EEM_Registration::instance()->count($query_params);
-    }
-
-
-    /**
-     * @param EE_Registration $item
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function column_cb($item): string
-    {
-        return sprintf('<input type="checkbox" name="checkbox[%1$s]" value="%1$s" />', $item->ID());
-    }
-
-
-    /**
-     * column_REG_att_checked_in
-     *
-     * @param EE_Registration $registration
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function column__REG_att_checked_in(EE_Registration $registration): string
-    {
-        $attendee      = $registration->attendee();
-        $attendee_name = $attendee instanceof EE_Attendee ? $attendee->full_name() : '';
-
-        if ($this->_cur_dtt_id === 0 && count($this->_dtts_for_event) === 1) {
-            $latest_related_datetime = $registration->get_latest_related_datetime();
-            if ($latest_related_datetime instanceof EE_Datetime) {
-                $this->_cur_dtt_id = $latest_related_datetime->ID();
-            }
-        }
-        $checkin_status_dashicon = CheckinStatusDashicon::fromRegistrationAndDatetimeId(
-            $registration,
-            $this->_cur_dtt_id
-        );
-        $nonce                   = wp_create_nonce('checkin_nonce');
-        $toggle_active           = ! empty($this->_cur_dtt_id)
-                                   && EE_Registry::instance()->CAP->current_user_can(
-                                       'ee_edit_checkin',
-                                       'espresso_registrations_toggle_checkin_status',
-                                       $registration->ID()
-                                   )
-            ? ' clickable trigger-checkin'
-            : '';
-        $mobile_view_content     = ' <span class="show-on-mobile-view-only">' . $attendee_name . '</span>';
-        return '
+	/**
+	 * @var Extend_Registrations_Admin_Page
+	 */
+	protected $_admin_page;
+
+	/**
+	 * This property will hold the related Datetimes on an event IF the event id is included in the request.
+	 *
+	 * @var EE_Datetime[]
+	 */
+	protected $_dtts_for_event = [];
+
+	/**
+	 * The event if one is specified in the request
+	 *
+	 * @var EE_Event
+	 */
+	protected $_evt = null;
+
+	/**
+	 * The DTT_ID if the current view has a specified datetime.
+	 *
+	 * @var int $_cur_dtt_id
+	 */
+	protected $_cur_dtt_id = 0;
+
+
+	/**
+	 * EE_Event_Registrations_List_Table constructor.
+	 *
+	 * @param Registrations_Admin_Page $admin_page
+	 */
+	public function __construct($admin_page)
+	{
+		parent::__construct($admin_page);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 */
+	protected function _setup_data()
+	{
+		$this->_data = $this->_view !== 'trash'
+			? $this->_admin_page->get_event_attendees($this->_per_page)
+			: $this->_admin_page->get_event_attendees($this->_per_page, false, true);
+
+		$this->_all_data_count = $this->_view !== 'trash'
+			? $this->_admin_page->get_event_attendees($this->_per_page, true)
+			: $this->_admin_page->get_event_attendees($this->_per_page, true, true);
+	}
+
+
+	/**
+	 * @throws ReflectionException
+	 * @throws EE_Error
+	 */
+	protected function _set_properties()
+	{
+		$return_url = $this->getReturnUrl();
+		$evt_id     = $this->_req_data['event_id'] ?? null;
+
+		$this->_wp_list_args = [
+			'singular' => esc_html__('registrant', 'event_espresso'),
+			'plural'   => esc_html__('registrants', 'event_espresso'),
+			'ajax'     => true,
+			'screen'   => $this->_admin_page->get_current_screen()->id,
+		];
+		$columns             = [];
+		$this->_columns      = [
+			'_REG_att_checked_in' => esc_html__('Check In', 'event_espresso'),
+			'ATT_name'            => esc_html__('Registrant', 'event_espresso'),
+			'ATT_email'           => esc_html__('Email Address', 'event_espresso'),
+			'Event'               => esc_html__('Event', 'event_espresso'),
+			'PRC_name'            => esc_html__('TKT Option', 'event_espresso'),
+			'_REG_final_price'    => esc_html__('Price', 'event_espresso'),
+			'TXN_paid'            => esc_html__('Paid', 'event_espresso'),
+			'TXN_total'           => esc_html__('Total', 'event_espresso'),
+		];
+		// Add/remove columns when an event has been selected
+		if (! empty($evt_id)) {
+			// Render a checkbox column
+			$columns['cb']              = '<input type="checkbox" />';
+			$this->_has_checkbox_column = true;
+			// Remove the 'Event' column
+			unset($this->_columns['Event']);
+		}
+		$this->_columns        = array_merge($columns, $this->_columns);
+		$this->_primary_column = '_REG_att_checked_in';
+		if (
+			! empty($evt_id)
+			&& EE_Registry::instance()->CAP->current_user_can(
+				'ee_read_registrations',
+				'espresso_registrations_registrations_reports',
+				$evt_id
+			)
+		) {
+			$this->_bottom_buttons = [
+				'report' => [
+					'route'         => 'registrations_report',
+					'extra_request' =>
+						[
+							'EVT_ID'     => $evt_id,
+							'return_url' => $return_url,
+						],
+				],
+			];
+		}
+		$this->_bottom_buttons['report_filtered'] = [
+			'route'         => 'registrations_checkin_report',
+			'extra_request' => [
+				'use_filters' => true,
+				'filters'     => array_merge(
+					[
+						'EVT_ID' => $evt_id,
+					],
+					array_diff_key(
+						$this->_req_data,
+						array_flip(
+							[
+								'page',
+								'action',
+								'default_nonce',
+							]
+						)
+					)
+				),
+				'return_url'  => $return_url,
+			],
+		];
+		$this->_sortable_columns                  = [
+			/**
+			 * Allows users to change the default sort if they wish.
+			 * Returning a falsey on this filter will result in the default sort to be by firstname rather than last name.
+			 *
+			 * Note: usual naming conventions for filters aren't followed here so that just one filter can be used to
+			 * change the sorts on any list table involving registration contacts.  If you want to only change the filter
+			 * for a specific list table you can use the provided reference to this object instance.
+			 */
+			'ATT_name' => [
+				'FHEE__EE_Registrations_List_Table___set_properties__default_sort_by_registration_last_name',
+				true,
+				$this,
+			]
+				? ['ATT_lname' => true]
+				: ['ATT_fname' => true],
+			'Event'    => ['Event.EVT_name' => false],
+		];
+		$this->_hidden_columns                    = [];
+		$this->_evt                               = EEM_Event::instance()->get_one_by_ID($evt_id);
+		$this->_dtts_for_event                    =
+			$this->_evt instanceof EE_Event ? $this->_evt->datetimes_ordered() : [];
+	}
+
+
+	/**
+	 * @param EE_Registration $item
+	 * @return string
+	 */
+	protected function _get_row_class($item): string
+	{
+		$class = parent::_get_row_class($item);
+		if ($this->_has_checkbox_column) {
+			$class .= ' has-checkbox-column';
+		}
+		return $class;
+	}
+
+
+	/**
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _get_table_filters(): array
+	{
+		$filters        = $where = [];
+		$current_EVT_ID = isset($this->_req_data['event_id']) ? (int) $this->_req_data['event_id'] : 0;
+		if (empty($this->_dtts_for_event) || count($this->_dtts_for_event) === 1) {
+			// this means we don't have an event so let's setup a filter dropdown for all the events to select
+			// note possible capability restrictions
+			if (! EE_Registry::instance()->CAP->current_user_can('ee_read_private_events', 'get_events')) {
+				$where['status**'] = ['!=', 'private'];
+			}
+			if (! EE_Registry::instance()->CAP->current_user_can('ee_read_others_events', 'get_events')) {
+				$where['EVT_wp_user'] = get_current_user_id();
+			}
+			$events   = EEM_Event::instance()->get_all(
+				[
+					$where,
+					'order_by' => ['Datetime.DTT_EVT_start' => 'DESC'],
+				]
+			);
+			$events[] = [
+				'id'   => 0,
+				'text' => esc_html__(' - select an event - ', 'event_espresso'),
+			];
+			$checked  = 'checked';
+			/** @var EE_Event $event */
+			foreach ($events as $event) {
+				// any registrations for this event?
+				if (! $event instanceof EE_Event || ! $event->get_count_of_all_registrations()) {
+					continue;
+				}
+				$events[] = [
+					'id'    => $event->ID(),
+					'text'  => apply_filters(
+						'FHEE__EE_Event_Registrations___get_table_filters__event_name',
+						$event->get('EVT_name'),
+						$event
+					),
+					'class' => $event->is_expired() ? 'ee-expired-event' : '',
+				];
+				if ($event->ID() === $current_EVT_ID && $event->is_expired()) {
+					$checked = '';
+				}
+			}
+			$event_filter = '<div class="ee-event-filter">';
+			$event_filter .= '<label for="event_id">';
+			$event_filter .= esc_html__('Check-in Status for', 'event_espresso');
+			$event_filter .= '</label>&nbsp;&nbsp;';
+			$event_filter .= EEH_Form_Fields::select_input('event_id', $events, $current_EVT_ID);
+			$event_filter .= '<span class="ee-event-filter-toggle">';
+			$event_filter .= '<label for="js-ee-hide-expired-events">';
+			$event_filter .= '<input type="checkbox" id="js-ee-hide-expired-events" ' . $checked . '>&nbsp;&nbsp;';
+			$event_filter .= esc_html__('Hide Expired Events', 'event_espresso');
+			$event_filter .= '</label>';
+			$event_filter .= '</span>';
+			$event_filter .= '</div>';
+			$filters[]    = $event_filter;
+		}
+		if (! empty($this->_dtts_for_event)) {
+			// DTT datetimes filter
+			$this->_cur_dtt_id = $this->_req_data['DTT_ID'] ?? 0;
+			if (count($this->_dtts_for_event) > 1) {
+				$datetimes[0] = esc_html__('To toggle check-in status, select a datetime.', 'event_espresso');
+				foreach ($this->_dtts_for_event as $datetime) {
+					$datetime_string              = $datetime->name();
+					$datetime_string              = ! empty($datetime_string) ? ' (' . $datetime_string . ')' : '';
+					$datetime_string              =
+						$datetime->start_date_and_time() . ' - ' . $datetime->end_date_and_time() . $datetime_string;
+					$datetimes[ $datetime->ID() ] = $datetime_string;
+				}
+				$input     = new EE_Select_Input(
+					$datetimes,
+					[
+						'html_name' => 'DTT_ID',
+						'html_id'   => 'DTT_ID',
+						'default'   => $this->_cur_dtt_id,
+					]
+				);
+				$filters[] = $input->get_html_for_input();
+				$filters[] = '<input type="hidden" name="event_id" value="' . $current_EVT_ID . '">';
+			}
+		}
+		return $filters;
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _add_view_counts()
+	{
+		$this->_views['all']['count'] = $this->_get_total_event_attendees();
+	}
+
+
+	/**
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _get_total_event_attendees(): int
+	{
+		$EVT_ID       = isset($this->_req_data['event_id']) ? absint($this->_req_data['event_id']) : false;
+		$DTT_ID       = $this->_cur_dtt_id;
+		$query_params = [];
+		if ($EVT_ID) {
+			$query_params[0]['EVT_ID'] = $EVT_ID;
+		}
+		// if DTT is included we only show for that datetime.  Otherwise we're showing for all datetimes (the event).
+		if ($DTT_ID) {
+			$query_params[0]['Ticket.Datetime.DTT_ID'] = $DTT_ID;
+		}
+		$status_ids_array          = apply_filters(
+			'FHEE__Extend_Registrations_Admin_Page__get_event_attendees__status_ids_array',
+			[EEM_Registration::status_id_pending_payment, EEM_Registration::status_id_approved]
+		);
+		$query_params[0]['STS_ID'] = ['IN', $status_ids_array];
+		return EEM_Registration::instance()->count($query_params);
+	}
+
+
+	/**
+	 * @param EE_Registration $item
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function column_cb($item): string
+	{
+		return sprintf('<input type="checkbox" name="checkbox[%1$s]" value="%1$s" />', $item->ID());
+	}
+
+
+	/**
+	 * column_REG_att_checked_in
+	 *
+	 * @param EE_Registration $registration
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function column__REG_att_checked_in(EE_Registration $registration): string
+	{
+		$attendee      = $registration->attendee();
+		$attendee_name = $attendee instanceof EE_Attendee ? $attendee->full_name() : '';
+
+		if ($this->_cur_dtt_id === 0 && count($this->_dtts_for_event) === 1) {
+			$latest_related_datetime = $registration->get_latest_related_datetime();
+			if ($latest_related_datetime instanceof EE_Datetime) {
+				$this->_cur_dtt_id = $latest_related_datetime->ID();
+			}
+		}
+		$checkin_status_dashicon = CheckinStatusDashicon::fromRegistrationAndDatetimeId(
+			$registration,
+			$this->_cur_dtt_id
+		);
+		$nonce                   = wp_create_nonce('checkin_nonce');
+		$toggle_active           = ! empty($this->_cur_dtt_id)
+								   && EE_Registry::instance()->CAP->current_user_can(
+									   'ee_edit_checkin',
+									   'espresso_registrations_toggle_checkin_status',
+									   $registration->ID()
+								   )
+			? ' clickable trigger-checkin'
+			: '';
+		$mobile_view_content     = ' <span class="show-on-mobile-view-only">' . $attendee_name . '</span>';
+		return '
         <button class="button button--secondary button--icon-only ' . $toggle_active . '"
                 data-_regid="' . $registration->ID() . '"
                 data-dttid="' . $this->_cur_dtt_id . '"
@@ -364,263 +364,263 @@ 
             <span class="' . $checkin_status_dashicon->cssClasses() . '"></span>
         </button>
             '
-               . $mobile_view_content;
-    }
-
-
-    /**
-     * @param EE_Registration $registration
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function column_ATT_name(EE_Registration $registration): string
-    {
-        $attendee = $registration->attendee();
-        if (! $attendee instanceof EE_Attendee) {
-            return esc_html__('No contact record for this registration.', 'event_espresso');
-        }
-        // edit attendee link
-        $edit_lnk_url = EE_Admin_Page::add_query_args_and_nonce(
-            ['action' => 'view_registration', '_REG_ID' => $registration->ID()],
-            REG_ADMIN_URL
-        );
-        $name_link    = '
+			   . $mobile_view_content;
+	}
+
+
+	/**
+	 * @param EE_Registration $registration
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function column_ATT_name(EE_Registration $registration): string
+	{
+		$attendee = $registration->attendee();
+		if (! $attendee instanceof EE_Attendee) {
+			return esc_html__('No contact record for this registration.', 'event_espresso');
+		}
+		// edit attendee link
+		$edit_lnk_url = EE_Admin_Page::add_query_args_and_nonce(
+			['action' => 'view_registration', '_REG_ID' => $registration->ID()],
+			REG_ADMIN_URL
+		);
+		$name_link    = '
             <span class="ee-status-dot ee-status-bg--' . esc_attr($registration->status_ID()) . ' ee-aria-tooltip"
             aria-label="' . EEH_Template::pretty_status($registration->status_ID(), false, 'sentence') . '">
             </span>';
-        $name_link    .= EE_Registry::instance()->CAP->current_user_can(
-            'ee_edit_contacts',
-            'espresso_registrations_edit_attendee'
-        )
-            ? '<a class="ee-aria-tooltip" href="' . $edit_lnk_url . '" aria-label="' . esc_attr__(
-                'View Registration Details',
-                'event_espresso'
-            ) . '">'
-              . $registration->attendee()->full_name()
-              . '</a>'
-            : $registration->attendee()->full_name();
-        $name_link    .= $registration->count() === 1
-            ? '&nbsp;<sup><div class="dashicons dashicons-star-filled gold-icon"></div></sup>	'
-            : '';
-        // add group details
-        $name_link .= '&nbsp;' . sprintf(
-            esc_html__('(%s of %s)', 'event_espresso'),
-            $registration->count(),
-            $registration->group_size()
-        );
-        // add regcode
-        $link      = EE_Admin_Page::add_query_args_and_nonce(
-            ['action' => 'view_registration', '_REG_ID' => $registration->ID()],
-            REG_ADMIN_URL
-        );
-        $name_link .= '<br>';
-        $name_link .= EE_Registry::instance()->instance()->CAP->current_user_can(
-            'ee_read_registration',
-            'view_registration',
-            $registration->ID()
-        )
-            ? '<a class="ee-aria-tooltip" href="' . $link . '" aria-label="' . esc_attr__(
-                'View Registration Details',
-                'event_espresso'
-            ) . '">'
-              . $registration->reg_code()
-              . '</a>'
-            : $registration->reg_code();
-        // status
-        // $name_link               .= '<br><span class="ee-status-text-small">';
-        // $name_link               .= EEH_Template::pretty_status($registration->status_ID(), false, 'sentence');
-        // $name_link               .= '</span>';
-        $actions                 = [];
-        $DTT_ID                  = $this->_cur_dtt_id;
-        $latest_related_datetime =
-            empty($DTT_ID) && ! empty($this->_req_data['event_id'])
-                ? $registration->get_latest_related_datetime()
-                : null;
-        $DTT_ID                  = $latest_related_datetime instanceof EE_Datetime
-            ? $latest_related_datetime->ID()
-            : $DTT_ID;
-        if (
-            ! empty($DTT_ID)
-            && EE_Registry::instance()->CAP->current_user_can(
-                'ee_read_checkins',
-                'espresso_registrations_registration_checkins'
-            )
-        ) {
-            $checkin_list_url = EE_Admin_Page::add_query_args_and_nonce(
-                ['action' => 'registration_checkins', '_REG_ID' => $registration->ID(), 'DTT_ID' => $DTT_ID],
-                REG_ADMIN_URL
-            );
-            // get the timestamps for this registration's checkins, related to the selected datetime
-            $timestamps = $registration->get_many_related('Checkin', [['DTT_ID' => $DTT_ID]]);
-            if (! empty($timestamps)) {
-                // get the last timestamp
-                $last_timestamp = end($timestamps);
-                // checked in or checked out?
-                $checkin_status = $last_timestamp->get('CHK_in')
-                    ? esc_html__('Checked In', 'event_espresso')
-                    : esc_html__('Checked Out', 'event_espresso');
-                // get timestamp string
-                $timestamp_string   = $last_timestamp->get_datetime('CHK_timestamp');
-                $actions['checkin'] = '<a class="ee-aria-tooltip" href="' . $checkin_list_url . '" aria-label="'
-                                      . esc_attr__(
-                                          'View this registrant\'s check-ins/checkouts for the datetime',
-                                          'event_espresso'
-                                      ) . '">' . $checkin_status . ': ' . $timestamp_string . '</a>';
-            }
-        }
-        return (! empty($DTT_ID) && ! empty($timestamps))
-            ? sprintf('%1$s %2$s', $name_link, $this->row_actions($actions, true))
-            : $name_link;
-    }
-
-
-    /**
-     * @param EE_Registration $registration
-     * @return string
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    public function column_ATT_email(EE_Registration $registration): string
-    {
-        $attendee = $registration->attendee();
-        return $attendee instanceof EE_Attendee ? $attendee->email() : '';
-    }
-
-
-    /**
-     * @param EE_Registration $registration
-     * @return bool|string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function column_Event(EE_Registration $registration)
-    {
-        try {
-            $event            = $this->_evt instanceof EE_Event ? $this->_evt : $registration->event();
-            $checkin_link_url = EE_Admin_Page::add_query_args_and_nonce(
-                ['action' => 'event_registrations', 'event_id' => $event->ID()],
-                REG_ADMIN_URL
-            );
-            $event_label      = EE_Registry::instance()->CAP->current_user_can(
-                'ee_read_checkins',
-                'espresso_registrations_registration_checkins'
-            ) ? '<a class="ee-aria-tooltip" href="' . $checkin_link_url . '" aria-label="'
-                . esc_attr__(
-                    'View Checkins for this Event',
-                    'event_espresso'
-                ) . '">' . $event->name() . '</a>' : $event->name();
-        } catch (EntityNotFoundException $e) {
-            $event_label = esc_html__('Unknown', 'event_espresso');
-        }
-        return $event_label;
-    }
-
-
-    /**
-     * @param EE_Registration $registration
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function column_PRC_name(EE_Registration $registration): string
-    {
-        return $registration->ticket() instanceof EE_Ticket
-            ? $registration->ticket()->name()
-            : esc_html__(
-                "Unknown",
-                "event_espresso"
-            );
-    }
-
-
-    /**
-     * column_REG_final_price
-     *
-     * @param EE_Registration $registration
-     * @return string
-     * @throws EE_Error
-     */
-    public function column__REG_final_price(EE_Registration $registration): string
-    {
-        return '<span class="reg-pad-rght">' . ' ' . $registration->pretty_final_price() . '</span>';
-    }
-
-
-    /**
-     * column_TXN_paid
-     *
-     * @param EE_Registration $registration
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function column_TXN_paid(EE_Registration $registration): string
-    {
-        if ($registration->count() === 1) {
-            if ($registration->transaction()->paid() >= $registration->transaction()->total()) {
-                return '<span class="reg-pad-rght"><div class="dashicons dashicons-yes green-icon"></div></span>';
-            } else {
-                $view_txn_lnk_url = EE_Admin_Page::add_query_args_and_nonce(
-                    ['action' => 'view_transaction', 'TXN_ID' => $registration->transaction_ID()],
-                    TXN_ADMIN_URL
-                );
-                return EE_Registry::instance()->CAP->current_user_can(
-                    'ee_read_transaction',
-                    'espresso_transactions_view_transaction'
-                ) ? '
+		$name_link    .= EE_Registry::instance()->CAP->current_user_can(
+			'ee_edit_contacts',
+			'espresso_registrations_edit_attendee'
+		)
+			? '<a class="ee-aria-tooltip" href="' . $edit_lnk_url . '" aria-label="' . esc_attr__(
+				'View Registration Details',
+				'event_espresso'
+			) . '">'
+			  . $registration->attendee()->full_name()
+			  . '</a>'
+			: $registration->attendee()->full_name();
+		$name_link    .= $registration->count() === 1
+			? '&nbsp;<sup><div class="dashicons dashicons-star-filled gold-icon"></div></sup>	'
+			: '';
+		// add group details
+		$name_link .= '&nbsp;' . sprintf(
+			esc_html__('(%s of %s)', 'event_espresso'),
+			$registration->count(),
+			$registration->group_size()
+		);
+		// add regcode
+		$link      = EE_Admin_Page::add_query_args_and_nonce(
+			['action' => 'view_registration', '_REG_ID' => $registration->ID()],
+			REG_ADMIN_URL
+		);
+		$name_link .= '<br>';
+		$name_link .= EE_Registry::instance()->instance()->CAP->current_user_can(
+			'ee_read_registration',
+			'view_registration',
+			$registration->ID()
+		)
+			? '<a class="ee-aria-tooltip" href="' . $link . '" aria-label="' . esc_attr__(
+				'View Registration Details',
+				'event_espresso'
+			) . '">'
+			  . $registration->reg_code()
+			  . '</a>'
+			: $registration->reg_code();
+		// status
+		// $name_link               .= '<br><span class="ee-status-text-small">';
+		// $name_link               .= EEH_Template::pretty_status($registration->status_ID(), false, 'sentence');
+		// $name_link               .= '</span>';
+		$actions                 = [];
+		$DTT_ID                  = $this->_cur_dtt_id;
+		$latest_related_datetime =
+			empty($DTT_ID) && ! empty($this->_req_data['event_id'])
+				? $registration->get_latest_related_datetime()
+				: null;
+		$DTT_ID                  = $latest_related_datetime instanceof EE_Datetime
+			? $latest_related_datetime->ID()
+			: $DTT_ID;
+		if (
+			! empty($DTT_ID)
+			&& EE_Registry::instance()->CAP->current_user_can(
+				'ee_read_checkins',
+				'espresso_registrations_registration_checkins'
+			)
+		) {
+			$checkin_list_url = EE_Admin_Page::add_query_args_and_nonce(
+				['action' => 'registration_checkins', '_REG_ID' => $registration->ID(), 'DTT_ID' => $DTT_ID],
+				REG_ADMIN_URL
+			);
+			// get the timestamps for this registration's checkins, related to the selected datetime
+			$timestamps = $registration->get_many_related('Checkin', [['DTT_ID' => $DTT_ID]]);
+			if (! empty($timestamps)) {
+				// get the last timestamp
+				$last_timestamp = end($timestamps);
+				// checked in or checked out?
+				$checkin_status = $last_timestamp->get('CHK_in')
+					? esc_html__('Checked In', 'event_espresso')
+					: esc_html__('Checked Out', 'event_espresso');
+				// get timestamp string
+				$timestamp_string   = $last_timestamp->get_datetime('CHK_timestamp');
+				$actions['checkin'] = '<a class="ee-aria-tooltip" href="' . $checkin_list_url . '" aria-label="'
+									  . esc_attr__(
+										  'View this registrant\'s check-ins/checkouts for the datetime',
+										  'event_espresso'
+									  ) . '">' . $checkin_status . ': ' . $timestamp_string . '</a>';
+			}
+		}
+		return (! empty($DTT_ID) && ! empty($timestamps))
+			? sprintf('%1$s %2$s', $name_link, $this->row_actions($actions, true))
+			: $name_link;
+	}
+
+
+	/**
+	 * @param EE_Registration $registration
+	 * @return string
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	public function column_ATT_email(EE_Registration $registration): string
+	{
+		$attendee = $registration->attendee();
+		return $attendee instanceof EE_Attendee ? $attendee->email() : '';
+	}
+
+
+	/**
+	 * @param EE_Registration $registration
+	 * @return bool|string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function column_Event(EE_Registration $registration)
+	{
+		try {
+			$event            = $this->_evt instanceof EE_Event ? $this->_evt : $registration->event();
+			$checkin_link_url = EE_Admin_Page::add_query_args_and_nonce(
+				['action' => 'event_registrations', 'event_id' => $event->ID()],
+				REG_ADMIN_URL
+			);
+			$event_label      = EE_Registry::instance()->CAP->current_user_can(
+				'ee_read_checkins',
+				'espresso_registrations_registration_checkins'
+			) ? '<a class="ee-aria-tooltip" href="' . $checkin_link_url . '" aria-label="'
+				. esc_attr__(
+					'View Checkins for this Event',
+					'event_espresso'
+				) . '">' . $event->name() . '</a>' : $event->name();
+		} catch (EntityNotFoundException $e) {
+			$event_label = esc_html__('Unknown', 'event_espresso');
+		}
+		return $event_label;
+	}
+
+
+	/**
+	 * @param EE_Registration $registration
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function column_PRC_name(EE_Registration $registration): string
+	{
+		return $registration->ticket() instanceof EE_Ticket
+			? $registration->ticket()->name()
+			: esc_html__(
+				"Unknown",
+				"event_espresso"
+			);
+	}
+
+
+	/**
+	 * column_REG_final_price
+	 *
+	 * @param EE_Registration $registration
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function column__REG_final_price(EE_Registration $registration): string
+	{
+		return '<span class="reg-pad-rght">' . ' ' . $registration->pretty_final_price() . '</span>';
+	}
+
+
+	/**
+	 * column_TXN_paid
+	 *
+	 * @param EE_Registration $registration
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function column_TXN_paid(EE_Registration $registration): string
+	{
+		if ($registration->count() === 1) {
+			if ($registration->transaction()->paid() >= $registration->transaction()->total()) {
+				return '<span class="reg-pad-rght"><div class="dashicons dashicons-yes green-icon"></div></span>';
+			} else {
+				$view_txn_lnk_url = EE_Admin_Page::add_query_args_and_nonce(
+					['action' => 'view_transaction', 'TXN_ID' => $registration->transaction_ID()],
+					TXN_ADMIN_URL
+				);
+				return EE_Registry::instance()->CAP->current_user_can(
+					'ee_read_transaction',
+					'espresso_transactions_view_transaction'
+				) ? '
 				<span class="reg-pad-rght">
 					<a class="ee-aria-tooltip ee-status-color--'
-                    . $registration->transaction()->status_ID()
-                    . '" href="'
-                    . $view_txn_lnk_url
-                    . '"  aria-label="'
-                    . esc_attr__('View Transaction', 'event_espresso')
-                    . '">
+					. $registration->transaction()->status_ID()
+					. '" href="'
+					. $view_txn_lnk_url
+					. '"  aria-label="'
+					. esc_attr__('View Transaction', 'event_espresso')
+					. '">
 						'
-                    . $registration->transaction()->pretty_paid()
-                    . '
+					. $registration->transaction()->pretty_paid()
+					. '
 					</a>
 				<span>' : '<span class="reg-pad-rght">' . $registration->transaction()->pretty_paid() . '</span>';
-            }
-        } else {
-            return '<span class="reg-pad-rght"></span>';
-        }
-    }
-
-
-    /**
-     *        column_TXN_total
-     *
-     * @param EE_Registration $registration
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function column_TXN_total(EE_Registration $registration): string
-    {
-        $txn          = $registration->transaction();
-        $view_txn_url = add_query_arg(['action' => 'view_transaction', 'TXN_ID' => $txn->ID()], TXN_ADMIN_URL);
-        if ($registration->get('REG_count') === 1) {
-            $line_total_obj = $txn->total_line_item();
-            $txn_total      = $line_total_obj instanceof EE_Line_Item
-                ? $line_total_obj->get_pretty('LIN_total')
-                : esc_html__(
-                    'View Transaction',
-                    'event_espresso'
-                );
-            return EE_Registry::instance()->CAP->current_user_can(
-                'ee_read_transaction',
-                'espresso_transactions_view_transaction'
-            ) ? '<a class="ee-aria-tooltip" href="'
-                . $view_txn_url
-                . '" aria-label="'
-                . esc_attr__('View Transaction', 'event_espresso')
-                . '"><span class="reg-pad-rght">'
-                . $txn_total
-                . '</span></a>' : '<span class="reg-pad-rght">' . $txn_total . '</span>';
-        } else {
-            return '<span class="reg-pad-rght"></span>';
-        }
-    }
+			}
+		} else {
+			return '<span class="reg-pad-rght"></span>';
+		}
+	}
+
+
+	/**
+	 *        column_TXN_total
+	 *
+	 * @param EE_Registration $registration
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function column_TXN_total(EE_Registration $registration): string
+	{
+		$txn          = $registration->transaction();
+		$view_txn_url = add_query_arg(['action' => 'view_transaction', 'TXN_ID' => $txn->ID()], TXN_ADMIN_URL);
+		if ($registration->get('REG_count') === 1) {
+			$line_total_obj = $txn->total_line_item();
+			$txn_total      = $line_total_obj instanceof EE_Line_Item
+				? $line_total_obj->get_pretty('LIN_total')
+				: esc_html__(
+					'View Transaction',
+					'event_espresso'
+				);
+			return EE_Registry::instance()->CAP->current_user_can(
+				'ee_read_transaction',
+				'espresso_transactions_view_transaction'
+			) ? '<a class="ee-aria-tooltip" href="'
+				. $view_txn_url
+				. '" aria-label="'
+				. esc_attr__('View Transaction', 'event_espresso')
+				. '"><span class="reg-pad-rght">'
+				. $txn_total
+				. '</span></a>' : '<span class="reg-pad-rght">' . $txn_total . '</span>';
+		} else {
+			return '<span class="reg-pad-rght"></span>';
+		}
+	}
 }

Spacing +45 added lines, -45 removed lines

@@ -92,7 +92,7 @@ 
             'TXN_total'           => esc_html__('Total', 'event_espresso'),
         ];
         // Add/remove columns when an event has been selected
-        if (! empty($evt_id)) {
+        if ( ! empty($evt_id)) {
             // Render a checkbox column
             $columns['cb']              = '<input type="checkbox" />';
             $this->_has_checkbox_column = true;
@@ -142,7 +142,7 @@ 
                 'return_url'  => $return_url,
             ],
         ];
-        $this->_sortable_columns                  = [
+        $this->_sortable_columns = [
             /**
              * Allows users to change the default sort if they wish.
              * Returning a falsey on this filter will result in the default sort to be by firstname rather than last name.
@@ -193,13 +193,13 @@ 
         if (empty($this->_dtts_for_event) || count($this->_dtts_for_event) === 1) {
             // this means we don't have an event so let's setup a filter dropdown for all the events to select
             // note possible capability restrictions
-            if (! EE_Registry::instance()->CAP->current_user_can('ee_read_private_events', 'get_events')) {
+            if ( ! EE_Registry::instance()->CAP->current_user_can('ee_read_private_events', 'get_events')) {
                 $where['status**'] = ['!=', 'private'];
             }
-            if (! EE_Registry::instance()->CAP->current_user_can('ee_read_others_events', 'get_events')) {
+            if ( ! EE_Registry::instance()->CAP->current_user_can('ee_read_others_events', 'get_events')) {
                 $where['EVT_wp_user'] = get_current_user_id();
             }
-            $events   = EEM_Event::instance()->get_all(
+            $events = EEM_Event::instance()->get_all(
                 [
                     $where,
                     'order_by' => ['Datetime.DTT_EVT_start' => 'DESC'],
@@ -209,11 +209,11 @@ 
                 'id'   => 0,
                 'text' => esc_html__(' - select an event - ', 'event_espresso'),
             ];
-            $checked  = 'checked';
+            $checked = 'checked';
             /** @var EE_Event $event */
             foreach ($events as $event) {
                 // any registrations for this event?
-                if (! $event instanceof EE_Event || ! $event->get_count_of_all_registrations()) {
+                if ( ! $event instanceof EE_Event || ! $event->get_count_of_all_registrations()) {
                     continue;
                 }
                 $events[] = [
@@ -236,26 +236,26 @@ 
             $event_filter .= EEH_Form_Fields::select_input('event_id', $events, $current_EVT_ID);
             $event_filter .= '<span class="ee-event-filter-toggle">';
             $event_filter .= '<label for="js-ee-hide-expired-events">';
-            $event_filter .= '<input type="checkbox" id="js-ee-hide-expired-events" ' . $checked . '>&nbsp;&nbsp;';
+            $event_filter .= '<input type="checkbox" id="js-ee-hide-expired-events" '.$checked.'>&nbsp;&nbsp;';
             $event_filter .= esc_html__('Hide Expired Events', 'event_espresso');
             $event_filter .= '</label>';
             $event_filter .= '</span>';
             $event_filter .= '</div>';
-            $filters[]    = $event_filter;
+            $filters[] = $event_filter;
         }
-        if (! empty($this->_dtts_for_event)) {
+        if ( ! empty($this->_dtts_for_event)) {
             // DTT datetimes filter
             $this->_cur_dtt_id = $this->_req_data['DTT_ID'] ?? 0;
             if (count($this->_dtts_for_event) > 1) {
                 $datetimes[0] = esc_html__('To toggle check-in status, select a datetime.', 'event_espresso');
                 foreach ($this->_dtts_for_event as $datetime) {
                     $datetime_string              = $datetime->name();
-                    $datetime_string              = ! empty($datetime_string) ? ' (' . $datetime_string . ')' : '';
+                    $datetime_string              = ! empty($datetime_string) ? ' ('.$datetime_string.')' : '';
                     $datetime_string              =
-                        $datetime->start_date_and_time() . ' - ' . $datetime->end_date_and_time() . $datetime_string;
-                    $datetimes[ $datetime->ID() ] = $datetime_string;
+                        $datetime->start_date_and_time().' - '.$datetime->end_date_and_time().$datetime_string;
+                    $datetimes[$datetime->ID()] = $datetime_string;
                 }
-                $input     = new EE_Select_Input(
+                $input = new EE_Select_Input(
                     $datetimes,
                     [
                         'html_name' => 'DTT_ID',
@@ -264,7 +264,7 @@ 
                     ]
                 );
                 $filters[] = $input->get_html_for_input();
-                $filters[] = '<input type="hidden" name="event_id" value="' . $current_EVT_ID . '">';
+                $filters[] = '<input type="hidden" name="event_id" value="'.$current_EVT_ID.'">';
             }
         }
         return $filters;
@@ -298,7 +298,7 @@ 
         if ($DTT_ID) {
             $query_params[0]['Ticket.Datetime.DTT_ID'] = $DTT_ID;
         }
-        $status_ids_array          = apply_filters(
+        $status_ids_array = apply_filters(
             'FHEE__Extend_Registrations_Admin_Page__get_event_attendees__status_ids_array',
             [EEM_Registration::status_id_pending_payment, EEM_Registration::status_id_approved]
         );
@@ -354,14 +354,14 @@ 
                                    )
             ? ' clickable trigger-checkin'
             : '';
-        $mobile_view_content     = ' <span class="show-on-mobile-view-only">' . $attendee_name . '</span>';
+        $mobile_view_content = ' <span class="show-on-mobile-view-only">'.$attendee_name.'</span>';
         return '
-        <button class="button button--secondary button--icon-only ' . $toggle_active . '"
-                data-_regid="' . $registration->ID() . '"
-                data-dttid="' . $this->_cur_dtt_id . '"
-                data-nonce="' . $nonce . '"
+        <button class="button button--secondary button--icon-only ' . $toggle_active.'"
+                data-_regid="' . $registration->ID().'"
+                data-dttid="' . $this->_cur_dtt_id.'"
+                data-nonce="' . $nonce.'"
         >   
-            <span class="' . $checkin_status_dashicon->cssClasses() . '"></span>
+            <span class="' . $checkin_status_dashicon->cssClasses().'"></span>
         </button>
             '
                . $mobile_view_content;
@@ -377,7 +377,7 @@ 
     public function column_ATT_name(EE_Registration $registration): string
     {
         $attendee = $registration->attendee();
-        if (! $attendee instanceof EE_Attendee) {
+        if ( ! $attendee instanceof EE_Attendee) {
             return esc_html__('No contact record for this registration.', 'event_espresso');
         }
         // edit attendee link
@@ -385,32 +385,32 @@ 
             ['action' => 'view_registration', '_REG_ID' => $registration->ID()],
             REG_ADMIN_URL
         );
-        $name_link    = '
-            <span class="ee-status-dot ee-status-bg--' . esc_attr($registration->status_ID()) . ' ee-aria-tooltip"
-            aria-label="' . EEH_Template::pretty_status($registration->status_ID(), false, 'sentence') . '">
+        $name_link = '
+            <span class="ee-status-dot ee-status-bg--' . esc_attr($registration->status_ID()).' ee-aria-tooltip"
+            aria-label="' . EEH_Template::pretty_status($registration->status_ID(), false, 'sentence').'">
             </span>';
-        $name_link    .= EE_Registry::instance()->CAP->current_user_can(
+        $name_link .= EE_Registry::instance()->CAP->current_user_can(
             'ee_edit_contacts',
             'espresso_registrations_edit_attendee'
         )
-            ? '<a class="ee-aria-tooltip" href="' . $edit_lnk_url . '" aria-label="' . esc_attr__(
+            ? '<a class="ee-aria-tooltip" href="'.$edit_lnk_url.'" aria-label="'.esc_attr__(
                 'View Registration Details',
                 'event_espresso'
-            ) . '">'
+            ).'">'
               . $registration->attendee()->full_name()
               . '</a>'
             : $registration->attendee()->full_name();
-        $name_link    .= $registration->count() === 1
+        $name_link .= $registration->count() === 1
             ? '&nbsp;<sup><div class="dashicons dashicons-star-filled gold-icon"></div></sup>	'
             : '';
         // add group details
-        $name_link .= '&nbsp;' . sprintf(
+        $name_link .= '&nbsp;'.sprintf(
             esc_html__('(%s of %s)', 'event_espresso'),
             $registration->count(),
             $registration->group_size()
         );
         // add regcode
-        $link      = EE_Admin_Page::add_query_args_and_nonce(
+        $link = EE_Admin_Page::add_query_args_and_nonce(
             ['action' => 'view_registration', '_REG_ID' => $registration->ID()],
             REG_ADMIN_URL
         );
@@ -420,10 +420,10 @@ 
             'view_registration',
             $registration->ID()
         )
-            ? '<a class="ee-aria-tooltip" href="' . $link . '" aria-label="' . esc_attr__(
+            ? '<a class="ee-aria-tooltip" href="'.$link.'" aria-label="'.esc_attr__(
                 'View Registration Details',
                 'event_espresso'
-            ) . '">'
+            ).'">'
               . $registration->reg_code()
               . '</a>'
             : $registration->reg_code();
@@ -437,7 +437,7 @@ 
             empty($DTT_ID) && ! empty($this->_req_data['event_id'])
                 ? $registration->get_latest_related_datetime()
                 : null;
-        $DTT_ID                  = $latest_related_datetime instanceof EE_Datetime
+        $DTT_ID = $latest_related_datetime instanceof EE_Datetime
             ? $latest_related_datetime->ID()
             : $DTT_ID;
         if (
@@ -453,7 +453,7 @@ 
             );
             // get the timestamps for this registration's checkins, related to the selected datetime
             $timestamps = $registration->get_many_related('Checkin', [['DTT_ID' => $DTT_ID]]);
-            if (! empty($timestamps)) {
+            if ( ! empty($timestamps)) {
                 // get the last timestamp
                 $last_timestamp = end($timestamps);
                 // checked in or checked out?
@@ -462,14 +462,14 @@ 
                     : esc_html__('Checked Out', 'event_espresso');
                 // get timestamp string
                 $timestamp_string   = $last_timestamp->get_datetime('CHK_timestamp');
-                $actions['checkin'] = '<a class="ee-aria-tooltip" href="' . $checkin_list_url . '" aria-label="'
+                $actions['checkin'] = '<a class="ee-aria-tooltip" href="'.$checkin_list_url.'" aria-label="'
                                       . esc_attr__(
                                           'View this registrant\'s check-ins/checkouts for the datetime',
                                           'event_espresso'
-                                      ) . '">' . $checkin_status . ': ' . $timestamp_string . '</a>';
+                                      ).'">'.$checkin_status.': '.$timestamp_string.'</a>';
             }
         }
-        return (! empty($DTT_ID) && ! empty($timestamps))
+        return ( ! empty($DTT_ID) && ! empty($timestamps))
             ? sprintf('%1$s %2$s', $name_link, $this->row_actions($actions, true))
             : $name_link;
     }
@@ -502,14 +502,14 @@ 
                 ['action' => 'event_registrations', 'event_id' => $event->ID()],
                 REG_ADMIN_URL
             );
-            $event_label      = EE_Registry::instance()->CAP->current_user_can(
+            $event_label = EE_Registry::instance()->CAP->current_user_can(
                 'ee_read_checkins',
                 'espresso_registrations_registration_checkins'
-            ) ? '<a class="ee-aria-tooltip" href="' . $checkin_link_url . '" aria-label="'
+            ) ? '<a class="ee-aria-tooltip" href="'.$checkin_link_url.'" aria-label="'
                 . esc_attr__(
                     'View Checkins for this Event',
                     'event_espresso'
-                ) . '">' . $event->name() . '</a>' : $event->name();
+                ).'">'.$event->name().'</a>' : $event->name();
         } catch (EntityNotFoundException $e) {
             $event_label = esc_html__('Unknown', 'event_espresso');
         }
@@ -543,7 +543,7 @@ 
      */
     public function column__REG_final_price(EE_Registration $registration): string
     {
-        return '<span class="reg-pad-rght">' . ' ' . $registration->pretty_final_price() . '</span>';
+        return '<span class="reg-pad-rght">'.' '.$registration->pretty_final_price().'</span>';
     }
 
 
@@ -581,7 +581,7 @@ 
                     . $registration->transaction()->pretty_paid()
                     . '
 					</a>
-				<span>' : '<span class="reg-pad-rght">' . $registration->transaction()->pretty_paid() . '</span>';
+				<span>' : '<span class="reg-pad-rght">'.$registration->transaction()->pretty_paid().'</span>';
             }
         } else {
             return '<span class="reg-pad-rght"></span>';
@@ -618,7 +618,7 @@ 
                 . esc_attr__('View Transaction', 'event_espresso')
                 . '"><span class="reg-pad-rght">'
                 . $txn_total
-                . '</span></a>' : '<span class="reg-pad-rght">' . $txn_total . '</span>';
+                . '</span></a>' : '<span class="reg-pad-rght">'.$txn_total.'</span>';
         } else {
             return '<span class="reg-pad-rght"></span>';
         }

admin_pages/events/Events_Admin_List_Table.class.php

Indentation +571 added lines, -571 removed lines

@@ -14,177 +14,177 @@ 
  */
 class Events_Admin_List_Table extends EE_Admin_List_Table
 {
-    /**
-     * @var Events_Admin_Page
-     */
-    protected $_admin_page;
-
-    /**
-     * @var EE_Datetime
-     */
-    private $_dtt;
-
-
-    /**
-     * Initial setup of data properties for the list table.
-     *
-     * @throws Exception
-     */
-    protected function _setup_data()
-    {
-        $this->_data           = $this->_admin_page->get_events($this->_per_page, $this->_current_page);
-        $this->_all_data_count = $this->_admin_page->get_events(0, 0, true);
-    }
-
-
-    /**
-     * Set up of additional properties for the list table.
-     *
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _set_properties()
-    {
-        $this->_wp_list_args    = [
-            'singular' => esc_html__('event', 'event_espresso'),
-            'plural'   => esc_html__('events', 'event_espresso'),
-            'ajax'     => true, // for now
-            'screen'   => $this->_admin_page->get_current_screen()->id,
-        ];
-        $approved_registrations = esc_html__('Approved Registrations', 'event_espresso');
-        $this->_columns         = [
-            'cb'              => '<input type="checkbox" />',
-            'id'              => esc_html__('ID', 'event_espresso'),
-            'name'            => esc_html__('Name', 'event_espresso'),
-            'author'          => esc_html__('Author', 'event_espresso'),
-            'venue'           => esc_html__('Venue', 'event_espresso'),
-            'start_date_time' => esc_html__('Event Start', 'event_espresso'),
-            'reg_begins'      => esc_html__('On Sale', 'event_espresso'),
-            'attendees'       => '
+	/**
+	 * @var Events_Admin_Page
+	 */
+	protected $_admin_page;
+
+	/**
+	 * @var EE_Datetime
+	 */
+	private $_dtt;
+
+
+	/**
+	 * Initial setup of data properties for the list table.
+	 *
+	 * @throws Exception
+	 */
+	protected function _setup_data()
+	{
+		$this->_data           = $this->_admin_page->get_events($this->_per_page, $this->_current_page);
+		$this->_all_data_count = $this->_admin_page->get_events(0, 0, true);
+	}
+
+
+	/**
+	 * Set up of additional properties for the list table.
+	 *
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _set_properties()
+	{
+		$this->_wp_list_args    = [
+			'singular' => esc_html__('event', 'event_espresso'),
+			'plural'   => esc_html__('events', 'event_espresso'),
+			'ajax'     => true, // for now
+			'screen'   => $this->_admin_page->get_current_screen()->id,
+		];
+		$approved_registrations = esc_html__('Approved Registrations', 'event_espresso');
+		$this->_columns         = [
+			'cb'              => '<input type="checkbox" />',
+			'id'              => esc_html__('ID', 'event_espresso'),
+			'name'            => esc_html__('Name', 'event_espresso'),
+			'author'          => esc_html__('Author', 'event_espresso'),
+			'venue'           => esc_html__('Venue', 'event_espresso'),
+			'start_date_time' => esc_html__('Event Start', 'event_espresso'),
+			'reg_begins'      => esc_html__('On Sale', 'event_espresso'),
+			'attendees'       => '
                 <span class="show-on-mobile-view-only" aria-label="' . $approved_registrations . '">
                     ' . $approved_registrations . '
                 </span>
                 <span class="dashicons dashicons-groups ee-icon-color-ee-green"></span>',
-            'actions'         => $this->actionsColumnHeader(),
-        ];
-        $this->addConditionalColumns();
-        $this->_sortable_columns = [
-            'id'              => ['EVT_ID' => true],
-            'name'            => ['EVT_name' => false],
-            'author'          => ['EVT_wp_user' => false],
-            'venue'           => ['Venue.VNU_name' => false],
-            'start_date_time' => ['Datetime.DTT_EVT_start' => false],
-            'reg_begins'      => ['Datetime.Ticket.TKT_start_date' => false],
-        ];
-
-        $this->_primary_column = 'id';
-        $this->_hidden_columns = ['author', 'event_category'];
-    }
-
-
-    /**
-     * @return array
-     */
-    protected function _get_table_filters(): array
-    {
-        return []; // no filters with decaf
-    }
-
-
-    /**
-     * Setup of views properties.
-     *
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws EE_Error
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    protected function _add_view_counts()
-    {
-        $this->_views['all']['count']   = $this->_admin_page->total_events();
-        $this->_views['draft']['count'] = $this->_admin_page->total_events_draft();
-        if (
-            EE_Registry::instance()->CAP->current_user_can(
-                'ee_delete_events',
-                'espresso_events_trash_events'
-            )
-        ) {
-            $this->_views['trash']['count'] = $this->_admin_page->total_trashed_events();
-        }
-    }
-
-
-    /**
-     * @param EE_Event $item
-     * @return string
-     */
-    protected function _get_row_class($item): string
-    {
-        $class = parent::_get_row_class($item);
-        if ($this->_has_checkbox_column) {
-            $class .= ' has-checkbox-column';
-        }
-        return $class;
-    }
-
-
-    /**
-     * @param EE_Event $item
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function column_cb($item): string
-    {
-        if (! $item instanceof EE_Event) {
-            return '';
-        }
-        $this->_dtt = $item->primary_datetime(); // set this for use in other columns
-        $content    = sprintf(
-            '<input type="checkbox" name="EVT_IDs[]" value="%s" />',
-            $item->ID()
-        );
-        return $this->columnContent('cb', $content, 'center');
-    }
-
-
-    /**
-     * @param EE_Event $event
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function column_id(EE_Event $event): string
-    {
-        $content = $event->ID();
-        $content .= '<span class="show-on-mobile-view-only">';
-        $content .= $this->column_name($event, false);
-        $content .= '</span>';
-        return $this->columnContent('id', $content, 'end');
-    }
-
-
-    /**
-     * @param EE_Event $event
-     * @param bool     $prep_content
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function column_name(EE_Event $event, bool $prep_content = true): string
-    {
-        $edit_query_args = [
-            'action' => 'edit',
-            'post'   => $event->ID(),
-        ];
-        $edit_link       = EE_Admin_Page::add_query_args_and_nonce($edit_query_args, EVENTS_ADMIN_URL);
-        $actions         = $this->_column_name_action_setup($event);
-        $status          = esc_attr($event->get_active_status());
-        $pretty_status   = EEH_Template::pretty_status($status, false, 'sentence');
-        $status_dot      = '<span class="ee-status-dot ee-status-bg--' . $status . '"></span>';
-        $content         = '
+			'actions'         => $this->actionsColumnHeader(),
+		];
+		$this->addConditionalColumns();
+		$this->_sortable_columns = [
+			'id'              => ['EVT_ID' => true],
+			'name'            => ['EVT_name' => false],
+			'author'          => ['EVT_wp_user' => false],
+			'venue'           => ['Venue.VNU_name' => false],
+			'start_date_time' => ['Datetime.DTT_EVT_start' => false],
+			'reg_begins'      => ['Datetime.Ticket.TKT_start_date' => false],
+		];
+
+		$this->_primary_column = 'id';
+		$this->_hidden_columns = ['author', 'event_category'];
+	}
+
+
+	/**
+	 * @return array
+	 */
+	protected function _get_table_filters(): array
+	{
+		return []; // no filters with decaf
+	}
+
+
+	/**
+	 * Setup of views properties.
+	 *
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	protected function _add_view_counts()
+	{
+		$this->_views['all']['count']   = $this->_admin_page->total_events();
+		$this->_views['draft']['count'] = $this->_admin_page->total_events_draft();
+		if (
+			EE_Registry::instance()->CAP->current_user_can(
+				'ee_delete_events',
+				'espresso_events_trash_events'
+			)
+		) {
+			$this->_views['trash']['count'] = $this->_admin_page->total_trashed_events();
+		}
+	}
+
+
+	/**
+	 * @param EE_Event $item
+	 * @return string
+	 */
+	protected function _get_row_class($item): string
+	{
+		$class = parent::_get_row_class($item);
+		if ($this->_has_checkbox_column) {
+			$class .= ' has-checkbox-column';
+		}
+		return $class;
+	}
+
+
+	/**
+	 * @param EE_Event $item
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function column_cb($item): string
+	{
+		if (! $item instanceof EE_Event) {
+			return '';
+		}
+		$this->_dtt = $item->primary_datetime(); // set this for use in other columns
+		$content    = sprintf(
+			'<input type="checkbox" name="EVT_IDs[]" value="%s" />',
+			$item->ID()
+		);
+		return $this->columnContent('cb', $content, 'center');
+	}
+
+
+	/**
+	 * @param EE_Event $event
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function column_id(EE_Event $event): string
+	{
+		$content = $event->ID();
+		$content .= '<span class="show-on-mobile-view-only">';
+		$content .= $this->column_name($event, false);
+		$content .= '</span>';
+		return $this->columnContent('id', $content, 'end');
+	}
+
+
+	/**
+	 * @param EE_Event $event
+	 * @param bool     $prep_content
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function column_name(EE_Event $event, bool $prep_content = true): string
+	{
+		$edit_query_args = [
+			'action' => 'edit',
+			'post'   => $event->ID(),
+		];
+		$edit_link       = EE_Admin_Page::add_query_args_and_nonce($edit_query_args, EVENTS_ADMIN_URL);
+		$actions         = $this->_column_name_action_setup($event);
+		$status          = esc_attr($event->get_active_status());
+		$pretty_status   = EEH_Template::pretty_status($status, false, 'sentence');
+		$status_dot      = '<span class="ee-status-dot ee-status-bg--' . $status . '"></span>';
+		$content         = '
             <div class="ee-layout-row ee-layout-row--fixed">
                 <a  class="row-title ee-status-color--' . $status . ' ee-aria-tooltip" 
                     aria-label="' . $pretty_status . '" 
@@ -194,409 +194,409 @@ 
                 </a>
             </div>';
 
-        $content .= $this->row_actions($actions);
-
-        return $prep_content ? $this->columnContent('name', $content) : $content;
-    }
-
-
-    /**
-     * Just a method for setting up the actions for the name column
-     *
-     * @param EE_Event $event
-     * @return array array of actions
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _column_name_action_setup(EE_Event $event): array
-    {
-        // todo: remove when attendees is active
-        if (! defined('REG_ADMIN_URL')) {
-            define('REG_ADMIN_URL', EVENTS_ADMIN_URL);
-        }
-        $actions            = [];
-        $restore_event_link = '';
-        $delete_event_link  = '';
-        $trash_event_link   = '';
-        if (
-            EE_Registry::instance()->CAP->current_user_can(
-                'ee_edit_event',
-                'espresso_events_edit',
-                $event->ID()
-            )
-        ) {
-            $edit_query_args = [
-                'action' => 'edit',
-                'post'   => $event->ID(),
-            ];
-            $edit_link       = EE_Admin_Page::add_query_args_and_nonce($edit_query_args, EVENTS_ADMIN_URL);
-            $actions['edit'] = '<a href="' . $edit_link . '" class="ee-aria-tooltip" '
-                               . ' aria-label="' . esc_attr__('Edit Event', 'event_espresso') . '">'
-                               . esc_html__('Edit', 'event_espresso')
-                               . '</a>';
-        }
-        if (
-            EE_Registry::instance()->CAP->current_user_can(
-                'ee_read_registrations',
-                'espresso_registrations_view_registration'
-            )
-            && EE_Registry::instance()->CAP->current_user_can(
-                'ee_read_event',
-                'espresso_registrations_view_registration',
-                $event->ID()
-            )
-        ) {
-            $attendees_query_args = [
-                'action'   => 'default',
-                'event_id' => $event->ID(),
-            ];
-            $attendees_link       = EE_Admin_Page::add_query_args_and_nonce($attendees_query_args, REG_ADMIN_URL);
-            $actions['attendees'] = '<a href="' . $attendees_link . '" class="ee-aria-tooltip"'
-                                    . ' aria-label="' . esc_attr__('View Registrations', 'event_espresso') . '">'
-                                    . esc_html__('Registrations', 'event_espresso')
-                                    . '</a>';
-        }
-        if (
-            EE_Registry::instance()->CAP->current_user_can(
-                'ee_delete_event',
-                'espresso_events_trash_event',
-                $event->ID()
-            )
-        ) {
-            $trash_event_query_args = [
-                'action' => 'trash_event',
-                'EVT_ID' => $event->ID(),
-            ];
-            $trash_event_link       = EE_Admin_Page::add_query_args_and_nonce(
-                $trash_event_query_args,
-                EVENTS_ADMIN_URL
-            );
-        }
-        if (
-            EE_Registry::instance()->CAP->current_user_can(
-                'ee_delete_event',
-                'espresso_events_restore_event',
-                $event->ID()
-            )
-        ) {
-            $restore_event_query_args = [
-                'action' => 'restore_event',
-                'EVT_ID' => $event->ID(),
-            ];
-            $restore_event_link       = EE_Admin_Page::add_query_args_and_nonce(
-                $restore_event_query_args,
-                EVENTS_ADMIN_URL
-            );
-        }
-        if (
-            EE_Registry::instance()->CAP->current_user_can(
-                'ee_delete_event',
-                'espresso_events_delete_event',
-                $event->ID()
-            )
-        ) {
-            $delete_event_query_args = [
-                'action' => 'delete_event',
-                'EVT_ID' => $event->ID(),
-            ];
-            $delete_event_link       = EE_Admin_Page::add_query_args_and_nonce(
-                $delete_event_query_args,
-                EVENTS_ADMIN_URL
-            );
-        }
-        $view_link       = get_permalink($event->ID());
-        $actions['view'] = '<a href="' . $view_link . '" class="ee-aria-tooltip"'
-                           . ' aria-label="' . esc_attr__('View Event', 'event_espresso') . '">'
-                           . esc_html__('View', 'event_espresso')
-                           . '</a>';
-        if ($event->get('status') === 'trash') {
-            if (
-                EE_Registry::instance()->CAP->current_user_can(
-                    'ee_delete_event',
-                    'espresso_events_restore_event',
-                    $event->ID()
-                )
-            ) {
-                $actions['restore_from_trash'] = '<a href="' . $restore_event_link . '" class="ee-aria-tooltip"'
-                                                 . ' aria-label="' . esc_attr__('Restore from Trash', 'event_espresso')
-                                                 . '">'
-                                                 . esc_html__('Restore from Trash', 'event_espresso')
-                                                 . '</a>';
-            }
-            if (
-                EE_Registry::instance()->CAP->current_user_can(
-                    'ee_delete_event',
-                    'espresso_events_delete_event',
-                    $event->ID()
-                )
-            ) {
-                $actions['delete'] = '<a href="' . $delete_event_link . '" class="ee-aria-tooltip"'
-                                     . ' aria-label="' . esc_attr__('Delete Permanently', 'event_espresso') . '">'
-                                     . esc_html__('Delete Permanently', 'event_espresso')
-                                     . '</a>';
-            }
-        } else {
-            if (
-                EE_Registry::instance()->CAP->current_user_can(
-                    'ee_delete_event',
-                    'espresso_events_trash_event',
-                    $event->ID()
-                )
-            ) {
-                $actions['move to trash'] = '<a href="' . $trash_event_link . '" class="ee-aria-tooltip"'
-                                            . ' aria-label="' . esc_attr__('Trash Event', 'event_espresso') . '">'
-                                            . esc_html__('Trash', 'event_espresso')
-                                            . '</a>';
-            }
-        }
-        return $actions;
-    }
-
-
-    /**
-     * @param EE_Event $event
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function column_author(EE_Event $event): string
-    {
-        // user author info
-        $event_author = get_userdata($event->wp_user());
-        $gravatar     = get_avatar($event->wp_user(), '24');
-        // filter link
-        $query_args = [
-            'action'      => 'default',
-            'EVT_wp_user' => $event->wp_user(),
-        ];
-        $filter_url = EE_Admin_Page::add_query_args_and_nonce($query_args, EVENTS_ADMIN_URL);
-        $content    = '<div class="ee-layout-row ee-layout-row--fixed">';
-        $content    .= $gravatar . '  <a href="' . $filter_url . '" class="ee-aria-tooltip"'
-                       . ' aria-label="' . esc_attr__('Click to filter events by this author.', 'event_espresso') . '">'
-                       . $event_author->display_name
-                       . '</a>';
-        $content    .= '</div>';
-        return $this->columnContent('author', $content);
-    }
-
-
-    /**
-     * @param EE_Event $event
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function column_event_category(EE_Event $event): string
-    {
-        $event_categories = $event->get_all_event_categories();
-        $content          = implode(
-            ', ',
-            array_map(
-                function (EE_Term $category) {
-                    return $category->name();
-                },
-                $event_categories
-            )
-        );
-        return $this->columnContent('event_category', $content);
-    }
-
-
-    /**
-     * @param EE_Event $event
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function column_venue(EE_Event $event): string
-    {
-        $venue   = $event->get_first_related('Venue');
-        $content = ! empty($venue)
-            ? $venue->name()
-            : '';
-        return $this->columnContent('venue', $content);
-    }
-
-
-    /**
-     * @param EE_Event $event
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function column_start_date_time(EE_Event $event): string
-    {
-        $content = $this->_dtt instanceof EE_Datetime
-            ? $this->_dtt->get_i18n_datetime('DTT_EVT_start')
-            : esc_html__('No Date was saved for this Event', 'event_espresso');
-        return $this->columnContent('start_date_time', $content);
-    }
-
-
-    /**
-     * @param EE_Event $event
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function column_reg_begins(EE_Event $event): string
-    {
-        $reg_start = $event->get_ticket_with_earliest_start_time();
-        $content   = $reg_start instanceof EE_Ticket
-            ? $reg_start->get_i18n_datetime('TKT_start_date')
-            : esc_html__('No Tickets have been setup for this Event', 'event_espresso');
-        return $this->columnContent('reg_begins', $content);
-    }
-
-
-    /**
-     * @param EE_Event $event
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function column_attendees(EE_Event $event): string
-    {
-        $attendees_query_args = [
-            'action'   => 'default',
-            'event_id' => $event->ID(),
-        ];
-        $attendees_link       = EE_Admin_Page::add_query_args_and_nonce($attendees_query_args, REG_ADMIN_URL);
-        $registered_attendees = EEM_Registration::instance()->get_event_registration_count($event->ID());
-
-        $content              = EE_Registry::instance()->CAP->current_user_can(
-            'ee_read_event',
-            'espresso_registrations_view_registration',
-            $event->ID()
-        ) && EE_Registry::instance()->CAP->current_user_can(
-            'ee_read_registrations',
-            'espresso_registrations_view_registration'
-        )
-            ? '<a href="' . $attendees_link . '">' . $registered_attendees . '</a>'
-            : $registered_attendees;
-        return $this->columnContent('attendees', $content, 'center');
-    }
-
-
-    /**
-     * @param EE_Event $event
-     * @return float
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function column_tkts_sold(EE_Event $event): float
-    {
-        $content = EEM_Ticket::instance()->sum([['Datetime.EVT_ID' => $event->ID()]], 'TKT_sold');
-        return $this->columnContent('tkts_sold', $content);
-    }
-
-
-    /**
-     * @param EE_Event $event
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function column_actions(EE_Event $event): string
-    {
-        // todo: remove when attendees is active
-        if (! defined('REG_ADMIN_URL')) {
-            define('REG_ADMIN_URL', EVENTS_ADMIN_URL);
-        }
-        $action_links   = [];
-        $view_link      = get_permalink($event->ID());
-        $action_links[] = '<a href="' . $view_link . '" class="ee-aria-tooltip button button--icon-only"'
-                          . ' aria-label="' . esc_attr__('View Event', 'event_espresso') . '" target="_blank">
+		$content .= $this->row_actions($actions);
+
+		return $prep_content ? $this->columnContent('name', $content) : $content;
+	}
+
+
+	/**
+	 * Just a method for setting up the actions for the name column
+	 *
+	 * @param EE_Event $event
+	 * @return array array of actions
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _column_name_action_setup(EE_Event $event): array
+	{
+		// todo: remove when attendees is active
+		if (! defined('REG_ADMIN_URL')) {
+			define('REG_ADMIN_URL', EVENTS_ADMIN_URL);
+		}
+		$actions            = [];
+		$restore_event_link = '';
+		$delete_event_link  = '';
+		$trash_event_link   = '';
+		if (
+			EE_Registry::instance()->CAP->current_user_can(
+				'ee_edit_event',
+				'espresso_events_edit',
+				$event->ID()
+			)
+		) {
+			$edit_query_args = [
+				'action' => 'edit',
+				'post'   => $event->ID(),
+			];
+			$edit_link       = EE_Admin_Page::add_query_args_and_nonce($edit_query_args, EVENTS_ADMIN_URL);
+			$actions['edit'] = '<a href="' . $edit_link . '" class="ee-aria-tooltip" '
+							   . ' aria-label="' . esc_attr__('Edit Event', 'event_espresso') . '">'
+							   . esc_html__('Edit', 'event_espresso')
+							   . '</a>';
+		}
+		if (
+			EE_Registry::instance()->CAP->current_user_can(
+				'ee_read_registrations',
+				'espresso_registrations_view_registration'
+			)
+			&& EE_Registry::instance()->CAP->current_user_can(
+				'ee_read_event',
+				'espresso_registrations_view_registration',
+				$event->ID()
+			)
+		) {
+			$attendees_query_args = [
+				'action'   => 'default',
+				'event_id' => $event->ID(),
+			];
+			$attendees_link       = EE_Admin_Page::add_query_args_and_nonce($attendees_query_args, REG_ADMIN_URL);
+			$actions['attendees'] = '<a href="' . $attendees_link . '" class="ee-aria-tooltip"'
+									. ' aria-label="' . esc_attr__('View Registrations', 'event_espresso') . '">'
+									. esc_html__('Registrations', 'event_espresso')
+									. '</a>';
+		}
+		if (
+			EE_Registry::instance()->CAP->current_user_can(
+				'ee_delete_event',
+				'espresso_events_trash_event',
+				$event->ID()
+			)
+		) {
+			$trash_event_query_args = [
+				'action' => 'trash_event',
+				'EVT_ID' => $event->ID(),
+			];
+			$trash_event_link       = EE_Admin_Page::add_query_args_and_nonce(
+				$trash_event_query_args,
+				EVENTS_ADMIN_URL
+			);
+		}
+		if (
+			EE_Registry::instance()->CAP->current_user_can(
+				'ee_delete_event',
+				'espresso_events_restore_event',
+				$event->ID()
+			)
+		) {
+			$restore_event_query_args = [
+				'action' => 'restore_event',
+				'EVT_ID' => $event->ID(),
+			];
+			$restore_event_link       = EE_Admin_Page::add_query_args_and_nonce(
+				$restore_event_query_args,
+				EVENTS_ADMIN_URL
+			);
+		}
+		if (
+			EE_Registry::instance()->CAP->current_user_can(
+				'ee_delete_event',
+				'espresso_events_delete_event',
+				$event->ID()
+			)
+		) {
+			$delete_event_query_args = [
+				'action' => 'delete_event',
+				'EVT_ID' => $event->ID(),
+			];
+			$delete_event_link       = EE_Admin_Page::add_query_args_and_nonce(
+				$delete_event_query_args,
+				EVENTS_ADMIN_URL
+			);
+		}
+		$view_link       = get_permalink($event->ID());
+		$actions['view'] = '<a href="' . $view_link . '" class="ee-aria-tooltip"'
+						   . ' aria-label="' . esc_attr__('View Event', 'event_espresso') . '">'
+						   . esc_html__('View', 'event_espresso')
+						   . '</a>';
+		if ($event->get('status') === 'trash') {
+			if (
+				EE_Registry::instance()->CAP->current_user_can(
+					'ee_delete_event',
+					'espresso_events_restore_event',
+					$event->ID()
+				)
+			) {
+				$actions['restore_from_trash'] = '<a href="' . $restore_event_link . '" class="ee-aria-tooltip"'
+												 . ' aria-label="' . esc_attr__('Restore from Trash', 'event_espresso')
+												 . '">'
+												 . esc_html__('Restore from Trash', 'event_espresso')
+												 . '</a>';
+			}
+			if (
+				EE_Registry::instance()->CAP->current_user_can(
+					'ee_delete_event',
+					'espresso_events_delete_event',
+					$event->ID()
+				)
+			) {
+				$actions['delete'] = '<a href="' . $delete_event_link . '" class="ee-aria-tooltip"'
+									 . ' aria-label="' . esc_attr__('Delete Permanently', 'event_espresso') . '">'
+									 . esc_html__('Delete Permanently', 'event_espresso')
+									 . '</a>';
+			}
+		} else {
+			if (
+				EE_Registry::instance()->CAP->current_user_can(
+					'ee_delete_event',
+					'espresso_events_trash_event',
+					$event->ID()
+				)
+			) {
+				$actions['move to trash'] = '<a href="' . $trash_event_link . '" class="ee-aria-tooltip"'
+											. ' aria-label="' . esc_attr__('Trash Event', 'event_espresso') . '">'
+											. esc_html__('Trash', 'event_espresso')
+											. '</a>';
+			}
+		}
+		return $actions;
+	}
+
+
+	/**
+	 * @param EE_Event $event
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function column_author(EE_Event $event): string
+	{
+		// user author info
+		$event_author = get_userdata($event->wp_user());
+		$gravatar     = get_avatar($event->wp_user(), '24');
+		// filter link
+		$query_args = [
+			'action'      => 'default',
+			'EVT_wp_user' => $event->wp_user(),
+		];
+		$filter_url = EE_Admin_Page::add_query_args_and_nonce($query_args, EVENTS_ADMIN_URL);
+		$content    = '<div class="ee-layout-row ee-layout-row--fixed">';
+		$content    .= $gravatar . '  <a href="' . $filter_url . '" class="ee-aria-tooltip"'
+					   . ' aria-label="' . esc_attr__('Click to filter events by this author.', 'event_espresso') . '">'
+					   . $event_author->display_name
+					   . '</a>';
+		$content    .= '</div>';
+		return $this->columnContent('author', $content);
+	}
+
+
+	/**
+	 * @param EE_Event $event
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function column_event_category(EE_Event $event): string
+	{
+		$event_categories = $event->get_all_event_categories();
+		$content          = implode(
+			', ',
+			array_map(
+				function (EE_Term $category) {
+					return $category->name();
+				},
+				$event_categories
+			)
+		);
+		return $this->columnContent('event_category', $content);
+	}
+
+
+	/**
+	 * @param EE_Event $event
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function column_venue(EE_Event $event): string
+	{
+		$venue   = $event->get_first_related('Venue');
+		$content = ! empty($venue)
+			? $venue->name()
+			: '';
+		return $this->columnContent('venue', $content);
+	}
+
+
+	/**
+	 * @param EE_Event $event
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function column_start_date_time(EE_Event $event): string
+	{
+		$content = $this->_dtt instanceof EE_Datetime
+			? $this->_dtt->get_i18n_datetime('DTT_EVT_start')
+			: esc_html__('No Date was saved for this Event', 'event_espresso');
+		return $this->columnContent('start_date_time', $content);
+	}
+
+
+	/**
+	 * @param EE_Event $event
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function column_reg_begins(EE_Event $event): string
+	{
+		$reg_start = $event->get_ticket_with_earliest_start_time();
+		$content   = $reg_start instanceof EE_Ticket
+			? $reg_start->get_i18n_datetime('TKT_start_date')
+			: esc_html__('No Tickets have been setup for this Event', 'event_espresso');
+		return $this->columnContent('reg_begins', $content);
+	}
+
+
+	/**
+	 * @param EE_Event $event
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function column_attendees(EE_Event $event): string
+	{
+		$attendees_query_args = [
+			'action'   => 'default',
+			'event_id' => $event->ID(),
+		];
+		$attendees_link       = EE_Admin_Page::add_query_args_and_nonce($attendees_query_args, REG_ADMIN_URL);
+		$registered_attendees = EEM_Registration::instance()->get_event_registration_count($event->ID());
+
+		$content              = EE_Registry::instance()->CAP->current_user_can(
+			'ee_read_event',
+			'espresso_registrations_view_registration',
+			$event->ID()
+		) && EE_Registry::instance()->CAP->current_user_can(
+			'ee_read_registrations',
+			'espresso_registrations_view_registration'
+		)
+			? '<a href="' . $attendees_link . '">' . $registered_attendees . '</a>'
+			: $registered_attendees;
+		return $this->columnContent('attendees', $content, 'center');
+	}
+
+
+	/**
+	 * @param EE_Event $event
+	 * @return float
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function column_tkts_sold(EE_Event $event): float
+	{
+		$content = EEM_Ticket::instance()->sum([['Datetime.EVT_ID' => $event->ID()]], 'TKT_sold');
+		return $this->columnContent('tkts_sold', $content);
+	}
+
+
+	/**
+	 * @param EE_Event $event
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function column_actions(EE_Event $event): string
+	{
+		// todo: remove when attendees is active
+		if (! defined('REG_ADMIN_URL')) {
+			define('REG_ADMIN_URL', EVENTS_ADMIN_URL);
+		}
+		$action_links   = [];
+		$view_link      = get_permalink($event->ID());
+		$action_links[] = '<a href="' . $view_link . '" class="ee-aria-tooltip button button--icon-only"'
+						  . ' aria-label="' . esc_attr__('View Event', 'event_espresso') . '" target="_blank">
                           <span class="dashicons dashicons-visibility"></span></a>';
-        if (
-            EE_Registry::instance()->CAP->current_user_can(
-                'ee_edit_event',
-                'espresso_events_edit',
-                $event->ID()
-            )
-        ) {
-            $edit_query_args = [
-                'action' => 'edit',
-                'post'   => $event->ID(),
-            ];
-            $edit_link       = EE_Admin_Page::add_query_args_and_nonce($edit_query_args, EVENTS_ADMIN_URL);
-            $action_links[]  = '<a href="' . $edit_link . '" class="ee-aria-tooltip button button--icon-only"'
-                               . ' aria-label="' . esc_attr__('Edit Event', 'event_espresso') . '">'
-                               . '<span class="dashicons dashicons-calendar-alt"></span>'
-                               . '</a>';
-        }
-        if (
-            EE_Registry::instance()->CAP->current_user_can(
-                'ee_read_registrations',
-                'espresso_registrations_view_registration'
-            )
-            && EE_Registry::instance()->CAP->current_user_can(
-                'ee_read_event',
-                'espresso_registrations_view_registration',
-                $event->ID()
-            )
-        ) {
-            $attendees_query_args = [
-                'action'   => 'default',
-                'event_id' => $event->ID(),
-            ];
-            $attendees_link       = EE_Admin_Page::add_query_args_and_nonce($attendees_query_args, REG_ADMIN_URL);
-            $action_links[]       = '<a href="' . $attendees_link . '" class="ee-aria-tooltip button button--icon-only"'
-                                    . ' aria-label="' . esc_attr__('View Registrants', 'event_espresso') . '">'
-                                    . '<span class="dashicons dashicons-groups"></span>'
-                                    . '</a>';
-        }
-        $action_links = apply_filters(
-            'FHEE__Events_Admin_List_Table__column_actions__action_links',
-            $action_links,
-            $event
-        );
-        $content      = $this->_action_string(
-            implode("\n\t", $action_links),
-            $event,
-            'div',
-            'event-overview-actions ee-list-table-actions'
-        );
-        return $this->columnContent('actions', $this->actionsModalMenu($content));
-    }
-
-
-    /**
-     * Helper for adding columns conditionally
-     *
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function addConditionalColumns()
-    {
-        $event_category_count = EEM_Term::instance()->count(
-            [['Term_Taxonomy.taxonomy' => EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY]]
-        );
-        if ($event_category_count === 0) {
-            return;
-        }
-        $column_array = [];
-        foreach ($this->_columns as $column => $column_label) {
-            $column_array[ $column ] = $column_label;
-            if ($column === 'venue') {
-                $column_array['event_category'] = esc_html__('Event Category', 'event_espresso');
-            }
-        }
-        $this->_columns = $column_array;
-    }
+		if (
+			EE_Registry::instance()->CAP->current_user_can(
+				'ee_edit_event',
+				'espresso_events_edit',
+				$event->ID()
+			)
+		) {
+			$edit_query_args = [
+				'action' => 'edit',
+				'post'   => $event->ID(),
+			];
+			$edit_link       = EE_Admin_Page::add_query_args_and_nonce($edit_query_args, EVENTS_ADMIN_URL);
+			$action_links[]  = '<a href="' . $edit_link . '" class="ee-aria-tooltip button button--icon-only"'
+							   . ' aria-label="' . esc_attr__('Edit Event', 'event_espresso') . '">'
+							   . '<span class="dashicons dashicons-calendar-alt"></span>'
+							   . '</a>';
+		}
+		if (
+			EE_Registry::instance()->CAP->current_user_can(
+				'ee_read_registrations',
+				'espresso_registrations_view_registration'
+			)
+			&& EE_Registry::instance()->CAP->current_user_can(
+				'ee_read_event',
+				'espresso_registrations_view_registration',
+				$event->ID()
+			)
+		) {
+			$attendees_query_args = [
+				'action'   => 'default',
+				'event_id' => $event->ID(),
+			];
+			$attendees_link       = EE_Admin_Page::add_query_args_and_nonce($attendees_query_args, REG_ADMIN_URL);
+			$action_links[]       = '<a href="' . $attendees_link . '" class="ee-aria-tooltip button button--icon-only"'
+									. ' aria-label="' . esc_attr__('View Registrants', 'event_espresso') . '">'
+									. '<span class="dashicons dashicons-groups"></span>'
+									. '</a>';
+		}
+		$action_links = apply_filters(
+			'FHEE__Events_Admin_List_Table__column_actions__action_links',
+			$action_links,
+			$event
+		);
+		$content      = $this->_action_string(
+			implode("\n\t", $action_links),
+			$event,
+			'div',
+			'event-overview-actions ee-list-table-actions'
+		);
+		return $this->columnContent('actions', $this->actionsModalMenu($content));
+	}
+
+
+	/**
+	 * Helper for adding columns conditionally
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function addConditionalColumns()
+	{
+		$event_category_count = EEM_Term::instance()->count(
+			[['Term_Taxonomy.taxonomy' => EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY]]
+		);
+		if ($event_category_count === 0) {
+			return;
+		}
+		$column_array = [];
+		foreach ($this->_columns as $column => $column_label) {
+			$column_array[ $column ] = $column_label;
+			if ($column === 'venue') {
+				$column_array['event_category'] = esc_html__('Event Category', 'event_espresso');
+			}
+		}
+		$this->_columns = $column_array;
+	}
 }

Spacing +39 added lines, -39 removed lines

@@ -45,7 +45,7 @@ 
      */
     protected function _set_properties()
     {
-        $this->_wp_list_args    = [
+        $this->_wp_list_args = [
             'singular' => esc_html__('event', 'event_espresso'),
             'plural'   => esc_html__('events', 'event_espresso'),
             'ajax'     => true, // for now
@@ -61,8 +61,8 @@ 
             'start_date_time' => esc_html__('Event Start', 'event_espresso'),
             'reg_begins'      => esc_html__('On Sale', 'event_espresso'),
             'attendees'       => '
-                <span class="show-on-mobile-view-only" aria-label="' . $approved_registrations . '">
-                    ' . $approved_registrations . '
+                <span class="show-on-mobile-view-only" aria-label="' . $approved_registrations.'">
+                    ' . $approved_registrations.'
                 </span>
                 <span class="dashicons dashicons-groups ee-icon-color-ee-green"></span>',
             'actions'         => $this->actionsColumnHeader(),
@@ -138,7 +138,7 @@ 
      */
     public function column_cb($item): string
     {
-        if (! $item instanceof EE_Event) {
+        if ( ! $item instanceof EE_Event) {
             return '';
         }
         $this->_dtt = $item->primary_datetime(); // set this for use in other columns
@@ -183,14 +183,14 @@ 
         $actions         = $this->_column_name_action_setup($event);
         $status          = esc_attr($event->get_active_status());
         $pretty_status   = EEH_Template::pretty_status($status, false, 'sentence');
-        $status_dot      = '<span class="ee-status-dot ee-status-bg--' . $status . '"></span>';
+        $status_dot      = '<span class="ee-status-dot ee-status-bg--'.$status.'"></span>';
         $content         = '
             <div class="ee-layout-row ee-layout-row--fixed">
-                <a  class="row-title ee-status-color--' . $status . ' ee-aria-tooltip" 
-                    aria-label="' . $pretty_status . '" 
-                    href="' . $edit_link . '"
+                <a  class="row-title ee-status-color--' . $status.' ee-aria-tooltip" 
+                    aria-label="' . $pretty_status.'" 
+                    href="' . $edit_link.'"
                 >
-                    ' . $status_dot . $event->name() . '
+                    ' . $status_dot.$event->name().'
                 </a>
             </div>';
 
@@ -214,7 +214,7 @@ 
     protected function _column_name_action_setup(EE_Event $event): array
     {
         // todo: remove when attendees is active
-        if (! defined('REG_ADMIN_URL')) {
+        if ( ! defined('REG_ADMIN_URL')) {
             define('REG_ADMIN_URL', EVENTS_ADMIN_URL);
         }
         $actions            = [];
@@ -233,8 +233,8 @@ 
                 'post'   => $event->ID(),
             ];
             $edit_link       = EE_Admin_Page::add_query_args_and_nonce($edit_query_args, EVENTS_ADMIN_URL);
-            $actions['edit'] = '<a href="' . $edit_link . '" class="ee-aria-tooltip" '
-                               . ' aria-label="' . esc_attr__('Edit Event', 'event_espresso') . '">'
+            $actions['edit'] = '<a href="'.$edit_link.'" class="ee-aria-tooltip" '
+                               . ' aria-label="'.esc_attr__('Edit Event', 'event_espresso').'">'
                                . esc_html__('Edit', 'event_espresso')
                                . '</a>';
         }
@@ -254,8 +254,8 @@ 
                 'event_id' => $event->ID(),
             ];
             $attendees_link       = EE_Admin_Page::add_query_args_and_nonce($attendees_query_args, REG_ADMIN_URL);
-            $actions['attendees'] = '<a href="' . $attendees_link . '" class="ee-aria-tooltip"'
-                                    . ' aria-label="' . esc_attr__('View Registrations', 'event_espresso') . '">'
+            $actions['attendees'] = '<a href="'.$attendees_link.'" class="ee-aria-tooltip"'
+                                    . ' aria-label="'.esc_attr__('View Registrations', 'event_espresso').'">'
                                     . esc_html__('Registrations', 'event_espresso')
                                     . '</a>';
         }
@@ -270,7 +270,7 @@ 
                 'action' => 'trash_event',
                 'EVT_ID' => $event->ID(),
             ];
-            $trash_event_link       = EE_Admin_Page::add_query_args_and_nonce(
+            $trash_event_link = EE_Admin_Page::add_query_args_and_nonce(
                 $trash_event_query_args,
                 EVENTS_ADMIN_URL
             );
@@ -286,7 +286,7 @@ 
                 'action' => 'restore_event',
                 'EVT_ID' => $event->ID(),
             ];
-            $restore_event_link       = EE_Admin_Page::add_query_args_and_nonce(
+            $restore_event_link = EE_Admin_Page::add_query_args_and_nonce(
                 $restore_event_query_args,
                 EVENTS_ADMIN_URL
             );
@@ -302,14 +302,14 @@ 
                 'action' => 'delete_event',
                 'EVT_ID' => $event->ID(),
             ];
-            $delete_event_link       = EE_Admin_Page::add_query_args_and_nonce(
+            $delete_event_link = EE_Admin_Page::add_query_args_and_nonce(
                 $delete_event_query_args,
                 EVENTS_ADMIN_URL
             );
         }
         $view_link       = get_permalink($event->ID());
-        $actions['view'] = '<a href="' . $view_link . '" class="ee-aria-tooltip"'
-                           . ' aria-label="' . esc_attr__('View Event', 'event_espresso') . '">'
+        $actions['view'] = '<a href="'.$view_link.'" class="ee-aria-tooltip"'
+                           . ' aria-label="'.esc_attr__('View Event', 'event_espresso').'">'
                            . esc_html__('View', 'event_espresso')
                            . '</a>';
         if ($event->get('status') === 'trash') {
@@ -320,8 +320,8 @@ 
                     $event->ID()
                 )
             ) {
-                $actions['restore_from_trash'] = '<a href="' . $restore_event_link . '" class="ee-aria-tooltip"'
-                                                 . ' aria-label="' . esc_attr__('Restore from Trash', 'event_espresso')
+                $actions['restore_from_trash'] = '<a href="'.$restore_event_link.'" class="ee-aria-tooltip"'
+                                                 . ' aria-label="'.esc_attr__('Restore from Trash', 'event_espresso')
                                                  . '">'
                                                  . esc_html__('Restore from Trash', 'event_espresso')
                                                  . '</a>';
@@ -333,8 +333,8 @@ 
                     $event->ID()
                 )
             ) {
-                $actions['delete'] = '<a href="' . $delete_event_link . '" class="ee-aria-tooltip"'
-                                     . ' aria-label="' . esc_attr__('Delete Permanently', 'event_espresso') . '">'
+                $actions['delete'] = '<a href="'.$delete_event_link.'" class="ee-aria-tooltip"'
+                                     . ' aria-label="'.esc_attr__('Delete Permanently', 'event_espresso').'">'
                                      . esc_html__('Delete Permanently', 'event_espresso')
                                      . '</a>';
             }
@@ -346,8 +346,8 @@ 
                     $event->ID()
                 )
             ) {
-                $actions['move to trash'] = '<a href="' . $trash_event_link . '" class="ee-aria-tooltip"'
-                                            . ' aria-label="' . esc_attr__('Trash Event', 'event_espresso') . '">'
+                $actions['move to trash'] = '<a href="'.$trash_event_link.'" class="ee-aria-tooltip"'
+                                            . ' aria-label="'.esc_attr__('Trash Event', 'event_espresso').'">'
                                             . esc_html__('Trash', 'event_espresso')
                                             . '</a>';
             }
@@ -374,11 +374,11 @@ 
         ];
         $filter_url = EE_Admin_Page::add_query_args_and_nonce($query_args, EVENTS_ADMIN_URL);
         $content    = '<div class="ee-layout-row ee-layout-row--fixed">';
-        $content    .= $gravatar . '  <a href="' . $filter_url . '" class="ee-aria-tooltip"'
-                       . ' aria-label="' . esc_attr__('Click to filter events by this author.', 'event_espresso') . '">'
+        $content .= $gravatar.'  <a href="'.$filter_url.'" class="ee-aria-tooltip"'
+                       . ' aria-label="'.esc_attr__('Click to filter events by this author.', 'event_espresso').'">'
                        . $event_author->display_name
                        . '</a>';
-        $content    .= '</div>';
+        $content .= '</div>';
         return $this->columnContent('author', $content);
     }
 
@@ -395,7 +395,7 @@ 
         $content          = implode(
             ', ',
             array_map(
-                function (EE_Term $category) {
+                function(EE_Term $category) {
                     return $category->name();
                 },
                 $event_categories
@@ -478,7 +478,7 @@ 
             'ee_read_registrations',
             'espresso_registrations_view_registration'
         )
-            ? '<a href="' . $attendees_link . '">' . $registered_attendees . '</a>'
+            ? '<a href="'.$attendees_link.'">'.$registered_attendees.'</a>'
             : $registered_attendees;
         return $this->columnContent('attendees', $content, 'center');
     }
@@ -512,13 +512,13 @@ 
     public function column_actions(EE_Event $event): string
     {
         // todo: remove when attendees is active
-        if (! defined('REG_ADMIN_URL')) {
+        if ( ! defined('REG_ADMIN_URL')) {
             define('REG_ADMIN_URL', EVENTS_ADMIN_URL);
         }
         $action_links   = [];
         $view_link      = get_permalink($event->ID());
-        $action_links[] = '<a href="' . $view_link . '" class="ee-aria-tooltip button button--icon-only"'
-                          . ' aria-label="' . esc_attr__('View Event', 'event_espresso') . '" target="_blank">
+        $action_links[] = '<a href="'.$view_link.'" class="ee-aria-tooltip button button--icon-only"'
+                          . ' aria-label="'.esc_attr__('View Event', 'event_espresso').'" target="_blank">
                           <span class="dashicons dashicons-visibility"></span></a>';
         if (
             EE_Registry::instance()->CAP->current_user_can(
@@ -532,8 +532,8 @@ 
                 'post'   => $event->ID(),
             ];
             $edit_link       = EE_Admin_Page::add_query_args_and_nonce($edit_query_args, EVENTS_ADMIN_URL);
-            $action_links[]  = '<a href="' . $edit_link . '" class="ee-aria-tooltip button button--icon-only"'
-                               . ' aria-label="' . esc_attr__('Edit Event', 'event_espresso') . '">'
+            $action_links[]  = '<a href="'.$edit_link.'" class="ee-aria-tooltip button button--icon-only"'
+                               . ' aria-label="'.esc_attr__('Edit Event', 'event_espresso').'">'
                                . '<span class="dashicons dashicons-calendar-alt"></span>'
                                . '</a>';
         }
@@ -553,8 +553,8 @@ 
                 'event_id' => $event->ID(),
             ];
             $attendees_link       = EE_Admin_Page::add_query_args_and_nonce($attendees_query_args, REG_ADMIN_URL);
-            $action_links[]       = '<a href="' . $attendees_link . '" class="ee-aria-tooltip button button--icon-only"'
-                                    . ' aria-label="' . esc_attr__('View Registrants', 'event_espresso') . '">'
+            $action_links[]       = '<a href="'.$attendees_link.'" class="ee-aria-tooltip button button--icon-only"'
+                                    . ' aria-label="'.esc_attr__('View Registrants', 'event_espresso').'">'
                                     . '<span class="dashicons dashicons-groups"></span>'
                                     . '</a>';
         }
@@ -563,7 +563,7 @@ 
             $action_links,
             $event
         );
-        $content      = $this->_action_string(
+        $content = $this->_action_string(
             implode("\n\t", $action_links),
             $event,
             'div',
@@ -592,7 +592,7 @@ 
         }
         $column_array = [];
         foreach ($this->_columns as $column => $column_label) {
-            $column_array[ $column ] = $column_label;
+            $column_array[$column] = $column_label;
             if ($column === 'venue') {
                 $column_array['event_category'] = esc_html__('Event Category', 'event_espresso');
             }

admin_pages/transactions/templates/txn_admin_details_main_meta_box_txn_details.template.php

Indentation +166 added lines, -166 removed lines

@@ -80,21 +80,21 @@ 
     </div>
     <br class="clear" />
     <?php
-    $no_payments = $grand_raw_total > 0
-                   || $TXN_status !== EEM_Transaction::complete_status_code
-                   || ! empty($payments);
-    ?>
+	$no_payments = $grand_raw_total > 0
+				   || $TXN_status !== EEM_Transaction::complete_status_code
+				   || ! empty($payments);
+	?>
     <?php if ($attendee instanceof EE_Attendee && $no_payments) : ?>
         <?php $no_payment_text = $can_edit_payments
-            ? esc_html__(
-                'No payments have been applied to this transaction yet. Click "Apply Payment" below to make a payment.',
-                'event_espresso'
-            )
-            : esc_html__(
-                'No payments have been applied to this transaction yet.',
-                'event_espresso'
-            );
-        ?>
+			? esc_html__(
+				'No payments have been applied to this transaction yet. Click "Apply Payment" below to make a payment.',
+				'event_espresso'
+			)
+			: esc_html__(
+				'No payments have been applied to this transaction yet.',
+				'event_espresso'
+			);
+		?>
 
         <h3 class="admin-primary-mbox-h4 hdr-has-icon">
             <?php esc_html_e('Payment Details', 'event_espresso'); ?>
@@ -140,15 +140,15 @@ 
                     <?php if ($payments) : ?>
                         <?php $payment_total = 0; ?>
                         <?php foreach ($payments as $PAY_ID => $payment) :
-                            if (! $payment instanceof EE_Payment) {
-                                continue;
-                            }
-                            $PAY_ID = absint($PAY_ID);
-                            $existing_reg_payment_json = isset($existing_reg_payments[ $PAY_ID ])
-                                ? wp_json_encode($existing_reg_payments[ $PAY_ID ])
-                                : '{}';
-                            $escaped_pay_id = esc_attr($PAY_ID);
-                            ?>
+							if (! $payment instanceof EE_Payment) {
+								continue;
+							}
+							$PAY_ID = absint($PAY_ID);
+							$existing_reg_payment_json = isset($existing_reg_payments[ $PAY_ID ])
+								? wp_json_encode($existing_reg_payments[ $PAY_ID ])
+								: '{}';
+							$escaped_pay_id = esc_attr($PAY_ID);
+							?>
                             <tr id="txn-admin-payment-tr-<?php echo $escaped_pay_id; ?>" class=' jst-cntr'>
                                 <td class="jst-cntr no-pad">
                                     <span id="payment-status-<?php echo $escaped_pay_id; ?>"
@@ -164,7 +164,7 @@ 
                                 <td class=" jst-rght">
                                     <div id="payment-id-<?php echo $escaped_pay_id; ?>">
                                         <?php echo $PAY_ID; // sanitized
-                                        ?>
+										?>
                                     </div>
                                 </td>
                                 <td class=" jst-left">
@@ -174,20 +174,20 @@ 
                                 </td>
                                 <td class=' jst-rght'>
                                     <?php
-                                    $payment_class = $payment->amount() > 0
-                                        ? 'txn-admin-payment-status-' . $payment->STS_ID()
-                                        : 'txn-admin-payment-status-PDC';
-                                    ?>
+									$payment_class = $payment->amount() > 0
+										? 'txn-admin-payment-status-' . $payment->STS_ID()
+										: 'txn-admin-payment-status-PDC';
+									?>
                                     <span class="<?php echo esc_attr($payment_class); ?>">
                                         <span id="payment-amount-<?php echo $escaped_pay_id; ?>"
                                               style="display:inline;"
                                         >
                                         <?php echo EEH_Template::format_currency(
-                                            $payment->amount(),
-                                            false,
-                                            false
-                                        ); // already escaped
-                                        ?>
+											$payment->amount(),
+											false,
+											false
+										); // already escaped
+										?>
                                         </span>
                                     </span>
                                 </td>
@@ -198,13 +198,13 @@ 
                                     <span class="ee-status--ignore">&raquo;</span>
                                     <span id="payment-gateway-<?php echo $escaped_pay_id; ?>">
                                         <?php echo $payment->payment_method() instanceof EE_Payment_Method
-                                            ? esc_html($payment->payment_method()->admin_name())
-                                            : esc_html__("Unknown", 'event_espresso'); ?>
+											? esc_html($payment->payment_method()->admin_name())
+											: esc_html__("Unknown", 'event_espresso'); ?>
                                     </span>
                                     <span id="payment-gateway-id-<?php echo $escaped_pay_id; ?>" class="hidden">
                                         <?php echo $payment->payment_method() instanceof EE_Payment_Method
-                                            ? esc_html($payment->payment_method()->ID())
-                                            : 0; ?>
+											? esc_html($payment->payment_method()->ID())
+											: 0; ?>
                                     </span>
                                 </td>
                                 <td class=" jst-left">
@@ -255,9 +255,9 @@ 
                             <?php $payment_total += $payment->STS_ID() == 'PAP' ? $payment->amount() : 0; ?>
                         <?php endforeach; ?>
                         <?php $pay_totals_class = $payment_total > $grand_raw_total
-                            ? ' important-notice'
-                            : '';
-                        ?>
+							? ' important-notice'
+							: '';
+						?>
                         <tr id="txn-admin-no-payments-tr" class="admin-primary-mbox-total-tr hidden">
                             <td class=" jst-rght" colspan="10">
                                 <span class="important-notice"><?php echo $no_payment_text; // already escaped ?></span>
@@ -269,27 +269,27 @@ 
                             <th class=" jst-rght" colspan="9">
                         <span id="payments-total-spn">
                         <?php
-                        $overpaid = $payment_total > $grand_raw_total
-                            ? '<span id="overpaid">'
-                              . __('This transaction has been overpaid ! ', 'event_espresso')
-                              . '</span>'
-                            : '';
-                        echo $overpaid . esc_html(
-                            sprintf(
-                                __('Payments Total %s', 'event_espresso'),
-                                '(' . EE_Registry::instance()->CFG->currency->code . ')'
-                            )
-                        ); ?>
+						$overpaid = $payment_total > $grand_raw_total
+							? '<span id="overpaid">'
+							  . __('This transaction has been overpaid ! ', 'event_espresso')
+							  . '</span>'
+							: '';
+						echo $overpaid . esc_html(
+							sprintf(
+								__('Payments Total %s', 'event_espresso'),
+								'(' . EE_Registry::instance()->CFG->currency->code . ')'
+							)
+						); ?>
                         </span>
                             </th>
                             <th class=" jst-rght">
                         <span id="txn-admin-payment-total">
                         <?php
-                        echo EEH_Template::format_currency(
-                            $payment_total,
-                            false,
-                            false
-                        ); // already escaped ?>
+						echo EEH_Template::format_currency(
+							$payment_total,
+							false,
+							false
+						); // already escaped ?>
                         </span>
                             </th>
                         </tr>
@@ -370,7 +370,7 @@ 
 
         <ul id="txn-admin-payment-options-ul">
             <?php if ($can_edit_payments) :
-                ?>
+				?>
                 <li>
                     <a id="display-txn-admin-apply-payment"
                        class="button button--primary no-icon no-hide"
@@ -397,12 +397,12 @@ 
                 </li>
             <?php endif; ?>
             <?php
-            // Allows extend the fields at actions area.
-            do_action(
-                'AHEE__txn_admin_details_main_meta_box_txn_details__after_actions_buttons',
-                $can_edit_payments
-            );
-            ?>
+			// Allows extend the fields at actions area.
+			do_action(
+				'AHEE__txn_admin_details_main_meta_box_txn_details__after_actions_buttons',
+				$can_edit_payments
+			);
+			?>
         </ul>
         <br class="clear" />
 
@@ -419,23 +419,23 @@ 
                 style="display:none;"
             >
                 <?php
-                printf(
-                    esc_html__('Edit Payment #%s for Transaction #%s', 'event_espresso'),
-                    '<span class="ee-admin-payment-id"></span>',
-                    $txn_nmbr['value']
-                );
-                ?>
+				printf(
+					esc_html__('Edit Payment #%s for Transaction #%s', 'event_espresso'),
+					'<span class="ee-admin-payment-id"></span>',
+					$txn_nmbr['value']
+				);
+				?>
                 <span class='dashicons dashicons-money-alt'></span>
             </h2>
 
             <h2 id="admin-modal-dialog-edit-refund-h2" class="admin-modal-dialog-h2 hdr-has-icon" style="display:none;">
                 <?php
-                printf(
-                    esc_html__('Edit Refund #%s for Transaction #%s', 'event_espresso'),
-                    '<span class="ee-admin-payment-id"></span>',
-                    $txn_nmbr['value']
-                );
-                ?>
+				printf(
+					esc_html__('Edit Refund #%s for Transaction #%s', 'event_espresso'),
+					'<span class="ee-admin-payment-id"></span>',
+					$txn_nmbr['value']
+				);
+				?>
                 <span class='dashicons dashicons-money-alt'></span>
             </h2>
 
@@ -443,9 +443,9 @@ 
                 style="display:none;"
             >
                 <?php
-                echo esc_html__('Apply a Refund to Transaction #', 'event_espresso');
-                echo esc_html($txn_nmbr['value']);
-                ?>
+				echo esc_html__('Apply a Refund to Transaction #', 'event_espresso');
+				echo esc_html($txn_nmbr['value']);
+				?>
                 <span class='dashicons dashicons-money-alt'></span>
             </h2>
 
@@ -552,29 +552,29 @@ 
                                 >
                                     <?php foreach ($payment_methods as $method) : ?>
                                         <?php
-                                        $selected = $method->slug() == 'cash'
-                                            ? ' selected="selected"'
-                                            : '';
-                                        ?>
+										$selected = $method->slug() == 'cash'
+											? ' selected="selected"'
+											: '';
+										?>
                                         <option id="payment-method-opt-<?php echo esc_attr($method->slug()); ?>"
                                                 value="<?php echo esc_attr($method->ID()); ?>"
                                             <?php echo esc_attr($selected); ?>
                                         >
                                             <?php
-                                            echo esc_html(
-                                                sanitize_key($method->admin_desc())
-                                                    ? substr($method->admin_desc(), 0, 128)
-                                                    : $method->admin_name()
-                                            );
-                                            ?>&nbsp;&nbsp;
+											echo esc_html(
+												sanitize_key($method->admin_desc())
+													? substr($method->admin_desc(), 0, 128)
+													: $method->admin_name()
+											);
+											?>&nbsp;&nbsp;
                                         </option>
                                     <?php endforeach; ?>
                                 </select>
                                 <p class="description">
                                     <?php esc_html_e(
-                                        'Whether the payment was made via PayPal, Credit Card, Cheque, or Cash',
-                                        'event_espresso'
-                                    ); ?>
+										'Whether the payment was made via PayPal, Credit Card, Cheque, or Cash',
+										'event_espresso'
+									); ?>
                                 </p>
                             </div>
                         </div>
@@ -583,9 +583,9 @@ 
                         admin-modal-dialog-row ee-layout-row">
                             <label for="txn-admin-payment-txn-id-chq-nmbr-inp" class="">
                                 <?php esc_html_e(
-                                    'TXN ID / CHQ #',
-                                    'event_espresso'
-                                ); ?>
+									'TXN ID / CHQ #',
+									'event_espresso'
+								); ?>
                             </label>
                             <div class='ee-layout-stack'>
                                 <input name="txn_admin_payment[txn_id_chq_nmbr]"
@@ -595,9 +595,9 @@ 
                                 />
                                 <p class="description">
                                     <?php esc_html_e(
-                                        'The Transaction ID sent back from the payment gateway, or the Cheque #',
-                                        'event_espresso'
-                                    ); ?>
+										'The Transaction ID sent back from the payment gateway, or the Cheque #',
+										'event_espresso'
+									); ?>
                                 </p>
                             </div>
                         </div>
@@ -615,9 +615,9 @@ 
                                 />
                                 <p class="description">
                                     <?php esc_html_e(
-                                        'The gateway response string (optional)',
-                                        'event_espresso'
-                                    ); ?>
+										'The gateway response string (optional)',
+										'event_espresso'
+									); ?>
                                 </p>
                             </div>
                         </div>
@@ -626,9 +626,9 @@ 
                             ee-layout-row">
                             <label for="txn-admin-payment-status-slct" class="">
                                 <?php esc_html_e(
-                                    'Payment Status',
-                                    'event_espresso'
-                                ); ?>
+									'Payment Status',
+									'event_espresso'
+								); ?>
                             </label>
                             <div class='ee-layout-stack'>
                                 <select name="txn_admin_payment[status]"
@@ -638,10 +638,10 @@ 
                                 >
                                     <?php foreach ($payment_status as $STS_ID => $STS_code) : ?>
                                         <?php
-                                        $selected = $STS_ID == 'PAP'
-                                            ? ' selected="selected"'
-                                            : '';
-                                        ?>
+										$selected = $STS_ID == 'PAP'
+											? ' selected="selected"'
+											: '';
+										?>
                                         <option id="payment-status-opt-<?php echo esc_attr($STS_ID); ?>"
                                                 value="<?php echo esc_attr($STS_ID); ?>"
                                             <?php echo esc_attr($selected); ?>
@@ -652,10 +652,10 @@ 
                                 </select>
                                 <p class="description">
                                     <?php
-                                    esc_html_e(
-                                        'Whether the payment was approved, cancelled, declined or failed after submission to the gateway',
-                                        'event_espresso'
-                                    ); ?>
+									esc_html_e(
+										'Whether the payment was approved, cancelled, declined or failed after submission to the gateway',
+										'event_espresso'
+									); ?>
                                 </p>
                             </div>
                         </div>
@@ -673,9 +673,9 @@ 
                                 />
                                 <p class="description">
                                     <?php esc_html_e(
-                                        'The Purchase or Sales Order Number if any (optional)',
-                                        'event_espresso'
-                                    ); ?>
+										'The Purchase or Sales Order Number if any (optional)',
+										'event_espresso'
+									); ?>
                                 </p>
                             </div>
                         </div>
@@ -698,9 +698,9 @@ 
                                 />
                                 <p class="description">
                                     <?php esc_html_e(
-                                        'An extra field you may use for accounting purposes or simple notes. Defaults to the primary registrant\'s registration code.',
-                                        'event_espresso'
-                                    ); ?>
+										'An extra field you may use for accounting purposes or simple notes. Defaults to the primary registrant\'s registration code.',
+										'event_espresso'
+									); ?>
                                 </p>
                             </div>
                         </div>
@@ -739,9 +739,9 @@ 
                                 <?php echo $status_change_select; // already escaped ?>
                                 <p class="description">
                                     <?php esc_html_e(
-                                        'If you wish to change the status for the registrations selected above, then select which status from this dropdown.',
-                                        'event_espresso'
-                                    ); ?>
+										'If you wish to change the status for the registrations selected above, then select which status from this dropdown.',
+										'event_espresso'
+									); ?>
                                 </p>
                             </div>
                         </div>
@@ -772,14 +772,14 @@ 
                                 <br class="clear-float" />
                                 <p class="description">
                                     <?php printf(
-                                        esc_html__(
-                                            'By default %1$sa payment message is sent to the primary registrant%2$s after submitting this form.%3$sHowever, if you check the "Registration Messages" box, the system will also send any related messages matching the status of the registrations to %1$seach registration for this transaction%2$s.',
-                                            'event_espresso'
-                                        ),
-                                        '<strong>',
-                                        '</strong>',
-                                        '<br />'
-                                    ); ?>
+										esc_html__(
+											'By default %1$sa payment message is sent to the primary registrant%2$s after submitting this form.%3$sHowever, if you check the "Registration Messages" box, the system will also send any related messages matching the status of the registrations to %1$seach registration for this transaction%2$s.',
+											'event_espresso'
+										),
+										'<strong>',
+										'</strong>',
+										'<br />'
+									); ?>
                                 </p>
                             </div>
                         </div>
@@ -834,10 +834,10 @@ 
                 style="display:none;"
             >
                 <?php printf(
-                    esc_html__('Delete Payment/Refund for Transaction #', 'event_espresso'),
-                    $txn_nmbr['value']
-                );
-                ?>
+					esc_html__('Delete Payment/Refund for Transaction #', 'event_espresso'),
+					$txn_nmbr['value']
+				);
+				?>
                 <span class='dashicons dashicons-money-alt'></span>
             </h2>
 
@@ -875,13 +875,13 @@ 
                                 <?php echo $delete_status_change_select; // already escaped ?>
                                 <p class="description">
                                     <?php printf(
-                                        esc_html__(
-                                            'If you wish to change the status of all the registrations associated with this transaction after deleting this payment/refund, then select which status from this dropdown. %sNote: ALL registrations associated with this transaction will be updated to this new status.%s',
-                                            'event_espresso'
-                                        ),
-                                        '<strong>',
-                                        '</strong>'
-                                    ); ?>
+										esc_html__(
+											'If you wish to change the status of all the registrations associated with this transaction after deleting this payment/refund, then select which status from this dropdown. %sNote: ALL registrations associated with this transaction will be updated to this new status.%s',
+											'event_espresso'
+										),
+										'<strong>',
+										'</strong>'
+									); ?>
                                 </p>
                             </div>
                         </div>
@@ -898,10 +898,10 @@ 
                                 />
                                 <p class="description">
                                     <?php
-                                    esc_html_e(
-                                        'If you check this box, the system will send any related registration messages matching the status of the registrations to each registration for this transaction. No Payment notifications are sent when deleting a payment.',
-                                        'event_espresso'
-                                    ); ?>
+									esc_html_e(
+										'If you check this box, the system will send any related registration messages matching the status of the registrations to each registration for this transaction. No Payment notifications are sent when deleting a payment.',
+										'event_espresso'
+									); ?>
                                 </p>
                             </div>
                         </div>
@@ -929,8 +929,8 @@ 
     <?php endif; // $grand_raw_total > 0?>
 
     <?php if (WP_DEBUG) {
-        $delivered_messages = get_option('EED_Messages__payment', []);
-        if (isset($delivered_messages[ $TXN_ID ])) { ?>
+		$delivered_messages = get_option('EED_Messages__payment', []);
+		if (isset($delivered_messages[ $TXN_ID ])) { ?>
             <h4 class="admin-primary-mbox-h4 hdr-has-icon">
                 <?php esc_html_e('Messages Sent to Primary Registrant', 'event_espresso'); ?>
                 <span class="dashicons dashicons-email-alt"></span>
@@ -942,39 +942,39 @@ 
                             <th class="jst-left"><?php esc_html_e('Date & Time', 'event_espresso'); ?></th>
                             <th class="jst-left"><?php esc_html_e('Message Type', 'event_espresso'); ?></th>
                             <th class="jst-left"><?php esc_html_e(
-                                'Payment Status Upon Sending',
-                                'event_espresso'
-                            ); ?></th>
+								'Payment Status Upon Sending',
+								'event_espresso'
+							); ?></th>
                             <th class="jst-left"><?php esc_html_e('TXN Status Upon Sending', 'event_espresso'); ?></th>
                         </tr>
                     </thead>
                     <tbody>
                         <?php
-                        foreach ($delivered_messages[ $TXN_ID ] as $timestamp => $delivered_message) :
-                            ?>
+						foreach ($delivered_messages[ $TXN_ID ] as $timestamp => $delivered_message) :
+							?>
                             <tr>
                                 <td class="jst-left">
                                     <?php echo esc_html(
-                                        date(
-                                            get_option('date_format') . ' ' . get_option('time_format'),
-                                            ($timestamp + (get_option('gmt_offset') * HOUR_IN_SECONDS))
-                                        )
-                                    ); ?>
+										date(
+											get_option('date_format') . ' ' . get_option('time_format'),
+											($timestamp + (get_option('gmt_offset') * HOUR_IN_SECONDS))
+										)
+									); ?>
                                 </td>
                                 <td class="jst-left"><?php
-                                    echo isset($delivered_message['message_type'])
-                                        ? esc_html($delivered_message['message_type'])
-                                        : ''; ?>
+									echo isset($delivered_message['message_type'])
+										? esc_html($delivered_message['message_type'])
+										: ''; ?>
                                 </td>
                                 <td class="jst-left"><?php
-                                    echo isset($delivered_message['pay_status'])
-                                        ? esc_html($delivered_message['pay_status'])
-                                        : ''; ?>
+									echo isset($delivered_message['pay_status'])
+										? esc_html($delivered_message['pay_status'])
+										: ''; ?>
                                 </td>
                                 <td class="jst-left"><?php
-                                    echo isset($delivered_message['txn_status'])
-                                        ? esc_html($delivered_message['txn_status'])
-                                        : ''; ?>
+									echo isset($delivered_message['txn_status'])
+										? esc_html($delivered_message['txn_status'])
+										: ''; ?>
                                 </td>
                             </tr>
                         <?php endforeach; // $delivered_messages?>
@@ -982,7 +982,7 @@ 
                 </table>
             </div>
             <?php
-        }
-    }
-    ?>
+		}
+	}
+	?>
 </div>

Spacing +11 added lines, -11 removed lines

@@ -110,7 +110,7 @@ 
                             <?php esc_html_e('ID', 'event_espresso'); ?>
                         </th>
                         <th class="txn-admin-payment-date-col jst-left">
-                            <?php esc_html_e('Date', 'event_espresso');?>
+                            <?php esc_html_e('Date', 'event_espresso'); ?>
                         </th>
                         <th class='jst-cntr'>
                             <?php esc_html_e('Amount', 'event_espresso'); ?>
@@ -140,12 +140,12 @@ 
                     <?php if ($payments) : ?>
                         <?php $payment_total = 0; ?>
                         <?php foreach ($payments as $PAY_ID => $payment) :
-                            if (! $payment instanceof EE_Payment) {
+                            if ( ! $payment instanceof EE_Payment) {
                                 continue;
                             }
                             $PAY_ID = absint($PAY_ID);
-                            $existing_reg_payment_json = isset($existing_reg_payments[ $PAY_ID ])
-                                ? wp_json_encode($existing_reg_payments[ $PAY_ID ])
+                            $existing_reg_payment_json = isset($existing_reg_payments[$PAY_ID])
+                                ? wp_json_encode($existing_reg_payments[$PAY_ID])
                                 : '{}';
                             $escaped_pay_id = esc_attr($PAY_ID);
                             ?>
@@ -175,7 +175,7 @@ 
                                 <td class=' jst-rght'>
                                     <?php
                                     $payment_class = $payment->amount() > 0
-                                        ? 'txn-admin-payment-status-' . $payment->STS_ID()
+                                        ? 'txn-admin-payment-status-'.$payment->STS_ID()
                                         : 'txn-admin-payment-status-PDC';
                                     ?>
                                     <span class="<?php echo esc_attr($payment_class); ?>">
@@ -274,10 +274,10 @@ 
                               . __('This transaction has been overpaid ! ', 'event_espresso')
                               . '</span>'
                             : '';
-                        echo $overpaid . esc_html(
+                        echo $overpaid.esc_html(
                             sprintf(
                                 __('Payments Total %s', 'event_espresso'),
-                                '(' . EE_Registry::instance()->CFG->currency->code . ')'
+                                '('.EE_Registry::instance()->CFG->currency->code.')'
                             )
                         ); ?>
                         </span>
@@ -411,7 +411,7 @@ 
             <h2 id="admin-modal-dialog-apply-payment-h2" class="admin-modal-dialog-h2 hdr-has-icon"
                 style="display:none;"
             >
-                <?php echo esc_html__('Apply a Payment to Transaction #', 'event_espresso') . esc_html($txn_nmbr['value']); ?>
+                <?php echo esc_html__('Apply a Payment to Transaction #', 'event_espresso').esc_html($txn_nmbr['value']); ?>
                 <span class='dashicons dashicons-money-alt'></span>
             </h2>
 
@@ -930,7 +930,7 @@ 
 
     <?php if (WP_DEBUG) {
         $delivered_messages = get_option('EED_Messages__payment', []);
-        if (isset($delivered_messages[ $TXN_ID ])) { ?>
+        if (isset($delivered_messages[$TXN_ID])) { ?>
             <h4 class="admin-primary-mbox-h4 hdr-has-icon">
                 <?php esc_html_e('Messages Sent to Primary Registrant', 'event_espresso'); ?>
                 <span class="dashicons dashicons-email-alt"></span>
@@ -950,13 +950,13 @@ 
                     </thead>
                     <tbody>
                         <?php
-                        foreach ($delivered_messages[ $TXN_ID ] as $timestamp => $delivered_message) :
+                        foreach ($delivered_messages[$TXN_ID] as $timestamp => $delivered_message) :
                             ?>
                             <tr>
                                 <td class="jst-left">
                                     <?php echo esc_html(
                                         date(
-                                            get_option('date_format') . ' ' . get_option('time_format'),
+                                            get_option('date_format').' '.get_option('time_format'),
                                             ($timestamp + (get_option('gmt_offset') * HOUR_IN_SECONDS))
                                         )
                                     ); ?>