eventespresso / event-espresso-core

core/data_migration_scripts/EE_DMS_Core_5_0_0.dms.php

Indentation +426 added lines, -426 removed lines

@@ -11,9 +11,9 @@ 
 $stages            = glob(EE_CORE . 'data_migration_scripts/5_0_0_stages/*');
 $class_to_filepath = [];
 foreach ($stages as $filepath) {
-    $matches = [];
-    preg_match('~5_0_0_stages/(.*).dmsstage.php~', $filepath, $matches);
-    $class_to_filepath[ $matches[1] ] = $filepath;
+	$matches = [];
+	preg_match('~5_0_0_stages/(.*).dmsstage.php~', $filepath, $matches);
+	$class_to_filepath[ $matches[1] ] = $filepath;
 }
 // give addons a chance to autoload their stages too
 $class_to_filepath = apply_filters('FHEE__EE_DMS_5_0_0__autoloaded_stages', $class_to_filepath);
@@ -29,65 +29,65 @@ 
  */
 class EE_DMS_Core_5_0_0 extends EE_Data_Migration_Script_Base
 {
-    /**
-     * @param EE_DMS_Core_4_10_0 $dms_4_10
-     * @param TableManager|null  $table_manager
-     * @param TableAnalysis|null $table_analysis
-     */
-    public function __construct(
-        EE_DMS_Core_4_10_0 $dms_4_10,
-        TableManager $table_manager = null,
-        TableAnalysis $table_analysis = null
-    ) {
-        $this->previous_dms      = $dms_4_10;
-        $this->_pretty_name      = esc_html__("Data Update to Event Espresso 5.0.0", "event_espresso");
-        $this->_priority         = 10;
-        $this->_migration_stages = [
-            new EE_DMS_5_0_0_Event_Venues(),
-        ];
-        parent::__construct($table_manager, $table_analysis);
-    }
-
-
-    /**
-     * Whether to migrate or not.
-     *
-     * @param array $version_array
-     * @return bool
-     */
-    public function can_migrate_from_version($version_array): bool
-    {
-        $version_string = $version_array['Core'];
-        return $version_string &&
-            version_compare($version_string, '5.0.0.decaf', '<') &&
-            version_compare($version_string, '4.10.0.decaf', '>=');
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function schema_changes_before_migration(): bool
-    {
-        require_once EE_HELPERS . 'EEH_Activation.helper.php';
-
-        $this->_table_has_not_changed_since_previous(
-            'esp_answer',
-            ' ANS_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+	/**
+	 * @param EE_DMS_Core_4_10_0 $dms_4_10
+	 * @param TableManager|null  $table_manager
+	 * @param TableAnalysis|null $table_analysis
+	 */
+	public function __construct(
+		EE_DMS_Core_4_10_0 $dms_4_10,
+		TableManager $table_manager = null,
+		TableAnalysis $table_analysis = null
+	) {
+		$this->previous_dms      = $dms_4_10;
+		$this->_pretty_name      = esc_html__("Data Update to Event Espresso 5.0.0", "event_espresso");
+		$this->_priority         = 10;
+		$this->_migration_stages = [
+			new EE_DMS_5_0_0_Event_Venues(),
+		];
+		parent::__construct($table_manager, $table_analysis);
+	}
+
+
+	/**
+	 * Whether to migrate or not.
+	 *
+	 * @param array $version_array
+	 * @return bool
+	 */
+	public function can_migrate_from_version($version_array): bool
+	{
+		$version_string = $version_array['Core'];
+		return $version_string &&
+			version_compare($version_string, '5.0.0.decaf', '<') &&
+			version_compare($version_string, '4.10.0.decaf', '>=');
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function schema_changes_before_migration(): bool
+	{
+		require_once EE_HELPERS . 'EEH_Activation.helper.php';
+
+		$this->_table_has_not_changed_since_previous(
+			'esp_answer',
+			' ANS_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
             REG_ID int(10) unsigned NOT NULL,
             QST_ID int(10) unsigned NOT NULL,
             ANS_value text NOT NULL,
             PRIMARY KEY  (ANS_ID)'
-        );
-        $this->_get_table_manager()->addIndex('esp_answer', 'REG_ID', 'REG_ID');
-        $this->_get_table_manager()->addIndex('esp_answer', 'QST_ID', 'QST_ID');
+		);
+		$this->_get_table_manager()->addIndex('esp_answer', 'REG_ID', 'REG_ID');
+		$this->_get_table_manager()->addIndex('esp_answer', 'QST_ID', 'QST_ID');
 
 
-        $this->_table_has_not_changed_since_previous(
-            'esp_attendee_meta',
-            "ATTM_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous(
+			'esp_attendee_meta',
+			"ATTM_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				ATT_ID bigint(20) unsigned NOT NULL,
 				ATT_fname varchar(45) NOT NULL,
 				ATT_lname varchar(45) NOT NULL,
@@ -100,43 +100,43 @@ 
 				ATT_email varchar(255) NOT NULL,
 				ATT_phone varchar(45) DEFAULT NULL,
 				PRIMARY KEY  (ATTM_ID)"
-        );
-        $this->_get_table_manager()->addIndex('esp_attendee_meta', 'ATT_ID', 'ATT_ID');
-        $this->_get_table_manager()->addIndex(
-            'esp_attendee_meta',
-            'ATT_email',
-            'ATT_email',
-            TableAnalysis::INDEX_TYPE_INDEX,
-            TableAnalysis::INDEX_COLUMN_SIZE
-        );
-        $this->_get_table_manager()->addIndex('esp_attendee_meta', 'ATT_lname', 'ATT_lname');
-        $this->_get_table_manager()->addIndex('esp_attendee_meta', 'ATT_fname', 'ATT_fname');
-
-
-        $this->_table_has_not_changed_since_previous(
-            'esp_checkin',
-            "CHK_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		);
+		$this->_get_table_manager()->addIndex('esp_attendee_meta', 'ATT_ID', 'ATT_ID');
+		$this->_get_table_manager()->addIndex(
+			'esp_attendee_meta',
+			'ATT_email',
+			'ATT_email',
+			TableAnalysis::INDEX_TYPE_INDEX,
+			TableAnalysis::INDEX_COLUMN_SIZE
+		);
+		$this->_get_table_manager()->addIndex('esp_attendee_meta', 'ATT_lname', 'ATT_lname');
+		$this->_get_table_manager()->addIndex('esp_attendee_meta', 'ATT_fname', 'ATT_fname');
+
+
+		$this->_table_has_not_changed_since_previous(
+			'esp_checkin',
+			"CHK_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				REG_ID int(10) unsigned NOT NULL,
 				DTT_ID int(10) unsigned NOT NULL,
 				CHK_in tinyint(1) unsigned NOT NULL DEFAULT 1,
 				CHK_timestamp datetime NOT NULL DEFAULT CURRENT_TIMESTAMP,
 				PRIMARY KEY  (CHK_ID)"
-        );
-        $this->_get_table_manager()->addIndex('esp_checkin', 'REG_ID', 'REG_ID');
-        $this->_get_table_manager()->addIndex('esp_checkin', 'DTT_ID', 'DTT_ID');
-        $this->_get_table_manager()->addIndex(
-            'esp_checkin',
-            'CHK_timestamp',
-            'CHK_timestamp',
-            TableAnalysis::INDEX_TYPE_INDEX,
-            null,
-            true
-        );
-
-
-        $this->_table_has_not_changed_since_previous(
-            'esp_country',
-            "CNT_ISO varchar(2) NOT NULL,
+		);
+		$this->_get_table_manager()->addIndex('esp_checkin', 'REG_ID', 'REG_ID');
+		$this->_get_table_manager()->addIndex('esp_checkin', 'DTT_ID', 'DTT_ID');
+		$this->_get_table_manager()->addIndex(
+			'esp_checkin',
+			'CHK_timestamp',
+			'CHK_timestamp',
+			TableAnalysis::INDEX_TYPE_INDEX,
+			null,
+			true
+		);
+
+
+		$this->_table_has_not_changed_since_previous(
+			'esp_country',
+			"CNT_ISO varchar(2) NOT NULL,
 				CNT_ISO3 varchar(3) NOT NULL,
 				RGN_ID tinyint(3) unsigned DEFAULT NULL,
 				CNT_name varchar(45) NOT NULL,
@@ -152,38 +152,38 @@ 
 				CNT_is_EU tinyint(1) DEFAULT '0',
 				CNT_active tinyint(1) DEFAULT '0',
 				PRIMARY KEY  (CNT_ISO)"
-        );
+		);
 
 
-        $this->_table_has_not_changed_since_previous(
-            'esp_currency',
-            "CUR_code varchar(6) NOT NULL,
+		$this->_table_has_not_changed_since_previous(
+			'esp_currency',
+			"CUR_code varchar(6) NOT NULL,
 				CUR_single varchar(45) DEFAULT 'dollar',
 				CUR_plural varchar(45) DEFAULT 'dollars',
 				CUR_sign varchar(45) DEFAULT '$',
 				CUR_dec_plc varchar(1) NOT NULL DEFAULT '2',
 				CUR_active tinyint(1) DEFAULT '0',
 				PRIMARY KEY  (CUR_code)"
-        );
+		);
 
 
-        // note: although this table is no longer in use,
-        // it hasn't been removed because then queries to the model will have errors.
-        // but you should expect this table and its corresponding model to be removed in
-        // the next few months
-        $this->_table_is_new_in_this_version(
-            'esp_currency_payment_method',
-            "CPM_ID int(11) NOT NULL AUTO_INCREMENT,
+		// note: although this table is no longer in use,
+		// it hasn't been removed because then queries to the model will have errors.
+		// but you should expect this table and its corresponding model to be removed in
+		// the next few months
+		$this->_table_is_new_in_this_version(
+			'esp_currency_payment_method',
+			"CPM_ID int(11) NOT NULL AUTO_INCREMENT,
 				CUR_code varchar(6) NOT NULL,
 				PMD_ID int(11) NOT NULL,
 				PRIMARY KEY  (CPM_ID)"
-        );
-        $this->_get_table_manager()->addIndex('esp_currency_payment_method', 'PMD_ID', 'PMD_ID');
+		);
+		$this->_get_table_manager()->addIndex('esp_currency_payment_method', 'PMD_ID', 'PMD_ID');
 
 
-        $this->_table_is_changed_in_this_version(
-            'esp_datetime',
-            "DTT_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_is_changed_in_this_version(
+			'esp_datetime',
+			"DTT_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				EVT_ID bigint(20) unsigned NOT NULL,
 			    VNU_ID bigint(20) unsigned NOT NULL DEFAULT 0,
 				DTT_name varchar(255) NOT NULL DEFAULT '',
@@ -198,39 +198,39 @@ 
 				DTT_parent int(10) unsigned DEFAULT 0,
 				DTT_deleted tinyint(1) unsigned NOT NULL DEFAULT 0,
 				PRIMARY KEY  (DTT_ID)"
-        );
-        $this->_get_table_manager()->addIndex('esp_datetime', 'EVT_ID', 'EVT_ID');
-        // $this->_get_table_manager()->addIndex('esp_datetime', 'VNU_ID', 'VNU_ID');
-        $this->_get_table_manager()->addIndex('esp_datetime', 'DTT_EVT_start', 'DTT_EVT_start');
-        // $this->_get_table_manager()->addIndex('esp_datetime', 'DTT_EVT_end', 'DTT_EVT_end');
-        // $this->_get_table_manager()->dropIndex('esp_datetime', 'DTT_is_primary');
+		);
+		$this->_get_table_manager()->addIndex('esp_datetime', 'EVT_ID', 'EVT_ID');
+		// $this->_get_table_manager()->addIndex('esp_datetime', 'VNU_ID', 'VNU_ID');
+		$this->_get_table_manager()->addIndex('esp_datetime', 'DTT_EVT_start', 'DTT_EVT_start');
+		// $this->_get_table_manager()->addIndex('esp_datetime', 'DTT_EVT_end', 'DTT_EVT_end');
+		// $this->_get_table_manager()->dropIndex('esp_datetime', 'DTT_is_primary');
 
 
-        $this->_table_has_not_changed_since_previous(
-            'esp_datetime_ticket',
-            "DTK_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous(
+			'esp_datetime_ticket',
+			"DTK_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				DTT_ID int(10) unsigned NOT NULL,
 				TKT_ID int(10) unsigned NOT NULL,
 				PRIMARY KEY  (DTK_ID)"
-        );
-        $this->_get_table_manager()->addIndex('esp_datetime_ticket', 'DTT_ID', 'DTT_ID');
-        $this->_get_table_manager()->addIndex('esp_datetime_ticket', 'TKT_ID', 'TKT_ID');
+		);
+		$this->_get_table_manager()->addIndex('esp_datetime_ticket', 'DTT_ID', 'DTT_ID');
+		$this->_get_table_manager()->addIndex('esp_datetime_ticket', 'TKT_ID', 'TKT_ID');
 
 
-        $this->_table_has_not_changed_since_previous(
-            'esp_event_message_template',
-            "EMT_ID bigint(20) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous(
+			'esp_event_message_template',
+			"EMT_ID bigint(20) unsigned NOT NULL AUTO_INCREMENT,
 				EVT_ID bigint(20) unsigned NOT NULL DEFAULT 0,
 				GRP_ID int(10) unsigned NOT NULL DEFAULT 0,
 				PRIMARY KEY  (EMT_ID)"
-        );
-        $this->_get_table_manager()->addIndex('esp_event_message_template', 'EVT_ID', 'EVT_ID');
-        $this->_get_table_manager()->addIndex('esp_event_message_template', 'GRP_ID', 'GRP_ID');
+		);
+		$this->_get_table_manager()->addIndex('esp_event_message_template', 'EVT_ID', 'EVT_ID');
+		$this->_get_table_manager()->addIndex('esp_event_message_template', 'GRP_ID', 'GRP_ID');
 
 
-        $this->_table_is_changed_in_this_version(
-            'esp_event_meta',
-            "EVTM_ID int(10) NOT NULL AUTO_INCREMENT,
+		$this->_table_is_changed_in_this_version(
+			'esp_event_meta',
+			"EVTM_ID int(10) NOT NULL AUTO_INCREMENT,
 				EVT_ID bigint(20) unsigned NOT NULL,
 			    VNU_ID bigint(20) unsigned NOT NULL DEFAULT 0,
 				EVT_display_desc tinyint(1) unsigned NOT NULL DEFAULT 1,
@@ -246,77 +246,77 @@ 
 				EVT_donations tinyint(1) NULL,
 				FSC_UUID varchar(25) DEFAULT NULL,
 				PRIMARY KEY  (EVTM_ID)"
-        );
-        $this->_get_table_manager()->addIndex(
-            'esp_event_meta',
-            'EVT_ID',
-            'EVT_ID',
-            TableAnalysis::INDEX_TYPE_INDEX,
-            null,
-            true
-        );
-        // $this->_get_table_manager()->addIndex('esp_event_meta', 'VNU_ID', 'VNU_ID');
-
-
-        $this->_table_has_not_changed_since_previous(
-            'esp_event_question_group',
-            "EQG_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		);
+		$this->_get_table_manager()->addIndex(
+			'esp_event_meta',
+			'EVT_ID',
+			'EVT_ID',
+			TableAnalysis::INDEX_TYPE_INDEX,
+			null,
+			true
+		);
+		// $this->_get_table_manager()->addIndex('esp_event_meta', 'VNU_ID', 'VNU_ID');
+
+
+		$this->_table_has_not_changed_since_previous(
+			'esp_event_question_group',
+			"EQG_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				EVT_ID bigint(20) unsigned NOT NULL,
 				QSG_ID int(10) unsigned NOT NULL,
 				EQG_primary tinyint(1) unsigned NOT NULL DEFAULT 0,
 				EQG_additional tinyint(1) unsigned NOT NULL DEFAULT 0,
 				PRIMARY KEY  (EQG_ID)"
-        );
-        $this->_get_table_manager()->addIndex('esp_event_question_group', 'EVT_ID', 'EVT_ID');
-        $this->_get_table_manager()->addIndex('esp_event_question_group', 'QSG_ID', 'QSG_ID');
+		);
+		$this->_get_table_manager()->addIndex('esp_event_question_group', 'EVT_ID', 'EVT_ID');
+		$this->_get_table_manager()->addIndex('esp_event_question_group', 'QSG_ID', 'QSG_ID');
 
 
-        $this->_table_has_not_changed_since_previous(
-            'esp_event_venue',
-            "EVV_ID int(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous(
+			'esp_event_venue',
+			"EVV_ID int(11) NOT NULL AUTO_INCREMENT,
 				EVT_ID bigint(20) unsigned NOT NULL,
 				VNU_ID bigint(20) unsigned NOT NULL,
 				EVV_primary tinyint(1) unsigned NOT NULL DEFAULT 0,
 				PRIMARY KEY  (EVV_ID)"
-        );
+		);
 
 
-        $this->_table_has_not_changed_since_previous(
-            'esp_extra_meta',
-            "EXM_ID int(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous(
+			'esp_extra_meta',
+			"EXM_ID int(11) NOT NULL AUTO_INCREMENT,
 				OBJ_ID int(11) DEFAULT NULL,
 				EXM_type varchar(45) DEFAULT NULL,
 				EXM_key varchar(45) DEFAULT NULL,
 				EXM_value text,
 				PRIMARY KEY  (EXM_ID)"
-        );
-        $this->_get_table_manager()->addIndex('esp_extra_meta', 'EXM_type', 'EXM_type,OBJ_ID,EXM_key');
+		);
+		$this->_get_table_manager()->addIndex('esp_extra_meta', 'EXM_type', 'EXM_type,OBJ_ID,EXM_key');
 
 
-        $this->_table_has_not_changed_since_previous(
-            'esp_extra_join',
-            "EXJ_ID int(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous(
+			'esp_extra_join',
+			"EXJ_ID int(11) NOT NULL AUTO_INCREMENT,
 				EXJ_first_model_id varchar(12) NOT NULL,
 				EXJ_first_model_name varchar(20) NOT NULL,
 				EXJ_second_model_id varchar(12) NOT NULL,
 				EXJ_second_model_name varchar(20) NOT NULL,
 				PRIMARY KEY  (EXJ_ID)"
-        );
-        $this->_get_table_manager()->addIndex(
-            'esp_extra_join',
-            'first_model',
-            'EXJ_first_model_name,EXJ_first_model_id'
-        );
-        $this->_get_table_manager()->addIndex(
-            'esp_extra_join',
-            'second_model',
-            'EXJ_second_model_name,EXJ_second_model_id'
-        );
-
-
-        $this->_table_is_new_in_this_version(
-            'esp_form_element',
-            "FIN_UUID varchar(25) NOT NULL,
+		);
+		$this->_get_table_manager()->addIndex(
+			'esp_extra_join',
+			'first_model',
+			'EXJ_first_model_name,EXJ_first_model_id'
+		);
+		$this->_get_table_manager()->addIndex(
+			'esp_extra_join',
+			'second_model',
+			'EXJ_second_model_name,EXJ_second_model_id'
+		);
+
+
+		$this->_table_is_new_in_this_version(
+			'esp_form_element',
+			"FIN_UUID varchar(25) NOT NULL,
 				FSC_UUID varchar(25) NOT NULL,
 				FIN_adminOnly tinyint(1) unsigned NOT NULL DEFAULT 0,
 				FIN_attributes text DEFAULT NULL,
@@ -330,15 +330,15 @@ 
 				FIN_type tinytext DEFAULT NULL,
 				FIN_wpUser bigint(20) unsigned DEFAULT NULL,
 				PRIMARY KEY  (FIN_UUID)"
-        );
-        $this->_get_table_manager()->addIndex('esp_form_element', 'FSC_UUID', 'FSC_UUID');
-        // $this->_get_table_manager()->dropIndex('esp_form_element', 'FIN_order');
-        // $this->_get_table_manager()->dropIndex('esp_form_element', 'FIN_status');
+		);
+		$this->_get_table_manager()->addIndex('esp_form_element', 'FSC_UUID', 'FSC_UUID');
+		// $this->_get_table_manager()->dropIndex('esp_form_element', 'FIN_order');
+		// $this->_get_table_manager()->dropIndex('esp_form_element', 'FIN_status');
 
 
-        $this->_table_is_new_in_this_version(
-            'esp_form_section',
-            "FSC_UUID varchar(25) NOT NULL,
+		$this->_table_is_new_in_this_version(
+			'esp_form_section',
+			"FSC_UUID varchar(25) NOT NULL,
 				FSC_appliesTo tinytext NOT NULL,
 				FSC_attributes text DEFAULT NULL,
 				FSC_belongsTo varchar(25) DEFAULT NULL,
@@ -347,36 +347,36 @@ 
 				FSC_status varchar(32) NOT NULL DEFAULT 'active',
 				FSC_wpUser bigint(20) unsigned DEFAULT NULL,
 				PRIMARY KEY  (FSC_UUID)"
-        );
-        $this->_get_table_manager()->addIndex('esp_form_section', 'FSC_belongsTo', 'FSC_belongsTo');
-        // $this->_get_table_manager()->dropIndex('esp_form_section', 'FSC_order');
-        // $this->_get_table_manager()->dropIndex('esp_form_section', 'FSC_status');
+		);
+		$this->_get_table_manager()->addIndex('esp_form_section', 'FSC_belongsTo', 'FSC_belongsTo');
+		// $this->_get_table_manager()->dropIndex('esp_form_section', 'FSC_order');
+		// $this->_get_table_manager()->dropIndex('esp_form_section', 'FSC_status');
 
 
-        $this->_table_is_new_in_this_version(
-            'esp_form_submission',
-            "FSB_UUID varchar(25) NOT NULL,
+		$this->_table_is_new_in_this_version(
+			'esp_form_submission',
+			"FSB_UUID varchar(25) NOT NULL,
                 FSC_UUID varchar(25) NOT NULL,
 				TXN_ID int(10) DEFAULT NULL,
 				FSB_data mediumtext DEFAULT NULL,
 				FSB_submitted datetime NOT NULL DEFAULT CURRENT_TIMESTAMP,
 				PRIMARY KEY  (FSB_UUID)"
-        );
-        $this->_get_table_manager()->addIndex('esp_form_submission', 'FSC_UUID', 'FSC_UUID');
-        $this->_get_table_manager()->addIndex('esp_form_submission', 'TXN_ID', 'TXN_ID');
-        $this->_get_table_manager()->addIndex(
-            'esp_form_submission',
-            'FSB_submitted',
-            'FSB_submitted',
-            TableAnalysis::INDEX_TYPE_INDEX,
-            null,
-            true
-        );
-
-
-        $this->_table_is_changed_in_this_version(
-            'esp_line_item',
-            "LIN_ID int(11) NOT NULL AUTO_INCREMENT,
+		);
+		$this->_get_table_manager()->addIndex('esp_form_submission', 'FSC_UUID', 'FSC_UUID');
+		$this->_get_table_manager()->addIndex('esp_form_submission', 'TXN_ID', 'TXN_ID');
+		$this->_get_table_manager()->addIndex(
+			'esp_form_submission',
+			'FSB_submitted',
+			'FSB_submitted',
+			TableAnalysis::INDEX_TYPE_INDEX,
+			null,
+			true
+		);
+
+
+		$this->_table_is_changed_in_this_version(
+			'esp_line_item',
+			"LIN_ID int(11) NOT NULL AUTO_INCREMENT,
 				LIN_code varchar(245) NOT NULL DEFAULT '',
 				TXN_ID int(10) DEFAULT NULL,
 				LIN_name varchar(245) NOT NULL DEFAULT '',
@@ -394,24 +394,24 @@ 
 				OBJ_type varchar(45) DEFAULT NULL,
 				LIN_timestamp datetime NOT NULL DEFAULT CURRENT_TIMESTAMP,
 				PRIMARY KEY  (LIN_ID)"
-        );
-        $this->_get_table_manager()->addIndex('esp_line_item', 'parent_order', 'LIN_parent,LIN_order');
-        $this->_get_table_manager()->addIndex('esp_line_item', 'txn_type_timestamp', 'TXN_ID,LIN_type,LIN_timestamp');
-        $this->_get_table_manager()->addIndex('esp_line_item', 'txn_obj_id_obj_type', 'TXN_ID,OBJ_ID,OBJ_type');
-        $this->_get_table_manager()->addIndex('esp_line_item', 'obj_id_obj_type', 'OBJ_ID,OBJ_type');
-        $this->_get_table_manager()->addIndex(
-            'esp_line_item',
-            'LIN_timestamp',
-            'LIN_timestamp',
-            TableAnalysis::INDEX_TYPE_INDEX,
-            null,
-            true
-        );
-
-
-        $this->_table_has_not_changed_since_previous(
-            'esp_log',
-            "LOG_ID int(11) NOT NULL AUTO_INCREMENT,
+		);
+		$this->_get_table_manager()->addIndex('esp_line_item', 'parent_order', 'LIN_parent,LIN_order');
+		$this->_get_table_manager()->addIndex('esp_line_item', 'txn_type_timestamp', 'TXN_ID,LIN_type,LIN_timestamp');
+		$this->_get_table_manager()->addIndex('esp_line_item', 'txn_obj_id_obj_type', 'TXN_ID,OBJ_ID,OBJ_type');
+		$this->_get_table_manager()->addIndex('esp_line_item', 'obj_id_obj_type', 'OBJ_ID,OBJ_type');
+		$this->_get_table_manager()->addIndex(
+			'esp_line_item',
+			'LIN_timestamp',
+			'LIN_timestamp',
+			TableAnalysis::INDEX_TYPE_INDEX,
+			null,
+			true
+		);
+
+
+		$this->_table_has_not_changed_since_previous(
+			'esp_log',
+			"LOG_ID int(11) NOT NULL AUTO_INCREMENT,
 				LOG_time datetime DEFAULT NULL,
 				OBJ_ID varchar(45) DEFAULT NULL,
 				OBJ_type varchar(45) DEFAULT NULL,
@@ -419,15 +419,15 @@ 
 				LOG_message text,
 				LOG_wp_user int(11) DEFAULT NULL,
 				PRIMARY KEY  (LOG_ID)"
-        );
-        $this->_get_table_manager()->addIndex('esp_log', 'LOG_time', 'LOG_time');
-        $this->_get_table_manager()->addIndex('esp_log', 'LOG_type', 'LOG_type');
-        $this->_get_table_manager()->addIndex('esp_log', 'OBJ', 'OBJ_type,OBJ_ID');
+		);
+		$this->_get_table_manager()->addIndex('esp_log', 'LOG_time', 'LOG_time');
+		$this->_get_table_manager()->addIndex('esp_log', 'LOG_type', 'LOG_type');
+		$this->_get_table_manager()->addIndex('esp_log', 'OBJ', 'OBJ_type,OBJ_ID');
 
 
-        $this->_table_has_not_changed_since_previous(
-            'esp_message',
-            "MSG_ID bigint(20) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous(
+			'esp_message',
+			"MSG_ID bigint(20) unsigned NOT NULL AUTO_INCREMENT,
 				GRP_ID int(10) unsigned NULL,
 				MSG_token varchar(255) NULL,
 				TXN_ID int(10) unsigned NULL,
@@ -445,50 +445,50 @@ 
 				MSG_created datetime NOT NULL DEFAULT CURRENT_TIMESTAMP,
 				MSG_modified datetime NOT NULL DEFAULT CURRENT_TIMESTAMP,
 				PRIMARY KEY  (MSG_ID)"
-        );
-        $this->_get_table_manager()->addIndex('esp_message', 'GRP_ID', 'GRP_ID');
-        $this->_get_table_manager()->addIndex('esp_message', 'TXN_ID', 'TXN_ID');
-        $this->_get_table_manager()->addIndex('esp_message', 'MSG_recipient_ID', 'MSG_recipient_ID');
-        $this->_get_table_manager()->addIndex(
-            'esp_message',
-            'MSG_to',
-            'MSG_to',
-            TableAnalysis::INDEX_TYPE_INDEX,
-            TableAnalysis::INDEX_COLUMN_SIZE
-        );
-        $this->_get_table_manager()->addIndex(
-            'esp_message',
-            'MSG_from',
-            'MSG_from',
-            TableAnalysis::INDEX_TYPE_INDEX,
-            TableAnalysis::INDEX_COLUMN_SIZE
-        );
-        $this->_get_table_manager()->addIndex('esp_message', 'MSG_modified', 'MSG_modified');
-        // $this->_get_table_manager()->dropIndex('esp_message', 'MSG_messenger');
-        // $this->_get_table_manager()->dropIndex('esp_message', 'MSG_message_type');
-        // $this->_get_table_manager()->dropIndex('esp_message', 'MSG_context');
-        // $this->_get_table_manager()->dropIndex('esp_message', 'MSG_recipient_type');
-        // $this->_get_table_manager()->dropIndex('esp_message', 'MSG_subject');
-        // $this->_get_table_manager()->dropIndex('esp_message', 'MSG_created');
-        // $this->_get_table_manager()->dropIndex('esp_message', 'MSG_priority');
-        // $this->_get_table_manager()->dropIndex('esp_message', 'STS_ID');
-
-
-        $this->_table_has_not_changed_since_previous(
-            'esp_message_template',
-            "MTP_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		);
+		$this->_get_table_manager()->addIndex('esp_message', 'GRP_ID', 'GRP_ID');
+		$this->_get_table_manager()->addIndex('esp_message', 'TXN_ID', 'TXN_ID');
+		$this->_get_table_manager()->addIndex('esp_message', 'MSG_recipient_ID', 'MSG_recipient_ID');
+		$this->_get_table_manager()->addIndex(
+			'esp_message',
+			'MSG_to',
+			'MSG_to',
+			TableAnalysis::INDEX_TYPE_INDEX,
+			TableAnalysis::INDEX_COLUMN_SIZE
+		);
+		$this->_get_table_manager()->addIndex(
+			'esp_message',
+			'MSG_from',
+			'MSG_from',
+			TableAnalysis::INDEX_TYPE_INDEX,
+			TableAnalysis::INDEX_COLUMN_SIZE
+		);
+		$this->_get_table_manager()->addIndex('esp_message', 'MSG_modified', 'MSG_modified');
+		// $this->_get_table_manager()->dropIndex('esp_message', 'MSG_messenger');
+		// $this->_get_table_manager()->dropIndex('esp_message', 'MSG_message_type');
+		// $this->_get_table_manager()->dropIndex('esp_message', 'MSG_context');
+		// $this->_get_table_manager()->dropIndex('esp_message', 'MSG_recipient_type');
+		// $this->_get_table_manager()->dropIndex('esp_message', 'MSG_subject');
+		// $this->_get_table_manager()->dropIndex('esp_message', 'MSG_created');
+		// $this->_get_table_manager()->dropIndex('esp_message', 'MSG_priority');
+		// $this->_get_table_manager()->dropIndex('esp_message', 'STS_ID');
+
+
+		$this->_table_has_not_changed_since_previous(
+			'esp_message_template',
+			"MTP_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				GRP_ID int(10) unsigned NOT NULL,
 				MTP_context varchar(50) NOT NULL,
 				MTP_template_field varchar(30) NOT NULL,
 				MTP_content text NOT NULL,
 				PRIMARY KEY  (MTP_ID)"
-        );
-        $this->_get_table_manager()->addIndex('esp_message_template', 'GRP_ID', 'GRP_ID');
+		);
+		$this->_get_table_manager()->addIndex('esp_message_template', 'GRP_ID', 'GRP_ID');
 
 
-        $this->_table_has_not_changed_since_previous(
-            'esp_message_template_group',
-            "GRP_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous(
+			'esp_message_template_group',
+			"GRP_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				MTP_user_id int(10) NOT NULL DEFAULT '1',
 				MTP_name varchar(245) NOT NULL DEFAULT '',
 				MTP_description varchar(245) NOT NULL DEFAULT '',
@@ -499,13 +499,13 @@ 
 				MTP_deleted tinyint(1) NOT NULL DEFAULT '0',
 				MTP_is_active tinyint(1) NOT NULL DEFAULT '1',
 				PRIMARY KEY  (GRP_ID)"
-        );
-        $this->_get_table_manager()->addIndex('esp_message_template_group', 'MTP_user_id', 'MTP_user_id');
+		);
+		$this->_get_table_manager()->addIndex('esp_message_template_group', 'MTP_user_id', 'MTP_user_id');
 
 
-        $this->_table_has_not_changed_since_previous(
-            'esp_payment',
-            "PAY_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous(
+			'esp_payment',
+			"PAY_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				TXN_ID int(10) unsigned DEFAULT NULL,
 				STS_ID varchar(3) DEFAULT NULL,
 				PAY_timestamp datetime NOT NULL DEFAULT CURRENT_TIMESTAMP,
@@ -520,21 +520,21 @@ 
 				PAY_redirect_url varchar(300),
 				PAY_redirect_args text,
 				PRIMARY KEY  (PAY_ID)"
-        );
-        $this->_get_table_manager()->addIndex(
-            'esp_payment',
-            'PAY_timestamp',
-            'PAY_timestamp',
-            TableAnalysis::INDEX_TYPE_INDEX,
-            null,
-            true
-        );
-        $this->_get_table_manager()->addIndex('esp_payment', 'TXN_ID', 'TXN_ID');
-
-
-        $this->_table_has_not_changed_since_previous(
-            'esp_payment_method',
-            "PMD_ID int(11) NOT NULL AUTO_INCREMENT,
+		);
+		$this->_get_table_manager()->addIndex(
+			'esp_payment',
+			'PAY_timestamp',
+			'PAY_timestamp',
+			TableAnalysis::INDEX_TYPE_INDEX,
+			null,
+			true
+		);
+		$this->_get_table_manager()->addIndex('esp_payment', 'TXN_ID', 'TXN_ID');
+
+
+		$this->_table_has_not_changed_since_previous(
+			'esp_payment_method',
+			"PMD_ID int(11) NOT NULL AUTO_INCREMENT,
 				PMD_type varchar(124) DEFAULT NULL,
 				PMD_name varchar(255) DEFAULT NULL,
 				PMD_desc text,
@@ -548,19 +548,19 @@ 
 				PMD_button_url varchar(1012) DEFAULT NULL,
 				PMD_scope varchar(255) NULL DEFAULT 'frontend',
 				PRIMARY KEY  (PMD_ID)"
-        );
-        $this->_get_table_manager()->addIndex(
-            'esp_payment_method',
-            'PMD_slug_UNIQUE',
-            'PMD_slug',
-            TableAnalysis::INDEX_TYPE_UNIQUE
-        );
-        // $this->_get_table_manager()->dropIndex('esp_payment_method', 'PMD_type');
-
-
-        $this->_table_is_changed_in_this_version(
-            'esp_price',
-            "PRC_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		);
+		$this->_get_table_manager()->addIndex(
+			'esp_payment_method',
+			'PMD_slug_UNIQUE',
+			'PMD_slug',
+			TableAnalysis::INDEX_TYPE_UNIQUE
+		);
+		// $this->_get_table_manager()->dropIndex('esp_payment_method', 'PMD_type');
+
+
+		$this->_table_is_changed_in_this_version(
+			'esp_price',
+			"PRC_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				PRT_ID tinyint(3) unsigned NOT NULL,
 				PRC_amount decimal(12,6) NOT NULL DEFAULT '0.00',
 				PRC_name varchar(245) NOT NULL,
@@ -572,13 +572,13 @@ 
 				PRC_wp_user bigint(20) unsigned NULL,
 				PRC_parent int(10) unsigned DEFAULT 0,
 				PRIMARY KEY  (PRC_ID)"
-        );
-        $this->_get_table_manager()->addIndex('esp_price', 'PRT_ID', 'PRT_ID');
+		);
+		$this->_get_table_manager()->addIndex('esp_price', 'PRT_ID', 'PRT_ID');
 
 
-        $this->_table_has_not_changed_since_previous(
-            'esp_price_type',
-            "PRT_ID tinyint(3) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous(
+			'esp_price_type',
+			"PRT_ID tinyint(3) unsigned NOT NULL AUTO_INCREMENT,
 				PRT_name varchar(45) NOT NULL,
 				PBT_ID tinyint(3) unsigned NOT NULL DEFAULT '1',
 				PRT_is_percent tinyint(1) NOT NULL DEFAULT '0',
@@ -587,33 +587,33 @@ 
 				PRT_deleted tinyint(1) NOT NULL DEFAULT '0',
 				UNIQUE KEY PRT_name_UNIQUE (PRT_name),
 				PRIMARY KEY  (PRT_ID)"
-        );
+		);
 
 
-        $this->_table_has_not_changed_since_previous(
-            'esp_ticket_price',
-            "TKP_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous(
+			'esp_ticket_price',
+			"TKP_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				TKT_ID int(10) unsigned NOT NULL,
 				PRC_ID int(10) unsigned NOT NULL,
 				PRIMARY KEY  (TKP_ID)"
-        );
-        $this->_get_table_manager()->addIndex('esp_ticket_price', 'TKT_ID', 'TKT_ID');
-        $this->_get_table_manager()->addIndex('esp_ticket_price', 'PRC_ID', 'PRC_ID');
+		);
+		$this->_get_table_manager()->addIndex('esp_ticket_price', 'TKT_ID', 'TKT_ID');
+		$this->_get_table_manager()->addIndex('esp_ticket_price', 'PRC_ID', 'PRC_ID');
 
 
-        $this->_table_has_not_changed_since_previous(
-            'esp_ticket_template',
-            "TTM_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous(
+			'esp_ticket_template',
+			"TTM_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				TTM_name varchar(45) NOT NULL,
 				TTM_description text,
 				TTM_file varchar(45),
 				PRIMARY KEY  (TTM_ID)"
-        );
+		);
 
 
-        $this->_table_has_not_changed_since_previous(
-            'esp_question',
-            "QST_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous(
+			'esp_question',
+			"QST_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				QST_display_text text NOT NULL,
 				QST_admin_label varchar(255) NOT NULL,
 				QST_system varchar(25) DEFAULT NULL,
@@ -626,13 +626,13 @@ 
 				QST_wp_user bigint(20) unsigned NULL,
 				QST_deleted tinyint(2) unsigned NOT NULL DEFAULT 0,
 				PRIMARY KEY  (QST_ID)"
-        );
-        // $this->_get_table_manager()->dropIndex('esp_question', 'QST_order');
+		);
+		// $this->_get_table_manager()->dropIndex('esp_question', 'QST_order');
 
 
-        $this->_table_has_not_changed_since_previous(
-            'esp_question_group',
-            "QSG_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous(
+			'esp_question_group',
+			"QSG_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				QSG_name varchar(255) NOT NULL,
 				QSG_identifier varchar(100) NOT NULL,
 				QSG_desc text NULL,
@@ -643,31 +643,31 @@ 
 				QSG_deleted tinyint(1) unsigned NOT NULL DEFAULT 0,
 				QSG_wp_user bigint(20) unsigned NULL,
 				PRIMARY KEY  (QSG_ID)"
-        );
-        $this->_get_table_manager()->addIndex(
-            'esp_question_group',
-            'QSG_identifier_UNIQUE',
-            'QSG_identifier',
-            TableAnalysis::INDEX_TYPE_UNIQUE
-        );
-        // $this->_get_table_manager()->dropIndex('esp_question_group', 'QSG_order');
-
-
-        $this->_table_has_not_changed_since_previous(
-            'esp_question_group_question',
-            "QGQ_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		);
+		$this->_get_table_manager()->addIndex(
+			'esp_question_group',
+			'QSG_identifier_UNIQUE',
+			'QSG_identifier',
+			TableAnalysis::INDEX_TYPE_UNIQUE
+		);
+		// $this->_get_table_manager()->dropIndex('esp_question_group', 'QSG_order');
+
+
+		$this->_table_has_not_changed_since_previous(
+			'esp_question_group_question',
+			"QGQ_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				QSG_ID int(10) unsigned NOT NULL,
 				QST_ID int(10) unsigned NOT NULL,
 				QGQ_order int(10) unsigned NOT NULL DEFAULT 0,
 				PRIMARY KEY  (QGQ_ID)"
-        );
-        $this->_get_table_manager()->addIndex('esp_question_group_question', 'QST_ID', 'QST_ID');
-        // $this->_get_table_manager()->dropIndex('esp_question_group_question', 'QSG_ID_order');
+		);
+		$this->_get_table_manager()->addIndex('esp_question_group_question', 'QST_ID', 'QST_ID');
+		// $this->_get_table_manager()->dropIndex('esp_question_group_question', 'QSG_ID_order');
 
 
-        $this->_table_has_not_changed_since_previous(
-            'esp_question_option',
-            "QSO_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous(
+			'esp_question_option',
+			"QSO_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				QSO_value varchar(255) NOT NULL,
 				QSO_desc text NOT NULL,
 				QST_ID int(10) unsigned NOT NULL,
@@ -675,14 +675,14 @@ 
 				QSO_system varchar(25) DEFAULT NULL,
 				QSO_deleted tinyint(1) unsigned NOT NULL DEFAULT 0,
 				PRIMARY KEY  (QSO_ID)"
-        );
-        $this->_get_table_manager()->addIndex('esp_question_option', 'QST_ID', 'QST_ID');
-        $this->_get_table_manager()->dropIndex('esp_question_option', 'QSO_order');
+		);
+		$this->_get_table_manager()->addIndex('esp_question_option', 'QST_ID', 'QST_ID');
+		$this->_get_table_manager()->dropIndex('esp_question_option', 'QSO_order');
 
 
-        $this->_table_has_not_changed_since_previous(
-            'esp_registration',
-            "REG_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous(
+			'esp_registration',
+			"REG_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				EVT_ID bigint(20) unsigned NOT NULL,
 				ATT_ID bigint(20) unsigned NOT NULL,
 				TXN_ID int(10) unsigned NOT NULL,
@@ -699,67 +699,67 @@ 
 				REG_att_is_going tinyint(1) DEFAULT '0',
 				REG_deleted tinyint(1) DEFAULT '0',
 				PRIMARY KEY  (REG_ID)"
-        );
-        $this->_get_table_manager()->addIndex('esp_registration', 'REG_url_link', 'REG_url_link');
-        $this->_get_table_manager()->addIndex('esp_registration', 'REG_code', 'REG_code');
-        // $this->_get_table_manager()->addIndex(
-        //     'esp_registration',
-        //     'REG_date',
-        //     'REG_date',
-        //     TableAnalysis::INDEX_TYPE_INDEX,
-        //     null,
-        //     true
-        // );
-        $this->_get_table_manager()->addIndex('esp_registration', 'TXN_ID', 'TXN_ID');
-        $this->_get_table_manager()->addIndex('esp_registration', 'ATT_ID', 'ATT_ID');
-        $this->_get_table_manager()->addIndex('esp_registration', 'TKT_ID', 'TKT_ID');
-        $this->_get_table_manager()->addIndex('esp_registration', 'EVT_ID', 'EVT_ID');
-        $this->_get_table_manager()->dropIndex('esp_registration', 'REG_deleted');
-        // $this->_get_table_manager()->dropIndex('esp_registration', 'STS_ID');
-
-
-        $this->_table_has_not_changed_since_previous(
-            'esp_registration_payment',
-            "RPY_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		);
+		$this->_get_table_manager()->addIndex('esp_registration', 'REG_url_link', 'REG_url_link');
+		$this->_get_table_manager()->addIndex('esp_registration', 'REG_code', 'REG_code');
+		// $this->_get_table_manager()->addIndex(
+		//     'esp_registration',
+		//     'REG_date',
+		//     'REG_date',
+		//     TableAnalysis::INDEX_TYPE_INDEX,
+		//     null,
+		//     true
+		// );
+		$this->_get_table_manager()->addIndex('esp_registration', 'TXN_ID', 'TXN_ID');
+		$this->_get_table_manager()->addIndex('esp_registration', 'ATT_ID', 'ATT_ID');
+		$this->_get_table_manager()->addIndex('esp_registration', 'TKT_ID', 'TKT_ID');
+		$this->_get_table_manager()->addIndex('esp_registration', 'EVT_ID', 'EVT_ID');
+		$this->_get_table_manager()->dropIndex('esp_registration', 'REG_deleted');
+		// $this->_get_table_manager()->dropIndex('esp_registration', 'STS_ID');
+
+
+		$this->_table_has_not_changed_since_previous(
+			'esp_registration_payment',
+			"RPY_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 					  REG_ID int(10) unsigned NOT NULL,
 					  PAY_ID int(10) unsigned NULL,
 					  RPY_amount decimal(12,3) NOT NULL DEFAULT '0.00',
 					  PRIMARY KEY  (RPY_ID)"
-        );
-        $this->_get_table_manager()->addIndex('esp_registration_payment', 'REG_ID', 'REG_ID');
-        $this->_get_table_manager()->addIndex('esp_registration_payment', 'PAY_ID', 'PAY_ID');
+		);
+		$this->_get_table_manager()->addIndex('esp_registration_payment', 'REG_ID', 'REG_ID');
+		$this->_get_table_manager()->addIndex('esp_registration_payment', 'PAY_ID', 'PAY_ID');
 
 
-        $this->_table_has_not_changed_since_previous(
-            'esp_state',
-            "STA_ID smallint(5) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous(
+			'esp_state',
+			"STA_ID smallint(5) unsigned NOT NULL AUTO_INCREMENT,
 				CNT_ISO varchar(2) NOT NULL,
 				STA_abbrev varchar(24) NOT NULL,
 				STA_name varchar(100) NOT NULL,
 				STA_active tinyint(1) DEFAULT '1',
 				PRIMARY KEY  (STA_ID)"
-        );
-        $this->_get_table_manager()->addIndex('esp_state', 'STA_abbrev', 'STA_abbrev');
-        $this->_get_table_manager()->addIndex('esp_state', 'CNT_ISO', 'CNT_ISO');
+		);
+		$this->_get_table_manager()->addIndex('esp_state', 'STA_abbrev', 'STA_abbrev');
+		$this->_get_table_manager()->addIndex('esp_state', 'CNT_ISO', 'CNT_ISO');
 
 
-        $this->_table_has_not_changed_since_previous(
-            'esp_status',
-            "STS_ID varchar(3) NOT NULL,
+		$this->_table_has_not_changed_since_previous(
+			'esp_status',
+			"STS_ID varchar(3) NOT NULL,
 				STS_code varchar(45) NOT NULL,
 				STS_type varchar(45) NOT NULL,
 				STS_can_edit tinyint(1) NOT NULL DEFAULT 0,
 				STS_desc tinytext,
 				STS_open tinyint(1) NOT NULL DEFAULT 1,
 				PRIMARY KEY  (STS_ID)"
-        );
-        $this->_get_table_manager()->addIndex('esp_status', 'STS_type', 'STS_type');
-        $this->_get_table_manager()->dropIndex('esp_status', 'STS_ID_UNIQUE');
+		);
+		$this->_get_table_manager()->addIndex('esp_status', 'STS_type', 'STS_type');
+		$this->_get_table_manager()->dropIndex('esp_status', 'STS_ID_UNIQUE');
 
 
-        $this->_table_is_changed_in_this_version(
-            'esp_ticket',
-            "TKT_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_is_changed_in_this_version(
+			'esp_ticket',
+			"TKT_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				TTM_ID int(10) unsigned NOT NULL,
 				TKT_name varchar(245) NOT NULL DEFAULT '',
 				TKT_description text NOT NULL,
@@ -783,14 +783,14 @@ 
 				TKT_deleted tinyint(1) NOT NULL DEFAULT '0',
 				TKT_visibility smallint(6) unsigned NOT NULL DEFAULT 100,
 				PRIMARY KEY  (TKT_ID)"
-        );
-        $this->_get_table_manager()->addIndex('esp_ticket', 'TKT_start_date', 'TKT_start_date');
-        // $this->_get_table_manager()->addIndex('esp_ticket', 'TKT_end_date', 'TKT_end_date');
+		);
+		$this->_get_table_manager()->addIndex('esp_ticket', 'TKT_start_date', 'TKT_start_date');
+		// $this->_get_table_manager()->addIndex('esp_ticket', 'TKT_end_date', 'TKT_end_date');
 
 
-        $this->_table_has_not_changed_since_previous(
-            'esp_transaction',
-            "TXN_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous(
+			'esp_transaction',
+			"TXN_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				TXN_timestamp datetime NOT NULL DEFAULT CURRENT_TIMESTAMP,
 				TXN_total decimal(12,3) DEFAULT '0.00',
 				TXN_paid decimal(12,3) NOT NULL DEFAULT '0.00',
@@ -800,21 +800,21 @@ 
 				PMD_ID int(11) DEFAULT NULL,
 				TXN_reg_steps text,
 				PRIMARY KEY  (TXN_ID)"
-        );
-        $this->_get_table_manager()->addIndex(
-            'esp_transaction',
-            'TXN_timestamp',
-            'TXN_timestamp',
-            TableAnalysis::INDEX_TYPE_INDEX,
-            null,
-            true
-        );
-        // $this->_get_table_manager()->dropIndex('esp_transaction', 'STS_ID');
-
-
-        $this->_table_has_not_changed_since_previous(
-            'esp_venue_meta',
-            'VNUM_ID int(11) NOT NULL AUTO_INCREMENT,
+		);
+		$this->_get_table_manager()->addIndex(
+			'esp_transaction',
+			'TXN_timestamp',
+			'TXN_timestamp',
+			TableAnalysis::INDEX_TYPE_INDEX,
+			null,
+			true
+		);
+		// $this->_get_table_manager()->dropIndex('esp_transaction', 'STS_ID');
+
+
+		$this->_table_has_not_changed_since_previous(
+			'esp_venue_meta',
+			'VNUM_ID int(11) NOT NULL AUTO_INCREMENT,
 			VNU_ID bigint(20) unsigned NOT NULL DEFAULT 0,
 			VNU_address varchar(255) DEFAULT NULL,
 			VNU_address2 varchar(255) DEFAULT NULL,
@@ -830,29 +830,29 @@ 
 			VNU_enable_for_gmap tinyint(1) DEFAULT 0,
 			VNU_google_map_link varchar(255) DEFAULT NULL,
 			PRIMARY KEY  (VNUM_ID)'
-        );
-        $this->_get_table_manager()->addIndex('esp_venue_meta', 'VNU_ID', 'VNU_ID');
-        $this->_get_table_manager()->addIndex('esp_venue_meta', 'STA_ID', 'STA_ID');
-        $this->_get_table_manager()->addIndex('esp_venue_meta', 'CNT_ISO', 'CNT_ISO');
+		);
+		$this->_get_table_manager()->addIndex('esp_venue_meta', 'VNU_ID', 'VNU_ID');
+		$this->_get_table_manager()->addIndex('esp_venue_meta', 'STA_ID', 'STA_ID');
+		$this->_get_table_manager()->addIndex('esp_venue_meta', 'CNT_ISO', 'CNT_ISO');
 
 
-        $this->previous_dms->insert_default_data();
-        $LegacyTextDomainOptions = new LegacyTextDomainOptions();
-        $LegacyTextDomainOptions->convertToConsolidatedFormat();
-        return true;
-    }
+		$this->previous_dms->insert_default_data();
+		$LegacyTextDomainOptions = new LegacyTextDomainOptions();
+		$LegacyTextDomainOptions->convertToConsolidatedFormat();
+		return true;
+	}
 
 
-    /**
-     * @return bool
-     */
-    public function schema_changes_after_migration(): bool
-    {
-        return true;
-    }
+	/**
+	 * @return bool
+	 */
+	public function schema_changes_after_migration(): bool
+	{
+		return true;
+	}
 
 
-    public function migration_page_hooks()
-    {
-    }
+	public function migration_page_hooks()
+	{
+	}
 }

core/data_migration_scripts/EE_Data_Migration_Script_Stage_Table.core.php

Indentation +75 added lines, -75 removed lines

@@ -15,86 +15,86 @@
  */
 abstract class EE_Data_Migration_Script_Stage_Table extends EE_Data_Migration_Script_Stage
 {
-    /**
-     * @var string The columns to select. May be overridden for children.
-     */
-    protected string $select_expression = '*';
+	/**
+	 * @var string The columns to select. May be overridden for children.
+	 */
+	protected string $select_expression = '*';
 
-    /**
-     * Set in the constructor to add this sql to both the counting query in
-     * EE_Data_Migration_Script_Stage_Table::_count_records_to_migrate() and
-     * EE_Data_Migration_Script_Stage_Table::_get_rows().
-     * Eg "where column_name like '%some_value%'"
-     *
-     * @var string|null
-     */
-    protected ?string $_extra_where_sql = '';
+	/**
+	 * Set in the constructor to add this sql to both the counting query in
+	 * EE_Data_Migration_Script_Stage_Table::_count_records_to_migrate() and
+	 * EE_Data_Migration_Script_Stage_Table::_get_rows().
+	 * Eg "where column_name like '%some_value%'"
+	 *
+	 * @var string|null
+	 */
+	protected ?string $_extra_where_sql = '';
 
 
-    /**
-     * IMPORTANT: if an error is encountered, or everything is finished, this stage should update its status property
-     * accordingly. Note: it should not alter the count of items migrated. That is done in the public function that
-     * calls this. IMPORTANT: The count of items migrated should ONLY be less than $num_items_to_migrate when it's the
-     * last migration step, otherwise it should always return $num_items_to_migrate. (Eg, if we're migrating attendees
-     * rows from the database, and $num_items_to_migrate is set to 50, then we SHOULD actually migrate 50 rows,but at
-     * very least we MUST report/return 50 items migrated)
-     *
-     * @param int $num_items_to_migrate
-     * @return int number of items ACTUALLY migrated
-     */
-    public function _migration_step($num_items_to_migrate = 50)
-    {
-        $rows = $this->_get_rows($num_items_to_migrate);
-        $items_actually_migrated = 0;
-        foreach ($rows as $old_row) {
-            $this->_migrate_old_row($old_row);
-            $items_actually_migrated++;
-        }
-        if ($this->count_records_migrated() + $items_actually_migrated >= $this->count_records_to_migrate()) {
-            $this->set_completed();
-        }
-        return $items_actually_migrated;
-    }
+	/**
+	 * IMPORTANT: if an error is encountered, or everything is finished, this stage should update its status property
+	 * accordingly. Note: it should not alter the count of items migrated. That is done in the public function that
+	 * calls this. IMPORTANT: The count of items migrated should ONLY be less than $num_items_to_migrate when it's the
+	 * last migration step, otherwise it should always return $num_items_to_migrate. (Eg, if we're migrating attendees
+	 * rows from the database, and $num_items_to_migrate is set to 50, then we SHOULD actually migrate 50 rows,but at
+	 * very least we MUST report/return 50 items migrated)
+	 *
+	 * @param int $num_items_to_migrate
+	 * @return int number of items ACTUALLY migrated
+	 */
+	public function _migration_step($num_items_to_migrate = 50)
+	{
+		$rows = $this->_get_rows($num_items_to_migrate);
+		$items_actually_migrated = 0;
+		foreach ($rows as $old_row) {
+			$this->_migrate_old_row($old_row);
+			$items_actually_migrated++;
+		}
+		if ($this->count_records_migrated() + $items_actually_migrated >= $this->count_records_to_migrate()) {
+			$this->set_completed();
+		}
+		return $items_actually_migrated;
+	}
 
-    /**
-     * Gets the rows for each migration stage from the old table
-     *
-     * @global wpdb $wpdb
-     * @param int   $limit
-     * @return array of arrays like $wpdb->get_results($sql, ARRAY_A)
-     */
-    protected function _get_rows($limit)
-    {
-        global $wpdb;
-        $start_at_record = $this->count_records_migrated();
-        $query = "SELECT {$this->select_expression} FROM {$this->_old_table} {$this->_extra_where_sql} " . $wpdb->prepare(
-            "LIMIT %d, %d",
-            $start_at_record,
-            $limit
-        );
-        return $wpdb->get_results($query, ARRAY_A);
-    }
+	/**
+	 * Gets the rows for each migration stage from the old table
+	 *
+	 * @global wpdb $wpdb
+	 * @param int   $limit
+	 * @return array of arrays like $wpdb->get_results($sql, ARRAY_A)
+	 */
+	protected function _get_rows($limit)
+	{
+		global $wpdb;
+		$start_at_record = $this->count_records_migrated();
+		$query = "SELECT {$this->select_expression} FROM {$this->_old_table} {$this->_extra_where_sql} " . $wpdb->prepare(
+			"LIMIT %d, %d",
+			$start_at_record,
+			$limit
+		);
+		return $wpdb->get_results($query, ARRAY_A);
+	}
 
 
-    /**
-     * Counts the records to migrate; the public version may cache it
-     *
-     * @return int
-     */
-    public function _count_records_to_migrate()
-    {
-        global $wpdb;
-        $query = "SELECT COUNT(*) FROM {$this->_old_table} {$this->_extra_where_sql}";
-        return (int) $wpdb->get_var($query);
-    }
+	/**
+	 * Counts the records to migrate; the public version may cache it
+	 *
+	 * @return int
+	 */
+	public function _count_records_to_migrate()
+	{
+		global $wpdb;
+		$query = "SELECT COUNT(*) FROM {$this->_old_table} {$this->_extra_where_sql}";
+		return (int) $wpdb->get_var($query);
+	}
 
-    /**
-     * takes care of migrating this particular row from the OLD table to whatever its
-     * representation is in the new database. If there are errors, use $this->add_error to log them. If there is a
-     * fatal error which prevents all future migrations, throw an exception describing it
-     *
-     * @param array $old_row an associative array where keys are column names and values are their values.
-     * @return void
-     */
-    abstract protected function _migrate_old_row($old_row);
+	/**
+	 * takes care of migrating this particular row from the OLD table to whatever its
+	 * representation is in the new database. If there are errors, use $this->add_error to log them. If there is a
+	 * fatal error which prevents all future migrations, throw an exception describing it
+	 *
+	 * @param array $old_row an associative array where keys are column names and values are their values.
+	 * @return void
+	 */
+	abstract protected function _migrate_old_row($old_row);
 }

core/data_migration_scripts/4_6_0_stages/EE_DMS_4_6_0_invoice_settings.dmsstage.php

Indentation +58 added lines, -58 removed lines

@@ -13,67 +13,67 @@
 class EE_DMS_4_6_0_invoice_settings extends EE_Data_Migration_Script_Stage
 {
 
-    /**
-     * Just initializes the status of the migration
-     */
-    public function __construct()
-    {
-        $this->_pretty_name = esc_html__('Update Invoice Settings', 'event_espresso');
-        parent::__construct();
-    }
+	/**
+	 * Just initializes the status of the migration
+	 */
+	public function __construct()
+	{
+		$this->_pretty_name = esc_html__('Update Invoice Settings', 'event_espresso');
+		parent::__construct();
+	}
 
 
-    /**
-     * _count_records_to_migrate
-     * Counts the records to migrate; the public version may cache it
-     *
-     * @access protected
-     * @return int
-     */
-    protected function _count_records_to_migrate(): int
-    {
-        return 1;
-    }
+	/**
+	 * _count_records_to_migrate
+	 * Counts the records to migrate; the public version may cache it
+	 *
+	 * @access protected
+	 * @return int
+	 */
+	protected function _count_records_to_migrate(): int
+	{
+		return 1;
+	}
 
 
-    /**
-     *    _migration_step
-     *
-     * @access protected
-     * @param int $num_items_to_migrate
-     * @return int number of items ACTUALLY migrated
-     * @throws InvalidDataTypeException
-     */
-    protected function _migration_step($num_items_to_migrate = 1)
-    {
-        $templates_relative_path = 'modules/gateways/Invoice/lib/templates/';
-        $overridden_invoice_body = EEH_Template::locate_template(
-            $templates_relative_path . 'invoice_body.template.php',
-            [],
-            false,
-            false,
-            true
-        );
-        $overridden_receipt_body = EEH_Template::locate_template(
-            $templates_relative_path . 'receipt_body.template.php',
-            [],
-            false,
-            false,
-            true
-        );
-        if ($overridden_invoice_body || $overridden_receipt_body) {
-            new PersistentAdminNotice(
-                'invoice_overriding_templates',
-                esc_html__(
-                    'Note: in this version of Event Espresso, PDF and HTML Invoices and Receipts are now Messages and can be changed just like any other messages; however we noticed you had previously overridden the old default Invoice/Receipt templates. Because of this, your old Invoice/Receipt templates will continue to be used INSTEAD of the new Invoice/Receipt message equivalents (but this will be removed in an upcoming version). We recommend deleting your old Invoice/Receipt templates and using the new messages system. Then modify the new Invoice and Receipt messages\'s content in Messages -> Invoice and Messages -> Receipt.',
-                    'event_espresso'
-                ),
-                true
-            );
-        }
+	/**
+	 *    _migration_step
+	 *
+	 * @access protected
+	 * @param int $num_items_to_migrate
+	 * @return int number of items ACTUALLY migrated
+	 * @throws InvalidDataTypeException
+	 */
+	protected function _migration_step($num_items_to_migrate = 1)
+	{
+		$templates_relative_path = 'modules/gateways/Invoice/lib/templates/';
+		$overridden_invoice_body = EEH_Template::locate_template(
+			$templates_relative_path . 'invoice_body.template.php',
+			[],
+			false,
+			false,
+			true
+		);
+		$overridden_receipt_body = EEH_Template::locate_template(
+			$templates_relative_path . 'receipt_body.template.php',
+			[],
+			false,
+			false,
+			true
+		);
+		if ($overridden_invoice_body || $overridden_receipt_body) {
+			new PersistentAdminNotice(
+				'invoice_overriding_templates',
+				esc_html__(
+					'Note: in this version of Event Espresso, PDF and HTML Invoices and Receipts are now Messages and can be changed just like any other messages; however we noticed you had previously overridden the old default Invoice/Receipt templates. Because of this, your old Invoice/Receipt templates will continue to be used INSTEAD of the new Invoice/Receipt message equivalents (but this will be removed in an upcoming version). We recommend deleting your old Invoice/Receipt templates and using the new messages system. Then modify the new Invoice and Receipt messages\'s content in Messages -> Invoice and Messages -> Receipt.',
+					'event_espresso'
+				),
+				true
+			);
+		}
 
-        // regardless of whether it worked or not, we ought to continue the migration
-        $this->set_completed();
-        return 1;
-    }
+		// regardless of whether it worked or not, we ought to continue the migration
+		$this->set_completed();
+		return 1;
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -48,14 +48,14 @@
     {
         $templates_relative_path = 'modules/gateways/Invoice/lib/templates/';
         $overridden_invoice_body = EEH_Template::locate_template(
-            $templates_relative_path . 'invoice_body.template.php',
+            $templates_relative_path.'invoice_body.template.php',
             [],
             false,
             false,
             true
         );
         $overridden_receipt_body = EEH_Template::locate_template(
-            $templates_relative_path . 'receipt_body.template.php',
+            $templates_relative_path.'receipt_body.template.php',
             [],
             false,
             false,

core/db_models/EEM_Line_Item.model.php

Indentation +652 added lines, -652 removed lines

@@ -27,659 +27,659 @@
  */
 class EEM_Line_Item extends EEM_Base
 {
-    /**
-     * Tax sub-total is just the total of all the taxes, which should be children
-     * of this line item. There should only ever be one tax sub-total, and it should
-     * be a direct child of the grand total. Its quantity and LIN_unit_price = 1.
-     */
-    const type_tax_sub_total = 'tax-sub-total';
-
-    /**
-     * Tax line items indicate a tax applied to all the taxable line items.
-     * Should not have any children line items. Its LIN_unit_price = 0. Its LIN_percent is a percent, not a decimal
-     * (eg 10% tax = 10, not 0.1). Its LIN_total = LIN_unit_price * pre-tax-total. Quantity = 1.
-     */
-    const type_tax = 'tax';
-
-    /**
-     * Indicating individual items purchased, or discounts or surcharges.
-     * The sum of all the regular line items  plus the tax items should equal the grand total.
-     * Possible children are sub-line-items and cancellations.
-     * For flat items, LIN_unit_price * LIN_quantity = LIN_total. Its LIN_total is the sum of all the children
-     * LIN_totals. Its LIN_percent = 0.
-     * For percent items, its LIN_unit_price = 0. Its LIN_percent is a percent, not a decimal (eg 10% = 10, not 0.1).
-     * Its LIN_total is LIN_percent / 100 * sum of lower-priority sibling line items. Quantity = 1.
-     */
-    const type_line_item = 'line-item';
-
-    /**
-     * Line item indicating all the factors that make a single line item.
-     * Sub-line items should have NO children line items.
-     * For flat sub-items, their quantity should match their parent item, their LIN_unit_price should be this sub-item's
-     * contribution towards the price of ONE of their parent items, and its LIN_total should be
-     *  = LIN_quantity * LIN_unit_price. Its LIN_percent = 0.
-     * For percent sub-items, the quantity should be 1, LIN_unit_price should be 0, and its LIN_total should
-     * = LIN_percent / 100 * sum of lower-priority sibling line items..
-     */
-    const type_sub_line_item = 'sub-item';
-
-    /**
-     * SubTax line items indicate a tax that is only applied to the pre-tax total of their parent line item.
-     * Should not have any children line items. Its LIN_unit_price = 0. Its LIN_percent is a percent, not a decimal
-     * (eg 10% tax = 10, not 0.1). Its LIN_total = LIN_unit_price * pre-tax-total. Quantity = 1.
-     */
-    const type_sub_tax = 'sub-tax';
-
-    /**
-     * Line item indicating a sub-total (eg total for an event, or pre-tax subtotal).
-     * Direct children should be event subtotals.
-     * Should have quantity of 1, and a LIN_total and LIN_unit_price of the sum of all its sub-items' LIN_totals.
-     */
-    const type_sub_total = 'sub-total';
-
-    /**
-     * Line item for the grand total of an order.
-     * Its direct children should be tax subtotals and (pre-tax) subtotals,
-     * and possibly a regular line item indicating a transaction-wide discount/surcharge.
-     * Should have a quantity of 1, a LIN_total and LIN_unit_price of the entire order's amount.
-     */
-    const type_total = 'total';
-
-    /**
-     * When a line item is cancelled, a sub-line-item of type 'cancellation'
-     * should be created, indicating the quantity that were cancelled
-     * (because a line item could have a quantity of 1, and its cancellation item
-     * could be for 3, indicating that originally 4 were purchased, but 3 have been
-     * cancelled, and only one remains).
-     * When items are refunded, a cancellation line item should be made, which points
-     * to teh payment model object which actually refunded the payment.
-     * Cancellations should NOT have any children line items; the should NOT affect
-     * any calculations, and are only meant as a record that cancellations have occurred.
-     * Their LIN_percent should be 0.
-     */
-    const type_cancellation = 'cancellation';
-
-    // various line item object types
-    const OBJ_TYPE_EVENT       = 'Event';
-
-    const OBJ_TYPE_PRICE       = 'Price';
-
-    const OBJ_TYPE_PROMOTION   = 'Promotion';
-
-    const OBJ_TYPE_TICKET      = 'Ticket';
-
-    const OBJ_TYPE_TRANSACTION = 'Transaction';
-
-    /**
-     * @var EEM_Line_Item $_instance
-     */
-    protected static $_instance;
-
-
-    /**
-     * private constructor to prevent direct creation
-     *
-     * @param string|null $timezone string representing the timezone we want to set for returned Date Time Strings
-     *                              (and any incoming timezone data that gets saved).
-     *                              Note this just sends the timezone info to the date time model field objects.
-     *                              Default is NULL
-     *                              (and will be assumed using the set timezone in the 'timezone_string' wp option)
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function __construct(?string $timezone = '')
-    {
-        $this->singular_item = esc_html__('Line Item', 'event_espresso');
-        $this->plural_item   = esc_html__('Line Items', 'event_espresso');
-
-        $this->_tables                 = [
-            'Line_Item' => new EE_Primary_Table('esp_line_item', 'LIN_ID'),
-        ];
-        $line_items_can_be_for         = apply_filters(
-            'FHEE__EEM_Line_Item__line_items_can_be_for',
-            ['Ticket', 'Price', 'Event']
-        );
-        $this->_fields                 = [
-            'Line_Item' => [
-                'LIN_ID'         => new EE_Primary_Key_Int_Field(
-                    'LIN_ID',
-                    esc_html__('ID', 'event_espresso')
-                ),
-                'LIN_code'       => new EE_Slug_Field(
-                    'LIN_code',
-                    esc_html__('Code for index into Cart', 'event_espresso'),
-                    true
-                ),
-                'TXN_ID'         => new EE_Foreign_Key_Int_Field(
-                    'TXN_ID',
-                    esc_html__('Transaction ID', 'event_espresso'),
-                    true,
-                    null,
-                    'Transaction'
-                ),
-                'LIN_name'       => new EE_Full_HTML_Field(
-                    'LIN_name',
-                    esc_html__('Line Item Name', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'LIN_desc'       => new EE_Full_HTML_Field(
-                    'LIN_desc',
-                    esc_html__('Line Item Description', 'event_espresso'),
-                    true
-                ),
-                'LIN_unit_price' => new EE_Money_Field(
-                    'LIN_unit_price',
-                    esc_html__('Unit Price', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'LIN_percent'    => new EE_Float_Field(
-                    'LIN_percent',
-                    esc_html__('Percent', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'LIN_is_taxable' => new EE_Boolean_Field(
-                    'LIN_is_taxable',
-                    esc_html__('Taxable', 'event_espresso'),
-                    false,
-                    false
-                ),
-                'LIN_order'      => new EE_Integer_Field(
-                    'LIN_order',
-                    esc_html__('Order of Application towards total of parent', 'event_espresso'),
-                    false,
-                    1
-                ),
-                'LIN_total'      => new EE_Money_Field(
-                    'LIN_total',
-                    esc_html__('Total (unit price x quantity) after taxes', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'LIN_pretax'     => new EE_Money_Field(
-                    'LIN_pretax',
-                    esc_html__('Total (unit price x quantity) before taxes', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'LIN_quantity'   => new EE_Integer_Field(
-                    'LIN_quantity',
-                    esc_html__('Quantity', 'event_espresso'),
-                    false,
-                    1
-                ),
-                'LIN_parent'     => new EE_Integer_Field(
-                    'LIN_parent',
-                    esc_html__("Parent ID (this item goes towards that Line Item's total)", 'event_espresso'),
-                    true,
-                    null
-                ),
-                'LIN_type'       => new EE_Enum_Text_Field(
-                    'LIN_type',
-                    esc_html__('Type', 'event_espresso'),
-                    false,
-                    'line-item',
-                    [
-                        self::type_line_item     => esc_html__('Line Item', 'event_espresso'),
-                        self::type_sub_line_item => esc_html__('Sub-Item', 'event_espresso'),
-                        self::type_sub_tax       => esc_html__('Sub-Tax', 'event_espresso'),
-                        self::type_sub_total     => esc_html__('Subtotal', 'event_espresso'),
-                        self::type_tax_sub_total => esc_html__('Tax Subtotal', 'event_espresso'),
-                        self::type_tax           => esc_html__('Tax', 'event_espresso'),
-                        self::type_total         => esc_html__('Total', 'event_espresso'),
-                        self::type_cancellation  => esc_html__('Cancellation', 'event_espresso'),
-                    ]
-                ),
-                'OBJ_ID'         => new EE_Foreign_Key_Int_Field(
-                    'OBJ_ID',
-                    esc_html__('ID of Item purchased.', 'event_espresso'),
-                    true,
-                    null,
-                    $line_items_can_be_for
-                ),
-                'OBJ_type'       => new EE_Any_Foreign_Model_Name_Field(
-                    'OBJ_type',
-                    esc_html__('Model Name this Line Item is for', 'event_espresso'),
-                    true,
-                    null,
-                    $line_items_can_be_for
-                ),
-                'LIN_timestamp'  => new EE_Datetime_Field(
-                    'LIN_timestamp',
-                    esc_html__('When the line item was created', 'event_espresso'),
-                    false,
-                    EE_Datetime_Field::now,
-                    $timezone
-                ),
-            ],
-        ];
-        $this->_model_relations        = [
-            'Transaction' => new EE_Belongs_To_Relation(),
-            'Ticket'      => new EE_Belongs_To_Any_Relation(),
-            'Price'       => new EE_Belongs_To_Any_Relation(),
-            'Event'       => new EE_Belongs_To_Any_Relation(),
-        ];
-        $this->_model_chain_to_wp_user = 'Transaction.Registration.Event';
-        $this->_caps_slug              = 'transactions';
-        parent::__construct($timezone);
-    }
-
-
-    /**
-     * Gets all the line items for this transaction of the given type
-     *
-     * @param string             $line_item_type like one of EEM_Line_Item::type_*
-     * @param EE_Transaction|int $transaction
-     * @return EE_Base_Class[]|EE_Line_Item[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function get_all_of_type_for_transaction($line_item_type, $transaction)
-    {
-        $transaction = EEM_Transaction::instance()->ensure_is_ID($transaction);
-        return $this->get_all(
-            [
-                [
-                    'LIN_type' => $line_item_type,
-                    'TXN_ID'   => $transaction,
-                ],
-            ]
-        );
-    }
-
-
-    /**
-     * Gets all line items unrelated to tickets that are normal line items
-     * (eg shipping, promotions, and miscellaneous other stuff should probably fit in this category)
-     *
-     * @param EE_Transaction|int $transaction
-     * @return EE_Base_Class[]|EE_Line_Item[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function get_all_non_ticket_line_items_for_transaction($transaction)
-    {
-        $transaction = EEM_Transaction::instance()->ensure_is_ID($transaction);
-        return $this->get_all(
-            [
-                [
-                    'LIN_type' => self::type_line_item,
-                    'TXN_ID'   => $transaction,
-                    'OR'       => [
-                        'OBJ_type*notticket' => ['!=', EEM_Line_Item::OBJ_TYPE_TICKET],
-                        'OBJ_type*null'      => ['IS_NULL'],
-                    ],
-                ],
-            ]
-        );
-    }
-
-
-    /**
-     * Deletes line items with no transaction who have passed the transaction cutoff time.
-     * This needs to be very efficient
-     * because if there are spam bots afoot there will be LOTS of line items. Also MySQL doesn't allow a limit when
-     * deleting and joining tables like this.
-     *
-     * @return int count of how many deleted
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function delete_line_items_with_no_transaction()
-    {
-        /** @type WPDB $wpdb */
-        global $wpdb;
-        $time_to_leave_alone = apply_filters(
-            'FHEE__EEM_Line_Item__delete_line_items_with_no_transaction__time_to_leave_alone',
-            WEEK_IN_SECONDS
-        );
-        $query               = $wpdb->prepare(
-            'DELETE li
+	/**
+	 * Tax sub-total is just the total of all the taxes, which should be children
+	 * of this line item. There should only ever be one tax sub-total, and it should
+	 * be a direct child of the grand total. Its quantity and LIN_unit_price = 1.
+	 */
+	const type_tax_sub_total = 'tax-sub-total';
+
+	/**
+	 * Tax line items indicate a tax applied to all the taxable line items.
+	 * Should not have any children line items. Its LIN_unit_price = 0. Its LIN_percent is a percent, not a decimal
+	 * (eg 10% tax = 10, not 0.1). Its LIN_total = LIN_unit_price * pre-tax-total. Quantity = 1.
+	 */
+	const type_tax = 'tax';
+
+	/**
+	 * Indicating individual items purchased, or discounts or surcharges.
+	 * The sum of all the regular line items  plus the tax items should equal the grand total.
+	 * Possible children are sub-line-items and cancellations.
+	 * For flat items, LIN_unit_price * LIN_quantity = LIN_total. Its LIN_total is the sum of all the children
+	 * LIN_totals. Its LIN_percent = 0.
+	 * For percent items, its LIN_unit_price = 0. Its LIN_percent is a percent, not a decimal (eg 10% = 10, not 0.1).
+	 * Its LIN_total is LIN_percent / 100 * sum of lower-priority sibling line items. Quantity = 1.
+	 */
+	const type_line_item = 'line-item';
+
+	/**
+	 * Line item indicating all the factors that make a single line item.
+	 * Sub-line items should have NO children line items.
+	 * For flat sub-items, their quantity should match their parent item, their LIN_unit_price should be this sub-item's
+	 * contribution towards the price of ONE of their parent items, and its LIN_total should be
+	 *  = LIN_quantity * LIN_unit_price. Its LIN_percent = 0.
+	 * For percent sub-items, the quantity should be 1, LIN_unit_price should be 0, and its LIN_total should
+	 * = LIN_percent / 100 * sum of lower-priority sibling line items..
+	 */
+	const type_sub_line_item = 'sub-item';
+
+	/**
+	 * SubTax line items indicate a tax that is only applied to the pre-tax total of their parent line item.
+	 * Should not have any children line items. Its LIN_unit_price = 0. Its LIN_percent is a percent, not a decimal
+	 * (eg 10% tax = 10, not 0.1). Its LIN_total = LIN_unit_price * pre-tax-total. Quantity = 1.
+	 */
+	const type_sub_tax = 'sub-tax';
+
+	/**
+	 * Line item indicating a sub-total (eg total for an event, or pre-tax subtotal).
+	 * Direct children should be event subtotals.
+	 * Should have quantity of 1, and a LIN_total and LIN_unit_price of the sum of all its sub-items' LIN_totals.
+	 */
+	const type_sub_total = 'sub-total';
+
+	/**
+	 * Line item for the grand total of an order.
+	 * Its direct children should be tax subtotals and (pre-tax) subtotals,
+	 * and possibly a regular line item indicating a transaction-wide discount/surcharge.
+	 * Should have a quantity of 1, a LIN_total and LIN_unit_price of the entire order's amount.
+	 */
+	const type_total = 'total';
+
+	/**
+	 * When a line item is cancelled, a sub-line-item of type 'cancellation'
+	 * should be created, indicating the quantity that were cancelled
+	 * (because a line item could have a quantity of 1, and its cancellation item
+	 * could be for 3, indicating that originally 4 were purchased, but 3 have been
+	 * cancelled, and only one remains).
+	 * When items are refunded, a cancellation line item should be made, which points
+	 * to teh payment model object which actually refunded the payment.
+	 * Cancellations should NOT have any children line items; the should NOT affect
+	 * any calculations, and are only meant as a record that cancellations have occurred.
+	 * Their LIN_percent should be 0.
+	 */
+	const type_cancellation = 'cancellation';
+
+	// various line item object types
+	const OBJ_TYPE_EVENT       = 'Event';
+
+	const OBJ_TYPE_PRICE       = 'Price';
+
+	const OBJ_TYPE_PROMOTION   = 'Promotion';
+
+	const OBJ_TYPE_TICKET      = 'Ticket';
+
+	const OBJ_TYPE_TRANSACTION = 'Transaction';
+
+	/**
+	 * @var EEM_Line_Item $_instance
+	 */
+	protected static $_instance;
+
+
+	/**
+	 * private constructor to prevent direct creation
+	 *
+	 * @param string|null $timezone string representing the timezone we want to set for returned Date Time Strings
+	 *                              (and any incoming timezone data that gets saved).
+	 *                              Note this just sends the timezone info to the date time model field objects.
+	 *                              Default is NULL
+	 *                              (and will be assumed using the set timezone in the 'timezone_string' wp option)
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function __construct(?string $timezone = '')
+	{
+		$this->singular_item = esc_html__('Line Item', 'event_espresso');
+		$this->plural_item   = esc_html__('Line Items', 'event_espresso');
+
+		$this->_tables                 = [
+			'Line_Item' => new EE_Primary_Table('esp_line_item', 'LIN_ID'),
+		];
+		$line_items_can_be_for         = apply_filters(
+			'FHEE__EEM_Line_Item__line_items_can_be_for',
+			['Ticket', 'Price', 'Event']
+		);
+		$this->_fields                 = [
+			'Line_Item' => [
+				'LIN_ID'         => new EE_Primary_Key_Int_Field(
+					'LIN_ID',
+					esc_html__('ID', 'event_espresso')
+				),
+				'LIN_code'       => new EE_Slug_Field(
+					'LIN_code',
+					esc_html__('Code for index into Cart', 'event_espresso'),
+					true
+				),
+				'TXN_ID'         => new EE_Foreign_Key_Int_Field(
+					'TXN_ID',
+					esc_html__('Transaction ID', 'event_espresso'),
+					true,
+					null,
+					'Transaction'
+				),
+				'LIN_name'       => new EE_Full_HTML_Field(
+					'LIN_name',
+					esc_html__('Line Item Name', 'event_espresso'),
+					false,
+					''
+				),
+				'LIN_desc'       => new EE_Full_HTML_Field(
+					'LIN_desc',
+					esc_html__('Line Item Description', 'event_espresso'),
+					true
+				),
+				'LIN_unit_price' => new EE_Money_Field(
+					'LIN_unit_price',
+					esc_html__('Unit Price', 'event_espresso'),
+					false,
+					0
+				),
+				'LIN_percent'    => new EE_Float_Field(
+					'LIN_percent',
+					esc_html__('Percent', 'event_espresso'),
+					false,
+					0
+				),
+				'LIN_is_taxable' => new EE_Boolean_Field(
+					'LIN_is_taxable',
+					esc_html__('Taxable', 'event_espresso'),
+					false,
+					false
+				),
+				'LIN_order'      => new EE_Integer_Field(
+					'LIN_order',
+					esc_html__('Order of Application towards total of parent', 'event_espresso'),
+					false,
+					1
+				),
+				'LIN_total'      => new EE_Money_Field(
+					'LIN_total',
+					esc_html__('Total (unit price x quantity) after taxes', 'event_espresso'),
+					false,
+					0
+				),
+				'LIN_pretax'     => new EE_Money_Field(
+					'LIN_pretax',
+					esc_html__('Total (unit price x quantity) before taxes', 'event_espresso'),
+					false,
+					0
+				),
+				'LIN_quantity'   => new EE_Integer_Field(
+					'LIN_quantity',
+					esc_html__('Quantity', 'event_espresso'),
+					false,
+					1
+				),
+				'LIN_parent'     => new EE_Integer_Field(
+					'LIN_parent',
+					esc_html__("Parent ID (this item goes towards that Line Item's total)", 'event_espresso'),
+					true,
+					null
+				),
+				'LIN_type'       => new EE_Enum_Text_Field(
+					'LIN_type',
+					esc_html__('Type', 'event_espresso'),
+					false,
+					'line-item',
+					[
+						self::type_line_item     => esc_html__('Line Item', 'event_espresso'),
+						self::type_sub_line_item => esc_html__('Sub-Item', 'event_espresso'),
+						self::type_sub_tax       => esc_html__('Sub-Tax', 'event_espresso'),
+						self::type_sub_total     => esc_html__('Subtotal', 'event_espresso'),
+						self::type_tax_sub_total => esc_html__('Tax Subtotal', 'event_espresso'),
+						self::type_tax           => esc_html__('Tax', 'event_espresso'),
+						self::type_total         => esc_html__('Total', 'event_espresso'),
+						self::type_cancellation  => esc_html__('Cancellation', 'event_espresso'),
+					]
+				),
+				'OBJ_ID'         => new EE_Foreign_Key_Int_Field(
+					'OBJ_ID',
+					esc_html__('ID of Item purchased.', 'event_espresso'),
+					true,
+					null,
+					$line_items_can_be_for
+				),
+				'OBJ_type'       => new EE_Any_Foreign_Model_Name_Field(
+					'OBJ_type',
+					esc_html__('Model Name this Line Item is for', 'event_espresso'),
+					true,
+					null,
+					$line_items_can_be_for
+				),
+				'LIN_timestamp'  => new EE_Datetime_Field(
+					'LIN_timestamp',
+					esc_html__('When the line item was created', 'event_espresso'),
+					false,
+					EE_Datetime_Field::now,
+					$timezone
+				),
+			],
+		];
+		$this->_model_relations        = [
+			'Transaction' => new EE_Belongs_To_Relation(),
+			'Ticket'      => new EE_Belongs_To_Any_Relation(),
+			'Price'       => new EE_Belongs_To_Any_Relation(),
+			'Event'       => new EE_Belongs_To_Any_Relation(),
+		];
+		$this->_model_chain_to_wp_user = 'Transaction.Registration.Event';
+		$this->_caps_slug              = 'transactions';
+		parent::__construct($timezone);
+	}
+
+
+	/**
+	 * Gets all the line items for this transaction of the given type
+	 *
+	 * @param string             $line_item_type like one of EEM_Line_Item::type_*
+	 * @param EE_Transaction|int $transaction
+	 * @return EE_Base_Class[]|EE_Line_Item[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function get_all_of_type_for_transaction($line_item_type, $transaction)
+	{
+		$transaction = EEM_Transaction::instance()->ensure_is_ID($transaction);
+		return $this->get_all(
+			[
+				[
+					'LIN_type' => $line_item_type,
+					'TXN_ID'   => $transaction,
+				],
+			]
+		);
+	}
+
+
+	/**
+	 * Gets all line items unrelated to tickets that are normal line items
+	 * (eg shipping, promotions, and miscellaneous other stuff should probably fit in this category)
+	 *
+	 * @param EE_Transaction|int $transaction
+	 * @return EE_Base_Class[]|EE_Line_Item[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function get_all_non_ticket_line_items_for_transaction($transaction)
+	{
+		$transaction = EEM_Transaction::instance()->ensure_is_ID($transaction);
+		return $this->get_all(
+			[
+				[
+					'LIN_type' => self::type_line_item,
+					'TXN_ID'   => $transaction,
+					'OR'       => [
+						'OBJ_type*notticket' => ['!=', EEM_Line_Item::OBJ_TYPE_TICKET],
+						'OBJ_type*null'      => ['IS_NULL'],
+					],
+				],
+			]
+		);
+	}
+
+
+	/**
+	 * Deletes line items with no transaction who have passed the transaction cutoff time.
+	 * This needs to be very efficient
+	 * because if there are spam bots afoot there will be LOTS of line items. Also MySQL doesn't allow a limit when
+	 * deleting and joining tables like this.
+	 *
+	 * @return int count of how many deleted
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function delete_line_items_with_no_transaction()
+	{
+		/** @type WPDB $wpdb */
+		global $wpdb;
+		$time_to_leave_alone = apply_filters(
+			'FHEE__EEM_Line_Item__delete_line_items_with_no_transaction__time_to_leave_alone',
+			WEEK_IN_SECONDS
+		);
+		$query               = $wpdb->prepare(
+			'DELETE li
 				FROM ' . $this->table() . ' li
 				LEFT JOIN ' . EEM_Transaction::instance()->table() . ' t ON li.TXN_ID = t.TXN_ID
 				WHERE t.TXN_ID IS NULL AND li.LIN_timestamp < %s',
-            // use GMT time because that's what TXN_timestamps are in
-            date('Y-m-d H:i:s', time() - $time_to_leave_alone)
-        );
-        return $wpdb->query($query);
-    }
-
-
-    /**
-     * get_line_item_for_transaction_object
-     * Gets a transaction's line item record for a specific object such as a EE_Event or EE_Ticket
-     *
-     * @param int           $TXN_ID
-     * @param EE_Base_Class $object
-     * @return EE_Base_Class[]|EE_Line_Item[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function get_line_item_for_transaction_object($TXN_ID, EE_Base_Class $object)
-    {
-        return $this->get_all(
-            [
-                [
-                    'TXN_ID'   => $TXN_ID,
-                    'OBJ_type' => str_replace('EE_', '', get_class($object)),
-                    'OBJ_ID'   => $object->ID(),
-                ],
-            ]
-        );
-    }
-
-
-    /**
-     * get_object_line_items_for_transaction
-     * Gets all of the the object line items for a transaction, based on an object type plus an array of object IDs
-     *
-     * @param int    $TXN_ID
-     * @param string $OBJ_type
-     * @param array  $OBJ_IDs
-     * @return EE_Base_Class[]|EE_Line_Item[]
-     * @throws EE_Error
-     */
-    public function get_object_line_items_for_transaction(
-        $TXN_ID,
-        $OBJ_type = EEM_Line_Item::OBJ_TYPE_EVENT,
-        $OBJ_IDs = []
-    ) {
-        $query_params = [
-            'OBJ_type' => $OBJ_type,
-            // if incoming $OBJ_IDs is an array, then make sure it is formatted correctly for the query
-            'OBJ_ID'   => is_array($OBJ_IDs) && ! isset($OBJ_IDs['IN']) ? ['IN', $OBJ_IDs] : $OBJ_IDs,
-        ];
-        if ($TXN_ID) {
-            $query_params['TXN_ID'] = $TXN_ID;
-        }
-        return $this->get_all([$query_params]);
-    }
-
-
-    /**
-     * get_all_ticket_line_items_for_transaction
-     *
-     * @param EE_Transaction $transaction
-     * @return EE_Base_Class[]|EE_Line_Item[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function get_all_ticket_line_items_for_transaction(EE_Transaction $transaction)
-    {
-        return $this->get_all(
-            [
-                [
-                    'TXN_ID'   => $transaction->ID(),
-                    'OBJ_type' => EEM_Line_Item::OBJ_TYPE_TICKET,
-                ],
-            ]
-        );
-    }
-
-
-    /**
-     * get_ticket_line_item_for_transaction
-     *
-     * @param int $TXN_ID
-     * @param int $TKT_ID
-     * @return EE_Base_Class|EE_Line_Item|EE_Soft_Delete_Base_Class|NULL
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function get_ticket_line_item_for_transaction($TXN_ID, $TKT_ID)
-    {
-        return $this->get_one(
-            [
-                [
-                    'TXN_ID'   => EEM_Transaction::instance()->ensure_is_ID($TXN_ID),
-                    'OBJ_ID'   => $TKT_ID,
-                    'OBJ_type' => EEM_Line_Item::OBJ_TYPE_TICKET,
-                ],
-            ]
-        );
-    }
-
-
-    /**
-     * get_existing_promotion_line_item
-     * searches the cart for existing line items for the specified promotion
-     *
-     * @param EE_Line_Item $parent_line_item
-     * @param EE_Promotion $promotion
-     * @return EE_Base_Class|EE_Line_Item|EE_Soft_Delete_Base_Class|NULL
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @since 1.0.0
-     */
-    public function get_existing_promotion_line_item(EE_Line_Item $parent_line_item, EE_Promotion $promotion)
-    {
-        return $this->get_one(
-            [
-                [
-                    'TXN_ID'     => $parent_line_item->TXN_ID(),
-                    'LIN_parent' => $parent_line_item->ID(),
-                    'OBJ_type'   => EEM_Line_Item::OBJ_TYPE_PROMOTION,
-                    'OBJ_ID'     => $promotion->ID(),
-                ],
-            ]
-        );
-    }
-
-
-    /**
-     * searches the cart for existing line items for the specified transaction and promotion
-     *
-     * @param int $TXN_ID
-     * @param string $promo_code
-     * @return EE_Base_Class|EE_Line_Item|EE_Soft_Delete_Base_Class|null
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @since 1.0.0
-     */
-    public function getExistingPromotionLineItemForTransactionByCode(int $TXN_ID, string $promo_code)
-    {
-        return $this->get_one(
-            [
-                [
-                    'TXN_ID'     => $TXN_ID,
-                    'LIN_name'   => $promo_code,
-                    'OBJ_type'   => EEM_Line_Item::OBJ_TYPE_PROMOTION,
-                ],
-            ]
-        );
-    }
-
-
-    /**
-     * get_all_promotion_line_items
-     * searches the cart for any and all existing promotion line items
-     *
-     * @param EE_Line_Item $parent_line_item
-     * @return EE_Base_Class[]|EE_Line_Item[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @since   1.0.0
-     */
-    public function get_all_promotion_line_items(EE_Line_Item $parent_line_item)
-    {
-        return $this->get_all(
-            [
-                [
-                    'TXN_ID'     => $parent_line_item->TXN_ID(),
-                    'LIN_parent' => $parent_line_item->ID(),
-                    'OBJ_type'   => EEM_Line_Item::OBJ_TYPE_PROMOTION,
-                ],
-            ]
-        );
-    }
-
-
-    /**
-     * Gets the registration's corresponding line item.
-     * Note: basically does NOT support having multiple line items for a single ticket,
-     * which would happen if some of the registrations had a price modifier while others didn't.
-     * In order to support that, we'd probably need a LIN_ID on registrations or something.
-     *
-     * @param EE_Registration $registration
-     * @return EE_Base_Class|EE_Line_ITem|EE_Soft_Delete_Base_Class|NULL
-     * @throws EE_Error
-     */
-    public function get_line_item_for_registration(EE_Registration $registration)
-    {
-        return $this->get_one($this->line_item_for_registration_query_params($registration));
-    }
-
-
-    /**
-     * Gets the query params used to retrieve a specific line item for the given registration
-     *
-     * @param EE_Registration $registration
-     * @param array           $original_query_params any extra query params you'd like to be merged with
-     * @return array @see
-     *                                               https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @throws EE_Error
-     */
-    public function line_item_for_registration_query_params(
-        EE_Registration $registration,
-        $original_query_params = []
-    ) {
-        return array_replace_recursive(
-            $original_query_params,
-            [
-                [
-                    'OBJ_ID'   => $registration->ticket_ID(),
-                    'OBJ_type' => EEM_Line_Item::OBJ_TYPE_TICKET,
-                    'TXN_ID'   => $registration->transaction_ID(),
-                ],
-            ]
-        );
-    }
-
-
-    /**
-     * @return EE_Base_Class[]|EE_Line_Item[]
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     */
-    public function get_total_line_items_with_no_transaction()
-    {
-        return $this->get_total_line_items_for_carts();
-    }
-
-
-    /**
-     * @return EE_Base_Class[]|EE_Line_Item[]
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     */
-    public function get_total_line_items_for_active_carts()
-    {
-        return $this->get_total_line_items_for_carts(false);
-    }
-
-
-    /**
-     * @return EE_Base_Class[]|EE_Line_Item[]
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     */
-    public function get_total_line_items_for_expired_carts()
-    {
-        return $this->get_total_line_items_for_carts(true);
-    }
-
-
-    /**
-     * Returns an array of grand total line items where the TXN_ID is 0.
-     * If $expired is set to true, then only line items for expired sessions will be returned.
-     * If $expired is set to false, then only line items for active sessions will be returned.
-     *
-     * @param null $expired
-     * @return EE_Base_Class[]|EE_Line_Item[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function get_total_line_items_for_carts($expired = null)
-    {
-        $where_params = [
-            'TXN_ID'   => 0,
-            'LIN_type' => 'total',
-        ];
-        if ($expired !== null) {
-            /** @var EventEspresso\core\domain\values\session\SessionLifespan $session_lifespan */
-            $session_lifespan              = LoaderFactory::getLoader()->getShared(
-                'EventEspresso\core\domain\values\session\SessionLifespan'
-            );
-            $where_params['LIN_timestamp'] = [
-                $expired ? '<=' : '>',
-                $session_lifespan->expiration(),
-            ];
-        }
-        return $this->get_all([$where_params]);
-    }
-
-
-    /**
-     * Returns an array of ticket total line items where the TXN_ID is 0
-     * AND the timestamp is older than the session lifespan.
-     *
-     * @param int $timestamp
-     * @return EE_Base_Class[]|EE_Line_Item[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function getTicketLineItemsForExpiredCarts($timestamp = 0)
-    {
-        if (! absint($timestamp)) {
-            /** @var EventEspresso\core\domain\values\session\SessionLifespan $session_lifespan */
-            $session_lifespan = LoaderFactory::getLoader()->getShared(
-                'EventEspresso\core\domain\values\session\SessionLifespan'
-            );
-            $timestamp        = $session_lifespan->expiration();
-        }
-        return $this->get_all(
-            [
-                [
-                    'TXN_ID'        => 0,
-                    'OBJ_type'      => EEM_Line_Item::OBJ_TYPE_TICKET,
-                    'LIN_timestamp' => ['<=', $timestamp],
-                ],
-            ]
-        );
-    }
+			// use GMT time because that's what TXN_timestamps are in
+			date('Y-m-d H:i:s', time() - $time_to_leave_alone)
+		);
+		return $wpdb->query($query);
+	}
+
+
+	/**
+	 * get_line_item_for_transaction_object
+	 * Gets a transaction's line item record for a specific object such as a EE_Event or EE_Ticket
+	 *
+	 * @param int           $TXN_ID
+	 * @param EE_Base_Class $object
+	 * @return EE_Base_Class[]|EE_Line_Item[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function get_line_item_for_transaction_object($TXN_ID, EE_Base_Class $object)
+	{
+		return $this->get_all(
+			[
+				[
+					'TXN_ID'   => $TXN_ID,
+					'OBJ_type' => str_replace('EE_', '', get_class($object)),
+					'OBJ_ID'   => $object->ID(),
+				],
+			]
+		);
+	}
+
+
+	/**
+	 * get_object_line_items_for_transaction
+	 * Gets all of the the object line items for a transaction, based on an object type plus an array of object IDs
+	 *
+	 * @param int    $TXN_ID
+	 * @param string $OBJ_type
+	 * @param array  $OBJ_IDs
+	 * @return EE_Base_Class[]|EE_Line_Item[]
+	 * @throws EE_Error
+	 */
+	public function get_object_line_items_for_transaction(
+		$TXN_ID,
+		$OBJ_type = EEM_Line_Item::OBJ_TYPE_EVENT,
+		$OBJ_IDs = []
+	) {
+		$query_params = [
+			'OBJ_type' => $OBJ_type,
+			// if incoming $OBJ_IDs is an array, then make sure it is formatted correctly for the query
+			'OBJ_ID'   => is_array($OBJ_IDs) && ! isset($OBJ_IDs['IN']) ? ['IN', $OBJ_IDs] : $OBJ_IDs,
+		];
+		if ($TXN_ID) {
+			$query_params['TXN_ID'] = $TXN_ID;
+		}
+		return $this->get_all([$query_params]);
+	}
+
+
+	/**
+	 * get_all_ticket_line_items_for_transaction
+	 *
+	 * @param EE_Transaction $transaction
+	 * @return EE_Base_Class[]|EE_Line_Item[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function get_all_ticket_line_items_for_transaction(EE_Transaction $transaction)
+	{
+		return $this->get_all(
+			[
+				[
+					'TXN_ID'   => $transaction->ID(),
+					'OBJ_type' => EEM_Line_Item::OBJ_TYPE_TICKET,
+				],
+			]
+		);
+	}
+
+
+	/**
+	 * get_ticket_line_item_for_transaction
+	 *
+	 * @param int $TXN_ID
+	 * @param int $TKT_ID
+	 * @return EE_Base_Class|EE_Line_Item|EE_Soft_Delete_Base_Class|NULL
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function get_ticket_line_item_for_transaction($TXN_ID, $TKT_ID)
+	{
+		return $this->get_one(
+			[
+				[
+					'TXN_ID'   => EEM_Transaction::instance()->ensure_is_ID($TXN_ID),
+					'OBJ_ID'   => $TKT_ID,
+					'OBJ_type' => EEM_Line_Item::OBJ_TYPE_TICKET,
+				],
+			]
+		);
+	}
+
+
+	/**
+	 * get_existing_promotion_line_item
+	 * searches the cart for existing line items for the specified promotion
+	 *
+	 * @param EE_Line_Item $parent_line_item
+	 * @param EE_Promotion $promotion
+	 * @return EE_Base_Class|EE_Line_Item|EE_Soft_Delete_Base_Class|NULL
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @since 1.0.0
+	 */
+	public function get_existing_promotion_line_item(EE_Line_Item $parent_line_item, EE_Promotion $promotion)
+	{
+		return $this->get_one(
+			[
+				[
+					'TXN_ID'     => $parent_line_item->TXN_ID(),
+					'LIN_parent' => $parent_line_item->ID(),
+					'OBJ_type'   => EEM_Line_Item::OBJ_TYPE_PROMOTION,
+					'OBJ_ID'     => $promotion->ID(),
+				],
+			]
+		);
+	}
+
+
+	/**
+	 * searches the cart for existing line items for the specified transaction and promotion
+	 *
+	 * @param int $TXN_ID
+	 * @param string $promo_code
+	 * @return EE_Base_Class|EE_Line_Item|EE_Soft_Delete_Base_Class|null
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @since 1.0.0
+	 */
+	public function getExistingPromotionLineItemForTransactionByCode(int $TXN_ID, string $promo_code)
+	{
+		return $this->get_one(
+			[
+				[
+					'TXN_ID'     => $TXN_ID,
+					'LIN_name'   => $promo_code,
+					'OBJ_type'   => EEM_Line_Item::OBJ_TYPE_PROMOTION,
+				],
+			]
+		);
+	}
+
+
+	/**
+	 * get_all_promotion_line_items
+	 * searches the cart for any and all existing promotion line items
+	 *
+	 * @param EE_Line_Item $parent_line_item
+	 * @return EE_Base_Class[]|EE_Line_Item[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @since   1.0.0
+	 */
+	public function get_all_promotion_line_items(EE_Line_Item $parent_line_item)
+	{
+		return $this->get_all(
+			[
+				[
+					'TXN_ID'     => $parent_line_item->TXN_ID(),
+					'LIN_parent' => $parent_line_item->ID(),
+					'OBJ_type'   => EEM_Line_Item::OBJ_TYPE_PROMOTION,
+				],
+			]
+		);
+	}
+
+
+	/**
+	 * Gets the registration's corresponding line item.
+	 * Note: basically does NOT support having multiple line items for a single ticket,
+	 * which would happen if some of the registrations had a price modifier while others didn't.
+	 * In order to support that, we'd probably need a LIN_ID on registrations or something.
+	 *
+	 * @param EE_Registration $registration
+	 * @return EE_Base_Class|EE_Line_ITem|EE_Soft_Delete_Base_Class|NULL
+	 * @throws EE_Error
+	 */
+	public function get_line_item_for_registration(EE_Registration $registration)
+	{
+		return $this->get_one($this->line_item_for_registration_query_params($registration));
+	}
+
+
+	/**
+	 * Gets the query params used to retrieve a specific line item for the given registration
+	 *
+	 * @param EE_Registration $registration
+	 * @param array           $original_query_params any extra query params you'd like to be merged with
+	 * @return array @see
+	 *                                               https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @throws EE_Error
+	 */
+	public function line_item_for_registration_query_params(
+		EE_Registration $registration,
+		$original_query_params = []
+	) {
+		return array_replace_recursive(
+			$original_query_params,
+			[
+				[
+					'OBJ_ID'   => $registration->ticket_ID(),
+					'OBJ_type' => EEM_Line_Item::OBJ_TYPE_TICKET,
+					'TXN_ID'   => $registration->transaction_ID(),
+				],
+			]
+		);
+	}
+
+
+	/**
+	 * @return EE_Base_Class[]|EE_Line_Item[]
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 */
+	public function get_total_line_items_with_no_transaction()
+	{
+		return $this->get_total_line_items_for_carts();
+	}
+
+
+	/**
+	 * @return EE_Base_Class[]|EE_Line_Item[]
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 */
+	public function get_total_line_items_for_active_carts()
+	{
+		return $this->get_total_line_items_for_carts(false);
+	}
+
+
+	/**
+	 * @return EE_Base_Class[]|EE_Line_Item[]
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 */
+	public function get_total_line_items_for_expired_carts()
+	{
+		return $this->get_total_line_items_for_carts(true);
+	}
+
+
+	/**
+	 * Returns an array of grand total line items where the TXN_ID is 0.
+	 * If $expired is set to true, then only line items for expired sessions will be returned.
+	 * If $expired is set to false, then only line items for active sessions will be returned.
+	 *
+	 * @param null $expired
+	 * @return EE_Base_Class[]|EE_Line_Item[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function get_total_line_items_for_carts($expired = null)
+	{
+		$where_params = [
+			'TXN_ID'   => 0,
+			'LIN_type' => 'total',
+		];
+		if ($expired !== null) {
+			/** @var EventEspresso\core\domain\values\session\SessionLifespan $session_lifespan */
+			$session_lifespan              = LoaderFactory::getLoader()->getShared(
+				'EventEspresso\core\domain\values\session\SessionLifespan'
+			);
+			$where_params['LIN_timestamp'] = [
+				$expired ? '<=' : '>',
+				$session_lifespan->expiration(),
+			];
+		}
+		return $this->get_all([$where_params]);
+	}
+
+
+	/**
+	 * Returns an array of ticket total line items where the TXN_ID is 0
+	 * AND the timestamp is older than the session lifespan.
+	 *
+	 * @param int $timestamp
+	 * @return EE_Base_Class[]|EE_Line_Item[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function getTicketLineItemsForExpiredCarts($timestamp = 0)
+	{
+		if (! absint($timestamp)) {
+			/** @var EventEspresso\core\domain\values\session\SessionLifespan $session_lifespan */
+			$session_lifespan = LoaderFactory::getLoader()->getShared(
+				'EventEspresso\core\domain\values\session\SessionLifespan'
+			);
+			$timestamp        = $session_lifespan->expiration();
+		}
+		return $this->get_all(
+			[
+				[
+					'TXN_ID'        => 0,
+					'OBJ_type'      => EEM_Line_Item::OBJ_TYPE_TICKET,
+					'LIN_timestamp' => ['<=', $timestamp],
+				],
+			]
+		);
+	}
 }

core/admin/EE_Admin_List_Table.core.php

Indentation +951 added lines, -951 removed lines

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

core/admin/EE_Admin_Page_CPT.core.php

Indentation +1427 added lines, -1427 removed lines

@@ -31,452 +31,452 @@ 
  */
 abstract class EE_Admin_Page_CPT extends EE_Admin_Page
 {
-    /**
-     * @var EE_CPT_Base|null
-     */
-    protected $_cpt_model_obj;
-
-    protected ?WP_Post_Type $_cpt_object = null;
-
-
-    /**
-     * This property allows cpt classes to define multiple routes as cpt routes.
-     * //in this array we define what the custom post type for this route is.
-     * array(
-     * 'route_name' => 'custom_post_type_slug'
-     * )
-     *
-     * @var array
-     */
-    protected array $_cpt_routes = [];
-
-
-    /**
-     * This simply defines what the corresponding routes WP will be redirected to after completing a post save/update.
-     * in this format:
-     * array(
-     * 'post_type_slug' => 'edit_route'
-     * )
-     *
-     * @var array
-     */
-    protected array $_cpt_edit_routes = [];
-
-
-    /**
-     * If child classes set the name of their main model via the $_cpt_obj_models property, EE_Admin_Page_CPT will
-     * attempt to retrieve the related object model for the edit pages and assign it to _cpt_page_object. the
-     * _cpt_model_names property should be in the following format: array(
-     * 'route_defined_by_action_param' => 'Model_Name')
-     *
-     * @var array $_cpt_model_names
-     */
-    protected array $_cpt_model_names = [];
-
-
-    /**
-     * This will hold an array of autosave containers that will be used to obtain input values and hook into the WP
-     * autosave so we can save our inputs on the save_post hook!  Children classes should add to this array by using
-     * the _register_autosave_containers() method so that we don't override any other containers already registered.
-     * Registration of containers should be done before load_page_dependencies() is run.
-     *
-     * @var array
-     */
-    protected array $_autosave_containers = [];
-
-    protected array $_autosave_fields     = [];
-
-    /**
-     * Array mapping from admin actions to their equivalent wp core pages for custom post types. So when a user visits
-     * a page for an action, it will appear as if they were visiting the wp core page for that custom post type
-     *
-     * @var array
-     */
-    protected array $_pagenow_map= [];
-
-
-    /**
-     * This is the route that will be used for the edit post route.
-     *
-     * @var string
-     */
-    protected string $cpt_editpost_route = 'edit';
-
-
-    /**
-     * This is hooked into the WordPress do_action('save_post') hook and runs after the custom post type has been
-     * saved.  Child classes are required to declare this method.  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.
-     *
-     * @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
-     */
-    abstract protected function _insert_update_cpt_item($post_id, $post);
-
-
-    /**
-     * This is hooked into the WordPress do_action('trashed_post') hook and runs after a cpt has been trashed.
-     *
-     * @abstract
-     * @param string $post_id The ID of the cpt that was trashed
-     * @return void
-     */
-    abstract public function trash_cpt_item($post_id);
-
-
-    /**
-     * This is hooked into the WordPress do_action('untrashed_post') hook and runs after a cpt has been untrashed
-     *
-     * @param string $post_id theID of the cpt that was untrashed
-     * @return void
-     */
-    abstract public function restore_cpt_item($post_id);
-
-
-    /**
-     * This is hooked into the WordPress do_action('delete_cpt_item') hook and runs after a cpt has been fully deleted
-     * from the db
-     *
-     * @param string $post_id the ID of the cpt that was deleted
-     * @return void
-     */
-    abstract public function delete_cpt_item($post_id);
-
-
-    /**
-     * @return LoaderInterface
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function getLoader(): LoaderInterface
-    {
-        if (! $this->loader instanceof LoaderInterface) {
-            $this->loader = LoaderFactory::getLoader();
-        }
-        return $this->loader;
-    }
-
-
-    /**
-     * Just utilizing the method EE_Admin exposes for doing things before page setup.
-     *
-     * @return void
-     */
-    protected function _before_page_setup()
-    {
-        $this->raw_req_action = $this->request->getRequestParam('action');
-        $this->raw_req_page   = $this->request->getRequestParam('page');
-        $this->_cpt_routes    = array_merge(
-            [
-                'create_new' => $this->page_slug,
-                'edit'       => $this->page_slug,
-                'trash'      => $this->page_slug,
-            ],
-            $this->_cpt_routes
-        );
-        $cpt_route_action     = $this->_cpt_routes[ $this->raw_req_action ] ?? null;
-        // let's see if the current route has a value for cpt_object_slug. if it does, we use that instead of the page
-        $page              = $this->raw_req_page ?: $this->page_slug;
-        $page              = $cpt_route_action ?: $page;
-        $this->_cpt_object = get_post_type_object($page);
-        // tweak pagenow for page loading.
-        if (empty($this->_pagenow_map)) {
-            $this->_pagenow_map = [
-                'create_new' => 'post-new.php',
-                'edit'       => 'post.php',
-                'trash'      => 'post.php',
-            ];
-        }
-        add_action('current_screen', [$this, 'modify_pagenow']);
-        // TODO the below will need to be reworked to account for the cpt routes that are NOT based off of page but action param.
-        // get current page from autosave
-        $current_page        = $this->request->getRequestParam('ee_autosave_data[ee-cpt-hidden-inputs][current_page]');
-        $this->_current_page = $this->request->getRequestParam('current_page', $current_page);
-    }
-
-
-    /**
-     * Simply ensure that we simulate the correct post route for cpt screens
-     *
-     * @param WP_Screen|null $current_screen
-     * @return void
-     */
-    public function modify_pagenow(?WP_Screen $current_screen)
-    {
-        // possibly reset pagenow.
-        if (
-            $this->page_slug === $this->raw_req_page
-            && isset($this->_pagenow_map[ $this->raw_req_action ])
-        ) {
-            global $pagenow, $hook_suffix;
-            $pagenow     = $this->_pagenow_map[ $this->raw_req_action ];
-            $hook_suffix = $pagenow;
-        }
-    }
-
-
-    /**
-     * This method is used to register additional autosave containers to the _autosave_containers property.
-     *
-     * @param array $ids  an array of ids for containers that hold form inputs we want autosave to pickup.  Typically
-     *                    you would send along the id of a metabox container.
-     * @return void
-     * @todo We should automate this at some point by creating a wrapper for add_post_metabox and in our wrapper we
-     *                    automatically register the id for the post metabox as a container.
-     */
-    protected function _register_autosave_containers($ids)
-    {
-        $this->_autosave_containers = array_merge($this->_autosave_fields, (array) $ids);
-    }
-
-
-    /**
-     * Something nifty.  We're going to loop through all the registered metaboxes and if the CALLBACK is an instance of
-     * EE_Admin_Page OR EE_Admin_Hooks, then we'll add the id to our _autosave_containers array.
-     */
-    protected function _set_autosave_containers()
-    {
-        global $wp_meta_boxes;
-        $containers = [];
-        if (empty($wp_meta_boxes)) {
-            return;
-        }
-        $current_metaboxes = $wp_meta_boxes[ $this->page_slug ] ?? [];
-        foreach ($current_metaboxes as $box_context) {
-            foreach ($box_context as $box_details) {
-                foreach ($box_details as $box) {
-                    if (
-                        is_array($box) && is_array($box['callback'])
-                        && (
-                            $box['callback'][0] instanceof EE_Admin_Page
-                            || $box['callback'][0] instanceof EE_Admin_Hooks
-                        )
-                    ) {
-                        $containers[] = $box['id'];
-                    }
-                }
-            }
-        }
-        $this->_autosave_containers = array_merge($this->_autosave_containers, $containers);
-        // add hidden inputs container
-        $this->_autosave_containers[] = 'ee-cpt-hidden-inputs';
-    }
-
-
-    protected function _load_autosave_scripts_styles()
-    {
-        /*wp_register_script('cpt-autosave', EE_ADMIN_URL . 'assets/ee-cpt-autosave.js', array('ee-serialize-full-array', 'event_editor_js'), EVENT_ESPRESSO_VERSION, TRUE );
+	/**
+	 * @var EE_CPT_Base|null
+	 */
+	protected $_cpt_model_obj;
+
+	protected ?WP_Post_Type $_cpt_object = null;
+
+
+	/**
+	 * This property allows cpt classes to define multiple routes as cpt routes.
+	 * //in this array we define what the custom post type for this route is.
+	 * array(
+	 * 'route_name' => 'custom_post_type_slug'
+	 * )
+	 *
+	 * @var array
+	 */
+	protected array $_cpt_routes = [];
+
+
+	/**
+	 * This simply defines what the corresponding routes WP will be redirected to after completing a post save/update.
+	 * in this format:
+	 * array(
+	 * 'post_type_slug' => 'edit_route'
+	 * )
+	 *
+	 * @var array
+	 */
+	protected array $_cpt_edit_routes = [];
+
+
+	/**
+	 * If child classes set the name of their main model via the $_cpt_obj_models property, EE_Admin_Page_CPT will
+	 * attempt to retrieve the related object model for the edit pages and assign it to _cpt_page_object. the
+	 * _cpt_model_names property should be in the following format: array(
+	 * 'route_defined_by_action_param' => 'Model_Name')
+	 *
+	 * @var array $_cpt_model_names
+	 */
+	protected array $_cpt_model_names = [];
+
+
+	/**
+	 * This will hold an array of autosave containers that will be used to obtain input values and hook into the WP
+	 * autosave so we can save our inputs on the save_post hook!  Children classes should add to this array by using
+	 * the _register_autosave_containers() method so that we don't override any other containers already registered.
+	 * Registration of containers should be done before load_page_dependencies() is run.
+	 *
+	 * @var array
+	 */
+	protected array $_autosave_containers = [];
+
+	protected array $_autosave_fields     = [];
+
+	/**
+	 * Array mapping from admin actions to their equivalent wp core pages for custom post types. So when a user visits
+	 * a page for an action, it will appear as if they were visiting the wp core page for that custom post type
+	 *
+	 * @var array
+	 */
+	protected array $_pagenow_map= [];
+
+
+	/**
+	 * This is the route that will be used for the edit post route.
+	 *
+	 * @var string
+	 */
+	protected string $cpt_editpost_route = 'edit';
+
+
+	/**
+	 * This is hooked into the WordPress do_action('save_post') hook and runs after the custom post type has been
+	 * saved.  Child classes are required to declare this method.  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.
+	 *
+	 * @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
+	 */
+	abstract protected function _insert_update_cpt_item($post_id, $post);
+
+
+	/**
+	 * This is hooked into the WordPress do_action('trashed_post') hook and runs after a cpt has been trashed.
+	 *
+	 * @abstract
+	 * @param string $post_id The ID of the cpt that was trashed
+	 * @return void
+	 */
+	abstract public function trash_cpt_item($post_id);
+
+
+	/**
+	 * This is hooked into the WordPress do_action('untrashed_post') hook and runs after a cpt has been untrashed
+	 *
+	 * @param string $post_id theID of the cpt that was untrashed
+	 * @return void
+	 */
+	abstract public function restore_cpt_item($post_id);
+
+
+	/**
+	 * This is hooked into the WordPress do_action('delete_cpt_item') hook and runs after a cpt has been fully deleted
+	 * from the db
+	 *
+	 * @param string $post_id the ID of the cpt that was deleted
+	 * @return void
+	 */
+	abstract public function delete_cpt_item($post_id);
+
+
+	/**
+	 * @return LoaderInterface
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function getLoader(): LoaderInterface
+	{
+		if (! $this->loader instanceof LoaderInterface) {
+			$this->loader = LoaderFactory::getLoader();
+		}
+		return $this->loader;
+	}
+
+
+	/**
+	 * Just utilizing the method EE_Admin exposes for doing things before page setup.
+	 *
+	 * @return void
+	 */
+	protected function _before_page_setup()
+	{
+		$this->raw_req_action = $this->request->getRequestParam('action');
+		$this->raw_req_page   = $this->request->getRequestParam('page');
+		$this->_cpt_routes    = array_merge(
+			[
+				'create_new' => $this->page_slug,
+				'edit'       => $this->page_slug,
+				'trash'      => $this->page_slug,
+			],
+			$this->_cpt_routes
+		);
+		$cpt_route_action     = $this->_cpt_routes[ $this->raw_req_action ] ?? null;
+		// let's see if the current route has a value for cpt_object_slug. if it does, we use that instead of the page
+		$page              = $this->raw_req_page ?: $this->page_slug;
+		$page              = $cpt_route_action ?: $page;
+		$this->_cpt_object = get_post_type_object($page);
+		// tweak pagenow for page loading.
+		if (empty($this->_pagenow_map)) {
+			$this->_pagenow_map = [
+				'create_new' => 'post-new.php',
+				'edit'       => 'post.php',
+				'trash'      => 'post.php',
+			];
+		}
+		add_action('current_screen', [$this, 'modify_pagenow']);
+		// TODO the below will need to be reworked to account for the cpt routes that are NOT based off of page but action param.
+		// get current page from autosave
+		$current_page        = $this->request->getRequestParam('ee_autosave_data[ee-cpt-hidden-inputs][current_page]');
+		$this->_current_page = $this->request->getRequestParam('current_page', $current_page);
+	}
+
+
+	/**
+	 * Simply ensure that we simulate the correct post route for cpt screens
+	 *
+	 * @param WP_Screen|null $current_screen
+	 * @return void
+	 */
+	public function modify_pagenow(?WP_Screen $current_screen)
+	{
+		// possibly reset pagenow.
+		if (
+			$this->page_slug === $this->raw_req_page
+			&& isset($this->_pagenow_map[ $this->raw_req_action ])
+		) {
+			global $pagenow, $hook_suffix;
+			$pagenow     = $this->_pagenow_map[ $this->raw_req_action ];
+			$hook_suffix = $pagenow;
+		}
+	}
+
+
+	/**
+	 * This method is used to register additional autosave containers to the _autosave_containers property.
+	 *
+	 * @param array $ids  an array of ids for containers that hold form inputs we want autosave to pickup.  Typically
+	 *                    you would send along the id of a metabox container.
+	 * @return void
+	 * @todo We should automate this at some point by creating a wrapper for add_post_metabox and in our wrapper we
+	 *                    automatically register the id for the post metabox as a container.
+	 */
+	protected function _register_autosave_containers($ids)
+	{
+		$this->_autosave_containers = array_merge($this->_autosave_fields, (array) $ids);
+	}
+
+
+	/**
+	 * Something nifty.  We're going to loop through all the registered metaboxes and if the CALLBACK is an instance of
+	 * EE_Admin_Page OR EE_Admin_Hooks, then we'll add the id to our _autosave_containers array.
+	 */
+	protected function _set_autosave_containers()
+	{
+		global $wp_meta_boxes;
+		$containers = [];
+		if (empty($wp_meta_boxes)) {
+			return;
+		}
+		$current_metaboxes = $wp_meta_boxes[ $this->page_slug ] ?? [];
+		foreach ($current_metaboxes as $box_context) {
+			foreach ($box_context as $box_details) {
+				foreach ($box_details as $box) {
+					if (
+						is_array($box) && is_array($box['callback'])
+						&& (
+							$box['callback'][0] instanceof EE_Admin_Page
+							|| $box['callback'][0] instanceof EE_Admin_Hooks
+						)
+					) {
+						$containers[] = $box['id'];
+					}
+				}
+			}
+		}
+		$this->_autosave_containers = array_merge($this->_autosave_containers, $containers);
+		// add hidden inputs container
+		$this->_autosave_containers[] = 'ee-cpt-hidden-inputs';
+	}
+
+
+	protected function _load_autosave_scripts_styles()
+	{
+		/*wp_register_script('cpt-autosave', EE_ADMIN_URL . 'assets/ee-cpt-autosave.js', array('ee-serialize-full-array', 'event_editor_js'), EVENT_ESPRESSO_VERSION, TRUE );
         wp_enqueue_script('cpt-autosave');/**/ // todo re-enable when we start doing autosave again in 4.2
 
-        // filter _autosave_containers
-        $containers = apply_filters(
-            'FHEE__EE_Admin_Page_CPT___load_autosave_scripts_styles__containers',
-            $this->_autosave_containers,
-            $this
-        );
-        $containers = apply_filters(
-            'FHEE__EE_Admin_Page_CPT__' . get_class($this) . '___load_autosave_scripts_styles__containers',
-            $containers,
-            $this
-        );
-
-        wp_localize_script(
-            'event_editor_js',
-            'EE_AUTOSAVE_IDS',
-            $containers
-        ); // todo once we enable autosaves, this needs to be switched to localize with "cpt-autosave"
-
-        $unsaved_data_msg = [
-            'eventmsg'     => sprintf(
-                wp_strip_all_tags(
-                    __(
-                        "The changes you made to this %s will be lost if you navigate away from this page.",
-                        'event_espresso'
-                    )
-                ),
-                $this->_cpt_object->labels->singular_name
-            ),
-            'inputChanged' => 0,
-        ];
-        wp_localize_script('event_editor_js', 'UNSAVED_DATA_MSG', $unsaved_data_msg);
-    }
-
-
-    /**
-     * overloading the EE_Admin_Page parent load_page_dependencies so we can get the cpt stuff added in appropriately
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws Throwable
-     */
-    protected function _load_page_dependencies()
-    {
-        // we only add stuff if this is a cpt_route!
-        if (! $this->_cpt_route) {
-            parent::_load_page_dependencies();
-            return;
-        }
-        // now let's do some automatic filters into the wp_system
-        // and we'll check to make sure the CHILD class
-        // automatically has the required methods in place.
-        // the following filters are for setting all the redirects
-        // on DEFAULT WP custom post type actions
-        // let's add a hidden input to the post-edit form
-        // so we know when we have to trigger our custom redirects!
-        // Otherwise the redirects will happen on ALL post saves which wouldn't be good of course!
-        add_action('edit_form_after_title', [$this, 'cpt_post_form_hidden_input']);
-        // inject our Admin page nav tabs...
-        // let's make sure the nav tabs are set if they aren't already
-        // if ( empty( $this->_nav_tabs ) ) $this->_set_nav_tabs();
-        add_action('edit_form_top', [$this, 'inject_nav_tabs']);
-        // modify the post_updated messages array
-        add_action('post_updated_messages', [$this, 'post_update_messages']);
-        // This basically allows us to change the title of the "publish" metabox area
-        // on CPT pages by setting a 'publishbox' value in the $_labels property array in the child class.
-        $screen = $this->_cpt_routes[ $this->_req_action ];
-        if (! empty($this->_labels['publishbox'])) {
-            $this->addMetaBox(
-                'submitdiv',
-                $this->getPublishBoxTitle(),
-                'post_submit_meta_box',
-                $screen,
-                'side',
-                'core'
-            );
-        }
-        // let's add page_templates metabox if this cpt added support for it.
-        if ($this->_supports_page_templates($this->_cpt_object->name)) {
-            $this->addMetaBox(
-                'page_templates',
-                esc_html__('Page Template', 'event_espresso'),
-                [$this, 'page_template_meta_box'],
-                $screen,
-                'side'
-            );
-        }
-        // add preview button
-        // add_filter('get_sample_permalink_html', [PreviewButton::class, 'addButton'], 5, 2);
-        PreviewButton::addEventEditorPermalinkButton(5);
-        // add shortlink button to cpt edit screens.
-        //  We can do this as a universal thing BECAUSE, cpts use the same format for shortlinks as posts!
-        // add_filter('get_sample_permalink_html', [EventShortlinkButton::class, 'addButton'], 10, 2);
-        EventShortlinkButton::addEventEditorPermalinkButton();
-        // this is a filter that allows the addition of extra html after the permalink field on the wp post edit-form
-        // add_filter('get_sample_permalink_html', [TicketSelectorShortcodeButton::class, 'addButton'], 12, 2);
-        TicketSelectorShortcodeButton::addEventEditorPermalinkButton(12);
-        // insert our own post_stati dropdown
-        add_action('post_submitbox_misc_actions', [$this, 'custom_post_stati_dropdown']);
-        // This allows adding additional information to the publish post submitbox on the wp post edit form
-        if (method_exists($this, 'extra_misc_actions_publish_box')) {
-            add_action('post_submitbox_misc_actions', [$this, 'extra_misc_actions_publish_box']);
-        }
-        // This allows for adding additional stuff after the title field on the wp post edit form.
-        // This is also before the wp_editor for post description field.
-        if (method_exists($this, 'edit_form_after_title')) {
-            add_action('edit_form_after_title', [$this, 'edit_form_after_title']);
-        }
-        /**
-         * Filtering WP's esc_url to capture urls pointing to core wp routes so they point to our route.
-         */
-        add_filter('clean_url', [$this, 'switch_core_wp_urls_with_ours']);
-        parent::_load_page_dependencies();
-        // notice we are ALSO going to load the pagenow hook set for this route
-        // (see _before_page_setup for the reset of the pagenow global ).
-        // This is for any plugins that are doing things properly
-        // and hooking into the load page hook for core wp cpt routes.
-        global $pagenow;
-        add_action('load-' . $pagenow, [$this, 'modify_current_screen'], 20);
-        do_action('load-' . $pagenow);
-        add_action('admin_enqueue_scripts', [$this, 'setup_autosave_hooks'], 30);
-        // we route REALLY early.
-        try {
-            $this->_route_admin_request();
-        } catch (EE_Error $e) {
-            $e->get_error();
-        }
-    }
-
-
-    /**
-     * Since we don't want users going to default core wp routes, this will check any wp urls run through the
-     * esc_url() method and if we see a url matching a pattern for our routes, we'll modify it to point to OUR
-     * route instead.
-     *
-     * @param string $good_protocol_url The escaped url.
-     * @return string possibly a new url for our route.
-     */
-    public function switch_core_wp_urls_with_ours(string $good_protocol_url): string
-    {
-        $routes_to_match = [
-            0 => [
-                'edit.php?post_type=espresso_attendees',
-                'admin.php?page=espresso_registrations&action=contact_list',
-            ],
-            1 => [
-                'edit.php?post_type=' . $this->_cpt_object->name,
-                'admin.php?page=' . $this->_cpt_object->name,
-            ],
-        ];
-        foreach ($routes_to_match as $route_matches) {
-            if (strpos($good_protocol_url, $route_matches[0]) !== false) {
-                return str_replace($route_matches[0], $route_matches[1], $good_protocol_url);
-            }
-        }
-        return $good_protocol_url;
-    }
-
-
-    /**
-     * Determine whether the current cpt supports page templates or not.
-     *
-     * @param string $cpt_name The cpt slug we're checking on.
-     * @return bool True supported, false not.
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @since %VER%
-     */
-    private function _supports_page_templates(string $cpt_name): bool
-    {
-        /** @var EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions $custom_post_types */
-        $custom_post_types = $this->loader->getShared(
-            'EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions'
-        );
-        $cpt_args          = $custom_post_types->getDefinitions();
-        $cpt_args          = isset($cpt_args[ $cpt_name ]) ? $cpt_args[ $cpt_name ]['args'] : [];
-        $cpt_has_support   = ! empty($cpt_args['page_templates']);
-
-        $post_templates = wp_get_theme()->get_post_templates();
-        // if there are $post_templates for this cpt, then we return false for this method because
-        // that means we aren't going to load our page template manager and leave that up to the native
-        // cpt template manager.
-        return ! isset($post_templates[ $cpt_name ]) ? $cpt_has_support : false;
-    }
-
-
-    /**
-     * Callback for the page_templates metabox selector.
-     *
-     * @return void
-     * @since %VER%
-     */
-    public function page_template_meta_box()
-    {
-        global $post;
-        $template = '';
-
-        $page_template_count = count(get_page_templates());
-        if ($page_template_count) {
-            $page_template = get_post_meta($post->ID, '_wp_page_template', true);
-            $template      = ! empty($page_template) ? $page_template : '';
-        }
-        ?>
+		// filter _autosave_containers
+		$containers = apply_filters(
+			'FHEE__EE_Admin_Page_CPT___load_autosave_scripts_styles__containers',
+			$this->_autosave_containers,
+			$this
+		);
+		$containers = apply_filters(
+			'FHEE__EE_Admin_Page_CPT__' . get_class($this) . '___load_autosave_scripts_styles__containers',
+			$containers,
+			$this
+		);
+
+		wp_localize_script(
+			'event_editor_js',
+			'EE_AUTOSAVE_IDS',
+			$containers
+		); // todo once we enable autosaves, this needs to be switched to localize with "cpt-autosave"
+
+		$unsaved_data_msg = [
+			'eventmsg'     => sprintf(
+				wp_strip_all_tags(
+					__(
+						"The changes you made to this %s will be lost if you navigate away from this page.",
+						'event_espresso'
+					)
+				),
+				$this->_cpt_object->labels->singular_name
+			),
+			'inputChanged' => 0,
+		];
+		wp_localize_script('event_editor_js', 'UNSAVED_DATA_MSG', $unsaved_data_msg);
+	}
+
+
+	/**
+	 * overloading the EE_Admin_Page parent load_page_dependencies so we can get the cpt stuff added in appropriately
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws Throwable
+	 */
+	protected function _load_page_dependencies()
+	{
+		// we only add stuff if this is a cpt_route!
+		if (! $this->_cpt_route) {
+			parent::_load_page_dependencies();
+			return;
+		}
+		// now let's do some automatic filters into the wp_system
+		// and we'll check to make sure the CHILD class
+		// automatically has the required methods in place.
+		// the following filters are for setting all the redirects
+		// on DEFAULT WP custom post type actions
+		// let's add a hidden input to the post-edit form
+		// so we know when we have to trigger our custom redirects!
+		// Otherwise the redirects will happen on ALL post saves which wouldn't be good of course!
+		add_action('edit_form_after_title', [$this, 'cpt_post_form_hidden_input']);
+		// inject our Admin page nav tabs...
+		// let's make sure the nav tabs are set if they aren't already
+		// if ( empty( $this->_nav_tabs ) ) $this->_set_nav_tabs();
+		add_action('edit_form_top', [$this, 'inject_nav_tabs']);
+		// modify the post_updated messages array
+		add_action('post_updated_messages', [$this, 'post_update_messages']);
+		// This basically allows us to change the title of the "publish" metabox area
+		// on CPT pages by setting a 'publishbox' value in the $_labels property array in the child class.
+		$screen = $this->_cpt_routes[ $this->_req_action ];
+		if (! empty($this->_labels['publishbox'])) {
+			$this->addMetaBox(
+				'submitdiv',
+				$this->getPublishBoxTitle(),
+				'post_submit_meta_box',
+				$screen,
+				'side',
+				'core'
+			);
+		}
+		// let's add page_templates metabox if this cpt added support for it.
+		if ($this->_supports_page_templates($this->_cpt_object->name)) {
+			$this->addMetaBox(
+				'page_templates',
+				esc_html__('Page Template', 'event_espresso'),
+				[$this, 'page_template_meta_box'],
+				$screen,
+				'side'
+			);
+		}
+		// add preview button
+		// add_filter('get_sample_permalink_html', [PreviewButton::class, 'addButton'], 5, 2);
+		PreviewButton::addEventEditorPermalinkButton(5);
+		// add shortlink button to cpt edit screens.
+		//  We can do this as a universal thing BECAUSE, cpts use the same format for shortlinks as posts!
+		// add_filter('get_sample_permalink_html', [EventShortlinkButton::class, 'addButton'], 10, 2);
+		EventShortlinkButton::addEventEditorPermalinkButton();
+		// this is a filter that allows the addition of extra html after the permalink field on the wp post edit-form
+		// add_filter('get_sample_permalink_html', [TicketSelectorShortcodeButton::class, 'addButton'], 12, 2);
+		TicketSelectorShortcodeButton::addEventEditorPermalinkButton(12);
+		// insert our own post_stati dropdown
+		add_action('post_submitbox_misc_actions', [$this, 'custom_post_stati_dropdown']);
+		// This allows adding additional information to the publish post submitbox on the wp post edit form
+		if (method_exists($this, 'extra_misc_actions_publish_box')) {
+			add_action('post_submitbox_misc_actions', [$this, 'extra_misc_actions_publish_box']);
+		}
+		// This allows for adding additional stuff after the title field on the wp post edit form.
+		// This is also before the wp_editor for post description field.
+		if (method_exists($this, 'edit_form_after_title')) {
+			add_action('edit_form_after_title', [$this, 'edit_form_after_title']);
+		}
+		/**
+		 * Filtering WP's esc_url to capture urls pointing to core wp routes so they point to our route.
+		 */
+		add_filter('clean_url', [$this, 'switch_core_wp_urls_with_ours']);
+		parent::_load_page_dependencies();
+		// notice we are ALSO going to load the pagenow hook set for this route
+		// (see _before_page_setup for the reset of the pagenow global ).
+		// This is for any plugins that are doing things properly
+		// and hooking into the load page hook for core wp cpt routes.
+		global $pagenow;
+		add_action('load-' . $pagenow, [$this, 'modify_current_screen'], 20);
+		do_action('load-' . $pagenow);
+		add_action('admin_enqueue_scripts', [$this, 'setup_autosave_hooks'], 30);
+		// we route REALLY early.
+		try {
+			$this->_route_admin_request();
+		} catch (EE_Error $e) {
+			$e->get_error();
+		}
+	}
+
+
+	/**
+	 * Since we don't want users going to default core wp routes, this will check any wp urls run through the
+	 * esc_url() method and if we see a url matching a pattern for our routes, we'll modify it to point to OUR
+	 * route instead.
+	 *
+	 * @param string $good_protocol_url The escaped url.
+	 * @return string possibly a new url for our route.
+	 */
+	public function switch_core_wp_urls_with_ours(string $good_protocol_url): string
+	{
+		$routes_to_match = [
+			0 => [
+				'edit.php?post_type=espresso_attendees',
+				'admin.php?page=espresso_registrations&action=contact_list',
+			],
+			1 => [
+				'edit.php?post_type=' . $this->_cpt_object->name,
+				'admin.php?page=' . $this->_cpt_object->name,
+			],
+		];
+		foreach ($routes_to_match as $route_matches) {
+			if (strpos($good_protocol_url, $route_matches[0]) !== false) {
+				return str_replace($route_matches[0], $route_matches[1], $good_protocol_url);
+			}
+		}
+		return $good_protocol_url;
+	}
+
+
+	/**
+	 * Determine whether the current cpt supports page templates or not.
+	 *
+	 * @param string $cpt_name The cpt slug we're checking on.
+	 * @return bool True supported, false not.
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @since %VER%
+	 */
+	private function _supports_page_templates(string $cpt_name): bool
+	{
+		/** @var EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions $custom_post_types */
+		$custom_post_types = $this->loader->getShared(
+			'EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions'
+		);
+		$cpt_args          = $custom_post_types->getDefinitions();
+		$cpt_args          = isset($cpt_args[ $cpt_name ]) ? $cpt_args[ $cpt_name ]['args'] : [];
+		$cpt_has_support   = ! empty($cpt_args['page_templates']);
+
+		$post_templates = wp_get_theme()->get_post_templates();
+		// if there are $post_templates for this cpt, then we return false for this method because
+		// that means we aren't going to load our page template manager and leave that up to the native
+		// cpt template manager.
+		return ! isset($post_templates[ $cpt_name ]) ? $cpt_has_support : false;
+	}
+
+
+	/**
+	 * Callback for the page_templates metabox selector.
+	 *
+	 * @return void
+	 * @since %VER%
+	 */
+	public function page_template_meta_box()
+	{
+		global $post;
+		$template = '';
+
+		$page_template_count = count(get_page_templates());
+		if ($page_template_count) {
+			$page_template = get_post_meta($post->ID, '_wp_page_template', true);
+			$template      = ! empty($page_template) ? $page_template : '';
+		}
+		?>
         <p><strong><?php esc_html_e('Template', 'event_espresso') ?></strong></p>
         <label class="screen-reader-text" for="page_template">
             <?php esc_html_e('Page Template', 'event_espresso') ?>
@@ -486,457 +486,457 @@ 
             <?php page_template_dropdown($template); ?>
         </select>
         <?php
-    }
-
-
-    /**
-     * if this post is a draft or scheduled post then we provide a preview button for user to click
-     * 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
-     * @return string            The new html string for the permalink area
-     * @deprecated 5.0.0.p
-     * @see PreviewButton::addButton()
-     */
-    public function preview_button_html(string $return, int $id): string
-    {
-        return PreviewButton::addButton($return, $id);
-    }
-
-
-    /**
-     * add our custom post status dropdown on the wp post page for this cpt
-     *
-     * @return void
-     */
-    public function custom_post_stati_dropdown()
-    {
-        $statuses         = $this->_cpt_model_obj->get_custom_post_statuses();
-        $cur_status_label = array_key_exists($this->_cpt_model_obj->status(), $statuses)
-            ? $statuses[ $this->_cpt_model_obj->status() ]
-            : '';
-        $template_args    = [
-            'cur_status'            => $this->_cpt_model_obj->status(),
-            'statuses'              => $statuses,
-            'cur_status_label'      => $cur_status_label,
-            'localized_status_save' => sprintf(esc_html__('Save %s', 'event_espresso'), $cur_status_label),
-        ];
-        // we'll add a trash post status (WP doesn't add one for some reason)
-        if ($this->_cpt_model_obj->status() === 'trash') {
-            $template_args['cur_status_label'] = esc_html__('Trashed', 'event_espresso');
-            $statuses['trash']                 = esc_html__('Trashed', 'event_espresso');
-            $template_args['statuses']         = $statuses;
-        }
-
-        $template = EE_ADMIN_TEMPLATE . 'status_dropdown.template.php';
-        EEH_Template::display_template($template, $template_args);
-    }
-
-
-    public function setup_autosave_hooks()
-    {
-        $this->_set_autosave_containers();
-        $this->_load_autosave_scripts_styles();
-    }
-
-
-    /**
-     * This is run on all WordPress autosaves AFTER the autosave is complete and sends along a post object (available
-     * in request data) containing: post_ID of the saved post autosavenonce for the saved post We'll do the check
-     * for the nonce in here, but then this method looks for two things:
-     * 1. Execute a method (if exists) matching 'ee_autosave_' and appended with the given route. OR
-     * 2. do_actions() for global or class specific actions that have been registered (for plugins/addons not in an
-     * EE_Admin_Page class. PLEASE NOTE: Data will be returned using the _return_json() object and so the
-     * $_template_args property should be used to hold the $data array.  We're expecting the following things set in
-     * template args.
-     *    1. $template_args['error'] = IF there is an error you can add the message in here.
-     *    2. $template_args['data']['items'] = an array of items that are setup in key index pairs of 'where_values_go'
-     *    => 'values_to_add'.  In other words, for the datetime metabox we'll have something like
-     *    $this->_template_args['data']['items'] = array(
-     *        'event-datetime-ids' => '1,2,3';
-     *    );
-     *    Keep in mind the following things:
-     *    - "where" index is for the input with the id as that string.
-     *    - "what" index is what will be used for the value of that input.
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    public function do_extra_autosave_stuff()
-    {
-        // next let's check for the autosave nonce (we'll use _verify_nonce )
-        $nonce = $this->request->getRequestParam('autosavenonce');
-        $this->_verify_nonce($nonce, 'autosave');
-        // make sure we define doing autosave (cause WP isn't triggering this we want to make sure we define it)
-        if (! defined('DOING_AUTOSAVE')) {
-            define('DOING_AUTOSAVE', true);
-        }
-        // if we made it here then the nonce checked out.  Let's run our methods and actions
-        $autosave = "_ee_autosave_$this->_current_view";
-        if (method_exists($this, $autosave)) {
-            $this->$autosave();
-        } else {
-            $this->_template_args['success'] = true;
-        }
-        do_action('AHEE__EE_Admin_Page_CPT__do_extra_autosave_stuff__global_after', $this);
-        do_action('AHEE__EE_Admin_Page_CPT__do_extra_autosave_stuff__after_' . get_class($this), $this);
-        // now let's return json
-        $this->_return_json();
-    }
-
-
-    /**
-     * This takes care of setting up default routes and pages that utilize the core WP admin pages.
-     * Child classes can override the defaults (in cases for adding metaboxes etc.)
-     * but take care that you include the defaults here otherwise your core WP admin pages for the cpt won't work!
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _extend_page_config_for_cpt()
-    {
-        // before doing anything we need to make sure this runs ONLY when the loaded page matches the set page_slug
-        if ($this->raw_req_page !== $this->page_slug) {
-            return;
-        }
-        // set page routes and page config but ONLY if we're not viewing a custom setup cpt route as defined in _cpt_routes
-        if (! empty($this->_cpt_object)) {
-            $this->_page_routes = array_merge(
-                [
-                    'create_new' => [$this, '_create_new_cpt_item'],
-                    'edit'       => [$this, '_edit_cpt_item'],
-                ],
-                $this->_page_routes
-            );
-            $this->_page_config = array_merge(
-                [
-                    'create_new' => [
-                        'nav'           => [
-                            'label' => $this->_cpt_object->labels->add_new_item,
-                            'order' => 5,
-                        ],
-                        'require_nonce' => false,
-                    ],
-                    'edit'       => [
-                        'nav'           => [
-                            'label'      => $this->_cpt_object->labels->edit_item,
-                            'order'      => 5,
-                            'persistent' => false,
-                            'url'        => '',
-                        ],
-                        'require_nonce' => false,
-                    ],
-                ],
-                $this->_page_config
-            );
-        }
-        // load the next section only if this is a matching cpt route as set in the cpt routes array.
-        if (! isset($this->_cpt_routes[ $this->_req_action ])) {
-            return;
-        }
-        $this->_cpt_route = true;
-        // $this->_cpt_route = isset($this->_cpt_routes[ $this->_req_action ]);
-        // add_action('FHEE__EE_Admin_Page___load_page_dependencies__after_load', array( $this, 'modify_current_screen') );
-        if (empty($this->_cpt_object)) {
-            $msg = sprintf(
-                esc_html__(
-                    'This page has been set as being related to a registered custom post type, however, the custom post type object could not be retrieved. There are two possible reasons for this:  1. The "%s" does not match a registered post type. or 2. The custom post type is not registered for the "%s" action as indexed in the "$_cpt_routes" property on this class (%s).',
-                    'event_espresso'
-                ),
-                $this->page_slug,
-                $this->_req_action,
-                get_class($this)
-            );
-            throw new EE_Error($msg);
-        }
-        $this->_set_model_object($this->request->getRequestParam('post', 0, DataType::INT));
-    }
-
-
-    /**
-     * Sets the _cpt_model_object property using what has been set for the _cpt_model_name and a given id.
-     *
-     * @param int    $id       The id to retrieve the model object for. If empty we set a default object.
-     * @param bool   $ignore_route_check
-     * @param string $req_type whether the current route is for inserting, updating, or deleting the CPT
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _set_model_object(int $id = 0, bool $ignore_route_check = false, string $req_type = '')
-    {
-        $model = null;
-        if (
-            empty($this->_cpt_model_names)
-            || (
-                ! $ignore_route_check
-                && ! isset($this->_cpt_routes[ $this->_req_action ])
-            )
-            || (
-                $this->_cpt_model_obj instanceof EE_CPT_Base
-                && $this->_cpt_model_obj->ID() === $id
-            )
-        ) {
-            // get out cuz we either don't have a model name OR the object has already been set and it has the same id as what has been sent.
-            return;
-        }
-        // if ignore_route_check is true, then get the model name via CustomPostTypeDefinitions
-        if ($ignore_route_check) {
-            $post_type = get_post_type($id);
-            /** @var EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions $custom_post_types */
-            $custom_post_types = $this->loader->getShared(
-                'EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions'
-            );
-            $model_names       = $custom_post_types->getCustomPostTypeModelNames($post_type);
-            if (isset($model_names[ $post_type ])) {
-                $model = EE_Registry::instance()->load_model($model_names[ $post_type ]);
-            }
-        } else {
-            $model = EE_Registry::instance()->load_model($this->_cpt_model_names[ $this->_req_action ]);
-        }
-        if ($model instanceof EEM_Base) {
-            $this->_cpt_model_obj = ! empty($id) ? $model->get_one_by_ID($id) : $model->create_default_object();
-        }
-        do_action(
-            'AHEE__EE_Admin_Page_CPT__set_model_object__after_set_object',
-            $this->_cpt_model_obj,
-            $req_type
-        );
-    }
-
-
-    /**
-     * admin_init_global
-     * This runs all the code that we want executed within the WP admin_init hook.
-     * This method executes for ALL EE Admin pages.
-     *
-     * @return void
-     */
-    public function admin_init_global()
-    {
-        $post_ID = $this->request->getRequestParam('post', 0, DataType::INT);
-        // its possible this is a new save so let's catch that instead
-        $post_ID        = $this->request->getRequestParam('post_ID', $post_ID, DataType::INT);
-        $post           = get_post($post_ID);
-        $post_type      = $post instanceof WP_Post ? $post->post_type : false;
-        $current_route  = $this->request->getRequestParam('current_route', 'shouldneverwork');
-        $route_to_check = $post_type && isset($this->_cpt_routes[ $current_route ])
-            ? $this->_cpt_routes[ $current_route ]
-            : '';
-        add_filter('get_delete_post_link', [$this, 'modify_delete_post_link'], 10, 2);
-        add_filter('get_edit_post_link', [$this, 'modify_edit_post_link'], 10, 2);
-        if ($post_type === $route_to_check) {
-            add_filter('redirect_post_location', [$this, 'cpt_post_location_redirect'], 10, 2);
-        }
-        // now let's filter redirect if we're on a revision page and the revision is for an event CPT.
-        $revision = $this->request->getRequestParam('revision');
-        if (! empty($revision)) {
-            $action = $this->request->getRequestParam('action');
-            // doing a restore?
-            if (! empty($action) && $action === 'restore') {
-                // get post for revision
-                $rev_post   = get_post($revision);
-                $rev_parent = get_post($rev_post->post_parent);
-                // only do our redirect filter AND our restore revision action if the post_type for the parent is one of our cpts.
-                if ($rev_parent && $rev_parent->post_type === $this->page_slug) {
-                    add_filter('wp_redirect', [$this, 'revision_redirect']);
-                    // restores of revisions
-                    add_action('wp_restore_post_revision', [$this, 'restore_revision'], 10, 2);
-                }
-            }
-        }
-        // NOTE we ONLY want to run these hooks if we're on the right class for the given post type.  Otherwise we could see some really freaky things happen!
-        if ($post_type && $post_type === $route_to_check) {
-            // $post_id, $post
-            add_action('save_post', [$this, 'insert_update'], 10, 3);
-            // $post_id
-            add_action('trashed_post', [$this, 'before_trash_cpt_item']);
-            add_action('trashed_post', [$this, 'dont_permanently_delete_ee_cpts']);
-            add_action('untrashed_post', [$this, 'before_restore_cpt_item']);
-            add_action('after_delete_post', [$this, 'before_delete_cpt_item']);
-        }
-    }
-
-
-    /**
-     * Callback for the WordPress trashed_post hook.
-     * Execute some basic checks before calling the trash_cpt_item declared in the child class.
-     *
-     * @param int $post_id
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function before_trash_cpt_item(int $post_id)
-    {
-        $this->_set_model_object($post_id, true, 'trash');
-        // if our cpt object isn't existent then get out immediately.
-        if (! $this->_cpt_model_obj instanceof EE_CPT_Base || $this->_cpt_model_obj->ID() !== $post_id) {
-            return;
-        }
-        $this->trash_cpt_item($post_id);
-    }
-
-
-    /**
-     * Callback for the WordPress untrashed_post hook.
-     * Execute some basic checks before calling the restore_cpt_method in the child class.
-     *
-     * @param $post_id
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function before_restore_cpt_item($post_id)
-    {
-        $this->_set_model_object($post_id, true, 'restore');
-        // if our cpt object isn't existent then get out immediately.
-        if (! $this->_cpt_model_obj instanceof EE_CPT_Base || $this->_cpt_model_obj->ID() !== $post_id) {
-            return;
-        }
-        $this->restore_cpt_item($post_id);
-    }
-
-
-    /**
-     * Callback for the WordPress after_delete_post hook.
-     * Execute some basic checks before calling the delete_cpt_item method in the child class.
-     *
-     * @param $post_id
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function before_delete_cpt_item($post_id)
-    {
-        $this->_set_model_object($post_id, true, 'delete');
-        // if our cpt object isn't existent then get out immediately.
-        if (! $this->_cpt_model_obj instanceof EE_CPT_Base || $this->_cpt_model_obj->ID() !== $post_id) {
-            return;
-        }
-        $this->delete_cpt_item($post_id);
-    }
-
-
-    /**
-     * This simply verifies if the cpt_model_object is instantiated for the given page and throws an error message
-     * accordingly.
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function verify_cpt_object()
-    {
-        $label = ! empty($this->_cpt_object) ? $this->_cpt_object->labels->singular_name : $this->page_label;
-        // verify event object
-        if (! $this->_cpt_model_obj instanceof EE_CPT_Base) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'Something has gone wrong with the page load because we are unable to set up the object for the %1$s.  This usually happens when the given id for the page route is NOT for the correct custom post type for this page',
-                        'event_espresso'
-                    ),
-                    $label
-                )
-            );
-        }
-        // if auto-draft then throw an error
-        if ($this->_cpt_model_obj->get('status') === 'auto-draft') {
-            EE_Error::overwrite_errors();
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'This %1$s was saved without a title, description, or excerpt which means that none of the extra details you added were saved properly.  All autodrafts will show up in the "draft" view of your event list table.  You can delete them from there. Please click the "Add %1$s" button to refresh and restart.',
-                        'event_espresso'
-                    ),
-                    $label
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-    }
-
-
-    /**
-     * admin_footer_scripts_global
-     * Anything triggered by the 'admin_print_footer_scripts' WP hook should be put in here. This particular method
-     * will apply on ALL EE_Admin pages.
-     *
-     * @return void
-     */
-    public function admin_footer_scripts_global()
-    {
-        $this->_add_admin_page_ajax_loading_img();
-        $this->_add_admin_page_overlay();
-    }
-
-
-    /**
-     * add in any global scripts for cpt routes
-     *
-     * @return void
-     */
-    public function load_global_scripts_styles()
-    {
-        parent::load_global_scripts_styles();
-        if ($this->_cpt_model_obj instanceof EE_CPT_Base) {
-            // setup custom post status object for localize script but only if we've got a cpt object
-            $statuses = $this->_cpt_model_obj->get_custom_post_statuses();
-            if (! empty($statuses)) {
-                // get ALL statuses!
-                $statuses = $this->_cpt_model_obj->get_all_post_statuses();
-                // setup object
-                $ee_cpt_statuses = [];
-                foreach ($statuses as $status => $label) {
-                    $ee_cpt_statuses[ $status ] = [
-                        'label'      => $label,
-                        'save_label' => sprintf(
-                            wp_strip_all_tags(__('Save as %s', 'event_espresso')),
-                            $label
-                        ),
-                    ];
-                }
-                wp_localize_script('ee_admin_js', 'eeCPTstatuses', $ee_cpt_statuses);
-            }
-        }
-    }
-
-
-    /**
-     * This is a wrapper for the insert/update routes for cpt items so we can add things that are common to ALL
-     * insert/updates
-     *
-     * @param int     $post_id ID of post being updated
-     * @param WP_Post $post    Post object from WP
-     * @param bool    $update  Whether this is an update or a new save.
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function insert_update(int $post_id, WP_Post $post, bool $update)
-    {
-        // make sure that if this is a revision OR trash action that we don't do any updates!
-        $action = $this->request->getRequestParam('action');
-        if ($action === 'restore' || $action === 'trash') {
-            return;
-        }
-        $this->_set_model_object($post_id, true, 'insert_update');
-        // if our cpt object is not instantiated and its NOT the same post_id as what is triggering this callback, then exit.
-        if (
-            $update
-            && (
-                ! $this->_cpt_model_obj instanceof EE_CPT_Base
-                || $this->_cpt_model_obj->ID() !== $post_id
-            )
-        ) {
-            return;
-        }
-        // check for autosave and update our req_data property accordingly.
-        /*if ( defined('DOING_AUTOSAVE') && DOING_AUTOSAVE && isset( $this->_req_data['ee_autosave_data'] ) ) {
+	}
+
+
+	/**
+	 * if this post is a draft or scheduled post then we provide a preview button for user to click
+	 * 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
+	 * @return string            The new html string for the permalink area
+	 * @deprecated 5.0.0.p
+	 * @see PreviewButton::addButton()
+	 */
+	public function preview_button_html(string $return, int $id): string
+	{
+		return PreviewButton::addButton($return, $id);
+	}
+
+
+	/**
+	 * add our custom post status dropdown on the wp post page for this cpt
+	 *
+	 * @return void
+	 */
+	public function custom_post_stati_dropdown()
+	{
+		$statuses         = $this->_cpt_model_obj->get_custom_post_statuses();
+		$cur_status_label = array_key_exists($this->_cpt_model_obj->status(), $statuses)
+			? $statuses[ $this->_cpt_model_obj->status() ]
+			: '';
+		$template_args    = [
+			'cur_status'            => $this->_cpt_model_obj->status(),
+			'statuses'              => $statuses,
+			'cur_status_label'      => $cur_status_label,
+			'localized_status_save' => sprintf(esc_html__('Save %s', 'event_espresso'), $cur_status_label),
+		];
+		// we'll add a trash post status (WP doesn't add one for some reason)
+		if ($this->_cpt_model_obj->status() === 'trash') {
+			$template_args['cur_status_label'] = esc_html__('Trashed', 'event_espresso');
+			$statuses['trash']                 = esc_html__('Trashed', 'event_espresso');
+			$template_args['statuses']         = $statuses;
+		}
+
+		$template = EE_ADMIN_TEMPLATE . 'status_dropdown.template.php';
+		EEH_Template::display_template($template, $template_args);
+	}
+
+
+	public function setup_autosave_hooks()
+	{
+		$this->_set_autosave_containers();
+		$this->_load_autosave_scripts_styles();
+	}
+
+
+	/**
+	 * This is run on all WordPress autosaves AFTER the autosave is complete and sends along a post object (available
+	 * in request data) containing: post_ID of the saved post autosavenonce for the saved post We'll do the check
+	 * for the nonce in here, but then this method looks for two things:
+	 * 1. Execute a method (if exists) matching 'ee_autosave_' and appended with the given route. OR
+	 * 2. do_actions() for global or class specific actions that have been registered (for plugins/addons not in an
+	 * EE_Admin_Page class. PLEASE NOTE: Data will be returned using the _return_json() object and so the
+	 * $_template_args property should be used to hold the $data array.  We're expecting the following things set in
+	 * template args.
+	 *    1. $template_args['error'] = IF there is an error you can add the message in here.
+	 *    2. $template_args['data']['items'] = an array of items that are setup in key index pairs of 'where_values_go'
+	 *    => 'values_to_add'.  In other words, for the datetime metabox we'll have something like
+	 *    $this->_template_args['data']['items'] = array(
+	 *        'event-datetime-ids' => '1,2,3';
+	 *    );
+	 *    Keep in mind the following things:
+	 *    - "where" index is for the input with the id as that string.
+	 *    - "what" index is what will be used for the value of that input.
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function do_extra_autosave_stuff()
+	{
+		// next let's check for the autosave nonce (we'll use _verify_nonce )
+		$nonce = $this->request->getRequestParam('autosavenonce');
+		$this->_verify_nonce($nonce, 'autosave');
+		// make sure we define doing autosave (cause WP isn't triggering this we want to make sure we define it)
+		if (! defined('DOING_AUTOSAVE')) {
+			define('DOING_AUTOSAVE', true);
+		}
+		// if we made it here then the nonce checked out.  Let's run our methods and actions
+		$autosave = "_ee_autosave_$this->_current_view";
+		if (method_exists($this, $autosave)) {
+			$this->$autosave();
+		} else {
+			$this->_template_args['success'] = true;
+		}
+		do_action('AHEE__EE_Admin_Page_CPT__do_extra_autosave_stuff__global_after', $this);
+		do_action('AHEE__EE_Admin_Page_CPT__do_extra_autosave_stuff__after_' . get_class($this), $this);
+		// now let's return json
+		$this->_return_json();
+	}
+
+
+	/**
+	 * This takes care of setting up default routes and pages that utilize the core WP admin pages.
+	 * Child classes can override the defaults (in cases for adding metaboxes etc.)
+	 * but take care that you include the defaults here otherwise your core WP admin pages for the cpt won't work!
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _extend_page_config_for_cpt()
+	{
+		// before doing anything we need to make sure this runs ONLY when the loaded page matches the set page_slug
+		if ($this->raw_req_page !== $this->page_slug) {
+			return;
+		}
+		// set page routes and page config but ONLY if we're not viewing a custom setup cpt route as defined in _cpt_routes
+		if (! empty($this->_cpt_object)) {
+			$this->_page_routes = array_merge(
+				[
+					'create_new' => [$this, '_create_new_cpt_item'],
+					'edit'       => [$this, '_edit_cpt_item'],
+				],
+				$this->_page_routes
+			);
+			$this->_page_config = array_merge(
+				[
+					'create_new' => [
+						'nav'           => [
+							'label' => $this->_cpt_object->labels->add_new_item,
+							'order' => 5,
+						],
+						'require_nonce' => false,
+					],
+					'edit'       => [
+						'nav'           => [
+							'label'      => $this->_cpt_object->labels->edit_item,
+							'order'      => 5,
+							'persistent' => false,
+							'url'        => '',
+						],
+						'require_nonce' => false,
+					],
+				],
+				$this->_page_config
+			);
+		}
+		// load the next section only if this is a matching cpt route as set in the cpt routes array.
+		if (! isset($this->_cpt_routes[ $this->_req_action ])) {
+			return;
+		}
+		$this->_cpt_route = true;
+		// $this->_cpt_route = isset($this->_cpt_routes[ $this->_req_action ]);
+		// add_action('FHEE__EE_Admin_Page___load_page_dependencies__after_load', array( $this, 'modify_current_screen') );
+		if (empty($this->_cpt_object)) {
+			$msg = sprintf(
+				esc_html__(
+					'This page has been set as being related to a registered custom post type, however, the custom post type object could not be retrieved. There are two possible reasons for this:  1. The "%s" does not match a registered post type. or 2. The custom post type is not registered for the "%s" action as indexed in the "$_cpt_routes" property on this class (%s).',
+					'event_espresso'
+				),
+				$this->page_slug,
+				$this->_req_action,
+				get_class($this)
+			);
+			throw new EE_Error($msg);
+		}
+		$this->_set_model_object($this->request->getRequestParam('post', 0, DataType::INT));
+	}
+
+
+	/**
+	 * Sets the _cpt_model_object property using what has been set for the _cpt_model_name and a given id.
+	 *
+	 * @param int    $id       The id to retrieve the model object for. If empty we set a default object.
+	 * @param bool   $ignore_route_check
+	 * @param string $req_type whether the current route is for inserting, updating, or deleting the CPT
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _set_model_object(int $id = 0, bool $ignore_route_check = false, string $req_type = '')
+	{
+		$model = null;
+		if (
+			empty($this->_cpt_model_names)
+			|| (
+				! $ignore_route_check
+				&& ! isset($this->_cpt_routes[ $this->_req_action ])
+			)
+			|| (
+				$this->_cpt_model_obj instanceof EE_CPT_Base
+				&& $this->_cpt_model_obj->ID() === $id
+			)
+		) {
+			// get out cuz we either don't have a model name OR the object has already been set and it has the same id as what has been sent.
+			return;
+		}
+		// if ignore_route_check is true, then get the model name via CustomPostTypeDefinitions
+		if ($ignore_route_check) {
+			$post_type = get_post_type($id);
+			/** @var EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions $custom_post_types */
+			$custom_post_types = $this->loader->getShared(
+				'EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions'
+			);
+			$model_names       = $custom_post_types->getCustomPostTypeModelNames($post_type);
+			if (isset($model_names[ $post_type ])) {
+				$model = EE_Registry::instance()->load_model($model_names[ $post_type ]);
+			}
+		} else {
+			$model = EE_Registry::instance()->load_model($this->_cpt_model_names[ $this->_req_action ]);
+		}
+		if ($model instanceof EEM_Base) {
+			$this->_cpt_model_obj = ! empty($id) ? $model->get_one_by_ID($id) : $model->create_default_object();
+		}
+		do_action(
+			'AHEE__EE_Admin_Page_CPT__set_model_object__after_set_object',
+			$this->_cpt_model_obj,
+			$req_type
+		);
+	}
+
+
+	/**
+	 * admin_init_global
+	 * This runs all the code that we want executed within the WP admin_init hook.
+	 * This method executes for ALL EE Admin pages.
+	 *
+	 * @return void
+	 */
+	public function admin_init_global()
+	{
+		$post_ID = $this->request->getRequestParam('post', 0, DataType::INT);
+		// its possible this is a new save so let's catch that instead
+		$post_ID        = $this->request->getRequestParam('post_ID', $post_ID, DataType::INT);
+		$post           = get_post($post_ID);
+		$post_type      = $post instanceof WP_Post ? $post->post_type : false;
+		$current_route  = $this->request->getRequestParam('current_route', 'shouldneverwork');
+		$route_to_check = $post_type && isset($this->_cpt_routes[ $current_route ])
+			? $this->_cpt_routes[ $current_route ]
+			: '';
+		add_filter('get_delete_post_link', [$this, 'modify_delete_post_link'], 10, 2);
+		add_filter('get_edit_post_link', [$this, 'modify_edit_post_link'], 10, 2);
+		if ($post_type === $route_to_check) {
+			add_filter('redirect_post_location', [$this, 'cpt_post_location_redirect'], 10, 2);
+		}
+		// now let's filter redirect if we're on a revision page and the revision is for an event CPT.
+		$revision = $this->request->getRequestParam('revision');
+		if (! empty($revision)) {
+			$action = $this->request->getRequestParam('action');
+			// doing a restore?
+			if (! empty($action) && $action === 'restore') {
+				// get post for revision
+				$rev_post   = get_post($revision);
+				$rev_parent = get_post($rev_post->post_parent);
+				// only do our redirect filter AND our restore revision action if the post_type for the parent is one of our cpts.
+				if ($rev_parent && $rev_parent->post_type === $this->page_slug) {
+					add_filter('wp_redirect', [$this, 'revision_redirect']);
+					// restores of revisions
+					add_action('wp_restore_post_revision', [$this, 'restore_revision'], 10, 2);
+				}
+			}
+		}
+		// NOTE we ONLY want to run these hooks if we're on the right class for the given post type.  Otherwise we could see some really freaky things happen!
+		if ($post_type && $post_type === $route_to_check) {
+			// $post_id, $post
+			add_action('save_post', [$this, 'insert_update'], 10, 3);
+			// $post_id
+			add_action('trashed_post', [$this, 'before_trash_cpt_item']);
+			add_action('trashed_post', [$this, 'dont_permanently_delete_ee_cpts']);
+			add_action('untrashed_post', [$this, 'before_restore_cpt_item']);
+			add_action('after_delete_post', [$this, 'before_delete_cpt_item']);
+		}
+	}
+
+
+	/**
+	 * Callback for the WordPress trashed_post hook.
+	 * Execute some basic checks before calling the trash_cpt_item declared in the child class.
+	 *
+	 * @param int $post_id
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function before_trash_cpt_item(int $post_id)
+	{
+		$this->_set_model_object($post_id, true, 'trash');
+		// if our cpt object isn't existent then get out immediately.
+		if (! $this->_cpt_model_obj instanceof EE_CPT_Base || $this->_cpt_model_obj->ID() !== $post_id) {
+			return;
+		}
+		$this->trash_cpt_item($post_id);
+	}
+
+
+	/**
+	 * Callback for the WordPress untrashed_post hook.
+	 * Execute some basic checks before calling the restore_cpt_method in the child class.
+	 *
+	 * @param $post_id
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function before_restore_cpt_item($post_id)
+	{
+		$this->_set_model_object($post_id, true, 'restore');
+		// if our cpt object isn't existent then get out immediately.
+		if (! $this->_cpt_model_obj instanceof EE_CPT_Base || $this->_cpt_model_obj->ID() !== $post_id) {
+			return;
+		}
+		$this->restore_cpt_item($post_id);
+	}
+
+
+	/**
+	 * Callback for the WordPress after_delete_post hook.
+	 * Execute some basic checks before calling the delete_cpt_item method in the child class.
+	 *
+	 * @param $post_id
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function before_delete_cpt_item($post_id)
+	{
+		$this->_set_model_object($post_id, true, 'delete');
+		// if our cpt object isn't existent then get out immediately.
+		if (! $this->_cpt_model_obj instanceof EE_CPT_Base || $this->_cpt_model_obj->ID() !== $post_id) {
+			return;
+		}
+		$this->delete_cpt_item($post_id);
+	}
+
+
+	/**
+	 * This simply verifies if the cpt_model_object is instantiated for the given page and throws an error message
+	 * accordingly.
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function verify_cpt_object()
+	{
+		$label = ! empty($this->_cpt_object) ? $this->_cpt_object->labels->singular_name : $this->page_label;
+		// verify event object
+		if (! $this->_cpt_model_obj instanceof EE_CPT_Base) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'Something has gone wrong with the page load because we are unable to set up the object for the %1$s.  This usually happens when the given id for the page route is NOT for the correct custom post type for this page',
+						'event_espresso'
+					),
+					$label
+				)
+			);
+		}
+		// if auto-draft then throw an error
+		if ($this->_cpt_model_obj->get('status') === 'auto-draft') {
+			EE_Error::overwrite_errors();
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'This %1$s was saved without a title, description, or excerpt which means that none of the extra details you added were saved properly.  All autodrafts will show up in the "draft" view of your event list table.  You can delete them from there. Please click the "Add %1$s" button to refresh and restart.',
+						'event_espresso'
+					),
+					$label
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+	}
+
+
+	/**
+	 * admin_footer_scripts_global
+	 * Anything triggered by the 'admin_print_footer_scripts' WP hook should be put in here. This particular method
+	 * will apply on ALL EE_Admin pages.
+	 *
+	 * @return void
+	 */
+	public function admin_footer_scripts_global()
+	{
+		$this->_add_admin_page_ajax_loading_img();
+		$this->_add_admin_page_overlay();
+	}
+
+
+	/**
+	 * add in any global scripts for cpt routes
+	 *
+	 * @return void
+	 */
+	public function load_global_scripts_styles()
+	{
+		parent::load_global_scripts_styles();
+		if ($this->_cpt_model_obj instanceof EE_CPT_Base) {
+			// setup custom post status object for localize script but only if we've got a cpt object
+			$statuses = $this->_cpt_model_obj->get_custom_post_statuses();
+			if (! empty($statuses)) {
+				// get ALL statuses!
+				$statuses = $this->_cpt_model_obj->get_all_post_statuses();
+				// setup object
+				$ee_cpt_statuses = [];
+				foreach ($statuses as $status => $label) {
+					$ee_cpt_statuses[ $status ] = [
+						'label'      => $label,
+						'save_label' => sprintf(
+							wp_strip_all_tags(__('Save as %s', 'event_espresso')),
+							$label
+						),
+					];
+				}
+				wp_localize_script('ee_admin_js', 'eeCPTstatuses', $ee_cpt_statuses);
+			}
+		}
+	}
+
+
+	/**
+	 * This is a wrapper for the insert/update routes for cpt items so we can add things that are common to ALL
+	 * insert/updates
+	 *
+	 * @param int     $post_id ID of post being updated
+	 * @param WP_Post $post    Post object from WP
+	 * @param bool    $update  Whether this is an update or a new save.
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function insert_update(int $post_id, WP_Post $post, bool $update)
+	{
+		// make sure that if this is a revision OR trash action that we don't do any updates!
+		$action = $this->request->getRequestParam('action');
+		if ($action === 'restore' || $action === 'trash') {
+			return;
+		}
+		$this->_set_model_object($post_id, true, 'insert_update');
+		// if our cpt object is not instantiated and its NOT the same post_id as what is triggering this callback, then exit.
+		if (
+			$update
+			&& (
+				! $this->_cpt_model_obj instanceof EE_CPT_Base
+				|| $this->_cpt_model_obj->ID() !== $post_id
+			)
+		) {
+			return;
+		}
+		// check for autosave and update our req_data property accordingly.
+		/*if ( defined('DOING_AUTOSAVE') && DOING_AUTOSAVE && isset( $this->_req_data['ee_autosave_data'] ) ) {
             foreach( (array) $this->_req_data['ee_autosave_data'] as $id => $values ) {
 
                 foreach ( (array) $values as $key => $value ) {
@@ -946,549 +946,549 @@ 
 
         }/**/ // TODO reactivate after autosave is implemented in 4.2
 
-        // take care of updating any selected page_template IF this cpt supports it.
-
-        $page_template = $this->request->getRequestParam('page_template');
-        if ($this->_supports_page_templates($post->post_type) && ! empty($page_template)) {
-            // wp version aware.
-            if (RecommendedVersions::compareWordPressVersion('4.7')) {
-                $page_templates = wp_get_theme()->get_page_templates();
-            } else {
-                $post->page_template = $page_template;
-                $page_templates      = wp_get_theme()->get_page_templates($post);
-            }
-            if ($page_template !== 'default' && ! isset($page_templates[ $page_template ])) {
-                EE_Error::add_error(
-                    esc_html__('Invalid Page Template.', 'event_espresso'),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            } else {
-                update_post_meta($post_id, '_wp_page_template', $page_template);
-            }
-        }
-        if (defined('DOING_AUTOSAVE') && DOING_AUTOSAVE) {
-            return;
-        } //TODO we'll remove this after reimplementing autosave in 4.2
-        $this->_insert_update_cpt_item($post_id, $post);
-    }
-
-
-    /**
-     * This hooks into the wp_trash_post() function and removes the `_wp_trash_meta_status` and `_wp_trash_meta_time`
-     * post meta IF the trashed post is one of our CPT's - note this method should only be called with our cpt routes
-     * so we don't have to check for our CPT.
-     *
-     * @param int $post_id ID of the post
-     * @return void
-     */
-    public function dont_permanently_delete_ee_cpts(int $post_id)
-    {
-        // only do this if we're actually processing one of our CPTs
-        // if our cpt object isn't existent then get out immediately.
-        if (! $this->_cpt_model_obj instanceof EE_CPT_Base) {
-            return;
-        }
-        delete_post_meta($post_id, '_wp_trash_meta_status');
-        delete_post_meta($post_id, '_wp_trash_meta_time');
-        // our cpts may have comments so let's take care of that too
-        delete_post_meta($post_id, '_wp_trash_meta_comments_status');
-    }
-
-
-    /**
-     * This is a wrapper for the restore_cpt_revision route for cpt items so we can make sure that when a revision is
-     * triggered that we restore related items.  In order to work cpt classes MUST have a restore_cpt_revision method
-     * in them. We also have our OWN action in here so addons can hook into the restore process easily.
-     *
-     * @param int $post_id     ID of cpt item
-     * @param int $revision_id ID of revision being restored
-     * @return void
-     */
-    public function restore_revision(int $post_id, int $revision_id)
-    {
-        $this->_restore_cpt_item($post_id, $revision_id);
-        // global action
-        do_action('AHEE_EE_Admin_Page_CPT__restore_revision', $post_id, $revision_id);
-        // class specific action so you can limit hooking into a specific page.
-        do_action('AHEE_EE_Admin_Page_CPT_' . get_class($this) . '__restore_revision', $post_id, $revision_id);
-    }
-
-
-    /**
-     * @param int $post_id     ID of cpt item
-     * @param int $revision_id ID of revision for item
-     * @return void
-     * @see restore_revision() for details
-     */
-    abstract protected function _restore_cpt_item(int $post_id, int $revision_id);
-
-
-    /**
-     * Execution of this method is added to the end of the load_page_dependencies method in the parent
-     * so that we can fix a bug where default core metaboxes were not being called in the sidebar.
-     * To fix we have to reset the current_screen using the page_slug
-     * (which is identical - or should be - to our registered_post_type id.)
-     * Also, since the core WP file loads the admin_header.php for WP
-     * (and there are a bunch of other things edit-form-advanced.php loads that need to happen really early)
-     * we need to load it NOW, hence our _route_admin_request in here. (Otherwise screen options won't be set).
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function modify_current_screen()
-    {
-        // ONLY do this if the current page_route IS a cpt route
-        if (! $this->_cpt_route) {
-            return;
-        }
-        // routing things REALLY early b/c this is a cpt admin page
-        set_current_screen($this->_cpt_routes[ $this->_req_action ]);
-        $this->_current_screen       = get_current_screen();
-        $this->_current_screen->base = 'event-espresso';
-        $this->_add_help_tabs(); // we make sure we add any help tabs back in!
-        /*try {
+		// take care of updating any selected page_template IF this cpt supports it.
+
+		$page_template = $this->request->getRequestParam('page_template');
+		if ($this->_supports_page_templates($post->post_type) && ! empty($page_template)) {
+			// wp version aware.
+			if (RecommendedVersions::compareWordPressVersion('4.7')) {
+				$page_templates = wp_get_theme()->get_page_templates();
+			} else {
+				$post->page_template = $page_template;
+				$page_templates      = wp_get_theme()->get_page_templates($post);
+			}
+			if ($page_template !== 'default' && ! isset($page_templates[ $page_template ])) {
+				EE_Error::add_error(
+					esc_html__('Invalid Page Template.', 'event_espresso'),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			} else {
+				update_post_meta($post_id, '_wp_page_template', $page_template);
+			}
+		}
+		if (defined('DOING_AUTOSAVE') && DOING_AUTOSAVE) {
+			return;
+		} //TODO we'll remove this after reimplementing autosave in 4.2
+		$this->_insert_update_cpt_item($post_id, $post);
+	}
+
+
+	/**
+	 * This hooks into the wp_trash_post() function and removes the `_wp_trash_meta_status` and `_wp_trash_meta_time`
+	 * post meta IF the trashed post is one of our CPT's - note this method should only be called with our cpt routes
+	 * so we don't have to check for our CPT.
+	 *
+	 * @param int $post_id ID of the post
+	 * @return void
+	 */
+	public function dont_permanently_delete_ee_cpts(int $post_id)
+	{
+		// only do this if we're actually processing one of our CPTs
+		// if our cpt object isn't existent then get out immediately.
+		if (! $this->_cpt_model_obj instanceof EE_CPT_Base) {
+			return;
+		}
+		delete_post_meta($post_id, '_wp_trash_meta_status');
+		delete_post_meta($post_id, '_wp_trash_meta_time');
+		// our cpts may have comments so let's take care of that too
+		delete_post_meta($post_id, '_wp_trash_meta_comments_status');
+	}
+
+
+	/**
+	 * This is a wrapper for the restore_cpt_revision route for cpt items so we can make sure that when a revision is
+	 * triggered that we restore related items.  In order to work cpt classes MUST have a restore_cpt_revision method
+	 * in them. We also have our OWN action in here so addons can hook into the restore process easily.
+	 *
+	 * @param int $post_id     ID of cpt item
+	 * @param int $revision_id ID of revision being restored
+	 * @return void
+	 */
+	public function restore_revision(int $post_id, int $revision_id)
+	{
+		$this->_restore_cpt_item($post_id, $revision_id);
+		// global action
+		do_action('AHEE_EE_Admin_Page_CPT__restore_revision', $post_id, $revision_id);
+		// class specific action so you can limit hooking into a specific page.
+		do_action('AHEE_EE_Admin_Page_CPT_' . get_class($this) . '__restore_revision', $post_id, $revision_id);
+	}
+
+
+	/**
+	 * @param int $post_id     ID of cpt item
+	 * @param int $revision_id ID of revision for item
+	 * @return void
+	 * @see restore_revision() for details
+	 */
+	abstract protected function _restore_cpt_item(int $post_id, int $revision_id);
+
+
+	/**
+	 * Execution of this method is added to the end of the load_page_dependencies method in the parent
+	 * so that we can fix a bug where default core metaboxes were not being called in the sidebar.
+	 * To fix we have to reset the current_screen using the page_slug
+	 * (which is identical - or should be - to our registered_post_type id.)
+	 * Also, since the core WP file loads the admin_header.php for WP
+	 * (and there are a bunch of other things edit-form-advanced.php loads that need to happen really early)
+	 * we need to load it NOW, hence our _route_admin_request in here. (Otherwise screen options won't be set).
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function modify_current_screen()
+	{
+		// ONLY do this if the current page_route IS a cpt route
+		if (! $this->_cpt_route) {
+			return;
+		}
+		// routing things REALLY early b/c this is a cpt admin page
+		set_current_screen($this->_cpt_routes[ $this->_req_action ]);
+		$this->_current_screen       = get_current_screen();
+		$this->_current_screen->base = 'event-espresso';
+		$this->_add_help_tabs(); // we make sure we add any help tabs back in!
+		/*try {
             $this->_route_admin_request();
         } catch ( EE_Error $e ) {
             $e->get_error();
         }/**/
-    }
-
-
-    /**
-     * This allows child classes to modify the default editor title that appears when people add a new or edit an
-     * existing CPT item.     * This uses the _labels property set by the child class via _define_page_props. Just make
-     * sure you have a key in _labels property that equals 'editor_title' and the value can be whatever you want the
-     * default to be.
-     *
-     * @param string|null $title The new title (or existing if there is no editor_title defined)
-     * @return string|null
-     */
-    public function add_custom_editor_default_title(?string $title): ?string
-    {
-        return $this->_labels['editor_title'][ $this->_cpt_routes[ $this->_req_action ] ] ?? $title;
-    }
-
-
-    /**
-     * hooks into the wp_get_shortlink button and makes sure that the shortlink gets generated
-     *
-     * @param string $shortlink   The already generated shortlink
-     * @param int    $id          Post ID for this item
-     * @return string
-     * @deprecated 5.0.0.p
-     * @see EventShortlinkButton::addButton()
-     */
-    public function add_shortlink_button_to_editor(string $shortlink, int $id): string
-    {
-        return EventShortlinkButton::addButton($shortlink, $id);
-    }
-
-
-    /**
-     * overriding the parent route_admin_request method so we DON'T run the route twice on cpt core page loads (it's
-     * already run in modify_current_screen())
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws Throwable
-     */
-    public function route_admin_request()
-    {
-        if ($this->_cpt_route) {
-            return;
-        }
-        try {
-            $this->_route_admin_request();
-        } catch (EE_Error $e) {
-            $e->get_error();
-        }
-    }
-
-
-    /**
-     * Add a hidden form input to cpt core pages so that we know to do redirects to our routes on saves
-     *
-     * @return void
-     */
-    public function cpt_post_form_hidden_input()
-    {
-        // we're also going to add the route value and the current page so we can direct autosave parsing correctly
-        echo '
+	}
+
+
+	/**
+	 * This allows child classes to modify the default editor title that appears when people add a new or edit an
+	 * existing CPT item.     * This uses the _labels property set by the child class via _define_page_props. Just make
+	 * sure you have a key in _labels property that equals 'editor_title' and the value can be whatever you want the
+	 * default to be.
+	 *
+	 * @param string|null $title The new title (or existing if there is no editor_title defined)
+	 * @return string|null
+	 */
+	public function add_custom_editor_default_title(?string $title): ?string
+	{
+		return $this->_labels['editor_title'][ $this->_cpt_routes[ $this->_req_action ] ] ?? $title;
+	}
+
+
+	/**
+	 * hooks into the wp_get_shortlink button and makes sure that the shortlink gets generated
+	 *
+	 * @param string $shortlink   The already generated shortlink
+	 * @param int    $id          Post ID for this item
+	 * @return string
+	 * @deprecated 5.0.0.p
+	 * @see EventShortlinkButton::addButton()
+	 */
+	public function add_shortlink_button_to_editor(string $shortlink, int $id): string
+	{
+		return EventShortlinkButton::addButton($shortlink, $id);
+	}
+
+
+	/**
+	 * overriding the parent route_admin_request method so we DON'T run the route twice on cpt core page loads (it's
+	 * already run in modify_current_screen())
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws Throwable
+	 */
+	public function route_admin_request()
+	{
+		if ($this->_cpt_route) {
+			return;
+		}
+		try {
+			$this->_route_admin_request();
+		} catch (EE_Error $e) {
+			$e->get_error();
+		}
+	}
+
+
+	/**
+	 * Add a hidden form input to cpt core pages so that we know to do redirects to our routes on saves
+	 *
+	 * @return void
+	 */
+	public function cpt_post_form_hidden_input()
+	{
+		// we're also going to add the route value and the current page so we can direct autosave parsing correctly
+		echo '
         <input type="hidden" name="ee_cpt_item_redirect_url" value="' . esc_url_raw($this->_admin_base_url) . '"/>
         <div id="ee-cpt-hidden-inputs">
             <input type="hidden" id="current_route" name="current_route" value="' . esc_attr($this->_current_view) . '"/>
             <input type="hidden" id="current_page" name="current_page" value="' . esc_attr($this->page_slug) . '"/>
         </div>';
-    }
-
-
-    /**
-     * This allows us to redirect the location of revision restores when they happen so it goes to our CPT routes.
-     *
-     * @param string $location Original location url
-     * @return string           new (or original) url to redirect to.
-     * @throws EE_Error
-     */
-    public function revision_redirect(string $location): string
-    {
-        // get revision
-        $revision = $this->request->getRequestParam('revision');
-        // can't do anything without revision so let's get out if not present
-        if (empty($revision)) {
-            return $location;
-        }
-        // get rev_post_data
-        $rev        = get_post($revision);
-        $admin_url  = $this->_admin_base_url;
-        $query_args = [
-            'action'   => 'edit',
-            'post'     => $rev->post_parent,
-            'revision' => $revision,
-            'message'  => 5,
-        ];
-        $this->_process_notices($query_args, true);
-        return EE_Admin_Page_CPT::add_query_args_and_nonce($query_args, $admin_url);
-    }
-
-
-    /**
-     * Modify the edit post link generated by wp core function so that EE CPTs get setup differently.
-     *
-     * @param string $link    the original generated link
-     * @param int    $id      post id
-     * @return string          the link
-     */
-    public function modify_edit_post_link(string $link, int $id): string
-    {
-        $post = get_post($id);
-        $action = $this->request->getRequestParam('action');
-        if (
-            empty($action)
-            || ! isset($this->_cpt_routes[ $action ])
-            || $post->post_type !== $this->_cpt_routes[ $action ]
-        ) {
-            return $link;
-        }
-        $query_args = [
-            'action' => $this->_cpt_edit_routes[ $post->post_type ] ?? 'edit',
-            'post'   => $id,
-        ];
-        return EE_Admin_Page_CPT::add_query_args_and_nonce($query_args, $this->_admin_base_url);
-    }
-
-
-    /**
-     * Modify the trash link on our cpt edit pages so it has the required query var for triggering redirect properly on
-     * our routes.
-     *
-     * @param string $delete_link  original delete link
-     * @param int    $post_id      id of cpt object
-     * @return string new delete link
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function modify_delete_post_link(string $delete_link, int $post_id): string
-    {
-        $post = get_post($post_id);
-        $action = $this->request->getRequestParam('action');
-        if (
-            ! $post instanceof WP_Post
-            || empty($action)
-            || ! isset($this->_cpt_routes[ $action ])
-            || $post->post_type !== $this->_cpt_routes[ $action ]
-        ) {
-            return $delete_link;
-        }
-        $this->_set_model_object($post->ID, true);
-
-        // returns something like `trash_event` or `trash_attendee` or `trash_venue`
-        $action = 'trash_' . str_replace('ee_', '', strtolower(get_class($this->_cpt_model_obj)));
-
-        return EE_Admin_Page::add_query_args_and_nonce(
-            [
-                'page'   => $this->request->getRequestParam('page'),
-                'action' => $action,
-                $this->_cpt_model_obj->get_model()->get_primary_key_field()->get_name() => $post->ID,
-            ],
-            admin_url()
-        );
-    }
-
-
-    /**
-     * This is the callback for the 'redirect_post_location' filter in wp-admin/post.php
-     * so that we can hijack the default redirect locations for wp custom post types
-     * that WE'RE using and send back to OUR routes.  This should only be hooked in on the right route.
-     *
-     * @param string $location This is the incoming currently set redirect location
-     * @param string $post_id  This is the 'ID' value of the wp_posts table
-     * @return string           the new location to redirect to
-     * @throws EE_Error
-     */
-    public function cpt_post_location_redirect(string $location, string $post_id): string
-    {
-        // we DO have a match so let's setup the url
-        // we have to get the post to determine our route
-        $post       = get_post($post_id);
-        $edit_route = $this->_cpt_edit_routes[ $post->post_type ];
-        // shared query_args
-        $query_args = ['action' => $edit_route, 'post' => $post_id];
-
-        $save = $this->request->getRequestParam('save');
-        $publish = $this->request->getRequestParam('publish');
-        $add_meta = $this->request->getRequestParam('addmeta');
-        $delete_meta = $this->request->getRequestParam('deletemeta');
-        if ($save || $publish) {
-            $status = get_post_status($post_id);
-            if ($publish) {
-                switch ($status) {
-                    case 'pending':
-                        $message = 8;
-                        break;
-                    case 'future':
-                        $message = 9;
-                        break;
-                    default:
-                        $message = 6;
-                }
-            } else {
-                $message = 'draft' === $status ? 10 : 1;
-            }
-        } elseif ($add_meta) {
-            $message = 2;
-        } elseif ($delete_meta) {
-            $message = 3;
-        } elseif ($this->request->getRequestParam('action') === 'post-quickpress-save-cont') {
-            $message = 7;
-        } else {
-            $message = 4;
-        }
-        // change the message if the post type is not viewable on the frontend
-        $this->_cpt_object = get_post_type_object($post->post_type);
-
-        $query_args['message'] = $message === 1 && ! $this->_cpt_object->publicly_queryable ? 4 : $message;
-        $this->_process_notices($query_args, true);
-        return EE_Admin_Page_CPT::add_query_args_and_nonce($query_args, $this->_admin_base_url);
-    }
-
-
-    /**
-     * This method is called to inject nav tabs on core WP cpt pages
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    public function inject_nav_tabs()
-    {
-        echo wp_kses($this->_get_main_nav_tabs(), AllowedTags::getWithFormTags());
-    }
-
-
-    /**
-     * This just sets up the post update messages when an update form is loaded
-     *
-     * @param array $messages the original messages array
-     * @return array           the new messages array
-     */
-    public function post_update_messages(array $messages): array
-    {
-        global $post;
-        $id       = $this->request->getRequestParam('post');
-        $id       = empty($id) && is_object($post) ? $post->ID : null;
-        $revision = $this->request->getRequestParam('revision', 0, 'int');
-
-        $messages[ $post->post_type ] = [
-            0  => '', // Unused. Messages start at index 1.
-            1  => sprintf(
-                esc_html__('%1$s updated. %2$sView %1$s%3$s', 'event_espresso'),
-                $this->_cpt_object->labels->singular_name,
-                '<a href="' . esc_url(get_permalink($id)) . '">',
-                '</a>'
-            ),
-            2  => esc_html__('Custom field updated', 'event_espresso'),
-            3  => esc_html__('Custom field deleted.', 'event_espresso'),
-            4  => sprintf(esc_html__('%1$s updated.', 'event_espresso'), $this->_cpt_object->labels->singular_name),
-            5  => $revision
-                ? sprintf(
-                    esc_html__('%s restored to revision from %s', 'event_espresso'),
-                    $this->_cpt_object->labels->singular_name,
-                    wp_post_revision_title($revision, false)
-                )
-                : false,
-            6  => sprintf(
-                esc_html__('%1$s published. %2$sView %1$s%3$s', 'event_espresso'),
-                $this->_cpt_object->labels->singular_name,
-                '<a href="' . esc_url(get_permalink($id)) . '">',
-                '</a>'
-            ),
-            7  => sprintf(esc_html__('%1$s saved.', 'event_espresso'), $this->_cpt_object->labels->singular_name),
-            8  => sprintf(
-                esc_html__('%1$s submitted. %2$sPreview %1$s%3$s', 'event_espresso'),
-                $this->_cpt_object->labels->singular_name,
-                '<a target="_blank" href="' . esc_url(add_query_arg('preview', 'true', get_permalink($id))) . '">',
-                '</a>'
-            ),
-            9  => sprintf(
-                esc_html__('%1$s scheduled for: %2$s. %3$s">Preview %1$s%3$s', 'event_espresso'),
-                $this->_cpt_object->labels->singular_name,
-                '<strong>' . date_i18n('M j, Y @ G:i', strtotime($post->post_date)) . '</strong>',
-                '<a target="_blank" href="' . esc_url(get_permalink($id)),
-                '</a>'
-            ),
-            10 => sprintf(
-                esc_html__('%1$s draft updated. %2$s">Preview page%3$s', 'event_espresso'),
-                $this->_cpt_object->labels->singular_name,
-                '<a target="_blank" href="' . esc_url(add_query_arg('preview', 'true', get_permalink($id))),
-                '</a>'
-            ),
-        ];
-        return $messages;
-    }
-
-
-    /**
-     * default method for the 'create_new' route for cpt admin pages.
-     * For reference what to include in here, see wp-admin/post-new.php
-     *
-     * @return void
-     */
-    protected function _create_new_cpt_item()
-    {
-        // gather template vars for WP_ADMIN_PATH . 'edit-form-advanced.php'
-        global $post, $title, $post_type, $post_type_object;
-        $post_type        = $this->_cpt_routes[ $this->_req_action ];
-        $post_type_object = $this->_cpt_object;
-        $title            = $post_type_object->labels->add_new_item;
-        $post             = $post = get_default_post_to_edit($this->_cpt_routes[ $this->_req_action ], true);
-        add_action('admin_print_styles', [$this, 'add_new_admin_page_global']);
-        // modify the default editor title field with default title.
-        add_filter('enter_title_here', [$this, 'add_custom_editor_default_title']);
-        $this->loadEditorTemplate();
-    }
-
-
-    /**
-     * Enqueues auto-save and loads the editor template
-     *
-     * @param bool $creating
-     */
-    private function loadEditorTemplate(bool $creating = true)
-    {
-        if ($this->admin_config && ! $this->admin_config->useAdvancedEditor()) {
-            add_filter('admin_body_class', function($classes)
-            {
-                $classes .= ' espresso-legacy-editor';
-                return $classes;
-            });
-        }
-
-        global $post, $title, $is_IE, $post_type, $post_type_object;
-        // these vars are used by the template
-        $editing = true;
-        $post_ID = $post->ID;
-        if (apply_filters('FHEE__EE_Admin_Page_CPT___create_new_cpt_item__replace_editor', false, $post) === false) {
-            // only enqueue autosave when creating event (necessary to get permalink/url generated)
-            // otherwise EE doesn't support autosave fully, so to prevent user confusion we disable it in edit context.
-            $action = $this->request->getRequestParam('action');
-            if ($creating) {
-                wp_enqueue_script('autosave');
-            } elseif (
-                isset($this->_cpt_routes[ $action ])
-                && ! isset($this->_labels['hide_add_button_on_cpt_route'][ $action ])
-            ) {
-                $create_new_action = apply_filters(
-                    'FHEE__EE_Admin_Page_CPT___edit_cpt_item__create_new_action',
-                    'create_new',
-                    $this
-                );
-                $post_new_file     = EE_Admin_Page::add_query_args_and_nonce(
-                    [
-                        'action' => $create_new_action,
-                        'page'   => $this->page_slug,
-                    ],
-                    'admin.php'
-                );
-            }
-            include_once WP_ADMIN_PATH . 'edit-form-advanced.php';
-        }
-    }
-
-
-    public function add_new_admin_page_global()
-    {
-        $admin_page = $this->request->getRequestParam('post', 0, DataType::INT) !== 0
-            ? 'post-php'
-            : 'post-new-php';
-        ?>
+	}
+
+
+	/**
+	 * This allows us to redirect the location of revision restores when they happen so it goes to our CPT routes.
+	 *
+	 * @param string $location Original location url
+	 * @return string           new (or original) url to redirect to.
+	 * @throws EE_Error
+	 */
+	public function revision_redirect(string $location): string
+	{
+		// get revision
+		$revision = $this->request->getRequestParam('revision');
+		// can't do anything without revision so let's get out if not present
+		if (empty($revision)) {
+			return $location;
+		}
+		// get rev_post_data
+		$rev        = get_post($revision);
+		$admin_url  = $this->_admin_base_url;
+		$query_args = [
+			'action'   => 'edit',
+			'post'     => $rev->post_parent,
+			'revision' => $revision,
+			'message'  => 5,
+		];
+		$this->_process_notices($query_args, true);
+		return EE_Admin_Page_CPT::add_query_args_and_nonce($query_args, $admin_url);
+	}
+
+
+	/**
+	 * Modify the edit post link generated by wp core function so that EE CPTs get setup differently.
+	 *
+	 * @param string $link    the original generated link
+	 * @param int    $id      post id
+	 * @return string          the link
+	 */
+	public function modify_edit_post_link(string $link, int $id): string
+	{
+		$post = get_post($id);
+		$action = $this->request->getRequestParam('action');
+		if (
+			empty($action)
+			|| ! isset($this->_cpt_routes[ $action ])
+			|| $post->post_type !== $this->_cpt_routes[ $action ]
+		) {
+			return $link;
+		}
+		$query_args = [
+			'action' => $this->_cpt_edit_routes[ $post->post_type ] ?? 'edit',
+			'post'   => $id,
+		];
+		return EE_Admin_Page_CPT::add_query_args_and_nonce($query_args, $this->_admin_base_url);
+	}
+
+
+	/**
+	 * Modify the trash link on our cpt edit pages so it has the required query var for triggering redirect properly on
+	 * our routes.
+	 *
+	 * @param string $delete_link  original delete link
+	 * @param int    $post_id      id of cpt object
+	 * @return string new delete link
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function modify_delete_post_link(string $delete_link, int $post_id): string
+	{
+		$post = get_post($post_id);
+		$action = $this->request->getRequestParam('action');
+		if (
+			! $post instanceof WP_Post
+			|| empty($action)
+			|| ! isset($this->_cpt_routes[ $action ])
+			|| $post->post_type !== $this->_cpt_routes[ $action ]
+		) {
+			return $delete_link;
+		}
+		$this->_set_model_object($post->ID, true);
+
+		// returns something like `trash_event` or `trash_attendee` or `trash_venue`
+		$action = 'trash_' . str_replace('ee_', '', strtolower(get_class($this->_cpt_model_obj)));
+
+		return EE_Admin_Page::add_query_args_and_nonce(
+			[
+				'page'   => $this->request->getRequestParam('page'),
+				'action' => $action,
+				$this->_cpt_model_obj->get_model()->get_primary_key_field()->get_name() => $post->ID,
+			],
+			admin_url()
+		);
+	}
+
+
+	/**
+	 * This is the callback for the 'redirect_post_location' filter in wp-admin/post.php
+	 * so that we can hijack the default redirect locations for wp custom post types
+	 * that WE'RE using and send back to OUR routes.  This should only be hooked in on the right route.
+	 *
+	 * @param string $location This is the incoming currently set redirect location
+	 * @param string $post_id  This is the 'ID' value of the wp_posts table
+	 * @return string           the new location to redirect to
+	 * @throws EE_Error
+	 */
+	public function cpt_post_location_redirect(string $location, string $post_id): string
+	{
+		// we DO have a match so let's setup the url
+		// we have to get the post to determine our route
+		$post       = get_post($post_id);
+		$edit_route = $this->_cpt_edit_routes[ $post->post_type ];
+		// shared query_args
+		$query_args = ['action' => $edit_route, 'post' => $post_id];
+
+		$save = $this->request->getRequestParam('save');
+		$publish = $this->request->getRequestParam('publish');
+		$add_meta = $this->request->getRequestParam('addmeta');
+		$delete_meta = $this->request->getRequestParam('deletemeta');
+		if ($save || $publish) {
+			$status = get_post_status($post_id);
+			if ($publish) {
+				switch ($status) {
+					case 'pending':
+						$message = 8;
+						break;
+					case 'future':
+						$message = 9;
+						break;
+					default:
+						$message = 6;
+				}
+			} else {
+				$message = 'draft' === $status ? 10 : 1;
+			}
+		} elseif ($add_meta) {
+			$message = 2;
+		} elseif ($delete_meta) {
+			$message = 3;
+		} elseif ($this->request->getRequestParam('action') === 'post-quickpress-save-cont') {
+			$message = 7;
+		} else {
+			$message = 4;
+		}
+		// change the message if the post type is not viewable on the frontend
+		$this->_cpt_object = get_post_type_object($post->post_type);
+
+		$query_args['message'] = $message === 1 && ! $this->_cpt_object->publicly_queryable ? 4 : $message;
+		$this->_process_notices($query_args, true);
+		return EE_Admin_Page_CPT::add_query_args_and_nonce($query_args, $this->_admin_base_url);
+	}
+
+
+	/**
+	 * This method is called to inject nav tabs on core WP cpt pages
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function inject_nav_tabs()
+	{
+		echo wp_kses($this->_get_main_nav_tabs(), AllowedTags::getWithFormTags());
+	}
+
+
+	/**
+	 * This just sets up the post update messages when an update form is loaded
+	 *
+	 * @param array $messages the original messages array
+	 * @return array           the new messages array
+	 */
+	public function post_update_messages(array $messages): array
+	{
+		global $post;
+		$id       = $this->request->getRequestParam('post');
+		$id       = empty($id) && is_object($post) ? $post->ID : null;
+		$revision = $this->request->getRequestParam('revision', 0, 'int');
+
+		$messages[ $post->post_type ] = [
+			0  => '', // Unused. Messages start at index 1.
+			1  => sprintf(
+				esc_html__('%1$s updated. %2$sView %1$s%3$s', 'event_espresso'),
+				$this->_cpt_object->labels->singular_name,
+				'<a href="' . esc_url(get_permalink($id)) . '">',
+				'</a>'
+			),
+			2  => esc_html__('Custom field updated', 'event_espresso'),
+			3  => esc_html__('Custom field deleted.', 'event_espresso'),
+			4  => sprintf(esc_html__('%1$s updated.', 'event_espresso'), $this->_cpt_object->labels->singular_name),
+			5  => $revision
+				? sprintf(
+					esc_html__('%s restored to revision from %s', 'event_espresso'),
+					$this->_cpt_object->labels->singular_name,
+					wp_post_revision_title($revision, false)
+				)
+				: false,
+			6  => sprintf(
+				esc_html__('%1$s published. %2$sView %1$s%3$s', 'event_espresso'),
+				$this->_cpt_object->labels->singular_name,
+				'<a href="' . esc_url(get_permalink($id)) . '">',
+				'</a>'
+			),
+			7  => sprintf(esc_html__('%1$s saved.', 'event_espresso'), $this->_cpt_object->labels->singular_name),
+			8  => sprintf(
+				esc_html__('%1$s submitted. %2$sPreview %1$s%3$s', 'event_espresso'),
+				$this->_cpt_object->labels->singular_name,
+				'<a target="_blank" href="' . esc_url(add_query_arg('preview', 'true', get_permalink($id))) . '">',
+				'</a>'
+			),
+			9  => sprintf(
+				esc_html__('%1$s scheduled for: %2$s. %3$s">Preview %1$s%3$s', 'event_espresso'),
+				$this->_cpt_object->labels->singular_name,
+				'<strong>' . date_i18n('M j, Y @ G:i', strtotime($post->post_date)) . '</strong>',
+				'<a target="_blank" href="' . esc_url(get_permalink($id)),
+				'</a>'
+			),
+			10 => sprintf(
+				esc_html__('%1$s draft updated. %2$s">Preview page%3$s', 'event_espresso'),
+				$this->_cpt_object->labels->singular_name,
+				'<a target="_blank" href="' . esc_url(add_query_arg('preview', 'true', get_permalink($id))),
+				'</a>'
+			),
+		];
+		return $messages;
+	}
+
+
+	/**
+	 * default method for the 'create_new' route for cpt admin pages.
+	 * For reference what to include in here, see wp-admin/post-new.php
+	 *
+	 * @return void
+	 */
+	protected function _create_new_cpt_item()
+	{
+		// gather template vars for WP_ADMIN_PATH . 'edit-form-advanced.php'
+		global $post, $title, $post_type, $post_type_object;
+		$post_type        = $this->_cpt_routes[ $this->_req_action ];
+		$post_type_object = $this->_cpt_object;
+		$title            = $post_type_object->labels->add_new_item;
+		$post             = $post = get_default_post_to_edit($this->_cpt_routes[ $this->_req_action ], true);
+		add_action('admin_print_styles', [$this, 'add_new_admin_page_global']);
+		// modify the default editor title field with default title.
+		add_filter('enter_title_here', [$this, 'add_custom_editor_default_title']);
+		$this->loadEditorTemplate();
+	}
+
+
+	/**
+	 * Enqueues auto-save and loads the editor template
+	 *
+	 * @param bool $creating
+	 */
+	private function loadEditorTemplate(bool $creating = true)
+	{
+		if ($this->admin_config && ! $this->admin_config->useAdvancedEditor()) {
+			add_filter('admin_body_class', function($classes)
+			{
+				$classes .= ' espresso-legacy-editor';
+				return $classes;
+			});
+		}
+
+		global $post, $title, $is_IE, $post_type, $post_type_object;
+		// these vars are used by the template
+		$editing = true;
+		$post_ID = $post->ID;
+		if (apply_filters('FHEE__EE_Admin_Page_CPT___create_new_cpt_item__replace_editor', false, $post) === false) {
+			// only enqueue autosave when creating event (necessary to get permalink/url generated)
+			// otherwise EE doesn't support autosave fully, so to prevent user confusion we disable it in edit context.
+			$action = $this->request->getRequestParam('action');
+			if ($creating) {
+				wp_enqueue_script('autosave');
+			} elseif (
+				isset($this->_cpt_routes[ $action ])
+				&& ! isset($this->_labels['hide_add_button_on_cpt_route'][ $action ])
+			) {
+				$create_new_action = apply_filters(
+					'FHEE__EE_Admin_Page_CPT___edit_cpt_item__create_new_action',
+					'create_new',
+					$this
+				);
+				$post_new_file     = EE_Admin_Page::add_query_args_and_nonce(
+					[
+						'action' => $create_new_action,
+						'page'   => $this->page_slug,
+					],
+					'admin.php'
+				);
+			}
+			include_once WP_ADMIN_PATH . 'edit-form-advanced.php';
+		}
+	}
+
+
+	public function add_new_admin_page_global()
+	{
+		$admin_page = $this->request->getRequestParam('post', 0, DataType::INT) !== 0
+			? 'post-php'
+			: 'post-new-php';
+		?>
         <script type="text/javascript">
             adminpage = '<?php echo esc_js($admin_page); ?>';
         </script>
         <?php
-    }
-
-
-    /**
-     * default method for the 'edit' route for cpt admin pages
-     * For reference on what to put in here, refer to wp-admin/post.php
-     *
-     * @return void
-     */
-    protected function _edit_cpt_item()
-    {
-        global $post, $post_type, $post_type_object, $title;
-        $post_id = $this->request->getRequestParam('post', 0, DataType::INT);
-        $post    = $post_id ? get_post($post_id, OBJECT, 'edit') : null;
-        if (empty($post)) {
-            wp_die(
-                esc_html__(
-                    "You attempted to edit an item that doesn't exist. Perhaps it was deleted?",
-                    'event_espresso'
-                )
-            );
-        }
-
-        $post_lock = $this->request->getRequestParam('get-post-lock');
-        if ($post_lock) {
-            wp_set_post_lock($post_id);
-            EEH_URL::safeRedirectAndExit(get_edit_post_link($post_id, 'url'));
-        }
-
-        // template vars for WP_ADMIN_PATH . 'edit-form-advanced.php'
-        $post_type        = $this->_cpt_routes[ $this->_req_action ];
-        $post_type_object = $this->_cpt_object;
-        $title = $this->_labels['editor_title'][ $this->_cpt_routes[ $this->_req_action ] ]
-                 ?? $post_type_object->labels->edit_item;
-
-        if (! wp_check_post_lock($post->ID)) {
-            wp_set_post_lock($post->ID);
-        }
-        add_action('admin_footer', '_admin_notice_post_locked');
-        if (post_type_supports($this->_cpt_routes[ $this->_req_action ], 'comments')) {
-            wp_enqueue_script('admin-comments');
-            enqueue_comment_hotkeys_js();
-        }
-        add_action('admin_print_styles', [$this, 'add_new_admin_page_global']);
-        // modify the default editor title field with default title.
-        add_filter('enter_title_here', [$this, 'add_custom_editor_default_title']);
-        $this->loadEditorTemplate(false);
-    }
-
-
-
-    /**
-     * some getters
-     */
-    /**
-     * This returns the protected _cpt_model_obj property
-     *
-     * @return EE_CPT_Base|null
-     */
-    public function get_cpt_model_obj(): ?EE_CPT_Base
-    {
-        return $this->_cpt_model_obj;
-    }
+	}
+
+
+	/**
+	 * default method for the 'edit' route for cpt admin pages
+	 * For reference on what to put in here, refer to wp-admin/post.php
+	 *
+	 * @return void
+	 */
+	protected function _edit_cpt_item()
+	{
+		global $post, $post_type, $post_type_object, $title;
+		$post_id = $this->request->getRequestParam('post', 0, DataType::INT);
+		$post    = $post_id ? get_post($post_id, OBJECT, 'edit') : null;
+		if (empty($post)) {
+			wp_die(
+				esc_html__(
+					"You attempted to edit an item that doesn't exist. Perhaps it was deleted?",
+					'event_espresso'
+				)
+			);
+		}
+
+		$post_lock = $this->request->getRequestParam('get-post-lock');
+		if ($post_lock) {
+			wp_set_post_lock($post_id);
+			EEH_URL::safeRedirectAndExit(get_edit_post_link($post_id, 'url'));
+		}
+
+		// template vars for WP_ADMIN_PATH . 'edit-form-advanced.php'
+		$post_type        = $this->_cpt_routes[ $this->_req_action ];
+		$post_type_object = $this->_cpt_object;
+		$title = $this->_labels['editor_title'][ $this->_cpt_routes[ $this->_req_action ] ]
+				 ?? $post_type_object->labels->edit_item;
+
+		if (! wp_check_post_lock($post->ID)) {
+			wp_set_post_lock($post->ID);
+		}
+		add_action('admin_footer', '_admin_notice_post_locked');
+		if (post_type_supports($this->_cpt_routes[ $this->_req_action ], 'comments')) {
+			wp_enqueue_script('admin-comments');
+			enqueue_comment_hotkeys_js();
+		}
+		add_action('admin_print_styles', [$this, 'add_new_admin_page_global']);
+		// modify the default editor title field with default title.
+		add_filter('enter_title_here', [$this, 'add_custom_editor_default_title']);
+		$this->loadEditorTemplate(false);
+	}
+
+
+
+	/**
+	 * some getters
+	 */
+	/**
+	 * This returns the protected _cpt_model_obj property
+	 *
+	 * @return EE_CPT_Base|null
+	 */
+	public function get_cpt_model_obj(): ?EE_CPT_Base
+	{
+		return $this->_cpt_model_obj;
+	}
 }

core/admin/EE_Admin_Page.core.php

Indentation +4240 added lines, -4240 removed lines

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

Spacing +174 added lines, -174 removed lines

@@ -102,7 +102,7 @@ 
      */
     protected ?bool $_is_UI_request = null;
 
-    protected bool  $_is_caf        = false;                                                                                                                                                                                                                                  // This is just a property that flags whether the given route is a caffeinated route or not.
+    protected bool  $_is_caf        = false; // This is just a property that flags whether the given route is a caffeinated route or not.
 
     protected bool  $_routing       = false;
 
@@ -597,7 +597,7 @@ 
         $ee_menu_slugs = (array) $ee_menu_slugs;
         if (
             ! $this->request->isAjax()
-            && (! $this->_current_page || ! isset($ee_menu_slugs[ $this->_current_page ]))
+            && ( ! $this->_current_page || ! isset($ee_menu_slugs[$this->_current_page]))
         ) {
             return;
         }
@@ -616,7 +616,7 @@ 
             ? $route
             : $req_action;
         $this->_current_view = $this->_req_action;
-        $this->_req_nonce    = $this->_req_action . '_nonce';
+        $this->_req_nonce    = $this->_req_action.'_nonce';
         $this->_define_page_props();
         $this->_current_page_view_url = add_query_arg(
             ['page' => $this->_current_page, 'action' => $this->_current_view],
@@ -640,33 +640,33 @@ 
         }
         // filter routes and page_config so addons can add their stuff. Filtering done per class
         $this->_page_routes = apply_filters(
-            'FHEE__' . $this->class_name . '__page_setup__page_routes',
+            'FHEE__'.$this->class_name.'__page_setup__page_routes',
             $this->_page_routes,
             $this
         );
         $this->_page_config = apply_filters(
-            'FHEE__' . $this->class_name . '__page_setup__page_config',
+            'FHEE__'.$this->class_name.'__page_setup__page_config',
             $this->_page_config,
             $this
         );
         if ($this->base_class_name !== '') {
             $this->_page_routes = apply_filters(
-                'FHEE__' . $this->base_class_name . '__page_setup__page_routes',
+                'FHEE__'.$this->base_class_name.'__page_setup__page_routes',
                 $this->_page_routes,
                 $this
             );
             $this->_page_config = apply_filters(
-                'FHEE__' . $this->base_class_name . '__page_setup__page_config',
+                'FHEE__'.$this->base_class_name.'__page_setup__page_config',
                 $this->_page_config,
                 $this
             );
         }
         // if AHEE__EE_Admin_Page__route_admin_request_$this->_current_view method is present
         // then we call it hooked into the AHEE__EE_Admin_Page__route_admin_request action
-        if (method_exists($this, 'AHEE__EE_Admin_Page__route_admin_request_' . $this->_current_view)) {
+        if (method_exists($this, 'AHEE__EE_Admin_Page__route_admin_request_'.$this->_current_view)) {
             add_action(
                 'AHEE__EE_Admin_Page__route_admin_request',
-                [$this, 'AHEE__EE_Admin_Page__route_admin_request_' . $this->_current_view],
+                [$this, 'AHEE__EE_Admin_Page__route_admin_request_'.$this->_current_view],
                 10,
                 2
             );
@@ -679,8 +679,8 @@ 
             if ($this->_is_UI_request) {
                 // admin_init stuff - global, all views for this page class, specific view
                 add_action('admin_init', [$this, 'admin_init']);
-                if (method_exists($this, 'admin_init_' . $this->_current_view)) {
-                    add_action('admin_init', [$this, 'admin_init_' . $this->_current_view], 15);
+                if (method_exists($this, 'admin_init_'.$this->_current_view)) {
+                    add_action('admin_init', [$this, 'admin_init_'.$this->_current_view], 15);
                 }
             } else {
                 // hijack regular WP loading and route admin request immediately
@@ -699,12 +699,12 @@ 
      */
     private function _do_other_page_hooks()
     {
-        $registered_pages = apply_filters('FHEE_do_other_page_hooks_' . $this->page_slug, []);
+        $registered_pages = apply_filters('FHEE_do_other_page_hooks_'.$this->page_slug, []);
         foreach ($registered_pages as $page) {
             // now let's setup the file name and class that should be present
             $classname = str_replace('.class.php', '', $page);
             // autoloaders should take care of loading file
-            if (! class_exists($classname)) {
+            if ( ! class_exists($classname)) {
                 $error_msg[] = sprintf(
                     esc_html__(
                         'Something went wrong with loading the %s admin hooks page.',
@@ -721,7 +721,7 @@ 
                                    ),
                                    $page,
                                    '<br />',
-                                   '<strong>' . $classname . '</strong>'
+                                   '<strong>'.$classname.'</strong>'
                                );
                 throw new EE_Error(implode('||', $error_msg));
             }
@@ -770,13 +770,13 @@ 
         // load admin_notices - global, page class, and view specific
         add_action('admin_notices', [$this, 'admin_notices_global'], 5);
         add_action('admin_notices', [$this, 'admin_notices']);
-        if (method_exists($this, 'admin_notices_' . $this->_current_view)) {
-            add_action('admin_notices', [$this, 'admin_notices_' . $this->_current_view], 15);
+        if (method_exists($this, 'admin_notices_'.$this->_current_view)) {
+            add_action('admin_notices', [$this, 'admin_notices_'.$this->_current_view], 15);
         }
         // load network admin_notices - global, page class, and view specific
         add_action('network_admin_notices', [$this, 'network_admin_notices_global'], 5);
-        if (method_exists($this, 'network_admin_notices_' . $this->_current_view)) {
-            add_action('network_admin_notices', [$this, 'network_admin_notices_' . $this->_current_view]);
+        if (method_exists($this, 'network_admin_notices_'.$this->_current_view)) {
+            add_action('network_admin_notices', [$this, 'network_admin_notices_'.$this->_current_view]);
         }
         // this will save any per_page screen options if they are present
         $this->_set_per_page_screen_options();
@@ -902,7 +902,7 @@ 
      */
     protected function _verify_routes(): bool
     {
-        if (! $this->_current_page && ! $this->request->isAjax()) {
+        if ( ! $this->_current_page && ! $this->request->isAjax()) {
             return false;
         }
         // check that the page_routes array is not empty
@@ -913,7 +913,7 @@ 
                 $this->_admin_page_title
             );
             // developer error msg
-            $error_msg .= '||' . $error_msg
+            $error_msg .= '||'.$error_msg
                           . esc_html__(
                               ' Make sure the "set_page_routes()" method exists, and is setting the "_page_routes" array properly.',
                               'event_espresso'
@@ -931,8 +931,8 @@ 
         }
         // and that the requested page route exists
         if (array_key_exists($this->_req_action, $this->_page_routes)) {
-            $this->_route        = $this->_page_routes[ $this->_req_action ];
-            $this->_route_config = $this->_page_config[ $this->_req_action ] ?? [];
+            $this->_route        = $this->_page_routes[$this->_req_action];
+            $this->_route_config = $this->_page_config[$this->_req_action] ?? [];
         } else {
             // user error msg
             $error_msg = sprintf(
@@ -943,7 +943,7 @@ 
                 $this->_admin_page_title
             );
             // developer error msg
-            $error_msg .= '||' . $error_msg
+            $error_msg .= '||'.$error_msg
                           . sprintf(
                               esc_html__(
                                   ' Create a key in the "_page_routes" array named "%s" and set its value to the appropriate method.',
@@ -954,7 +954,7 @@ 
             throw new EE_Error($error_msg);
         }
         // and that a default route exists
-        if (! array_key_exists('default', $this->_page_routes)) {
+        if ( ! array_key_exists('default', $this->_page_routes)) {
             // user error msg
             $error_msg = sprintf(
                 esc_html__(
@@ -964,7 +964,7 @@ 
                 $this->_admin_page_title
             );
             // developer error msg
-            $error_msg .= '||' . $error_msg
+            $error_msg .= '||'.$error_msg
                           . esc_html__(
                               ' Create a key in the "_page_routes" array named "default" and set its value to your default page method.',
                               'event_espresso'
@@ -1004,7 +1004,7 @@ 
             $this->_admin_page_title
         );
         // developer error msg
-        $error_msg .= '||' . $error_msg
+        $error_msg .= '||'.$error_msg
                       . sprintf(
                           esc_html__(
                               ' Check the route you are using in your method (%s) and make sure it matches a route set in your "_page_routes" array property',
@@ -1032,7 +1032,7 @@ 
     protected function _verify_nonce(string $nonce, string $nonce_ref)
     {
         // verify nonce against expected value
-        if (! wp_verify_nonce($nonce, $nonce_ref)) {
+        if ( ! wp_verify_nonce($nonce, $nonce_ref)) {
             // these are not the droids you are looking for !!!
             $msg = sprintf(
                 esc_html__('%sNonce Fail.%s', 'event_espresso'),
@@ -1049,7 +1049,7 @@ 
                     __CLASS__
                 );
             }
-            if (! $this->request->isAjax()) {
+            if ( ! $this->request->isAjax()) {
                 wp_die($msg);
             }
             EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
@@ -1074,7 +1074,7 @@ 
      */
     protected function _route_admin_request()
     {
-        if (! $this->_is_UI_request) {
+        if ( ! $this->_is_UI_request) {
             $this->_verify_routes();
         }
         $nonce_check = ! isset($this->_route_config['require_nonce']) || $this->_route_config['require_nonce'];
@@ -1094,7 +1094,7 @@ 
 
         // action right before calling route
         // (hook is something like 'AHEE__Registrations_Admin_Page__route_admin_request')
-        if (! did_action('AHEE__EE_Admin_Page__route_admin_request')) {
+        if ( ! did_action('AHEE__EE_Admin_Page__route_admin_request')) {
             do_action('AHEE__EE_Admin_Page__route_admin_request', $this->_current_view, $this);
         }
         // strip _wp_http_referer from the server REQUEST_URI
@@ -1109,7 +1109,7 @@ 
         $this->request->setRequestParam('_wp_http_referer', $cleaner_request_uri, true);
         $this->request->setServerParam('REQUEST_URI', $cleaner_request_uri, true);
         $route_callback = [];
-        if (! empty($func)) {
+        if ( ! empty($func)) {
             if (is_array($func) && is_callable($func)) {
                 $route_callback = $func;
             } elseif (is_string($func)) {
@@ -1123,7 +1123,7 @@ 
             }
             [$class, $method] = $route_callback;
             // is it neither a class method NOR a standalone function?
-            if (! is_callable($route_callback)) {
+            if ( ! is_callable($route_callback)) {
                 // user error msg
                 $error_msg = esc_html__(
                     'An error occurred. The  requested page route could not be found.',
@@ -1150,7 +1150,7 @@ 
             } catch (Throwable $throwable) {
                 $nice_args = [];
                 foreach ($args as $key => $arg) {
-                    $nice_args[ $key ] = is_object($arg) ? get_class($arg) : $key;
+                    $nice_args[$key] = is_object($arg) ? get_class($arg) : $key;
                 }
                 new ExceptionStackTraceDisplay(
                     new RuntimeException(
@@ -1254,7 +1254,7 @@ 
                 if (strpos($key, 'nonce') !== false) {
                     continue;
                 }
-                $args[ 'wp_referer[' . $key . ']' ] = is_string($value) ? htmlspecialchars($value) : $value;
+                $args['wp_referer['.$key.']'] = is_string($value) ? htmlspecialchars($value) : $value;
             }
         }
         return EEH_URL::add_query_args_and_nonce($args, $url, $exclude_nonce, $context);
@@ -1294,12 +1294,12 @@ 
      */
     protected function _add_help_tabs()
     {
-        if (isset($this->_page_config[ $this->_req_action ])) {
-            $config = $this->_page_config[ $this->_req_action ];
+        if (isset($this->_page_config[$this->_req_action])) {
+            $config = $this->_page_config[$this->_req_action];
             // let's see if there is a help_sidebar set for the current route and we'll set that up for usage as well.
             if (is_array($config) && isset($config['help_sidebar'])) {
                 // check that the callback given is valid
-                if (! method_exists($this, $config['help_sidebar'])) {
+                if ( ! method_exists($this, $config['help_sidebar'])) {
                     throw new EE_Error(
                         sprintf(
                             esc_html__(
@@ -1312,18 +1312,18 @@ 
                     );
                 }
                 $content = apply_filters(
-                    'FHEE__' . $this->class_name . '__add_help_tabs__help_sidebar',
+                    'FHEE__'.$this->class_name.'__add_help_tabs__help_sidebar',
                     $this->{$config['help_sidebar']}()
                 );
                 $this->_current_screen->set_help_sidebar($content);
             }
-            if (! isset($config['help_tabs'])) {
+            if ( ! isset($config['help_tabs'])) {
                 return;
             } //no help tabs for this route
             foreach ((array) $config['help_tabs'] as $tab_id => $cfg) {
                 // we're here so there ARE help tabs!
                 // make sure we've got what we need
-                if (! isset($cfg['title'])) {
+                if ( ! isset($cfg['title'])) {
                     throw new EE_Error(
                         esc_html__(
                             'The _page_config array is not set up properly for help tabs.  It is missing a title',
@@ -1331,7 +1331,7 @@ 
                         )
                     );
                 }
-                if (! isset($cfg['filename']) && ! isset($cfg['callback']) && ! isset($cfg['content'])) {
+                if ( ! isset($cfg['filename']) && ! isset($cfg['callback']) && ! isset($cfg['content'])) {
                     throw new EE_Error(
                         esc_html__(
                             'The _page_config array is not setup properly for help tabs. It is missing a either a filename reference, or a callback reference or a content reference so there is no way to know the content for the help tab',
@@ -1340,11 +1340,11 @@ 
                     );
                 }
                 // first priority goes to content.
-                if (! empty($cfg['content'])) {
+                if ( ! empty($cfg['content'])) {
                     $content = $cfg['content'];
                     // second priority goes to filename
-                } elseif (! empty($cfg['filename'])) {
-                    $file_path = $this->_get_dir() . '/help_tabs/' . $cfg['filename'] . '.help_tab.php';
+                } elseif ( ! empty($cfg['filename'])) {
+                    $file_path = $this->_get_dir().'/help_tabs/'.$cfg['filename'].'.help_tab.php';
                     // it's possible that the file is located on decaf route (and above sets up for caf route, if this is the case then lets check decaf route too)
                     $file_path = ! is_readable($file_path) ? EE_ADMIN_PAGES
                                                              . basename($this->_get_dir())
@@ -1352,7 +1352,7 @@ 
                                                              . $cfg['filename']
                                                              . '.help_tab.php' : $file_path;
                     // if file is STILL not readable then let's do a EE_Error so its more graceful than a fatal error.
-                    if (! isset($cfg['callback']) && ! is_readable($file_path)) {
+                    if ( ! isset($cfg['callback']) && ! is_readable($file_path)) {
                         EE_Error::add_error(
                             sprintf(
                                 esc_html__(
@@ -1400,7 +1400,7 @@ 
                     return;
                 }
                 // setup config array for help tab method
-                $id  = $this->page_slug . '-' . $this->_req_action . '-' . $tab_id;
+                $id  = $this->page_slug.'-'.$this->_req_action.'-'.$tab_id;
                 $_ht = [
                     'id'       => $id,
                     'title'    => $cfg['title'],
@@ -1426,8 +1426,8 @@ 
             $qtips = (array) $this->_route_config['qtips'];
             // load qtip loader
             $path = [
-                $this->_get_dir() . '/qtips/',
-                EE_ADMIN_PAGES . basename($this->_get_dir()) . '/qtips/',
+                $this->_get_dir().'/qtips/',
+                EE_ADMIN_PAGES.basename($this->_get_dir()).'/qtips/',
             ];
             EEH_Qtip_Loader::instance()->register($qtips, $path);
         }
@@ -1449,7 +1449,7 @@ 
         $i        = 0;
         $only_tab = count($this->_page_config) < 2;
         foreach ($this->_page_config as $slug => $config) {
-            if (! is_array($config) || empty($config['nav'])) {
+            if ( ! is_array($config) || empty($config['nav'])) {
                 continue;
             }
             // no nav tab for this config
@@ -1458,7 +1458,7 @@ 
                 // nav tab is only to appear when route requested.
                 continue;
             }
-            if (! $this->check_user_access($slug, true)) {
+            if ( ! $this->check_user_access($slug, true)) {
                 // no nav tab because current user does not have access.
                 continue;
             }
@@ -1466,20 +1466,20 @@ 
             $css_class .= $only_tab ? ' ee-only-tab' : '';
             $css_class .= " ee-nav-tab__$slug";
 
-            $this->_nav_tabs[ $slug ] = [
+            $this->_nav_tabs[$slug] = [
                 'url'       => $config['nav']['url'] ?? EE_Admin_Page::add_query_args_and_nonce(
                         ['action' => $slug],
                         $this->_admin_base_url
                     ),
                 'link_text' => $this->navTabLabel($config['nav'], $slug),
-                'css_class' => $this->_req_action === $slug ? $css_class . ' nav-tab-active' : $css_class,
+                'css_class' => $this->_req_action === $slug ? $css_class.' nav-tab-active' : $css_class,
                 'order'     => $config['nav']['order'] ?? $i,
             ];
             $i++;
         }
         // if $this->_nav_tabs is empty then lets set the default
         if (empty($this->_nav_tabs)) {
-            $this->_nav_tabs[ $this->_default_nav_tab_name ] = [
+            $this->_nav_tabs[$this->_default_nav_tab_name] = [
                 'url'       => $this->_admin_base_url,
                 'link_text' => ucwords(str_replace('_', ' ', $this->_default_nav_tab_name)),
                 'css_class' => 'nav-tab-active',
@@ -1495,11 +1495,11 @@ 
     {
         $label = $nav_tab['label'] ?? ucwords(str_replace('_', ' ', $slug));
         $icon  = $nav_tab['icon'] ?? null;
-        $icon  = $icon ? '<span class="dashicons ' . $icon . '"></span>' : '';
+        $icon  = $icon ? '<span class="dashicons '.$icon.'"></span>' : '';
         return '
             <span class="ee-admin-screen-tab__label">
-                ' . $icon . '
-                <span class="ee-nav-label__text">' . $label . '</span>
+                ' . $icon.'
+                <span class="ee-nav-label__text">' . $label.'</span>
             </span>';
     }
 
@@ -1517,10 +1517,10 @@ 
             foreach ($this->_route_config['labels'] as $label => $text) {
                 if (is_array($text)) {
                     foreach ($text as $sublabel => $subtext) {
-                        $this->_labels[ $label ][ $sublabel ] = $subtext;
+                        $this->_labels[$label][$sublabel] = $subtext;
                     }
                 } else {
-                    $this->_labels[ $label ] = $text;
+                    $this->_labels[$label] = $text;
                 }
             }
         }
@@ -1542,8 +1542,8 @@ 
     {
         // if no route_to_check is passed in then use the current route set via _req_action
         $action = $route_to_check ?: $this->_req_action;
-        $capability = ! empty($this->_page_routes[ $action ]['capability'])
-            ? $this->_page_routes[ $action ]['capability']
+        $capability = ! empty($this->_page_routes[$action]['capability'])
+            ? $this->_page_routes[$action]['capability']
             : null;
 
         if (empty($capability)) {
@@ -1593,14 +1593,14 @@ 
         string $priority = 'default',
         ?array $callback_args = null
     ) {
-        if (! (is_callable($callback) || ! function_exists($callback))) {
+        if ( ! (is_callable($callback) || ! function_exists($callback))) {
             return;
         }
 
         add_meta_box($box_id, $title, $callback, $screen, $context, $priority, $callback_args);
         add_filter(
             "postbox_classes_{$this->_wp_page_slug}_$box_id",
-            function ($classes) {
+            function($classes) {
                 $classes[] = 'ee-admin-container';
                 return $classes;
             }
@@ -1691,8 +1691,8 @@ 
             <div class="ee-notices"></div>
             <div class="ee-admin-dialog-container-inner-content"></div>
         </div>
-        <span id="current_timezone" class="hidden">' . esc_html(EEH_DTT_Helper::get_timezone()) . '</span>
-        <input type="hidden" id="espresso_admin_current_page" value="' . esc_attr($this->_current_page) . '"/>';
+        <span id="current_timezone" class="hidden">' . esc_html(EEH_DTT_Helper::get_timezone()).'</span>
+        <input type="hidden" id="espresso_admin_current_page" value="' . esc_attr($this->_current_page).'"/>';
     }
 
 
@@ -1726,7 +1726,7 @@ 
         // loop through the array and setup content
         foreach ($help_array as $trigger => $help) {
             // make sure the array is setup properly
-            if (! isset($help['title'], $help['content'])) {
+            if ( ! isset($help['title'], $help['content'])) {
                 throw new EE_Error(
                     esc_html__(
                         'Does not look like the popup content array has been setup correctly.  Might want to double check that.  Read the comments for the _get_help_popup_content method found in "EE_Admin_Page" class',
@@ -1740,8 +1740,8 @@ 
                 'help_popup_title'   => $help['title'],
                 'help_popup_content' => $help['content'],
             ];
-            $content       .= EEH_Template::display_template(
-                EE_ADMIN_TEMPLATE . 'admin_help_popup.template.php',
+            $content .= EEH_Template::display_template(
+                EE_ADMIN_TEMPLATE.'admin_help_popup.template.php',
                 $template_args,
                 true
             );
@@ -1763,15 +1763,15 @@ 
     private function _get_help_content(): array
     {
         // what is the method we're looking for?
-        $method_name = '_help_popup_content_' . $this->_req_action;
+        $method_name = '_help_popup_content_'.$this->_req_action;
         // if method doesn't exist let's get out.
-        if (! method_exists($this, $method_name)) {
+        if ( ! method_exists($this, $method_name)) {
             return [];
         }
         // k we're good to go let's retrieve the help array
         $help_array = $this->{$method_name}();
         // make sure we've got an array!
-        if (! is_array($help_array)) {
+        if ( ! is_array($help_array)) {
             throw new EE_Error(
                 esc_html__(
                     'Something went wrong with help popup content generation. Expecting an array and well, this ain\'t no array bub.',
@@ -1803,15 +1803,15 @@ 
         // let's check and see if there is any content set for this popup.  If there isn't then we'll include a default title and content so that developers know something needs to be corrected
         $help_array   = $this->_get_help_content();
         $help_content = '';
-        if (empty($help_array) || ! isset($help_array[ $trigger_id ])) {
-            $help_array[ $trigger_id ] = [
+        if (empty($help_array) || ! isset($help_array[$trigger_id])) {
+            $help_array[$trigger_id] = [
                 'title'   => esc_html__('Missing Content', 'event_espresso'),
                 'content' => esc_html__(
                     'A trigger has been set that doesn\'t have any corresponding content. Make sure you have set the help content. (see the "_set_help_popup_content" method in the EE_Admin_Page for instructions.)',
                     'event_espresso'
                 ),
             ];
-            $help_content              = $this->_set_help_popup_content($help_array);
+            $help_content = $this->_set_help_popup_content($help_array);
         }
         $height   = esc_attr($dimensions[0]) ?? 400;
         $width    = esc_attr($dimensions[1]) ?? 640;
@@ -1899,7 +1899,7 @@ 
 
         add_filter(
             'admin_body_class',
-            function ($classes) {
+            function($classes) {
                 if (strpos($classes, 'espresso-admin') === false) {
                     $classes .= ' espresso-admin';
                 }
@@ -1990,12 +1990,12 @@ 
     protected function _set_list_table()
     {
         // first is this a list_table view?
-        if (! isset($this->_route_config['list_table'])) {
+        if ( ! isset($this->_route_config['list_table'])) {
             return;
         } //not a list_table view so get out.
         // list table functions are per view specific (because some admin pages might have more than one list table!)
-        $list_table_view = '_set_list_table_views_' . $this->_req_action;
-        if (! method_exists($this, $list_table_view) || $this->{$list_table_view}() === false) {
+        $list_table_view = '_set_list_table_views_'.$this->_req_action;
+        if ( ! method_exists($this, $list_table_view) || $this->{$list_table_view}() === false) {
             // user error msg
             $error_msg = esc_html__(
                 'An error occurred. The requested list table views could not be found.',
@@ -2015,10 +2015,10 @@ 
         }
         // let's provide the ability to filter the views per PAGE AND ROUTE, per PAGE, and globally
         $this->_views = apply_filters(
-            'FHEE_list_table_views_' . $this->page_slug . '_' . $this->_req_action,
+            'FHEE_list_table_views_'.$this->page_slug.'_'.$this->_req_action,
             $this->_views
         );
-        $this->_views = apply_filters('FHEE_list_table_views_' . $this->page_slug, $this->_views);
+        $this->_views = apply_filters('FHEE_list_table_views_'.$this->page_slug, $this->_views);
         $this->_views = apply_filters('FHEE_list_table_views', $this->_views);
         $this->_set_list_table_view();
         $this->_set_list_table_object();
@@ -2053,7 +2053,7 @@ 
     protected function _set_list_table_object()
     {
         if (isset($this->_route_config['list_table'])) {
-            if (! class_exists($this->_route_config['list_table'])) {
+            if ( ! class_exists($this->_route_config['list_table'])) {
                 throw new EE_Error(
                     sprintf(
                         esc_html__(
@@ -2095,16 +2095,16 @@ 
         foreach ($this->_views as $key => $view) {
             $query_args = [];
             // check for current view
-            $this->_views[ $key ]['class'] = $this->_view === $view['slug'] ? 'current' : '';
+            $this->_views[$key]['class'] = $this->_view === $view['slug'] ? 'current' : '';
             $query_args['action']          = $this->_req_action;
             $action_nonce                  = "{$this->_req_action}_nonce";
-            $query_args[ $action_nonce ]   = wp_create_nonce($action_nonce);
+            $query_args[$action_nonce]   = wp_create_nonce($action_nonce);
             $query_args['status']          = $view['slug'];
             // merge any other arguments sent in.
-            if (isset($extra_query_args[ $view['slug'] ])) {
-                $query_args = array_merge($query_args, $extra_query_args[ $view['slug'] ]);
+            if (isset($extra_query_args[$view['slug']])) {
+                $query_args = array_merge($query_args, $extra_query_args[$view['slug']]);
             }
-            $this->_views[ $key ]['url'] = EE_Admin_Page::add_query_args_and_nonce($query_args, $this->_admin_base_url);
+            $this->_views[$key]['url'] = EE_Admin_Page::add_query_args_and_nonce($query_args, $this->_admin_base_url);
         }
         return $this->_views;
     }
@@ -2133,14 +2133,14 @@ 
 					<select id="entries-per-page-slct" name="entries-per-page-slct">';
         foreach ($values as $value) {
             if ($value < $max_entries) {
-                $selected                  = $value === $per_page ? ' selected="' . $per_page . '"' : '';
+                $selected = $value === $per_page ? ' selected="'.$per_page.'"' : '';
                 $entries_per_page_dropdown .= '
-						<option value="' . $value . '"' . $selected . '>' . $value . '&nbsp;&nbsp;</option>';
+						<option value="' . $value.'"'.$selected.'>'.$value.'&nbsp;&nbsp;</option>';
             }
         }
-        $selected                  = $max_entries === $per_page ? ' selected="' . $per_page . '"' : '';
+        $selected = $max_entries === $per_page ? ' selected="'.$per_page.'"' : '';
         $entries_per_page_dropdown .= '
-						<option value="' . $max_entries . '"' . $selected . '>All&nbsp;&nbsp;</option>';
+						<option value="' . $max_entries.'"'.$selected.'>All&nbsp;&nbsp;</option>';
         $entries_per_page_dropdown .= '
 					</select>
 					entries
@@ -2164,7 +2164,7 @@ 
             empty($this->_search_btn_label) ? $this->page_label
                 : $this->_search_btn_label
         );
-        $this->_template_args['search']['callback']  = 'search_' . $this->page_slug;
+        $this->_template_args['search']['callback'] = 'search_'.$this->page_slug;
     }
 
 
@@ -2225,7 +2225,7 @@ 
                                   );
                     throw new EE_Error($error_msg);
                 }
-                unset($this->_route_config['metaboxes'][ $key ]);
+                unset($this->_route_config['metaboxes'][$key]);
             }
         }
     }
@@ -2258,7 +2258,7 @@ 
             $total_columns                                       = ! empty($screen_columns)
                 ? $screen_columns
                 : $this->_route_config['columns'][1];
-            $this->_template_args['current_screen_widget_class'] = 'columns-' . $total_columns;
+            $this->_template_args['current_screen_widget_class'] = 'columns-'.$total_columns;
             $this->_template_args['current_page']                = $this->_wp_page_slug;
             $this->_template_args['screen']                      = $this->_current_screen;
             $this->_column_template_path                         = EE_ADMIN_TEMPLATE
@@ -2304,7 +2304,7 @@ 
      */
     protected function _espresso_ratings_request()
     {
-        if (! apply_filters('FHEE_show_ratings_request_meta_box', true)) {
+        if ( ! apply_filters('FHEE_show_ratings_request_meta_box', true)) {
             return;
         }
         $ratings_box_title = apply_filters(
@@ -2331,28 +2331,28 @@ 
      */
     public function espresso_ratings_request()
     {
-        EEH_Template::display_template(EE_ADMIN_TEMPLATE . 'espresso_ratings_request_content.template.php');
+        EEH_Template::display_template(EE_ADMIN_TEMPLATE.'espresso_ratings_request_content.template.php');
     }
 
 
     public static function cached_rss_display(string $rss_id, string $url): bool
     {
-        $loading   = '<p class="widget-loading hide-if-no-js">'
+        $loading = '<p class="widget-loading hide-if-no-js">'
                      . esc_html__('Loading&#8230;', 'event_espresso')
                      . '</p><p class="hide-if-js">'
                      . esc_html__('This widget requires JavaScript.', 'event_espresso')
                      . '</p>';
-        $pre       = '<div class="espresso-rss-display">' . "\n\t";
-        $pre       .= '<span id="' . esc_attr($rss_id) . '_url" class="hidden">' . esc_url_raw($url) . '</span>';
-        $post      = '</div>' . "\n";
-        $cache_key = 'ee_rss_' . md5($rss_id);
+        $pre       = '<div class="espresso-rss-display">'."\n\t";
+        $pre .= '<span id="'.esc_attr($rss_id).'_url" class="hidden">'.esc_url_raw($url).'</span>';
+        $post      = '</div>'."\n";
+        $cache_key = 'ee_rss_'.md5($rss_id);
         $output    = get_transient($cache_key);
         if ($output !== false) {
-            echo wp_kses($pre . $output . $post, AllowedTags::getWithFormTags());
+            echo wp_kses($pre.$output.$post, AllowedTags::getWithFormTags());
             return true;
         }
-        if (! (defined('DOING_AJAX') && DOING_AJAX)) {
-            echo wp_kses($pre . $loading . $post, AllowedTags::getWithFormTags());
+        if ( ! (defined('DOING_AJAX') && DOING_AJAX)) {
+            echo wp_kses($pre.$loading.$post, AllowedTags::getWithFormTags());
             return false;
         }
         ob_start();
@@ -2419,7 +2419,7 @@ 
     public function espresso_sponsors_post_box()
     {
         EEH_Template::display_template(
-            EE_ADMIN_TEMPLATE . 'admin_general_metabox_contents_espresso_sponsors.template.php'
+            EE_ADMIN_TEMPLATE.'admin_general_metabox_contents_espresso_sponsors.template.php'
         );
     }
 
@@ -2436,9 +2436,9 @@ 
     protected function getPublishBoxTitle(): string
     {
         $publish_box_title = esc_html__('Publish', 'event_espresso');
-        if (! empty($this->_labels['publishbox'])) {
+        if ( ! empty($this->_labels['publishbox'])) {
             if (is_array($this->_labels['publishbox'])) {
-                $publish_box_title = $this->_labels['publishbox'][ $this->_req_action ] ?? $publish_box_title;
+                $publish_box_title = $this->_labels['publishbox'][$this->_req_action] ?? $publish_box_title;
             } else {
                 $publish_box_title = $this->_labels['publishbox'];
             }
@@ -2488,7 +2488,7 @@ 
         // if we have extra content set let's add it in if not make sure its empty
         $this->_template_args['publish_box_extra_content'] = $this->_template_args['publish_box_extra_content'] ?? '';
         echo EEH_Template::display_template(
-            EE_ADMIN_TEMPLATE . 'admin_details_publish_metabox.template.php',
+            EE_ADMIN_TEMPLATE.'admin_details_publish_metabox.template.php',
             $this->_template_args,
             true
         );
@@ -2541,10 +2541,10 @@ 
                 'submitdelete deletion button button--outline button--caution'
             );
         }
-        if (! isset($this->_template_args['publish_delete_link'])) {
+        if ( ! isset($this->_template_args['publish_delete_link'])) {
             $this->_template_args['publish_delete_link'] = '';
         }
-        if (! empty($name) && ! empty($id)) {
+        if ( ! empty($name) && ! empty($id)) {
             $this->addPublishPostMetaBoxHiddenFields($name, ['type' => 'hidden', 'value' => $id]);
         }
         $hidden_fields = $this->_generate_admin_form_fields($this->publish_post_meta_box_hidden_fields, 'array');
@@ -2577,7 +2577,7 @@ 
 
     protected function addPublishPostMetaBoxHiddenFields(string $field_name, array $field_attributes)
     {
-        $this->publish_post_meta_box_hidden_fields[ $field_name ] = $field_attributes;
+        $this->publish_post_meta_box_hidden_fields[$field_name] = $field_attributes;
     }
 
 
@@ -2679,7 +2679,7 @@ 
         }
         // if $create_func is true (default) then we automatically create the function for displaying the actual meta box.  If false then we take the $callback reference passed through and use it instead (so callers can define their own callback function/method if they wish)
         $call_back_func = $create_func
-            ? static function ($post, $metabox) {
+            ? static function($post, $metabox) {
                 echo EEH_Template::display_template(
                     $metabox['args']['template_path'],
                     $metabox['args']['template_args'],
@@ -2688,7 +2688,7 @@ 
             }
             : $callback;
         $this->addMetaBox(
-            str_replace('_', '-', $action) . '-mbox',
+            str_replace('_', '-', $action).'-mbox',
             $title,
             $call_back_func,
             $this->_wp_page_slug,
@@ -2804,15 +2804,15 @@ 
                                                                     'event-espresso_page_espresso_',
                                                                     '',
                                                                     $this->_wp_page_slug
-                                                                ) . ' ' . $this->_req_action . '-route';
+                                                                ).' '.$this->_req_action.'-route';
 
         $template_path = $sidebar
             ? EE_ADMIN_TEMPLATE . 'admin_details_wrapper.template.php'
-            : EE_ADMIN_TEMPLATE . 'admin_details_wrapper_no_sidebar.template.php';
+            : EE_ADMIN_TEMPLATE.'admin_details_wrapper_no_sidebar.template.php';
 
         $this->_template_args['is_ajax'] = $this->request->isAjax();
         if ($this->request->isAjax()) {
-            $template_path = EE_ADMIN_TEMPLATE . 'admin_details_wrapper_no_sidebar_ajax.template.php';
+            $template_path = EE_ADMIN_TEMPLATE.'admin_details_wrapper_no_sidebar_ajax.template.php';
         }
         $template_path = ! empty($this->_column_template_path) ? $this->_column_template_path : $template_path;
 
@@ -2824,10 +2824,10 @@ 
         // to prevent WooCommerce from blowing things up if not using CPT
         global $post_type, $post;
         $this->_template_args['post_type'] = $post_type ?? '';
-        $this->_template_args['post']  = $post ?? new WP_Post( (object) [ 'ID' => 0, 'filter' => 'raw' ] );
+        $this->_template_args['post'] = $post ?? new WP_Post((object) ['ID' => 0, 'filter' => 'raw']);
 
         $this->_template_args['post_body_content'] = EEH_Template::display_template(
-            EE_ADMIN_TEMPLATE . 'admin_details_wrapper_post_body_content.template.php',
+            EE_ADMIN_TEMPLATE.'admin_details_wrapper_post_body_content.template.php',
             $this->_template_args,
             true
         );
@@ -2859,11 +2859,11 @@ 
     public function display_admin_caf_preview_page(string $utm_campaign_source = '', bool $display_sidebar = true)
     {
         // let's generate a default preview action button if there isn't one already present.
-        $this->_labels['buttons']['buy_now']           = esc_html__(
+        $this->_labels['buttons']['buy_now'] = esc_html__(
             'Upgrade to Event Espresso 4 Right Now',
             'event_espresso'
         );
-        $buy_now_url                                   = add_query_arg(
+        $buy_now_url = add_query_arg(
             [
                 'ee_ver'       => 'ee4',
                 'utm_source'   => 'ee4_plugin_admin',
@@ -2883,8 +2883,8 @@ 
                 true
             )
             : $this->_template_args['preview_action_button'];
-        $this->_template_args['admin_page_content']    = EEH_Template::display_template(
-            EE_ADMIN_TEMPLATE . 'admin_caf_full_page_preview.template.php',
+        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
+            EE_ADMIN_TEMPLATE.'admin_caf_full_page_preview.template.php',
             $this->_template_args,
             true
         );
@@ -2942,7 +2942,7 @@ 
         // setup search attributes
         $this->_set_search_attributes();
         $this->_template_args['current_page']     = $this->_wp_page_slug;
-        $template_path                            = EE_ADMIN_TEMPLATE . 'admin_list_wrapper.template.php';
+        $template_path                            = EE_ADMIN_TEMPLATE.'admin_list_wrapper.template.php';
         $this->_template_args['table_url']        = $this->request->isAjax()
             ? add_query_arg(['noheader' => 'true', 'route' => $this->_req_action], $this->_admin_base_url)
             : add_query_arg(['route' => $this->_req_action], $this->_admin_base_url);
@@ -2950,10 +2950,10 @@ 
         $this->_template_args['current_route']    = $this->_req_action;
         $this->_template_args['list_table_class'] = get_class($this->_list_table_object);
         $ajax_sorting_callback                    = $this->_list_table_object->get_ajax_sorting_callback();
-        if (! empty($ajax_sorting_callback)) {
+        if ( ! empty($ajax_sorting_callback)) {
             $sortable_list_table_form_fields = wp_nonce_field(
-                $ajax_sorting_callback . '_nonce',
-                $ajax_sorting_callback . '_nonce',
+                $ajax_sorting_callback.'_nonce',
+                $ajax_sorting_callback.'_nonce',
                 false,
                 false
             );
@@ -2970,18 +2970,18 @@ 
 
         $hidden_form_fields = $this->_template_args['list_table_hidden_fields'] ?? '';
 
-        $nonce_ref          = $this->_req_action . '_nonce';
+        $nonce_ref          = $this->_req_action.'_nonce';
         $hidden_form_fields .= '
-            <input type="hidden" name="' . $nonce_ref . '" value="' . wp_create_nonce($nonce_ref) . '">';
+            <input type="hidden" name="' . $nonce_ref.'" value="'.wp_create_nonce($nonce_ref).'">';
 
         $this->_template_args['list_table_hidden_fields'] = $hidden_form_fields;
         // display message about search results?
-        $search                                    = $this->request->getRequestParam('s');
+        $search = $this->request->getRequestParam('s');
         $this->_template_args['before_list_table'] .= ! empty($search)
-            ? '<p class="ee-search-results">' . sprintf(
+            ? '<p class="ee-search-results">'.sprintf(
                 esc_html__('Displaying search results for the search string: %1$s', 'event_espresso'),
                 trim($search, '%')
-            ) . '</p>'
+            ).'</p>'
             : '';
         // filter before_list_table template arg
         $this->_template_args['before_list_table'] = apply_filters(
@@ -3015,7 +3015,7 @@ 
         // convert to array and filter again
         // arrays are easier to inject new items in a specific location,
         // but would not be backwards compatible, so we have to add a new filter
-        $this->_template_args['after_list_table']   = implode(
+        $this->_template_args['after_list_table'] = implode(
             " \n",
             (array) apply_filters(
                 'FHEE__EE_Admin_Page___display_admin_list_table_page__after_list_table__template_args_array',
@@ -3070,7 +3070,7 @@ 
             $this->page_slug
         );
         return EEH_Template::display_template(
-            EE_ADMIN_TEMPLATE . 'admin_details_legend.template.php',
+            EE_ADMIN_TEMPLATE.'admin_details_legend.template.php',
             $this->_template_args,
             true
         );
@@ -3193,7 +3193,7 @@ 
         if ($this->request->isAjax()) {
             $this->_template_args['admin_page_content'] = EEH_Template::display_template(
             // $template_path,
-                EE_ADMIN_TEMPLATE . 'admin_wrapper_ajax.template.php',
+                EE_ADMIN_TEMPLATE.'admin_wrapper_ajax.template.php',
                 $this->_template_args,
                 true
             );
@@ -3202,7 +3202,7 @@ 
         // load settings page wrapper template
         $template_path = $about
             ? EE_ADMIN_TEMPLATE . 'about_admin_wrapper.template.php'
-            : EE_ADMIN_TEMPLATE . 'admin_wrapper.template.php';
+            : EE_ADMIN_TEMPLATE.'admin_wrapper.template.php';
 
         EEH_Template::display_template($template_path, $this->_template_args);
     }
@@ -3286,12 +3286,12 @@ 
         $default_names = ['save', 'save_and_close'];
         $buttons       = '';
         foreach ($button_text as $key => $button) {
-            $ref     = $default_names[ $key ];
-            $name    = ! empty($actions) ? $actions[ $key ] : $ref;
-            $buttons .= '<input type="submit" class="button button--primary ' . $ref . '" '
-                        . 'value="' . $button . '" name="' . $name . '" '
-                        . 'id="' . $this->_current_view . '_' . $ref . '" />';
-            if (! $both) {
+            $ref     = $default_names[$key];
+            $name    = ! empty($actions) ? $actions[$key] : $ref;
+            $buttons .= '<input type="submit" class="button button--primary '.$ref.'" '
+                        . 'value="'.$button.'" name="'.$name.'" '
+                        . 'id="'.$this->_current_view.'_'.$ref.'" />';
+            if ( ! $both) {
                 break;
             }
         }
@@ -3332,13 +3332,13 @@ 
                 'An error occurred. No action was set for this page\'s form.',
                 'event_espresso'
             );
-            $dev_msg  = $user_msg . "\n"
+            $dev_msg = $user_msg."\n"
                         . sprintf(
                             esc_html__('The $route argument is required for the %s->%s method.', 'event_espresso'),
                             __FUNCTION__,
                             __CLASS__
                         );
-            EE_Error::add_error($user_msg . '||' . $dev_msg, __FILE__, __FUNCTION__, __LINE__);
+            EE_Error::add_error($user_msg.'||'.$dev_msg, __FILE__, __FUNCTION__, __LINE__);
         }
         // open form
         $action                                            = $this->_admin_base_url;
@@ -3346,9 +3346,9 @@ 
             <form name='form' method='post' action='$action' id='{$route}_event_form' class='ee-admin-page-form' >
             ";
         // add nonce
-        $nonce                                             =
-            wp_nonce_field($route . '_nonce', $route . '_nonce', false, false);
-        $this->_template_args['before_admin_page_content'] .= "\n\t" . $nonce;
+        $nonce =
+            wp_nonce_field($route.'_nonce', $route.'_nonce', false, false);
+        $this->_template_args['before_admin_page_content'] .= "\n\t".$nonce;
         // add REQUIRED form action
         $hidden_fields = [
             'action' => ['type' => 'hidden', 'value' => $route],
@@ -3361,7 +3361,7 @@ 
         $form_fields = $this->_generate_admin_form_fields($hidden_fields, 'array');
         // add fields to form
         foreach ((array) $form_fields as $form_field) {
-            $this->_template_args['before_admin_page_content'] .= "\n\t" . $form_field['field'];
+            $this->_template_args['before_admin_page_content'] .= "\n\t".$form_field['field'];
         }
         // close form
         $this->_template_args['after_admin_page_content'] = '</form>';
@@ -3444,10 +3444,10 @@ 
     ) {
         $notices = EE_Error::get_notices(false);
         // overwrite default success messages //BUT ONLY if overwrite not overridden
-        if (! $override_overwrite || ! empty($notices['errors'])) {
+        if ( ! $override_overwrite || ! empty($notices['errors'])) {
             EE_Error::overwrite_success();
         }
-        if (! $override_overwrite && ! empty($what) && ! empty($action_desc) && empty($notices['errors'])) {
+        if ( ! $override_overwrite && ! empty($what) && ! empty($action_desc) && empty($notices['errors'])) {
             // how many records affected ? more than one record ? or just one ?
             EE_Error::add_success(
                 sprintf(
@@ -3498,7 +3498,7 @@ 
             $redirect_url = admin_url('admin.php');
         }
         // merge any default query_args set in _default_route_query_args property
-        if (! empty($this->_default_route_query_args) && ! $this->_is_UI_request) {
+        if ( ! empty($this->_default_route_query_args) && ! $this->_is_UI_request) {
             $args_to_merge = [];
             foreach ($this->_default_route_query_args as $query_param => $query_value) {
                 // is there a wp_referer array in our _default_route_query_args property?
@@ -3510,15 +3510,15 @@ 
                         }
                         // finally we will override any arguments in the referer with
                         // what might be set on the _default_route_query_args array.
-                        if (isset($this->_default_route_query_args[ $reference ])) {
-                            $args_to_merge[ $reference ] = urlencode($this->_default_route_query_args[ $reference ]);
+                        if (isset($this->_default_route_query_args[$reference])) {
+                            $args_to_merge[$reference] = urlencode($this->_default_route_query_args[$reference]);
                         } else {
-                            $args_to_merge[ $reference ] = urlencode($value);
+                            $args_to_merge[$reference] = urlencode($value);
                         }
                     }
                     continue;
                 }
-                $args_to_merge[ $query_param ] = $query_value;
+                $args_to_merge[$query_param] = $query_value;
             }
             // now let's merge these arguments but override with what was specifically sent in to the
             // redirect.
@@ -3530,19 +3530,19 @@ 
         if (isset($query_args['action'])) {
             // manually generate wp_nonce and merge that with the query vars
             // becuz the wp_nonce_url function wrecks havoc on some vars
-            $query_args['_wpnonce'] = wp_create_nonce($query_args['action'] . '_nonce');
+            $query_args['_wpnonce'] = wp_create_nonce($query_args['action'].'_nonce');
         }
         // we're adding some hooks and filters in here for processing any things just before redirects
         // (example: an admin page has done an insert or update and we want to run something after that).
-        do_action('AHEE_redirect_' . $this->class_name . $this->_req_action, $query_args);
+        do_action('AHEE_redirect_'.$this->class_name.$this->_req_action, $query_args);
         $redirect_url = apply_filters(
-            'FHEE_redirect_' . $this->class_name . $this->_req_action,
+            'FHEE_redirect_'.$this->class_name.$this->_req_action,
             EE_Admin_Page::add_query_args_and_nonce($query_args, $redirect_url),
             $query_args
         );
         // check if we're doing ajax.  If we are then lets just return the results and js can handle how it wants.
         if ($this->request->isAjax()) {
-            $default_data                    = [
+            $default_data = [
                 'close'        => true,
                 'redirect_url' => $redirect_url,
                 'where'        => 'main',
@@ -3595,7 +3595,7 @@ 
         }
         $this->_template_args['notices'] = EE_Error::get_notices();
         // IF this isn't ajax we need to create a transient for the notices using the route (however, overridden if $sticky_notices == true)
-        if (! $this->request->isAjax() || $sticky_notices) {
+        if ( ! $this->request->isAjax() || $sticky_notices) {
             $route = $query_args['action'] ?? 'default';
             $this->_add_transient(
                 $route,
@@ -3635,7 +3635,7 @@ 
         bool $exclude_nonce = false
     ): string {
         // first let's validate the action (if $base_url is FALSE otherwise validation will happen further along)
-        if (empty($base_url) && ! isset($this->_page_routes[ $action ])) {
+        if (empty($base_url) && ! isset($this->_page_routes[$action])) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -3646,7 +3646,7 @@ 
                 )
             );
         }
-        if (! isset($this->_labels['buttons'][ $type ])) {
+        if ( ! isset($this->_labels['buttons'][$type])) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -3659,7 +3659,7 @@ 
         }
         // finally check user access for this button.
         $has_access = $this->check_user_access($action, true);
-        if (! $has_access) {
+        if ( ! $has_access) {
             return '';
         }
         $_base_url  = ! $base_url ? $this->_admin_base_url : $base_url;
@@ -3667,11 +3667,11 @@ 
             'action' => $action,
         ];
         // merge extra_request args but make sure our original action takes precedence and doesn't get overwritten.
-        if (! empty($extra_request)) {
+        if ( ! empty($extra_request)) {
             $query_args = array_merge($extra_request, $query_args);
         }
         $url = EE_Admin_Page::add_query_args_and_nonce($query_args, $_base_url, false, $exclude_nonce);
-        return EEH_Template::get_button_or_link($url, $this->_labels['buttons'][ $type ], $class);
+        return EEH_Template::get_button_or_link($url, $this->_labels['buttons'][$type], $class);
     }
 
 
@@ -3697,7 +3697,7 @@ 
                 'FHEE__EE_Admin_Page___per_page_screen_options__default',
                 20
             ),
-            'option'  => $this->_current_page . '_' . $this->_current_view . '_per_page',
+            'option'  => $this->_current_page.'_'.$this->_current_view.'_per_page',
         ];
         // ONLY add the screen option if the user has access to it.
         if ($this->check_user_access($this->_current_view, true)) {
@@ -3718,18 +3718,18 @@ 
     {
         if ($this->request->requestParamIsSet('wp_screen_options')) {
             check_admin_referer('screen-options-nonce', 'screenoptionnonce');
-            if (! $user = wp_get_current_user()) {
+            if ( ! $user = wp_get_current_user()) {
                 return;
             }
             $option = $this->request->getRequestParam('wp_screen_options[option]', '', DataType::KEY);
-            if (! $option) {
+            if ( ! $option) {
                 return;
             }
             $value      = $this->request->getRequestParam('wp_screen_options[value]', 0, DataType::INT);
             $map_option = $option;
             $option     = str_replace('-', '_', $option);
             switch ($map_option) {
-                case $this->_current_page . '_' . $this->_current_view . '_per_page':
+                case $this->_current_page.'_'.$this->_current_view.'_per_page':
                     $max_value = apply_filters(
                         'FHEE__EE_Admin_Page___set_per_page_screen_options__max_value',
                         999,
@@ -3796,7 +3796,7 @@ 
         bool $skip_route_verify = false
     ) {
         $user_id = get_current_user_id();
-        if (! $skip_route_verify) {
+        if ( ! $skip_route_verify) {
             $this->_verify_route($route);
         }
         // now let's set the string for what kind of transient we're setting
@@ -3829,8 +3829,8 @@ 
         $user_id   = get_current_user_id();
         $route     = ! $route ? $this->_req_action : $route;
         $transient = $notices
-            ? 'ee_rte_n_tx_' . $route . '_' . $user_id
-            : 'rte_tx_' . $route . '_' . $user_id;
+            ? 'ee_rte_n_tx_'.$route.'_'.$user_id
+            : 'rte_tx_'.$route.'_'.$user_id;
         $data      = is_multisite() && is_network_admin()
             ? get_site_transient($transient)
             : get_transient($transient);
@@ -4088,7 +4088,7 @@ 
      */
     protected function _next_link(string $url, string $class = 'dashicons dashicons-arrow-right'): string
     {
-        return '<a class="' . $class . '" href="' . $url . '"></a>';
+        return '<a class="'.$class.'" href="'.$url.'"></a>';
     }
 
 
@@ -4101,7 +4101,7 @@ 
      */
     protected function _previous_link(string $url, string $class = 'dashicons dashicons-arrow-left'): string
     {
-        return '<a class="' . $class . '" href="' . $url . '"></a>';
+        return '<a class="'.$class.'" href="'.$url.'"></a>';
     }
 
 
@@ -4249,13 +4249,13 @@ 
         ?callable $callback = null
     ): bool {
         $entity_ID = absint($entity_ID);
-        if (! $entity_ID) {
+        if ( ! $entity_ID) {
             $this->trashRestoreDeleteError($action, $entity_model);
         }
         $result = 0;
         try {
             $entity = $entity_model->get_one_by_ID($entity_ID);
-            if (! $entity instanceof EE_Base_Class) {
+            if ( ! $entity instanceof EE_Base_Class) {
                 throw new DomainException(
                     sprintf(
                         esc_html__(
@@ -4306,7 +4306,7 @@ 
                 )
             );
         }
-        if (! $entity_model->has_field($delete_column)) {
+        if ( ! $entity_model->has_field($delete_column)) {
             throw new DomainException(
                 sprintf(
                     esc_html__(

core/libraries/payment_methods/EE_Gateway.lib.php

Indentation +537 added lines, -537 removed lines

@@ -23,541 +23,541 @@
  */
 abstract class EE_Gateway
 {
-    /**
-     * a constant used as a possible value for $_currencies_supported to indicate
-     * that ALL currencies are supported by this gateway
-     */
-    const all_currencies_supported = 'all_currencies_supported';
-
-    /**
-     * Where values are 3-letter currency codes
-     *
-     * @var array|string
-     */
-    protected $_currencies_supported = [];
-
-    /**
-     * Whether this gateway can support SENDING a refund request (ie, initiated by
-     * admin in EE's wp-admin page)
-     *
-     * @var boolean
-     */
-    protected bool $_supports_sending_refunds = false;
-
-    /**
-     * Whether this gateway can support RECEIVING a refund request from the payment
-     * provider (ie, initiated by admin on the payment prover's website who sends an IPN to EE)
-     *
-     * @var boolean
-     */
-    protected bool $_supports_receiving_refunds = false;
-
-    /**
-     * Model for querying for existing payments
-     *
-     * @var EEMI_Payment|null
-     */
-    protected ?EEMI_Payment $_pay_model = null;
-
-    /**
-     * Model used for adding to the payments log
-     *
-     * @var EEM_Change_Log|null
-     */
-    protected ?EEM_Change_Log $_pay_log = null;
-
-    /**
-     * Used for formatting some input to gateways
-     *
-     * @var EEH_Template|null
-     */
-    protected ?EEH_Template $_template = null;
-
-    /**
-     * Concrete class that implements EEHI_Money, used by most gateways
-     *
-     * @var EEH_Money|null
-     */
-    protected ?EEH_Money $_money = null;
-
-    /**
-     * Concrete class that implements EEH_Line_Item, used for manipulating the line item tree
-     *
-     * @var EEH_Line_Item|null
-     */
-    protected ?EEH_Line_Item $_line_item = null;
-
-    protected ?GatewayDataFormatterInterface $_gateway_data_formatter = null;
-
-    protected ?FormatterInterface $_unsupported_character_remover = null;
-
-    /**
-     * The ID of the payment method using this gateway
-     *
-     * @var int
-     */
-    protected int $_ID = 0;
-
-    /**
-     * @var $_debug_mode boolean whether to send requests to teh sandbox site or not
-     */
-    protected bool $_debug_mode = false;
-
-    /**
-     * @var string $_name name to show for this payment method
-     */
-    protected string $_name = '';
-
-    /**
-     * @var string name to show for this payment method to admin-type users
-     */
-    protected string $_admin_name = '';
-
-    protected array $settings = [];
-
-
-
-
-    /**
-     * We don't want to serialize models as they often have circular structures
-     * (eg a payment model has a reference to each payment model object; and most
-     * payments have a transaction, most transactions have a payment method;
-     * most payment methods have a payment method type; most payment method types
-     * have a gateway. And if a gateway serializes its models, we start at the
-     * beginning again)
-     *
-     * @return array
-     */
-    public function __sleep()
-    {
-        $properties = get_object_vars($this);
-        unset($properties['_pay_model'], $properties['_pay_log']);
-        return array_keys($properties);
-    }
-
-
-    /**
-     * Returns whether this gateway should support SENDING refunds
-     * see $_supports_sending_refunds
-     *
-     * @return bool
-     */
-    public function supports_sending_refunds(): bool
-    {
-        return $this->_supports_sending_refunds;
-    }
-
-
-    /**
-     * Returns whether this gateway should support RECEIVING refunds
-     * see $_supports_receiving_refunds
-     *
-     * @return bool
-     */
-    public function supports_receiving_refunds(): bool
-    {
-        return $this->_supports_receiving_refunds;
-    }
-
-
-    /**
-     * Tries to refund the payment specified, taking into account the extra
-     * refund info. Note that if the gateway's _supports_sending_refunds is false,
-     * this should just throw an exception.
-     *
-     * @param EE_Payment|null $payment
-     * @param array|null      $refund_info
-     * @return EE_Payment|null
-     */
-    public function do_direct_refund(?EE_Payment $payment, ?array $refund_info = null): ?EE_Payment
-    {
-        return null;
-    }
-
-
-    /**
-     * Sets the payment method's settings so the gateway knows where to send the request
-     * etc
-     *
-     * @param array $settings_array
-     */
-    public function set_settings(array $settings_array)
-    {
-        foreach ($settings_array as $name => $value) {
-            // preface property name with underscore
-            $property_name          = strpos($name, '_') !== 0
-                ? '_' . $name
-                : $name;
-            if (property_exists($this, $property_name)) {
-                $this->{$property_name} = $value;
-            } else {
-                $this->settings[ $property_name ] = $value;
-            }
-        }
-    }
-
-
-    public function __get($property_name)
-    {
-        if (property_exists($this, $property_name)) {
-            return $this->{$property_name};
-        }
-        return $this->settings[ $property_name ] ?? null;
-    }
-
-
-    /**
-     * See this class description
-     *
-     * @param EEM_Payment $payment_model
-     */
-    public function set_payment_model(EEM_Payment $payment_model)
-    {
-        $this->_pay_model = $payment_model;
-    }
-
-
-    /**
-     * See this class description
-     *
-     * @param EEM_Change_Log $payment_log_model
-     */
-    public function set_payment_log(EEM_Change_Log $payment_log_model)
-    {
-        $this->_pay_log = $payment_log_model;
-    }
-
-
-    /**
-     * See this class description
-     *
-     * @param EEH_Template $template_helper
-     */
-    public function set_template_helper(EEH_Template $template_helper)
-    {
-        $this->_template = $template_helper;
-    }
-
-
-    /**
-     * See this class description
-     *
-     * @param EEH_Line_Item $line_item_helper
-     */
-    public function set_line_item_helper(EEH_Line_Item $line_item_helper)
-    {
-        $this->_line_item = $line_item_helper;
-    }
-
-
-    /**
-     * See this class description
-     *
-     * @param EEH_Money $money_helper
-     */
-    public function set_money_helper(EEH_Money $money_helper)
-    {
-        $this->_money = $money_helper;
-    }
-
-
-    /**
-     * Sets the gateway data formatter helper
-     *
-     * @param GatewayDataFormatterInterface|null $gateway_data_formatter
-     * @throws InvalidEntityException if it's not set properly
-     */
-    public function set_gateway_data_formatter(?GatewayDataFormatterInterface $gateway_data_formatter)
-    {
-        if (! $gateway_data_formatter instanceof GatewayDataFormatterInterface) {
-            throw new InvalidEntityException(
-                is_object($gateway_data_formatter)
-                    ? get_class($gateway_data_formatter)
-                    : esc_html__('Not an object', 'event_espresso'),
-                '\\EventEspresso\\core\\services\\payment_methods\\gateways\\GatewayDataFormatterInterface'
-            );
-        }
-        $this->_gateway_data_formatter = $gateway_data_formatter;
-    }
-
-
-    /**
-     * Gets the gateway data formatter
-     *
-     * @return GatewayDataFormatterInterface
-     * @throws InvalidEntityException if it's not set properly
-     */
-    protected function _get_gateway_formatter(): GatewayDataFormatterInterface
-    {
-        if (! $this->_gateway_data_formatter instanceof GatewayDataFormatterInterface) {
-            throw new InvalidEntityException(
-                is_object($this->_gateway_data_formatter)
-                    ? get_class($this->_gateway_data_formatter)
-                    : esc_html__('Not an object', 'event_espresso'),
-                '\\EventEspresso\\core\\services\\payment_methods\\gateways\\GatewayDataFormatterInterface'
-            );
-        }
-        return $this->_gateway_data_formatter;
-    }
-
-
-    /**
-     * Sets the helper which will remove unsupported characters for most gateways
-     *
-     * @param FormatterInterface|null $formatter
-     * @return void
-     * @throws InvalidEntityException
-     */
-    public function set_unsupported_character_remover(?FormatterInterface $formatter)
-    {
-        if (! $formatter instanceof FormatterInterface) {
-            throw new InvalidEntityException(
-                is_object($formatter)
-                    ? get_class($formatter)
-                    : esc_html__('Not an object', 'event_espresso'),
-                '\\EventEspresso\\core\\services\\formatters\\FormatterInterface'
-            );
-        }
-        $this->_unsupported_character_remover = $formatter;
-    }
-
-
-    /**
-     * Gets the helper which removes characters which gateways might not support, like emojis etc.
-     *
-     * @return FormatterInterface
-     * @throws InvalidEntityException
-     */
-    protected function _get_unsupported_character_remover(): FormatterInterface
-    {
-        if (! $this->_unsupported_character_remover instanceof FormatterInterface) {
-            throw new InvalidEntityException(
-                is_object($this->_unsupported_character_remover)
-                    ? get_class($this->_unsupported_character_remover)
-                    : esc_html__('Not an object', 'event_espresso'),
-                '\\EventEspresso\\core\\services\\formatters\\FormatterInterface'
-            );
-        }
-        return $this->_unsupported_character_remover;
-    }
-
-
-    /**
-     * @param array|string      $message
-     * @param mixed             $object_logged
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function log($message, $object_logged)
-    {
-        if ($object_logged instanceof EE_Payment) {
-            $type = 'Payment';
-            $id   = $object_logged->ID();
-        } elseif ($object_logged instanceof EE_Transaction) {
-            $type = 'Transaction';
-            $id   = $object_logged->ID();
-        } else {
-            $type = 'Payment_Method';
-            $id   = $this->_ID;
-        }
-        // only log if we're going to store it for longer than the minimum time
-        $reg_config = LoaderFactory::getLoader()->load('EE_Registration_Config');
-        if ($reg_config->gateway_log_lifespan !== '1 second') {
-            $this->_pay_log->gateway_log($message, $id, $type);
-        }
-    }
-
-
-    /**
-     * Formats the amount so it can generally be sent to gateways
-     *
-     * @param float $amount
-     * @return string
-     * @deprecated since 4.9.31 insetad use
-     *             EventEspresso\core\services\payment_methods\gateways\GatewayDataFormatter::format_currency()
-     */
-    public function format_currency(float $amount): string
-    {
-        return $this->_get_gateway_formatter()->formatCurrency($amount);
-    }
-
-
-    /**
-     * Returns either an array of all the currency codes supported,
-     * or a string indicating they are all supported (EE_gateway::all_currencies_supported)
-     *
-     * @return array|string
-     */
-    public function currencies_supported()
-    {
-        return $this->_currencies_supported;
-    }
-
-
-    /**
-     * Returns what a simple summing of items and taxes for this transaction. This
-     * can be used to determine if some more complex line items, like promotions,
-     * surcharges, or cancellations occurred (in which case we might want to forget
-     * about creating an itemized list of purchases and instead only send the total due)
-     *
-     * @param EE_Transaction $transaction
-     * @return float
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _sum_items_and_taxes(EE_Transaction $transaction)
-    {
-        $total_line_item = $transaction->total_line_item();
-        $total           = 0;
-        foreach ($total_line_item->get_items() as $item_line_item) {
-            $total += max($item_line_item->total(), 0);
-        }
-        foreach ($total_line_item->tax_descendants() as $tax_line_item) {
-            $total += max($tax_line_item->total(), 0);
-        }
-        return $total;
-    }
-
-
-    /**
-     * Determines whether we can easily itemize the transaction using only
-     * items and taxes (ie, no promotions or surcharges or cancellations needed)
-     *
-     * @param EE_Payment $payment
-     * @return boolean
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _can_easily_itemize_transaction_for(EE_Payment $payment): bool
-    {
-        return $this->_money->compare_floats(
-            $this->_sum_items_and_taxes($payment->transaction()),
-            $payment->transaction()->total()
-        )
-               && $this->_money->compare_floats(
-                   $payment->amount(),
-                   $payment->transaction()->total()
-               );
-    }
-
-
-    /**
-     * Handles updating the transaction and any other related data based on the payment.
-     * You may be tempted to do this as part of do_direct_payment or handle_payment_update,
-     * but doing so on those functions might be too early. It's possible that the changes
-     * you make to teh transaction or registration or line items may just get overwritten
-     * at that point. Instead, you should store any info you need on the payment during those
-     * functions, and use that information at this step, which client code will decide
-     * for you when it should be called.
-     *
-     * @param EE_Payment $payment
-     * @return void
-     */
-    public function update_txn_based_on_payment($payment)
-    {
-        // maybe update the transaction or line items or registrations
-        // but most gateways don't need to do this, because they only update the payment
-    }
-
-
-    /**
-     * Gets the first event for this payment (it's possible that it could be for multiple)
-     *
-     * @param EE_Payment $payment
-     * @return EE_Event|null
-     * @deprecated since 4.9.31 instead use EE_Payment::get_first_event()
-     */
-    protected function _get_first_event_for_payment(EE_Payment $payment): ?EE_Event
-    {
-        return $payment->get_first_event();
-    }
-
-
-    /**
-     * Gets the name of the first event for which is being paid
-     *
-     * @param EE_Payment $payment
-     * @return string
-     * @deprecated since 4.9.31 instead use EE_Payment::get_first_event_name()
-     */
-    protected function _get_first_event_name_for_payment(EE_Payment $payment): string
-    {
-        return $payment->get_first_event_name();
-    }
-
-
-    /**
-     * Gets the text to use for a gateway's line item name when this is a partial payment
-     *
-     * @param EE_Payment $payment
-     * @return string
-     * @deprecated since 4.9.31 instead use $this->_get_gateway_formatter()->formatPartialPaymentLineItemName($payment)
-     */
-    protected function _format_partial_payment_line_item_name(EE_Payment $payment): string
-    {
-        return $this->_get_gateway_formatter()->formatPartialPaymentLineItemName($payment);
-    }
-
-
-    /**
-     * Gets the text to use for a gateway's line item description when this is a partial payment
-     *
-     * @param EE_Payment $payment
-     * @return string
-     * @deprecated since 4.9.31 instead use $this->_get_gateway_formatter()->formatPartialPaymentLineItemDesc()
-     */
-    protected function _format_partial_payment_line_item_desc(EE_Payment $payment): string
-    {
-        return $this->_get_gateway_formatter()->formatPartialPaymentLineItemDesc($payment);
-    }
-
-
-    /**
-     * Gets the name to use for a line item when sending line items to the gateway
-     *
-     * @param EE_Line_Item $line_item
-     * @param EE_Payment   $payment
-     * @return string
-     * @deprecated since 4.9.31 instead use $this->_get_gateway_formatter()->formatLineItemName($line_item,$payment)
-     */
-    protected function _format_line_item_name(EE_Line_Item $line_item, EE_Payment $payment): string
-    {
-        return $this->_get_gateway_formatter()->formatLineItemName($line_item, $payment);
-    }
-
-
-    /**
-     * Gets the description to use for a line item when sending line items to the gateway
-     *
-     * @param EE_Line_Item $line_item
-     * @param EE_Payment   $payment
-     * @return string
-     * @deprecated since 4.9.31 instead use $this->_get_gateway_formatter()->formatLineItemDesc($line_item, $payment))
-     */
-    protected function _format_line_item_desc(EE_Line_Item $line_item, EE_Payment $payment): string
-    {
-        return $this->_get_gateway_formatter()->formatLineItemDesc($line_item, $payment);
-    }
-
-
-    /**
-     * Gets the order description that should generlly be sent to gateways
-     *
-     * @param EE_Payment $payment
-     * @return string
-     * @deprecated since 4.9.31 instead use $this->_get_gateway_formatter()->formatOrderDescription($payment)
-     */
-    protected function _format_order_description(EE_Payment $payment): string
-    {
-        return $this->_get_gateway_formatter()->formatOrderDescription($payment);
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isInSandboxMode(): bool
-    {
-        return $this->_debug_mode;
-    }
+	/**
+	 * a constant used as a possible value for $_currencies_supported to indicate
+	 * that ALL currencies are supported by this gateway
+	 */
+	const all_currencies_supported = 'all_currencies_supported';
+
+	/**
+	 * Where values are 3-letter currency codes
+	 *
+	 * @var array|string
+	 */
+	protected $_currencies_supported = [];
+
+	/**
+	 * Whether this gateway can support SENDING a refund request (ie, initiated by
+	 * admin in EE's wp-admin page)
+	 *
+	 * @var boolean
+	 */
+	protected bool $_supports_sending_refunds = false;
+
+	/**
+	 * Whether this gateway can support RECEIVING a refund request from the payment
+	 * provider (ie, initiated by admin on the payment prover's website who sends an IPN to EE)
+	 *
+	 * @var boolean
+	 */
+	protected bool $_supports_receiving_refunds = false;
+
+	/**
+	 * Model for querying for existing payments
+	 *
+	 * @var EEMI_Payment|null
+	 */
+	protected ?EEMI_Payment $_pay_model = null;
+
+	/**
+	 * Model used for adding to the payments log
+	 *
+	 * @var EEM_Change_Log|null
+	 */
+	protected ?EEM_Change_Log $_pay_log = null;
+
+	/**
+	 * Used for formatting some input to gateways
+	 *
+	 * @var EEH_Template|null
+	 */
+	protected ?EEH_Template $_template = null;
+
+	/**
+	 * Concrete class that implements EEHI_Money, used by most gateways
+	 *
+	 * @var EEH_Money|null
+	 */
+	protected ?EEH_Money $_money = null;
+
+	/**
+	 * Concrete class that implements EEH_Line_Item, used for manipulating the line item tree
+	 *
+	 * @var EEH_Line_Item|null
+	 */
+	protected ?EEH_Line_Item $_line_item = null;
+
+	protected ?GatewayDataFormatterInterface $_gateway_data_formatter = null;
+
+	protected ?FormatterInterface $_unsupported_character_remover = null;
+
+	/**
+	 * The ID of the payment method using this gateway
+	 *
+	 * @var int
+	 */
+	protected int $_ID = 0;
+
+	/**
+	 * @var $_debug_mode boolean whether to send requests to teh sandbox site or not
+	 */
+	protected bool $_debug_mode = false;
+
+	/**
+	 * @var string $_name name to show for this payment method
+	 */
+	protected string $_name = '';
+
+	/**
+	 * @var string name to show for this payment method to admin-type users
+	 */
+	protected string $_admin_name = '';
+
+	protected array $settings = [];
+
+
+
+
+	/**
+	 * We don't want to serialize models as they often have circular structures
+	 * (eg a payment model has a reference to each payment model object; and most
+	 * payments have a transaction, most transactions have a payment method;
+	 * most payment methods have a payment method type; most payment method types
+	 * have a gateway. And if a gateway serializes its models, we start at the
+	 * beginning again)
+	 *
+	 * @return array
+	 */
+	public function __sleep()
+	{
+		$properties = get_object_vars($this);
+		unset($properties['_pay_model'], $properties['_pay_log']);
+		return array_keys($properties);
+	}
+
+
+	/**
+	 * Returns whether this gateway should support SENDING refunds
+	 * see $_supports_sending_refunds
+	 *
+	 * @return bool
+	 */
+	public function supports_sending_refunds(): bool
+	{
+		return $this->_supports_sending_refunds;
+	}
+
+
+	/**
+	 * Returns whether this gateway should support RECEIVING refunds
+	 * see $_supports_receiving_refunds
+	 *
+	 * @return bool
+	 */
+	public function supports_receiving_refunds(): bool
+	{
+		return $this->_supports_receiving_refunds;
+	}
+
+
+	/**
+	 * Tries to refund the payment specified, taking into account the extra
+	 * refund info. Note that if the gateway's _supports_sending_refunds is false,
+	 * this should just throw an exception.
+	 *
+	 * @param EE_Payment|null $payment
+	 * @param array|null      $refund_info
+	 * @return EE_Payment|null
+	 */
+	public function do_direct_refund(?EE_Payment $payment, ?array $refund_info = null): ?EE_Payment
+	{
+		return null;
+	}
+
+
+	/**
+	 * Sets the payment method's settings so the gateway knows where to send the request
+	 * etc
+	 *
+	 * @param array $settings_array
+	 */
+	public function set_settings(array $settings_array)
+	{
+		foreach ($settings_array as $name => $value) {
+			// preface property name with underscore
+			$property_name          = strpos($name, '_') !== 0
+				? '_' . $name
+				: $name;
+			if (property_exists($this, $property_name)) {
+				$this->{$property_name} = $value;
+			} else {
+				$this->settings[ $property_name ] = $value;
+			}
+		}
+	}
+
+
+	public function __get($property_name)
+	{
+		if (property_exists($this, $property_name)) {
+			return $this->{$property_name};
+		}
+		return $this->settings[ $property_name ] ?? null;
+	}
+
+
+	/**
+	 * See this class description
+	 *
+	 * @param EEM_Payment $payment_model
+	 */
+	public function set_payment_model(EEM_Payment $payment_model)
+	{
+		$this->_pay_model = $payment_model;
+	}
+
+
+	/**
+	 * See this class description
+	 *
+	 * @param EEM_Change_Log $payment_log_model
+	 */
+	public function set_payment_log(EEM_Change_Log $payment_log_model)
+	{
+		$this->_pay_log = $payment_log_model;
+	}
+
+
+	/**
+	 * See this class description
+	 *
+	 * @param EEH_Template $template_helper
+	 */
+	public function set_template_helper(EEH_Template $template_helper)
+	{
+		$this->_template = $template_helper;
+	}
+
+
+	/**
+	 * See this class description
+	 *
+	 * @param EEH_Line_Item $line_item_helper
+	 */
+	public function set_line_item_helper(EEH_Line_Item $line_item_helper)
+	{
+		$this->_line_item = $line_item_helper;
+	}
+
+
+	/**
+	 * See this class description
+	 *
+	 * @param EEH_Money $money_helper
+	 */
+	public function set_money_helper(EEH_Money $money_helper)
+	{
+		$this->_money = $money_helper;
+	}
+
+
+	/**
+	 * Sets the gateway data formatter helper
+	 *
+	 * @param GatewayDataFormatterInterface|null $gateway_data_formatter
+	 * @throws InvalidEntityException if it's not set properly
+	 */
+	public function set_gateway_data_formatter(?GatewayDataFormatterInterface $gateway_data_formatter)
+	{
+		if (! $gateway_data_formatter instanceof GatewayDataFormatterInterface) {
+			throw new InvalidEntityException(
+				is_object($gateway_data_formatter)
+					? get_class($gateway_data_formatter)
+					: esc_html__('Not an object', 'event_espresso'),
+				'\\EventEspresso\\core\\services\\payment_methods\\gateways\\GatewayDataFormatterInterface'
+			);
+		}
+		$this->_gateway_data_formatter = $gateway_data_formatter;
+	}
+
+
+	/**
+	 * Gets the gateway data formatter
+	 *
+	 * @return GatewayDataFormatterInterface
+	 * @throws InvalidEntityException if it's not set properly
+	 */
+	protected function _get_gateway_formatter(): GatewayDataFormatterInterface
+	{
+		if (! $this->_gateway_data_formatter instanceof GatewayDataFormatterInterface) {
+			throw new InvalidEntityException(
+				is_object($this->_gateway_data_formatter)
+					? get_class($this->_gateway_data_formatter)
+					: esc_html__('Not an object', 'event_espresso'),
+				'\\EventEspresso\\core\\services\\payment_methods\\gateways\\GatewayDataFormatterInterface'
+			);
+		}
+		return $this->_gateway_data_formatter;
+	}
+
+
+	/**
+	 * Sets the helper which will remove unsupported characters for most gateways
+	 *
+	 * @param FormatterInterface|null $formatter
+	 * @return void
+	 * @throws InvalidEntityException
+	 */
+	public function set_unsupported_character_remover(?FormatterInterface $formatter)
+	{
+		if (! $formatter instanceof FormatterInterface) {
+			throw new InvalidEntityException(
+				is_object($formatter)
+					? get_class($formatter)
+					: esc_html__('Not an object', 'event_espresso'),
+				'\\EventEspresso\\core\\services\\formatters\\FormatterInterface'
+			);
+		}
+		$this->_unsupported_character_remover = $formatter;
+	}
+
+
+	/**
+	 * Gets the helper which removes characters which gateways might not support, like emojis etc.
+	 *
+	 * @return FormatterInterface
+	 * @throws InvalidEntityException
+	 */
+	protected function _get_unsupported_character_remover(): FormatterInterface
+	{
+		if (! $this->_unsupported_character_remover instanceof FormatterInterface) {
+			throw new InvalidEntityException(
+				is_object($this->_unsupported_character_remover)
+					? get_class($this->_unsupported_character_remover)
+					: esc_html__('Not an object', 'event_espresso'),
+				'\\EventEspresso\\core\\services\\formatters\\FormatterInterface'
+			);
+		}
+		return $this->_unsupported_character_remover;
+	}
+
+
+	/**
+	 * @param array|string      $message
+	 * @param mixed             $object_logged
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function log($message, $object_logged)
+	{
+		if ($object_logged instanceof EE_Payment) {
+			$type = 'Payment';
+			$id   = $object_logged->ID();
+		} elseif ($object_logged instanceof EE_Transaction) {
+			$type = 'Transaction';
+			$id   = $object_logged->ID();
+		} else {
+			$type = 'Payment_Method';
+			$id   = $this->_ID;
+		}
+		// only log if we're going to store it for longer than the minimum time
+		$reg_config = LoaderFactory::getLoader()->load('EE_Registration_Config');
+		if ($reg_config->gateway_log_lifespan !== '1 second') {
+			$this->_pay_log->gateway_log($message, $id, $type);
+		}
+	}
+
+
+	/**
+	 * Formats the amount so it can generally be sent to gateways
+	 *
+	 * @param float $amount
+	 * @return string
+	 * @deprecated since 4.9.31 insetad use
+	 *             EventEspresso\core\services\payment_methods\gateways\GatewayDataFormatter::format_currency()
+	 */
+	public function format_currency(float $amount): string
+	{
+		return $this->_get_gateway_formatter()->formatCurrency($amount);
+	}
+
+
+	/**
+	 * Returns either an array of all the currency codes supported,
+	 * or a string indicating they are all supported (EE_gateway::all_currencies_supported)
+	 *
+	 * @return array|string
+	 */
+	public function currencies_supported()
+	{
+		return $this->_currencies_supported;
+	}
+
+
+	/**
+	 * Returns what a simple summing of items and taxes for this transaction. This
+	 * can be used to determine if some more complex line items, like promotions,
+	 * surcharges, or cancellations occurred (in which case we might want to forget
+	 * about creating an itemized list of purchases and instead only send the total due)
+	 *
+	 * @param EE_Transaction $transaction
+	 * @return float
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _sum_items_and_taxes(EE_Transaction $transaction)
+	{
+		$total_line_item = $transaction->total_line_item();
+		$total           = 0;
+		foreach ($total_line_item->get_items() as $item_line_item) {
+			$total += max($item_line_item->total(), 0);
+		}
+		foreach ($total_line_item->tax_descendants() as $tax_line_item) {
+			$total += max($tax_line_item->total(), 0);
+		}
+		return $total;
+	}
+
+
+	/**
+	 * Determines whether we can easily itemize the transaction using only
+	 * items and taxes (ie, no promotions or surcharges or cancellations needed)
+	 *
+	 * @param EE_Payment $payment
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _can_easily_itemize_transaction_for(EE_Payment $payment): bool
+	{
+		return $this->_money->compare_floats(
+			$this->_sum_items_and_taxes($payment->transaction()),
+			$payment->transaction()->total()
+		)
+			   && $this->_money->compare_floats(
+				   $payment->amount(),
+				   $payment->transaction()->total()
+			   );
+	}
+
+
+	/**
+	 * Handles updating the transaction and any other related data based on the payment.
+	 * You may be tempted to do this as part of do_direct_payment or handle_payment_update,
+	 * but doing so on those functions might be too early. It's possible that the changes
+	 * you make to teh transaction or registration or line items may just get overwritten
+	 * at that point. Instead, you should store any info you need on the payment during those
+	 * functions, and use that information at this step, which client code will decide
+	 * for you when it should be called.
+	 *
+	 * @param EE_Payment $payment
+	 * @return void
+	 */
+	public function update_txn_based_on_payment($payment)
+	{
+		// maybe update the transaction or line items or registrations
+		// but most gateways don't need to do this, because they only update the payment
+	}
+
+
+	/**
+	 * Gets the first event for this payment (it's possible that it could be for multiple)
+	 *
+	 * @param EE_Payment $payment
+	 * @return EE_Event|null
+	 * @deprecated since 4.9.31 instead use EE_Payment::get_first_event()
+	 */
+	protected function _get_first_event_for_payment(EE_Payment $payment): ?EE_Event
+	{
+		return $payment->get_first_event();
+	}
+
+
+	/**
+	 * Gets the name of the first event for which is being paid
+	 *
+	 * @param EE_Payment $payment
+	 * @return string
+	 * @deprecated since 4.9.31 instead use EE_Payment::get_first_event_name()
+	 */
+	protected function _get_first_event_name_for_payment(EE_Payment $payment): string
+	{
+		return $payment->get_first_event_name();
+	}
+
+
+	/**
+	 * Gets the text to use for a gateway's line item name when this is a partial payment
+	 *
+	 * @param EE_Payment $payment
+	 * @return string
+	 * @deprecated since 4.9.31 instead use $this->_get_gateway_formatter()->formatPartialPaymentLineItemName($payment)
+	 */
+	protected function _format_partial_payment_line_item_name(EE_Payment $payment): string
+	{
+		return $this->_get_gateway_formatter()->formatPartialPaymentLineItemName($payment);
+	}
+
+
+	/**
+	 * Gets the text to use for a gateway's line item description when this is a partial payment
+	 *
+	 * @param EE_Payment $payment
+	 * @return string
+	 * @deprecated since 4.9.31 instead use $this->_get_gateway_formatter()->formatPartialPaymentLineItemDesc()
+	 */
+	protected function _format_partial_payment_line_item_desc(EE_Payment $payment): string
+	{
+		return $this->_get_gateway_formatter()->formatPartialPaymentLineItemDesc($payment);
+	}
+
+
+	/**
+	 * Gets the name to use for a line item when sending line items to the gateway
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param EE_Payment   $payment
+	 * @return string
+	 * @deprecated since 4.9.31 instead use $this->_get_gateway_formatter()->formatLineItemName($line_item,$payment)
+	 */
+	protected function _format_line_item_name(EE_Line_Item $line_item, EE_Payment $payment): string
+	{
+		return $this->_get_gateway_formatter()->formatLineItemName($line_item, $payment);
+	}
+
+
+	/**
+	 * Gets the description to use for a line item when sending line items to the gateway
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param EE_Payment   $payment
+	 * @return string
+	 * @deprecated since 4.9.31 instead use $this->_get_gateway_formatter()->formatLineItemDesc($line_item, $payment))
+	 */
+	protected function _format_line_item_desc(EE_Line_Item $line_item, EE_Payment $payment): string
+	{
+		return $this->_get_gateway_formatter()->formatLineItemDesc($line_item, $payment);
+	}
+
+
+	/**
+	 * Gets the order description that should generlly be sent to gateways
+	 *
+	 * @param EE_Payment $payment
+	 * @return string
+	 * @deprecated since 4.9.31 instead use $this->_get_gateway_formatter()->formatOrderDescription($payment)
+	 */
+	protected function _format_order_description(EE_Payment $payment): string
+	{
+		return $this->_get_gateway_formatter()->formatOrderDescription($payment);
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isInSandboxMode(): bool
+	{
+		return $this->_debug_mode;
+	}
 }

core/libraries/form_sections/base/EE_Form_Section_Proper.form.php

Indentation +1533 added lines, -1533 removed lines

@@ -15,1537 +15,1537 @@
  */
 class EE_Form_Section_Proper extends EE_Form_Section_Validatable
 {
-    const SUBMITTED_FORM_DATA_SSN_KEY = 'submitted_form_data';
-
-    /**
-     * Subsections
-     *
-     * @var EE_Form_Section_Validatable[]
-     */
-    protected $_subsections = array();
-
-    /**
-     * Strategy for laying out the form
-     *
-     * @var EE_Form_Section_Layout_Base
-     */
-    protected $_layout_strategy;
-
-    /**
-     * Whether or not this form has received and validated a form submission yet
-     *
-     * @var boolean
-     */
-    protected $_received_submission = false;
-
-    /**
-     * message displayed to users upon successful form submission
-     *
-     * @var string
-     */
-    protected $_form_submission_success_message = '';
-
-    /**
-     * message displayed to users upon unsuccessful form submission
-     *
-     * @var string
-     */
-    protected $_form_submission_error_message = '';
-
-    /**
-     * @var array like post / request
-     */
-    protected $cached_request_data;
-
-    /**
-     * Stores whether this form (and its sub-sections) were found to be valid or not.
-     * Starts off as null, but once the form is validated, it set to either true or false
-     * @var boolean|null
-     */
-    protected $is_valid;
-
-    /**
-     * Stores all the data that will localized for form validation
-     *
-     * @var array
-     */
-    protected static $_js_localization = array();
-
-    /**
-     * whether or not the form's localized validation JS vars have been set
-     *
-     * @type boolean
-     */
-    protected static $_scripts_localized = false;
-
-
-    /**
-     * when constructing a proper form section, calls _construct_finalize on children
-     * so that they know who their parent is, and what name they've been given.
-     *
-     * @param array[] $options_array   {
-     * @type          $subsections     EE_Form_Section_Validatable[] where keys are the section's name
-     * @type          $include         string[] numerically-indexed where values are section names to be included,
-     *                                 and in that order. This is handy if you want
-     *                                 the subsections to be ordered differently than the default, and if you override
-     *                                 which fields are shown
-     * @type          $exclude         string[] values are subsections to be excluded. This is handy if you want
-     *                                 to remove certain default subsections (note: if you specify BOTH 'include' AND
-     *                                 'exclude', the inclusions will be applied first, and the exclusions will exclude
-     *                                 items from that list of inclusions)
-     * @type          $layout_strategy EE_Form_Section_Layout_Base strategy for laying out the form
-     *                                 } @see EE_Form_Section_Validatable::__construct()
-     * @throws EE_Error
-     */
-    public function __construct($options_array = array())
-    {
-        $options_array = (array) apply_filters(
-            'FHEE__EE_Form_Section_Proper___construct__options_array',
-            $options_array,
-            $this
-        );
-        // call parent first, as it may be setting the name
-        parent::__construct($options_array);
-        // if they've included subsections in the constructor, add them now
-        if (isset($options_array['include'])) {
-            // we are going to make sure we ONLY have those subsections to include
-            // AND we are going to make sure they're in that specified order
-            $reordered_subsections = array();
-            foreach ($options_array['include'] as $input_name) {
-                if (isset($this->_subsections[ $input_name ])) {
-                    $reordered_subsections[ $input_name ] = $this->_subsections[ $input_name ];
-                }
-            }
-            $this->_subsections = $reordered_subsections;
-        }
-        if (isset($options_array['exclude'])) {
-            $exclude            = $options_array['exclude'];
-            $this->_subsections = array_diff_key($this->_subsections, array_flip($exclude));
-        }
-        if (isset($options_array['layout_strategy'])) {
-            $this->_layout_strategy = $options_array['layout_strategy'];
-        }
-        if (! $this->_layout_strategy) {
-            $this->_layout_strategy = is_admin() ? new EE_Admin_Two_Column_Layout() : new EE_Two_Column_Layout();
-        }
-        $this->_layout_strategy->_construct_finalize($this);
-        // ok so we are definitely going to want the forms JS,
-        // so enqueue it or remember to enqueue it during wp_enqueue_scripts
-        if (did_action('wp_enqueue_scripts') || did_action('admin_enqueue_scripts')) {
-            // ok so they've constructed this object after when they should have.
-            // just enqueue the generic form scripts and initialize the form immediately in the JS
-            EE_Form_Section_Proper::wp_enqueue_scripts(true);
-        } else {
-            add_action('wp_enqueue_scripts', array('EE_Form_Section_Proper', 'wp_enqueue_scripts'));
-            add_action('admin_enqueue_scripts', array('EE_Form_Section_Proper', 'wp_enqueue_scripts'));
-        }
-        add_action('wp_footer', array($this, 'ensure_scripts_localized'), 1);
-        /**
-         * Gives other plugins a chance to hook in before construct finalize is called.
-         * The form probably doesn't yet have a parent form section.
-         * Since 4.9.32, when this action was introduced, this is the best place to add a subsection onto a form,
-         * assuming you don't care what the form section's name, HTML ID, or HTML name etc are.
-         * Also see AHEE__EE_Form_Section_Proper___construct_finalize__end
-         *
-         * @since 4.9.32
-         * @param EE_Form_Section_Proper $this          before __construct is done, but all of its logic,
-         *                                              except maybe calling _construct_finalize has been done
-         * @param array                  $options_array options passed into the constructor
-         */
-        do_action(
-            'AHEE__EE_Form_Input_Base___construct__before_construct_finalize_called',
-            $this,
-            $options_array
-        );
-        if (isset($options_array['name'])) {
-            $this->_construct_finalize(null, $options_array['name']);
-        }
-    }
-
-
-    /**
-     * Finishes construction given the parent form section and this form section's name
-     *
-     * @param EE_Form_Section_Proper|null $parent_form_section
-     * @param string                 $name
-     * @throws EE_Error
-     */
-    public function _construct_finalize($parent_form_section, $name)
-    {
-        parent::_construct_finalize($parent_form_section, $name);
-        $this->_set_default_name_if_empty();
-        $this->_set_default_html_id_if_empty();
-        foreach ($this->_subsections as $subsection_name => $subsection) {
-            if ($subsection instanceof EE_Form_Section_Base) {
-                $subsection->_construct_finalize($this, $subsection_name);
-            } else {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            'Subsection "%s" is not an instanceof EE_Form_Section_Base on form "%s". It is a "%s"',
-                            'event_espresso'
-                        ),
-                        $subsection_name,
-                        get_class($this),
-                        $subsection ? get_class($subsection) : esc_html__('NULL', 'event_espresso')
-                    )
-                );
-            }
-        }
-        /**
-         * Action performed just after form has been given a name (and HTML ID etc) and is fully constructed.
-         * If you have code that should modify the form and needs it and its subsections to have a name, HTML ID
-         * (or other attributes derived from the name like the HTML label id, etc), this is where it should be done.
-         * This might only happen just before displaying the form, or just before it receives form submission data.
-         * If you need to modify the form or its subsections before _construct_finalize is called on it (and we've
-         * ensured it has a name, HTML IDs, etc
-         *
-         * @param EE_Form_Section_Proper      $this
-         * @param EE_Form_Section_Proper|null $parent_form_section
-         * @param string                      $name
-         */
-        do_action(
-            'AHEE__EE_Form_Section_Proper___construct_finalize__end',
-            $this,
-            $parent_form_section,
-            $name
-        );
-    }
-
-
-    /**
-     * Gets the layout strategy for this form section
-     *
-     * @return EE_Form_Section_Layout_Base
-     */
-    public function get_layout_strategy()
-    {
-        return $this->_layout_strategy;
-    }
-
-
-    /**
-     * Gets the HTML for a single input for this form section according
-     * to the layout strategy
-     *
-     * @param EE_Form_Input_Base $input
-     * @return string
-     */
-    public function get_html_for_input($input)
-    {
-        return $this->_layout_strategy->layout_input($input);
-    }
-
-
-    /**
-     * was_submitted - checks if form inputs are present in request data
-     * Basically an alias for form_data_present_in() (which is used by both
-     * proper form sections and form inputs)
-     *
-     * @param null $form_data
-     * @return boolean
-     * @throws EE_Error
-     */
-    public function was_submitted($form_data = null)
-    {
-        return $this->form_data_present_in($form_data);
-    }
-
-    /**
-     * Gets the cached request data; but if there is none, or $req_data was set with
-     * something different, refresh the cache, and then return it
-     * @param null $req_data
-     * @return array
-     */
-    protected function getCachedRequest($req_data = null)
-    {
-        if (
-            $this->cached_request_data === null
-            || (
-                $req_data !== null
-                && $req_data !== $this->cached_request_data
-            )
-        ) {
-            $req_data = apply_filters(
-                'FHEE__EE_Form_Section_Proper__receive_form_submission__req_data',
-                $req_data,
-                $this
-            );
-            if ($req_data === null) {
-                /** @var RequestInterface $request */
-                $request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-                $req_data = $request->requestParams();
-            }
-            $req_data = apply_filters(
-                'FHEE__EE_Form_Section_Proper__receive_form_submission__request_data',
-                $req_data,
-                $this
-            );
-            $this->cached_request_data = (array) $req_data;
-        }
-        return $this->cached_request_data;
-    }
-
-
-    /**
-     * After the form section is initially created, call this to sanitize the data in the submission
-     * which relates to this form section, validate it, and set it as properties on the form.
-     *
-     * @param array|null $req_data should usually be post data (the default).
-     *                             However, you CAN supply a different array.
-     *                             Consider using set_defaults() instead however.
-     *                             (If you rendered the form in the page using $form_x->get_html()
-     *                             the inputs will have the correct name in the request data for this function
-     *                             to find them and populate the form with them.
-     *                             If you have a flat form (with only input subsections),
-     *                             you can supply a flat array where keys
-     *                             are the form input names and values are their values)
-     * @param boolean    $validate whether or not to perform validation on this data. Default is,
-     *                             of course, to validate that data, and set errors on the invalid values.
-     *                             But if the data has already been validated
-     *                             (eg you validated the data then stored it in the DB)
-     *                             you may want to skip this step.
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function receive_form_submission($req_data = null, $validate = true)
-    {
-        $req_data = $this->getCachedRequest($req_data);
-        $this->_normalize($req_data);
-        if ($validate) {
-            $this->_validate();
-            // if it's invalid, we're going to want to re-display so remember what they submitted
-            if (! $this->is_valid()) {
-                $this->store_submitted_form_data_in_session();
-            }
-        }
-        if ($this->submission_error_message() === '' && ! $this->is_valid()) {
-            $this->set_submission_error_message();
-        }
-        do_action(
-            'AHEE__EE_Form_Section_Proper__receive_form_submission__end',
-            $req_data,
-            $this,
-            $validate
-        );
-    }
-
-
-    /**
-     * caches the originally submitted input values in the session
-     * so that they can be used to repopulate the form if it failed validation
-     *
-     * @return boolean whether or not the data was successfully stored in the session
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    protected function store_submitted_form_data_in_session()
-    {
-        $session = EE_Registry::instance()->SSN;
-        if ($session instanceof EE_Session) {
-            return EE_Registry::instance()->SSN->set_session_data(
-                [
-                    EE_Form_Section_Proper::SUBMITTED_FORM_DATA_SSN_KEY => $this->submitted_values(true),
-                ]
-            );
-        }
-        return false;
-    }
-
-
-    /**
-     * retrieves the originally submitted input values in the session
-     * so that they can be used to repopulate the form if it failed validation
-     *
-     * @return array
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    protected function get_submitted_form_data_from_session()
-    {
-        $session = EE_Registry::instance()->SSN;
-        if ($session instanceof EE_Session) {
-            return $session->get_session_data(
-                EE_Form_Section_Proper::SUBMITTED_FORM_DATA_SSN_KEY
-            );
-        }
-        return array();
-    }
-
-
-    /**
-     * flushed the originally submitted input values from the session
-     *
-     * @return boolean whether or not the data was successfully removed from the session
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    public static function flush_submitted_form_data_from_session()
-    {
-        return EE_Registry::instance()->SSN->reset_data(
-            [EE_Form_Section_Proper::SUBMITTED_FORM_DATA_SSN_KEY]
-        );
-    }
-
-
-    /**
-     * Populates this form and its subsections with data from the session.
-     * (Wrapper for EE_Form_Section_Proper::receive_form_submission, so it shows
-     * validation errors when displaying too)
-     * Returns true if the form was populated from the session, false otherwise
-     *
-     * @return boolean
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function populate_from_session()
-    {
-        $form_data_in_session = $this->get_submitted_form_data_from_session();
-        if (empty($form_data_in_session)) {
-            return false;
-        }
-        $this->receive_form_submission($form_data_in_session);
-        add_action('shutdown', array('EE_Form_Section_Proper', 'flush_submitted_form_data_from_session'));
-        if ($this->form_data_present_in($form_data_in_session)) {
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * Populates the default data for the form, given an array where keys are
-     * the input names, and values are their values (preferably normalized to be their
-     * proper PHP types, not all strings... although that should be ok too).
-     * Proper subsections are sub-arrays, the key being the subsection's name, and
-     * the value being an array formatted in teh same way
-     *
-     * @param array $default_data
-     * @throws EE_Error
-     */
-    public function populate_defaults($default_data)
-    {
-        foreach ($this->subsections(false) as $subsection_name => $subsection) {
-            if (isset($default_data[ $subsection_name ])) {
-                if ($subsection instanceof EE_Form_Input_Base) {
-                    $subsection->set_default($default_data[ $subsection_name ]);
-                } elseif ($subsection instanceof EE_Form_Section_Proper) {
-                    $subsection->populate_defaults($default_data[ $subsection_name ]);
-                }
-            }
-        }
-    }
-
-
-    /**
-     * returns true if subsection exists
-     *
-     * @param string $name
-     * @return boolean
-     */
-    public function subsection_exists($name)
-    {
-        return isset($this->_subsections[ $name ]) ? true : false;
-    }
-
-
-    /**
-     * Gets the subsection specified by its name
-     *
-     * @param string  $name
-     * @param boolean $require_construction_to_be_finalized most client code should leave this as TRUE
-     *                                                      so that the inputs will be properly configured.
-     *                                                      However, some client code may be ok
-     *                                                      with construction finalize being called later
-     *                                                      (realizing that the subsections' html names
-     *                                                      might not be set yet, etc.)
-     * @return EE_Form_Section_Base
-     * @throws EE_Error
-     */
-    public function get_subsection($name, $require_construction_to_be_finalized = true)
-    {
-        if ($require_construction_to_be_finalized) {
-            $this->ensure_construct_finalized_called();
-        }
-        return $this->subsection_exists($name) ? $this->_subsections[ $name ] : null;
-    }
-
-
-    /**
-     * Gets all the validatable subsections of this form section
-     *
-     * @return EE_Form_Section_Validatable[]
-     * @throws EE_Error
-     */
-    public function get_validatable_subsections()
-    {
-        $validatable_subsections = array();
-        foreach ($this->subsections() as $name => $obj) {
-            if ($obj instanceof EE_Form_Section_Validatable) {
-                $validatable_subsections[ $name ] = $obj;
-            }
-        }
-        return $validatable_subsections;
-    }
-
-
-    /**
-     * Gets an input by the given name. If not found, or if its not an EE_FOrm_Input_Base child,
-     * throw an EE_Error.
-     *
-     * @param string  $name
-     * @param boolean $require_construction_to_be_finalized most client code should
-     *                                                      leave this as TRUE so that the inputs will be properly
-     *                                                      configured. However, some client code may be ok with
-     *                                                      construction finalize being called later
-     *                                                      (realizing that the subsections' html names might not be
-     *                                                      set yet, etc.)
-     * @return EE_Form_Input_Base
-     * @throws EE_Error
-     */
-    public function get_input($name, $require_construction_to_be_finalized = true)
-    {
-        $subsection = $this->get_subsection(
-            $name,
-            $require_construction_to_be_finalized
-        );
-        if (! $subsection instanceof EE_Form_Input_Base) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        "Subsection '%s' is not an instanceof EE_Form_Input_Base on form '%s'. It is a '%s'",
-                        'event_espresso'
-                    ),
-                    $name,
-                    get_class($this),
-                    $subsection ? get_class($subsection) : esc_html__('NULL', 'event_espresso')
-                )
-            );
-        }
-        return $subsection;
-    }
-
-
-    /**
-     * Like get_input(), gets the proper subsection of the form given the name,
-     * otherwise throws an EE_Error
-     *
-     * @param string  $name
-     * @param boolean $require_construction_to_be_finalized most client code should
-     *                                                      leave this as TRUE so that the inputs will be properly
-     *                                                      configured. However, some client code may be ok with
-     *                                                      construction finalize being called later
-     *                                                      (realizing that the subsections' html names might not be
-     *                                                      set yet, etc.)
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     */
-    public function get_proper_subsection($name, $require_construction_to_be_finalized = true)
-    {
-        $subsection = $this->get_subsection(
-            $name,
-            $require_construction_to_be_finalized
-        );
-        if (! $subsection instanceof EE_Form_Section_Proper) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        "Subsection '%'s is not an instanceof EE_Form_Section_Proper on form '%s'",
-                        'event_espresso'
-                    ),
-                    $name,
-                    get_class($this)
-                )
-            );
-        }
-        return $subsection;
-    }
-
-
-    /**
-     * Gets the value of the specified input. Should be called after receive_form_submission()
-     * or populate_defaults() on the form, where the normalized value on the input is set.
-     *
-     * @param string $name
-     * @return mixed depending on the input's type and its normalization strategy
-     * @throws EE_Error
-     */
-    public function get_input_value($name)
-    {
-        $input = $this->get_input($name);
-        return $input->normalized_value();
-    }
-
-
-    /**
-     * Checks if this form section itself is valid, and then checks its subsections
-     *
-     * @throws EE_Error
-     * @return boolean
-     */
-    public function is_valid()
-    {
-        if ($this->is_valid === null) {
-            if (! $this->has_received_submission()) {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            'You cannot check if a form is valid before receiving the form submission using receive_form_submission',
-                            'event_espresso'
-                        )
-                    )
-                );
-            }
-            if (! parent::is_valid()) {
-                $this->is_valid = false;
-            } else {
-                // ok so no general errors to this entire form section.
-                // so let's check the subsections, but only set errors if that hasn't been done yet
-                $this->is_valid = true;
-                foreach ($this->get_validatable_subsections() as $subsection) {
-                    if (! $subsection->is_valid()) {
-                        $this->is_valid = false;
-                    }
-                }
-            }
-        }
-        return $this->is_valid;
-    }
-
-
-    /**
-     * gets the default name of this form section if none is specified
-     *
-     * @return void
-     */
-    protected function _set_default_name_if_empty()
-    {
-        if (! $this->_name) {
-            $classname    = get_class($this);
-            $default_name = str_replace('EE_', '', $classname);
-            $this->_name  = $default_name;
-        }
-    }
-
-
-    /**
-     * Returns the HTML for the form, except for the form opening and closing tags
-     * (as the form section doesn't know where you necessarily want to send the information to),
-     * and except for a submit button. Enqueues JS and CSS; if called early enough we will
-     * try to enqueue them in the header, otherwise they'll be enqueued in the footer.
-     * Not doing_it_wrong because theoretically this CAN be used properly,
-     * provided its used during "wp_enqueue_scripts", or it doesn't need to enqueue
-     * any CSS.
-     *
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function get_html_and_js()
-    {
-        $this->enqueue_js();
-        return $this->get_html();
-    }
-
-
-    /**
-     * returns HTML for displaying this form section. recursively calls display_section() on all subsections
-     *
-     * @param bool $display_previously_submitted_data
-     * @return string
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    public function get_html($display_previously_submitted_data = true)
-    {
-        $this->ensure_construct_finalized_called();
-        if ($display_previously_submitted_data) {
-            $this->populate_from_session();
-        }
-        return $this->_form_html_filter
-            ? $this->_form_html_filter->filterHtml($this->_layout_strategy->layout_form(), $this)
-            : $this->_layout_strategy->layout_form();
-    }
-
-
-    /**
-     * enqueues JS and CSS for the form.
-     * It is preferred to call this before wp_enqueue_scripts so the
-     * scripts and styles can be put in the header, but if called later
-     * they will be put in the footer (which is OK for JS, but in HTML4 CSS should
-     * only be in the header; but in HTML5 its ok in the body.
-     * See http://stackoverflow.com/questions/4957446/load-external-css-file-in-body-tag.
-     * So if your form enqueues CSS, it's preferred to call this before wp_enqueue_scripts.)
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    public function enqueue_js()
-    {
-        $this->_enqueue_and_localize_form_js();
-        foreach ($this->subsections() as $subsection) {
-            $subsection->enqueue_js();
-        }
-    }
-
-
-    /**
-     * adds a filter so that jquery validate gets enqueued in EE_System::wp_enqueue_scripts().
-     * This must be done BEFORE wp_enqueue_scripts() gets called, which is on
-     * the wp_enqueue_scripts hook.
-     * However, registering the form js and localizing it can happen when we
-     * actually output the form (which is preferred, seeing how teh form's fields
-     * could change until it's actually outputted)
-     *
-     * @param boolean $init_form_validation_automatically whether or not we want the form validation
-     *                                                    to be triggered automatically or not
-     * @return void
-     */
-    public static function wp_enqueue_scripts($init_form_validation_automatically = true)
-    {
-        wp_register_script(
-            'ee_form_section_validation',
-            EE_GLOBAL_ASSETS_URL . 'scripts' . '/form_section_validation.js',
-            array('jquery-validate', 'jquery-ui-datepicker', 'jquery-validate-extra-methods'),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_localize_script(
-            'ee_form_section_validation',
-            'ee_form_section_validation_init',
-            array('init' => $init_form_validation_automatically ? '1' : '0')
-        );
-    }
-
-
-    /**
-     * gets the variables used by form_section_validation.js.
-     * This needs to be called AFTER we've called $this->_enqueue_jquery_validate_script,
-     * but before the wordpress hook wp_loaded
-     *
-     * @throws EE_Error
-     */
-    public function _enqueue_and_localize_form_js()
-    {
-        $this->ensure_construct_finalized_called();
-        // actually, we don't want to localize just yet. There may be other forms on the page.
-        // so we need to add our form section data to a static variable accessible by all form sections
-        // and localize it just before the footer
-        $this->localize_validation_rules();
-        add_action('wp_footer', array('EE_Form_Section_Proper', 'localize_script_for_all_forms'), 2);
-        add_action('admin_footer', array('EE_Form_Section_Proper', 'localize_script_for_all_forms'));
-    }
-
-
-    /**
-     * add our form section data to a static variable accessible by all form sections
-     *
-     * @param bool $return_for_subsection
-     * @return void
-     * @throws EE_Error
-     */
-    public function localize_validation_rules($return_for_subsection = false)
-    {
-        // we only want to localize vars ONCE for the entire form,
-        // so if the form section doesn't have a parent, then it must be the top dog
-        if ($return_for_subsection || ! $this->parent_section()) {
-            EE_Form_Section_Proper::$_js_localization['form_data'][ $this->html_id() ] = array(
-                'form_section_id'  => $this->html_id(true),
-                'validation_rules' => $this->get_jquery_validation_rules(),
-                'other_data'       => $this->get_other_js_data(),
-                'errors'           => $this->subsection_validation_errors_by_html_name(),
-            );
-            EE_Form_Section_Proper::$_scripts_localized                                = true;
-        }
-    }
-
-
-    /**
-     * Gets an array of extra data that will be useful for client-side javascript.
-     * This is primarily data added by inputs and forms in addition to any
-     * scripts they might enqueue
-     *
-     * @param array $form_other_js_data
-     * @return array
-     * @throws EE_Error
-     */
-    public function get_other_js_data($form_other_js_data = array())
-    {
-        foreach ($this->subsections() as $subsection) {
-            $form_other_js_data = $subsection->get_other_js_data($form_other_js_data);
-        }
-        return $form_other_js_data;
-    }
-
-
-    /**
-     * Gets a flat array of inputs for this form section and its subsections.
-     * Keys are their form names, and values are the inputs themselves
-     *
-     * @return EE_Form_Input_Base
-     * @throws EE_Error
-     */
-    public function inputs_in_subsections()
-    {
-        $inputs = array();
-        foreach ($this->subsections() as $subsection) {
-            if ($subsection instanceof EE_Form_Input_Base) {
-                $inputs[ $subsection->html_name() ] = $subsection;
-            } elseif ($subsection instanceof EE_Form_Section_Proper) {
-                $inputs += $subsection->inputs_in_subsections();
-            }
-        }
-        return $inputs;
-    }
-
-
-    /**
-     * Gets a flat array of all the validation errors.
-     * Keys are html names (because those should be unique)
-     * and values are a string of all their validation errors
-     *
-     * @return string[]
-     * @throws EE_Error
-     */
-    public function subsection_validation_errors_by_html_name()
-    {
-        $inputs = $this->inputs();
-        $errors = array();
-        foreach ($inputs as $form_input) {
-            if ($form_input instanceof EE_Form_Input_Base && $form_input->get_validation_errors()) {
-                $errors[ $form_input->html_name() ] = $form_input->get_validation_error_string();
-            }
-        }
-        return $errors;
-    }
-
-
-    /**
-     * passes all the form data required by the JS to the JS, and enqueues the few required JS files.
-     * Should be setup by each form during the _enqueues_and_localize_form_js
-     *
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    public static function localize_script_for_all_forms()
-    {
-        // allow inputs and stuff to hook in their JS and stuff here
-        do_action('AHEE__EE_Form_Section_Proper__localize_script_for_all_forms__begin');
-        EE_Form_Section_Proper::$_js_localization['localized_error_messages'] = EE_Form_Section_Proper::_get_localized_error_messages();
-        $email_validation_level = isset(EE_Registry::instance()->CFG->registration->email_validation_level)
-            ? EE_Registry::instance()->CFG->registration->email_validation_level
-            : 'wp_default';
-        EE_Form_Section_Proper::$_js_localization['email_validation_level']   = $email_validation_level;
-        wp_enqueue_script('ee_form_section_validation');
-        wp_localize_script(
-            'ee_form_section_validation',
-            'ee_form_section_vars',
-            EE_Form_Section_Proper::$_js_localization
-        );
-    }
-
-
-    /**
-     * ensure_scripts_localized
-     *
-     * @throws EE_Error
-     */
-    public function ensure_scripts_localized()
-    {
-        if (! EE_Form_Section_Proper::$_scripts_localized) {
-            $this->_enqueue_and_localize_form_js();
-        }
-    }
-
-
-    /**
-     * Gets the hard-coded validation error messages to be used in the JS. The convention
-     * is that the key here should be the same as the custom validation rule put in the JS file
-     *
-     * @return array keys are custom validation rules, and values are internationalized strings
-     */
-    private static function _get_localized_error_messages()
-    {
-        return array(
-            'validUrl' => wp_strip_all_tags(__('This is not a valid absolute URL. Eg, http://domain.com/monkey.jpg', 'event_espresso')),
-            'regex'    => wp_strip_all_tags(__('Please check your input', 'event_espresso'))
-        );
-    }
-
-
-    /**
-     * @return array
-     */
-    public static function js_localization()
-    {
-        return self::$_js_localization;
-    }
-
-
-    /**
-     * @return void
-     */
-    public static function reset_js_localization()
-    {
-        self::$_js_localization = array();
-    }
-
-
-    /**
-     * Gets the JS to put inside the jquery validation rules for subsection of this form section.
-     * See parent function for more...
-     *
-     * @return array
-     * @throws EE_Error
-     */
-    public function get_jquery_validation_rules()
-    {
-        $jquery_validation_rules = array();
-        foreach ($this->get_validatable_subsections() as $subsection) {
-            $jquery_validation_rules = array_merge(
-                $jquery_validation_rules,
-                $subsection->get_jquery_validation_rules()
-            );
-        }
-        return $jquery_validation_rules;
-    }
-
-
-    /**
-     * Sanitizes all the data and sets the sanitized value of each field
-     *
-     * @param array $req_data
-     * @return void
-     * @throws EE_Error
-     */
-    protected function _normalize($req_data)
-    {
-        $this->_received_submission = true;
-        $this->_validation_errors   = array();
-        foreach ($this->get_validatable_subsections() as $subsection) {
-            try {
-                $subsection->_normalize($req_data);
-            } catch (EE_Validation_Error $e) {
-                $subsection->add_validation_error($e);
-            }
-        }
-    }
-
-
-    /**
-     * Performs validation on this form section and its subsections.
-     * For each subsection,
-     * calls _validate_{subsection_name} on THIS form (if the function exists)
-     * and passes it the subsection, then calls _validate on that subsection.
-     * If you need to perform validation on the form as a whole (considering multiple)
-     * you would be best to override this _validate method,
-     * calling parent::_validate() first.
-     *
-     * @throws EE_Error
-     */
-    protected function _validate()
-    {
-        // reset the cache of whether this form is valid or not- we're re-validating it now
-        $this->is_valid = null;
-        foreach ($this->get_validatable_subsections() as $subsection_name => $subsection) {
-            if (method_exists($this, '_validate_' . $subsection_name)) {
-                call_user_func_array(array($this, '_validate_' . $subsection_name), array($subsection));
-            }
-            $subsection->_validate();
-        }
-    }
-
-
-    /**
-     * Gets all the validated inputs for the form section
-     *
-     * @return array
-     * @throws EE_Error
-     */
-    public function valid_data()
-    {
-        $inputs = array();
-        foreach ($this->subsections() as $subsection_name => $subsection) {
-            if ($subsection instanceof EE_Form_Section_Proper) {
-                $inputs[ $subsection_name ] = $subsection->valid_data();
-            } elseif ($subsection instanceof EE_Form_Input_Base) {
-                $inputs[ $subsection_name ] = $subsection->normalized_value();
-            }
-        }
-        return $inputs;
-    }
-
-
-    /**
-     * Gets all the inputs on this form section
-     *
-     * @return EE_Form_Input_Base[]
-     * @throws EE_Error
-     */
-    public function inputs()
-    {
-        $inputs = array();
-        foreach ($this->subsections() as $subsection_name => $subsection) {
-            if ($subsection instanceof EE_Form_Input_Base) {
-                $inputs[ $subsection_name ] = $subsection;
-            }
-        }
-        return $inputs;
-    }
-
-
-    /**
-     * Gets all the subsections which are a proper form
-     *
-     * @return EE_Form_Section_Proper[]
-     * @throws EE_Error
-     */
-    public function subforms()
-    {
-        $form_sections = array();
-        foreach ($this->subsections() as $name => $obj) {
-            if ($obj instanceof EE_Form_Section_Proper) {
-                $form_sections[ $name ] = $obj;
-            }
-        }
-        return $form_sections;
-    }
-
-
-    /**
-     * Gets all the subsections (inputs, proper subsections, or html-only sections).
-     * Consider using inputs() or subforms()
-     * if you only want form inputs or proper form sections.
-     *
-     * @param boolean $require_construction_to_be_finalized most client code should
-     *                                                      leave this as TRUE so that the inputs will be properly
-     *                                                      configured. However, some client code may be ok with
-     *                                                      construction finalize being called later
-     *                                                      (realizing that the subsections' html names might not be
-     *                                                      set yet, etc.)
-     * @return EE_Form_Section_Proper[]
-     * @throws EE_Error
-     */
-    public function subsections($require_construction_to_be_finalized = true)
-    {
-        if ($require_construction_to_be_finalized) {
-            $this->ensure_construct_finalized_called();
-        }
-        return $this->_subsections;
-    }
-
-
-    /**
-     * Returns whether this form has any subforms or inputs
-     * @return bool
-     */
-    public function hasSubsections()
-    {
-        return ! empty($this->_subsections);
-    }
-
-
-    /**
-     * Returns a simple array where keys are input names, and values are their normalized
-     * values. (Similar to calling get_input_value on inputs)
-     *
-     * @param boolean $include_subform_inputs Whether to include inputs from subforms,
-     *                                        or just this forms' direct children inputs
-     * @param boolean $flatten                Whether to force the results into 1-dimensional array,
-     *                                        or allow multidimensional array
-     * @return array if $flatten is TRUE it will always be a 1-dimensional array
-     *                                        with array keys being input names
-     *                                        (regardless of whether they are from a subsection or not),
-     *                                        and if $flatten is FALSE it can be a multidimensional array
-     *                                        where keys are always subsection names and values are either
-     *                                        the input's normalized value, or an array like the top-level array
-     * @throws EE_Error
-     */
-    public function input_values($include_subform_inputs = false, $flatten = false)
-    {
-        return $this->_input_values(false, $include_subform_inputs, $flatten);
-    }
-
-
-    /**
-     * Similar to EE_Form_Section_Proper::input_values(), except this returns the 'display_value'
-     * of each input. On some inputs (especially radio boxes or checkboxes), the value stored
-     * is not necessarily the value we want to display to users. This creates an array
-     * where keys are the input names, and values are their display values
-     *
-     * @param boolean $include_subform_inputs Whether to include inputs from subforms,
-     *                                        or just this forms' direct children inputs
-     * @param boolean $flatten                Whether to force the results into 1-dimensional array,
-     *                                        or allow multidimensional array
-     * @return array if $flatten is TRUE it will always be a 1-dimensional array
-     *                                        with array keys being input names
-     *                                        (regardless of whether they are from a subsection or not),
-     *                                        and if $flatten is FALSE it can be a multidimensional array
-     *                                        where keys are always subsection names and values are either
-     *                                        the input's normalized value, or an array like the top-level array
-     * @throws EE_Error
-     */
-    public function input_pretty_values($include_subform_inputs = false, $flatten = false)
-    {
-        return $this->_input_values(true, $include_subform_inputs, $flatten);
-    }
-
-
-    /**
-     * Gets the input values from the form
-     *
-     * @param boolean $pretty                 Whether to retrieve the pretty value,
-     *                                        or just the normalized value
-     * @param boolean $include_subform_inputs Whether to include inputs from subforms,
-     *                                        or just this forms' direct children inputs
-     * @param boolean $flatten                Whether to force the results into 1-dimensional array,
-     *                                        or allow multidimensional array
-     * @return array if $flatten is TRUE it will always be a 1-dimensional array with array keys being
-     *                                        input names (regardless of whether they are from a subsection or not),
-     *                                        and if $flatten is FALSE it can be a multidimensional array
-     *                                        where keys are always subsection names and values are either
-     *                                        the input's normalized value, or an array like the top-level array
-     * @throws EE_Error
-     */
-    public function _input_values($pretty = false, $include_subform_inputs = false, $flatten = false)
-    {
-        $input_values = array();
-        foreach ($this->subsections() as $subsection_name => $subsection) {
-            if ($subsection instanceof EE_Form_Input_Base) {
-                $input_values[ $subsection_name ] = $pretty
-                    ? $subsection->pretty_value()
-                    : $subsection->normalized_value();
-            } elseif ($subsection instanceof EE_Form_Section_Proper && $include_subform_inputs) {
-                $subform_input_values = $subsection->_input_values(
-                    $pretty,
-                    $include_subform_inputs,
-                    $flatten
-                );
-                if ($flatten) {
-                    $input_values = array_merge($input_values, $subform_input_values);
-                } else {
-                    $input_values[ $subsection_name ] = $subform_input_values;
-                }
-            }
-        }
-        return $input_values;
-    }
-
-
-    /**
-     * Gets the originally submitted input values from the form
-     *
-     * @param boolean $include_subforms  Whether to include inputs from subforms,
-     *                                   or just this forms' direct children inputs
-     * @return array                     if $flatten is TRUE it will always be a 1-dimensional array
-     *                                   with array keys being input names
-     *                                   (regardless of whether they are from a subsection or not),
-     *                                   and if $flatten is FALSE it can be a multidimensional array
-     *                                   where keys are always subsection names and values are either
-     *                                   the input's normalized value, or an array like the top-level array
-     * @throws EE_Error
-     */
-    public function submitted_values($include_subforms = false)
-    {
-        $submitted_values = array();
-        foreach ($this->subsections() as $subsection) {
-            if ($subsection instanceof EE_Form_Input_Base) {
-                // is this input part of an array of inputs?
-                if (strpos($subsection->html_name(), '[') !== false) {
-                    $full_input_name  = EEH_Array::convert_array_values_to_keys(
-                        explode(
-                            '[',
-                            str_replace(']', '', $subsection->html_name())
-                        ),
-                        $subsection->raw_value()
-                    );
-                    $submitted_values = array_replace_recursive($submitted_values, $full_input_name);
-                } else {
-                    $submitted_values[ $subsection->html_name() ] = $subsection->raw_value();
-                }
-            } elseif ($subsection instanceof EE_Form_Section_Proper && $include_subforms) {
-                $subform_input_values = $subsection->submitted_values($include_subforms);
-                $submitted_values     = array_replace_recursive($submitted_values, $subform_input_values);
-            }
-        }
-        return $submitted_values;
-    }
-
-
-    /**
-     * Indicates whether or not this form has received a submission yet
-     * (ie, had receive_form_submission called on it yet)
-     *
-     * @return boolean
-     * @throws EE_Error
-     */
-    public function has_received_submission()
-    {
-        $this->ensure_construct_finalized_called();
-        return $this->_received_submission;
-    }
-
-
-    /**
-     * Equivalent to passing 'exclude' in the constructor's options array.
-     * Removes the listed inputs from the form
-     *
-     * @param array $inputs_to_exclude values are the input names
-     * @return void
-     */
-    public function exclude(array $inputs_to_exclude = array())
-    {
-        foreach ($inputs_to_exclude as $input_to_exclude_name) {
-            unset($this->_subsections[ $input_to_exclude_name ]);
-        }
-    }
-
-
-    /**
-     * Changes these inputs' display strategy to be EE_Hidden_Display_Strategy.
-     * @param array $inputs_to_hide
-     * @throws EE_Error
-     */
-    public function hide(array $inputs_to_hide = array())
-    {
-        foreach ($inputs_to_hide as $input_to_hide) {
-            $input = $this->get_input($input_to_hide);
-            $input->set_display_strategy(new EE_Hidden_Display_Strategy());
-        }
-    }
-
-
-    /**
-     * add_subsections
-     * Adds the listed subsections to the form section.
-     * If $subsection_name_to_target is provided,
-     * then new subsections are added before or after that subsection,
-     * otherwise to the start or end of the entire subsections array.
-     *
-     * @param EE_Form_Section_Base[] $new_subsections           array of new form subsections
-     *                                                          where keys are their names
-     * @param string                 $subsection_name_to_target an existing for section that $new_subsections
-     *                                                          should be added before or after
-     *                                                          IF $subsection_name_to_target is null,
-     *                                                          then $new_subsections will be added to
-     *                                                          the beginning or end of the entire subsections array
-     * @param boolean                $add_before                whether to add $new_subsections, before or after
-     *                                                          $subsection_name_to_target,
-     *                                                          or if $subsection_name_to_target is null,
-     *                                                          before or after entire subsections array
-     * @return void
-     * @throws EE_Error
-     */
-    public function add_subsections($new_subsections, $subsection_name_to_target = null, $add_before = true)
-    {
-        foreach ($new_subsections as $subsection_name => $subsection) {
-            if (! $subsection instanceof EE_Form_Section_Base) {
-                EE_Error::add_error(
-                    sprintf(
-                        esc_html__(
-                            "Trying to add a %s as a subsection (it was named '%s') to the form section '%s'. It was removed.",
-                            'event_espresso'
-                        ),
-                        get_class($subsection),
-                        $subsection_name,
-                        $this->name()
-                    ),
-                    __FILE__, __FUNCTION__, __LINE__
-                );
-                unset($new_subsections[ $subsection_name ]);
-            }
-        }
-        $this->_subsections = EEH_Array::insert_into_array(
-            $this->_subsections,
-            $new_subsections,
-            $subsection_name_to_target,
-            $add_before
-        );
-        if ($this->_construction_finalized) {
-            foreach ($this->_subsections as $name => $subsection) {
-                $subsection->_construct_finalize($this, $name);
-            }
-        }
-    }
-
-
-    /**
-     * @param string $subsection_name
-     * @param bool   $recursive
-     * @return bool
-     */
-    public function has_subsection($subsection_name, $recursive = false)
-    {
-        foreach ($this->_subsections as $name => $subsection) {
-            if (
-                $name === $subsection_name
-                || (
-                    $recursive
-                    && $subsection instanceof EE_Form_Section_Proper
-                    && $subsection->has_subsection($subsection_name, $recursive)
-                )
-            ) {
-                return true;
-            }
-        }
-        return false;
-    }
-
-
-
-    /**
-     * Just gets all validatable subsections to clean their sensitive data
-     *
-     * @throws EE_Error
-     */
-    public function clean_sensitive_data()
-    {
-        foreach ($this->get_validatable_subsections() as $subsection) {
-            $subsection->clean_sensitive_data();
-        }
-    }
-
-
-    /**
-     * Sets the submission error message (aka validation error message for this form section and all sub-sections)
-     * @param string                           $form_submission_error_message
-     * @param EE_Form_Section_Validatable $form_section unused
-     * @throws EE_Error
-     */
-    public function set_submission_error_message(
-        $form_submission_error_message = ''
-    ) {
-        $this->_form_submission_error_message = ! empty($form_submission_error_message)
-            ? $form_submission_error_message
-            : $this->getAllValidationErrorsString();
-    }
-
-
-    /**
-     * Returns the cached error message. A default value is set for this during _validate(),
-     * (called during receive_form_submission) but it can be explicitly set using
-     * set_submission_error_message
-     *
-     * @return string
-     */
-    public function submission_error_message()
-    {
-        return $this->_form_submission_error_message;
-    }
-
-
-    /**
-     * Sets a message to display if the data submitted to the form was valid.
-     * @param string $form_submission_success_message
-     */
-    public function set_submission_success_message($form_submission_success_message = '')
-    {
-        $this->_form_submission_success_message = ! empty($form_submission_success_message)
-            ? $form_submission_success_message
-            : esc_html__('Form submitted successfully', 'event_espresso');
-    }
-
-
-    /**
-     * Gets a message appropriate for display when the form is correctly submitted
-     * @return string
-     */
-    public function submission_success_message()
-    {
-        return $this->_form_submission_success_message;
-    }
-
-
-    /**
-     * Returns the prefix that should be used on child of this form section for
-     * their html names. If this form section itself has a parent, prepends ITS
-     * prefix onto this form section's prefix. Used primarily by
-     * EE_Form_Input_Base::_set_default_html_name_if_empty
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function html_name_prefix()
-    {
-        if ($this->parent_section() instanceof EE_Form_Section_Proper) {
-            return $this->parent_section()->html_name_prefix() . '[' . $this->name() . ']';
-        }
-        return $this->name();
-    }
-
-
-    /**
-     * Gets the name, but first checks _construct_finalize has been called. If not,
-     * calls it (assumes there is no parent and that we want the name to be whatever
-     * was set, which is probably nothing, or the classname)
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function name()
-    {
-        $this->ensure_construct_finalized_called();
-        return parent::name();
-    }
-
-
-    /**
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     */
-    public function parent_section()
-    {
-        $this->ensure_construct_finalized_called();
-        return parent::parent_section();
-    }
-
-
-    /**
-     * make sure construction finalized was called, otherwise children might not be ready
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    public function ensure_construct_finalized_called()
-    {
-        if (! $this->_construction_finalized) {
-            $this->_construct_finalize($this->_parent_section, $this->_name);
-        }
-    }
-
-
-    /**
-     * Checks if any of this form section's inputs, or any of its children's inputs,
-     * are in teh form data. If any are found, returns true. Else false
-     *
-     * @param array $req_data
-     * @return boolean
-     * @throws EE_Error
-     */
-    public function form_data_present_in($req_data = null)
-    {
-        $req_data = $this->getCachedRequest($req_data);
-        foreach ($this->subsections() as $subsection) {
-            if ($subsection instanceof EE_Form_Input_Base) {
-                if ($subsection->form_data_present_in($req_data)) {
-                    return true;
-                }
-            } elseif ($subsection instanceof EE_Form_Section_Proper) {
-                if ($subsection->form_data_present_in($req_data)) {
-                    return true;
-                }
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     * Gets validation errors for this form section and subsections
-     * Similar to EE_Form_Section_Validatable::get_validation_errors() except this
-     * gets the validation errors for ALL subsection
-     *
-     * @return EE_Validation_Error[]
-     * @throws EE_Error
-     */
-    public function get_validation_errors_accumulated()
-    {
-        $validation_errors = $this->get_validation_errors();
-        foreach ($this->get_validatable_subsections() as $subsection) {
-            if ($subsection instanceof EE_Form_Section_Proper) {
-                $validation_errors_on_this_subsection = $subsection->get_validation_errors_accumulated();
-            } else {
-                $validation_errors_on_this_subsection = $subsection->get_validation_errors();
-            }
-            if ($validation_errors_on_this_subsection) {
-                $validation_errors = array_merge($validation_errors, $validation_errors_on_this_subsection);
-            }
-        }
-        return $validation_errors;
-    }
-
-    /**
-     * Fetch validation errors from children and grandchildren and puts them in a single string.
-     * This traverses the form section tree to generate this, but you probably want to instead use
-     * get_form_submission_error_message() which is usually this message cached (or a custom validation error message)
-     *
-     * @return string
-     * @since 4.9.59.p
-     */
-    protected function getAllValidationErrorsString()
-    {
-        $submission_error_messages = array();
-        // bad, bad, bad registrant
-        foreach ($this->get_validation_errors_accumulated() as $validation_error) {
-            if ($validation_error instanceof EE_Validation_Error) {
-                $form_section = $validation_error->get_form_section();
-                if ($form_section instanceof EE_Form_Input_Base) {
-                    $label = $validation_error->get_form_section()->html_label_text();
-                } elseif ($form_section instanceof EE_Form_Section_Validatable) {
-                    $label = $validation_error->get_form_section()->name();
-                } else {
-                    $label = esc_html__('Unknown', 'event_espresso');
-                }
-                $submission_error_messages[] = sprintf(
-                    esc_html__('%s : %s', 'event_espresso'),
-                    $label,
-                    $validation_error->getMessage()
-                );
-            }
-        }
-        return implode('<br>', $submission_error_messages);
-    }
-
-
-    /**
-     * This isn't just the name of an input, it's a path pointing to an input. The
-     * path is similar to a folder path: slash (/) means to descend into a subsection,
-     * dot-dot-slash (../) means to ascend into the parent section.
-     * After a series of slashes and dot-dot-slashes, there should be the name of an input,
-     * which will be returned.
-     * Eg, if you want the related input to be conditional on a sibling input name 'foobar'
-     * just use 'foobar'. If you want it to be conditional on an aunt/uncle input name
-     * 'baz', use '../baz'. If you want it to be conditional on a cousin input,
-     * the child of 'baz_section' named 'baz_child', use '../baz_section/baz_child'.
-     * Etc
-     *
-     * @param string|false $form_section_path we accept false also because substr( '../', '../' ) = false
-     * @return EE_Form_Section_Base
-     * @throws EE_Error
-     */
-    public function find_section_from_path($form_section_path)
-    {
-        // check if we can find the input from purely going straight up the tree
-        $input = parent::find_section_from_path($form_section_path);
-        if ($input instanceof EE_Form_Section_Base) {
-            return $input;
-        }
-        $next_slash_pos = strpos($form_section_path, '/');
-        if ($next_slash_pos !== false) {
-            $child_section_name = substr($form_section_path, 0, $next_slash_pos);
-            $subpath            = substr($form_section_path, $next_slash_pos + 1);
-        } else {
-            $child_section_name = $form_section_path;
-            $subpath            = '';
-        }
-        $child_section = $this->get_subsection($child_section_name);
-        if ($child_section instanceof EE_Form_Section_Base) {
-            return $child_section->find_section_from_path($subpath);
-        }
-        return null;
-    }
+	const SUBMITTED_FORM_DATA_SSN_KEY = 'submitted_form_data';
+
+	/**
+	 * Subsections
+	 *
+	 * @var EE_Form_Section_Validatable[]
+	 */
+	protected $_subsections = array();
+
+	/**
+	 * Strategy for laying out the form
+	 *
+	 * @var EE_Form_Section_Layout_Base
+	 */
+	protected $_layout_strategy;
+
+	/**
+	 * Whether or not this form has received and validated a form submission yet
+	 *
+	 * @var boolean
+	 */
+	protected $_received_submission = false;
+
+	/**
+	 * message displayed to users upon successful form submission
+	 *
+	 * @var string
+	 */
+	protected $_form_submission_success_message = '';
+
+	/**
+	 * message displayed to users upon unsuccessful form submission
+	 *
+	 * @var string
+	 */
+	protected $_form_submission_error_message = '';
+
+	/**
+	 * @var array like post / request
+	 */
+	protected $cached_request_data;
+
+	/**
+	 * Stores whether this form (and its sub-sections) were found to be valid or not.
+	 * Starts off as null, but once the form is validated, it set to either true or false
+	 * @var boolean|null
+	 */
+	protected $is_valid;
+
+	/**
+	 * Stores all the data that will localized for form validation
+	 *
+	 * @var array
+	 */
+	protected static $_js_localization = array();
+
+	/**
+	 * whether or not the form's localized validation JS vars have been set
+	 *
+	 * @type boolean
+	 */
+	protected static $_scripts_localized = false;
+
+
+	/**
+	 * when constructing a proper form section, calls _construct_finalize on children
+	 * so that they know who their parent is, and what name they've been given.
+	 *
+	 * @param array[] $options_array   {
+	 * @type          $subsections     EE_Form_Section_Validatable[] where keys are the section's name
+	 * @type          $include         string[] numerically-indexed where values are section names to be included,
+	 *                                 and in that order. This is handy if you want
+	 *                                 the subsections to be ordered differently than the default, and if you override
+	 *                                 which fields are shown
+	 * @type          $exclude         string[] values are subsections to be excluded. This is handy if you want
+	 *                                 to remove certain default subsections (note: if you specify BOTH 'include' AND
+	 *                                 'exclude', the inclusions will be applied first, and the exclusions will exclude
+	 *                                 items from that list of inclusions)
+	 * @type          $layout_strategy EE_Form_Section_Layout_Base strategy for laying out the form
+	 *                                 } @see EE_Form_Section_Validatable::__construct()
+	 * @throws EE_Error
+	 */
+	public function __construct($options_array = array())
+	{
+		$options_array = (array) apply_filters(
+			'FHEE__EE_Form_Section_Proper___construct__options_array',
+			$options_array,
+			$this
+		);
+		// call parent first, as it may be setting the name
+		parent::__construct($options_array);
+		// if they've included subsections in the constructor, add them now
+		if (isset($options_array['include'])) {
+			// we are going to make sure we ONLY have those subsections to include
+			// AND we are going to make sure they're in that specified order
+			$reordered_subsections = array();
+			foreach ($options_array['include'] as $input_name) {
+				if (isset($this->_subsections[ $input_name ])) {
+					$reordered_subsections[ $input_name ] = $this->_subsections[ $input_name ];
+				}
+			}
+			$this->_subsections = $reordered_subsections;
+		}
+		if (isset($options_array['exclude'])) {
+			$exclude            = $options_array['exclude'];
+			$this->_subsections = array_diff_key($this->_subsections, array_flip($exclude));
+		}
+		if (isset($options_array['layout_strategy'])) {
+			$this->_layout_strategy = $options_array['layout_strategy'];
+		}
+		if (! $this->_layout_strategy) {
+			$this->_layout_strategy = is_admin() ? new EE_Admin_Two_Column_Layout() : new EE_Two_Column_Layout();
+		}
+		$this->_layout_strategy->_construct_finalize($this);
+		// ok so we are definitely going to want the forms JS,
+		// so enqueue it or remember to enqueue it during wp_enqueue_scripts
+		if (did_action('wp_enqueue_scripts') || did_action('admin_enqueue_scripts')) {
+			// ok so they've constructed this object after when they should have.
+			// just enqueue the generic form scripts and initialize the form immediately in the JS
+			EE_Form_Section_Proper::wp_enqueue_scripts(true);
+		} else {
+			add_action('wp_enqueue_scripts', array('EE_Form_Section_Proper', 'wp_enqueue_scripts'));
+			add_action('admin_enqueue_scripts', array('EE_Form_Section_Proper', 'wp_enqueue_scripts'));
+		}
+		add_action('wp_footer', array($this, 'ensure_scripts_localized'), 1);
+		/**
+		 * Gives other plugins a chance to hook in before construct finalize is called.
+		 * The form probably doesn't yet have a parent form section.
+		 * Since 4.9.32, when this action was introduced, this is the best place to add a subsection onto a form,
+		 * assuming you don't care what the form section's name, HTML ID, or HTML name etc are.
+		 * Also see AHEE__EE_Form_Section_Proper___construct_finalize__end
+		 *
+		 * @since 4.9.32
+		 * @param EE_Form_Section_Proper $this          before __construct is done, but all of its logic,
+		 *                                              except maybe calling _construct_finalize has been done
+		 * @param array                  $options_array options passed into the constructor
+		 */
+		do_action(
+			'AHEE__EE_Form_Input_Base___construct__before_construct_finalize_called',
+			$this,
+			$options_array
+		);
+		if (isset($options_array['name'])) {
+			$this->_construct_finalize(null, $options_array['name']);
+		}
+	}
+
+
+	/**
+	 * Finishes construction given the parent form section and this form section's name
+	 *
+	 * @param EE_Form_Section_Proper|null $parent_form_section
+	 * @param string                 $name
+	 * @throws EE_Error
+	 */
+	public function _construct_finalize($parent_form_section, $name)
+	{
+		parent::_construct_finalize($parent_form_section, $name);
+		$this->_set_default_name_if_empty();
+		$this->_set_default_html_id_if_empty();
+		foreach ($this->_subsections as $subsection_name => $subsection) {
+			if ($subsection instanceof EE_Form_Section_Base) {
+				$subsection->_construct_finalize($this, $subsection_name);
+			} else {
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							'Subsection "%s" is not an instanceof EE_Form_Section_Base on form "%s". It is a "%s"',
+							'event_espresso'
+						),
+						$subsection_name,
+						get_class($this),
+						$subsection ? get_class($subsection) : esc_html__('NULL', 'event_espresso')
+					)
+				);
+			}
+		}
+		/**
+		 * Action performed just after form has been given a name (and HTML ID etc) and is fully constructed.
+		 * If you have code that should modify the form and needs it and its subsections to have a name, HTML ID
+		 * (or other attributes derived from the name like the HTML label id, etc), this is where it should be done.
+		 * This might only happen just before displaying the form, or just before it receives form submission data.
+		 * If you need to modify the form or its subsections before _construct_finalize is called on it (and we've
+		 * ensured it has a name, HTML IDs, etc
+		 *
+		 * @param EE_Form_Section_Proper      $this
+		 * @param EE_Form_Section_Proper|null $parent_form_section
+		 * @param string                      $name
+		 */
+		do_action(
+			'AHEE__EE_Form_Section_Proper___construct_finalize__end',
+			$this,
+			$parent_form_section,
+			$name
+		);
+	}
+
+
+	/**
+	 * Gets the layout strategy for this form section
+	 *
+	 * @return EE_Form_Section_Layout_Base
+	 */
+	public function get_layout_strategy()
+	{
+		return $this->_layout_strategy;
+	}
+
+
+	/**
+	 * Gets the HTML for a single input for this form section according
+	 * to the layout strategy
+	 *
+	 * @param EE_Form_Input_Base $input
+	 * @return string
+	 */
+	public function get_html_for_input($input)
+	{
+		return $this->_layout_strategy->layout_input($input);
+	}
+
+
+	/**
+	 * was_submitted - checks if form inputs are present in request data
+	 * Basically an alias for form_data_present_in() (which is used by both
+	 * proper form sections and form inputs)
+	 *
+	 * @param null $form_data
+	 * @return boolean
+	 * @throws EE_Error
+	 */
+	public function was_submitted($form_data = null)
+	{
+		return $this->form_data_present_in($form_data);
+	}
+
+	/**
+	 * Gets the cached request data; but if there is none, or $req_data was set with
+	 * something different, refresh the cache, and then return it
+	 * @param null $req_data
+	 * @return array
+	 */
+	protected function getCachedRequest($req_data = null)
+	{
+		if (
+			$this->cached_request_data === null
+			|| (
+				$req_data !== null
+				&& $req_data !== $this->cached_request_data
+			)
+		) {
+			$req_data = apply_filters(
+				'FHEE__EE_Form_Section_Proper__receive_form_submission__req_data',
+				$req_data,
+				$this
+			);
+			if ($req_data === null) {
+				/** @var RequestInterface $request */
+				$request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
+				$req_data = $request->requestParams();
+			}
+			$req_data = apply_filters(
+				'FHEE__EE_Form_Section_Proper__receive_form_submission__request_data',
+				$req_data,
+				$this
+			);
+			$this->cached_request_data = (array) $req_data;
+		}
+		return $this->cached_request_data;
+	}
+
+
+	/**
+	 * After the form section is initially created, call this to sanitize the data in the submission
+	 * which relates to this form section, validate it, and set it as properties on the form.
+	 *
+	 * @param array|null $req_data should usually be post data (the default).
+	 *                             However, you CAN supply a different array.
+	 *                             Consider using set_defaults() instead however.
+	 *                             (If you rendered the form in the page using $form_x->get_html()
+	 *                             the inputs will have the correct name in the request data for this function
+	 *                             to find them and populate the form with them.
+	 *                             If you have a flat form (with only input subsections),
+	 *                             you can supply a flat array where keys
+	 *                             are the form input names and values are their values)
+	 * @param boolean    $validate whether or not to perform validation on this data. Default is,
+	 *                             of course, to validate that data, and set errors on the invalid values.
+	 *                             But if the data has already been validated
+	 *                             (eg you validated the data then stored it in the DB)
+	 *                             you may want to skip this step.
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function receive_form_submission($req_data = null, $validate = true)
+	{
+		$req_data = $this->getCachedRequest($req_data);
+		$this->_normalize($req_data);
+		if ($validate) {
+			$this->_validate();
+			// if it's invalid, we're going to want to re-display so remember what they submitted
+			if (! $this->is_valid()) {
+				$this->store_submitted_form_data_in_session();
+			}
+		}
+		if ($this->submission_error_message() === '' && ! $this->is_valid()) {
+			$this->set_submission_error_message();
+		}
+		do_action(
+			'AHEE__EE_Form_Section_Proper__receive_form_submission__end',
+			$req_data,
+			$this,
+			$validate
+		);
+	}
+
+
+	/**
+	 * caches the originally submitted input values in the session
+	 * so that they can be used to repopulate the form if it failed validation
+	 *
+	 * @return boolean whether or not the data was successfully stored in the session
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	protected function store_submitted_form_data_in_session()
+	{
+		$session = EE_Registry::instance()->SSN;
+		if ($session instanceof EE_Session) {
+			return EE_Registry::instance()->SSN->set_session_data(
+				[
+					EE_Form_Section_Proper::SUBMITTED_FORM_DATA_SSN_KEY => $this->submitted_values(true),
+				]
+			);
+		}
+		return false;
+	}
+
+
+	/**
+	 * retrieves the originally submitted input values in the session
+	 * so that they can be used to repopulate the form if it failed validation
+	 *
+	 * @return array
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	protected function get_submitted_form_data_from_session()
+	{
+		$session = EE_Registry::instance()->SSN;
+		if ($session instanceof EE_Session) {
+			return $session->get_session_data(
+				EE_Form_Section_Proper::SUBMITTED_FORM_DATA_SSN_KEY
+			);
+		}
+		return array();
+	}
+
+
+	/**
+	 * flushed the originally submitted input values from the session
+	 *
+	 * @return boolean whether or not the data was successfully removed from the session
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	public static function flush_submitted_form_data_from_session()
+	{
+		return EE_Registry::instance()->SSN->reset_data(
+			[EE_Form_Section_Proper::SUBMITTED_FORM_DATA_SSN_KEY]
+		);
+	}
+
+
+	/**
+	 * Populates this form and its subsections with data from the session.
+	 * (Wrapper for EE_Form_Section_Proper::receive_form_submission, so it shows
+	 * validation errors when displaying too)
+	 * Returns true if the form was populated from the session, false otherwise
+	 *
+	 * @return boolean
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function populate_from_session()
+	{
+		$form_data_in_session = $this->get_submitted_form_data_from_session();
+		if (empty($form_data_in_session)) {
+			return false;
+		}
+		$this->receive_form_submission($form_data_in_session);
+		add_action('shutdown', array('EE_Form_Section_Proper', 'flush_submitted_form_data_from_session'));
+		if ($this->form_data_present_in($form_data_in_session)) {
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * Populates the default data for the form, given an array where keys are
+	 * the input names, and values are their values (preferably normalized to be their
+	 * proper PHP types, not all strings... although that should be ok too).
+	 * Proper subsections are sub-arrays, the key being the subsection's name, and
+	 * the value being an array formatted in teh same way
+	 *
+	 * @param array $default_data
+	 * @throws EE_Error
+	 */
+	public function populate_defaults($default_data)
+	{
+		foreach ($this->subsections(false) as $subsection_name => $subsection) {
+			if (isset($default_data[ $subsection_name ])) {
+				if ($subsection instanceof EE_Form_Input_Base) {
+					$subsection->set_default($default_data[ $subsection_name ]);
+				} elseif ($subsection instanceof EE_Form_Section_Proper) {
+					$subsection->populate_defaults($default_data[ $subsection_name ]);
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * returns true if subsection exists
+	 *
+	 * @param string $name
+	 * @return boolean
+	 */
+	public function subsection_exists($name)
+	{
+		return isset($this->_subsections[ $name ]) ? true : false;
+	}
+
+
+	/**
+	 * Gets the subsection specified by its name
+	 *
+	 * @param string  $name
+	 * @param boolean $require_construction_to_be_finalized most client code should leave this as TRUE
+	 *                                                      so that the inputs will be properly configured.
+	 *                                                      However, some client code may be ok
+	 *                                                      with construction finalize being called later
+	 *                                                      (realizing that the subsections' html names
+	 *                                                      might not be set yet, etc.)
+	 * @return EE_Form_Section_Base
+	 * @throws EE_Error
+	 */
+	public function get_subsection($name, $require_construction_to_be_finalized = true)
+	{
+		if ($require_construction_to_be_finalized) {
+			$this->ensure_construct_finalized_called();
+		}
+		return $this->subsection_exists($name) ? $this->_subsections[ $name ] : null;
+	}
+
+
+	/**
+	 * Gets all the validatable subsections of this form section
+	 *
+	 * @return EE_Form_Section_Validatable[]
+	 * @throws EE_Error
+	 */
+	public function get_validatable_subsections()
+	{
+		$validatable_subsections = array();
+		foreach ($this->subsections() as $name => $obj) {
+			if ($obj instanceof EE_Form_Section_Validatable) {
+				$validatable_subsections[ $name ] = $obj;
+			}
+		}
+		return $validatable_subsections;
+	}
+
+
+	/**
+	 * Gets an input by the given name. If not found, or if its not an EE_FOrm_Input_Base child,
+	 * throw an EE_Error.
+	 *
+	 * @param string  $name
+	 * @param boolean $require_construction_to_be_finalized most client code should
+	 *                                                      leave this as TRUE so that the inputs will be properly
+	 *                                                      configured. However, some client code may be ok with
+	 *                                                      construction finalize being called later
+	 *                                                      (realizing that the subsections' html names might not be
+	 *                                                      set yet, etc.)
+	 * @return EE_Form_Input_Base
+	 * @throws EE_Error
+	 */
+	public function get_input($name, $require_construction_to_be_finalized = true)
+	{
+		$subsection = $this->get_subsection(
+			$name,
+			$require_construction_to_be_finalized
+		);
+		if (! $subsection instanceof EE_Form_Input_Base) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						"Subsection '%s' is not an instanceof EE_Form_Input_Base on form '%s'. It is a '%s'",
+						'event_espresso'
+					),
+					$name,
+					get_class($this),
+					$subsection ? get_class($subsection) : esc_html__('NULL', 'event_espresso')
+				)
+			);
+		}
+		return $subsection;
+	}
+
+
+	/**
+	 * Like get_input(), gets the proper subsection of the form given the name,
+	 * otherwise throws an EE_Error
+	 *
+	 * @param string  $name
+	 * @param boolean $require_construction_to_be_finalized most client code should
+	 *                                                      leave this as TRUE so that the inputs will be properly
+	 *                                                      configured. However, some client code may be ok with
+	 *                                                      construction finalize being called later
+	 *                                                      (realizing that the subsections' html names might not be
+	 *                                                      set yet, etc.)
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 */
+	public function get_proper_subsection($name, $require_construction_to_be_finalized = true)
+	{
+		$subsection = $this->get_subsection(
+			$name,
+			$require_construction_to_be_finalized
+		);
+		if (! $subsection instanceof EE_Form_Section_Proper) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						"Subsection '%'s is not an instanceof EE_Form_Section_Proper on form '%s'",
+						'event_espresso'
+					),
+					$name,
+					get_class($this)
+				)
+			);
+		}
+		return $subsection;
+	}
+
+
+	/**
+	 * Gets the value of the specified input. Should be called after receive_form_submission()
+	 * or populate_defaults() on the form, where the normalized value on the input is set.
+	 *
+	 * @param string $name
+	 * @return mixed depending on the input's type and its normalization strategy
+	 * @throws EE_Error
+	 */
+	public function get_input_value($name)
+	{
+		$input = $this->get_input($name);
+		return $input->normalized_value();
+	}
+
+
+	/**
+	 * Checks if this form section itself is valid, and then checks its subsections
+	 *
+	 * @throws EE_Error
+	 * @return boolean
+	 */
+	public function is_valid()
+	{
+		if ($this->is_valid === null) {
+			if (! $this->has_received_submission()) {
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							'You cannot check if a form is valid before receiving the form submission using receive_form_submission',
+							'event_espresso'
+						)
+					)
+				);
+			}
+			if (! parent::is_valid()) {
+				$this->is_valid = false;
+			} else {
+				// ok so no general errors to this entire form section.
+				// so let's check the subsections, but only set errors if that hasn't been done yet
+				$this->is_valid = true;
+				foreach ($this->get_validatable_subsections() as $subsection) {
+					if (! $subsection->is_valid()) {
+						$this->is_valid = false;
+					}
+				}
+			}
+		}
+		return $this->is_valid;
+	}
+
+
+	/**
+	 * gets the default name of this form section if none is specified
+	 *
+	 * @return void
+	 */
+	protected function _set_default_name_if_empty()
+	{
+		if (! $this->_name) {
+			$classname    = get_class($this);
+			$default_name = str_replace('EE_', '', $classname);
+			$this->_name  = $default_name;
+		}
+	}
+
+
+	/**
+	 * Returns the HTML for the form, except for the form opening and closing tags
+	 * (as the form section doesn't know where you necessarily want to send the information to),
+	 * and except for a submit button. Enqueues JS and CSS; if called early enough we will
+	 * try to enqueue them in the header, otherwise they'll be enqueued in the footer.
+	 * Not doing_it_wrong because theoretically this CAN be used properly,
+	 * provided its used during "wp_enqueue_scripts", or it doesn't need to enqueue
+	 * any CSS.
+	 *
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function get_html_and_js()
+	{
+		$this->enqueue_js();
+		return $this->get_html();
+	}
+
+
+	/**
+	 * returns HTML for displaying this form section. recursively calls display_section() on all subsections
+	 *
+	 * @param bool $display_previously_submitted_data
+	 * @return string
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	public function get_html($display_previously_submitted_data = true)
+	{
+		$this->ensure_construct_finalized_called();
+		if ($display_previously_submitted_data) {
+			$this->populate_from_session();
+		}
+		return $this->_form_html_filter
+			? $this->_form_html_filter->filterHtml($this->_layout_strategy->layout_form(), $this)
+			: $this->_layout_strategy->layout_form();
+	}
+
+
+	/**
+	 * enqueues JS and CSS for the form.
+	 * It is preferred to call this before wp_enqueue_scripts so the
+	 * scripts and styles can be put in the header, but if called later
+	 * they will be put in the footer (which is OK for JS, but in HTML4 CSS should
+	 * only be in the header; but in HTML5 its ok in the body.
+	 * See http://stackoverflow.com/questions/4957446/load-external-css-file-in-body-tag.
+	 * So if your form enqueues CSS, it's preferred to call this before wp_enqueue_scripts.)
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function enqueue_js()
+	{
+		$this->_enqueue_and_localize_form_js();
+		foreach ($this->subsections() as $subsection) {
+			$subsection->enqueue_js();
+		}
+	}
+
+
+	/**
+	 * adds a filter so that jquery validate gets enqueued in EE_System::wp_enqueue_scripts().
+	 * This must be done BEFORE wp_enqueue_scripts() gets called, which is on
+	 * the wp_enqueue_scripts hook.
+	 * However, registering the form js and localizing it can happen when we
+	 * actually output the form (which is preferred, seeing how teh form's fields
+	 * could change until it's actually outputted)
+	 *
+	 * @param boolean $init_form_validation_automatically whether or not we want the form validation
+	 *                                                    to be triggered automatically or not
+	 * @return void
+	 */
+	public static function wp_enqueue_scripts($init_form_validation_automatically = true)
+	{
+		wp_register_script(
+			'ee_form_section_validation',
+			EE_GLOBAL_ASSETS_URL . 'scripts' . '/form_section_validation.js',
+			array('jquery-validate', 'jquery-ui-datepicker', 'jquery-validate-extra-methods'),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_localize_script(
+			'ee_form_section_validation',
+			'ee_form_section_validation_init',
+			array('init' => $init_form_validation_automatically ? '1' : '0')
+		);
+	}
+
+
+	/**
+	 * gets the variables used by form_section_validation.js.
+	 * This needs to be called AFTER we've called $this->_enqueue_jquery_validate_script,
+	 * but before the wordpress hook wp_loaded
+	 *
+	 * @throws EE_Error
+	 */
+	public function _enqueue_and_localize_form_js()
+	{
+		$this->ensure_construct_finalized_called();
+		// actually, we don't want to localize just yet. There may be other forms on the page.
+		// so we need to add our form section data to a static variable accessible by all form sections
+		// and localize it just before the footer
+		$this->localize_validation_rules();
+		add_action('wp_footer', array('EE_Form_Section_Proper', 'localize_script_for_all_forms'), 2);
+		add_action('admin_footer', array('EE_Form_Section_Proper', 'localize_script_for_all_forms'));
+	}
+
+
+	/**
+	 * add our form section data to a static variable accessible by all form sections
+	 *
+	 * @param bool $return_for_subsection
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function localize_validation_rules($return_for_subsection = false)
+	{
+		// we only want to localize vars ONCE for the entire form,
+		// so if the form section doesn't have a parent, then it must be the top dog
+		if ($return_for_subsection || ! $this->parent_section()) {
+			EE_Form_Section_Proper::$_js_localization['form_data'][ $this->html_id() ] = array(
+				'form_section_id'  => $this->html_id(true),
+				'validation_rules' => $this->get_jquery_validation_rules(),
+				'other_data'       => $this->get_other_js_data(),
+				'errors'           => $this->subsection_validation_errors_by_html_name(),
+			);
+			EE_Form_Section_Proper::$_scripts_localized                                = true;
+		}
+	}
+
+
+	/**
+	 * Gets an array of extra data that will be useful for client-side javascript.
+	 * This is primarily data added by inputs and forms in addition to any
+	 * scripts they might enqueue
+	 *
+	 * @param array $form_other_js_data
+	 * @return array
+	 * @throws EE_Error
+	 */
+	public function get_other_js_data($form_other_js_data = array())
+	{
+		foreach ($this->subsections() as $subsection) {
+			$form_other_js_data = $subsection->get_other_js_data($form_other_js_data);
+		}
+		return $form_other_js_data;
+	}
+
+
+	/**
+	 * Gets a flat array of inputs for this form section and its subsections.
+	 * Keys are their form names, and values are the inputs themselves
+	 *
+	 * @return EE_Form_Input_Base
+	 * @throws EE_Error
+	 */
+	public function inputs_in_subsections()
+	{
+		$inputs = array();
+		foreach ($this->subsections() as $subsection) {
+			if ($subsection instanceof EE_Form_Input_Base) {
+				$inputs[ $subsection->html_name() ] = $subsection;
+			} elseif ($subsection instanceof EE_Form_Section_Proper) {
+				$inputs += $subsection->inputs_in_subsections();
+			}
+		}
+		return $inputs;
+	}
+
+
+	/**
+	 * Gets a flat array of all the validation errors.
+	 * Keys are html names (because those should be unique)
+	 * and values are a string of all their validation errors
+	 *
+	 * @return string[]
+	 * @throws EE_Error
+	 */
+	public function subsection_validation_errors_by_html_name()
+	{
+		$inputs = $this->inputs();
+		$errors = array();
+		foreach ($inputs as $form_input) {
+			if ($form_input instanceof EE_Form_Input_Base && $form_input->get_validation_errors()) {
+				$errors[ $form_input->html_name() ] = $form_input->get_validation_error_string();
+			}
+		}
+		return $errors;
+	}
+
+
+	/**
+	 * passes all the form data required by the JS to the JS, and enqueues the few required JS files.
+	 * Should be setup by each form during the _enqueues_and_localize_form_js
+	 *
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	public static function localize_script_for_all_forms()
+	{
+		// allow inputs and stuff to hook in their JS and stuff here
+		do_action('AHEE__EE_Form_Section_Proper__localize_script_for_all_forms__begin');
+		EE_Form_Section_Proper::$_js_localization['localized_error_messages'] = EE_Form_Section_Proper::_get_localized_error_messages();
+		$email_validation_level = isset(EE_Registry::instance()->CFG->registration->email_validation_level)
+			? EE_Registry::instance()->CFG->registration->email_validation_level
+			: 'wp_default';
+		EE_Form_Section_Proper::$_js_localization['email_validation_level']   = $email_validation_level;
+		wp_enqueue_script('ee_form_section_validation');
+		wp_localize_script(
+			'ee_form_section_validation',
+			'ee_form_section_vars',
+			EE_Form_Section_Proper::$_js_localization
+		);
+	}
+
+
+	/**
+	 * ensure_scripts_localized
+	 *
+	 * @throws EE_Error
+	 */
+	public function ensure_scripts_localized()
+	{
+		if (! EE_Form_Section_Proper::$_scripts_localized) {
+			$this->_enqueue_and_localize_form_js();
+		}
+	}
+
+
+	/**
+	 * Gets the hard-coded validation error messages to be used in the JS. The convention
+	 * is that the key here should be the same as the custom validation rule put in the JS file
+	 *
+	 * @return array keys are custom validation rules, and values are internationalized strings
+	 */
+	private static function _get_localized_error_messages()
+	{
+		return array(
+			'validUrl' => wp_strip_all_tags(__('This is not a valid absolute URL. Eg, http://domain.com/monkey.jpg', 'event_espresso')),
+			'regex'    => wp_strip_all_tags(__('Please check your input', 'event_espresso'))
+		);
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public static function js_localization()
+	{
+		return self::$_js_localization;
+	}
+
+
+	/**
+	 * @return void
+	 */
+	public static function reset_js_localization()
+	{
+		self::$_js_localization = array();
+	}
+
+
+	/**
+	 * Gets the JS to put inside the jquery validation rules for subsection of this form section.
+	 * See parent function for more...
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 */
+	public function get_jquery_validation_rules()
+	{
+		$jquery_validation_rules = array();
+		foreach ($this->get_validatable_subsections() as $subsection) {
+			$jquery_validation_rules = array_merge(
+				$jquery_validation_rules,
+				$subsection->get_jquery_validation_rules()
+			);
+		}
+		return $jquery_validation_rules;
+	}
+
+
+	/**
+	 * Sanitizes all the data and sets the sanitized value of each field
+	 *
+	 * @param array $req_data
+	 * @return void
+	 * @throws EE_Error
+	 */
+	protected function _normalize($req_data)
+	{
+		$this->_received_submission = true;
+		$this->_validation_errors   = array();
+		foreach ($this->get_validatable_subsections() as $subsection) {
+			try {
+				$subsection->_normalize($req_data);
+			} catch (EE_Validation_Error $e) {
+				$subsection->add_validation_error($e);
+			}
+		}
+	}
+
+
+	/**
+	 * Performs validation on this form section and its subsections.
+	 * For each subsection,
+	 * calls _validate_{subsection_name} on THIS form (if the function exists)
+	 * and passes it the subsection, then calls _validate on that subsection.
+	 * If you need to perform validation on the form as a whole (considering multiple)
+	 * you would be best to override this _validate method,
+	 * calling parent::_validate() first.
+	 *
+	 * @throws EE_Error
+	 */
+	protected function _validate()
+	{
+		// reset the cache of whether this form is valid or not- we're re-validating it now
+		$this->is_valid = null;
+		foreach ($this->get_validatable_subsections() as $subsection_name => $subsection) {
+			if (method_exists($this, '_validate_' . $subsection_name)) {
+				call_user_func_array(array($this, '_validate_' . $subsection_name), array($subsection));
+			}
+			$subsection->_validate();
+		}
+	}
+
+
+	/**
+	 * Gets all the validated inputs for the form section
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 */
+	public function valid_data()
+	{
+		$inputs = array();
+		foreach ($this->subsections() as $subsection_name => $subsection) {
+			if ($subsection instanceof EE_Form_Section_Proper) {
+				$inputs[ $subsection_name ] = $subsection->valid_data();
+			} elseif ($subsection instanceof EE_Form_Input_Base) {
+				$inputs[ $subsection_name ] = $subsection->normalized_value();
+			}
+		}
+		return $inputs;
+	}
+
+
+	/**
+	 * Gets all the inputs on this form section
+	 *
+	 * @return EE_Form_Input_Base[]
+	 * @throws EE_Error
+	 */
+	public function inputs()
+	{
+		$inputs = array();
+		foreach ($this->subsections() as $subsection_name => $subsection) {
+			if ($subsection instanceof EE_Form_Input_Base) {
+				$inputs[ $subsection_name ] = $subsection;
+			}
+		}
+		return $inputs;
+	}
+
+
+	/**
+	 * Gets all the subsections which are a proper form
+	 *
+	 * @return EE_Form_Section_Proper[]
+	 * @throws EE_Error
+	 */
+	public function subforms()
+	{
+		$form_sections = array();
+		foreach ($this->subsections() as $name => $obj) {
+			if ($obj instanceof EE_Form_Section_Proper) {
+				$form_sections[ $name ] = $obj;
+			}
+		}
+		return $form_sections;
+	}
+
+
+	/**
+	 * Gets all the subsections (inputs, proper subsections, or html-only sections).
+	 * Consider using inputs() or subforms()
+	 * if you only want form inputs or proper form sections.
+	 *
+	 * @param boolean $require_construction_to_be_finalized most client code should
+	 *                                                      leave this as TRUE so that the inputs will be properly
+	 *                                                      configured. However, some client code may be ok with
+	 *                                                      construction finalize being called later
+	 *                                                      (realizing that the subsections' html names might not be
+	 *                                                      set yet, etc.)
+	 * @return EE_Form_Section_Proper[]
+	 * @throws EE_Error
+	 */
+	public function subsections($require_construction_to_be_finalized = true)
+	{
+		if ($require_construction_to_be_finalized) {
+			$this->ensure_construct_finalized_called();
+		}
+		return $this->_subsections;
+	}
+
+
+	/**
+	 * Returns whether this form has any subforms or inputs
+	 * @return bool
+	 */
+	public function hasSubsections()
+	{
+		return ! empty($this->_subsections);
+	}
+
+
+	/**
+	 * Returns a simple array where keys are input names, and values are their normalized
+	 * values. (Similar to calling get_input_value on inputs)
+	 *
+	 * @param boolean $include_subform_inputs Whether to include inputs from subforms,
+	 *                                        or just this forms' direct children inputs
+	 * @param boolean $flatten                Whether to force the results into 1-dimensional array,
+	 *                                        or allow multidimensional array
+	 * @return array if $flatten is TRUE it will always be a 1-dimensional array
+	 *                                        with array keys being input names
+	 *                                        (regardless of whether they are from a subsection or not),
+	 *                                        and if $flatten is FALSE it can be a multidimensional array
+	 *                                        where keys are always subsection names and values are either
+	 *                                        the input's normalized value, or an array like the top-level array
+	 * @throws EE_Error
+	 */
+	public function input_values($include_subform_inputs = false, $flatten = false)
+	{
+		return $this->_input_values(false, $include_subform_inputs, $flatten);
+	}
+
+
+	/**
+	 * Similar to EE_Form_Section_Proper::input_values(), except this returns the 'display_value'
+	 * of each input. On some inputs (especially radio boxes or checkboxes), the value stored
+	 * is not necessarily the value we want to display to users. This creates an array
+	 * where keys are the input names, and values are their display values
+	 *
+	 * @param boolean $include_subform_inputs Whether to include inputs from subforms,
+	 *                                        or just this forms' direct children inputs
+	 * @param boolean $flatten                Whether to force the results into 1-dimensional array,
+	 *                                        or allow multidimensional array
+	 * @return array if $flatten is TRUE it will always be a 1-dimensional array
+	 *                                        with array keys being input names
+	 *                                        (regardless of whether they are from a subsection or not),
+	 *                                        and if $flatten is FALSE it can be a multidimensional array
+	 *                                        where keys are always subsection names and values are either
+	 *                                        the input's normalized value, or an array like the top-level array
+	 * @throws EE_Error
+	 */
+	public function input_pretty_values($include_subform_inputs = false, $flatten = false)
+	{
+		return $this->_input_values(true, $include_subform_inputs, $flatten);
+	}
+
+
+	/**
+	 * Gets the input values from the form
+	 *
+	 * @param boolean $pretty                 Whether to retrieve the pretty value,
+	 *                                        or just the normalized value
+	 * @param boolean $include_subform_inputs Whether to include inputs from subforms,
+	 *                                        or just this forms' direct children inputs
+	 * @param boolean $flatten                Whether to force the results into 1-dimensional array,
+	 *                                        or allow multidimensional array
+	 * @return array if $flatten is TRUE it will always be a 1-dimensional array with array keys being
+	 *                                        input names (regardless of whether they are from a subsection or not),
+	 *                                        and if $flatten is FALSE it can be a multidimensional array
+	 *                                        where keys are always subsection names and values are either
+	 *                                        the input's normalized value, or an array like the top-level array
+	 * @throws EE_Error
+	 */
+	public function _input_values($pretty = false, $include_subform_inputs = false, $flatten = false)
+	{
+		$input_values = array();
+		foreach ($this->subsections() as $subsection_name => $subsection) {
+			if ($subsection instanceof EE_Form_Input_Base) {
+				$input_values[ $subsection_name ] = $pretty
+					? $subsection->pretty_value()
+					: $subsection->normalized_value();
+			} elseif ($subsection instanceof EE_Form_Section_Proper && $include_subform_inputs) {
+				$subform_input_values = $subsection->_input_values(
+					$pretty,
+					$include_subform_inputs,
+					$flatten
+				);
+				if ($flatten) {
+					$input_values = array_merge($input_values, $subform_input_values);
+				} else {
+					$input_values[ $subsection_name ] = $subform_input_values;
+				}
+			}
+		}
+		return $input_values;
+	}
+
+
+	/**
+	 * Gets the originally submitted input values from the form
+	 *
+	 * @param boolean $include_subforms  Whether to include inputs from subforms,
+	 *                                   or just this forms' direct children inputs
+	 * @return array                     if $flatten is TRUE it will always be a 1-dimensional array
+	 *                                   with array keys being input names
+	 *                                   (regardless of whether they are from a subsection or not),
+	 *                                   and if $flatten is FALSE it can be a multidimensional array
+	 *                                   where keys are always subsection names and values are either
+	 *                                   the input's normalized value, or an array like the top-level array
+	 * @throws EE_Error
+	 */
+	public function submitted_values($include_subforms = false)
+	{
+		$submitted_values = array();
+		foreach ($this->subsections() as $subsection) {
+			if ($subsection instanceof EE_Form_Input_Base) {
+				// is this input part of an array of inputs?
+				if (strpos($subsection->html_name(), '[') !== false) {
+					$full_input_name  = EEH_Array::convert_array_values_to_keys(
+						explode(
+							'[',
+							str_replace(']', '', $subsection->html_name())
+						),
+						$subsection->raw_value()
+					);
+					$submitted_values = array_replace_recursive($submitted_values, $full_input_name);
+				} else {
+					$submitted_values[ $subsection->html_name() ] = $subsection->raw_value();
+				}
+			} elseif ($subsection instanceof EE_Form_Section_Proper && $include_subforms) {
+				$subform_input_values = $subsection->submitted_values($include_subforms);
+				$submitted_values     = array_replace_recursive($submitted_values, $subform_input_values);
+			}
+		}
+		return $submitted_values;
+	}
+
+
+	/**
+	 * Indicates whether or not this form has received a submission yet
+	 * (ie, had receive_form_submission called on it yet)
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 */
+	public function has_received_submission()
+	{
+		$this->ensure_construct_finalized_called();
+		return $this->_received_submission;
+	}
+
+
+	/**
+	 * Equivalent to passing 'exclude' in the constructor's options array.
+	 * Removes the listed inputs from the form
+	 *
+	 * @param array $inputs_to_exclude values are the input names
+	 * @return void
+	 */
+	public function exclude(array $inputs_to_exclude = array())
+	{
+		foreach ($inputs_to_exclude as $input_to_exclude_name) {
+			unset($this->_subsections[ $input_to_exclude_name ]);
+		}
+	}
+
+
+	/**
+	 * Changes these inputs' display strategy to be EE_Hidden_Display_Strategy.
+	 * @param array $inputs_to_hide
+	 * @throws EE_Error
+	 */
+	public function hide(array $inputs_to_hide = array())
+	{
+		foreach ($inputs_to_hide as $input_to_hide) {
+			$input = $this->get_input($input_to_hide);
+			$input->set_display_strategy(new EE_Hidden_Display_Strategy());
+		}
+	}
+
+
+	/**
+	 * add_subsections
+	 * Adds the listed subsections to the form section.
+	 * If $subsection_name_to_target is provided,
+	 * then new subsections are added before or after that subsection,
+	 * otherwise to the start or end of the entire subsections array.
+	 *
+	 * @param EE_Form_Section_Base[] $new_subsections           array of new form subsections
+	 *                                                          where keys are their names
+	 * @param string                 $subsection_name_to_target an existing for section that $new_subsections
+	 *                                                          should be added before or after
+	 *                                                          IF $subsection_name_to_target is null,
+	 *                                                          then $new_subsections will be added to
+	 *                                                          the beginning or end of the entire subsections array
+	 * @param boolean                $add_before                whether to add $new_subsections, before or after
+	 *                                                          $subsection_name_to_target,
+	 *                                                          or if $subsection_name_to_target is null,
+	 *                                                          before or after entire subsections array
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function add_subsections($new_subsections, $subsection_name_to_target = null, $add_before = true)
+	{
+		foreach ($new_subsections as $subsection_name => $subsection) {
+			if (! $subsection instanceof EE_Form_Section_Base) {
+				EE_Error::add_error(
+					sprintf(
+						esc_html__(
+							"Trying to add a %s as a subsection (it was named '%s') to the form section '%s'. It was removed.",
+							'event_espresso'
+						),
+						get_class($subsection),
+						$subsection_name,
+						$this->name()
+					),
+					__FILE__, __FUNCTION__, __LINE__
+				);
+				unset($new_subsections[ $subsection_name ]);
+			}
+		}
+		$this->_subsections = EEH_Array::insert_into_array(
+			$this->_subsections,
+			$new_subsections,
+			$subsection_name_to_target,
+			$add_before
+		);
+		if ($this->_construction_finalized) {
+			foreach ($this->_subsections as $name => $subsection) {
+				$subsection->_construct_finalize($this, $name);
+			}
+		}
+	}
+
+
+	/**
+	 * @param string $subsection_name
+	 * @param bool   $recursive
+	 * @return bool
+	 */
+	public function has_subsection($subsection_name, $recursive = false)
+	{
+		foreach ($this->_subsections as $name => $subsection) {
+			if (
+				$name === $subsection_name
+				|| (
+					$recursive
+					&& $subsection instanceof EE_Form_Section_Proper
+					&& $subsection->has_subsection($subsection_name, $recursive)
+				)
+			) {
+				return true;
+			}
+		}
+		return false;
+	}
+
+
+
+	/**
+	 * Just gets all validatable subsections to clean their sensitive data
+	 *
+	 * @throws EE_Error
+	 */
+	public function clean_sensitive_data()
+	{
+		foreach ($this->get_validatable_subsections() as $subsection) {
+			$subsection->clean_sensitive_data();
+		}
+	}
+
+
+	/**
+	 * Sets the submission error message (aka validation error message for this form section and all sub-sections)
+	 * @param string                           $form_submission_error_message
+	 * @param EE_Form_Section_Validatable $form_section unused
+	 * @throws EE_Error
+	 */
+	public function set_submission_error_message(
+		$form_submission_error_message = ''
+	) {
+		$this->_form_submission_error_message = ! empty($form_submission_error_message)
+			? $form_submission_error_message
+			: $this->getAllValidationErrorsString();
+	}
+
+
+	/**
+	 * Returns the cached error message. A default value is set for this during _validate(),
+	 * (called during receive_form_submission) but it can be explicitly set using
+	 * set_submission_error_message
+	 *
+	 * @return string
+	 */
+	public function submission_error_message()
+	{
+		return $this->_form_submission_error_message;
+	}
+
+
+	/**
+	 * Sets a message to display if the data submitted to the form was valid.
+	 * @param string $form_submission_success_message
+	 */
+	public function set_submission_success_message($form_submission_success_message = '')
+	{
+		$this->_form_submission_success_message = ! empty($form_submission_success_message)
+			? $form_submission_success_message
+			: esc_html__('Form submitted successfully', 'event_espresso');
+	}
+
+
+	/**
+	 * Gets a message appropriate for display when the form is correctly submitted
+	 * @return string
+	 */
+	public function submission_success_message()
+	{
+		return $this->_form_submission_success_message;
+	}
+
+
+	/**
+	 * Returns the prefix that should be used on child of this form section for
+	 * their html names. If this form section itself has a parent, prepends ITS
+	 * prefix onto this form section's prefix. Used primarily by
+	 * EE_Form_Input_Base::_set_default_html_name_if_empty
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function html_name_prefix()
+	{
+		if ($this->parent_section() instanceof EE_Form_Section_Proper) {
+			return $this->parent_section()->html_name_prefix() . '[' . $this->name() . ']';
+		}
+		return $this->name();
+	}
+
+
+	/**
+	 * Gets the name, but first checks _construct_finalize has been called. If not,
+	 * calls it (assumes there is no parent and that we want the name to be whatever
+	 * was set, which is probably nothing, or the classname)
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function name()
+	{
+		$this->ensure_construct_finalized_called();
+		return parent::name();
+	}
+
+
+	/**
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 */
+	public function parent_section()
+	{
+		$this->ensure_construct_finalized_called();
+		return parent::parent_section();
+	}
+
+
+	/**
+	 * make sure construction finalized was called, otherwise children might not be ready
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function ensure_construct_finalized_called()
+	{
+		if (! $this->_construction_finalized) {
+			$this->_construct_finalize($this->_parent_section, $this->_name);
+		}
+	}
+
+
+	/**
+	 * Checks if any of this form section's inputs, or any of its children's inputs,
+	 * are in teh form data. If any are found, returns true. Else false
+	 *
+	 * @param array $req_data
+	 * @return boolean
+	 * @throws EE_Error
+	 */
+	public function form_data_present_in($req_data = null)
+	{
+		$req_data = $this->getCachedRequest($req_data);
+		foreach ($this->subsections() as $subsection) {
+			if ($subsection instanceof EE_Form_Input_Base) {
+				if ($subsection->form_data_present_in($req_data)) {
+					return true;
+				}
+			} elseif ($subsection instanceof EE_Form_Section_Proper) {
+				if ($subsection->form_data_present_in($req_data)) {
+					return true;
+				}
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 * Gets validation errors for this form section and subsections
+	 * Similar to EE_Form_Section_Validatable::get_validation_errors() except this
+	 * gets the validation errors for ALL subsection
+	 *
+	 * @return EE_Validation_Error[]
+	 * @throws EE_Error
+	 */
+	public function get_validation_errors_accumulated()
+	{
+		$validation_errors = $this->get_validation_errors();
+		foreach ($this->get_validatable_subsections() as $subsection) {
+			if ($subsection instanceof EE_Form_Section_Proper) {
+				$validation_errors_on_this_subsection = $subsection->get_validation_errors_accumulated();
+			} else {
+				$validation_errors_on_this_subsection = $subsection->get_validation_errors();
+			}
+			if ($validation_errors_on_this_subsection) {
+				$validation_errors = array_merge($validation_errors, $validation_errors_on_this_subsection);
+			}
+		}
+		return $validation_errors;
+	}
+
+	/**
+	 * Fetch validation errors from children and grandchildren and puts them in a single string.
+	 * This traverses the form section tree to generate this, but you probably want to instead use
+	 * get_form_submission_error_message() which is usually this message cached (or a custom validation error message)
+	 *
+	 * @return string
+	 * @since 4.9.59.p
+	 */
+	protected function getAllValidationErrorsString()
+	{
+		$submission_error_messages = array();
+		// bad, bad, bad registrant
+		foreach ($this->get_validation_errors_accumulated() as $validation_error) {
+			if ($validation_error instanceof EE_Validation_Error) {
+				$form_section = $validation_error->get_form_section();
+				if ($form_section instanceof EE_Form_Input_Base) {
+					$label = $validation_error->get_form_section()->html_label_text();
+				} elseif ($form_section instanceof EE_Form_Section_Validatable) {
+					$label = $validation_error->get_form_section()->name();
+				} else {
+					$label = esc_html__('Unknown', 'event_espresso');
+				}
+				$submission_error_messages[] = sprintf(
+					esc_html__('%s : %s', 'event_espresso'),
+					$label,
+					$validation_error->getMessage()
+				);
+			}
+		}
+		return implode('<br>', $submission_error_messages);
+	}
+
+
+	/**
+	 * This isn't just the name of an input, it's a path pointing to an input. The
+	 * path is similar to a folder path: slash (/) means to descend into a subsection,
+	 * dot-dot-slash (../) means to ascend into the parent section.
+	 * After a series of slashes and dot-dot-slashes, there should be the name of an input,
+	 * which will be returned.
+	 * Eg, if you want the related input to be conditional on a sibling input name 'foobar'
+	 * just use 'foobar'. If you want it to be conditional on an aunt/uncle input name
+	 * 'baz', use '../baz'. If you want it to be conditional on a cousin input,
+	 * the child of 'baz_section' named 'baz_child', use '../baz_section/baz_child'.
+	 * Etc
+	 *
+	 * @param string|false $form_section_path we accept false also because substr( '../', '../' ) = false
+	 * @return EE_Form_Section_Base
+	 * @throws EE_Error
+	 */
+	public function find_section_from_path($form_section_path)
+	{
+		// check if we can find the input from purely going straight up the tree
+		$input = parent::find_section_from_path($form_section_path);
+		if ($input instanceof EE_Form_Section_Base) {
+			return $input;
+		}
+		$next_slash_pos = strpos($form_section_path, '/');
+		if ($next_slash_pos !== false) {
+			$child_section_name = substr($form_section_path, 0, $next_slash_pos);
+			$subpath            = substr($form_section_path, $next_slash_pos + 1);
+		} else {
+			$child_section_name = $form_section_path;
+			$subpath            = '';
+		}
+		$child_section = $this->get_subsection($child_section_name);
+		if ($child_section instanceof EE_Form_Section_Base) {
+			return $child_section->find_section_from_path($subpath);
+		}
+		return null;
+	}
 }