eventespresso / event-espresso-core

admin_pages/events/Events_Admin_Page.core.php

Indentation +2956 added lines, -2956 removed lines

@@ -18,2963 +18,2963 @@
  */
 class Events_Admin_Page extends EE_Admin_Page_CPT
 {
-    /**
-     * This will hold the event object for event_details screen.
+	/**
+	 * This will hold the event object for event_details screen.
+	 *
+	 * @var EE_Event $_event
+	 */
+	protected $_event;
+
+
+	/**
+	 * This will hold the category object for category_details screen.
+	 *
+	 * @var stdClass $_category
+	 */
+	protected $_category;
+
+
+	/**
+	 * This will hold the event model instance
+	 *
+	 * @var EEM_Event $_event_model
+	 */
+	protected $_event_model;
+
+
+	/**
+	 * @var EE_Event
+	 */
+	protected $_cpt_model_obj = false;
+
+
+	/**
+	 * @var NodeGroupDao
+	 */
+	protected $model_obj_node_group_persister;
+
+	/**
+	 * @var AdvancedEditorAdminFormSection
+	 */
+	protected $advanced_editor_admin_form;
+
+
+	/**
+	 * Initialize page props for this admin page group.
+	 */
+	protected function _init_page_props()
+	{
+		$this->page_slug        = EVENTS_PG_SLUG;
+		$this->page_label       = EVENTS_LABEL;
+		$this->_admin_base_url  = EVENTS_ADMIN_URL;
+		$this->_admin_base_path = EVENTS_ADMIN;
+		$this->_cpt_model_names = [
+			'create_new' => 'EEM_Event',
+			'edit'       => 'EEM_Event',
+		];
+		$this->_cpt_edit_routes = [
+			'espresso_events' => 'edit',
+		];
+		add_action(
+			'AHEE__EE_Admin_Page_CPT__set_model_object__after_set_object',
+			[$this, 'verify_event_edit'],
+			10,
+			2
+		);
+	}
+
+
+	/**
+	 * Sets the ajax hooks used for this admin page group.
+	 */
+	protected function _ajax_hooks()
+	{
+		add_action('wp_ajax_ee_save_timezone_setting', [$this, 'saveTimezoneString']);
+	}
+
+
+	/**
+	 * Sets the page properties for this admin page group.
+	 */
+	protected function _define_page_props()
+	{
+		$event_id = $this->request->getRequestParam('post', 0, DataType::INT);
+		if ($event_id) {
+			$event_post = get_post($event_id);
+		}
+
+		$this->_admin_page_title = EVENTS_LABEL;
+		$this->_labels           = [
+			'buttons'      => [
+				'add'             => esc_html__('Add New Event', 'event_espresso'),
+				'edit'            => esc_html__('Edit Event', 'event_espresso'),
+				'delete'          => esc_html__('Delete Event', 'event_espresso'),
+				'add_category'    => esc_html__('Add New Category', 'event_espresso'),
+				'edit_category'   => esc_html__('Edit Category', 'event_espresso'),
+				'delete_category' => esc_html__('Delete Category', 'event_espresso'),
+			],
+			'editor_title' => [
+				'espresso_events' => isset($event_post) && $event_post instanceof WP_Post
+					? $event_post->post_title
+					: esc_html__('Edit Event', 'event_espresso'),
+			],
+			'publishbox'   => [
+				'create_new'        => esc_html__('Save New Event', 'event_espresso'),
+				'edit'              => esc_html__('Update Event', 'event_espresso'),
+				'add_category'      => esc_html__('Save New Category', 'event_espresso'),
+				'edit_category'     => esc_html__('Update Category', 'event_espresso'),
+				'template_settings' => esc_html__('Update Settings', 'event_espresso'),
+			],
+		];
+	}
+
+
+	/**
+	 * Sets the page routes property for this admin page group.
+	 */
+	protected function _set_page_routes()
+	{
+		// load formatter helper
+		// load field generator helper
+		// is there a evt_id in the request?
+		$EVT_ID = $this->request->getRequestParam('EVT_ID', 0, DataType::INT);
+		$EVT_ID = $this->request->getRequestParam('post', $EVT_ID, DataType::INT);
+
+		$this->_page_routes = [
+			'default'                       => [
+				'func'       => [$this, '_events_overview_list_table'],
+				'capability' => 'ee_read_events',
+			],
+			'create_new'                    => [
+				'func'       => [$this, '_create_new_cpt_item'],
+				'capability' => 'ee_edit_events',
+			],
+			'edit'                          => [
+				'func'       => [$this, '_edit_cpt_item'],
+				'capability' => 'ee_edit_event',
+				'obj_id'     => $EVT_ID,
+			],
+			'copy_event'                    => [
+				'func'       => [$this, '_copy_events'],
+				'capability' => 'ee_edit_event',
+				'obj_id'     => $EVT_ID,
+				'noheader'   => true,
+			],
+			'trash_event'                   => [
+				'func'       => [$this, '_trash_or_restore_event'],
+				'args'       => ['event_status' => 'trash'],
+				'capability' => 'ee_delete_event',
+				'obj_id'     => $EVT_ID,
+				'noheader'   => true,
+			],
+			'trash_events'                  => [
+				'func'       => [$this, '_trash_or_restore_events'],
+				'args'       => ['event_status' => 'trash'],
+				'capability' => 'ee_delete_events',
+				'noheader'   => true,
+			],
+			'restore_event'                 => [
+				'func'       => [$this, '_trash_or_restore_event'],
+				'args'       => ['event_status' => 'draft'],
+				'capability' => 'ee_delete_event',
+				'obj_id'     => $EVT_ID,
+				'noheader'   => true,
+			],
+			'restore_events'                => [
+				'func'       => [$this, '_trash_or_restore_events'],
+				'args'       => ['event_status' => 'draft'],
+				'capability' => 'ee_delete_events',
+				'noheader'   => true,
+			],
+			'delete_event'                  => [
+				'func'       => [$this, '_delete_event'],
+				'capability' => 'ee_delete_event',
+				'obj_id'     => $EVT_ID,
+				'noheader'   => true,
+			],
+			'delete_events'                 => [
+				'func'       => [$this, '_delete_events'],
+				'capability' => 'ee_delete_events',
+				'noheader'   => true,
+			],
+			'view_report'                   => [
+				'func'       => [$this, '_view_report'],
+				'capability' => 'ee_edit_events',
+			],
+			'default_event_settings'        => [
+				'func'       => [$this, '_default_event_settings'],
+				'capability' => 'manage_options',
+			],
+			'update_default_event_settings' => [
+				'func'       => [$this, '_update_default_event_settings'],
+				'capability' => 'manage_options',
+				'noheader'   => true,
+			],
+			'template_settings'             => [
+				'func'       => [$this, '_template_settings'],
+				'capability' => 'manage_options',
+			],
+			// event category tab related
+			'add_category'                  => [
+				'func'       => [$this, '_category_details'],
+				'capability' => 'ee_edit_event_category',
+				'args'       => ['view' => 'add'],
+			],
+			'edit_category'                 => [
+				'func'       => [$this, '_category_details'],
+				'capability' => 'ee_edit_event_category',
+				'args'       => ['view' => 'edit'],
+			],
+			'delete_categories'             => [
+				'func'       => [$this, '_delete_categories'],
+				'capability' => 'ee_delete_event_category',
+				'noheader'   => true,
+			],
+			'delete_category'               => [
+				'func'       => [$this, '_delete_categories'],
+				'capability' => 'ee_delete_event_category',
+				'noheader'   => true,
+			],
+			'insert_category'               => [
+				'func'       => [$this, '_insert_or_update_category'],
+				'args'       => ['new_category' => true],
+				'capability' => 'ee_edit_event_category',
+				'noheader'   => true,
+			],
+			'update_category'               => [
+				'func'       => [$this, '_insert_or_update_category'],
+				'args'       => ['new_category' => false],
+				'capability' => 'ee_edit_event_category',
+				'noheader'   => true,
+			],
+			'category_list'                 => [
+				'func'       => [$this, '_category_list_table'],
+				'capability' => 'ee_manage_event_categories',
+			],
+			'preview_deletion'              => [
+				'func'       => [$this, 'previewDeletion'],
+				'capability' => 'ee_delete_events',
+			],
+			'confirm_deletion'              => [
+				'func'       => [$this, 'confirmDeletion'],
+				'capability' => 'ee_delete_events',
+				'noheader'   => true,
+			],
+		];
+	}
+
+
+	/**
+	 * Set the _page_config property for this admin page group.
+	 */
+	protected function _set_page_config()
+	{
+		$post_id            = $this->request->getRequestParam('post', 0, DataType::INT);
+		$EVT_CAT_ID         = $this->request->getRequestParam('EVT_CAT_ID', 0, DataType::INT);
+		$this->_page_config = [
+			'default'                => [
+				'nav'           => [
+					'label' => esc_html__('Overview', 'event_espresso'),
+					'icon'  => 'dashicons-list-view',
+					'order' => 10,
+				],
+				'list_table'    => 'Events_Admin_List_Table',
+				'help_tabs'     => [
+					'events_overview_help_tab'                       => [
+						'title'    => esc_html__('Events Overview', 'event_espresso'),
+						'filename' => 'events_overview',
+					],
+					'events_overview_table_column_headings_help_tab' => [
+						'title'    => esc_html__('Events Overview Table Column Headings', 'event_espresso'),
+						'filename' => 'events_overview_table_column_headings',
+					],
+					'events_overview_filters_help_tab'               => [
+						'title'    => esc_html__('Events Overview Filters', 'event_espresso'),
+						'filename' => 'events_overview_filters',
+					],
+					'events_overview_view_help_tab'                  => [
+						'title'    => esc_html__('Events Overview Views', 'event_espresso'),
+						'filename' => 'events_overview_views',
+					],
+					'events_overview_other_help_tab'                 => [
+						'title'    => esc_html__('Events Overview Other', 'event_espresso'),
+						'filename' => 'events_overview_other',
+					],
+				],
+				'require_nonce' => false,
+			],
+			'create_new'             => [
+				'nav'           => [
+					'label'      => esc_html__('Add New Event', 'event_espresso'),
+					'icon'       => 'dashicons-plus-alt',
+					'order'      => 15,
+					'persistent' => false,
+				],
+				'metaboxes'     => ['_register_event_editor_meta_boxes'],
+				'help_tabs'     => [
+					'event_editor_help_tab'                            => [
+						'title'    => esc_html__('Event Editor', 'event_espresso'),
+						'filename' => 'event_editor',
+					],
+					'event_editor_title_richtexteditor_help_tab'       => [
+						'title'    => esc_html__('Event Title & Rich Text Editor', 'event_espresso'),
+						'filename' => 'event_editor_title_richtexteditor',
+					],
+					'event_editor_venue_details_help_tab'              => [
+						'title'    => esc_html__('Event Venue Details', 'event_espresso'),
+						'filename' => 'event_editor_venue_details',
+					],
+					'event_editor_event_datetimes_help_tab'            => [
+						'title'    => esc_html__('Event Datetimes', 'event_espresso'),
+						'filename' => 'event_editor_event_datetimes',
+					],
+					'event_editor_event_tickets_help_tab'              => [
+						'title'    => esc_html__('Event Tickets', 'event_espresso'),
+						'filename' => 'event_editor_event_tickets',
+					],
+					'event_editor_event_registration_options_help_tab' => [
+						'title'    => esc_html__('Event Registration Options', 'event_espresso'),
+						'filename' => 'event_editor_event_registration_options',
+					],
+					'event_editor_tags_categories_help_tab'            => [
+						'title'    => esc_html__('Event Tags & Categories', 'event_espresso'),
+						'filename' => 'event_editor_tags_categories',
+					],
+					'event_editor_questions_registrants_help_tab'      => [
+						'title'    => esc_html__('Questions for Registrants', 'event_espresso'),
+						'filename' => 'event_editor_questions_registrants',
+					],
+					'event_editor_save_new_event_help_tab'             => [
+						'title'    => esc_html__('Save New Event', 'event_espresso'),
+						'filename' => 'event_editor_save_new_event',
+					],
+					'event_editor_other_help_tab'                      => [
+						'title'    => esc_html__('Event Other', 'event_espresso'),
+						'filename' => 'event_editor_other',
+					],
+				],
+				'qtips'         => ['EE_Event_Editor_Decaf_Tips'],
+				'require_nonce' => false,
+			],
+			'edit'                   => [
+				'nav'           => [
+					'label'      => esc_html__('Edit Event', 'event_espresso'),
+					'icon'       => 'dashicons-edit',
+					'order'      => 15,
+					'persistent' => false,
+					'url'        => $post_id
+						? EE_Admin_Page::add_query_args_and_nonce(
+							['post' => $post_id, 'action' => 'edit'],
+							$this->_current_page_view_url
+						)
+						: $this->_admin_base_url,
+				],
+				'metaboxes'     => ['_register_event_editor_meta_boxes'],
+				'help_tabs'     => [
+					'event_editor_help_tab'                            => [
+						'title'    => esc_html__('Event Editor', 'event_espresso'),
+						'filename' => 'event_editor',
+					],
+					'event_editor_title_richtexteditor_help_tab'       => [
+						'title'    => esc_html__('Event Title & Rich Text Editor', 'event_espresso'),
+						'filename' => 'event_editor_title_richtexteditor',
+					],
+					'event_editor_venue_details_help_tab'              => [
+						'title'    => esc_html__('Event Venue Details', 'event_espresso'),
+						'filename' => 'event_editor_venue_details',
+					],
+					'event_editor_event_datetimes_help_tab'            => [
+						'title'    => esc_html__('Event Datetimes', 'event_espresso'),
+						'filename' => 'event_editor_event_datetimes',
+					],
+					'event_editor_event_tickets_help_tab'              => [
+						'title'    => esc_html__('Event Tickets', 'event_espresso'),
+						'filename' => 'event_editor_event_tickets',
+					],
+					'event_editor_event_registration_options_help_tab' => [
+						'title'    => esc_html__('Event Registration Options', 'event_espresso'),
+						'filename' => 'event_editor_event_registration_options',
+					],
+					'event_editor_tags_categories_help_tab'            => [
+						'title'    => esc_html__('Event Tags & Categories', 'event_espresso'),
+						'filename' => 'event_editor_tags_categories',
+					],
+					'event_editor_questions_registrants_help_tab'      => [
+						'title'    => esc_html__('Questions for Registrants', 'event_espresso'),
+						'filename' => 'event_editor_questions_registrants',
+					],
+					'event_editor_save_new_event_help_tab'             => [
+						'title'    => esc_html__('Save New Event', 'event_espresso'),
+						'filename' => 'event_editor_save_new_event',
+					],
+					'event_editor_other_help_tab'                      => [
+						'title'    => esc_html__('Event Other', 'event_espresso'),
+						'filename' => 'event_editor_other',
+					],
+				],
+				'require_nonce' => false,
+			],
+			'default_event_settings' => [
+				'nav'           => [
+					'label' => esc_html__('Default Settings', 'event_espresso'),
+					'icon'  => 'dashicons-admin-generic',
+					'order' => 40,
+				],
+				'metaboxes'     => array_merge(['_publish_post_box'], $this->_default_espresso_metaboxes),
+				'labels'        => [
+					'publishbox' => esc_html__('Update Settings', 'event_espresso'),
+				],
+				'help_tabs'     => [
+					'default_settings_help_tab'        => [
+						'title'    => esc_html__('Default Event Settings', 'event_espresso'),
+						'filename' => 'events_default_settings',
+					],
+					'default_settings_status_help_tab' => [
+						'title'    => esc_html__('Default Registration Status', 'event_espresso'),
+						'filename' => 'events_default_settings_status',
+					],
+					'default_maximum_tickets_help_tab' => [
+						'title'    => esc_html__('Default Maximum Tickets Per Order', 'event_espresso'),
+						'filename' => 'events_default_settings_max_tickets',
+					],
+				],
+				'require_nonce' => false,
+			],
+			// template settings
+			'template_settings'      => [
+				'nav'           => [
+					'label' => esc_html__('Templates', 'event_espresso'),
+					'icon'  => 'dashicons-layout',
+					'order' => 30,
+				],
+				'metaboxes'     => $this->_default_espresso_metaboxes,
+				'help_tabs'     => [
+					'general_settings_templates_help_tab' => [
+						'title'    => esc_html__('Templates', 'event_espresso'),
+						'filename' => 'general_settings_templates',
+					],
+				],
+				'require_nonce' => false,
+			],
+			// event category stuff
+			'add_category'           => [
+				'nav'           => [
+					'label'      => esc_html__('Add Category', 'event_espresso'),
+					'icon'       => 'dashicons-plus-alt',
+					'order'      => 25,
+					'persistent' => false,
+				],
+				'help_tabs'     => [
+					'add_category_help_tab' => [
+						'title'    => esc_html__('Add New Event Category', 'event_espresso'),
+						'filename' => 'events_add_category',
+					],
+				],
+				'metaboxes'     => ['_publish_post_box'],
+				'require_nonce' => false,
+			],
+			'edit_category'          => [
+				'nav'           => [
+					'label'      => esc_html__('Edit Category', 'event_espresso'),
+					'icon'       => 'dashicons-edit',
+					'order'      => 25,
+					'persistent' => false,
+					'url'        => $EVT_CAT_ID
+						? add_query_arg(
+							['EVT_CAT_ID' => $EVT_CAT_ID],
+							$this->_current_page_view_url
+						)
+						: $this->_admin_base_url,
+				],
+				'help_tabs'     => [
+					'edit_category_help_tab' => [
+						'title'    => esc_html__('Edit Event Category', 'event_espresso'),
+						'filename' => 'events_edit_category',
+					],
+				],
+				'metaboxes'     => ['_publish_post_box'],
+				'require_nonce' => false,
+			],
+			'category_list'          => [
+				'nav'           => [
+					'label' => esc_html__('Categories', 'event_espresso'),
+					'icon'  => 'dashicons-networking',
+					'order' => 20,
+				],
+				'list_table'    => 'Event_Categories_Admin_List_Table',
+				'help_tabs'     => [
+					'events_categories_help_tab'                       => [
+						'title'    => esc_html__('Event Categories', 'event_espresso'),
+						'filename' => 'events_categories',
+					],
+					'events_categories_table_column_headings_help_tab' => [
+						'title'    => esc_html__('Event Categories Table Column Headings', 'event_espresso'),
+						'filename' => 'events_categories_table_column_headings',
+					],
+					'events_categories_view_help_tab'                  => [
+						'title'    => esc_html__('Event Categories Views', 'event_espresso'),
+						'filename' => 'events_categories_views',
+					],
+					'events_categories_other_help_tab'                 => [
+						'title'    => esc_html__('Event Categories Other', 'event_espresso'),
+						'filename' => 'events_categories_other',
+					],
+				],
+				'metaboxes'     => $this->_default_espresso_metaboxes,
+				'require_nonce' => false,
+			],
+			'preview_deletion'       => [
+				'nav'           => [
+					'label'      => esc_html__('Preview Deletion', 'event_espresso'),
+					'icon'       => 'dashicons-remove',
+					'order'      => 15,
+					'persistent' => false,
+					'url'        => '',
+				],
+				'require_nonce' => false,
+			],
+		];
+	}
+
+
+	/**
+	 * Used to register any global screen options if necessary for every route in this admin page group.
+	 */
+	protected function _add_screen_options()
+	{
+	}
+
+
+	/**
+	 * Implementing the screen options for the 'default' route.
+	 *
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _add_screen_options_default()
+	{
+		$this->_per_page_screen_option();
+	}
+
+
+	/**
+	 * Implementing screen options for the category list route.
+	 *
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _add_screen_options_category_list()
+	{
+		$page_title              = $this->_admin_page_title;
+		$this->_admin_page_title = esc_html__('Categories', 'event_espresso');
+		$this->_per_page_screen_option();
+		$this->_admin_page_title = $page_title;
+	}
+
+
+	/**
+	 * Used to register any global feature pointers for the admin page group.
+	 */
+	protected function _add_feature_pointers()
+	{
+	}
+
+
+	/**
+	 * Registers and enqueues any global scripts and styles for the entire admin page group.
+	 */
+	public function load_scripts_styles()
+	{
+		wp_register_style(
+			'events-admin-css',
+			EVENTS_ASSETS_URL . 'events-admin-page.css',
+			[],
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_register_style(
+			'ee-cat-admin',
+			EVENTS_ASSETS_URL . 'ee-cat-admin.css',
+			[],
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_style('events-admin-css');
+		wp_enqueue_style('ee-cat-admin');
+		// scripts
+		wp_register_script(
+			'event_editor_js',
+			EVENTS_ASSETS_URL . 'event_editor.js',
+			['ee_admin_js', 'jquery-ui-slider', 'jquery-ui-timepicker-addon'],
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+	}
+
+
+	/**
+	 * Enqueuing scripts and styles specific to this view
+	 */
+	public function load_scripts_styles_create_new()
+	{
+		$this->load_scripts_styles_edit();
+	}
+
+
+	/**
+	 * Enqueuing scripts and styles specific to this view
+	 */
+	public function load_scripts_styles_edit()
+	{
+		// styles
+		wp_enqueue_style('espresso-ui-theme');
+		wp_register_style(
+			'event-editor-css',
+			EVENTS_ASSETS_URL . 'event-editor.css',
+			['ee-admin-css'],
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_style('event-editor-css');
+		// scripts
+		if (! $this->admin_config->useAdvancedEditor()) {
+			wp_register_script(
+				'event-datetime-metabox',
+				EVENTS_ASSETS_URL . 'event-datetime-metabox.js',
+				['event_editor_js', 'ee-datepicker'],
+				EVENT_ESPRESSO_VERSION
+			);
+			wp_enqueue_script('event-datetime-metabox');
+		}
+	}
+
+
+	/**
+	 * Populating the _views property for the category list table view.
+	 */
+	protected function _set_list_table_views_category_list()
+	{
+		$this->_views = [
+			'all' => [
+				'slug'        => 'all',
+				'label'       => esc_html__('All', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => [
+					'delete_categories' => esc_html__('Delete Permanently', 'event_espresso'),
+				],
+			],
+		];
+	}
+
+
+	/**
+	 * For adding anything that fires on the admin_init hook for any route within this admin page group.
+	 */
+	public function admin_init()
+	{
+		EE_Registry::$i18n_js_strings['image_confirm'] = esc_html__(
+			'Do you really want to delete this image? Please remember to update your event to complete the removal.',
+			'event_espresso'
+		);
+	}
+
+
+	/**
+	 * For adding anything that should be triggered on the admin_notices hook for any route within this admin page
+	 * group.
+	 */
+	public function admin_notices()
+	{
+	}
+
+
+	/**
+	 * For adding anything that should be triggered on the `admin_print_footer_scripts` hook for any route within
+	 * this admin page group.
+	 */
+	public function admin_footer_scripts()
+	{
+	}
+
+
+	/**
+	 * Call this function to verify if an event is public and has tickets for sale.  If it does, then we need to show a
+	 * warning (via EE_Error::add_error());
+	 *
+	 * @param EE_Event|null $event Event object
+	 * @param string        $req_type
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function verify_event_edit(?EE_Base_Class $event = null, string $req_type = '')
+	{
+		// don't need to do this when processing
+		if (! empty($req_type)) {
+			return;
+		}
+		// no event?
+		if (! $event instanceof EE_Event) {
+			$event = $this->_cpt_model_obj;
+		}
+		// STILL no event?
+		if (! $event instanceof EE_Event) {
+			return;
+		}
+		// don't need to keep calling this
+		remove_action(
+			'AHEE__EE_Admin_Page_CPT__set_model_object__after_set_object',
+			[$this, 'verify_event_edit']
+		);
+		$orig_status = $event->status();
+		// first check if event is active.
+		if (
+			$orig_status === EEM_Event::cancelled
+			|| $orig_status === EEM_Event::postponed
+			|| $event->is_expired()
+			|| $event->is_inactive()
+		) {
+			return;
+		}
+		// made it here so it IS active... next check that any of the tickets are sold.
+		if ($event->is_sold_out(true)) {
+			if ($orig_status !== EEM_Event::sold_out && $event->status() !== $orig_status) {
+				EE_Error::add_attention(
+					sprintf(
+						esc_html__(
+							'Please note that the Event Status has automatically been changed to %s because there are no more spaces available for this event.  However, this change is not permanent until you update the event.  You can change the status back to something else before updating if you wish.',
+							'event_espresso'
+						),
+						EEH_Template::pretty_status(EEM_Event::sold_out, false, 'sentence')
+					)
+				);
+			}
+			return;
+		}
+		if ($orig_status === EEM_Event::sold_out) {
+			EE_Error::add_attention(
+				sprintf(
+					esc_html__(
+						'Please note that the Event Status has automatically been changed to %s because more spaces have become available for this event, most likely due to abandoned transactions freeing up reserved tickets.  However, this change is not permanent until you update the event. If you wish, you can change the status back to something else before updating.',
+						'event_espresso'
+					),
+					EEH_Template::pretty_status($event->status(), false, 'sentence')
+				)
+			);
+		}
+		// now we need to determine if the event has any tickets on sale.  If not then we dont' show the error
+		if (! $event->tickets_on_sale()) {
+			return;
+		}
+		// made it here so show warning
+		$this->_edit_event_warning();
+	}
+
+
+	/**
+	 * This is the text used for when an event is being edited that is public and has tickets for sale.
+	 * When needed, hook this into a EE_Error::add_error() notice.
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _edit_event_warning()
+	{
+		// we don't want to add warnings during these requests
+		if ($this->request->getRequestParam('action') === 'editpost') {
+			return;
+		}
+		EE_Error::add_attention(
+			sprintf(
+				esc_html__(
+					'Your event is open for registration. Making changes may disrupt any transactions in progress. %sLearn more%s',
+					'event_espresso'
+				),
+				'<a class="espresso-help-tab-lnk ee-help-tab-link">',
+				'</a>'
+			)
+		);
+	}
+
+
+	/**
+	 * When a user is creating a new event, notify them if they haven't set their timezone.
+	 * Otherwise, do the normal logic
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _create_new_cpt_item()
+	{
+		$has_timezone_string = get_option('timezone_string');
+		// only nag them about setting their timezone if it's their first event, and they haven't already done it
+		if (! $has_timezone_string && ! EEM_Event::instance()->exists([])) {
+			EE_Error::add_attention(
+				sprintf(
+					esc_html__(
+						'Your website\'s timezone is currently set to a UTC offset. We recommend updating your timezone to a city or region near you before you create an event. Change your timezone now:%1$s%2$s%3$sChange Timezone%4$s',
+						'event_espresso'
+					),
+					'<br>',
+					'<select id="timezone_string" name="timezone_string" aria-describedby="timezone-description">'
+					. EEH_DTT_Helper::wp_timezone_choice('', EEH_DTT_Helper::get_user_locale())
+					. '</select>',
+					'<button class="button button--secondary timezone-submit">',
+					'</button><span class="spinner"></span>'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		parent::_create_new_cpt_item();
+	}
+
+
+	/**
+	 * Sets the _views property for the default route in this admin page group.
+	 */
+	protected function _set_list_table_views_default()
+	{
+		$this->_views = [
+			'all'   => [
+				'slug'        => 'all',
+				'label'       => esc_html__('View All Events', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => [
+					'trash_events' => esc_html__('Move to Trash', 'event_espresso'),
+				],
+			],
+			'draft' => [
+				'slug'        => 'draft',
+				'label'       => esc_html__('Draft', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => [
+					'trash_events' => esc_html__('Move to Trash', 'event_espresso'),
+				],
+			],
+		];
+		if (EE_Registry::instance()->CAP->current_user_can('ee_delete_events', 'espresso_events_trash_events')) {
+			$this->_views['trash'] = [
+				'slug'        => 'trash',
+				'label'       => esc_html__('Trash', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => [
+					'restore_events' => esc_html__('Restore From Trash', 'event_espresso'),
+					'delete_events'  => esc_html__('Delete Permanently', 'event_espresso'),
+				],
+			];
+		}
+	}
+
+
+	/**
+	 * Provides the legend item array for the default list table view.
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	protected function _event_legend_items(): array
+	{
+		$items    = [
+			'view_details'   => [
+				'class' => 'dashicons dashicons-visibility',
+				'desc'  => esc_html__('View Event', 'event_espresso'),
+			],
+			'edit_event'     => [
+				'class' => 'dashicons dashicons-calendar-alt',
+				'desc'  => esc_html__('Edit Event Details', 'event_espresso'),
+			],
+			'view_attendees' => [
+				'class' => 'dashicons dashicons-groups',
+				'desc'  => esc_html__('View Registrations for Event', 'event_espresso'),
+			],
+		];
+		$items    = apply_filters('FHEE__Events_Admin_Page___event_legend_items__items', $items);
+		$statuses = [
+			'sold_out_status'  => [
+				'class' => 'ee-status-legend ee-status-bg--' . EE_Datetime::sold_out,
+				'desc'  => EEH_Template::pretty_status(EE_Datetime::sold_out, false, 'sentence'),
+			],
+			'active_status'    => [
+				'class' => 'ee-status-legend ee-status-bg--' . EE_Datetime::active,
+				'desc'  => EEH_Template::pretty_status(EE_Datetime::active, false, 'sentence'),
+			],
+			'upcoming_status'  => [
+				'class' => 'ee-status-legend ee-status-bg--' . EE_Datetime::upcoming,
+				'desc'  => EEH_Template::pretty_status(EE_Datetime::upcoming, false, 'sentence'),
+			],
+			'postponed_status' => [
+				'class' => 'ee-status-legend ee-status-bg--' . EE_Datetime::postponed,
+				'desc'  => EEH_Template::pretty_status(EE_Datetime::postponed, false, 'sentence'),
+			],
+			'cancelled_status' => [
+				'class' => 'ee-status-legend ee-status-bg--' . EE_Datetime::cancelled,
+				'desc'  => EEH_Template::pretty_status(EE_Datetime::cancelled, false, 'sentence'),
+			],
+			'expired_status'   => [
+				'class' => 'ee-status-legend ee-status-bg--' . EE_Datetime::expired,
+				'desc'  => EEH_Template::pretty_status(EE_Datetime::expired, false, 'sentence'),
+			],
+			'inactive_status'  => [
+				'class' => 'ee-status-legend ee-status-bg--' . EE_Datetime::inactive,
+				'desc'  => EEH_Template::pretty_status(EE_Datetime::inactive, false, 'sentence'),
+			],
+		];
+		$statuses = apply_filters('FHEE__Events_Admin_Page__event_legend_items__statuses', $statuses);
+		return array_merge($items, $statuses);
+	}
+
+
+	/**
+	 * @return EEM_Event
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function _event_model(): EEM_Event
+	{
+		if (! $this->_event_model instanceof EEM_Event) {
+			$this->_event_model = EE_Registry::instance()->load_model('Event');
+		}
+		return $this->_event_model;
+	}
+
+
+	/**
+	 * Adds extra buttons to the WP CPT permalink field row.
+	 * Method is called from parent and is hooked into the wp 'get_sample_permalink_html' filter.
+	 *
+	 * @param string      $return    the current html
+	 * @param int         $id        the post id for the page
+	 * @param string|null $new_title What the title is
+	 * @param string|null $new_slug  what the slug is
+	 * @return string            The new html string for the permalink area
+	 * @deprecated $VID:$
+	 * @see TicketSelectorShortcodeButton::addButton
+	 */
+	public function extra_permalink_field_buttons(
+		string $return,
+		int $id,
+		?string $new_title,
+		?string $new_slug
+	): string {
+		return TicketSelectorShortcodeButton::addButton($return, $id, $new_title, $new_slug);
+	}
+
+
+	/**
+	 * _events_overview_list_table
+	 * This contains the logic for showing the events_overview list
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _events_overview_list_table()
+	{
+		$after_list_table = [];
+		$links_html       = EEH_HTML::div('', '', 'ee-admin-section ee-layout-stack');
+		$links_html       .= EEH_HTML::h3(esc_html__('Links', 'event_espresso'));
+		$links_html       .= EEH_HTML::div(
+			EEH_Template::get_button_or_link(
+				get_post_type_archive_link('espresso_events'),
+				esc_html__('View Event Archive Page', 'event_espresso'),
+				'button button--small button--secondary'
+			),
+			'',
+			'ee-admin-button-row ee-admin-button-row--align-start'
+		);
+		$links_html       .= EEH_HTML::divx();
+
+		$after_list_table['view_event_list_button'] = $links_html;
+
+		$after_list_table['legend'] = $this->_display_legend($this->_event_legend_items());
+		$this->_admin_page_title    .= ' ' . $this->get_action_link_or_button(
+			'create_new',
+			'add',
+			[],
+			'add-new-h2'
+		);
+
+		$this->_template_args['after_list_table'] = array_merge(
+			(array) $this->_template_args['after_list_table'],
+			$after_list_table
+		);
+		$this->display_admin_list_table_page_with_no_sidebar();
+	}
+
+
+	/**
+	 * this allows for extra misc actions in the default WP publish box
+	 *
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function extra_misc_actions_publish_box()
+	{
+		$this->_generate_publish_box_extra_content();
+	}
+
+
+	/**
+	 * This is hooked into the WordPress do_action('save_post') hook and runs after the custom post type has been
+	 * saved.
+	 * Typically you would use this to save any additional data.
+	 * Keep in mind also that "save_post" runs on EVERY post update to the database.
+	 * ALSO very important.  When a post transitions from scheduled to published,
+	 * the save_post action is fired but you will NOT have any _POST data containing any extra info you may have from
+	 * other meta saves. So MAKE sure that you handle this accordingly.
+	 *
+	 * @access protected
+	 * @abstract
+	 * @param string  $post_id The ID of the cpt that was saved (so you can link relationally)
+	 * @param WP_Post $post    The post object of the cpt that was saved.
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _insert_update_cpt_item($post_id, $post)
+	{
+		if ($post instanceof WP_Post && $post->post_type !== 'espresso_events') {
+			// get out we're not processing an event save.
+			return;
+		}
+		$event_values = [
+			'EVT_member_only'     => $this->request->getRequestParam('member_only', false, DataType::BOOL),
+			'EVT_allow_overflow'  => $this->request->getRequestParam('EVT_allow_overflow', false, DataType::BOOL),
+			'EVT_timezone_string' => $this->request->getRequestParam('timezone_string'),
+		];
+		// check if the new EDTR reg options meta box is being used, and if so, don't run updates for legacy version
+		if (! $this->admin_config->useAdvancedEditor() || ! $this->feature->allowed('use_reg_options_meta_box')) {
+			$event_values['EVT_display_ticket_selector']     = $this->request->getRequestParam(
+				'display_ticket_selector',
+				false,
+				'bool'
+			);
+			$event_values['EVT_additional_limit']            = min(
+				apply_filters('FHEE__EE_Events_Admin__insert_update_cpt_item__EVT_additional_limit_max', 255),
+				$this->request->getRequestParam(
+					'additional_limit',
+					EEM_Event::get_default_additional_limit(),
+					'int'
+				)
+			);
+			$event_values['EVT_default_registration_status'] = $this->request->getRequestParam(
+				'EVT_default_registration_status',
+				EE_Registry::instance()->CFG->registration->default_STS_ID
+			);
+
+			$event_values['EVT_external_URL'] = $this->request->getRequestParam('externalURL');
+			$event_values['EVT_phone']        = $this->request->getRequestParam('event_phone');
+			$event_values['EVT_display_desc'] = $this->request->getRequestParam('display_desc', false, DataType::BOOL);
+		} elseif ($post instanceof WP_Post) {
+			$event_values['EVT_name'] = $post->post_title;
+			$event_values['EVT_desc'] = $post->post_content;
+		}
+		// update event
+		$success = $this->_event_model()->update_by_ID($event_values, $post_id);
+		// get event_object for other metaboxes...
+		// though it would seem to make sense to just use $this->_event_model()->get_one_by_ID( $post_id )..
+		// i have to setup where conditions to override the filters in the model
+		// that filter out auto-draft and inherit statuses so we GET the inherit id!
+		/** @var EE_Event $event */
+		$event = $this->_event_model()->get_one(
+			[
+				[
+					$this->_event_model()->primary_key_name() => $post_id,
+					'OR'                                      => [
+						'status'   => $post->post_status,
+						// if trying to "Publish" a sold out event, it's status will get switched back to "sold_out" in the db,
+						// but the returned object here has a status of "publish", so use the original post status as well
+						'status*1' => $this->request->getRequestParam('original_post_status'),
+					],
+				],
+			]
+		);
+
+		// the following are default callbacks for event attachment updates
+		// that can be overridden by caffeinated functionality and/or addons.
+		$event_update_callbacks = [];
+		if (! $this->admin_config->useAdvancedEditor()) {
+			$event_update_callbacks['_default_venue_update']   = [$this, '_default_venue_update'];
+			$event_update_callbacks['_default_tickets_update'] = [$this, '_default_tickets_update'];
+		}
+		$event_update_callbacks = apply_filters(
+			'FHEE__Events_Admin_Page___insert_update_cpt_item__event_update_callbacks',
+			$event_update_callbacks
+		);
+
+		$att_success = true;
+		foreach ($event_update_callbacks as $e_callback) {
+			$_success = is_callable($e_callback)
+				? $e_callback($event, $this->request->requestParams())
+				: false;
+			// if ANY of these updates fail then we want the appropriate global error message
+			$att_success = $_success !== false ? $att_success : false;
+		}
+		// any errors?
+		if ($success && $att_success === false) {
+			EE_Error::add_error(
+				esc_html__(
+					'Event Details saved successfully but something went wrong with saving attachments.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		} elseif ($success === false) {
+			EE_Error::add_error(
+				esc_html__('Event Details did not save successfully.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+	}
+
+
+	/**
+	 * @param int $post_id
+	 * @param int $revision_id
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @see parent::restore_item()
+	 */
+	protected function _restore_cpt_item(int $post_id, int $revision_id)
+	{
+		// copy existing event meta to new post
+		$post_evt = $this->_event_model()->get_one_by_ID($post_id);
+		if ($post_evt instanceof EE_Event) {
+			// meta revision restore
+			$post_evt->restore_revision($revision_id);
+			// related objs restore
+			$post_evt->restore_revision($revision_id, ['Venue', 'Datetime', 'Price']);
+		}
+	}
+
+
+	/**
+	 * Attach the venue to the Event
+	 *
+	 * @param EE_Event $event Event Object to add the venue to
+	 * @param array    $data  The request data from the form
+	 * @return bool           Success or fail.
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _default_venue_update(EE_Event $event, array $data): bool
+	{
+		require_once(EE_MODELS . 'EEM_Venue.model.php');
+		$venue_model = EE_Registry::instance()->load_model('Venue');
+		$venue_id    = ! empty($data['venue_id']) ? $data['venue_id'] : null;
+		// very important.  If we don't have a venue name...
+		// then we'll get out because not necessary to create empty venue
+		if (empty($data['venue_title'])) {
+			return false;
+		}
+		$venue_array = [
+			'VNU_wp_user'         => $event->get('EVT_wp_user'),
+			'VNU_name'            => $data['venue_title'],
+			'VNU_desc'            => ! empty($data['venue_description']) ? $data['venue_description'] : null,
+			'VNU_identifier'      => ! empty($data['venue_identifier']) ? $data['venue_identifier'] : null,
+			'VNU_short_desc'      => ! empty($data['venue_short_description'])
+				? $data['venue_short_description']
+				: null,
+			'VNU_address'         => ! empty($data['address']) ? $data['address'] : null,
+			'VNU_address2'        => ! empty($data['address2']) ? $data['address2'] : null,
+			'VNU_city'            => ! empty($data['city']) ? $data['city'] : null,
+			'STA_ID'              => ! empty($data['state']) ? $data['state'] : null,
+			'CNT_ISO'             => ! empty($data['countries']) ? $data['countries'] : null,
+			'VNU_zip'             => ! empty($data['zip']) ? $data['zip'] : null,
+			'VNU_phone'           => ! empty($data['venue_phone']) ? $data['venue_phone'] : null,
+			'VNU_capacity'        => ! empty($data['venue_capacity']) ? $data['venue_capacity'] : null,
+			'VNU_url'             => ! empty($data['venue_url']) ? $data['venue_url'] : null,
+			'VNU_virtual_phone'   => ! empty($data['virtual_phone']) ? $data['virtual_phone'] : null,
+			'VNU_virtual_url'     => ! empty($data['virtual_url']) ? $data['virtual_url'] : null,
+			'VNU_enable_for_gmap' => isset($data['enable_for_gmap']) ? 1 : 0,
+			'status'              => 'publish',
+		];
+		// if we've got the venue_id then we're just updating the existing venue so let's do that and then get out.
+		if (! empty($venue_id)) {
+			$update_where  = [$venue_model->primary_key_name() => $venue_id];
+			$rows_affected = $venue_model->update($venue_array, [$update_where]);
+			// we've gotta make sure that the venue is always attached to a revision..
+			// add_relation_to should take care of making sure that the relation is already present.
+			$event->_add_relation_to($venue_id, 'Venue');
+			return $rows_affected > 0;
+		}
+		// we insert the venue
+		$venue_id = $venue_model->insert($venue_array);
+		$event->_add_relation_to($venue_id, 'Venue');
+		return ! empty($venue_id);
+		// when we have the ancestor come in it's already been handled by the revision save.
+	}
+
+
+	/**
+	 * Handles saving everything related to Tickets (datetimes, tickets, prices)
+	 *
+	 * @param EE_Event $event The Event object we're attaching data to
+	 * @param array    $data  The request data from the form
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws Exception
+	 */
+	protected function _default_tickets_update(EE_Event $event, array $data): array
+	{
+		if ($this->admin_config->useAdvancedEditor()) {
+			return [];
+		}
+		$datetime       = null;
+		$saved_tickets  = [];
+		$event_timezone = $event->get_timezone();
+		$date_formats   = ['Y-m-d', 'h:i a'];
+		foreach ($data['edit_event_datetimes'] as $row => $datetime_data) {
+			// trim all values to ensure any excess whitespace is removed.
+			$datetime_data                = array_map('trim', $datetime_data);
+			$datetime_data['DTT_EVT_end'] =
+				isset($datetime_data['DTT_EVT_end']) && ! empty($datetime_data['DTT_EVT_end'])
+					? $datetime_data['DTT_EVT_end']
+					: $datetime_data['DTT_EVT_start'];
+			$datetime_values              = [
+				'DTT_ID'        => ! empty($datetime_data['DTT_ID']) ? $datetime_data['DTT_ID'] : null,
+				'DTT_EVT_start' => $datetime_data['DTT_EVT_start'],
+				'DTT_EVT_end'   => $datetime_data['DTT_EVT_end'],
+				'DTT_reg_limit' => empty($datetime_data['DTT_reg_limit']) ? EE_INF : $datetime_data['DTT_reg_limit'],
+				'DTT_order'     => $row,
+			];
+			// if we have an id then let's get existing object first and then set the new values.
+			//  Otherwise we instantiate a new object for save.
+			if (! empty($datetime_data['DTT_ID'])) {
+				$datetime = EEM_Datetime::instance($event_timezone)->get_one_by_ID($datetime_data['DTT_ID']);
+				if (! $datetime instanceof EE_Datetime) {
+					throw new RuntimeException(
+						sprintf(
+							esc_html__(
+								'Something went wrong! A valid Datetime could not be retrieved from the database using the supplied ID: %1$d',
+								'event_espresso'
+							),
+							$datetime_data['DTT_ID']
+						)
+					);
+				}
+				$datetime->set_date_format($date_formats[0]);
+				$datetime->set_time_format($date_formats[1]);
+				foreach ($datetime_values as $field => $value) {
+					$datetime->set($field, $value);
+				}
+			} else {
+				$datetime = EE_Datetime::new_instance($datetime_values, $event_timezone, $date_formats);
+			}
+			if (! $datetime instanceof EE_Datetime) {
+				throw new RuntimeException(
+					sprintf(
+						esc_html__(
+							'Something went wrong! A valid Datetime could not be generated or retrieved using the supplied data: %1$s',
+							'event_espresso'
+						),
+						print_r($datetime_values, true)
+					)
+				);
+			}
+			// before going any further make sure our dates are setup correctly
+			// so that the end date is always equal or greater than the start date.
+			if ($datetime->get_raw('DTT_EVT_start') > $datetime->get_raw('DTT_EVT_end')) {
+				$datetime->set('DTT_EVT_end', $datetime->get('DTT_EVT_start'));
+				$datetime = EEH_DTT_Helper::date_time_add($datetime, 'DTT_EVT_end', 'days');
+			}
+			$datetime->save();
+			$event->_add_relation_to($datetime, 'Datetime');
+		}
+		// no datetimes get deleted so we don't do any of that logic here.
+		// update tickets next
+		$old_tickets = isset($data['ticket_IDs']) ? explode(',', $data['ticket_IDs']) : [];
+
+		// set up some default start and end dates in case those are not present in the incoming data
+		$default_start_date = new DateTime('now', new DateTimeZone($event->get_timezone()));
+		$default_start_date = $default_start_date->format($date_formats[0] . ' ' . $date_formats[1]);
+		// use the start date of the first datetime for the end date
+		$first_datetime   = $event->first_datetime();
+		$default_end_date = $first_datetime->start_date_and_time($date_formats[0], $date_formats[1]);
+
+		// now process the incoming data
+		foreach ($data['edit_tickets'] as $row => $ticket_data) {
+			$update_prices = false;
+			$ticket_price  = $data['edit_prices'][ $row ][1]['PRC_amount'] ?? 0;
+			// trim inputs to ensure any excess whitespace is removed.
+			$ticket_data   = array_map('trim', $ticket_data);
+			$ticket_values = [
+				'TKT_ID'          => ! empty($ticket_data['TKT_ID']) ? $ticket_data['TKT_ID'] : null,
+				'TTM_ID'          => ! empty($ticket_data['TTM_ID']) ? $ticket_data['TTM_ID'] : 0,
+				'TKT_name'        => ! empty($ticket_data['TKT_name']) ? $ticket_data['TKT_name'] : '',
+				'TKT_description' => ! empty($ticket_data['TKT_description']) ? $ticket_data['TKT_description'] : '',
+				'TKT_start_date'  => ! empty($ticket_data['TKT_start_date'])
+					? $ticket_data['TKT_start_date']
+					: $default_start_date,
+				'TKT_end_date'    => ! empty($ticket_data['TKT_end_date'])
+					? $ticket_data['TKT_end_date']
+					: $default_end_date,
+				'TKT_qty'         => ! empty($ticket_data['TKT_qty'])
+									 || (isset($ticket_data['TKT_qty']) && (int) $ticket_data['TKT_qty'] === 0)
+					? $ticket_data['TKT_qty']
+					: EE_INF,
+				'TKT_uses'        => ! empty($ticket_data['TKT_uses'])
+									 || (isset($ticket_data['TKT_uses']) && (int) $ticket_data['TKT_uses'] === 0)
+					? $ticket_data['TKT_uses']
+					: EE_INF,
+				'TKT_min'         => ! empty($ticket_data['TKT_min']) ? $ticket_data['TKT_min'] : 0,
+				'TKT_max'         => ! empty($ticket_data['TKT_max']) ? $ticket_data['TKT_max'] : EE_INF,
+				'TKT_order'       => $ticket_data['TKT_order'] ?? $row,
+				'TKT_price'       => $ticket_price,
+				'TKT_row'         => $row,
+			];
+			// if this is a default ticket, then we need to set the TKT_ID to 0 and update accordingly,
+			// which means in turn that the prices will become new prices as well.
+			if (isset($ticket_data['TKT_is_default']) && $ticket_data['TKT_is_default']) {
+				$ticket_values['TKT_ID']         = 0;
+				$ticket_values['TKT_is_default'] = 0;
+				$update_prices                   = true;
+			}
+			// if we have a TKT_ID then we need to get that existing TKT_obj and update it
+			// we actually do our saves ahead of adding any relations because its entirely possible that this
+			// ticket didn't get removed or added to any datetime in the session but DID have it's items modified.
+			// keep in mind that if the ticket has been sold (and we have changed pricing information),
+			// then we won't be updating the tkt but instead a new tkt will be created and the old one archived.
+			if (! empty($ticket_data['TKT_ID'])) {
+				$existing_ticket = EEM_Ticket::instance($event_timezone)->get_one_by_ID($ticket_data['TKT_ID']);
+				if (! $existing_ticket instanceof EE_Ticket) {
+					throw new RuntimeException(
+						sprintf(
+							esc_html__(
+								'Something went wrong! A valid Ticket could not be retrieved from the database using the supplied ID: %1$d',
+								'event_espresso'
+							),
+							$ticket_data['TKT_ID']
+						)
+					);
+				}
+				$ticket_sold = $existing_ticket->count_related(
+					'Registration',
+					[
+							[
+								'STS_ID' => [
+									'NOT IN',
+									[EEM_Registration::status_id_incomplete],
+								],
+							],
+						]
+				) > 0;
+				// let's just check the total price for the existing ticket and determine if it matches the new total price.
+				// if they are different then we create a new ticket (if $ticket_sold)
+				// if they aren't different then we go ahead and modify existing ticket.
+				$create_new_ticket = $ticket_sold
+									 && $ticket_price !== $existing_ticket->price()
+									 && ! $existing_ticket->deleted();
+				$existing_ticket->set_date_format($date_formats[0]);
+				$existing_ticket->set_time_format($date_formats[1]);
+				// set new values
+				foreach ($ticket_values as $field => $value) {
+					if ($field == 'TKT_qty') {
+						$existing_ticket->set_qty($value);
+					} elseif ($field == 'TKT_price') {
+						$existing_ticket->set('TKT_price', $ticket_price);
+					} else {
+						$existing_ticket->set($field, $value);
+					}
+				}
+				$ticket = $existing_ticket;
+				// if $create_new_ticket is false then we can safely update the existing ticket.
+				//  Otherwise we have to create a new ticket.
+				if ($create_new_ticket) {
+					// archive the old ticket first
+					$existing_ticket->set('TKT_deleted', 1);
+					$existing_ticket->save();
+					// make sure this ticket is still recorded in our $saved_tickets
+					// so we don't run it through the regular trash routine.
+					$saved_tickets[ $existing_ticket->ID() ] = $existing_ticket;
+					// create new ticket that's a copy of the existing except,
+					// (a new id of course and not archived) AND has the new TKT_price associated with it.
+					$new_ticket = clone $existing_ticket;
+					$new_ticket->set('TKT_ID', 0);
+					$new_ticket->set('TKT_deleted', 0);
+					$new_ticket->set('TKT_sold', 0);
+					// now we need to make sure that $new prices are created as well and attached to new ticket.
+					$update_prices = true;
+					$ticket        = $new_ticket;
+				}
+			} else {
+				// no TKT_id so a new ticket
+				$ticket_values['TKT_price'] = $ticket_price;
+				$ticket                     = EE_Ticket::new_instance($ticket_values, $event_timezone, $date_formats);
+				$update_prices              = true;
+			}
+			if (! $ticket instanceof EE_Ticket) {
+				throw new RuntimeException(
+					sprintf(
+						esc_html__(
+							'Something went wrong! A valid Ticket could not be generated or retrieved using the supplied data: %1$s',
+							'event_espresso'
+						),
+						print_r($ticket_values, true)
+					)
+				);
+			}
+			// cap ticket qty by datetime reg limits
+			$ticket->set_qty(min($ticket->qty(), $ticket->qty('reg_limit')));
+			// update ticket.
+			$ticket->save();
+			// before going any further make sure our dates are setup correctly
+			// so that the end date is always equal or greater than the start date.
+			if ($ticket->get_raw('TKT_start_date') > $ticket->get_raw('TKT_end_date')) {
+				$ticket->set('TKT_end_date', $ticket->get('TKT_start_date'));
+				$ticket = EEH_DTT_Helper::date_time_add($ticket, 'TKT_end_date', 'days');
+				$ticket->save();
+			}
+			// initially let's add the ticket to the datetime
+			$datetime->_add_relation_to($ticket, 'Ticket');
+			$saved_tickets[ $ticket->ID() ] = $ticket;
+			// add prices to ticket
+			$prices_data = isset($data['edit_prices'][ $row ]) && is_array($data['edit_prices'][ $row ])
+				? $data['edit_prices'][ $row ]
+				: [];
+			$this->_add_prices_to_ticket($prices_data, $ticket, $update_prices);
+		}
+		// however now we need to handle permanently deleting tickets via the ui.
+		// Keep in mind that the ui does not allow deleting/archiving tickets that have ticket sold.
+		// However, it does allow for deleting tickets that have no tickets sold,
+		// in which case we want to get rid of permanently because there is no need to save in db.
+		$old_tickets     = isset($old_tickets[0]) && $old_tickets[0] === '' ? [] : $old_tickets;
+		$tickets_removed = array_diff($old_tickets, array_keys($saved_tickets));
+		foreach ($tickets_removed as $id) {
+			$id = absint($id);
+			// get the ticket for this id
+			$ticket_to_remove = EEM_Ticket::instance()->get_one_by_ID($id);
+			if (! $ticket_to_remove instanceof EE_Ticket) {
+				continue;
+			}
+			// need to get all the related datetimes on this ticket and remove from every single one of them
+			// (remember this process can ONLY kick off if there are NO tickets sold)
+			$related_datetimes = $ticket_to_remove->get_many_related('Datetime');
+			foreach ($related_datetimes as $related_datetime) {
+				$ticket_to_remove->_remove_relation_to($related_datetime, 'Datetime');
+			}
+			// need to do the same for prices (except these prices can also be deleted because again,
+			// tickets can only be trashed if they don't have any TKTs sold (otherwise they are just archived))
+			$ticket_to_remove->delete_related_permanently('Price');
+			// finally let's delete this ticket
+			// (which should not be blocked at this point b/c we've removed all our relationships)
+			$ticket_to_remove->delete_permanently();
+		}
+		return [$datetime, $saved_tickets];
+	}
+
+
+	/**
+	 * This attaches a list of given prices to a ticket.
+	 * Note we dont' have to worry about ever removing relationships (or archiving prices)
+	 * because if there is a change in price information on a ticket, a new ticket is created anyways
+	 * so the archived ticket will retain the old price info and prices are automatically "archived" via the ticket.
+	 *
+	 * @access  private
+	 * @param array     $prices_data Array of prices from the form.
+	 * @param EE_Ticket $ticket      EE_Ticket object that prices are being attached to.
+	 * @param bool      $new_prices  Whether attach existing incoming prices or create new ones.
+	 * @return  void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _add_prices_to_ticket(array $prices_data, EE_Ticket $ticket, bool $new_prices = false)
+	{
+		$timezone = $ticket->get_timezone();
+		foreach ($prices_data as $row => $price_data) {
+			$price_values = [
+				'PRC_ID'         => ! empty($price_data['PRC_ID']) ? $price_data['PRC_ID'] : null,
+				'PRT_ID'         => ! empty($price_data['PRT_ID']) ? $price_data['PRT_ID'] : null,
+				'PRC_amount'     => ! empty($price_data['PRC_amount']) ? $price_data['PRC_amount'] : 0,
+				'PRC_name'       => ! empty($price_data['PRC_name']) ? $price_data['PRC_name'] : '',
+				'PRC_desc'       => ! empty($price_data['PRC_desc']) ? $price_data['PRC_desc'] : '',
+				'PRC_is_default' => 0, // make sure prices are NOT set as default from this context
+				'PRC_order'      => $row,
+			];
+			if ($new_prices || empty($price_values['PRC_ID'])) {
+				$price_values['PRC_ID'] = 0;
+				$price                  = EE_Price::new_instance($price_values, $timezone);
+			} else {
+				$price = EEM_Price::instance($timezone)->get_one_by_ID($price_data['PRC_ID']);
+				// update this price with new values
+				foreach ($price_values as $field => $new_price) {
+					$price->set($field, $new_price);
+				}
+			}
+			if (! $price instanceof EE_Price) {
+				throw new RuntimeException(
+					sprintf(
+						esc_html__(
+							'Something went wrong! A valid Price could not be generated or retrieved using the supplied data: %1$s',
+							'event_espresso'
+						),
+						print_r($price_values, true)
+					)
+				);
+			}
+			$price->save();
+			$ticket->_add_relation_to($price, 'Price');
+		}
+	}
+
+
+	/**
+	 * Add in our autosave ajax handlers
+	 *
+	 */
+	protected function _ee_autosave_create_new()
+	{
+	}
+
+
+	/**
+	 * More autosave handlers.
+	 */
+	protected function _ee_autosave_edit()
+	{
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _generate_publish_box_extra_content()
+	{
+		// load formatter helper
+		// args for getting related registrations
+		$approved_query_args        = [
+			[
+				'REG_deleted' => 0,
+				'STS_ID'      => EEM_Registration::status_id_approved,
+			],
+		];
+		$not_approved_query_args    = [
+			[
+				'REG_deleted' => 0,
+				'STS_ID'      => EEM_Registration::status_id_not_approved,
+			],
+		];
+		$pending_payment_query_args = [
+			[
+				'REG_deleted' => 0,
+				'STS_ID'      => EEM_Registration::status_id_pending_payment,
+			],
+		];
+		// publish box
+		$publish_box_extra_args = [
+			'view_approved_reg_url'        => add_query_arg(
+				[
+					'action'      => 'default',
+					'event_id'    => $this->_cpt_model_obj->ID(),
+					'_reg_status' => EEM_Registration::status_id_approved,
+					'use_filters' => true,
+				],
+				REG_ADMIN_URL
+			),
+			'view_not_approved_reg_url'    => add_query_arg(
+				[
+					'action'      => 'default',
+					'event_id'    => $this->_cpt_model_obj->ID(),
+					'_reg_status' => EEM_Registration::status_id_not_approved,
+					'use_filters' => true,
+				],
+				REG_ADMIN_URL
+			),
+			'view_pending_payment_reg_url' => add_query_arg(
+				[
+					'action'      => 'default',
+					'event_id'    => $this->_cpt_model_obj->ID(),
+					'_reg_status' => EEM_Registration::status_id_pending_payment,
+					'use_filters' => true,
+				],
+				REG_ADMIN_URL
+			),
+			'approved_regs'                => $this->_cpt_model_obj->count_related(
+				'Registration',
+				$approved_query_args
+			),
+			'not_approved_regs'            => $this->_cpt_model_obj->count_related(
+				'Registration',
+				$not_approved_query_args
+			),
+			'pending_payment_regs'         => $this->_cpt_model_obj->count_related(
+				'Registration',
+				$pending_payment_query_args
+			),
+			'misc_pub_section_class'       => apply_filters(
+				'FHEE_Events_Admin_Page___generate_publish_box_extra_content__misc_pub_section_class',
+				'misc-pub-section'
+			),
+		];
+		ob_start();
+		do_action(
+			'AHEE__Events_Admin_Page___generate_publish_box_extra_content__event_editor_overview_add',
+			$this->_cpt_model_obj
+		);
+		$publish_box_extra_args['event_editor_overview_add'] = ob_get_clean();
+		// load template
+		EEH_Template::display_template(
+			EVENTS_TEMPLATE_PATH . 'event_publish_box_extras.template.php',
+			$publish_box_extra_args
+		);
+	}
+
+
+	/**
+	 * @return EE_Event
+	 */
+	public function get_event_object()
+	{
+		return $this->_cpt_model_obj;
+	}
+
+
+
+
+	/** METABOXES * */
+	/**
+	 * _register_event_editor_meta_boxes
+	 * add all metaboxes related to the event_editor
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _register_event_editor_meta_boxes()
+	{
+		$this->verify_cpt_object();
+		$use_advanced_editor = $this->admin_config->useAdvancedEditor();
+		// check if the new EDTR reg options meta box is being used, and if so, don't load the legacy version
+		if (! $use_advanced_editor || ! $this->feature->allowed('use_reg_options_meta_box')) {
+			$this->addMetaBox(
+				'espresso_event_editor_event_options',
+				esc_html__('Event Registration Options', 'event_espresso'),
+				[$this, 'registration_options_meta_box'],
+				$this->page_slug,
+				'side'
+			);
+		}
+		if (! $use_advanced_editor) {
+			$this->addMetaBox(
+				'espresso_event_editor_tickets',
+				esc_html__('Event Datetime & Ticket', 'event_espresso'),
+				[$this, 'ticket_metabox'],
+				$this->page_slug,
+				'normal',
+				'high'
+			);
+		} elseif ($this->feature->allowed('use_reg_options_meta_box')) {
+			add_action(
+				'add_meta_boxes_espresso_events',
+				function () {
+					global $current_screen;
+					remove_meta_box('authordiv', $current_screen, 'normal');
+				},
+				99
+			);
+		}
+		// NOTE: if you're looking for other metaboxes in here,
+		// where a metabox has a related management page in the admin
+		// you will find it setup in the related management page's "_Hooks" file.
+		// i.e. messages metabox is found in "espresso_events_Messages_Hooks.class.php".
+	}
+
+
+	/**
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function ticket_metabox()
+	{
+		$existing_datetime_ids = $existing_ticket_ids = [];
+		// defaults for template args
+		$template_args = [
+			'ticket_rows'       => '',
+			'total_ticket_rows' => 1,
+			'trash_icon'        => 'dashicons dashicons-lock',
+			'disabled'          => '',
+		];
+		$event_id      = is_object($this->_cpt_model_obj) ? $this->_cpt_model_obj->ID() : null;
+		/**
+		 * 1. Start with retrieving Datetimes
+		 * 2. Fore each datetime get related tickets
+		 * 3. For each ticket get related prices
+		 */
+		/** @var EEM_Datetime $datetime_model */
+		$datetime_model = EE_Registry::instance()->load_model('Datetime');
+		/** @var EEM_Ticket $datetime_model */
+		$ticket_model = EE_Registry::instance()->load_model('Ticket');
+		$times        = $datetime_model->get_all_event_dates($event_id);
+		/** @type EE_Datetime $first_datetime */
+		$first_datetime = reset($times);
+		// do we get related tickets?
+		if (
+			$first_datetime instanceof EE_Datetime
+			&& $first_datetime->ID() !== 0
+		) {
+			$existing_datetime_ids[] = $first_datetime->get('DTT_ID');
+			$template_args['time']   = $first_datetime;
+			$related_tickets         = $first_datetime->tickets(
+				[
+					['OR' => ['TKT_deleted' => 1, 'TKT_deleted*' => 0]],
+					'default_where_conditions' => 'none',
+				]
+			);
+			if (! empty($related_tickets)) {
+				$template_args['total_ticket_rows'] = count($related_tickets);
+				$row                                = 0;
+				foreach ($related_tickets as $ticket) {
+					$existing_ticket_ids[]        = $ticket->get('TKT_ID');
+					$template_args['ticket_rows'] .= $this->_get_ticket_row($ticket, false, $row);
+					$row++;
+				}
+			} else {
+				$template_args['total_ticket_rows'] = 1;
+				/** @type EE_Ticket $ticket */
+				$ticket                       = $ticket_model->create_default_object();
+				$template_args['ticket_rows'] .= $this->_get_ticket_row($ticket);
+			}
+		} else {
+			$template_args['time'] = $times[0];
+			/** @type EE_Ticket[] $tickets */
+			$tickets                      = $ticket_model->get_all_default_tickets();
+			$template_args['ticket_rows'] .= $this->_get_ticket_row($tickets[1]);
+			// NOTE: we're just sending the first default row
+			// (decaf can't manage default tickets so this should be sufficient);
+		}
+		$template_args['event_datetime_help_link'] = $this->_get_help_tab_link(
+			'event_editor_event_datetimes_help_tab'
+		);
+		$template_args['ticket_options_help_link'] = $this->_get_help_tab_link('ticket_options_info');
+		$template_args['existing_datetime_ids']    = implode(',', $existing_datetime_ids);
+		$template_args['existing_ticket_ids']      = implode(',', $existing_ticket_ids);
+		$template_args['ticket_js_structure']      = $this->_get_ticket_row(
+			$ticket_model->create_default_object(),
+			true
+		);
+		$template                                  = apply_filters(
+			'FHEE__Events_Admin_Page__ticket_metabox__template',
+			EVENTS_TEMPLATE_PATH . 'event_tickets_metabox_main.template.php'
+		);
+		EEH_Template::display_template($template, $template_args);
+	}
+
+
+	/**
+	 * Setup an individual ticket form for the decaf event editor page
+	 *
+	 * @access private
+	 * @param EE_Ticket $ticket   the ticket object
+	 * @param boolean   $skeleton whether we're generating a skeleton for js manipulation
+	 * @param int       $row
+	 * @return string generated html for the ticket row.
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _get_ticket_row(EE_Ticket $ticket, bool $skeleton = false, int $row = 0): string
+	{
+		$template_args = [
+			'tkt_status_class'    => ' tkt-status-' . $ticket->ticket_status(),
+			'tkt_archive_class'   => $ticket->ticket_status() === EE_Ticket::archived && ! $skeleton ? ' tkt-archived'
+				: '',
+			'ticketrow'           => $skeleton ? 'TICKETNUM' : $row,
+			'TKT_ID'              => $ticket->get('TKT_ID'),
+			'TKT_name'            => $ticket->get('TKT_name'),
+			'TKT_start_date'      => $skeleton ? '' : $ticket->get_date('TKT_start_date', 'Y-m-d h:i a'),
+			'TKT_end_date'        => $skeleton ? '' : $ticket->get_date('TKT_end_date', 'Y-m-d h:i a'),
+			'TKT_is_default'      => $ticket->get('TKT_is_default'),
+			'TKT_qty'             => $ticket->get_pretty('TKT_qty', 'input'),
+			'edit_ticketrow_name' => $skeleton ? 'TICKETNAMEATTR' : 'edit_tickets',
+			'TKT_sold'            => $skeleton ? 0 : $ticket->get('TKT_sold'),
+			'trash_icon'          => ($skeleton || (! empty($ticket) && ! $ticket->get('TKT_deleted')))
+									 && (! empty($ticket) && $ticket->get('TKT_sold') === 0)
+				? 'trash-icon dashicons dashicons-post-trash clickable' : 'dashicons dashicons-lock',
+			'disabled'            => $skeleton || (! empty($ticket) && ! $ticket->get('TKT_deleted')) ? ''
+				: ' disabled=disabled',
+		];
+		$price         = $ticket->ID() !== 0
+			? $ticket->get_first_related('Price', ['default_where_conditions' => 'none'])
+			: null;
+		$price         = $price instanceof EE_Price
+			? $price
+			: EEM_Price::instance()->create_default_object();
+		$price_args    = [
+			'price_currency_symbol' => EE_Registry::instance()->CFG->currency->sign,
+			'PRC_amount'            => $price->get('PRC_amount'),
+			'PRT_ID'                => $price->get('PRT_ID'),
+			'PRC_ID'                => $price->get('PRC_ID'),
+			'PRC_is_default'        => $price->get('PRC_is_default'),
+		];
+		// make sure we have default start and end dates if skeleton
+		// handle rows that should NOT be empty
+		if (empty($template_args['TKT_start_date'])) {
+			// if empty then the start date will be now.
+			$template_args['TKT_start_date'] = date('Y-m-d h:i a', current_time('timestamp'));
+		}
+		if (empty($template_args['TKT_end_date'])) {
+			// get the earliest datetime (if present);
+			$earliest_datetime             = $this->_cpt_model_obj->ID() > 0
+				? $this->_cpt_model_obj->get_first_related(
+					'Datetime',
+					['order_by' => ['DTT_EVT_start' => 'ASC']]
+				)
+				: null;
+			$template_args['TKT_end_date'] = $earliest_datetime instanceof EE_Datetime
+				? $earliest_datetime->get_datetime('DTT_EVT_start', 'Y-m-d', 'h:i a')
+				: date('Y-m-d h:i a', mktime(0, 0, 0, date('m'), date('d') + 7, date('Y')));
+		}
+		$template_args = array_merge($template_args, $price_args);
+		$template      = apply_filters(
+			'FHEE__Events_Admin_Page__get_ticket_row__template',
+			EVENTS_TEMPLATE_PATH . 'event_tickets_metabox_ticket_row.template.php',
+			$ticket
+		);
+		return EEH_Template::display_template($template, $template_args, true);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function registration_options_meta_box()
+	{
+		$yes_no_values             = [
+			['id' => true, 'text' => esc_html__('Yes', 'event_espresso')],
+			['id' => false, 'text' => esc_html__('No', 'event_espresso')],
+		];
+		$default_reg_status_values = EEM_Registration::reg_status_array(
+			[
+				EEM_Registration::status_id_cancelled,
+				EEM_Registration::status_id_declined,
+				EEM_Registration::status_id_incomplete,
+			],
+			true
+		);
+		// $template_args['is_active_select'] = EEH_Form_Fields::select_input('is_active', $yes_no_values, $this->_cpt_model_obj->is_active());
+		$template_args['_event']                          = $this->_cpt_model_obj;
+		$template_args['event']                           = $this->_cpt_model_obj;
+		$template_args['active_status']                   = $this->_cpt_model_obj->pretty_active_status(false);
+		$template_args['additional_limit']                = $this->_cpt_model_obj->additional_limit();
+		$template_args['default_registration_status']     = EEH_Form_Fields::select_input(
+			'default_reg_status',
+			$default_reg_status_values,
+			$this->_cpt_model_obj->default_registration_status()
+		);
+		$template_args['display_description']             = EEH_Form_Fields::select_input(
+			'display_desc',
+			$yes_no_values,
+			$this->_cpt_model_obj->display_description()
+		);
+		$template_args['display_ticket_selector']         = EEH_Form_Fields::select_input(
+			'display_ticket_selector',
+			$yes_no_values,
+			$this->_cpt_model_obj->display_ticket_selector(),
+			'',
+			'',
+			false
+		);
+		$template_args['additional_registration_options'] = apply_filters(
+			'FHEE__Events_Admin_Page__registration_options_meta_box__additional_registration_options',
+			'',
+			$template_args,
+			$yes_no_values,
+			$default_reg_status_values
+		);
+		EEH_Template::display_template(
+			EVENTS_TEMPLATE_PATH . 'event_registration_options.template.php',
+			$template_args
+		);
+	}
+
+
+	/**
+	 * _get_events()
+	 * This method simply returns all the events (for the given _view and paging)
+	 *
+	 * @access public
+	 * @param int  $per_page     count of items per page (20 default);
+	 * @param int  $current_page what is the current page being viewed.
+	 * @param bool $count        if TRUE then we just return a count of ALL events matching the given _view.
+	 *                           If FALSE then we return an array of event objects
+	 *                           that match the given _view and paging parameters.
+	 * @return array|int         an array of event objects or a count of them.
+	 * @throws Exception
+	 */
+	public function get_events(int $per_page = 10, int $current_page = 1, bool $count = false)
+	{
+		$EEM_Event   = $this->_event_model();
+		$offset      = ($current_page - 1) * $per_page;
+		$limit       = $count ? null : $offset . ',' . $per_page;
+		$orderby     = $this->request->getRequestParam('orderby', 'EVT_ID');
+		$order       = $this->request->getRequestParam('order', 'DESC');
+		$month_range = $this->request->getRequestParam('month_range');
+		if ($month_range) {
+			$pieces = explode(' ', $month_range, 3);
+			// simulate the FIRST day of the month, that fixes issues for months like February
+			// where PHP doesn't know what to assume for date.
+			// @see https://events.codebasehq.com/projects/event-espresso/tickets/10437
+			$month_r = ! empty($pieces[0]) ? date('m', EEH_DTT_Helper::first_of_month_timestamp($pieces[0])) : '';
+			$year_r  = ! empty($pieces[1]) ? $pieces[1] : '';
+		}
+		$where  = [];
+		$status = $this->request->getRequestParam('status');
+		// determine what post_status our condition will have for the query.
+		switch ($status) {
+			case 'month':
+			case 'today':
+			case null:
+			case 'all':
+				break;
+			case 'draft':
+				$where['status'] = ['IN', ['draft', 'auto-draft']];
+				break;
+			default:
+				$where['status'] = $status;
+		}
+		// categories? The default for all categories is -1
+		$category = $this->request->getRequestParam('EVT_CAT', -1, DataType::INT);
+		if ($category !== -1) {
+			$where['Term_Taxonomy.taxonomy'] = EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY;
+			$where['Term_Taxonomy.term_id']  = $category;
+		}
+		// date where conditions
+		$start_formats = EEM_Datetime::instance()->get_formats_for('DTT_EVT_start');
+		if ($month_range) {
+			$DateTime = new DateTime(
+				$year_r . '-' . $month_r . '-01 00:00:00',
+				new DateTimeZone('UTC')
+			);
+			$start    = $DateTime->getTimestamp();
+			// set the datetime to be the end of the month
+			$DateTime->setDate(
+				$year_r,
+				$month_r,
+				$DateTime->format('t')
+			)->setTime(23, 59, 59);
+			$end                             = $DateTime->getTimestamp();
+			$where['Datetime.DTT_EVT_start'] = ['BETWEEN', [$start, $end]];
+		} elseif ($status === 'today') {
+			$DateTime                        =
+				new DateTime('now', new DateTimeZone(EEM_Event::instance()->get_timezone()));
+			$start                           = $DateTime->setTime(0, 0)->format(implode(' ', $start_formats));
+			$end                             = $DateTime->setTime(23, 59, 59)->format(implode(' ', $start_formats));
+			$where['Datetime.DTT_EVT_start'] = ['BETWEEN', [$start, $end]];
+		} elseif ($status === 'month') {
+			$now                             = date('Y-m-01');
+			$DateTime                        =
+				new DateTime($now, new DateTimeZone(EEM_Event::instance()->get_timezone()));
+			$start                           = $DateTime->setTime(0, 0)->format(implode(' ', $start_formats));
+			$end                             = $DateTime->setDate(date('Y'), date('m'), $DateTime->format('t'))
+														->setTime(23, 59, 59)
+														->format(implode(' ', $start_formats));
+			$where['Datetime.DTT_EVT_start'] = ['BETWEEN', [$start, $end]];
+		}
+		if (! EE_Registry::instance()->CAP->current_user_can('ee_read_others_events', 'get_events')) {
+			$where['EVT_wp_user'] = get_current_user_id();
+		} else {
+			if (! isset($where['status'])) {
+				if (! EE_Registry::instance()->CAP->current_user_can('ee_read_private_events', 'get_events')) {
+					$where['OR'] = [
+						'status*restrict_private' => ['!=', 'private'],
+						'AND'                     => [
+							'status*inclusive' => ['=', 'private'],
+							'EVT_wp_user'      => get_current_user_id(),
+						],
+					];
+				}
+			}
+		}
+		$wp_user = $this->request->getRequestParam('EVT_wp_user', 0, DataType::INT);
+		if (
+			$wp_user
+			&& $wp_user !== get_current_user_id()
+			&& EE_Registry::instance()->CAP->current_user_can('ee_read_others_events', 'get_events')
+		) {
+			$where['EVT_wp_user'] = $wp_user;
+		}
+		// search query handling
+		$search_term = $this->request->getRequestParam('s');
+		if ($search_term) {
+			$search_term = '%' . $search_term . '%';
+			$where['OR'] = [
+				'EVT_name'       => ['LIKE', $search_term],
+				'EVT_desc'       => ['LIKE', $search_term],
+				'EVT_short_desc' => ['LIKE', $search_term],
+			];
+		}
+		// filter events by venue.
+		$venue = $this->request->getRequestParam('venue', 0, DataType::INT);
+		if ($venue) {
+			$where['Venue.VNU_ID'] = $venue;
+		}
+		$request_params = $this->request->requestParams();
+		$where          = apply_filters('FHEE__Events_Admin_Page__get_events__where', $where, $request_params);
+		$query_params   = apply_filters(
+			'FHEE__Events_Admin_Page__get_events__query_params',
+			[
+				$where,
+				'limit'    => $limit,
+				'order_by' => $orderby,
+				'order'    => $order,
+				'group_by' => 'EVT_ID',
+			],
+			$request_params
+		);
+
+		// let's first check if we have special requests coming in.
+		$active_status = $this->request->getRequestParam('active_status');
+		if ($active_status) {
+			switch ($active_status) {
+				case 'upcoming':
+					return $EEM_Event->get_upcoming_events($query_params, $count);
+				case 'expired':
+					return $EEM_Event->get_expired_events($query_params, $count);
+				case 'active':
+					return $EEM_Event->get_active_events($query_params, $count);
+				case 'inactive':
+					return $EEM_Event->get_inactive_events($query_params, $count);
+			}
+		}
+
+		return $count ? $EEM_Event->count([$where], 'EVT_ID', true) : $EEM_Event->get_all($query_params);
+	}
+
+
+	/**
+	 * handling for WordPress CPT actions (trash, restore, delete)
+	 *
+	 * @param string $post_id
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function trash_cpt_item($post_id)
+	{
+		$this->request->setRequestParam('EVT_ID', $post_id);
+		$this->_trash_or_restore_event('trash', false);
+	}
+
+
+	/**
+	 * @param string $post_id
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function restore_cpt_item($post_id)
+	{
+		$this->request->setRequestParam('EVT_ID', $post_id);
+		$this->_trash_or_restore_event('draft', false);
+	}
+
+
+	/**
+	 * @param string $post_id
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	public function delete_cpt_item($post_id)
+	{
+		throw new EE_Error(
+			esc_html__(
+				'Please contact Event Espresso support with the details of the steps taken to produce this error.',
+				'event_espresso'
+			)
+		);
+		// $this->request->setRequestParam('EVT_ID', $post_id);
+		// $this->_delete_event();
+	}
+
+
+	/**
+	 * _trash_or_restore_event
+	 *
+	 * @access protected
+	 * @param string $event_status
+	 * @param bool   $redirect_after
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _trash_or_restore_event(string $event_status = 'trash', bool $redirect_after = true)
+	{
+		// determine the event id and set to array.
+		$EVT_ID = $this->request->getRequestParam('EVT_ID', 0, DataType::INT);
+		// loop thru events
+		if ($EVT_ID) {
+			// clean status
+			$event_status = sanitize_key($event_status);
+			// grab status
+			if (! empty($event_status)) {
+				$success = $this->_change_event_status($EVT_ID, $event_status);
+			} else {
+				$success = false;
+				$msg     = esc_html__(
+					'An error occurred. The event could not be moved to the trash because a valid event status was not not supplied.',
+					'event_espresso'
+				);
+				EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			}
+		} else {
+			$success = false;
+			$msg     = esc_html__(
+				'An error occurred. The event could not be moved to the trash because a valid event ID was not not supplied.',
+				'event_espresso'
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+		}
+		$action = $event_status === 'trash' ? 'moved to the trash' : 'restored from the trash';
+		if ($redirect_after) {
+			$this->_redirect_after_action($success, 'Event', $action, ['action' => 'default']);
+		}
+	}
+
+
+	/**
+	 * _trash_or_restore_events
+	 *
+	 * @access protected
+	 * @param string $event_status
+	 * @return void
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _trash_or_restore_events(string $event_status = 'trash')
+	{
+		// clean status
+		$event_status = sanitize_key($event_status);
+		// grab status
+		if (! empty($event_status)) {
+			$success = true;
+			// determine the event id and set to array.
+			$EVT_IDs = $this->request->getRequestParam('EVT_IDs', [], 'int', true);
+			// loop thru events
+			foreach ($EVT_IDs as $EVT_ID) {
+				if ($EVT_ID = absint($EVT_ID)) {
+					$results = $this->_change_event_status($EVT_ID, $event_status);
+					$success = $results !== false ? $success : false;
+				} else {
+					$msg = sprintf(
+						esc_html__(
+							'An error occurred. Event #%d could not be moved to the trash because a valid event ID was not not supplied.',
+							'event_espresso'
+						),
+						$EVT_ID
+					);
+					EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+					$success = false;
+				}
+			}
+		} else {
+			$success = false;
+			$msg     = esc_html__(
+				'An error occurred. The event could not be moved to the trash because a valid event status was not not supplied.',
+				'event_espresso'
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+		}
+		// in order to force a pluralized result message we need to send back a success status greater than 1
+		$success = $success ? 2 : false;
+		$action  = $event_status === 'trash' ? 'moved to the trash' : 'restored from the trash';
+		$this->_redirect_after_action($success, 'Events', $action, ['action' => 'default']);
+	}
+
+
+	/**
+	 * @param int    $EVT_ID
+	 * @param string $event_status
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _change_event_status(int $EVT_ID = 0, string $event_status = ''): bool
+	{
+		// grab event id
+		if (! $EVT_ID) {
+			$msg = esc_html__(
+				'An error occurred. No Event ID or an invalid Event ID was received.',
+				'event_espresso'
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		$this->_cpt_model_obj = EEM_Event::instance()->get_one_by_ID($EVT_ID);
+		// clean status
+		$event_status = sanitize_key($event_status);
+		// grab status
+		if (empty($event_status)) {
+			$msg = esc_html__(
+				'An error occurred. No Event Status or an invalid Event Status was received.',
+				'event_espresso'
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		// was event trashed or restored ?
+		switch ($event_status) {
+			case 'draft':
+				$action = 'restored from the trash';
+				$hook   = 'AHEE_event_restored_from_trash';
+				break;
+			case 'trash':
+				$action = 'moved to the trash';
+				$hook   = 'AHEE_event_moved_to_trash';
+				break;
+			default:
+				$action = 'updated';
+				$hook   = false;
+		}
+		// use class to change status
+		$this->_cpt_model_obj->set_status($event_status);
+		$success = $this->_cpt_model_obj->save();
+		if (! $success) {
+			$msg = sprintf(esc_html__('An error occurred. The event could not be %s.', 'event_espresso'), $action);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		if ($hook) {
+			do_action($hook);
+			// fake the action hook in EE_Soft_Delete_Base_Class::delete_or_restore()
+			// because events side step that and it otherwise won't get called
+			do_action(
+				'AHEE__EE_Soft_Delete_Base_Class__delete_or_restore__after',
+				$this->_cpt_model_obj,
+				$hook === 'AHEE_event_moved_to_trash',
+				$success
+			);
+		}
+		return true;
+	}
+
+
+	/**
+	 * @param array $event_ids
+	 * @return array
+	 * @since   4.10.23.p
+	 */
+	private function cleanEventIds(array $event_ids): array
+	{
+		return array_map('absint', $event_ids);
+	}
+
+
+	/**
+	 * @return array
+	 * @since   4.10.23.p
+	 */
+	private function getEventIdsFromRequest(): array
+	{
+		if ($this->request->requestParamIsSet('EVT_IDs')) {
+			return $this->request->getRequestParam('EVT_IDs', [], 'int', true);
+		} else {
+			return $this->request->getRequestParam('EVT_ID', [], 'int', true);
+		}
+	}
+
+
+	/**
+	 * @param bool $preview_delete
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _delete_event(bool $preview_delete = true)
+	{
+		$this->_delete_events($preview_delete);
+	}
+
+
+	/**
+	 * Gets the tree traversal batch persister.
+	 *
+	 * @return NodeGroupDao
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @since 4.10.12.p
+	 */
+	protected function getModelObjNodeGroupPersister(): NodeGroupDao
+	{
+		if (! $this->model_obj_node_group_persister instanceof NodeGroupDao) {
+			$this->model_obj_node_group_persister =
+				$this->getLoader()->load('\EventEspresso\core\services\orm\tree_traversal\NodeGroupDao');
+		}
+		return $this->model_obj_node_group_persister;
+	}
+
+
+	/**
+	 * @param bool $preview_delete
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _delete_events(bool $preview_delete = true)
+	{
+		$event_ids = $this->getEventIdsFromRequest();
+		if ($preview_delete) {
+			$this->generateDeletionPreview($event_ids);
+		} else {
+			foreach ($event_ids as $event_id) {
+				$event = EEM_Event::instance()->get_one_by_ID($event_id);
+				if ($event instanceof EE_Event) {
+					$event->delete_permanently();
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * @param array $event_ids
+	 */
+	protected function generateDeletionPreview(array $event_ids)
+	{
+		$event_ids = $this->cleanEventIds($event_ids);
+		// Set a code we can use to reference this deletion task in the batch jobs and preview page.
+		$deletion_job_code = $this->getModelObjNodeGroupPersister()->generateGroupCode();
+		$return_url        = EE_Admin_Page::add_query_args_and_nonce(
+			[
+				'action'            => 'preview_deletion',
+				'deletion_job_code' => $deletion_job_code,
+			],
+			$this->_admin_base_url
+		);
+		EEH_URL::safeRedirectAndExit(
+			EE_Admin_Page::add_query_args_and_nonce(
+				[
+					'page'              => EED_Batch::PAGE_SLUG,
+					'batch'             => EED_Batch::batch_job,
+					'EVT_IDs'           => $event_ids,
+					'deletion_job_code' => $deletion_job_code,
+					'job_handler'       => urlencode('EventEspressoBatchRequest\JobHandlers\PreviewEventDeletion'),
+					'return_url'        => urlencode($return_url),
+				],
+				admin_url()
+			)
+		);
+	}
+
+
+	/**
+	 * Checks for a POST submission
+	 *
+	 * @since 4.10.12.p
+	 */
+	protected function confirmDeletion()
+	{
+		$deletion_redirect_logic = $this->getLoader()->getShared(
+			'EventEspresso\core\domain\services\admin\events\data\ConfirmDeletion'
+		);
+		$deletion_redirect_logic->handle($this->get_request_data(), $this->admin_base_url());
+	}
+
+
+	/**
+	 * A page for users to preview what exactly will be deleted, and confirm they want to delete it.
+	 *
+	 * @throws EE_Error
+	 * @since 4.10.12.p
+	 */
+	protected function previewDeletion()
+	{
+		$preview_deletion_logic = $this->getLoader()->getShared(
+			'EventEspresso\core\domain\services\admin\events\data\PreviewDeletion'
+		);
+		$this->set_template_args($preview_deletion_logic->handle($this->get_request_data(), $this->admin_base_url()));
+		$this->display_admin_page_with_no_sidebar();
+	}
+
+
+	/**
+	 * get total number of events
+	 *
+	 * @access public
+	 * @return int
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function total_events(): int
+	{
+		return EEM_Event::instance()->count(
+			['caps' => 'read_admin'],
+			'EVT_ID',
+			true
+		);
+	}
+
+
+	/**
+	 * get total number of draft events
+	 *
+	 * @access public
+	 * @return int
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function total_events_draft(): int
+	{
+		return EEM_Event::instance()->count(
+			[
+				['status' => ['IN', ['draft', 'auto-draft']]],
+				'caps' => 'read_admin',
+			],
+			'EVT_ID',
+			true
+		);
+	}
+
+
+	/**
+	 * get total number of trashed events
+	 *
+	 * @access public
+	 * @return int
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function total_trashed_events(): int
+	{
+		return EEM_Event::instance()->count(
+			[
+				['status' => 'trash'],
+				'caps' => 'read_admin',
+			],
+			'EVT_ID',
+			true
+		);
+	}
+
+
+	/**
+	 *    _default_event_settings
+	 *    This generates the Default Settings Tab
+	 *
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _default_event_settings()
+	{
+		$this->_set_add_edit_form_tags('update_default_event_settings');
+		$this->_set_publish_post_box_vars();
+		$this->_template_args['admin_page_content'] = EEH_HTML::div(
+			$this->_default_event_settings_form()->get_html(),
+			'',
+			'padding'
+		);
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	/**
+	 * Return the form for event settings.
+	 *
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 */
+	protected function _default_event_settings_form(): EE_Form_Section_Proper
+	{
+		$registration_config              = EE_Registry::instance()->CFG->registration;
+		$registration_stati_for_selection = EEM_Registration::reg_status_array(
+		// exclude
+			[
+				EEM_Registration::status_id_cancelled,
+				EEM_Registration::status_id_declined,
+				EEM_Registration::status_id_incomplete,
+				EEM_Registration::status_id_wait_list,
+			],
+			true
+		);
+		// setup Advanced Editor ???
+		if (
+			$this->raw_req_action === 'default_event_settings'
+			|| $this->raw_req_action === 'update_default_event_settings'
+		) {
+			$this->advanced_editor_admin_form = $this->loader->getShared(AdvancedEditorAdminFormSection::class);
+		}
+		return new EE_Form_Section_Proper(
+			[
+				'name'            => 'update_default_event_settings',
+				'html_id'         => 'update_default_event_settings',
+				'html_class'      => 'form-table',
+				'layout_strategy' => new EE_Admin_Two_Column_Layout(),
+				'subsections'     => apply_filters(
+					'FHEE__Events_Admin_Page___default_event_settings_form__form_subsections',
+					[
+						'defaults_section_header' => new EE_Form_Section_HTML(
+							EEH_HTML::h2(
+								esc_html__('Default Settings', 'event_espresso'),
+								'',
+								'ee-admin-settings-hdr'
+							)
+						),
+						'default_reg_status'      => new EE_Select_Input(
+							$registration_stati_for_selection,
+							[
+								'default'         => isset($registration_config->default_STS_ID)
+													 && array_key_exists(
+														 $registration_config->default_STS_ID,
+														 $registration_stati_for_selection
+													 )
+									? sanitize_text_field($registration_config->default_STS_ID)
+									: EEM_Registration::status_id_pending_payment,
+								'html_label_text' => esc_html__('Default Registration Status', 'event_espresso')
+													 . EEH_Template::get_help_tab_link(
+														 'default_settings_status_help_tab'
+													 ),
+								'html_help_text'  => esc_html__(
+									'This setting allows you to preselect what the default registration status setting is when creating an event.  Note that changing this setting does NOT retroactively apply it to existing events.',
+									'event_espresso'
+								),
+							]
+						),
+						'default_max_tickets'     => new EE_Integer_Input(
+							[
+								'default'         => $registration_config->default_maximum_number_of_tickets
+													 ?? EEM_Event::get_default_additional_limit(),
+								'html_label_text' => esc_html__(
+									'Default Maximum Tickets Allowed Per Order:',
+									'event_espresso'
+								)
+													 . EEH_Template::get_help_tab_link(
+														 'default_maximum_tickets_help_tab"'
+													 ),
+								'html_help_text'  => esc_html__(
+									'This setting allows you to indicate what will be the default for the maximum number of tickets per order when creating new events.',
+									'event_espresso'
+								),
+							]
+						),
+					]
+				),
+			]
+		);
+	}
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _update_default_event_settings()
+	{
+		$form = $this->_default_event_settings_form();
+		if ($form->was_submitted()) {
+			$form->receive_form_submission();
+			if ($form->is_valid()) {
+				$registration_config = EE_Registry::instance()->CFG->registration;
+				$valid_data          = $form->valid_data();
+				if (isset($valid_data['default_reg_status'])) {
+					$registration_config->default_STS_ID = $valid_data['default_reg_status'];
+				}
+				if (isset($valid_data['default_max_tickets'])) {
+					$registration_config->default_maximum_number_of_tickets = $valid_data['default_max_tickets'];
+				}
+				do_action(
+					'AHEE__Events_Admin_Page___update_default_event_settings',
+					$valid_data,
+					EE_Registry::instance()->CFG,
+					$this
+				);
+				// update because data was valid!
+				EE_Registry::instance()->CFG->update_espresso_config();
+				EE_Error::overwrite_success();
+				EE_Error::add_success(
+					esc_html__('Default Event Settings were updated', 'event_espresso')
+				);
+			}
+		}
+		$this->_redirect_after_action(0, '', '', ['action' => 'default_event_settings'], true);
+	}
+
+
+	/*************        Templates        *************
      *
-     * @var EE_Event $_event
-     */
-    protected $_event;
-
-
-    /**
-     * This will hold the category object for category_details screen.
-     *
-     * @var stdClass $_category
-     */
-    protected $_category;
-
-
-    /**
-     * This will hold the event model instance
-     *
-     * @var EEM_Event $_event_model
-     */
-    protected $_event_model;
-
-
-    /**
-     * @var EE_Event
-     */
-    protected $_cpt_model_obj = false;
-
-
-    /**
-     * @var NodeGroupDao
-     */
-    protected $model_obj_node_group_persister;
-
-    /**
-     * @var AdvancedEditorAdminFormSection
-     */
-    protected $advanced_editor_admin_form;
-
-
-    /**
-     * Initialize page props for this admin page group.
-     */
-    protected function _init_page_props()
-    {
-        $this->page_slug        = EVENTS_PG_SLUG;
-        $this->page_label       = EVENTS_LABEL;
-        $this->_admin_base_url  = EVENTS_ADMIN_URL;
-        $this->_admin_base_path = EVENTS_ADMIN;
-        $this->_cpt_model_names = [
-            'create_new' => 'EEM_Event',
-            'edit'       => 'EEM_Event',
-        ];
-        $this->_cpt_edit_routes = [
-            'espresso_events' => 'edit',
-        ];
-        add_action(
-            'AHEE__EE_Admin_Page_CPT__set_model_object__after_set_object',
-            [$this, 'verify_event_edit'],
-            10,
-            2
-        );
-    }
-
-
-    /**
-     * Sets the ajax hooks used for this admin page group.
-     */
-    protected function _ajax_hooks()
-    {
-        add_action('wp_ajax_ee_save_timezone_setting', [$this, 'saveTimezoneString']);
-    }
-
-
-    /**
-     * Sets the page properties for this admin page group.
-     */
-    protected function _define_page_props()
-    {
-        $event_id = $this->request->getRequestParam('post', 0, DataType::INT);
-        if ($event_id) {
-            $event_post = get_post($event_id);
-        }
-
-        $this->_admin_page_title = EVENTS_LABEL;
-        $this->_labels           = [
-            'buttons'      => [
-                'add'             => esc_html__('Add New Event', 'event_espresso'),
-                'edit'            => esc_html__('Edit Event', 'event_espresso'),
-                'delete'          => esc_html__('Delete Event', 'event_espresso'),
-                'add_category'    => esc_html__('Add New Category', 'event_espresso'),
-                'edit_category'   => esc_html__('Edit Category', 'event_espresso'),
-                'delete_category' => esc_html__('Delete Category', 'event_espresso'),
-            ],
-            'editor_title' => [
-                'espresso_events' => isset($event_post) && $event_post instanceof WP_Post
-                    ? $event_post->post_title
-                    : esc_html__('Edit Event', 'event_espresso'),
-            ],
-            'publishbox'   => [
-                'create_new'        => esc_html__('Save New Event', 'event_espresso'),
-                'edit'              => esc_html__('Update Event', 'event_espresso'),
-                'add_category'      => esc_html__('Save New Category', 'event_espresso'),
-                'edit_category'     => esc_html__('Update Category', 'event_espresso'),
-                'template_settings' => esc_html__('Update Settings', 'event_espresso'),
-            ],
-        ];
-    }
-
-
-    /**
-     * Sets the page routes property for this admin page group.
-     */
-    protected function _set_page_routes()
-    {
-        // load formatter helper
-        // load field generator helper
-        // is there a evt_id in the request?
-        $EVT_ID = $this->request->getRequestParam('EVT_ID', 0, DataType::INT);
-        $EVT_ID = $this->request->getRequestParam('post', $EVT_ID, DataType::INT);
-
-        $this->_page_routes = [
-            'default'                       => [
-                'func'       => [$this, '_events_overview_list_table'],
-                'capability' => 'ee_read_events',
-            ],
-            'create_new'                    => [
-                'func'       => [$this, '_create_new_cpt_item'],
-                'capability' => 'ee_edit_events',
-            ],
-            'edit'                          => [
-                'func'       => [$this, '_edit_cpt_item'],
-                'capability' => 'ee_edit_event',
-                'obj_id'     => $EVT_ID,
-            ],
-            'copy_event'                    => [
-                'func'       => [$this, '_copy_events'],
-                'capability' => 'ee_edit_event',
-                'obj_id'     => $EVT_ID,
-                'noheader'   => true,
-            ],
-            'trash_event'                   => [
-                'func'       => [$this, '_trash_or_restore_event'],
-                'args'       => ['event_status' => 'trash'],
-                'capability' => 'ee_delete_event',
-                'obj_id'     => $EVT_ID,
-                'noheader'   => true,
-            ],
-            'trash_events'                  => [
-                'func'       => [$this, '_trash_or_restore_events'],
-                'args'       => ['event_status' => 'trash'],
-                'capability' => 'ee_delete_events',
-                'noheader'   => true,
-            ],
-            'restore_event'                 => [
-                'func'       => [$this, '_trash_or_restore_event'],
-                'args'       => ['event_status' => 'draft'],
-                'capability' => 'ee_delete_event',
-                'obj_id'     => $EVT_ID,
-                'noheader'   => true,
-            ],
-            'restore_events'                => [
-                'func'       => [$this, '_trash_or_restore_events'],
-                'args'       => ['event_status' => 'draft'],
-                'capability' => 'ee_delete_events',
-                'noheader'   => true,
-            ],
-            'delete_event'                  => [
-                'func'       => [$this, '_delete_event'],
-                'capability' => 'ee_delete_event',
-                'obj_id'     => $EVT_ID,
-                'noheader'   => true,
-            ],
-            'delete_events'                 => [
-                'func'       => [$this, '_delete_events'],
-                'capability' => 'ee_delete_events',
-                'noheader'   => true,
-            ],
-            'view_report'                   => [
-                'func'       => [$this, '_view_report'],
-                'capability' => 'ee_edit_events',
-            ],
-            'default_event_settings'        => [
-                'func'       => [$this, '_default_event_settings'],
-                'capability' => 'manage_options',
-            ],
-            'update_default_event_settings' => [
-                'func'       => [$this, '_update_default_event_settings'],
-                'capability' => 'manage_options',
-                'noheader'   => true,
-            ],
-            'template_settings'             => [
-                'func'       => [$this, '_template_settings'],
-                'capability' => 'manage_options',
-            ],
-            // event category tab related
-            'add_category'                  => [
-                'func'       => [$this, '_category_details'],
-                'capability' => 'ee_edit_event_category',
-                'args'       => ['view' => 'add'],
-            ],
-            'edit_category'                 => [
-                'func'       => [$this, '_category_details'],
-                'capability' => 'ee_edit_event_category',
-                'args'       => ['view' => 'edit'],
-            ],
-            'delete_categories'             => [
-                'func'       => [$this, '_delete_categories'],
-                'capability' => 'ee_delete_event_category',
-                'noheader'   => true,
-            ],
-            'delete_category'               => [
-                'func'       => [$this, '_delete_categories'],
-                'capability' => 'ee_delete_event_category',
-                'noheader'   => true,
-            ],
-            'insert_category'               => [
-                'func'       => [$this, '_insert_or_update_category'],
-                'args'       => ['new_category' => true],
-                'capability' => 'ee_edit_event_category',
-                'noheader'   => true,
-            ],
-            'update_category'               => [
-                'func'       => [$this, '_insert_or_update_category'],
-                'args'       => ['new_category' => false],
-                'capability' => 'ee_edit_event_category',
-                'noheader'   => true,
-            ],
-            'category_list'                 => [
-                'func'       => [$this, '_category_list_table'],
-                'capability' => 'ee_manage_event_categories',
-            ],
-            'preview_deletion'              => [
-                'func'       => [$this, 'previewDeletion'],
-                'capability' => 'ee_delete_events',
-            ],
-            'confirm_deletion'              => [
-                'func'       => [$this, 'confirmDeletion'],
-                'capability' => 'ee_delete_events',
-                'noheader'   => true,
-            ],
-        ];
-    }
-
-
-    /**
-     * Set the _page_config property for this admin page group.
-     */
-    protected function _set_page_config()
-    {
-        $post_id            = $this->request->getRequestParam('post', 0, DataType::INT);
-        $EVT_CAT_ID         = $this->request->getRequestParam('EVT_CAT_ID', 0, DataType::INT);
-        $this->_page_config = [
-            'default'                => [
-                'nav'           => [
-                    'label' => esc_html__('Overview', 'event_espresso'),
-                    'icon'  => 'dashicons-list-view',
-                    'order' => 10,
-                ],
-                'list_table'    => 'Events_Admin_List_Table',
-                'help_tabs'     => [
-                    'events_overview_help_tab'                       => [
-                        'title'    => esc_html__('Events Overview', 'event_espresso'),
-                        'filename' => 'events_overview',
-                    ],
-                    'events_overview_table_column_headings_help_tab' => [
-                        'title'    => esc_html__('Events Overview Table Column Headings', 'event_espresso'),
-                        'filename' => 'events_overview_table_column_headings',
-                    ],
-                    'events_overview_filters_help_tab'               => [
-                        'title'    => esc_html__('Events Overview Filters', 'event_espresso'),
-                        'filename' => 'events_overview_filters',
-                    ],
-                    'events_overview_view_help_tab'                  => [
-                        'title'    => esc_html__('Events Overview Views', 'event_espresso'),
-                        'filename' => 'events_overview_views',
-                    ],
-                    'events_overview_other_help_tab'                 => [
-                        'title'    => esc_html__('Events Overview Other', 'event_espresso'),
-                        'filename' => 'events_overview_other',
-                    ],
-                ],
-                'require_nonce' => false,
-            ],
-            'create_new'             => [
-                'nav'           => [
-                    'label'      => esc_html__('Add New Event', 'event_espresso'),
-                    'icon'       => 'dashicons-plus-alt',
-                    'order'      => 15,
-                    'persistent' => false,
-                ],
-                'metaboxes'     => ['_register_event_editor_meta_boxes'],
-                'help_tabs'     => [
-                    'event_editor_help_tab'                            => [
-                        'title'    => esc_html__('Event Editor', 'event_espresso'),
-                        'filename' => 'event_editor',
-                    ],
-                    'event_editor_title_richtexteditor_help_tab'       => [
-                        'title'    => esc_html__('Event Title & Rich Text Editor', 'event_espresso'),
-                        'filename' => 'event_editor_title_richtexteditor',
-                    ],
-                    'event_editor_venue_details_help_tab'              => [
-                        'title'    => esc_html__('Event Venue Details', 'event_espresso'),
-                        'filename' => 'event_editor_venue_details',
-                    ],
-                    'event_editor_event_datetimes_help_tab'            => [
-                        'title'    => esc_html__('Event Datetimes', 'event_espresso'),
-                        'filename' => 'event_editor_event_datetimes',
-                    ],
-                    'event_editor_event_tickets_help_tab'              => [
-                        'title'    => esc_html__('Event Tickets', 'event_espresso'),
-                        'filename' => 'event_editor_event_tickets',
-                    ],
-                    'event_editor_event_registration_options_help_tab' => [
-                        'title'    => esc_html__('Event Registration Options', 'event_espresso'),
-                        'filename' => 'event_editor_event_registration_options',
-                    ],
-                    'event_editor_tags_categories_help_tab'            => [
-                        'title'    => esc_html__('Event Tags & Categories', 'event_espresso'),
-                        'filename' => 'event_editor_tags_categories',
-                    ],
-                    'event_editor_questions_registrants_help_tab'      => [
-                        'title'    => esc_html__('Questions for Registrants', 'event_espresso'),
-                        'filename' => 'event_editor_questions_registrants',
-                    ],
-                    'event_editor_save_new_event_help_tab'             => [
-                        'title'    => esc_html__('Save New Event', 'event_espresso'),
-                        'filename' => 'event_editor_save_new_event',
-                    ],
-                    'event_editor_other_help_tab'                      => [
-                        'title'    => esc_html__('Event Other', 'event_espresso'),
-                        'filename' => 'event_editor_other',
-                    ],
-                ],
-                'qtips'         => ['EE_Event_Editor_Decaf_Tips'],
-                'require_nonce' => false,
-            ],
-            'edit'                   => [
-                'nav'           => [
-                    'label'      => esc_html__('Edit Event', 'event_espresso'),
-                    'icon'       => 'dashicons-edit',
-                    'order'      => 15,
-                    'persistent' => false,
-                    'url'        => $post_id
-                        ? EE_Admin_Page::add_query_args_and_nonce(
-                            ['post' => $post_id, 'action' => 'edit'],
-                            $this->_current_page_view_url
-                        )
-                        : $this->_admin_base_url,
-                ],
-                'metaboxes'     => ['_register_event_editor_meta_boxes'],
-                'help_tabs'     => [
-                    'event_editor_help_tab'                            => [
-                        'title'    => esc_html__('Event Editor', 'event_espresso'),
-                        'filename' => 'event_editor',
-                    ],
-                    'event_editor_title_richtexteditor_help_tab'       => [
-                        'title'    => esc_html__('Event Title & Rich Text Editor', 'event_espresso'),
-                        'filename' => 'event_editor_title_richtexteditor',
-                    ],
-                    'event_editor_venue_details_help_tab'              => [
-                        'title'    => esc_html__('Event Venue Details', 'event_espresso'),
-                        'filename' => 'event_editor_venue_details',
-                    ],
-                    'event_editor_event_datetimes_help_tab'            => [
-                        'title'    => esc_html__('Event Datetimes', 'event_espresso'),
-                        'filename' => 'event_editor_event_datetimes',
-                    ],
-                    'event_editor_event_tickets_help_tab'              => [
-                        'title'    => esc_html__('Event Tickets', 'event_espresso'),
-                        'filename' => 'event_editor_event_tickets',
-                    ],
-                    'event_editor_event_registration_options_help_tab' => [
-                        'title'    => esc_html__('Event Registration Options', 'event_espresso'),
-                        'filename' => 'event_editor_event_registration_options',
-                    ],
-                    'event_editor_tags_categories_help_tab'            => [
-                        'title'    => esc_html__('Event Tags & Categories', 'event_espresso'),
-                        'filename' => 'event_editor_tags_categories',
-                    ],
-                    'event_editor_questions_registrants_help_tab'      => [
-                        'title'    => esc_html__('Questions for Registrants', 'event_espresso'),
-                        'filename' => 'event_editor_questions_registrants',
-                    ],
-                    'event_editor_save_new_event_help_tab'             => [
-                        'title'    => esc_html__('Save New Event', 'event_espresso'),
-                        'filename' => 'event_editor_save_new_event',
-                    ],
-                    'event_editor_other_help_tab'                      => [
-                        'title'    => esc_html__('Event Other', 'event_espresso'),
-                        'filename' => 'event_editor_other',
-                    ],
-                ],
-                'require_nonce' => false,
-            ],
-            'default_event_settings' => [
-                'nav'           => [
-                    'label' => esc_html__('Default Settings', 'event_espresso'),
-                    'icon'  => 'dashicons-admin-generic',
-                    'order' => 40,
-                ],
-                'metaboxes'     => array_merge(['_publish_post_box'], $this->_default_espresso_metaboxes),
-                'labels'        => [
-                    'publishbox' => esc_html__('Update Settings', 'event_espresso'),
-                ],
-                'help_tabs'     => [
-                    'default_settings_help_tab'        => [
-                        'title'    => esc_html__('Default Event Settings', 'event_espresso'),
-                        'filename' => 'events_default_settings',
-                    ],
-                    'default_settings_status_help_tab' => [
-                        'title'    => esc_html__('Default Registration Status', 'event_espresso'),
-                        'filename' => 'events_default_settings_status',
-                    ],
-                    'default_maximum_tickets_help_tab' => [
-                        'title'    => esc_html__('Default Maximum Tickets Per Order', 'event_espresso'),
-                        'filename' => 'events_default_settings_max_tickets',
-                    ],
-                ],
-                'require_nonce' => false,
-            ],
-            // template settings
-            'template_settings'      => [
-                'nav'           => [
-                    'label' => esc_html__('Templates', 'event_espresso'),
-                    'icon'  => 'dashicons-layout',
-                    'order' => 30,
-                ],
-                'metaboxes'     => $this->_default_espresso_metaboxes,
-                'help_tabs'     => [
-                    'general_settings_templates_help_tab' => [
-                        'title'    => esc_html__('Templates', 'event_espresso'),
-                        'filename' => 'general_settings_templates',
-                    ],
-                ],
-                'require_nonce' => false,
-            ],
-            // event category stuff
-            'add_category'           => [
-                'nav'           => [
-                    'label'      => esc_html__('Add Category', 'event_espresso'),
-                    'icon'       => 'dashicons-plus-alt',
-                    'order'      => 25,
-                    'persistent' => false,
-                ],
-                'help_tabs'     => [
-                    'add_category_help_tab' => [
-                        'title'    => esc_html__('Add New Event Category', 'event_espresso'),
-                        'filename' => 'events_add_category',
-                    ],
-                ],
-                'metaboxes'     => ['_publish_post_box'],
-                'require_nonce' => false,
-            ],
-            'edit_category'          => [
-                'nav'           => [
-                    'label'      => esc_html__('Edit Category', 'event_espresso'),
-                    'icon'       => 'dashicons-edit',
-                    'order'      => 25,
-                    'persistent' => false,
-                    'url'        => $EVT_CAT_ID
-                        ? add_query_arg(
-                            ['EVT_CAT_ID' => $EVT_CAT_ID],
-                            $this->_current_page_view_url
-                        )
-                        : $this->_admin_base_url,
-                ],
-                'help_tabs'     => [
-                    'edit_category_help_tab' => [
-                        'title'    => esc_html__('Edit Event Category', 'event_espresso'),
-                        'filename' => 'events_edit_category',
-                    ],
-                ],
-                'metaboxes'     => ['_publish_post_box'],
-                'require_nonce' => false,
-            ],
-            'category_list'          => [
-                'nav'           => [
-                    'label' => esc_html__('Categories', 'event_espresso'),
-                    'icon'  => 'dashicons-networking',
-                    'order' => 20,
-                ],
-                'list_table'    => 'Event_Categories_Admin_List_Table',
-                'help_tabs'     => [
-                    'events_categories_help_tab'                       => [
-                        'title'    => esc_html__('Event Categories', 'event_espresso'),
-                        'filename' => 'events_categories',
-                    ],
-                    'events_categories_table_column_headings_help_tab' => [
-                        'title'    => esc_html__('Event Categories Table Column Headings', 'event_espresso'),
-                        'filename' => 'events_categories_table_column_headings',
-                    ],
-                    'events_categories_view_help_tab'                  => [
-                        'title'    => esc_html__('Event Categories Views', 'event_espresso'),
-                        'filename' => 'events_categories_views',
-                    ],
-                    'events_categories_other_help_tab'                 => [
-                        'title'    => esc_html__('Event Categories Other', 'event_espresso'),
-                        'filename' => 'events_categories_other',
-                    ],
-                ],
-                'metaboxes'     => $this->_default_espresso_metaboxes,
-                'require_nonce' => false,
-            ],
-            'preview_deletion'       => [
-                'nav'           => [
-                    'label'      => esc_html__('Preview Deletion', 'event_espresso'),
-                    'icon'       => 'dashicons-remove',
-                    'order'      => 15,
-                    'persistent' => false,
-                    'url'        => '',
-                ],
-                'require_nonce' => false,
-            ],
-        ];
-    }
-
-
-    /**
-     * Used to register any global screen options if necessary for every route in this admin page group.
-     */
-    protected function _add_screen_options()
-    {
-    }
-
-
-    /**
-     * Implementing the screen options for the 'default' route.
-     *
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _add_screen_options_default()
-    {
-        $this->_per_page_screen_option();
-    }
-
-
-    /**
-     * Implementing screen options for the category list route.
-     *
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _add_screen_options_category_list()
-    {
-        $page_title              = $this->_admin_page_title;
-        $this->_admin_page_title = esc_html__('Categories', 'event_espresso');
-        $this->_per_page_screen_option();
-        $this->_admin_page_title = $page_title;
-    }
-
-
-    /**
-     * Used to register any global feature pointers for the admin page group.
-     */
-    protected function _add_feature_pointers()
-    {
-    }
-
-
-    /**
-     * Registers and enqueues any global scripts and styles for the entire admin page group.
-     */
-    public function load_scripts_styles()
-    {
-        wp_register_style(
-            'events-admin-css',
-            EVENTS_ASSETS_URL . 'events-admin-page.css',
-            [],
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_register_style(
-            'ee-cat-admin',
-            EVENTS_ASSETS_URL . 'ee-cat-admin.css',
-            [],
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_style('events-admin-css');
-        wp_enqueue_style('ee-cat-admin');
-        // scripts
-        wp_register_script(
-            'event_editor_js',
-            EVENTS_ASSETS_URL . 'event_editor.js',
-            ['ee_admin_js', 'jquery-ui-slider', 'jquery-ui-timepicker-addon'],
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-    }
-
-
-    /**
-     * Enqueuing scripts and styles specific to this view
-     */
-    public function load_scripts_styles_create_new()
-    {
-        $this->load_scripts_styles_edit();
-    }
-
-
-    /**
-     * Enqueuing scripts and styles specific to this view
-     */
-    public function load_scripts_styles_edit()
-    {
-        // styles
-        wp_enqueue_style('espresso-ui-theme');
-        wp_register_style(
-            'event-editor-css',
-            EVENTS_ASSETS_URL . 'event-editor.css',
-            ['ee-admin-css'],
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_style('event-editor-css');
-        // scripts
-        if (! $this->admin_config->useAdvancedEditor()) {
-            wp_register_script(
-                'event-datetime-metabox',
-                EVENTS_ASSETS_URL . 'event-datetime-metabox.js',
-                ['event_editor_js', 'ee-datepicker'],
-                EVENT_ESPRESSO_VERSION
-            );
-            wp_enqueue_script('event-datetime-metabox');
-        }
-    }
-
-
-    /**
-     * Populating the _views property for the category list table view.
-     */
-    protected function _set_list_table_views_category_list()
-    {
-        $this->_views = [
-            'all' => [
-                'slug'        => 'all',
-                'label'       => esc_html__('All', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => [
-                    'delete_categories' => esc_html__('Delete Permanently', 'event_espresso'),
-                ],
-            ],
-        ];
-    }
-
-
-    /**
-     * For adding anything that fires on the admin_init hook for any route within this admin page group.
-     */
-    public function admin_init()
-    {
-        EE_Registry::$i18n_js_strings['image_confirm'] = esc_html__(
-            'Do you really want to delete this image? Please remember to update your event to complete the removal.',
-            'event_espresso'
-        );
-    }
-
-
-    /**
-     * For adding anything that should be triggered on the admin_notices hook for any route within this admin page
-     * group.
-     */
-    public function admin_notices()
-    {
-    }
-
-
-    /**
-     * For adding anything that should be triggered on the `admin_print_footer_scripts` hook for any route within
-     * this admin page group.
-     */
-    public function admin_footer_scripts()
-    {
-    }
-
-
-    /**
-     * Call this function to verify if an event is public and has tickets for sale.  If it does, then we need to show a
-     * warning (via EE_Error::add_error());
-     *
-     * @param EE_Event|null $event Event object
-     * @param string        $req_type
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function verify_event_edit(?EE_Base_Class $event = null, string $req_type = '')
-    {
-        // don't need to do this when processing
-        if (! empty($req_type)) {
-            return;
-        }
-        // no event?
-        if (! $event instanceof EE_Event) {
-            $event = $this->_cpt_model_obj;
-        }
-        // STILL no event?
-        if (! $event instanceof EE_Event) {
-            return;
-        }
-        // don't need to keep calling this
-        remove_action(
-            'AHEE__EE_Admin_Page_CPT__set_model_object__after_set_object',
-            [$this, 'verify_event_edit']
-        );
-        $orig_status = $event->status();
-        // first check if event is active.
-        if (
-            $orig_status === EEM_Event::cancelled
-            || $orig_status === EEM_Event::postponed
-            || $event->is_expired()
-            || $event->is_inactive()
-        ) {
-            return;
-        }
-        // made it here so it IS active... next check that any of the tickets are sold.
-        if ($event->is_sold_out(true)) {
-            if ($orig_status !== EEM_Event::sold_out && $event->status() !== $orig_status) {
-                EE_Error::add_attention(
-                    sprintf(
-                        esc_html__(
-                            'Please note that the Event Status has automatically been changed to %s because there are no more spaces available for this event.  However, this change is not permanent until you update the event.  You can change the status back to something else before updating if you wish.',
-                            'event_espresso'
-                        ),
-                        EEH_Template::pretty_status(EEM_Event::sold_out, false, 'sentence')
-                    )
-                );
-            }
-            return;
-        }
-        if ($orig_status === EEM_Event::sold_out) {
-            EE_Error::add_attention(
-                sprintf(
-                    esc_html__(
-                        'Please note that the Event Status has automatically been changed to %s because more spaces have become available for this event, most likely due to abandoned transactions freeing up reserved tickets.  However, this change is not permanent until you update the event. If you wish, you can change the status back to something else before updating.',
-                        'event_espresso'
-                    ),
-                    EEH_Template::pretty_status($event->status(), false, 'sentence')
-                )
-            );
-        }
-        // now we need to determine if the event has any tickets on sale.  If not then we dont' show the error
-        if (! $event->tickets_on_sale()) {
-            return;
-        }
-        // made it here so show warning
-        $this->_edit_event_warning();
-    }
-
-
-    /**
-     * This is the text used for when an event is being edited that is public and has tickets for sale.
-     * When needed, hook this into a EE_Error::add_error() notice.
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _edit_event_warning()
-    {
-        // we don't want to add warnings during these requests
-        if ($this->request->getRequestParam('action') === 'editpost') {
-            return;
-        }
-        EE_Error::add_attention(
-            sprintf(
-                esc_html__(
-                    'Your event is open for registration. Making changes may disrupt any transactions in progress. %sLearn more%s',
-                    'event_espresso'
-                ),
-                '<a class="espresso-help-tab-lnk ee-help-tab-link">',
-                '</a>'
-            )
-        );
-    }
-
-
-    /**
-     * When a user is creating a new event, notify them if they haven't set their timezone.
-     * Otherwise, do the normal logic
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _create_new_cpt_item()
-    {
-        $has_timezone_string = get_option('timezone_string');
-        // only nag them about setting their timezone if it's their first event, and they haven't already done it
-        if (! $has_timezone_string && ! EEM_Event::instance()->exists([])) {
-            EE_Error::add_attention(
-                sprintf(
-                    esc_html__(
-                        'Your website\'s timezone is currently set to a UTC offset. We recommend updating your timezone to a city or region near you before you create an event. Change your timezone now:%1$s%2$s%3$sChange Timezone%4$s',
-                        'event_espresso'
-                    ),
-                    '<br>',
-                    '<select id="timezone_string" name="timezone_string" aria-describedby="timezone-description">'
-                    . EEH_DTT_Helper::wp_timezone_choice('', EEH_DTT_Helper::get_user_locale())
-                    . '</select>',
-                    '<button class="button button--secondary timezone-submit">',
-                    '</button><span class="spinner"></span>'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        parent::_create_new_cpt_item();
-    }
-
-
-    /**
-     * Sets the _views property for the default route in this admin page group.
-     */
-    protected function _set_list_table_views_default()
-    {
-        $this->_views = [
-            'all'   => [
-                'slug'        => 'all',
-                'label'       => esc_html__('View All Events', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => [
-                    'trash_events' => esc_html__('Move to Trash', 'event_espresso'),
-                ],
-            ],
-            'draft' => [
-                'slug'        => 'draft',
-                'label'       => esc_html__('Draft', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => [
-                    'trash_events' => esc_html__('Move to Trash', 'event_espresso'),
-                ],
-            ],
-        ];
-        if (EE_Registry::instance()->CAP->current_user_can('ee_delete_events', 'espresso_events_trash_events')) {
-            $this->_views['trash'] = [
-                'slug'        => 'trash',
-                'label'       => esc_html__('Trash', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => [
-                    'restore_events' => esc_html__('Restore From Trash', 'event_espresso'),
-                    'delete_events'  => esc_html__('Delete Permanently', 'event_espresso'),
-                ],
-            ];
-        }
-    }
-
-
-    /**
-     * Provides the legend item array for the default list table view.
-     *
-     * @return array
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    protected function _event_legend_items(): array
-    {
-        $items    = [
-            'view_details'   => [
-                'class' => 'dashicons dashicons-visibility',
-                'desc'  => esc_html__('View Event', 'event_espresso'),
-            ],
-            'edit_event'     => [
-                'class' => 'dashicons dashicons-calendar-alt',
-                'desc'  => esc_html__('Edit Event Details', 'event_espresso'),
-            ],
-            'view_attendees' => [
-                'class' => 'dashicons dashicons-groups',
-                'desc'  => esc_html__('View Registrations for Event', 'event_espresso'),
-            ],
-        ];
-        $items    = apply_filters('FHEE__Events_Admin_Page___event_legend_items__items', $items);
-        $statuses = [
-            'sold_out_status'  => [
-                'class' => 'ee-status-legend ee-status-bg--' . EE_Datetime::sold_out,
-                'desc'  => EEH_Template::pretty_status(EE_Datetime::sold_out, false, 'sentence'),
-            ],
-            'active_status'    => [
-                'class' => 'ee-status-legend ee-status-bg--' . EE_Datetime::active,
-                'desc'  => EEH_Template::pretty_status(EE_Datetime::active, false, 'sentence'),
-            ],
-            'upcoming_status'  => [
-                'class' => 'ee-status-legend ee-status-bg--' . EE_Datetime::upcoming,
-                'desc'  => EEH_Template::pretty_status(EE_Datetime::upcoming, false, 'sentence'),
-            ],
-            'postponed_status' => [
-                'class' => 'ee-status-legend ee-status-bg--' . EE_Datetime::postponed,
-                'desc'  => EEH_Template::pretty_status(EE_Datetime::postponed, false, 'sentence'),
-            ],
-            'cancelled_status' => [
-                'class' => 'ee-status-legend ee-status-bg--' . EE_Datetime::cancelled,
-                'desc'  => EEH_Template::pretty_status(EE_Datetime::cancelled, false, 'sentence'),
-            ],
-            'expired_status'   => [
-                'class' => 'ee-status-legend ee-status-bg--' . EE_Datetime::expired,
-                'desc'  => EEH_Template::pretty_status(EE_Datetime::expired, false, 'sentence'),
-            ],
-            'inactive_status'  => [
-                'class' => 'ee-status-legend ee-status-bg--' . EE_Datetime::inactive,
-                'desc'  => EEH_Template::pretty_status(EE_Datetime::inactive, false, 'sentence'),
-            ],
-        ];
-        $statuses = apply_filters('FHEE__Events_Admin_Page__event_legend_items__statuses', $statuses);
-        return array_merge($items, $statuses);
-    }
-
-
-    /**
-     * @return EEM_Event
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function _event_model(): EEM_Event
-    {
-        if (! $this->_event_model instanceof EEM_Event) {
-            $this->_event_model = EE_Registry::instance()->load_model('Event');
-        }
-        return $this->_event_model;
-    }
-
-
-    /**
-     * Adds extra buttons to the WP CPT permalink field row.
-     * Method is called from parent and is hooked into the wp 'get_sample_permalink_html' filter.
-     *
-     * @param string      $return    the current html
-     * @param int         $id        the post id for the page
-     * @param string|null $new_title What the title is
-     * @param string|null $new_slug  what the slug is
-     * @return string            The new html string for the permalink area
-     * @deprecated $VID:$
-     * @see TicketSelectorShortcodeButton::addButton
-     */
-    public function extra_permalink_field_buttons(
-        string $return,
-        int $id,
-        ?string $new_title,
-        ?string $new_slug
-    ): string {
-        return TicketSelectorShortcodeButton::addButton($return, $id, $new_title, $new_slug);
-    }
-
-
-    /**
-     * _events_overview_list_table
-     * This contains the logic for showing the events_overview list
-     *
-     * @access protected
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _events_overview_list_table()
-    {
-        $after_list_table = [];
-        $links_html       = EEH_HTML::div('', '', 'ee-admin-section ee-layout-stack');
-        $links_html       .= EEH_HTML::h3(esc_html__('Links', 'event_espresso'));
-        $links_html       .= EEH_HTML::div(
-            EEH_Template::get_button_or_link(
-                get_post_type_archive_link('espresso_events'),
-                esc_html__('View Event Archive Page', 'event_espresso'),
-                'button button--small button--secondary'
-            ),
-            '',
-            'ee-admin-button-row ee-admin-button-row--align-start'
-        );
-        $links_html       .= EEH_HTML::divx();
-
-        $after_list_table['view_event_list_button'] = $links_html;
-
-        $after_list_table['legend'] = $this->_display_legend($this->_event_legend_items());
-        $this->_admin_page_title    .= ' ' . $this->get_action_link_or_button(
-            'create_new',
-            'add',
-            [],
-            'add-new-h2'
-        );
-
-        $this->_template_args['after_list_table'] = array_merge(
-            (array) $this->_template_args['after_list_table'],
-            $after_list_table
-        );
-        $this->display_admin_list_table_page_with_no_sidebar();
-    }
-
-
-    /**
-     * this allows for extra misc actions in the default WP publish box
-     *
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function extra_misc_actions_publish_box()
-    {
-        $this->_generate_publish_box_extra_content();
-    }
-
-
-    /**
-     * This is hooked into the WordPress do_action('save_post') hook and runs after the custom post type has been
-     * saved.
-     * Typically you would use this to save any additional data.
-     * Keep in mind also that "save_post" runs on EVERY post update to the database.
-     * ALSO very important.  When a post transitions from scheduled to published,
-     * the save_post action is fired but you will NOT have any _POST data containing any extra info you may have from
-     * other meta saves. So MAKE sure that you handle this accordingly.
-     *
-     * @access protected
-     * @abstract
-     * @param string  $post_id The ID of the cpt that was saved (so you can link relationally)
-     * @param WP_Post $post    The post object of the cpt that was saved.
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _insert_update_cpt_item($post_id, $post)
-    {
-        if ($post instanceof WP_Post && $post->post_type !== 'espresso_events') {
-            // get out we're not processing an event save.
-            return;
-        }
-        $event_values = [
-            'EVT_member_only'     => $this->request->getRequestParam('member_only', false, DataType::BOOL),
-            'EVT_allow_overflow'  => $this->request->getRequestParam('EVT_allow_overflow', false, DataType::BOOL),
-            'EVT_timezone_string' => $this->request->getRequestParam('timezone_string'),
-        ];
-        // check if the new EDTR reg options meta box is being used, and if so, don't run updates for legacy version
-        if (! $this->admin_config->useAdvancedEditor() || ! $this->feature->allowed('use_reg_options_meta_box')) {
-            $event_values['EVT_display_ticket_selector']     = $this->request->getRequestParam(
-                'display_ticket_selector',
-                false,
-                'bool'
-            );
-            $event_values['EVT_additional_limit']            = min(
-                apply_filters('FHEE__EE_Events_Admin__insert_update_cpt_item__EVT_additional_limit_max', 255),
-                $this->request->getRequestParam(
-                    'additional_limit',
-                    EEM_Event::get_default_additional_limit(),
-                    'int'
-                )
-            );
-            $event_values['EVT_default_registration_status'] = $this->request->getRequestParam(
-                'EVT_default_registration_status',
-                EE_Registry::instance()->CFG->registration->default_STS_ID
-            );
-
-            $event_values['EVT_external_URL'] = $this->request->getRequestParam('externalURL');
-            $event_values['EVT_phone']        = $this->request->getRequestParam('event_phone');
-            $event_values['EVT_display_desc'] = $this->request->getRequestParam('display_desc', false, DataType::BOOL);
-        } elseif ($post instanceof WP_Post) {
-            $event_values['EVT_name'] = $post->post_title;
-            $event_values['EVT_desc'] = $post->post_content;
-        }
-        // update event
-        $success = $this->_event_model()->update_by_ID($event_values, $post_id);
-        // get event_object for other metaboxes...
-        // though it would seem to make sense to just use $this->_event_model()->get_one_by_ID( $post_id )..
-        // i have to setup where conditions to override the filters in the model
-        // that filter out auto-draft and inherit statuses so we GET the inherit id!
-        /** @var EE_Event $event */
-        $event = $this->_event_model()->get_one(
-            [
-                [
-                    $this->_event_model()->primary_key_name() => $post_id,
-                    'OR'                                      => [
-                        'status'   => $post->post_status,
-                        // if trying to "Publish" a sold out event, it's status will get switched back to "sold_out" in the db,
-                        // but the returned object here has a status of "publish", so use the original post status as well
-                        'status*1' => $this->request->getRequestParam('original_post_status'),
-                    ],
-                ],
-            ]
-        );
-
-        // the following are default callbacks for event attachment updates
-        // that can be overridden by caffeinated functionality and/or addons.
-        $event_update_callbacks = [];
-        if (! $this->admin_config->useAdvancedEditor()) {
-            $event_update_callbacks['_default_venue_update']   = [$this, '_default_venue_update'];
-            $event_update_callbacks['_default_tickets_update'] = [$this, '_default_tickets_update'];
-        }
-        $event_update_callbacks = apply_filters(
-            'FHEE__Events_Admin_Page___insert_update_cpt_item__event_update_callbacks',
-            $event_update_callbacks
-        );
-
-        $att_success = true;
-        foreach ($event_update_callbacks as $e_callback) {
-            $_success = is_callable($e_callback)
-                ? $e_callback($event, $this->request->requestParams())
-                : false;
-            // if ANY of these updates fail then we want the appropriate global error message
-            $att_success = $_success !== false ? $att_success : false;
-        }
-        // any errors?
-        if ($success && $att_success === false) {
-            EE_Error::add_error(
-                esc_html__(
-                    'Event Details saved successfully but something went wrong with saving attachments.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        } elseif ($success === false) {
-            EE_Error::add_error(
-                esc_html__('Event Details did not save successfully.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-    }
-
-
-    /**
-     * @param int $post_id
-     * @param int $revision_id
-     * @throws EE_Error
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @see parent::restore_item()
-     */
-    protected function _restore_cpt_item(int $post_id, int $revision_id)
-    {
-        // copy existing event meta to new post
-        $post_evt = $this->_event_model()->get_one_by_ID($post_id);
-        if ($post_evt instanceof EE_Event) {
-            // meta revision restore
-            $post_evt->restore_revision($revision_id);
-            // related objs restore
-            $post_evt->restore_revision($revision_id, ['Venue', 'Datetime', 'Price']);
-        }
-    }
-
-
-    /**
-     * Attach the venue to the Event
-     *
-     * @param EE_Event $event Event Object to add the venue to
-     * @param array    $data  The request data from the form
-     * @return bool           Success or fail.
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _default_venue_update(EE_Event $event, array $data): bool
-    {
-        require_once(EE_MODELS . 'EEM_Venue.model.php');
-        $venue_model = EE_Registry::instance()->load_model('Venue');
-        $venue_id    = ! empty($data['venue_id']) ? $data['venue_id'] : null;
-        // very important.  If we don't have a venue name...
-        // then we'll get out because not necessary to create empty venue
-        if (empty($data['venue_title'])) {
-            return false;
-        }
-        $venue_array = [
-            'VNU_wp_user'         => $event->get('EVT_wp_user'),
-            'VNU_name'            => $data['venue_title'],
-            'VNU_desc'            => ! empty($data['venue_description']) ? $data['venue_description'] : null,
-            'VNU_identifier'      => ! empty($data['venue_identifier']) ? $data['venue_identifier'] : null,
-            'VNU_short_desc'      => ! empty($data['venue_short_description'])
-                ? $data['venue_short_description']
-                : null,
-            'VNU_address'         => ! empty($data['address']) ? $data['address'] : null,
-            'VNU_address2'        => ! empty($data['address2']) ? $data['address2'] : null,
-            'VNU_city'            => ! empty($data['city']) ? $data['city'] : null,
-            'STA_ID'              => ! empty($data['state']) ? $data['state'] : null,
-            'CNT_ISO'             => ! empty($data['countries']) ? $data['countries'] : null,
-            'VNU_zip'             => ! empty($data['zip']) ? $data['zip'] : null,
-            'VNU_phone'           => ! empty($data['venue_phone']) ? $data['venue_phone'] : null,
-            'VNU_capacity'        => ! empty($data['venue_capacity']) ? $data['venue_capacity'] : null,
-            'VNU_url'             => ! empty($data['venue_url']) ? $data['venue_url'] : null,
-            'VNU_virtual_phone'   => ! empty($data['virtual_phone']) ? $data['virtual_phone'] : null,
-            'VNU_virtual_url'     => ! empty($data['virtual_url']) ? $data['virtual_url'] : null,
-            'VNU_enable_for_gmap' => isset($data['enable_for_gmap']) ? 1 : 0,
-            'status'              => 'publish',
-        ];
-        // if we've got the venue_id then we're just updating the existing venue so let's do that and then get out.
-        if (! empty($venue_id)) {
-            $update_where  = [$venue_model->primary_key_name() => $venue_id];
-            $rows_affected = $venue_model->update($venue_array, [$update_where]);
-            // we've gotta make sure that the venue is always attached to a revision..
-            // add_relation_to should take care of making sure that the relation is already present.
-            $event->_add_relation_to($venue_id, 'Venue');
-            return $rows_affected > 0;
-        }
-        // we insert the venue
-        $venue_id = $venue_model->insert($venue_array);
-        $event->_add_relation_to($venue_id, 'Venue');
-        return ! empty($venue_id);
-        // when we have the ancestor come in it's already been handled by the revision save.
-    }
-
-
-    /**
-     * Handles saving everything related to Tickets (datetimes, tickets, prices)
-     *
-     * @param EE_Event $event The Event object we're attaching data to
-     * @param array    $data  The request data from the form
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws Exception
-     */
-    protected function _default_tickets_update(EE_Event $event, array $data): array
-    {
-        if ($this->admin_config->useAdvancedEditor()) {
-            return [];
-        }
-        $datetime       = null;
-        $saved_tickets  = [];
-        $event_timezone = $event->get_timezone();
-        $date_formats   = ['Y-m-d', 'h:i a'];
-        foreach ($data['edit_event_datetimes'] as $row => $datetime_data) {
-            // trim all values to ensure any excess whitespace is removed.
-            $datetime_data                = array_map('trim', $datetime_data);
-            $datetime_data['DTT_EVT_end'] =
-                isset($datetime_data['DTT_EVT_end']) && ! empty($datetime_data['DTT_EVT_end'])
-                    ? $datetime_data['DTT_EVT_end']
-                    : $datetime_data['DTT_EVT_start'];
-            $datetime_values              = [
-                'DTT_ID'        => ! empty($datetime_data['DTT_ID']) ? $datetime_data['DTT_ID'] : null,
-                'DTT_EVT_start' => $datetime_data['DTT_EVT_start'],
-                'DTT_EVT_end'   => $datetime_data['DTT_EVT_end'],
-                'DTT_reg_limit' => empty($datetime_data['DTT_reg_limit']) ? EE_INF : $datetime_data['DTT_reg_limit'],
-                'DTT_order'     => $row,
-            ];
-            // if we have an id then let's get existing object first and then set the new values.
-            //  Otherwise we instantiate a new object for save.
-            if (! empty($datetime_data['DTT_ID'])) {
-                $datetime = EEM_Datetime::instance($event_timezone)->get_one_by_ID($datetime_data['DTT_ID']);
-                if (! $datetime instanceof EE_Datetime) {
-                    throw new RuntimeException(
-                        sprintf(
-                            esc_html__(
-                                'Something went wrong! A valid Datetime could not be retrieved from the database using the supplied ID: %1$d',
-                                'event_espresso'
-                            ),
-                            $datetime_data['DTT_ID']
-                        )
-                    );
-                }
-                $datetime->set_date_format($date_formats[0]);
-                $datetime->set_time_format($date_formats[1]);
-                foreach ($datetime_values as $field => $value) {
-                    $datetime->set($field, $value);
-                }
-            } else {
-                $datetime = EE_Datetime::new_instance($datetime_values, $event_timezone, $date_formats);
-            }
-            if (! $datetime instanceof EE_Datetime) {
-                throw new RuntimeException(
-                    sprintf(
-                        esc_html__(
-                            'Something went wrong! A valid Datetime could not be generated or retrieved using the supplied data: %1$s',
-                            'event_espresso'
-                        ),
-                        print_r($datetime_values, true)
-                    )
-                );
-            }
-            // before going any further make sure our dates are setup correctly
-            // so that the end date is always equal or greater than the start date.
-            if ($datetime->get_raw('DTT_EVT_start') > $datetime->get_raw('DTT_EVT_end')) {
-                $datetime->set('DTT_EVT_end', $datetime->get('DTT_EVT_start'));
-                $datetime = EEH_DTT_Helper::date_time_add($datetime, 'DTT_EVT_end', 'days');
-            }
-            $datetime->save();
-            $event->_add_relation_to($datetime, 'Datetime');
-        }
-        // no datetimes get deleted so we don't do any of that logic here.
-        // update tickets next
-        $old_tickets = isset($data['ticket_IDs']) ? explode(',', $data['ticket_IDs']) : [];
-
-        // set up some default start and end dates in case those are not present in the incoming data
-        $default_start_date = new DateTime('now', new DateTimeZone($event->get_timezone()));
-        $default_start_date = $default_start_date->format($date_formats[0] . ' ' . $date_formats[1]);
-        // use the start date of the first datetime for the end date
-        $first_datetime   = $event->first_datetime();
-        $default_end_date = $first_datetime->start_date_and_time($date_formats[0], $date_formats[1]);
-
-        // now process the incoming data
-        foreach ($data['edit_tickets'] as $row => $ticket_data) {
-            $update_prices = false;
-            $ticket_price  = $data['edit_prices'][ $row ][1]['PRC_amount'] ?? 0;
-            // trim inputs to ensure any excess whitespace is removed.
-            $ticket_data   = array_map('trim', $ticket_data);
-            $ticket_values = [
-                'TKT_ID'          => ! empty($ticket_data['TKT_ID']) ? $ticket_data['TKT_ID'] : null,
-                'TTM_ID'          => ! empty($ticket_data['TTM_ID']) ? $ticket_data['TTM_ID'] : 0,
-                'TKT_name'        => ! empty($ticket_data['TKT_name']) ? $ticket_data['TKT_name'] : '',
-                'TKT_description' => ! empty($ticket_data['TKT_description']) ? $ticket_data['TKT_description'] : '',
-                'TKT_start_date'  => ! empty($ticket_data['TKT_start_date'])
-                    ? $ticket_data['TKT_start_date']
-                    : $default_start_date,
-                'TKT_end_date'    => ! empty($ticket_data['TKT_end_date'])
-                    ? $ticket_data['TKT_end_date']
-                    : $default_end_date,
-                'TKT_qty'         => ! empty($ticket_data['TKT_qty'])
-                                     || (isset($ticket_data['TKT_qty']) && (int) $ticket_data['TKT_qty'] === 0)
-                    ? $ticket_data['TKT_qty']
-                    : EE_INF,
-                'TKT_uses'        => ! empty($ticket_data['TKT_uses'])
-                                     || (isset($ticket_data['TKT_uses']) && (int) $ticket_data['TKT_uses'] === 0)
-                    ? $ticket_data['TKT_uses']
-                    : EE_INF,
-                'TKT_min'         => ! empty($ticket_data['TKT_min']) ? $ticket_data['TKT_min'] : 0,
-                'TKT_max'         => ! empty($ticket_data['TKT_max']) ? $ticket_data['TKT_max'] : EE_INF,
-                'TKT_order'       => $ticket_data['TKT_order'] ?? $row,
-                'TKT_price'       => $ticket_price,
-                'TKT_row'         => $row,
-            ];
-            // if this is a default ticket, then we need to set the TKT_ID to 0 and update accordingly,
-            // which means in turn that the prices will become new prices as well.
-            if (isset($ticket_data['TKT_is_default']) && $ticket_data['TKT_is_default']) {
-                $ticket_values['TKT_ID']         = 0;
-                $ticket_values['TKT_is_default'] = 0;
-                $update_prices                   = true;
-            }
-            // if we have a TKT_ID then we need to get that existing TKT_obj and update it
-            // we actually do our saves ahead of adding any relations because its entirely possible that this
-            // ticket didn't get removed or added to any datetime in the session but DID have it's items modified.
-            // keep in mind that if the ticket has been sold (and we have changed pricing information),
-            // then we won't be updating the tkt but instead a new tkt will be created and the old one archived.
-            if (! empty($ticket_data['TKT_ID'])) {
-                $existing_ticket = EEM_Ticket::instance($event_timezone)->get_one_by_ID($ticket_data['TKT_ID']);
-                if (! $existing_ticket instanceof EE_Ticket) {
-                    throw new RuntimeException(
-                        sprintf(
-                            esc_html__(
-                                'Something went wrong! A valid Ticket could not be retrieved from the database using the supplied ID: %1$d',
-                                'event_espresso'
-                            ),
-                            $ticket_data['TKT_ID']
-                        )
-                    );
-                }
-                $ticket_sold = $existing_ticket->count_related(
-                    'Registration',
-                    [
-                            [
-                                'STS_ID' => [
-                                    'NOT IN',
-                                    [EEM_Registration::status_id_incomplete],
-                                ],
-                            ],
-                        ]
-                ) > 0;
-                // let's just check the total price for the existing ticket and determine if it matches the new total price.
-                // if they are different then we create a new ticket (if $ticket_sold)
-                // if they aren't different then we go ahead and modify existing ticket.
-                $create_new_ticket = $ticket_sold
-                                     && $ticket_price !== $existing_ticket->price()
-                                     && ! $existing_ticket->deleted();
-                $existing_ticket->set_date_format($date_formats[0]);
-                $existing_ticket->set_time_format($date_formats[1]);
-                // set new values
-                foreach ($ticket_values as $field => $value) {
-                    if ($field == 'TKT_qty') {
-                        $existing_ticket->set_qty($value);
-                    } elseif ($field == 'TKT_price') {
-                        $existing_ticket->set('TKT_price', $ticket_price);
-                    } else {
-                        $existing_ticket->set($field, $value);
-                    }
-                }
-                $ticket = $existing_ticket;
-                // if $create_new_ticket is false then we can safely update the existing ticket.
-                //  Otherwise we have to create a new ticket.
-                if ($create_new_ticket) {
-                    // archive the old ticket first
-                    $existing_ticket->set('TKT_deleted', 1);
-                    $existing_ticket->save();
-                    // make sure this ticket is still recorded in our $saved_tickets
-                    // so we don't run it through the regular trash routine.
-                    $saved_tickets[ $existing_ticket->ID() ] = $existing_ticket;
-                    // create new ticket that's a copy of the existing except,
-                    // (a new id of course and not archived) AND has the new TKT_price associated with it.
-                    $new_ticket = clone $existing_ticket;
-                    $new_ticket->set('TKT_ID', 0);
-                    $new_ticket->set('TKT_deleted', 0);
-                    $new_ticket->set('TKT_sold', 0);
-                    // now we need to make sure that $new prices are created as well and attached to new ticket.
-                    $update_prices = true;
-                    $ticket        = $new_ticket;
-                }
-            } else {
-                // no TKT_id so a new ticket
-                $ticket_values['TKT_price'] = $ticket_price;
-                $ticket                     = EE_Ticket::new_instance($ticket_values, $event_timezone, $date_formats);
-                $update_prices              = true;
-            }
-            if (! $ticket instanceof EE_Ticket) {
-                throw new RuntimeException(
-                    sprintf(
-                        esc_html__(
-                            'Something went wrong! A valid Ticket could not be generated or retrieved using the supplied data: %1$s',
-                            'event_espresso'
-                        ),
-                        print_r($ticket_values, true)
-                    )
-                );
-            }
-            // cap ticket qty by datetime reg limits
-            $ticket->set_qty(min($ticket->qty(), $ticket->qty('reg_limit')));
-            // update ticket.
-            $ticket->save();
-            // before going any further make sure our dates are setup correctly
-            // so that the end date is always equal or greater than the start date.
-            if ($ticket->get_raw('TKT_start_date') > $ticket->get_raw('TKT_end_date')) {
-                $ticket->set('TKT_end_date', $ticket->get('TKT_start_date'));
-                $ticket = EEH_DTT_Helper::date_time_add($ticket, 'TKT_end_date', 'days');
-                $ticket->save();
-            }
-            // initially let's add the ticket to the datetime
-            $datetime->_add_relation_to($ticket, 'Ticket');
-            $saved_tickets[ $ticket->ID() ] = $ticket;
-            // add prices to ticket
-            $prices_data = isset($data['edit_prices'][ $row ]) && is_array($data['edit_prices'][ $row ])
-                ? $data['edit_prices'][ $row ]
-                : [];
-            $this->_add_prices_to_ticket($prices_data, $ticket, $update_prices);
-        }
-        // however now we need to handle permanently deleting tickets via the ui.
-        // Keep in mind that the ui does not allow deleting/archiving tickets that have ticket sold.
-        // However, it does allow for deleting tickets that have no tickets sold,
-        // in which case we want to get rid of permanently because there is no need to save in db.
-        $old_tickets     = isset($old_tickets[0]) && $old_tickets[0] === '' ? [] : $old_tickets;
-        $tickets_removed = array_diff($old_tickets, array_keys($saved_tickets));
-        foreach ($tickets_removed as $id) {
-            $id = absint($id);
-            // get the ticket for this id
-            $ticket_to_remove = EEM_Ticket::instance()->get_one_by_ID($id);
-            if (! $ticket_to_remove instanceof EE_Ticket) {
-                continue;
-            }
-            // need to get all the related datetimes on this ticket and remove from every single one of them
-            // (remember this process can ONLY kick off if there are NO tickets sold)
-            $related_datetimes = $ticket_to_remove->get_many_related('Datetime');
-            foreach ($related_datetimes as $related_datetime) {
-                $ticket_to_remove->_remove_relation_to($related_datetime, 'Datetime');
-            }
-            // need to do the same for prices (except these prices can also be deleted because again,
-            // tickets can only be trashed if they don't have any TKTs sold (otherwise they are just archived))
-            $ticket_to_remove->delete_related_permanently('Price');
-            // finally let's delete this ticket
-            // (which should not be blocked at this point b/c we've removed all our relationships)
-            $ticket_to_remove->delete_permanently();
-        }
-        return [$datetime, $saved_tickets];
-    }
-
-
-    /**
-     * This attaches a list of given prices to a ticket.
-     * Note we dont' have to worry about ever removing relationships (or archiving prices)
-     * because if there is a change in price information on a ticket, a new ticket is created anyways
-     * so the archived ticket will retain the old price info and prices are automatically "archived" via the ticket.
-     *
-     * @access  private
-     * @param array     $prices_data Array of prices from the form.
-     * @param EE_Ticket $ticket      EE_Ticket object that prices are being attached to.
-     * @param bool      $new_prices  Whether attach existing incoming prices or create new ones.
-     * @return  void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _add_prices_to_ticket(array $prices_data, EE_Ticket $ticket, bool $new_prices = false)
-    {
-        $timezone = $ticket->get_timezone();
-        foreach ($prices_data as $row => $price_data) {
-            $price_values = [
-                'PRC_ID'         => ! empty($price_data['PRC_ID']) ? $price_data['PRC_ID'] : null,
-                'PRT_ID'         => ! empty($price_data['PRT_ID']) ? $price_data['PRT_ID'] : null,
-                'PRC_amount'     => ! empty($price_data['PRC_amount']) ? $price_data['PRC_amount'] : 0,
-                'PRC_name'       => ! empty($price_data['PRC_name']) ? $price_data['PRC_name'] : '',
-                'PRC_desc'       => ! empty($price_data['PRC_desc']) ? $price_data['PRC_desc'] : '',
-                'PRC_is_default' => 0, // make sure prices are NOT set as default from this context
-                'PRC_order'      => $row,
-            ];
-            if ($new_prices || empty($price_values['PRC_ID'])) {
-                $price_values['PRC_ID'] = 0;
-                $price                  = EE_Price::new_instance($price_values, $timezone);
-            } else {
-                $price = EEM_Price::instance($timezone)->get_one_by_ID($price_data['PRC_ID']);
-                // update this price with new values
-                foreach ($price_values as $field => $new_price) {
-                    $price->set($field, $new_price);
-                }
-            }
-            if (! $price instanceof EE_Price) {
-                throw new RuntimeException(
-                    sprintf(
-                        esc_html__(
-                            'Something went wrong! A valid Price could not be generated or retrieved using the supplied data: %1$s',
-                            'event_espresso'
-                        ),
-                        print_r($price_values, true)
-                    )
-                );
-            }
-            $price->save();
-            $ticket->_add_relation_to($price, 'Price');
-        }
-    }
-
-
-    /**
-     * Add in our autosave ajax handlers
-     *
-     */
-    protected function _ee_autosave_create_new()
-    {
-    }
-
-
-    /**
-     * More autosave handlers.
-     */
-    protected function _ee_autosave_edit()
-    {
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _generate_publish_box_extra_content()
-    {
-        // load formatter helper
-        // args for getting related registrations
-        $approved_query_args        = [
-            [
-                'REG_deleted' => 0,
-                'STS_ID'      => EEM_Registration::status_id_approved,
-            ],
-        ];
-        $not_approved_query_args    = [
-            [
-                'REG_deleted' => 0,
-                'STS_ID'      => EEM_Registration::status_id_not_approved,
-            ],
-        ];
-        $pending_payment_query_args = [
-            [
-                'REG_deleted' => 0,
-                'STS_ID'      => EEM_Registration::status_id_pending_payment,
-            ],
-        ];
-        // publish box
-        $publish_box_extra_args = [
-            'view_approved_reg_url'        => add_query_arg(
-                [
-                    'action'      => 'default',
-                    'event_id'    => $this->_cpt_model_obj->ID(),
-                    '_reg_status' => EEM_Registration::status_id_approved,
-                    'use_filters' => true,
-                ],
-                REG_ADMIN_URL
-            ),
-            'view_not_approved_reg_url'    => add_query_arg(
-                [
-                    'action'      => 'default',
-                    'event_id'    => $this->_cpt_model_obj->ID(),
-                    '_reg_status' => EEM_Registration::status_id_not_approved,
-                    'use_filters' => true,
-                ],
-                REG_ADMIN_URL
-            ),
-            'view_pending_payment_reg_url' => add_query_arg(
-                [
-                    'action'      => 'default',
-                    'event_id'    => $this->_cpt_model_obj->ID(),
-                    '_reg_status' => EEM_Registration::status_id_pending_payment,
-                    'use_filters' => true,
-                ],
-                REG_ADMIN_URL
-            ),
-            'approved_regs'                => $this->_cpt_model_obj->count_related(
-                'Registration',
-                $approved_query_args
-            ),
-            'not_approved_regs'            => $this->_cpt_model_obj->count_related(
-                'Registration',
-                $not_approved_query_args
-            ),
-            'pending_payment_regs'         => $this->_cpt_model_obj->count_related(
-                'Registration',
-                $pending_payment_query_args
-            ),
-            'misc_pub_section_class'       => apply_filters(
-                'FHEE_Events_Admin_Page___generate_publish_box_extra_content__misc_pub_section_class',
-                'misc-pub-section'
-            ),
-        ];
-        ob_start();
-        do_action(
-            'AHEE__Events_Admin_Page___generate_publish_box_extra_content__event_editor_overview_add',
-            $this->_cpt_model_obj
-        );
-        $publish_box_extra_args['event_editor_overview_add'] = ob_get_clean();
-        // load template
-        EEH_Template::display_template(
-            EVENTS_TEMPLATE_PATH . 'event_publish_box_extras.template.php',
-            $publish_box_extra_args
-        );
-    }
-
-
-    /**
-     * @return EE_Event
-     */
-    public function get_event_object()
-    {
-        return $this->_cpt_model_obj;
-    }
-
-
-
-
-    /** METABOXES * */
-    /**
-     * _register_event_editor_meta_boxes
-     * add all metaboxes related to the event_editor
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _register_event_editor_meta_boxes()
-    {
-        $this->verify_cpt_object();
-        $use_advanced_editor = $this->admin_config->useAdvancedEditor();
-        // check if the new EDTR reg options meta box is being used, and if so, don't load the legacy version
-        if (! $use_advanced_editor || ! $this->feature->allowed('use_reg_options_meta_box')) {
-            $this->addMetaBox(
-                'espresso_event_editor_event_options',
-                esc_html__('Event Registration Options', 'event_espresso'),
-                [$this, 'registration_options_meta_box'],
-                $this->page_slug,
-                'side'
-            );
-        }
-        if (! $use_advanced_editor) {
-            $this->addMetaBox(
-                'espresso_event_editor_tickets',
-                esc_html__('Event Datetime & Ticket', 'event_espresso'),
-                [$this, 'ticket_metabox'],
-                $this->page_slug,
-                'normal',
-                'high'
-            );
-        } elseif ($this->feature->allowed('use_reg_options_meta_box')) {
-            add_action(
-                'add_meta_boxes_espresso_events',
-                function () {
-                    global $current_screen;
-                    remove_meta_box('authordiv', $current_screen, 'normal');
-                },
-                99
-            );
-        }
-        // NOTE: if you're looking for other metaboxes in here,
-        // where a metabox has a related management page in the admin
-        // you will find it setup in the related management page's "_Hooks" file.
-        // i.e. messages metabox is found in "espresso_events_Messages_Hooks.class.php".
-    }
-
-
-    /**
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function ticket_metabox()
-    {
-        $existing_datetime_ids = $existing_ticket_ids = [];
-        // defaults for template args
-        $template_args = [
-            'ticket_rows'       => '',
-            'total_ticket_rows' => 1,
-            'trash_icon'        => 'dashicons dashicons-lock',
-            'disabled'          => '',
-        ];
-        $event_id      = is_object($this->_cpt_model_obj) ? $this->_cpt_model_obj->ID() : null;
-        /**
-         * 1. Start with retrieving Datetimes
-         * 2. Fore each datetime get related tickets
-         * 3. For each ticket get related prices
-         */
-        /** @var EEM_Datetime $datetime_model */
-        $datetime_model = EE_Registry::instance()->load_model('Datetime');
-        /** @var EEM_Ticket $datetime_model */
-        $ticket_model = EE_Registry::instance()->load_model('Ticket');
-        $times        = $datetime_model->get_all_event_dates($event_id);
-        /** @type EE_Datetime $first_datetime */
-        $first_datetime = reset($times);
-        // do we get related tickets?
-        if (
-            $first_datetime instanceof EE_Datetime
-            && $first_datetime->ID() !== 0
-        ) {
-            $existing_datetime_ids[] = $first_datetime->get('DTT_ID');
-            $template_args['time']   = $first_datetime;
-            $related_tickets         = $first_datetime->tickets(
-                [
-                    ['OR' => ['TKT_deleted' => 1, 'TKT_deleted*' => 0]],
-                    'default_where_conditions' => 'none',
-                ]
-            );
-            if (! empty($related_tickets)) {
-                $template_args['total_ticket_rows'] = count($related_tickets);
-                $row                                = 0;
-                foreach ($related_tickets as $ticket) {
-                    $existing_ticket_ids[]        = $ticket->get('TKT_ID');
-                    $template_args['ticket_rows'] .= $this->_get_ticket_row($ticket, false, $row);
-                    $row++;
-                }
-            } else {
-                $template_args['total_ticket_rows'] = 1;
-                /** @type EE_Ticket $ticket */
-                $ticket                       = $ticket_model->create_default_object();
-                $template_args['ticket_rows'] .= $this->_get_ticket_row($ticket);
-            }
-        } else {
-            $template_args['time'] = $times[0];
-            /** @type EE_Ticket[] $tickets */
-            $tickets                      = $ticket_model->get_all_default_tickets();
-            $template_args['ticket_rows'] .= $this->_get_ticket_row($tickets[1]);
-            // NOTE: we're just sending the first default row
-            // (decaf can't manage default tickets so this should be sufficient);
-        }
-        $template_args['event_datetime_help_link'] = $this->_get_help_tab_link(
-            'event_editor_event_datetimes_help_tab'
-        );
-        $template_args['ticket_options_help_link'] = $this->_get_help_tab_link('ticket_options_info');
-        $template_args['existing_datetime_ids']    = implode(',', $existing_datetime_ids);
-        $template_args['existing_ticket_ids']      = implode(',', $existing_ticket_ids);
-        $template_args['ticket_js_structure']      = $this->_get_ticket_row(
-            $ticket_model->create_default_object(),
-            true
-        );
-        $template                                  = apply_filters(
-            'FHEE__Events_Admin_Page__ticket_metabox__template',
-            EVENTS_TEMPLATE_PATH . 'event_tickets_metabox_main.template.php'
-        );
-        EEH_Template::display_template($template, $template_args);
-    }
-
-
-    /**
-     * Setup an individual ticket form for the decaf event editor page
-     *
-     * @access private
-     * @param EE_Ticket $ticket   the ticket object
-     * @param boolean   $skeleton whether we're generating a skeleton for js manipulation
-     * @param int       $row
-     * @return string generated html for the ticket row.
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _get_ticket_row(EE_Ticket $ticket, bool $skeleton = false, int $row = 0): string
-    {
-        $template_args = [
-            'tkt_status_class'    => ' tkt-status-' . $ticket->ticket_status(),
-            'tkt_archive_class'   => $ticket->ticket_status() === EE_Ticket::archived && ! $skeleton ? ' tkt-archived'
-                : '',
-            'ticketrow'           => $skeleton ? 'TICKETNUM' : $row,
-            'TKT_ID'              => $ticket->get('TKT_ID'),
-            'TKT_name'            => $ticket->get('TKT_name'),
-            'TKT_start_date'      => $skeleton ? '' : $ticket->get_date('TKT_start_date', 'Y-m-d h:i a'),
-            'TKT_end_date'        => $skeleton ? '' : $ticket->get_date('TKT_end_date', 'Y-m-d h:i a'),
-            'TKT_is_default'      => $ticket->get('TKT_is_default'),
-            'TKT_qty'             => $ticket->get_pretty('TKT_qty', 'input'),
-            'edit_ticketrow_name' => $skeleton ? 'TICKETNAMEATTR' : 'edit_tickets',
-            'TKT_sold'            => $skeleton ? 0 : $ticket->get('TKT_sold'),
-            'trash_icon'          => ($skeleton || (! empty($ticket) && ! $ticket->get('TKT_deleted')))
-                                     && (! empty($ticket) && $ticket->get('TKT_sold') === 0)
-                ? 'trash-icon dashicons dashicons-post-trash clickable' : 'dashicons dashicons-lock',
-            'disabled'            => $skeleton || (! empty($ticket) && ! $ticket->get('TKT_deleted')) ? ''
-                : ' disabled=disabled',
-        ];
-        $price         = $ticket->ID() !== 0
-            ? $ticket->get_first_related('Price', ['default_where_conditions' => 'none'])
-            : null;
-        $price         = $price instanceof EE_Price
-            ? $price
-            : EEM_Price::instance()->create_default_object();
-        $price_args    = [
-            'price_currency_symbol' => EE_Registry::instance()->CFG->currency->sign,
-            'PRC_amount'            => $price->get('PRC_amount'),
-            'PRT_ID'                => $price->get('PRT_ID'),
-            'PRC_ID'                => $price->get('PRC_ID'),
-            'PRC_is_default'        => $price->get('PRC_is_default'),
-        ];
-        // make sure we have default start and end dates if skeleton
-        // handle rows that should NOT be empty
-        if (empty($template_args['TKT_start_date'])) {
-            // if empty then the start date will be now.
-            $template_args['TKT_start_date'] = date('Y-m-d h:i a', current_time('timestamp'));
-        }
-        if (empty($template_args['TKT_end_date'])) {
-            // get the earliest datetime (if present);
-            $earliest_datetime             = $this->_cpt_model_obj->ID() > 0
-                ? $this->_cpt_model_obj->get_first_related(
-                    'Datetime',
-                    ['order_by' => ['DTT_EVT_start' => 'ASC']]
-                )
-                : null;
-            $template_args['TKT_end_date'] = $earliest_datetime instanceof EE_Datetime
-                ? $earliest_datetime->get_datetime('DTT_EVT_start', 'Y-m-d', 'h:i a')
-                : date('Y-m-d h:i a', mktime(0, 0, 0, date('m'), date('d') + 7, date('Y')));
-        }
-        $template_args = array_merge($template_args, $price_args);
-        $template      = apply_filters(
-            'FHEE__Events_Admin_Page__get_ticket_row__template',
-            EVENTS_TEMPLATE_PATH . 'event_tickets_metabox_ticket_row.template.php',
-            $ticket
-        );
-        return EEH_Template::display_template($template, $template_args, true);
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function registration_options_meta_box()
-    {
-        $yes_no_values             = [
-            ['id' => true, 'text' => esc_html__('Yes', 'event_espresso')],
-            ['id' => false, 'text' => esc_html__('No', 'event_espresso')],
-        ];
-        $default_reg_status_values = EEM_Registration::reg_status_array(
-            [
-                EEM_Registration::status_id_cancelled,
-                EEM_Registration::status_id_declined,
-                EEM_Registration::status_id_incomplete,
-            ],
-            true
-        );
-        // $template_args['is_active_select'] = EEH_Form_Fields::select_input('is_active', $yes_no_values, $this->_cpt_model_obj->is_active());
-        $template_args['_event']                          = $this->_cpt_model_obj;
-        $template_args['event']                           = $this->_cpt_model_obj;
-        $template_args['active_status']                   = $this->_cpt_model_obj->pretty_active_status(false);
-        $template_args['additional_limit']                = $this->_cpt_model_obj->additional_limit();
-        $template_args['default_registration_status']     = EEH_Form_Fields::select_input(
-            'default_reg_status',
-            $default_reg_status_values,
-            $this->_cpt_model_obj->default_registration_status()
-        );
-        $template_args['display_description']             = EEH_Form_Fields::select_input(
-            'display_desc',
-            $yes_no_values,
-            $this->_cpt_model_obj->display_description()
-        );
-        $template_args['display_ticket_selector']         = EEH_Form_Fields::select_input(
-            'display_ticket_selector',
-            $yes_no_values,
-            $this->_cpt_model_obj->display_ticket_selector(),
-            '',
-            '',
-            false
-        );
-        $template_args['additional_registration_options'] = apply_filters(
-            'FHEE__Events_Admin_Page__registration_options_meta_box__additional_registration_options',
-            '',
-            $template_args,
-            $yes_no_values,
-            $default_reg_status_values
-        );
-        EEH_Template::display_template(
-            EVENTS_TEMPLATE_PATH . 'event_registration_options.template.php',
-            $template_args
-        );
-    }
-
-
-    /**
-     * _get_events()
-     * This method simply returns all the events (for the given _view and paging)
-     *
-     * @access public
-     * @param int  $per_page     count of items per page (20 default);
-     * @param int  $current_page what is the current page being viewed.
-     * @param bool $count        if TRUE then we just return a count of ALL events matching the given _view.
-     *                           If FALSE then we return an array of event objects
-     *                           that match the given _view and paging parameters.
-     * @return array|int         an array of event objects or a count of them.
-     * @throws Exception
-     */
-    public function get_events(int $per_page = 10, int $current_page = 1, bool $count = false)
-    {
-        $EEM_Event   = $this->_event_model();
-        $offset      = ($current_page - 1) * $per_page;
-        $limit       = $count ? null : $offset . ',' . $per_page;
-        $orderby     = $this->request->getRequestParam('orderby', 'EVT_ID');
-        $order       = $this->request->getRequestParam('order', 'DESC');
-        $month_range = $this->request->getRequestParam('month_range');
-        if ($month_range) {
-            $pieces = explode(' ', $month_range, 3);
-            // simulate the FIRST day of the month, that fixes issues for months like February
-            // where PHP doesn't know what to assume for date.
-            // @see https://events.codebasehq.com/projects/event-espresso/tickets/10437
-            $month_r = ! empty($pieces[0]) ? date('m', EEH_DTT_Helper::first_of_month_timestamp($pieces[0])) : '';
-            $year_r  = ! empty($pieces[1]) ? $pieces[1] : '';
-        }
-        $where  = [];
-        $status = $this->request->getRequestParam('status');
-        // determine what post_status our condition will have for the query.
-        switch ($status) {
-            case 'month':
-            case 'today':
-            case null:
-            case 'all':
-                break;
-            case 'draft':
-                $where['status'] = ['IN', ['draft', 'auto-draft']];
-                break;
-            default:
-                $where['status'] = $status;
-        }
-        // categories? The default for all categories is -1
-        $category = $this->request->getRequestParam('EVT_CAT', -1, DataType::INT);
-        if ($category !== -1) {
-            $where['Term_Taxonomy.taxonomy'] = EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY;
-            $where['Term_Taxonomy.term_id']  = $category;
-        }
-        // date where conditions
-        $start_formats = EEM_Datetime::instance()->get_formats_for('DTT_EVT_start');
-        if ($month_range) {
-            $DateTime = new DateTime(
-                $year_r . '-' . $month_r . '-01 00:00:00',
-                new DateTimeZone('UTC')
-            );
-            $start    = $DateTime->getTimestamp();
-            // set the datetime to be the end of the month
-            $DateTime->setDate(
-                $year_r,
-                $month_r,
-                $DateTime->format('t')
-            )->setTime(23, 59, 59);
-            $end                             = $DateTime->getTimestamp();
-            $where['Datetime.DTT_EVT_start'] = ['BETWEEN', [$start, $end]];
-        } elseif ($status === 'today') {
-            $DateTime                        =
-                new DateTime('now', new DateTimeZone(EEM_Event::instance()->get_timezone()));
-            $start                           = $DateTime->setTime(0, 0)->format(implode(' ', $start_formats));
-            $end                             = $DateTime->setTime(23, 59, 59)->format(implode(' ', $start_formats));
-            $where['Datetime.DTT_EVT_start'] = ['BETWEEN', [$start, $end]];
-        } elseif ($status === 'month') {
-            $now                             = date('Y-m-01');
-            $DateTime                        =
-                new DateTime($now, new DateTimeZone(EEM_Event::instance()->get_timezone()));
-            $start                           = $DateTime->setTime(0, 0)->format(implode(' ', $start_formats));
-            $end                             = $DateTime->setDate(date('Y'), date('m'), $DateTime->format('t'))
-                                                        ->setTime(23, 59, 59)
-                                                        ->format(implode(' ', $start_formats));
-            $where['Datetime.DTT_EVT_start'] = ['BETWEEN', [$start, $end]];
-        }
-        if (! EE_Registry::instance()->CAP->current_user_can('ee_read_others_events', 'get_events')) {
-            $where['EVT_wp_user'] = get_current_user_id();
-        } else {
-            if (! isset($where['status'])) {
-                if (! EE_Registry::instance()->CAP->current_user_can('ee_read_private_events', 'get_events')) {
-                    $where['OR'] = [
-                        'status*restrict_private' => ['!=', 'private'],
-                        'AND'                     => [
-                            'status*inclusive' => ['=', 'private'],
-                            'EVT_wp_user'      => get_current_user_id(),
-                        ],
-                    ];
-                }
-            }
-        }
-        $wp_user = $this->request->getRequestParam('EVT_wp_user', 0, DataType::INT);
-        if (
-            $wp_user
-            && $wp_user !== get_current_user_id()
-            && EE_Registry::instance()->CAP->current_user_can('ee_read_others_events', 'get_events')
-        ) {
-            $where['EVT_wp_user'] = $wp_user;
-        }
-        // search query handling
-        $search_term = $this->request->getRequestParam('s');
-        if ($search_term) {
-            $search_term = '%' . $search_term . '%';
-            $where['OR'] = [
-                'EVT_name'       => ['LIKE', $search_term],
-                'EVT_desc'       => ['LIKE', $search_term],
-                'EVT_short_desc' => ['LIKE', $search_term],
-            ];
-        }
-        // filter events by venue.
-        $venue = $this->request->getRequestParam('venue', 0, DataType::INT);
-        if ($venue) {
-            $where['Venue.VNU_ID'] = $venue;
-        }
-        $request_params = $this->request->requestParams();
-        $where          = apply_filters('FHEE__Events_Admin_Page__get_events__where', $where, $request_params);
-        $query_params   = apply_filters(
-            'FHEE__Events_Admin_Page__get_events__query_params',
-            [
-                $where,
-                'limit'    => $limit,
-                'order_by' => $orderby,
-                'order'    => $order,
-                'group_by' => 'EVT_ID',
-            ],
-            $request_params
-        );
-
-        // let's first check if we have special requests coming in.
-        $active_status = $this->request->getRequestParam('active_status');
-        if ($active_status) {
-            switch ($active_status) {
-                case 'upcoming':
-                    return $EEM_Event->get_upcoming_events($query_params, $count);
-                case 'expired':
-                    return $EEM_Event->get_expired_events($query_params, $count);
-                case 'active':
-                    return $EEM_Event->get_active_events($query_params, $count);
-                case 'inactive':
-                    return $EEM_Event->get_inactive_events($query_params, $count);
-            }
-        }
-
-        return $count ? $EEM_Event->count([$where], 'EVT_ID', true) : $EEM_Event->get_all($query_params);
-    }
-
-
-    /**
-     * handling for WordPress CPT actions (trash, restore, delete)
-     *
-     * @param string $post_id
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function trash_cpt_item($post_id)
-    {
-        $this->request->setRequestParam('EVT_ID', $post_id);
-        $this->_trash_or_restore_event('trash', false);
-    }
-
-
-    /**
-     * @param string $post_id
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function restore_cpt_item($post_id)
-    {
-        $this->request->setRequestParam('EVT_ID', $post_id);
-        $this->_trash_or_restore_event('draft', false);
-    }
-
-
-    /**
-     * @param string $post_id
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    public function delete_cpt_item($post_id)
-    {
-        throw new EE_Error(
-            esc_html__(
-                'Please contact Event Espresso support with the details of the steps taken to produce this error.',
-                'event_espresso'
-            )
-        );
-        // $this->request->setRequestParam('EVT_ID', $post_id);
-        // $this->_delete_event();
-    }
-
-
-    /**
-     * _trash_or_restore_event
-     *
-     * @access protected
-     * @param string $event_status
-     * @param bool   $redirect_after
-     * @throws EE_Error
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _trash_or_restore_event(string $event_status = 'trash', bool $redirect_after = true)
-    {
-        // determine the event id and set to array.
-        $EVT_ID = $this->request->getRequestParam('EVT_ID', 0, DataType::INT);
-        // loop thru events
-        if ($EVT_ID) {
-            // clean status
-            $event_status = sanitize_key($event_status);
-            // grab status
-            if (! empty($event_status)) {
-                $success = $this->_change_event_status($EVT_ID, $event_status);
-            } else {
-                $success = false;
-                $msg     = esc_html__(
-                    'An error occurred. The event could not be moved to the trash because a valid event status was not not supplied.',
-                    'event_espresso'
-                );
-                EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            }
-        } else {
-            $success = false;
-            $msg     = esc_html__(
-                'An error occurred. The event could not be moved to the trash because a valid event ID was not not supplied.',
-                'event_espresso'
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-        }
-        $action = $event_status === 'trash' ? 'moved to the trash' : 'restored from the trash';
-        if ($redirect_after) {
-            $this->_redirect_after_action($success, 'Event', $action, ['action' => 'default']);
-        }
-    }
-
-
-    /**
-     * _trash_or_restore_events
-     *
-     * @access protected
-     * @param string $event_status
-     * @return void
-     * @throws EE_Error
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _trash_or_restore_events(string $event_status = 'trash')
-    {
-        // clean status
-        $event_status = sanitize_key($event_status);
-        // grab status
-        if (! empty($event_status)) {
-            $success = true;
-            // determine the event id and set to array.
-            $EVT_IDs = $this->request->getRequestParam('EVT_IDs', [], 'int', true);
-            // loop thru events
-            foreach ($EVT_IDs as $EVT_ID) {
-                if ($EVT_ID = absint($EVT_ID)) {
-                    $results = $this->_change_event_status($EVT_ID, $event_status);
-                    $success = $results !== false ? $success : false;
-                } else {
-                    $msg = sprintf(
-                        esc_html__(
-                            'An error occurred. Event #%d could not be moved to the trash because a valid event ID was not not supplied.',
-                            'event_espresso'
-                        ),
-                        $EVT_ID
-                    );
-                    EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-                    $success = false;
-                }
-            }
-        } else {
-            $success = false;
-            $msg     = esc_html__(
-                'An error occurred. The event could not be moved to the trash because a valid event status was not not supplied.',
-                'event_espresso'
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-        }
-        // in order to force a pluralized result message we need to send back a success status greater than 1
-        $success = $success ? 2 : false;
-        $action  = $event_status === 'trash' ? 'moved to the trash' : 'restored from the trash';
-        $this->_redirect_after_action($success, 'Events', $action, ['action' => 'default']);
-    }
-
-
-    /**
-     * @param int    $EVT_ID
-     * @param string $event_status
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _change_event_status(int $EVT_ID = 0, string $event_status = ''): bool
-    {
-        // grab event id
-        if (! $EVT_ID) {
-            $msg = esc_html__(
-                'An error occurred. No Event ID or an invalid Event ID was received.',
-                'event_espresso'
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        $this->_cpt_model_obj = EEM_Event::instance()->get_one_by_ID($EVT_ID);
-        // clean status
-        $event_status = sanitize_key($event_status);
-        // grab status
-        if (empty($event_status)) {
-            $msg = esc_html__(
-                'An error occurred. No Event Status or an invalid Event Status was received.',
-                'event_espresso'
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        // was event trashed or restored ?
-        switch ($event_status) {
-            case 'draft':
-                $action = 'restored from the trash';
-                $hook   = 'AHEE_event_restored_from_trash';
-                break;
-            case 'trash':
-                $action = 'moved to the trash';
-                $hook   = 'AHEE_event_moved_to_trash';
-                break;
-            default:
-                $action = 'updated';
-                $hook   = false;
-        }
-        // use class to change status
-        $this->_cpt_model_obj->set_status($event_status);
-        $success = $this->_cpt_model_obj->save();
-        if (! $success) {
-            $msg = sprintf(esc_html__('An error occurred. The event could not be %s.', 'event_espresso'), $action);
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        if ($hook) {
-            do_action($hook);
-            // fake the action hook in EE_Soft_Delete_Base_Class::delete_or_restore()
-            // because events side step that and it otherwise won't get called
-            do_action(
-                'AHEE__EE_Soft_Delete_Base_Class__delete_or_restore__after',
-                $this->_cpt_model_obj,
-                $hook === 'AHEE_event_moved_to_trash',
-                $success
-            );
-        }
-        return true;
-    }
-
-
-    /**
-     * @param array $event_ids
-     * @return array
-     * @since   4.10.23.p
-     */
-    private function cleanEventIds(array $event_ids): array
-    {
-        return array_map('absint', $event_ids);
-    }
-
-
-    /**
-     * @return array
-     * @since   4.10.23.p
-     */
-    private function getEventIdsFromRequest(): array
-    {
-        if ($this->request->requestParamIsSet('EVT_IDs')) {
-            return $this->request->getRequestParam('EVT_IDs', [], 'int', true);
-        } else {
-            return $this->request->getRequestParam('EVT_ID', [], 'int', true);
-        }
-    }
-
-
-    /**
-     * @param bool $preview_delete
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _delete_event(bool $preview_delete = true)
-    {
-        $this->_delete_events($preview_delete);
-    }
-
-
-    /**
-     * Gets the tree traversal batch persister.
-     *
-     * @return NodeGroupDao
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @since 4.10.12.p
-     */
-    protected function getModelObjNodeGroupPersister(): NodeGroupDao
-    {
-        if (! $this->model_obj_node_group_persister instanceof NodeGroupDao) {
-            $this->model_obj_node_group_persister =
-                $this->getLoader()->load('\EventEspresso\core\services\orm\tree_traversal\NodeGroupDao');
-        }
-        return $this->model_obj_node_group_persister;
-    }
-
-
-    /**
-     * @param bool $preview_delete
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _delete_events(bool $preview_delete = true)
-    {
-        $event_ids = $this->getEventIdsFromRequest();
-        if ($preview_delete) {
-            $this->generateDeletionPreview($event_ids);
-        } else {
-            foreach ($event_ids as $event_id) {
-                $event = EEM_Event::instance()->get_one_by_ID($event_id);
-                if ($event instanceof EE_Event) {
-                    $event->delete_permanently();
-                }
-            }
-        }
-    }
-
-
-    /**
-     * @param array $event_ids
-     */
-    protected function generateDeletionPreview(array $event_ids)
-    {
-        $event_ids = $this->cleanEventIds($event_ids);
-        // Set a code we can use to reference this deletion task in the batch jobs and preview page.
-        $deletion_job_code = $this->getModelObjNodeGroupPersister()->generateGroupCode();
-        $return_url        = EE_Admin_Page::add_query_args_and_nonce(
-            [
-                'action'            => 'preview_deletion',
-                'deletion_job_code' => $deletion_job_code,
-            ],
-            $this->_admin_base_url
-        );
-        EEH_URL::safeRedirectAndExit(
-            EE_Admin_Page::add_query_args_and_nonce(
-                [
-                    'page'              => EED_Batch::PAGE_SLUG,
-                    'batch'             => EED_Batch::batch_job,
-                    'EVT_IDs'           => $event_ids,
-                    'deletion_job_code' => $deletion_job_code,
-                    'job_handler'       => urlencode('EventEspressoBatchRequest\JobHandlers\PreviewEventDeletion'),
-                    'return_url'        => urlencode($return_url),
-                ],
-                admin_url()
-            )
-        );
-    }
-
-
-    /**
-     * Checks for a POST submission
-     *
-     * @since 4.10.12.p
-     */
-    protected function confirmDeletion()
-    {
-        $deletion_redirect_logic = $this->getLoader()->getShared(
-            'EventEspresso\core\domain\services\admin\events\data\ConfirmDeletion'
-        );
-        $deletion_redirect_logic->handle($this->get_request_data(), $this->admin_base_url());
-    }
-
-
-    /**
-     * A page for users to preview what exactly will be deleted, and confirm they want to delete it.
-     *
-     * @throws EE_Error
-     * @since 4.10.12.p
-     */
-    protected function previewDeletion()
-    {
-        $preview_deletion_logic = $this->getLoader()->getShared(
-            'EventEspresso\core\domain\services\admin\events\data\PreviewDeletion'
-        );
-        $this->set_template_args($preview_deletion_logic->handle($this->get_request_data(), $this->admin_base_url()));
-        $this->display_admin_page_with_no_sidebar();
-    }
-
-
-    /**
-     * get total number of events
-     *
-     * @access public
-     * @return int
-     * @throws EE_Error
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function total_events(): int
-    {
-        return EEM_Event::instance()->count(
-            ['caps' => 'read_admin'],
-            'EVT_ID',
-            true
-        );
-    }
-
-
-    /**
-     * get total number of draft events
-     *
-     * @access public
-     * @return int
-     * @throws EE_Error
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function total_events_draft(): int
-    {
-        return EEM_Event::instance()->count(
-            [
-                ['status' => ['IN', ['draft', 'auto-draft']]],
-                'caps' => 'read_admin',
-            ],
-            'EVT_ID',
-            true
-        );
-    }
-
-
-    /**
-     * get total number of trashed events
-     *
-     * @access public
-     * @return int
-     * @throws EE_Error
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function total_trashed_events(): int
-    {
-        return EEM_Event::instance()->count(
-            [
-                ['status' => 'trash'],
-                'caps' => 'read_admin',
-            ],
-            'EVT_ID',
-            true
-        );
-    }
-
-
-    /**
-     *    _default_event_settings
-     *    This generates the Default Settings Tab
-     *
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _default_event_settings()
-    {
-        $this->_set_add_edit_form_tags('update_default_event_settings');
-        $this->_set_publish_post_box_vars();
-        $this->_template_args['admin_page_content'] = EEH_HTML::div(
-            $this->_default_event_settings_form()->get_html(),
-            '',
-            'padding'
-        );
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    /**
-     * Return the form for event settings.
-     *
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     */
-    protected function _default_event_settings_form(): EE_Form_Section_Proper
-    {
-        $registration_config              = EE_Registry::instance()->CFG->registration;
-        $registration_stati_for_selection = EEM_Registration::reg_status_array(
-        // exclude
-            [
-                EEM_Registration::status_id_cancelled,
-                EEM_Registration::status_id_declined,
-                EEM_Registration::status_id_incomplete,
-                EEM_Registration::status_id_wait_list,
-            ],
-            true
-        );
-        // setup Advanced Editor ???
-        if (
-            $this->raw_req_action === 'default_event_settings'
-            || $this->raw_req_action === 'update_default_event_settings'
-        ) {
-            $this->advanced_editor_admin_form = $this->loader->getShared(AdvancedEditorAdminFormSection::class);
-        }
-        return new EE_Form_Section_Proper(
-            [
-                'name'            => 'update_default_event_settings',
-                'html_id'         => 'update_default_event_settings',
-                'html_class'      => 'form-table',
-                'layout_strategy' => new EE_Admin_Two_Column_Layout(),
-                'subsections'     => apply_filters(
-                    'FHEE__Events_Admin_Page___default_event_settings_form__form_subsections',
-                    [
-                        'defaults_section_header' => new EE_Form_Section_HTML(
-                            EEH_HTML::h2(
-                                esc_html__('Default Settings', 'event_espresso'),
-                                '',
-                                'ee-admin-settings-hdr'
-                            )
-                        ),
-                        'default_reg_status'      => new EE_Select_Input(
-                            $registration_stati_for_selection,
-                            [
-                                'default'         => isset($registration_config->default_STS_ID)
-                                                     && array_key_exists(
-                                                         $registration_config->default_STS_ID,
-                                                         $registration_stati_for_selection
-                                                     )
-                                    ? sanitize_text_field($registration_config->default_STS_ID)
-                                    : EEM_Registration::status_id_pending_payment,
-                                'html_label_text' => esc_html__('Default Registration Status', 'event_espresso')
-                                                     . EEH_Template::get_help_tab_link(
-                                                         'default_settings_status_help_tab'
-                                                     ),
-                                'html_help_text'  => esc_html__(
-                                    'This setting allows you to preselect what the default registration status setting is when creating an event.  Note that changing this setting does NOT retroactively apply it to existing events.',
-                                    'event_espresso'
-                                ),
-                            ]
-                        ),
-                        'default_max_tickets'     => new EE_Integer_Input(
-                            [
-                                'default'         => $registration_config->default_maximum_number_of_tickets
-                                                     ?? EEM_Event::get_default_additional_limit(),
-                                'html_label_text' => esc_html__(
-                                    'Default Maximum Tickets Allowed Per Order:',
-                                    'event_espresso'
-                                )
-                                                     . EEH_Template::get_help_tab_link(
-                                                         'default_maximum_tickets_help_tab"'
-                                                     ),
-                                'html_help_text'  => esc_html__(
-                                    'This setting allows you to indicate what will be the default for the maximum number of tickets per order when creating new events.',
-                                    'event_espresso'
-                                ),
-                            ]
-                        ),
-                    ]
-                ),
-            ]
-        );
-    }
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _update_default_event_settings()
-    {
-        $form = $this->_default_event_settings_form();
-        if ($form->was_submitted()) {
-            $form->receive_form_submission();
-            if ($form->is_valid()) {
-                $registration_config = EE_Registry::instance()->CFG->registration;
-                $valid_data          = $form->valid_data();
-                if (isset($valid_data['default_reg_status'])) {
-                    $registration_config->default_STS_ID = $valid_data['default_reg_status'];
-                }
-                if (isset($valid_data['default_max_tickets'])) {
-                    $registration_config->default_maximum_number_of_tickets = $valid_data['default_max_tickets'];
-                }
-                do_action(
-                    'AHEE__Events_Admin_Page___update_default_event_settings',
-                    $valid_data,
-                    EE_Registry::instance()->CFG,
-                    $this
-                );
-                // update because data was valid!
-                EE_Registry::instance()->CFG->update_espresso_config();
-                EE_Error::overwrite_success();
-                EE_Error::add_success(
-                    esc_html__('Default Event Settings were updated', 'event_espresso')
-                );
-            }
-        }
-        $this->_redirect_after_action(0, '', '', ['action' => 'default_event_settings'], true);
-    }
-
-
-    /*************        Templates        *************
-     *
-     * @throws EE_Error
-     */
-    protected function _template_settings()
-    {
-        $this->_admin_page_title              = esc_html__('Template Settings (Preview)', 'event_espresso');
-        $this->_template_args['preview_img']  = '<img src="'
-                                                . EVENTS_ASSETS_URL
-                                                . '/images/'
-                                                . 'caffeinated_template_features.jpg" alt="'
-                                                . esc_attr__('Template Settings Preview screenshot', 'event_espresso')
-                                                . '" />';
-        $this->_template_args['preview_text'] = '<strong>'
-                                                . esc_html__(
-                                                    'Template Settings is a feature that is only available in the premium version of Event Espresso 4 which is available with a support license purchase on EventEspresso.com. Template Settings allow you to configure some of the appearance options for both the Event List and Event Details pages.',
-                                                    'event_espresso'
-                                                ) . '</strong>';
-        $this->display_admin_caf_preview_page('template_settings_tab');
-    }
-
-
-    /** Event Category Stuff **/
-    /**
-     * set the _category property with the category object for the loaded page.
-     *
-     * @access private
-     * @return void
-     */
-    private function _set_category_object()
-    {
-        if (isset($this->_category->id) && ! empty($this->_category->id)) {
-            return;
-        } //already have the category object so get out.
-        // set default category object
-        $this->_set_empty_category_object();
-        // only set if we've got an id
-        $category_ID = $this->request->getRequestParam('EVT_CAT_ID', 0, DataType::INT);
-        if (! $category_ID) {
-            return;
-        }
-        $term = get_term($category_ID, EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY);
-        if (! empty($term)) {
-            $this->_category->category_name       = $term->name;
-            $this->_category->category_identifier = $term->slug;
-            $this->_category->category_desc       = $term->description;
-            $this->_category->id                  = $term->term_id;
-            $this->_category->parent              = $term->parent;
-        }
-    }
-
-
-    /**
-     * Clears out category properties.
-     */
-    private function _set_empty_category_object()
-    {
-        $this->_category                = new stdClass();
-        $this->_category->category_name = $this->_category->category_identifier = $this->_category->category_desc = '';
-        $this->_category->id            = $this->_category->parent = 0;
-    }
-
-
-    /**
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _category_list_table()
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $this->_search_btn_label = esc_html__('Categories', 'event_espresso');
-        $this->_admin_page_title .= ' ';
-        $this->_admin_page_title .= $this->get_action_link_or_button(
-            'add_category',
-            'add_category',
-            [],
-            'add-new-h2'
-        );
-        $this->display_admin_list_table_page_with_sidebar();
-    }
-
-
-    /**
-     * Output category details view.
-     *
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    protected function _category_details($view)
-    {
-        $route = $view === 'edit' ? 'update_category' : 'insert_category';
-        $this->_set_add_edit_form_tags($route);
-        $this->_set_category_object();
-        $id            = ! empty($this->_category->id) ? $this->_category->id : '';
-        $delete_action = 'delete_category';
-        // custom redirect
-        $redirect = EE_Admin_Page::add_query_args_and_nonce(
-            ['action' => 'category_list'],
-            $this->_admin_base_url
-        );
-        $this->_set_publish_post_box_vars('EVT_CAT_ID', $id, $delete_action, $redirect, true);
-        // take care of contents
-        $this->_template_args['admin_page_content'] = $this->_category_details_content();
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    /**
-     * Output category details content.
-     *
-     * @throws DomainException
-     */
-    protected function _category_details_content(): string
-    {
-        $editor_args['category_desc'] = [
-            'type'          => 'wp_editor',
-            'value'         => EEH_Formatter::admin_format_content($this->_category->category_desc),
-            'class'         => 'my_editor_custom',
-            'wpeditor_args' => ['media_buttons' => false],
-        ];
-        $_wp_editor                   = $this->_generate_admin_form_fields($editor_args, 'array');
-        $all_terms                    = get_terms(
-            [EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY],
-            ['hide_empty' => 0, 'exclude' => [$this->_category->id]]
-        );
-        // setup category select for term parents.
-        $category_select_values[] = [
-            'text' => esc_html__('No Parent', 'event_espresso'),
-            'id'   => 0,
-        ];
-        foreach ($all_terms as $term) {
-            $category_select_values[] = [
-                'text' => $term->name,
-                'id'   => $term->term_id,
-            ];
-        }
-        $category_select = EEH_Form_Fields::select_input(
-            'category_parent',
-            $category_select_values,
-            $this->_category->parent
-        );
-        $template_args   = [
-            'category'                 => $this->_category,
-            'category_select'          => $category_select,
-            'unique_id_info_help_link' => $this->_get_help_tab_link('unique_id_info'),
-            'category_desc_editor'     => $_wp_editor['category_desc']['field'],
-            'disable'                  => '',
-            'disabled_message'         => false,
-        ];
-        $template        = EVENTS_TEMPLATE_PATH . 'event_category_details.template.php';
-        return EEH_Template::display_template($template, $template_args, true);
-    }
-
-
-    /**
-     * Handles deleting categories.
-     *
-     * @throws EE_Error
-     */
-    protected function _delete_categories()
-    {
-        $category_IDs = $this->request->getRequestParam('EVT_CAT_ID', 0, 'int', true);
-        foreach ($category_IDs as $category_ID) {
-            $this->_delete_category($category_ID);
-        }
-        // doesn't matter what page we're coming from... we're going to the same place after delete.
-        $query_args = [
-            'action' => 'category_list',
-        ];
-        $this->_redirect_after_action(0, '', '', $query_args);
-    }
-
-
-    /**
-     * Handles deleting specific category.
-     *
-     * @param int $cat_id
-     */
-    protected function _delete_category(int $cat_id)
-    {
-        $cat_id = absint($cat_id);
-        wp_delete_term($cat_id, EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY);
-    }
-
-
-    /**
-     * Handles triggering the update or insertion of a new category.
-     *
-     * @param bool $new_category true means we're triggering the insert of a new category.
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    protected function _insert_or_update_category(bool $new_category)
-    {
-        $cat_id  = $this->_insert_category($new_category);
-        $success = 0; // we already have a success message so lets not send another.
-        if ($cat_id) {
-            $query_args = [
-                'action'     => 'edit_category',
-                'EVT_CAT_ID' => $cat_id,
-            ];
-        } else {
-            $query_args = ['action' => 'add_category'];
-        }
-        $this->_redirect_after_action($success, '', '', $query_args, true);
-    }
-
-
-    /**
-     * Inserts or updates category
-     *
-     * @param bool $new_category (true indicates we're updating a category).
-     * @return bool|mixed|string
-     */
-    private function _insert_category(bool $new_category)
-    {
-        $category_ID         = $this->request->getRequestParam('EVT_CAT_ID', 0, DataType::INT);
-        $category_name       = $this->request->getRequestParam('category_name', '');
-        $category_desc       = $this->request->getRequestParam('category_desc', '', DataType::HTML);
-        $category_parent     = $this->request->getRequestParam('category_parent', 0, DataType::INT);
-        $category_identifier = $this->request->getRequestParam('category_identifier', '');
-
-        if (empty($category_name)) {
-            $msg = esc_html__('You must add a name for the category.', 'event_espresso');
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return 0;
-        }
-        $term_args = [
-            'name'        => $category_name,
-            'description' => $category_desc,
-            'parent'      => $category_parent,
-        ];
-        // was the category_identifier input disabled?
-        if ($category_identifier) {
-            $term_args['slug'] = $category_identifier;
-        }
-        $insert_ids = $new_category
-            ? wp_insert_term($category_name, EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY, $term_args)
-            : wp_update_term($category_ID, EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY, $term_args);
-
-        if ($insert_ids instanceof WP_Error) {
-            EE_Error::add_error($insert_ids->get_error_message(), __FILE__, __FUNCTION__, __LINE__);
-            return 0;
-        }
-        $category_ID = $insert_ids['term_id'] ?? 0;
-        if (! $category_ID) {
-            EE_Error::add_error(
-                esc_html__(
-                    'An error occurred and the category has not been saved to the database.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return 0;
-        }
-        EE_Error::add_success(
-            sprintf(
-                esc_html__('The category %s was successfully saved', 'event_espresso'),
-                $category_name
-            )
-        );
-        return $category_ID;
-    }
-
-
-    /**
-     * Gets categories or count of categories matching the arguments in the request.
-     *
-     * @param int  $per_page
-     * @param int  $current_page
-     * @param bool $count
-     * @return EE_Term_Taxonomy[]|int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_categories(int $per_page = 10, int $current_page = 1, bool $count = false)
-    {
-        // testing term stuff
-        $orderby     = $this->request->getRequestParam('orderby', 'Term.term_id');
-        $order       = $this->request->getRequestParam('order', 'DESC');
-        $limit       = ($current_page - 1) * $per_page;
-        $where       = ['taxonomy' => EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY];
-        $search_term = $this->request->getRequestParam('s');
-        if ($search_term) {
-            $search_term = '%' . $search_term . '%';
-            $where['OR'] = [
-                'Term.name'   => ['LIKE', $search_term],
-                'description' => ['LIKE', $search_term],
-            ];
-        }
-        $query_params = [
-            $where,
-            'order_by'   => [$orderby => $order],
-            'limit'      => $limit . ',' . $per_page,
-            'force_join' => ['Term'],
-        ];
-        return $count
-            ? EEM_Term_Taxonomy::instance()->count($query_params, 'term_id')
-            : EEM_Term_Taxonomy::instance()->get_all($query_params);
-    }
-
-    /* end category stuff */
-
-
-    /**************/
-
-
-    /**
-     * Callback for the `ee_save_timezone_setting` ajax action.
-     *
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function saveTimezoneString()
-    {
-        $timezone_string = $this->request->getRequestParam('timezone_selected');
-        if (empty($timezone_string) || ! EEH_DTT_Helper::validate_timezone($timezone_string, false)) {
-            EE_Error::add_error(
-                esc_html__('An invalid timezone string submitted.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $this->_template_args['error'] = true;
-            $this->_return_json();
-        }
-
-        update_option('timezone_string', $timezone_string);
-        EE_Error::add_success(
-            esc_html__('Your timezone string was updated.', 'event_espresso')
-        );
-        $this->_template_args['success'] = true;
-        $this->_return_json(true, ['action' => 'create_new']);
-    }
-
-
-    /**
      * @throws EE_Error
-     * @deprecated 4.10.25.p
      */
-    public function save_timezonestring_setting()
-    {
-        $this->saveTimezoneString();
-    }
+	protected function _template_settings()
+	{
+		$this->_admin_page_title              = esc_html__('Template Settings (Preview)', 'event_espresso');
+		$this->_template_args['preview_img']  = '<img src="'
+												. EVENTS_ASSETS_URL
+												. '/images/'
+												. 'caffeinated_template_features.jpg" alt="'
+												. esc_attr__('Template Settings Preview screenshot', 'event_espresso')
+												. '" />';
+		$this->_template_args['preview_text'] = '<strong>'
+												. esc_html__(
+													'Template Settings is a feature that is only available in the premium version of Event Espresso 4 which is available with a support license purchase on EventEspresso.com. Template Settings allow you to configure some of the appearance options for both the Event List and Event Details pages.',
+													'event_espresso'
+												) . '</strong>';
+		$this->display_admin_caf_preview_page('template_settings_tab');
+	}
+
+
+	/** Event Category Stuff **/
+	/**
+	 * set the _category property with the category object for the loaded page.
+	 *
+	 * @access private
+	 * @return void
+	 */
+	private function _set_category_object()
+	{
+		if (isset($this->_category->id) && ! empty($this->_category->id)) {
+			return;
+		} //already have the category object so get out.
+		// set default category object
+		$this->_set_empty_category_object();
+		// only set if we've got an id
+		$category_ID = $this->request->getRequestParam('EVT_CAT_ID', 0, DataType::INT);
+		if (! $category_ID) {
+			return;
+		}
+		$term = get_term($category_ID, EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY);
+		if (! empty($term)) {
+			$this->_category->category_name       = $term->name;
+			$this->_category->category_identifier = $term->slug;
+			$this->_category->category_desc       = $term->description;
+			$this->_category->id                  = $term->term_id;
+			$this->_category->parent              = $term->parent;
+		}
+	}
+
+
+	/**
+	 * Clears out category properties.
+	 */
+	private function _set_empty_category_object()
+	{
+		$this->_category                = new stdClass();
+		$this->_category->category_name = $this->_category->category_identifier = $this->_category->category_desc = '';
+		$this->_category->id            = $this->_category->parent = 0;
+	}
+
+
+	/**
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _category_list_table()
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$this->_search_btn_label = esc_html__('Categories', 'event_espresso');
+		$this->_admin_page_title .= ' ';
+		$this->_admin_page_title .= $this->get_action_link_or_button(
+			'add_category',
+			'add_category',
+			[],
+			'add-new-h2'
+		);
+		$this->display_admin_list_table_page_with_sidebar();
+	}
+
+
+	/**
+	 * Output category details view.
+	 *
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	protected function _category_details($view)
+	{
+		$route = $view === 'edit' ? 'update_category' : 'insert_category';
+		$this->_set_add_edit_form_tags($route);
+		$this->_set_category_object();
+		$id            = ! empty($this->_category->id) ? $this->_category->id : '';
+		$delete_action = 'delete_category';
+		// custom redirect
+		$redirect = EE_Admin_Page::add_query_args_and_nonce(
+			['action' => 'category_list'],
+			$this->_admin_base_url
+		);
+		$this->_set_publish_post_box_vars('EVT_CAT_ID', $id, $delete_action, $redirect, true);
+		// take care of contents
+		$this->_template_args['admin_page_content'] = $this->_category_details_content();
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	/**
+	 * Output category details content.
+	 *
+	 * @throws DomainException
+	 */
+	protected function _category_details_content(): string
+	{
+		$editor_args['category_desc'] = [
+			'type'          => 'wp_editor',
+			'value'         => EEH_Formatter::admin_format_content($this->_category->category_desc),
+			'class'         => 'my_editor_custom',
+			'wpeditor_args' => ['media_buttons' => false],
+		];
+		$_wp_editor                   = $this->_generate_admin_form_fields($editor_args, 'array');
+		$all_terms                    = get_terms(
+			[EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY],
+			['hide_empty' => 0, 'exclude' => [$this->_category->id]]
+		);
+		// setup category select for term parents.
+		$category_select_values[] = [
+			'text' => esc_html__('No Parent', 'event_espresso'),
+			'id'   => 0,
+		];
+		foreach ($all_terms as $term) {
+			$category_select_values[] = [
+				'text' => $term->name,
+				'id'   => $term->term_id,
+			];
+		}
+		$category_select = EEH_Form_Fields::select_input(
+			'category_parent',
+			$category_select_values,
+			$this->_category->parent
+		);
+		$template_args   = [
+			'category'                 => $this->_category,
+			'category_select'          => $category_select,
+			'unique_id_info_help_link' => $this->_get_help_tab_link('unique_id_info'),
+			'category_desc_editor'     => $_wp_editor['category_desc']['field'],
+			'disable'                  => '',
+			'disabled_message'         => false,
+		];
+		$template        = EVENTS_TEMPLATE_PATH . 'event_category_details.template.php';
+		return EEH_Template::display_template($template, $template_args, true);
+	}
+
+
+	/**
+	 * Handles deleting categories.
+	 *
+	 * @throws EE_Error
+	 */
+	protected function _delete_categories()
+	{
+		$category_IDs = $this->request->getRequestParam('EVT_CAT_ID', 0, 'int', true);
+		foreach ($category_IDs as $category_ID) {
+			$this->_delete_category($category_ID);
+		}
+		// doesn't matter what page we're coming from... we're going to the same place after delete.
+		$query_args = [
+			'action' => 'category_list',
+		];
+		$this->_redirect_after_action(0, '', '', $query_args);
+	}
+
+
+	/**
+	 * Handles deleting specific category.
+	 *
+	 * @param int $cat_id
+	 */
+	protected function _delete_category(int $cat_id)
+	{
+		$cat_id = absint($cat_id);
+		wp_delete_term($cat_id, EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY);
+	}
+
+
+	/**
+	 * Handles triggering the update or insertion of a new category.
+	 *
+	 * @param bool $new_category true means we're triggering the insert of a new category.
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	protected function _insert_or_update_category(bool $new_category)
+	{
+		$cat_id  = $this->_insert_category($new_category);
+		$success = 0; // we already have a success message so lets not send another.
+		if ($cat_id) {
+			$query_args = [
+				'action'     => 'edit_category',
+				'EVT_CAT_ID' => $cat_id,
+			];
+		} else {
+			$query_args = ['action' => 'add_category'];
+		}
+		$this->_redirect_after_action($success, '', '', $query_args, true);
+	}
+
+
+	/**
+	 * Inserts or updates category
+	 *
+	 * @param bool $new_category (true indicates we're updating a category).
+	 * @return bool|mixed|string
+	 */
+	private function _insert_category(bool $new_category)
+	{
+		$category_ID         = $this->request->getRequestParam('EVT_CAT_ID', 0, DataType::INT);
+		$category_name       = $this->request->getRequestParam('category_name', '');
+		$category_desc       = $this->request->getRequestParam('category_desc', '', DataType::HTML);
+		$category_parent     = $this->request->getRequestParam('category_parent', 0, DataType::INT);
+		$category_identifier = $this->request->getRequestParam('category_identifier', '');
+
+		if (empty($category_name)) {
+			$msg = esc_html__('You must add a name for the category.', 'event_espresso');
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return 0;
+		}
+		$term_args = [
+			'name'        => $category_name,
+			'description' => $category_desc,
+			'parent'      => $category_parent,
+		];
+		// was the category_identifier input disabled?
+		if ($category_identifier) {
+			$term_args['slug'] = $category_identifier;
+		}
+		$insert_ids = $new_category
+			? wp_insert_term($category_name, EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY, $term_args)
+			: wp_update_term($category_ID, EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY, $term_args);
+
+		if ($insert_ids instanceof WP_Error) {
+			EE_Error::add_error($insert_ids->get_error_message(), __FILE__, __FUNCTION__, __LINE__);
+			return 0;
+		}
+		$category_ID = $insert_ids['term_id'] ?? 0;
+		if (! $category_ID) {
+			EE_Error::add_error(
+				esc_html__(
+					'An error occurred and the category has not been saved to the database.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return 0;
+		}
+		EE_Error::add_success(
+			sprintf(
+				esc_html__('The category %s was successfully saved', 'event_espresso'),
+				$category_name
+			)
+		);
+		return $category_ID;
+	}
+
+
+	/**
+	 * Gets categories or count of categories matching the arguments in the request.
+	 *
+	 * @param int  $per_page
+	 * @param int  $current_page
+	 * @param bool $count
+	 * @return EE_Term_Taxonomy[]|int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_categories(int $per_page = 10, int $current_page = 1, bool $count = false)
+	{
+		// testing term stuff
+		$orderby     = $this->request->getRequestParam('orderby', 'Term.term_id');
+		$order       = $this->request->getRequestParam('order', 'DESC');
+		$limit       = ($current_page - 1) * $per_page;
+		$where       = ['taxonomy' => EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY];
+		$search_term = $this->request->getRequestParam('s');
+		if ($search_term) {
+			$search_term = '%' . $search_term . '%';
+			$where['OR'] = [
+				'Term.name'   => ['LIKE', $search_term],
+				'description' => ['LIKE', $search_term],
+			];
+		}
+		$query_params = [
+			$where,
+			'order_by'   => [$orderby => $order],
+			'limit'      => $limit . ',' . $per_page,
+			'force_join' => ['Term'],
+		];
+		return $count
+			? EEM_Term_Taxonomy::instance()->count($query_params, 'term_id')
+			: EEM_Term_Taxonomy::instance()->get_all($query_params);
+	}
+
+	/* end category stuff */
+
+
+	/**************/
+
+
+	/**
+	 * Callback for the `ee_save_timezone_setting` ajax action.
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function saveTimezoneString()
+	{
+		$timezone_string = $this->request->getRequestParam('timezone_selected');
+		if (empty($timezone_string) || ! EEH_DTT_Helper::validate_timezone($timezone_string, false)) {
+			EE_Error::add_error(
+				esc_html__('An invalid timezone string submitted.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$this->_template_args['error'] = true;
+			$this->_return_json();
+		}
+
+		update_option('timezone_string', $timezone_string);
+		EE_Error::add_success(
+			esc_html__('Your timezone string was updated.', 'event_espresso')
+		);
+		$this->_template_args['success'] = true;
+		$this->_return_json(true, ['action' => 'create_new']);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @deprecated 4.10.25.p
+	 */
+	public function save_timezonestring_setting()
+	{
+		$this->saveTimezoneString();
+	}
 }

espresso.php

Indentation +93 added lines, -93 removed lines

@@ -37,120 +37,120 @@
  * @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="http://php.net/downloads.php">http://php.net/downloads.php</a>'
-                    );
-                    ?>
+					printf(
+						esc_html__(
+							'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
+							'event_espresso'
+						),
+						EE_MIN_PHP_VER_REQUIRED,
+						PHP_VERSION,
+						'<br/>',
+						'<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>'
+					);
+					?>
                 </p>
             </div>
             <?php
-            espresso_deactivate_plugin(plugin_basename(__FILE__));
-        }
+			espresso_deactivate_plugin(plugin_basename(__FILE__));
+		}
 
-        add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
-    } else {
-        define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
+		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/wp-graphql/wp-graphql/wp-graphql.php';
+		require_once __DIR__ . '/vendor/autoload.php';
+		require_once __DIR__ . '/vendor/wp-graphql/wp-graphql/wp-graphql.php';
 
-        /**
-         * espresso_version
-         * Returns the plugin version
-         *
-         * @return string
-         */
-        function espresso_version()
-        {
-            return apply_filters('FHEE__espresso__espresso_version', '5.0.0.rc.015');
-        }
+		/**
+		 * espresso_version
+		 * Returns the plugin version
+		 *
+		 * @return string
+		 */
+		function espresso_version()
+		{
+			return apply_filters('FHEE__espresso__espresso_version', '5.0.0.rc.015');
+		}
 
-        /**
-         * 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);
-            // Run WP GraphQL activation callback
-            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);
+			// Run WP GraphQL activation callback
+			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
-            graphql_deactivation_callback();
-        }
-        register_deactivation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_deactivation');
+		/**
+		 * espresso_plugin_deactivation
+		 */
+		function espresso_plugin_deactivation()
+		{
+			// Run WP GraphQL deactivation callback
+			graphql_deactivation_callback();
+		}
+		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($plugin_basename = '')
-    {
-        if (! function_exists('deactivate_plugins')) {
-            require_once ABSPATH . 'wp-admin/includes/plugin.php';
-        }
-        unset($_GET['activate'], $_REQUEST['activate']);
-        deactivate_plugins($plugin_basename);
-    }
+	/**
+	 *    deactivate_plugin
+	 * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
+	 *
+	 * @access public
+	 * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
+	 * @return    void
+	 */
+	function espresso_deactivate_plugin($plugin_basename = '')
+	{
+		if (! function_exists('deactivate_plugins')) {
+			require_once ABSPATH . 'wp-admin/includes/plugin.php';
+		}
+		unset($_GET['activate'], $_REQUEST['activate']);
+		deactivate_plugins($plugin_basename);
+	}
 }

core/domain/services/registration/form/v1/RegistrantForm.php

Indentation +193 added lines, -193 removed lines

@@ -17,197 +17,197 @@
 
 class RegistrantForm extends EE_Form_Section_Proper
 {
-    /**
-     * @var EE_SPCO_Reg_Step_Attendee_Information
-     */
-    public $reg_step;
-
-    /**
-     * @var EEM_Event_Question_Group
-     */
-    public $event_question_group_model;
-
-    /**
-     * @var bool
-     */
-    private $has_questions = false;
-
-
-    /**
-     * RegistrantForm constructor.
-     *
-     * @param EE_Registration          $registration
-     * @param bool                     $copy_attendee_info
-     * @param callable                 $enablePrintCopyInfo
-     * @param EE_SPCO_Reg_Step_Attendee_Information $reg_step
-     * @param EEM_Event_Question_Group $event_question_group_model
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function __construct(
-        EE_Registration $registration,
-        bool $copy_attendee_info,
-        callable $enablePrintCopyInfo,
-        EE_SPCO_Reg_Step_Attendee_Information $reg_step,
-        EEM_Event_Question_Group $event_question_group_model
-    ) {
-        $this->reg_step = $reg_step;
-        $this->event_question_group_model = $event_question_group_model;
-        parent::__construct(
-            $this->generateFormArgs($registration, $copy_attendee_info, $enablePrintCopyInfo)
-        );
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function hasQuestions(): bool
-    {
-        return $this->has_questions;
-    }
-
-
-    /**
-     * @param EE_Registration $registration
-     * @param bool            $copy_attendee_info
-     * @param callable        $enablePrintCopyInfo
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function generateFormArgs(
-        EE_Registration $registration,
-        bool $copy_attendee_info,
-        callable $enablePrintCopyInfo
-    ): array {
-        static $attendee_nmbr = 1;
-        $form_args = [];
-        // verify that registration has valid event
-        if ($registration->event() instanceof EE_Event) {
-            $field_name      = 'Event_Question_Group.' . $this->event_question_group_model->fieldNameForContext(
-                $registration->is_primary_registrant()
-            );
-            $question_groups = $registration->event()->question_groups(
-                apply_filters(
-                    'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegistrantForm__generateFormArgs__question_groups_query_parameters',
-                    [
-                        [
-                            'Event.EVT_ID' => $registration->event()->ID(),
-                            $field_name    => true,
-                            'QSG_deleted'  => false,
-                        ],
-                        'order_by' => ['QSG_order' => 'ASC'],
-                    ],
-                    $registration,
-                    $this
-                )
-            );
-            if ($question_groups) {
-                // array of params to pass to parent constructor
-                $form_args = [
-                    'html_id'         => 'ee-registration-' . $registration->reg_url_link(),
-                    'html_class'      => 'ee-reg-form-attendee-dv',
-                    'html_style'      => $this->reg_step->checkout->admin_request
-                        ? 'padding:0em 2em 1em; margin:3em 0 0; border:1px solid #ddd;'
-                        : '',
-                    'subsections'     => [],
-                    'layout_strategy' => new EE_Fieldset_Section_Layout(
-                        [
-                            'legend_class' => 'spco-attendee-lgnd',
-                            'legend_text'  => sprintf(
-                                esc_html_x(
-                                    'Attendee %d',
-                                    'Attendee 123',
-                                    'event_espresso'
-                                ),
-                                $attendee_nmbr
-                            ),
-                        ]
-                    ),
-                ];
-                foreach ($question_groups as $question_group) {
-                    if ($question_group instanceof EE_Question_Group) {
-                        $question_group_reg_form = LoaderFactory::getNew(
-                            RegFormQuestionGroup::class,
-                            [$registration, $question_group, $this->reg_step]
-                        );
-                        $form_args['subsections'][ $question_group->identifier() ] = apply_filters(
-                            'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegistrantForm__generateFormArgs__question_group_reg_form',
-                            $question_group_reg_form,
-                            $registration,
-                            $question_group,
-                            $this
-                        );
-                    }
-                }
-                // add hidden input
-                $form_args['subsections']['additional_attendee_reg_info'] = $this->additionalAttendeeRegInfoInput(
-                    $registration
-                );
-
-                // If we have question groups for additional attendees, then display the copy options
-                $printCopyInfo = apply_filters(
-                    'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegistrantForm__generateFormArgs__printCopyInfo',
-                    $attendee_nmbr > 1 && $copy_attendee_info,
-                    $attendee_nmbr,
-                    $registration,
-                    $this
-                );
-                if ($printCopyInfo) {
-                    $enablePrintCopyInfo();
-                }
-
-
-                if ($registration->is_primary_registrant()) {
-                    // generate hidden input
-                    $form_args['subsections']['primary_registrant'] = $this->additionalPrimaryRegistrantInputs(
-                        $registration
-                    );
-                }
-            }
-        }
-        $attendee_nmbr++;
-
-        // Increment the reg forms number if form is valid.
-        if (! empty($form_args)) {
-            $this->has_questions = true;
-        }
-
-        return $form_args;
-    }
-
-
-    /**
-     * @param EE_Registration $registration
-     * @return EE_Form_Input_Base
-     * @throws EE_Error
-     */
-    private function additionalAttendeeRegInfoInput(EE_Registration $registration)
-    {
-        // generate hidden input
-        return new EE_Hidden_Input(
-            [
-                'html_id' => 'additional-attendee-reg-info-' . $registration->reg_url_link(),
-                'default' => true,
-            ]
-        );
-    }
-
-
-    /**
-     * @param EE_Registration $registration
-     * @return    EE_Form_Input_Base
-     * @throws EE_Error
-     */
-    private function additionalPrimaryRegistrantInputs(EE_Registration $registration)
-    {
-        // generate hidden input
-        return new EE_Hidden_Input(
-            [
-                'html_id' => 'primary_registrant',
-                'default' => $registration->reg_url_link(),
-            ]
-        );
-    }
+	/**
+	 * @var EE_SPCO_Reg_Step_Attendee_Information
+	 */
+	public $reg_step;
+
+	/**
+	 * @var EEM_Event_Question_Group
+	 */
+	public $event_question_group_model;
+
+	/**
+	 * @var bool
+	 */
+	private $has_questions = false;
+
+
+	/**
+	 * RegistrantForm constructor.
+	 *
+	 * @param EE_Registration          $registration
+	 * @param bool                     $copy_attendee_info
+	 * @param callable                 $enablePrintCopyInfo
+	 * @param EE_SPCO_Reg_Step_Attendee_Information $reg_step
+	 * @param EEM_Event_Question_Group $event_question_group_model
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function __construct(
+		EE_Registration $registration,
+		bool $copy_attendee_info,
+		callable $enablePrintCopyInfo,
+		EE_SPCO_Reg_Step_Attendee_Information $reg_step,
+		EEM_Event_Question_Group $event_question_group_model
+	) {
+		$this->reg_step = $reg_step;
+		$this->event_question_group_model = $event_question_group_model;
+		parent::__construct(
+			$this->generateFormArgs($registration, $copy_attendee_info, $enablePrintCopyInfo)
+		);
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function hasQuestions(): bool
+	{
+		return $this->has_questions;
+	}
+
+
+	/**
+	 * @param EE_Registration $registration
+	 * @param bool            $copy_attendee_info
+	 * @param callable        $enablePrintCopyInfo
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function generateFormArgs(
+		EE_Registration $registration,
+		bool $copy_attendee_info,
+		callable $enablePrintCopyInfo
+	): array {
+		static $attendee_nmbr = 1;
+		$form_args = [];
+		// verify that registration has valid event
+		if ($registration->event() instanceof EE_Event) {
+			$field_name      = 'Event_Question_Group.' . $this->event_question_group_model->fieldNameForContext(
+				$registration->is_primary_registrant()
+			);
+			$question_groups = $registration->event()->question_groups(
+				apply_filters(
+					'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegistrantForm__generateFormArgs__question_groups_query_parameters',
+					[
+						[
+							'Event.EVT_ID' => $registration->event()->ID(),
+							$field_name    => true,
+							'QSG_deleted'  => false,
+						],
+						'order_by' => ['QSG_order' => 'ASC'],
+					],
+					$registration,
+					$this
+				)
+			);
+			if ($question_groups) {
+				// array of params to pass to parent constructor
+				$form_args = [
+					'html_id'         => 'ee-registration-' . $registration->reg_url_link(),
+					'html_class'      => 'ee-reg-form-attendee-dv',
+					'html_style'      => $this->reg_step->checkout->admin_request
+						? 'padding:0em 2em 1em; margin:3em 0 0; border:1px solid #ddd;'
+						: '',
+					'subsections'     => [],
+					'layout_strategy' => new EE_Fieldset_Section_Layout(
+						[
+							'legend_class' => 'spco-attendee-lgnd',
+							'legend_text'  => sprintf(
+								esc_html_x(
+									'Attendee %d',
+									'Attendee 123',
+									'event_espresso'
+								),
+								$attendee_nmbr
+							),
+						]
+					),
+				];
+				foreach ($question_groups as $question_group) {
+					if ($question_group instanceof EE_Question_Group) {
+						$question_group_reg_form = LoaderFactory::getNew(
+							RegFormQuestionGroup::class,
+							[$registration, $question_group, $this->reg_step]
+						);
+						$form_args['subsections'][ $question_group->identifier() ] = apply_filters(
+							'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegistrantForm__generateFormArgs__question_group_reg_form',
+							$question_group_reg_form,
+							$registration,
+							$question_group,
+							$this
+						);
+					}
+				}
+				// add hidden input
+				$form_args['subsections']['additional_attendee_reg_info'] = $this->additionalAttendeeRegInfoInput(
+					$registration
+				);
+
+				// If we have question groups for additional attendees, then display the copy options
+				$printCopyInfo = apply_filters(
+					'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegistrantForm__generateFormArgs__printCopyInfo',
+					$attendee_nmbr > 1 && $copy_attendee_info,
+					$attendee_nmbr,
+					$registration,
+					$this
+				);
+				if ($printCopyInfo) {
+					$enablePrintCopyInfo();
+				}
+
+
+				if ($registration->is_primary_registrant()) {
+					// generate hidden input
+					$form_args['subsections']['primary_registrant'] = $this->additionalPrimaryRegistrantInputs(
+						$registration
+					);
+				}
+			}
+		}
+		$attendee_nmbr++;
+
+		// Increment the reg forms number if form is valid.
+		if (! empty($form_args)) {
+			$this->has_questions = true;
+		}
+
+		return $form_args;
+	}
+
+
+	/**
+	 * @param EE_Registration $registration
+	 * @return EE_Form_Input_Base
+	 * @throws EE_Error
+	 */
+	private function additionalAttendeeRegInfoInput(EE_Registration $registration)
+	{
+		// generate hidden input
+		return new EE_Hidden_Input(
+			[
+				'html_id' => 'additional-attendee-reg-info-' . $registration->reg_url_link(),
+				'default' => true,
+			]
+		);
+	}
+
+
+	/**
+	 * @param EE_Registration $registration
+	 * @return    EE_Form_Input_Base
+	 * @throws EE_Error
+	 */
+	private function additionalPrimaryRegistrantInputs(EE_Registration $registration)
+	{
+		// generate hidden input
+		return new EE_Hidden_Input(
+			[
+				'html_id' => 'primary_registrant',
+				'default' => $registration->reg_url_link(),
+			]
+		);
+	}
 }

core/libraries/messages/EE_messenger.lib.php

Indentation +765 added lines, -765 removed lines

@@ -16,182 +16,182 @@ 
  */
 abstract class EE_messenger extends EE_Messages_Base
 {
-    /**
-     * This property holds the default message types associated with this messenger when it is activated. The values of the array must match a valid message type.
-     * This property gets set by the _set_default_message_types() method.
-     *
-     * @var array
-     */
-    protected $_default_message_types = array();
+	/**
+	 * This property holds the default message types associated with this messenger when it is activated. The values of the array must match a valid message type.
+	 * This property gets set by the _set_default_message_types() method.
+	 *
+	 * @var array
+	 */
+	protected $_default_message_types = array();
 
 
 
 
-    /**
-     * This property holds the message types that are valid for use with this messenger.
-     * It gets set by the _set_valid_message_types() method.
-     *
-     * @var array
-     */
-    protected $_valid_message_types = array();
+	/**
+	 * This property holds the message types that are valid for use with this messenger.
+	 * It gets set by the _set_valid_message_types() method.
+	 *
+	 * @var array
+	 */
+	protected $_valid_message_types = array();
 
 
 
-    /**
-     * Holds the configuration for the EE_Messages_Validator class to know how to validated the different fields. Note that the Validator will match each field here with the allowed shortcodes set in the "valid_shortcodes" array for the matched message type context.  So message types don't need to set a $_validator_config property.
-     *
-     * Remember, ALL fields must be declared in this array.  However, an empty value for the field means that the field will accept all valid shortcodes set for the given context in the message type (by default).
-     *
-     * Array should be in this format:
-     *
-     * array(
-     *  'field_name(i.e.to)' => array(
-     *      'shortcodes' => array('email'), //an array of shortcode groups (correspond to EE_Shortcodes library class) that are allowed in the field. Typically you can just include $this->_valid_shortcodes['field_name'] as the value here (because they will match).
-     *      'specific_shortcodes' => array( array('[EVENT_AUTHOR_EMAIL]' => esc_html__('Admin Email', 'event_espresso')), //if this index is present you can further restrict the field to ONLY specific shortcodes if an entire group isn't sufficient. Specific shortcodes need to be listed as an array with the index the shortcode and the value = the label.
-     *      'type' => 'email' //this is the field type and should match one of the validator types (see EE_Messages_Validator::validator() for all the possible types).  If not required you can just leave empty.,
-     *      'required' => array'[SHORTCODE]') //this is used to indicate the shortcodes that MUST be in the assembled array of shortcodes by the validator in order for this field to be included in validation.  Otherwise the validator will always assign shortcodes for this field (regardless of whether the field settings for the given messenger/message_type/context use the field or not.).. please note, this does NOT mean that the shortcodes listed here MUST be in the given field.
-     *  )
-     * )
-     *
-     * @var array
-     */
-    protected $_validator_config = array();
+	/**
+	 * Holds the configuration for the EE_Messages_Validator class to know how to validated the different fields. Note that the Validator will match each field here with the allowed shortcodes set in the "valid_shortcodes" array for the matched message type context.  So message types don't need to set a $_validator_config property.
+	 *
+	 * Remember, ALL fields must be declared in this array.  However, an empty value for the field means that the field will accept all valid shortcodes set for the given context in the message type (by default).
+	 *
+	 * Array should be in this format:
+	 *
+	 * array(
+	 *  'field_name(i.e.to)' => array(
+	 *      'shortcodes' => array('email'), //an array of shortcode groups (correspond to EE_Shortcodes library class) that are allowed in the field. Typically you can just include $this->_valid_shortcodes['field_name'] as the value here (because they will match).
+	 *      'specific_shortcodes' => array( array('[EVENT_AUTHOR_EMAIL]' => esc_html__('Admin Email', 'event_espresso')), //if this index is present you can further restrict the field to ONLY specific shortcodes if an entire group isn't sufficient. Specific shortcodes need to be listed as an array with the index the shortcode and the value = the label.
+	 *      'type' => 'email' //this is the field type and should match one of the validator types (see EE_Messages_Validator::validator() for all the possible types).  If not required you can just leave empty.,
+	 *      'required' => array'[SHORTCODE]') //this is used to indicate the shortcodes that MUST be in the assembled array of shortcodes by the validator in order for this field to be included in validation.  Otherwise the validator will always assign shortcodes for this field (regardless of whether the field settings for the given messenger/message_type/context use the field or not.).. please note, this does NOT mean that the shortcodes listed here MUST be in the given field.
+	 *  )
+	 * )
+	 *
+	 * @var array
+	 */
+	protected $_validator_config = array();
 
 
 
-    /**
-     * This will hold the EEM_message_templates model for interacting with the database and retrieving active templates for the messenger
-     * @var object
-     */
-    protected $_EEM_data;
+	/**
+	 * This will hold the EEM_message_templates model for interacting with the database and retrieving active templates for the messenger
+	 * @var object
+	 */
+	protected $_EEM_data;
 
 
 
-    /**
-     * this property just holds an array of the various template refs.
-     * @var array
-     */
-    protected $_template_fields = array();
+	/**
+	 * this property just holds an array of the various template refs.
+	 * @var array
+	 */
+	protected $_template_fields = array();
 
 
 
 
-    /**
-     * This holds an array of the arguments used in parsing a template for the sender.
-     * @var array
-     */
-    protected $_template_args = array();
+	/**
+	 * This holds an array of the arguments used in parsing a template for the sender.
+	 * @var array
+	 */
+	protected $_template_args = array();
 
 
 
 
 
 
-    /**
-     * This property will hold the configuration for any test settings fields that are required for the "test" button that is used to trigger an actual test of this messenger
-     *
-     * @protected
-     * @var array
-     */
-    protected $_test_settings_fields = array();
+	/**
+	 * This property will hold the configuration for any test settings fields that are required for the "test" button that is used to trigger an actual test of this messenger
+	 *
+	 * @protected
+	 * @var array
+	 */
+	protected $_test_settings_fields = array();
 
 
 
 
 
 
-    /**
-     * This will hold the EE_Messages_Template_Pack object when set on the messenger.  This is set via the validate and setup method which grabs the template pack from the incoming messages object.
-     *
-     * @since 4.5.0
-     *
-     * @var EE_Messages_Template_Pack
-     */
-    protected $_tmp_pack;
+	/**
+	 * This will hold the EE_Messages_Template_Pack object when set on the messenger.  This is set via the validate and setup method which grabs the template pack from the incoming messages object.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @var EE_Messages_Template_Pack
+	 */
+	protected $_tmp_pack;
 
 
 
 
-    /**
-     * This will hold the variation to use when performing a send.  It is set via the validate and setup method which grabs the variation from the incoming messages object on the send method.
-     *
-     * @since 4.5.0
-     *
-     * @var string
-     */
-    protected $_variation;
+	/**
+	 * This will hold the variation to use when performing a send.  It is set via the validate and setup method which grabs the variation from the incoming messages object on the send method.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @var string
+	 */
+	protected $_variation;
 
 
 
 
 
-    /**
-     * This property is a stdClass that holds labels for all the various supporting properties for this messenger.  These labels are set via the _set_supports_labels() method in children classes. Initially this will include the label for:
-     *
-     *  - template pack
-     *  - template variation
-     *
-     * @since 4.5.0
-     *
-     * @var stdClass
-     */
-    protected $_supports_labels;
+	/**
+	 * This property is a stdClass that holds labels for all the various supporting properties for this messenger.  These labels are set via the _set_supports_labels() method in children classes. Initially this will include the label for:
+	 *
+	 *  - template pack
+	 *  - template variation
+	 *
+	 * @since 4.5.0
+	 *
+	 * @var stdClass
+	 */
+	protected $_supports_labels;
 
 
 
 
 
-    /**
-     * This property is set when the send_message() method is called and holds the Message Type used to generate templates with this messenger for the messages.
-     *
-     * @var EE_message_type
-     */
-    protected $_incoming_message_type;
+	/**
+	 * This property is set when the send_message() method is called and holds the Message Type used to generate templates with this messenger for the messages.
+	 *
+	 * @var EE_message_type
+	 */
+	protected $_incoming_message_type;
 
 
 
-    /**
-     * This flag sets whether a messenger is activated by default  on installation (or reactivation) of EE core or not.
-     *
-     * @var bool
-     */
-    public $activate_on_install = false;
+	/**
+	 * This flag sets whether a messenger is activated by default  on installation (or reactivation) of EE core or not.
+	 *
+	 * @var bool
+	 */
+	public $activate_on_install = false;
 
 
 
 
 
-    public function __construct()
-    {
-        $this->_EEM_data = EEM_Message_Template_Group::instance();
-        $this->_messages_item_type = 'messenger';
+	public function __construct()
+	{
+		$this->_EEM_data = EEM_Message_Template_Group::instance();
+		$this->_messages_item_type = 'messenger';
 
-        parent::__construct();
+		parent::__construct();
 
-        $this->_set_test_settings_fields();
-        $this->_set_template_fields();
-        $this->_set_default_message_types();
-        $this->_set_valid_message_types();
-        $this->_set_validator_config();
+		$this->_set_test_settings_fields();
+		$this->_set_template_fields();
+		$this->_set_default_message_types();
+		$this->_set_valid_message_types();
+		$this->_set_validator_config();
 
 
-        $this->_supports_labels = new stdClass();
-        $this->_set_supports_labels();
-    }
+		$this->_supports_labels = new stdClass();
+		$this->_set_supports_labels();
+	}
 
 
 
 
 
-    /**
-     * _set_template_fields
-     * This sets up the fields that a messenger requires for the message to go out.
-     *
-     * @abstract
-     * @access  protected
-     * @return void
-     */
-    abstract protected function _set_template_fields();
+	/**
+	 * _set_template_fields
+	 * This sets up the fields that a messenger requires for the message to go out.
+	 *
+	 * @abstract
+	 * @access  protected
+	 * @return void
+	 */
+	abstract protected function _set_template_fields();
 
 
 
@@ -201,14 +201,14 @@ 
 
 
 
-    /**
-     * This method sets the _default_message_type property (see definition in docs attached to property)
-     *
-     * @abstract
-     * @access protected
-     * @return void
-     */
-    abstract protected function _set_default_message_types();
+	/**
+	 * This method sets the _default_message_type property (see definition in docs attached to property)
+	 *
+	 * @abstract
+	 * @access protected
+	 * @return void
+	 */
+	abstract protected function _set_default_message_types();
 
 
 
@@ -216,15 +216,15 @@ 
 
 
 
-    /**
-     * Sets the _valid_message_types property (see definition in cods attached to property)
-     *
-     * @since 4.5.0
-     *
-     * @abstract
-     * @return void
-     */
-    abstract protected function _set_valid_message_types();
+	/**
+	 * Sets the _valid_message_types property (see definition in cods attached to property)
+	 *
+	 * @since 4.5.0
+	 *
+	 * @abstract
+	 * @return void
+	 */
+	abstract protected function _set_valid_message_types();
 
 
 
@@ -232,171 +232,171 @@ 
 
 
 
-    /**
-     * Child classes must declare the $_validator_config property using this method.
-     * See comments for $_validator_config for details on what it is used for.
-     *
-     * NOTE:  messengers should set an array of valid shortcodes for ALL scenarios.  The corresponding validator class (validators/{messenger}) can be used to restrict only certain shortcodes per template so users cannot add certain shortcodes.
-     *
-     * @access protected
-     * @return void
-     */
-    abstract protected function _set_validator_config();
+	/**
+	 * Child classes must declare the $_validator_config property using this method.
+	 * See comments for $_validator_config for details on what it is used for.
+	 *
+	 * NOTE:  messengers should set an array of valid shortcodes for ALL scenarios.  The corresponding validator class (validators/{messenger}) can be used to restrict only certain shortcodes per template so users cannot add certain shortcodes.
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	abstract protected function _set_validator_config();
 
 
 
 
 
 
-    /**
-     * We just deliver the messages don't kill us!!  This method will need to be modified by child classes for whatever action is taken to actually send a message.
-     *
-     * @return bool|WP_Error
-     * @throw \Exception
-     */
-    abstract protected function _send_message();
+	/**
+	 * We just deliver the messages don't kill us!!  This method will need to be modified by child classes for whatever action is taken to actually send a message.
+	 *
+	 * @return bool|WP_Error
+	 * @throw \Exception
+	 */
+	abstract protected function _send_message();
 
 
 
 
-    /**
-     * We give you pretty previews of the messages!
-     * @return string html body for message content.
-     */
-    abstract protected function _preview();
+	/**
+	 * We give you pretty previews of the messages!
+	 * @return string html body for message content.
+	 */
+	abstract protected function _preview();
 
 
 
 
-    /**
-     * Used by messengers (or preview) for enqueueing any scripts or styles need in message generation.
-     *
-     * @since 4.5.0
-     *
-     * @return void
-     */
-    public function enqueue_scripts_styles()
-    {
-        do_action('AHEE__EE_messenger__enqueue_scripts_styles');
-    }
+	/**
+	 * Used by messengers (or preview) for enqueueing any scripts or styles need in message generation.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @return void
+	 */
+	public function enqueue_scripts_styles()
+	{
+		do_action('AHEE__EE_messenger__enqueue_scripts_styles');
+	}
 
 
 
 
 
-    /**
-     * This is used to indicate whether a messenger must be sent immediately or not.
-     * eg. The HTML messenger will override this to return true because it should be displayed in user's browser right
-     * away.  The PDF messenger is similar.
-     *
-     * This flag thus overrides any priorities that may be set on the message type used to generate the message.
-     *
-     * Default for this is false.  So children classes must override this if they want a message to be executed immediately.
-     *
-     * @since  4.9.0
-     * @return bool
-     */
-    public function send_now()
-    {
-        return false;
-    }
+	/**
+	 * This is used to indicate whether a messenger must be sent immediately or not.
+	 * eg. The HTML messenger will override this to return true because it should be displayed in user's browser right
+	 * away.  The PDF messenger is similar.
+	 *
+	 * This flag thus overrides any priorities that may be set on the message type used to generate the message.
+	 *
+	 * Default for this is false.  So children classes must override this if they want a message to be executed immediately.
+	 *
+	 * @since  4.9.0
+	 * @return bool
+	 */
+	public function send_now()
+	{
+		return false;
+	}
 
 
 
 
 
-    /**
-     * This is a way for a messenger to indicate whether it allows an empty to field or not.
-     * Note: If the generated message is a for a preview, this value is ignored.
-     * @since 4.9.0
-     * @return bool
-     */
-    public function allow_empty_to_field()
-    {
-        return false;
-    }
+	/**
+	 * This is a way for a messenger to indicate whether it allows an empty to field or not.
+	 * Note: If the generated message is a for a preview, this value is ignored.
+	 * @since 4.9.0
+	 * @return bool
+	 */
+	public function allow_empty_to_field()
+	{
+		return false;
+	}
 
 
 
 
 
-    /**
-     * Sets the defaults for the _supports_labels property.  Can be overridden by child classes.
-     * @see property definition for info on how its formatted.
-     *
-     * @since 4.5.0;
-     * @return void
-     */
-    protected function _set_supports_labels()
-    {
-        $this->_set_supports_labels_defaults();
-    }
+	/**
+	 * Sets the defaults for the _supports_labels property.  Can be overridden by child classes.
+	 * @see property definition for info on how its formatted.
+	 *
+	 * @since 4.5.0;
+	 * @return void
+	 */
+	protected function _set_supports_labels()
+	{
+		$this->_set_supports_labels_defaults();
+	}
 
 
 
 
 
-    /**
-     * Sets the defaults for the _supports_labels property.
-     *
-     * @since 4.5.0
-     *
-     * @return void
-     */
-    private function _set_supports_labels_defaults()
-    {
-        $this->_supports_labels->template_pack = esc_html__('Template Structure', 'event_espresso');
-        $this->_supports_labels->template_variation = esc_html__('Template Style', 'event_espresso');
-        $this->_supports_labels->template_pack_description = esc_html__('Template Structure options are bundled structural changes for templates.', 'event_espresso');
+	/**
+	 * Sets the defaults for the _supports_labels property.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @return void
+	 */
+	private function _set_supports_labels_defaults()
+	{
+		$this->_supports_labels->template_pack = esc_html__('Template Structure', 'event_espresso');
+		$this->_supports_labels->template_variation = esc_html__('Template Style', 'event_espresso');
+		$this->_supports_labels->template_pack_description = esc_html__('Template Structure options are bundled structural changes for templates.', 'event_espresso');
 
-        $this->_supports_labels->template_variation_description = esc_html__('These are different styles to choose from for the selected template structure.  Usually these affect things like font style, color, borders etc.  In some cases the styles will also make minor layout changes.', 'event_espresso');
+		$this->_supports_labels->template_variation_description = esc_html__('These are different styles to choose from for the selected template structure.  Usually these affect things like font style, color, borders etc.  In some cases the styles will also make minor layout changes.', 'event_espresso');
 
-        $this->_supports_labels = apply_filters('FHEE__EE_messenger___set_supports_labels_defaults___supports_labels', $this->_supports_labels, $this);
-    }
+		$this->_supports_labels = apply_filters('FHEE__EE_messenger___set_supports_labels_defaults___supports_labels', $this->_supports_labels, $this);
+	}
 
 
 
 
 
-    /**
-     * This returns the _supports_labels property.
-     *
-     * @since 4.5.0
-     *
-     * @return stdClass
-     */
-    public function get_supports_labels()
-    {
-        if (empty($this->_supports_labels->template_pack) || empty($this->_supports_labels->template_variation)) {
-            $this->_set_supports_labels_defaults();
-        }
-        return apply_filters('FHEE__EE_messenger__get_supports_labels', $this->_supports_labels, $this);
-    }
+	/**
+	 * This returns the _supports_labels property.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @return stdClass
+	 */
+	public function get_supports_labels()
+	{
+		if (empty($this->_supports_labels->template_pack) || empty($this->_supports_labels->template_variation)) {
+			$this->_set_supports_labels_defaults();
+		}
+		return apply_filters('FHEE__EE_messenger__get_supports_labels', $this->_supports_labels, $this);
+	}
 
 
 
 
-    /**
-     * Used to retrieve a variation (typically the path/url to a css file)
-     *
-     * @since 4.5.0
-     *
-     * @param EE_Messages_Template_Pack $pack   The template pack used for retrieving the variation.
-     * @param string                    $message_type_name The name property of the message type that we need the variation for.
-     * @param bool                      $url   Whether to return url (true) or path (false). Default is false.
-     * @param string                    $type What variation type to return. Default is 'main'.
-     * @param string               $variation What variation for the template pack
-     * @param bool             $skip_filters This allows messengers to add a filter for another messengers get_variation but call skip filters on the callback so there is no recursion on apply_filters.
-     *
-     * @return string                    path or url for the requested variation.
-     */
-    public function get_variation(EE_Messages_Template_Pack $pack, $message_type_name, $url = false, $type = 'main', $variation = 'default', $skip_filters = false)
-    {
-        $this->_tmp_pack = $pack;
-        $variation_path = apply_filters('EE_messenger__get_variation__variation', false, $pack, $this->name, $message_type_name, $url, $type, $variation, $skip_filters);
-        $variation_path = empty($variation_path) ? $this->_tmp_pack->get_variation($this->name, $message_type_name, $type, $variation, $url, '.css', $skip_filters) : $variation_path;
-        return $variation_path;
-    }
+	/**
+	 * Used to retrieve a variation (typically the path/url to a css file)
+	 *
+	 * @since 4.5.0
+	 *
+	 * @param EE_Messages_Template_Pack $pack   The template pack used for retrieving the variation.
+	 * @param string                    $message_type_name The name property of the message type that we need the variation for.
+	 * @param bool                      $url   Whether to return url (true) or path (false). Default is false.
+	 * @param string                    $type What variation type to return. Default is 'main'.
+	 * @param string               $variation What variation for the template pack
+	 * @param bool             $skip_filters This allows messengers to add a filter for another messengers get_variation but call skip filters on the callback so there is no recursion on apply_filters.
+	 *
+	 * @return string                    path or url for the requested variation.
+	 */
+	public function get_variation(EE_Messages_Template_Pack $pack, $message_type_name, $url = false, $type = 'main', $variation = 'default', $skip_filters = false)
+	{
+		$this->_tmp_pack = $pack;
+		$variation_path = apply_filters('EE_messenger__get_variation__variation', false, $pack, $this->name, $message_type_name, $url, $type, $variation, $skip_filters);
+		$variation_path = empty($variation_path) ? $this->_tmp_pack->get_variation($this->name, $message_type_name, $type, $variation, $url, '.css', $skip_filters) : $variation_path;
+		return $variation_path;
+	}
 
 
 
@@ -404,194 +404,194 @@ 
 
 
 
-    /**
-     * This just returns the default message types associated with this messenger when it is first activated.
-     *
-     * @access public
-     * @return array
-     */
-    public function get_default_message_types()
-    {
-        $class = get_class($this);
+	/**
+	 * This just returns the default message types associated with this messenger when it is first activated.
+	 *
+	 * @access public
+	 * @return array
+	 */
+	public function get_default_message_types()
+	{
+		$class = get_class($this);
 
-        // messenger specific filter
-        $default_types = apply_filters('FHEE__' . $class . '__get_default_message_types__default_types', $this->_default_message_types, $this);
+		// messenger specific filter
+		$default_types = apply_filters('FHEE__' . $class . '__get_default_message_types__default_types', $this->_default_message_types, $this);
 
-        // all messengers filter
-        $default_types = apply_filters('FHEE__EE_messenger__get_default_message_types__default_types', $default_types, $this);
-        return $default_types;
-    }
+		// all messengers filter
+		$default_types = apply_filters('FHEE__EE_messenger__get_default_message_types__default_types', $default_types, $this);
+		return $default_types;
+	}
 
 
 
 
-    /**
-     * Returns the valid message types associated with this messenger.
-     *
-     * @since 4.5.0
-     *
-     * @return array
-     */
-    public function get_valid_message_types()
-    {
-        $class = get_class($this);
-
-        // messenger specific filter
-        // messenger specific filter
-        $valid_types = apply_filters('FHEE__' . $class . '__get_valid_message_types__valid_types', $this->_valid_message_types, $this);
-
-        // all messengers filter
-        $valid_types = apply_filters('FHEE__EE_messenger__get_valid_message_types__valid_types', $valid_types, $this);
-        return $valid_types;
-    }
-
-
-
-
-
-    /**
-     * this is just used by the custom validators (EE_Messages_Validator classes) to modify the _validator_config for certain message_type/messenger combos where a context may only use certain shortcodes etc.
-     *
-     * @access public
-     * @param array $new_config Whatever is put in here will reset the _validator_config property
-     */
-    public function set_validator_config($new_config)
-    {
-        $this->_validator_config = $new_config;
-    }
-
-
-
-
-    /**
-     * This returns the _validator_config property
-     *
-     * @access public
-     * @return array
-     */
-    public function get_validator_config()
-    {
-        $class = get_class($this);
-
-        $config = apply_filters('FHEE__' . $class . '__get_validator_config', $this->_validator_config, $this);
-        $config = apply_filters('FHEE__EE_messenger__get_validator_config', $config, $this);
-        return $config;
-    }
-
-
-
-
-    /**
-     * this public method accepts a page slug (for an EE_admin page) and will return the response from the child class callback function if that page is registered via the `_admin_registered_page` property set by the child class.
-     *
-     * @param string $page the slug of the EE admin page
-     * @param array $message_types an array of active message type objects
-     * @param string $action the page action (to allow for more specific handling - i.e. edit vs. add pages)
-     * @param array $extra  This is just an extra argument that can be used to pass additional data for setting up page content.
-     * @access public
-     * @return string content for page
-     */
-    public function get_messenger_admin_page_content($page, $action = null, $extra = array(), $message_types = array())
-    {
-        return $this->_get_admin_page_content($page, $action, $extra, $message_types);
-    }
-
-
-
-    /**
-     * @param $message_types
-     * @param array $extra
-     * @return mixed|string
-     */
-    protected function _get_admin_content_events_edit($message_types, $extra)
-    {
-        // defaults
-        $template_args = array();
-        $selector_rows = '';
-
-        // we don't need message types here so we're just going to ignore. we do, however, expect the event id here. The event id is needed to provide a link to setup a custom template for this event.
-        $event_id = isset($extra['event']) ? $extra['event'] : null;
-
-        $template_wrapper_path = EE_LIBRARIES . 'messages/messenger/admin_templates/event_switcher_wrapper.template.php';
-        $template_row_path = EE_LIBRARIES . 'messages/messenger/admin_templates/event_switcher_row.template.php';
-
-        // array of template objects for global and custom (non-trashed) (but remember just for this messenger!)
-        $global_templates = EEM_Message_Template_Group::instance()->get_all(
-            array( array( 'MTP_messenger' => $this->name, 'MTP_is_global' => true, 'MTP_is_active' => true ) )
-        );
-        $templates_for_event = EEM_Message_Template_Group::instance()->get_all_custom_templates_by_event(
-            $event_id,
-            array(
-                'MTP_messenger' => $this->name,
-                'MTP_is_active' => true
-            )
-        );
-        $templates_for_event = !empty($templates_for_event) ? $templates_for_event : array();
-
-        // so we need to setup the rows for the selectors and we use the global mtpgs (cause those will the active message template groups)
-        foreach ($global_templates as $mtpgID => $mtpg) {
-            if ($mtpg instanceof EE_Message_Template_Group) {
-                // verify this message type is supposed to show on this page
-                $mtp_obj = $mtpg->message_type_obj();
-                if (! $mtp_obj instanceof EE_message_type) {
-                    continue;
-                }
-                $mtp_obj->admin_registered_pages = (array) $mtp_obj->admin_registered_pages;
-                if (! in_array('events_edit', $mtp_obj->admin_registered_pages)) {
-                    continue;
-                }
-                $select_values = array();
-                $select_values[ $mtpgID ] = esc_html__('Global', 'event_espresso');
-                $default_value = array_key_exists($mtpgID, $templates_for_event) && ! $mtpg->get('MTP_is_override') ? $mtpgID : null;
-                // if the override has been set for the global template, then that means even if there are custom templates already created we ignore them because of the set override.
-                if (! $mtpg->get('MTP_is_override')) {
-                    // any custom templates for this message type?
-                    $custom_templates = EEM_Message_Template_Group::instance()->get_custom_message_template_by_m_and_mt($this->name, $mtpg->message_type());
-                    foreach ($custom_templates as $cmtpgID => $cmtpg) {
-                        $select_values[ $cmtpgID ] = $cmtpg->name();
-                        $default_value = array_key_exists($cmtpgID, $templates_for_event) ? $cmtpgID : $default_value;
-                    }
-                }
-                // if there is no $default_value then we set it as the global
-                $default_value = empty($default_value) ? $mtpgID : $default_value;
-                $c_config = $mtpg->contexts_config();
-                $edit_context = key(array_slice($c_config, -1));
-                $edit_url_query_args = [
-                    'page' => 'espresso_messages',
-                    'action' => 'edit_message_template',
-                    'id' => $default_value,
-                    'evt_id' => $event_id,
-                    'context' => $edit_context,
-                ];
-                $edit_url = EEH_URL::add_query_args_and_nonce($edit_url_query_args, admin_url('admin.php'));
-                $create_url_query_args = [
-                    'page' => 'espresso_messages',
-                    'action' => 'add_new_message_template',
-                    'GRP_ID' => $default_value,
-                    'message_type' => $mtpg->message_type(),
-                    'messenger' => $this->name
-                ];
-                $mt_slug = $mtpg->message_type();
-                $create_url = EEH_URL::add_query_args_and_nonce($create_url_query_args, admin_url('admin.php'));
-                $st_args['mtpgID'] = $mtpgID;
-                $st_args['mt_name'] = ucwords($mtp_obj->label['singular']);
-                $st_args['mt_slug'] = $mt_slug;
-                $st_args['messenger_slug'] = $this->name;
-                $st_args['selector'] = EEH_Form_Fields::select_input(
-                    'event_message_templates_relation[' . $mtpgID . ']',
-                    $select_values,
-                    $default_value,
-                    'data-messenger="' . $this->name . '" data-messagetype="' . $mt_slug . '"',
-                    'message-template-selector'
-                );
-                $new_template_name = sprintf(
-                    esc_html__('Custom %1$s', 'event_espresso'),
-                    $st_args['mt_name'] ?? esc_html__('Template', 'event_espresso')
-                );
-                // note that  message template group that has override_all_custom set will remove the ability to set a custom message template based off of the global (and that also in turn overrides any other custom templates).
-                $st_args['create_button'] = $mtpg->get('MTP_is_override')
-                    ? ''
-                    : '
+	/**
+	 * Returns the valid message types associated with this messenger.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @return array
+	 */
+	public function get_valid_message_types()
+	{
+		$class = get_class($this);
+
+		// messenger specific filter
+		// messenger specific filter
+		$valid_types = apply_filters('FHEE__' . $class . '__get_valid_message_types__valid_types', $this->_valid_message_types, $this);
+
+		// all messengers filter
+		$valid_types = apply_filters('FHEE__EE_messenger__get_valid_message_types__valid_types', $valid_types, $this);
+		return $valid_types;
+	}
+
+
+
+
+
+	/**
+	 * this is just used by the custom validators (EE_Messages_Validator classes) to modify the _validator_config for certain message_type/messenger combos where a context may only use certain shortcodes etc.
+	 *
+	 * @access public
+	 * @param array $new_config Whatever is put in here will reset the _validator_config property
+	 */
+	public function set_validator_config($new_config)
+	{
+		$this->_validator_config = $new_config;
+	}
+
+
+
+
+	/**
+	 * This returns the _validator_config property
+	 *
+	 * @access public
+	 * @return array
+	 */
+	public function get_validator_config()
+	{
+		$class = get_class($this);
+
+		$config = apply_filters('FHEE__' . $class . '__get_validator_config', $this->_validator_config, $this);
+		$config = apply_filters('FHEE__EE_messenger__get_validator_config', $config, $this);
+		return $config;
+	}
+
+
+
+
+	/**
+	 * this public method accepts a page slug (for an EE_admin page) and will return the response from the child class callback function if that page is registered via the `_admin_registered_page` property set by the child class.
+	 *
+	 * @param string $page the slug of the EE admin page
+	 * @param array $message_types an array of active message type objects
+	 * @param string $action the page action (to allow for more specific handling - i.e. edit vs. add pages)
+	 * @param array $extra  This is just an extra argument that can be used to pass additional data for setting up page content.
+	 * @access public
+	 * @return string content for page
+	 */
+	public function get_messenger_admin_page_content($page, $action = null, $extra = array(), $message_types = array())
+	{
+		return $this->_get_admin_page_content($page, $action, $extra, $message_types);
+	}
+
+
+
+	/**
+	 * @param $message_types
+	 * @param array $extra
+	 * @return mixed|string
+	 */
+	protected function _get_admin_content_events_edit($message_types, $extra)
+	{
+		// defaults
+		$template_args = array();
+		$selector_rows = '';
+
+		// we don't need message types here so we're just going to ignore. we do, however, expect the event id here. The event id is needed to provide a link to setup a custom template for this event.
+		$event_id = isset($extra['event']) ? $extra['event'] : null;
+
+		$template_wrapper_path = EE_LIBRARIES . 'messages/messenger/admin_templates/event_switcher_wrapper.template.php';
+		$template_row_path = EE_LIBRARIES . 'messages/messenger/admin_templates/event_switcher_row.template.php';
+
+		// array of template objects for global and custom (non-trashed) (but remember just for this messenger!)
+		$global_templates = EEM_Message_Template_Group::instance()->get_all(
+			array( array( 'MTP_messenger' => $this->name, 'MTP_is_global' => true, 'MTP_is_active' => true ) )
+		);
+		$templates_for_event = EEM_Message_Template_Group::instance()->get_all_custom_templates_by_event(
+			$event_id,
+			array(
+				'MTP_messenger' => $this->name,
+				'MTP_is_active' => true
+			)
+		);
+		$templates_for_event = !empty($templates_for_event) ? $templates_for_event : array();
+
+		// so we need to setup the rows for the selectors and we use the global mtpgs (cause those will the active message template groups)
+		foreach ($global_templates as $mtpgID => $mtpg) {
+			if ($mtpg instanceof EE_Message_Template_Group) {
+				// verify this message type is supposed to show on this page
+				$mtp_obj = $mtpg->message_type_obj();
+				if (! $mtp_obj instanceof EE_message_type) {
+					continue;
+				}
+				$mtp_obj->admin_registered_pages = (array) $mtp_obj->admin_registered_pages;
+				if (! in_array('events_edit', $mtp_obj->admin_registered_pages)) {
+					continue;
+				}
+				$select_values = array();
+				$select_values[ $mtpgID ] = esc_html__('Global', 'event_espresso');
+				$default_value = array_key_exists($mtpgID, $templates_for_event) && ! $mtpg->get('MTP_is_override') ? $mtpgID : null;
+				// if the override has been set for the global template, then that means even if there are custom templates already created we ignore them because of the set override.
+				if (! $mtpg->get('MTP_is_override')) {
+					// any custom templates for this message type?
+					$custom_templates = EEM_Message_Template_Group::instance()->get_custom_message_template_by_m_and_mt($this->name, $mtpg->message_type());
+					foreach ($custom_templates as $cmtpgID => $cmtpg) {
+						$select_values[ $cmtpgID ] = $cmtpg->name();
+						$default_value = array_key_exists($cmtpgID, $templates_for_event) ? $cmtpgID : $default_value;
+					}
+				}
+				// if there is no $default_value then we set it as the global
+				$default_value = empty($default_value) ? $mtpgID : $default_value;
+				$c_config = $mtpg->contexts_config();
+				$edit_context = key(array_slice($c_config, -1));
+				$edit_url_query_args = [
+					'page' => 'espresso_messages',
+					'action' => 'edit_message_template',
+					'id' => $default_value,
+					'evt_id' => $event_id,
+					'context' => $edit_context,
+				];
+				$edit_url = EEH_URL::add_query_args_and_nonce($edit_url_query_args, admin_url('admin.php'));
+				$create_url_query_args = [
+					'page' => 'espresso_messages',
+					'action' => 'add_new_message_template',
+					'GRP_ID' => $default_value,
+					'message_type' => $mtpg->message_type(),
+					'messenger' => $this->name
+				];
+				$mt_slug = $mtpg->message_type();
+				$create_url = EEH_URL::add_query_args_and_nonce($create_url_query_args, admin_url('admin.php'));
+				$st_args['mtpgID'] = $mtpgID;
+				$st_args['mt_name'] = ucwords($mtp_obj->label['singular']);
+				$st_args['mt_slug'] = $mt_slug;
+				$st_args['messenger_slug'] = $this->name;
+				$st_args['selector'] = EEH_Form_Fields::select_input(
+					'event_message_templates_relation[' . $mtpgID . ']',
+					$select_values,
+					$default_value,
+					'data-messenger="' . $this->name . '" data-messagetype="' . $mt_slug . '"',
+					'message-template-selector'
+				);
+				$new_template_name = sprintf(
+					esc_html__('Custom %1$s', 'event_espresso'),
+					$st_args['mt_name'] ?? esc_html__('Template', 'event_espresso')
+				);
+				// note that  message template group that has override_all_custom set will remove the ability to set a custom message template based off of the global (and that also in turn overrides any other custom templates).
+				$st_args['create_button'] = $mtpg->get('MTP_is_override')
+					? ''
+					: '
                     <a data-messenger="' . $this->name . '"
                        data-messagetype="' . $mt_slug . '"
                        data-new_template_name="' . $new_template_name . '"
@@ -602,18 +602,18 @@ 
                     >
                         ' . esc_html__('Create New Custom', 'event_espresso') . '
                     </a>';
-                $st_args['create_button'] = EE_Registry::instance()->CAP->current_user_can(
-                    'ee_edit_messages',
-                    'espresso_messages_add_new_message_template'
-                )
-                    ? $st_args['create_button']
-                    : '';
-                $st_args['edit_button']   = EE_Registry::instance()->CAP->current_user_can(
-                    'ee_edit_message',
-                    'espresso_messages_edit_message_template',
-                    $mtpgID
-                )
-                    ? '
+				$st_args['create_button'] = EE_Registry::instance()->CAP->current_user_can(
+					'ee_edit_messages',
+					'espresso_messages_add_new_message_template'
+				)
+					? $st_args['create_button']
+					: '';
+				$st_args['edit_button']   = EE_Registry::instance()->CAP->current_user_can(
+					'ee_edit_message',
+					'espresso_messages_edit_message_template',
+					$mtpgID
+				)
+					? '
                     <a data-messagetype="' . $mt_slug . '"
                        data-grpid="' . $default_value . '"
                        target="_blank"
@@ -622,322 +622,322 @@ 
                     >
                         ' . esc_html__('Edit', 'event_espresso') . '
                     </a>'
-                    : '';
-                $selector_rows .= EEH_Template::display_template($template_row_path, $st_args, true);
-            }
-        }
-
-        // if no selectors present then get out.
-        if (empty($selector_rows)) {
-            return '';
-        }
-
-        $template_args['selector_rows'] = $selector_rows;
-        return EEH_Template::display_template($template_wrapper_path, $template_args, true);
-    }
-
-
-
-
-
-
-    /**
-     * get_template_fields
-     *
-     * @access public
-     * @return array $this->_template_fields
-     */
-    public function get_template_fields()
-    {
-        $template_fields = apply_filters('FHEE__' . get_class($this) . '__get_template_fields', $this->_template_fields, $this);
-        $template_fields = apply_filters('FHEE__EE_messenger__get_template_fields', $template_fields, $this);
-        return $template_fields;
-    }
-
-
-
-
-    /** SETUP METHODS **/
-    /**
-     * The following method doesn't NEED to be used by child classes but might be modified by the specific messenger
-     * @param string $item
-     * @param mixed $value
-     */
-    protected function _set_template_value($item, $value)
-    {
-        if (array_key_exists($item, $this->_template_fields)) {
-            $prop = '_' . $item;
-            $this->{$prop} = $value;
-        }
-    }
-
-    /**
-     * Sets up the message for sending.
-     *
-     * @param  EE_message $message the message object that contains details about the message.
-     * @param EE_message_type $message_type The message type object used in combination with this messenger to generate the provided message.
-     *
-     * @return bool Very important that all messengers return bool for successful send or not.  Error messages can be
-     *              added to EE_Error.
-     *              true = message sent successfully
-     *              false = message not sent but can be retried (i.e. the failure might be just due to communication issues at the time of send).
-     *              Throwing a SendMessageException means the message failed sending and cannot be retried.
-     *
-     * @throws SendMessageException
-     */
-    final public function send_message($message, EE_message_type $message_type)
-    {
-        try {
-            $this->_validate_and_setup($message);
-            $this->_incoming_message_type = $message_type;
-            $response = $this->_send_message();
-            if ($response instanceof WP_Error) {
-                EE_Error::add_error($response->get_error_message(), __FILE__, __FUNCTION__, __LINE__);
-                $response = false;
-            }
-        } catch (\Exception $e) {
-            // convert to an instance of SendMessageException
-            throw new SendMessageException($e->getMessage());
-        }
-        return $response;
-    }
-
-
-
-    /**
-     * Sets up and returns message preview
-     * @param  EE_Message $message incoming message object
-     * @param EE_message_type $message_type This is whatever message type was used in combination with this messenger to generate the message.
-     * @param  bool   $send    true we will actually use the _send method (for test sends). FALSE we just return preview
-     * @return string          return the message html content
-     */
-    public function get_preview(EE_Message $message, EE_message_type $message_type, $send = false)
-    {
-        $this->_validate_and_setup($message);
-
-        $this->_incoming_message_type = $message_type;
-
-        if ($send) {
-            // are we overriding any existing template fields?
-            $settings = apply_filters(
-                'FHEE__EE_messenger__get_preview__messenger_test_settings',
-                $this->get_existing_test_settings(),
-                $this,
-                $send,
-                $message,
-                $message_type
-            );
-            if (! empty($settings)) {
-                foreach ($settings as $field => $value) {
-                    $this->_set_template_value($field, $value);
-                }
-            }
-        }
-
-        // enqueue preview js so that any links/buttons on the page are disabled.
-        if (! $send) {
-            // the below may seem like duplication.  However, typically if a messenger enqueues scripts/styles,
-            // it deregisters all existing wp scripts and styles first.  So the second hook ensures our previewer still gets setup.
-            add_action('admin_enqueue_scripts', array( $this, 'add_preview_script' ), 10);
-            add_action('wp_enqueue_scripts', array( $this, 'add_preview_script' ), 10);
-            add_action('AHEE__EE_messenger__enqueue_scripts_styles', array( $this, 'add_preview_script' ), 10);
-        }
-
-        return $send ? $this->_send_message() : $this->_preview();
-    }
-
-
-
-
-    /**
-     * Callback for enqueue_scripts so that we setup the preview script for all previews.
-     *
-     * @since 4.5.0
-     *
-     * @return void
-     */
-    public function add_preview_script()
-    {
-        // error message
-        EE_Registry::$i18n_js_strings['links_disabled'] = wp_strip_all_tags(
-            __('All the links on this page have been disabled because this is a generated preview message for the purpose of ensuring layout, style, and content setup.  To test generated links, you must trigger an actual message notification.', 'event_espresso')
-        );
-        wp_register_script('ee-messages-preview-js', EE_LIBRARIES_URL . 'messages/messenger/assets/js/ee-messages-preview.js', array( 'jquery' ), EVENT_ESPRESSO_VERSION, true);
-        wp_localize_script('ee-messages-preview-js', 'eei18n', EE_Registry::$i18n_js_strings);
-        wp_enqueue_script('ee-messages-preview-js');
-    }
-
-
-
-
-    /**
-     * simply validates the incoming message object and then sets up the properties for the messenger
-     * @param  EE_Message $message
-     * @throws EE_Error
-     */
-    protected function _validate_and_setup(EE_Message $message)
-    {
-        $template_pack = $message->get_template_pack();
-        $variation = $message->get_template_pack_variation();
-
-        // verify we have the required template pack value on the $message object.
-        if (! $template_pack instanceof EE_Messages_Template_Pack) {
-            throw new EE_Error(esc_html__('Incoming $message object must have an EE_Messages_Template_Pack object available.', 'event_espresso'));
-        }
-
-        $this->_tmp_pack = $template_pack;
-
-        $this->_variation = $variation ? $variation : 'default';
-
-        $template_fields = $this->get_template_fields();
-
-        foreach ($template_fields as $template => $value) {
-            if ($template !== 'extra') {
-                $column_value = $message->get_field_or_extra_meta('MSG_' . $template);
-                $message_template_value = $column_value ? $column_value : null;
-                $this->_set_template_value($template, $message_template_value);
-            }
-        }
-    }
-
-
-
-    /**
-     * Utility method for child classes to get the contents of a template file and return
-     *
-     * We're assuming the child messenger class has already setup template args!
-     * @param  bool $preview if true we use the preview wrapper otherwise we use main wrapper.
-     * @return string
-     * @throws \EE_Error
-     */
-    protected function _get_main_template($preview = false)
-    {
-        $type = $preview ? 'preview' : 'main';
-
-        $wrapper_template = $this->_tmp_pack->get_wrapper($this->name, $type);
-
-        // check file exists and is readable
-        if (!is_readable($wrapper_template)) {
-            throw new EE_Error(sprintf(esc_html__('Unable to access the template file for the %s messenger main content wrapper.  The location being attempted is %s.', 'event_espresso'), ucwords($this->label['singular']), $wrapper_template));
-        }
-
-        // add message type to template args
-        $this->_template_args['message_type'] = $this->_incoming_message_type;
-
-        return EEH_Template::display_template($wrapper_template, $this->_template_args, true);
-    }
-
-
-
-    /**
-     * set the _test_settings_fields property
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _set_test_settings_fields()
-    {
-        $this->_test_settings_fields = array();
-    }
-
-
-
-    /**
-     * return the _test_settings_fields property
-     * @return array
-     */
-    public function get_test_settings_fields()
-    {
-        return $this->_test_settings_fields;
-    }
-
-
-
-
-    /**
-     * This just returns any existing test settings that might be saved in the database
-     *
-     * @access public
-     * @return array
-     */
-    public function get_existing_test_settings()
-    {
-        /** @var EE_Message_Resource_Manager $Message_Resource_Manager */
-        $Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        $settings = $Message_Resource_Manager->get_active_messengers_option();
-        return isset($settings[ $this->name ]['test_settings']) ? $settings[ $this->name ]['test_settings'] : array();
-    }
-
-
-
-    /**
-     * All this does is set the existing test settings (in the db) for the messenger
-     *
-     * @access public
-     * @param $settings
-     * @return bool success/fail
-     */
-    public function set_existing_test_settings($settings)
-    {
-        /** @var EE_Message_Resource_Manager $Message_Resource_Manager */
-        $Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        $existing = $Message_Resource_Manager->get_active_messengers_option();
-        $existing[ $this->name ]['test_settings'] = $settings;
-        return $Message_Resource_Manager->update_active_messengers_option($existing);
-    }
-
-
-
-    /**
-     * This just returns the field label for a given field setup in the _template_fields property.
-     *
-     * @since   4.3.0
-     *
-     * @param string $field The field to retrieve the label for
-     * @return string             The label
-     */
-    public function get_field_label($field)
-    {
-        // first let's see if the field requests is in the top level array.
-        if (isset($this->_template_fields[ $field ]) && !empty($this->_template_fields[ $field ]['label'])) {
-            return $this->_template[ $field ]['label'];
-        }
-
-        // nope so let's look in the extra array to see if it's there HOWEVER if the field exists as a top level index in the extra array then we know the label is in the 'main' index.
-        if (isset($this->_template_fields['extra']) && !empty($this->_template_fields['extra'][ $field ]) && !empty($this->_template_fields['extra'][ $field ]['main']['label'])) {
-            return $this->_template_fields['extra'][ $field ]['main']['label'];
-        }
-
-        // now it's possible this field may just be existing in any of the extra array items.
-        if (!empty($this->_template_fields['extra']) && is_array($this->_template_fields['extra'])) {
-            foreach ($this->_template_fields['extra'] as $main_field => $subfields) {
-                if (!is_array($subfields)) {
-                    continue;
-                }
-                if (isset($subfields[ $field ]) && !empty($subfields[ $field ]['label'])) {
-                    return $subfields[ $field ]['label'];
-                }
-            }
-        }
-
-        // if we made it here then there's no label set so let's just return the $field.
-        return $field;
-    }
-
-
-
-
-    /**
-     * This is a method called from EE_messages when this messenger is a generating messenger and the sending messenger is a different messenger.  Child messengers can set hooks for the sending messenger to callback on if necessary (i.e. swap out css files or something else).
-     *
-     * @since 4.5.0
-     *
-     * @param string $sending_messenger_name the name of the sending messenger so we only set the hooks needed.
-     *
-     * @return void
-     */
-    public function do_secondary_messenger_hooks($sending_messenger_name)
-    {
-        return;
-    }
+					: '';
+				$selector_rows .= EEH_Template::display_template($template_row_path, $st_args, true);
+			}
+		}
+
+		// if no selectors present then get out.
+		if (empty($selector_rows)) {
+			return '';
+		}
+
+		$template_args['selector_rows'] = $selector_rows;
+		return EEH_Template::display_template($template_wrapper_path, $template_args, true);
+	}
+
+
+
+
+
+
+	/**
+	 * get_template_fields
+	 *
+	 * @access public
+	 * @return array $this->_template_fields
+	 */
+	public function get_template_fields()
+	{
+		$template_fields = apply_filters('FHEE__' . get_class($this) . '__get_template_fields', $this->_template_fields, $this);
+		$template_fields = apply_filters('FHEE__EE_messenger__get_template_fields', $template_fields, $this);
+		return $template_fields;
+	}
+
+
+
+
+	/** SETUP METHODS **/
+	/**
+	 * The following method doesn't NEED to be used by child classes but might be modified by the specific messenger
+	 * @param string $item
+	 * @param mixed $value
+	 */
+	protected function _set_template_value($item, $value)
+	{
+		if (array_key_exists($item, $this->_template_fields)) {
+			$prop = '_' . $item;
+			$this->{$prop} = $value;
+		}
+	}
+
+	/**
+	 * Sets up the message for sending.
+	 *
+	 * @param  EE_message $message the message object that contains details about the message.
+	 * @param EE_message_type $message_type The message type object used in combination with this messenger to generate the provided message.
+	 *
+	 * @return bool Very important that all messengers return bool for successful send or not.  Error messages can be
+	 *              added to EE_Error.
+	 *              true = message sent successfully
+	 *              false = message not sent but can be retried (i.e. the failure might be just due to communication issues at the time of send).
+	 *              Throwing a SendMessageException means the message failed sending and cannot be retried.
+	 *
+	 * @throws SendMessageException
+	 */
+	final public function send_message($message, EE_message_type $message_type)
+	{
+		try {
+			$this->_validate_and_setup($message);
+			$this->_incoming_message_type = $message_type;
+			$response = $this->_send_message();
+			if ($response instanceof WP_Error) {
+				EE_Error::add_error($response->get_error_message(), __FILE__, __FUNCTION__, __LINE__);
+				$response = false;
+			}
+		} catch (\Exception $e) {
+			// convert to an instance of SendMessageException
+			throw new SendMessageException($e->getMessage());
+		}
+		return $response;
+	}
+
+
+
+	/**
+	 * Sets up and returns message preview
+	 * @param  EE_Message $message incoming message object
+	 * @param EE_message_type $message_type This is whatever message type was used in combination with this messenger to generate the message.
+	 * @param  bool   $send    true we will actually use the _send method (for test sends). FALSE we just return preview
+	 * @return string          return the message html content
+	 */
+	public function get_preview(EE_Message $message, EE_message_type $message_type, $send = false)
+	{
+		$this->_validate_and_setup($message);
+
+		$this->_incoming_message_type = $message_type;
+
+		if ($send) {
+			// are we overriding any existing template fields?
+			$settings = apply_filters(
+				'FHEE__EE_messenger__get_preview__messenger_test_settings',
+				$this->get_existing_test_settings(),
+				$this,
+				$send,
+				$message,
+				$message_type
+			);
+			if (! empty($settings)) {
+				foreach ($settings as $field => $value) {
+					$this->_set_template_value($field, $value);
+				}
+			}
+		}
+
+		// enqueue preview js so that any links/buttons on the page are disabled.
+		if (! $send) {
+			// the below may seem like duplication.  However, typically if a messenger enqueues scripts/styles,
+			// it deregisters all existing wp scripts and styles first.  So the second hook ensures our previewer still gets setup.
+			add_action('admin_enqueue_scripts', array( $this, 'add_preview_script' ), 10);
+			add_action('wp_enqueue_scripts', array( $this, 'add_preview_script' ), 10);
+			add_action('AHEE__EE_messenger__enqueue_scripts_styles', array( $this, 'add_preview_script' ), 10);
+		}
+
+		return $send ? $this->_send_message() : $this->_preview();
+	}
+
+
+
+
+	/**
+	 * Callback for enqueue_scripts so that we setup the preview script for all previews.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @return void
+	 */
+	public function add_preview_script()
+	{
+		// error message
+		EE_Registry::$i18n_js_strings['links_disabled'] = wp_strip_all_tags(
+			__('All the links on this page have been disabled because this is a generated preview message for the purpose of ensuring layout, style, and content setup.  To test generated links, you must trigger an actual message notification.', 'event_espresso')
+		);
+		wp_register_script('ee-messages-preview-js', EE_LIBRARIES_URL . 'messages/messenger/assets/js/ee-messages-preview.js', array( 'jquery' ), EVENT_ESPRESSO_VERSION, true);
+		wp_localize_script('ee-messages-preview-js', 'eei18n', EE_Registry::$i18n_js_strings);
+		wp_enqueue_script('ee-messages-preview-js');
+	}
+
+
+
+
+	/**
+	 * simply validates the incoming message object and then sets up the properties for the messenger
+	 * @param  EE_Message $message
+	 * @throws EE_Error
+	 */
+	protected function _validate_and_setup(EE_Message $message)
+	{
+		$template_pack = $message->get_template_pack();
+		$variation = $message->get_template_pack_variation();
+
+		// verify we have the required template pack value on the $message object.
+		if (! $template_pack instanceof EE_Messages_Template_Pack) {
+			throw new EE_Error(esc_html__('Incoming $message object must have an EE_Messages_Template_Pack object available.', 'event_espresso'));
+		}
+
+		$this->_tmp_pack = $template_pack;
+
+		$this->_variation = $variation ? $variation : 'default';
+
+		$template_fields = $this->get_template_fields();
+
+		foreach ($template_fields as $template => $value) {
+			if ($template !== 'extra') {
+				$column_value = $message->get_field_or_extra_meta('MSG_' . $template);
+				$message_template_value = $column_value ? $column_value : null;
+				$this->_set_template_value($template, $message_template_value);
+			}
+		}
+	}
+
+
+
+	/**
+	 * Utility method for child classes to get the contents of a template file and return
+	 *
+	 * We're assuming the child messenger class has already setup template args!
+	 * @param  bool $preview if true we use the preview wrapper otherwise we use main wrapper.
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	protected function _get_main_template($preview = false)
+	{
+		$type = $preview ? 'preview' : 'main';
+
+		$wrapper_template = $this->_tmp_pack->get_wrapper($this->name, $type);
+
+		// check file exists and is readable
+		if (!is_readable($wrapper_template)) {
+			throw new EE_Error(sprintf(esc_html__('Unable to access the template file for the %s messenger main content wrapper.  The location being attempted is %s.', 'event_espresso'), ucwords($this->label['singular']), $wrapper_template));
+		}
+
+		// add message type to template args
+		$this->_template_args['message_type'] = $this->_incoming_message_type;
+
+		return EEH_Template::display_template($wrapper_template, $this->_template_args, true);
+	}
+
+
+
+	/**
+	 * set the _test_settings_fields property
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _set_test_settings_fields()
+	{
+		$this->_test_settings_fields = array();
+	}
+
+
+
+	/**
+	 * return the _test_settings_fields property
+	 * @return array
+	 */
+	public function get_test_settings_fields()
+	{
+		return $this->_test_settings_fields;
+	}
+
+
+
+
+	/**
+	 * This just returns any existing test settings that might be saved in the database
+	 *
+	 * @access public
+	 * @return array
+	 */
+	public function get_existing_test_settings()
+	{
+		/** @var EE_Message_Resource_Manager $Message_Resource_Manager */
+		$Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		$settings = $Message_Resource_Manager->get_active_messengers_option();
+		return isset($settings[ $this->name ]['test_settings']) ? $settings[ $this->name ]['test_settings'] : array();
+	}
+
+
+
+	/**
+	 * All this does is set the existing test settings (in the db) for the messenger
+	 *
+	 * @access public
+	 * @param $settings
+	 * @return bool success/fail
+	 */
+	public function set_existing_test_settings($settings)
+	{
+		/** @var EE_Message_Resource_Manager $Message_Resource_Manager */
+		$Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		$existing = $Message_Resource_Manager->get_active_messengers_option();
+		$existing[ $this->name ]['test_settings'] = $settings;
+		return $Message_Resource_Manager->update_active_messengers_option($existing);
+	}
+
+
+
+	/**
+	 * This just returns the field label for a given field setup in the _template_fields property.
+	 *
+	 * @since   4.3.0
+	 *
+	 * @param string $field The field to retrieve the label for
+	 * @return string             The label
+	 */
+	public function get_field_label($field)
+	{
+		// first let's see if the field requests is in the top level array.
+		if (isset($this->_template_fields[ $field ]) && !empty($this->_template_fields[ $field ]['label'])) {
+			return $this->_template[ $field ]['label'];
+		}
+
+		// nope so let's look in the extra array to see if it's there HOWEVER if the field exists as a top level index in the extra array then we know the label is in the 'main' index.
+		if (isset($this->_template_fields['extra']) && !empty($this->_template_fields['extra'][ $field ]) && !empty($this->_template_fields['extra'][ $field ]['main']['label'])) {
+			return $this->_template_fields['extra'][ $field ]['main']['label'];
+		}
+
+		// now it's possible this field may just be existing in any of the extra array items.
+		if (!empty($this->_template_fields['extra']) && is_array($this->_template_fields['extra'])) {
+			foreach ($this->_template_fields['extra'] as $main_field => $subfields) {
+				if (!is_array($subfields)) {
+					continue;
+				}
+				if (isset($subfields[ $field ]) && !empty($subfields[ $field ]['label'])) {
+					return $subfields[ $field ]['label'];
+				}
+			}
+		}
+
+		// if we made it here then there's no label set so let's just return the $field.
+		return $field;
+	}
+
+
+
+
+	/**
+	 * This is a method called from EE_messages when this messenger is a generating messenger and the sending messenger is a different messenger.  Child messengers can set hooks for the sending messenger to callback on if necessary (i.e. swap out css files or something else).
+	 *
+	 * @since 4.5.0
+	 *
+	 * @param string $sending_messenger_name the name of the sending messenger so we only set the hooks needed.
+	 *
+	 * @return void
+	 */
+	public function do_secondary_messenger_hooks($sending_messenger_name)
+	{
+		return;
+	}
 }

Spacing +46 added lines, -46 removed lines

@@ -415,7 +415,7 @@ 
         $class = get_class($this);
 
         // messenger specific filter
-        $default_types = apply_filters('FHEE__' . $class . '__get_default_message_types__default_types', $this->_default_message_types, $this);
+        $default_types = apply_filters('FHEE__'.$class.'__get_default_message_types__default_types', $this->_default_message_types, $this);
 
         // all messengers filter
         $default_types = apply_filters('FHEE__EE_messenger__get_default_message_types__default_types', $default_types, $this);
@@ -438,7 +438,7 @@ 
 
         // messenger specific filter
         // messenger specific filter
-        $valid_types = apply_filters('FHEE__' . $class . '__get_valid_message_types__valid_types', $this->_valid_message_types, $this);
+        $valid_types = apply_filters('FHEE__'.$class.'__get_valid_message_types__valid_types', $this->_valid_message_types, $this);
 
         // all messengers filter
         $valid_types = apply_filters('FHEE__EE_messenger__get_valid_message_types__valid_types', $valid_types, $this);
@@ -473,7 +473,7 @@ 
     {
         $class = get_class($this);
 
-        $config = apply_filters('FHEE__' . $class . '__get_validator_config', $this->_validator_config, $this);
+        $config = apply_filters('FHEE__'.$class.'__get_validator_config', $this->_validator_config, $this);
         $config = apply_filters('FHEE__EE_messenger__get_validator_config', $config, $this);
         return $config;
     }
@@ -512,12 +512,12 @@ 
         // we don't need message types here so we're just going to ignore. we do, however, expect the event id here. The event id is needed to provide a link to setup a custom template for this event.
         $event_id = isset($extra['event']) ? $extra['event'] : null;
 
-        $template_wrapper_path = EE_LIBRARIES . 'messages/messenger/admin_templates/event_switcher_wrapper.template.php';
-        $template_row_path = EE_LIBRARIES . 'messages/messenger/admin_templates/event_switcher_row.template.php';
+        $template_wrapper_path = EE_LIBRARIES.'messages/messenger/admin_templates/event_switcher_wrapper.template.php';
+        $template_row_path = EE_LIBRARIES.'messages/messenger/admin_templates/event_switcher_row.template.php';
 
         // array of template objects for global and custom (non-trashed) (but remember just for this messenger!)
         $global_templates = EEM_Message_Template_Group::instance()->get_all(
-            array( array( 'MTP_messenger' => $this->name, 'MTP_is_global' => true, 'MTP_is_active' => true ) )
+            array(array('MTP_messenger' => $this->name, 'MTP_is_global' => true, 'MTP_is_active' => true))
         );
         $templates_for_event = EEM_Message_Template_Group::instance()->get_all_custom_templates_by_event(
             $event_id,
@@ -526,29 +526,29 @@ 
                 'MTP_is_active' => true
             )
         );
-        $templates_for_event = !empty($templates_for_event) ? $templates_for_event : array();
+        $templates_for_event = ! empty($templates_for_event) ? $templates_for_event : array();
 
         // so we need to setup the rows for the selectors and we use the global mtpgs (cause those will the active message template groups)
         foreach ($global_templates as $mtpgID => $mtpg) {
             if ($mtpg instanceof EE_Message_Template_Group) {
                 // verify this message type is supposed to show on this page
                 $mtp_obj = $mtpg->message_type_obj();
-                if (! $mtp_obj instanceof EE_message_type) {
+                if ( ! $mtp_obj instanceof EE_message_type) {
                     continue;
                 }
                 $mtp_obj->admin_registered_pages = (array) $mtp_obj->admin_registered_pages;
-                if (! in_array('events_edit', $mtp_obj->admin_registered_pages)) {
+                if ( ! in_array('events_edit', $mtp_obj->admin_registered_pages)) {
                     continue;
                 }
                 $select_values = array();
-                $select_values[ $mtpgID ] = esc_html__('Global', 'event_espresso');
+                $select_values[$mtpgID] = esc_html__('Global', 'event_espresso');
                 $default_value = array_key_exists($mtpgID, $templates_for_event) && ! $mtpg->get('MTP_is_override') ? $mtpgID : null;
                 // if the override has been set for the global template, then that means even if there are custom templates already created we ignore them because of the set override.
-                if (! $mtpg->get('MTP_is_override')) {
+                if ( ! $mtpg->get('MTP_is_override')) {
                     // any custom templates for this message type?
                     $custom_templates = EEM_Message_Template_Group::instance()->get_custom_message_template_by_m_and_mt($this->name, $mtpg->message_type());
                     foreach ($custom_templates as $cmtpgID => $cmtpg) {
-                        $select_values[ $cmtpgID ] = $cmtpg->name();
+                        $select_values[$cmtpgID] = $cmtpg->name();
                         $default_value = array_key_exists($cmtpgID, $templates_for_event) ? $cmtpgID : $default_value;
                     }
                 }
@@ -578,10 +578,10 @@ 
                 $st_args['mt_slug'] = $mt_slug;
                 $st_args['messenger_slug'] = $this->name;
                 $st_args['selector'] = EEH_Form_Fields::select_input(
-                    'event_message_templates_relation[' . $mtpgID . ']',
+                    'event_message_templates_relation['.$mtpgID.']',
                     $select_values,
                     $default_value,
-                    'data-messenger="' . $this->name . '" data-messagetype="' . $mt_slug . '"',
+                    'data-messenger="'.$this->name.'" data-messagetype="'.$mt_slug.'"',
                     'message-template-selector'
                 );
                 $new_template_name = sprintf(
@@ -592,15 +592,15 @@ 
                 $st_args['create_button'] = $mtpg->get('MTP_is_override')
                     ? ''
                     : '
-                    <a data-messenger="' . $this->name . '"
-                       data-messagetype="' . $mt_slug . '"
-                       data-new_template_name="' . $new_template_name . '"
-                       data-grpid="' . $default_value . '"
+                    <a data-messenger="' . $this->name.'"
+                       data-messagetype="' . $mt_slug.'"
+                       data-new_template_name="' . $new_template_name.'"
+                       data-grpid="' . $default_value.'"
                        target="_blank"
-                       href="' . $create_url . '"
+                       href="' . $create_url.'"
                        class="button button--secondary create-mtpg-button"
                     >
-                        ' . esc_html__('Create New Custom', 'event_espresso') . '
+                        ' . esc_html__('Create New Custom', 'event_espresso').'
                     </a>';
                 $st_args['create_button'] = EE_Registry::instance()->CAP->current_user_can(
                     'ee_edit_messages',
@@ -608,19 +608,19 @@ 
                 )
                     ? $st_args['create_button']
                     : '';
-                $st_args['edit_button']   = EE_Registry::instance()->CAP->current_user_can(
+                $st_args['edit_button'] = EE_Registry::instance()->CAP->current_user_can(
                     'ee_edit_message',
                     'espresso_messages_edit_message_template',
                     $mtpgID
                 )
                     ? '
-                    <a data-messagetype="' . $mt_slug . '"
-                       data-grpid="' . $default_value . '"
+                    <a data-messagetype="' . $mt_slug.'"
+                       data-grpid="' . $default_value.'"
                        target="_blank"
-                       href="' . $edit_url . '"
+                       href="' . $edit_url.'"
                        class="button button--secondary edit-mtpg-button"
                     >
-                        ' . esc_html__('Edit', 'event_espresso') . '
+                        ' . esc_html__('Edit', 'event_espresso').'
                     </a>'
                     : '';
                 $selector_rows .= EEH_Template::display_template($template_row_path, $st_args, true);
@@ -649,7 +649,7 @@ 
      */
     public function get_template_fields()
     {
-        $template_fields = apply_filters('FHEE__' . get_class($this) . '__get_template_fields', $this->_template_fields, $this);
+        $template_fields = apply_filters('FHEE__'.get_class($this).'__get_template_fields', $this->_template_fields, $this);
         $template_fields = apply_filters('FHEE__EE_messenger__get_template_fields', $template_fields, $this);
         return $template_fields;
     }
@@ -666,7 +666,7 @@ 
     protected function _set_template_value($item, $value)
     {
         if (array_key_exists($item, $this->_template_fields)) {
-            $prop = '_' . $item;
+            $prop = '_'.$item;
             $this->{$prop} = $value;
         }
     }
@@ -727,7 +727,7 @@ 
                 $message,
                 $message_type
             );
-            if (! empty($settings)) {
+            if ( ! empty($settings)) {
                 foreach ($settings as $field => $value) {
                     $this->_set_template_value($field, $value);
                 }
@@ -735,12 +735,12 @@ 
         }
 
         // enqueue preview js so that any links/buttons on the page are disabled.
-        if (! $send) {
+        if ( ! $send) {
             // the below may seem like duplication.  However, typically if a messenger enqueues scripts/styles,
             // it deregisters all existing wp scripts and styles first.  So the second hook ensures our previewer still gets setup.
-            add_action('admin_enqueue_scripts', array( $this, 'add_preview_script' ), 10);
-            add_action('wp_enqueue_scripts', array( $this, 'add_preview_script' ), 10);
-            add_action('AHEE__EE_messenger__enqueue_scripts_styles', array( $this, 'add_preview_script' ), 10);
+            add_action('admin_enqueue_scripts', array($this, 'add_preview_script'), 10);
+            add_action('wp_enqueue_scripts', array($this, 'add_preview_script'), 10);
+            add_action('AHEE__EE_messenger__enqueue_scripts_styles', array($this, 'add_preview_script'), 10);
         }
 
         return $send ? $this->_send_message() : $this->_preview();
@@ -762,7 +762,7 @@ 
         EE_Registry::$i18n_js_strings['links_disabled'] = wp_strip_all_tags(
             __('All the links on this page have been disabled because this is a generated preview message for the purpose of ensuring layout, style, and content setup.  To test generated links, you must trigger an actual message notification.', 'event_espresso')
         );
-        wp_register_script('ee-messages-preview-js', EE_LIBRARIES_URL . 'messages/messenger/assets/js/ee-messages-preview.js', array( 'jquery' ), EVENT_ESPRESSO_VERSION, true);
+        wp_register_script('ee-messages-preview-js', EE_LIBRARIES_URL.'messages/messenger/assets/js/ee-messages-preview.js', array('jquery'), EVENT_ESPRESSO_VERSION, true);
         wp_localize_script('ee-messages-preview-js', 'eei18n', EE_Registry::$i18n_js_strings);
         wp_enqueue_script('ee-messages-preview-js');
     }
@@ -781,7 +781,7 @@ 
         $variation = $message->get_template_pack_variation();
 
         // verify we have the required template pack value on the $message object.
-        if (! $template_pack instanceof EE_Messages_Template_Pack) {
+        if ( ! $template_pack instanceof EE_Messages_Template_Pack) {
             throw new EE_Error(esc_html__('Incoming $message object must have an EE_Messages_Template_Pack object available.', 'event_espresso'));
         }
 
@@ -793,7 +793,7 @@ 
 
         foreach ($template_fields as $template => $value) {
             if ($template !== 'extra') {
-                $column_value = $message->get_field_or_extra_meta('MSG_' . $template);
+                $column_value = $message->get_field_or_extra_meta('MSG_'.$template);
                 $message_template_value = $column_value ? $column_value : null;
                 $this->_set_template_value($template, $message_template_value);
             }
@@ -817,7 +817,7 @@ 
         $wrapper_template = $this->_tmp_pack->get_wrapper($this->name, $type);
 
         // check file exists and is readable
-        if (!is_readable($wrapper_template)) {
+        if ( ! is_readable($wrapper_template)) {
             throw new EE_Error(sprintf(esc_html__('Unable to access the template file for the %s messenger main content wrapper.  The location being attempted is %s.', 'event_espresso'), ucwords($this->label['singular']), $wrapper_template));
         }
 
@@ -865,7 +865,7 @@ 
         /** @var EE_Message_Resource_Manager $Message_Resource_Manager */
         $Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
         $settings = $Message_Resource_Manager->get_active_messengers_option();
-        return isset($settings[ $this->name ]['test_settings']) ? $settings[ $this->name ]['test_settings'] : array();
+        return isset($settings[$this->name]['test_settings']) ? $settings[$this->name]['test_settings'] : array();
     }
 
 
@@ -882,7 +882,7 @@ 
         /** @var EE_Message_Resource_Manager $Message_Resource_Manager */
         $Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
         $existing = $Message_Resource_Manager->get_active_messengers_option();
-        $existing[ $this->name ]['test_settings'] = $settings;
+        $existing[$this->name]['test_settings'] = $settings;
         return $Message_Resource_Manager->update_active_messengers_option($existing);
     }
 
@@ -899,23 +899,23 @@ 
     public function get_field_label($field)
     {
         // first let's see if the field requests is in the top level array.
-        if (isset($this->_template_fields[ $field ]) && !empty($this->_template_fields[ $field ]['label'])) {
-            return $this->_template[ $field ]['label'];
+        if (isset($this->_template_fields[$field]) && ! empty($this->_template_fields[$field]['label'])) {
+            return $this->_template[$field]['label'];
         }
 
         // nope so let's look in the extra array to see if it's there HOWEVER if the field exists as a top level index in the extra array then we know the label is in the 'main' index.
-        if (isset($this->_template_fields['extra']) && !empty($this->_template_fields['extra'][ $field ]) && !empty($this->_template_fields['extra'][ $field ]['main']['label'])) {
-            return $this->_template_fields['extra'][ $field ]['main']['label'];
+        if (isset($this->_template_fields['extra']) && ! empty($this->_template_fields['extra'][$field]) && ! empty($this->_template_fields['extra'][$field]['main']['label'])) {
+            return $this->_template_fields['extra'][$field]['main']['label'];
         }
 
         // now it's possible this field may just be existing in any of the extra array items.
-        if (!empty($this->_template_fields['extra']) && is_array($this->_template_fields['extra'])) {
+        if ( ! empty($this->_template_fields['extra']) && is_array($this->_template_fields['extra'])) {
             foreach ($this->_template_fields['extra'] as $main_field => $subfields) {
-                if (!is_array($subfields)) {
+                if ( ! is_array($subfields)) {
                     continue;
                 }
-                if (isset($subfields[ $field ]) && !empty($subfields[ $field ]['label'])) {
-                    return $subfields[ $field ]['label'];
+                if (isset($subfields[$field]) && ! empty($subfields[$field]['label'])) {
+                    return $subfields[$field]['label'];
                 }
             }
         }

core/helpers/EEH_Maps.helper.php

Indentation +195 added lines, -195 removed lines

@@ -11,68 +11,68 @@ 
  */
 class EEH_Maps
 {
-    // array of map settings
-    public static $gmap_vars = [];
-
-
-    /**
-     * google_map - creates a Google Map Link
-     *
-     * @param array $ee_gmaps_opts array of attributes required for the map link generation
-     * @return string (link to map!)
-     */
-    public static function google_map(array $ee_gmaps_opts): string
-    {
-        $ee_map_width = ! empty($ee_gmaps_opts['ee_map_width'])
-            ? absint($ee_gmaps_opts['ee_map_width'])
-            : 300;
-
-        $ee_map_height = ! empty($ee_gmaps_opts['ee_map_height'])
-            ? absint($ee_gmaps_opts['ee_map_height'])
-            : 185;
-
-        $ee_map_zoom = ! empty($ee_gmaps_opts['ee_map_zoom'])
-            ? absint($ee_gmaps_opts['ee_map_zoom'])
-            : 12;
-
-        $ee_map_nav_display = ! empty($ee_gmaps_opts['ee_map_nav_display']) ? 'true' : 'false';
-
-        $ee_map_nav_size = ! empty($ee_gmaps_opts['ee_map_nav_size'])
-            ? sanitize_text_field($ee_gmaps_opts['ee_map_nav_size'])
-            : 'default';
-
-        $ee_map_type_control = ! empty($ee_gmaps_opts['ee_map_type_control'])
-            ? sanitize_text_field($ee_gmaps_opts['ee_map_type_control'])
-            : 'default';
-
-        $static_url = ! empty($ee_gmaps_opts['ee_static_url'])
-            ? esc_url_raw($ee_gmaps_opts['ee_static_url'])
-            : false;
-
-        if (! empty($ee_gmaps_opts['ee_map_align'])) {
-            switch ($ee_gmaps_opts['ee_map_align']) {
-                case "left":
-                    $map_align = 'ee-gmap-align-left left';
-                    break;
-                case "right":
-                    $map_align = 'ee-gmap-align-right right';
-                    break;
-                case "center":
-                    $map_align = 'ee-gmap-align-center center';
-                    break;
-                case "none":
-                default:
-                    $map_align = 'ee-gmap-align-none';
-            }
-        } else {
-            $map_align = 'ee-gmap-align-none';
-        }
-
-
-        // Determine whether user has set a hardcoded url to use and
-        // if so display a Google static iframe map else run V3 api
-        if ($static_url) {
-            $html = '
+	// array of map settings
+	public static $gmap_vars = [];
+
+
+	/**
+	 * google_map - creates a Google Map Link
+	 *
+	 * @param array $ee_gmaps_opts array of attributes required for the map link generation
+	 * @return string (link to map!)
+	 */
+	public static function google_map(array $ee_gmaps_opts): string
+	{
+		$ee_map_width = ! empty($ee_gmaps_opts['ee_map_width'])
+			? absint($ee_gmaps_opts['ee_map_width'])
+			: 300;
+
+		$ee_map_height = ! empty($ee_gmaps_opts['ee_map_height'])
+			? absint($ee_gmaps_opts['ee_map_height'])
+			: 185;
+
+		$ee_map_zoom = ! empty($ee_gmaps_opts['ee_map_zoom'])
+			? absint($ee_gmaps_opts['ee_map_zoom'])
+			: 12;
+
+		$ee_map_nav_display = ! empty($ee_gmaps_opts['ee_map_nav_display']) ? 'true' : 'false';
+
+		$ee_map_nav_size = ! empty($ee_gmaps_opts['ee_map_nav_size'])
+			? sanitize_text_field($ee_gmaps_opts['ee_map_nav_size'])
+			: 'default';
+
+		$ee_map_type_control = ! empty($ee_gmaps_opts['ee_map_type_control'])
+			? sanitize_text_field($ee_gmaps_opts['ee_map_type_control'])
+			: 'default';
+
+		$static_url = ! empty($ee_gmaps_opts['ee_static_url'])
+			? esc_url_raw($ee_gmaps_opts['ee_static_url'])
+			: false;
+
+		if (! empty($ee_gmaps_opts['ee_map_align'])) {
+			switch ($ee_gmaps_opts['ee_map_align']) {
+				case "left":
+					$map_align = 'ee-gmap-align-left left';
+					break;
+				case "right":
+					$map_align = 'ee-gmap-align-right right';
+					break;
+				case "center":
+					$map_align = 'ee-gmap-align-center center';
+					break;
+				case "none":
+				default:
+					$map_align = 'ee-gmap-align-none';
+			}
+		} else {
+			$map_align = 'ee-gmap-align-none';
+		}
+
+
+		// Determine whether user has set a hardcoded url to use and
+		// if so display a Google static iframe map else run V3 api
+		if ($static_url) {
+			$html = '
             <div class="ee-gmap-iframewrap ee-gmap-wrapper ' . $map_align . '">
                 <iframe src="' . $static_url . '&output=embed"
                         style="width: ' . $ee_map_width . 'px; height: ' . $ee_map_height . 'px;"
@@ -82,18 +82,18 @@ 
                 </iframe>
                 <a href="' . $static_url . '">' . esc_html__('View Large map', 'event_espresso') . '</a>
             </div>';
-        } else {
-            EEH_Maps::$gmap_vars[ $ee_gmaps_opts['map_ID'] ] = [
-                'map_ID'              => $ee_gmaps_opts['map_ID'],
-                'ee_map_zoom'         => $ee_map_zoom,
-                'ee_map_nav_display'  => $ee_map_nav_display,
-                'ee_map_nav_size'     => $ee_map_nav_size,
-                'ee_map_type_control' => $ee_map_type_control,
-                'location'            => $ee_gmaps_opts['location'],
-            ];
-
-            $style = 'width: ' . $ee_map_width . 'px; height: ' . $ee_map_height . 'px;';
-            $html  = '
+		} else {
+			EEH_Maps::$gmap_vars[ $ee_gmaps_opts['map_ID'] ] = [
+				'map_ID'              => $ee_gmaps_opts['map_ID'],
+				'ee_map_zoom'         => $ee_map_zoom,
+				'ee_map_nav_display'  => $ee_map_nav_display,
+				'ee_map_nav_size'     => $ee_map_nav_size,
+				'ee_map_type_control' => $ee_map_type_control,
+				'location'            => $ee_gmaps_opts['location'],
+			];
+
+			$style = 'width: ' . $ee_map_width . 'px; height: ' . $ee_map_height . 'px;';
+			$html  = '
             <div class="ee-gmap-wrapper ' . esc_attr($map_align) . '">
                 <div class="ee-gmap" 
                      id="map_canvas_' . esc_attr($ee_gmaps_opts['map_ID']) . '"
@@ -101,111 +101,111 @@ 
                  ></div>
             </div>';
 
-            wp_enqueue_script('gmap_api');
-            wp_enqueue_script('ee_gmap');
-            add_action('wp_footer', ['EEH_Maps', 'footer_enqueue_script']);
-        }
-        return $html; // end auto map or static url map check
-    }
-
-
-    /**
-     * enqueue_script
-     *
-     * @return void
-     */
-    public static function footer_enqueue_script(): void
-    {
-        wp_localize_script('ee_gmap', 'ee_gmap_vars', EEH_Maps::$gmap_vars);
-    }
-
-
-    /**
-     * registers scripts for maps
-     *
-     * @return void
-     */
-    public static function espresso_google_map_js(): void
-    {
-        $api_url = sprintf(
-            "https://maps.googleapis.com/maps/api/js?callback=ee_gmap_callback&key=%s",
-            apply_filters(
-                'FHEE__EEH_Maps__espresso_google_maps_js__api_key',
-                EE_Registry::instance()->CFG->map_settings->google_map_api_key
-            )
-        );
-        wp_register_script(
-            'ee_gmap',
-            plugin_dir_url(__FILE__) . 'assets/ee_gmap.js',
-            ['jquery'],
-            '1.1',
-            true
-        );
-        wp_register_script(
-            'gmap_api',
-            esc_url_raw($api_url),
-            ['ee_gmap'],
-            null,
-            true
-        );
-    }
-
-
-    /**
-     * creates a Google Map Link
-     *
-     * @param array $atts array of attributes required for the map link generation
-     * @return string (link to map!)
-     */
-    public static function google_map_link(array $atts): string
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        extract($atts);
-        /** @var string $address */
-        /** @var string $city */
-        /** @var string $state */
-        /** @var string $zip */
-        /** @var string $country */
-        $address         = "$address";
-        $city            = "$city";
-        $state           = "$state";
-        $zip             = "$zip";
-        $country         = "$country";
-        $text            = isset($text) ? "$text" : "";
-        $type            = isset($type) ? "$type" : "";
-        $map_w           = isset($map_w) ? "$map_w" : 400;
-        $map_h           = isset($map_h) ? "$map_h" : 400;
-        $id              = $id ?? 'not_set';
-        $map_image_class = $map_image_class ?? 'ee_google_map_view';
-
-        $address_string = ($address != '' ? $address : '')
-                          . ($city != '' ? ',' . $city : '')
-                          . ($state != '' ? ',' . $state : '')
-                          . ($zip != '' ? ',' . $zip : '')
-                          . ($country != '' ? ',' . $country : '');
-
-        $google_map = htmlentities2('https://maps.google.com/maps?q=' . urlencode($address_string));
-
-        switch ($type) {
-            case 'text':
-            default:
-                $text = $text == '' ? esc_html__('Map and Directions', 'event_espresso') : $text;
-                break;
-
-            case 'url_only':
-            case 'url':
-                $text = $google_map;
-                break;
-
-            case 'map':
-                $scheme = is_ssl() ? 'https://' : 'http://';
-
-                $api_key = apply_filters(
-                    'FHEE__EEH_Maps__espresso_google_maps_link__api_key',
-                    EE_Registry::instance()->CFG->map_settings->google_map_api_key
-                );
-
-                return '
+			wp_enqueue_script('gmap_api');
+			wp_enqueue_script('ee_gmap');
+			add_action('wp_footer', ['EEH_Maps', 'footer_enqueue_script']);
+		}
+		return $html; // end auto map or static url map check
+	}
+
+
+	/**
+	 * enqueue_script
+	 *
+	 * @return void
+	 */
+	public static function footer_enqueue_script(): void
+	{
+		wp_localize_script('ee_gmap', 'ee_gmap_vars', EEH_Maps::$gmap_vars);
+	}
+
+
+	/**
+	 * registers scripts for maps
+	 *
+	 * @return void
+	 */
+	public static function espresso_google_map_js(): void
+	{
+		$api_url = sprintf(
+			"https://maps.googleapis.com/maps/api/js?callback=ee_gmap_callback&key=%s",
+			apply_filters(
+				'FHEE__EEH_Maps__espresso_google_maps_js__api_key',
+				EE_Registry::instance()->CFG->map_settings->google_map_api_key
+			)
+		);
+		wp_register_script(
+			'ee_gmap',
+			plugin_dir_url(__FILE__) . 'assets/ee_gmap.js',
+			['jquery'],
+			'1.1',
+			true
+		);
+		wp_register_script(
+			'gmap_api',
+			esc_url_raw($api_url),
+			['ee_gmap'],
+			null,
+			true
+		);
+	}
+
+
+	/**
+	 * creates a Google Map Link
+	 *
+	 * @param array $atts array of attributes required for the map link generation
+	 * @return string (link to map!)
+	 */
+	public static function google_map_link(array $atts): string
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		extract($atts);
+		/** @var string $address */
+		/** @var string $city */
+		/** @var string $state */
+		/** @var string $zip */
+		/** @var string $country */
+		$address         = "$address";
+		$city            = "$city";
+		$state           = "$state";
+		$zip             = "$zip";
+		$country         = "$country";
+		$text            = isset($text) ? "$text" : "";
+		$type            = isset($type) ? "$type" : "";
+		$map_w           = isset($map_w) ? "$map_w" : 400;
+		$map_h           = isset($map_h) ? "$map_h" : 400;
+		$id              = $id ?? 'not_set';
+		$map_image_class = $map_image_class ?? 'ee_google_map_view';
+
+		$address_string = ($address != '' ? $address : '')
+						  . ($city != '' ? ',' . $city : '')
+						  . ($state != '' ? ',' . $state : '')
+						  . ($zip != '' ? ',' . $zip : '')
+						  . ($country != '' ? ',' . $country : '');
+
+		$google_map = htmlentities2('https://maps.google.com/maps?q=' . urlencode($address_string));
+
+		switch ($type) {
+			case 'text':
+			default:
+				$text = $text == '' ? esc_html__('Map and Directions', 'event_espresso') : $text;
+				break;
+
+			case 'url_only':
+			case 'url':
+				$text = $google_map;
+				break;
+
+			case 'map':
+				$scheme = is_ssl() ? 'https://' : 'http://';
+
+				$api_key = apply_filters(
+					'FHEE__EEH_Maps__espresso_google_maps_link__api_key',
+					EE_Registry::instance()->CFG->map_settings->google_map_api_key
+				);
+
+				return '
                 <a class="a_map_image_link" 
                    href="' . esc_url_raw($google_map) . '" 
                    target="_blank" 
@@ -215,23 +215,23 @@ 
                          class="map_image_link" 
                          id="venue_map_' . $id . '" ' . $map_image_class . ' 
                          src="'
-                       . htmlentities2(
-                           $scheme
-                           . 'maps.googleapis.com/maps/api/staticmap?center='
-                           . urlencode($address_string)
-                           . '&amp;zoom=14&amp;size='
-                           . $map_w . 'x' . $map_h
-                           . '&amp;markers=color:green|label:|'
-                           . urlencode($address_string)
-                           . '&amp;sensor=false&amp;key='
-                           . $api_key
-                       ) . '"
+					   . htmlentities2(
+						   $scheme
+						   . 'maps.googleapis.com/maps/api/staticmap?center='
+						   . urlencode($address_string)
+						   . '&amp;zoom=14&amp;size='
+						   . $map_w . 'x' . $map_h
+						   . '&amp;markers=color:green|label:|'
+						   . urlencode($address_string)
+						   . '&amp;sensor=false&amp;key='
+						   . $api_key
+					   ) . '"
                      />
                  </a>';
-        }
+		}
 
-        return $type === 'url_only'
-            ? $text
-            : '<a href="' . esc_url_raw($google_map) . '" target="_blank" rel="noopener noreferrer">' . $text . '</a>';
-    }
+		return $type === 'url_only'
+			? $text
+			: '<a href="' . esc_url_raw($google_map) . '" target="_blank" rel="noopener noreferrer">' . $text . '</a>';
+	}
 }

Spacing +22 added lines, -22 removed lines

@@ -49,7 +49,7 @@ 
             ? esc_url_raw($ee_gmaps_opts['ee_static_url'])
             : false;
 
-        if (! empty($ee_gmaps_opts['ee_map_align'])) {
+        if ( ! empty($ee_gmaps_opts['ee_map_align'])) {
             switch ($ee_gmaps_opts['ee_map_align']) {
                 case "left":
                     $map_align = 'ee-gmap-align-left left';
@@ -73,17 +73,17 @@ 
         // if so display a Google static iframe map else run V3 api
         if ($static_url) {
             $html = '
-            <div class="ee-gmap-iframewrap ee-gmap-wrapper ' . $map_align . '">
-                <iframe src="' . $static_url . '&output=embed"
-                        style="width: ' . $ee_map_width . 'px; height: ' . $ee_map_height . 'px;"
+            <div class="ee-gmap-iframewrap ee-gmap-wrapper ' . $map_align.'">
+                <iframe src="' . $static_url.'&output=embed"
+                        style="width: ' . $ee_map_width.'px; height: '.$ee_map_height.'px;"
                         frameborder="0" 
                         scrolling="no"
                     >
                 </iframe>
-                <a href="' . $static_url . '">' . esc_html__('View Large map', 'event_espresso') . '</a>
+                <a href="' . $static_url.'">'.esc_html__('View Large map', 'event_espresso').'</a>
             </div>';
         } else {
-            EEH_Maps::$gmap_vars[ $ee_gmaps_opts['map_ID'] ] = [
+            EEH_Maps::$gmap_vars[$ee_gmaps_opts['map_ID']] = [
                 'map_ID'              => $ee_gmaps_opts['map_ID'],
                 'ee_map_zoom'         => $ee_map_zoom,
                 'ee_map_nav_display'  => $ee_map_nav_display,
@@ -92,12 +92,12 @@ 
                 'location'            => $ee_gmaps_opts['location'],
             ];
 
-            $style = 'width: ' . $ee_map_width . 'px; height: ' . $ee_map_height . 'px;';
+            $style = 'width: '.$ee_map_width.'px; height: '.$ee_map_height.'px;';
             $html  = '
-            <div class="ee-gmap-wrapper ' . esc_attr($map_align) . '">
+            <div class="ee-gmap-wrapper ' . esc_attr($map_align).'">
                 <div class="ee-gmap" 
-                     id="map_canvas_' . esc_attr($ee_gmaps_opts['map_ID']) . '"
-                     style="' . esc_attr($style) . '"
+                     id="map_canvas_' . esc_attr($ee_gmaps_opts['map_ID']).'"
+                     style="' . esc_attr($style).'"
                  ></div>
             </div>';
 
@@ -136,7 +136,7 @@ 
         );
         wp_register_script(
             'ee_gmap',
-            plugin_dir_url(__FILE__) . 'assets/ee_gmap.js',
+            plugin_dir_url(__FILE__).'assets/ee_gmap.js',
             ['jquery'],
             '1.1',
             true
@@ -179,12 +179,12 @@ 
         $map_image_class = $map_image_class ?? 'ee_google_map_view';
 
         $address_string = ($address != '' ? $address : '')
-                          . ($city != '' ? ',' . $city : '')
-                          . ($state != '' ? ',' . $state : '')
-                          . ($zip != '' ? ',' . $zip : '')
-                          . ($country != '' ? ',' . $country : '');
+                          . ($city != '' ? ','.$city : '')
+                          . ($state != '' ? ','.$state : '')
+                          . ($zip != '' ? ','.$zip : '')
+                          . ($country != '' ? ','.$country : '');
 
-        $google_map = htmlentities2('https://maps.google.com/maps?q=' . urlencode($address_string));
+        $google_map = htmlentities2('https://maps.google.com/maps?q='.urlencode($address_string));
 
         switch ($type) {
             case 'text':
@@ -207,31 +207,31 @@ 
 
                 return '
                 <a class="a_map_image_link" 
-                   href="' . esc_url_raw($google_map) . '" 
+                   href="' . esc_url_raw($google_map).'" 
                    target="_blank" 
                    rel="noopener noreferrer"
                 >
-                    <img alt="' . esc_html__('Map and Directions', 'event_espresso') . '"
+                    <img alt="' . esc_html__('Map and Directions', 'event_espresso').'"
                          class="map_image_link" 
-                         id="venue_map_' . $id . '" ' . $map_image_class . ' 
+                         id="venue_map_' . $id.'" '.$map_image_class.' 
                          src="'
                        . htmlentities2(
                            $scheme
                            . 'maps.googleapis.com/maps/api/staticmap?center='
                            . urlencode($address_string)
                            . '&amp;zoom=14&amp;size='
-                           . $map_w . 'x' . $map_h
+                           . $map_w.'x'.$map_h
                            . '&amp;markers=color:green|label:|'
                            . urlencode($address_string)
                            . '&amp;sensor=false&amp;key='
                            . $api_key
-                       ) . '"
+                       ).'"
                      />
                  </a>';
         }
 
         return $type === 'url_only'
             ? $text
-            : '<a href="' . esc_url_raw($google_map) . '" target="_blank" rel="noopener noreferrer">' . $text . '</a>';
+            : '<a href="'.esc_url_raw($google_map).'" target="_blank" rel="noopener noreferrer">'.$text.'</a>';
     }
 }

core/helpers/EEH_MSG_Template.helper.php

Indentation +1252 added lines, -1252 removed lines

@@ -13,1259 +13,1259 @@
  */
 class EEH_MSG_Template
 {
-    /**
-     * Holds a collection of EE_Message_Template_Pack objects.
-     * @type EE_Messages_Template_Pack_Collection
-     */
-    protected static $_template_pack_collection;
-
-
-    /**
-     * @throws EE_Error
-     */
-    private static function _set_autoloader()
-    {
-        EED_Messages::set_autoloaders();
-    }
-
-
-    /**
-     * generate_new_templates
-     * This will handle the messenger, message_type selection when "adding a new custom template" for an event and will
-     * automatically create the defaults for the event.  The user would then be redirected to edit the default context
-     * for the event.
-     *
-     * @access protected
-     * @param string $messenger     the messenger we are generating templates for
-     * @param array  $message_types array of message types that the templates are generated for.
-     * @param int    $GRP_ID        If a non global template is being generated then it is expected we'll have a GRP_ID
-     *                              to use as the base for the new generated template.
-     * @param bool   $global        true indicates generating templates on messenger activation. false requires GRP_ID
-     *                              for event specific template generation.
-     * @return array  @see EEH_MSG_Template::_create_new_templates for the return value of each element in the array
-     *                for templates that are generated.  If this is an empty array then it means no templates were
-     *                generated which usually means there was an error.  Anything in the array with an empty value for
-     *                `MTP_context` means that it was not a new generated template but just reactivated (which only
-     *                happens for global templates that already exist in the database.
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function generate_new_templates($messenger, $message_types, $GRP_ID = 0, $global = false)
-    {
-        // make sure message_type is an array.
-        $message_types = (array) $message_types;
-        $templates = array();
-
-        if (empty($messenger)) {
-            throw new EE_Error(esc_html__('We need a messenger to generate templates!', 'event_espresso'));
-        }
-
-        // if we STILL have empty $message_types then we need to generate an error message b/c we NEED message types to do the template files.
-        if (empty($message_types)) {
-            throw new EE_Error(esc_html__('We need at least one message type to generate templates!', 'event_espresso'));
-        }
-
-        EEH_MSG_Template::_set_autoloader();
-        foreach ($message_types as $message_type) {
-            // if this is global template generation.
-            if ($global) {
-                // let's attempt to get the GRP_ID for this combo IF GRP_ID is empty.
-                if (empty($GRP_ID)) {
-                    $GRP_ID = EEM_Message_Template_Group::instance()->get_one(
-                        array(
-                            array(
-                                'MTP_messenger'    => $messenger,
-                                'MTP_message_type' => $message_type,
-                                'MTP_is_global'    => true,
-                            ),
-                        )
-                    );
-                    $GRP_ID = $GRP_ID instanceof EE_Message_Template_Group ? $GRP_ID->ID() : 0;
-                }
-                // First let's determine if we already HAVE global templates for this messenger and message_type combination.
-                //  If we do then NO generation!!
-                if (EEH_MSG_Template::already_generated($messenger, $message_type, $GRP_ID)) {
-                    $templates[] = array(
-                        'GRP_ID' => $GRP_ID,
-                        'MTP_context' => '',
-                    );
-                    // we already have generated templates for this so let's go to the next message type.
-                    continue;
-                }
-            }
-            $new_message_template_group = EEH_MSG_Template::create_new_templates($messenger, $message_type, $GRP_ID, $global);
-
-            if (! $new_message_template_group) {
-                continue;
-            }
-            $templates[] = $new_message_template_group;
-        }
-
-        return $templates;
-    }
-
-
-    /**
-     * The purpose of this method is to determine if there are already generated templates in the database for the
-     * given variables.
-     *
-     * @param string $messenger    messenger
-     * @param string $message_type message type
-     * @param int    $GRP_ID       GRP ID ( if a custom template) (if not provided then we're just doing global
-     *                             template check)
-     * @return bool                true = generated, false = hasn't been generated.
-     * @throws EE_Error
-     */
-    public static function already_generated($messenger, $message_type, $GRP_ID = 0)
-    {
-        EEH_MSG_Template::_set_autoloader();
-        // what method we use depends on whether we have an GRP_ID or not
-        $count = empty($GRP_ID)
-            ? EEM_Message_Template::instance()->count(
-                array(
-                    array(
-                        'Message_Template_Group.MTP_messenger'    => $messenger,
-                        'Message_Template_Group.MTP_message_type' => $message_type,
-                        'Message_Template_Group.MTP_is_global'    => true
-                    )
-                )
-            )
-            : EEM_Message_Template::instance()->count(array( array( 'GRP_ID' => $GRP_ID ) ));
-
-        return $count > 0;
-    }
-
-
-    /**
-     * Updates all message templates matching the incoming messengers and message types to active status.
-     *
-     * @static
-     * @param array $messenger_names    Messenger slug
-     * @param array $message_type_names Message type slug
-     * @return  int                         count of updated records.
-     * @throws EE_Error
-     */
-    public static function update_to_active($messenger_names, $message_type_names)
-    {
-        $messenger_names = is_array($messenger_names) ? $messenger_names : array( $messenger_names );
-        $message_type_names = is_array($message_type_names) ? $message_type_names : array( $message_type_names );
-        return EEM_Message_Template_Group::instance()->update(
-            array( 'MTP_is_active' => 1 ),
-            array(
-                array(
-                    'MTP_messenger'     => array( 'IN', $messenger_names ),
-                    'MTP_message_type'  => array( 'IN', $message_type_names )
-                )
-            )
-        );
-    }
-
-
-    /**
-     * Updates all message template groups matching the incoming arguments to inactive status.
-     *
-     * @static
-     * @param array $messenger_names    The messenger slugs.
-     *                                  If empty then all templates matching the message types are marked inactive.
-     *                                  Otherwise only templates matching the messengers and message types.
-     * @param array $message_type_names The message type slugs.
-     *                                  If empty then all templates matching the messengers are marked inactive.
-     *                                  Otherwise only templates matching the messengers and message types.
-     *
-     * @return int  count of updated records.
-     * @throws EE_Error
-     */
-    public static function update_to_inactive($messenger_names = array(), $message_type_names = array())
-    {
-        return EEM_Message_Template_Group::instance()->deactivate_message_template_groups_for(
-            $messenger_names,
-            $message_type_names
-        );
-    }
-
-
-    /**
-     * The purpose of this function is to return all installed message objects
-     * (messengers and message type regardless of whether they are ACTIVE or not)
-     *
-     * @param string $type
-     * @return array array consisting of installed messenger objects and installed message type objects.
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @deprecated 4.9.0
-     * @static
-     */
-    public static function get_installed_message_objects($type = 'all')
-    {
-        self::_set_autoloader();
-        $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        return array(
-            'messenger' => $message_resource_manager->installed_messengers(),
-            'message_type' => $message_resource_manager->installed_message_types()
-        );
-    }
-
-
-    /**
-     * This will return an array of shortcodes => labels from the
-     * messenger and message_type objects associated with this
-     * template.
-     *
-     * @param string $message_type
-     * @param string $messenger
-     * @param array  $fields                        What fields we're returning valid shortcodes for.
-     *                                              If empty then we assume all fields are to be returned. Optional.
-     * @param string $context                       What context we're going to return shortcodes for. Optional.
-     * @param bool   $merged                        If TRUE then we don't return shortcodes indexed by field,
-     *                                              but instead an array of the unique shortcodes for all the given (
-     *                                              or all) fields. Optional.
-     * @return array                                an array of shortcodes in the format
-     *                                              array( '[shortcode] => 'label')
-     *                                              OR
-     *                                              FALSE if no shortcodes found.
-     * @throws ReflectionException
-     * @throws EE_Error*@since 4.3.0
-     *
-     */
-    public static function get_shortcodes(
-        $message_type,
-        $messenger,
-        $fields = array(),
-        $context = 'admin',
-        $merged = false
-    ) {
-        $messenger_name = str_replace(' ', '_', ucwords(str_replace('_', ' ', $messenger)));
-        $mt_name = str_replace(' ', '_', ucwords(str_replace('_', ' ', $message_type)));
-        /** @var EE_Message_Resource_Manager $message_resource_manager */
-        $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        // convert slug to object
-        $messenger = $message_resource_manager->get_messenger($messenger);
-
-        // if messenger isn't a EE_messenger resource then bail.
-        if (! $messenger instanceof EE_messenger) {
-            return array();
-        }
-
-        // validate class for getting our list of shortcodes
-        $classname = 'EE_Messages_' . $messenger_name . '_' . $mt_name . '_Validator';
-        if (! class_exists($classname)) {
-            $msg[] = esc_html__('The Validator class was unable to load', 'event_espresso');
-            $msg[] = sprintf(
-                esc_html__('The class name compiled was %s. Please check and make sure the spelling and case is correct for the class name and that there is an autoloader in place for this class', 'event_espresso'),
-                $classname
-            );
-            throw new EE_Error(implode('||', $msg));
-        }
-
-        /** @type EE_Messages_Validator $_VLD */
-        $_VLD = new $classname(array(), $context);
-        $valid_shortcodes = $_VLD->get_validators();
-
-        // let's make sure we're only getting the shortcode part of the validators
-        $shortcodes = array();
-        foreach ($valid_shortcodes as $field => $validators) {
-            $shortcodes[ $field ] = $validators['shortcodes'];
-        }
-        $valid_shortcodes = $shortcodes;
-
-        // if not all fields let's make sure we ONLY include the shortcodes for the specified fields.
-        if (! empty($fields)) {
-            $specified_shortcodes = array();
-            foreach ($fields as $field) {
-                if (isset($valid_shortcodes[ $field ])) {
-                    $specified_shortcodes[ $field ] = $valid_shortcodes[ $field ];
-                }
-            }
-            $valid_shortcodes = $specified_shortcodes;
-        }
-
-        // if not merged then let's replace the fields with the localized fields
-        if (! $merged) {
-            // let's get all the fields for the set messenger so that we can get the localized label and use that in the returned array.
-            $field_settings = $messenger->get_template_fields();
-            $localized = array();
-            foreach ($valid_shortcodes as $field => $shortcodes) {
-                // get localized field label
-                if (isset($field_settings[ $field ])) {
-                    // possible that this is used as a main field.
-                    if (empty($field_settings[ $field ])) {
-                        if (isset($field_settings['extra'][ $field ])) {
-                            $_field = $field_settings['extra'][ $field ]['main']['label'];
-                        } else {
-                            $_field = $field;
-                        }
-                    } else {
-                        $_field = $field_settings[ $field ]['label'];
-                    }
-                } elseif (isset($field_settings['extra'])) {
-                    // loop through extra "main fields" and see if any of their children have our field
-                    foreach ($field_settings['extra'] as $fields) {
-                        if (isset($fields[ $field ])) {
-                            $_field = $fields[ $field ]['label'];
-                        } else {
-                            $_field = $field;
-                        }
-                    }
-                } else {
-                    $_field = $field;
-                }
-                if (isset($_field)) {
-                    $localized[ (string) $_field ] = $shortcodes;
-                }
-            }
-            $valid_shortcodes = $localized;
-        }
-
-        // if $merged then let's merge all the shortcodes into one list NOT indexed by field.
-        if ($merged) {
-            $merged_codes = array();
-            foreach ($valid_shortcodes as $shortcode) {
-                foreach ($shortcode as $code => $label) {
-                    if (isset($merged_codes[ $code ])) {
-                        continue;
-                    } else {
-                        $merged_codes[ $code ] = $label;
-                    }
-                }
-            }
-            $valid_shortcodes = $merged_codes;
-        }
-
-        return $valid_shortcodes;
-    }
-
-
-    /**
-     * Get Messenger object.
-     *
-     * @param string $messenger messenger slug for the messenger object we want to retrieve.
-     * @return EE_messenger
-     * @throws ReflectionException
-     * @throws EE_Error*@since 4.3.0
-     * @deprecated 4.9.0
-     */
-    public static function messenger_obj($messenger)
-    {
-        /** @type EE_Message_Resource_Manager $Message_Resource_Manager */
-        $Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        return $Message_Resource_Manager->get_messenger($messenger);
-    }
-
-
-    /**
-     * get Message type object
-     *
-     * @param string $message_type the slug for the message type object to retrieve
-     * @return EE_message_type
-     * @throws ReflectionException
-     * @throws EE_Error*@since 4.3.0
-     * @deprecated 4.9.0
-     */
-    public static function message_type_obj($message_type)
-    {
-        /** @type EE_Message_Resource_Manager $Message_Resource_Manager */
-        $Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        return $Message_Resource_Manager->get_message_type($message_type);
-    }
-
-
-    /**
-     * Given a message_type slug, will return whether that message type is active in the system or not.
-     *
-     * @since    4.3.0
-     * @param string $message_type message type to check for.
-     * @return boolean
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function is_mt_active($message_type)
-    {
-        /** @type EE_Message_Resource_Manager $Message_Resource_Manager */
-        $Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        $active_mts = $Message_Resource_Manager->list_of_active_message_types();
-        return in_array($message_type, $active_mts);
-    }
-
-
-    /**
-     * Given a messenger slug, will return whether that messenger is active in the system or not.
-     *
-     * @since    4.3.0
-     *
-     * @param string $messenger slug for messenger to check.
-     * @return boolean
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function is_messenger_active($messenger)
-    {
-        /** @type EE_Message_Resource_Manager $Message_Resource_Manager */
-        $Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        $active_messenger = $Message_Resource_Manager->get_active_messenger($messenger);
-        return $active_messenger instanceof EE_messenger;
-    }
-
-
-    /**
-     * Used to return active messengers array stored in the wp options table.
-     * If no value is present in the option then an empty array is returned.
-     *
-     * @deprecated 4.9
-     * @since      4.3.1
-     *
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function get_active_messengers_in_db()
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__('Please use EE_Message_Resource_Manager::get_active_messengers_option() instead.', 'event_espresso'),
-            '4.9.0'
-        );
-        /** @var EE_Message_Resource_Manager $Message_Resource_Manager */
-        $Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        return $Message_Resource_Manager->get_active_messengers_option();
-    }
-
-
-    /**
-     * Used to update the active messengers array stored in the wp options table.
-     *
-     * @since      4.3.1
-     * @deprecated 4.9.0
-     *
-     * @param array $data_to_save Incoming data to save.
-     *
-     * @return bool FALSE if not updated, TRUE if updated.
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function update_active_messengers_in_db($data_to_save)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__('Please use EE_Message_Resource_Manager::update_active_messengers_option() instead.', 'event_espresso'),
-            '4.9.0'
-        );
-        /** @var EE_Message_Resource_Manager $Message_Resource_Manager */
-        $Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        return $Message_Resource_Manager->update_active_messengers_option($data_to_save);
-    }
-
-
-    /**
-     * This does some validation of incoming params, determines what type of url is being prepped and returns the
-     * appropriate url trigger
-     *
-     * @param EE_message_type $message_type
-     * @param EE_Message $message
-     * @param EE_Registration | null $registration  The registration object must be included if this
-     *                                              is going to be a registration trigger url.
-     * @param string $sending_messenger             The (optional) sending messenger for the url.
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public static function get_url_trigger(
-        EE_message_type $message_type,
-        EE_Message $message,
-        $registration = null,
-        $sending_messenger = ''
-    ) {
-        // first determine if the url can be to the EE_Message object.
-        if (! $message_type->always_generate()) {
-            return EEH_MSG_Template::generate_browser_trigger($message);
-        }
-
-        // if $registration object is not valid then exit early because there's nothing that can be generated.
-        if (! $registration instanceof EE_Registration) {
-            throw new EE_Error(
-                esc_html__('Incoming value for registration is not a valid EE_Registration object.', 'event_espresso')
-            );
-        }
-
-        // validate given context
-        $contexts = $message_type->get_contexts();
-        if ($message->context() !== '' && ! isset($contexts[ $message->context() ])) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__('The context %s is not a valid context for %s.', 'event_espresso'),
-                    $message->context(),
-                    get_class($message_type)
-                )
-            );
-        }
-
-        // valid sending messenger but only if sending messenger set.  Otherwise generating messenger is used.
-        if (! empty($sending_messenger)) {
-            $with_messengers = $message_type->with_messengers();
-            if (
-                ! isset($with_messengers[ $message->messenger() ])
-                 || ! in_array($sending_messenger, $with_messengers[ $message->messenger() ])
-            ) {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            'The given sending messenger string (%1$s) does not match a valid sending messenger with the %2$s.  If this is incorrect, make sure that the message type has defined this messenger as a sending messenger in its $_with_messengers array.',
-                            'event_espresso'
-                        ),
-                        $sending_messenger,
-                        get_class($message_type)
-                    )
-                );
-            }
-        } else {
-            $sending_messenger = $message->messenger();
-        }
-        return EEH_MSG_Template::generate_url_trigger(
-            $sending_messenger,
-            $message->messenger(),
-            $message->context(),
-            $message->message_type(),
-            $registration,
-            $message->GRP_ID()
-        );
-    }
-
-
-    /**
-     * This returns the url for triggering a in browser view of a specific EE_Message object.
-     * @param EE_Message $message
-     * @return string.
-     */
-    public static function generate_browser_trigger(EE_Message $message)
-    {
-        $query_args = array(
-            'ee' => 'msg_browser_trigger',
-            'token' => $message->MSG_token()
-        );
-        return apply_filters(
-            'FHEE__EEH_MSG_Template__generate_browser_trigger',
-            add_query_arg($query_args, site_url()),
-            $message
-        );
-    }
-
-
-
-
-
-
-    /**
-     * This returns the url for triggering an in browser view of the error saved on the incoming message object.
-     * @param EE_Message $message
-     * @return string
-     */
-    public static function generate_error_display_trigger(EE_Message $message)
-    {
-        return apply_filters(
-            'FHEE__EEH_MSG_Template__generate_error_display_trigger',
-            add_query_arg(
-                array(
-                    'ee' => 'msg_browser_error_trigger',
-                    'token' => $message->MSG_token()
-                ),
-                site_url()
-            ),
-            $message
-        );
-    }
-
-
-    /**
-     * This generates a url trigger for the msg_url_trigger route using the given arguments
-     *
-     * @param string          $sending_messenger      The sending messenger slug.
-     * @param string          $generating_messenger   The generating messenger slug.
-     * @param string          $context                The context for the template.
-     * @param string          $message_type           The message type slug
-     * @param EE_Registration $registration
-     * @param integer         $message_template_group id   The EE_Message_Template_Group ID for the template.
-     * @param integer         $data_id                The id to the EE_Base_Class for getting the data used by the
-     *                                                trigger.
-     * @return string          The generated url.
-     * @throws EE_Error
-     */
-    public static function generate_url_trigger(
-        $sending_messenger,
-        $generating_messenger,
-        $context,
-        $message_type,
-        EE_Registration $registration,
-        $message_template_group,
-        $data_id = 0
-    ) {
-        $query_args = array(
-            'ee' => 'msg_url_trigger',
-            'snd_msgr' => $sending_messenger,
-            'gen_msgr' => $generating_messenger,
-            'message_type' => $message_type,
-            'context' => $context,
-            'token' => $registration->reg_url_link(),
-            'GRP_ID' => $message_template_group,
-            'id' => $data_id
-            );
-        $url = add_query_arg($query_args, get_home_url());
-
-        // made it here so now we can just get the url and filter it.  Filtered globally and by message type.
-        return apply_filters(
-            'FHEE__EEH_MSG_Template__generate_url_trigger',
-            $url,
-            $sending_messenger,
-            $generating_messenger,
-            $context,
-            $message_type,
-            $registration,
-            $message_template_group,
-            $data_id
-        );
-    }
-
-
-
-
-    /**
-     * Return the specific css for the action icon given.
-     *
-     * @param string $type  What action to return.
-     * @return string[]
-     * @since 4.9.0
-     */
-    public static function get_message_action_icon($type)
-    {
-        $action_icons = self::get_message_action_icons();
-        return isset($action_icons[ $type ]) ? $action_icons[ $type ] : [];
-    }
-
-
-    /**
-     * This is used for retrieving the css classes used for the icons representing message actions.
-     *
-     * @since 4.9.0
-     *
-     * @return array
-     */
-    public static function get_message_action_icons()
-    {
-        return apply_filters(
-            'FHEE__EEH_MSG_Template__message_action_icons',
-            array(
-                'view' => array(
-                    'label' => esc_html__('View Message', 'event_espresso'),
-                    'css_class' => 'dashicons dashicons-visibility',
-                ),
-                'error' => array(
-                    'label' => esc_html__('View Error Message', 'event_espresso'),
-                    'css_class' => 'dashicons dashicons-info',
-                ),
-                'see_notifications_for' => array(
-                    'label' => esc_html__('View Related Messages', 'event_espresso'),
-                    'css_class' => 'dashicons dashicons-megaphone',
-                ),
-                'generate_now' => array(
-                    'label' => esc_html__('Generate the message now.', 'event_espresso'),
-                    'css_class' => 'dashicons dashicons-admin-tools',
-                ),
-                'send_now' => array(
-                    'label' => esc_html__('Send Immediately', 'event_espresso'),
-                    'css_class' => 'dashicons dashicons-controls-forward',
-                ),
-                'queue_for_resending' => array(
-                    'label' => esc_html__('Queue for Resending', 'event_espresso'),
-                    'css_class' => 'dashicons dashicons-controls-repeat',
-                ),
-                'view_transaction' => array(
-                    'label' => esc_html__('View related Transaction', 'event_espresso'),
-                    'css_class' => 'dashicons dashicons-cart',
-                )
-            )
-        );
-    }
-
-
-    /**
-     * This returns the url for a given action related to EE_Message.
-     *
-     * @param string     $type         What type of action to return the url for.
-     * @param EE_Message $message      Required for generating the correct url for some types.
-     * @param array      $query_params Any additional query params to be included with the generated url.
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since 4.9.0
-     *
-     */
-    public static function get_message_action_url($type, EE_Message $message = null, $query_params = array())
-    {
-        $action_urls = self::get_message_action_urls($message, $query_params);
-        return isset($action_urls[ $type ])  ? $action_urls[ $type ] : '';
-    }
-
-
-    /**
-     * This returns all the current urls for EE_Message actions.
-     *
-     * @since 4.9.0
-     *
-     * @param EE_Message $message      The EE_Message object required to generate correct urls for some types.
-     * @param array      $query_params Any additional query_params to be included with the generated url.
-     *
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function get_message_action_urls(EE_Message $message = null, $query_params = array())
-    {
-        EE_Registry::instance()->load_helper('URL');
-        // if $message is not an instance of EE_Message then let's just do a dummy.
-        $message = empty($message) ? EE_Message_Factory::create() : $message;
-        $action_urls =  apply_filters(
-            'FHEE__EEH_MSG_Template__get_message_action_url',
-            array(
-                'view' => EEH_MSG_Template::generate_browser_trigger($message),
-                'error' => EEH_MSG_Template::generate_error_display_trigger($message),
-                'see_notifications_for' => EEH_URL::add_query_args_and_nonce(
-                    array_merge(
-                        array(
-                            'page' => 'espresso_messages',
-                            'action' => 'default',
-                            'filterby' => 1,
-                        ),
-                        $query_params
-                    ),
-                    admin_url('admin.php')
-                ),
-                'generate_now' => EEH_URL::add_query_args_and_nonce(
-                    array(
-                        'page' => 'espresso_messages',
-                        'action' => 'generate_now',
-                        'MSG_ID' => $message->ID()
-                    ),
-                    admin_url('admin.php')
-                ),
-                'send_now' => EEH_URL::add_query_args_and_nonce(
-                    array(
-                        'page' => 'espresso_messages',
-                        'action' => 'send_now',
-                        'MSG_ID' => $message->ID()
-                    ),
-                    admin_url('admin.php')
-                ),
-                'queue_for_resending' => EEH_URL::add_query_args_and_nonce(
-                    array(
-                        'page' => 'espresso_messages',
-                        'action' => 'queue_for_resending',
-                        'MSG_ID' => $message->ID()
-                    ),
-                    admin_url('admin.php')
-                ),
-            )
-        );
-        if (
-            $message->TXN_ID() > 0
-            && EE_Registry::instance()->CAP->current_user_can(
-                'ee_read_transaction',
-                'espresso_transactions_default',
-                $message->TXN_ID()
-            )
-        ) {
-            $action_urls['view_transaction'] = EEH_URL::add_query_args_and_nonce(
-                array(
-                    'page' => 'espresso_transactions',
-                    'action' => 'view_transaction',
-                    'TXN_ID' => $message->TXN_ID()
-                ),
-                admin_url('admin.php')
-            );
-        } else {
-            $action_urls['view_transaction'] = '';
-        }
-        return $action_urls;
-    }
-
-
-    /**
-     * This returns a generated link html including the icon used for the action link for EE_Message actions.
-     *
-     * @param string          $type         What type of action the link is for (if invalid type is passed in then an
-     *                                      empty string is returned)
-     * @param EE_Message|null $message      The EE_Message object (required for some actions to generate correctly)
-     * @param array           $query_params Any extra query params to include in the generated link.
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since 4.9.0
-     *
-     */
-    public static function get_message_action_link($type, EE_Message $message = null, $query_params = array())
-    {
-        $url = EEH_MSG_Template::get_message_action_url($type, $message, $query_params);
-        $icon_css = EEH_MSG_Template::get_message_action_icon($type);
-        $label = $icon_css['label'] ?? null;
-        $label = $label ? 'aria-label="' . $label . '"' : '';
-        $class = $label ? ' ee-aria-tooltip' : '';
-
-        if (empty($url) || empty($icon_css) || ! isset($icon_css['css_class'])) {
-            return '';
-        }
-
-        $icon_css_class = $icon_css['css_class'] . apply_filters(
-            'FHEE__EEH_MSG_Template__get_message_action_link__icon_css_class',
-            ' js-ee-message-action-link ee-message-action-link-' . $type,
-            $type,
-            $message,
-            $query_params
-        );
-
-        return '
+	/**
+	 * Holds a collection of EE_Message_Template_Pack objects.
+	 * @type EE_Messages_Template_Pack_Collection
+	 */
+	protected static $_template_pack_collection;
+
+
+	/**
+	 * @throws EE_Error
+	 */
+	private static function _set_autoloader()
+	{
+		EED_Messages::set_autoloaders();
+	}
+
+
+	/**
+	 * generate_new_templates
+	 * This will handle the messenger, message_type selection when "adding a new custom template" for an event and will
+	 * automatically create the defaults for the event.  The user would then be redirected to edit the default context
+	 * for the event.
+	 *
+	 * @access protected
+	 * @param string $messenger     the messenger we are generating templates for
+	 * @param array  $message_types array of message types that the templates are generated for.
+	 * @param int    $GRP_ID        If a non global template is being generated then it is expected we'll have a GRP_ID
+	 *                              to use as the base for the new generated template.
+	 * @param bool   $global        true indicates generating templates on messenger activation. false requires GRP_ID
+	 *                              for event specific template generation.
+	 * @return array  @see EEH_MSG_Template::_create_new_templates for the return value of each element in the array
+	 *                for templates that are generated.  If this is an empty array then it means no templates were
+	 *                generated which usually means there was an error.  Anything in the array with an empty value for
+	 *                `MTP_context` means that it was not a new generated template but just reactivated (which only
+	 *                happens for global templates that already exist in the database.
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function generate_new_templates($messenger, $message_types, $GRP_ID = 0, $global = false)
+	{
+		// make sure message_type is an array.
+		$message_types = (array) $message_types;
+		$templates = array();
+
+		if (empty($messenger)) {
+			throw new EE_Error(esc_html__('We need a messenger to generate templates!', 'event_espresso'));
+		}
+
+		// if we STILL have empty $message_types then we need to generate an error message b/c we NEED message types to do the template files.
+		if (empty($message_types)) {
+			throw new EE_Error(esc_html__('We need at least one message type to generate templates!', 'event_espresso'));
+		}
+
+		EEH_MSG_Template::_set_autoloader();
+		foreach ($message_types as $message_type) {
+			// if this is global template generation.
+			if ($global) {
+				// let's attempt to get the GRP_ID for this combo IF GRP_ID is empty.
+				if (empty($GRP_ID)) {
+					$GRP_ID = EEM_Message_Template_Group::instance()->get_one(
+						array(
+							array(
+								'MTP_messenger'    => $messenger,
+								'MTP_message_type' => $message_type,
+								'MTP_is_global'    => true,
+							),
+						)
+					);
+					$GRP_ID = $GRP_ID instanceof EE_Message_Template_Group ? $GRP_ID->ID() : 0;
+				}
+				// First let's determine if we already HAVE global templates for this messenger and message_type combination.
+				//  If we do then NO generation!!
+				if (EEH_MSG_Template::already_generated($messenger, $message_type, $GRP_ID)) {
+					$templates[] = array(
+						'GRP_ID' => $GRP_ID,
+						'MTP_context' => '',
+					);
+					// we already have generated templates for this so let's go to the next message type.
+					continue;
+				}
+			}
+			$new_message_template_group = EEH_MSG_Template::create_new_templates($messenger, $message_type, $GRP_ID, $global);
+
+			if (! $new_message_template_group) {
+				continue;
+			}
+			$templates[] = $new_message_template_group;
+		}
+
+		return $templates;
+	}
+
+
+	/**
+	 * The purpose of this method is to determine if there are already generated templates in the database for the
+	 * given variables.
+	 *
+	 * @param string $messenger    messenger
+	 * @param string $message_type message type
+	 * @param int    $GRP_ID       GRP ID ( if a custom template) (if not provided then we're just doing global
+	 *                             template check)
+	 * @return bool                true = generated, false = hasn't been generated.
+	 * @throws EE_Error
+	 */
+	public static function already_generated($messenger, $message_type, $GRP_ID = 0)
+	{
+		EEH_MSG_Template::_set_autoloader();
+		// what method we use depends on whether we have an GRP_ID or not
+		$count = empty($GRP_ID)
+			? EEM_Message_Template::instance()->count(
+				array(
+					array(
+						'Message_Template_Group.MTP_messenger'    => $messenger,
+						'Message_Template_Group.MTP_message_type' => $message_type,
+						'Message_Template_Group.MTP_is_global'    => true
+					)
+				)
+			)
+			: EEM_Message_Template::instance()->count(array( array( 'GRP_ID' => $GRP_ID ) ));
+
+		return $count > 0;
+	}
+
+
+	/**
+	 * Updates all message templates matching the incoming messengers and message types to active status.
+	 *
+	 * @static
+	 * @param array $messenger_names    Messenger slug
+	 * @param array $message_type_names Message type slug
+	 * @return  int                         count of updated records.
+	 * @throws EE_Error
+	 */
+	public static function update_to_active($messenger_names, $message_type_names)
+	{
+		$messenger_names = is_array($messenger_names) ? $messenger_names : array( $messenger_names );
+		$message_type_names = is_array($message_type_names) ? $message_type_names : array( $message_type_names );
+		return EEM_Message_Template_Group::instance()->update(
+			array( 'MTP_is_active' => 1 ),
+			array(
+				array(
+					'MTP_messenger'     => array( 'IN', $messenger_names ),
+					'MTP_message_type'  => array( 'IN', $message_type_names )
+				)
+			)
+		);
+	}
+
+
+	/**
+	 * Updates all message template groups matching the incoming arguments to inactive status.
+	 *
+	 * @static
+	 * @param array $messenger_names    The messenger slugs.
+	 *                                  If empty then all templates matching the message types are marked inactive.
+	 *                                  Otherwise only templates matching the messengers and message types.
+	 * @param array $message_type_names The message type slugs.
+	 *                                  If empty then all templates matching the messengers are marked inactive.
+	 *                                  Otherwise only templates matching the messengers and message types.
+	 *
+	 * @return int  count of updated records.
+	 * @throws EE_Error
+	 */
+	public static function update_to_inactive($messenger_names = array(), $message_type_names = array())
+	{
+		return EEM_Message_Template_Group::instance()->deactivate_message_template_groups_for(
+			$messenger_names,
+			$message_type_names
+		);
+	}
+
+
+	/**
+	 * The purpose of this function is to return all installed message objects
+	 * (messengers and message type regardless of whether they are ACTIVE or not)
+	 *
+	 * @param string $type
+	 * @return array array consisting of installed messenger objects and installed message type objects.
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @deprecated 4.9.0
+	 * @static
+	 */
+	public static function get_installed_message_objects($type = 'all')
+	{
+		self::_set_autoloader();
+		$message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		return array(
+			'messenger' => $message_resource_manager->installed_messengers(),
+			'message_type' => $message_resource_manager->installed_message_types()
+		);
+	}
+
+
+	/**
+	 * This will return an array of shortcodes => labels from the
+	 * messenger and message_type objects associated with this
+	 * template.
+	 *
+	 * @param string $message_type
+	 * @param string $messenger
+	 * @param array  $fields                        What fields we're returning valid shortcodes for.
+	 *                                              If empty then we assume all fields are to be returned. Optional.
+	 * @param string $context                       What context we're going to return shortcodes for. Optional.
+	 * @param bool   $merged                        If TRUE then we don't return shortcodes indexed by field,
+	 *                                              but instead an array of the unique shortcodes for all the given (
+	 *                                              or all) fields. Optional.
+	 * @return array                                an array of shortcodes in the format
+	 *                                              array( '[shortcode] => 'label')
+	 *                                              OR
+	 *                                              FALSE if no shortcodes found.
+	 * @throws ReflectionException
+	 * @throws EE_Error*@since 4.3.0
+	 *
+	 */
+	public static function get_shortcodes(
+		$message_type,
+		$messenger,
+		$fields = array(),
+		$context = 'admin',
+		$merged = false
+	) {
+		$messenger_name = str_replace(' ', '_', ucwords(str_replace('_', ' ', $messenger)));
+		$mt_name = str_replace(' ', '_', ucwords(str_replace('_', ' ', $message_type)));
+		/** @var EE_Message_Resource_Manager $message_resource_manager */
+		$message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		// convert slug to object
+		$messenger = $message_resource_manager->get_messenger($messenger);
+
+		// if messenger isn't a EE_messenger resource then bail.
+		if (! $messenger instanceof EE_messenger) {
+			return array();
+		}
+
+		// validate class for getting our list of shortcodes
+		$classname = 'EE_Messages_' . $messenger_name . '_' . $mt_name . '_Validator';
+		if (! class_exists($classname)) {
+			$msg[] = esc_html__('The Validator class was unable to load', 'event_espresso');
+			$msg[] = sprintf(
+				esc_html__('The class name compiled was %s. Please check and make sure the spelling and case is correct for the class name and that there is an autoloader in place for this class', 'event_espresso'),
+				$classname
+			);
+			throw new EE_Error(implode('||', $msg));
+		}
+
+		/** @type EE_Messages_Validator $_VLD */
+		$_VLD = new $classname(array(), $context);
+		$valid_shortcodes = $_VLD->get_validators();
+
+		// let's make sure we're only getting the shortcode part of the validators
+		$shortcodes = array();
+		foreach ($valid_shortcodes as $field => $validators) {
+			$shortcodes[ $field ] = $validators['shortcodes'];
+		}
+		$valid_shortcodes = $shortcodes;
+
+		// if not all fields let's make sure we ONLY include the shortcodes for the specified fields.
+		if (! empty($fields)) {
+			$specified_shortcodes = array();
+			foreach ($fields as $field) {
+				if (isset($valid_shortcodes[ $field ])) {
+					$specified_shortcodes[ $field ] = $valid_shortcodes[ $field ];
+				}
+			}
+			$valid_shortcodes = $specified_shortcodes;
+		}
+
+		// if not merged then let's replace the fields with the localized fields
+		if (! $merged) {
+			// let's get all the fields for the set messenger so that we can get the localized label and use that in the returned array.
+			$field_settings = $messenger->get_template_fields();
+			$localized = array();
+			foreach ($valid_shortcodes as $field => $shortcodes) {
+				// get localized field label
+				if (isset($field_settings[ $field ])) {
+					// possible that this is used as a main field.
+					if (empty($field_settings[ $field ])) {
+						if (isset($field_settings['extra'][ $field ])) {
+							$_field = $field_settings['extra'][ $field ]['main']['label'];
+						} else {
+							$_field = $field;
+						}
+					} else {
+						$_field = $field_settings[ $field ]['label'];
+					}
+				} elseif (isset($field_settings['extra'])) {
+					// loop through extra "main fields" and see if any of their children have our field
+					foreach ($field_settings['extra'] as $fields) {
+						if (isset($fields[ $field ])) {
+							$_field = $fields[ $field ]['label'];
+						} else {
+							$_field = $field;
+						}
+					}
+				} else {
+					$_field = $field;
+				}
+				if (isset($_field)) {
+					$localized[ (string) $_field ] = $shortcodes;
+				}
+			}
+			$valid_shortcodes = $localized;
+		}
+
+		// if $merged then let's merge all the shortcodes into one list NOT indexed by field.
+		if ($merged) {
+			$merged_codes = array();
+			foreach ($valid_shortcodes as $shortcode) {
+				foreach ($shortcode as $code => $label) {
+					if (isset($merged_codes[ $code ])) {
+						continue;
+					} else {
+						$merged_codes[ $code ] = $label;
+					}
+				}
+			}
+			$valid_shortcodes = $merged_codes;
+		}
+
+		return $valid_shortcodes;
+	}
+
+
+	/**
+	 * Get Messenger object.
+	 *
+	 * @param string $messenger messenger slug for the messenger object we want to retrieve.
+	 * @return EE_messenger
+	 * @throws ReflectionException
+	 * @throws EE_Error*@since 4.3.0
+	 * @deprecated 4.9.0
+	 */
+	public static function messenger_obj($messenger)
+	{
+		/** @type EE_Message_Resource_Manager $Message_Resource_Manager */
+		$Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		return $Message_Resource_Manager->get_messenger($messenger);
+	}
+
+
+	/**
+	 * get Message type object
+	 *
+	 * @param string $message_type the slug for the message type object to retrieve
+	 * @return EE_message_type
+	 * @throws ReflectionException
+	 * @throws EE_Error*@since 4.3.0
+	 * @deprecated 4.9.0
+	 */
+	public static function message_type_obj($message_type)
+	{
+		/** @type EE_Message_Resource_Manager $Message_Resource_Manager */
+		$Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		return $Message_Resource_Manager->get_message_type($message_type);
+	}
+
+
+	/**
+	 * Given a message_type slug, will return whether that message type is active in the system or not.
+	 *
+	 * @since    4.3.0
+	 * @param string $message_type message type to check for.
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function is_mt_active($message_type)
+	{
+		/** @type EE_Message_Resource_Manager $Message_Resource_Manager */
+		$Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		$active_mts = $Message_Resource_Manager->list_of_active_message_types();
+		return in_array($message_type, $active_mts);
+	}
+
+
+	/**
+	 * Given a messenger slug, will return whether that messenger is active in the system or not.
+	 *
+	 * @since    4.3.0
+	 *
+	 * @param string $messenger slug for messenger to check.
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function is_messenger_active($messenger)
+	{
+		/** @type EE_Message_Resource_Manager $Message_Resource_Manager */
+		$Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		$active_messenger = $Message_Resource_Manager->get_active_messenger($messenger);
+		return $active_messenger instanceof EE_messenger;
+	}
+
+
+	/**
+	 * Used to return active messengers array stored in the wp options table.
+	 * If no value is present in the option then an empty array is returned.
+	 *
+	 * @deprecated 4.9
+	 * @since      4.3.1
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function get_active_messengers_in_db()
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__('Please use EE_Message_Resource_Manager::get_active_messengers_option() instead.', 'event_espresso'),
+			'4.9.0'
+		);
+		/** @var EE_Message_Resource_Manager $Message_Resource_Manager */
+		$Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		return $Message_Resource_Manager->get_active_messengers_option();
+	}
+
+
+	/**
+	 * Used to update the active messengers array stored in the wp options table.
+	 *
+	 * @since      4.3.1
+	 * @deprecated 4.9.0
+	 *
+	 * @param array $data_to_save Incoming data to save.
+	 *
+	 * @return bool FALSE if not updated, TRUE if updated.
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function update_active_messengers_in_db($data_to_save)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__('Please use EE_Message_Resource_Manager::update_active_messengers_option() instead.', 'event_espresso'),
+			'4.9.0'
+		);
+		/** @var EE_Message_Resource_Manager $Message_Resource_Manager */
+		$Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		return $Message_Resource_Manager->update_active_messengers_option($data_to_save);
+	}
+
+
+	/**
+	 * This does some validation of incoming params, determines what type of url is being prepped and returns the
+	 * appropriate url trigger
+	 *
+	 * @param EE_message_type $message_type
+	 * @param EE_Message $message
+	 * @param EE_Registration | null $registration  The registration object must be included if this
+	 *                                              is going to be a registration trigger url.
+	 * @param string $sending_messenger             The (optional) sending messenger for the url.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public static function get_url_trigger(
+		EE_message_type $message_type,
+		EE_Message $message,
+		$registration = null,
+		$sending_messenger = ''
+	) {
+		// first determine if the url can be to the EE_Message object.
+		if (! $message_type->always_generate()) {
+			return EEH_MSG_Template::generate_browser_trigger($message);
+		}
+
+		// if $registration object is not valid then exit early because there's nothing that can be generated.
+		if (! $registration instanceof EE_Registration) {
+			throw new EE_Error(
+				esc_html__('Incoming value for registration is not a valid EE_Registration object.', 'event_espresso')
+			);
+		}
+
+		// validate given context
+		$contexts = $message_type->get_contexts();
+		if ($message->context() !== '' && ! isset($contexts[ $message->context() ])) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__('The context %s is not a valid context for %s.', 'event_espresso'),
+					$message->context(),
+					get_class($message_type)
+				)
+			);
+		}
+
+		// valid sending messenger but only if sending messenger set.  Otherwise generating messenger is used.
+		if (! empty($sending_messenger)) {
+			$with_messengers = $message_type->with_messengers();
+			if (
+				! isset($with_messengers[ $message->messenger() ])
+				 || ! in_array($sending_messenger, $with_messengers[ $message->messenger() ])
+			) {
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							'The given sending messenger string (%1$s) does not match a valid sending messenger with the %2$s.  If this is incorrect, make sure that the message type has defined this messenger as a sending messenger in its $_with_messengers array.',
+							'event_espresso'
+						),
+						$sending_messenger,
+						get_class($message_type)
+					)
+				);
+			}
+		} else {
+			$sending_messenger = $message->messenger();
+		}
+		return EEH_MSG_Template::generate_url_trigger(
+			$sending_messenger,
+			$message->messenger(),
+			$message->context(),
+			$message->message_type(),
+			$registration,
+			$message->GRP_ID()
+		);
+	}
+
+
+	/**
+	 * This returns the url for triggering a in browser view of a specific EE_Message object.
+	 * @param EE_Message $message
+	 * @return string.
+	 */
+	public static function generate_browser_trigger(EE_Message $message)
+	{
+		$query_args = array(
+			'ee' => 'msg_browser_trigger',
+			'token' => $message->MSG_token()
+		);
+		return apply_filters(
+			'FHEE__EEH_MSG_Template__generate_browser_trigger',
+			add_query_arg($query_args, site_url()),
+			$message
+		);
+	}
+
+
+
+
+
+
+	/**
+	 * This returns the url for triggering an in browser view of the error saved on the incoming message object.
+	 * @param EE_Message $message
+	 * @return string
+	 */
+	public static function generate_error_display_trigger(EE_Message $message)
+	{
+		return apply_filters(
+			'FHEE__EEH_MSG_Template__generate_error_display_trigger',
+			add_query_arg(
+				array(
+					'ee' => 'msg_browser_error_trigger',
+					'token' => $message->MSG_token()
+				),
+				site_url()
+			),
+			$message
+		);
+	}
+
+
+	/**
+	 * This generates a url trigger for the msg_url_trigger route using the given arguments
+	 *
+	 * @param string          $sending_messenger      The sending messenger slug.
+	 * @param string          $generating_messenger   The generating messenger slug.
+	 * @param string          $context                The context for the template.
+	 * @param string          $message_type           The message type slug
+	 * @param EE_Registration $registration
+	 * @param integer         $message_template_group id   The EE_Message_Template_Group ID for the template.
+	 * @param integer         $data_id                The id to the EE_Base_Class for getting the data used by the
+	 *                                                trigger.
+	 * @return string          The generated url.
+	 * @throws EE_Error
+	 */
+	public static function generate_url_trigger(
+		$sending_messenger,
+		$generating_messenger,
+		$context,
+		$message_type,
+		EE_Registration $registration,
+		$message_template_group,
+		$data_id = 0
+	) {
+		$query_args = array(
+			'ee' => 'msg_url_trigger',
+			'snd_msgr' => $sending_messenger,
+			'gen_msgr' => $generating_messenger,
+			'message_type' => $message_type,
+			'context' => $context,
+			'token' => $registration->reg_url_link(),
+			'GRP_ID' => $message_template_group,
+			'id' => $data_id
+			);
+		$url = add_query_arg($query_args, get_home_url());
+
+		// made it here so now we can just get the url and filter it.  Filtered globally and by message type.
+		return apply_filters(
+			'FHEE__EEH_MSG_Template__generate_url_trigger',
+			$url,
+			$sending_messenger,
+			$generating_messenger,
+			$context,
+			$message_type,
+			$registration,
+			$message_template_group,
+			$data_id
+		);
+	}
+
+
+
+
+	/**
+	 * Return the specific css for the action icon given.
+	 *
+	 * @param string $type  What action to return.
+	 * @return string[]
+	 * @since 4.9.0
+	 */
+	public static function get_message_action_icon($type)
+	{
+		$action_icons = self::get_message_action_icons();
+		return isset($action_icons[ $type ]) ? $action_icons[ $type ] : [];
+	}
+
+
+	/**
+	 * This is used for retrieving the css classes used for the icons representing message actions.
+	 *
+	 * @since 4.9.0
+	 *
+	 * @return array
+	 */
+	public static function get_message_action_icons()
+	{
+		return apply_filters(
+			'FHEE__EEH_MSG_Template__message_action_icons',
+			array(
+				'view' => array(
+					'label' => esc_html__('View Message', 'event_espresso'),
+					'css_class' => 'dashicons dashicons-visibility',
+				),
+				'error' => array(
+					'label' => esc_html__('View Error Message', 'event_espresso'),
+					'css_class' => 'dashicons dashicons-info',
+				),
+				'see_notifications_for' => array(
+					'label' => esc_html__('View Related Messages', 'event_espresso'),
+					'css_class' => 'dashicons dashicons-megaphone',
+				),
+				'generate_now' => array(
+					'label' => esc_html__('Generate the message now.', 'event_espresso'),
+					'css_class' => 'dashicons dashicons-admin-tools',
+				),
+				'send_now' => array(
+					'label' => esc_html__('Send Immediately', 'event_espresso'),
+					'css_class' => 'dashicons dashicons-controls-forward',
+				),
+				'queue_for_resending' => array(
+					'label' => esc_html__('Queue for Resending', 'event_espresso'),
+					'css_class' => 'dashicons dashicons-controls-repeat',
+				),
+				'view_transaction' => array(
+					'label' => esc_html__('View related Transaction', 'event_espresso'),
+					'css_class' => 'dashicons dashicons-cart',
+				)
+			)
+		);
+	}
+
+
+	/**
+	 * This returns the url for a given action related to EE_Message.
+	 *
+	 * @param string     $type         What type of action to return the url for.
+	 * @param EE_Message $message      Required for generating the correct url for some types.
+	 * @param array      $query_params Any additional query params to be included with the generated url.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since 4.9.0
+	 *
+	 */
+	public static function get_message_action_url($type, EE_Message $message = null, $query_params = array())
+	{
+		$action_urls = self::get_message_action_urls($message, $query_params);
+		return isset($action_urls[ $type ])  ? $action_urls[ $type ] : '';
+	}
+
+
+	/**
+	 * This returns all the current urls for EE_Message actions.
+	 *
+	 * @since 4.9.0
+	 *
+	 * @param EE_Message $message      The EE_Message object required to generate correct urls for some types.
+	 * @param array      $query_params Any additional query_params to be included with the generated url.
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function get_message_action_urls(EE_Message $message = null, $query_params = array())
+	{
+		EE_Registry::instance()->load_helper('URL');
+		// if $message is not an instance of EE_Message then let's just do a dummy.
+		$message = empty($message) ? EE_Message_Factory::create() : $message;
+		$action_urls =  apply_filters(
+			'FHEE__EEH_MSG_Template__get_message_action_url',
+			array(
+				'view' => EEH_MSG_Template::generate_browser_trigger($message),
+				'error' => EEH_MSG_Template::generate_error_display_trigger($message),
+				'see_notifications_for' => EEH_URL::add_query_args_and_nonce(
+					array_merge(
+						array(
+							'page' => 'espresso_messages',
+							'action' => 'default',
+							'filterby' => 1,
+						),
+						$query_params
+					),
+					admin_url('admin.php')
+				),
+				'generate_now' => EEH_URL::add_query_args_and_nonce(
+					array(
+						'page' => 'espresso_messages',
+						'action' => 'generate_now',
+						'MSG_ID' => $message->ID()
+					),
+					admin_url('admin.php')
+				),
+				'send_now' => EEH_URL::add_query_args_and_nonce(
+					array(
+						'page' => 'espresso_messages',
+						'action' => 'send_now',
+						'MSG_ID' => $message->ID()
+					),
+					admin_url('admin.php')
+				),
+				'queue_for_resending' => EEH_URL::add_query_args_and_nonce(
+					array(
+						'page' => 'espresso_messages',
+						'action' => 'queue_for_resending',
+						'MSG_ID' => $message->ID()
+					),
+					admin_url('admin.php')
+				),
+			)
+		);
+		if (
+			$message->TXN_ID() > 0
+			&& EE_Registry::instance()->CAP->current_user_can(
+				'ee_read_transaction',
+				'espresso_transactions_default',
+				$message->TXN_ID()
+			)
+		) {
+			$action_urls['view_transaction'] = EEH_URL::add_query_args_and_nonce(
+				array(
+					'page' => 'espresso_transactions',
+					'action' => 'view_transaction',
+					'TXN_ID' => $message->TXN_ID()
+				),
+				admin_url('admin.php')
+			);
+		} else {
+			$action_urls['view_transaction'] = '';
+		}
+		return $action_urls;
+	}
+
+
+	/**
+	 * This returns a generated link html including the icon used for the action link for EE_Message actions.
+	 *
+	 * @param string          $type         What type of action the link is for (if invalid type is passed in then an
+	 *                                      empty string is returned)
+	 * @param EE_Message|null $message      The EE_Message object (required for some actions to generate correctly)
+	 * @param array           $query_params Any extra query params to include in the generated link.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since 4.9.0
+	 *
+	 */
+	public static function get_message_action_link($type, EE_Message $message = null, $query_params = array())
+	{
+		$url = EEH_MSG_Template::get_message_action_url($type, $message, $query_params);
+		$icon_css = EEH_MSG_Template::get_message_action_icon($type);
+		$label = $icon_css['label'] ?? null;
+		$label = $label ? 'aria-label="' . $label . '"' : '';
+		$class = $label ? ' ee-aria-tooltip' : '';
+
+		if (empty($url) || empty($icon_css) || ! isset($icon_css['css_class'])) {
+			return '';
+		}
+
+		$icon_css_class = $icon_css['css_class'] . apply_filters(
+			'FHEE__EEH_MSG_Template__get_message_action_link__icon_css_class',
+			' js-ee-message-action-link ee-message-action-link-' . $type,
+			$type,
+			$message,
+			$query_params
+		);
+
+		return '
             <a href="' . $url . '" ' . $label . ' class="button button--icon-only' . $class . '">
                 <span class="' .  esc_attr($icon_css_class) . '"></span>
             </a>';
-    }
-
-
-
-
-
-    /**
-     * This returns an array with keys as reg statuses and values as the corresponding message type slug (filtered).
-     *
-     * @since 4.9.0
-     * @return array
-     */
-    public static function reg_status_to_message_type_array()
-    {
-        return (array) apply_filters(
-            'FHEE__EEH_MSG_Template__reg_status_to_message_type_array',
-            array(
-                EEM_Registration::status_id_approved => 'registration',
-                EEM_Registration::status_id_pending_payment => 'pending_approval',
-                EEM_Registration::status_id_not_approved => 'not_approved_registration',
-                EEM_Registration::status_id_cancelled => 'cancelled_registration',
-                EEM_Registration::status_id_declined => 'declined_registration'
-            )
-        );
-    }
-
-
-
-
-    /**
-     * This returns the corresponding registration message type slug to the given reg status. If there isn't a
-     * match, then returns an empty string.
-     *
-     * @since 4.9.0
-     * @param $reg_status
-     * @return string
-     */
-    public static function convert_reg_status_to_message_type($reg_status)
-    {
-        $reg_status_array = self::reg_status_to_message_type_array();
-        return isset($reg_status_array[ $reg_status ]) ? $reg_status_array[ $reg_status ] : '';
-    }
-
-
-    /**
-     * This returns an array with keys as payment stati and values as the corresponding message type slug (filtered).
-     *
-     * @since 4.9.0
-     * @return array
-     */
-    public static function payment_status_to_message_type_array()
-    {
-        return (array) apply_filters(
-            'FHEE__EEH_MSG_Template__payment_status_to_message_type_array',
-            array(
-                EEM_Payment::status_id_approved => 'payment',
-                EEM_Payment::status_id_pending => 'payment_pending',
-                EEM_Payment::status_id_cancelled => 'payment_cancelled',
-                EEM_Payment::status_id_declined => 'payment_declined',
-                EEM_Payment::status_id_failed => 'payment_failed'
-            )
-        );
-    }
-
-
-
-
-    /**
-     * This returns the corresponding payment message type slug to the given payment status. If there isn't a match then
-     * an empty string is returned
-     *
-     * @since 4.9.0
-     * @param $payment_status
-     * @return string
-     */
-    public static function convert_payment_status_to_message_type($payment_status)
-    {
-        $payment_status_array = self::payment_status_to_message_type_array();
-        return isset($payment_status_array[ $payment_status ]) ? $payment_status_array[ $payment_status ] : '';
-    }
-
-
-    /**
-     * This is used to retrieve the template pack for the given name.
-     *
-     * @param string $template_pack_name  should match the set `dbref` property value on the EE_Messages_Template_Pack.
-     *
-     * @return EE_Messages_Template_Pack
-     */
-    public static function get_template_pack($template_pack_name)
-    {
-        if (! self::$_template_pack_collection instanceof EE_Object_Collection) {
-            self::$_template_pack_collection = new EE_Messages_Template_Pack_Collection();
-        }
-
-        // first see if in collection already
-        $template_pack = self::$_template_pack_collection->get_by_name($template_pack_name);
-
-        if ($template_pack instanceof EE_Messages_Template_Pack) {
-            return $template_pack;
-        }
-
-        // nope...let's get it.
-        // not set yet so let's attempt to get it.
-        $pack_class_name = 'EE_Messages_Template_Pack_' . str_replace(
-            ' ',
-            '_',
-            ucwords(
-                str_replace('_', ' ', $template_pack_name)
-            )
-        );
-        if (! class_exists($pack_class_name) && $template_pack_name !== 'default') {
-            return self::get_template_pack('default');
-        } else {
-            $template_pack = new $pack_class_name();
-            self::$_template_pack_collection->add($template_pack);
-            return $template_pack;
-        }
-    }
-
-
-
-
-    /**
-     * Globs template packs installed in core and returns the template pack collection with all installed template packs
-     * in it.
-     *
-     * @since 4.9.0
-     *
-     * @return EE_Messages_Template_Pack_Collection
-     */
-    public static function get_template_pack_collection()
-    {
-        $new_collection = false;
-        if (! self::$_template_pack_collection instanceof EE_Messages_Template_Pack_Collection) {
-            self::$_template_pack_collection = new EE_Messages_Template_Pack_Collection();
-            $new_collection = true;
-        }
-
-        // glob the defaults directory for messages
-        $templates = glob(EE_LIBRARIES . 'messages/defaults/*', GLOB_ONLYDIR);
-        foreach ($templates as $template_path) {
-            // grab folder name
-            $template = basename($template_path);
-
-            if (! $new_collection) {
-                // already have it?
-                if (self::$_template_pack_collection->get_by_name($template) instanceof EE_Messages_Template_Pack) {
-                    continue;
-                }
-            }
-
-            // setup classname.
-            $template_pack_class_name = 'EE_Messages_Template_Pack_' . str_replace(
-                ' ',
-                '_',
-                ucwords(
-                    str_replace(
-                        '_',
-                        ' ',
-                        $template
-                    )
-                )
-            );
-            if (! class_exists($template_pack_class_name)) {
-                continue;
-            }
-            self::$_template_pack_collection->add(new $template_pack_class_name());
-        }
-
-        /**
-         * Filter for plugins to add in any additional template packs
-         * Note the filter name here is for backward compat, this used to be found in EED_Messages.
-         */
-        $additional_template_packs = apply_filters('FHEE__EED_Messages__get_template_packs__template_packs', array());
-        foreach ((array) $additional_template_packs as $template_pack) {
-            if (
-                self::$_template_pack_collection->get_by_name(
-                    $template_pack->dbref
-                ) instanceof EE_Messages_Template_Pack
-            ) {
-                continue;
-            }
-            self::$_template_pack_collection->add($template_pack);
-        }
-        return self::$_template_pack_collection;
-    }
-
-
-    /**
-     * This is a wrapper for the protected _create_new_templates function
-     *
-     * @param string $messenger_name
-     * @param string $message_type_name message type that the templates are being created for
-     * @param int    $GRP_ID
-     * @param bool   $global
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function create_new_templates($messenger_name, $message_type_name, $GRP_ID = 0, $global = false)
-    {
-        /** @type EE_Message_Resource_Manager $Message_Resource_Manager */
-        $Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        $messenger = $Message_Resource_Manager->valid_messenger($messenger_name);
-        $message_type = $Message_Resource_Manager->valid_message_type($message_type_name);
-        if (! EEH_MSG_Template::message_type_has_active_templates_for_messenger($messenger, $message_type, $global)) {
-            return array();
-        }
-        // whew made it this far!  Okay, let's go ahead and create the templates then
-        return EEH_MSG_Template::_create_new_templates($messenger, $message_type, $GRP_ID, $global);
-    }
-
-
-    /**
-     * @param EE_messenger     $messenger
-     * @param EE_message_type  $message_type
-     * @param                  $GRP_ID
-     * @param                  $global
-     * @return array|mixed
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected static function _create_new_templates(EE_messenger $messenger, EE_message_type $message_type, $GRP_ID, $global)
-    {
-        // if we're creating a custom template then we don't need to use the defaults class
-        if (! $global) {
-            return EEH_MSG_Template::_create_custom_template_group($messenger, $message_type, $GRP_ID);
-        }
-        /** @type EE_Messages_Template_Defaults $Message_Template_Defaults */
-        $Message_Template_Defaults = EE_Registry::factory(
-            'EE_Messages_Template_Defaults',
-            array( $messenger, $message_type, $GRP_ID )
-        );
-        // generate templates
-        $success = $Message_Template_Defaults->create_new_templates();
-
-        // if creating the template failed.  Then we should deactivate the related message_type for the messenger because
-        // its not active if it doesn't have a template.  Note this is only happening for GLOBAL template creation
-        // attempts.
-        if (! $success) {
-            /** @var EE_Message_Resource_Manager $message_resource_manager */
-            $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-            $message_resource_manager->deactivate_message_type_for_messenger($message_type->name, $messenger->name);
-        }
-
-        /**
-         * $success is in an array in the following format
-         * array(
-         *    'GRP_ID' => $new_grp_id,
-         *    'MTP_context' => $first_context_in_new_templates,
-         * )
-         */
-        return $success;
-    }
-
-
-    /**
-     * This creates a custom template using the incoming GRP_ID
-     *
-     * @param EE_messenger    $messenger
-     * @param EE_message_type $message_type
-     * @param int             $GRP_ID           GRP_ID for the template_group being used as the base
-     * @return  array $success              This will be an array in the format:
-     *                                          array(
-     *                                          'GRP_ID' => $new_grp_id,
-     *                                          'MTP_context' => $first_context_in_created_template
-     *                                          )
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @access private
-     */
-    private static function _create_custom_template_group(EE_messenger $messenger, EE_message_type $message_type, $GRP_ID)
-    {
-        // defaults
-        $success = array( 'GRP_ID' => null, 'MTP_context' => '' );
-        // get the template group to use as a template from the db.  If $GRP_ID is empty then we'll assume the base will be the global template matching the messenger and message type.
-        $Message_Template_Group = empty($GRP_ID)
-            ? EEM_Message_Template_Group::instance()->get_one(
-                array(
-                    array(
-                        'MTP_messenger'    => $messenger->name,
-                        'MTP_message_type' => $message_type->name,
-                        'MTP_is_global'    => true
-                    )
-                )
-            )
-            : EEM_Message_Template_Group::instance()->get_one_by_ID($GRP_ID);
-        // if we don't have a mtg at this point then we need to bail.
-        if (! $Message_Template_Group instanceof EE_Message_Template_Group) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'Something went wrong with generating the custom template from this group id: %s.  This usually happens when there is no matching message template group in the db.',
-                        'event_espresso'
-                    ),
-                    $GRP_ID
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return $success;
-        }
-        // let's get all the related message_template objects for this group.
-        $message_templates = $Message_Template_Group->message_templates();
-        // now we have what we need to setup the new template
-        $new_mtg = clone $Message_Template_Group;
-        $new_mtg->set('GRP_ID', 0);
-        $new_mtg->set('MTP_is_global', false);
-
-        /** @var RequestInterface $request */
-        $request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-        $template_name = $request->isAjax() && $request->requestParamIsSet('templateName')
-            ? $request->getRequestParam('templateName')
-            : sprintf(
-                esc_html__('Custom %1$s', 'event_espresso'),
-                ucwords($message_type->label['singular']) ?? esc_html__('Template', 'event_espresso')
-            );
-        $template_description = $request->isAjax() && $request->requestParamIsSet('templateDescription')
-            ? $request->getRequestParam('templateDescription')
-            : sprintf(
-                esc_html__(
-                    'This is a custom template that was created for the %s messenger and %s message type.',
-                    'event_espresso'
-                ),
-                $new_mtg->messenger_obj()->label['singular'],
-                $new_mtg->message_type_obj()->label['singular']
-            );
-        $new_mtg->set('MTP_name', $template_name);
-        $new_mtg->set('MTP_description', $template_description);
-        // remove ALL relations on this template group so they don't get saved!
-        $new_mtg->_remove_relations('Message_Template');
-        $new_mtg->save();
-        $success['GRP_ID'] = $new_mtg->ID();
-        $success['template_name'] = $template_name;
-        // add new message templates and add relation to.
-        foreach ($message_templates as $message_template) {
-            if (! $message_template instanceof EE_Message_Template) {
-                continue;
-            }
-            $new_message_template = clone $message_template;
-            $new_message_template->set('MTP_ID', 0);
-            $new_message_template->set('GRP_ID', $new_mtg->ID()); // relation
-            $new_message_template->save();
-            if (empty($success['MTP_context']) && $new_message_template->get('MTP_context') !== 'admin') {
-                $success['MTP_context'] = $new_message_template->get('MTP_context');
-            }
-        }
-        return $success;
-    }
-
-
-    /**
-     * message_type_has_active_templates_for_messenger
-     *
-     * @param EE_messenger    $messenger
-     * @param EE_message_type $message_type
-     * @param bool            $global
-     * @return bool
-     * @throws EE_Error
-     */
-    public static function message_type_has_active_templates_for_messenger(
-        EE_messenger $messenger,
-        EE_message_type $message_type,
-        $global = false
-    ) {
-        // is given message_type valid for given messenger (if this is not a global save)
-        if ($global) {
-            return true;
-        }
-        $active_templates = EEM_Message_Template_Group::instance()->count(
-            array(
-                array(
-                    'MTP_is_active'    => true,
-                    'MTP_messenger'    => $messenger->name,
-                    'MTP_message_type' => $message_type->name
-                )
-            )
-        );
-        if ($active_templates > 0) {
-            return true;
-        }
-        EE_Error::add_error(
-            sprintf(
-                esc_html__(
-                    'The %1$s message type is not registered with the %2$s messenger. Please visit the Messenger activation page to assign this message type first if you want to use it.',
-                    'event_espresso'
-                ),
-                $message_type->name,
-                $messenger->name
-            ),
-            __FILE__,
-            __FUNCTION__,
-            __LINE__
-        );
-        return false;
-    }
-
-
-    /**
-     * get_fields
-     * This takes a given messenger and message type and returns all the template fields indexed by context (and with field type).
-     *
-     * @param string $messenger_name    name of EE_messenger
-     * @param string $message_type_name name of EE_message_type
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function get_fields($messenger_name, $message_type_name)
-    {
-        $template_fields = array();
-        /** @type EE_Message_Resource_Manager $Message_Resource_Manager */
-        $Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        $messenger = $Message_Resource_Manager->valid_messenger($messenger_name);
-        $message_type = $Message_Resource_Manager->valid_message_type($message_type_name);
-        if (! EEH_MSG_Template::message_type_has_active_templates_for_messenger($messenger, $message_type)) {
-            return array();
-        }
-
-        $excluded_fields_for_messenger = $message_type->excludedFieldsForMessenger($messenger_name);
-
-        // okay now let's assemble an array with the messenger template fields added to the message_type contexts.
-        foreach ($message_type->get_contexts() as $context => $details) {
-            foreach ($messenger->get_template_fields() as $field => $value) {
-                if (in_array($field, $excluded_fields_for_messenger, true)) {
-                    continue;
-                }
-                $template_fields[ $context ][ $field ] = $value;
-            }
-        }
-        if (empty($template_fields)) {
-            EE_Error::add_error(
-                esc_html__('Something went wrong and we couldn\'t get any templates assembled', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return array();
-        }
-        return $template_fields;
-    }
+	}
+
+
+
+
+
+	/**
+	 * This returns an array with keys as reg statuses and values as the corresponding message type slug (filtered).
+	 *
+	 * @since 4.9.0
+	 * @return array
+	 */
+	public static function reg_status_to_message_type_array()
+	{
+		return (array) apply_filters(
+			'FHEE__EEH_MSG_Template__reg_status_to_message_type_array',
+			array(
+				EEM_Registration::status_id_approved => 'registration',
+				EEM_Registration::status_id_pending_payment => 'pending_approval',
+				EEM_Registration::status_id_not_approved => 'not_approved_registration',
+				EEM_Registration::status_id_cancelled => 'cancelled_registration',
+				EEM_Registration::status_id_declined => 'declined_registration'
+			)
+		);
+	}
+
+
+
+
+	/**
+	 * This returns the corresponding registration message type slug to the given reg status. If there isn't a
+	 * match, then returns an empty string.
+	 *
+	 * @since 4.9.0
+	 * @param $reg_status
+	 * @return string
+	 */
+	public static function convert_reg_status_to_message_type($reg_status)
+	{
+		$reg_status_array = self::reg_status_to_message_type_array();
+		return isset($reg_status_array[ $reg_status ]) ? $reg_status_array[ $reg_status ] : '';
+	}
+
+
+	/**
+	 * This returns an array with keys as payment stati and values as the corresponding message type slug (filtered).
+	 *
+	 * @since 4.9.0
+	 * @return array
+	 */
+	public static function payment_status_to_message_type_array()
+	{
+		return (array) apply_filters(
+			'FHEE__EEH_MSG_Template__payment_status_to_message_type_array',
+			array(
+				EEM_Payment::status_id_approved => 'payment',
+				EEM_Payment::status_id_pending => 'payment_pending',
+				EEM_Payment::status_id_cancelled => 'payment_cancelled',
+				EEM_Payment::status_id_declined => 'payment_declined',
+				EEM_Payment::status_id_failed => 'payment_failed'
+			)
+		);
+	}
+
+
+
+
+	/**
+	 * This returns the corresponding payment message type slug to the given payment status. If there isn't a match then
+	 * an empty string is returned
+	 *
+	 * @since 4.9.0
+	 * @param $payment_status
+	 * @return string
+	 */
+	public static function convert_payment_status_to_message_type($payment_status)
+	{
+		$payment_status_array = self::payment_status_to_message_type_array();
+		return isset($payment_status_array[ $payment_status ]) ? $payment_status_array[ $payment_status ] : '';
+	}
+
+
+	/**
+	 * This is used to retrieve the template pack for the given name.
+	 *
+	 * @param string $template_pack_name  should match the set `dbref` property value on the EE_Messages_Template_Pack.
+	 *
+	 * @return EE_Messages_Template_Pack
+	 */
+	public static function get_template_pack($template_pack_name)
+	{
+		if (! self::$_template_pack_collection instanceof EE_Object_Collection) {
+			self::$_template_pack_collection = new EE_Messages_Template_Pack_Collection();
+		}
+
+		// first see if in collection already
+		$template_pack = self::$_template_pack_collection->get_by_name($template_pack_name);
+
+		if ($template_pack instanceof EE_Messages_Template_Pack) {
+			return $template_pack;
+		}
+
+		// nope...let's get it.
+		// not set yet so let's attempt to get it.
+		$pack_class_name = 'EE_Messages_Template_Pack_' . str_replace(
+			' ',
+			'_',
+			ucwords(
+				str_replace('_', ' ', $template_pack_name)
+			)
+		);
+		if (! class_exists($pack_class_name) && $template_pack_name !== 'default') {
+			return self::get_template_pack('default');
+		} else {
+			$template_pack = new $pack_class_name();
+			self::$_template_pack_collection->add($template_pack);
+			return $template_pack;
+		}
+	}
+
+
+
+
+	/**
+	 * Globs template packs installed in core and returns the template pack collection with all installed template packs
+	 * in it.
+	 *
+	 * @since 4.9.0
+	 *
+	 * @return EE_Messages_Template_Pack_Collection
+	 */
+	public static function get_template_pack_collection()
+	{
+		$new_collection = false;
+		if (! self::$_template_pack_collection instanceof EE_Messages_Template_Pack_Collection) {
+			self::$_template_pack_collection = new EE_Messages_Template_Pack_Collection();
+			$new_collection = true;
+		}
+
+		// glob the defaults directory for messages
+		$templates = glob(EE_LIBRARIES . 'messages/defaults/*', GLOB_ONLYDIR);
+		foreach ($templates as $template_path) {
+			// grab folder name
+			$template = basename($template_path);
+
+			if (! $new_collection) {
+				// already have it?
+				if (self::$_template_pack_collection->get_by_name($template) instanceof EE_Messages_Template_Pack) {
+					continue;
+				}
+			}
+
+			// setup classname.
+			$template_pack_class_name = 'EE_Messages_Template_Pack_' . str_replace(
+				' ',
+				'_',
+				ucwords(
+					str_replace(
+						'_',
+						' ',
+						$template
+					)
+				)
+			);
+			if (! class_exists($template_pack_class_name)) {
+				continue;
+			}
+			self::$_template_pack_collection->add(new $template_pack_class_name());
+		}
+
+		/**
+		 * Filter for plugins to add in any additional template packs
+		 * Note the filter name here is for backward compat, this used to be found in EED_Messages.
+		 */
+		$additional_template_packs = apply_filters('FHEE__EED_Messages__get_template_packs__template_packs', array());
+		foreach ((array) $additional_template_packs as $template_pack) {
+			if (
+				self::$_template_pack_collection->get_by_name(
+					$template_pack->dbref
+				) instanceof EE_Messages_Template_Pack
+			) {
+				continue;
+			}
+			self::$_template_pack_collection->add($template_pack);
+		}
+		return self::$_template_pack_collection;
+	}
+
+
+	/**
+	 * This is a wrapper for the protected _create_new_templates function
+	 *
+	 * @param string $messenger_name
+	 * @param string $message_type_name message type that the templates are being created for
+	 * @param int    $GRP_ID
+	 * @param bool   $global
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function create_new_templates($messenger_name, $message_type_name, $GRP_ID = 0, $global = false)
+	{
+		/** @type EE_Message_Resource_Manager $Message_Resource_Manager */
+		$Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		$messenger = $Message_Resource_Manager->valid_messenger($messenger_name);
+		$message_type = $Message_Resource_Manager->valid_message_type($message_type_name);
+		if (! EEH_MSG_Template::message_type_has_active_templates_for_messenger($messenger, $message_type, $global)) {
+			return array();
+		}
+		// whew made it this far!  Okay, let's go ahead and create the templates then
+		return EEH_MSG_Template::_create_new_templates($messenger, $message_type, $GRP_ID, $global);
+	}
+
+
+	/**
+	 * @param EE_messenger     $messenger
+	 * @param EE_message_type  $message_type
+	 * @param                  $GRP_ID
+	 * @param                  $global
+	 * @return array|mixed
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected static function _create_new_templates(EE_messenger $messenger, EE_message_type $message_type, $GRP_ID, $global)
+	{
+		// if we're creating a custom template then we don't need to use the defaults class
+		if (! $global) {
+			return EEH_MSG_Template::_create_custom_template_group($messenger, $message_type, $GRP_ID);
+		}
+		/** @type EE_Messages_Template_Defaults $Message_Template_Defaults */
+		$Message_Template_Defaults = EE_Registry::factory(
+			'EE_Messages_Template_Defaults',
+			array( $messenger, $message_type, $GRP_ID )
+		);
+		// generate templates
+		$success = $Message_Template_Defaults->create_new_templates();
+
+		// if creating the template failed.  Then we should deactivate the related message_type for the messenger because
+		// its not active if it doesn't have a template.  Note this is only happening for GLOBAL template creation
+		// attempts.
+		if (! $success) {
+			/** @var EE_Message_Resource_Manager $message_resource_manager */
+			$message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+			$message_resource_manager->deactivate_message_type_for_messenger($message_type->name, $messenger->name);
+		}
+
+		/**
+		 * $success is in an array in the following format
+		 * array(
+		 *    'GRP_ID' => $new_grp_id,
+		 *    'MTP_context' => $first_context_in_new_templates,
+		 * )
+		 */
+		return $success;
+	}
+
+
+	/**
+	 * This creates a custom template using the incoming GRP_ID
+	 *
+	 * @param EE_messenger    $messenger
+	 * @param EE_message_type $message_type
+	 * @param int             $GRP_ID           GRP_ID for the template_group being used as the base
+	 * @return  array $success              This will be an array in the format:
+	 *                                          array(
+	 *                                          'GRP_ID' => $new_grp_id,
+	 *                                          'MTP_context' => $first_context_in_created_template
+	 *                                          )
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @access private
+	 */
+	private static function _create_custom_template_group(EE_messenger $messenger, EE_message_type $message_type, $GRP_ID)
+	{
+		// defaults
+		$success = array( 'GRP_ID' => null, 'MTP_context' => '' );
+		// get the template group to use as a template from the db.  If $GRP_ID is empty then we'll assume the base will be the global template matching the messenger and message type.
+		$Message_Template_Group = empty($GRP_ID)
+			? EEM_Message_Template_Group::instance()->get_one(
+				array(
+					array(
+						'MTP_messenger'    => $messenger->name,
+						'MTP_message_type' => $message_type->name,
+						'MTP_is_global'    => true
+					)
+				)
+			)
+			: EEM_Message_Template_Group::instance()->get_one_by_ID($GRP_ID);
+		// if we don't have a mtg at this point then we need to bail.
+		if (! $Message_Template_Group instanceof EE_Message_Template_Group) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'Something went wrong with generating the custom template from this group id: %s.  This usually happens when there is no matching message template group in the db.',
+						'event_espresso'
+					),
+					$GRP_ID
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return $success;
+		}
+		// let's get all the related message_template objects for this group.
+		$message_templates = $Message_Template_Group->message_templates();
+		// now we have what we need to setup the new template
+		$new_mtg = clone $Message_Template_Group;
+		$new_mtg->set('GRP_ID', 0);
+		$new_mtg->set('MTP_is_global', false);
+
+		/** @var RequestInterface $request */
+		$request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
+		$template_name = $request->isAjax() && $request->requestParamIsSet('templateName')
+			? $request->getRequestParam('templateName')
+			: sprintf(
+				esc_html__('Custom %1$s', 'event_espresso'),
+				ucwords($message_type->label['singular']) ?? esc_html__('Template', 'event_espresso')
+			);
+		$template_description = $request->isAjax() && $request->requestParamIsSet('templateDescription')
+			? $request->getRequestParam('templateDescription')
+			: sprintf(
+				esc_html__(
+					'This is a custom template that was created for the %s messenger and %s message type.',
+					'event_espresso'
+				),
+				$new_mtg->messenger_obj()->label['singular'],
+				$new_mtg->message_type_obj()->label['singular']
+			);
+		$new_mtg->set('MTP_name', $template_name);
+		$new_mtg->set('MTP_description', $template_description);
+		// remove ALL relations on this template group so they don't get saved!
+		$new_mtg->_remove_relations('Message_Template');
+		$new_mtg->save();
+		$success['GRP_ID'] = $new_mtg->ID();
+		$success['template_name'] = $template_name;
+		// add new message templates and add relation to.
+		foreach ($message_templates as $message_template) {
+			if (! $message_template instanceof EE_Message_Template) {
+				continue;
+			}
+			$new_message_template = clone $message_template;
+			$new_message_template->set('MTP_ID', 0);
+			$new_message_template->set('GRP_ID', $new_mtg->ID()); // relation
+			$new_message_template->save();
+			if (empty($success['MTP_context']) && $new_message_template->get('MTP_context') !== 'admin') {
+				$success['MTP_context'] = $new_message_template->get('MTP_context');
+			}
+		}
+		return $success;
+	}
+
+
+	/**
+	 * message_type_has_active_templates_for_messenger
+	 *
+	 * @param EE_messenger    $messenger
+	 * @param EE_message_type $message_type
+	 * @param bool            $global
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public static function message_type_has_active_templates_for_messenger(
+		EE_messenger $messenger,
+		EE_message_type $message_type,
+		$global = false
+	) {
+		// is given message_type valid for given messenger (if this is not a global save)
+		if ($global) {
+			return true;
+		}
+		$active_templates = EEM_Message_Template_Group::instance()->count(
+			array(
+				array(
+					'MTP_is_active'    => true,
+					'MTP_messenger'    => $messenger->name,
+					'MTP_message_type' => $message_type->name
+				)
+			)
+		);
+		if ($active_templates > 0) {
+			return true;
+		}
+		EE_Error::add_error(
+			sprintf(
+				esc_html__(
+					'The %1$s message type is not registered with the %2$s messenger. Please visit the Messenger activation page to assign this message type first if you want to use it.',
+					'event_espresso'
+				),
+				$message_type->name,
+				$messenger->name
+			),
+			__FILE__,
+			__FUNCTION__,
+			__LINE__
+		);
+		return false;
+	}
+
+
+	/**
+	 * get_fields
+	 * This takes a given messenger and message type and returns all the template fields indexed by context (and with field type).
+	 *
+	 * @param string $messenger_name    name of EE_messenger
+	 * @param string $message_type_name name of EE_message_type
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function get_fields($messenger_name, $message_type_name)
+	{
+		$template_fields = array();
+		/** @type EE_Message_Resource_Manager $Message_Resource_Manager */
+		$Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		$messenger = $Message_Resource_Manager->valid_messenger($messenger_name);
+		$message_type = $Message_Resource_Manager->valid_message_type($message_type_name);
+		if (! EEH_MSG_Template::message_type_has_active_templates_for_messenger($messenger, $message_type)) {
+			return array();
+		}
+
+		$excluded_fields_for_messenger = $message_type->excludedFieldsForMessenger($messenger_name);
+
+		// okay now let's assemble an array with the messenger template fields added to the message_type contexts.
+		foreach ($message_type->get_contexts() as $context => $details) {
+			foreach ($messenger->get_template_fields() as $field => $value) {
+				if (in_array($field, $excluded_fields_for_messenger, true)) {
+					continue;
+				}
+				$template_fields[ $context ][ $field ] = $value;
+			}
+		}
+		if (empty($template_fields)) {
+			EE_Error::add_error(
+				esc_html__('Something went wrong and we couldn\'t get any templates assembled', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return array();
+		}
+		return $template_fields;
+	}
 }