eventespresso / event-espresso-core

core/data_migration_scripts/4_10_0_stages/EE_DMS_4_10_0_Event_Question_Group.dmsstage.php

Spacing +6 added lines, -6 removed lines

@@ -21,7 +21,7 @@ 
     {
         global $wpdb;
         $this->_pretty_name = esc_html__('Event-Question Group Relations', 'event_espresso');
-        $this->_old_table = $wpdb->prefix . 'esp_event_question_group';
+        $this->_old_table = $wpdb->prefix.'esp_event_question_group';
         $this->_extra_where_sql = "WHERE EQG_primary = 0 AND EQG_additional=0";
         parent::__construct();
     }
@@ -44,7 +44,7 @@ 
             // in order to avoid locking the table for too long.
             $ids_to_update = $wpdb->get_col(
                 $wpdb->prepare(
-                    'SELECT EQG_ID FROM ' . $this->_old_table . ' WHERE EQG_primary=1 AND EVT_ID=%d AND QSG_ID=%d',
+                    'SELECT EQG_ID FROM '.$this->_old_table.' WHERE EQG_primary=1 AND EVT_ID=%d AND QSG_ID=%d',
                     $event_question_group['EVT_ID'],
                     $event_question_group['QSG_ID']
                 )
@@ -56,7 +56,7 @@ 
                     . $this->_old_table
                     . ' SET EQG_additional=1 WHERE EQG_ID IN ('
                     . implode(',', array_map('intval', $ids_to_update))
-                    . ') LIMIT ' . count($ids_to_update)
+                    . ') LIMIT '.count($ids_to_update)
                 );
             }
             if ($success) {
@@ -69,7 +69,7 @@ 
                     ],
                     ['%d']
                 );
