eventespresso / event-espresso-core

widgets/upcoming_events/EEW_Upcoming_Events.widget.php

Indentation +623 added lines, -623 removed lines

@@ -14,109 +14,109 @@ 
  */
 class EEW_Upcoming_Events extends EspressoWidget
 {
-    /**
-     * @var string
-     */
-    private $title;
-    /**
-     * @var string
-     */
-    private $events_category;
-
-    /**
-     * @var bool
-     */
-    private $show_expired;
-
-    /**
-     * @var string
-     */
-    private $image_size;
-
-    /**
-     * @var bool
-     */
-    private $show_desc;
-
-    /**
-     * @var bool
-     */
-    private $show_dates;
-
-    /**
-     * @var string
-     */
-    private $date_limit;
-
-    /**
-     * @var string
-     */
-    private $date_range;
-
-    /**
-     * @var string
-     */
-    private $limit;
-
-    /**
-     * @var string
-     */
-    private $order;
-
-
-    /**
-     * Register widget with WordPress.
-     */
-    public function __construct()
-    {
-        parent::__construct(
-            esc_html__('Event Espresso Upcoming Events', 'event_espresso'),
-            ['description' => esc_html__('A widget to display your upcoming events.', 'event_espresso')]
-        );
-    }
-
-
-    /**
-     * Back-end widget form.
-     *
-     * @param array $instance Previously saved values from database.
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @see WP_Widget::form()
-     */
-    public function form($instance)
-    {
-
-        EE_Registry::instance()->load_class('Question_Option', [], false, false, true);
-        // Set up some default widget settings.
-        $defaults = [
-            'title'           => esc_html__('Upcoming Events', 'event_espresso'),
-            'category_name'   => '',
-            'show_expired'    => 0,
-            'show_desc'       => true,
-            'show_dates'      => true,
-            'show_everywhere' => false,
-            'date_limit'      => 2,
-            'limit'           => 10,
-            'sort'            => 'ASC',
-            'date_range'      => false,
-            'image_size'      => 'medium',
-        ];
-
-        $instance = wp_parse_args((array) $instance, $defaults);
-        // don't add HTML labels for EE_Form_Fields generated inputs
-        add_filter('FHEE__EEH_Form_Fields__label_html', '__return_empty_string');
-        $yes_no_values = [
-            EE_Question_Option::new_instance(['QSO_value' => false, 'QSO_desc' => esc_html__('No', 'event_espresso')]),
-            EE_Question_Option::new_instance(['QSO_value' => true, 'QSO_desc' => esc_html__('Yes', 'event_espresso')]),
-        ];
-        $sort_values   = [
-            EE_Question_Option::new_instance(['QSO_value' => 'ASC', 'QSO_desc' => esc_html__('ASC', 'event_espresso')]),
-            EE_Question_Option::new_instance(['QSO_value' => 'DESC', 'QSO_desc' => esc_html__('DESC', 'event_espresso')]),
-        ];
-
-        ?>
+	/**
+	 * @var string
+	 */
+	private $title;
+	/**
+	 * @var string
+	 */
+	private $events_category;
+
+	/**
+	 * @var bool
+	 */
+	private $show_expired;
+
+	/**
+	 * @var string
+	 */
+	private $image_size;
+
+	/**
+	 * @var bool
+	 */
+	private $show_desc;
+
+	/**
+	 * @var bool
+	 */
+	private $show_dates;
+
+	/**
+	 * @var string
+	 */
+	private $date_limit;
+
+	/**
+	 * @var string
+	 */
+	private $date_range;
+
+	/**
+	 * @var string
+	 */
+	private $limit;
+
+	/**
+	 * @var string
+	 */
+	private $order;
+
+
+	/**
+	 * Register widget with WordPress.
+	 */
+	public function __construct()
+	{
+		parent::__construct(
+			esc_html__('Event Espresso Upcoming Events', 'event_espresso'),
+			['description' => esc_html__('A widget to display your upcoming events.', 'event_espresso')]
+		);
+	}
+
+
+	/**
+	 * Back-end widget form.
+	 *
+	 * @param array $instance Previously saved values from database.
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @see WP_Widget::form()
+	 */
+	public function form($instance)
+	{
+
+		EE_Registry::instance()->load_class('Question_Option', [], false, false, true);
+		// Set up some default widget settings.
+		$defaults = [
+			'title'           => esc_html__('Upcoming Events', 'event_espresso'),
+			'category_name'   => '',
+			'show_expired'    => 0,
+			'show_desc'       => true,
+			'show_dates'      => true,
+			'show_everywhere' => false,
+			'date_limit'      => 2,
+			'limit'           => 10,
+			'sort'            => 'ASC',
+			'date_range'      => false,
+			'image_size'      => 'medium',
+		];
+
+		$instance = wp_parse_args((array) $instance, $defaults);
+		// don't add HTML labels for EE_Form_Fields generated inputs
+		add_filter('FHEE__EEH_Form_Fields__label_html', '__return_empty_string');
+		$yes_no_values = [
+			EE_Question_Option::new_instance(['QSO_value' => false, 'QSO_desc' => esc_html__('No', 'event_espresso')]),
+			EE_Question_Option::new_instance(['QSO_value' => true, 'QSO_desc' => esc_html__('Yes', 'event_espresso')]),
+		];
+		$sort_values   = [
+			EE_Question_Option::new_instance(['QSO_value' => 'ASC', 'QSO_desc' => esc_html__('ASC', 'event_espresso')]),
+			EE_Question_Option::new_instance(['QSO_value' => 'DESC', 'QSO_desc' => esc_html__('DESC', 'event_espresso')]),
+		];
+
+		?>
 
         <!-- Widget Title: Text Input -->
 
@@ -153,38 +153,38 @@ 
                 <?php esc_html_e('Show Expired Events:', 'event_espresso'); ?>
             </label>
             <?php
-            $show_expired_options   = $yes_no_values;
-            $show_expired_options[] = EE_Question_Option::new_instance(
-                ['QSO_value' => 2, 'QSO_desc' => esc_html__('Show Only Expired', 'event_espresso')]
-            );
-            echo wp_kses(
-                EEH_Form_Fields::select(
-                    esc_html__('Show Expired Events:', 'event_espresso'),
-                    $instance['show_expired'],
-                    $show_expired_options,
-                    $this->fieldName('show_expired'),
-                    $this->fieldID('show_expired')
-                ),
-                AllowedTags::getWithFormTags()
-            );
-            ?>
+			$show_expired_options   = $yes_no_values;
+			$show_expired_options[] = EE_Question_Option::new_instance(
+				['QSO_value' => 2, 'QSO_desc' => esc_html__('Show Only Expired', 'event_espresso')]
+			);
+			echo wp_kses(
+				EEH_Form_Fields::select(
+					esc_html__('Show Expired Events:', 'event_espresso'),
+					$instance['show_expired'],
+					$show_expired_options,
+					$this->fieldName('show_expired'),
+					$this->fieldID('show_expired')
+				),
+				AllowedTags::getWithFormTags()
+			);
+			?>
         </p>
         <p>
             <label for="<?php echo esc_attr($this->fieldID('sort')); ?>">
                 <?php esc_html_e('Sort Events:', 'event_espresso'); ?>
             </label>
             <?php
-            echo wp_kses(
-                EEH_Form_Fields::select(
-                    esc_html__('Sort Events:', 'event_espresso'),
-                    $instance['sort'],
-                    $sort_values,
-                    $this->fieldName('sort'),
-                    $this->fieldID('sort')
-                ),
-                AllowedTags::getWithFormTags()
-            );
-            ?>
+			echo wp_kses(
+				EEH_Form_Fields::select(
+					esc_html__('Sort Events:', 'event_espresso'),
+					$instance['sort'],
+					$sort_values,
+					$this->fieldName('sort'),
+					$this->fieldID('sort')
+				),
+				AllowedTags::getWithFormTags()
+			);
+			?>
         </p>
         <p>
             <label for="<?php echo esc_attr($this->fieldID('image_size')); ?>">
@@ -198,51 +198,51 @@ 
                 <?php esc_html_e('Show Description:', 'event_espresso'); ?>
             </label>
             <?php
-            echo wp_kses(
-                EEH_Form_Fields::select(
-                    esc_html__('Show Description:', 'event_espresso'),
-                    $instance['show_desc'],
-                    $yes_no_values,
-                    $this->fieldName('show_desc'),
-                    $this->fieldID('show_desc')
-                ),
-                AllowedTags::getWithFormTags()
-            );
-            ?>
+			echo wp_kses(
+				EEH_Form_Fields::select(
+					esc_html__('Show Description:', 'event_espresso'),
+					$instance['show_desc'],
+					$yes_no_values,
+					$this->fieldName('show_desc'),
+					$this->fieldID('show_desc')
+				),
+				AllowedTags::getWithFormTags()
+			);
+			?>
         </p>
         <p>
             <label for="<?php echo esc_attr($this->fieldID('show_dates')); ?>">
                 <?php esc_html_e('Show Dates:', 'event_espresso'); ?>
             </label>
             <?php
-            echo wp_kses(
-                EEH_Form_Fields::select(
-                    esc_html__('Show Dates:', 'event_espresso'),
-                    $instance['show_dates'],
-                    $yes_no_values,
-                    $this->fieldName('show_dates'),
-                    $this->fieldID('show_dates')
-                ),
-                AllowedTags::getWithFormTags()
-            );
-            ?>
+			echo wp_kses(
+				EEH_Form_Fields::select(
+					esc_html__('Show Dates:', 'event_espresso'),
+					$instance['show_dates'],
+					$yes_no_values,
+					$this->fieldName('show_dates'),
+					$this->fieldID('show_dates')
+				),
+				AllowedTags::getWithFormTags()
+			);
+			?>
         </p>
         <p>
             <label for="<?php echo esc_attr($this->fieldID('show_everywhere')); ?>">
                 <?php esc_html_e('Show on all Pages:', 'event_espresso'); ?>
             </label>
             <?php
-            echo wp_kses(
-                EEH_Form_Fields::select(
-                    esc_html__('Show on all Pages:', 'event_espresso'),
-                    $instance['show_everywhere'],
-                    $yes_no_values,
-                    $this->fieldName('show_everywhere'),
-                    $this->fieldID('show_everywhere')
-                ),
-                AllowedTags::getWithFormTags()
-            );
-            ?>
+			echo wp_kses(
+				EEH_Form_Fields::select(
+					esc_html__('Show on all Pages:', 'event_espresso'),
+					$instance['show_everywhere'],
+					$yes_no_values,
+					$this->fieldName('show_everywhere'),
+					$this->fieldID('show_everywhere')
+				),
+				AllowedTags::getWithFormTags()
+			);
+			?>
         </p>
         <p>
             <label for="<?php echo esc_attr($this->fieldID('date_limit')); ?>">
@@ -260,292 +260,292 @@ 
                 <?php esc_html_e('Show Date Range:', 'event_espresso'); ?>
             </label>
             <?php
-            echo wp_kses(
-                EEH_Form_Fields::select(
-                    esc_html__('Show Date Range:', 'event_espresso'),
-                    $instance['date_range'],
-                    $yes_no_values,
-                    $this->fieldName('date_range'),
-                    $this->fieldID('date_range')
-                ),
-                AllowedTags::getWithFormTags()
-            );
-            ?>
+			echo wp_kses(
+				EEH_Form_Fields::select(
+					esc_html__('Show Date Range:', 'event_espresso'),
+					$instance['date_range'],
+					$yes_no_values,
+					$this->fieldName('date_range'),
+					$this->fieldID('date_range')
+				),
+				AllowedTags::getWithFormTags()
+			);
+			?>
             <span class="description">
                 <br />
                 <?php esc_html_e(
-                    'This setting will replace the list of dates in the widget.',
-                    'event_espresso'
-                ); ?>
+					'This setting will replace the list of dates in the widget.',
+					'event_espresso'
+				); ?>
             </span>
         </p>
 
         <?php
-    }
-
-
-    /**
-     * Sanitize widget form values as they are saved.
-     *
-     * @param array $new_instance Values just sent to be saved.
-     * @param array $old_instance Previously saved values from database.
-     *
-     * @return array Updated safe values to be saved.
-     * @see WP_Widget::update()
-     *
-     */
-    public function update($new_instance, $old_instance)
-    {
-        /** @var EE_Capabilities $capabilities */
-        $capabilities = LoaderFactory::getLoader()->getShared(EE_Capabilities::class);
-        if (! $capabilities->current_user_can('manage_options', 'update-espresso-widget')) {
-            wp_die(esc_html__('You do not have the required privileges to perform this action', 'event_espresso'));
-        }
-        $instance                    = $old_instance;
-        $instance['title']           = ! empty($new_instance['title']) ? strip_tags((string) $new_instance['title']) : '';
-        $instance['category_name']   = $new_instance['category_name'];
-        $instance['show_expired']    = $new_instance['show_expired'];
-        $instance['limit']           = $new_instance['limit'];
-        $instance['sort']            = $new_instance['sort'];
-        $instance['image_size']      = $new_instance['image_size'];
-        $instance['show_desc']       = $new_instance['show_desc'];
-        $instance['show_dates']      = $new_instance['show_dates'];
-        $instance['show_everywhere'] = $new_instance['show_everywhere'];
-        $instance['date_limit']      = $new_instance['date_limit'];
-        $instance['date_range']      = $new_instance['date_range'];
-        return $instance;
-    }
-
-
-    /**
-     * Front-end display of widget.
-     *
-     * @param array $args     Widget arguments.
-     * @param array $instance Saved values from database.
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @see WP_Widget::widget()
-     *
-     */
-    public function widget($args, $instance)
-    {
-
-        global $post;
-        // make sure there is some kinda post object
-        if ($post instanceof WP_Post) {
-            $before_widget = '';
-            $before_title  = '';
-            $after_title   = '';
-            $after_widget  = '';
-            // but NOT an events archives page, cuz that would be like two event lists on the same page
-            $show_everywhere = ! isset($instance['show_everywhere']) || absint($instance['show_everywhere']);
-            if ($show_everywhere || ! ($post->post_type == EspressoPostType::EVENTS && is_archive())) {
-                // let's use some of the event helper functions'
-                // make separate vars out of attributes
-                extract($args);
-
-                // grab widget settings
-                $this->parseWidgetSettings($instance);
-                $title = $this->widgetTitle();
-
-                // Before widget (defined by themes).
-                echo wp_kses($before_widget, AllowedTags::getAllowedTags());
-                // Display the widget title if one was input (before and after defined by themes).
-                if (! empty($title)) {
-                    echo wp_kses($before_title . $title . $after_title, AllowedTags::getAllowedTags());
-                }
-                echo wp_kses($this->widgetContent($post), AllowedTags::getWithFormTags());
-                // After widget (defined by themes).
-                echo wp_kses($after_widget, AllowedTags::getAllowedTags());
-            }
-        }
-    }
-
-
-    /**
-     * make_the_title_a_link
-     * callback for widget_title filter
-     *
-     * @param $title
-     * @return string
-     */
-    public function make_the_title_a_link($title)
-    {
-        return '<a href="' . EEH_Event_View::event_archive_url() . '">' . $title . '</a>';
-    }
-
-
-    /**
-     * @param string $field_name
-     * @return string
-     * @since   4.10.14.p
-     */
-    public function fieldID($field_name)
-    {
-        return parent::get_field_id($field_name);
-    }
-
-
-    /**
-     * @param string $field_name
-     * @return string
-     * @since   4.10.14.p
-     */
-    public function fieldName($field_name)
-    {
-        return parent::get_field_name($field_name);
-    }
-
-
-    /**
-     * @param array $instance
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since   4.10.14.p
-     */
-    private function eventCategoriesSelector(array $instance)
-    {
-        $event_categories = [];
-        $categories       = EEM_Term::instance()->get_all_ee_categories(true);
-        if ($categories) {
-            foreach ($categories as $category) {
-                if ($category instanceof EE_Term) {
-                    $event_categories[] =
-                        EE_Question_Option::new_instance(
-                            [
-                                'QSO_value' => $category->get('slug'),
-                                'QSO_desc'  => $category->get('name'),
-                            ]
-                        );
-                }
-            }
-        }
-        array_unshift(
-            $event_categories,
-            EE_Question_Option::new_instance(
-                [
-                    'QSO_value' => '',
-                    'QSO_desc'  => esc_html__(' - display all - ', 'event_espresso'),
-                ]
-            )
-        );
-        echo wp_kses(
-            EEH_Form_Fields::select(
-                esc_html__('Event Category:', 'event_espresso'),
-                $instance['category_name'],
-                $event_categories,
-                $this->fieldName('category_name'),
-                $this->fieldID('category_name')
-            ),
-            AllowedTags::getWithFormTags()
-        );
-    }
-
-
-    /**
-     * @param array $instance
-     * @since   4.10.14.p
-     */
-    private function imageSizeSelector(array $instance)
-    {
-        $image_sizes = [];
-        $sizes       = get_intermediate_image_sizes();
-        if ($sizes) {
-            // loop thru images and create option objects out of them
-            foreach ($sizes as $image_size) {
-                $image_size = trim($image_size);
-                // no big images plz
-                if (! in_array($image_size, ['large', 'post-thumbnail'])) {
-                    $image_sizes[] =
-                        EE_Question_Option::new_instance(['QSO_value' => $image_size, 'QSO_desc' => $image_size]);
-                }
-            }
-            $image_sizes[] =
-                EE_Question_Option::new_instance(
-                    ['QSO_value' => 'none', 'QSO_desc' => esc_html__('don\'t show images', 'event_espresso')]
-                );
-        }
-        echo wp_kses(
-            EEH_Form_Fields::select(
-                esc_html__('Image Size:', 'event_espresso'),
-                $instance['image_size'],
-                $image_sizes,
-                $this->fieldName('image_size'),
-                $this->fieldID('image_size')
-            ),
-            AllowedTags::getWithFormTags()
-        );
-    }
-
-
-    /**
-     * @param array $instance
-     * @since   4.10.14.p
-     */
-    private function parseWidgetSettings(array $instance)
-    {
-        $this->title = isset($instance['title']) && ! empty($instance['title']) ? $instance['title'] : '';
-        $this->events_category     = isset($instance['category_name']) && ! empty($instance['category_name'])
-            ? $instance['category_name']
-            : false;
-        $this->show_expired = isset($instance['show_expired'])
-            ? filter_var($instance['show_expired'], FILTER_VALIDATE_BOOLEAN)
-            : 0;
-        $this->image_size   = isset($instance['image_size']) && ! empty($instance['image_size'])
-            ? $instance['image_size']
-            : 'medium';
-        $this->show_desc    = ! isset($instance['show_desc'])
-                              || filter_var($instance['show_desc'], FILTER_VALIDATE_BOOLEAN);
-        $this->show_dates   = ! isset($instance['show_dates'])
-                              || filter_var($instance['show_dates'], FILTER_VALIDATE_BOOLEAN);
-        $this->date_limit   = isset($instance['date_limit']) && ! empty($instance['date_limit'])
-            ? $instance['date_limit']
-            : null;
-        $this->date_range   = isset($instance['date_range']) && ! empty($instance['date_range'])
-            ? $instance['date_range']
-            : false;
-        $this->limit        = isset($instance['limit']) ? absint($instance['limit']) : 10;
-        $this->order        = isset($instance['sort']) && $instance['sort'] === 'DESC'
-            ? 'DESC'
-            : 'ASC';
-    }
-
-
-    /**
-     * @return mixed|void
-     * @since   4.10.14.p
-     */
-    private function widgetTitle()
-    {
-        // add function to make the title a link
-        add_filter('widget_title', [$this, 'make_the_title_a_link'], 15);
-        // filter the title
-        $title = apply_filters('widget_title', $this->title);
-        // remove the function from the filter, so it does not affect other widgets
-        remove_filter('widget_title', [$this, 'make_the_title_a_link'], 15);
-        return $title;
-    }
-
-
-    /**
-     * @param WP_Post $post
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since   4.10.14.p
-     */
-    private function widgetContent(WP_Post $post)
-    {
-        // run the query
-        $events = $this->getUpcomingEvents();
-        if (empty($events)) {
-            return '';
-        }
-        $list_items = '';
-        foreach ($events as $event) {
-            if ($event instanceof EE_Event && (! is_single() || $post->ID != $event->ID())) {
-                $event_url = $this->eventUrl($event);
-                $list_items .= '
+	}
+
+
+	/**
+	 * Sanitize widget form values as they are saved.
+	 *
+	 * @param array $new_instance Values just sent to be saved.
+	 * @param array $old_instance Previously saved values from database.
+	 *
+	 * @return array Updated safe values to be saved.
+	 * @see WP_Widget::update()
+	 *
+	 */
+	public function update($new_instance, $old_instance)
+	{
+		/** @var EE_Capabilities $capabilities */
+		$capabilities = LoaderFactory::getLoader()->getShared(EE_Capabilities::class);
+		if (! $capabilities->current_user_can('manage_options', 'update-espresso-widget')) {
+			wp_die(esc_html__('You do not have the required privileges to perform this action', 'event_espresso'));
+		}
+		$instance                    = $old_instance;
+		$instance['title']           = ! empty($new_instance['title']) ? strip_tags((string) $new_instance['title']) : '';
+		$instance['category_name']   = $new_instance['category_name'];
+		$instance['show_expired']    = $new_instance['show_expired'];
+		$instance['limit']           = $new_instance['limit'];
+		$instance['sort']            = $new_instance['sort'];
+		$instance['image_size']      = $new_instance['image_size'];
+		$instance['show_desc']       = $new_instance['show_desc'];
+		$instance['show_dates']      = $new_instance['show_dates'];
+		$instance['show_everywhere'] = $new_instance['show_everywhere'];
+		$instance['date_limit']      = $new_instance['date_limit'];
+		$instance['date_range']      = $new_instance['date_range'];
+		return $instance;
+	}
+
+
+	/**
+	 * Front-end display of widget.
+	 *
+	 * @param array $args     Widget arguments.
+	 * @param array $instance Saved values from database.
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @see WP_Widget::widget()
+	 *
+	 */
+	public function widget($args, $instance)
+	{
+
+		global $post;
+		// make sure there is some kinda post object
+		if ($post instanceof WP_Post) {
+			$before_widget = '';
+			$before_title  = '';
+			$after_title   = '';
+			$after_widget  = '';
+			// but NOT an events archives page, cuz that would be like two event lists on the same page
+			$show_everywhere = ! isset($instance['show_everywhere']) || absint($instance['show_everywhere']);
+			if ($show_everywhere || ! ($post->post_type == EspressoPostType::EVENTS && is_archive())) {
+				// let's use some of the event helper functions'
+				// make separate vars out of attributes
+				extract($args);
+
+				// grab widget settings
+				$this->parseWidgetSettings($instance);
+				$title = $this->widgetTitle();
+
+				// Before widget (defined by themes).
+				echo wp_kses($before_widget, AllowedTags::getAllowedTags());
+				// Display the widget title if one was input (before and after defined by themes).
+				if (! empty($title)) {
+					echo wp_kses($before_title . $title . $after_title, AllowedTags::getAllowedTags());
+				}
+				echo wp_kses($this->widgetContent($post), AllowedTags::getWithFormTags());
+				// After widget (defined by themes).
+				echo wp_kses($after_widget, AllowedTags::getAllowedTags());
+			}
+		}
+	}
+
+
+	/**
+	 * make_the_title_a_link
+	 * callback for widget_title filter
+	 *
+	 * @param $title
+	 * @return string
+	 */
+	public function make_the_title_a_link($title)
+	{
+		return '<a href="' . EEH_Event_View::event_archive_url() . '">' . $title . '</a>';
+	}
+
+
+	/**
+	 * @param string $field_name
+	 * @return string
+	 * @since   4.10.14.p
+	 */
+	public function fieldID($field_name)
+	{
+		return parent::get_field_id($field_name);
+	}
+
+
+	/**
+	 * @param string $field_name
+	 * @return string
+	 * @since   4.10.14.p
+	 */
+	public function fieldName($field_name)
+	{
+		return parent::get_field_name($field_name);
+	}
+
+
+	/**
+	 * @param array $instance
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since   4.10.14.p
+	 */
+	private function eventCategoriesSelector(array $instance)
+	{
+		$event_categories = [];
+		$categories       = EEM_Term::instance()->get_all_ee_categories(true);
+		if ($categories) {
+			foreach ($categories as $category) {
+				if ($category instanceof EE_Term) {
+					$event_categories[] =
+						EE_Question_Option::new_instance(
+							[
+								'QSO_value' => $category->get('slug'),
+								'QSO_desc'  => $category->get('name'),
+							]
+						);
+				}
+			}
+		}
+		array_unshift(
+			$event_categories,
+			EE_Question_Option::new_instance(
+				[
+					'QSO_value' => '',
+					'QSO_desc'  => esc_html__(' - display all - ', 'event_espresso'),
+				]
+			)
+		);
+		echo wp_kses(
+			EEH_Form_Fields::select(
+				esc_html__('Event Category:', 'event_espresso'),
+				$instance['category_name'],
+				$event_categories,
+				$this->fieldName('category_name'),
+				$this->fieldID('category_name')
+			),
+			AllowedTags::getWithFormTags()
+		);
+	}
+
+
+	/**
+	 * @param array $instance
+	 * @since   4.10.14.p
+	 */
+	private function imageSizeSelector(array $instance)
+	{
+		$image_sizes = [];
+		$sizes       = get_intermediate_image_sizes();
+		if ($sizes) {
+			// loop thru images and create option objects out of them
+			foreach ($sizes as $image_size) {
+				$image_size = trim($image_size);
+				// no big images plz
+				if (! in_array($image_size, ['large', 'post-thumbnail'])) {
+					$image_sizes[] =
+						EE_Question_Option::new_instance(['QSO_value' => $image_size, 'QSO_desc' => $image_size]);
+				}
+			}
+			$image_sizes[] =
+				EE_Question_Option::new_instance(
+					['QSO_value' => 'none', 'QSO_desc' => esc_html__('don\'t show images', 'event_espresso')]
+				);
+		}
+		echo wp_kses(
+			EEH_Form_Fields::select(
+				esc_html__('Image Size:', 'event_espresso'),
+				$instance['image_size'],
+				$image_sizes,
+				$this->fieldName('image_size'),
+				$this->fieldID('image_size')
+			),
+			AllowedTags::getWithFormTags()
+		);
+	}
+
+
+	/**
+	 * @param array $instance
+	 * @since   4.10.14.p
+	 */
+	private function parseWidgetSettings(array $instance)
+	{
+		$this->title = isset($instance['title']) && ! empty($instance['title']) ? $instance['title'] : '';
+		$this->events_category     = isset($instance['category_name']) && ! empty($instance['category_name'])
+			? $instance['category_name']
+			: false;
+		$this->show_expired = isset($instance['show_expired'])
+			? filter_var($instance['show_expired'], FILTER_VALIDATE_BOOLEAN)
+			: 0;
+		$this->image_size   = isset($instance['image_size']) && ! empty($instance['image_size'])
+			? $instance['image_size']
+			: 'medium';
+		$this->show_desc    = ! isset($instance['show_desc'])
+							  || filter_var($instance['show_desc'], FILTER_VALIDATE_BOOLEAN);
+		$this->show_dates   = ! isset($instance['show_dates'])
+							  || filter_var($instance['show_dates'], FILTER_VALIDATE_BOOLEAN);
+		$this->date_limit   = isset($instance['date_limit']) && ! empty($instance['date_limit'])
+			? $instance['date_limit']
+			: null;
+		$this->date_range   = isset($instance['date_range']) && ! empty($instance['date_range'])
+			? $instance['date_range']
+			: false;
+		$this->limit        = isset($instance['limit']) ? absint($instance['limit']) : 10;
+		$this->order        = isset($instance['sort']) && $instance['sort'] === 'DESC'
+			? 'DESC'
+			: 'ASC';
+	}
+
+
+	/**
+	 * @return mixed|void
+	 * @since   4.10.14.p
+	 */
+	private function widgetTitle()
+	{
+		// add function to make the title a link
+		add_filter('widget_title', [$this, 'make_the_title_a_link'], 15);
+		// filter the title
+		$title = apply_filters('widget_title', $this->title);
+		// remove the function from the filter, so it does not affect other widgets
+		remove_filter('widget_title', [$this, 'make_the_title_a_link'], 15);
+		return $title;
+	}
+
+
+	/**
+	 * @param WP_Post $post
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since   4.10.14.p
+	 */
+	private function widgetContent(WP_Post $post)
+	{
+		// run the query
+		$events = $this->getUpcomingEvents();
+		if (empty($events)) {
+			return '';
+		}
+		$list_items = '';
+		foreach ($events as $event) {
+			if ($event instanceof EE_Event && (! is_single() || $post->ID != $event->ID())) {
+				$event_url = $this->eventUrl($event);
+				$list_items .= '
                 <li id="ee-upcoming-events-widget-li-' . absint($event->ID()) . '"
                     class="ee-upcoming-events-widget-li"
                 >
@@ -556,194 +556,194 @@ 
                     </h5>
                     ' . $this->eventWidgetContent($event, $event_url) . '
                 </li>';
-            }
-        }
-        return '
+			}
+		}
+		return '
             <ul class="ee-upcoming-events-widget-ul">
                 ' . $list_items . '
             </ul>';
-    }
-
-
-    /**
-     * @param EE_Event $event
-     * @return string|null
-     * @throws EE_Error
-     * @since   4.10.14.p
-     */
-    private function eventUrl(EE_Event $event)
-    {
-        return esc_url_raw(
-            apply_filters(
-                'FHEE_EEW_Upcoming_Events__widget__event_url',
-                $event->get_permalink(),
-                $event
-            )
-        );
-    }
-
-
-    /**
-     * @return EE_Base_Class[]
-     * @throws EE_Error
-     */
-    private function getUpcomingEvents()
-    {
-        return EEM_Event::instance()->get_all(
-            [
-                $this->queryWhereParams(),
-                'limit'    => '0,' . $this->limit,
-                'order_by' => 'Datetime.DTT_EVT_start',
-                'order'    => $this->order,
-                'group_by' => 'EVT_ID',
-            ]
-        );
-    }
-
-
-    /**
-     * @return mixed|void
-     * @throws EE_Error
-     * @since   4.10.14.p
-     */
-    private function queryWhereParams()
-    {
-        // start to build our where clause
-        $where = [
-            'status' => ['IN', ['publish', 'sold_out']],
-        ];
-        // add category
-        if ($this->events_category) {
-            $where['Term_Taxonomy.taxonomy']  = 'espresso_event_categories';
-            $where['Term_Taxonomy.Term.slug'] = $this->events_category;
-        }
-        // if NOT expired then we want events that start today or in the future
-        // if NOT show expired then we want events that start today or in the future
-        if ($this->show_expired == 0) {
-            $where['Datetime.DTT_EVT_end'] = [
-                '>=',
-                EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
-            ];
-        }
-        // if show ONLY expired we want events that ended prior to today
-        if ($this->show_expired == 2) {
-            $where['Datetime.DTT_EVT_end'] = [
-                '<=',
-                EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'),
-            ];
-        }
-        // allow $where to be filtered
-        return apply_filters('FHEE__EEW_Upcoming_Events__widget__where', $where, $this->events_category, $this->show_expired);
-    }
-
-
-    /**
-     * @param EE_Event $event
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since   4.10.14.p
-     */
-    private function linkClass(EE_Event $event)
-    {
-        // how big is the event name ?
-        $name_length = strlen($event->name());
-        switch ($name_length) {
-            case $name_length > 70:
-                return ' three-line';
-            case $name_length > 35:
-                return ' two-line';
-        }
-        return ' one-line';
-    }
-
-
-    /**
-     * @param EE_Event $event
-     * @param string   $event_url
-     * @return mixed|string|void
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since   4.10.14.p
-     */
-    private function eventWidgetContent(EE_Event $event, $event_url = '')
-    {
-        if (post_password_required($event->ID())) {
-            return apply_filters(
-                'FHEE_EEW_Upcoming_Events__widget__password_form',
-                get_the_password_form($event->ID()),
-                $event
-            );
-        }
-
-        $content = '';
-        if (has_post_thumbnail($event->ID()) && $this->image_size != 'none') {
-            $content .= '
+	}
+
+
+	/**
+	 * @param EE_Event $event
+	 * @return string|null
+	 * @throws EE_Error
+	 * @since   4.10.14.p
+	 */
+	private function eventUrl(EE_Event $event)
+	{
+		return esc_url_raw(
+			apply_filters(
+				'FHEE_EEW_Upcoming_Events__widget__event_url',
+				$event->get_permalink(),
+				$event
+			)
+		);
+	}
+
+
+	/**
+	 * @return EE_Base_Class[]
+	 * @throws EE_Error
+	 */
+	private function getUpcomingEvents()
+	{
+		return EEM_Event::instance()->get_all(
+			[
+				$this->queryWhereParams(),
+				'limit'    => '0,' . $this->limit,
+				'order_by' => 'Datetime.DTT_EVT_start',
+				'order'    => $this->order,
+				'group_by' => 'EVT_ID',
+			]
+		);
+	}
+
+
+	/**
+	 * @return mixed|void
+	 * @throws EE_Error
+	 * @since   4.10.14.p
+	 */
+	private function queryWhereParams()
+	{
+		// start to build our where clause
+		$where = [
+			'status' => ['IN', ['publish', 'sold_out']],
+		];
+		// add category
+		if ($this->events_category) {
+			$where['Term_Taxonomy.taxonomy']  = 'espresso_event_categories';
+			$where['Term_Taxonomy.Term.slug'] = $this->events_category;
+		}
+		// if NOT expired then we want events that start today or in the future
+		// if NOT show expired then we want events that start today or in the future
+		if ($this->show_expired == 0) {
+			$where['Datetime.DTT_EVT_end'] = [
+				'>=',
+				EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
+			];
+		}
+		// if show ONLY expired we want events that ended prior to today
+		if ($this->show_expired == 2) {
+			$where['Datetime.DTT_EVT_end'] = [
+				'<=',
+				EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'),
+			];
+		}
+		// allow $where to be filtered
+		return apply_filters('FHEE__EEW_Upcoming_Events__widget__where', $where, $this->events_category, $this->show_expired);
+	}
+
+
+	/**
+	 * @param EE_Event $event
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since   4.10.14.p
+	 */
+	private function linkClass(EE_Event $event)
+	{
+		// how big is the event name ?
+		$name_length = strlen($event->name());
+		switch ($name_length) {
+			case $name_length > 70:
+				return ' three-line';
+			case $name_length > 35:
+				return ' two-line';
+		}
+		return ' one-line';
+	}
+
+
+	/**
+	 * @param EE_Event $event
+	 * @param string   $event_url
+	 * @return mixed|string|void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since   4.10.14.p
+	 */
+	private function eventWidgetContent(EE_Event $event, $event_url = '')
+	{
+		if (post_password_required($event->ID())) {
+			return apply_filters(
+				'FHEE_EEW_Upcoming_Events__widget__password_form',
+				get_the_password_form($event->ID()),
+				$event
+			);
+		}
+
+		$content = '';
+		if (has_post_thumbnail($event->ID()) && $this->image_size != 'none') {
+			$content .= '
                 <div class="ee-upcoming-events-widget-img-dv">
                     <a class="ee-upcoming-events-widget-img" href="' . $event_url . '">
                         ' . get_the_post_thumbnail($event->ID(), $this->image_size) . '
                     </a>
                 </div>';
-        }
-
-        if ($this->show_dates) {
-            $content .= $this->eventDates($event);
-        }
-
-        if ($this->show_desc) {
-            $allowedtags = AllowedTags::getAllowedTags();
-            $desc    = $event->short_description(25);
-            $content .= $desc ? '<p style="margin-top: .5em">' . wp_kses($desc, $allowedtags) . '</p>' : '';
-        }
-
-        return $content;
-    }
-
-
-    /**
-     * @param EE_Event $event
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since   4.10.14.p
-     */
-    private function eventDates(EE_Event $event)
-    {
-        $date_format        = apply_filters(
-            'FHEE__espresso_event_date_range__date_format',
-            get_option('date_format')
-        );
-        $time_format        = apply_filters(
-            'FHEE__espresso_event_date_range__time_format',
-            get_option('time_format')
-        );
-        $single_date_format = apply_filters(
-            'FHEE__espresso_event_date_range__single_date_format',
-            get_option('date_format')
-        );
-        $single_time_format = apply_filters(
-            'FHEE__espresso_event_date_range__single_time_format',
-            get_option('time_format')
-        );
-        if ($this->date_range == true) {
-            return espresso_event_date_range(
-                $date_format,
-                $time_format,
-                $single_date_format,
-                $single_time_format,
-                $event->ID(),
-                false
-            );
-        }
-        return espresso_list_of_event_dates(
-            $event->ID(),
-            $date_format,
-            $time_format,
-            false,
-            null,
-            true,
-            true,
-            $this->date_limit
-        );
-    }
+		}
+
+		if ($this->show_dates) {
+			$content .= $this->eventDates($event);
+		}
+
+		if ($this->show_desc) {
+			$allowedtags = AllowedTags::getAllowedTags();
+			$desc    = $event->short_description(25);
+			$content .= $desc ? '<p style="margin-top: .5em">' . wp_kses($desc, $allowedtags) . '</p>' : '';
+		}
+
+		return $content;
+	}
+
+
+	/**
+	 * @param EE_Event $event
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since   4.10.14.p
+	 */
+	private function eventDates(EE_Event $event)
+	{
+		$date_format        = apply_filters(
+			'FHEE__espresso_event_date_range__date_format',
+			get_option('date_format')
+		);
+		$time_format        = apply_filters(
+			'FHEE__espresso_event_date_range__time_format',
+			get_option('time_format')
+		);
+		$single_date_format = apply_filters(
+			'FHEE__espresso_event_date_range__single_date_format',
+			get_option('date_format')
+		);
+		$single_time_format = apply_filters(
+			'FHEE__espresso_event_date_range__single_time_format',
+			get_option('time_format')
+		);
+		if ($this->date_range == true) {
+			return espresso_event_date_range(
+				$date_format,
+				$time_format,
+				$single_date_format,
+				$single_time_format,
+				$event->ID(),
+				false
+			);
+		}
+		return espresso_list_of_event_dates(
+			$event->ID(),
+			$date_format,
+			$time_format,
+			false,
+			null,
+			true,
+			true,
+			$this->date_limit
+		);
+	}
 }

Spacing +20 added lines, -20 removed lines

@@ -111,7 +111,7 @@ 
             EE_Question_Option::new_instance(['QSO_value' => false, 'QSO_desc' => esc_html__('No', 'event_espresso')]),
             EE_Question_Option::new_instance(['QSO_value' => true, 'QSO_desc' => esc_html__('Yes', 'event_espresso')]),
         ];
-        $sort_values   = [
+        $sort_values = [
             EE_Question_Option::new_instance(['QSO_value' => 'ASC', 'QSO_desc' => esc_html__('ASC', 'event_espresso')]),
             EE_Question_Option::new_instance(['QSO_value' => 'DESC', 'QSO_desc' => esc_html__('DESC', 'event_espresso')]),
         ];
@@ -298,7 +298,7 @@ 
     {
         /** @var EE_Capabilities $capabilities */
         $capabilities = LoaderFactory::getLoader()->getShared(EE_Capabilities::class);
-        if (! $capabilities->current_user_can('manage_options', 'update-espresso-widget')) {
+        if ( ! $capabilities->current_user_can('manage_options', 'update-espresso-widget')) {
             wp_die(esc_html__('You do not have the required privileges to perform this action', 'event_espresso'));
         }
         $instance                    = $old_instance;
@@ -351,8 +351,8 @@ 
                 // Before widget (defined by themes).
                 echo wp_kses($before_widget, AllowedTags::getAllowedTags());
                 // Display the widget title if one was input (before and after defined by themes).
-                if (! empty($title)) {
-                    echo wp_kses($before_title . $title . $after_title, AllowedTags::getAllowedTags());
+                if ( ! empty($title)) {
+                    echo wp_kses($before_title.$title.$after_title, AllowedTags::getAllowedTags());
                 }
                 echo wp_kses($this->widgetContent($post), AllowedTags::getWithFormTags());
                 // After widget (defined by themes).
@@ -371,7 +371,7 @@ 
      */
     public function make_the_title_a_link($title)
     {
-        return '<a href="' . EEH_Event_View::event_archive_url() . '">' . $title . '</a>';
+        return '<a href="'.EEH_Event_View::event_archive_url().'">'.$title.'</a>';
     }
 
 
@@ -455,7 +455,7 @@ 
             foreach ($sizes as $image_size) {
                 $image_size = trim($image_size);
                 // no big images plz
-                if (! in_array($image_size, ['large', 'post-thumbnail'])) {
+                if ( ! in_array($image_size, ['large', 'post-thumbnail'])) {
                     $image_sizes[] =
                         EE_Question_Option::new_instance(['QSO_value' => $image_size, 'QSO_desc' => $image_size]);
                 }
@@ -485,7 +485,7 @@ 
     private function parseWidgetSettings(array $instance)
     {
         $this->title = isset($instance['title']) && ! empty($instance['title']) ? $instance['title'] : '';
-        $this->events_category     = isset($instance['category_name']) && ! empty($instance['category_name'])
+        $this->events_category = isset($instance['category_name']) && ! empty($instance['category_name'])
             ? $instance['category_name']
             : false;
         $this->show_expired = isset($instance['show_expired'])
@@ -543,24 +543,24 @@ 
         }
         $list_items = '';
         foreach ($events as $event) {
-            if ($event instanceof EE_Event && (! is_single() || $post->ID != $event->ID())) {
+            if ($event instanceof EE_Event && ( ! is_single() || $post->ID != $event->ID())) {
                 $event_url = $this->eventUrl($event);
                 $list_items .= '
-                <li id="ee-upcoming-events-widget-li-' . absint($event->ID()) . '"
+                <li id="ee-upcoming-events-widget-li-' . absint($event->ID()).'"
                     class="ee-upcoming-events-widget-li"
                 >
                     <h5 class="ee-upcoming-events-widget-title-h5">
-                        <a class="ee-widget-event-name-a' . $this->linkClass($event) . '" href="' . $event_url . '">
-                            ' . esc_html($event->name()) . '
+                        <a class="ee-widget-event-name-a' . $this->linkClass($event).'" href="'.$event_url.'">
+                            ' . esc_html($event->name()).'
                         </a>
                     </h5>
-                    ' . $this->eventWidgetContent($event, $event_url) . '
+                    ' . $this->eventWidgetContent($event, $event_url).'
                 </li>';
             }
         }
         return '
             <ul class="ee-upcoming-events-widget-ul">
-                ' . $list_items . '
+                ' . $list_items.'
             </ul>';
     }
 
@@ -592,7 +592,7 @@ 
         return EEM_Event::instance()->get_all(
             [
                 $this->queryWhereParams(),
-                'limit'    => '0,' . $this->limit,
+                'limit'    => '0,'.$this->limit,
                 'order_by' => 'Datetime.DTT_EVT_start',
                 'order'    => $this->order,
                 'group_by' => 'EVT_ID',
@@ -680,8 +680,8 @@ 
         if (has_post_thumbnail($event->ID()) && $this->image_size != 'none') {
             $content .= '
                 <div class="ee-upcoming-events-widget-img-dv">
-                    <a class="ee-upcoming-events-widget-img" href="' . $event_url . '">
-                        ' . get_the_post_thumbnail($event->ID(), $this->image_size) . '
+                    <a class="ee-upcoming-events-widget-img" href="' . $event_url.'">
+                        ' . get_the_post_thumbnail($event->ID(), $this->image_size).'
                     </a>
                 </div>';
         }
@@ -692,8 +692,8 @@ 
 
         if ($this->show_desc) {
             $allowedtags = AllowedTags::getAllowedTags();
-            $desc    = $event->short_description(25);
-            $content .= $desc ? '<p style="margin-top: .5em">' . wp_kses($desc, $allowedtags) . '</p>' : '';
+            $desc = $event->short_description(25);
+            $content .= $desc ? '<p style="margin-top: .5em">'.wp_kses($desc, $allowedtags).'</p>' : '';
         }
 
         return $content;
@@ -709,11 +709,11 @@ 
      */
     private function eventDates(EE_Event $event)
     {
-        $date_format        = apply_filters(
+        $date_format = apply_filters(
             'FHEE__espresso_event_date_range__date_format',
             get_option('date_format')
         );
-        $time_format        = apply_filters(
+        $time_format = apply_filters(
             'FHEE__espresso_event_date_range__time_format',
             get_option('time_format')
         );

espresso.php

Indentation +107 added lines, -107 removed lines

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

core/helpers/EEH_Form_Fields.helper.php

Indentation +2059 added lines, -2059 removed lines

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

Spacing +135 added lines, -135 removed lines

@@ -108,8 +108,8 @@ 
             $type           = $input_value['input'];
             $value          = $input_value['value'];
 
-            $id    = $form_id ? $form_id . '-' . $input_key : $input_key;
-            $class = $required ? 'required ' . $css_class : $css_class;
+            $id    = $form_id ? $form_id.'-'.$input_key : $input_key;
+            $class = $required ? 'required '.$css_class : $css_class;
 
             // what type of input are we dealing with ?
             switch ($type) {
@@ -161,8 +161,8 @@ 
             }
         } // end foreach( $input_vars as $input_key => $input_value )
 
-        if (! empty($inputs)) {
-            $glue   = "
+        if ( ! empty($inputs)) {
+            $glue = "
                 </li>
                 <li>
                     ";
@@ -175,7 +175,7 @@ 
             </ul>
             ";
         }
-        return $output . implode("\n", $hidden_inputs);
+        return $output.implode("\n", $hidden_inputs);
     }
 
 
@@ -256,7 +256,7 @@ 
             // generate label
             $label = ! empty($label) ? self::adminLabel($id, $label, $required) : '';
             // generate field name
-            $name = ! empty($unique_id) ? $field_name . '[' . $unique_id . ']' : $field_name;
+            $name = ! empty($unique_id) ? $field_name.'['.$unique_id.']' : $field_name;
 
             // we determine what we're building based on the type
             switch ($type) {
@@ -267,14 +267,14 @@ 
                         foreach ($value as $key => $val) {
                             $c_input .= self::adminMulti(
                                 $default,
-                                isset($classes[ $key ]) ? $classes[ $key ] : '',
-                                $field_name . '_' . $value,
+                                isset($classes[$key]) ? $classes[$key] : '',
+                                $field_name.'_'.$value,
                                 $name,
                                 $required,
                                 $tab_index,
                                 $type,
                                 $val,
-                                isset($labels[ $key ]) ? $labels[ $key ] : ''
+                                isset($labels[$key]) ? $labels[$key] : ''
                             );
                         }
                         $field = $c_input;
@@ -300,7 +300,7 @@ 
                 case 'select':
                     $options = [];
                     foreach ($value as $key => $val) {
-                        $options[ $val ] = isset($labels[ $key ]) ? $labels[ $key ] : '';
+                        $options[$val] = isset($labels[$key]) ? $labels[$key] : '';
                     }
                     $field = self::adminSelect($default, $class, $id, $name, $required, $tab_index, $options);
                     break;
@@ -326,7 +326,7 @@ 
                     $field = self::adminText($class, $id, $name, $required, $tab_index, $value);
             }
 
-            $form_fields[ $field_name ] = ['label' => $label, 'field' => $field . $extra_desc];
+            $form_fields[$field_name] = ['label' => $label, 'field' => $field.$extra_desc];
         }
 
         return $form_fields;
@@ -395,7 +395,7 @@ 
         }
         $label = esc_html($label);
         $label_class = self::appendInputSizeClass('', $label);
-        $label_class = $label_class ? ' class="' . $label_class . '"' : '';
+        $label_class = $label_class ? ' class="'.$label_class.'"' : '';
         return "
         <label for='$id'{$label_class}>
             {$input}
@@ -545,7 +545,7 @@ 
         $autosize = true
     ) {
         // if $values was submitted in the wrong format, convert it over
-        if (! empty($values) && (! array_key_exists(0, $values) || ! is_array($values[0]))) {
+        if ( ! empty($values) && ( ! array_key_exists(0, $values) || ! is_array($values[0]))) {
             $converted_values = [];
             foreach ($values as $id => $text) {
                 $converted_values[] = ['id' => $id, 'text' => $text];
@@ -554,19 +554,19 @@ 
         }
 
         $field =
-            '<select id="' . EEH_Formatter::ee_tep_output_string($name)
-            . '" name="' . EEH_Formatter::ee_tep_output_string($name)
+            '<select id="'.EEH_Formatter::ee_tep_output_string($name)
+            . '" name="'.EEH_Formatter::ee_tep_output_string($name)
             . '"';
 
         if (EEH_Formatter::ee_tep_not_null($parameters)) {
-            $field .= ' ' . $parameters;
+            $field .= ' '.$parameters;
         }
         $class = $autosize ? self::appendInputSizeClass($class, $values) : '';
 
-        $field .= ' class="' . $class . '">';
+        $field .= ' class="'.$class.'">';
 
-        if (empty($default) && isset($GLOBALS[ $name ])) {
-            $default = stripslashes($GLOBALS[ $name ]);
+        if (empty($default) && isset($GLOBALS[$name])) {
+            $default = stripslashes($GLOBALS[$name]);
         }
 
         $field .= self::selectInputOption($values, $default);
@@ -582,7 +582,7 @@ 
             $id = is_scalar($values['id']) ? $values['id'] : '';
             $text = is_scalar($values['text']) ? $values['text'] : '';
             $selected = $default == $values['id'] ? ' selected = "selected"' : '';
-            $html_class = isset($values['class']) ? ' class="' . $values['class'] . '"' : '';
+            $html_class = isset($values['class']) ? ' class="'.$values['class'].'"' : '';
             return "<option value='{$id}'{$selected}{$html_class}>{$text}</option>";
         }
         $options = '';
@@ -612,7 +612,7 @@ 
             return $chars;
         }
         // not a primitive? return something big
-        if (! is_scalar($value)) {
+        if ( ! is_scalar($value)) {
             return 500;
         }
         return strlen((string) $value);
@@ -662,11 +662,11 @@ 
         $after_question_group_questions  =
             apply_filters('FHEE__EEH_Form_Fields__generate_question_groups_html__after_question_group_questions', '');
 
-        if (! empty($question_groups)) {
+        if ( ! empty($question_groups)) {
             // loop thru question groups
             foreach ($question_groups as $QSG) {
                 // check that questions exist
-                if (! empty($QSG['QSG_questions'])) {
+                if ( ! empty($QSG['QSG_questions'])) {
                     // use fieldsets
                     $html .= "\n\t"
                              . '<'
@@ -691,7 +691,7 @@ 
                     $html .= $before_question_group_questions;
                     // loop thru questions
                     foreach ($QSG['QSG_questions'] as $question) {
-                        $QFI  = new EE_Question_Form_Input(
+                        $QFI = new EE_Question_Form_Input(
                             $question['qst_obj'],
                             $question['ans_obj'],
                             $question
@@ -699,7 +699,7 @@ 
                         $html .= self::generate_form_input($QFI);
                     }
                     $html .= $after_question_group_questions;
-                    $html .= "\n\t" . '</' . $group_wrapper . '>';
+                    $html .= "\n\t".'</'.$group_wrapper.'>';
                 }
             }
         }
@@ -739,25 +739,25 @@ 
             'input_id'    => '',
             'input_class' => '',
         ];
-        $q_meta         = array_merge($default_q_meta, $q_meta);
+        $q_meta = array_merge($default_q_meta, $q_meta);
 
-        if (! empty($question_groups)) {
+        if ( ! empty($question_groups)) {
             // loop thru question groups
             foreach ($question_groups as $QSG) {
                 if ($QSG instanceof EE_Question_Group) {
                     // check that questions exist
 
                     $where = ['QST_deleted' => 0];
-                    if (! $from_admin) {
+                    if ( ! $from_admin) {
                         $where['QST_admin_only'] = 0;
                     }
                     $questions =
                         $QSG->questions([$where, 'order_by' => ['Question_Group_Question.QGQ_order' => 'ASC']]);
-                    if (! empty($questions)) {
+                    if ( ! empty($questions)) {
                         // use fieldsets
                         $html .= "\n\t"
-                                 . '<' . $group_wrapper . ' class="espresso-question-group-wrap" '
-                                 . 'id="' . $QSG->get('QSG_identifier') . '">';
+                                 . '<'.$group_wrapper.' class="espresso-question-group-wrap" '
+                                 . 'id="'.$QSG->get('QSG_identifier').'">';
                         // group_name
                         if ($QSG->show_group_name()) {
                             $html .= "\n\t\t"
@@ -782,21 +782,21 @@ 
                             /** @var RequestInterface $request */
                             $request      = LoaderFactory::getLoader()->getShared(RequestInterface::class);
                             $request_qstn = $request->getRequestParam('qstn', [], 'string', true);
-                            if (! empty($request_qstn) && isset($q_meta['input_id']) && isset($q_meta['att_nmbr'])) {
+                            if ( ! empty($request_qstn) && isset($q_meta['input_id']) && isset($q_meta['att_nmbr'])) {
                                 // check for answer in $request_qstn in case we are reprocessing a form after an error
-                                if (isset($request_qstn[ $q_meta['input_id'] ][ $qstn_id ])) {
-                                    $answer = is_array($request_qstn[ $q_meta['input_id'] ][ $qstn_id ])
-                                        ? $request_qstn[ $q_meta['input_id'] ][ $qstn_id ]
-                                        : sanitize_text_field($request_qstn[ $q_meta['input_id'] ][ $qstn_id ]);
+                                if (isset($request_qstn[$q_meta['input_id']][$qstn_id])) {
+                                    $answer = is_array($request_qstn[$q_meta['input_id']][$qstn_id])
+                                        ? $request_qstn[$q_meta['input_id']][$qstn_id]
+                                        : sanitize_text_field($request_qstn[$q_meta['input_id']][$qstn_id]);
                                 }
                             } elseif (isset($q_meta['attendee']) && $q_meta['attendee']) {
                                 // attendee data from the session
                                 $answer =
-                                    isset($q_meta['attendee'][ $qstn_id ]) ? $q_meta['attendee'][ $qstn_id ] : null;
+                                    isset($q_meta['attendee'][$qstn_id]) ? $q_meta['attendee'][$qstn_id] : null;
                             }
 
 
-                            $QFI  = new EE_Question_Form_Input(
+                            $QFI = new EE_Question_Form_Input(
                                 $QST,
                                 EE_Answer::new_instance(
                                     [
@@ -811,7 +811,7 @@ 
                             $html .= self::generate_form_input($QFI);
                         }
                         $html .= $after_question_group_questions;
-                        $html .= "\n\t" . '</' . $group_wrapper . '>';
+                        $html .= "\n\t".'</'.$group_wrapper.'>';
                     }
                 }
             }
@@ -993,7 +993,7 @@ 
     ): string {
         $for   = ! empty($name) ? " for='{$name}'" : '';
         $class = ! empty($label_class) ? " class='{$label_class}'" : '';
-        $label = self::prep_question($question) . $required_label;
+        $label = self::prep_question($question).$required_label;
         $label_html = "
             {$required_text}
             <label{$for}{$class}>{$label}</label>";
@@ -1049,7 +1049,7 @@ 
         $extra_attributes = ''
     ) {
         // need these
-        if (! $question || ! $name) {
+        if ( ! $question || ! $name) {
             return null;
         }
         // prep the answer
@@ -1061,9 +1061,9 @@ 
         // ya gots ta have style man!!!
         $txt_class = is_admin() ? 'regular-text' : 'espresso-text-inp';
         $class     = empty($class) ? $txt_class : $class;
-        $class     .= ! empty($system_ID) ? ' ' . $system_ID : '';
+        $class .= ! empty($system_ID) ? ' '.$system_ID : '';
         $class = self::appendInputSizeClass($class, $answer);
-        $class .= ! empty($required['class']) ? ' ' . $required['class'] : '';
+        $class .= ! empty($required['class']) ? ' '.$required['class'] : '';
         $extra_attributes = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', $extra_attributes);
 
         $label_html = self::label($question, $required_text, $required['label'], $name, $label_class);
@@ -1076,18 +1076,18 @@ 
             $name
         );
 
-        $input_html = $mobile_label . '
+        $input_html = $mobile_label.'
             <input  type="text"
-                    name="' . $name . '"
-                    id="' . $id . '"
-                    class="' . trim($class) . '"
-                    value="' . esc_attr($answer) . '"
-                    aria-label="' . esc_attr($required['msg']) . '"
-                    ' . $disabled . ' ' . $extra_attributes . '
+                    name="' . $name.'"
+                    id="' . $id.'"
+                    class="' . trim($class).'"
+                    value="' . esc_attr($answer).'"
+                    aria-label="' . esc_attr($required['msg']).'"
+                    ' . $disabled.' '.$extra_attributes.'
             />';
 
         $input_html = apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
-        return $label_html . $input_html;
+        return $label_html.$input_html;
     }
 
 
@@ -1122,7 +1122,7 @@ 
         $add_mobile_label = false
     ) {
         // need these
-        if (! $question || ! $name) {
+        if ( ! $question || ! $name) {
             return null;
         }
         // prep the answer
@@ -1136,9 +1136,9 @@ 
         // set disabled tag
         $disabled = $answer === null || ! $disabled ? '' : ' disabled="disabled"';
         // ya gots ta have style man!!!
-        $class     .= ! empty($system_ID) ? ' ' . $system_ID : '';
-        $class     .= ! empty($required['class']) ? ' ' . $required['class'] : '';
-        $extra     = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
+        $class     .= ! empty($system_ID) ? ' '.$system_ID : '';
+        $class     .= ! empty($required['class']) ? ' '.$required['class'] : '';
+        $extra = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
 
         $label_html   = self::label($question, $required_text, $required['label'], $name, $label_class);
         $mobile_label = self::mobileLabel(
@@ -1151,14 +1151,14 @@ 
         );
 
         $input_html = $mobile_label
-            . '<textarea name="' . $name . '" id="' . $id . '" class="' . trim($class) . '" '
-            . 'rows="' . $dimensions['rows'] . '" cols="' . $dimensions['cols'] . '"  '
-            . 'aria-label="' . $required['msg'] . '" ' . $disabled . ' ' . $extra . '>'
+            . '<textarea name="'.$name.'" id="'.$id.'" class="'.trim($class).'" '
+            . 'rows="'.$dimensions['rows'].'" cols="'.$dimensions['cols'].'"  '
+            . 'aria-label="'.$required['msg'].'" '.$disabled.' '.$extra.'>'
              . esc_textarea($answer)
               . '</textarea>';
 
         $input_html = apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
-        return $label_html . $input_html;
+        return $label_html.$input_html;
     }
 
 
@@ -1196,7 +1196,7 @@ 
     ) {
 
         // need these
-        if (! $question || ! $name || ! $options || empty($options) || ! is_array($options)) {
+        if ( ! $question || ! $name || ! $options || empty($options) || ! is_array($options)) {
             return null;
         }
         // prep the answer
@@ -1208,9 +1208,9 @@ 
         // set disabled tag
         $disabled = $answer === null || ! $disabled ? '' : ' disabled="disabled"';
         // ya gots ta have style man!!!
-        $class     .= ! empty($system_ID) ? ' ' . $system_ID : '';
+        $class .= ! empty($system_ID) ? ' '.$system_ID : '';
         $class = self::appendInputSizeClass($class, $options);
-        $extra     = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
+        $extra = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
 
         $label_html   = self::label($question, $required_text, $required['label'], $name, $label_class);
         $mobile_label = self::mobileLabel(
@@ -1223,16 +1223,16 @@ 
         );
 
         $input_html = $mobile_label
-            . '<select name="' . $name . '" id="' . $id . '" class="' . trim($class) . ' ' . $required['class'] . '" '
-            . 'aria-label="' . esc_attr($required['msg']) . '"' . $disabled . ' ' . $extra . '>';
+            . '<select name="'.$name.'" id="'.$id.'" class="'.trim($class).' '.$required['class'].'" '
+            . 'aria-label="'.esc_attr($required['msg']).'"'.$disabled.' '.$extra.'>';
         // recursively count array elements, to determine total number of options
         $only_option = count($options, 1) == 1;
-        if (! $only_option) {
+        if ( ! $only_option) {
             // if there is NO answer set and there are multiple options to choose from, then set the "please select" message as selected
-            $selected   = $answer === null ? ' selected' : '';
+            $selected = $answer === null ? ' selected' : '';
             $input_html .= $add_please_select_option
                 ? "\n\t\t\t\t"
-                  . '<option value=""' . $selected . '>'
+                  . '<option value=""'.$selected.'>'
                   . esc_html__(' - please select - ', 'event_espresso')
                   . '</option>'
                 : '';
@@ -1255,7 +1255,7 @@ 
                 );
         }
 
-        $input_html .= "\n\t\t\t" . '</select>';
+        $input_html .= "\n\t\t\t".'</select>';
 
         $input_html =
             apply_filters(
@@ -1270,7 +1270,7 @@ 
             );
 
         $input_html = apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
-        return $label_html . $input_html;
+        return $label_html.$input_html;
     }
 
 
@@ -1288,11 +1288,11 @@ 
      */
     private static function _generate_select_option_group($opt_group, $QSOs, $answer, $use_html_entities = true)
     {
-        $html = "\n\t\t\t\t" . '<optgroup label="' . self::prep_option_value($opt_group) . '">';
+        $html = "\n\t\t\t\t".'<optgroup label="'.self::prep_option_value($opt_group).'">';
         foreach ($QSOs as $QSO) {
             $html .= self::_generate_select_option($QSO->value(), $QSO->desc(), $answer, false, $use_html_entities);
         }
-        $html .= "\n\t\t\t\t" . '</optgroup>';
+        $html .= "\n\t\t\t\t".'</optgroup>';
         return $html;
     }
 
@@ -1319,7 +1319,7 @@ 
         $value    = ! empty($value) ? $value : $key;
         $selected = ($answer == $key || $only_option) ? 'selected' : '';
         return "\n\t\t\t\t"
-               . '<option value="' . self::prep_option_value($key) . '" ' . $selected . '> '
+               . '<option value="'.self::prep_option_value($key).'" '.$selected.'> '
                . $value
                . '&nbsp;&nbsp;&nbsp;</option>';
     }
@@ -1364,7 +1364,7 @@ 
         bool $add_mobile_label = false
     ) {
         // need these
-        if (! $question || ! $name || ! $options || empty($options) || ! is_array($options)) {
+        if ( ! $question || ! $name || ! $options || empty($options) || ! is_array($options)) {
             return null;
         }
         // prep the answer
@@ -1388,50 +1388,50 @@ 
         );
 
         $input_html = $mobile_label
-            . '<ul id="' . $id . '-ul" class="espresso-radio-btn-options-ul ' . $class . '-ul">';
+            . '<ul id="'.$id.'-ul" class="espresso-radio-btn-options-ul '.$class.'-ul">';
 
-        $class .= ! empty($system_ID) ? ' ' . $system_ID : '';
-        $class .= ! empty($required['class']) ? ' ' . $required['class'] : '';
+        $class .= ! empty($system_ID) ? ' '.$system_ID : '';
+        $class .= ! empty($required['class']) ? ' '.$required['class'] : '';
 
         foreach ($options as $OPT) {
             if ($OPT instanceof EE_Question_Option) {
                 $value   = self::prep_option_value($OPT->value());
                 $label   = $use_desc_4_label ? $OPT->desc() : $OPT->value();
                 $size    = $use_desc_4_label
-                    ? self::get_label_size_class($OPT->value() . ' ' . $OPT->desc())
+                    ? self::get_label_size_class($OPT->value().' '.$OPT->desc())
                     : self::get_label_size_class($OPT->value());
-                $desc    = $OPT->desc();// no self::prep_answer
+                $desc    = $OPT->desc(); // no self::prep_answer
                 $answer  = is_numeric($value) && empty($answer) ? 0 : $answer;
-                $value  = is_numeric($answer) && empty($value) ? 0 : $value;
+                $value = is_numeric($answer) && empty($value) ? 0 : $value;
                 $checked = (string) $value == (string) $answer ? ' checked' : '';
-                $opt     = '-' . sanitize_key($value);
+                $opt     = '-'.sanitize_key($value);
 
-                $input_html .= "\n\t\t\t\t" . '<li' . $size . '>';
-                $input_html .= "\n\t\t\t\t\t" . '<label class="' . $radio_class . ' espresso-radio-btn-lbl">';
-                $input_html .= $label_b4 ? "\n\t\t\t\t\t\t" . '<span>' . $label . '</span>&nbsp;' : '';
+                $input_html .= "\n\t\t\t\t".'<li'.$size.'>';
+                $input_html .= "\n\t\t\t\t\t".'<label class="'.$radio_class.' espresso-radio-btn-lbl">';
+                $input_html .= $label_b4 ? "\n\t\t\t\t\t\t".'<span>'.$label.'</span>&nbsp;' : '';
                 $input_html .= "\n\t\t\t\t\t\t"
-                               . '<input type="radio" name="' . $name . '" id="' . $id . $opt . '" '
-                               . 'class="' . $class . '" value="' . $value . '" '
-                               . 'aria-label="' . esc_attr($required['msg']) . '" ' . $disabled
-                               . $checked . ' ' . $extra . '/>';
+                               . '<input type="radio" name="'.$name.'" id="'.$id.$opt.'" '
+                               . 'class="'.$class.'" value="'.$value.'" '
+                               . 'aria-label="'.esc_attr($required['msg']).'" '.$disabled
+                               . $checked.' '.$extra.'/>';
                 $input_html .= ! $label_b4
                     ? "\n\t\t\t\t\t\t"
                       . '&nbsp;<span class="espresso-radio-btn-desc">'
                       . $label
                       . '</span>'
                     : '';
-                $input_html .= "\n\t\t\t\t\t" . '</label>';
+                $input_html .= "\n\t\t\t\t\t".'</label>';
                 $input_html .= $use_desc_4_label
                     ? ''
-                    : '<span class="espresso-radio-btn-option-desc small-text grey-text">' . $desc . '</span>';
-                $input_html .= "\n\t\t\t\t" . '</li>';
+                    : '<span class="espresso-radio-btn-option-desc small-text grey-text">'.$desc.'</span>';
+                $input_html .= "\n\t\t\t\t".'</li>';
             }
         }
 
-        $input_html .= "\n\t\t\t" . '</ul>';
+        $input_html .= "\n\t\t\t".'</ul>';
 
         $input_html = apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
-        return $label_html . $input_html;
+        return $label_html.$input_html;
     }
 
 
@@ -1467,7 +1467,7 @@ 
         $add_mobile_label = false
     ) {
         // need these
-        if (! $question || ! $name || ! $options || empty($options) || ! is_array($options)) {
+        if ( ! $question || ! $name || ! $options || empty($options) || ! is_array($options)) {
             return null;
         }
         $answer = maybe_unserialize($answer);
@@ -1477,7 +1477,7 @@ 
 
         foreach ($answer as $key => $value) {
             $key            = self::prep_option_value($key);
-            $answer[ $key ] = self::prep_answer($value, $use_html_entities);
+            $answer[$key] = self::prep_answer($value, $use_html_entities);
         }
 
         // prep the required array
@@ -1499,42 +1499,42 @@ 
         );
 
         $input_html = $mobile_label
-            . '<ul id="' . $id . '-ul" class="espresso-checkbox-options-ul ' . $class . '-ul">';
+            . '<ul id="'.$id.'-ul" class="espresso-checkbox-options-ul '.$class.'-ul">';
 
-        $class .= ! empty($system_ID) ? ' ' . $system_ID : '';
-        $class .= ! empty($required['class']) ? ' ' . $required['class'] : '';
+        $class .= ! empty($system_ID) ? ' '.$system_ID : '';
+        $class .= ! empty($required['class']) ? ' '.$required['class'] : '';
 
         foreach ($options as $OPT) {
-            $value = $OPT->value();// self::prep_option_value( $OPT->value() );
-            $size  = self::get_label_size_class($OPT->value() . ' ' . $OPT->desc());
+            $value = $OPT->value(); // self::prep_option_value( $OPT->value() );
+            $size  = self::get_label_size_class($OPT->value().' '.$OPT->desc());
             $text  = self::prep_answer($OPT->value());
             $desc  = $OPT->desc();
-            $opt   = '-' . sanitize_key($value);
+            $opt   = '-'.sanitize_key($value);
 
             $checked = is_array($answer) && in_array($text, $answer) ? ' checked' : '';
 
-            $input_html .= "\n\t\t\t\t" . '<li' . $size . '>';
-            $input_html .= "\n\t\t\t\t\t" . '<label class="' . $radio_class . ' espresso-checkbox-lbl">';
-            $input_html .= $label_b4 ? "\n\t\t\t\t\t\t" . '<span>' . $text . '</span>&nbsp;' : '';
+            $input_html .= "\n\t\t\t\t".'<li'.$size.'>';
+            $input_html .= "\n\t\t\t\t\t".'<label class="'.$radio_class.' espresso-checkbox-lbl">';
+            $input_html .= $label_b4 ? "\n\t\t\t\t\t\t".'<span>'.$text.'</span>&nbsp;' : '';
             $input_html .= "\n\t\t\t\t\t\t"
-                           . '<input type="checkbox" name="' . $name . '[' . $OPT->ID() . ']" '
-                           . 'id="' . $id . $opt . '" class="' . $class . '" value="' . $value . '" '
-                           . 'aria-label="' . esc_attr($required['msg']) . '" ' . $disabled . $checked . ' ' . $extra . '/>';
-            $input_html .= ! $label_b4 ? "\n\t\t\t\t\t\t" . '&nbsp;<span>' . $text . '</span>' : '';
-            $input_html .= "\n\t\t\t\t\t" . '</label>';
-            if (! empty($desc) && $desc != $text) {
+                           . '<input type="checkbox" name="'.$name.'['.$OPT->ID().']" '
+                           . 'id="'.$id.$opt.'" class="'.$class.'" value="'.$value.'" '
+                           . 'aria-label="'.esc_attr($required['msg']).'" '.$disabled.$checked.' '.$extra.'/>';
+            $input_html .= ! $label_b4 ? "\n\t\t\t\t\t\t".'&nbsp;<span>'.$text.'</span>' : '';
+            $input_html .= "\n\t\t\t\t\t".'</label>';
+            if ( ! empty($desc) && $desc != $text) {
                 $input_html .= "\n\t\t\t\t\t"
                                . ' &nbsp; <br/><div class="espresso-checkbox-option-desc small-text grey-text">'
                                . $desc
                                . '</div>';
             }
-            $input_html .= "\n\t\t\t\t" . '</li>';
+            $input_html .= "\n\t\t\t\t".'</li>';
         }
 
-        $input_html .= "\n\t\t\t" . '</ul>';
+        $input_html .= "\n\t\t\t".'</ul>';
 
         $input_html = apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
-        return $label_html . $input_html;
+        return $label_html.$input_html;
     }
 
 
@@ -1567,7 +1567,7 @@ 
         $add_mobile_label = false
     ) {
         // need these
-        if (! $question || ! $name) {
+        if ( ! $question || ! $name) {
             return null;
         }
         // prep the answer
@@ -1579,7 +1579,7 @@ 
         // ya gots ta have style man!!!
         $txt_class = is_admin() ? 'regular-text' : 'espresso-datepicker-inp';
         $class     = empty($class) ? $txt_class : $class;
-        $class     .= ! empty($system_ID) ? ' ' . $system_ID : '';
+        $class .= ! empty($system_ID) ? ' '.$system_ID : '';
         $class = self::appendInputSizeClass($class, $answer);
         $extra     = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', '');
 
@@ -1594,14 +1594,14 @@ 
         );
 
         $input_html = $mobile_label
-            . '<input type="text" name="' . $name . '" id="' . $id . '" '
-            . 'class="' . $class . ' ' . $required['class'] . ' datepicker" value="' . $answer . '"  '
-            . 'aria-label="' . esc_attr($required['msg']) . '" ' . $disabled . ' ' . $extra . '/>';
+            . '<input type="text" name="'.$name.'" id="'.$id.'" '
+            . 'class="'.$class.' '.$required['class'].' datepicker" value="'.$answer.'"  '
+            . 'aria-label="'.esc_attr($required['msg']).'" '.$disabled.' '.$extra.'/>';
 
         // enqueue scripts
         wp_register_style(
             'espresso-ui-theme',
-            EE_GLOBAL_ASSETS_URL . 'css/espresso-ui-theme/jquery-ui-1.10.3.custom.min.css',
+            EE_GLOBAL_ASSETS_URL.'css/espresso-ui-theme/jquery-ui-1.10.3.custom.min.css',
             [],
             EVENT_ESPRESSO_VERSION
         );
@@ -1609,7 +1609,7 @@ 
         wp_enqueue_script('jquery-ui-datepicker');
 
         $input_html = apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id);
-        return $label_html . $input_html;
+        return $label_html.$input_html;
     }
 
 
@@ -1636,7 +1636,7 @@ 
     public static function hidden_input($name, $value, $id = '')
     {
         $id = ! empty($id) ? $id : $name;
-        return '<input id="' . $id . '" type="hidden" name="' . $name . '" value="' . $value . '"/>';
+        return '<input id="'.$id.'" type="hidden" name="'.$name.'" value="'.$value.'"/>';
     }
 
 
@@ -1681,7 +1681,7 @@ 
         $prepped_answer_options = [];
         if (is_array($QSOs) && ! empty($QSOs)) {
             foreach ($QSOs as $key => $QSO) {
-                if (! $QSO instanceof EE_Question_Option) {
+                if ( ! $QSO instanceof EE_Question_Option) {
                     $QSO = EE_Question_Option::new_instance(
                         [
                             'QSO_value' => is_array($QSO) && isset($QSO['id'])
@@ -1694,7 +1694,7 @@ 
                     );
                 }
                 if ($QSO->opt_group()) {
-                    $prepped_answer_options[ $QSO->opt_group() ][] = $QSO;
+                    $prepped_answer_options[$QSO->opt_group()][] = $QSO;
                 } else {
                     $prepped_answer_options[] = $QSO;
                 }
@@ -1906,7 +1906,7 @@ 
         $options = [];
         for ($x = 1; $x <= 12; $x++) {
             $mm             = str_pad($x, 2, '0', STR_PAD_LEFT);
-            $options[ $mm ] = $mm;
+            $options[$mm] = $mm;
         }
         return EEH_Form_Fields::prep_answer_options($options);
     }
@@ -1924,7 +1924,7 @@ 
         $next_decade  = $current_year + 10;
         for ($x = $current_year; $x <= $next_decade; $x++) {
             $yy             = str_pad($x, 2, '0', STR_PAD_LEFT);
-            $options[ $yy ] = $yy;
+            $options[$yy] = $yy;
         }
         return EEH_Form_Fields::prep_answer_options($options);
     }
@@ -1943,7 +1943,7 @@ 
     public static function generate_registration_months_dropdown($cur_date = '', $status = '', $evt_category = 0)
     {
         $_where = [];
-        if (! empty($status)) {
+        if ( ! empty($status)) {
             $_where['STS_ID'] = $status;
         }
 
@@ -1962,7 +1962,7 @@ 
         ];
 
         foreach ($reg_dates as $reg_date) {
-            $date      = $reg_date->reg_month . ' ' . $reg_date->reg_year;
+            $date      = $reg_date->reg_month.' '.$reg_date->reg_year;
             $options[] = [
                 'text' => $date,
                 'id'   => $date,
@@ -2007,7 +2007,7 @@ 
         }
 
         // categories?
-        if (! empty($evt_category) and $evt_category > 0) {
+        if ( ! empty($evt_category) and $evt_category > 0) {
             $where['Event.Term_Taxonomy.taxonomy'] = 'espresso_event_categories';
             $where['Event.Term_Taxonomy.term_id']  = $evt_category;
         }
@@ -2029,8 +2029,8 @@ 
         global $wp_locale;
 
         foreach ($DTTS as $DTT) {
-            $localized_date = $wp_locale->get_month($DTT->dtt_month_num) . ' ' . $DTT->dtt_year;
-            $id             = $DTT->dtt_month . ' ' . $DTT->dtt_year;
+            $localized_date = $wp_locale->get_month($DTT->dtt_month_num).' '.$DTT->dtt_year;
+            $id             = $DTT->dtt_month.' '.$DTT->dtt_year;
             $options[]      = [
                 'text' => $localized_date,
                 'id'   => $id,
@@ -2103,16 +2103,16 @@ 
             return $btn;
         }
         $text = ! empty($text) ? $text : esc_html__('Submit', 'event_espresso');
-        $btn  .= '<input id="' . $ID . '-btn" class="' . $class . '" '
-                 . 'type="submit" value="' . $text . '" ' . $extra_attributes . '/>';
-        if (! $input_only) {
-            $btn_frm = '<form id="' . $ID . '-frm" method="POST" action="' . $url . '">';
+        $btn .= '<input id="'.$ID.'-btn" class="'.$class.'" '
+                 . 'type="submit" value="'.$text.'" '.$extra_attributes.'/>';
+        if ( ! $input_only) {
+            $btn_frm = '<form id="'.$ID.'-frm" method="POST" action="'.$url.'">';
             $btn_frm .= ! empty($nonce_action)
-                ? wp_nonce_field($nonce_action, $nonce_action . '_nonce', true, false)
+                ? wp_nonce_field($nonce_action, $nonce_action.'_nonce', true, false)
                 : '';
             $btn_frm .= $btn;
             $btn_frm .= '</form>';
-            $btn     = $btn_frm;
+            $btn = $btn_frm;
             unset($btn_frm);
         }
         return $btn;

core/db_models/EEM_Payment_Method.model.php

Indentation +453 added lines, -453 removed lines

@@ -16,457 +16,457 @@
  */
 class EEM_Payment_Method extends EEM_Base
 {
-    const scope_cart  = 'CART';
-
-    const scope_admin = 'ADMIN';
-
-    const scope_api   = 'API';
-
-
-    protected static ?EEM_Payment_Method $_instance = null;
-
-
-    /**
-     * private constructor to prevent direct creation
-     *
-     * @param string|null $timezone
-     * @throws EE_Error
-     */
-    protected function __construct(?string $timezone = '')
-    {
-        $this->singular_item    = esc_html__('Payment Method', 'event_espresso');
-        $this->plural_item      = esc_html__('Payment Methods', 'event_espresso');
-        $this->_tables          = [
-            'Payment_Method' => new EE_Primary_Table('esp_payment_method', 'PMD_ID'),
-        ];
-        $this->_fields          = [
-            'Payment_Method' => [
-                'PMD_ID'              => new EE_Primary_Key_Int_Field(
-                    'PMD_ID',
-                    esc_html__('ID', 'event_espresso')
-                ),
-                'PMD_type'            => new EE_Plain_Text_Field(
-                    'PMD_type',
-                    esc_html__('Payment Method Type', 'event_espresso'),
-                    false,
-                    'Admin_Only'
-                ),
-                'PMD_name'            => new EE_Plain_Text_Field(
-                    'PMD_name',
-                    esc_html__('Name', 'event_espresso'),
-                    false
-                ),
-                'PMD_desc'            => new EE_Post_Content_Field(
-                    'PMD_desc',
-                    esc_html__('Description', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'PMD_admin_name'      => new EE_Plain_Text_Field(
-                    'PMD_admin_name',
-                    esc_html__('Admin-Only Name', 'event_espresso'),
-                    true
-                ),
-                'PMD_admin_desc'      => new EE_Post_Content_Field(
-                    'PMD_admin_desc',
-                    esc_html__('Admin-Only Description', 'event_espresso'),
-                    true
-                ),
-                'PMD_slug'            => new EE_Slug_Field(
-                    'PMD_slug',
-                    esc_html__('Slug', 'event_espresso'),
-                    false
-                ),
-                'PMD_order'           => new EE_Integer_Field(
-                    'PMD_order',
-                    esc_html__('Order', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'PMD_debug_mode'      => new EE_Boolean_Field(
-                    'PMD_debug_mode',
-                    esc_html__('Sandbox Mode On? (AKA: debug mode)', 'event_espresso'),
-                    false,
-                    false
-                ),
-                'PMD_wp_user'         => new EE_WP_User_Field(
-                    'PMD_wp_user',
-                    esc_html__('Payment Method Creator ID', 'event_espresso'),
-                    false
-                ),
-                'PMD_open_by_default' => new EE_Boolean_Field(
-                    'PMD_open_by_default',
-                    esc_html__('Open by Default?', 'event_espresso'),
-                    false,
-                    false
-                ),
-                'PMD_button_url'      => new EE_Plain_Text_Field(
-                    'PMD_button_url',
-                    esc_html__('Button URL', 'event_espresso'),
-                    true,
-                    ''
-                ),
-                'PMD_scope'           => new EE_Serialized_Text_Field(
-                    'PMD_scope',
-                    esc_html__('Usable From?', 'event_espresso'),
-                    false,
-                    []// possible values currently are 'CART','ADMIN','API'
-                ),
-            ],
-        ];
-        $this->_model_relations = [
-            'Currency'    => new EE_HABTM_Relation('Currency_Payment_Method'),
-            'Payment'     => new EE_Has_Many_Relation(),
-            'Transaction' => new EE_Has_Many_Relation(),
-            'WP_User'     => new EE_Belongs_To_Relation(),
-        ];
-        parent::__construct($timezone);
-    }
-
-
-    /**
-     * Gets one by the slug provided
-     *
-     * @param string $slug
-     * @return EE_Base_Class|EE_Payment_Method|EE_Soft_Delete_Base_Class|NULL
-     * @throws EE_Error
-     */
-    public function get_one_by_slug($slug)
-    {
-        return $this->get_one([['PMD_slug' => $slug]]);
-    }
-
-
-    /**
-     * Gets all the acceptable scopes for payment methods.
-     * Keys are their names as store din the DB, and values are nice names for displaying them
-     *
-     * @return array
-     */
-    public function scopes()
-    {
-        return apply_filters(
-            'FHEE__EEM_Payment_Method__scopes',
-            [
-                EEM_Payment_Method::scope_cart  => esc_html__('Front-end Registration Page', 'event_espresso'),
-                EEM_Payment_Method::scope_admin => esc_html__(
-                    'Admin Registration Page (no online processing)',
-                    'event_espresso'
-                ),
-            ]
-        );
-    }
-
-
-    /**
-     * Determines if this is an valid scope
-     *
-     * @param string $scope like one of EEM_Payment_Method::instance()->scopes()
-     * @return boolean
-     */
-    public function is_valid_scope($scope)
-    {
-        $scopes = $this->scopes();
-        if (isset($scopes[ $scope ])) {
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * Gets all active payment methods
-     *
-     * @param string $scope one of
-     * @param array  $query_params
-     * @return EE_Base_Class[]|EE_Payment_Method[]
-     * @throws EE_Error
-     */
-    public function get_all_active($scope = null, $query_params = [])
-    {
-        if (! isset($query_params['order_by']) && ! isset($query_params['order'])) {
-            $query_params['order_by'] = ['PMD_order' => 'ASC', 'PMD_ID' => 'ASC'];
-        }
-        return $this->get_all($this->_get_query_params_for_all_active($scope, $query_params));
-    }
-
-
-    /**
-     * Counts all active gateways in the specified scope
-     *
-     * @param string $scope one of EEM_Payment_Method::scope_*
-     * @param array  $query_params
-     * @return int
-     * @throws EE_Error
-     */
-    public function count_active($scope = null, $query_params = [])
-    {
-        return $this->count($this->_get_query_params_for_all_active($scope, $query_params));
-    }
-
-
-    /**
-     * Creates the $query_params that can be passed into any EEM_Payment_Method as their $query_params
-     * argument to get all active for a given scope
-     *
-     * @param string $scope one of the constants EEM_Payment_Method::scope_*
-     * @param array  $query_params
-     * @return array
-     * @throws EE_Error
-     * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     */
-    protected function _get_query_params_for_all_active($scope = null, $query_params = [])
-    {
-        if ($scope) {
-            if ($this->is_valid_scope($scope)) {
-                return array_replace_recursive([['PMD_scope' => ['LIKE', "%$scope%"]]], $query_params);
-            }
-            throw new EE_Error(
-                sprintf(
-                    esc_html__("'%s' is not a valid scope for a payment method", 'event_espresso'),
-                    $scope
-                )
-            );
-        }
-        $acceptable_scopes = [];
-        $count             = 0;
-        foreach ($this->scopes() as $scope_name => $desc) {
-            $count++;
-            $acceptable_scopes[ 'PMD_scope*' . $count ] = ['LIKE', '%' . $scope_name . '%'];
-        }
-        return array_replace_recursive([['OR*active_scope' => $acceptable_scopes]], $query_params);
-    }
-
-
-    /**
-     * Creates the $query_params that can be passed into any EEM_Payment_Method as their $query_params
-     * argument to get all active for a given scope
-     *
-     * @param string $scope one of the constants EEM_Payment_Method::scope_*
-     * @param array  $query_params
-     * @return array
-     * @throws EE_Error
-     * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     */
-    public function get_query_params_for_all_active($scope = null, $query_params = [])
-    {
-        return $this->_get_query_params_for_all_active($scope, $query_params);
-    }
-
-
-    /**
-     * Gets one active payment method. see @get_all_active for documentation
-     *
-     * @param string $scope
-     * @param array  $query_params
-     * @return EE_Base_Class|EE_Payment_Method|EE_Soft_Delete_Base_Class|NULL
-     * @throws EE_Error
-     */
-    public function get_one_active($scope = null, $query_params = [])
-    {
-        return $this->get_one($this->_get_query_params_for_all_active($scope, $query_params));
-    }
-
-
-    /**
-     * Gets one payment method of that type, regardless of whether its active or not
-     *
-     * @param string $type
-     * @return EE_Base_Class|EE_Payment_Method|EE_Soft_Delete_Base_Class|NULL
-     * @throws EE_Error
-     */
-    public function get_one_of_type($type)
-    {
-        return $this->get_one([['PMD_type' => $type]]);
-    }
-
-
-    /**
-     * Overrides parent ot also check by the slug
-     *
-     * @param string|int|EE_Payment_Method $base_class_obj_or_id
-     * @param boolean                      $ensure_is_in_db
-     * @return EE_Base_Class|EE_Payment_Method|EE_Soft_Delete_Base_Class|int|string
-     * @throws EE_Error
-     * @see EEM_Base::ensure_is_obj()
-     */
-    public function ensure_is_obj($base_class_obj_or_id, $ensure_is_in_db = false)
-    {
-        // first: check if it's a slug
-        if (is_string($base_class_obj_or_id)) {
-            $obj = $this->get_one_by_slug($base_class_obj_or_id);
-            if ($obj) {
-                return $obj;
-            }
-        }
-        // ok so it wasn't a slug we were passed. try the usual then (ie, it's an object or an ID)
-        try {
-            return parent::ensure_is_obj($base_class_obj_or_id, $ensure_is_in_db);
-        } catch (EE_Error $e) {
-            // handle it outside the catch
-        }
-        throw new EE_Error(
-            sprintf(
-                esc_html__("'%s' is neither a Payment Method ID, slug, nor object.", 'event_espresso'),
-                $base_class_obj_or_id
-            )
-        );
-    }
-
-
-    /**
-     * Gets the ID of this object, or if its a string finds the object's id
-     * associated with that slug
-     *
-     * @param mixed $base_obj_or_id_or_slug
-     * @return int
-     * @throws EE_Error
-     */
-    public function ensure_is_ID($base_obj_or_id_or_slug)
-    {
-        if (is_string($base_obj_or_id_or_slug)) {
-            // assume it's a slug
-            $base_obj_or_id_or_slug = $this->get_one_by_slug($base_obj_or_id_or_slug);
-        }
-        return parent::ensure_is_ID($base_obj_or_id_or_slug);
-    }
-
-
-    /**
-     * Verifies the button urls on all the passed payment methods have a valid button url.
-     * If not, resets them to their default.
-     *
-     * @param EE_Payment_Method[] $payment_methods if NULL, defaults to all payment methods active in the cart
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function verify_button_urls($payment_methods = null)
-    {
-        $payment_methods = is_array($payment_methods)
-            ? $payment_methods
-            : $this->get_all_active(EEM_Payment_Method::scope_cart);
-        foreach ($payment_methods as $payment_method) {
-            try {
-                // If there is really no button URL at all, or if the button URLs still point to decaf folder even
-                // though this is a caffeinated install, reset it to the default.
-                $current_button_url = $payment_method->button_url();
-                if (
-                    empty($current_button_url)
-                    || (
-                        strpos($current_button_url, 'decaf') !== false
-                        && strpos($payment_method->type_obj()->default_button_url(), 'decaf') === false
-                    )
-                ) {
-                    $payment_method->save(
-                        [
-                            'PMD_button_url' => $payment_method->type_obj()->default_button_url(),
-                        ]
-                    );
-                }
-            } catch (EE_Error $e) {
-                $payment_method->deactivate();
-            }
-        }
-    }
-
-
-    /**
-     * Overrides parent to not only turn wpdb results into EE_Payment_Method objects,
-     * but also verifies the payment method type of each is a usable object. If not,
-     * deactivate it, sets a notification, and deactivates it
-     *
-     * @param array $rows
-     * @return EE_Payment_Method[]
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws ReflectionException
-     */
-    protected function _create_objects($rows = [])
-    {
-        EE_Registry::instance()->load_lib('Payment_Method_Manager');
-        $PMM = EE_Payment_Method_Manager::instance();
-        $payment_methods = parent::_create_objects($rows);
-        /* @var $payment_methods EE_Payment_Method[] */
-        $usable_payment_methods = [];
-        foreach ($payment_methods as $key => $payment_method) {
-            // check if the payment method type exists and force recheck
-            $pm_type_exists = $PMM->payment_method_type_exists($payment_method->type(), true);
-            if ($pm_type_exists) {
-                $usable_payment_methods[ $key ] = $payment_method;
-                // some payment methods enqueue their scripts in EE_PMT_*::__construct
-                // which is kinda a no-no (just because it's being constructed doesn't mean we need to enqueue
-                // its scripts). but for backwards-compat we should continue to do that
-                $payment_method->type_obj();
-            } elseif ($payment_method->active()) {
-                // only deactivate and notify the admin if the payment is active somewhere
-                $payment_method->deactivate();
-                $payment_method->save();
-                do_action(
-                    'AHEE__EEM_Payment_Method___create_objects_auto_deactivated_payment_method',
-                    $payment_method
-                );
-                new PersistentAdminNotice(
-                    'auto-deactivated-' . $payment_method->type(),
-                    sprintf(
-                        esc_html__(
-                            'The payment method %1$s was automatically deactivated because it appears its associated Event Espresso Addon was recently deactivated.%2$sIt can be reactivated on the %3$sPlugins admin page%4$s, then you can reactivate the payment method.',
-                            'event_espresso'
-                        ),
-                        $payment_method->admin_name(),
-                        '<br />',
-                        '<a href="' . admin_url('plugins.php') . '">',
-                        '</a>'
-                    ),
-                    true
-                );
-            }
-        }
-        return $usable_payment_methods;
-    }
-
-
-    /**
-     * Gets all the payment methods which can be used for transaction
-     * (according to the relations between payment methods and events, and
-     * the currencies used for the transaction and their relation to payment methods)
-     *
-     * @param EE_Transaction $transaction
-     * @param string         $scope @see EEM_Payment_Method::get_all_for_events
-     * @return EE_Payment_Method[]
-     * @throws EE_Error
-     */
-    public function get_all_for_transaction($transaction, $scope)
-    {
-        // give addons a chance to override what payment methods are chosen based on the transaction
-        return apply_filters(
-            'FHEE__EEM_Payment_Method__get_all_for_transaction__payment_methods',
-            $this->get_all_active($scope, ['group_by' => 'PMD_type']),
-            $transaction,
-            $scope
-        );
-    }
-
-
-    /**
-     * Returns the payment method used for the last payment made for a registration.
-     * Note: if an offline payment method was selected on the related transaction then this will have no payment
-     * methods returned. It will ONLY return a payment method for a PAYMENT recorded against the registration.
-     *
-     * @param EE_Registration|int $registration_or_reg_id Either the EE_Registration object or the id for the
-     *                                                    registration.
-     * @return EE_Payment|null
-     * @throws EE_Error
-     */
-    public function get_last_used_for_registration($registration_or_reg_id)
-    {
-        $registration_id = EEM_Registration::instance()->ensure_is_ID($registration_or_reg_id);
-
-        $query_params = [
-            0          => [
-                'Payment.Registration.REG_ID' => $registration_id,
-            ],
-            'order_by' => ['Payment.PAY_ID' => 'DESC'],
-        ];
-        return $this->get_one($query_params);
-    }
+	const scope_cart  = 'CART';
+
+	const scope_admin = 'ADMIN';
+
+	const scope_api   = 'API';
+
+
+	protected static ?EEM_Payment_Method $_instance = null;
+
+
+	/**
+	 * private constructor to prevent direct creation
+	 *
+	 * @param string|null $timezone
+	 * @throws EE_Error
+	 */
+	protected function __construct(?string $timezone = '')
+	{
+		$this->singular_item    = esc_html__('Payment Method', 'event_espresso');
+		$this->plural_item      = esc_html__('Payment Methods', 'event_espresso');
+		$this->_tables          = [
+			'Payment_Method' => new EE_Primary_Table('esp_payment_method', 'PMD_ID'),
+		];
+		$this->_fields          = [
+			'Payment_Method' => [
+				'PMD_ID'              => new EE_Primary_Key_Int_Field(
+					'PMD_ID',
+					esc_html__('ID', 'event_espresso')
+				),
+				'PMD_type'            => new EE_Plain_Text_Field(
+					'PMD_type',
+					esc_html__('Payment Method Type', 'event_espresso'),
+					false,
+					'Admin_Only'
+				),
+				'PMD_name'            => new EE_Plain_Text_Field(
+					'PMD_name',
+					esc_html__('Name', 'event_espresso'),
+					false
+				),
+				'PMD_desc'            => new EE_Post_Content_Field(
+					'PMD_desc',
+					esc_html__('Description', 'event_espresso'),
+					false,
+					''
+				),
+				'PMD_admin_name'      => new EE_Plain_Text_Field(
+					'PMD_admin_name',
+					esc_html__('Admin-Only Name', 'event_espresso'),
+					true
+				),
+				'PMD_admin_desc'      => new EE_Post_Content_Field(
+					'PMD_admin_desc',
+					esc_html__('Admin-Only Description', 'event_espresso'),
+					true
+				),
+				'PMD_slug'            => new EE_Slug_Field(
+					'PMD_slug',
+					esc_html__('Slug', 'event_espresso'),
+					false
+				),
+				'PMD_order'           => new EE_Integer_Field(
+					'PMD_order',
+					esc_html__('Order', 'event_espresso'),
+					false,
+					0
+				),
+				'PMD_debug_mode'      => new EE_Boolean_Field(
+					'PMD_debug_mode',
+					esc_html__('Sandbox Mode On? (AKA: debug mode)', 'event_espresso'),
+					false,
+					false
+				),
+				'PMD_wp_user'         => new EE_WP_User_Field(
+					'PMD_wp_user',
+					esc_html__('Payment Method Creator ID', 'event_espresso'),
+					false
+				),
+				'PMD_open_by_default' => new EE_Boolean_Field(
+					'PMD_open_by_default',
+					esc_html__('Open by Default?', 'event_espresso'),
+					false,
+					false
+				),
+				'PMD_button_url'      => new EE_Plain_Text_Field(
+					'PMD_button_url',
+					esc_html__('Button URL', 'event_espresso'),
+					true,
+					''
+				),
+				'PMD_scope'           => new EE_Serialized_Text_Field(
+					'PMD_scope',
+					esc_html__('Usable From?', 'event_espresso'),
+					false,
+					[]// possible values currently are 'CART','ADMIN','API'
+				),
+			],
+		];
+		$this->_model_relations = [
+			'Currency'    => new EE_HABTM_Relation('Currency_Payment_Method'),
+			'Payment'     => new EE_Has_Many_Relation(),
+			'Transaction' => new EE_Has_Many_Relation(),
+			'WP_User'     => new EE_Belongs_To_Relation(),
+		];
+		parent::__construct($timezone);
+	}
+
+
+	/**
+	 * Gets one by the slug provided
+	 *
+	 * @param string $slug
+	 * @return EE_Base_Class|EE_Payment_Method|EE_Soft_Delete_Base_Class|NULL
+	 * @throws EE_Error
+	 */
+	public function get_one_by_slug($slug)
+	{
+		return $this->get_one([['PMD_slug' => $slug]]);
+	}
+
+
+	/**
+	 * Gets all the acceptable scopes for payment methods.
+	 * Keys are their names as store din the DB, and values are nice names for displaying them
+	 *
+	 * @return array
+	 */
+	public function scopes()
+	{
+		return apply_filters(
+			'FHEE__EEM_Payment_Method__scopes',
+			[
+				EEM_Payment_Method::scope_cart  => esc_html__('Front-end Registration Page', 'event_espresso'),
+				EEM_Payment_Method::scope_admin => esc_html__(
+					'Admin Registration Page (no online processing)',
+					'event_espresso'
+				),
+			]
+		);
+	}
+
+
+	/**
+	 * Determines if this is an valid scope
+	 *
+	 * @param string $scope like one of EEM_Payment_Method::instance()->scopes()
+	 * @return boolean
+	 */
+	public function is_valid_scope($scope)
+	{
+		$scopes = $this->scopes();
+		if (isset($scopes[ $scope ])) {
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * Gets all active payment methods
+	 *
+	 * @param string $scope one of
+	 * @param array  $query_params
+	 * @return EE_Base_Class[]|EE_Payment_Method[]
+	 * @throws EE_Error
+	 */
+	public function get_all_active($scope = null, $query_params = [])
+	{
+		if (! isset($query_params['order_by']) && ! isset($query_params['order'])) {
+			$query_params['order_by'] = ['PMD_order' => 'ASC', 'PMD_ID' => 'ASC'];
+		}
+		return $this->get_all($this->_get_query_params_for_all_active($scope, $query_params));
+	}
+
+
+	/**
+	 * Counts all active gateways in the specified scope
+	 *
+	 * @param string $scope one of EEM_Payment_Method::scope_*
+	 * @param array  $query_params
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function count_active($scope = null, $query_params = [])
+	{
+		return $this->count($this->_get_query_params_for_all_active($scope, $query_params));
+	}
+
+
+	/**
+	 * Creates the $query_params that can be passed into any EEM_Payment_Method as their $query_params
+	 * argument to get all active for a given scope
+	 *
+	 * @param string $scope one of the constants EEM_Payment_Method::scope_*
+	 * @param array  $query_params
+	 * @return array
+	 * @throws EE_Error
+	 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 */
+	protected function _get_query_params_for_all_active($scope = null, $query_params = [])
+	{
+		if ($scope) {
+			if ($this->is_valid_scope($scope)) {
+				return array_replace_recursive([['PMD_scope' => ['LIKE', "%$scope%"]]], $query_params);
+			}
+			throw new EE_Error(
+				sprintf(
+					esc_html__("'%s' is not a valid scope for a payment method", 'event_espresso'),
+					$scope
+				)
+			);
+		}
+		$acceptable_scopes = [];
+		$count             = 0;
+		foreach ($this->scopes() as $scope_name => $desc) {
+			$count++;
+			$acceptable_scopes[ 'PMD_scope*' . $count ] = ['LIKE', '%' . $scope_name . '%'];
+		}
+		return array_replace_recursive([['OR*active_scope' => $acceptable_scopes]], $query_params);
+	}
+
+
+	/**
+	 * Creates the $query_params that can be passed into any EEM_Payment_Method as their $query_params
+	 * argument to get all active for a given scope
+	 *
+	 * @param string $scope one of the constants EEM_Payment_Method::scope_*
+	 * @param array  $query_params
+	 * @return array
+	 * @throws EE_Error
+	 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 */
+	public function get_query_params_for_all_active($scope = null, $query_params = [])
+	{
+		return $this->_get_query_params_for_all_active($scope, $query_params);
+	}
+
+
+	/**
+	 * Gets one active payment method. see @get_all_active for documentation
+	 *
+	 * @param string $scope
+	 * @param array  $query_params
+	 * @return EE_Base_Class|EE_Payment_Method|EE_Soft_Delete_Base_Class|NULL
+	 * @throws EE_Error
+	 */
+	public function get_one_active($scope = null, $query_params = [])
+	{
+		return $this->get_one($this->_get_query_params_for_all_active($scope, $query_params));
+	}
+
+
+	/**
+	 * Gets one payment method of that type, regardless of whether its active or not
+	 *
+	 * @param string $type
+	 * @return EE_Base_Class|EE_Payment_Method|EE_Soft_Delete_Base_Class|NULL
+	 * @throws EE_Error
+	 */
+	public function get_one_of_type($type)
+	{
+		return $this->get_one([['PMD_type' => $type]]);
+	}
+
+
+	/**
+	 * Overrides parent ot also check by the slug
+	 *
+	 * @param string|int|EE_Payment_Method $base_class_obj_or_id
+	 * @param boolean                      $ensure_is_in_db
+	 * @return EE_Base_Class|EE_Payment_Method|EE_Soft_Delete_Base_Class|int|string
+	 * @throws EE_Error
+	 * @see EEM_Base::ensure_is_obj()
+	 */
+	public function ensure_is_obj($base_class_obj_or_id, $ensure_is_in_db = false)
+	{
+		// first: check if it's a slug
+		if (is_string($base_class_obj_or_id)) {
+			$obj = $this->get_one_by_slug($base_class_obj_or_id);
+			if ($obj) {
+				return $obj;
+			}
+		}
+		// ok so it wasn't a slug we were passed. try the usual then (ie, it's an object or an ID)
+		try {
+			return parent::ensure_is_obj($base_class_obj_or_id, $ensure_is_in_db);
+		} catch (EE_Error $e) {
+			// handle it outside the catch
+		}
+		throw new EE_Error(
+			sprintf(
+				esc_html__("'%s' is neither a Payment Method ID, slug, nor object.", 'event_espresso'),
+				$base_class_obj_or_id
+			)
+		);
+	}
+
+
+	/**
+	 * Gets the ID of this object, or if its a string finds the object's id
+	 * associated with that slug
+	 *
+	 * @param mixed $base_obj_or_id_or_slug
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function ensure_is_ID($base_obj_or_id_or_slug)
+	{
+		if (is_string($base_obj_or_id_or_slug)) {
+			// assume it's a slug
+			$base_obj_or_id_or_slug = $this->get_one_by_slug($base_obj_or_id_or_slug);
+		}
+		return parent::ensure_is_ID($base_obj_or_id_or_slug);
+	}
+
+
+	/**
+	 * Verifies the button urls on all the passed payment methods have a valid button url.
+	 * If not, resets them to their default.
+	 *
+	 * @param EE_Payment_Method[] $payment_methods if NULL, defaults to all payment methods active in the cart
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function verify_button_urls($payment_methods = null)
+	{
+		$payment_methods = is_array($payment_methods)
+			? $payment_methods
+			: $this->get_all_active(EEM_Payment_Method::scope_cart);
+		foreach ($payment_methods as $payment_method) {
+			try {
+				// If there is really no button URL at all, or if the button URLs still point to decaf folder even
+				// though this is a caffeinated install, reset it to the default.
+				$current_button_url = $payment_method->button_url();
+				if (
+					empty($current_button_url)
+					|| (
+						strpos($current_button_url, 'decaf') !== false
+						&& strpos($payment_method->type_obj()->default_button_url(), 'decaf') === false
+					)
+				) {
+					$payment_method->save(
+						[
+							'PMD_button_url' => $payment_method->type_obj()->default_button_url(),
+						]
+					);
+				}
+			} catch (EE_Error $e) {
+				$payment_method->deactivate();
+			}
+		}
+	}
+
+
+	/**
+	 * Overrides parent to not only turn wpdb results into EE_Payment_Method objects,
+	 * but also verifies the payment method type of each is a usable object. If not,
+	 * deactivate it, sets a notification, and deactivates it
+	 *
+	 * @param array $rows
+	 * @return EE_Payment_Method[]
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws ReflectionException
+	 */
+	protected function _create_objects($rows = [])
+	{
+		EE_Registry::instance()->load_lib('Payment_Method_Manager');
+		$PMM = EE_Payment_Method_Manager::instance();
+		$payment_methods = parent::_create_objects($rows);
+		/* @var $payment_methods EE_Payment_Method[] */
+		$usable_payment_methods = [];
+		foreach ($payment_methods as $key => $payment_method) {
+			// check if the payment method type exists and force recheck
+			$pm_type_exists = $PMM->payment_method_type_exists($payment_method->type(), true);
+			if ($pm_type_exists) {
+				$usable_payment_methods[ $key ] = $payment_method;
+				// some payment methods enqueue their scripts in EE_PMT_*::__construct
+				// which is kinda a no-no (just because it's being constructed doesn't mean we need to enqueue
+				// its scripts). but for backwards-compat we should continue to do that
+				$payment_method->type_obj();
+			} elseif ($payment_method->active()) {
+				// only deactivate and notify the admin if the payment is active somewhere
+				$payment_method->deactivate();
+				$payment_method->save();
+				do_action(
+					'AHEE__EEM_Payment_Method___create_objects_auto_deactivated_payment_method',
+					$payment_method
+				);
+				new PersistentAdminNotice(
+					'auto-deactivated-' . $payment_method->type(),
+					sprintf(
+						esc_html__(
+							'The payment method %1$s was automatically deactivated because it appears its associated Event Espresso Addon was recently deactivated.%2$sIt can be reactivated on the %3$sPlugins admin page%4$s, then you can reactivate the payment method.',
+							'event_espresso'
+						),
+						$payment_method->admin_name(),
+						'<br />',
+						'<a href="' . admin_url('plugins.php') . '">',
+						'</a>'
+					),
+					true
+				);
+			}
+		}
+		return $usable_payment_methods;
+	}
+
+
+	/**
+	 * Gets all the payment methods which can be used for transaction
+	 * (according to the relations between payment methods and events, and
+	 * the currencies used for the transaction and their relation to payment methods)
+	 *
+	 * @param EE_Transaction $transaction
+	 * @param string         $scope @see EEM_Payment_Method::get_all_for_events
+	 * @return EE_Payment_Method[]
+	 * @throws EE_Error
+	 */
+	public function get_all_for_transaction($transaction, $scope)
+	{
+		// give addons a chance to override what payment methods are chosen based on the transaction
+		return apply_filters(
+			'FHEE__EEM_Payment_Method__get_all_for_transaction__payment_methods',
+			$this->get_all_active($scope, ['group_by' => 'PMD_type']),
+			$transaction,
+			$scope
+		);
+	}
+
+
+	/**
+	 * Returns the payment method used for the last payment made for a registration.
+	 * Note: if an offline payment method was selected on the related transaction then this will have no payment
+	 * methods returned. It will ONLY return a payment method for a PAYMENT recorded against the registration.
+	 *
+	 * @param EE_Registration|int $registration_or_reg_id Either the EE_Registration object or the id for the
+	 *                                                    registration.
+	 * @return EE_Payment|null
+	 * @throws EE_Error
+	 */
+	public function get_last_used_for_registration($registration_or_reg_id)
+	{
+		$registration_id = EEM_Registration::instance()->ensure_is_ID($registration_or_reg_id);
+
+		$query_params = [
+			0          => [
+				'Payment.Registration.REG_ID' => $registration_id,
+			],
+			'order_by' => ['Payment.PAY_ID' => 'DESC'],
+		];
+		return $this->get_one($query_params);
+	}
 }

Spacing +6 added lines, -6 removed lines

@@ -167,7 +167,7 @@ 
     public function is_valid_scope($scope)
     {
         $scopes = $this->scopes();
-        if (isset($scopes[ $scope ])) {
+        if (isset($scopes[$scope])) {
             return true;
         }
         return false;
@@ -184,7 +184,7 @@ 
      */
     public function get_all_active($scope = null, $query_params = [])
     {
-        if (! isset($query_params['order_by']) && ! isset($query_params['order'])) {
+        if ( ! isset($query_params['order_by']) && ! isset($query_params['order'])) {
             $query_params['order_by'] = ['PMD_order' => 'ASC', 'PMD_ID' => 'ASC'];
         }
         return $this->get_all($this->_get_query_params_for_all_active($scope, $query_params));
@@ -232,7 +232,7 @@ 
         $count             = 0;
         foreach ($this->scopes() as $scope_name => $desc) {
             $count++;
-            $acceptable_scopes[ 'PMD_scope*' . $count ] = ['LIKE', '%' . $scope_name . '%'];
+            $acceptable_scopes['PMD_scope*'.$count] = ['LIKE', '%'.$scope_name.'%'];
         }
         return array_replace_recursive([['OR*active_scope' => $acceptable_scopes]], $query_params);
     }
@@ -392,7 +392,7 @@ 
             // check if the payment method type exists and force recheck
             $pm_type_exists = $PMM->payment_method_type_exists($payment_method->type(), true);
             if ($pm_type_exists) {
-                $usable_payment_methods[ $key ] = $payment_method;
+                $usable_payment_methods[$key] = $payment_method;
                 // some payment methods enqueue their scripts in EE_PMT_*::__construct
                 // which is kinda a no-no (just because it's being constructed doesn't mean we need to enqueue
                 // its scripts). but for backwards-compat we should continue to do that
@@ -406,7 +406,7 @@ 
                     $payment_method
                 );
                 new PersistentAdminNotice(
-                    'auto-deactivated-' . $payment_method->type(),
+                    'auto-deactivated-'.$payment_method->type(),
                     sprintf(
                         esc_html__(
                             'The payment method %1$s was automatically deactivated because it appears its associated Event Espresso Addon was recently deactivated.%2$sIt can be reactivated on the %3$sPlugins admin page%4$s, then you can reactivate the payment method.',
@@ -414,7 +414,7 @@ 
                         ),
                         $payment_method->admin_name(),
                         '<br />',
-                        '<a href="' . admin_url('plugins.php') . '">',
+                        '<a href="'.admin_url('plugins.php').'">',
                         '</a>'
                     ),
                     true

core/admin/EE_Admin_List_Table.core.php

Indentation +972 added lines, -972 removed lines

@@ -6,7 +6,7 @@ 
 use EventEspresso\core\services\request\sanitizers\AllowedTags;
 
 if (! class_exists('WP_List_Table')) {
-    require_once ABSPATH . 'wp-admin/includes/class-wp-list-table.php';
+	require_once ABSPATH . 'wp-admin/includes/class-wp-list-table.php';
 }
 
 
@@ -24,465 +24,465 @@ 
  */
 abstract class EE_Admin_List_Table extends WP_List_Table
 {
-    const ACTION_COPY    = 'duplicate';
-
-    const ACTION_DELETE  = 'delete';
-
-    const ACTION_EDIT    = 'edit';
-
-    const ACTION_RESTORE = 'restore';
-
-    const ACTION_TRASH   = 'trash';
-
-    protected static array $actions = [
-        self::ACTION_COPY,
-        self::ACTION_DELETE,
-        self::ACTION_EDIT,
-        self::ACTION_RESTORE,
-        self::ACTION_TRASH,
-    ];
-
-    /**
-     * holds the data that will be processed for the table
-     *
-     * @var array $_data
-     */
-    protected array $_data;
-
-
-    /**
-     * This holds the value of all the data available for the given view (for all pages).
-     *
-     * @var int $_all_data_count
-     */
-    protected int $_all_data_count;
-
-
-    /**
-     * Will contain the count of trashed items for the view label.
-     *
-     * @var int $_trashed_count
-     */
-    protected int $_trashed_count;
-
-
-    /**
-     * This is what will be referenced as the slug for the current screen
-     *
-     * @var string $_screen
-     */
-    protected string $_screen;
-
-
-    /**
-     * this is the EE_Admin_Page object
-     *
-     * @var EE_Admin_Page $_admin_page
-     */
-    protected EE_Admin_Page $_admin_page;
-
-
-    /**
-     * The current view
-     *
-     * @var string $_view
-     */
-    protected string $_view;
-
-
-    /**
-     * array of possible views for this table
-     *
-     * @var array $_views
-     */
-    protected array $_views;
-
-
-    /**
-     * An array of key => value pairs containing information about the current table
-     * array(
-     *        'plural' => 'plural label',
-     *        'singular' => 'singular label',
-     *        'ajax' => false, //whether to use ajax or not
-     *        'screen' => null, //string used to reference what screen this is
-     *        (WP_List_table converts to screen object)
-     * )
-     *
-     * @var array $_wp_list_args
-     */
-    protected array $_wp_list_args;
-
-    /**
-     * an array of column names
-     * array(
-     *    'internal-name' => 'Title'
-     * )
-     *
-     * @var array $_columns
-     */
-    protected array $_columns;
-
-    /**
-     * An array of sortable columns
-     * array(
-     *    'internal-name' => 'orderby' //or
-     *    'internal-name' => array( 'orderby', true )
-     * )
-     *
-     * @var array $_sortable_columns
-     */
-    protected array $_sortable_columns;
-
-    /**
-     * callback method used to perform AJAX row reordering
-     *
-     * @var string|null $_ajax_sorting_callback
-     */
-    protected ?string $_ajax_sorting_callback = null;
-
-    /**
-     * An array of hidden columns (if needed)
-     * array('internal-name', 'internal-name')
-     *
-     * @var array $_hidden_columns
-     */
-    protected array $_hidden_columns;
-
-    /**
-     * holds the per_page value
-     *
-     * @var int $_per_page
-     */
-    protected int $_per_page;
-
-    /**
-     * holds what page number is currently being viewed
-     *
-     * @var int $_current_page
-     */
-    protected int $_current_page;
-
-    /**
-     * the reference string for the nonce_action
-     *
-     * @var string $_nonce_action_ref
-     */
-    protected string $_nonce_action_ref;
-
-    /**
-     * property to hold incoming request data (as set by the admin_page_core)
-     *
-     * @var array $_req_data
-     */
-    protected array $_req_data;
-
-
-    /**
-     * yes / no array for admin form fields
-     *
-     * @var array $_yes_no
-     */
-    protected array $_yes_no = [];
-
-    /**
-     * Array describing buttons that should appear at the bottom of the page
-     * Keys are strings that represent the button's function (specifically a key in _labels['buttons']),
-     * and the values are another array with the following keys
-     * array(
-     *    'route' => 'page_route',
-     *    'extra_request' => array('evt_id' => 1 ); //extra request vars that need to be included in the button.
-     * )
-     *
-     * @var array $_bottom_buttons
-     */
-    protected array $_bottom_buttons = [];
-
-
-    /**
-     * Used to indicate what should be the primary column for the list table.
-     * If not present then falls back to what WP calculates
-     * as the primary column.
-     *
-     * @type string $_primary_column
-     */
-    protected string $_primary_column = '';
-
-
-    /**
-     * Used to indicate whether the table has a checkbox column or not.
-     *
-     * @type bool $_has_checkbox_column
-     */
-    protected bool $_has_checkbox_column = false;
-
-    /**
-     * @var AdminListTableFilters|null
-     */
-    protected ?AdminListTableFilters $admin_list_table_filters = null;
-
-    protected ?RequestInterface $request = null;
-
-
-    /**
-     * @param EE_Admin_Page              $admin_page we use this for obtaining everything we need in the list table
-     * @param AdminListTableFilters|null $filters    to display list table filters
-     */
-    public function __construct(EE_Admin_Page $admin_page, ?AdminListTableFilters $filters = null)
-    {
-        $this->request     = $this->request ?? LoaderFactory::getShared(RequestInterface::class);
-        $this->_admin_page = $admin_page;
-        // kept for back compat
-        $this->_req_data     = $this->_admin_page->get_request_data();
-        $this->_view         = $this->_admin_page->get_view();
-        $this->_views        = $this->_admin_page->get_list_table_view_RLs();
-        $this->_current_page = $this->get_pagenum();
-        $this->_screen       = $this->_admin_page->get_current_page() . '_' . $this->_admin_page->get_current_view();
-        $this->_yes_no       = [
-            esc_html__('No', 'event_espresso'),
-            esc_html__('Yes', 'event_espresso'),
-        ];
-
-        $this->_per_page = $this->get_items_per_page($this->_screen . '_per_page');
-
-        $this->admin_list_table_filters = $filters instanceof AdminListTableFilters
-            ? $filters
-            : LoaderFactory::getShared(AdminListTableFilters::class);
-
-        $this->_setup_data();
-        $this->_add_view_counts();
-        // ensure changes made to views in child classes get ported back to the admin page
-        $this->_admin_page->updateViews($this->_views);
-
-        $this->_nonce_action_ref = $this->_view;
-
-        $this->_set_properties();
-
-        // set primary column
-        add_filter('list_table_primary_column', [$this, 'set_primary_column']);
-
-        // set parent defaults
-        parent::__construct($this->_wp_list_args);
-
-        $this->prepare_items();
-    }
-
-
-    /**
-     * _setup_data
-     * this method is used to setup the $_data, $_all_data_count, and _per_page properties
-     *
-     * @return void
-     * @uses $this->_admin_page
-     */
-    abstract protected function _setup_data();
-
-
-    /**
-     * set the properties that this class needs to be able to execute wp_list_table properly
-     * properties set:
-     * _wp_list_args = what the arguments required for the parent _wp_list_table.
-     * _columns = set the columns in an array.
-     * _sortable_columns = columns that are sortable (array).
-     * _hidden_columns = columns that are hidden (array)
-     * _default_orderby = the default orderby for sorting.
-     *
-     * @abstract
-     * @access protected
-     * @return void
-     */
-    abstract protected function _set_properties();
-
-
-    /**
-     * _get_table_filters
-     * We use this to assemble and return any filters that are associated with this table that help further refine what
-     * gets shown in the table.
-     *
-     * @abstract
-     * @access protected
-     * @return string[]
-     */
-    abstract protected function _get_table_filters();
-
-
-    /**
-     * this is a method that child class will do to add counts to the views array so when views are displayed the
-     * counts of the views is accurate.
-     *
-     * @abstract
-     * @access protected
-     * @return void
-     */
-    abstract protected function _add_view_counts();
-
-
-    /**
-     * _get_hidden_fields
-     * returns a html string of hidden fields so if any table filters are used the current view will be respected.
-     *
-     * @return string
-     */
-    protected function _get_hidden_fields()
-    {
-        $page   = $this->request->getRequestParam('page', '');
-        $action = $this->request->getRequestParam('route', '');
-        $action = $this->request->getRequestParam('action', $action);
-        // if action is STILL empty, then we set it to default
-        $action = empty($action) || $action === '-1' ? 'default' : $action;
-        $field  = '<input type="hidden" name="page" value="' . esc_attr($page) . '" />' . "\n";
-        $field  .= '<input type="hidden" name="route" value="' . esc_attr($action) . '" />' . "\n";
-        $field  .= '<input type="hidden" name="perpage" value="' . esc_attr($this->_per_page) . '" />' . "\n";
-
-        $bulk_actions = $this->_get_bulk_actions();
-        foreach ($bulk_actions as $bulk_action => $label) {
-            $field .= '<input type="hidden" name="' . $bulk_action . '_nonce"'
-                . ' value="' . wp_create_nonce($bulk_action . '_nonce') . '" />' . "\n";
-        }
-
-        return $field;
-    }
-
-
-    /**
-     * _set_column_info
-     * we're using this to set the column headers property.
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _set_column_info()
-    {
-        $columns   = $this->get_columns();
-        $hidden    = $this->get_hidden_columns();
-        $_sortable = $this->get_sortable_columns();
-
-        /**
-         * Dynamic hook allowing for adding sortable columns in this list table.
-         * Note that $this->screen->id is in the format
-         * {sanitize_title($top_level_menu_label)}_page_{$espresso_admin_page_slug}.  So for the messages list
-         * table it is: event-espresso_page_espresso_messages.
-         * However, take note that if the top level menu label has been translated (i.e. "Event Espresso"). then the
-         * hook prefix ("event-espresso") will be different.
-         *
-         * @var array $_sortable
-         */
-        $_sortable = apply_filters(
-            "FHEE_manage_{$this->screen->id}_sortable_columns",
-            $_sortable,
-            $this->_screen,
-            $this
-        );
-
-        $sortable = [];
-        foreach ($_sortable as $id => $data) {
-            if (empty($data)) {
-                continue;
-            }
-            // fix for offset errors with WP_List_Table default get_columninfo()
-            if (is_array($data)) {
-                $_data[0] = key($data);
-                $_data[1] = $data[1] ?? false;
-            } else {
-                $_data[0] = $data;
-            }
-
-            $data = (array) $data;
-
-            if (! isset($data[1])) {
-                $_data[1] = false;
-            }
-
-            $sortable[ $id ] = $_data;
-        }
-        $primary               = $this->get_primary_column_name();
-        $this->_column_headers = [$columns, $hidden, $sortable, $primary];
-    }
-
-
-    /**
-     * Added for WP4.1 backward compat (@see https://events.codebasehq.com/projects/event-espresso/tickets/8814)
-     *
-     * @return string
-     */
-    protected function get_primary_column_name()
-    {
-        foreach (class_parents($this) as $parent) {
-            if ($parent === 'WP_List_Table' && method_exists($parent, 'get_primary_column_name')) {
-                return parent::get_primary_column_name();
-            }
-        }
-        return $this->_primary_column;
-    }
-
-
-    /**
-     * Added for WP4.1 backward compat (@see https://events.codebasehq.com/projects/event-espresso/tickets/8814)
-     *
-     * @param EE_Base_Class $item
-     * @param string        $column_name
-     * @param string        $primary
-     * @return string
-     */
-    protected function handle_row_actions($item, $column_name, $primary)
-    {
-        foreach (class_parents($this) as $parent) {
-            if ($parent === 'WP_List_Table' && method_exists($parent, 'handle_row_actions')) {
-                return parent::handle_row_actions($item, $column_name, $primary);
-            }
-        }
-        return '';
-    }
-
-
-    /**
-     * _get_bulk_actions
-     * This is a wrapper called by WP_List_Table::get_bulk_actions()
-     *
-     * @access protected
-     * @return array bulk_actions
-     */
-    protected function _get_bulk_actions(): array
-    {
-        $actions = [];
-        // the _views property should have the bulk_actions, so let's go through and extract them into a properly
-        // formatted array for the wp_list_table();
-        foreach ($this->_views as $view => $args) {
-            if ($this->_view === $view && isset($args['bulk_action']) && is_array($args['bulk_action'])) {
-                // each bulk action will correspond with a admin page route, so we can check whatever the capability is
-                // for that page route and skip adding the bulk action if no access for the current logged in user.
-                foreach ($args['bulk_action'] as $route => $label) {
-                    if ($this->_admin_page->check_user_access($route, true)) {
-                        $actions[ $route ] = $label;
-                    }
-                }
-            }
-        }
-        return $actions;
-    }
-
-
-    /**
-     * Generate the table navigation above or below the table.
-     * Overrides the parent table nav in WP_List_Table so we can hide the bulk action div if there are no bulk actions.
-     *
-     * @throws EE_Error
-     * @since 4.9.44.rc.001
-     */
-    public function display_tablenav($which)
-    {
-        if ('top' === $which) {
-            wp_nonce_field('bulk-' . $this->_args['plural']);
-        }
-
-        ob_start();
-        $this->extra_tablenav($which);
-        $ee_tablenav = ob_get_clean();
-
-        ob_start();
-        $this->bulk_actions();
-        $bulkactions = ob_get_clean();
-
-        ?>
+	const ACTION_COPY    = 'duplicate';
+
+	const ACTION_DELETE  = 'delete';
+
+	const ACTION_EDIT    = 'edit';
+
+	const ACTION_RESTORE = 'restore';
+
+	const ACTION_TRASH   = 'trash';
+
+	protected static array $actions = [
+		self::ACTION_COPY,
+		self::ACTION_DELETE,
+		self::ACTION_EDIT,
+		self::ACTION_RESTORE,
+		self::ACTION_TRASH,
+	];
+
+	/**
+	 * holds the data that will be processed for the table
+	 *
+	 * @var array $_data
+	 */
+	protected array $_data;
+
+
+	/**
+	 * This holds the value of all the data available for the given view (for all pages).
+	 *
+	 * @var int $_all_data_count
+	 */
+	protected int $_all_data_count;
+
+
+	/**
+	 * Will contain the count of trashed items for the view label.
+	 *
+	 * @var int $_trashed_count
+	 */
+	protected int $_trashed_count;
+
+
+	/**
+	 * This is what will be referenced as the slug for the current screen
+	 *
+	 * @var string $_screen
+	 */
+	protected string $_screen;
+
+
+	/**
+	 * this is the EE_Admin_Page object
+	 *
+	 * @var EE_Admin_Page $_admin_page
+	 */
+	protected EE_Admin_Page $_admin_page;
+
+
+	/**
+	 * The current view
+	 *
+	 * @var string $_view
+	 */
+	protected string $_view;
+
+
+	/**
+	 * array of possible views for this table
+	 *
+	 * @var array $_views
+	 */
+	protected array $_views;
+
+
+	/**
+	 * An array of key => value pairs containing information about the current table
+	 * array(
+	 *        'plural' => 'plural label',
+	 *        'singular' => 'singular label',
+	 *        'ajax' => false, //whether to use ajax or not
+	 *        'screen' => null, //string used to reference what screen this is
+	 *        (WP_List_table converts to screen object)
+	 * )
+	 *
+	 * @var array $_wp_list_args
+	 */
+	protected array $_wp_list_args;
+
+	/**
+	 * an array of column names
+	 * array(
+	 *    'internal-name' => 'Title'
+	 * )
+	 *
+	 * @var array $_columns
+	 */
+	protected array $_columns;
+
+	/**
+	 * An array of sortable columns
+	 * array(
+	 *    'internal-name' => 'orderby' //or
+	 *    'internal-name' => array( 'orderby', true )
+	 * )
+	 *
+	 * @var array $_sortable_columns
+	 */
+	protected array $_sortable_columns;
+
+	/**
+	 * callback method used to perform AJAX row reordering
+	 *
+	 * @var string|null $_ajax_sorting_callback
+	 */
+	protected ?string $_ajax_sorting_callback = null;
+
+	/**
+	 * An array of hidden columns (if needed)
+	 * array('internal-name', 'internal-name')
+	 *
+	 * @var array $_hidden_columns
+	 */
+	protected array $_hidden_columns;
+
+	/**
+	 * holds the per_page value
+	 *
+	 * @var int $_per_page
+	 */
+	protected int $_per_page;
+
+	/**
+	 * holds what page number is currently being viewed
+	 *
+	 * @var int $_current_page
+	 */
+	protected int $_current_page;
+
+	/**
+	 * the reference string for the nonce_action
+	 *
+	 * @var string $_nonce_action_ref
+	 */
+	protected string $_nonce_action_ref;
+
+	/**
+	 * property to hold incoming request data (as set by the admin_page_core)
+	 *
+	 * @var array $_req_data
+	 */
+	protected array $_req_data;
+
+
+	/**
+	 * yes / no array for admin form fields
+	 *
+	 * @var array $_yes_no
+	 */
+	protected array $_yes_no = [];
+
+	/**
+	 * Array describing buttons that should appear at the bottom of the page
+	 * Keys are strings that represent the button's function (specifically a key in _labels['buttons']),
+	 * and the values are another array with the following keys
+	 * array(
+	 *    'route' => 'page_route',
+	 *    'extra_request' => array('evt_id' => 1 ); //extra request vars that need to be included in the button.
+	 * )
+	 *
+	 * @var array $_bottom_buttons
+	 */
+	protected array $_bottom_buttons = [];
+
+
+	/**
+	 * Used to indicate what should be the primary column for the list table.
+	 * If not present then falls back to what WP calculates
+	 * as the primary column.
+	 *
+	 * @type string $_primary_column
+	 */
+	protected string $_primary_column = '';
+
+
+	/**
+	 * Used to indicate whether the table has a checkbox column or not.
+	 *
+	 * @type bool $_has_checkbox_column
+	 */
+	protected bool $_has_checkbox_column = false;
+
+	/**
+	 * @var AdminListTableFilters|null
+	 */
+	protected ?AdminListTableFilters $admin_list_table_filters = null;
+
+	protected ?RequestInterface $request = null;
+
+
+	/**
+	 * @param EE_Admin_Page              $admin_page we use this for obtaining everything we need in the list table
+	 * @param AdminListTableFilters|null $filters    to display list table filters
+	 */
+	public function __construct(EE_Admin_Page $admin_page, ?AdminListTableFilters $filters = null)
+	{
+		$this->request     = $this->request ?? LoaderFactory::getShared(RequestInterface::class);
+		$this->_admin_page = $admin_page;
+		// kept for back compat
+		$this->_req_data     = $this->_admin_page->get_request_data();
+		$this->_view         = $this->_admin_page->get_view();
+		$this->_views        = $this->_admin_page->get_list_table_view_RLs();
+		$this->_current_page = $this->get_pagenum();
+		$this->_screen       = $this->_admin_page->get_current_page() . '_' . $this->_admin_page->get_current_view();
+		$this->_yes_no       = [
+			esc_html__('No', 'event_espresso'),
+			esc_html__('Yes', 'event_espresso'),
+		];
+
+		$this->_per_page = $this->get_items_per_page($this->_screen . '_per_page');
+
+		$this->admin_list_table_filters = $filters instanceof AdminListTableFilters
+			? $filters
+			: LoaderFactory::getShared(AdminListTableFilters::class);
+
+		$this->_setup_data();
+		$this->_add_view_counts();
+		// ensure changes made to views in child classes get ported back to the admin page
+		$this->_admin_page->updateViews($this->_views);
+
+		$this->_nonce_action_ref = $this->_view;
+
+		$this->_set_properties();
+
+		// set primary column
+		add_filter('list_table_primary_column', [$this, 'set_primary_column']);
+
+		// set parent defaults
+		parent::__construct($this->_wp_list_args);
+
+		$this->prepare_items();
+	}
+
+
+	/**
+	 * _setup_data
+	 * this method is used to setup the $_data, $_all_data_count, and _per_page properties
+	 *
+	 * @return void
+	 * @uses $this->_admin_page
+	 */
+	abstract protected function _setup_data();
+
+
+	/**
+	 * set the properties that this class needs to be able to execute wp_list_table properly
+	 * properties set:
+	 * _wp_list_args = what the arguments required for the parent _wp_list_table.
+	 * _columns = set the columns in an array.
+	 * _sortable_columns = columns that are sortable (array).
+	 * _hidden_columns = columns that are hidden (array)
+	 * _default_orderby = the default orderby for sorting.
+	 *
+	 * @abstract
+	 * @access protected
+	 * @return void
+	 */
+	abstract protected function _set_properties();
+
+
+	/**
+	 * _get_table_filters
+	 * We use this to assemble and return any filters that are associated with this table that help further refine what
+	 * gets shown in the table.
+	 *
+	 * @abstract
+	 * @access protected
+	 * @return string[]
+	 */
+	abstract protected function _get_table_filters();
+
+
+	/**
+	 * this is a method that child class will do to add counts to the views array so when views are displayed the
+	 * counts of the views is accurate.
+	 *
+	 * @abstract
+	 * @access protected
+	 * @return void
+	 */
+	abstract protected function _add_view_counts();
+
+
+	/**
+	 * _get_hidden_fields
+	 * returns a html string of hidden fields so if any table filters are used the current view will be respected.
+	 *
+	 * @return string
+	 */
+	protected function _get_hidden_fields()
+	{
+		$page   = $this->request->getRequestParam('page', '');
+		$action = $this->request->getRequestParam('route', '');
+		$action = $this->request->getRequestParam('action', $action);
+		// if action is STILL empty, then we set it to default
+		$action = empty($action) || $action === '-1' ? 'default' : $action;
+		$field  = '<input type="hidden" name="page" value="' . esc_attr($page) . '" />' . "\n";
+		$field  .= '<input type="hidden" name="route" value="' . esc_attr($action) . '" />' . "\n";
+		$field  .= '<input type="hidden" name="perpage" value="' . esc_attr($this->_per_page) . '" />' . "\n";
+
+		$bulk_actions = $this->_get_bulk_actions();
+		foreach ($bulk_actions as $bulk_action => $label) {
+			$field .= '<input type="hidden" name="' . $bulk_action . '_nonce"'
+				. ' value="' . wp_create_nonce($bulk_action . '_nonce') . '" />' . "\n";
+		}
+
+		return $field;
+	}
+
+
+	/**
+	 * _set_column_info
+	 * we're using this to set the column headers property.
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _set_column_info()
+	{
+		$columns   = $this->get_columns();
+		$hidden    = $this->get_hidden_columns();
+		$_sortable = $this->get_sortable_columns();
+
+		/**
+		 * Dynamic hook allowing for adding sortable columns in this list table.
+		 * Note that $this->screen->id is in the format
+		 * {sanitize_title($top_level_menu_label)}_page_{$espresso_admin_page_slug}.  So for the messages list
+		 * table it is: event-espresso_page_espresso_messages.
+		 * However, take note that if the top level menu label has been translated (i.e. "Event Espresso"). then the
+		 * hook prefix ("event-espresso") will be different.
+		 *
+		 * @var array $_sortable
+		 */
+		$_sortable = apply_filters(
+			"FHEE_manage_{$this->screen->id}_sortable_columns",
+			$_sortable,
+			$this->_screen,
+			$this
+		);
+
+		$sortable = [];
+		foreach ($_sortable as $id => $data) {
+			if (empty($data)) {
+				continue;
+			}
+			// fix for offset errors with WP_List_Table default get_columninfo()
+			if (is_array($data)) {
+				$_data[0] = key($data);
+				$_data[1] = $data[1] ?? false;
+			} else {
+				$_data[0] = $data;
+			}
+
+			$data = (array) $data;
+
+			if (! isset($data[1])) {
+				$_data[1] = false;
+			}
+
+			$sortable[ $id ] = $_data;
+		}
+		$primary               = $this->get_primary_column_name();
+		$this->_column_headers = [$columns, $hidden, $sortable, $primary];
+	}
+
+
+	/**
+	 * Added for WP4.1 backward compat (@see https://events.codebasehq.com/projects/event-espresso/tickets/8814)
+	 *
+	 * @return string
+	 */
+	protected function get_primary_column_name()
+	{
+		foreach (class_parents($this) as $parent) {
+			if ($parent === 'WP_List_Table' && method_exists($parent, 'get_primary_column_name')) {
+				return parent::get_primary_column_name();
+			}
+		}
+		return $this->_primary_column;
+	}
+
+
+	/**
+	 * Added for WP4.1 backward compat (@see https://events.codebasehq.com/projects/event-espresso/tickets/8814)
+	 *
+	 * @param EE_Base_Class $item
+	 * @param string        $column_name
+	 * @param string        $primary
+	 * @return string
+	 */
+	protected function handle_row_actions($item, $column_name, $primary)
+	{
+		foreach (class_parents($this) as $parent) {
+			if ($parent === 'WP_List_Table' && method_exists($parent, 'handle_row_actions')) {
+				return parent::handle_row_actions($item, $column_name, $primary);
+			}
+		}
+		return '';
+	}
+
+
+	/**
+	 * _get_bulk_actions
+	 * This is a wrapper called by WP_List_Table::get_bulk_actions()
+	 *
+	 * @access protected
+	 * @return array bulk_actions
+	 */
+	protected function _get_bulk_actions(): array
+	{
+		$actions = [];
+		// the _views property should have the bulk_actions, so let's go through and extract them into a properly
+		// formatted array for the wp_list_table();
+		foreach ($this->_views as $view => $args) {
+			if ($this->_view === $view && isset($args['bulk_action']) && is_array($args['bulk_action'])) {
+				// each bulk action will correspond with a admin page route, so we can check whatever the capability is
+				// for that page route and skip adding the bulk action if no access for the current logged in user.
+				foreach ($args['bulk_action'] as $route => $label) {
+					if ($this->_admin_page->check_user_access($route, true)) {
+						$actions[ $route ] = $label;
+					}
+				}
+			}
+		}
+		return $actions;
+	}
+
+
+	/**
+	 * Generate the table navigation above or below the table.
+	 * Overrides the parent table nav in WP_List_Table so we can hide the bulk action div if there are no bulk actions.
+	 *
+	 * @throws EE_Error
+	 * @since 4.9.44.rc.001
+	 */
+	public function display_tablenav($which)
+	{
+		if ('top' === $which) {
+			wp_nonce_field('bulk-' . $this->_args['plural']);
+		}
+
+		ob_start();
+		$this->extra_tablenav($which);
+		$ee_tablenav = ob_get_clean();
+
+		ob_start();
+		$this->bulk_actions();
+		$bulkactions = ob_get_clean();
+
+		?>
     <?php if ($ee_tablenav && $which === 'top') : ?>
     <div class="tablenav <?php echo esc_attr($which); ?> ee-tablenav">
         <?php echo wp_kses($ee_tablenav, AllowedTags::getWithFormTags()); ?>
@@ -502,484 +502,484 @@ 
     </div>
     <?php endif; ?>
         <?php
-        if ($which === 'top') {
-            echo wp_kses($this->_get_hidden_fields(), AllowedTags::getWithFormTags());
-        }
-    }
-
-
-    /**
-     * _filters
-     * This receives the filters array from children _get_table_filters() and assembles the string including the filter
-     * button.
-     *
-     * @access private
-     * @return void  echos html showing filters
-     */
-    private function _filters(): void
-    {
-        $classname = get_class($this);
-        $filters   = apply_filters(
-            "FHEE__{$classname}__filters",
-            $this->_get_table_filters(),
-            $this,
-            $this->_screen
-        );
-
-        if (empty($filters)) {
-            return;
-        }
-
-        $this->admin_list_table_filters->filters(
-            $filters,
-            $this->get_admin_page()->get_current_page_view_url()
-        );
-    }
-
-
-    /**
-     * Callback for 'list_table_primary_column' WordPress filter
-     * If child EE_Admin_List_Table classes set the _primary_column property then that will be set as the primary
-     * column when class is instantiated.
-     *
-     * @param string $column_name
-     * @return string
-     * @see WP_List_Table::get_primary_column_name
-     */
-    public function set_primary_column($column_name)
-    {
-        return ! empty($this->_primary_column) ? $this->_primary_column : $column_name;
-    }
-
-
-    /**
-     *
-     */
-    public function prepare_items()
-    {
-        $this->_set_column_info();
-        $this->process_bulk_action();
-
-        $this->items = $this->_data;
-        $this->set_pagination_args(
-            [
-                'total_items' => $this->_all_data_count,
-                'per_page'    => $this->_per_page,
-                'total_pages' => (int) ceil($this->_all_data_count / $this->_per_page),
-            ]
-        );
-    }
-
-
-    /**
-     * @param object|array $item
-     * @return string html content for the column
-     */
-    protected function column_cb($item)
-    {
-        return '';
-    }
-
-
-    /**
-     * This column is the default for when there is no defined column method for a registered column.
-     * This can be overridden by child classes, but allows for hooking in for custom columns.
-     *
-     * @param EE_Base_Class $item
-     * @param string        $column_name The column being called.
-     * @return string html content for the column
-     */
-    public function column_default($item, $column_name)
-    {
-        /**
-         * Dynamic hook allowing for adding additional column content in this list table.
-         * Note that $this->screen->id is in the format
-         * {sanitize_title($top_level_menu_label)}_page_{$espresso_admin_page_slug}.  So for the messages list
-         * table it is: event-espresso_page_espresso_messages.
-         * However, take note that if the top level menu label has been translated (i.e. "Event Espresso"). then the
-         * hook prefix ("event-espresso") will be different.
-         */
-        ob_start();
-        do_action(
-            'AHEE__EE_Admin_List_Table__column_' . $column_name . '__' . $this->screen->id,
-            $item,
-            $this->_screen
-        );
-        $content = ob_get_clean();
-        return $column_name === 'actions' ? $this->actionsModalMenu($content) : $content;
-    }
-
-
-    /**
-     * Get a list of columns. The format is:
-     * 'internal-name' => 'Title'
-     *
-     * @return array
-     * @since  3.1.0
-     * @access public
-     * @abstract
-     */
-    public function get_columns()
-    {
-        /**
-         * Dynamic hook allowing for adding additional columns in this list table.
-         * Note that $this->screen->id is in the format
-         * {sanitize_title($top_level_menu_label)}_page_{$espresso_admin_page_slug}.  So for the messages list
-         * table it is: event-espresso_page_espresso_messages.
-         * However, take note that if the top level menu label has been translated (i.e. "Event Espresso"). then the
-         * hook prefix ("event-espresso") will be different.
-         *
-         * @var array
-         */
-        return apply_filters("FHEE_manage_{$this->screen->id}_columns", $this->_columns, $this->_screen, $this);
-    }
-
-
-    /**
-     * Get an associative array ( id => link ) with the list
-     * of views available on this table.
-     *
-     * @return array
-     * @since  3.1.0
-     * @access protected
-     */
-    public function get_views()
-    {
-        return $this->_views;
-    }
-
-
-    /**
-     * Generate the views html.
-     */
-    public function display_views()
-    {
-        $views           = $this->get_views();
-        $assembled_views = [];
-
-        if (empty($views)) {
-            return;
-        }
-        echo "<ul class='subsubsub'>\n";
-        foreach ($views as $view) {
-            $count = ! empty($view['count']) ? absint($view['count']) : 0;
-            if (isset($view['slug'], $view['class'], $view['url'], $view['label'])) {
-                $filter                           = "<li";
-                $filter                           .= $view['class'] ? " class='" . esc_attr($view['class']) . "'" : '';
-                $filter                           .= ">";
-                $filter                           .= '<a href="' . esc_url_raw($view['url']) . '">' . esc_html(
-                        $view['label']
-                    ) . '</a>';
-                $filter                           .= '<span class="count">(' . $count . ')</span>';
-                $filter                           .= '</li>';
-                $assembled_views[ $view['slug'] ] = $filter;
-            }
-        }
-
-        echo ! empty($assembled_views)
-            ? implode("<li style='margin:0 .5rem;'>|</li>", $assembled_views)
-            : '';
-        echo "</ul>";
-    }
-
-
-    /**
-     * Generates content for a single row of the table
-     *
-     * @param EE_Base_Class $item The current item
-     * @since  4.1
-     * @access public
-     */
-    public function single_row($item)
-    {
-        $row_class = $this->_get_row_class($item);
-        echo '<tr class="' . esc_attr($row_class) . '">';
-        $this->single_row_columns($item); // already escaped
-        echo '</tr>';
-    }
-
-
-    /**
-     * This simply sets up the row class for the table rows.
-     * Allows for easier overriding of child methods for setting up sorting.
-     *
-     * @param EE_Base_Class $item the current item
-     * @return string
-     */
-    protected function _get_row_class($item)
-    {
-        static $row_class = '';
-        $row_class = ($row_class === '' ? 'alternate' : '');
-
-        $new_row_class = $row_class;
-
-        if (! empty($this->_ajax_sorting_callback)) {
-            $new_row_class .= ' rowsortable';
-        }
-
-        return $new_row_class;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function get_sortable_columns()
-    {
-        return (array) $this->_sortable_columns;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function get_ajax_sorting_callback()
-    {
-        return $this->_ajax_sorting_callback;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function get_hidden_columns(): array
-    {
-        $user_id     = get_current_user_id();
-        $has_default = get_user_option('default' . $this->screen->id . 'columnshidden', $user_id);
-        if (empty($has_default) && ! empty($this->_hidden_columns)) {
-            update_user_option($user_id, 'default' . $this->screen->id . 'columnshidden', true);
-            update_user_option($user_id, 'manage' . $this->screen->id . 'columnshidden', $this->_hidden_columns, true);
-        }
-        $ref = 'manage' . $this->screen->id . 'columnshidden';
-        return (array) get_user_option($ref, $user_id);
-    }
-
-
-    /**
-     * Generates the columns for a single row of the table.
-     * Overridden from wp_list_table so as to allow us to filter the column content for a given
-     * column.
-     *
-     * @param EE_Base_Class $item The current item
-     * @since 3.1.0
-     */
-    public function single_row_columns($item)
-    {
-        [$columns, $hidden, $sortable, $primary] = $this->get_column_info();
-
-        foreach ($columns as $column_name => $column_display_name) {
-            /**
-             * With WordPress version 4.3.RC+ WordPress started using the hidden css class to control whether columns
-             * are hidden or not instead of using "display:none;".  This bit of code provides backward compat.
-             */
-            $hidden_class = in_array($column_name, $hidden) ? ' hidden' : '';
-
-            $classes = $column_name . ' column-' . $column_name . $hidden_class;
-            if ($primary === $column_name) {
-                $classes .= ' has-row-actions column-primary';
-            }
-
-            $data = ' data-colname="' . wp_strip_all_tags($column_display_name) . '"';
-
-            $class = 'class="' . esc_attr($classes) . '"';
-
-            $attributes = "$class$data";
-
-            if ($column_name === 'cb') {
-                echo '<th scope="row" class="check-column">';
-                echo apply_filters(
-                    'FHEE__EE_Admin_List_Table__single_row_columns__column_cb_content',
-                    $this->column_cb($item), // already escaped
-                    $item,
-                    $this
-                );
-                echo '</th>';
-            } elseif (method_exists($this, "column_$column_name")) {
-                echo "<td $attributes>"; // already escaped
-                echo apply_filters(
-                    'FHEE__EE_Admin_List_Table__single_row_columns__column_' . $column_name . '__column_content',
-                    call_user_func([$this, "column_$column_name"], $item),
-                    $item,
-                    $this
-                );
-                echo wp_kses($this->handle_row_actions($item, $column_name, $primary), AllowedTags::getWithFormTags());
-                echo "</td>";
-            } else {
-                echo "<td $attributes>"; // already escaped
-                echo apply_filters(
-                    'FHEE__EE_Admin_List_Table__single_row_columns__column_default__column_content',
-                    $this->column_default($item, $column_name),
-                    $item,
-                    $column_name,
-                    $this
-                );
-                echo wp_kses($this->handle_row_actions($item, $column_name, $primary), AllowedTags::getWithFormTags());
-                echo "</td>";
-            }
-        }
-    }
-
-
-    /**
-     * Extra controls to be displayed between bulk actions and pagination
-     *
-     * @access public
-     * @param string $which
-     * @throws EE_Error
-     */
-    public function extra_tablenav($which)
-    {
-        if ($which === 'top') {
-            $this->_filters();
-        } elseif($this->_bottom_buttons) {
-            echo '<div class="list-table-bottom-buttons alignleft actions">';
-            foreach ($this->_bottom_buttons as $type => $action) {
-                $route         = $action['route'] ?? '';
-                $extra_request = $action['extra_request'] ?? [];
-                $btn_class     = $action['btn_class'] ?? 'button button--secondary';
-                // already escaped
-                echo wp_kses(
-                    $this->_admin_page->get_action_link_or_button(
-                        $route,
-                        $type,
-                        $extra_request,
-                        $btn_class
-                    ),
-                    AllowedTags::getWithFormTags()
-                );
-            }
-            do_action('AHEE__EE_Admin_List_Table__extra_tablenav__after_bottom_buttons', $this, $this->_screen);
-            echo '</div>';
-        }
-    }
-
-
-    /**
-     * Get an associative array ( option_name => option_title ) with the list
-     * of bulk actions available on this table.
-     *
-     * @return array
-     * @since  3.1.0
-     * @access protected
-     */
-    public function get_bulk_actions()
-    {
-        return (array) $this->_get_bulk_actions();
-    }
-
-
-    /**
-     * Processing bulk actions.
-     */
-    public function process_bulk_action()
-    {
-        // this is not used it is handled by the child EE_Admin_Page class (routes).  However, including here for
-        // reference in case there is a case where it gets used.
-    }
-
-
-    /**
-     * returns the EE admin page this list table is associated with
-     *
-     * @return EE_Admin_Page
-     */
-    public function get_admin_page()
-    {
-        return $this->_admin_page;
-    }
-
-
-    /**
-     * A "helper" function for all children to provide an html string of
-     * actions to output in their content.  It is preferable for child classes
-     * to use this method for generating their actions content so that it's
-     * filterable by plugins
-     *
-     * @param string        $action_container           what are the html container
-     *                                                  elements for this actions string?
-     * @param string        $action_class               What class is for the container
-     *                                                  element.
-     * @param string        $action_items               The contents for the action items
-     *                                                  container.  This is filtered before
-     *                                                  returned.
-     * @param string        $action_id                  What id (optional) is used for the
-     *                                                  container element.
-     * @param EE_Base_Class $item                       The object for the column displaying
-     *                                                  the actions.
-     * @return string The assembled action elements container.
-     */
-    protected function _action_string(
-        $action_items,
-        $item,
-        $action_container = 'ul',
-        $action_class = '',
-        $action_id = ''
-    ) {
-        $action_class = ! empty($action_class) ? ' class="' . esc_attr($action_class) . '"' : '';
-        $action_id    = ! empty($action_id) ? ' id="' . esc_attr($action_id) . '"' : '';
-        $open_tag     = ! empty($action_container) ? '<' . $action_container . $action_class . $action_id . '>' : '';
-        $close_tag    = ! empty($action_container) ? '</' . $action_container . '>' : '';
-        try {
-            $content = apply_filters(
-                'FHEE__EE_Admin_List_Table___action_string__action_items',
-                $action_items,
-                $item,
-                $this
-            );
-        } catch (Exception $e) {
-            if (WP_DEBUG) {
-                EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
-            }
-            $content = $action_items;
-        }
-        return "$open_tag$content$close_tag";
-    }
-
-
-    /**
-     * @return string
-     */
-    protected function getReturnUrl()
-    {
-        $host = $this->_admin_page->get_request()->getServerParam('HTTP_HOST');
-        $uri  = $this->_admin_page->get_request()->getServerParam('REQUEST_URI');
-        return urlencode(esc_url_raw("//$host$uri"));
-    }
-
-
-    /**
-     * @param string $id
-     * @param string $content
-     * @param string $align  start (default), center, end
-     * @param string $layout row (default) or stack
-     * @return string
-     * @since   5.0.0.p
-     */
-    protected function columnContent(
-        string $id,
-        string $content,
-        string $align = 'start',
-        string $layout = 'row'
-    ): string {
-        if (! isset($this->_columns[ $id ])) {
-            throw new DomainException('missing column id');
-        }
-        $heading = $id !== 'cb' ? $this->_columns[ $id ] : '';
-        $align   = in_array($align, ['start', 'center', 'end']) ? $align : 'start';
-        $align   = "ee-responsive-table-cell--$align";
-        $layout  = $layout === 'row' ? 'ee-layout-row' : 'ee-layout-stack';
-
-        $html = "<div class='ee-responsive-table-cell ee-responsive-table-cell--column-$id $align $layout'>";
-        $html .= "<div class='ee-responsive-table-cell__heading'>$heading</div>";
-        $html .= "<div class='ee-responsive-table-cell__content $layout'>$content</div>";
-        $html .= "</div>";
-        return $html;
-    }
-
-
-    protected function actionsModalMenu($actions): string
-    {
-        return '
+		if ($which === 'top') {
+			echo wp_kses($this->_get_hidden_fields(), AllowedTags::getWithFormTags());
+		}
+	}
+
+
+	/**
+	 * _filters
+	 * This receives the filters array from children _get_table_filters() and assembles the string including the filter
+	 * button.
+	 *
+	 * @access private
+	 * @return void  echos html showing filters
+	 */
+	private function _filters(): void
+	{
+		$classname = get_class($this);
+		$filters   = apply_filters(
+			"FHEE__{$classname}__filters",
+			$this->_get_table_filters(),
+			$this,
+			$this->_screen
+		);
+
+		if (empty($filters)) {
+			return;
+		}
+
+		$this->admin_list_table_filters->filters(
+			$filters,
+			$this->get_admin_page()->get_current_page_view_url()
+		);
+	}
+
+
+	/**
+	 * Callback for 'list_table_primary_column' WordPress filter
+	 * If child EE_Admin_List_Table classes set the _primary_column property then that will be set as the primary
+	 * column when class is instantiated.
+	 *
+	 * @param string $column_name
+	 * @return string
+	 * @see WP_List_Table::get_primary_column_name
+	 */
+	public function set_primary_column($column_name)
+	{
+		return ! empty($this->_primary_column) ? $this->_primary_column : $column_name;
+	}
+
+
+	/**
+	 *
+	 */
+	public function prepare_items()
+	{
+		$this->_set_column_info();
+		$this->process_bulk_action();
+
+		$this->items = $this->_data;
+		$this->set_pagination_args(
+			[
+				'total_items' => $this->_all_data_count,
+				'per_page'    => $this->_per_page,
+				'total_pages' => (int) ceil($this->_all_data_count / $this->_per_page),
+			]
+		);
+	}
+
+
+	/**
+	 * @param object|array $item
+	 * @return string html content for the column
+	 */
+	protected function column_cb($item)
+	{
+		return '';
+	}
+
+
+	/**
+	 * This column is the default for when there is no defined column method for a registered column.
+	 * This can be overridden by child classes, but allows for hooking in for custom columns.
+	 *
+	 * @param EE_Base_Class $item
+	 * @param string        $column_name The column being called.
+	 * @return string html content for the column
+	 */
+	public function column_default($item, $column_name)
+	{
+		/**
+		 * Dynamic hook allowing for adding additional column content in this list table.
+		 * Note that $this->screen->id is in the format
+		 * {sanitize_title($top_level_menu_label)}_page_{$espresso_admin_page_slug}.  So for the messages list
+		 * table it is: event-espresso_page_espresso_messages.
+		 * However, take note that if the top level menu label has been translated (i.e. "Event Espresso"). then the
+		 * hook prefix ("event-espresso") will be different.
+		 */
+		ob_start();
+		do_action(
+			'AHEE__EE_Admin_List_Table__column_' . $column_name . '__' . $this->screen->id,
+			$item,
+			$this->_screen
+		);
+		$content = ob_get_clean();
+		return $column_name === 'actions' ? $this->actionsModalMenu($content) : $content;
+	}
+
+
+	/**
+	 * Get a list of columns. The format is:
+	 * 'internal-name' => 'Title'
+	 *
+	 * @return array
+	 * @since  3.1.0
+	 * @access public
+	 * @abstract
+	 */
+	public function get_columns()
+	{
+		/**
+		 * Dynamic hook allowing for adding additional columns in this list table.
+		 * Note that $this->screen->id is in the format
+		 * {sanitize_title($top_level_menu_label)}_page_{$espresso_admin_page_slug}.  So for the messages list
+		 * table it is: event-espresso_page_espresso_messages.
+		 * However, take note that if the top level menu label has been translated (i.e. "Event Espresso"). then the
+		 * hook prefix ("event-espresso") will be different.
+		 *
+		 * @var array
+		 */
+		return apply_filters("FHEE_manage_{$this->screen->id}_columns", $this->_columns, $this->_screen, $this);
+	}
+
+
+	/**
+	 * Get an associative array ( id => link ) with the list
+	 * of views available on this table.
+	 *
+	 * @return array
+	 * @since  3.1.0
+	 * @access protected
+	 */
+	public function get_views()
+	{
+		return $this->_views;
+	}
+
+
+	/**
+	 * Generate the views html.
+	 */
+	public function display_views()
+	{
+		$views           = $this->get_views();
+		$assembled_views = [];
+
+		if (empty($views)) {
+			return;
+		}
+		echo "<ul class='subsubsub'>\n";
+		foreach ($views as $view) {
+			$count = ! empty($view['count']) ? absint($view['count']) : 0;
+			if (isset($view['slug'], $view['class'], $view['url'], $view['label'])) {
+				$filter                           = "<li";
+				$filter                           .= $view['class'] ? " class='" . esc_attr($view['class']) . "'" : '';
+				$filter                           .= ">";
+				$filter                           .= '<a href="' . esc_url_raw($view['url']) . '">' . esc_html(
+						$view['label']
+					) . '</a>';
+				$filter                           .= '<span class="count">(' . $count . ')</span>';
+				$filter                           .= '</li>';
+				$assembled_views[ $view['slug'] ] = $filter;
+			}
+		}
+
+		echo ! empty($assembled_views)
+			? implode("<li style='margin:0 .5rem;'>|</li>", $assembled_views)
+			: '';
+		echo "</ul>";
+	}
+
+
+	/**
+	 * Generates content for a single row of the table
+	 *
+	 * @param EE_Base_Class $item The current item
+	 * @since  4.1
+	 * @access public
+	 */
+	public function single_row($item)
+	{
+		$row_class = $this->_get_row_class($item);
+		echo '<tr class="' . esc_attr($row_class) . '">';
+		$this->single_row_columns($item); // already escaped
+		echo '</tr>';
+	}
+
+
+	/**
+	 * This simply sets up the row class for the table rows.
+	 * Allows for easier overriding of child methods for setting up sorting.
+	 *
+	 * @param EE_Base_Class $item the current item
+	 * @return string
+	 */
+	protected function _get_row_class($item)
+	{
+		static $row_class = '';
+		$row_class = ($row_class === '' ? 'alternate' : '');
+
+		$new_row_class = $row_class;
+
+		if (! empty($this->_ajax_sorting_callback)) {
+			$new_row_class .= ' rowsortable';
+		}
+
+		return $new_row_class;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function get_sortable_columns()
+	{
+		return (array) $this->_sortable_columns;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function get_ajax_sorting_callback()
+	{
+		return $this->_ajax_sorting_callback;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function get_hidden_columns(): array
+	{
+		$user_id     = get_current_user_id();
+		$has_default = get_user_option('default' . $this->screen->id . 'columnshidden', $user_id);
+		if (empty($has_default) && ! empty($this->_hidden_columns)) {
+			update_user_option($user_id, 'default' . $this->screen->id . 'columnshidden', true);
+			update_user_option($user_id, 'manage' . $this->screen->id . 'columnshidden', $this->_hidden_columns, true);
+		}
+		$ref = 'manage' . $this->screen->id . 'columnshidden';
+		return (array) get_user_option($ref, $user_id);
+	}
+
+
+	/**
+	 * Generates the columns for a single row of the table.
+	 * Overridden from wp_list_table so as to allow us to filter the column content for a given
+	 * column.
+	 *
+	 * @param EE_Base_Class $item The current item
+	 * @since 3.1.0
+	 */
+	public function single_row_columns($item)
+	{
+		[$columns, $hidden, $sortable, $primary] = $this->get_column_info();
+
+		foreach ($columns as $column_name => $column_display_name) {
+			/**
+			 * With WordPress version 4.3.RC+ WordPress started using the hidden css class to control whether columns
+			 * are hidden or not instead of using "display:none;".  This bit of code provides backward compat.
+			 */
+			$hidden_class = in_array($column_name, $hidden) ? ' hidden' : '';
+
+			$classes = $column_name . ' column-' . $column_name . $hidden_class;
+			if ($primary === $column_name) {
+				$classes .= ' has-row-actions column-primary';
+			}
+
+			$data = ' data-colname="' . wp_strip_all_tags($column_display_name) . '"';
+
+			$class = 'class="' . esc_attr($classes) . '"';
+
+			$attributes = "$class$data";
+
+			if ($column_name === 'cb') {
+				echo '<th scope="row" class="check-column">';
+				echo apply_filters(
+					'FHEE__EE_Admin_List_Table__single_row_columns__column_cb_content',
+					$this->column_cb($item), // already escaped
+					$item,
+					$this
+				);
+				echo '</th>';
+			} elseif (method_exists($this, "column_$column_name")) {
+				echo "<td $attributes>"; // already escaped
+				echo apply_filters(
+					'FHEE__EE_Admin_List_Table__single_row_columns__column_' . $column_name . '__column_content',
+					call_user_func([$this, "column_$column_name"], $item),
+					$item,
+					$this
+				);
+				echo wp_kses($this->handle_row_actions($item, $column_name, $primary), AllowedTags::getWithFormTags());
+				echo "</td>";
+			} else {
+				echo "<td $attributes>"; // already escaped
+				echo apply_filters(
+					'FHEE__EE_Admin_List_Table__single_row_columns__column_default__column_content',
+					$this->column_default($item, $column_name),
+					$item,
+					$column_name,
+					$this
+				);
+				echo wp_kses($this->handle_row_actions($item, $column_name, $primary), AllowedTags::getWithFormTags());
+				echo "</td>";
+			}
+		}
+	}
+
+
+	/**
+	 * Extra controls to be displayed between bulk actions and pagination
+	 *
+	 * @access public
+	 * @param string $which
+	 * @throws EE_Error
+	 */
+	public function extra_tablenav($which)
+	{
+		if ($which === 'top') {
+			$this->_filters();
+		} elseif($this->_bottom_buttons) {
+			echo '<div class="list-table-bottom-buttons alignleft actions">';
+			foreach ($this->_bottom_buttons as $type => $action) {
+				$route         = $action['route'] ?? '';
+				$extra_request = $action['extra_request'] ?? [];
+				$btn_class     = $action['btn_class'] ?? 'button button--secondary';
+				// already escaped
+				echo wp_kses(
+					$this->_admin_page->get_action_link_or_button(
+						$route,
+						$type,
+						$extra_request,
+						$btn_class
+					),
+					AllowedTags::getWithFormTags()
+				);
+			}
+			do_action('AHEE__EE_Admin_List_Table__extra_tablenav__after_bottom_buttons', $this, $this->_screen);
+			echo '</div>';
+		}
+	}
+
+
+	/**
+	 * Get an associative array ( option_name => option_title ) with the list
+	 * of bulk actions available on this table.
+	 *
+	 * @return array
+	 * @since  3.1.0
+	 * @access protected
+	 */
+	public function get_bulk_actions()
+	{
+		return (array) $this->_get_bulk_actions();
+	}
+
+
+	/**
+	 * Processing bulk actions.
+	 */
+	public function process_bulk_action()
+	{
+		// this is not used it is handled by the child EE_Admin_Page class (routes).  However, including here for
+		// reference in case there is a case where it gets used.
+	}
+
+
+	/**
+	 * returns the EE admin page this list table is associated with
+	 *
+	 * @return EE_Admin_Page
+	 */
+	public function get_admin_page()
+	{
+		return $this->_admin_page;
+	}
+
+
+	/**
+	 * A "helper" function for all children to provide an html string of
+	 * actions to output in their content.  It is preferable for child classes
+	 * to use this method for generating their actions content so that it's
+	 * filterable by plugins
+	 *
+	 * @param string        $action_container           what are the html container
+	 *                                                  elements for this actions string?
+	 * @param string        $action_class               What class is for the container
+	 *                                                  element.
+	 * @param string        $action_items               The contents for the action items
+	 *                                                  container.  This is filtered before
+	 *                                                  returned.
+	 * @param string        $action_id                  What id (optional) is used for the
+	 *                                                  container element.
+	 * @param EE_Base_Class $item                       The object for the column displaying
+	 *                                                  the actions.
+	 * @return string The assembled action elements container.
+	 */
+	protected function _action_string(
+		$action_items,
+		$item,
+		$action_container = 'ul',
+		$action_class = '',
+		$action_id = ''
+	) {
+		$action_class = ! empty($action_class) ? ' class="' . esc_attr($action_class) . '"' : '';
+		$action_id    = ! empty($action_id) ? ' id="' . esc_attr($action_id) . '"' : '';
+		$open_tag     = ! empty($action_container) ? '<' . $action_container . $action_class . $action_id . '>' : '';
+		$close_tag    = ! empty($action_container) ? '</' . $action_container . '>' : '';
+		try {
+			$content = apply_filters(
+				'FHEE__EE_Admin_List_Table___action_string__action_items',
+				$action_items,
+				$item,
+				$this
+			);
+		} catch (Exception $e) {
+			if (WP_DEBUG) {
+				EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
+			}
+			$content = $action_items;
+		}
+		return "$open_tag$content$close_tag";
+	}
+
+
+	/**
+	 * @return string
+	 */
+	protected function getReturnUrl()
+	{
+		$host = $this->_admin_page->get_request()->getServerParam('HTTP_HOST');
+		$uri  = $this->_admin_page->get_request()->getServerParam('REQUEST_URI');
+		return urlencode(esc_url_raw("//$host$uri"));
+	}
+
+
+	/**
+	 * @param string $id
+	 * @param string $content
+	 * @param string $align  start (default), center, end
+	 * @param string $layout row (default) or stack
+	 * @return string
+	 * @since   5.0.0.p
+	 */
+	protected function columnContent(
+		string $id,
+		string $content,
+		string $align = 'start',
+		string $layout = 'row'
+	): string {
+		if (! isset($this->_columns[ $id ])) {
+			throw new DomainException('missing column id');
+		}
+		$heading = $id !== 'cb' ? $this->_columns[ $id ] : '';
+		$align   = in_array($align, ['start', 'center', 'end']) ? $align : 'start';
+		$align   = "ee-responsive-table-cell--$align";
+		$layout  = $layout === 'row' ? 'ee-layout-row' : 'ee-layout-stack';
+
+		$html = "<div class='ee-responsive-table-cell ee-responsive-table-cell--column-$id $align $layout'>";
+		$html .= "<div class='ee-responsive-table-cell__heading'>$heading</div>";
+		$html .= "<div class='ee-responsive-table-cell__content $layout'>$content</div>";
+		$html .= "</div>";
+		return $html;
+	}
+
+
+	protected function actionsModalMenu($actions): string
+	{
+		return '
         <div class="ee-modal-menu">
             <button class="ee-modal-menu__button button button--secondary button--icon-only ee-aria-tooltip"
                     aria-label="' . esc_attr__('list table actions menu', 'event_espresso') . '"
@@ -991,44 +991,44 @@ 
                 ' . $actions . '
             </div>
         </div>';
-    }
+	}
 
 
-    public function actionsColumnHeader(): string
-    {
-        return '
+	public function actionsColumnHeader(): string
+	{
+		return '
             <span class="ee-actions-column-header-wrap">
                 <span class="dashicons dashicons-screenoptions"></span>
                 <span class="ee-actions-column-header">' . esc_html__('Actions', 'event_espresso') . '</span>
             </span>';
-    }
-
-
-    protected function getActionLink(string $url, string $display_text, string $label, $class = ''): string
-    {
-        $class = ! empty($class) ? "$class ee-list-table-action" : 'ee-list-table-action';
-        $class = ! empty($label) ? "$class ee-aria-tooltip" : $class;
-        $label = ! empty($label) ? " aria-label='$label'" : '';
-        return "<a href='$url' class='$class'$label>$display_text</a>";
-    }
-
-
-    /**
-     * Override the search box method of WP List Table to include a reset button
-     *
-     * @param string $text     The 'submit' button label.
-     * @param string $input_id ID attribute value for the search input field.
-     */
-    public function search_box($text, $input_id)
-    {
-        if (empty($_REQUEST['s']) && ! $this->has_items()) {
-            return;
-        }
-
-        $this->admin_list_table_filters->searchBox(
-            $text,
-            $input_id,
-            $this->get_admin_page()->get_current_page_view_url()
-        );
-    }
+	}
+
+
+	protected function getActionLink(string $url, string $display_text, string $label, $class = ''): string
+	{
+		$class = ! empty($class) ? "$class ee-list-table-action" : 'ee-list-table-action';
+		$class = ! empty($label) ? "$class ee-aria-tooltip" : $class;
+		$label = ! empty($label) ? " aria-label='$label'" : '';
+		return "<a href='$url' class='$class'$label>$display_text</a>";
+	}
+
+
+	/**
+	 * Override the search box method of WP List Table to include a reset button
+	 *
+	 * @param string $text     The 'submit' button label.
+	 * @param string $input_id ID attribute value for the search input field.
+	 */
+	public function search_box($text, $input_id)
+	{
+		if (empty($_REQUEST['s']) && ! $this->has_items()) {
+			return;
+		}
+
+		$this->admin_list_table_filters->searchBox(
+			$text,
+			$input_id,
+			$this->get_admin_page()->get_current_page_view_url()
+		);
+	}
 }

Spacing +40 added lines, -40 removed lines

@@ -5,8 +5,8 @@ 
 use EventEspresso\core\services\request\RequestInterface;
 use EventEspresso\core\services\request\sanitizers\AllowedTags;
 
-if (! class_exists('WP_List_Table')) {
-    require_once ABSPATH . 'wp-admin/includes/class-wp-list-table.php';
+if ( ! class_exists('WP_List_Table')) {
+    require_once ABSPATH.'wp-admin/includes/class-wp-list-table.php';
 }
 
 
@@ -236,13 +236,13 @@ 
         $this->_view         = $this->_admin_page->get_view();
         $this->_views        = $this->_admin_page->get_list_table_view_RLs();
         $this->_current_page = $this->get_pagenum();
-        $this->_screen       = $this->_admin_page->get_current_page() . '_' . $this->_admin_page->get_current_view();
+        $this->_screen       = $this->_admin_page->get_current_page().'_'.$this->_admin_page->get_current_view();
         $this->_yes_no       = [
             esc_html__('No', 'event_espresso'),
             esc_html__('Yes', 'event_espresso'),
         ];
 
-        $this->_per_page = $this->get_items_per_page($this->_screen . '_per_page');
+        $this->_per_page = $this->get_items_per_page($this->_screen.'_per_page');
 
         $this->admin_list_table_filters = $filters instanceof AdminListTableFilters
             ? $filters
@@ -329,14 +329,14 @@ 
         $action = $this->request->getRequestParam('action', $action);
         // if action is STILL empty, then we set it to default
         $action = empty($action) || $action === '-1' ? 'default' : $action;
-        $field  = '<input type="hidden" name="page" value="' . esc_attr($page) . '" />' . "\n";
-        $field  .= '<input type="hidden" name="route" value="' . esc_attr($action) . '" />' . "\n";
-        $field  .= '<input type="hidden" name="perpage" value="' . esc_attr($this->_per_page) . '" />' . "\n";
+        $field  = '<input type="hidden" name="page" value="'.esc_attr($page).'" />'."\n";
+        $field  .= '<input type="hidden" name="route" value="'.esc_attr($action).'" />'."\n";
+        $field  .= '<input type="hidden" name="perpage" value="'.esc_attr($this->_per_page).'" />'."\n";
 
         $bulk_actions = $this->_get_bulk_actions();
         foreach ($bulk_actions as $bulk_action => $label) {
-            $field .= '<input type="hidden" name="' . $bulk_action . '_nonce"'
-                . ' value="' . wp_create_nonce($bulk_action . '_nonce') . '" />' . "\n";
+            $field .= '<input type="hidden" name="'.$bulk_action.'_nonce"'
+                . ' value="'.wp_create_nonce($bulk_action.'_nonce').'" />'."\n";
         }
 
         return $field;
@@ -388,11 +388,11 @@ 
 
             $data = (array) $data;
 
-            if (! isset($data[1])) {
+            if ( ! isset($data[1])) {
                 $_data[1] = false;
             }
 
-            $sortable[ $id ] = $_data;
+            $sortable[$id] = $_data;
         }
         $primary               = $this->get_primary_column_name();
         $this->_column_headers = [$columns, $hidden, $sortable, $primary];
@@ -452,7 +452,7 @@ 
                 // for that page route and skip adding the bulk action if no access for the current logged in user.
                 foreach ($args['bulk_action'] as $route => $label) {
                     if ($this->_admin_page->check_user_access($route, true)) {
-                        $actions[ $route ] = $label;
+                        $actions[$route] = $label;
                     }
                 }
             }
@@ -471,7 +471,7 @@ 
     public function display_tablenav($which)
     {
         if ('top' === $which) {
-            wp_nonce_field('bulk-' . $this->_args['plural']);
+            wp_nonce_field('bulk-'.$this->_args['plural']);
         }
 
         ob_start();
@@ -601,7 +601,7 @@ 
          */
         ob_start();
         do_action(
-            'AHEE__EE_Admin_List_Table__column_' . $column_name . '__' . $this->screen->id,
+            'AHEE__EE_Admin_List_Table__column_'.$column_name.'__'.$this->screen->id,
             $item,
             $this->_screen
         );
@@ -664,15 +664,15 @@ 
         foreach ($views as $view) {
             $count = ! empty($view['count']) ? absint($view['count']) : 0;
             if (isset($view['slug'], $view['class'], $view['url'], $view['label'])) {
-                $filter                           = "<li";
-                $filter                           .= $view['class'] ? " class='" . esc_attr($view['class']) . "'" : '';
+                $filter = "<li";
+                $filter                           .= $view['class'] ? " class='".esc_attr($view['class'])."'" : '';
                 $filter                           .= ">";
-                $filter                           .= '<a href="' . esc_url_raw($view['url']) . '">' . esc_html(
+                $filter                           .= '<a href="'.esc_url_raw($view['url']).'">'.esc_html(
                         $view['label']
-                    ) . '</a>';
-                $filter                           .= '<span class="count">(' . $count . ')</span>';
+                    ).'</a>';
+                $filter                           .= '<span class="count">('.$count.')</span>';
                 $filter                           .= '</li>';
-                $assembled_views[ $view['slug'] ] = $filter;
+                $assembled_views[$view['slug']] = $filter;
             }
         }
 
@@ -693,7 +693,7 @@ 
     public function single_row($item)
     {
         $row_class = $this->_get_row_class($item);
-        echo '<tr class="' . esc_attr($row_class) . '">';
+        echo '<tr class="'.esc_attr($row_class).'">';
         $this->single_row_columns($item); // already escaped
         echo '</tr>';
     }
@@ -713,7 +713,7 @@ 
 
         $new_row_class = $row_class;
 
-        if (! empty($this->_ajax_sorting_callback)) {
+        if ( ! empty($this->_ajax_sorting_callback)) {
             $new_row_class .= ' rowsortable';
         }
 
@@ -745,12 +745,12 @@ 
     public function get_hidden_columns(): array
     {
         $user_id     = get_current_user_id();
-        $has_default = get_user_option('default' . $this->screen->id . 'columnshidden', $user_id);
+        $has_default = get_user_option('default'.$this->screen->id.'columnshidden', $user_id);
         if (empty($has_default) && ! empty($this->_hidden_columns)) {
-            update_user_option($user_id, 'default' . $this->screen->id . 'columnshidden', true);
-            update_user_option($user_id, 'manage' . $this->screen->id . 'columnshidden', $this->_hidden_columns, true);
+            update_user_option($user_id, 'default'.$this->screen->id.'columnshidden', true);
+            update_user_option($user_id, 'manage'.$this->screen->id.'columnshidden', $this->_hidden_columns, true);
         }
-        $ref = 'manage' . $this->screen->id . 'columnshidden';
+        $ref = 'manage'.$this->screen->id.'columnshidden';
         return (array) get_user_option($ref, $user_id);
     }
 
@@ -774,14 +774,14 @@ 
              */
             $hidden_class = in_array($column_name, $hidden) ? ' hidden' : '';
 
-            $classes = $column_name . ' column-' . $column_name . $hidden_class;
+            $classes = $column_name.' column-'.$column_name.$hidden_class;
             if ($primary === $column_name) {
                 $classes .= ' has-row-actions column-primary';
             }
 
-            $data = ' data-colname="' . wp_strip_all_tags($column_display_name) . '"';
+            $data = ' data-colname="'.wp_strip_all_tags($column_display_name).'"';
 
-            $class = 'class="' . esc_attr($classes) . '"';
+            $class = 'class="'.esc_attr($classes).'"';
 
             $attributes = "$class$data";
 
@@ -797,7 +797,7 @@ 
             } elseif (method_exists($this, "column_$column_name")) {
                 echo "<td $attributes>"; // already escaped
                 echo apply_filters(
-                    'FHEE__EE_Admin_List_Table__single_row_columns__column_' . $column_name . '__column_content',
+                    'FHEE__EE_Admin_List_Table__single_row_columns__column_'.$column_name.'__column_content',
                     call_user_func([$this, "column_$column_name"], $item),
                     $item,
                     $this
@@ -831,7 +831,7 @@ 
     {
         if ($which === 'top') {
             $this->_filters();
-        } elseif($this->_bottom_buttons) {
+        } elseif ($this->_bottom_buttons) {
             echo '<div class="list-table-bottom-buttons alignleft actions">';
             foreach ($this->_bottom_buttons as $type => $action) {
                 $route         = $action['route'] ?? '';
@@ -915,10 +915,10 @@ 
         $action_class = '',
         $action_id = ''
     ) {
-        $action_class = ! empty($action_class) ? ' class="' . esc_attr($action_class) . '"' : '';
-        $action_id    = ! empty($action_id) ? ' id="' . esc_attr($action_id) . '"' : '';
-        $open_tag     = ! empty($action_container) ? '<' . $action_container . $action_class . $action_id . '>' : '';
-        $close_tag    = ! empty($action_container) ? '</' . $action_container . '>' : '';
+        $action_class = ! empty($action_class) ? ' class="'.esc_attr($action_class).'"' : '';
+        $action_id    = ! empty($action_id) ? ' id="'.esc_attr($action_id).'"' : '';
+        $open_tag     = ! empty($action_container) ? '<'.$action_container.$action_class.$action_id.'>' : '';
+        $close_tag    = ! empty($action_container) ? '</'.$action_container.'>' : '';
         try {
             $content = apply_filters(
                 'FHEE__EE_Admin_List_Table___action_string__action_items',
@@ -961,10 +961,10 @@ 
         string $align = 'start',
         string $layout = 'row'
     ): string {
-        if (! isset($this->_columns[ $id ])) {
+        if ( ! isset($this->_columns[$id])) {
             throw new DomainException('missing column id');
         }
-        $heading = $id !== 'cb' ? $this->_columns[ $id ] : '';
+        $heading = $id !== 'cb' ? $this->_columns[$id] : '';
         $align   = in_array($align, ['start', 'center', 'end']) ? $align : 'start';
         $align   = "ee-responsive-table-cell--$align";
         $layout  = $layout === 'row' ? 'ee-layout-row' : 'ee-layout-stack';
@@ -982,13 +982,13 @@ 
         return '
         <div class="ee-modal-menu">
             <button class="ee-modal-menu__button button button--secondary button--icon-only ee-aria-tooltip"
-                    aria-label="' . esc_attr__('list table actions menu', 'event_espresso') . '"
+                    aria-label="' . esc_attr__('list table actions menu', 'event_espresso').'"
             >
                 <span class="dashicons dashicons-menu"></span>
             </button>
             <div class="ee-modal-menu__content ee-admin-container">
                 <span class="ee-modal-menu__close dashicons dashicons-no"></span>
-                ' . $actions . '
+                ' . $actions.'
             </div>
         </div>';
     }
@@ -999,7 +999,7 @@ 
         return '
             <span class="ee-actions-column-header-wrap">
                 <span class="dashicons dashicons-screenoptions"></span>
-                <span class="ee-actions-column-header">' . esc_html__('Actions', 'event_espresso') . '</span>
+                <span class="ee-actions-column-header">' . esc_html__('Actions', 'event_espresso').'</span>
             </span>';
     }
 

core/admin/EE_Admin_Hooks.core.php

Indentation +756 added lines, -756 removed lines

@@ -15,760 +15,760 @@
 abstract class EE_Admin_Hooks extends EE_Base
 {
 
-    /**
-     * This just holds an instance of the page object for this hook
-     *
-     * @var EE_Admin_Page|EE_Admin_Page_CPT|null
-     * @deprecated  5.0.8.p
-     */
-    protected $_page_object = null;
-
-    /**
-     * This holds the EE_Admin_Page object from the calling admin page that this object hooks into.
-     *
-     * @var EE_Admin_Page|EE_Admin_Page_CPT|null
-     */
-    protected                   $_adminpage_obj = null;
-
-    protected ?EE_Registry      $EE             = null;
-
-    protected ?RequestInterface $request        = null;
-
-    /**
-     * This is set by child classes and is an associative array of ajax hooks in the format:
-     * array(
-     *    'ajax_action_ref' => 'executing_method'; //must be public
-     * )
-     */
-    protected array $_ajax_func = [];
-
-    /**
-     * This is an array of methods that get executed on a page routes admin_init hook. Use the following format:
-     * array(
-     *    'page_route' => 'executing_method' //must be public
-     * )
-     */
-    protected array $_init_func = [];
-
-    /**
-     * This is an array of methods that output metabox content for the given page route.  Use the following format:
-     * [
-     *      0 => [
-     *          'page_route' => 'string_for_page_route',    must correspond to a page route in the class being connected
-     *                                                      with (i.e. "edit_event") If this is in an array then the
-     *                                                      same params below will be used but the metabox will be
-     *                                                      added to each route.
-     *          'func' =>  'executing_method',              must be public (i.e. public function executing_method
-     *                                                      ($post, $callback_args){} ).
-     *                                                      Note if you include callback args in the array then you
-     *                                                      need to declare them in the method arguments.
-     *          'id' => 'identifier_for_metabox',           so it can be removed by addons
-     *                                                      (optional, class will set it automatically)
-     *          'priority' => 'default',                    default 'default' (optional)
-     *          'label' => esc_html__('Localized Title', 'event_espresso'),
-     *          'context' => 'advanced'                     advanced is default (optional),
-     *      ]
-     *      'callback_args' => array() //any callback args to include (optional)
-     * ]
-     * Why are we indexing numerically?  Because it's possible there may be more than one metabox per page_route.
-     */
-    protected array $_metaboxes = [];
-
-    /**
-     * This is an array of values that indicate any metaboxes we want removed from a given page route.  Usually this is
-     * used when caffeinated functionality is replacing decaffeinated functionality.  Use the following format for the
-     * array: array(
-     *    0 => array(
-     *        'page_route' => 'string_for_page_route' //can be string or array of strings that match a page_route(s)
-     *        that are in the class being connected with (i.e. 'edit', or 'create_new').
-     *        'id' => 'identifier_for_metabox', //what the id is of the metabox being removed
-     *        'context' => 'normal', //the context for the metabox being removed (has to match)
-     *        'screen' => 'screen_id', //(optional), if not included then this class will attempt to remove the metabox
-     *        using the currently loaded screen object->id  however, there may be cases where you have to specify the
-     *        id for the screen the metabox is on.
-     *    )
-     * )
-     */
-    protected array $_remove_metaboxes = [];
-
-    protected array $_req_data         = [];
-
-    /**
-     * This parent class takes care of loading the scripts and styles if the child class has set the properties for
-     * them in the following format.  Note, the first array index ('register') is for defining all the registers.  The
-     * second array index is for indicating what routes each script/style loads on. array(
-     * 'registers' => array(
-     *        'script_ref' => array( // if more than one script is to be loaded its best to use the 'dependency'
-     *        argument to link scripts together.
-     *            'type' => 'js' // 'js' or 'css' (defaults to js).  This tells us what type of wp_function to use
-     *            'url' => 'http://urltoscript.css.js',
-     *            'depends' => array('jquery'), //an array of dependencies for the scripts. REMEMBER, if a script has
-     *            already been registered elsewhere in the system.  You can just use the depends array to make sure it
-     *            gets loaded before the one you are setting here.
-     *            'footer' => TRUE //defaults to true (styles don't use this parameter)
-     *        ),
-     *    'enqueues' => array( //this time each key corresponds to the script ref followed by an array of page routes
-     *    the script gets enqueued on.
-     *        'script_ref' => array('route_one', 'route_two')
-     *    ),
-     *    'localize' => array( //this allows you to set a localized object.  Indicate which script the object is being
-     *    attached to and then include an array indexed by the name of the object and the array of key/value pairs for
-     *    the object.
-     *        'scrip_ref' => array(
-     *            'NAME_OF_JS_OBJECT' => array(
-     *                'translate_ref' => esc_html__('localized_string', 'event_espresso'),
-     *                'some_data' => 5
-     *            )
-     *        )
-     *    )
-     * )
-     */
-    protected array $_scripts_styles = [];
-
-    protected array $_scripts        = [];
-
-    protected array $_styles         = [];
-
-    /**
-     * this optional property can be set by child classes to override the priority for the automatic action/filter hook
-     * loading in the `_load_routed_hooks()` method.  Please follow this format: array(
-     *    'wp_hook_reference' => 1
-     *    )
-     * )
-     */
-    protected array $_wp_action_filters_priority = [];
-
-    /**
-     * this is just a flag set automatically to indicate whether we've got an extended hook class running (i.e.
-     * espresso_events_Registration_Form_Hooks_Extend extends espresso_events_Registration_Form_Hooks).  This flag is
-     * used later to make sure we require the needed files.
-     */
-    protected bool $_extend = false;
-
-    /**
-     * we're just going to use this to hold the name of the caller class (child class name)
-     */
-    public string    $caller         = '';
-
-    protected string $_current_route = '';
-
-
-    /**
-     * child classes MUST set this property so that the page object can be loaded correctly
-     */
-    protected string $_name = '';
-
-
-    /**
-     * constructor
-     *
-     * @param EE_Admin_Page $admin_page
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function __construct(EE_Admin_Page $admin_page)
-    {
-        $this->_adminpage_obj = $admin_page;
-        $this->request        = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-        $this->_req_data      = $this->request->requestParams();
-        $current_page         = $this->request->getRequestParam('page');
-        $current_page         = $this->request->getRequestParam('current_page', $current_page);
-        // first let's verify we're on the right page
-        if ($current_page !== $this->_adminpage_obj->page_slug) {
-            return;
-        }
-        $this->_set_defaults();
-        $this->_set_hooks_properties();
-        // get out nothing more to be done here.
-        // allow for extends to modify properties
-        if (method_exists($this, '_extend_properties')) {
-            $this->_extend_properties();
-        }
-        // $this->_set_page_object();
-        $this->_init_hooks();
-        $this->_load_custom_methods();
-        $this->_load_routed_hooks();
-        add_action('admin_enqueue_scripts', [$this, 'enqueue_scripts_styles']);
-        add_action('admin_enqueue_scripts', [$this, 'add_metaboxes'], 20);
-        add_action('admin_enqueue_scripts', [$this, 'remove_metaboxes'], 15);
-        $this->_ajax_hooks();
-    }
-
-
-    /**
-     * used by child classes to set the following properties:
-     * $_ajax_func (optional)
-     * $_init_func (optional)
-     * $_metaboxes (optional)
-     * $_scripts (optional)
-     * $_styles (optional)
-     * $_name (required)
-     * Also in this method will be registered any scripts or styles loaded on the targeted page (as indicated in the
-     * _scripts/_styles properties) Also children should place in this method any filters/actions that have to happen
-     * really early on page load (just after admin_init) if they want to have them registered for handling early.
-     *
-     * @abstract
-     * @return void
-     */
-    abstract protected function _set_hooks_properties();
-
-
-    /**
-     * The hooks for enqueue_scripts and enqueue_styles will be run in here.  Child classes need to define their
-     * scripts and styles in the relevant $_scripts and $_styles properties.  Child classes must have also already
-     * registered the scripts and styles using wp_register_script and wp_register_style functions.
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    public function enqueue_scripts_styles()
-    {
-        if (! empty($this->_scripts_styles)) {
-            // first let's do all the registrations
-            if (! isset($this->_scripts_styles['registers'])) {
-                $msg[] = esc_html__(
-                    'There is no "registers" index in the <code>$this->_scripts_styles</code> property.',
-                    'event_espresso'
-                );
-                $msg[] = sprintf(
-                    esc_html__(
-                        'Make sure you read the phpdoc comments above the definition of the $_scripts_styles property in the <code>EE_Admin_Hooks</code> class and modify according in the %s child',
-                        'event_espresso'
-                    ),
-                    '<strong>' . $this->caller . '</strong>'
-                );
-                throw new EE_Error(implode('||', $msg));
-            }
-            $defaults = [
-                'type'    => 'js',
-                'url'     => '',
-                'depends' => [],
-                'version' => EVENT_ESPRESSO_VERSION,
-                'footer'  => true,
-            ];
-            foreach ($this->_scripts_styles['registers'] as $ref => $details) {
-                $details = wp_parse_args($details, $defaults);
-                $type    = $details['type'];
-                $url     = $details['url'];
-                $depends = $details['depends'];
-                $version = $details['version'];
-                $footer  = $details['footer'];
-                // let's make sure that we set the 'registers' type if it's not set!
-                // We need it later to determine which enqueue we do
-                $this->_scripts_styles['registers'][ $ref ]['type'] = $type;
-                // let's make sure we're not missing any REQUIRED parameters
-                if (empty($url)) {
-                    $msg[] = sprintf(
-                        esc_html__('Missing the url for the requested %s', 'event_espresso'),
-                        $type == 'js' ? 'script' : 'stylesheet'
-                    );
-                    $msg[] = sprintf(
-                        esc_html__(
-                            'Double-check your <code>$this->_scripts_styles</code> array in %s and make sure that there is a "url" set for the %s ref',
-                            'event_espresso'
-                        ),
-                        '<strong>' . $this->caller . '</strong>',
-                        $ref
-                    );
-                    throw new EE_Error(implode('||', $msg));
-                }
-                // made it here so let's do the appropriate registration
-                $type == 'js'
-                    ? wp_register_script($ref, $url, $depends, $version, $footer)
-                    : wp_register_style(
-                    $ref,
-                    $url,
-                    $depends,
-                    $version
-                );
-            }
-            // k now let's do the enqueues
-            if (! isset($this->_scripts_styles['enqueues'])) {
-                return;
-            }  //not sure if we should throw an error here or not.
-
-            foreach ($this->_scripts_styles['enqueues'] as $ref => $routes) {
-                // make sure $routes is an array
-                $routes = (array) $routes;
-                if (in_array($this->_current_route, $routes)) {
-                    $this->_scripts_styles['registers'][ $ref ]['type'] == 'js' ? wp_enqueue_script($ref)
-                        : wp_enqueue_style($ref);
-                    // if we have a localization for the script let's do that too.
-                    if (isset($this->_scripts_styles['localize'][ $ref ])) {
-                        foreach ($this->_scripts_styles['localize'][ $ref ] as $object_name => $indexes) {
-                            wp_localize_script(
-                                $ref,
-                                $object_name,
-                                $this->_scripts_styles['localize'][ $ref ][ $object_name ]
-                            );
-                        }
-                    }
-                }
-            }
-            // let's do the deregisters
-            if (! isset($this->_scripts_styles['deregisters'])) {
-                return;
-            }
-            foreach ($this->_scripts_styles['deregisters'] as $ref => $details) {
-                $defaults = ['type' => 'js'];
-                $details  = wp_parse_args($details, $defaults);
-                $details['type'] === 'js' ? wp_deregister_script($ref) : wp_deregister_style($ref);
-            }
-        }
-    }
-
-
-    /**
-     * just set the defaults for the hooks properties.
-     *
-     * @return void
-     */
-    private function _set_defaults()
-    {
-        $this->_ajax_func                  = [];
-        $this->_init_func                  = [];
-        $this->_metaboxes                  = [];
-        $this->_scripts                    = [];
-        $this->_styles                     = [];
-        $this->_wp_action_filters_priority = [];
-        $this->_current_route              = $this->getCurrentRoute();
-        $this->caller                      = get_class($this);
-        $this->_extend                     = (bool) stripos($this->caller, 'Extend');
-    }
-
-
-    /**
-     * A helper for determining the current route.
-     *
-     * @return string
-     */
-    private function getCurrentRoute(): string
-    {
-        $action = $this->request->getRequestParam('action');
-        // list tables do something else with 'action' for bulk actions.
-        $action = $action !== '-1' && $action !== '' ? $action : 'default';
-        $route  = $this->request->getRequestParam('route');
-        // we set a 'route' variable in some cases where action is being used by something else.
-        return $action === 'default' && $route !== '' ? $route : $action;
-    }
-
-
-    /**
-     * this sets the _page_object property
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws Throwable
-     * @deprecated  5.0.8.p
-     */
-    protected function _set_page_object()
-    {
-        if ($this->_page_object instanceof EE_Admin_Page) {
-            return;
-        }
-        // first make sure $this->_name is set
-        if (empty($this->_name)) {
-            $msg[] = esc_html__('We can\'t load the page object', 'event_espresso');
-            $msg[] = sprintf(
-                esc_html__("This is because the %s child class has not set the '_name' property", 'event_espresso'),
-                $this->caller
-            );
-            throw new EE_Error(implode('||', $msg));
-        }
-        // change "the_message" to "the message"
-        $class_name = str_replace('_', ' ', $this->_name);
-        // change "the message" to "The_Message_Admin_Page"
-        $class_name = str_replace(' ', '_', ucwords($class_name)) . '_Admin_Page';
-        // first default file (if exists)
-        $decaf_file = EE_ADMIN_PAGES . "$this->_name/$class_name.core.php";
-        if (is_readable($decaf_file)) {
-            require_once($decaf_file);
-        }
-        // now we have to do require for extended file (if needed)
-        if ($this->_extend) {
-            require_once EE_CORE_CAF_ADMIN_EXTEND . "$this->_name/Extend_$class_name.core.php";
-            // and extend the class name as well
-            $class_name = 'Extend_' . $class_name;
-        }
-        // let's make sure the class exists
-        if (! class_exists($class_name)) {
-            $msg[] = esc_html__('We can\'t load the page object', 'event_espresso');
-            $msg[] = sprintf(
-                esc_html__(
-                    'The class name that was given is %s. Check the spelling and make sure its correct, also there needs to be an autoloader setup for the class',
-                    'event_espresso'
-                ),
-                $class_name
-            );
-            throw new EE_Error(implode('||', $msg));
-        }
-        // do NOT load admin pages that are ALREADY LOADED!!!
-        if ($class_name !== $this->_adminpage_obj->class_name) {
-            return;
-        }
-        $this->_page_object = LoaderFactory::getLoader()->getShared($class_name, [false]);
-        $this->_page_object->initializePage();
-    }
-
-
-    /**
-     * Child "hook" classes can declare any methods that they want executed when a specific page route is loaded.  The
-     * advantage of this is when doing things like running our own db interactions on saves etc.  Remember that
-     * $this->_req_data (all the _POST and _GET data) is available to your methods.
-     *
-     * @return void
-     */
-    private function _load_custom_methods()
-    {
-        /**
-         * method cannot be named 'default' (@see http://us3.php
-         * .net/manual/en/reserved.keywords.php) so need to
-         * handle routes that are "default"
-         *
-         * @since 4.3.0
-         */
-        $method_callback = $this->_current_route == 'default' ? 'default_callback' : $this->_current_route;
-        // these run before the Admin_Page route executes.
-        if (is_callable($this, $method_callback)) {
-            call_user_func([$this, $method_callback]);
-        }
-        // these run via the _redirect_after_action method in EE_Admin_Page which usually happens after non_UI methods in EE_Admin_Page classes.  There are two redirect actions, the first fires before $query_args might be manipulated by "save and close" actions and the second fires right before the actual redirect happens.
-        // first the actions
-        // note that these action hooks will have the $query_args value available.
-        $admin_class_name = get_class($this->_adminpage_obj);
-        if (method_exists($this, '_redirect_action_early_' . $this->_current_route)) {
-            add_action(
-                'AHEE__'
-                . $admin_class_name
-                . '___redirect_after_action__before_redirect_modification_'
-                . $this->_current_route,
-                [$this, '_redirect_action_early_' . $this->_current_route]
-            );
-        }
-        if (method_exists($this, '_redirect_action_' . $this->_current_route)) {
-            add_action(
-                'AHEE_redirect_' . $admin_class_name . $this->_current_route,
-                [$this, '_redirect_action_' . $this->_current_route]
-            );
-        }
-        // let's hook into the _redirect itself and allow for changing where the user goes after redirect.  This will have $query_args and $redirect_url available.
-        if (method_exists($this, '_redirect_filter_' . $this->_current_route)) {
-            add_filter(
-                'FHEE_redirect_' . $admin_class_name . $this->_current_route,
-                [$this, '_redirect_filter_' . $this->_current_route],
-                10,
-                2
-            );
-        }
-    }
-
-
-    /**
-     * This method will search for a corresponding method with a name matching the route and the wp_hook to run.  This
-     * allows child hook classes to target hooking into a specific wp action or filter hook ONLY on a certain route.
-     * just remember, methods MUST be public Future hooks should be added in here to be access by child classes.
-     *
-     * @return void
-     */
-    private function _load_routed_hooks()
-    {
-        // this array provides the hook action names that will be referenced.  Key is the action. Value is an array with the type (action or filter) and the number of parameters for the hook.  We'll default all priorities for automatic hooks to 10.
-        $hook_filter_array = [
-            'admin_footer'                                                                            => [
-                'type'     => 'action',
-                'argnum'   => 1,
-                'priority' => 10,
-            ],
-            'FHEE_list_table_views_' . $this->_adminpage_obj->page_slug . '_' . $this->_current_route => [
-                'type'     => 'filter',
-                'argnum'   => 1,
-                'priority' => 10,
-            ],
-            'FHEE_list_table_views_' . $this->_adminpage_obj->page_slug                               => [
-                'type'     => 'filter',
-                'argnum'   => 1,
-                'priority' => 10,
-            ],
-            'FHEE_list_table_views'                                                                   => [
-                'type'     => 'filter',
-                'argnum'   => 1,
-                'priority' => 10,
-            ],
-            'AHEE__EE_Admin_Page___display_admin_page__modify_metaboxes'                              => [
-                'type'     => 'action',
-                'argnum'   => 1,
-                'priority' => 10,
-            ],
-        ];
-        foreach ($hook_filter_array as $hook => $args) {
-            if (method_exists($this, $this->_current_route . '_' . $hook)) {
-                if (isset($this->_wp_action_filters_priority[ $hook ])) {
-                    $args['priority'] = $this->_wp_action_filters_priority[ $hook ];
-                }
-                if ($args['type'] == 'action') {
-                    add_action(
-                        $hook,
-                        [$this, $this->_current_route . '_' . $hook],
-                        $args['priority'],
-                        $args['argnum']
-                    );
-                } else {
-                    add_filter(
-                        $hook,
-                        [$this, $this->_current_route . '_' . $hook],
-                        $args['priority'],
-                        $args['argnum']
-                    );
-                }
-            }
-        }
-    }
-
-
-    /**
-     * Loop through the $_ajax_func array and add_actions for the array.
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    private function _ajax_hooks()
-    {
-        if (empty($this->_ajax_func)) {
-            // get out there's nothing to take care of.
-            return;
-        }
-
-        // check for the most basic EE capability
-        if (! $this->_adminpage_obj->capabilities()->current_user_can('ee_read_ee', 'access-ajax-actions')) {
-            return;
-        }
-
-        foreach ($this->_ajax_func as $action => $method) {
-            // make sure method exists
-            if (! method_exists($this, $method)) {
-                $msg[] = esc_html__(
-                             'There is no corresponding method for the hook labeled in the _ajax_func array',
-                             'event_espresso'
-                         ) . '<br />';
-                $msg[] = sprintf(
-                    esc_html__(
-                        'The method name given in the array is %s, check the spelling and make sure it exists in the %s class',
-                        'event_espresso'
-                    ),
-                    $method,
-                    $this->caller
-                );
-                throw new EE_Error(implode('||', $msg));
-            }
-            add_action('wp_ajax_' . $action, [$this, $method]);
-        }
-    }
-
-
-    /**
-     * Loop through the $_init_func array and add_actions for the array.
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    protected function _init_hooks()
-    {
-        if (empty($this->_init_func)) {
-            return;
-        }
-        // get out there's nothing to take care of.
-        // We need to determine what page_route we are on!
-        foreach ($this->_init_func as $route => $method) {
-            // make sure method exists
-            if (! method_exists($this, $method)) {
-                $msg[] = esc_html__(
-                             'There is no corresponding method for the hook labeled in the _init_func array',
-                             'event_espresso'
-                         ) . '<br />';
-                $msg[] = sprintf(
-                    esc_html__(
-                        'The method name given in the array is %s, check the spelling and make sure it exists in the %s class',
-                        'event_espresso'
-                    ),
-                    $method,
-                    $this->caller
-                );
-                throw new EE_Error(implode('||', $msg));
-            }
-            if ($route == $this->_current_route) {
-                add_action('admin_init', [$this, $method]);
-            }
-        }
-    }
-
-
-    /**
-     * Loop through the _metaboxes property and add_metaboxes accordingly
-     * //todo we could eventually make this a config component class (i.e. new EE_Metabox);
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    public function add_metaboxes()
-    {
-        if (empty($this->_metaboxes)) {
-            return;
-        } //get out we don't have any metaboxes to set for this connection
-        $this->_handle_metabox_array($this->_metaboxes);
-    }
-
-
-    /**
-     * @param array     $boxes
-     * @param bool|null $add
-     * @throws EE_Error
-     */
-    private function _handle_metabox_array(array $boxes, ?bool $add = true)
-    {
-        foreach ($boxes as $box) {
-            if (! isset($box['page_route'])) {
-                continue;
-            }
-            // we don't have a valid array
-            // let's make sure $box['page_route'] is an array so the "foreach" will work.
-            $box['page_route'] = (array) $box['page_route'];
-            foreach ($box['page_route'] as $route) {
-                if ($route != $this->_current_route) {
-                    continue;
-                } //get out we only add metaboxes for set route.
-                if ($add) {
-                    $this->_add_metabox($box);
-                } else {
-                    $this->_remove_metabox($box);
-                }
-            }
-        }
-    }
-
-
-    /**
-     * Loop through the _remove_metaboxes property and remove metaboxes accordingly.
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    public function remove_metaboxes()
-    {
-        if (empty($this->_remove_metaboxes)) {
-            return;
-        } //get out there are no metaboxes to remove
-        $this->_handle_metabox_array($this->_remove_metaboxes, false);
-    }
-
-
-    /**
-     * This just handles adding a metabox
-     *
-     * @param array $args an array of args that have been set for this metabox by the child class
-     * @throws EE_Error
-     */
-    private function _add_metabox(array $args)
-    {
-        $current_screen    = get_current_screen();
-        $screen_id         = is_object($current_screen) ? $current_screen->id : null;
-        $callback          = $args['func'] ?? 'some_invalid_callback';
-        $callback_function = is_array($callback) ? end($callback) : $callback;
-        // set defaults
-        $defaults      = [
-            'callback_args' => [],
-            'context'       => 'advanced',
-            'func'          => $callback,
-            'id'            => $this->caller . '_' . $callback_function . '_metabox',
-            'label'         => $this->caller,
-            'page'          => $args['page'] ?? $screen_id,
-            'priority'      => 'default',
-        ];
-        $args          = wp_parse_args($args, $defaults);
-        $callback_args = $args['callback_args'];
-        $context       = $args['context'];
-        $id            = $args['id'];
-        $label         = $args['label'];
-        $page          = $args['page'];
-        $priority      = $args['priority'];
-        // make sure method exists
-        if (! method_exists($this, $callback_function)) {
-            $msg[] =
-                esc_html__('There is no corresponding method to display the metabox content', 'event_espresso')
-                . '<br />';
-            $msg[] = sprintf(
-                esc_html__(
-                    'The method name given in the array is %s, check the spelling and make sure it exists in the %s class',
-                    'event_espresso'
-                ),
-                $callback_function,
-                $this->caller
-            );
-            throw new EE_Error(implode('||', $msg));
-        }
-        // everything checks out so let's add the metabox
-        add_meta_box($id, $label, [$this, $callback_function], $page, $context, $priority, $callback_args);
-        add_filter(
-            "postbox_classes_{$page}_$id",
-            function ($classes) {
-                $classes[] = 'ee-admin-container';
-                return $classes;
-            }
-        );
-    }
-
-
-    private function _remove_metabox($args)
-    {
-        $current_screen = get_current_screen();
-        $screen_id      = is_object($current_screen) ? $current_screen->id : null;
-        $func           = $args['func'] ?? 'some_invalid_callback';
-        // set defaults
-        $defaults = [
-            'context' => 'default',
-            'id'      => $args['id'] ?? "{$this->_current_route}_{$this->caller}_{$func}_metabox",
-            'screen'  => $args['screen'] ?? $screen_id,
-        ];
-        $args     = wp_parse_args($args, $defaults);
-        $context  = $args['context'];
-        $id       = $args['id'];
-        $screen   = $args['screen'];
-        // everything checks out so lets remove the box!
-        remove_meta_box($id, $screen, $context);
-    }
-
-    /**
-     * 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 string $content
-     * @param array $data
-     */
-    public function returnJson(string $content = '', array $data = []): void
-    {
-        // make sure any EE_Error notices have been handled.
-        $notices = EE_Error::get_notices(false);
-        wp_send_json(
-            [
-                'success'   => $notices['success'] ?? false,
-                'errors'    => $notices['errors'] ?? false,
-                'attention' => $notices['attention'] ?? false,
-                'notices'   => $notices,
-                'content'   => $content,
-                'data'      => $data,
-                // special flag so any ajax.Success methods in js can identify this return package as a EEajax package.
-                'isEEajax'  => true,
-            ]
-        );
-    }
+	/**
+	 * This just holds an instance of the page object for this hook
+	 *
+	 * @var EE_Admin_Page|EE_Admin_Page_CPT|null
+	 * @deprecated  5.0.8.p
+	 */
+	protected $_page_object = null;
+
+	/**
+	 * This holds the EE_Admin_Page object from the calling admin page that this object hooks into.
+	 *
+	 * @var EE_Admin_Page|EE_Admin_Page_CPT|null
+	 */
+	protected                   $_adminpage_obj = null;
+
+	protected ?EE_Registry      $EE             = null;
+
+	protected ?RequestInterface $request        = null;
+
+	/**
+	 * This is set by child classes and is an associative array of ajax hooks in the format:
+	 * array(
+	 *    'ajax_action_ref' => 'executing_method'; //must be public
+	 * )
+	 */
+	protected array $_ajax_func = [];
+
+	/**
+	 * This is an array of methods that get executed on a page routes admin_init hook. Use the following format:
+	 * array(
+	 *    'page_route' => 'executing_method' //must be public
+	 * )
+	 */
+	protected array $_init_func = [];
+
+	/**
+	 * This is an array of methods that output metabox content for the given page route.  Use the following format:
+	 * [
+	 *      0 => [
+	 *          'page_route' => 'string_for_page_route',    must correspond to a page route in the class being connected
+	 *                                                      with (i.e. "edit_event") If this is in an array then the
+	 *                                                      same params below will be used but the metabox will be
+	 *                                                      added to each route.
+	 *          'func' =>  'executing_method',              must be public (i.e. public function executing_method
+	 *                                                      ($post, $callback_args){} ).
+	 *                                                      Note if you include callback args in the array then you
+	 *                                                      need to declare them in the method arguments.
+	 *          'id' => 'identifier_for_metabox',           so it can be removed by addons
+	 *                                                      (optional, class will set it automatically)
+	 *          'priority' => 'default',                    default 'default' (optional)
+	 *          'label' => esc_html__('Localized Title', 'event_espresso'),
+	 *          'context' => 'advanced'                     advanced is default (optional),
+	 *      ]
+	 *      'callback_args' => array() //any callback args to include (optional)
+	 * ]
+	 * Why are we indexing numerically?  Because it's possible there may be more than one metabox per page_route.
+	 */
+	protected array $_metaboxes = [];
+
+	/**
+	 * This is an array of values that indicate any metaboxes we want removed from a given page route.  Usually this is
+	 * used when caffeinated functionality is replacing decaffeinated functionality.  Use the following format for the
+	 * array: array(
+	 *    0 => array(
+	 *        'page_route' => 'string_for_page_route' //can be string or array of strings that match a page_route(s)
+	 *        that are in the class being connected with (i.e. 'edit', or 'create_new').
+	 *        'id' => 'identifier_for_metabox', //what the id is of the metabox being removed
+	 *        'context' => 'normal', //the context for the metabox being removed (has to match)
+	 *        'screen' => 'screen_id', //(optional), if not included then this class will attempt to remove the metabox
+	 *        using the currently loaded screen object->id  however, there may be cases where you have to specify the
+	 *        id for the screen the metabox is on.
+	 *    )
+	 * )
+	 */
+	protected array $_remove_metaboxes = [];
+
+	protected array $_req_data         = [];
+
+	/**
+	 * This parent class takes care of loading the scripts and styles if the child class has set the properties for
+	 * them in the following format.  Note, the first array index ('register') is for defining all the registers.  The
+	 * second array index is for indicating what routes each script/style loads on. array(
+	 * 'registers' => array(
+	 *        'script_ref' => array( // if more than one script is to be loaded its best to use the 'dependency'
+	 *        argument to link scripts together.
+	 *            'type' => 'js' // 'js' or 'css' (defaults to js).  This tells us what type of wp_function to use
+	 *            'url' => 'http://urltoscript.css.js',
+	 *            'depends' => array('jquery'), //an array of dependencies for the scripts. REMEMBER, if a script has
+	 *            already been registered elsewhere in the system.  You can just use the depends array to make sure it
+	 *            gets loaded before the one you are setting here.
+	 *            'footer' => TRUE //defaults to true (styles don't use this parameter)
+	 *        ),
+	 *    'enqueues' => array( //this time each key corresponds to the script ref followed by an array of page routes
+	 *    the script gets enqueued on.
+	 *        'script_ref' => array('route_one', 'route_two')
+	 *    ),
+	 *    'localize' => array( //this allows you to set a localized object.  Indicate which script the object is being
+	 *    attached to and then include an array indexed by the name of the object and the array of key/value pairs for
+	 *    the object.
+	 *        'scrip_ref' => array(
+	 *            'NAME_OF_JS_OBJECT' => array(
+	 *                'translate_ref' => esc_html__('localized_string', 'event_espresso'),
+	 *                'some_data' => 5
+	 *            )
+	 *        )
+	 *    )
+	 * )
+	 */
+	protected array $_scripts_styles = [];
+
+	protected array $_scripts        = [];
+
+	protected array $_styles         = [];
+
+	/**
+	 * this optional property can be set by child classes to override the priority for the automatic action/filter hook
+	 * loading in the `_load_routed_hooks()` method.  Please follow this format: array(
+	 *    'wp_hook_reference' => 1
+	 *    )
+	 * )
+	 */
+	protected array $_wp_action_filters_priority = [];
+
+	/**
+	 * this is just a flag set automatically to indicate whether we've got an extended hook class running (i.e.
+	 * espresso_events_Registration_Form_Hooks_Extend extends espresso_events_Registration_Form_Hooks).  This flag is
+	 * used later to make sure we require the needed files.
+	 */
+	protected bool $_extend = false;
+
+	/**
+	 * we're just going to use this to hold the name of the caller class (child class name)
+	 */
+	public string    $caller         = '';
+
+	protected string $_current_route = '';
+
+
+	/**
+	 * child classes MUST set this property so that the page object can be loaded correctly
+	 */
+	protected string $_name = '';
+
+
+	/**
+	 * constructor
+	 *
+	 * @param EE_Admin_Page $admin_page
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function __construct(EE_Admin_Page $admin_page)
+	{
+		$this->_adminpage_obj = $admin_page;
+		$this->request        = LoaderFactory::getLoader()->getShared(RequestInterface::class);
+		$this->_req_data      = $this->request->requestParams();
+		$current_page         = $this->request->getRequestParam('page');
+		$current_page         = $this->request->getRequestParam('current_page', $current_page);
+		// first let's verify we're on the right page
+		if ($current_page !== $this->_adminpage_obj->page_slug) {
+			return;
+		}
+		$this->_set_defaults();
+		$this->_set_hooks_properties();
+		// get out nothing more to be done here.
+		// allow for extends to modify properties
+		if (method_exists($this, '_extend_properties')) {
+			$this->_extend_properties();
+		}
+		// $this->_set_page_object();
+		$this->_init_hooks();
+		$this->_load_custom_methods();
+		$this->_load_routed_hooks();
+		add_action('admin_enqueue_scripts', [$this, 'enqueue_scripts_styles']);
+		add_action('admin_enqueue_scripts', [$this, 'add_metaboxes'], 20);
+		add_action('admin_enqueue_scripts', [$this, 'remove_metaboxes'], 15);
+		$this->_ajax_hooks();
+	}
+
+
+	/**
+	 * used by child classes to set the following properties:
+	 * $_ajax_func (optional)
+	 * $_init_func (optional)
+	 * $_metaboxes (optional)
+	 * $_scripts (optional)
+	 * $_styles (optional)
+	 * $_name (required)
+	 * Also in this method will be registered any scripts or styles loaded on the targeted page (as indicated in the
+	 * _scripts/_styles properties) Also children should place in this method any filters/actions that have to happen
+	 * really early on page load (just after admin_init) if they want to have them registered for handling early.
+	 *
+	 * @abstract
+	 * @return void
+	 */
+	abstract protected function _set_hooks_properties();
+
+
+	/**
+	 * The hooks for enqueue_scripts and enqueue_styles will be run in here.  Child classes need to define their
+	 * scripts and styles in the relevant $_scripts and $_styles properties.  Child classes must have also already
+	 * registered the scripts and styles using wp_register_script and wp_register_style functions.
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function enqueue_scripts_styles()
+	{
+		if (! empty($this->_scripts_styles)) {
+			// first let's do all the registrations
+			if (! isset($this->_scripts_styles['registers'])) {
+				$msg[] = esc_html__(
+					'There is no "registers" index in the <code>$this->_scripts_styles</code> property.',
+					'event_espresso'
+				);
+				$msg[] = sprintf(
+					esc_html__(
+						'Make sure you read the phpdoc comments above the definition of the $_scripts_styles property in the <code>EE_Admin_Hooks</code> class and modify according in the %s child',
+						'event_espresso'
+					),
+					'<strong>' . $this->caller . '</strong>'
+				);
+				throw new EE_Error(implode('||', $msg));
+			}
+			$defaults = [
+				'type'    => 'js',
+				'url'     => '',
+				'depends' => [],
+				'version' => EVENT_ESPRESSO_VERSION,
+				'footer'  => true,
+			];
+			foreach ($this->_scripts_styles['registers'] as $ref => $details) {
+				$details = wp_parse_args($details, $defaults);
+				$type    = $details['type'];
+				$url     = $details['url'];
+				$depends = $details['depends'];
+				$version = $details['version'];
+				$footer  = $details['footer'];
+				// let's make sure that we set the 'registers' type if it's not set!
+				// We need it later to determine which enqueue we do
+				$this->_scripts_styles['registers'][ $ref ]['type'] = $type;
+				// let's make sure we're not missing any REQUIRED parameters
+				if (empty($url)) {
+					$msg[] = sprintf(
+						esc_html__('Missing the url for the requested %s', 'event_espresso'),
+						$type == 'js' ? 'script' : 'stylesheet'
+					);
+					$msg[] = sprintf(
+						esc_html__(
+							'Double-check your <code>$this->_scripts_styles</code> array in %s and make sure that there is a "url" set for the %s ref',
+							'event_espresso'
+						),
+						'<strong>' . $this->caller . '</strong>',
+						$ref
+					);
+					throw new EE_Error(implode('||', $msg));
+				}
+				// made it here so let's do the appropriate registration
+				$type == 'js'
+					? wp_register_script($ref, $url, $depends, $version, $footer)
+					: wp_register_style(
+					$ref,
+					$url,
+					$depends,
+					$version
+				);
+			}
+			// k now let's do the enqueues
+			if (! isset($this->_scripts_styles['enqueues'])) {
+				return;
+			}  //not sure if we should throw an error here or not.
+
+			foreach ($this->_scripts_styles['enqueues'] as $ref => $routes) {
+				// make sure $routes is an array
+				$routes = (array) $routes;
+				if (in_array($this->_current_route, $routes)) {
+					$this->_scripts_styles['registers'][ $ref ]['type'] == 'js' ? wp_enqueue_script($ref)
+						: wp_enqueue_style($ref);
+					// if we have a localization for the script let's do that too.
+					if (isset($this->_scripts_styles['localize'][ $ref ])) {
+						foreach ($this->_scripts_styles['localize'][ $ref ] as $object_name => $indexes) {
+							wp_localize_script(
+								$ref,
+								$object_name,
+								$this->_scripts_styles['localize'][ $ref ][ $object_name ]
+							);
+						}
+					}
+				}
+			}
+			// let's do the deregisters
+			if (! isset($this->_scripts_styles['deregisters'])) {
+				return;
+			}
+			foreach ($this->_scripts_styles['deregisters'] as $ref => $details) {
+				$defaults = ['type' => 'js'];
+				$details  = wp_parse_args($details, $defaults);
+				$details['type'] === 'js' ? wp_deregister_script($ref) : wp_deregister_style($ref);
+			}
+		}
+	}
+
+
+	/**
+	 * just set the defaults for the hooks properties.
+	 *
+	 * @return void
+	 */
+	private function _set_defaults()
+	{
+		$this->_ajax_func                  = [];
+		$this->_init_func                  = [];
+		$this->_metaboxes                  = [];
+		$this->_scripts                    = [];
+		$this->_styles                     = [];
+		$this->_wp_action_filters_priority = [];
+		$this->_current_route              = $this->getCurrentRoute();
+		$this->caller                      = get_class($this);
+		$this->_extend                     = (bool) stripos($this->caller, 'Extend');
+	}
+
+
+	/**
+	 * A helper for determining the current route.
+	 *
+	 * @return string
+	 */
+	private function getCurrentRoute(): string
+	{
+		$action = $this->request->getRequestParam('action');
+		// list tables do something else with 'action' for bulk actions.
+		$action = $action !== '-1' && $action !== '' ? $action : 'default';
+		$route  = $this->request->getRequestParam('route');
+		// we set a 'route' variable in some cases where action is being used by something else.
+		return $action === 'default' && $route !== '' ? $route : $action;
+	}
+
+
+	/**
+	 * this sets the _page_object property
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws Throwable
+	 * @deprecated  5.0.8.p
+	 */
+	protected function _set_page_object()
+	{
+		if ($this->_page_object instanceof EE_Admin_Page) {
+			return;
+		}
+		// first make sure $this->_name is set
+		if (empty($this->_name)) {
+			$msg[] = esc_html__('We can\'t load the page object', 'event_espresso');
+			$msg[] = sprintf(
+				esc_html__("This is because the %s child class has not set the '_name' property", 'event_espresso'),
+				$this->caller
+			);
+			throw new EE_Error(implode('||', $msg));
+		}
+		// change "the_message" to "the message"
+		$class_name = str_replace('_', ' ', $this->_name);
+		// change "the message" to "The_Message_Admin_Page"
+		$class_name = str_replace(' ', '_', ucwords($class_name)) . '_Admin_Page';
+		// first default file (if exists)
+		$decaf_file = EE_ADMIN_PAGES . "$this->_name/$class_name.core.php";
+		if (is_readable($decaf_file)) {
+			require_once($decaf_file);
+		}
+		// now we have to do require for extended file (if needed)
+		if ($this->_extend) {
+			require_once EE_CORE_CAF_ADMIN_EXTEND . "$this->_name/Extend_$class_name.core.php";
+			// and extend the class name as well
+			$class_name = 'Extend_' . $class_name;
+		}
+		// let's make sure the class exists
+		if (! class_exists($class_name)) {
+			$msg[] = esc_html__('We can\'t load the page object', 'event_espresso');
+			$msg[] = sprintf(
+				esc_html__(
+					'The class name that was given is %s. Check the spelling and make sure its correct, also there needs to be an autoloader setup for the class',
+					'event_espresso'
+				),
+				$class_name
+			);
+			throw new EE_Error(implode('||', $msg));
+		}
+		// do NOT load admin pages that are ALREADY LOADED!!!
+		if ($class_name !== $this->_adminpage_obj->class_name) {
+			return;
+		}
+		$this->_page_object = LoaderFactory::getLoader()->getShared($class_name, [false]);
+		$this->_page_object->initializePage();
+	}
+
+
+	/**
+	 * Child "hook" classes can declare any methods that they want executed when a specific page route is loaded.  The
+	 * advantage of this is when doing things like running our own db interactions on saves etc.  Remember that
+	 * $this->_req_data (all the _POST and _GET data) is available to your methods.
+	 *
+	 * @return void
+	 */
+	private function _load_custom_methods()
+	{
+		/**
+		 * method cannot be named 'default' (@see http://us3.php
+		 * .net/manual/en/reserved.keywords.php) so need to
+		 * handle routes that are "default"
+		 *
+		 * @since 4.3.0
+		 */
+		$method_callback = $this->_current_route == 'default' ? 'default_callback' : $this->_current_route;
+		// these run before the Admin_Page route executes.
+		if (is_callable($this, $method_callback)) {
+			call_user_func([$this, $method_callback]);
+		}
+		// these run via the _redirect_after_action method in EE_Admin_Page which usually happens after non_UI methods in EE_Admin_Page classes.  There are two redirect actions, the first fires before $query_args might be manipulated by "save and close" actions and the second fires right before the actual redirect happens.
+		// first the actions
+		// note that these action hooks will have the $query_args value available.
+		$admin_class_name = get_class($this->_adminpage_obj);
+		if (method_exists($this, '_redirect_action_early_' . $this->_current_route)) {
+			add_action(
+				'AHEE__'
+				. $admin_class_name
+				. '___redirect_after_action__before_redirect_modification_'
+				. $this->_current_route,
+				[$this, '_redirect_action_early_' . $this->_current_route]
+			);
+		}
+		if (method_exists($this, '_redirect_action_' . $this->_current_route)) {
+			add_action(
+				'AHEE_redirect_' . $admin_class_name . $this->_current_route,
+				[$this, '_redirect_action_' . $this->_current_route]
+			);
+		}
+		// let's hook into the _redirect itself and allow for changing where the user goes after redirect.  This will have $query_args and $redirect_url available.
+		if (method_exists($this, '_redirect_filter_' . $this->_current_route)) {
+			add_filter(
+				'FHEE_redirect_' . $admin_class_name . $this->_current_route,
+				[$this, '_redirect_filter_' . $this->_current_route],
+				10,
+				2
+			);
+		}
+	}
+
+
+	/**
+	 * This method will search for a corresponding method with a name matching the route and the wp_hook to run.  This
+	 * allows child hook classes to target hooking into a specific wp action or filter hook ONLY on a certain route.
+	 * just remember, methods MUST be public Future hooks should be added in here to be access by child classes.
+	 *
+	 * @return void
+	 */
+	private function _load_routed_hooks()
+	{
+		// this array provides the hook action names that will be referenced.  Key is the action. Value is an array with the type (action or filter) and the number of parameters for the hook.  We'll default all priorities for automatic hooks to 10.
+		$hook_filter_array = [
+			'admin_footer'                                                                            => [
+				'type'     => 'action',
+				'argnum'   => 1,
+				'priority' => 10,
+			],
+			'FHEE_list_table_views_' . $this->_adminpage_obj->page_slug . '_' . $this->_current_route => [
+				'type'     => 'filter',
+				'argnum'   => 1,
+				'priority' => 10,
+			],
+			'FHEE_list_table_views_' . $this->_adminpage_obj->page_slug                               => [
+				'type'     => 'filter',
+				'argnum'   => 1,
+				'priority' => 10,
+			],
+			'FHEE_list_table_views'                                                                   => [
+				'type'     => 'filter',
+				'argnum'   => 1,
+				'priority' => 10,
+			],
+			'AHEE__EE_Admin_Page___display_admin_page__modify_metaboxes'                              => [
+				'type'     => 'action',
+				'argnum'   => 1,
+				'priority' => 10,
+			],
+		];
+		foreach ($hook_filter_array as $hook => $args) {
+			if (method_exists($this, $this->_current_route . '_' . $hook)) {
+				if (isset($this->_wp_action_filters_priority[ $hook ])) {
+					$args['priority'] = $this->_wp_action_filters_priority[ $hook ];
+				}
+				if ($args['type'] == 'action') {
+					add_action(
+						$hook,
+						[$this, $this->_current_route . '_' . $hook],
+						$args['priority'],
+						$args['argnum']
+					);
+				} else {
+					add_filter(
+						$hook,
+						[$this, $this->_current_route . '_' . $hook],
+						$args['priority'],
+						$args['argnum']
+					);
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * Loop through the $_ajax_func array and add_actions for the array.
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private function _ajax_hooks()
+	{
+		if (empty($this->_ajax_func)) {
+			// get out there's nothing to take care of.
+			return;
+		}
+
+		// check for the most basic EE capability
+		if (! $this->_adminpage_obj->capabilities()->current_user_can('ee_read_ee', 'access-ajax-actions')) {
+			return;
+		}
+
+		foreach ($this->_ajax_func as $action => $method) {
+			// make sure method exists
+			if (! method_exists($this, $method)) {
+				$msg[] = esc_html__(
+							 'There is no corresponding method for the hook labeled in the _ajax_func array',
+							 'event_espresso'
+						 ) . '<br />';
+				$msg[] = sprintf(
+					esc_html__(
+						'The method name given in the array is %s, check the spelling and make sure it exists in the %s class',
+						'event_espresso'
+					),
+					$method,
+					$this->caller
+				);
+				throw new EE_Error(implode('||', $msg));
+			}
+			add_action('wp_ajax_' . $action, [$this, $method]);
+		}
+	}
+
+
+	/**
+	 * Loop through the $_init_func array and add_actions for the array.
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	protected function _init_hooks()
+	{
+		if (empty($this->_init_func)) {
+			return;
+		}
+		// get out there's nothing to take care of.
+		// We need to determine what page_route we are on!
+		foreach ($this->_init_func as $route => $method) {
+			// make sure method exists
+			if (! method_exists($this, $method)) {
+				$msg[] = esc_html__(
+							 'There is no corresponding method for the hook labeled in the _init_func array',
+							 'event_espresso'
+						 ) . '<br />';
+				$msg[] = sprintf(
+					esc_html__(
+						'The method name given in the array is %s, check the spelling and make sure it exists in the %s class',
+						'event_espresso'
+					),
+					$method,
+					$this->caller
+				);
+				throw new EE_Error(implode('||', $msg));
+			}
+			if ($route == $this->_current_route) {
+				add_action('admin_init', [$this, $method]);
+			}
+		}
+	}
+
+
+	/**
+	 * Loop through the _metaboxes property and add_metaboxes accordingly
+	 * //todo we could eventually make this a config component class (i.e. new EE_Metabox);
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function add_metaboxes()
+	{
+		if (empty($this->_metaboxes)) {
+			return;
+		} //get out we don't have any metaboxes to set for this connection
+		$this->_handle_metabox_array($this->_metaboxes);
+	}
+
+
+	/**
+	 * @param array     $boxes
+	 * @param bool|null $add
+	 * @throws EE_Error
+	 */
+	private function _handle_metabox_array(array $boxes, ?bool $add = true)
+	{
+		foreach ($boxes as $box) {
+			if (! isset($box['page_route'])) {
+				continue;
+			}
+			// we don't have a valid array
+			// let's make sure $box['page_route'] is an array so the "foreach" will work.
+			$box['page_route'] = (array) $box['page_route'];
+			foreach ($box['page_route'] as $route) {
+				if ($route != $this->_current_route) {
+					continue;
+				} //get out we only add metaboxes for set route.
+				if ($add) {
+					$this->_add_metabox($box);
+				} else {
+					$this->_remove_metabox($box);
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * Loop through the _remove_metaboxes property and remove metaboxes accordingly.
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function remove_metaboxes()
+	{
+		if (empty($this->_remove_metaboxes)) {
+			return;
+		} //get out there are no metaboxes to remove
+		$this->_handle_metabox_array($this->_remove_metaboxes, false);
+	}
+
+
+	/**
+	 * This just handles adding a metabox
+	 *
+	 * @param array $args an array of args that have been set for this metabox by the child class
+	 * @throws EE_Error
+	 */
+	private function _add_metabox(array $args)
+	{
+		$current_screen    = get_current_screen();
+		$screen_id         = is_object($current_screen) ? $current_screen->id : null;
+		$callback          = $args['func'] ?? 'some_invalid_callback';
+		$callback_function = is_array($callback) ? end($callback) : $callback;
+		// set defaults
+		$defaults      = [
+			'callback_args' => [],
+			'context'       => 'advanced',
+			'func'          => $callback,
+			'id'            => $this->caller . '_' . $callback_function . '_metabox',
+			'label'         => $this->caller,
+			'page'          => $args['page'] ?? $screen_id,
+			'priority'      => 'default',
+		];
+		$args          = wp_parse_args($args, $defaults);
+		$callback_args = $args['callback_args'];
+		$context       = $args['context'];
+		$id            = $args['id'];
+		$label         = $args['label'];
+		$page          = $args['page'];
+		$priority      = $args['priority'];
+		// make sure method exists
+		if (! method_exists($this, $callback_function)) {
+			$msg[] =
+				esc_html__('There is no corresponding method to display the metabox content', 'event_espresso')
+				. '<br />';
+			$msg[] = sprintf(
+				esc_html__(
+					'The method name given in the array is %s, check the spelling and make sure it exists in the %s class',
+					'event_espresso'
+				),
+				$callback_function,
+				$this->caller
+			);
+			throw new EE_Error(implode('||', $msg));
+		}
+		// everything checks out so let's add the metabox
+		add_meta_box($id, $label, [$this, $callback_function], $page, $context, $priority, $callback_args);
+		add_filter(
+			"postbox_classes_{$page}_$id",
+			function ($classes) {
+				$classes[] = 'ee-admin-container';
+				return $classes;
+			}
+		);
+	}
+
+
+	private function _remove_metabox($args)
+	{
+		$current_screen = get_current_screen();
+		$screen_id      = is_object($current_screen) ? $current_screen->id : null;
+		$func           = $args['func'] ?? 'some_invalid_callback';
+		// set defaults
+		$defaults = [
+			'context' => 'default',
+			'id'      => $args['id'] ?? "{$this->_current_route}_{$this->caller}_{$func}_metabox",
+			'screen'  => $args['screen'] ?? $screen_id,
+		];
+		$args     = wp_parse_args($args, $defaults);
+		$context  = $args['context'];
+		$id       = $args['id'];
+		$screen   = $args['screen'];
+		// everything checks out so lets remove the box!
+		remove_meta_box($id, $screen, $context);
+	}
+
+	/**
+	 * 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 string $content
+	 * @param array $data
+	 */
+	public function returnJson(string $content = '', array $data = []): void
+	{
+		// make sure any EE_Error notices have been handled.
+		$notices = EE_Error::get_notices(false);
+		wp_send_json(
+			[
+				'success'   => $notices['success'] ?? false,
+				'errors'    => $notices['errors'] ?? false,
+				'attention' => $notices['attention'] ?? false,
+				'notices'   => $notices,
+				'content'   => $content,
+				'data'      => $data,
+				// special flag so any ajax.Success methods in js can identify this return package as a EEajax package.
+				'isEEajax'  => true,
+			]
+		);
+	}
 }

Spacing +42 added lines, -42 removed lines

@@ -223,9 +223,9 @@ 
      */
     public function enqueue_scripts_styles()
     {
-        if (! empty($this->_scripts_styles)) {
+        if ( ! empty($this->_scripts_styles)) {
             // first let's do all the registrations
-            if (! isset($this->_scripts_styles['registers'])) {
+            if ( ! isset($this->_scripts_styles['registers'])) {
                 $msg[] = esc_html__(
                     'There is no "registers" index in the <code>$this->_scripts_styles</code> property.',
                     'event_espresso'
@@ -235,7 +235,7 @@ 
                         'Make sure you read the phpdoc comments above the definition of the $_scripts_styles property in the <code>EE_Admin_Hooks</code> class and modify according in the %s child',
                         'event_espresso'
                     ),
-                    '<strong>' . $this->caller . '</strong>'
+                    '<strong>'.$this->caller.'</strong>'
                 );
                 throw new EE_Error(implode('||', $msg));
             }
@@ -255,7 +255,7 @@ 
                 $footer  = $details['footer'];
                 // let's make sure that we set the 'registers' type if it's not set!
                 // We need it later to determine which enqueue we do
-                $this->_scripts_styles['registers'][ $ref ]['type'] = $type;
+                $this->_scripts_styles['registers'][$ref]['type'] = $type;
                 // let's make sure we're not missing any REQUIRED parameters
                 if (empty($url)) {
                     $msg[] = sprintf(
@@ -267,7 +267,7 @@ 
                             'Double-check your <code>$this->_scripts_styles</code> array in %s and make sure that there is a "url" set for the %s ref',
                             'event_espresso'
                         ),
-                        '<strong>' . $this->caller . '</strong>',
+                        '<strong>'.$this->caller.'</strong>',
                         $ref
                     );
                     throw new EE_Error(implode('||', $msg));
@@ -283,7 +283,7 @@ 
                 );
             }
             // k now let's do the enqueues
-            if (! isset($this->_scripts_styles['enqueues'])) {
+            if ( ! isset($this->_scripts_styles['enqueues'])) {
                 return;
             }  //not sure if we should throw an error here or not.
 
@@ -291,22 +291,22 @@ 
                 // make sure $routes is an array
                 $routes = (array) $routes;
                 if (in_array($this->_current_route, $routes)) {
-                    $this->_scripts_styles['registers'][ $ref ]['type'] == 'js' ? wp_enqueue_script($ref)
+                    $this->_scripts_styles['registers'][$ref]['type'] == 'js' ? wp_enqueue_script($ref)
                         : wp_enqueue_style($ref);
                     // if we have a localization for the script let's do that too.
-                    if (isset($this->_scripts_styles['localize'][ $ref ])) {
-                        foreach ($this->_scripts_styles['localize'][ $ref ] as $object_name => $indexes) {
+                    if (isset($this->_scripts_styles['localize'][$ref])) {
+                        foreach ($this->_scripts_styles['localize'][$ref] as $object_name => $indexes) {
                             wp_localize_script(
                                 $ref,
                                 $object_name,
-                                $this->_scripts_styles['localize'][ $ref ][ $object_name ]
+                                $this->_scripts_styles['localize'][$ref][$object_name]
                             );
                         }
                     }
                 }
             }
             // let's do the deregisters
-            if (! isset($this->_scripts_styles['deregisters'])) {
+            if ( ! isset($this->_scripts_styles['deregisters'])) {
                 return;
             }
             foreach ($this->_scripts_styles['deregisters'] as $ref => $details) {
@@ -379,20 +379,20 @@ 
         // change "the_message" to "the message"
         $class_name = str_replace('_', ' ', $this->_name);
         // change "the message" to "The_Message_Admin_Page"
-        $class_name = str_replace(' ', '_', ucwords($class_name)) . '_Admin_Page';
+        $class_name = str_replace(' ', '_', ucwords($class_name)).'_Admin_Page';
         // first default file (if exists)
-        $decaf_file = EE_ADMIN_PAGES . "$this->_name/$class_name.core.php";
+        $decaf_file = EE_ADMIN_PAGES."$this->_name/$class_name.core.php";
         if (is_readable($decaf_file)) {
             require_once($decaf_file);
         }
         // now we have to do require for extended file (if needed)
         if ($this->_extend) {
-            require_once EE_CORE_CAF_ADMIN_EXTEND . "$this->_name/Extend_$class_name.core.php";
+            require_once EE_CORE_CAF_ADMIN_EXTEND."$this->_name/Extend_$class_name.core.php";
             // and extend the class name as well
-            $class_name = 'Extend_' . $class_name;
+            $class_name = 'Extend_'.$class_name;
         }
         // let's make sure the class exists
-        if (! class_exists($class_name)) {
+        if ( ! class_exists($class_name)) {
             $msg[] = esc_html__('We can\'t load the page object', 'event_espresso');
             $msg[] = sprintf(
                 esc_html__(
@@ -437,26 +437,26 @@ 
         // first the actions
         // note that these action hooks will have the $query_args value available.
         $admin_class_name = get_class($this->_adminpage_obj);
-        if (method_exists($this, '_redirect_action_early_' . $this->_current_route)) {
+        if (method_exists($this, '_redirect_action_early_'.$this->_current_route)) {
             add_action(
                 'AHEE__'
                 . $admin_class_name
                 . '___redirect_after_action__before_redirect_modification_'
                 . $this->_current_route,
-                [$this, '_redirect_action_early_' . $this->_current_route]
+                [$this, '_redirect_action_early_'.$this->_current_route]
             );
         }
-        if (method_exists($this, '_redirect_action_' . $this->_current_route)) {
+        if (method_exists($this, '_redirect_action_'.$this->_current_route)) {
             add_action(
-                'AHEE_redirect_' . $admin_class_name . $this->_current_route,
-                [$this, '_redirect_action_' . $this->_current_route]
+                'AHEE_redirect_'.$admin_class_name.$this->_current_route,
+                [$this, '_redirect_action_'.$this->_current_route]
             );
         }
         // let's hook into the _redirect itself and allow for changing where the user goes after redirect.  This will have $query_args and $redirect_url available.
-        if (method_exists($this, '_redirect_filter_' . $this->_current_route)) {
+        if (method_exists($this, '_redirect_filter_'.$this->_current_route)) {
             add_filter(
-                'FHEE_redirect_' . $admin_class_name . $this->_current_route,
-                [$this, '_redirect_filter_' . $this->_current_route],
+                'FHEE_redirect_'.$admin_class_name.$this->_current_route,
+                [$this, '_redirect_filter_'.$this->_current_route],
                 10,
                 2
             );
@@ -480,12 +480,12 @@ 
                 'argnum'   => 1,
                 'priority' => 10,
             ],
-            'FHEE_list_table_views_' . $this->_adminpage_obj->page_slug . '_' . $this->_current_route => [
+            'FHEE_list_table_views_'.$this->_adminpage_obj->page_slug.'_'.$this->_current_route => [
                 'type'     => 'filter',
                 'argnum'   => 1,
                 'priority' => 10,
             ],
-            'FHEE_list_table_views_' . $this->_adminpage_obj->page_slug                               => [
+            'FHEE_list_table_views_'.$this->_adminpage_obj->page_slug                               => [
                 'type'     => 'filter',
                 'argnum'   => 1,
                 'priority' => 10,
@@ -502,21 +502,21 @@ 
             ],
         ];
         foreach ($hook_filter_array as $hook => $args) {
-            if (method_exists($this, $this->_current_route . '_' . $hook)) {
-                if (isset($this->_wp_action_filters_priority[ $hook ])) {
-                    $args['priority'] = $this->_wp_action_filters_priority[ $hook ];
+            if (method_exists($this, $this->_current_route.'_'.$hook)) {
+                if (isset($this->_wp_action_filters_priority[$hook])) {
+                    $args['priority'] = $this->_wp_action_filters_priority[$hook];
                 }
                 if ($args['type'] == 'action') {
                     add_action(
                         $hook,
-                        [$this, $this->_current_route . '_' . $hook],
+                        [$this, $this->_current_route.'_'.$hook],
                         $args['priority'],
                         $args['argnum']
                     );
                 } else {
                     add_filter(
                         $hook,
-                        [$this, $this->_current_route . '_' . $hook],
+                        [$this, $this->_current_route.'_'.$hook],
                         $args['priority'],
                         $args['argnum']
                     );
@@ -540,17 +540,17 @@ 
         }
 
         // check for the most basic EE capability
-        if (! $this->_adminpage_obj->capabilities()->current_user_can('ee_read_ee', 'access-ajax-actions')) {
+        if ( ! $this->_adminpage_obj->capabilities()->current_user_can('ee_read_ee', 'access-ajax-actions')) {
             return;
         }
 
         foreach ($this->_ajax_func as $action => $method) {
             // make sure method exists
-            if (! method_exists($this, $method)) {
+            if ( ! method_exists($this, $method)) {
                 $msg[] = esc_html__(
                              'There is no corresponding method for the hook labeled in the _ajax_func array',
                              'event_espresso'
-                         ) . '<br />';
+                         ).'<br />';
                 $msg[] = sprintf(
                     esc_html__(
                         'The method name given in the array is %s, check the spelling and make sure it exists in the %s class',
@@ -561,7 +561,7 @@ 
                 );
                 throw new EE_Error(implode('||', $msg));
             }
-            add_action('wp_ajax_' . $action, [$this, $method]);
+            add_action('wp_ajax_'.$action, [$this, $method]);
         }
     }
 
@@ -581,11 +581,11 @@ 
         // We need to determine what page_route we are on!
         foreach ($this->_init_func as $route => $method) {
             // make sure method exists
-            if (! method_exists($this, $method)) {
+            if ( ! method_exists($this, $method)) {
                 $msg[] = esc_html__(
                              'There is no corresponding method for the hook labeled in the _init_func array',
                              'event_espresso'
-                         ) . '<br />';
+                         ).'<br />';
                 $msg[] = sprintf(
                     esc_html__(
                         'The method name given in the array is %s, check the spelling and make sure it exists in the %s class',
@@ -627,7 +627,7 @@ 
     private function _handle_metabox_array(array $boxes, ?bool $add = true)
     {
         foreach ($boxes as $box) {
-            if (! isset($box['page_route'])) {
+            if ( ! isset($box['page_route'])) {
                 continue;
             }
             // we don't have a valid array
@@ -675,11 +675,11 @@ 
         $callback          = $args['func'] ?? 'some_invalid_callback';
         $callback_function = is_array($callback) ? end($callback) : $callback;
         // set defaults
-        $defaults      = [
+        $defaults = [
             'callback_args' => [],
             'context'       => 'advanced',
             'func'          => $callback,
-            'id'            => $this->caller . '_' . $callback_function . '_metabox',
+            'id'            => $this->caller.'_'.$callback_function.'_metabox',
             'label'         => $this->caller,
             'page'          => $args['page'] ?? $screen_id,
             'priority'      => 'default',
@@ -692,7 +692,7 @@ 
         $page          = $args['page'];
         $priority      = $args['priority'];
         // make sure method exists
-        if (! method_exists($this, $callback_function)) {
+        if ( ! method_exists($this, $callback_function)) {
             $msg[] =
                 esc_html__('There is no corresponding method to display the metabox content', 'event_espresso')
                 . '<br />';
@@ -710,7 +710,7 @@ 
         add_meta_box($id, $label, [$this, $callback_function], $page, $context, $priority, $callback_args);
         add_filter(
             "postbox_classes_{$page}_$id",
-            function ($classes) {
+            function($classes) {
                 $classes[] = 'ee-admin-container';
                 return $classes;
             }

core/admin/EE_Admin_Page.core.php

Indentation +4231 added lines, -4231 removed lines

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

Spacing +173 added lines, -173 removed lines

@@ -245,7 +245,7 @@ 
 
     public function capabilities(): EE_Capabilities
     {
-        if (! $this->capabilities instanceof EE_Capabilities) {
+        if ( ! $this->capabilities instanceof EE_Capabilities) {
             $this->capabilities = $this->loader->getShared(EE_Capabilities::class);
         }
         return $this->capabilities;
@@ -609,7 +609,7 @@ 
         $ee_menu_slugs = (array) $ee_menu_slugs;
         if (
             ! $this->request->isAjax()
-            && (! $this->_current_page || ! isset($ee_menu_slugs[ $this->_current_page ]))
+            && ( ! $this->_current_page || ! isset($ee_menu_slugs[$this->_current_page]))
         ) {
             return;
         }
@@ -629,7 +629,7 @@ 
             ? $route
             : $req_action;
         $this->_current_view = $this->_req_action;
-        $this->_req_nonce    = $this->_req_action . '_nonce';
+        $this->_req_nonce    = $this->_req_action.'_nonce';
         $this->_define_page_props();
         $this->_current_page_view_url = add_query_arg(
             ['page' => $this->_current_page, 'action' => $this->_current_view],
@@ -653,33 +653,33 @@ 
         }
         // filter routes and page_config so addons can add their stuff. Filtering done per class
         $this->_page_routes = apply_filters(
-            'FHEE__' . $this->class_name . '__page_setup__page_routes',
+            'FHEE__'.$this->class_name.'__page_setup__page_routes',
             $this->_page_routes,
             $this
         );
         $this->_page_config = apply_filters(
-            'FHEE__' . $this->class_name . '__page_setup__page_config',
+            'FHEE__'.$this->class_name.'__page_setup__page_config',
             $this->_page_config,
             $this
         );
         if ($this->base_class_name !== '') {
             $this->_page_routes = apply_filters(
-                'FHEE__' . $this->base_class_name . '__page_setup__page_routes',
+                'FHEE__'.$this->base_class_name.'__page_setup__page_routes',
                 $this->_page_routes,
                 $this
             );
             $this->_page_config = apply_filters(
-                'FHEE__' . $this->base_class_name . '__page_setup__page_config',
+                'FHEE__'.$this->base_class_name.'__page_setup__page_config',
                 $this->_page_config,
                 $this
             );
         }
         // if AHEE__EE_Admin_Page__route_admin_request_$this->_current_view method is present
         // then we call it hooked into the AHEE__EE_Admin_Page__route_admin_request action
-        if (method_exists($this, 'AHEE__EE_Admin_Page__route_admin_request_' . $this->_current_view)) {
+        if (method_exists($this, 'AHEE__EE_Admin_Page__route_admin_request_'.$this->_current_view)) {
             add_action(
                 'AHEE__EE_Admin_Page__route_admin_request',
-                [$this, 'AHEE__EE_Admin_Page__route_admin_request_' . $this->_current_view],
+                [$this, 'AHEE__EE_Admin_Page__route_admin_request_'.$this->_current_view],
                 10,
                 2
             );
@@ -692,8 +692,8 @@ 
             if ($this->_is_UI_request) {
                 // admin_init stuff - global, all views for this page class, specific view
                 add_action('admin_init', [$this, 'admin_init']);
-                if (method_exists($this, 'admin_init_' . $this->_current_view)) {
-                    add_action('admin_init', [$this, 'admin_init_' . $this->_current_view], 15);
+                if (method_exists($this, 'admin_init_'.$this->_current_view)) {
+                    add_action('admin_init', [$this, 'admin_init_'.$this->_current_view], 15);
                 }
             } else {
                 // hijack regular WP loading and route admin request immediately
@@ -712,12 +712,12 @@ 
      */
     private function _do_other_page_hooks()
     {
-        $registered_pages = apply_filters('FHEE_do_other_page_hooks_' . $this->page_slug, []);
+        $registered_pages = apply_filters('FHEE_do_other_page_hooks_'.$this->page_slug, []);
         foreach ($registered_pages as $page) {
             // now let's set up the file name and class that should be present
             $classname = str_replace('.class.php', '', $page);
             // autoloaders should take care of loading file
-            if (! class_exists($classname)) {
+            if ( ! class_exists($classname)) {
                 $error_msg[] = sprintf(
                     esc_html__(
                         'Something went wrong with loading the %s admin hooks page.',
@@ -734,7 +734,7 @@ 
                                    ),
                                    $page,
                                    '<br />',
-                                   '<strong>' . $classname . '</strong>'
+                                   '<strong>'.$classname.'</strong>'
                                );
                 throw new EE_Error(implode('||', $error_msg));
             }
@@ -783,13 +783,13 @@ 
         // load admin_notices - global, page class, and view specific
         add_action('admin_notices', [$this, 'admin_notices_global'], 5);
         add_action('admin_notices', [$this, 'admin_notices']);
-        if (method_exists($this, 'admin_notices_' . $this->_current_view)) {
-            add_action('admin_notices', [$this, 'admin_notices_' . $this->_current_view], 15);
+        if (method_exists($this, 'admin_notices_'.$this->_current_view)) {
+            add_action('admin_notices', [$this, 'admin_notices_'.$this->_current_view], 15);
         }
         // load network admin_notices - global, page class, and view specific
         add_action('network_admin_notices', [$this, 'network_admin_notices_global'], 5);
-        if (method_exists($this, 'network_admin_notices_' . $this->_current_view)) {
-            add_action('network_admin_notices', [$this, 'network_admin_notices_' . $this->_current_view]);
+        if (method_exists($this, 'network_admin_notices_'.$this->_current_view)) {
+            add_action('network_admin_notices', [$this, 'network_admin_notices_'.$this->_current_view]);
         }
         // this will save any per_page screen options if they are present
         $this->_set_per_page_screen_options();
@@ -915,7 +915,7 @@ 
      */
     protected function _verify_routes(): bool
     {
-        if (! $this->_current_page && ! $this->request->isAjax()) {
+        if ( ! $this->_current_page && ! $this->request->isAjax()) {
             return false;
         }
         // check that the page_routes array is not empty
@@ -926,7 +926,7 @@ 
                 $this->_admin_page_title
             );
             // developer error msg
-            $error_msg .= '||' . $error_msg
+            $error_msg .= '||'.$error_msg
                           . esc_html__(
                               ' Make sure the "set_page_routes()" method exists, and is setting the "_page_routes" array properly.',
                               'event_espresso'
@@ -944,8 +944,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(
@@ -956,7 +956,7 @@ 
                 $this->_admin_page_title
             );
             // developer error msg
-            $error_msg .= '||' . $error_msg
+            $error_msg .= '||'.$error_msg
                           . sprintf(
                               esc_html__(
                                   ' Create a key in the "_page_routes" array named "%s" and set its value to the appropriate method.',
@@ -967,7 +967,7 @@ 
             throw new EE_Error($error_msg);
         }
         // and that a default route exists
-        if (! array_key_exists('default', $this->_page_routes)) {
+        if ( ! array_key_exists('default', $this->_page_routes)) {
             // user error msg
             $error_msg = sprintf(
                 esc_html__(
@@ -977,7 +977,7 @@ 
                 $this->_admin_page_title
             );
             // developer error msg
-            $error_msg .= '||' . $error_msg
+            $error_msg .= '||'.$error_msg
                           . esc_html__(
                               ' Create a key in the "_page_routes" array named "default" and set its value to your default page method.',
                               'event_espresso'
@@ -1017,7 +1017,7 @@ 
             $this->_admin_page_title
         );
         // developer error msg
-        $error_msg .= '||' . $error_msg
+        $error_msg .= '||'.$error_msg
                       . sprintf(
                           esc_html__(
                               ' Check the route you are using in your method (%s) and make sure it matches a route set in your "_page_routes" array property',
@@ -1045,7 +1045,7 @@ 
     protected function _verify_nonce(string $nonce, string $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'),
@@ -1062,7 +1062,7 @@ 
                     __CLASS__
                 );
             }
-            if (! $this->request->isAjax()) {
+            if ( ! $this->request->isAjax()) {
                 wp_die($msg);
             }
             EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
@@ -1087,7 +1087,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'];
@@ -1107,7 +1107,7 @@ 
 
         // action right before calling route
         // (hook is something like 'AHEE__Registrations_Admin_Page__route_admin_request')
-        if (! did_action('AHEE__EE_Admin_Page__route_admin_request')) {
+        if ( ! did_action('AHEE__EE_Admin_Page__route_admin_request')) {
             do_action('AHEE__EE_Admin_Page__route_admin_request', $this->_current_view, $this);
         }
         // strip _wp_http_referer from the server REQUEST_URI
@@ -1122,7 +1122,7 @@ 
         $this->request->setRequestParam('_wp_http_referer', $cleaner_request_uri, true);
         $this->request->setServerParam('REQUEST_URI', $cleaner_request_uri, true);
         $route_callback = [];
-        if (! empty($func)) {
+        if ( ! empty($func)) {
             if (is_array($func) && is_callable($func)) {
                 $route_callback = $func;
             } elseif (is_string($func)) {
@@ -1136,7 +1136,7 @@ 
             }
             [$class, $method] = $route_callback;
             // is it neither a class method NOR a standalone function?
-            if (! is_callable($route_callback)) {
+            if ( ! is_callable($route_callback)) {
                 // user error msg
                 $error_msg = esc_html__(
                     'An error occurred. The  requested page route could not be found.',
@@ -1245,7 +1245,7 @@ 
                 if (strpos($key, 'nonce') !== false) {
                     continue;
                 }
-                $args[ 'wp_referer[' . $key . ']' ] = is_string($value) ? htmlspecialchars($value) : $value;
+                $args['wp_referer['.$key.']'] = is_string($value) ? htmlspecialchars($value) : $value;
             }
         }
         return EEH_URL::add_query_args_and_nonce($args, $url, $exclude_nonce, $context);
@@ -1285,12 +1285,12 @@ 
      */
     protected function _add_help_tabs()
     {
-        if (isset($this->_page_config[ $this->_req_action ])) {
-            $config = $this->_page_config[ $this->_req_action ];
+        if (isset($this->_page_config[$this->_req_action])) {
+            $config = $this->_page_config[$this->_req_action];
             // let's see if there is a help_sidebar set for the current route and we'll set that up for usage as well.
             if (is_array($config) && isset($config['help_sidebar'])) {
                 // check that the callback given is valid
-                if (! method_exists($this, $config['help_sidebar'])) {
+                if ( ! method_exists($this, $config['help_sidebar'])) {
                     throw new EE_Error(
                         sprintf(
                             esc_html__(
@@ -1303,18 +1303,18 @@ 
                     );
                 }
                 $content = apply_filters(
-                    'FHEE__' . $this->class_name . '__add_help_tabs__help_sidebar',
+                    'FHEE__'.$this->class_name.'__add_help_tabs__help_sidebar',
                     $this->{$config['help_sidebar']}()
                 );
                 $this->_current_screen->set_help_sidebar($content);
             }
-            if (! isset($config['help_tabs'])) {
+            if ( ! isset($config['help_tabs'])) {
                 return;
             } //no help tabs for this route
             foreach ((array) $config['help_tabs'] as $tab_id => $cfg) {
                 // we're here so there ARE help tabs!
                 // make sure we've got what we need
-                if (! isset($cfg['title'])) {
+                if ( ! isset($cfg['title'])) {
                     throw new EE_Error(
                         esc_html__(
                             'The _page_config array is not set up properly for help tabs.  It is missing a title',
@@ -1322,7 +1322,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',
@@ -1331,11 +1331,11 @@ 
                     );
                 }
                 // first priority goes to content.
-                if (! empty($cfg['content'])) {
+                if ( ! empty($cfg['content'])) {
                     $content = $cfg['content'];
                     // second priority goes to filename
-                } elseif (! empty($cfg['filename'])) {
-                    $file_path = $this->_get_dir() . '/help_tabs/' . $cfg['filename'] . '.help_tab.php';
+                } elseif ( ! empty($cfg['filename'])) {
+                    $file_path = $this->_get_dir().'/help_tabs/'.$cfg['filename'].'.help_tab.php';
                     // it's possible that the file is located on decaf route (and above sets up for caf route, if this is the case then lets check decaf route too)
                     $file_path = ! is_readable($file_path) ? EE_ADMIN_PAGES
                                                              . basename($this->_get_dir())
@@ -1343,7 +1343,7 @@ 
                                                              . $cfg['filename']
                                                              . '.help_tab.php' : $file_path;
                     // if file is STILL not readable then let's do an EE_Error so its more graceful than a fatal error.
-                    if (! isset($cfg['callback']) && ! is_readable($file_path)) {
+                    if ( ! isset($cfg['callback']) && ! is_readable($file_path)) {
                         EE_Error::add_error(
                             sprintf(
                                 esc_html__(
@@ -1391,7 +1391,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'],
@@ -1417,8 +1417,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);
         }
@@ -1440,7 +1440,7 @@ 
         $i        = 0;
         $only_tab = count($this->_page_config) < 2;
         foreach ($this->_page_config as $slug => $config) {
-            if (! is_array($config) || empty($config['nav'])) {
+            if ( ! is_array($config) || empty($config['nav'])) {
                 continue;
             }
             // no nav tab for this config
@@ -1449,7 +1449,7 @@ 
                 // nav tab is only to appear when route requested.
                 continue;
             }
-            if (! $this->check_user_access($slug, true)) {
+            if ( ! $this->check_user_access($slug, true)) {
                 // no nav tab because current user does not have access.
                 continue;
             }
@@ -1457,20 +1457,20 @@ 
             $css_class .= $only_tab ? ' ee-only-tab' : '';
             $css_class .= " ee-nav-tab__$slug";
 
-            $this->_nav_tabs[ $slug ] = [
+            $this->_nav_tabs[$slug] = [
                 'url'       => $config['nav']['url'] ?? EE_Admin_Page::add_query_args_and_nonce(
                         ['action' => $slug],
                         $this->_admin_base_url
                     ),
                 'link_text' => $this->navTabLabel($config['nav'], $slug),
-                'css_class' => $this->_req_action === $slug ? $css_class . ' nav-tab-active' : $css_class,
+                'css_class' => $this->_req_action === $slug ? $css_class.' nav-tab-active' : $css_class,
                 'order'     => $config['nav']['order'] ?? $i,
             ];
             $i++;
         }
         // if $this->_nav_tabs is empty then lets set the default
         if (empty($this->_nav_tabs)) {
-            $this->_nav_tabs[ $this->_default_nav_tab_name ] = [
+            $this->_nav_tabs[$this->_default_nav_tab_name] = [
                 'url'       => $this->_admin_base_url,
                 'link_text' => ucwords(str_replace('_', ' ', $this->_default_nav_tab_name)),
                 'css_class' => 'nav-tab-active',
@@ -1486,11 +1486,11 @@ 
     {
         $label = $nav_tab['label'] ?? ucwords(str_replace('_', ' ', $slug));
         $icon  = $nav_tab['icon'] ?? null;
-        $icon  = $icon ? '<span class="dashicons ' . $icon . '"></span>' : '';
+        $icon  = $icon ? '<span class="dashicons '.$icon.'"></span>' : '';
         return '
             <span class="ee-admin-screen-tab__label">
-                ' . $icon . '
-                <span class="ee-nav-label__text">' . $label . '</span>
+                ' . $icon.'
+                <span class="ee-nav-label__text">' . $label.'</span>
             </span>';
     }
 
@@ -1508,10 +1508,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;
                 }
             }
         }
@@ -1533,8 +1533,8 @@ 
     {
         // if no route_to_check is passed in then use the current route set via _req_action
         $action = $route_to_check ?: $this->_req_action;
-        $capability = ! empty($this->_page_routes[ $action ]['capability'])
-            ? $this->_page_routes[ $action ]['capability']
+        $capability = ! empty($this->_page_routes[$action]['capability'])
+            ? $this->_page_routes[$action]['capability']
             : null;
 
         if (empty($capability)) {
@@ -1584,14 +1584,14 @@ 
         string $priority = 'default',
         ?array $callback_args = null
     ) {
-        if (! (is_callable($callback) || ! function_exists($callback))) {
+        if ( ! (is_callable($callback) || ! function_exists($callback))) {
             return;
         }
 
         add_meta_box($box_id, $title, $callback, $screen, $context, $priority, $callback_args);
         add_filter(
             "postbox_classes_{$this->_wp_page_slug}_$box_id",
-            function ($classes) {
+            function($classes) {
                 $classes[] = 'ee-admin-container';
                 return $classes;
             }
@@ -1682,8 +1682,8 @@ 
             <div class="ee-notices"></div>
             <div class="ee-admin-dialog-container-inner-content"></div>
         </div>
-        <span id="current_timezone" class="hidden">' . esc_html(EEH_DTT_Helper::get_timezone()) . '</span>
-        <input type="hidden" id="espresso_admin_current_page" value="' . esc_attr($this->_current_page) . '"/>';
+        <span id="current_timezone" class="hidden">' . esc_html(EEH_DTT_Helper::get_timezone()).'</span>
+        <input type="hidden" id="espresso_admin_current_page" value="' . esc_attr($this->_current_page).'"/>';
     }
 
 
@@ -1717,7 +1717,7 @@ 
         // loop through the array and setup content
         foreach ($help_array as $trigger => $help) {
             // make sure the array is set up properly
-            if (! isset($help['title'], $help['content'])) {
+            if ( ! isset($help['title'], $help['content'])) {
                 throw new EE_Error(
                     esc_html__(
                         'Does not look like the popup content array has been setup correctly.  Might want to double check that.  Read the comments for the _get_help_popup_content method found in "EE_Admin_Page" class',
@@ -1731,8 +1731,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
             );
@@ -1754,15 +1754,15 @@ 
     private function _get_help_content(): array
     {
         // what is the method we're looking for?
-        $method_name = '_help_popup_content_' . $this->_req_action;
+        $method_name = '_help_popup_content_'.$this->_req_action;
         // if method doesn't exist let's get out.
-        if (! method_exists($this, $method_name)) {
+        if ( ! method_exists($this, $method_name)) {
             return [];
         }
         // k we're good to go let's retrieve the help array
         $help_array = $this->{$method_name}();
         // make sure we've got an array!
-        if (! is_array($help_array)) {
+        if ( ! is_array($help_array)) {
             throw new EE_Error(
                 esc_html__(
                     'Something went wrong with help popup content generation. Expecting an array and well, this ain\'t no array bub.',
@@ -1794,15 +1794,15 @@ 
         // let's check and see if there is any content set for this popup.  If there isn't then we'll include a default title and content so that developers know something needs to be corrected
         $help_array   = $this->_get_help_content();
         $help_content = '';
-        if (empty($help_array) || ! isset($help_array[ $trigger_id ])) {
-            $help_array[ $trigger_id ] = [
+        if (empty($help_array) || ! isset($help_array[$trigger_id])) {
+            $help_array[$trigger_id] = [
                 'title'   => esc_html__('Missing Content', 'event_espresso'),
                 'content' => esc_html__(
                     'A trigger has been set that doesn\'t have any corresponding content. Make sure you have set the help content. (see the "_set_help_popup_content" method in the EE_Admin_Page for instructions.)',
                     'event_espresso'
                 ),
             ];
-            $help_content              = $this->_set_help_popup_content($help_array);
+            $help_content = $this->_set_help_popup_content($help_array);
         }
         $height   = esc_attr($dimensions[0]) ?? 400;
         $width    = esc_attr($dimensions[1]) ?? 640;
@@ -1890,7 +1890,7 @@ 
 
         add_filter(
             'admin_body_class',
-            function ($classes) {
+            function($classes) {
                 if (strpos($classes, 'espresso-admin') === false) {
                     $classes .= ' espresso-admin';
                 }
@@ -1981,12 +1981,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.',
@@ -2006,10 +2006,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();
@@ -2044,7 +2044,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__(
@@ -2086,16 +2086,16 @@ 
         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;
             $action_nonce                  = "{$this->_req_action}_nonce";
-            $query_args[ $action_nonce ]   = wp_create_nonce($action_nonce);
+            $query_args[$action_nonce]   = wp_create_nonce($action_nonce);
             $query_args['status']          = $view['slug'];
             // merge any other arguments sent in.
-            if (isset($extra_query_args[ $view['slug'] ])) {
-                $query_args = array_merge($query_args, $extra_query_args[ $view['slug'] ]);
+            if (isset($extra_query_args[$view['slug']])) {
+                $query_args = array_merge($query_args, $extra_query_args[$view['slug']]);
             }
-            $this->_views[ $key ]['url'] = EE_Admin_Page::add_query_args_and_nonce($query_args, $this->_admin_base_url);
+            $this->_views[$key]['url'] = EE_Admin_Page::add_query_args_and_nonce($query_args, $this->_admin_base_url);
         }
         return $this->_views;
     }
@@ -2124,14 +2124,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
@@ -2155,7 +2155,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;
     }
 
 
@@ -2216,7 +2216,7 @@ 
                                   );
                     throw new EE_Error($error_msg);
                 }
-                unset($this->_route_config['metaboxes'][ $key ]);
+                unset($this->_route_config['metaboxes'][$key]);
             }
         }
     }
@@ -2249,7 +2249,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
@@ -2295,7 +2295,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(
@@ -2322,28 +2322,28 @@ 
      */
     public function espresso_ratings_request()
     {
-        EEH_Template::display_template(EE_ADMIN_TEMPLATE . 'espresso_ratings_request_content.template.php');
+        EEH_Template::display_template(EE_ADMIN_TEMPLATE.'espresso_ratings_request_content.template.php');
     }
 
 
     public static function cached_rss_display(string $rss_id, string $url): bool
     {
-        $loading   = '<p class="widget-loading hide-if-no-js">'
+        $loading = '<p class="widget-loading hide-if-no-js">'
                      . esc_html__('Loading&#8230;', 'event_espresso')
                      . '</p><p class="hide-if-js">'
                      . esc_html__('This widget requires JavaScript.', 'event_espresso')
                      . '</p>';
-        $pre       = '<div class="espresso-rss-display">' . "\n\t";
-        $pre       .= '<span id="' . esc_attr($rss_id) . '_url" class="hidden">' . esc_url_raw($url) . '</span>';
-        $post      = '</div>' . "\n";
-        $cache_key = 'ee_rss_' . md5($rss_id);
+        $pre       = '<div class="espresso-rss-display">'."\n\t";
+        $pre .= '<span id="'.esc_attr($rss_id).'_url" class="hidden">'.esc_url_raw($url).'</span>';
+        $post      = '</div>'."\n";
+        $cache_key = 'ee_rss_'.md5($rss_id);
         $output    = get_transient($cache_key);
         if ($output !== false) {
-            echo wp_kses($pre . $output . $post, AllowedTags::getWithFormTags());
+            echo wp_kses($pre.$output.$post, AllowedTags::getWithFormTags());
             return true;
         }
-        if (! (defined('DOING_AJAX') && DOING_AJAX)) {
-            echo wp_kses($pre . $loading . $post, AllowedTags::getWithFormTags());
+        if ( ! (defined('DOING_AJAX') && DOING_AJAX)) {
+            echo wp_kses($pre.$loading.$post, AllowedTags::getWithFormTags());
             return false;
         }
         ob_start();
@@ -2410,7 +2410,7 @@ 
     public function espresso_sponsors_post_box()
     {
         EEH_Template::display_template(
-            EE_ADMIN_TEMPLATE . 'admin_general_metabox_contents_espresso_sponsors.template.php'
+            EE_ADMIN_TEMPLATE.'admin_general_metabox_contents_espresso_sponsors.template.php'
         );
     }
 
@@ -2427,9 +2427,9 @@ 
     protected function getPublishBoxTitle(): string
     {
         $publish_box_title = esc_html__('Publish', 'event_espresso');
-        if (! empty($this->_labels['publishbox'])) {
+        if ( ! empty($this->_labels['publishbox'])) {
             if (is_array($this->_labels['publishbox'])) {
-                $publish_box_title = $this->_labels['publishbox'][ $this->_req_action ] ?? $publish_box_title;
+                $publish_box_title = $this->_labels['publishbox'][$this->_req_action] ?? $publish_box_title;
             } else {
                 $publish_box_title = $this->_labels['publishbox'];
             }
@@ -2479,7 +2479,7 @@ 
         // if we have extra content set let's add it in if not make sure its empty
         $this->_template_args['publish_box_extra_content'] = $this->_template_args['publish_box_extra_content'] ?? '';
         echo EEH_Template::display_template(
-            EE_ADMIN_TEMPLATE . 'admin_details_publish_metabox.template.php',
+            EE_ADMIN_TEMPLATE.'admin_details_publish_metabox.template.php',
             $this->_template_args,
             true
         );
@@ -2532,10 +2532,10 @@ 
                 'submitdelete deletion button button--outline button--caution'
             );
         }
-        if (! isset($this->_template_args['publish_delete_link'])) {
+        if ( ! isset($this->_template_args['publish_delete_link'])) {
             $this->_template_args['publish_delete_link'] = '';
         }
-        if (! empty($name) && ! empty($id)) {
+        if ( ! empty($name) && ! empty($id)) {
             $this->addPublishPostMetaBoxHiddenFields($name, ['type' => 'hidden', 'value' => $id]);
         }
         $hidden_fields = $this->_generate_admin_form_fields($this->publish_post_meta_box_hidden_fields, 'array');
@@ -2568,7 +2568,7 @@ 
 
     protected function addPublishPostMetaBoxHiddenFields(string $field_name, array $field_attributes)
     {
-        $this->publish_post_meta_box_hidden_fields[ $field_name ] = $field_attributes;
+        $this->publish_post_meta_box_hidden_fields[$field_name] = $field_attributes;
     }
 
 
@@ -2670,7 +2670,7 @@ 
         }
         // if $create_func is true (default) then we automatically create the function for displaying the actual meta box.  If false then we take the $callback reference passed through and use it instead (so callers can define their own callback function/method if they wish)
         $call_back_func = $create_func
-            ? static function ($post, $metabox) {
+            ? static function($post, $metabox) {
                 echo EEH_Template::display_template(
                     $metabox['args']['template_path'],
                     $metabox['args']['template_args'],
@@ -2679,7 +2679,7 @@ 
             }
             : $callback;
         $this->addMetaBox(
-            str_replace('_', '-', $action) . '-mbox',
+            str_replace('_', '-', $action).'-mbox',
             $title,
             $call_back_func,
             $this->_wp_page_slug,
@@ -2795,15 +2795,15 @@ 
                                                                     'event-espresso_page_espresso_',
                                                                     '',
                                                                     $this->_wp_page_slug
-                                                                ) . ' ' . $this->_req_action . '-route';
+                                                                ).' '.$this->_req_action.'-route';
 
         $template_path = $sidebar
             ? EE_ADMIN_TEMPLATE . 'admin_details_wrapper.template.php'
-            : EE_ADMIN_TEMPLATE . 'admin_details_wrapper_no_sidebar.template.php';
+            : EE_ADMIN_TEMPLATE.'admin_details_wrapper_no_sidebar.template.php';
 
         $this->_template_args['is_ajax'] = $this->request->isAjax();
         if ($this->request->isAjax()) {
-            $template_path = EE_ADMIN_TEMPLATE . 'admin_details_wrapper_no_sidebar_ajax.template.php';
+            $template_path = EE_ADMIN_TEMPLATE.'admin_details_wrapper_no_sidebar_ajax.template.php';
         }
         $template_path = ! empty($this->_column_template_path) ? $this->_column_template_path : $template_path;
 
@@ -2815,10 +2815,10 @@ 
         // to prevent WooCommerce from blowing things up if not using CPT
         global $post_type, $post;
         $this->_template_args['post_type'] = $post_type ?? '';
-        $this->_template_args['post']  = $post ?? new WP_Post( (object) [ 'ID' => 0, 'filter' => 'raw' ] );
+        $this->_template_args['post'] = $post ?? new WP_Post((object) ['ID' => 0, 'filter' => 'raw']);
 
         $this->_template_args['post_body_content'] = EEH_Template::display_template(
-            EE_ADMIN_TEMPLATE . 'admin_details_wrapper_post_body_content.template.php',
+            EE_ADMIN_TEMPLATE.'admin_details_wrapper_post_body_content.template.php',
             $this->_template_args,
             true
         );
@@ -2850,11 +2850,11 @@ 
     public function display_admin_caf_preview_page(string $utm_campaign_source = '', bool $display_sidebar = true)
     {
         // let's generate a default preview action button if there isn't one already present.
-        $this->_labels['buttons']['buy_now']           = esc_html__(
+        $this->_labels['buttons']['buy_now'] = esc_html__(
             'Upgrade to Event Espresso 4 Right Now',
             'event_espresso'
         );
-        $buy_now_url                                   = add_query_arg(
+        $buy_now_url = add_query_arg(
             [
                 'ee_ver'       => 'ee4',
                 'utm_source'   => 'ee4_plugin_admin',
@@ -2874,8 +2874,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
         );
@@ -2933,7 +2933,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);
@@ -2941,10 +2941,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
             );
@@ -2961,18 +2961,18 @@ 
 
         $hidden_form_fields = $this->_template_args['list_table_hidden_fields'] ?? '';
 
-        $nonce_ref          = $this->_req_action . '_nonce';
+        $nonce_ref          = $this->_req_action.'_nonce';
         $hidden_form_fields .= '
-            <input type="hidden" name="' . $nonce_ref . '" value="' . wp_create_nonce($nonce_ref) . '">';
+            <input type="hidden" name="' . $nonce_ref.'" value="'.wp_create_nonce($nonce_ref).'">';
 
         $this->_template_args['list_table_hidden_fields'] = $hidden_form_fields;
         // display message about search results?
-        $search                                    = $this->request->getRequestParam('s');
+        $search = $this->request->getRequestParam('s');
         $this->_template_args['before_list_table'] .= ! empty($search)
-            ? '<p class="ee-search-results">' . sprintf(
+            ? '<p class="ee-search-results">'.sprintf(
                 esc_html__('Displaying search results for the search string: %1$s', 'event_espresso'),
                 trim($search, '%')
-            ) . '</p>'
+            ).'</p>'
             : '';
         // filter before_list_table template arg
         $this->_template_args['before_list_table'] = apply_filters(
@@ -3006,7 +3006,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',
@@ -3061,7 +3061,7 @@ 
             $this->page_slug
         );
         return EEH_Template::display_template(
-            EE_ADMIN_TEMPLATE . 'admin_details_legend.template.php',
+            EE_ADMIN_TEMPLATE.'admin_details_legend.template.php',
             $this->_template_args,
             true
         );
@@ -3184,7 +3184,7 @@ 
         if ($this->request->isAjax()) {
             $this->_template_args['admin_page_content'] = EEH_Template::display_template(
             // $template_path,
-                EE_ADMIN_TEMPLATE . 'admin_wrapper_ajax.template.php',
+                EE_ADMIN_TEMPLATE.'admin_wrapper_ajax.template.php',
                 $this->_template_args,
                 true
             );
@@ -3193,7 +3193,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);
     }
@@ -3277,12 +3277,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;
             }
         }
@@ -3323,13 +3323,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;
@@ -3337,9 +3337,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],
@@ -3352,7 +3352,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>';
@@ -3435,10 +3435,10 @@ 
     ) {
         $notices = EE_Error::get_notices(false);
         // overwrite default success messages //BUT ONLY if overwrite not overridden
-        if (! $override_overwrite || ! empty($notices['errors'])) {
+        if ( ! $override_overwrite || ! empty($notices['errors'])) {
             EE_Error::overwrite_success();
         }
-        if (! $override_overwrite && ! empty($what) && ! empty($action_desc) && empty($notices['errors'])) {
+        if ( ! $override_overwrite && ! empty($what) && ! empty($action_desc) && empty($notices['errors'])) {
             // how many records affected ? more than one record ? or just one ?
             EE_Error::add_success(
                 sprintf(
@@ -3489,7 +3489,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?
@@ -3501,15 +3501,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.
@@ -3521,19 +3521,19 @@ 
         if (isset($query_args['action'])) {
             // manually generate wp_nonce and merge that with the query vars
             // becuz the wp_nonce_url function wrecks havoc on some vars
-            $query_args['_wpnonce'] = wp_create_nonce($query_args['action'] . '_nonce');
+            $query_args['_wpnonce'] = wp_create_nonce($query_args['action'].'_nonce');
         }
         // we're adding some hooks and filters in here for processing any things just before redirects
         // (example: an admin page has done an insert or update and we want to run something after that).
-        do_action('AHEE_redirect_' . $this->class_name . $this->_req_action, $query_args);
+        do_action('AHEE_redirect_'.$this->class_name.$this->_req_action, $query_args);
         $redirect_url = apply_filters(
-            'FHEE_redirect_' . $this->class_name . $this->_req_action,
+            'FHEE_redirect_'.$this->class_name.$this->_req_action,
             EE_Admin_Page::add_query_args_and_nonce($query_args, $redirect_url),
             $query_args
         );
         // check if we're doing ajax.  If we are then lets just return the results and js can handle how it wants.
         if ($this->request->isAjax()) {
-            $default_data                    = [
+            $default_data = [
                 'close'        => true,
                 'redirect_url' => $redirect_url,
                 'where'        => 'main',
@@ -3586,7 +3586,7 @@ 
         }
         $this->_template_args['notices'] = EE_Error::get_notices();
         // IF this isn't ajax we need to create a transient for the notices using the route (however, overridden if $sticky_notices == true)
-        if (! $this->request->isAjax() || $sticky_notices) {
+        if ( ! $this->request->isAjax() || $sticky_notices) {
             $route = $query_args['action'] ?? 'default';
             $this->_add_transient(
                 $route,
@@ -3626,7 +3626,7 @@ 
         bool $exclude_nonce = false
     ): string {
         // first let's validate the action (if $base_url is FALSE otherwise validation will happen further along)
-        if (empty($base_url) && ! isset($this->_page_routes[ $action ])) {
+        if (empty($base_url) && ! isset($this->_page_routes[$action])) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -3637,7 +3637,7 @@ 
                 )
             );
         }
-        if (! isset($this->_labels['buttons'][ $type ])) {
+        if ( ! isset($this->_labels['buttons'][$type])) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -3650,7 +3650,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;
@@ -3658,11 +3658,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);
     }
 
 
@@ -3688,7 +3688,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)) {
@@ -3709,18 +3709,18 @@ 
     {
         if ($this->request->requestParamIsSet('wp_screen_options')) {
             check_admin_referer('screen-options-nonce', 'screenoptionnonce');
-            if (! $user = wp_get_current_user()) {
+            if ( ! $user = wp_get_current_user()) {
                 return;
             }
             $option = $this->request->getRequestParam('wp_screen_options[option]', '', DataType::KEY);
-            if (! $option) {
+            if ( ! $option) {
                 return;
             }
             $value      = $this->request->getRequestParam('wp_screen_options[value]', 0, DataType::INT);
             $map_option = $option;
             $option     = str_replace('-', '_', $option);
             switch ($map_option) {
-                case $this->_current_page . '_' . $this->_current_view . '_per_page':
+                case $this->_current_page.'_'.$this->_current_view.'_per_page':
                     $max_value = apply_filters(
                         'FHEE__EE_Admin_Page___set_per_page_screen_options__max_value',
                         999,
@@ -3787,7 +3787,7 @@ 
         bool $skip_route_verify = false
     ) {
         $user_id = get_current_user_id();
-        if (! $skip_route_verify) {
+        if ( ! $skip_route_verify) {
             $this->_verify_route($route);
         }
         // now let's set the string for what kind of transient we're setting
@@ -3820,8 +3820,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);
@@ -4079,7 +4079,7 @@ 
      */
     protected function _next_link(string $url, string $class = 'dashicons dashicons-arrow-right'): string
     {
-        return '<a class="' . $class . '" href="' . $url . '"></a>';
+        return '<a class="'.$class.'" href="'.$url.'"></a>';
     }
 
 
@@ -4092,7 +4092,7 @@ 
      */
     protected function _previous_link(string $url, string $class = 'dashicons dashicons-arrow-left'): string
     {
-        return '<a class="' . $class . '" href="' . $url . '"></a>';
+        return '<a class="'.$class.'" href="'.$url.'"></a>';
     }
 
 
@@ -4240,13 +4240,13 @@ 
         ?callable $callback = null
     ): bool {
         $entity_ID = absint($entity_ID);
-        if (! $entity_ID) {
+        if ( ! $entity_ID) {
             $this->trashRestoreDeleteError($action, $entity_model);
         }
         $result = 0;
         try {
             $entity = $entity_model->get_one_by_ID($entity_ID);
-            if (! $entity instanceof EE_Base_Class) {
+            if ( ! $entity instanceof EE_Base_Class) {
                 throw new DomainException(
                     sprintf(
                         esc_html__(
@@ -4297,7 +4297,7 @@ 
                 )
             );
         }
-        if (! $entity_model->has_field($delete_column)) {
+        if ( ! $entity_model->has_field($delete_column)) {
             throw new DomainException(
                 sprintf(
                     esc_html__(

core/libraries/payment_methods/EE_Payment_Method_Manager.lib.php

Indentation +584 added lines, -584 removed lines

@@ -16,588 +16,588 @@
  */
 class EE_Payment_Method_Manager implements ResettableInterface
 {
-    /**
-     * prefix added to all payment method capabilities names
-     */
-    const CAPABILITIES_PREFIX = 'ee_payment_method_';
-
-    private static ?EE_Payment_Method_Manager $_instance = null;
-
-    /**
-     * @var boolean
-     */
-    protected bool $payment_method_caps_initialized = false;
-
-    /**
-     * @var string[] keys are class names without 'EE_PMT_', values are their filepaths
-     */
-    protected array $_payment_method_types = [];
-
-    /**
-     * @var EE_PMT_Base[]
-     */
-    protected array $payment_method_objects = [];
-
-
-    /**
-     * EE_Payment_Method_Manager constructor.
-     *
-     * @throws DomainException
-     */
-    public function __construct()
-    {
-        // if in admin lets ensure caps are set.
-        if (is_admin()) {
-            $this->_register_payment_methods();
-            // add PM caps when EE_Capabilities is initialized
-            add_action(
-                'AHEE__EE_Capabilities__init_caps__before_initialization',
-                [$this, 'initializePaymentMethodCaps']
-            );
-            // plus any time they get reset
-            add_filter(
-                'FHEE__EE_Capabilities__addCaps__capabilities_to_add',
-                [$this, 'addPaymentMethodCapsDuringReset']
-            );
-        }
-        add_action('http_api_curl', ['EE_Payment_Method_Manager', 'curlRequestsToPaypalUseTls'], 10, 3);
-    }
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @return EE_Payment_Method_Manager instance
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function instance(): EE_Payment_Method_Manager
-    {
-        // check if class object is instantiated, and instantiated properly
-        if (! self::$_instance instanceof EE_Payment_Method_Manager) {
-            EE_Registry::instance()->load_lib('PMT_Base');
-            self::$_instance = new self();
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * Resets the instance and returns a new one
-     *
-     * @return EE_Payment_Method_Manager
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function reset(): EE_Payment_Method_Manager
-    {
-        self::$_instance = null;
-        return self::instance();
-    }
-
-
-    /**
-     * Force posts to PayPal to use TLS v1.2. See:
-     * https://core.trac.wordpress.org/ticket/36320
-     * https://core.trac.wordpress.org/ticket/34924#comment:15
-     * https://www.paypal-knowledge.com/infocenter/index?page=content&widgetview=true&id=FAQ1914&viewlocale=en_US
-     * This will affect PayPal standard, pro, express, and Payflow.
-     *
-     * @param $handle
-     * @param $r
-     * @param $url
-     */
-    public static function curlRequestsToPaypalUseTls($handle, $r, $url)
-    {
-        if (strpos($url, 'https://') !== false && strpos($url, '.paypal.com') !== false) {
-            // Use the value of the constant CURL_SSLVERSION_TLSv1 = 1
-            // instead of the constant because it might not be defined
-            curl_setopt($handle, CURLOPT_SSLVERSION, 6);
-        }
-    }
-
-
-    /**
-     * If necessary, re-register payment methods
-     *
-     * @param boolean $force_recheck whether to recheck for payment method types,
-     *                               or just re-use the PMTs we found last time we checked during this request (if
-     *                               we have not yet checked during this request, then we need to check anyways)
-     */
-    public function maybe_register_payment_methods(bool $force_recheck = false)
-    {
-        if (! $this->_payment_method_types || $force_recheck) {
-            $this->_register_payment_methods();
-        }
-    }
-
-
-    /**
-     * register_payment_methods
-     *
-     * @return array
-     */
-    protected function _register_payment_methods(): array
-    {
-        // grab list of installed modules
-        $pm_to_register = glob(EE_PAYMENT_METHODS . '*', GLOB_ONLYDIR);
-        // filter list of modules to register
-        $pm_to_register = apply_filters(
-            'FHEE__EE_Payment_Method_Manager__register_payment_methods__payment_methods_to_register',
-            $pm_to_register
-        );
-        // remove any duplicates if that should happen for some reason
-        $pm_to_register = array_unique($pm_to_register);
-        // loop through folders
-        foreach ($pm_to_register as $pm_path) {
-            $this->register_payment_method($pm_path);
-        }
-        do_action('FHEE__EE_Payment_Method_Manager__register_payment_methods__registered_payment_methods');
-        // filter list of installed modules
-        // keep them organized alphabetically by the payment method type's name
-        ksort($this->_payment_method_types);
-        return apply_filters(
-            'FHEE__EE_Payment_Method_Manager__register_payment_methods__installed_payment_methods',
-            $this->_payment_method_types
-        );
-    }
-
-
-    /**
-     * register_payment_method- makes core aware of this payment method
-     *
-     * @param string $payment_method_path - full path up to and including payment method folder
-     * @return boolean
-     */
-    public function register_payment_method(string $payment_method_path = ''): bool
-    {
-        do_action('AHEE__EE_Payment_Method_Manager__register_payment_method__begin', $payment_method_path);
-        $module_ext = '.pm.php';
-        // make all separators match
-        $payment_method_path = rtrim(str_replace('/\\', '/', $payment_method_path), '/');
-        // grab and sanitize module name
-        $module_dir = basename($payment_method_path);
-        // create class name from module directory name
-        $module = str_replace(['_', ' '], [' ', '_'], $module_dir);
-        // add class prefix
-        $module_class = 'EE_PMT_' . $module;
-        // does the module exist ?
-        if (! is_readable($payment_method_path . '/' . $module_class . $module_ext)) {
-            $msg = sprintf(
-                esc_html__(
-                    'The requested %s payment method file could not be found or is not readable due to file permissions.',
-                    'event_espresso'
-                ),
-                $module
-            );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        // load the module class file
-        require_once($payment_method_path . '/' . $module_class . $module_ext);
-        // verify that class exists
-        if (! class_exists($module_class)) {
-            $msg = sprintf(
-                esc_html__('The requested %s module class does not exist.', 'event_espresso'),
-                $module_class
-            );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        // add to array of registered modules
-        $this->_payment_method_types[ $module ] = $payment_method_path . '/' . $module_class . $module_ext;
-        return true;
-    }
-
-
-    /**
-     * Checks if a payment method has been registered, and if so includes it
-     *
-     * @param string  $payment_method_name like 'PayPal_Pro', (ie class name without the prefix 'EEPM_')
-     * @param boolean $force_recheck       whether to force re-checking for new payment method types
-     * @return boolean
-     */
-    public function payment_method_type_exists(string $payment_method_name, bool $force_recheck = false): bool
-    {
-        if (
-            $force_recheck
-            || empty($this->_payment_method_types)
-            || ! isset($this->_payment_method_types[ $payment_method_name ])
-        ) {
-            $this->maybe_register_payment_methods($force_recheck);
-        }
-        if (isset($this->_payment_method_types[ $payment_method_name ])) {
-            require_once($this->_payment_method_types[ $payment_method_name ]);
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * Returns all the class names of the various payment method types
-     *
-     * @param boolean $with_prefixes TRUE: get payment method type class names; false just their 'names'
-     *                               (what you'd find in wp_esp_payment_method.PMD_type)
-     * @param boolean $force_recheck whether to force re-checking for new payment method types
-     * @return array
-     */
-    public function payment_method_type_names(bool $with_prefixes = false, bool $force_recheck = false): array
-    {
-        $this->maybe_register_payment_methods($force_recheck);
-        if ($with_prefixes) {
-            $classnames      = array_keys($this->_payment_method_types);
-            $payment_methods = [];
-            foreach ($classnames as $classname) {
-                $payment_methods[] = $this->payment_method_class_from_type($classname);
-            }
-            return $payment_methods;
-        }
-        return array_keys($this->_payment_method_types);
-    }
-
-
-    /**
-     * Gets an object of each payment method type, none of which are bound to a
-     * payment method instance
-     *
-     * @param boolean $force_recheck whether to force re-checking for new payment method types
-     * @return EE_PMT_Base[]
-     */
-    public function payment_method_types(bool $force_recheck = false): array
-    {
-        if ($force_recheck || empty($this->payment_method_objects)) {
-            $this->maybe_register_payment_methods($force_recheck);
-            foreach ($this->payment_method_type_names(true) as $classname) {
-                if (! isset($this->payment_method_objects[ $classname ])) {
-                    $this->payment_method_objects[ $classname ] = new $classname();
-                }
-            }
-        }
-        return $this->payment_method_objects;
-    }
-
-
-    /**
-     * Changes the payment method's class name into the payment method type's name
-     * (as used on the payment method's table's PMD_type field)
-     *
-     * @param string $classname
-     * @return string
-     */
-    public function payment_method_type_sans_class_prefix(string $classname): string
-    {
-        return str_replace('EE_PMT_', '', $classname);
-    }
-
-
-    /**
-     * Does the opposite of payment-method_type_sans_prefix
-     *
-     * @param string $type
-     * @return string
-     */
-    public function payment_method_class_from_type(string $type): string
-    {
-        return 'EE_PMT_' . $type;
-    }
-
-
-    /**
-     * Activates a payment method of the given type.
-     *
-     * @param string $payment_method_type the PMT_type; for EE_PMT_Invoice this would be 'Invoice'
-     * @return EE_Payment_Method
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function activate_a_payment_method_of_type(string $payment_method_type): EE_Payment_Method
-    {
-        $this->maybe_register_payment_methods();
-        $payment_method = EEM_Payment_Method::instance()->get_one_of_type($payment_method_type);
-        if (! $payment_method instanceof EE_Payment_Method) {
-            $pm_type_class = $this->payment_method_class_from_type($payment_method_type);
-            if (class_exists($pm_type_class)) {
-                /** @var $pm_type_obj EE_PMT_Base */
-                $pm_type_obj    = new $pm_type_class();
-                $payment_method = EEM_Payment_Method::instance()->get_one_by_slug($pm_type_obj->system_name());
-                if (! $payment_method) {
-                    $payment_method = $this->create_payment_method_of_type($pm_type_obj);
-                }
-                $payment_method->set_type($payment_method_type);
-                $this->initialize_payment_method($payment_method);
-            } else {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            'There is no payment method of type %1$s, so it could not be activated',
-                            'event_espresso'
-                        ),
-                        $pm_type_class
-                    )
-                );
-            }
-        }
-        $payment_method->set_active();
-        $payment_method->save();
-        /** @type EE_Message_Resource_Manager $message_resource_manager */
-        // if this was the invoice message type, make sure users can view their invoices
-        if (
-            $payment_method->type() === 'Invoice'
-            && (
-            ! EEH_MSG_Template::is_mt_active('invoice')
-            )
-        ) {
-            $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-            /** @type EE_Message_Resource_Manager $message_resource_manager */
-            $message_resource_manager->ensure_message_type_is_active('invoice', 'html');
-            new PersistentAdminNotice(
-                'invoice_pm_requirements_notice',
-                sprintf(
-                    esc_html__(
-                        'The Invoice payment method has been activated. It requires the %1$sinvoice message%2$s type to be active, so it was automatically activated for you.',
-                        'event_espresso'
-                    ),
-                    '<a href="' . admin_url('admin.php?page=espresso_messages&action=settings') . '">',
-                    '</a>'
-                ),
-                true
-            );
-        }
-        return $payment_method;
-    }
-
-
-    /**
-     * Creates a payment method of the specified type. Does not save it.
-     *
-     * @param EE_PMT_Base $pm_type_obj
-     * @return EE_Payment_Method
-     * @throws EE_Error*@throws ReflectionException
-     * @throws ReflectionException
-     * @global WP_User    $current_user
-     */
-    public function create_payment_method_of_type(EE_PMT_Base $pm_type_obj): EE_Payment_Method
-    {
-        global $current_user;
-        return EE_Payment_Method::new_instance(
-            [
-                'PMD_type'       => $pm_type_obj->system_name(),
-                'PMD_name'       => $pm_type_obj->defaultFrontendName(),
-                'PMD_admin_name' => $pm_type_obj->pretty_name(),
-                'PMD_slug'       => $pm_type_obj->system_name(),// automatically converted to slug
-                'PMD_wp_user'    => $current_user->ID,
-                'PMD_order'      => EEM_Payment_Method::instance()->count(
-                    [['PMD_type' => ['!=', 'Admin_Only']]]
-                ) * 10,
-            ]
-        );
-    }
-
-
-    /**
-     * Sets the initial payment method properties (including extra meta)
-     *
-     * @param EE_Payment_Method $payment_method
-     * @return EE_Payment_Method
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function initialize_payment_method(EE_Payment_Method $payment_method): EE_Payment_Method
-    {
-        $pm_type_obj = $payment_method->type_obj();
-        $payment_method->set_description($pm_type_obj->default_description());
-        if (! $payment_method->button_url()) {
-            $payment_method->set_button_url($pm_type_obj->default_button_url());
-        }
-        // now add setup its default extra meta properties
-        $extra_metas = $pm_type_obj->settings_form()->extra_meta_inputs();
-        if (! empty($extra_metas)) {
-            // verify the payment method has an ID before adding extra meta
-            if (! $payment_method->ID()) {
-                $payment_method->save();
-            }
-            foreach ($extra_metas as $meta_name => $input) {
-                $payment_method->update_extra_meta($meta_name, $input->raw_value());
-            }
-        }
-        return $payment_method;
-    }
-
-
-    /**
-     * Makes sure the payment method is related to the specified payment method
-     *
-     * @param EE_Payment_Method $payment_method
-     * @return EE_Payment_Method
-     * @deprecated in 4.9.40 because the currency payment method table is being deprecated
-     */
-    public function set_usable_currencies_on_payment_method(EE_Payment_Method $payment_method): EE_Payment_Method
-    {
-        EE_Error::doing_it_wrong(
-            'EE_Payment_Method_Manager::set_usable_currencies_on_payment_method',
-            esc_html__(
-                'We no longer define what currencies are usable by payment methods. Its not used nor efficient.',
-                'event_espresso'
-            ),
-            '4.9.40'
-        );
-        return $payment_method;
-    }
-
-
-    /**
-     * Deactivates a payment method of the given payment method slug.
-     *
-     * @param string $payment_method_slug The slug for the payment method to deactivate.
-     * @return int count of rows updated.
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function deactivate_payment_method(string $payment_method_slug): int
-    {
-        EE_Log::instance()->log(
-            __FILE__,
-            __FUNCTION__,
-            sprintf(
-                esc_html__(
-                    'Payment method with slug %1$s is being deactivated by site admin',
-                    'event_espresso'
-                ),
-                $payment_method_slug
-            ),
-            'payment_method_change'
-        );
-        $count_updated = EEM_Payment_Method::instance()->update(
-            ['PMD_scope' => []],
-            [['PMD_slug' => $payment_method_slug]]
-        );
-        do_action(
-            'AHEE__EE_Payment_Method_Manager__deactivate_payment_method__after_deactivating_payment_method',
-            $payment_method_slug,
-            $count_updated
-        );
-        return $count_updated;
-    }
-
-
-    /**
-     * initializes payment method access caps via EE_Capabilities::init_role_caps()
-     * upon EE_Payment_Method_Manager construction
-     *
-     * @throws EE_Error
-     * @throws DomainException
-     */
-    public function initializePaymentMethodCaps()
-    {
-        // don't do this twice
-        if ($this->payment_method_caps_initialized) {
-            return;
-        }
-        EE_Capabilities::instance()->addCaps(
-            $this->getPaymentMethodCaps()
-        );
-        $this->payment_method_caps_initialized = true;
-    }
-
-
-    /**
-     * array  of dynamic payment method access caps.
-     * at the time of writing, october 20 2014, these are the caps added:
-     *  ee_payment_method_admin_only
-     *  ee_payment_method_aim
-     *  ee_payment_method_bank
-     *  ee_payment_method_check
-     *  ee_payment_method_invoice
-     *  ee_payment_method_mijireh
-     *  ee_payment_method_paypal_pro
-     *  ee_payment_method_paypal_standard
-     * Any other payment methods added to core or via addons will also get
-     * their related capability automatically added too, so long as they are
-     * registered properly using EE_Register_Payment_Method::register()
-     *
-     * @return array
-     * @throws DomainException
-     */
-    protected function getPaymentMethodCaps(): array
-    {
-        $caps = [];
-        foreach ($this->payment_method_type_names() as $payment_method_name) {
-            $caps = $this->addPaymentMethodCap($payment_method_name, $caps);
-        }
-        return $caps;
-    }
-
-
-    /**
-     * @param string $payment_method_name
-     * @param array  $payment_method_caps
-     * @param string $role
-     * @return array
-     * @throws DomainException
-     */
-    public function addPaymentMethodCap(
-        string $payment_method_name,
-        array $payment_method_caps,
-        string $role = 'administrator'
-    ): array {
-        if (empty($payment_method_name)) {
-            throw new DomainException(
-                esc_html__(
-                    'The name of a payment method must be specified to add capabilities.',
-                    'event_espresso'
-                )
-            );
-        }
-        if (empty($role)) {
-            throw new DomainException(
-                sprintf(
-                    esc_html__(
-                        'No role was supplied while trying to add capabilities for the %1$s payment method.',
-                        'event_espresso'
-                    ),
-                    $payment_method_name
-                )
-            );
-        }
-        if (! isset($payment_method_caps[ $role ])) {
-            $payment_method_caps[ $role ] = [];
-        }
-        $payment_method_caps[ $role ][] = EE_Payment_Method_Manager::CAPABILITIES_PREFIX
-                                          . strtolower($payment_method_name);
-        return $payment_method_caps;
-    }
-
-
-    /**
-     * callback for FHEE__EE_Capabilities__init_role_caps__caps_map filter
-     * to add dynamic payment method access caps when capabilities are reset
-     * (or if that filter is called and PM caps are not already set)
-     *
-     * @param array $caps capabilities being filtered
-     * @param bool  $reset
-     * @return array
-     * @throws DomainException
-     */
-    public function addPaymentMethodCapsDuringReset(array $caps, bool $reset = false): array
-    {
-        if ($reset || ! $this->payment_method_caps_initialized) {
-            $this->payment_method_caps_initialized = true;
-            $caps                                  = array_merge_recursive($caps, $this->getPaymentMethodCaps());
-        }
-        return $caps;
-    }
-
-
-    /**
-     * @param $caps
-     * @return mixed
-     * @deprecated 4.9.42
-     */
-    public function add_payment_method_caps($caps)
-    {
-        return $caps;
-    }
+	/**
+	 * prefix added to all payment method capabilities names
+	 */
+	const CAPABILITIES_PREFIX = 'ee_payment_method_';
+
+	private static ?EE_Payment_Method_Manager $_instance = null;
+
+	/**
+	 * @var boolean
+	 */
+	protected bool $payment_method_caps_initialized = false;
+
+	/**
+	 * @var string[] keys are class names without 'EE_PMT_', values are their filepaths
+	 */
+	protected array $_payment_method_types = [];
+
+	/**
+	 * @var EE_PMT_Base[]
+	 */
+	protected array $payment_method_objects = [];
+
+
+	/**
+	 * EE_Payment_Method_Manager constructor.
+	 *
+	 * @throws DomainException
+	 */
+	public function __construct()
+	{
+		// if in admin lets ensure caps are set.
+		if (is_admin()) {
+			$this->_register_payment_methods();
+			// add PM caps when EE_Capabilities is initialized
+			add_action(
+				'AHEE__EE_Capabilities__init_caps__before_initialization',
+				[$this, 'initializePaymentMethodCaps']
+			);
+			// plus any time they get reset
+			add_filter(
+				'FHEE__EE_Capabilities__addCaps__capabilities_to_add',
+				[$this, 'addPaymentMethodCapsDuringReset']
+			);
+		}
+		add_action('http_api_curl', ['EE_Payment_Method_Manager', 'curlRequestsToPaypalUseTls'], 10, 3);
+	}
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @return EE_Payment_Method_Manager instance
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function instance(): EE_Payment_Method_Manager
+	{
+		// check if class object is instantiated, and instantiated properly
+		if (! self::$_instance instanceof EE_Payment_Method_Manager) {
+			EE_Registry::instance()->load_lib('PMT_Base');
+			self::$_instance = new self();
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * Resets the instance and returns a new one
+	 *
+	 * @return EE_Payment_Method_Manager
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function reset(): EE_Payment_Method_Manager
+	{
+		self::$_instance = null;
+		return self::instance();
+	}
+
+
+	/**
+	 * Force posts to PayPal to use TLS v1.2. See:
+	 * https://core.trac.wordpress.org/ticket/36320
+	 * https://core.trac.wordpress.org/ticket/34924#comment:15
+	 * https://www.paypal-knowledge.com/infocenter/index?page=content&widgetview=true&id=FAQ1914&viewlocale=en_US
+	 * This will affect PayPal standard, pro, express, and Payflow.
+	 *
+	 * @param $handle
+	 * @param $r
+	 * @param $url
+	 */
+	public static function curlRequestsToPaypalUseTls($handle, $r, $url)
+	{
+		if (strpos($url, 'https://') !== false && strpos($url, '.paypal.com') !== false) {
+			// Use the value of the constant CURL_SSLVERSION_TLSv1 = 1
+			// instead of the constant because it might not be defined
+			curl_setopt($handle, CURLOPT_SSLVERSION, 6);
+		}
+	}
+
+
+	/**
+	 * If necessary, re-register payment methods
+	 *
+	 * @param boolean $force_recheck whether to recheck for payment method types,
+	 *                               or just re-use the PMTs we found last time we checked during this request (if
+	 *                               we have not yet checked during this request, then we need to check anyways)
+	 */
+	public function maybe_register_payment_methods(bool $force_recheck = false)
+	{
+		if (! $this->_payment_method_types || $force_recheck) {
+			$this->_register_payment_methods();
+		}
+	}
+
+
+	/**
+	 * register_payment_methods
+	 *
+	 * @return array
+	 */
+	protected function _register_payment_methods(): array
+	{
+		// grab list of installed modules
+		$pm_to_register = glob(EE_PAYMENT_METHODS . '*', GLOB_ONLYDIR);
+		// filter list of modules to register
+		$pm_to_register = apply_filters(
+			'FHEE__EE_Payment_Method_Manager__register_payment_methods__payment_methods_to_register',
+			$pm_to_register
+		);
+		// remove any duplicates if that should happen for some reason
+		$pm_to_register = array_unique($pm_to_register);
+		// loop through folders
+		foreach ($pm_to_register as $pm_path) {
+			$this->register_payment_method($pm_path);
+		}
+		do_action('FHEE__EE_Payment_Method_Manager__register_payment_methods__registered_payment_methods');
+		// filter list of installed modules
+		// keep them organized alphabetically by the payment method type's name
+		ksort($this->_payment_method_types);
+		return apply_filters(
+			'FHEE__EE_Payment_Method_Manager__register_payment_methods__installed_payment_methods',
+			$this->_payment_method_types
+		);
+	}
+
+
+	/**
+	 * register_payment_method- makes core aware of this payment method
+	 *
+	 * @param string $payment_method_path - full path up to and including payment method folder
+	 * @return boolean
+	 */
+	public function register_payment_method(string $payment_method_path = ''): bool
+	{
+		do_action('AHEE__EE_Payment_Method_Manager__register_payment_method__begin', $payment_method_path);
+		$module_ext = '.pm.php';
+		// make all separators match
+		$payment_method_path = rtrim(str_replace('/\\', '/', $payment_method_path), '/');
+		// grab and sanitize module name
+		$module_dir = basename($payment_method_path);
+		// create class name from module directory name
+		$module = str_replace(['_', ' '], [' ', '_'], $module_dir);
+		// add class prefix
+		$module_class = 'EE_PMT_' . $module;
+		// does the module exist ?
+		if (! is_readable($payment_method_path . '/' . $module_class . $module_ext)) {
+			$msg = sprintf(
+				esc_html__(
+					'The requested %s payment method file could not be found or is not readable due to file permissions.',
+					'event_espresso'
+				),
+				$module
+			);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		// load the module class file
+		require_once($payment_method_path . '/' . $module_class . $module_ext);
+		// verify that class exists
+		if (! class_exists($module_class)) {
+			$msg = sprintf(
+				esc_html__('The requested %s module class does not exist.', 'event_espresso'),
+				$module_class
+			);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		// add to array of registered modules
+		$this->_payment_method_types[ $module ] = $payment_method_path . '/' . $module_class . $module_ext;
+		return true;
+	}
+
+
+	/**
+	 * Checks if a payment method has been registered, and if so includes it
+	 *
+	 * @param string  $payment_method_name like 'PayPal_Pro', (ie class name without the prefix 'EEPM_')
+	 * @param boolean $force_recheck       whether to force re-checking for new payment method types
+	 * @return boolean
+	 */
+	public function payment_method_type_exists(string $payment_method_name, bool $force_recheck = false): bool
+	{
+		if (
+			$force_recheck
+			|| empty($this->_payment_method_types)
+			|| ! isset($this->_payment_method_types[ $payment_method_name ])
+		) {
+			$this->maybe_register_payment_methods($force_recheck);
+		}
+		if (isset($this->_payment_method_types[ $payment_method_name ])) {
+			require_once($this->_payment_method_types[ $payment_method_name ]);
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * Returns all the class names of the various payment method types
+	 *
+	 * @param boolean $with_prefixes TRUE: get payment method type class names; false just their 'names'
+	 *                               (what you'd find in wp_esp_payment_method.PMD_type)
+	 * @param boolean $force_recheck whether to force re-checking for new payment method types
+	 * @return array
+	 */
+	public function payment_method_type_names(bool $with_prefixes = false, bool $force_recheck = false): array
+	{
+		$this->maybe_register_payment_methods($force_recheck);
+		if ($with_prefixes) {
+			$classnames      = array_keys($this->_payment_method_types);
+			$payment_methods = [];
+			foreach ($classnames as $classname) {
+				$payment_methods[] = $this->payment_method_class_from_type($classname);
+			}
+			return $payment_methods;
+		}
+		return array_keys($this->_payment_method_types);
+	}
+
+
+	/**
+	 * Gets an object of each payment method type, none of which are bound to a
+	 * payment method instance
+	 *
+	 * @param boolean $force_recheck whether to force re-checking for new payment method types
+	 * @return EE_PMT_Base[]
+	 */
+	public function payment_method_types(bool $force_recheck = false): array
+	{
+		if ($force_recheck || empty($this->payment_method_objects)) {
+			$this->maybe_register_payment_methods($force_recheck);
+			foreach ($this->payment_method_type_names(true) as $classname) {
+				if (! isset($this->payment_method_objects[ $classname ])) {
+					$this->payment_method_objects[ $classname ] = new $classname();
+				}
+			}
+		}
+		return $this->payment_method_objects;
+	}
+
+
+	/**
+	 * Changes the payment method's class name into the payment method type's name
+	 * (as used on the payment method's table's PMD_type field)
+	 *
+	 * @param string $classname
+	 * @return string
+	 */
+	public function payment_method_type_sans_class_prefix(string $classname): string
+	{
+		return str_replace('EE_PMT_', '', $classname);
+	}
+
+
+	/**
+	 * Does the opposite of payment-method_type_sans_prefix
+	 *
+	 * @param string $type
+	 * @return string
+	 */
+	public function payment_method_class_from_type(string $type): string
+	{
+		return 'EE_PMT_' . $type;
+	}
+
+
+	/**
+	 * Activates a payment method of the given type.
+	 *
+	 * @param string $payment_method_type the PMT_type; for EE_PMT_Invoice this would be 'Invoice'
+	 * @return EE_Payment_Method
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function activate_a_payment_method_of_type(string $payment_method_type): EE_Payment_Method
+	{
+		$this->maybe_register_payment_methods();
+		$payment_method = EEM_Payment_Method::instance()->get_one_of_type($payment_method_type);
+		if (! $payment_method instanceof EE_Payment_Method) {
+			$pm_type_class = $this->payment_method_class_from_type($payment_method_type);
+			if (class_exists($pm_type_class)) {
+				/** @var $pm_type_obj EE_PMT_Base */
+				$pm_type_obj    = new $pm_type_class();
+				$payment_method = EEM_Payment_Method::instance()->get_one_by_slug($pm_type_obj->system_name());
+				if (! $payment_method) {
+					$payment_method = $this->create_payment_method_of_type($pm_type_obj);
+				}
+				$payment_method->set_type($payment_method_type);
+				$this->initialize_payment_method($payment_method);
+			} else {
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							'There is no payment method of type %1$s, so it could not be activated',
+							'event_espresso'
+						),
+						$pm_type_class
+					)
+				);
+			}
+		}
+		$payment_method->set_active();
+		$payment_method->save();
+		/** @type EE_Message_Resource_Manager $message_resource_manager */
+		// if this was the invoice message type, make sure users can view their invoices
+		if (
+			$payment_method->type() === 'Invoice'
+			&& (
+			! EEH_MSG_Template::is_mt_active('invoice')
+			)
+		) {
+			$message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+			/** @type EE_Message_Resource_Manager $message_resource_manager */
+			$message_resource_manager->ensure_message_type_is_active('invoice', 'html');
+			new PersistentAdminNotice(
+				'invoice_pm_requirements_notice',
+				sprintf(
+					esc_html__(
+						'The Invoice payment method has been activated. It requires the %1$sinvoice message%2$s type to be active, so it was automatically activated for you.',
+						'event_espresso'
+					),
+					'<a href="' . admin_url('admin.php?page=espresso_messages&action=settings') . '">',
+					'</a>'
+				),
+				true
+			);
+		}
+		return $payment_method;
+	}
+
+
+	/**
+	 * Creates a payment method of the specified type. Does not save it.
+	 *
+	 * @param EE_PMT_Base $pm_type_obj
+	 * @return EE_Payment_Method
+	 * @throws EE_Error*@throws ReflectionException
+	 * @throws ReflectionException
+	 * @global WP_User    $current_user
+	 */
+	public function create_payment_method_of_type(EE_PMT_Base $pm_type_obj): EE_Payment_Method
+	{
+		global $current_user;
+		return EE_Payment_Method::new_instance(
+			[
+				'PMD_type'       => $pm_type_obj->system_name(),
+				'PMD_name'       => $pm_type_obj->defaultFrontendName(),
+				'PMD_admin_name' => $pm_type_obj->pretty_name(),
+				'PMD_slug'       => $pm_type_obj->system_name(),// automatically converted to slug
+				'PMD_wp_user'    => $current_user->ID,
+				'PMD_order'      => EEM_Payment_Method::instance()->count(
+					[['PMD_type' => ['!=', 'Admin_Only']]]
+				) * 10,
+			]
+		);
+	}
+
+
+	/**
+	 * Sets the initial payment method properties (including extra meta)
+	 *
+	 * @param EE_Payment_Method $payment_method
+	 * @return EE_Payment_Method
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function initialize_payment_method(EE_Payment_Method $payment_method): EE_Payment_Method
+	{
+		$pm_type_obj = $payment_method->type_obj();
+		$payment_method->set_description($pm_type_obj->default_description());
+		if (! $payment_method->button_url()) {
+			$payment_method->set_button_url($pm_type_obj->default_button_url());
+		}
+		// now add setup its default extra meta properties
+		$extra_metas = $pm_type_obj->settings_form()->extra_meta_inputs();
+		if (! empty($extra_metas)) {
+			// verify the payment method has an ID before adding extra meta
+			if (! $payment_method->ID()) {
+				$payment_method->save();
+			}
+			foreach ($extra_metas as $meta_name => $input) {
+				$payment_method->update_extra_meta($meta_name, $input->raw_value());
+			}
+		}
+		return $payment_method;
+	}
+
+
+	/**
+	 * Makes sure the payment method is related to the specified payment method
+	 *
+	 * @param EE_Payment_Method $payment_method
+	 * @return EE_Payment_Method
+	 * @deprecated in 4.9.40 because the currency payment method table is being deprecated
+	 */
+	public function set_usable_currencies_on_payment_method(EE_Payment_Method $payment_method): EE_Payment_Method
+	{
+		EE_Error::doing_it_wrong(
+			'EE_Payment_Method_Manager::set_usable_currencies_on_payment_method',
+			esc_html__(
+				'We no longer define what currencies are usable by payment methods. Its not used nor efficient.',
+				'event_espresso'
+			),
+			'4.9.40'
+		);
+		return $payment_method;
+	}
+
+
+	/**
+	 * Deactivates a payment method of the given payment method slug.
+	 *
+	 * @param string $payment_method_slug The slug for the payment method to deactivate.
+	 * @return int count of rows updated.
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function deactivate_payment_method(string $payment_method_slug): int
+	{
+		EE_Log::instance()->log(
+			__FILE__,
+			__FUNCTION__,
+			sprintf(
+				esc_html__(
+					'Payment method with slug %1$s is being deactivated by site admin',
+					'event_espresso'
+				),
+				$payment_method_slug
+			),
+			'payment_method_change'
+		);
+		$count_updated = EEM_Payment_Method::instance()->update(
+			['PMD_scope' => []],
+			[['PMD_slug' => $payment_method_slug]]
+		);
+		do_action(
+			'AHEE__EE_Payment_Method_Manager__deactivate_payment_method__after_deactivating_payment_method',
+			$payment_method_slug,
+			$count_updated
+		);
+		return $count_updated;
+	}
+
+
+	/**
+	 * initializes payment method access caps via EE_Capabilities::init_role_caps()
+	 * upon EE_Payment_Method_Manager construction
+	 *
+	 * @throws EE_Error
+	 * @throws DomainException
+	 */
+	public function initializePaymentMethodCaps()
+	{
+		// don't do this twice
+		if ($this->payment_method_caps_initialized) {
+			return;
+		}
+		EE_Capabilities::instance()->addCaps(
+			$this->getPaymentMethodCaps()
+		);
+		$this->payment_method_caps_initialized = true;
+	}
+
+
+	/**
+	 * array  of dynamic payment method access caps.
+	 * at the time of writing, october 20 2014, these are the caps added:
+	 *  ee_payment_method_admin_only
+	 *  ee_payment_method_aim
+	 *  ee_payment_method_bank
+	 *  ee_payment_method_check
+	 *  ee_payment_method_invoice
+	 *  ee_payment_method_mijireh
+	 *  ee_payment_method_paypal_pro
+	 *  ee_payment_method_paypal_standard
+	 * Any other payment methods added to core or via addons will also get
+	 * their related capability automatically added too, so long as they are
+	 * registered properly using EE_Register_Payment_Method::register()
+	 *
+	 * @return array
+	 * @throws DomainException
+	 */
+	protected function getPaymentMethodCaps(): array
+	{
+		$caps = [];
+		foreach ($this->payment_method_type_names() as $payment_method_name) {
+			$caps = $this->addPaymentMethodCap($payment_method_name, $caps);
+		}
+		return $caps;
+	}
+
+
+	/**
+	 * @param string $payment_method_name
+	 * @param array  $payment_method_caps
+	 * @param string $role
+	 * @return array
+	 * @throws DomainException
+	 */
+	public function addPaymentMethodCap(
+		string $payment_method_name,
+		array $payment_method_caps,
+		string $role = 'administrator'
+	): array {
+		if (empty($payment_method_name)) {
+			throw new DomainException(
+				esc_html__(
+					'The name of a payment method must be specified to add capabilities.',
+					'event_espresso'
+				)
+			);
+		}
+		if (empty($role)) {
+			throw new DomainException(
+				sprintf(
+					esc_html__(
+						'No role was supplied while trying to add capabilities for the %1$s payment method.',
+						'event_espresso'
+					),
+					$payment_method_name
+				)
+			);
+		}
+		if (! isset($payment_method_caps[ $role ])) {
+			$payment_method_caps[ $role ] = [];
+		}
+		$payment_method_caps[ $role ][] = EE_Payment_Method_Manager::CAPABILITIES_PREFIX
+										  . strtolower($payment_method_name);
+		return $payment_method_caps;
+	}
+
+
+	/**
+	 * callback for FHEE__EE_Capabilities__init_role_caps__caps_map filter
+	 * to add dynamic payment method access caps when capabilities are reset
+	 * (or if that filter is called and PM caps are not already set)
+	 *
+	 * @param array $caps capabilities being filtered
+	 * @param bool  $reset
+	 * @return array
+	 * @throws DomainException
+	 */
+	public function addPaymentMethodCapsDuringReset(array $caps, bool $reset = false): array
+	{
+		if ($reset || ! $this->payment_method_caps_initialized) {
+			$this->payment_method_caps_initialized = true;
+			$caps                                  = array_merge_recursive($caps, $this->getPaymentMethodCaps());
+		}
+		return $caps;
+	}
+
+
+	/**
+	 * @param $caps
+	 * @return mixed
+	 * @deprecated 4.9.42
+	 */
+	public function add_payment_method_caps($caps)
+	{
+		return $caps;
+	}
 }

Spacing +26 added lines, -26 removed lines

@@ -74,7 +74,7 @@ 
     public static function instance(): EE_Payment_Method_Manager
     {
         // check if class object is instantiated, and instantiated properly
-        if (! self::$_instance instanceof EE_Payment_Method_Manager) {
+        if ( ! self::$_instance instanceof EE_Payment_Method_Manager) {
             EE_Registry::instance()->load_lib('PMT_Base');
             self::$_instance = new self();
         }
@@ -127,7 +127,7 @@ 
      */
     public function maybe_register_payment_methods(bool $force_recheck = false)
     {
-        if (! $this->_payment_method_types || $force_recheck) {
+        if ( ! $this->_payment_method_types || $force_recheck) {
             $this->_register_payment_methods();
         }
     }
@@ -141,7 +141,7 @@ 
     protected function _register_payment_methods(): array
     {
         // grab list of installed modules
-        $pm_to_register = glob(EE_PAYMENT_METHODS . '*', GLOB_ONLYDIR);
+        $pm_to_register = glob(EE_PAYMENT_METHODS.'*', GLOB_ONLYDIR);
         // filter list of modules to register
         $pm_to_register = apply_filters(
             'FHEE__EE_Payment_Method_Manager__register_payment_methods__payment_methods_to_register',
@@ -181,9 +181,9 @@ 
         // create class name from module directory name
         $module = str_replace(['_', ' '], [' ', '_'], $module_dir);
         // add class prefix
-        $module_class = 'EE_PMT_' . $module;
+        $module_class = 'EE_PMT_'.$module;
         // does the module exist ?
-        if (! is_readable($payment_method_path . '/' . $module_class . $module_ext)) {
+        if ( ! is_readable($payment_method_path.'/'.$module_class.$module_ext)) {
             $msg = sprintf(
                 esc_html__(
                     'The requested %s payment method file could not be found or is not readable due to file permissions.',
@@ -191,22 +191,22 @@ 
                 ),
                 $module
             );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+            EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
             return false;
         }
         // load the module class file
-        require_once($payment_method_path . '/' . $module_class . $module_ext);
+        require_once($payment_method_path.'/'.$module_class.$module_ext);
         // verify that class exists
-        if (! class_exists($module_class)) {
+        if ( ! class_exists($module_class)) {
             $msg = sprintf(
                 esc_html__('The requested %s module class does not exist.', 'event_espresso'),
                 $module_class
             );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+            EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
             return false;
         }
         // add to array of registered modules
-        $this->_payment_method_types[ $module ] = $payment_method_path . '/' . $module_class . $module_ext;
+        $this->_payment_method_types[$module] = $payment_method_path.'/'.$module_class.$module_ext;
         return true;
     }
 
@@ -223,12 +223,12 @@ 
         if (
             $force_recheck
             || empty($this->_payment_method_types)
-            || ! isset($this->_payment_method_types[ $payment_method_name ])
+            || ! isset($this->_payment_method_types[$payment_method_name])
         ) {
             $this->maybe_register_payment_methods($force_recheck);
         }
-        if (isset($this->_payment_method_types[ $payment_method_name ])) {
-            require_once($this->_payment_method_types[ $payment_method_name ]);
+        if (isset($this->_payment_method_types[$payment_method_name])) {
+            require_once($this->_payment_method_types[$payment_method_name]);
             return true;
         }
         return false;
@@ -270,8 +270,8 @@ 
         if ($force_recheck || empty($this->payment_method_objects)) {
             $this->maybe_register_payment_methods($force_recheck);
             foreach ($this->payment_method_type_names(true) as $classname) {
-                if (! isset($this->payment_method_objects[ $classname ])) {
-                    $this->payment_method_objects[ $classname ] = new $classname();
+                if ( ! isset($this->payment_method_objects[$classname])) {
+                    $this->payment_method_objects[$classname] = new $classname();
                 }
             }
         }
@@ -300,7 +300,7 @@ 
      */
     public function payment_method_class_from_type(string $type): string
     {
-        return 'EE_PMT_' . $type;
+        return 'EE_PMT_'.$type;
     }
 
 
@@ -317,13 +317,13 @@ 
     {
         $this->maybe_register_payment_methods();
         $payment_method = EEM_Payment_Method::instance()->get_one_of_type($payment_method_type);
-        if (! $payment_method instanceof EE_Payment_Method) {
+        if ( ! $payment_method instanceof EE_Payment_Method) {
             $pm_type_class = $this->payment_method_class_from_type($payment_method_type);
             if (class_exists($pm_type_class)) {
                 /** @var $pm_type_obj EE_PMT_Base */
                 $pm_type_obj    = new $pm_type_class();
                 $payment_method = EEM_Payment_Method::instance()->get_one_by_slug($pm_type_obj->system_name());
-                if (! $payment_method) {
+                if ( ! $payment_method) {
                     $payment_method = $this->create_payment_method_of_type($pm_type_obj);
                 }
                 $payment_method->set_type($payment_method_type);
@@ -360,7 +360,7 @@ 
                         'The Invoice payment method has been activated. It requires the %1$sinvoice message%2$s type to be active, so it was automatically activated for you.',
                         'event_espresso'
                     ),
-                    '<a href="' . admin_url('admin.php?page=espresso_messages&action=settings') . '">',
+                    '<a href="'.admin_url('admin.php?page=espresso_messages&action=settings').'">',
                     '</a>'
                 ),
                 true
@@ -387,7 +387,7 @@ 
                 'PMD_type'       => $pm_type_obj->system_name(),
                 'PMD_name'       => $pm_type_obj->defaultFrontendName(),
                 'PMD_admin_name' => $pm_type_obj->pretty_name(),
-                'PMD_slug'       => $pm_type_obj->system_name(),// automatically converted to slug
+                'PMD_slug'       => $pm_type_obj->system_name(), // automatically converted to slug
                 'PMD_wp_user'    => $current_user->ID,
                 'PMD_order'      => EEM_Payment_Method::instance()->count(
                     [['PMD_type' => ['!=', 'Admin_Only']]]
@@ -409,14 +409,14 @@ 
     {
         $pm_type_obj = $payment_method->type_obj();
         $payment_method->set_description($pm_type_obj->default_description());
-        if (! $payment_method->button_url()) {
+        if ( ! $payment_method->button_url()) {
             $payment_method->set_button_url($pm_type_obj->default_button_url());
         }
         // now add setup its default extra meta properties
         $extra_metas = $pm_type_obj->settings_form()->extra_meta_inputs();
-        if (! empty($extra_metas)) {
+        if ( ! empty($extra_metas)) {
             // verify the payment method has an ID before adding extra meta
-            if (! $payment_method->ID()) {
+            if ( ! $payment_method->ID()) {
                 $payment_method->save();
             }
             foreach ($extra_metas as $meta_name => $input) {
@@ -562,10 +562,10 @@ 
                 )
             );
         }
-        if (! isset($payment_method_caps[ $role ])) {
-            $payment_method_caps[ $role ] = [];
+        if ( ! isset($payment_method_caps[$role])) {
+            $payment_method_caps[$role] = [];
         }
-        $payment_method_caps[ $role ][] = EE_Payment_Method_Manager::CAPABILITIES_PREFIX
+        $payment_method_caps[$role][] = EE_Payment_Method_Manager::CAPABILITIES_PREFIX
                                           . strtolower($payment_method_name);
         return $payment_method_caps;
     }

core/domain/services/wp_queries/EventListQuery.php

Indentation +179 added lines, -179 removed lines

@@ -16,183 +16,183 @@
  */
 class EventListQuery extends WP_Query
 {
-    private ?string $title = '';
-
-    private int $limit = 10;
-
-    private ?string $css_class = '';
-
-    private bool $show_expired = false;
-
-    private ?string $month = '';
-
-    private ?string $category_slug = '';
-
-    /**
-     * @var array|string|null
-     */
-    private $order_by =[];
-
-    private ?string $sort = '';
-
-    private bool $show_title = true;
-
-
-    /**
-     * EE_Event_List_Query Constructor     *
-     *
-     * @param array $args
-     */
-    public function __construct($args = [])
-    {
-        $args = $this->parseArgs((array) $args);
-        $this->setupEventQueryHelper();
-        $this->setupFilters();
-        $args = $this->getQueryArgs($args);
-        // run the query
-        parent::__construct($args);
-    }
-
-
-    /**
-     * @param array $args
-     * @return array
-     */
-    private function parseArgs(array $args): array
-    {
-        // incoming args could be a mix of WP query args + EE shortcode args
-        foreach ($args as $property => $value) {
-            // if the arg is a property of this class, then it's an EE shortcode arg
-            if (property_exists($this, $property) && ! property_exists('WP_Query', $property)) {
-                // get the property type
-                $type = gettype($this->{$property});
-                // set the property value
-                switch ($type) {
-                    case 'integer':
-                        $this->{$property} = absint($value);
-                        break;
-                    case 'boolean':
-                        $this->{$property} = filter_var($value, FILTER_VALIDATE_BOOLEAN);
-                        break;
-                    case 'string':
-                        $this->{$property} = sanitize_text_field($value);
-                        break;
-                    default:
-                        $this->{$property} = $value;
-                        break;
-                }
-                // then remove it from the array of args that will later be passed to WP_Query()
-                unset($args[ $property ]);
-            }
-        }
-        return $args;
-    }
-
-
-    private function setupEventQueryHelper()
-    {
-        // add query filters
-        EEH_Event_Query::add_query_filters();
-        // set params that will get used by the filters
-        EEH_Event_Query::set_query_params(
-            $this->month,
-            $this->category_slug,
-            $this->show_expired,
-            $this->order_by,
-            $this->sort
-        );
-    }
-
-
-    private function setupFilters()
-    {
-        // first off, let's remove any filters from previous queries
-        remove_filter(
-            'FHEE__archive_espresso_events_template__show_header',
-            [$this, 'show_event_list_title']
-        );
-        remove_filter(
-            'FHEE__archive_espresso_events_template__upcoming_events_h1',
-            [$this, 'event_list_title']
-        );
-        remove_all_filters('FHEE__content_espresso_events__event_class');
-        // Event List Title ?
-        add_filter(
-            'FHEE__archive_espresso_events_template__show_header',
-            [$this, 'show_event_list_title']
-        );
-        add_filter(
-            'FHEE__archive_espresso_events_template__upcoming_events_h1',
-            [$this, 'event_list_title']
-        );
-        // add the css class
-        add_filter(
-            'FHEE__content_espresso_events__event_class',
-            [$this, 'event_list_css']
-        );
-    }
-
-
-    private function getQueryArgs(array $args): array
-    {
-        // the current "page" we are viewing
-        $paged = max(1, get_query_var('paged'));
-        // Force these args
-        return array_merge(
-            $args,
-            [
-                'post_type'              => EspressoPostType::EVENTS,
-                'posts_per_page'         => $this->limit,
-                'update_post_term_cache' => false,
-                'update_post_meta_cache' => false,
-                'paged'                  => $paged,
-                'offset'                 => ($paged - 1) * $this->limit,
-            ]
-        );
-    }
-
-    // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
-
-
-    /**
-     * show_event_list_title
-     *
-     * @return boolean
-     */
-    public function show_event_list_title(): bool
-    {
-        return filter_var($this->show_title, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * callback for FHEE__archive_espresso_events_template__upcoming_events_h1 filter
-     *
-     * @param string $event_list_title
-     * @return    string
-     */
-    public function event_list_title(string $event_list_title = ''): string
-    {
-        if (! empty($this->title)) {
-            return $this->title;
-        }
-        return $event_list_title;
-    }
-
-
-    /**
-     * callback for FHEE__content_espresso_events__event_class filter
-     *
-     * @param string $event_list_css
-     * @return string
-     */
-    public function event_list_css(string $event_list_css = ''): string
-    {
-        $event_list_css .= ! empty($event_list_css) ? ' ' : '';
-        $event_list_css .= ! empty($this->css_class) ? $this->css_class : '';
-        $event_list_css .= ! empty($event_list_css) ? ' ' : '';
-        $event_list_css .= ! empty($this->category_slug) ? $this->category_slug : '';
-        return $event_list_css;
-    }
-    // phpcs:enable
+	private ?string $title = '';
+
+	private int $limit = 10;
+
+	private ?string $css_class = '';
+
+	private bool $show_expired = false;
+
+	private ?string $month = '';
+
+	private ?string $category_slug = '';
+
+	/**
+	 * @var array|string|null
+	 */
+	private $order_by =[];
+
+	private ?string $sort = '';
+
+	private bool $show_title = true;
+
+
+	/**
+	 * EE_Event_List_Query Constructor     *
+	 *
+	 * @param array $args
+	 */
+	public function __construct($args = [])
+	{
+		$args = $this->parseArgs((array) $args);
+		$this->setupEventQueryHelper();
+		$this->setupFilters();
+		$args = $this->getQueryArgs($args);
+		// run the query
+		parent::__construct($args);
+	}
+
+
+	/**
+	 * @param array $args
+	 * @return array
+	 */
+	private function parseArgs(array $args): array
+	{
+		// incoming args could be a mix of WP query args + EE shortcode args
+		foreach ($args as $property => $value) {
+			// if the arg is a property of this class, then it's an EE shortcode arg
+			if (property_exists($this, $property) && ! property_exists('WP_Query', $property)) {
+				// get the property type
+				$type = gettype($this->{$property});
+				// set the property value
+				switch ($type) {
+					case 'integer':
+						$this->{$property} = absint($value);
+						break;
+					case 'boolean':
+						$this->{$property} = filter_var($value, FILTER_VALIDATE_BOOLEAN);
+						break;
+					case 'string':
+						$this->{$property} = sanitize_text_field($value);
+						break;
+					default:
+						$this->{$property} = $value;
+						break;
+				}
+				// then remove it from the array of args that will later be passed to WP_Query()
+				unset($args[ $property ]);
+			}
+		}
+		return $args;
+	}
+
+
+	private function setupEventQueryHelper()
+	{
+		// add query filters
+		EEH_Event_Query::add_query_filters();
+		// set params that will get used by the filters
+		EEH_Event_Query::set_query_params(
+			$this->month,
+			$this->category_slug,
+			$this->show_expired,
+			$this->order_by,
+			$this->sort
+		);
+	}
+
+
+	private function setupFilters()
+	{
+		// first off, let's remove any filters from previous queries
+		remove_filter(
+			'FHEE__archive_espresso_events_template__show_header',
+			[$this, 'show_event_list_title']
+		);
+		remove_filter(
+			'FHEE__archive_espresso_events_template__upcoming_events_h1',
+			[$this, 'event_list_title']
+		);
+		remove_all_filters('FHEE__content_espresso_events__event_class');
+		// Event List Title ?
+		add_filter(
+			'FHEE__archive_espresso_events_template__show_header',
+			[$this, 'show_event_list_title']
+		);
+		add_filter(
+			'FHEE__archive_espresso_events_template__upcoming_events_h1',
+			[$this, 'event_list_title']
+		);
+		// add the css class
+		add_filter(
+			'FHEE__content_espresso_events__event_class',
+			[$this, 'event_list_css']
+		);
+	}
+
+
+	private function getQueryArgs(array $args): array
+	{
+		// the current "page" we are viewing
+		$paged = max(1, get_query_var('paged'));
+		// Force these args
+		return array_merge(
+			$args,
+			[
+				'post_type'              => EspressoPostType::EVENTS,
+				'posts_per_page'         => $this->limit,
+				'update_post_term_cache' => false,
+				'update_post_meta_cache' => false,
+				'paged'                  => $paged,
+				'offset'                 => ($paged - 1) * $this->limit,
+			]
+		);
+	}
+
+	// phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
+
+
+	/**
+	 * show_event_list_title
+	 *
+	 * @return boolean
+	 */
+	public function show_event_list_title(): bool
+	{
+		return filter_var($this->show_title, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * callback for FHEE__archive_espresso_events_template__upcoming_events_h1 filter
+	 *
+	 * @param string $event_list_title
+	 * @return    string
+	 */
+	public function event_list_title(string $event_list_title = ''): string
+	{
+		if (! empty($this->title)) {
+			return $this->title;
+		}
+		return $event_list_title;
+	}
+
+
+	/**
+	 * callback for FHEE__content_espresso_events__event_class filter
+	 *
+	 * @param string $event_list_css
+	 * @return string
+	 */
+	public function event_list_css(string $event_list_css = ''): string
+	{
+		$event_list_css .= ! empty($event_list_css) ? ' ' : '';
+		$event_list_css .= ! empty($this->css_class) ? $this->css_class : '';
+		$event_list_css .= ! empty($event_list_css) ? ' ' : '';
+		$event_list_css .= ! empty($this->category_slug) ? $this->category_slug : '';
+		return $event_list_css;
+	}
+	// phpcs:enable
 }

Spacing +3 added lines, -3 removed lines

@@ -31,7 +31,7 @@ 
     /**
      * @var array|string|null
      */
-    private $order_by =[];
+    private $order_by = [];
 
     private ?string $sort = '';
 
@@ -82,7 +82,7 @@ 
                         break;
                 }
                 // then remove it from the array of args that will later be passed to WP_Query()
-                unset($args[ $property ]);
+                unset($args[$property]);
             }
         }
         return $args;
@@ -173,7 +173,7 @@ 
      */
     public function event_list_title(string $event_list_title = ''): string
     {
-        if (! empty($this->title)) {
+        if ( ! empty($this->title)) {
             return $this->title;
         }
         return $event_list_title;