-                if (!$successful_delete) {
+                if ( ! $successful_delete) {
                     $this->add_error(
                         sprintf(
                             esc_html__('Could not delete old event-question group relation row "%1$s" because "%2$s"', 'event_espresso'),
@@ -96,7 +96,7 @@ 
                         . $this->_old_table
                         . ' SET EQG_additional=1 WHERE EQG_ID IN ('
                         . implode(',', array_map('intval', $ids_to_update2))
-                        . ') LIMIT ' . count($ids_to_update2)
+                        . ') LIMIT '.count($ids_to_update2)
                     );
                 }
             }
@@ -115,7 +115,7 @@ 
     protected function _get_rows($limit)
     {
         global $wpdb;
-        $query = "SELECT * FROM {$this->_old_table} {$this->_extra_where_sql} " . $wpdb->prepare(
+        $query = "SELECT * FROM {$this->_old_table} {$this->_extra_where_sql} ".$wpdb->prepare(
             "LIMIT %d",
             $limit
         );

Indentation +130 added lines, -130 removed lines

@@ -11,138 +11,138 @@
  */
 class EE_DMS_4_10_0_Event_Question_Group extends EE_Data_Migration_Script_Stage_Table
 {
-    /**
-     * Just initializes the status of the migration
-     */
-    public function __construct()
-    {
-        global $wpdb;
-        $this->_pretty_name = esc_html__('Event-Question Group Relations', 'event_espresso');
-        $this->_old_table = $wpdb->prefix . 'esp_event_question_group';
-        $this->_extra_where_sql = "WHERE EQG_primary = 0 AND EQG_additional=0";
-        parent::__construct();
-    }
+	/**
+	 * Just initializes the status of the migration
+	 */
+	public function __construct()
+	{
+		global $wpdb;
+		$this->_pretty_name = esc_html__('Event-Question Group Relations', 'event_espresso');
+		$this->_old_table = $wpdb->prefix . 'esp_event_question_group';
+		$this->_extra_where_sql = "WHERE EQG_primary = 0 AND EQG_additional=0";
+		parent::__construct();
+	}
 
 
-    /**
-     * Removes the duplicate event_question_group rows that only had EQG_primary=0. Now we just have one row
-     * joining event-to-question-groups with two columns: EQG_primary and EQG_additional, indicating which question
-     * groups apply to which category of registrant.
-     * @param array $event_question_group an associative array where keys are column names and values are their values.
-     * @return null
-     */
-    protected function _migrate_old_row($event_question_group)
-    {
-        if (isset($event_question_group['EVT_ID'], $event_question_group['QSG_ID'])) {
-            global $wpdb;
-            // If the question group was also for primary attendees, we should just update that row.
-            // And we delete this row.
-            // Updating all the rows could be slow on massive DBs, so do the slow selection first, then a quick update
-            // in order to avoid locking the table for too long.
-            $ids_to_update = $wpdb->get_col(
-                $wpdb->prepare(
-                    'SELECT EQG_ID FROM ' . $this->_old_table . ' WHERE EQG_primary=1 AND EVT_ID=%d AND QSG_ID=%d',
-                    $event_question_group['EVT_ID'],
-                    $event_question_group['QSG_ID']
-                )
-            );
-            $success = false;
-            if ($ids_to_update) {
-                $success = $wpdb->query(
-                    'UPDATE '
-                    . $this->_old_table
-                    . ' SET EQG_additional=1 WHERE EQG_ID IN ('
-                    . implode(',', array_map('intval', $ids_to_update))
-                    . ') LIMIT ' . count($ids_to_update)
-                );
-            }
-            if ($success) {
-                // Ok it's confirmed: the question group WAS for the primary attendee group too. So
-                // now we just need to delete this row.
-                $successful_delete = $wpdb->delete(
-                    $this->_old_table,
-                    [
-                        'EQG_ID' => $event_question_group['EQG_ID']
-                    ],
-                    ['%d']
-                );
-                if (!$successful_delete) {
-                    $this->add_error(
-                        sprintf(
-                            esc_html__('Could not delete old event-question group relation row "%1$s" because "%2$s"', 'event_espresso'),
-                            wp_json_encode($event_question_group),
-                            $wpdb->last_error
-                        )
-                    );
-                }
-            } else {
-                // Oh, the question group actually was NOT for the primary attendee. So we just need to update this row
-                // Let's do the selection separately from the deletion, this way we don't lock big tables for too long.
-                $ids_to_update2 = $wpdb->get_col(
-                    $wpdb->prepare(
-                        'SELECT EQG_ID FROM '
-                        . $this->_old_table
-                        . ' WHERE EVT_ID=%d AND QSG_ID=%d',
-                        $event_question_group['EVT_ID'],
-                        $event_question_group['QSG_ID']
-                    )
-                );
-                if ($ids_to_update2) {
-                    $wpdb->query(
-                        'UPDATE '
-                        . $this->_old_table
-                        . ' SET EQG_additional=1 WHERE EQG_ID IN ('
-                        . implode(',', array_map('intval', $ids_to_update2))
-                        . ') LIMIT ' . count($ids_to_update2)
-                    );
-                }
-            }
-        }
-    }
+	/**
+	 * Removes the duplicate event_question_group rows that only had EQG_primary=0. Now we just have one row
+	 * joining event-to-question-groups with two columns: EQG_primary and EQG_additional, indicating which question
+	 * groups apply to which category of registrant.
+	 * @param array $event_question_group an associative array where keys are column names and values are their values.
+	 * @return null
+	 */
+	protected function _migrate_old_row($event_question_group)
+	{
+		if (isset($event_question_group['EVT_ID'], $event_question_group['QSG_ID'])) {
+			global $wpdb;
+			// If the question group was also for primary attendees, we should just update that row.
+			// And we delete this row.
+			// Updating all the rows could be slow on massive DBs, so do the slow selection first, then a quick update
+			// in order to avoid locking the table for too long.
+			$ids_to_update = $wpdb->get_col(
+				$wpdb->prepare(
+					'SELECT EQG_ID FROM ' . $this->_old_table . ' WHERE EQG_primary=1 AND EVT_ID=%d AND QSG_ID=%d',
+					$event_question_group['EVT_ID'],
+					$event_question_group['QSG_ID']
+				)
+			);
+			$success = false;
+			if ($ids_to_update) {
+				$success = $wpdb->query(
+					'UPDATE '
+					. $this->_old_table
+					. ' SET EQG_additional=1 WHERE EQG_ID IN ('
+					. implode(',', array_map('intval', $ids_to_update))
+					. ') LIMIT ' . count($ids_to_update)
+				);
+			}
+			if ($success) {
+				// Ok it's confirmed: the question group WAS for the primary attendee group too. So
+				// now we just need to delete this row.
+				$successful_delete = $wpdb->delete(
+					$this->_old_table,
+					[
+						'EQG_ID' => $event_question_group['EQG_ID']
+					],
+					['%d']
+				);
+				if (!$successful_delete) {
+					$this->add_error(
+						sprintf(
+							esc_html__('Could not delete old event-question group relation row "%1$s" because "%2$s"', 'event_espresso'),
+							wp_json_encode($event_question_group),
+							$wpdb->last_error
+						)
+					);
+				}
+			} else {
+				// Oh, the question group actually was NOT for the primary attendee. So we just need to update this row
+				// Let's do the selection separately from the deletion, this way we don't lock big tables for too long.
+				$ids_to_update2 = $wpdb->get_col(
+					$wpdb->prepare(
+						'SELECT EQG_ID FROM '
+						. $this->_old_table
+						. ' WHERE EVT_ID=%d AND QSG_ID=%d',
+						$event_question_group['EVT_ID'],
+						$event_question_group['QSG_ID']
+					)
+				);
+				if ($ids_to_update2) {
+					$wpdb->query(
+						'UPDATE '
+						. $this->_old_table
+						. ' SET EQG_additional=1 WHERE EQG_ID IN ('
+						. implode(',', array_map('intval', $ids_to_update2))
+						. ') LIMIT ' . count($ids_to_update2)
+					);
+				}
+			}
+		}
+	}
 
-    /**
-     * Gets the rows for the existing table that shouldn't exist in 4.10.
-     * Specifically the rows where EQG_primary=false and EQG_additional=false.
-     * Gotcha: because the migration is REMOVING rows as it goes, we shouldn't use the offset.
-     *
-     * @global wpdb $wpdb
-     * @param int   $limit
-     * @return array of arrays like $wpdb->get_results($sql, ARRAY_A)
-     */
-    protected function _get_rows($limit)
-    {
-        global $wpdb;
-        $query = "SELECT * FROM {$this->_old_table} {$this->_extra_where_sql} " . $wpdb->prepare(
-            "LIMIT %d",
-            $limit
-        );
-        return $wpdb->get_results($query, ARRAY_A);
-    }
+	/**
+	 * Gets the rows for the existing table that shouldn't exist in 4.10.
+	 * Specifically the rows where EQG_primary=false and EQG_additional=false.
+	 * Gotcha: because the migration is REMOVING rows as it goes, we shouldn't use the offset.
+	 *
+	 * @global wpdb $wpdb
+	 * @param int   $limit
+	 * @return array of arrays like $wpdb->get_results($sql, ARRAY_A)
+	 */
+	protected function _get_rows($limit)
+	{
+		global $wpdb;
+		$query = "SELECT * FROM {$this->_old_table} {$this->_extra_where_sql} " . $wpdb->prepare(
+			"LIMIT %d",
+			$limit
+		);
+		return $wpdb->get_results($query, ARRAY_A);
+	}
 
-    /**
-     * Slight departure from the normal procedure here: because this removes rows from the DB, we need to ensure
-     * we count the records first, then do the migration.
-     *
-     * @param int $num_items
-     * @return int number of items ACTUALLY migrated
-     */
-    public function _migration_step($num_items = 50)
-    {
-        // Count the items right away. This migration step will be removing those rows, so we need to count them
-        // right away to get an accurate count.
-        $this->count_records_to_migrate();
-        $rows = $this->_get_rows($num_items);
-        $items_actually_migrated = 0;
-        foreach ($rows as $old_row) {
-            $this->_migrate_old_row($old_row);
-            $items_actually_migrated++;
-        }
-        if (
-            empty($rows)
-            || ($this->count_records_migrated() + $items_actually_migrated >= $this->count_records_to_migrate())
-        ) {
-            $this->set_completed();
-        }
-        return $items_actually_migrated;
-    }
+	/**
+	 * Slight departure from the normal procedure here: because this removes rows from the DB, we need to ensure
+	 * we count the records first, then do the migration.
+	 *
+	 * @param int $num_items
+	 * @return int number of items ACTUALLY migrated
+	 */
+	public function _migration_step($num_items = 50)
+	{
+		// Count the items right away. This migration step will be removing those rows, so we need to count them
+		// right away to get an accurate count.
+		$this->count_records_to_migrate();
+		$rows = $this->_get_rows($num_items);
+		$items_actually_migrated = 0;
+		foreach ($rows as $old_row) {
+			$this->_migrate_old_row($old_row);
+			$items_actually_migrated++;
+		}
+		if (
+			empty($rows)
+			|| ($this->count_records_migrated() + $items_actually_migrated >= $this->count_records_to_migrate())
+		) {
+			$this->set_completed();
+		}
+		return $items_actually_migrated;
+	}
 }

core/services/request/sanitizers/AllowedTags.php

Indentation +280 added lines, -280 removed lines

@@ -12,284 +12,284 @@
  */
 class AllowedTags
 {
-    /**
-     * @var array[]
-     */
-    private static $attributes = [
-        'accept-charset'    => 1,
-        'action'            => 1,
-        'alt'               => 1,
-        'allow'             => 1,
-        'allowfullscreen'   => 1,
-        'align'             => 1,
-        'aria-*'            => 1,
-        'autocomplete'      => 1,
-        'bgcolor'           => 1,
-        'border'            => 1,
-        'cellpadding'       => 1,
-        'cellspacing'       => 1,
-        'checked'           => 1,
-        'class'             => 1,
-        'cols'              => 1,
-        'content'           => 1,
-        'data-*'            => 1,
-        'dir'               => 1,
-        'disabled'          => 1,
-        'enctype'           => 1,
-        'for'               => 1,
-        'frameborder'       => 1,
-        'height'            => 1,
-        'href'              => 1,
-        'id'                => 1,
-        'itemprop'          => 1,
-        'itemscope'         => 1,
-        'itemtype'          => 1,
-        'label'             => 1,
-        'lang'              => 1,
-        'leftmargin'        => 1,
-        'marginheight'      => 1,
-        'marginwidth'       => 1,
-        'max'               => 1,
-        'maxlength'         => 1,
-        'media'             => 1,
-        'method'            => 1,
-        'min'               => 1,
-        'multiple'          => 1,
-        'name'              => 1,
-        'novalidate'        => 1,
-        'placeholder'       => 1,
-        'property'          => 1,
-        'readonly'          => 1,
-        'rel'               => 1,
-        'required'          => 1,
-        'rows'              => 1,
-        'selected'          => 1,
-        'src'               => 1,
-        'size'              => 1,
-        'style'             => 1,
-        'step'              => 1,
-        'tabindex'          => 1,
-        'target'            => 1,
-        'title'             => 1,
-        'topmargin'         => 1,
-        'type'              => 1,
-        'value'             => 1,
-        'width'             => 1,
-    ];
-
-
-    /**
-     * @var array
-     */
-    private static $tags = [
-        'a',
-        'abbr',
-        'b',
-        'br',
-        'code',
-        'div',
-        'em',
-        'h1',
-        'h2',
-        'h3',
-        'h4',
-        'h5',
-        'h6',
-        'hr',
-        'i',
-        'img',
-        'li',
-        'ol',
-        'p',
-        'pre',
-        'small',
-        'span',
-        'strong',
-        'table',
-        'td',
-        'tr',
-        'ul',
-    ];
-
-
-    /**
-     * @var array
-     */
-    private static $allowed_tags;
-
-
-    /**
-     * @var array
-     */
-    private static $allowed_with_embed_tags;
-
-
-    /**
-     * @var array
-     */
-    private static $allowed_with_form_tags;
-
-
-    /**
-     * @var array
-     */
-    private static $allowed_with_script_and_style_tags;
-
-    /**
-     * @var array
-     */
-    private static $allowed_with_full_tags;
-
-
-    /**
-     * merges additional tags and attributes into the WP post tags
-     */
-    private static function initializeAllowedTags()
-    {
-        $allowed_post_tags = wp_kses_allowed_html('post');
-        $allowed_tags = [];
-        foreach (AllowedTags::$tags as $tag) {
-            $allowed_tags[ $tag ] = AllowedTags::$attributes;
-        }
-        AllowedTags::$allowed_tags = array_merge_recursive($allowed_post_tags, $allowed_tags);
-    }
-
-
-    /**
-     * merges embed tags and attributes into the EE all tags
-     */
-    private static function initializeWithEmbedTags()
-    {
-        $all_tags = AllowedTags::getAllowedTags();
-        $embed_tags = [
-            'iframe' => AllowedTags::$attributes
-        ];
-        AllowedTags::$allowed_with_embed_tags = array_merge_recursive($all_tags, $embed_tags);
-    }
-
-
-    /**
-     * merges form tags and attributes into the EE all tags
-     */
-    private static function initializeWithFormTags()
-    {
-        $all_tags = AllowedTags::getAllowedTags();
-        $form_tags = [
-            'form'     => AllowedTags::$attributes,
-            'label'    => AllowedTags::$attributes,
-            'input'    => AllowedTags::$attributes,
-            'select'   => AllowedTags::$attributes,
-            'option'   => AllowedTags::$attributes,
-            'optgroup' => AllowedTags::$attributes,
-            'textarea' => AllowedTags::$attributes,
-            'button'   => AllowedTags::$attributes,
-            'fieldset' => AllowedTags::$attributes,
-            'output'   => AllowedTags::$attributes,
-        ];
-        AllowedTags::$allowed_with_form_tags = array_merge_recursive($all_tags, $form_tags);
-    }
-
-
-    /**
-     * merges form script and style tags and attributes into the EE all tags
-     */
-    private static function initializeWithScriptAndStyleTags()
-    {
-        $all_tags = AllowedTags::getAllowedTags();
-        $script_and_style_tags = [
-            'script'   => AllowedTags::$attributes,
-            'style'    => AllowedTags::$attributes,
-            'link'     => AllowedTags::$attributes,
-            'noscript' => AllowedTags::$attributes,
-        ];
-        AllowedTags::$allowed_with_script_and_style_tags = array_merge_recursive($all_tags, $script_and_style_tags);
-    }
-
-    /**
-     * merges all head and body tags and attributes into the EE all tags
-     */
-    private static function initializeWithFullTags()
-    {
-        $all_tags = AllowedTags::getAllowedTags();
-        $full_tags = [
-            'script'    => AllowedTags::$attributes,
-            'style'     => AllowedTags::$attributes,
-            'link'      => AllowedTags::$attributes,
-            'title'     => AllowedTags::$attributes,
-            'meta'      => AllowedTags::$attributes,
-            'iframe'    => AllowedTags::$attributes,
-            'form'      => AllowedTags::$attributes,
-            'label'     => AllowedTags::$attributes,
-            'input'     => AllowedTags::$attributes,
-            'select'    => AllowedTags::$attributes,
-            'option'    => AllowedTags::$attributes,
-            'optgroup'  => AllowedTags::$attributes,
-            'textarea'  => AllowedTags::$attributes,
-            'button'    => AllowedTags::$attributes,
-            'fieldset'  => AllowedTags::$attributes,
-            'output'    => AllowedTags::$attributes,
-            'noscript'  => AllowedTags::$attributes,
-        ];
-        AllowedTags::$allowed_with_full_tags = array_merge_recursive($all_tags, $full_tags);
-    }
-
-
-    /**
-     * @return array[]
-     */
-    public static function getAllowedTags()
-    {
-        if (empty(AllowedTags::$allowed_tags)) {
-            AllowedTags::initializeAllowedTags();
-        }
-        return AllowedTags::$allowed_tags;
-    }
-
-
-    /**
-     * @return array[]
-     */
-    public static function getWithEmbedTags()
-    {
-        if (empty(AllowedTags::$allowed_with_embed_tags)) {
-            AllowedTags::initializeWithEmbedTags();
-        }
-        return AllowedTags::$allowed_with_embed_tags;
-    }
-
-
-    /**
-     * @return array[]
-     */
-    public static function getWithFormTags()
-    {
-        if (empty(AllowedTags::$allowed_with_form_tags)) {
-            AllowedTags::initializeWithFormTags();
-        }
-        return AllowedTags::$allowed_with_form_tags;
-    }
-
-
-    /**
-     * @return array[]
-     */
-    public static function getWithScriptAndStyleTags()
-    {
-        if (empty(AllowedTags::$allowed_with_script_and_style_tags)) {
-            AllowedTags::initializeWithScriptAndStyleTags();
-        }
-        return AllowedTags::$allowed_with_script_and_style_tags;
-    }
-
-
-    /**
-     * @return array[]
-     */
-    public static function getWithFullTags()
-    {
-        if (empty(AllowedTags::$allowed_with_full_tags)) {
-            AllowedTags::initializeWithFullTags();
-        }
-        return AllowedTags::$allowed_with_full_tags;
-    }
+	/**
+	 * @var array[]
+	 */
+	private static $attributes = [
+		'accept-charset'    => 1,
+		'action'            => 1,
+		'alt'               => 1,
+		'allow'             => 1,
+		'allowfullscreen'   => 1,
+		'align'             => 1,
+		'aria-*'            => 1,
+		'autocomplete'      => 1,
+		'bgcolor'           => 1,
+		'border'            => 1,
+		'cellpadding'       => 1,
+		'cellspacing'       => 1,
+		'checked'           => 1,
+		'class'             => 1,
+		'cols'              => 1,
+		'content'           => 1,
+		'data-*'            => 1,
+		'dir'               => 1,
+		'disabled'          => 1,
+		'enctype'           => 1,
+		'for'               => 1,
+		'frameborder'       => 1,
+		'height'            => 1,
+		'href'              => 1,
+		'id'                => 1,
+		'itemprop'          => 1,
+		'itemscope'         => 1,
+		'itemtype'          => 1,
+		'label'             => 1,
+		'lang'              => 1,
+		'leftmargin'        => 1,
+		'marginheight'      => 1,
+		'marginwidth'       => 1,
+		'max'               => 1,
+		'maxlength'         => 1,
+		'media'             => 1,
+		'method'            => 1,
+		'min'               => 1,
+		'multiple'          => 1,
+		'name'              => 1,
+		'novalidate'        => 1,
+		'placeholder'       => 1,
+		'property'          => 1,
+		'readonly'          => 1,
+		'rel'               => 1,
+		'required'          => 1,
+		'rows'              => 1,
+		'selected'          => 1,
+		'src'               => 1,
+		'size'              => 1,
+		'style'             => 1,
+		'step'              => 1,
+		'tabindex'          => 1,
+		'target'            => 1,
+		'title'             => 1,
+		'topmargin'         => 1,
+		'type'              => 1,
+		'value'             => 1,
+		'width'             => 1,
+	];
+
+
+	/**
+	 * @var array
+	 */
+	private static $tags = [
+		'a',
+		'abbr',
+		'b',
+		'br',
+		'code',
+		'div',
+		'em',
+		'h1',
+		'h2',
+		'h3',
+		'h4',
+		'h5',
+		'h6',
+		'hr',
+		'i',
+		'img',
+		'li',
+		'ol',
+		'p',
+		'pre',
+		'small',
+		'span',
+		'strong',
+		'table',
+		'td',
+		'tr',
+		'ul',
+	];
+
+
+	/**
+	 * @var array
+	 */
+	private static $allowed_tags;
+
+
+	/**
+	 * @var array
+	 */
+	private static $allowed_with_embed_tags;
+
+
+	/**
+	 * @var array
+	 */
+	private static $allowed_with_form_tags;
+
+
+	/**
+	 * @var array
+	 */
+	private static $allowed_with_script_and_style_tags;
+
+	/**
+	 * @var array
+	 */
+	private static $allowed_with_full_tags;
+
+
+	/**
+	 * merges additional tags and attributes into the WP post tags
+	 */
+	private static function initializeAllowedTags()
+	{
+		$allowed_post_tags = wp_kses_allowed_html('post');
+		$allowed_tags = [];
+		foreach (AllowedTags::$tags as $tag) {
+			$allowed_tags[ $tag ] = AllowedTags::$attributes;
+		}
+		AllowedTags::$allowed_tags = array_merge_recursive($allowed_post_tags, $allowed_tags);
+	}
+
+
+	/**
+	 * merges embed tags and attributes into the EE all tags
+	 */
+	private static function initializeWithEmbedTags()
+	{
+		$all_tags = AllowedTags::getAllowedTags();
+		$embed_tags = [
+			'iframe' => AllowedTags::$attributes
+		];
+		AllowedTags::$allowed_with_embed_tags = array_merge_recursive($all_tags, $embed_tags);
+	}
+
+
+	/**
+	 * merges form tags and attributes into the EE all tags
+	 */
+	private static function initializeWithFormTags()
+	{
+		$all_tags = AllowedTags::getAllowedTags();
+		$form_tags = [
+			'form'     => AllowedTags::$attributes,
+			'label'    => AllowedTags::$attributes,
+			'input'    => AllowedTags::$attributes,
+			'select'   => AllowedTags::$attributes,
+			'option'   => AllowedTags::$attributes,
+			'optgroup' => AllowedTags::$attributes,
+			'textarea' => AllowedTags::$attributes,
+			'button'   => AllowedTags::$attributes,
+			'fieldset' => AllowedTags::$attributes,
+			'output'   => AllowedTags::$attributes,
+		];
+		AllowedTags::$allowed_with_form_tags = array_merge_recursive($all_tags, $form_tags);
+	}
+
+
+	/**
+	 * merges form script and style tags and attributes into the EE all tags
+	 */
+	private static function initializeWithScriptAndStyleTags()
+	{
+		$all_tags = AllowedTags::getAllowedTags();
+		$script_and_style_tags = [
+			'script'   => AllowedTags::$attributes,
+			'style'    => AllowedTags::$attributes,
+			'link'     => AllowedTags::$attributes,
+			'noscript' => AllowedTags::$attributes,
+		];
+		AllowedTags::$allowed_with_script_and_style_tags = array_merge_recursive($all_tags, $script_and_style_tags);
+	}
+
+	/**
+	 * merges all head and body tags and attributes into the EE all tags
+	 */
+	private static function initializeWithFullTags()
+	{
+		$all_tags = AllowedTags::getAllowedTags();
+		$full_tags = [
+			'script'    => AllowedTags::$attributes,
+			'style'     => AllowedTags::$attributes,
+			'link'      => AllowedTags::$attributes,
+			'title'     => AllowedTags::$attributes,
+			'meta'      => AllowedTags::$attributes,
+			'iframe'    => AllowedTags::$attributes,
+			'form'      => AllowedTags::$attributes,
+			'label'     => AllowedTags::$attributes,
+			'input'     => AllowedTags::$attributes,
+			'select'    => AllowedTags::$attributes,
+			'option'    => AllowedTags::$attributes,
+			'optgroup'  => AllowedTags::$attributes,
+			'textarea'  => AllowedTags::$attributes,
+			'button'    => AllowedTags::$attributes,
+			'fieldset'  => AllowedTags::$attributes,
+			'output'    => AllowedTags::$attributes,
+			'noscript'  => AllowedTags::$attributes,
+		];
+		AllowedTags::$allowed_with_full_tags = array_merge_recursive($all_tags, $full_tags);
+	}
+
+
+	/**
+	 * @return array[]
+	 */
+	public static function getAllowedTags()
+	{
+		if (empty(AllowedTags::$allowed_tags)) {
+			AllowedTags::initializeAllowedTags();
+		}
+		return AllowedTags::$allowed_tags;
+	}
+
+
+	/**
+	 * @return array[]
+	 */
+	public static function getWithEmbedTags()
+	{
+		if (empty(AllowedTags::$allowed_with_embed_tags)) {
+			AllowedTags::initializeWithEmbedTags();
+		}
+		return AllowedTags::$allowed_with_embed_tags;
+	}
+
+
+	/**
+	 * @return array[]
+	 */
+	public static function getWithFormTags()
+	{
+		if (empty(AllowedTags::$allowed_with_form_tags)) {
+			AllowedTags::initializeWithFormTags();
+		}
+		return AllowedTags::$allowed_with_form_tags;
+	}
+
+
+	/**
+	 * @return array[]
+	 */
+	public static function getWithScriptAndStyleTags()
+	{
+		if (empty(AllowedTags::$allowed_with_script_and_style_tags)) {
+			AllowedTags::initializeWithScriptAndStyleTags();
+		}
+		return AllowedTags::$allowed_with_script_and_style_tags;
+	}
+
+
+	/**
+	 * @return array[]
+	 */
+	public static function getWithFullTags()
+	{
+		if (empty(AllowedTags::$allowed_with_full_tags)) {
+			AllowedTags::initializeWithFullTags();
+		}
+		return AllowedTags::$allowed_with_full_tags;
+	}
 }

admin_pages/general_settings/General_Settings_Admin_Page.core.php

Indentation +1427 added lines, -1427 removed lines

@@ -19,1444 +19,1444 @@
  */
 class General_Settings_Admin_Page extends EE_Admin_Page
 {
-    /**
-     * @var EE_Core_Config
-     */
-    public $core_config;
-
-
-    /**
-     * Initialize basic properties.
-     */
-    protected function _init_page_props()
-    {
-        $this->page_slug        = GEN_SET_PG_SLUG;
-        $this->page_label       = GEN_SET_LABEL;
-        $this->_admin_base_url  = GEN_SET_ADMIN_URL;
-        $this->_admin_base_path = GEN_SET_ADMIN;
-
-        $this->core_config = EE_Registry::instance()->CFG->core;
-    }
-
-
-    /**
-     * Set ajax hooks
-     */
-    protected function _ajax_hooks()
-    {
-        add_action('wp_ajax_espresso_display_country_settings', [$this, 'display_country_settings']);
-        add_action('wp_ajax_espresso_display_country_states', [$this, 'display_country_states']);
-        add_action('wp_ajax_espresso_delete_state', [$this, 'delete_state'], 10, 3);
-        add_action('wp_ajax_espresso_add_new_state', [$this, 'add_new_state']);
-    }
-
-
-    /**
-     * More page properties initialization.
-     */
-    protected function _define_page_props()
-    {
-        $this->_admin_page_title = GEN_SET_LABEL;
-        $this->_labels           = ['publishbox' => esc_html__('Update Settings', 'event_espresso')];
-    }
-
-
-    /**
-     * Set page routes property.
-     */
-    protected function _set_page_routes()
-    {
-        $this->_page_routes = [
-            'critical_pages'                => [
-                'func'       => '_espresso_page_settings',
-                'capability' => 'manage_options',
-            ],
-            'update_espresso_page_settings' => [
-                'func'       => '_update_espresso_page_settings',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-            ],
-            'default'                       => [
-                'func'       => '_your_organization_settings',
-                'capability' => 'manage_options',
-            ],
-
-            'update_your_organization_settings' => [
-                'func'       => '_update_your_organization_settings',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-            ],
-
-            'admin_option_settings' => [
-                'func'       => '_admin_option_settings',
-                'capability' => 'manage_options',
-            ],
-
-            'update_admin_option_settings' => [
-                'func'       => '_update_admin_option_settings',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-            ],
-
-            'country_settings' => [
-                'func'       => '_country_settings',
-                'capability' => 'manage_options',
-            ],
-
-            'update_country_settings' => [
-                'func'       => '_update_country_settings',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-            ],
-
-            'display_country_settings' => [
-                'func'       => 'display_country_settings',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-            ],
-
-            'add_new_state' => [
-                'func'       => 'add_new_state',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-            ],
-
-            'delete_state'            => [
-                'func'       => 'delete_state',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-            ],
-            'privacy_settings'        => [
-                'func'       => 'privacySettings',
-                'capability' => 'manage_options',
-            ],
-            'update_privacy_settings' => [
-                'func'               => 'updatePrivacySettings',
-                'capability'         => 'manage_options',
-                'noheader'           => true,
-                'headers_sent_route' => 'privacy_settings',
-            ],
-        ];
-    }
-
-
-    /**
-     * Set page configuration property
-     */
-    protected function _set_page_config()
-    {
-        $this->_page_config = [
-            'critical_pages'        => [
-                'nav'           => [
-                    'label' => esc_html__('Critical Pages', 'event_espresso'),
-                    'icon' => 'dashicons-warning',
-                    'order' => 50,
-                ],
-                'metaboxes'     => array_merge($this->_default_espresso_metaboxes, ['_publish_post_box']),
-                'help_tabs'     => [
-                    'general_settings_critical_pages_help_tab' => [
-                        'title'    => esc_html__('Critical Pages', 'event_espresso'),
-                        'filename' => 'general_settings_critical_pages',
-                    ],
-                ],
-                'require_nonce' => false,
-            ],
-            'default'               => [
-                'nav'           => [
-                    'label' => esc_html__('Your Organization', 'event_espresso'),
-                    'icon' => 'dashicons-admin-home',
-                    'order' => 20,
-                ],
-                'help_tabs'     => [
-                    'general_settings_your_organization_help_tab' => [
-                        'title'    => esc_html__('Your Organization', 'event_espresso'),
-                        'filename' => 'general_settings_your_organization',
-                    ],
-                ],
-                'metaboxes'     => array_merge($this->_default_espresso_metaboxes, ['_publish_post_box']),
-                'require_nonce' => false,
-            ],
-            'admin_option_settings' => [
-                'nav'           => [
-                    'label' => esc_html__('Admin Options', 'event_espresso'),
-                    'icon' => 'dashicons-admin-settings',
-                    'order' => 60,
-                ],
-                'metaboxes'     => array_merge($this->_default_espresso_metaboxes, ['_publish_post_box']),
-                'help_tabs'     => [
-                    'general_settings_admin_options_help_tab' => [
-                        'title'    => esc_html__('Admin Options', 'event_espresso'),
-                        'filename' => 'general_settings_admin_options',
-                    ],
-                ],
-                'require_nonce' => false,
-            ],
-            'country_settings'      => [
-                'nav'           => [
-                    'label' => esc_html__('Countries', 'event_espresso'),
-                    'icon' => 'dashicons-admin-site',
-                    'order' => 70,
-                ],
-                'help_tabs'     => [
-                    'general_settings_countries_help_tab' => [
-                        'title'    => esc_html__('Countries', 'event_espresso'),
-                        'filename' => 'general_settings_countries',
-                    ],
-                ],
-                'require_nonce' => false,
-            ],
-            'privacy_settings'      => [
-                'nav'           => [
-                    'label' => esc_html__('Privacy', 'event_espresso'),
-                    'icon' => 'dashicons-privacy',
-                    'order' => 80,
-                ],
-                'metaboxes'     => array_merge($this->_default_espresso_metaboxes, ['_publish_post_box']),
-                'require_nonce' => false,
-            ],
-        ];
-    }
-
-
-    protected function _add_screen_options()
-    {
-    }
-
-
-    protected function _add_feature_pointers()
-    {
-    }
-
-
-    /**
-     * Enqueue global scripts and styles for all routes in the General Settings Admin Pages.
-     */
-    public function load_scripts_styles()
-    {
-        // styles
-        wp_enqueue_style('espresso-ui-theme');
-        // scripts
-        wp_enqueue_script('ee_admin_js');
-    }
-
-
-    /**
-     * Execute logic running on `admin_init`
-     */
-    public function admin_init()
-    {
-        EE_Registry::$i18n_js_strings['invalid_server_response'] = wp_strip_all_tags(
-            esc_html__(
-                'An error occurred! Your request may have been processed, but a valid response from the server was not received. Please refresh the page and try again.',
-                'event_espresso'
-            )
-        );
-        EE_Registry::$i18n_js_strings['error_occurred']          = wp_strip_all_tags(
-            esc_html__(
-                'An error occurred! Please refresh the page and try again.',
-                'event_espresso'
-            )
-        );
-        EE_Registry::$i18n_js_strings['confirm_delete_state']    = wp_strip_all_tags(
-            esc_html__(
-                'Are you sure you want to delete this State / Province?',
-                'event_espresso'
-            )
-        );
-        EE_Registry::$i18n_js_strings['ajax_url']                = admin_url(
-            'admin-ajax.php?page=espresso_general_settings',
-            is_ssl() ? 'https://' : 'http://'
-        );
-    }
-
-
-    public function admin_notices()
-    {
-    }
-
-
-    public function admin_footer_scripts()
-    {
-    }
-
-
-    /**
-     * Enqueue scripts and styles for the default route.
-     */
-    public function load_scripts_styles_default()
-    {
-        // styles
-        wp_enqueue_style('thickbox');
-        // scripts
-        wp_enqueue_script('media-upload');
-        wp_enqueue_script('thickbox');
-        wp_register_script(
-            'organization_settings',
-            GEN_SET_ASSETS_URL . 'your_organization_settings.js',
-            ['jquery', 'media-upload', 'thickbox'],
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_register_style('organization-css', GEN_SET_ASSETS_URL . 'organization.css', [], EVENT_ESPRESSO_VERSION);
-        wp_enqueue_script('organization_settings');
-        wp_enqueue_style('organization-css');
-        $confirm_image_delete = [
-            'text' => wp_strip_all_tags(
-                esc_html__(
-                    'Do you really want to delete this image? Please remember to save your settings to complete the removal.',
-                    'event_espresso'
-                )
-            ),
-        ];
-        wp_localize_script('organization_settings', 'confirm_image_delete', $confirm_image_delete);
-    }
-
-
-    /**
-     * Enqueue scripts and styles for the country settings route.
-     */
-    public function load_scripts_styles_country_settings()
-    {
-        // scripts
-        wp_register_script(
-            'gen_settings_countries',
-            GEN_SET_ASSETS_URL . 'gen_settings_countries.js',
-            ['ee_admin_js'],
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_register_style('organization-css', GEN_SET_ASSETS_URL . 'organization.css', [], EVENT_ESPRESSO_VERSION);
-        wp_enqueue_script('gen_settings_countries');
-        wp_enqueue_style('organization-css');
-    }
-
-
-    /*************        Espresso Pages        *************/
-    /**
-     * _espresso_page_settings
-     *
-     * @throws EE_Error
-     * @throws DomainException
-     * @throws DomainException
-     * @throws InvalidDataTypeException
-     * @throws InvalidArgumentException
-     */
-    protected function _espresso_page_settings()
-    {
-        // Check to make sure all of the main pages are set up properly,
-        // if not create the default pages and display an admin notice
-        EEH_Activation::verify_default_pages_exist();
-        $this->_transient_garbage_collection();
-
-        $this->_template_args['values'] = $this->_yes_no_values;
-
-        $this->_template_args['reg_page_id']  = $this->core_config->reg_page_id ?? null;
-        $this->_template_args['reg_page_obj'] = isset($this->core_config->reg_page_id)
-            ? get_post($this->core_config->reg_page_id)
-            : false;
-
-        $this->_template_args['txn_page_id']  = $this->core_config->txn_page_id ?? null;
-        $this->_template_args['txn_page_obj'] = isset($this->core_config->txn_page_id)
-            ? get_post($this->core_config->txn_page_id)
-            : false;
-
-        $this->_template_args['thank_you_page_id']  = $this->core_config->thank_you_page_id ?? null;
-        $this->_template_args['thank_you_page_obj'] = isset($this->core_config->thank_you_page_id)
-            ? get_post($this->core_config->thank_you_page_id)
-            : false;
-
-        $this->_template_args['cancel_page_id']  = $this->core_config->cancel_page_id ?? null;
-        $this->_template_args['cancel_page_obj'] = isset($this->core_config->cancel_page_id)
-            ? get_post($this->core_config->cancel_page_id)
-            : false;
-
-        $this->_set_add_edit_form_tags('update_espresso_page_settings');
-        $this->_set_publish_post_box_vars(null, false, false, null, false);
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            GEN_SET_TEMPLATE_PATH . 'espresso_page_settings.template.php',
-            $this->_template_args,
-            true
-        );
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    /**
-     * Handler for updating espresso page settings.
-     *
-     * @throws EE_Error
-     */
-    protected function _update_espresso_page_settings()
-    {
-        $this->core_config = EE_Registry::instance()->CFG->core;
-        // capture incoming request data && set page IDs
-        $this->core_config->reg_page_id       = $this->request->getRequestParam(
-            'reg_page_id',
-            $this->core_config->reg_page_id,
-            DataType::INT
-        );
-        $this->core_config->txn_page_id       = $this->request->getRequestParam(
-            'txn_page_id',
-            $this->core_config->txn_page_id,
-            DataType::INT
-        );
-        $this->core_config->thank_you_page_id = $this->request->getRequestParam(
-            'thank_you_page_id',
-            $this->core_config->thank_you_page_id,
-            DataType::INT
-        );
-        $this->core_config->cancel_page_id    = $this->request->getRequestParam(
-            'cancel_page_id',
-            $this->core_config->cancel_page_id,
-            DataType::INT
-        );
-
-        $this->core_config = apply_filters(
-            'FHEE__General_Settings_Admin_Page___update_espresso_page_settings__CFG_core',
-            $this->core_config,
-            $this->request->requestParams()
-        );
-
-        $what = esc_html__('Critical Pages & Shortcodes', 'event_espresso');
-        $this->_redirect_after_action(
-            $this->_update_espresso_configuration(
-                $what,
-                $this->core_config,
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            ),
-            $what,
-            '',
-            [
-                'action' => 'critical_pages',
-            ],
-            true
-        );
-    }
-
-
-    /*************        Your Organization        *************/
-
-
-    /**
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _your_organization_settings()
-    {
-        $this->_template_args['admin_page_content'] = '';
-        try {
-            /** @var OrganizationSettings $organization_settings_form */
-            $organization_settings_form = $this->loader->getShared(OrganizationSettings::class);
-
-            $this->_template_args['admin_page_content'] = EEH_HTML::div(
-                $organization_settings_form->display(),
-                '',
-                'padding'
-            );
-        } catch (Exception $e) {
-            EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
-        }
-        $this->_set_add_edit_form_tags('update_your_organization_settings');
-        $this->_set_publish_post_box_vars(null, false, false, null, false);
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    /**
-     * Handler for updating organization settings.
-     *
-     * @throws EE_Error
-     */
-    protected function _update_your_organization_settings()
-    {
-        try {
-            /** @var OrganizationSettings $organization_settings_form */
-            $organization_settings_form = $this->loader->getShared(OrganizationSettings::class);
-
-            $success = $organization_settings_form->process($this->request->requestParams());
-
-            EE_Registry::instance()->CFG = apply_filters(
-                'FHEE__General_Settings_Admin_Page___update_your_organization_settings__CFG',
-                EE_Registry::instance()->CFG
-            );
-        } catch (Exception $e) {
-            EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
-            $success = false;
-        }
-
-        if ($success) {
-            $success = $this->_update_espresso_configuration(
-                esc_html__('Your Organization Settings', 'event_espresso'),
-                EE_Registry::instance()->CFG,
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-
-        $this->_redirect_after_action($success, '', '', ['action' => 'default'], true);
-    }
-
-
-
-    /*************        Admin Options        *************/
-
-
-    /**
-     * _admin_option_settings
-     *
-     * @throws EE_Error
-     * @throws LogicException
-     */
-    protected function _admin_option_settings()
-    {
-        $this->_template_args['admin_page_content'] = '';
-        try {
-            $admin_options_settings_form = new AdminOptionsSettings(EE_Registry::instance());
-            // still need this for the old school form in Extend_General_Settings_Admin_Page
-            $this->_template_args['values'] = $this->_yes_no_values;
-            // also need to account for the do_action that was in the old template
-            $admin_options_settings_form->setTemplateArgs($this->_template_args);
-            $this->_template_args['admin_page_content'] = EEH_HTML::div(
-                $admin_options_settings_form->display(),
-                '',
-                'padding'
-            );
-        } catch (Exception $e) {
-            EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
-        }
-        $this->_set_add_edit_form_tags('update_admin_option_settings');
-        $this->_set_publish_post_box_vars(null, false, false, null, false);
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    /**
-     * _update_admin_option_settings
-     *
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidFormSubmissionException
-     * @throws InvalidArgumentException
-     * @throws LogicException
-     */
-    protected function _update_admin_option_settings()
-    {
-        try {
-            $admin_options_settings_form = new AdminOptionsSettings(EE_Registry::instance());
-            $admin_options_settings_form->process(
-                $this->request->getRequestParam(
-                    $admin_options_settings_form->slug(),
-                    [],
-                    DataType::STRING,
-                    true
-                )
-            );
-            EE_Registry::instance()->CFG->admin = apply_filters(
-                'FHEE__General_Settings_Admin_Page___update_admin_option_settings__CFG_admin',
-                EE_Registry::instance()->CFG->admin
-            );
-        } catch (Exception $e) {
-            EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
-        }
-        $this->_redirect_after_action(
-            apply_filters(
-                'FHEE__General_Settings_Admin_Page___update_admin_option_settings__success',
-                $this->_update_espresso_configuration(
-                    esc_html__('Admin Options', 'event_espresso'),
-                    EE_Registry::instance()->CFG->admin,
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                )
-            ),
-            esc_html__('Admin Options', 'event_espresso'),
-            'updated',
-            ['action' => 'admin_option_settings']
-        );
-    }
-
-
-    /*************        Countries        *************/
-
-
-    /**
-     * @param string|null $default
-     * @return string
-     */
-    protected function getCountryISO(?string $default = null): string
-    {
-        $default = $default ?? $this->getCountryIsoForSite();
-        $CNT_ISO = $this->request->getRequestParam('country', $default);
-        $CNT_ISO = $this->request->getRequestParam('CNT_ISO', $CNT_ISO);
-        return strtoupper($CNT_ISO);
-    }
-
-
-    /**
-     * @return string
-     */
-    protected function getCountryIsoForSite(): string
-    {
-        return ! empty(EE_Registry::instance()->CFG->organization->CNT_ISO)
-            ? EE_Registry::instance()->CFG->organization->CNT_ISO
-            : 'US';
-    }
-
-
-    /**
-     * @param string          $CNT_ISO
-     * @param EE_Country|null $country
-     * @return EE_Base_Class|EE_Country
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function verifyOrGetCountryFromIso(string $CNT_ISO, ?EE_Country $country = null)
-    {
-        /** @var EE_Country $country */
-        return $country instanceof EE_Country && $country->ID() === $CNT_ISO
-            ? $country
-            : EEM_Country::instance()->get_one_by_ID($CNT_ISO);
-    }
-
-
-    /**
-     * Output Country Settings view.
-     *
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _country_settings()
-    {
-        $CNT_ISO = $this->getCountryISO();
-
-        $this->_template_args['values']    = $this->_yes_no_values;
-        $this->_template_args['countries'] = new EE_Question_Form_Input(
-            EE_Question::new_instance(
-                [
-                  'QST_ID'           => 0,
-                  'QST_display_text' => esc_html__('Select Country', 'event_espresso'),
-                  'QST_system'       => 'admin-country',
-                ]
-            ),
-            EE_Answer::new_instance(
-                [
-                    'ANS_ID'    => 0,
-                    'ANS_value' => $CNT_ISO,
-                ]
-            ),
-            [
-                'input_id'       => 'country',
-                'input_name'     => 'country',
-                'input_prefix'   => '',
-                'append_qstn_id' => false,
-            ]
-        );
-
-        $country = $this->verifyOrGetCountryFromIso($CNT_ISO);
-        add_filter('FHEE__EEH_Form_Fields__label_html', [$this, 'country_form_field_label_wrap'], 10);
-        add_filter('FHEE__EEH_Form_Fields__input_html', [$this, 'country_form_field_input__wrap'], 10);
-        $this->_template_args['country_details_settings'] = $this->display_country_settings(
-            $country->ID(),
-            $country
-        );
-        $this->_template_args['country_states_settings']  = $this->display_country_states(
-            $country->ID(),
-            $country
-        );
-        $this->_template_args['CNT_name_for_site']        = $country->name();
-
-        $this->_set_add_edit_form_tags('update_country_settings');
-        $this->_set_publish_post_box_vars(null, false, false, null, false);
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            GEN_SET_TEMPLATE_PATH . 'countries_settings.template.php',
-            $this->_template_args,
-            true
-        );
-        $this->display_admin_page_with_no_sidebar();
-    }
-
-
-    /**
-     * @param string          $CNT_ISO
-     * @param EE_Country|null $country
-     * @return string
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function display_country_settings(string $CNT_ISO = '', ?EE_Country $country = null): string
-    {
-        $CNT_ISO          = $this->getCountryISO($CNT_ISO);
-        $CNT_ISO_for_site = $this->getCountryIsoForSite();
-
-        if (! $CNT_ISO) {
-            return '';
-        }
-
-        // for ajax
-        remove_all_filters('FHEE__EEH_Form_Fields__label_html');
-        remove_all_filters('FHEE__EEH_Form_Fields__input_html');
-        add_filter('FHEE__EEH_Form_Fields__label_html', [$this, 'country_form_field_label_wrap'], 10, 2);
-        add_filter('FHEE__EEH_Form_Fields__input_html', [$this, 'country_form_field_input__wrap'], 10, 2);
-        $country                                  = $this->verifyOrGetCountryFromIso($CNT_ISO, $country);
-        $CNT_cur_disabled                         = $CNT_ISO !== $CNT_ISO_for_site;
-        $this->_template_args['CNT_cur_disabled'] = $CNT_cur_disabled;
-
-        $country_input_types            = [
-            'CNT_active'      => [
-                'type'             => 'RADIO_BTN',
-                'input_name'       => "cntry[$CNT_ISO]",
-                'class'            => '',
-                'options'          => $this->_yes_no_values,
-                'use_desc_4_label' => true,
-            ],
-            'CNT_ISO'         => [
-                'type'       => 'TEXT',
-                'input_name' => "cntry[$CNT_ISO]",
-                'class'      => 'ee-input-width--small',
-            ],
-            'CNT_ISO3'        => [
-                'type'       => 'TEXT',
-                'input_name' => "cntry[$CNT_ISO]",
-                'class'      => 'ee-input-width--small',
-            ],
-            // 'RGN_ID'          => [
-            //     'type'       => 'TEXT',
-            //     'input_name' => "cntry[$CNT_ISO]",
-            //     'class'      => 'ee-input-width--small',
-            // ],
-            'CNT_name'        => [
-                'type'       => 'TEXT',
-                'input_name' => "cntry[$CNT_ISO]",
-                'class'      => 'ee-input-width--big',
-            ],
-            'CNT_cur_code'    => [
-                'type'       => 'TEXT',
-                'input_name' => "cntry[$CNT_ISO]",
-                'class'      => 'ee-input-width--small',
-                'disabled'   => $CNT_cur_disabled,
-            ],
-            'CNT_cur_single'  => [
-                'type'       => 'TEXT',
-                'input_name' => "cntry[$CNT_ISO]",
-                'class'      => 'ee-input-width--reg',
-                'disabled'   => $CNT_cur_disabled,
-            ],
-            'CNT_cur_plural'  => [
-                'type'       => 'TEXT',
-                'input_name' => "cntry[$CNT_ISO]",
-                'class'      => 'ee-input-width--reg',
-                'disabled'   => $CNT_cur_disabled,
-            ],
-            'CNT_cur_sign'    => [
-                'type'         => 'TEXT',
-                'input_name'   => "cntry[$CNT_ISO]",
-                'class'        => 'ee-input-width--small',
-                'htmlentities' => false,
-                'disabled'     => $CNT_cur_disabled,
-            ],
-            'CNT_cur_sign_b4' => [
-                'type'             => 'RADIO_BTN',
-                'input_name'       => "cntry[$CNT_ISO]",
-                'class'            => '',
-                'options'          => $this->_yes_no_values,
-                'use_desc_4_label' => true,
-                'disabled'         => $CNT_cur_disabled,
-            ],
-            'CNT_cur_dec_plc' => [
-                'type'       => 'RADIO_BTN',
-                'input_name' => "cntry[$CNT_ISO]",
-                'class'      => '',
-                'options'    => [
-                    ['id' => 0, 'text' => ''],
-                    ['id' => 1, 'text' => ''],
-                    ['id' => 2, 'text' => ''],
-                    ['id' => 3, 'text' => ''],
-                ],
-                'disabled'   => $CNT_cur_disabled,
-            ],
-            'CNT_cur_dec_mrk' => [
-                'type'             => 'RADIO_BTN',
-                'input_name'       => "cntry[$CNT_ISO]",
-                'class'            => '',
-                'options'          => [
-                    [
-                        'id'   => ',',
-                        'text' => esc_html__(', (comma)', 'event_espresso'),
-                    ],
-                    ['id' => '.', 'text' => esc_html__('. (decimal)', 'event_espresso')],
-                ],
-                'use_desc_4_label' => true,
-                'disabled'         => $CNT_cur_disabled,
-            ],
-            'CNT_cur_thsnds'  => [
-                'type'             => 'RADIO_BTN',
-                'input_name'       => "cntry[$CNT_ISO]",
-                'class'            => '',
-                'options'          => [
-                    [
-                        'id'   => ',',
-                        'text' => esc_html__(', (comma)', 'event_espresso'),
-                    ],
-                    [
-                        'id'   => '.',
-                        'text' => esc_html__('. (decimal)', 'event_espresso'),
-                    ],
-                    [
-                        'id'   => ' ',
-                        'text' => esc_html__('(space)', 'event_espresso'),
-                    ],
-                    [
-                        'id'   => '_',
-                        'text' => esc_html__('_ (underscore)', 'event_espresso'),
-                    ],
-                    [
-                        'id'   => "'",
-                        'text' => esc_html__("' (apostrophe)", 'event_espresso'),
-                    ],
-                ],
-                'use_desc_4_label' => true,
-                'disabled'         => $CNT_cur_disabled,
-            ],
-            'CNT_tel_code'    => [
-                'type'       => 'TEXT',
-                'input_name' => "cntry[$CNT_ISO]",
-                'class'      => 'ee-input-width--small',
-            ],
-            'CNT_is_EU'       => [
-                'type'             => 'RADIO_BTN',
-                'input_name'       => "cntry[$CNT_ISO]",
-                'class'            => '',
-                'options'          => $this->_yes_no_values,
-                'use_desc_4_label' => true,
-            ],
-        ];
-        $this->_template_args['inputs'] = EE_Question_Form_Input::generate_question_form_inputs_for_object(
-            $country,
-            $country_input_types
-        );
-        $country_details_settings       = EEH_Template::display_template(
-            GEN_SET_TEMPLATE_PATH . 'country_details_settings.template.php',
-            $this->_template_args,
-            true
-        );
-
-        if (defined('DOING_AJAX')) {
-            $notices = EE_Error::get_notices(false, false, false);
-            echo wp_json_encode(
-                [
-                    'return_data' => $country_details_settings,
-                    'success'     => $notices['success'],
-                    'errors'      => $notices['errors'],
-                ]
-            );
-            die();
-        }
-        return $country_details_settings;
-    }
-
-
-    /**
-     * @param string          $CNT_ISO
-     * @param EE_Country|null $country
-     * @return string
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function display_country_states(string $CNT_ISO = '', ?EE_Country $country = null): string
-    {
-        $CNT_ISO = $this->getCountryISO($CNT_ISO);
-        if (! $CNT_ISO) {
-            return '';
-        }
-        // for ajax
-        remove_all_filters('FHEE__EEH_Form_Fields__label_html');
-        remove_all_filters('FHEE__EEH_Form_Fields__input_html');
-        add_filter('FHEE__EEH_Form_Fields__label_html', [$this, 'state_form_field_label_wrap'], 10, 2);
-        add_filter('FHEE__EEH_Form_Fields__input_html', [$this, 'state_form_field_input__wrap'], 10);
-        $states = EEM_State::instance()->get_all_states_for_these_countries([$CNT_ISO => $CNT_ISO]);
-        if (empty($states)) {
-            /** @var EventEspresso\core\services\address\CountrySubRegionDao $countrySubRegionDao */
-            $countrySubRegionDao = $this->loader->getShared(
-                'EventEspresso\core\services\address\CountrySubRegionDao'
-            );
-            if ($countrySubRegionDao instanceof EventEspresso\core\services\address\CountrySubRegionDao) {
-                $country = $this->verifyOrGetCountryFromIso($CNT_ISO, $country);
-                if ($countrySubRegionDao->saveCountrySubRegions($country)) {
-                    $states = EEM_State::instance()->get_all_states_for_these_countries([$CNT_ISO => $CNT_ISO]);
-                }
-            }
-        }
-        if (is_array($states)) {
-            foreach ($states as $STA_ID => $state) {
-                if ($state instanceof EE_State) {
-                    $inputs = EE_Question_Form_Input::generate_question_form_inputs_for_object(
-                        $state,
-                        [
-                            'STA_abbrev' => [
-                                'type'             => 'TEXT',
-                                'label'            => esc_html__('Code', 'event_espresso'),
-                                'input_name'       => "states[$STA_ID]",
-                                'class'            => 'ee-input-width--tiny',
-                                'add_mobile_label' => true,
-                            ],
-                            'STA_name'   => [
-                                'type'             => 'TEXT',
-                                'label'            => esc_html__('Name', 'event_espresso'),
-                                'input_name'       => "states[$STA_ID]",
-                                'class'            => 'ee-input-width--big',
-                                'add_mobile_label' => true,
-                            ],
-                            'STA_active' => [
-                                'type'             => 'RADIO_BTN',
-                                'label'            => esc_html__(
-                                    'State Appears in Dropdown Select Lists',
-                                    'event_espresso'
-                                ),
-                                'input_name'       => "states[$STA_ID]",
-                                'options'          => $this->_yes_no_values,
-                                'use_desc_4_label' => true,
-                                'add_mobile_label' => true,
-                            ],
-                        ]
-                    );
-
-                    $delete_state_url = EE_Admin_Page::add_query_args_and_nonce(
-                        [
-                            'action'     => 'delete_state',
-                            'STA_ID'     => $STA_ID,
-                            'CNT_ISO'    => $CNT_ISO,
-                            'STA_abbrev' => $state->abbrev(),
-                        ],
-                        GEN_SET_ADMIN_URL
-                    );
-
-                    $this->_template_args['states'][ $STA_ID ]['inputs']           = $inputs;
-                    $this->_template_args['states'][ $STA_ID ]['delete_state_url'] = $delete_state_url;
-                }
-            }
-        } else {
-            $this->_template_args['states'] = false;
-        }
-
-        $this->_template_args['add_new_state_url'] = EE_Admin_Page::add_query_args_and_nonce(
-            ['action' => 'add_new_state'],
-            GEN_SET_ADMIN_URL
-        );
-
-        $state_details_settings = EEH_Template::display_template(
-            GEN_SET_TEMPLATE_PATH . 'state_details_settings.template.php',
-            $this->_template_args,
-            true
-        );
-
-        if (defined('DOING_AJAX')) {
-            $notices = EE_Error::get_notices(false, false, false);
-            echo wp_json_encode(
-                [
-                    'return_data' => $state_details_settings,
-                    'success'     => $notices['success'],
-                    'errors'      => $notices['errors'],
-                ]
-            );
-            die();
-        }
-        return $state_details_settings;
-    }
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function add_new_state()
-    {
-        $success = true;
-        $CNT_ISO = $this->getCountryISO('');
-        if (! $CNT_ISO) {
-            EE_Error::add_error(
-                esc_html__('No Country ISO code or an invalid Country ISO code was received.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $success = false;
-        }
-        $STA_abbrev = $this->request->getRequestParam('STA_abbrev');
-        if (! $STA_abbrev) {
-            EE_Error::add_error(
-                esc_html__('No State ISO code or an invalid State ISO code was received.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $success = false;
-        }
-        $STA_name = $this->request->getRequestParam('STA_name');
-        if (! $STA_name) {
-            EE_Error::add_error(
-                esc_html__('No State name or an invalid State name was received.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $success = false;
-        }
-
-        if ($success) {
-            $cols_n_values = [
-                'CNT_ISO'    => $CNT_ISO,
-                'STA_abbrev' => $STA_abbrev,
-                'STA_name'   => $STA_name,
-                'STA_active' => true,
-            ];
-            $success       = EEM_State::instance()->insert($cols_n_values);
-            EE_Error::add_success(esc_html__('The State was added successfully.', 'event_espresso'));
-        }
-
-        if (defined('DOING_AJAX')) {
-            $notices = EE_Error::get_notices(false, false, false);
-            echo wp_json_encode(array_merge($notices, ['return_data' => $CNT_ISO]));
-            die();
-        }
-        $this->_redirect_after_action(
-            $success,
-            esc_html__('State', 'event_espresso'),
-            'added',
-            ['action' => 'country_settings']
-        );
-    }
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function delete_state()
-    {
-        $CNT_ISO    = $this->getCountryISO();
-        $STA_ID     = $this->request->getRequestParam('STA_ID');
-        $STA_abbrev = $this->request->getRequestParam('STA_abbrev');
-
-        if (! $STA_ID) {
-            EE_Error::add_error(
-                esc_html__('No State ID or an invalid State ID was received.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return;
-        }
-
-        $success = EEM_State::instance()->delete_by_ID($STA_ID);
-        if ($success !== false) {
-            do_action(
-                'AHEE__General_Settings_Admin_Page__delete_state__state_deleted',
-                $CNT_ISO,
-                $STA_ID,
-                ['STA_abbrev' => $STA_abbrev]
-            );
-            EE_Error::add_success(esc_html__('The State was deleted successfully.', 'event_espresso'));
-        }
-        if (defined('DOING_AJAX')) {
-            $notices                = EE_Error::get_notices(false);
-            $notices['return_data'] = true;
-            echo wp_json_encode($notices);
-            die();
-        }
-        $this->_redirect_after_action(
-            $success,
-            esc_html__('State', 'event_espresso'),
-            'deleted',
-            ['action' => 'country_settings']
-        );
-    }
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _update_country_settings()
-    {
-        $CNT_ISO = $this->getCountryISO();
-        if (! $CNT_ISO) {
-            EE_Error::add_error(
-                esc_html__('No Country ISO code or an invalid Country ISO code was received.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return;
-        }
-
-        $country = $this->verifyOrGetCountryFromIso($CNT_ISO);
-
-        $cols_n_values                    = [];
-        $cols_n_values['CNT_ISO3']        = strtoupper(
-            $this->request->getRequestParam('cntry', $country->ISO3())
-        );
-        $cols_n_values['CNT_name']        = $this->request->getRequestParam(
-            "cntry[$CNT_ISO][CNT_name]",
-            $country->name()
-        );
-        $cols_n_values['CNT_cur_code']    = strtoupper(
-            $this->request->getRequestParam(
-                "cntry[$CNT_ISO][CNT_cur_code]",
-                $country->currency_code()
-            )
-        );
-        $cols_n_values['CNT_cur_single']  = $this->request->getRequestParam(
-            "cntry[$CNT_ISO][CNT_cur_single]",
-            $country->currency_name_single()
-        );
-        $cols_n_values['CNT_cur_plural']  = $this->request->getRequestParam(
-            "cntry[$CNT_ISO][CNT_cur_plural]",
-            $country->currency_name_plural()
-        );
-        $cols_n_values['CNT_cur_sign']    = $this->request->getRequestParam(
-            "cntry[$CNT_ISO][CNT_cur_sign]",
-            $country->currency_sign()
-        );
-        $cols_n_values['CNT_cur_sign_b4'] = $this->request->getRequestParam(
-            "cntry[$CNT_ISO][CNT_cur_sign_b4]",
-            $country->currency_sign_before(),
-            DataType::BOOL
-        );
-        $cols_n_values['CNT_cur_dec_plc'] = $this->request->getRequestParam(
-            "cntry[$CNT_ISO][CNT_cur_dec_plc]",
-            $country->currency_decimal_places()
-        );
-        $cols_n_values['CNT_cur_dec_mrk'] = $this->request->getRequestParam(
-            "cntry[$CNT_ISO][CNT_cur_dec_mrk]",
-            $country->currency_decimal_mark()
-        );
-        $cols_n_values['CNT_cur_thsnds']  = $this->request->getRequestParam(
-            "cntry[$CNT_ISO][CNT_cur_thsnds]",
-            $country->currency_thousands_separator()
-        );
-        $cols_n_values['CNT_tel_code']    = $this->request->getRequestParam(
-            "cntry[$CNT_ISO][CNT_tel_code]",
-            $country->telephoneCode()
-        );
-        $cols_n_values['CNT_active']      = $this->request->getRequestParam(
-            "cntry[$CNT_ISO][CNT_active]",
-            $country->isActive(),
-            DataType::BOOL
-        );
-
-        // allow filtering of country data
-        $cols_n_values = apply_filters(
-            'FHEE__General_Settings_Admin_Page___update_country_settings__cols_n_values',
-            $cols_n_values
-        );
-
-        // where values
-        $where_cols_n_values = [['CNT_ISO' => $CNT_ISO]];
-        // run the update
-        $success = EEM_Country::instance()->update($cols_n_values, $where_cols_n_values);
-
-        // allow filtering of states data
-        $states = apply_filters(
-            'FHEE__General_Settings_Admin_Page___update_country_settings__states',
-            $this->request->getRequestParam('states', [], DataType::STRING, true)
-        );
-
-        if (! empty($states) && $success !== false) {
-            // loop thru state data ( looks like : states[75][STA_name] )
-            foreach ($states as $STA_ID => $state) {
-                $cols_n_values = [
-                    'CNT_ISO'    => $CNT_ISO,
-                    'STA_abbrev' => sanitize_text_field($state['STA_abbrev']),
-                    'STA_name'   => sanitize_text_field($state['STA_name']),
-                    'STA_active' => filter_var($state['STA_active'], FILTER_VALIDATE_BOOLEAN),
-                ];
-                // where values
-                $where_cols_n_values = [['STA_ID' => $STA_ID]];
-                // run the update
-                $success = EEM_State::instance()->update($cols_n_values, $where_cols_n_values);
-                if ($success !== false) {
-                    do_action(
-                        'AHEE__General_Settings_Admin_Page__update_country_settings__state_saved',
-                        $CNT_ISO,
-                        $STA_ID,
-                        $cols_n_values
-                    );
-                }
-            }
-        }
-        // check if country being edited matches org option country, and if so, then  update EE_Config with new settings
-        if (
-            isset(EE_Registry::instance()->CFG->organization->CNT_ISO)
-            && $CNT_ISO == EE_Registry::instance()->CFG->organization->CNT_ISO
-        ) {
-            EE_Registry::instance()->CFG->currency = new EE_Currency_Config($CNT_ISO);
-            EE_Registry::instance()->CFG->update_espresso_config();
-        }
-
-        if ($success !== false) {
-            EE_Error::add_success(
-                esc_html__('Country Settings updated successfully.', 'event_espresso')
-            );
-        }
-        $this->_redirect_after_action(
-            $success,
-            '',
-            '',
-            ['action' => 'country_settings', 'country' => $CNT_ISO],
-            true
-        );
-    }
-
-
-    /**
-     * form_form_field_label_wrap
-     *
-     * @param string $label
-     * @return string
-     */
-    public function country_form_field_label_wrap(string $label): string
-    {
-        return '
+	/**
+	 * @var EE_Core_Config
+	 */
+	public $core_config;
+
+
+	/**
+	 * Initialize basic properties.
+	 */
+	protected function _init_page_props()
+	{
+		$this->page_slug        = GEN_SET_PG_SLUG;
+		$this->page_label       = GEN_SET_LABEL;
+		$this->_admin_base_url  = GEN_SET_ADMIN_URL;
+		$this->_admin_base_path = GEN_SET_ADMIN;
+
+		$this->core_config = EE_Registry::instance()->CFG->core;
+	}
+
+
+	/**
+	 * Set ajax hooks
+	 */
+	protected function _ajax_hooks()
+	{
+		add_action('wp_ajax_espresso_display_country_settings', [$this, 'display_country_settings']);
+		add_action('wp_ajax_espresso_display_country_states', [$this, 'display_country_states']);
+		add_action('wp_ajax_espresso_delete_state', [$this, 'delete_state'], 10, 3);
+		add_action('wp_ajax_espresso_add_new_state', [$this, 'add_new_state']);
+	}
+
+
+	/**
+	 * More page properties initialization.
+	 */
+	protected function _define_page_props()
+	{
+		$this->_admin_page_title = GEN_SET_LABEL;
+		$this->_labels           = ['publishbox' => esc_html__('Update Settings', 'event_espresso')];
+	}
+
+
+	/**
+	 * Set page routes property.
+	 */
+	protected function _set_page_routes()
+	{
+		$this->_page_routes = [
+			'critical_pages'                => [
+				'func'       => '_espresso_page_settings',
+				'capability' => 'manage_options',
+			],
+			'update_espresso_page_settings' => [
+				'func'       => '_update_espresso_page_settings',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+			],
+			'default'                       => [
+				'func'       => '_your_organization_settings',
+				'capability' => 'manage_options',
+			],
+
+			'update_your_organization_settings' => [
+				'func'       => '_update_your_organization_settings',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+			],
+
+			'admin_option_settings' => [
+				'func'       => '_admin_option_settings',
+				'capability' => 'manage_options',
+			],
+
+			'update_admin_option_settings' => [
+				'func'       => '_update_admin_option_settings',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+			],
+
+			'country_settings' => [
+				'func'       => '_country_settings',
+				'capability' => 'manage_options',
+			],
+
+			'update_country_settings' => [
+				'func'       => '_update_country_settings',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+			],
+
+			'display_country_settings' => [
+				'func'       => 'display_country_settings',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+			],
+
+			'add_new_state' => [
+				'func'       => 'add_new_state',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+			],
+
+			'delete_state'            => [
+				'func'       => 'delete_state',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+			],
+			'privacy_settings'        => [
+				'func'       => 'privacySettings',
+				'capability' => 'manage_options',
+			],
+			'update_privacy_settings' => [
+				'func'               => 'updatePrivacySettings',
+				'capability'         => 'manage_options',
+				'noheader'           => true,
+				'headers_sent_route' => 'privacy_settings',
+			],
+		];
+	}
+
+
+	/**
+	 * Set page configuration property
+	 */
+	protected function _set_page_config()
+	{
+		$this->_page_config = [
+			'critical_pages'        => [
+				'nav'           => [
+					'label' => esc_html__('Critical Pages', 'event_espresso'),
+					'icon' => 'dashicons-warning',
+					'order' => 50,
+				],
+				'metaboxes'     => array_merge($this->_default_espresso_metaboxes, ['_publish_post_box']),
+				'help_tabs'     => [
+					'general_settings_critical_pages_help_tab' => [
+						'title'    => esc_html__('Critical Pages', 'event_espresso'),
+						'filename' => 'general_settings_critical_pages',
+					],
+				],
+				'require_nonce' => false,
+			],
+			'default'               => [
+				'nav'           => [
+					'label' => esc_html__('Your Organization', 'event_espresso'),
+					'icon' => 'dashicons-admin-home',
+					'order' => 20,
+				],
+				'help_tabs'     => [
+					'general_settings_your_organization_help_tab' => [
+						'title'    => esc_html__('Your Organization', 'event_espresso'),
+						'filename' => 'general_settings_your_organization',
+					],
+				],
+				'metaboxes'     => array_merge($this->_default_espresso_metaboxes, ['_publish_post_box']),
+				'require_nonce' => false,
+			],
+			'admin_option_settings' => [
+				'nav'           => [
+					'label' => esc_html__('Admin Options', 'event_espresso'),
+					'icon' => 'dashicons-admin-settings',
+					'order' => 60,
+				],
+				'metaboxes'     => array_merge($this->_default_espresso_metaboxes, ['_publish_post_box']),
+				'help_tabs'     => [
+					'general_settings_admin_options_help_tab' => [
+						'title'    => esc_html__('Admin Options', 'event_espresso'),
+						'filename' => 'general_settings_admin_options',
+					],
+				],
+				'require_nonce' => false,
+			],
+			'country_settings'      => [
+				'nav'           => [
+					'label' => esc_html__('Countries', 'event_espresso'),
+					'icon' => 'dashicons-admin-site',
+					'order' => 70,
+				],
+				'help_tabs'     => [
+					'general_settings_countries_help_tab' => [
+						'title'    => esc_html__('Countries', 'event_espresso'),
+						'filename' => 'general_settings_countries',
+					],
+				],
+				'require_nonce' => false,
+			],
+			'privacy_settings'      => [
+				'nav'           => [
+					'label' => esc_html__('Privacy', 'event_espresso'),
+					'icon' => 'dashicons-privacy',
+					'order' => 80,
+				],
+				'metaboxes'     => array_merge($this->_default_espresso_metaboxes, ['_publish_post_box']),
+				'require_nonce' => false,
+			],
+		];
+	}
+
+
+	protected function _add_screen_options()
+	{
+	}
+
+
+	protected function _add_feature_pointers()
+	{
+	}
+
+
+	/**
+	 * Enqueue global scripts and styles for all routes in the General Settings Admin Pages.
+	 */
+	public function load_scripts_styles()
+	{
+		// styles
+		wp_enqueue_style('espresso-ui-theme');
+		// scripts
+		wp_enqueue_script('ee_admin_js');
+	}
+
+
+	/**
+	 * Execute logic running on `admin_init`
+	 */
+	public function admin_init()
+	{
+		EE_Registry::$i18n_js_strings['invalid_server_response'] = wp_strip_all_tags(
+			esc_html__(
+				'An error occurred! Your request may have been processed, but a valid response from the server was not received. Please refresh the page and try again.',
+				'event_espresso'
+			)
+		);
+		EE_Registry::$i18n_js_strings['error_occurred']          = wp_strip_all_tags(
+			esc_html__(
+				'An error occurred! Please refresh the page and try again.',
+				'event_espresso'
+			)
+		);
+		EE_Registry::$i18n_js_strings['confirm_delete_state']    = wp_strip_all_tags(
+			esc_html__(
+				'Are you sure you want to delete this State / Province?',
+				'event_espresso'
+			)
+		);
+		EE_Registry::$i18n_js_strings['ajax_url']                = admin_url(
+			'admin-ajax.php?page=espresso_general_settings',
+			is_ssl() ? 'https://' : 'http://'
+		);
+	}
+
+
+	public function admin_notices()
+	{
+	}
+
+
+	public function admin_footer_scripts()
+	{
+	}
+
+
+	/**
+	 * Enqueue scripts and styles for the default route.
+	 */
+	public function load_scripts_styles_default()
+	{
+		// styles
+		wp_enqueue_style('thickbox');
+		// scripts
+		wp_enqueue_script('media-upload');
+		wp_enqueue_script('thickbox');
+		wp_register_script(
+			'organization_settings',
+			GEN_SET_ASSETS_URL . 'your_organization_settings.js',
+			['jquery', 'media-upload', 'thickbox'],
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_register_style('organization-css', GEN_SET_ASSETS_URL . 'organization.css', [], EVENT_ESPRESSO_VERSION);
+		wp_enqueue_script('organization_settings');
+		wp_enqueue_style('organization-css');
+		$confirm_image_delete = [
+			'text' => wp_strip_all_tags(
+				esc_html__(
+					'Do you really want to delete this image? Please remember to save your settings to complete the removal.',
+					'event_espresso'
+				)
+			),
+		];
+		wp_localize_script('organization_settings', 'confirm_image_delete', $confirm_image_delete);
+	}
+
+
+	/**
+	 * Enqueue scripts and styles for the country settings route.
+	 */
+	public function load_scripts_styles_country_settings()
+	{
+		// scripts
+		wp_register_script(
+			'gen_settings_countries',
+			GEN_SET_ASSETS_URL . 'gen_settings_countries.js',
+			['ee_admin_js'],
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_register_style('organization-css', GEN_SET_ASSETS_URL . 'organization.css', [], EVENT_ESPRESSO_VERSION);
+		wp_enqueue_script('gen_settings_countries');
+		wp_enqueue_style('organization-css');
+	}
+
+
+	/*************        Espresso Pages        *************/
+	/**
+	 * _espresso_page_settings
+	 *
+	 * @throws EE_Error
+	 * @throws DomainException
+	 * @throws DomainException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidArgumentException
+	 */
+	protected function _espresso_page_settings()
+	{
+		// Check to make sure all of the main pages are set up properly,
+		// if not create the default pages and display an admin notice
+		EEH_Activation::verify_default_pages_exist();
+		$this->_transient_garbage_collection();
+
+		$this->_template_args['values'] = $this->_yes_no_values;
+
+		$this->_template_args['reg_page_id']  = $this->core_config->reg_page_id ?? null;
+		$this->_template_args['reg_page_obj'] = isset($this->core_config->reg_page_id)
+			? get_post($this->core_config->reg_page_id)
+			: false;
+
+		$this->_template_args['txn_page_id']  = $this->core_config->txn_page_id ?? null;
+		$this->_template_args['txn_page_obj'] = isset($this->core_config->txn_page_id)
+			? get_post($this->core_config->txn_page_id)
+			: false;
+
+		$this->_template_args['thank_you_page_id']  = $this->core_config->thank_you_page_id ?? null;
+		$this->_template_args['thank_you_page_obj'] = isset($this->core_config->thank_you_page_id)
+			? get_post($this->core_config->thank_you_page_id)
+			: false;
+
+		$this->_template_args['cancel_page_id']  = $this->core_config->cancel_page_id ?? null;
+		$this->_template_args['cancel_page_obj'] = isset($this->core_config->cancel_page_id)
+			? get_post($this->core_config->cancel_page_id)
+			: false;
+
+		$this->_set_add_edit_form_tags('update_espresso_page_settings');
+		$this->_set_publish_post_box_vars(null, false, false, null, false);
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(
+			GEN_SET_TEMPLATE_PATH . 'espresso_page_settings.template.php',
+			$this->_template_args,
+			true
+		);
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	/**
+	 * Handler for updating espresso page settings.
+	 *
+	 * @throws EE_Error
+	 */
+	protected function _update_espresso_page_settings()
+	{
+		$this->core_config = EE_Registry::instance()->CFG->core;
+		// capture incoming request data && set page IDs
+		$this->core_config->reg_page_id       = $this->request->getRequestParam(
+			'reg_page_id',
+			$this->core_config->reg_page_id,
+			DataType::INT
+		);
+		$this->core_config->txn_page_id       = $this->request->getRequestParam(
+			'txn_page_id',
+			$this->core_config->txn_page_id,
+			DataType::INT
+		);
+		$this->core_config->thank_you_page_id = $this->request->getRequestParam(
+			'thank_you_page_id',
+			$this->core_config->thank_you_page_id,
+			DataType::INT
+		);
+		$this->core_config->cancel_page_id    = $this->request->getRequestParam(
+			'cancel_page_id',
+			$this->core_config->cancel_page_id,
+			DataType::INT
+		);
+
+		$this->core_config = apply_filters(
+			'FHEE__General_Settings_Admin_Page___update_espresso_page_settings__CFG_core',
+			$this->core_config,
+			$this->request->requestParams()
+		);
+
+		$what = esc_html__('Critical Pages & Shortcodes', 'event_espresso');
+		$this->_redirect_after_action(
+			$this->_update_espresso_configuration(
+				$what,
+				$this->core_config,
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			),
+			$what,
+			'',
+			[
+				'action' => 'critical_pages',
+			],
+			true
+		);
+	}
+
+
+	/*************        Your Organization        *************/
+
+
+	/**
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _your_organization_settings()
+	{
+		$this->_template_args['admin_page_content'] = '';
+		try {
+			/** @var OrganizationSettings $organization_settings_form */
+			$organization_settings_form = $this->loader->getShared(OrganizationSettings::class);
+
+			$this->_template_args['admin_page_content'] = EEH_HTML::div(
+				$organization_settings_form->display(),
+				'',
+				'padding'
+			);
+		} catch (Exception $e) {
+			EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
+		}
+		$this->_set_add_edit_form_tags('update_your_organization_settings');
+		$this->_set_publish_post_box_vars(null, false, false, null, false);
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	/**
+	 * Handler for updating organization settings.
+	 *
+	 * @throws EE_Error
+	 */
+	protected function _update_your_organization_settings()
+	{
+		try {
+			/** @var OrganizationSettings $organization_settings_form */
+			$organization_settings_form = $this->loader->getShared(OrganizationSettings::class);
+
+			$success = $organization_settings_form->process($this->request->requestParams());
+
+			EE_Registry::instance()->CFG = apply_filters(
+				'FHEE__General_Settings_Admin_Page___update_your_organization_settings__CFG',
+				EE_Registry::instance()->CFG
+			);
+		} catch (Exception $e) {
+			EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
+			$success = false;
+		}
+
+		if ($success) {
+			$success = $this->_update_espresso_configuration(
+				esc_html__('Your Organization Settings', 'event_espresso'),
+				EE_Registry::instance()->CFG,
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+
+		$this->_redirect_after_action($success, '', '', ['action' => 'default'], true);
+	}
+
+
+
+	/*************        Admin Options        *************/
+
+
+	/**
+	 * _admin_option_settings
+	 *
+	 * @throws EE_Error
+	 * @throws LogicException
+	 */
+	protected function _admin_option_settings()
+	{
+		$this->_template_args['admin_page_content'] = '';
+		try {
+			$admin_options_settings_form = new AdminOptionsSettings(EE_Registry::instance());
+			// still need this for the old school form in Extend_General_Settings_Admin_Page
+			$this->_template_args['values'] = $this->_yes_no_values;
+			// also need to account for the do_action that was in the old template
+			$admin_options_settings_form->setTemplateArgs($this->_template_args);
+			$this->_template_args['admin_page_content'] = EEH_HTML::div(
+				$admin_options_settings_form->display(),
+				'',
+				'padding'
+			);
+		} catch (Exception $e) {
+			EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
+		}
+		$this->_set_add_edit_form_tags('update_admin_option_settings');
+		$this->_set_publish_post_box_vars(null, false, false, null, false);
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	/**
+	 * _update_admin_option_settings
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidFormSubmissionException
+	 * @throws InvalidArgumentException
+	 * @throws LogicException
+	 */
+	protected function _update_admin_option_settings()
+	{
+		try {
+			$admin_options_settings_form = new AdminOptionsSettings(EE_Registry::instance());
+			$admin_options_settings_form->process(
+				$this->request->getRequestParam(
+					$admin_options_settings_form->slug(),
+					[],
+					DataType::STRING,
+					true
+				)
+			);
+			EE_Registry::instance()->CFG->admin = apply_filters(
+				'FHEE__General_Settings_Admin_Page___update_admin_option_settings__CFG_admin',
+				EE_Registry::instance()->CFG->admin
+			);
+		} catch (Exception $e) {
+			EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
+		}
+		$this->_redirect_after_action(
+			apply_filters(
+				'FHEE__General_Settings_Admin_Page___update_admin_option_settings__success',
+				$this->_update_espresso_configuration(
+					esc_html__('Admin Options', 'event_espresso'),
+					EE_Registry::instance()->CFG->admin,
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				)
+			),
+			esc_html__('Admin Options', 'event_espresso'),
+			'updated',
+			['action' => 'admin_option_settings']
+		);
+	}
+
+
+	/*************        Countries        *************/
+
+
+	/**
+	 * @param string|null $default
+	 * @return string
+	 */
+	protected function getCountryISO(?string $default = null): string
+	{
+		$default = $default ?? $this->getCountryIsoForSite();
+		$CNT_ISO = $this->request->getRequestParam('country', $default);
+		$CNT_ISO = $this->request->getRequestParam('CNT_ISO', $CNT_ISO);
+		return strtoupper($CNT_ISO);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	protected function getCountryIsoForSite(): string
+	{
+		return ! empty(EE_Registry::instance()->CFG->organization->CNT_ISO)
+			? EE_Registry::instance()->CFG->organization->CNT_ISO
+			: 'US';
+	}
+
+
+	/**
+	 * @param string          $CNT_ISO
+	 * @param EE_Country|null $country
+	 * @return EE_Base_Class|EE_Country
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function verifyOrGetCountryFromIso(string $CNT_ISO, ?EE_Country $country = null)
+	{
+		/** @var EE_Country $country */
+		return $country instanceof EE_Country && $country->ID() === $CNT_ISO
+			? $country
+			: EEM_Country::instance()->get_one_by_ID($CNT_ISO);
+	}
+
+
+	/**
+	 * Output Country Settings view.
+	 *
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _country_settings()
+	{
+		$CNT_ISO = $this->getCountryISO();
+
+		$this->_template_args['values']    = $this->_yes_no_values;
+		$this->_template_args['countries'] = new EE_Question_Form_Input(
+			EE_Question::new_instance(
+				[
+				  'QST_ID'           => 0,
+				  'QST_display_text' => esc_html__('Select Country', 'event_espresso'),
+				  'QST_system'       => 'admin-country',
+				]
+			),
+			EE_Answer::new_instance(
+				[
+					'ANS_ID'    => 0,
+					'ANS_value' => $CNT_ISO,
+				]
+			),
+			[
+				'input_id'       => 'country',
+				'input_name'     => 'country',
+				'input_prefix'   => '',
+				'append_qstn_id' => false,
+			]
+		);
+
+		$country = $this->verifyOrGetCountryFromIso($CNT_ISO);
+		add_filter('FHEE__EEH_Form_Fields__label_html', [$this, 'country_form_field_label_wrap'], 10);
+		add_filter('FHEE__EEH_Form_Fields__input_html', [$this, 'country_form_field_input__wrap'], 10);
+		$this->_template_args['country_details_settings'] = $this->display_country_settings(
+			$country->ID(),
+			$country
+		);
+		$this->_template_args['country_states_settings']  = $this->display_country_states(
+			$country->ID(),
+			$country
+		);
+		$this->_template_args['CNT_name_for_site']        = $country->name();
+
+		$this->_set_add_edit_form_tags('update_country_settings');
+		$this->_set_publish_post_box_vars(null, false, false, null, false);
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(
+			GEN_SET_TEMPLATE_PATH . 'countries_settings.template.php',
+			$this->_template_args,
+			true
+		);
+		$this->display_admin_page_with_no_sidebar();
+	}
+
+
+	/**
+	 * @param string          $CNT_ISO
+	 * @param EE_Country|null $country
+	 * @return string
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function display_country_settings(string $CNT_ISO = '', ?EE_Country $country = null): string
+	{
+		$CNT_ISO          = $this->getCountryISO($CNT_ISO);
+		$CNT_ISO_for_site = $this->getCountryIsoForSite();
+
+		if (! $CNT_ISO) {
+			return '';
+		}
+
+		// for ajax
+		remove_all_filters('FHEE__EEH_Form_Fields__label_html');
+		remove_all_filters('FHEE__EEH_Form_Fields__input_html');
+		add_filter('FHEE__EEH_Form_Fields__label_html', [$this, 'country_form_field_label_wrap'], 10, 2);
+		add_filter('FHEE__EEH_Form_Fields__input_html', [$this, 'country_form_field_input__wrap'], 10, 2);
+		$country                                  = $this->verifyOrGetCountryFromIso($CNT_ISO, $country);
+		$CNT_cur_disabled                         = $CNT_ISO !== $CNT_ISO_for_site;
+		$this->_template_args['CNT_cur_disabled'] = $CNT_cur_disabled;
+
+		$country_input_types            = [
+			'CNT_active'      => [
+				'type'             => 'RADIO_BTN',
+				'input_name'       => "cntry[$CNT_ISO]",
+				'class'            => '',
+				'options'          => $this->_yes_no_values,
+				'use_desc_4_label' => true,
+			],
+			'CNT_ISO'         => [
+				'type'       => 'TEXT',
+				'input_name' => "cntry[$CNT_ISO]",
+				'class'      => 'ee-input-width--small',
+			],
+			'CNT_ISO3'        => [
+				'type'       => 'TEXT',
+				'input_name' => "cntry[$CNT_ISO]",
+				'class'      => 'ee-input-width--small',
+			],
+			// 'RGN_ID'          => [
+			//     'type'       => 'TEXT',
+			//     'input_name' => "cntry[$CNT_ISO]",
+			//     'class'      => 'ee-input-width--small',
+			// ],
+			'CNT_name'        => [
+				'type'       => 'TEXT',
+				'input_name' => "cntry[$CNT_ISO]",
+				'class'      => 'ee-input-width--big',
+			],
+			'CNT_cur_code'    => [
+				'type'       => 'TEXT',
+				'input_name' => "cntry[$CNT_ISO]",
+				'class'      => 'ee-input-width--small',
+				'disabled'   => $CNT_cur_disabled,
+			],
+			'CNT_cur_single'  => [
+				'type'       => 'TEXT',
+				'input_name' => "cntry[$CNT_ISO]",
+				'class'      => 'ee-input-width--reg',
+				'disabled'   => $CNT_cur_disabled,
+			],
+			'CNT_cur_plural'  => [
+				'type'       => 'TEXT',
+				'input_name' => "cntry[$CNT_ISO]",
+				'class'      => 'ee-input-width--reg',
+				'disabled'   => $CNT_cur_disabled,
+			],
+			'CNT_cur_sign'    => [
+				'type'         => 'TEXT',
+				'input_name'   => "cntry[$CNT_ISO]",
+				'class'        => 'ee-input-width--small',
+				'htmlentities' => false,
+				'disabled'     => $CNT_cur_disabled,
+			],
+			'CNT_cur_sign_b4' => [
+				'type'             => 'RADIO_BTN',
+				'input_name'       => "cntry[$CNT_ISO]",
+				'class'            => '',
+				'options'          => $this->_yes_no_values,
+				'use_desc_4_label' => true,
+				'disabled'         => $CNT_cur_disabled,
+			],
+			'CNT_cur_dec_plc' => [
+				'type'       => 'RADIO_BTN',
+				'input_name' => "cntry[$CNT_ISO]",
+				'class'      => '',
+				'options'    => [
+					['id' => 0, 'text' => ''],
+					['id' => 1, 'text' => ''],
+					['id' => 2, 'text' => ''],
+					['id' => 3, 'text' => ''],
+				],
+				'disabled'   => $CNT_cur_disabled,
+			],
+			'CNT_cur_dec_mrk' => [
+				'type'             => 'RADIO_BTN',
+				'input_name'       => "cntry[$CNT_ISO]",
+				'class'            => '',
+				'options'          => [
+					[
+						'id'   => ',',
+						'text' => esc_html__(', (comma)', 'event_espresso'),
+					],
+					['id' => '.', 'text' => esc_html__('. (decimal)', 'event_espresso')],
+				],
+				'use_desc_4_label' => true,
+				'disabled'         => $CNT_cur_disabled,
+			],
+			'CNT_cur_thsnds'  => [
+				'type'             => 'RADIO_BTN',
+				'input_name'       => "cntry[$CNT_ISO]",
+				'class'            => '',
+				'options'          => [
+					[
+						'id'   => ',',
+						'text' => esc_html__(', (comma)', 'event_espresso'),
+					],
+					[
+						'id'   => '.',
+						'text' => esc_html__('. (decimal)', 'event_espresso'),
+					],
+					[
+						'id'   => ' ',
+						'text' => esc_html__('(space)', 'event_espresso'),
+					],
+					[
+						'id'   => '_',
+						'text' => esc_html__('_ (underscore)', 'event_espresso'),
+					],
+					[
+						'id'   => "'",
+						'text' => esc_html__("' (apostrophe)", 'event_espresso'),
+					],
+				],
+				'use_desc_4_label' => true,
+				'disabled'         => $CNT_cur_disabled,
+			],
+			'CNT_tel_code'    => [
+				'type'       => 'TEXT',
+				'input_name' => "cntry[$CNT_ISO]",
+				'class'      => 'ee-input-width--small',
+			],
+			'CNT_is_EU'       => [
+				'type'             => 'RADIO_BTN',
+				'input_name'       => "cntry[$CNT_ISO]",
+				'class'            => '',
+				'options'          => $this->_yes_no_values,
+				'use_desc_4_label' => true,
+			],
+		];
+		$this->_template_args['inputs'] = EE_Question_Form_Input::generate_question_form_inputs_for_object(
+			$country,
+			$country_input_types
+		);
+		$country_details_settings       = EEH_Template::display_template(
+			GEN_SET_TEMPLATE_PATH . 'country_details_settings.template.php',
+			$this->_template_args,
+			true
+		);
+
+		if (defined('DOING_AJAX')) {
+			$notices = EE_Error::get_notices(false, false, false);
+			echo wp_json_encode(
+				[
+					'return_data' => $country_details_settings,
+					'success'     => $notices['success'],
+					'errors'      => $notices['errors'],
+				]
+			);
+			die();
+		}
+		return $country_details_settings;
+	}
+
+
+	/**
+	 * @param string          $CNT_ISO
+	 * @param EE_Country|null $country
+	 * @return string
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function display_country_states(string $CNT_ISO = '', ?EE_Country $country = null): string
+	{
+		$CNT_ISO = $this->getCountryISO($CNT_ISO);
+		if (! $CNT_ISO) {
+			return '';
+		}
+		// for ajax
+		remove_all_filters('FHEE__EEH_Form_Fields__label_html');
+		remove_all_filters('FHEE__EEH_Form_Fields__input_html');
+		add_filter('FHEE__EEH_Form_Fields__label_html', [$this, 'state_form_field_label_wrap'], 10, 2);
+		add_filter('FHEE__EEH_Form_Fields__input_html', [$this, 'state_form_field_input__wrap'], 10);
+		$states = EEM_State::instance()->get_all_states_for_these_countries([$CNT_ISO => $CNT_ISO]);
+		if (empty($states)) {
+			/** @var EventEspresso\core\services\address\CountrySubRegionDao $countrySubRegionDao */
+			$countrySubRegionDao = $this->loader->getShared(
+				'EventEspresso\core\services\address\CountrySubRegionDao'
+			);
+			if ($countrySubRegionDao instanceof EventEspresso\core\services\address\CountrySubRegionDao) {
+				$country = $this->verifyOrGetCountryFromIso($CNT_ISO, $country);
+				if ($countrySubRegionDao->saveCountrySubRegions($country)) {
+					$states = EEM_State::instance()->get_all_states_for_these_countries([$CNT_ISO => $CNT_ISO]);
+				}
+			}
+		}
+		if (is_array($states)) {
+			foreach ($states as $STA_ID => $state) {
+				if ($state instanceof EE_State) {
+					$inputs = EE_Question_Form_Input::generate_question_form_inputs_for_object(
+						$state,
+						[
+							'STA_abbrev' => [
+								'type'             => 'TEXT',
+								'label'            => esc_html__('Code', 'event_espresso'),
+								'input_name'       => "states[$STA_ID]",
+								'class'            => 'ee-input-width--tiny',
+								'add_mobile_label' => true,
+							],
+							'STA_name'   => [
+								'type'             => 'TEXT',
+								'label'            => esc_html__('Name', 'event_espresso'),
+								'input_name'       => "states[$STA_ID]",
+								'class'            => 'ee-input-width--big',
+								'add_mobile_label' => true,
+							],
+							'STA_active' => [
+								'type'             => 'RADIO_BTN',
+								'label'            => esc_html__(
+									'State Appears in Dropdown Select Lists',
+									'event_espresso'
+								),
+								'input_name'       => "states[$STA_ID]",
+								'options'          => $this->_yes_no_values,
+								'use_desc_4_label' => true,
+								'add_mobile_label' => true,
+							],
+						]
+					);
+
+					$delete_state_url = EE_Admin_Page::add_query_args_and_nonce(
+						[
+							'action'     => 'delete_state',
+							'STA_ID'     => $STA_ID,
+							'CNT_ISO'    => $CNT_ISO,
+							'STA_abbrev' => $state->abbrev(),
+						],
+						GEN_SET_ADMIN_URL
+					);
+
+					$this->_template_args['states'][ $STA_ID ]['inputs']           = $inputs;
+					$this->_template_args['states'][ $STA_ID ]['delete_state_url'] = $delete_state_url;
+				}
+			}
+		} else {
+			$this->_template_args['states'] = false;
+		}
+
+		$this->_template_args['add_new_state_url'] = EE_Admin_Page::add_query_args_and_nonce(
+			['action' => 'add_new_state'],
+			GEN_SET_ADMIN_URL
+		);
+
+		$state_details_settings = EEH_Template::display_template(
+			GEN_SET_TEMPLATE_PATH . 'state_details_settings.template.php',
+			$this->_template_args,
+			true
+		);
+
+		if (defined('DOING_AJAX')) {
+			$notices = EE_Error::get_notices(false, false, false);
+			echo wp_json_encode(
+				[
+					'return_data' => $state_details_settings,
+					'success'     => $notices['success'],
+					'errors'      => $notices['errors'],
+				]
+			);
+			die();
+		}
+		return $state_details_settings;
+	}
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function add_new_state()
+	{
+		$success = true;
+		$CNT_ISO = $this->getCountryISO('');
+		if (! $CNT_ISO) {
+			EE_Error::add_error(
+				esc_html__('No Country ISO code or an invalid Country ISO code was received.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$success = false;
+		}
+		$STA_abbrev = $this->request->getRequestParam('STA_abbrev');
+		if (! $STA_abbrev) {
+			EE_Error::add_error(
+				esc_html__('No State ISO code or an invalid State ISO code was received.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$success = false;
+		}
+		$STA_name = $this->request->getRequestParam('STA_name');
+		if (! $STA_name) {
+			EE_Error::add_error(
+				esc_html__('No State name or an invalid State name was received.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$success = false;
+		}
+
+		if ($success) {
+			$cols_n_values = [
+				'CNT_ISO'    => $CNT_ISO,
+				'STA_abbrev' => $STA_abbrev,
+				'STA_name'   => $STA_name,
+				'STA_active' => true,
+			];
+			$success       = EEM_State::instance()->insert($cols_n_values);
+			EE_Error::add_success(esc_html__('The State was added successfully.', 'event_espresso'));
+		}
+
+		if (defined('DOING_AJAX')) {
+			$notices = EE_Error::get_notices(false, false, false);
+			echo wp_json_encode(array_merge($notices, ['return_data' => $CNT_ISO]));
+			die();
+		}
+		$this->_redirect_after_action(
+			$success,
+			esc_html__('State', 'event_espresso'),
+			'added',
+			['action' => 'country_settings']
+		);
+	}
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function delete_state()
+	{
+		$CNT_ISO    = $this->getCountryISO();
+		$STA_ID     = $this->request->getRequestParam('STA_ID');
+		$STA_abbrev = $this->request->getRequestParam('STA_abbrev');
+
+		if (! $STA_ID) {
+			EE_Error::add_error(
+				esc_html__('No State ID or an invalid State ID was received.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return;
+		}
+
+		$success = EEM_State::instance()->delete_by_ID($STA_ID);
+		if ($success !== false) {
+			do_action(
+				'AHEE__General_Settings_Admin_Page__delete_state__state_deleted',
+				$CNT_ISO,
+				$STA_ID,
+				['STA_abbrev' => $STA_abbrev]
+			);
+			EE_Error::add_success(esc_html__('The State was deleted successfully.', 'event_espresso'));
+		}
+		if (defined('DOING_AJAX')) {
+			$notices                = EE_Error::get_notices(false);
+			$notices['return_data'] = true;
+			echo wp_json_encode($notices);
+			die();
+		}
+		$this->_redirect_after_action(
+			$success,
+			esc_html__('State', 'event_espresso'),
+			'deleted',
+			['action' => 'country_settings']
+		);
+	}
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _update_country_settings()
+	{
+		$CNT_ISO = $this->getCountryISO();
+		if (! $CNT_ISO) {
+			EE_Error::add_error(
+				esc_html__('No Country ISO code or an invalid Country ISO code was received.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return;
+		}
+
+		$country = $this->verifyOrGetCountryFromIso($CNT_ISO);
+
+		$cols_n_values                    = [];
+		$cols_n_values['CNT_ISO3']        = strtoupper(
+			$this->request->getRequestParam('cntry', $country->ISO3())
+		);
+		$cols_n_values['CNT_name']        = $this->request->getRequestParam(
+			"cntry[$CNT_ISO][CNT_name]",
+			$country->name()
+		);
+		$cols_n_values['CNT_cur_code']    = strtoupper(
+			$this->request->getRequestParam(
+				"cntry[$CNT_ISO][CNT_cur_code]",
+				$country->currency_code()
+			)
+		);
+		$cols_n_values['CNT_cur_single']  = $this->request->getRequestParam(
+			"cntry[$CNT_ISO][CNT_cur_single]",
+			$country->currency_name_single()
+		);
+		$cols_n_values['CNT_cur_plural']  = $this->request->getRequestParam(
+			"cntry[$CNT_ISO][CNT_cur_plural]",
+			$country->currency_name_plural()
+		);
+		$cols_n_values['CNT_cur_sign']    = $this->request->getRequestParam(
+			"cntry[$CNT_ISO][CNT_cur_sign]",
+			$country->currency_sign()
+		);
+		$cols_n_values['CNT_cur_sign_b4'] = $this->request->getRequestParam(
+			"cntry[$CNT_ISO][CNT_cur_sign_b4]",
+			$country->currency_sign_before(),
+			DataType::BOOL
+		);
+		$cols_n_values['CNT_cur_dec_plc'] = $this->request->getRequestParam(
+			"cntry[$CNT_ISO][CNT_cur_dec_plc]",
+			$country->currency_decimal_places()
+		);
+		$cols_n_values['CNT_cur_dec_mrk'] = $this->request->getRequestParam(
+			"cntry[$CNT_ISO][CNT_cur_dec_mrk]",
+			$country->currency_decimal_mark()
+		);
+		$cols_n_values['CNT_cur_thsnds']  = $this->request->getRequestParam(
+			"cntry[$CNT_ISO][CNT_cur_thsnds]",
+			$country->currency_thousands_separator()
+		);
+		$cols_n_values['CNT_tel_code']    = $this->request->getRequestParam(
+			"cntry[$CNT_ISO][CNT_tel_code]",
+			$country->telephoneCode()
+		);
+		$cols_n_values['CNT_active']      = $this->request->getRequestParam(
+			"cntry[$CNT_ISO][CNT_active]",
+			$country->isActive(),
+			DataType::BOOL
+		);
+
+		// allow filtering of country data
+		$cols_n_values = apply_filters(
+			'FHEE__General_Settings_Admin_Page___update_country_settings__cols_n_values',
+			$cols_n_values
+		);
+
+		// where values
+		$where_cols_n_values = [['CNT_ISO' => $CNT_ISO]];
+		// run the update
+		$success = EEM_Country::instance()->update($cols_n_values, $where_cols_n_values);
+
+		// allow filtering of states data
+		$states = apply_filters(
+			'FHEE__General_Settings_Admin_Page___update_country_settings__states',
+			$this->request->getRequestParam('states', [], DataType::STRING, true)
+		);
+
+		if (! empty($states) && $success !== false) {
+			// loop thru state data ( looks like : states[75][STA_name] )
+			foreach ($states as $STA_ID => $state) {
+				$cols_n_values = [
+					'CNT_ISO'    => $CNT_ISO,
+					'STA_abbrev' => sanitize_text_field($state['STA_abbrev']),
+					'STA_name'   => sanitize_text_field($state['STA_name']),
+					'STA_active' => filter_var($state['STA_active'], FILTER_VALIDATE_BOOLEAN),
+				];
+				// where values
+				$where_cols_n_values = [['STA_ID' => $STA_ID]];
+				// run the update
+				$success = EEM_State::instance()->update($cols_n_values, $where_cols_n_values);
+				if ($success !== false) {
+					do_action(
+						'AHEE__General_Settings_Admin_Page__update_country_settings__state_saved',
+						$CNT_ISO,
+						$STA_ID,
+						$cols_n_values
+					);
+				}
+			}
+		}
+		// check if country being edited matches org option country, and if so, then  update EE_Config with new settings
+		if (
+			isset(EE_Registry::instance()->CFG->organization->CNT_ISO)
+			&& $CNT_ISO == EE_Registry::instance()->CFG->organization->CNT_ISO
+		) {
+			EE_Registry::instance()->CFG->currency = new EE_Currency_Config($CNT_ISO);
+			EE_Registry::instance()->CFG->update_espresso_config();
+		}
+
+		if ($success !== false) {
+			EE_Error::add_success(
+				esc_html__('Country Settings updated successfully.', 'event_espresso')
+			);
+		}
+		$this->_redirect_after_action(
+			$success,
+			'',
+			'',
+			['action' => 'country_settings', 'country' => $CNT_ISO],
+			true
+		);
+	}
+
+
+	/**
+	 * form_form_field_label_wrap
+	 *
+	 * @param string $label
+	 * @return string
+	 */
+	public function country_form_field_label_wrap(string $label): string
+	{
+		return '
 			<tr>
 				<th>
 					' . $label . '
 				</th>';
-    }
-
-
-    /**
-     * form_form_field_input__wrap
-     *
-     * @param string $input
-     * @return string
-     */
-    public function country_form_field_input__wrap(string $input): string
-    {
-        return '
+	}
+
+
+	/**
+	 * form_form_field_input__wrap
+	 *
+	 * @param string $input
+	 * @return string
+	 */
+	public function country_form_field_input__wrap(string $input): string
+	{
+		return '
 				<td class="general-settings-country-input-td">
 					' . $input . '
 				</td>
 			</tr>';
-    }
-
-
-    /**
-     * form_form_field_label_wrap
-     *
-     * @param string $label
-     * @param string $required_text
-     * @return string
-     */
-    public function state_form_field_label_wrap(string $label, string $required_text): string
-    {
-        return $required_text;
-    }
-
-
-    /**
-     * form_form_field_input__wrap
-     *
-     * @param string $input
-     * @return string
-     */
-    public function state_form_field_input__wrap(string $input): string
-    {
-        return '
+	}
+
+
+	/**
+	 * form_form_field_label_wrap
+	 *
+	 * @param string $label
+	 * @param string $required_text
+	 * @return string
+	 */
+	public function state_form_field_label_wrap(string $label, string $required_text): string
+	{
+		return $required_text;
+	}
+
+
+	/**
+	 * form_form_field_input__wrap
+	 *
+	 * @param string $input
+	 * @return string
+	 */
+	public function state_form_field_input__wrap(string $input): string
+	{
+		return '
 				<td class="general-settings-country-state-input-td">
 					' . $input . '
 				</td>';
-    }
-
-
-    /***********/
-
-
-    /**
-     * displays edit and view links for critical EE pages
-     *
-     * @param int $ee_page_id
-     * @return string
-     */
-    public static function edit_view_links(int $ee_page_id): string
-    {
-        $edit_url = add_query_arg(
-            ['post' => $ee_page_id, 'action' => 'edit'],
-            admin_url('post.php')
-        );
-        $links    = '<a href="' . esc_url_raw($edit_url) . '" >' . esc_html__('Edit', 'event_espresso') . '</a>';
-        $links    .= ' &nbsp;|&nbsp; ';
-        $links    .= '<a href="' . get_permalink($ee_page_id) . '" >' . esc_html__('View', 'event_espresso') . '</a>';
-
-        return $links;
-    }
-
-
-    /**
-     * displays page and shortcode status for critical EE pages
-     *
-     * @param WP_Post $ee_page
-     * @param string  $shortcode
-     * @return string
-     */
-    public static function page_and_shortcode_status(WP_Post $ee_page, string $shortcode): string
-    {
-        // page status
-        if (isset($ee_page->post_status) && $ee_page->post_status == 'publish') {
-            $pg_class  = 'ee-status-bg--success';
-            $pg_status = sprintf(esc_html__('Page%sStatus%sOK', 'event_espresso'), '&nbsp;', '&nbsp;');
-        } else {
-            $pg_class  = 'ee-status-bg--error';
-            $pg_status = sprintf(esc_html__('Page%sVisibility%sProblem', 'event_espresso'), '&nbsp;', '&nbsp;');
-        }
-
-        // shortcode status
-        if (isset($ee_page->post_content) && strpos($ee_page->post_content, $shortcode) !== false) {
-            $sc_class  = 'ee-status-bg--success';
-            $sc_status = sprintf(esc_html__('Shortcode%sOK', 'event_espresso'), '&nbsp;');
-        } else {
-            $sc_class  = 'ee-status-bg--error';
-            $sc_status = sprintf(esc_html__('Shortcode%sProblem', 'event_espresso'), '&nbsp;');
-        }
-
-        return '
+	}
+
+
+	/***********/
+
+
+	/**
+	 * displays edit and view links for critical EE pages
+	 *
+	 * @param int $ee_page_id
+	 * @return string
+	 */
+	public static function edit_view_links(int $ee_page_id): string
+	{
+		$edit_url = add_query_arg(
+			['post' => $ee_page_id, 'action' => 'edit'],
+			admin_url('post.php')
+		);
+		$links    = '<a href="' . esc_url_raw($edit_url) . '" >' . esc_html__('Edit', 'event_espresso') . '</a>';
+		$links    .= ' &nbsp;|&nbsp; ';
+		$links    .= '<a href="' . get_permalink($ee_page_id) . '" >' . esc_html__('View', 'event_espresso') . '</a>';
+
+		return $links;
+	}
+
+
+	/**
+	 * displays page and shortcode status for critical EE pages
+	 *
+	 * @param WP_Post $ee_page
+	 * @param string  $shortcode
+	 * @return string
+	 */
+	public static function page_and_shortcode_status(WP_Post $ee_page, string $shortcode): string
+	{
+		// page status
+		if (isset($ee_page->post_status) && $ee_page->post_status == 'publish') {
+			$pg_class  = 'ee-status-bg--success';
+			$pg_status = sprintf(esc_html__('Page%sStatus%sOK', 'event_espresso'), '&nbsp;', '&nbsp;');
+		} else {
+			$pg_class  = 'ee-status-bg--error';
+			$pg_status = sprintf(esc_html__('Page%sVisibility%sProblem', 'event_espresso'), '&nbsp;', '&nbsp;');
+		}
+
+		// shortcode status
+		if (isset($ee_page->post_content) && strpos($ee_page->post_content, $shortcode) !== false) {
+			$sc_class  = 'ee-status-bg--success';
+			$sc_status = sprintf(esc_html__('Shortcode%sOK', 'event_espresso'), '&nbsp;');
+		} else {
+			$sc_class  = 'ee-status-bg--error';
+			$sc_status = sprintf(esc_html__('Shortcode%sProblem', 'event_espresso'), '&nbsp;');
+		}
+
+		return '
         <span class="ee-page-status ' . $pg_class . '"><strong>' . $pg_status . '</strong></span>
         <span class="ee-page-status ' . $sc_class . '"><strong>' . $sc_status . '</strong></span>';
-    }
-
-
-    /**
-     * generates a dropdown of all parent pages - copied from WP core
-     *
-     * @param int  $default
-     * @param int  $parent
-     * @param int  $level
-     * @param bool $echo
-     * @return string;
-     */
-    public static function page_settings_dropdown(
-        int $default = 0,
-        int $parent = 0,
-        int $level = 0,
-        bool $echo = true
-    ): string {
-        global $wpdb;
-        $items  = $wpdb->get_results(
-            $wpdb->prepare(
-                "SELECT ID, post_parent, post_title FROM $wpdb->posts WHERE post_parent = %d AND post_type = 'page' AND post_status != 'trash' ORDER BY menu_order",
-                $parent
-            )
-        );
-        $output = '';
-
-        if ($items) {
-            $level = absint($level);
-            foreach ($items as $item) {
-                $ID         = absint($item->ID);
-                $post_title = wp_strip_all_tags($item->post_title);
-                $pad        = str_repeat('&nbsp;', $level * 3);
-                $option     = "\n\t";
-                $option     .= '<option class="level-' . $level . '" ';
-                $option     .= 'value="' . $ID . '" ';
-                $option     .= $ID === absint($default) ? ' selected' : '';
-                $option     .= '>';
-                $option     .= "$pad {$post_title}";
-                $option     .= '</option>';
-                $output     .= $option;
-                ob_start();
-                parent_dropdown($default, $item->ID, $level + 1);
-                $output .= ob_get_clean();
-            }
-        }
-        if ($echo) {
-            echo wp_kses($output, AllowedTags::getWithFormTags());
-            return '';
-        }
-        return $output;
-    }
-
-
-    /**
-     * Loads the scripts for the privacy settings form
-     */
-    public function load_scripts_styles_privacy_settings()
-    {
-        $form_handler = $this->loader->getShared(
-            'EventEspresso\core\domain\services\admin\privacy\forms\PrivacySettingsFormHandler'
-        );
-        $form_handler->enqueueStylesAndScripts();
-    }
-
-
-    /**
-     * display the privacy settings form
-     *
-     * @throws EE_Error
-     */
-    public function privacySettings()
-    {
-        $this->_set_add_edit_form_tags('update_privacy_settings');
-        $this->_set_publish_post_box_vars(null, false, false, null, false);
-        $form_handler                               = $this->loader->getShared(
-            'EventEspresso\core\domain\services\admin\privacy\forms\PrivacySettingsFormHandler'
-        );
-        $this->_template_args['admin_page_content'] = EEH_HTML::div(
-            $form_handler->display(),
-            '',
-            'padding'
-        );
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    /**
-     * Update the privacy settings from form data
-     *
-     * @throws EE_Error
-     */
-    public function updatePrivacySettings()
-    {
-        $form_handler = $this->loader->getShared(
-            'EventEspresso\core\domain\services\admin\privacy\forms\PrivacySettingsFormHandler'
-        );
-        $success      = $form_handler->process($this->get_request_data());
-        $this->_redirect_after_action(
-            $success,
-            esc_html__('Registration Form Options', 'event_espresso'),
-            'updated',
-            ['action' => 'privacy_settings']
-        );
-    }
+	}
+
+
+	/**
+	 * generates a dropdown of all parent pages - copied from WP core
+	 *
+	 * @param int  $default
+	 * @param int  $parent
+	 * @param int  $level
+	 * @param bool $echo
+	 * @return string;
+	 */
+	public static function page_settings_dropdown(
+		int $default = 0,
+		int $parent = 0,
+		int $level = 0,
+		bool $echo = true
+	): string {
+		global $wpdb;
+		$items  = $wpdb->get_results(
+			$wpdb->prepare(
+				"SELECT ID, post_parent, post_title FROM $wpdb->posts WHERE post_parent = %d AND post_type = 'page' AND post_status != 'trash' ORDER BY menu_order",
+				$parent
+			)
+		);
+		$output = '';
+
+		if ($items) {
+			$level = absint($level);
+			foreach ($items as $item) {
+				$ID         = absint($item->ID);
+				$post_title = wp_strip_all_tags($item->post_title);
+				$pad        = str_repeat('&nbsp;', $level * 3);
+				$option     = "\n\t";
+				$option     .= '<option class="level-' . $level . '" ';
+				$option     .= 'value="' . $ID . '" ';
+				$option     .= $ID === absint($default) ? ' selected' : '';
+				$option     .= '>';
+				$option     .= "$pad {$post_title}";
+				$option     .= '</option>';
+				$output     .= $option;
+				ob_start();
+				parent_dropdown($default, $item->ID, $level + 1);
+				$output .= ob_get_clean();
+			}
+		}
+		if ($echo) {
+			echo wp_kses($output, AllowedTags::getWithFormTags());
+			return '';
+		}
+		return $output;
+	}
+
+
+	/**
+	 * Loads the scripts for the privacy settings form
+	 */
+	public function load_scripts_styles_privacy_settings()
+	{
+		$form_handler = $this->loader->getShared(
+			'EventEspresso\core\domain\services\admin\privacy\forms\PrivacySettingsFormHandler'
+		);
+		$form_handler->enqueueStylesAndScripts();
+	}
+
+
+	/**
+	 * display the privacy settings form
+	 *
+	 * @throws EE_Error
+	 */
+	public function privacySettings()
+	{
+		$this->_set_add_edit_form_tags('update_privacy_settings');
+		$this->_set_publish_post_box_vars(null, false, false, null, false);
+		$form_handler                               = $this->loader->getShared(
+			'EventEspresso\core\domain\services\admin\privacy\forms\PrivacySettingsFormHandler'
+		);
+		$this->_template_args['admin_page_content'] = EEH_HTML::div(
+			$form_handler->display(),
+			'',
+			'padding'
+		);
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	/**
+	 * Update the privacy settings from form data
+	 *
+	 * @throws EE_Error
+	 */
+	public function updatePrivacySettings()
+	{
+		$form_handler = $this->loader->getShared(
+			'EventEspresso\core\domain\services\admin\privacy\forms\PrivacySettingsFormHandler'
+		);
+		$success      = $form_handler->process($this->get_request_data());
+		$this->_redirect_after_action(
+			$success,
+			esc_html__('Registration Form Options', 'event_espresso'),
+			'updated',
+			['action' => 'privacy_settings']
+		);
+	}
 }

core/domain/services/admin/registrations/list_table/csv_reports/AnswersCSV.php

Indentation +58 added lines, -58 removed lines

@@ -18,65 +18,65 @@
  */
 class AnswersCSV
 {
-    /**
-     * Add question / answer columns to the CSV row
-     *
-     * @param array $reg_row
-     * @param array $data
-     * @param array $question_labels
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function addAnswerColumns(array $reg_row, array $data, array $question_labels): array
-    {
-        $answer_model = EEM_Answer::instance();
-        $qst_model = EEM_Question::instance();
-        $state_model = EEM_State::instance();
-        // make sure each registration has the same questions in the same order
-        foreach ($question_labels as $question_label) {
-            if (! isset($data[ $question_label ])) {
-                $data[ $question_label ] = null;
-            }
-        }
-        $answers = $answer_model->get_all_wpdb_results([
-            ['REG_ID' => $reg_row['Registration.REG_ID']],
-            'force_join' => ['Question'],
-        ]);
-        // now fill out the questions THEY answered
-        foreach ($answers as $answer_row) {
-            if ($answer_row['Question.QST_system']) {
-                // it's an answer to a system question. That was already displayed as part of the attendee
-                // fields, so don't write it out again thanks.
-                continue;
-            }
+	/**
+	 * Add question / answer columns to the CSV row
+	 *
+	 * @param array $reg_row
+	 * @param array $data
+	 * @param array $question_labels
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function addAnswerColumns(array $reg_row, array $data, array $question_labels): array
+	{
+		$answer_model = EEM_Answer::instance();
+		$qst_model = EEM_Question::instance();
+		$state_model = EEM_State::instance();
+		// make sure each registration has the same questions in the same order
+		foreach ($question_labels as $question_label) {
+			if (! isset($data[ $question_label ])) {
+				$data[ $question_label ] = null;
+			}
+		}
+		$answers = $answer_model->get_all_wpdb_results([
+			['REG_ID' => $reg_row['Registration.REG_ID']],
+			'force_join' => ['Question'],
+		]);
+		// now fill out the questions THEY answered
+		foreach ($answers as $answer_row) {
+			if ($answer_row['Question.QST_system']) {
+				// it's an answer to a system question. That was already displayed as part of the attendee
+				// fields, so don't write it out again thanks.
+				continue;
+			}
 
-            $question_label = $answer_row['Question.QST_ID']
-                ? EEH_Export::prepare_value_from_db_for_display(
-                    $qst_model,
-                    'QST_admin_label',
-                    $answer_row['Question.QST_admin_label']
-                )
-                : sprintf(esc_html__('Question $s', 'event_espresso'), $answer_row['Answer.QST_ID']);
+			$question_label = $answer_row['Question.QST_ID']
+				? EEH_Export::prepare_value_from_db_for_display(
+					$qst_model,
+					'QST_admin_label',
+					$answer_row['Question.QST_admin_label']
+				)
+				: sprintf(esc_html__('Question $s', 'event_espresso'), $answer_row['Answer.QST_ID']);
 
-            if (! array_key_exists($question_label, $data)) {
-                // We don't need an answer for this specific question in the current dataset
-                // so skip adding this value to $data.
-                continue;
-            }
+			if (! array_key_exists($question_label, $data)) {
+				// We don't need an answer for this specific question in the current dataset
+				// so skip adding this value to $data.
+				continue;
+			}
 
-            $data[ $question_label ] = isset($answer_row['Question.QST_type'])
-                                       && $answer_row['Question.QST_type'] === EEM_Question::QST_type_state
-                ? $state_model->get_state_name_by_ID($answer_row['Answer.ANS_value'])
-                // this isn't for html, so don't show html entities
-                : html_entity_decode(
-                    EEH_Export::prepare_value_from_db_for_display(
-                        $answer_model,
-                        'ANS_value',
-                        $answer_row['Answer.ANS_value']
-                    )
-                );
-        }
-        return $data;
-    }
+			$data[ $question_label ] = isset($answer_row['Question.QST_type'])
+									   && $answer_row['Question.QST_type'] === EEM_Question::QST_type_state
+				? $state_model->get_state_name_by_ID($answer_row['Answer.ANS_value'])
+				// this isn't for html, so don't show html entities
+				: html_entity_decode(
+					EEH_Export::prepare_value_from_db_for_display(
+						$answer_model,
+						'ANS_value',
+						$answer_row['Answer.ANS_value']
+					)
+				);
+		}
+		return $data;
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -35,8 +35,8 @@ 
         $state_model = EEM_State::instance();
         // make sure each registration has the same questions in the same order
         foreach ($question_labels as $question_label) {
-            if (! isset($data[ $question_label ])) {
-                $data[ $question_label ] = null;
+            if ( ! isset($data[$question_label])) {
+                $data[$question_label] = null;
             }
         }
         $answers = $answer_model->get_all_wpdb_results([
@@ -59,13 +59,13 @@ 
                 )
                 : sprintf(esc_html__('Question $s', 'event_espresso'), $answer_row['Answer.QST_ID']);
 
-            if (! array_key_exists($question_label, $data)) {
+            if ( ! array_key_exists($question_label, $data)) {
                 // We don't need an answer for this specific question in the current dataset
                 // so skip adding this value to $data.
                 continue;
             }
 
-            $data[ $question_label ] = isset($answer_row['Question.QST_type'])
+            $data[$question_label] = isset($answer_row['Question.QST_type'])
                                        && $answer_row['Question.QST_type'] === EEM_Question::QST_type_state
                 ? $state_model->get_state_name_by_ID($answer_row['Answer.ANS_value'])
                 // this isn't for html, so don't show html entities

core/libraries/messages/EE_messenger.lib.php

Indentation +776 added lines, -776 removed lines

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

core/EE_System.core.php

Indentation +1212 added lines, -1212 removed lines

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

Spacing +21 added lines, -21 removed lines

@@ -157,7 +157,7 @@ 
         Router $router = null
     ): EE_System {
         // check if class object is instantiated
-        if (! self::$_instance instanceof EE_System) {
+        if ( ! self::$_instance instanceof EE_System) {
             self::$_instance = new self($loader, $maintenance_mode, $registry, $request, $router);
         }
         return self::$_instance;
@@ -291,7 +291,7 @@ 
         $this->capabilities = $this->loader->getShared('EE_Capabilities');
         add_action(
             'AHEE__EE_Capabilities__init_caps__before_initialization',
-            function () {
+            function() {
                 LoaderFactory::getLoader()->getShared('EE_Payment_Method_Manager');
             }
         );
@@ -449,11 +449,11 @@ 
     private function fix_espresso_db_upgrade_option($espresso_db_update = null): array
     {
         do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__begin', $espresso_db_update);
-        if (! $espresso_db_update) {
+        if ( ! $espresso_db_update) {
             $espresso_db_update = get_option('espresso_db_update');
         }
         // check that option is an array
-        if (! is_array($espresso_db_update)) {
+        if ( ! is_array($espresso_db_update)) {
             // if option is FALSE, then it never existed
             if ($espresso_db_update === false) {
                 // make $espresso_db_update an array and save option with autoload OFF
@@ -473,10 +473,10 @@ 
                     // so it must be numerically-indexed, where values are versions installed...
                     // fix it!
                     $version_string                         = $should_be_array;
-                    $corrected_db_update[ $version_string ] = ['unknown-date'];
+                    $corrected_db_update[$version_string] = ['unknown-date'];
                 } else {
                     // ok it checks out
-                    $corrected_db_update[ $should_be_version_string ] = $should_be_array;
+                    $corrected_db_update[$should_be_version_string] = $should_be_array;
                 }
             }
             $espresso_db_update = $corrected_db_update;
@@ -562,13 +562,13 @@ 
      */
     public function update_list_of_installed_versions($version_history = null, $current_version_to_add = null): bool
     {
-        if (! $version_history) {
+        if ( ! $version_history) {
             $version_history = $this->fix_espresso_db_upgrade_option($version_history);
         }
         if ($current_version_to_add === null) {
             $current_version_to_add = espresso_version();
         }
-        $version_history[ $current_version_to_add ][] = date('Y-m-d H:i:s', time());
+        $version_history[$current_version_to_add][] = date('Y-m-d H:i:s', time());
         // re-save
         return update_option('espresso_db_update', $version_history);
     }
@@ -736,7 +736,7 @@ 
             foreach ($activation_history as $version => $activation_dates) {
                 // check there is a record of when this version was activated.
                 // Otherwise, mark it as unknown
-                if (! $activation_dates) {
+                if ( ! $activation_dates) {
                     $activation_dates = ['unknown-date'];
                 }
                 $activation_dates = is_string($activation_dates) ? [$activation_dates] : $activation_dates;
@@ -831,7 +831,7 @@ 
     private function _parse_model_names()
     {
         // get all the files in the EE_MODELS folder that end in .model.php
-        $models                 = glob(EE_MODELS . '*.model.php');
+        $models                 = glob(EE_MODELS.'*.model.php');
         $model_names            = [];
         $non_abstract_db_models = [];
         foreach ($models as $model) {
@@ -840,9 +840,9 @@ 
             $short_name      = str_replace('EEM_', '', $classname);
             $reflectionClass = new ReflectionClass($classname);
             if ($reflectionClass->isSubclassOf('EEM_Base') && ! $reflectionClass->isAbstract()) {
-                $non_abstract_db_models[ $short_name ] = $classname;
+                $non_abstract_db_models[$short_name] = $classname;
             }
-            $model_names[ $short_name ] = $classname;
+            $model_names[$short_name] = $classname;
         }
         $this->registry->models                 = apply_filters('FHEE__EE_System__parse_model_names', $model_names);
         $this->registry->non_abstract_db_models = apply_filters(
@@ -869,7 +869,7 @@ 
         /** @var Domain $domain */
         $domain = DomainFactory::getEventEspressoCoreDomain();
         if ($domain->isCaffeinated()) {
-            require_once EE_CAFF_PATH . 'brewing_regular.php';
+            require_once EE_CAFF_PATH.'brewing_regular.php';
         }
     }
 
@@ -948,7 +948,7 @@ 
         $class_names = EEH_Class_Tools::get_class_names_for_all_callbacks_on_hook(
             'AHEE__EE_System__register_shortcodes_modules_and_addons'
         );
-        if (! empty($class_names)) {
+        if ( ! empty($class_names)) {
             $msg = esc_html__(
                 'The following plugins, addons, or modules appear to be incompatible with this version of Event Espresso and were automatically deactivated to avoid fatal errors:',
                 'event_espresso'
@@ -960,7 +960,7 @@ 
                             ['EE_', 'EEM_', 'EED_', 'EES_', 'EEW_'],
                             '',
                             $class_name
-                        ) . '</b></li>';
+                        ).'</b></li>';
             }
             $msg .= '</ul>';
             $msg .= esc_html__(
@@ -1026,7 +1026,7 @@ 
     private function _deactivate_incompatible_addons()
     {
         $incompatible_addons = get_option('ee_incompatible_addons', []);
-        if (! empty($incompatible_addons)) {
+        if ( ! empty($incompatible_addons)) {
             $active_plugins = get_option('active_plugins', []);
             foreach ($active_plugins as $active_plugin) {
                 foreach ($incompatible_addons as $incompatible_addon) {
@@ -1100,7 +1100,7 @@ 
         do_action('AHEE__EE_System__core_loaded_and_ready');
         // always load template tags, because it's faster than checking if it's a front-end request, and many page
         // builders require these even on the front-end
-        require_once EE_PUBLIC . 'template_tags.php';
+        require_once EE_PUBLIC.'template_tags.php';
         do_action('AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons');
     }
 
@@ -1117,7 +1117,7 @@ 
         do_action('AHEE__EE_System__initialize');
         add_filter(
             'safe_style_css',
-            function ($styles) {
+            function($styles) {
                 $styles[] = 'display';
                 $styles[] = 'visibility';
                 $styles[] = 'position';
@@ -1178,13 +1178,13 @@ 
     public static function do_not_cache()
     {
         // set no cache constants
-        if (! defined('DONOTCACHEPAGE')) {
+        if ( ! defined('DONOTCACHEPAGE')) {
             define('DONOTCACHEPAGE', true);
         }
-        if (! defined('DONOTCACHCEOBJECT')) {
+        if ( ! defined('DONOTCACHCEOBJECT')) {
             define('DONOTCACHCEOBJECT', true);
         }
-        if (! defined('DONOTCACHEDB')) {
+        if ( ! defined('DONOTCACHEDB')) {
             define('DONOTCACHEDB', true);
         }
         // add no cache headers

core/helpers/EEH_MSG_Template.helper.php

Indentation +1251 added lines, -1251 removed lines

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