eventespresso / event-espresso-core

core/libraries/plugin_api/EE_Register_Message_Type.lib.php

Indentation +449 added lines, -449 removed lines

@@ -12,479 +12,479 @@
 {
 
 
-    /**
-     * Holds values for registered message types
-     *
-     * @var array
-     */
-    protected static $_ee_message_type_registry = [];
+	/**
+	 * Holds values for registered message types
+	 *
+	 * @var array
+	 */
+	protected static $_ee_message_type_registry = [];
 
 
-    /**
-     * Method for registering new message types in the EE_messages system.
-     * Note:  All message types must have the following files in order to work:
-     * Template files for default templates getting setup.
-     * See /core/libraries/messages/defaults/default/ for examples
-     * (note that template files match a specific naming schema).
-     * These templates will need to be registered with the default template pack.
-     * - EE_Messages_Validator extended class(es).  See /core/libraries/messages/validators/email/
-     *      for examples.  Note for any new message types, there will need to be a validator for each
-     *      messenger combo this message type can activate with.
-     * - And of course the main EE_{Message_Type_Name}_message_type class that defines the new
-     *      message type and its properties.
-     *
-     * @param string $addon_name    Whatever is defined for the $name property of
-     *                              the message type you are registering (eg.
-     *                              declined_registration). Required.
-     * @param array  $setup_args    An array of arguments provided for registering the message type.
-     * @throws EE_Error
-     *                              }
-     * @see      inline docs in the register method for what can be passed in as arguments.
-     * @since    4.3.0
-     */
-    public static function register(string $addon_name = '', array $setup_args = []): bool
-    {
-        // required fields MUST be present, so let's make sure they are.
-        if (! isset($addon_name)
-            || ! is_array($setup_args)
-            || empty($setup_args['mtfilename'])
-            || empty($setup_args['autoloadpaths'])
-        ) {
-            throw new EE_Error(
-                __(
-                    'In order to register a message type with EE_Register_Message_Type::register, you must include a unique name for the message type, plus an array containing the following keys: "mtfilename", "autoloadpaths"',
-                    'event_espresso'
-                )
-            );
-        }
+	/**
+	 * Method for registering new message types in the EE_messages system.
+	 * Note:  All message types must have the following files in order to work:
+	 * Template files for default templates getting setup.
+	 * See /core/libraries/messages/defaults/default/ for examples
+	 * (note that template files match a specific naming schema).
+	 * These templates will need to be registered with the default template pack.
+	 * - EE_Messages_Validator extended class(es).  See /core/libraries/messages/validators/email/
+	 *      for examples.  Note for any new message types, there will need to be a validator for each
+	 *      messenger combo this message type can activate with.
+	 * - And of course the main EE_{Message_Type_Name}_message_type class that defines the new
+	 *      message type and its properties.
+	 *
+	 * @param string $addon_name    Whatever is defined for the $name property of
+	 *                              the message type you are registering (eg.
+	 *                              declined_registration). Required.
+	 * @param array  $setup_args    An array of arguments provided for registering the message type.
+	 * @throws EE_Error
+	 *                              }
+	 * @see      inline docs in the register method for what can be passed in as arguments.
+	 * @since    4.3.0
+	 */
+	public static function register(string $addon_name = '', array $setup_args = []): bool
+	{
+		// required fields MUST be present, so let's make sure they are.
+		if (! isset($addon_name)
+			|| ! is_array($setup_args)
+			|| empty($setup_args['mtfilename'])
+			|| empty($setup_args['autoloadpaths'])
+		) {
+			throw new EE_Error(
+				__(
+					'In order to register a message type with EE_Register_Message_Type::register, you must include a unique name for the message type, plus an array containing the following keys: "mtfilename", "autoloadpaths"',
+					'event_espresso'
+				)
+			);
+		}
 
-        // make sure we don't register twice
-        if (isset(self::$_ee_message_type_registry[ $addon_name ])) {
-            return true;
-        }
+		// make sure we don't register twice
+		if (isset(self::$_ee_message_type_registry[ $addon_name ])) {
+			return true;
+		}
 
-        // make sure this was called in the right place!
-        if (
-            ! did_action('EE_Brewing_Regular___messages_caf')
-            || did_action('AHEE__EE_System__perform_activations_upgrades_and_migrations')
-        ) {
-            EE_Error::doing_it_wrong(
-                __METHOD__,
-                sprintf(
-                    __(
-                        'A message type named "%s" has been attempted to be registered with the EE Messages System.  It may or may not work because it should be only called on the "EE_Brewing_Regular___messages_caf" hook.',
-                        'event_espresso'
-                    ),
-                    $addon_name
-                ),
-                '4.3.0'
-            );
-        }
-        // setup $__ee_message_type_registry array from incoming values.
-        self::$_ee_message_type_registry[ $addon_name ] = [
-            /**
-             * The file name for the message type being registered.
-             * Required.
-             *
-             * @type string
-             */
-            'mtfilename'                                       => (string) $setup_args['mtfilename'],
-            /**
-             * Autoload paths for classes used by the message type.
-             * Required.
-             *
-             * @type array
-             */
-            'autoloadpaths'                                    => (array) $setup_args['autoloadpaths'],
-            /**
-             * Messengers that the message type should be able to activate with.
-             * Use messenger slugs.
-             *
-             * @type array
-             */
-            'messengers_to_activate_with'                      => ! empty($setup_args['messengers_to_activate_with'])
-                ? (array) $setup_args['messengers_to_activate_with']
-                : [],
-            /**
-             * Messengers that the message type should validate with.
-             * Use messenger slugs.
-             *
-             * @type array
-             */
-            'messengers_to_validate_with'                      => ! empty($setup_args['messengers_to_validate_with'])
-                ? (array) $setup_args['messengers_to_validate_with']
-                : [],
-            /**
-             * Whether to force activate this message type the first time it is registered.
-             *
-             * @type bool   False means its not activated by default and left up to the end user to activate.
-             */
-            'force_activation'                                 => ! empty($setup_args['force_activation'])
-                                                                  && $setup_args['force_activation'],
-            /**
-             * What messengers this message type supports the default template pack for.
-             * Note: If you do not set this (or any of the following template pack/variation related arguments) to true,
-             * then it is expected that the message type being registered is doing its own custom default template
-             * pack/variation registration.
-             *
-             * If this is set and has values, then it is expected that the following arguments are also set in the incoming options
-             * $setup_arguments array as well:
-             * - 'base_path_for_default_templates'
-             *
-             * @type array   Expect an array of messengers this supports default template packs for.
-             */
-            'messengers_supporting_default_template_pack_with' => isset($setup_args['messengers_supporting_default_template_pack_with'])
-                ? (array) $setup_args['messengers_supporting_default_template_pack_with']
-                : [],
-            /**
-             * The base path where the default templates for this message type can be found.
-             *
-             * @type string
-             */
-            'base_path_for_default_templates'                  => $setup_args['base_path_for_default_templates'] ?? '',
-            /**
-             * The base path where the default variations for this message type can be found.
-             *
-             * @type string
-             */
-            'base_path_for_default_variation'                  => $setup_args['base_path_for_default_variation'] ?? '',
-            /**
-             * The base url for the default variations for this message type.
-             *
-             * @type string
-             */
-            'base_url_for_default_variation'                   => $setup_args['base_url_for_default_variation'] ?? '',
-        ];
-        // add filters but only if they haven't already been set (these filters only need to be registered ONCE because
-        // the callback handles all registered message types.
-        if (false === has_filter(
-                'FHEE__EED_Messages___set_messages_paths___MSG_PATHS',
-                ['EE_Register_Message_Type', 'register_msgs_autoload_paths']
-            )) {
-            add_filter(
-                'FHEE__EED_Messages___set_messages_paths___MSG_PATHS',
-                ['EE_Register_Message_Type', 'register_msgs_autoload_paths'],
-                10
-            );
-            add_filter(
-                'FHEE__EE_messages__get_installed__messagetype_files',
-                ['EE_Register_Message_Type', 'register_messagetype_files'],
-                10,
-                1
-            );
-            add_filter(
-                'FHEE__EE_messenger__get_default_message_types__default_types',
-                ['EE_Register_Message_Type', 'register_messengers_to_activate_mt_with'],
-                10,
-                2
-            );
-            add_filter(
-                'FHEE__EE_messenger__get_valid_message_types__valid_types',
-                ['EE_Register_Message_Type', 'register_messengers_to_validate_mt_with'],
-                10,
-                2
-            );
-            // actions
-            add_action(
-                'AHEE__EE_Addon__initialize_default_data__begin',
-                ['EE_Register_Message_Type', 'set_defaults']
-            );
+		// make sure this was called in the right place!
+		if (
+			! did_action('EE_Brewing_Regular___messages_caf')
+			|| did_action('AHEE__EE_System__perform_activations_upgrades_and_migrations')
+		) {
+			EE_Error::doing_it_wrong(
+				__METHOD__,
+				sprintf(
+					__(
+						'A message type named "%s" has been attempted to be registered with the EE Messages System.  It may or may not work because it should be only called on the "EE_Brewing_Regular___messages_caf" hook.',
+						'event_espresso'
+					),
+					$addon_name
+				),
+				'4.3.0'
+			);
+		}
+		// setup $__ee_message_type_registry array from incoming values.
+		self::$_ee_message_type_registry[ $addon_name ] = [
+			/**
+			 * The file name for the message type being registered.
+			 * Required.
+			 *
+			 * @type string
+			 */
+			'mtfilename'                                       => (string) $setup_args['mtfilename'],
+			/**
+			 * Autoload paths for classes used by the message type.
+			 * Required.
+			 *
+			 * @type array
+			 */
+			'autoloadpaths'                                    => (array) $setup_args['autoloadpaths'],
+			/**
+			 * Messengers that the message type should be able to activate with.
+			 * Use messenger slugs.
+			 *
+			 * @type array
+			 */
+			'messengers_to_activate_with'                      => ! empty($setup_args['messengers_to_activate_with'])
+				? (array) $setup_args['messengers_to_activate_with']
+				: [],
+			/**
+			 * Messengers that the message type should validate with.
+			 * Use messenger slugs.
+			 *
+			 * @type array
+			 */
+			'messengers_to_validate_with'                      => ! empty($setup_args['messengers_to_validate_with'])
+				? (array) $setup_args['messengers_to_validate_with']
+				: [],
+			/**
+			 * Whether to force activate this message type the first time it is registered.
+			 *
+			 * @type bool   False means its not activated by default and left up to the end user to activate.
+			 */
+			'force_activation'                                 => ! empty($setup_args['force_activation'])
+																  && $setup_args['force_activation'],
+			/**
+			 * What messengers this message type supports the default template pack for.
+			 * Note: If you do not set this (or any of the following template pack/variation related arguments) to true,
+			 * then it is expected that the message type being registered is doing its own custom default template
+			 * pack/variation registration.
+			 *
+			 * If this is set and has values, then it is expected that the following arguments are also set in the incoming options
+			 * $setup_arguments array as well:
+			 * - 'base_path_for_default_templates'
+			 *
+			 * @type array   Expect an array of messengers this supports default template packs for.
+			 */
+			'messengers_supporting_default_template_pack_with' => isset($setup_args['messengers_supporting_default_template_pack_with'])
+				? (array) $setup_args['messengers_supporting_default_template_pack_with']
+				: [],
+			/**
+			 * The base path where the default templates for this message type can be found.
+			 *
+			 * @type string
+			 */
+			'base_path_for_default_templates'                  => $setup_args['base_path_for_default_templates'] ?? '',
+			/**
+			 * The base path where the default variations for this message type can be found.
+			 *
+			 * @type string
+			 */
+			'base_path_for_default_variation'                  => $setup_args['base_path_for_default_variation'] ?? '',
+			/**
+			 * The base url for the default variations for this message type.
+			 *
+			 * @type string
+			 */
+			'base_url_for_default_variation'                   => $setup_args['base_url_for_default_variation'] ?? '',
+		];
+		// add filters but only if they haven't already been set (these filters only need to be registered ONCE because
+		// the callback handles all registered message types.
+		if (false === has_filter(
+				'FHEE__EED_Messages___set_messages_paths___MSG_PATHS',
+				['EE_Register_Message_Type', 'register_msgs_autoload_paths']
+			)) {
+			add_filter(
+				'FHEE__EED_Messages___set_messages_paths___MSG_PATHS',
+				['EE_Register_Message_Type', 'register_msgs_autoload_paths'],
+				10
+			);
+			add_filter(
+				'FHEE__EE_messages__get_installed__messagetype_files',
+				['EE_Register_Message_Type', 'register_messagetype_files'],
+				10,
+				1
+			);
+			add_filter(
+				'FHEE__EE_messenger__get_default_message_types__default_types',
+				['EE_Register_Message_Type', 'register_messengers_to_activate_mt_with'],
+				10,
+				2
+			);
+			add_filter(
+				'FHEE__EE_messenger__get_valid_message_types__valid_types',
+				['EE_Register_Message_Type', 'register_messengers_to_validate_mt_with'],
+				10,
+				2
+			);
+			// actions
+			add_action(
+				'AHEE__EE_Addon__initialize_default_data__begin',
+				['EE_Register_Message_Type', 'set_defaults']
+			);
 
-            // default template packs and variations related
-            add_filter(
-                'FHEE__EE_Messages_Template_Pack_Default__get_supports',
-                ['EE_Register_Message_Type', 'register_default_template_pack_supports']
-            );
-            add_filter(
-                'FHEE__EE_Template_Pack___get_specific_template__filtered_base_path',
-                ['EE_Register_Message_Type', 'register_base_template_path'],
-                10,
-                6
-            );
-            add_filter(
-                'FHEE__EE_Messages_Template_Pack__get_variation__base_path_or_url',
-                ['EE_Register_Message_Type', 'register_variation_base_path_or_url'],
-                10,
-                8
-            );
-            add_filter(
-                'FHEE__EE_Messages_Template_Pack__get_variation__base_path',
-                ['EE_Register_Message_Type', 'register_variation_base_path_or_url'],
-                10,
-                8
-            );
-        }
-        return true;
-    }
+			// default template packs and variations related
+			add_filter(
+				'FHEE__EE_Messages_Template_Pack_Default__get_supports',
+				['EE_Register_Message_Type', 'register_default_template_pack_supports']
+			);
+			add_filter(
+				'FHEE__EE_Template_Pack___get_specific_template__filtered_base_path',
+				['EE_Register_Message_Type', 'register_base_template_path'],
+				10,
+				6
+			);
+			add_filter(
+				'FHEE__EE_Messages_Template_Pack__get_variation__base_path_or_url',
+				['EE_Register_Message_Type', 'register_variation_base_path_or_url'],
+				10,
+				8
+			);
+			add_filter(
+				'FHEE__EE_Messages_Template_Pack__get_variation__base_path',
+				['EE_Register_Message_Type', 'register_variation_base_path_or_url'],
+				10,
+				8
+			);
+		}
+		return true;
+	}
 
 
-    /**
-     * This just ensures that when an addon registers a message type that on initial activation/reactivation the
-     * defaults the addon sets are taken care of.
-     *
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function set_defaults()
-    {
-        /** @type EE_Message_Resource_Manager $message_resource_manager */
-        $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+	/**
+	 * This just ensures that when an addon registers a message type that on initial activation/reactivation the
+	 * defaults the addon sets are taken care of.
+	 *
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function set_defaults()
+	{
+		/** @type EE_Message_Resource_Manager $message_resource_manager */
+		$message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
 
-        // for any message types with force activation, let's ensure they are activated
-        foreach (self::$_ee_message_type_registry as $addon_name => $settings) {
-            if ($settings['force_activation']) {
-                foreach ($settings['messengers_to_activate_with'] as $messenger) {
-                    // DO not force activation if this message type has already been activated in the system
-                    if (! $message_resource_manager->has_message_type_been_activated_for_messenger(
-                        $addon_name,
-                        $messenger
-                    )
-                    ) {
-                        $message_resource_manager->ensure_message_type_is_active($addon_name, $messenger);
-                    }
-                }
-            }
-        }
-    }
+		// for any message types with force activation, let's ensure they are activated
+		foreach (self::$_ee_message_type_registry as $addon_name => $settings) {
+			if ($settings['force_activation']) {
+				foreach ($settings['messengers_to_activate_with'] as $messenger) {
+					// DO not force activation if this message type has already been activated in the system
+					if (! $message_resource_manager->has_message_type_been_activated_for_messenger(
+						$addon_name,
+						$messenger
+					)
+					) {
+						$message_resource_manager->ensure_message_type_is_active($addon_name, $messenger);
+					}
+				}
+			}
+		}
+	}
 
 
-    /**
-     * This deregisters a message type that was previously registered with a specific message_type_name.
-     *
-     * @param string $addon_name the name for the message type that was previously registered
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since    4.3.0
-     */
-    public static function deregister(string $addon_name = '')
-    {
-        if (! empty(self::$_ee_message_type_registry[ $addon_name ])) {
-            // let's make sure that we remove any place this message type was made active
-            /** @var EE_Message_Resource_Manager $Message_Resource_Manager */
-            $Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-            // ensures that if this message type is registered again that it retains its previous active state vs
-            // remaining inactive.
-            $Message_Resource_Manager->remove_message_type_has_been_activated_from_all_messengers(
-                $addon_name,
-                true
-            );
-            $Message_Resource_Manager->deactivate_message_type($addon_name, false);
-        }
-        unset(self::$_ee_message_type_registry[ $addon_name ]);
-    }
+	/**
+	 * This deregisters a message type that was previously registered with a specific message_type_name.
+	 *
+	 * @param string $addon_name the name for the message type that was previously registered
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since    4.3.0
+	 */
+	public static function deregister(string $addon_name = '')
+	{
+		if (! empty(self::$_ee_message_type_registry[ $addon_name ])) {
+			// let's make sure that we remove any place this message type was made active
+			/** @var EE_Message_Resource_Manager $Message_Resource_Manager */
+			$Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+			// ensures that if this message type is registered again that it retains its previous active state vs
+			// remaining inactive.
+			$Message_Resource_Manager->remove_message_type_has_been_activated_from_all_messengers(
+				$addon_name,
+				true
+			);
+			$Message_Resource_Manager->deactivate_message_type($addon_name, false);
+		}
+		unset(self::$_ee_message_type_registry[ $addon_name ]);
+	}
 
 
-    /**
-     * callback for FHEE__EE_messages__get_installed__messagetype_files filter.
-     *
-     * @param array $messagetype_files The current array of message type file names
-     * @return  array                                 Array of message type file names
-     * @since   4.3.0
-     */
-    public static function register_messagetype_files(array $messagetype_files): array
-    {
-        if (empty(self::$_ee_message_type_registry)) {
-            return $messagetype_files;
-        }
-        foreach (self::$_ee_message_type_registry as $mt_reg) {
-            if (empty($mt_reg['mtfilename'])) {
-                continue;
-            }
-            $messagetype_files[] = $mt_reg['mtfilename'];
-        }
-        return $messagetype_files;
-    }
+	/**
+	 * callback for FHEE__EE_messages__get_installed__messagetype_files filter.
+	 *
+	 * @param array $messagetype_files The current array of message type file names
+	 * @return  array                                 Array of message type file names
+	 * @since   4.3.0
+	 */
+	public static function register_messagetype_files(array $messagetype_files): array
+	{
+		if (empty(self::$_ee_message_type_registry)) {
+			return $messagetype_files;
+		}
+		foreach (self::$_ee_message_type_registry as $mt_reg) {
+			if (empty($mt_reg['mtfilename'])) {
+				continue;
+			}
+			$messagetype_files[] = $mt_reg['mtfilename'];
+		}
+		return $messagetype_files;
+	}
 
 
-    /**
-     * callback for FHEE__EED_Messages___set_messages_paths___MSG_PATHS filter.
-     *
-     * @param array $paths array of paths to be checked by EE_messages autoloader.
-     * @return array
-     * @since    4.3.0
-     */
-    public static function register_msgs_autoload_paths(array $paths): array
-    {
-        $autoload_paths = [];
-        if (! empty(self::$_ee_message_type_registry)) {
-            foreach (self::$_ee_message_type_registry as $mt_reg) {
-                if (empty($mt_reg['autoloadpaths'])) {
-                    continue;
-                }
-                $autoload_paths[] = $mt_reg['autoloadpaths'];
-            }
-        }
-        return array_merge($paths, ...$autoload_paths);
-    }
+	/**
+	 * callback for FHEE__EED_Messages___set_messages_paths___MSG_PATHS filter.
+	 *
+	 * @param array $paths array of paths to be checked by EE_messages autoloader.
+	 * @return array
+	 * @since    4.3.0
+	 */
+	public static function register_msgs_autoload_paths(array $paths): array
+	{
+		$autoload_paths = [];
+		if (! empty(self::$_ee_message_type_registry)) {
+			foreach (self::$_ee_message_type_registry as $mt_reg) {
+				if (empty($mt_reg['autoloadpaths'])) {
+					continue;
+				}
+				$autoload_paths[] = $mt_reg['autoloadpaths'];
+			}
+		}
+		return array_merge($paths, ...$autoload_paths);
+	}
 
 
-    /**
-     * callback for FHEE__EE_messenger__get_default_message_types__default_types filter.
-     *
-     * @param array        $default_types   array of message types activated with messenger (
-     *                                      corresponds to the $name property of message type)
-     * @param EE_messenger $messenger       The EE_messenger the filter is called from.
-     * @return array
-     * @since  4.3.0
-     */
-    public static function register_messengers_to_activate_mt_with(array $default_types, EE_messenger $messenger): array
-    {
-        if (empty(self::$_ee_message_type_registry)) {
-            return $default_types;
-        }
-        foreach (self::$_ee_message_type_registry as $addon_name => $mt_reg) {
-            if (empty($mt_reg['messengers_to_activate_with']) || empty($mt_reg['mtfilename'])) {
-                continue;
-            }
-            // loop through each of the messengers and if it matches the loaded class
-            // then we add this message type to the
-            foreach ($mt_reg['messengers_to_activate_with'] as $msgr) {
-                if ($messenger->name == $msgr) {
-                    $default_types[] = $addon_name;
-                }
-            }
-        }
+	/**
+	 * callback for FHEE__EE_messenger__get_default_message_types__default_types filter.
+	 *
+	 * @param array        $default_types   array of message types activated with messenger (
+	 *                                      corresponds to the $name property of message type)
+	 * @param EE_messenger $messenger       The EE_messenger the filter is called from.
+	 * @return array
+	 * @since  4.3.0
+	 */
+	public static function register_messengers_to_activate_mt_with(array $default_types, EE_messenger $messenger): array
+	{
+		if (empty(self::$_ee_message_type_registry)) {
+			return $default_types;
+		}
+		foreach (self::$_ee_message_type_registry as $addon_name => $mt_reg) {
+			if (empty($mt_reg['messengers_to_activate_with']) || empty($mt_reg['mtfilename'])) {
+				continue;
+			}
+			// loop through each of the messengers and if it matches the loaded class
+			// then we add this message type to the
+			foreach ($mt_reg['messengers_to_activate_with'] as $msgr) {
+				if ($messenger->name == $msgr) {
+					$default_types[] = $addon_name;
+				}
+			}
+		}
 
-        return $default_types;
-    }
+		return $default_types;
+	}
 
 
-    /**
-     * callback for FHEE__EE_messenger__get_valid_message_types__default_types filter.
-     *
-     * @param array        $valid_types     array of message types valid with messenger (
-     *                                      corresponds to the $name property of message type)
-     * @param EE_messenger $messenger       The EE_messenger the filter is called from.
-     * @return  array
-     * @since   4.3.0
-     */
-    public static function register_messengers_to_validate_mt_with(array $valid_types, EE_messenger $messenger): array
-    {
-        if (empty(self::$_ee_message_type_registry)) {
-            return $valid_types;
-        }
-        foreach (self::$_ee_message_type_registry as $addon_name => $mt_reg) {
-            if (empty($mt_reg['messengers_to_validate_with']) || empty($mt_reg['mtfilename'])) {
-                continue;
-            }
-            // loop through each of the messengers and if it matches the loaded class
-            // then we add this message type to the
-            foreach ($mt_reg['messengers_to_validate_with'] as $msgr) {
-                if ($messenger->name == $msgr) {
-                    $valid_types[] = $addon_name;
-                }
-            }
-        }
+	/**
+	 * callback for FHEE__EE_messenger__get_valid_message_types__default_types filter.
+	 *
+	 * @param array        $valid_types     array of message types valid with messenger (
+	 *                                      corresponds to the $name property of message type)
+	 * @param EE_messenger $messenger       The EE_messenger the filter is called from.
+	 * @return  array
+	 * @since   4.3.0
+	 */
+	public static function register_messengers_to_validate_mt_with(array $valid_types, EE_messenger $messenger): array
+	{
+		if (empty(self::$_ee_message_type_registry)) {
+			return $valid_types;
+		}
+		foreach (self::$_ee_message_type_registry as $addon_name => $mt_reg) {
+			if (empty($mt_reg['messengers_to_validate_with']) || empty($mt_reg['mtfilename'])) {
+				continue;
+			}
+			// loop through each of the messengers and if it matches the loaded class
+			// then we add this message type to the
+			foreach ($mt_reg['messengers_to_validate_with'] as $msgr) {
+				if ($messenger->name == $msgr) {
+					$valid_types[] = $addon_name;
+				}
+			}
+		}
 
-        return $valid_types;
-    }
+		return $valid_types;
+	}
 
 
-    /**
-     * Callback for `FHEE__EE_Messages_Template_Pack_Default__get_supports` filter to register this message type as
-     * supporting the default template pack
-     *
-     * @param array $supports
-     *
-     * @return array
-     */
-    public static function register_default_template_pack_supports(array $supports): array
-    {
-        foreach (self::$_ee_message_type_registry as $addon_name => $mt_reg) {
-            if (empty($mt_reg['messengers_supporting_default_template_pack_with'])) {
-                continue;
-            }
-            foreach ($mt_reg['messengers_supporting_default_template_pack_with'] as $messenger_slug) {
-                $supports[ $messenger_slug ][] = $addon_name;
-            }
-        }
-        return $supports;
-    }
+	/**
+	 * Callback for `FHEE__EE_Messages_Template_Pack_Default__get_supports` filter to register this message type as
+	 * supporting the default template pack
+	 *
+	 * @param array $supports
+	 *
+	 * @return array
+	 */
+	public static function register_default_template_pack_supports(array $supports): array
+	{
+		foreach (self::$_ee_message_type_registry as $addon_name => $mt_reg) {
+			if (empty($mt_reg['messengers_supporting_default_template_pack_with'])) {
+				continue;
+			}
+			foreach ($mt_reg['messengers_supporting_default_template_pack_with'] as $messenger_slug) {
+				$supports[ $messenger_slug ][] = $addon_name;
+			}
+		}
+		return $supports;
+	}
 
 
-    /**
-     * Callback for FHEE__EE_Template_Pack___get_specific_template__filtered_base_path
-     *
-     * @param string                    $base_path The original base path for message templates
-     * @param EE_messenger              $messenger
-     * @param EE_message_type           $message_type
-     * @param string                    $field     The field requesting a template
-     * @param string                    $context   The context requesting a template
-     * @param EE_Messages_Template_Pack $template_pack
-     *
-     * @return string
-     */
-    public static function register_base_template_path(
-        string $base_path,
-        EE_messenger $messenger,
-        EE_message_type $message_type,
-        string $field,
-        string $context,
-        EE_Messages_Template_Pack $template_pack
-    ): string {
-        if (! $template_pack instanceof EE_Messages_Template_Pack_Default
-            || ! $message_type instanceof EE_message_type
-        ) {
-            return $base_path;
-        }
-        foreach (self::$_ee_message_type_registry as $addon_name => $mt_reg) {
-            if ($message_type->name === $addon_name
-                && ! empty($mt_reg['base_path_for_default_templates'])
-            ) {
-                return $mt_reg['base_path_for_default_templates'];
-            }
-        }
-        return $base_path;
-    }
+	/**
+	 * Callback for FHEE__EE_Template_Pack___get_specific_template__filtered_base_path
+	 *
+	 * @param string                    $base_path The original base path for message templates
+	 * @param EE_messenger              $messenger
+	 * @param EE_message_type           $message_type
+	 * @param string                    $field     The field requesting a template
+	 * @param string                    $context   The context requesting a template
+	 * @param EE_Messages_Template_Pack $template_pack
+	 *
+	 * @return string
+	 */
+	public static function register_base_template_path(
+		string $base_path,
+		EE_messenger $messenger,
+		EE_message_type $message_type,
+		string $field,
+		string $context,
+		EE_Messages_Template_Pack $template_pack
+	): string {
+		if (! $template_pack instanceof EE_Messages_Template_Pack_Default
+			|| ! $message_type instanceof EE_message_type
+		) {
+			return $base_path;
+		}
+		foreach (self::$_ee_message_type_registry as $addon_name => $mt_reg) {
+			if ($message_type->name === $addon_name
+				&& ! empty($mt_reg['base_path_for_default_templates'])
+			) {
+				return $mt_reg['base_path_for_default_templates'];
+			}
+		}
+		return $base_path;
+	}
 
 
-    /**
-     * Callback for FHEE__EE_Messages_Template_Pack__get_variation__base_path and
-     * FHEE__EE_Messages_Template_Pack__get_variation__base_path_or_url hooks
-     *
-     * @param string                    $base_path_or_url  The original incoming base url or path
-     * @param string                    $messenger_slug    The slug of the messenger the template is being generated
-     *                                                     for.
-     * @param string                    $message_type_slug The slug of the message type the template is being generated
-     *                                                     for.
-     * @param string                    $type              The "type" of css being requested.
-     * @param string                    $variation         The variation being requested.
-     * @param bool                      $url               whether a url or path is being requested.
-     * @param string                    $file_extension    What file extension is expected for the variation file.
-     * @param EE_Messages_Template_Pack $template_pack
-     *
-     * @return string
-     */
-    public static function register_variation_base_path_or_url(
-        string $base_path_or_url,
-        string $messenger_slug,
-        string $message_type_slug,
-        string $type,
-        string $variation,
-        bool $url,
-        string $file_extension,
-        EE_Messages_Template_Pack $template_pack
-    ): string {
-        if (! $template_pack instanceof EE_Messages_Template_Pack_Default) {
-            return $base_path_or_url;
-        }
-        foreach (self::$_ee_message_type_registry as $addon_name => $mt_reg) {
-            if ($addon_name === $message_type_slug
-            ) {
-                if (
-                    $url
-                    && ! empty($mt_reg['base_url_for_default_variation'])
-                ) {
-                    return $mt_reg['base_url_for_default_variation'];
-                } elseif (
-                    ! $url
-                    && ! empty($mt_reg['base_path_for_default_variation'])
-                ) {
-                    return $mt_reg['base_path_for_default_variation'];
-                }
-            }
-        }
-        return $base_path_or_url;
-    }
+	/**
+	 * Callback for FHEE__EE_Messages_Template_Pack__get_variation__base_path and
+	 * FHEE__EE_Messages_Template_Pack__get_variation__base_path_or_url hooks
+	 *
+	 * @param string                    $base_path_or_url  The original incoming base url or path
+	 * @param string                    $messenger_slug    The slug of the messenger the template is being generated
+	 *                                                     for.
+	 * @param string                    $message_type_slug The slug of the message type the template is being generated
+	 *                                                     for.
+	 * @param string                    $type              The "type" of css being requested.
+	 * @param string                    $variation         The variation being requested.
+	 * @param bool                      $url               whether a url or path is being requested.
+	 * @param string                    $file_extension    What file extension is expected for the variation file.
+	 * @param EE_Messages_Template_Pack $template_pack
+	 *
+	 * @return string
+	 */
+	public static function register_variation_base_path_or_url(
+		string $base_path_or_url,
+		string $messenger_slug,
+		string $message_type_slug,
+		string $type,
+		string $variation,
+		bool $url,
+		string $file_extension,
+		EE_Messages_Template_Pack $template_pack
+	): string {
+		if (! $template_pack instanceof EE_Messages_Template_Pack_Default) {
+			return $base_path_or_url;
+		}
+		foreach (self::$_ee_message_type_registry as $addon_name => $mt_reg) {
+			if ($addon_name === $message_type_slug
+			) {
+				if (
+					$url
+					&& ! empty($mt_reg['base_url_for_default_variation'])
+				) {
+					return $mt_reg['base_url_for_default_variation'];
+				} elseif (
+					! $url
+					&& ! empty($mt_reg['base_path_for_default_variation'])
+				) {
+					return $mt_reg['base_path_for_default_variation'];
+				}
+			}
+		}
+		return $base_path_or_url;
+	}
 }

Spacing +10 added lines, -10 removed lines

@@ -45,7 +45,7 @@ 
     public static function register(string $addon_name = '', array $setup_args = []): bool
     {
         // required fields MUST be present, so let's make sure they are.
-        if (! isset($addon_name)
+        if ( ! isset($addon_name)
             || ! is_array($setup_args)
             || empty($setup_args['mtfilename'])
             || empty($setup_args['autoloadpaths'])
@@ -59,7 +59,7 @@ 
         }
 
         // make sure we don't register twice
-        if (isset(self::$_ee_message_type_registry[ $addon_name ])) {
+        if (isset(self::$_ee_message_type_registry[$addon_name])) {
             return true;
         }
 
@@ -81,7 +81,7 @@ 
             );
         }
         // setup $__ee_message_type_registry array from incoming values.
-        self::$_ee_message_type_registry[ $addon_name ] = [
+        self::$_ee_message_type_registry[$addon_name] = [
             /**
              * The file name for the message type being registered.
              * Required.
@@ -235,7 +235,7 @@ 
             if ($settings['force_activation']) {
                 foreach ($settings['messengers_to_activate_with'] as $messenger) {
                     // DO not force activation if this message type has already been activated in the system
-                    if (! $message_resource_manager->has_message_type_been_activated_for_messenger(
+                    if ( ! $message_resource_manager->has_message_type_been_activated_for_messenger(
                         $addon_name,
                         $messenger
                     )
@@ -259,7 +259,7 @@ 
      */
     public static function deregister(string $addon_name = '')
     {
-        if (! empty(self::$_ee_message_type_registry[ $addon_name ])) {
+        if ( ! empty(self::$_ee_message_type_registry[$addon_name])) {
             // let's make sure that we remove any place this message type was made active
             /** @var EE_Message_Resource_Manager $Message_Resource_Manager */
             $Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
@@ -271,7 +271,7 @@ 
             );
             $Message_Resource_Manager->deactivate_message_type($addon_name, false);
         }
-        unset(self::$_ee_message_type_registry[ $addon_name ]);
+        unset(self::$_ee_message_type_registry[$addon_name]);
     }
 
 
@@ -307,7 +307,7 @@ 
     public static function register_msgs_autoload_paths(array $paths): array
     {
         $autoload_paths = [];
-        if (! empty(self::$_ee_message_type_registry)) {
+        if ( ! empty(self::$_ee_message_type_registry)) {
             foreach (self::$_ee_message_type_registry as $mt_reg) {
                 if (empty($mt_reg['autoloadpaths'])) {
                     continue;
@@ -396,7 +396,7 @@ 
                 continue;
             }
             foreach ($mt_reg['messengers_supporting_default_template_pack_with'] as $messenger_slug) {
-                $supports[ $messenger_slug ][] = $addon_name;
+                $supports[$messenger_slug][] = $addon_name;
             }
         }
         return $supports;
@@ -423,7 +423,7 @@ 
         string $context,
         EE_Messages_Template_Pack $template_pack
     ): string {
-        if (! $template_pack instanceof EE_Messages_Template_Pack_Default
+        if ( ! $template_pack instanceof EE_Messages_Template_Pack_Default
             || ! $message_type instanceof EE_message_type
         ) {
             return $base_path;
@@ -466,7 +466,7 @@ 
         string $file_extension,
         EE_Messages_Template_Pack $template_pack
     ): string {
-        if (! $template_pack instanceof EE_Messages_Template_Pack_Default) {
+        if ( ! $template_pack instanceof EE_Messages_Template_Pack_Default) {
             return $base_path_or_url;
         }
         foreach (self::$_ee_message_type_registry as $addon_name => $mt_reg) {

core/libraries/messages/EE_Message_Resource_Manager.lib.php

Indentation +1118 added lines, -1118 removed lines

@@ -12,1122 +12,1122 @@
 class EE_Message_Resource_Manager
 {
 
-    /**
-     * This option in the database is used to keep a record of message types that have been activated for a messenger
-     * at some point in the history of the site.  It is utilized by the implementation of the 'force' flag in
-     * EE_Register_Message_Type.  The force flag is an indication of whether a message type should be activated by
-     * default when the message type is registered.  However, if a user has explicitly deactivated a message type, then
-     * the force flag is ignored.  The method by which the code knows whether to ignore this flag is via this option.
-     * Note, that this is NOT a historical record.  Its entirely possible for a message type to have been activated for
-     * a messenger and yet not have a record in this option.  This occurs when a message type is inactivated through an
-     * automated process (when an add-on registering the message type deactivates, or when some other code calls the
-     * EE_Registery_Message_Type::deregister method) and the related record(s) is(are) removed from this option to ensure
-     * the "force" flag is respected if that message type is later re-registered.
-     *
-     * This option should NOT be used to determine the current "active" state of a message type for a given messenger.
-     *
-     * The name of this option (and related methods/properties) is due to matching the original intended purpose for the
-     * option that got superseded by later behaviour requirements.
-     */
-    const HAS_ACTIVATED_MESSAGE_TYPE_FOR_MESSENGER_OPTION_NAME = 'ee_has_activated_messenger';
-
-    /**
-     * @type boolean $_initialized
-     */
-    protected $_initialized = false;
-
-    /**
-     * @type EE_Messenger_Collection $_messenger_collection_loader
-     */
-    protected $_messenger_collection_loader;
-
-    /**
-     * @type EE_Message_Type_Collection $_message_type_collection_loader
-     */
-    protected $_message_type_collection_loader;
-
-    /**
-     * @type EEM_Message_Template_Group $_message_template_group_model
-     */
-    protected $_message_template_group_model;
-
-    /**
-     * @type EE_messenger[]
-     */
-    protected $_installed_messengers = array();
-
-    /**
-     * @type EE_message_type[]
-     */
-    protected $_installed_message_types = array();
-
-    /**
-     * Array of active messengers.
-     * Format is this:
-     * array(
-     *      'messenger_name' => EE_messenger
-     * )
-     *
-     * @type EE_messenger[]
-     */
-    protected $_active_messengers = array();
-
-    /**
-     * Formatted array of active message types grouped per messenger.
-     * Format is this:
-     * array(
-     *      'messenger_name' => array(
-     *          'settings' => array(
-     *              '{messenger_name}-message_types' => array(
-     *                  'message_type_name' => array() //variable array of settings corresponding to message type.
-     *              )
-     *          )
-     *      )
-     * )
-     *
-     * @type array
-     */
-    protected $_active_message_types = array();
-
-
-    /**
-     * This holds the array of messengers and their corresponding message types that have
-     * been activated on a site at some point.  This is an important record that helps the messages system
-     * not accidentally reactivate something that was intentionally deactivated by a user.
-     *
-     * @see phpdocs on EE_Message_Resource_Manager::HAS_ACTIVATED_MESSAGE_TYPE_FOR_MESSENGER_OPTION_NAME for more details.
-     *
-     * @type array
-     */
-    protected $_has_activated_messengers_and_message_types = array();
-
-    /**
-     * An array of unique message type contexts across all active message types.
-     * The array will be indexed by either 'slugs' or 'all'.
-     * The slugs index contains an array indexed by unique context slugs with the latest label representation for that
-     * slug. array(
-     *      'context_slug' => 'localized label for context obtained from latest message type in the loop'.
-     * );
-     * The all index returns an array in this format:
-     * array(
-     *      'message_type_name' => array(
-     *          'context_slug' => array(
-     *              'label' => 'localized label for context',
-     *              'description' => 'localized description for context'
-     *          )
-     *      )
-     * );
-     *
-     * @type array
-     */
-    protected $_contexts = array();
-
-
-    /**
-     * EE_Message_Resource_Manager constructor.
-     *
-     * @param \EE_Messenger_Collection_Loader    $Messenger_Collection_Loader
-     * @param \EE_Message_Type_Collection_Loader $Message_Type_Collection_Loader
-     * @param \EEM_Message_Template_Group        $Message_Template_Group_Model
-     */
-    public function __construct(
-        EE_Messenger_Collection_Loader $Messenger_Collection_Loader,
-        EE_Message_Type_Collection_Loader $Message_Type_Collection_Loader,
-        EEM_Message_Template_Group $Message_Template_Group_Model
-    ) {
-        $this->_messenger_collection_loader    = $Messenger_Collection_Loader;
-        $this->_message_type_collection_loader = $Message_Type_Collection_Loader;
-        $this->_message_template_group_model   = $Message_Template_Group_Model;
-    }
-
-
-    /**
-     * @return void
-     */
-    protected function _initialize_collections()
-    {
-        if ($this->_initialized) {
-            return;
-        }
-        $this->_initialized = true;
-        $this->_messenger_collection_loader->load_messengers_from_folder();
-        $this->_message_type_collection_loader->load_message_types_from_folder();
-        $this->get_has_activated_messengers_option(true);
-        $this->_set_active_messengers_and_message_types();
-    }
-
-
-    /**
-     * @return EE_Messenger_Collection
-     */
-    public function messenger_collection()
-    {
-        $this->_initialize_collections();
-        return $this->_messenger_collection_loader->messenger_collection();
-    }
-
-
-    /**
-     * @return EE_messenger[]
-     */
-    public function active_messengers()
-    {
-        $this->_initialize_collections();
-        return $this->_active_messengers;
-    }
-
-
-    /**
-     * @param string $messenger_name
-     * @return \EE_messenger
-     */
-    public function get_messenger($messenger_name)
-    {
-        return $this->messenger_collection()->get_by_info($messenger_name);
-    }
-
-
-    /**
-     * This returns the corresponding EE_messenger object for the given string if it is active.
-     *
-     * @param string $messenger
-     * @return EE_messenger | null
-     */
-    public function get_active_messenger($messenger)
-    {
-        $this->_initialize_collections();
-        return ! empty($this->_active_messengers[ $messenger ]) ? $this->_active_messengers[ $messenger ] : null;
-    }
-
-
-    /**
-     * @return \EE_messenger[]
-     */
-    public function installed_messengers()
-    {
-        if (empty($this->_installed_messengers)) {
-            $this->_installed_messengers = array();
-            $this->messenger_collection()->rewind();
-            while ($this->messenger_collection()->valid()) {
-                $this->_installed_messengers[ $this->messenger_collection()->current()->name ] = $this->messenger_collection()->current();
-                $this->messenger_collection()->next();
-            }
-        }
-        return $this->_installed_messengers;
-    }
-
-
-    /**
-     * @param string $messenger_name
-     * @return \EE_messenger
-     * @throws EE_Error
-     */
-    public function valid_messenger($messenger_name)
-    {
-        $messenger = $this->get_messenger($messenger_name);
-        if ($messenger instanceof EE_messenger) {
-            return $messenger;
-        }
-        throw new EE_Error(
-            sprintf(
-                __('The "%1$s" messenger is either invalid or not installed', 'event_espresso'),
-                $messenger_name
-            )
-        );
-    }
-
-
-    /**
-     * @return EE_Message_Type_Collection
-     */
-    public function message_type_collection()
-    {
-        $this->_initialize_collections();
-        return $this->_message_type_collection_loader->message_type_collection();
-    }
-
-
-    /**
-     * @return array
-     */
-    public function active_message_types()
-    {
-        $this->_initialize_collections();
-        return $this->_active_message_types;
-    }
-
-
-    /**
-     * @param string $message_type_name
-     * @return \EE_message_type
-     */
-    public function get_message_type($message_type_name)
-    {
-        return $this->message_type_collection()->get_by_info($message_type_name);
-    }
-
-
-    /**
-     * This returns the EE_message_type from the active message types array ( if present );
-     *
-     * @param string $messenger_name
-     * @param string $message_type_name
-     * @return \EE_message_type|null
-     */
-    public function get_active_message_type_for_messenger($messenger_name, $message_type_name)
-    {
-        return $this->is_message_type_active_for_messenger($messenger_name, $message_type_name)
-            ? $this->get_message_type($message_type_name)
-            : null;
-    }
-
-
-    /**
-     * Returns whether the given message type is active for the given messenger.
-     *
-     * @param string $messenger_name
-     * @param string $message_type_name
-     * @return bool
-     */
-    public function is_message_type_active_for_messenger($messenger_name, $message_type_name)
-    {
-        $this->_initialize_collections();
-        return ! empty($this->_active_message_types[ $messenger_name ]['settings'][ $messenger_name . '-message_types' ][ $message_type_name ]);
-    }
-
-
-    /**
-     * Returns whether the given messenger is active.
-     *
-     * @param string $messenger_name the name of the messenger to check if active.
-     * @return bool
-     */
-    public function is_messenger_active($messenger_name)
-    {
-        $this->_initialize_collections();
-        return ! empty($this->_active_message_types[ $messenger_name ]);
-    }
-
-
-    /**
-     * This returns any settings that might be on a message type for a messenger
-     *
-     * @param string $messenger_name    The slug of the messenger
-     * @param string $message_type_name The slug of the message type getting the settings for.
-     * @return array
-     */
-    public function get_message_type_settings_for_messenger($messenger_name, $message_type_name)
-    {
-        $settings = array();
-        if ($this->is_message_type_active_for_messenger($messenger_name, $message_type_name)) {
-            $settings = isset($this->_active_message_types[ $messenger_name ]['settings'][ $messenger_name . '-message_types' ][ $message_type_name ]['settings'])
-                ? $this->_active_message_types[ $messenger_name ]['settings'][ $messenger_name . '-message_types' ][ $message_type_name ]['settings']
-                : array();
-        }
-        return $settings;
-    }
-
-
-    /**
-     * Returns whether the given messenger name has active message types on it.
-     * Infers whether the messenger is active or not as well.
-     *
-     * @param string $messenger_name
-     * @return bool
-     */
-    public function messenger_has_active_message_types($messenger_name)
-    {
-        $this->_initialize_collections();
-        return
-            ! empty($this->_active_message_types[ $messenger_name ])
-            && ! empty($this->_active_message_types[ $messenger_name ]['settings'][ $messenger_name . '-message_types' ]);
-    }
-
-
-    /**
-     * This checks the _active_message_types property for any active message types
-     * that are present for the given messenger and returns them.
-     *
-     * @since 4.9.0
-     * @param string $messenger_name The messenger being checked
-     * @return EE_message_type[]|array    (empty array if no active_message_types)
-     */
-    public function get_active_message_types_for_messenger($messenger_name)
-    {
-        $message_types = array();
-        if (! $this->messenger_has_active_message_types($messenger_name)) {
-            return $message_types;
-        }
-        $installed_message_types = $this->installed_message_types();
-        foreach ($installed_message_types as $message_type_name => $message_type) {
-            if ($this->is_message_type_active_for_messenger($messenger_name, $message_type_name)) {
-                $message_types[ $message_type_name ] = $message_type;
-            }
-        }
-        return $message_types;
-    }
-
-
-    /**
-     * This does NOT return the _active_message_types property but
-     * simply returns an array of active message type names from that property.
-     * (The _active_message_types property is indexed by messenger and active message_types per messenger).
-     *
-     * @return array message_type references (string)
-     */
-    public function list_of_active_message_types()
-    {
-        $active_message_type_names = array();
-        $this->_initialize_collections();
-        foreach ($this->_active_message_types as $messenger => $messenger_settings) {
-            if (! isset($messenger_settings['settings'][ $messenger . '-message_types' ])) {
-                continue;
-            }
-            foreach ($messenger_settings['settings'][ $messenger . '-message_types' ] as $message_type_name => $message_type_config) {
-                if (! in_array($message_type_name, $active_message_type_names)) {
-                    $active_message_type_names[] = $message_type_name;
-                }
-            }
-        }
-        return $active_message_type_names;
-    }
-
-
-    /**
-     * Same as list_of_active_message_types() except this returns actual EE_message_type objects
-     *
-     * @since 4.9.0
-     * @return \EE_message_type[]
-     */
-    public function get_active_message_type_objects()
-    {
-        $active_message_types      = array();
-        $installed_message_types   = $this->installed_message_types();
-        $active_message_type_names = $this->list_of_active_message_types();
-        foreach ($active_message_type_names as $active_message_type_name) {
-            if (isset($installed_message_types[ $active_message_type_name ])) {
-                $active_message_types[ $active_message_type_name ] = $installed_message_types[ $active_message_type_name ];
-            }
-        }
-        return $active_message_types;
-    }
-
-
-    /**
-     * @return \EE_message_type[]
-     */
-    public function installed_message_types()
-    {
-        if (empty($this->_installed_message_types)) {
-            $this->message_type_collection()->rewind();
-            while ($this->message_type_collection()->valid()) {
-                $this->_installed_message_types[ $this->message_type_collection()->current()->name ] = $this->message_type_collection()->current();
-                $this->message_type_collection()->next();
-            }
-        }
-        return $this->_installed_message_types;
-    }
-
-
-    /**
-     * @param string $message_type_name
-     * @return \EE_message_type
-     * @throws EE_Error
-     */
-    public function valid_message_type($message_type_name)
-    {
-        $message_type = $this->get_message_type($message_type_name);
-        if ($message_type instanceof EE_message_type) {
-            return $message_type;
-        }
-        throw new EE_Error(
-            sprintf(
-                __('The "%1$s" message type is either invalid or not installed', 'event_espresso'),
-                $message_type_name
-            )
-        );
-    }
-
-
-    /**
-     * valid_message_type_for_messenger
-     *
-     * @param EE_messenger $messenger
-     * @param string       $message_type_name
-     * @return boolean
-     * @throws EE_Error
-     */
-    public function valid_message_type_for_messenger(EE_messenger $messenger, $message_type_name)
-    {
-        $valid_message_types = $messenger->get_valid_message_types();
-        if (! in_array($message_type_name, $valid_message_types)) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'The message type (%1$s) sent to "%2$s" is not valid for the "%3$s" messenger.  Double-check the spelling and verify that message type has been registered as a valid type with the messenger.',
-                        'event_espresso'
-                    ),
-                    $message_type_name,
-                    __METHOD__,
-                    $messenger->name
-                )
-            );
-        }
-        return true;
-    }
-
-
-    /**
-     * 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.
-     *
-     * @param   bool $reset     If true then we ignore whether the option is cached on the _active_message_types
-     *                          property and pull directly from the db.  Otherwise whatever is currently on the
-     *                          $_active_message_types property is pulled.
-     * @return array
-     */
-    public function get_active_messengers_option($reset = false)
-    {
-        if ($reset) {
-            $this->_active_message_types = get_option('ee_active_messengers', array());
-        }
-        return $this->_active_message_types;
-    }
-
-
-    /**
-     * Used to update the active messengers array stored in the wp options table.
-     *
-     * @param array $active_messenger_settings Incoming data to save.  If empty, then the internal cached property
-     *                                         representing this data is used.
-     * @return bool FALSE if not updated, TRUE if updated.
-     */
-    public function update_active_messengers_option($active_messenger_settings = array())
-    {
-        $active_messenger_settings = empty($active_messenger_settings) ? $this->_active_message_types : $active_messenger_settings;
-        // make sure _active_message_types is updated (this is the internal cache for the settings).
-        $this->_active_message_types = $active_messenger_settings;
-        return update_option('ee_active_messengers', $active_messenger_settings);
-    }
-
-
-    /**
-     * Used to return has activated message types for messengers array stored in the wp options table.
-     * If no value is present in the option then an empty array is returned.
-     * The value is cached on the $_has_activated_messengers_and_message_types property for future calls.
-     * @see phpdocs on EE_Message_Resource_Manager::HAS_ACTIVATED_MESSAGE_TYPE_FOR_MESSENGER_OPTION_NAME for more details.
-     *
-     * @param   bool $reset Used to indicate that any cached value should be ignored.
-     * @return array
-     */
-    public function get_has_activated_messengers_option($reset = false)
-    {
-        if ($reset || empty($this->_has_activated_messengers_and_message_types)) {
-            $this->_has_activated_messengers_and_message_types = get_option(self::HAS_ACTIVATED_MESSAGE_TYPE_FOR_MESSENGER_OPTION_NAME, array());
-        }
-        return $this->_has_activated_messengers_and_message_types;
-    }
-
-
-    /**
-     * Used to update the has activated option in the db.
-     *
-     * @see phpdocs on EE_Message_Resource_Manager::HAS_ACTIVATED_MESSAGE_TYPE_FOR_MESSENGER_OPTION_NAME for more details.
-     *
-     * @param array $has_activated_messengers Incoming data to save.  If empty, then the internal cached property
-     *                                        representing this data is used.
-     * @return bool FALSE if not updated, TRUE if updated.
-     */
-    public function update_has_activated_messengers_option($has_activated_messengers = array())
-    {
-        // make sure the option has been retrieved from first so we don't overwrite it accidentally.
-        if (empty($has_activated_messengers) && empty($this->_has_activated_messengers_and_message_types)) {
-            $this->get_has_activated_messengers_option();
-        }
-        $has_activated_messengers = empty($has_activated_messengers)
-            ? $this->_has_activated_messengers_and_message_types
-            : $has_activated_messengers;
-        return update_option(self::HAS_ACTIVATED_MESSAGE_TYPE_FOR_MESSENGER_OPTION_NAME, $has_activated_messengers);
-    }
-
-
-    /**
-     * wrapper for _set_active_messengers_and_message_types()
-     */
-    public function reset_active_messengers_and_message_types()
-    {
-        $this->_set_active_messengers_and_message_types();
-    }
-
-
-    /**
-     * Generate list of active messengers and message types from collection.
-     * This sets up the active messengers from what is present in the database.
-     */
-    protected function _set_active_messengers_and_message_types()
-    {
-        // echo "\n\n " . __LINE__ . ") " . __METHOD__ . "() \n";
-        // list of activated messengers as set via the admin
-        // note calling `get_active_messengers_options` also initializes the _active_message_types property.
-        $this->get_active_messengers_option(true);
-        $this->ensure_messengers_are_active(array(), false, true);
-        $this->update_active_messengers_option();
-        $this->update_has_activated_messengers_option();
-    }
-
-
-    /**
-     * Ensures that the specified messenger is currently active.
-     * If not, activates it and its default message types.
-     *
-     * @param string $messenger_name
-     * @param bool   $update_option Whether to update the option in the db or not.
-     * @return boolean true if either already active or successfully activated.
-     */
-    public function ensure_messenger_is_active($messenger_name, $update_option = true)
-    {
-        if (! isset($this->_active_messengers[ $messenger_name ])) {
-            try {
-                $this->activate_messenger($messenger_name, array(), $update_option);
-            } catch (EE_Error $e) {
-                EE_Error::add_error(
-                    $e->getMessage(),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-                return false;
-            }
-        }
-        return true;
-    }
-
-
-    /**
-     * This ensures the given array of messenger names is active in the system.
-     * Note, this method will not activate any NEW message types for the messenger when it is called. Instead,
-     * it will automatically activate the default message types for the messenger if its not active.
-     *
-     * @param array $messenger_names  Array of messenger names for messengers to be activated.  If an empty array
-     *                                (default) then will attempt to set the active messengers from the
-     *                                activated_messengers option
-     *                                (stored in $_active_message_types property).
-     * @param bool  $update_option    Whether to update the related active messengers option.
-     * @param bool  $verify           Whether to verify the messengers are installed before activating. Note if this is
-     *                                set to true and a messenger is indicated as active, but is NOT installed, then it
-     *                                will automatically be deactivated.
-     */
-    public function ensure_messengers_are_active($messenger_names = array(), $update_option = true, $verify = false)
-    {
-        $messenger_names = empty($messenger_names) ? array_keys($this->_active_message_types) : $messenger_names;
-
-        $not_installed = array();
-        foreach ($messenger_names as $messenger_name) {
-            if ($verify && ! $this->messenger_collection()->has_by_name($messenger_name)) {
-                $not_installed[] = $messenger_name;
-                $this->deactivate_messenger($messenger_name);
-                continue;
-            }
-            $this->ensure_messenger_is_active($messenger_name, $update_option);
-        }
-
-        if (! empty($not_installed)) {
-            EE_Error::add_error(
-                sprintf(
-                    __('The following messengers are either not installed or are invalid:%1$s %2$s', 'event_espresso'),
-                    '<br />',
-                    implode(', ', $not_installed)
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-    }
-
-
-    /**
-     * Ensures that the specified message type for the given messenger is currently active, if not activates it.
-     * This ALSO ensures that the given messenger is active as well!
-     *
-     * @param string $message_type_name message type name.
-     * @param        $messenger_name
-     * @param bool   $update_option     Whether to update the option in the db or not.
-     * @return bool  Returns true if already is active or if was activated successfully.
-     * @throws EE_Error
-     */
-    public function ensure_message_type_is_active($message_type_name, $messenger_name, $update_option = true)
-    {
-        // grab the messenger to work with.
-        $messenger = $this->valid_messenger($messenger_name);
-        if ($this->valid_message_type_for_messenger($messenger, $message_type_name)) {
-            // ensure messenger is active (that's an inherent coupling between active message types and the
-            // messenger they are being activated for.
-            try {
-                if (! $this->is_message_type_active_for_messenger($messenger_name, $message_type_name)) {
-                    // all is good so let's just get it active
-                    $this->activate_messenger($messenger, array($message_type_name), $update_option);
-                }
-            } catch (EE_Error $e) {
-                EE_Error::add_error(
-                    $e->getMessage(),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-                return false;
-            }
-        }
-        return true;
-    }
-
-
-    /**
-     * This is a wrapper for `ensure_message_type_is_active` that will handle ensuring multiple message types for a
-     * messenger are active in one go.
-     *
-     * @param array  $message_type_names Array of message type names to ensure are active.
-     * @param string $messenger_name     The name of the messenger that the message types are to be activated on.
-     * @param bool   $update_option      Whether to persist the activation to the database or not (default true).
-     */
-    public function ensure_message_types_are_active($message_type_names, $messenger_name, $update_option = true)
-    {
-        $message_type_names = (array) $message_type_names;
-        foreach ($message_type_names as $message_type_name) {
-            // note, intentionally not updating option here because we're in a loop.
-            // We'll follow the instructions of the incoming $update_option argument after the loop.
-            $this->ensure_message_type_is_active($message_type_name, $messenger_name, false);
-        }
-        if ($update_option) {
-            $this->update_active_messengers_option();
-            $this->update_has_activated_messengers_option();
-        }
-    }
-
-
-    /**
-     * Activates the specified messenger.
-     *
-     * @param EE_messenger|string $messenger    Instantiated EE_messenger OR messenger name if not already loaded!
-     * @param array  $message_type_names        An array of message type names to activate with this messenger.
-     *                                          If included we do NOT setup the default message types
-     *                                          (assuming they are already setup.)
-     * @param bool   $update_active_messengers_option
-     * @return array of generated templates
-     * @throws EE_Error
-     */
-    public function activate_messenger(
-        $messenger,
-        $message_type_names = array(),
-        $update_active_messengers_option = true
-    ) {
-        $templates = array();
-        // grab the messenger to work with.
-        $messenger = $messenger instanceof EE_messenger
-            ? $messenger
-            : $this->messenger_collection()->get_by_info($messenger);
-        // it's inactive. Activate it.
-        if ($messenger instanceof EE_messenger) {
-            $this->_active_messengers[ $messenger->name ] = $messenger;
-            // activate incoming message types set to be activated with messenger.
-            $message_type_names = $this->_activate_message_types($messenger, $message_type_names);
-            // setup any initial settings for the messenger if necessary.
-            $this->add_settings_for_messenger($messenger->name);
-            if ($update_active_messengers_option) {
-                $this->update_active_messengers_option();
-                $this->update_has_activated_messengers_option();
-            }
-            // generate new templates if necessary and ensure all related templates that are already in the database are
-            // marked active.  Note, this will also deactivate a message type for a messenger if the template
-            // cannot be successfully created during its attempt (only happens for global template attempts).
-            if (! empty($message_type_names)) {
-                $templates = EEH_MSG_Template::generate_new_templates($messenger->name, $message_type_names, 0, true);
-                EEH_MSG_Template::update_to_active(array($messenger->name), $message_type_names);
-            }
-        }
-        return $templates;
-    }
-
-
-    /**
-     * Activates given message types for the given EE_messenger object.
-     * Note: (very important) This method does not persist the activation to the database.
-     * See code implementing this method in this class for examples of how to persist.
-     *
-     * @param \EE_messenger $messenger
-     * @param  array        $message_type_names
-     * @return array
-     */
-    protected function _activate_message_types(EE_messenger $messenger, $message_type_names = array())
-    {
-        // If $message_type_names is empty, AND $this->_active_message_types is empty, then that means
-        // things have never been initialized (which should happen on EEH_Activation::generate_message_templates).
-        // So ONLY then do we need to actually grab defaults and cycle through them.  Otherwise we
-        // only override _active_message_types when an explicit array of $message_type_names has been provided.
-        $message_type_names = empty($message_type_names) && ! isset($this->_active_message_types[ $messenger->name ])
-            ? $messenger->get_default_message_types()
-            : (array) $message_type_names;
-
-        // now we ALWAYS need to make sure that the messenger is active for the message types we're activating!
-        if (! isset($this->_active_message_types[ $messenger->name ])) {
-            $this->_active_message_types[ $messenger->name ]['settings'] = array();
-        }
-
-        if ($message_type_names) {
-            // cycle thru message types
-            foreach ($message_type_names as $message_type_name) {
-                // only register the message type as active IF it isn't already active
-                // and if its actually installed.
-                if (
-                    ! $this->is_message_type_active_for_messenger($messenger->name, $message_type_name)
-                ) {
-                    $this->add_settings_for_message_type($messenger->name, $message_type_name);
-                    $this->_set_messenger_has_activated_message_type(
-                        $messenger,
-                        $message_type_name
-                    );
-                }
-            }
-        }
-        return $message_type_names;
-    }
-
-
-    /**
-     * add_settings_for_message_type
-     * NOTE This does NOT automatically persist any settings to the db.  Client code should call
-     * $this->update_active_messengers_option to persist.
-     *
-     * @param  string $messenger_name    The name of the messenger adding the settings for
-     * @param  string $message_type_name The name of the message type adding the settings for
-     * @param  array  $new_settings      Any new settings being set for the message type and messenger
-     */
-    public function add_settings_for_message_type($messenger_name, $message_type_name, $new_settings = array())
-    {
-        // get installed message type from collection
-        $message_type      = $this->message_type_collection()->get_by_info($message_type_name);
-        $existing_settings = $this->get_message_type_settings_for_messenger($messenger_name, $message_type_name);
-        // we need to setup any initial settings for message types
-        if ($message_type instanceof EE_message_type) {
-            $default_settings = $message_type->get_admin_settings_fields();
-            foreach ($default_settings as $field => $values) {
-                if (isset($new_settings[ $field ])) {
-                    $existing_settings[ $field ] = $new_settings[ $field ];
-                    continue;
-                }
-                if (! isset($existing_settings[ $field ])) {
-                    $existing_settings[ $field ] = $values['default'];
-                }
-            }
-        }
-        $this->_active_message_types[ $messenger_name ]['settings'][ $messenger_name . '-message_types' ][ $message_type_name ]['settings'] = $existing_settings;
-    }
-
-
-    /**
-     * Updates the internal cached _has_activated_messengers_and_message_types property with the given messenger
-     * and message type.
-     *
-     * @see phpdocs on EE_Message_Resource_Manager::HAS_ACTIVATED_MESSAGE_TYPE_FOR_MESSENGER_OPTION_NAME for more details.
-     *
-     * @access protected
-     * @param \EE_messenger $messenger
-     * @param string        $message_type_name
-     */
-    protected function _set_messenger_has_activated_message_type(EE_messenger $messenger, $message_type_name)
-    {
-
-        // if _has_activated_messengers_and_message_types is empty then lets ensure its initialized
-        if (empty($this->_has_activated_messengers_and_message_types)) {
-            $this->get_has_activated_messengers_option();
-        }
-
-        // make sure this messenger has a record in the has_activated array
-        if (! isset($this->_has_activated_messengers_and_message_types[ $messenger->name ])) {
-            $this->_has_activated_messengers_and_message_types[ $messenger->name ] = array();
-        }
-        // check if message type has already been added
-        if (! in_array($message_type_name, $this->_has_activated_messengers_and_message_types[ $messenger->name ])) {
-            $this->_has_activated_messengers_and_message_types[ $messenger->name ][] = $message_type_name;
-        }
-    }
-
-
-    /**
-     * add_settings_for_messenger
-     * NOTE This does NOT automatically persist any settings to the db.  Client code should call
-     * $this->update_active_messengers_option to persist.
-     *
-     * @param string $messenger_name The name of the messenger the settings is being added for.
-     * @param array  $new_settings   An array of settings to update the existing settings.
-     */
-    public function add_settings_for_messenger($messenger_name, $new_settings = array())
-    {
-        $messenger = $this->get_messenger($messenger_name);
-        if ($messenger instanceof EE_messenger) {
-            $msgr_settings = $messenger->get_admin_settings_fields();
-            if (! empty($msgr_settings)) {
-                foreach ($msgr_settings as $field => $value) {
-                    // is there a new setting for this?
-                    if (isset($new_settings[ $field ])) {
-                        $this->_active_message_types[ $messenger->name ]['settings'][ $field ] = $new_settings[ $field ];
-                        continue;
-                    }
-                    // only set the default if it isn't already set.
-                    if (! isset($this->_active_message_types[ $messenger->name ]['settings'][ $field ])) {
-                        $this->_active_message_types[ $messenger->name ]['settings'][ $field ] = $value;
-                    }
-                }
-            }
-        }
-    }
-
-
-    /**
-     * deactivate_messenger
-     *
-     * @param  string|EE_messenger $messenger_name name of messenger
-     * @return void
-     */
-    public function deactivate_messenger($messenger_name)
-    {
-        $this->_initialize_collections();
-        if ($messenger_name instanceof EE_messenger) {
-            $messenger_name = $messenger_name->name;
-        }
-        unset($this->_active_messengers[ $messenger_name ]);
-        unset($this->_active_message_types[ $messenger_name ]);
-        $this->_message_template_group_model->deactivate_message_template_groups_for($messenger_name);
-        $this->update_active_messengers_option();
-    }
-
-
-    /**
-     * Deactivates a message type (note this will deactivate across all messenger's it is active on.
-     *
-     * @param  string $message_type_name     name of message type being deactivated
-     * @param bool    $set_has_active_record By default we always record the has_active record when deactivating a message
-     *                                       type.  However, this can be overridden if we don't want this set (usually when
-     *                                       this is called as a part of deregistration of a custom message type)
-     */
-    public function deactivate_message_type($message_type_name, $set_has_active_record = true)
-    {
-        $this->_initialize_collections();
-        if ($message_type_name instanceof EE_message_type) {
-            $message_type_name = $message_type_name->name;
-        }
-        foreach ($this->_active_message_types as $messenger_name => $settings) {
-            unset(
-                $this->_active_message_types[ $messenger_name ]['settings'][ $messenger_name . '-message_types' ][ $message_type_name ]
-            );
-
-            // we always record (even on deactivation) that a message type has been activated because there should at
-            // least be a record in the "has_activated" option that it WAS active at one point.
-            if ($set_has_active_record) {
-                $messenger = $this->get_messenger($messenger_name);
-                $this->_set_messenger_has_activated_message_type($messenger, $message_type_name);
-            }
-        }
-        $this->_message_template_group_model->deactivate_message_template_groups_for('', $message_type_name);
-        $this->update_active_messengers_option();
-        $this->update_has_activated_messengers_option();
-    }
-
-
-    /**
-     * Deactivates a message type for a specific messenger as opposed to all messengers.
-     *
-     * @param string $message_type_name Name of message type being deactivated.
-     * @param string $messenger_name    Name of messenger the message type is being deactivated for.
-     */
-    public function deactivate_message_type_for_messenger($message_type_name, $messenger_name)
-    {
-        $this->_initialize_collections();
-        if ($this->is_message_type_active_for_messenger($messenger_name, $message_type_name)) {
-            unset($this->_active_message_types[ $messenger_name ]['settings'][ $messenger_name . '-message_types' ][ $message_type_name ]);
-        }
-        $this->_message_template_group_model->deactivate_message_template_groups_for(
-            array($messenger_name),
-            array($message_type_name)
-        );
-        $this->update_active_messengers_option();
-    }
-
-
-    /**
-     * Used to verify if a message can be sent for the given messenger and message type
-     * and that it is a generating messenger (used for generating message templates).
-     *
-     * @param EE_messenger    $messenger    messenger used in trigger
-     * @param EE_message_type $message_type message type used in trigger
-     * @return bool true is a generating messenger and can be sent OR FALSE meaning cannot send.
-     */
-    public function is_generating_messenger_and_active(EE_messenger $messenger, EE_message_type $message_type)
-    {
-        // get the $messengers the message type says it can be used with.
-        foreach ($message_type->with_messengers() as $generating_messenger => $secondary_messengers) {
-            if (
-                $messenger->name === $generating_messenger
-                && $this->is_message_type_active_for_messenger($messenger->name, $message_type->name)
-            ) {
-                return true;
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     * This returns all the contexts that are registered by all message types.
-     * If $slugs_only is true,
-     * then just an array indexed by unique context slugs with the latest label representation for that slug.
-     * array(
-     *      'context_slug' => 'localized label for context obtained from latest message type in the loop'.
-     * );
-     * If $slugs_only is false, then the format is:
-     * array(
-     *      'message_type_name' => array(
-     *          'context_slug' => array(
-     *              'label' => 'localized label for context',
-     *              'description' => 'localized description for context'
-     *          )
-     *      )
-     * );
-     * Keep in mind that although different message types may share the same context slugs,
-     * it is possible that the context is described differently by the message type.
-     *
-     * @since 4.9.0
-     * @param   bool $slugs_only Whether to return an array of just slugs and labels (true)
-     *                           or all contexts indexed by message type.
-     * @return array
-     */
-    public function get_all_contexts($slugs_only = true)
-    {
-        $key = $slugs_only ? 'slugs' : 'all';
-        // check if contexts has been setup yet.
-        if (empty($this->_contexts[ $key ])) {
-            // So let's get all active message type objects and loop through to get all unique contexts
-            foreach ($this->get_active_message_type_objects() as $message_type) {
-                if ($message_type instanceof EE_message_type) {
-                    $message_type_contexts = $message_type->get_contexts();
-                    if ($slugs_only) {
-                        foreach ($message_type_contexts as $context => $context_details) {
-                            $this->_contexts[ $key ][ $context ] = $context_details['label'];
-                        }
-                    } else {
-                        $this->_contexts[ $key ][ $message_type->name ] = $message_type_contexts;
-                    }
-                }
-            }
-        }
-        return ! empty($this->_contexts[ $key ]) ? $this->_contexts[ $key ] : array();
-    }
-
-
-    /**
-     * This checks the internal record of what message types are considered "active" and verifies that
-     * there is an installed class definition for that message type.  If the active message type does not have a
-     * corresponding accessible message type class then it will be deactivated from all messengers it is active on and
-     * any related message templates will be inactivated as well.
-     *
-     * @return bool   true means all active message types are valid, false means at least one message type was
-     *                deactivated.
-     */
-    public function validate_active_message_types_are_installed()
-    {
-        $list_of_active_message_type_names = $this->list_of_active_message_types();
-        $installed_message_types           = $this->installed_message_types();
-        $all_message_types_valid           = true;
-        // loop through list of active message types and verify they are installed.
-        foreach ($list_of_active_message_type_names as $message_type_name) {
-            if (! isset($installed_message_types[ $message_type_name ])) {
-                $this->remove_message_type_has_been_activated_from_all_messengers(
-                    $message_type_name,
-                    true
-                );
-                $this->deactivate_message_type($message_type_name, false);
-                $all_message_types_valid = false;
-            }
-        }
-        return $all_message_types_valid;
-    }
-
-
-    /**
-     * This method checks the `ee_has_activated_messenger` option to see if the message type has ever been
-     * activated for the given messenger.  This can be called by client code on plugin updates etc to determine whether
-     * to attempt automatically reactivating message types that should be activated by default or not.
-     *
-     * @see phpdocs on EE_Message_Resource_Manager::HAS_ACTIVATED_MESSAGE_TYPE_FOR_MESSENGER_OPTION_NAME for more details.
-     *
-     * @param $message_type_name
-     * @param $messenger_name
-     * @return bool
-     */
-    public function has_message_type_been_activated_for_messenger($message_type_name, $messenger_name)
-    {
-        $has_activated = $this->get_has_activated_messengers_option();
-        return isset($has_activated[ $messenger_name ])
-               && in_array($message_type_name, $has_activated[ $messenger_name ]);
-    }
-
-
-    /**
-     * This method unsets a message type from the given messenger has activated option.
-     *
-     * @see phpdocs on EE_Message_Resource_Manager::HAS_ACTIVATED_MESSAGE_TYPE_FOR_MESSENGER_OPTION_NAME for more details.
-     *
-     * @param string $message_type_name
-     * @param string $messenger_name
-     * @param bool   $consider_current_state  Whether to consider whether the  message type is currently active or not.
-     *                                        If it is currently active, then remove.  Otherwise leave it alone.
-     */
-    public function remove_message_type_has_been_activated_for_messenger(
-        $message_type_name,
-        $messenger_name,
-        $consider_current_state = false
-    ) {
-        if (
-            $consider_current_state
-            && ! $this->is_message_type_active_for_messenger($messenger_name, $message_type_name)
-        ) {
-            // when consider current state is true, this means we don't want to change anything on the "has_activated"
-            // record if the message type is currently active for this messenger.  This is used when we want to retain
-            // the record for user initiated inactivations of the message type.
-            return;
-        }
-        $has_activated = $this->get_has_activated_messengers_option();
-        $key_for_message_type = isset($has_activated[ $messenger_name ])
-            ? array_search($message_type_name, $has_activated[ $messenger_name ], true)
-            : false;
-        if ($key_for_message_type !== false) {
-            unset($has_activated[ $messenger_name ][ $key_for_message_type ]);
-            $this->update_has_activated_messengers_option($has_activated);
-            // reset the internal cached property
-            $this->get_has_activated_messengers_option(true);
-        }
-    }
-
-
-    /**
-     * Removes a message type active record from all messengers it is attached to.
-     *
-     * @see phpdocs on EE_Message_Resource_Manager::HAS_ACTIVATED_MESSAGE_TYPE_FOR_MESSENGER_OPTION_NAME for more details.
-     *
-     * @param      $message_type_name
-     * @param bool $consider_current_state  Whether to consider whether the  message type is currently active or not.
-     *                                      If it is currently active, then remove.  Otherwise leave it alone.
-     */
-    public function remove_message_type_has_been_activated_from_all_messengers(
-        $message_type_name,
-        $consider_current_state = false
-    ) {
-        foreach (array_keys($this->get_has_activated_messengers_option()) as $messenger_name) {
-            $this->remove_message_type_has_been_activated_for_messenger(
-                $message_type_name,
-                $messenger_name,
-                $consider_current_state
-            );
-        }
-    }
+	/**
+	 * This option in the database is used to keep a record of message types that have been activated for a messenger
+	 * at some point in the history of the site.  It is utilized by the implementation of the 'force' flag in
+	 * EE_Register_Message_Type.  The force flag is an indication of whether a message type should be activated by
+	 * default when the message type is registered.  However, if a user has explicitly deactivated a message type, then
+	 * the force flag is ignored.  The method by which the code knows whether to ignore this flag is via this option.
+	 * Note, that this is NOT a historical record.  Its entirely possible for a message type to have been activated for
+	 * a messenger and yet not have a record in this option.  This occurs when a message type is inactivated through an
+	 * automated process (when an add-on registering the message type deactivates, or when some other code calls the
+	 * EE_Registery_Message_Type::deregister method) and the related record(s) is(are) removed from this option to ensure
+	 * the "force" flag is respected if that message type is later re-registered.
+	 *
+	 * This option should NOT be used to determine the current "active" state of a message type for a given messenger.
+	 *
+	 * The name of this option (and related methods/properties) is due to matching the original intended purpose for the
+	 * option that got superseded by later behaviour requirements.
+	 */
+	const HAS_ACTIVATED_MESSAGE_TYPE_FOR_MESSENGER_OPTION_NAME = 'ee_has_activated_messenger';
+
+	/**
+	 * @type boolean $_initialized
+	 */
+	protected $_initialized = false;
+
+	/**
+	 * @type EE_Messenger_Collection $_messenger_collection_loader
+	 */
+	protected $_messenger_collection_loader;
+
+	/**
+	 * @type EE_Message_Type_Collection $_message_type_collection_loader
+	 */
+	protected $_message_type_collection_loader;
+
+	/**
+	 * @type EEM_Message_Template_Group $_message_template_group_model
+	 */
+	protected $_message_template_group_model;
+
+	/**
+	 * @type EE_messenger[]
+	 */
+	protected $_installed_messengers = array();
+
+	/**
+	 * @type EE_message_type[]
+	 */
+	protected $_installed_message_types = array();
+
+	/**
+	 * Array of active messengers.
+	 * Format is this:
+	 * array(
+	 *      'messenger_name' => EE_messenger
+	 * )
+	 *
+	 * @type EE_messenger[]
+	 */
+	protected $_active_messengers = array();
+
+	/**
+	 * Formatted array of active message types grouped per messenger.
+	 * Format is this:
+	 * array(
+	 *      'messenger_name' => array(
+	 *          'settings' => array(
+	 *              '{messenger_name}-message_types' => array(
+	 *                  'message_type_name' => array() //variable array of settings corresponding to message type.
+	 *              )
+	 *          )
+	 *      )
+	 * )
+	 *
+	 * @type array
+	 */
+	protected $_active_message_types = array();
+
+
+	/**
+	 * This holds the array of messengers and their corresponding message types that have
+	 * been activated on a site at some point.  This is an important record that helps the messages system
+	 * not accidentally reactivate something that was intentionally deactivated by a user.
+	 *
+	 * @see phpdocs on EE_Message_Resource_Manager::HAS_ACTIVATED_MESSAGE_TYPE_FOR_MESSENGER_OPTION_NAME for more details.
+	 *
+	 * @type array
+	 */
+	protected $_has_activated_messengers_and_message_types = array();
+
+	/**
+	 * An array of unique message type contexts across all active message types.
+	 * The array will be indexed by either 'slugs' or 'all'.
+	 * The slugs index contains an array indexed by unique context slugs with the latest label representation for that
+	 * slug. array(
+	 *      'context_slug' => 'localized label for context obtained from latest message type in the loop'.
+	 * );
+	 * The all index returns an array in this format:
+	 * array(
+	 *      'message_type_name' => array(
+	 *          'context_slug' => array(
+	 *              'label' => 'localized label for context',
+	 *              'description' => 'localized description for context'
+	 *          )
+	 *      )
+	 * );
+	 *
+	 * @type array
+	 */
+	protected $_contexts = array();
+
+
+	/**
+	 * EE_Message_Resource_Manager constructor.
+	 *
+	 * @param \EE_Messenger_Collection_Loader    $Messenger_Collection_Loader
+	 * @param \EE_Message_Type_Collection_Loader $Message_Type_Collection_Loader
+	 * @param \EEM_Message_Template_Group        $Message_Template_Group_Model
+	 */
+	public function __construct(
+		EE_Messenger_Collection_Loader $Messenger_Collection_Loader,
+		EE_Message_Type_Collection_Loader $Message_Type_Collection_Loader,
+		EEM_Message_Template_Group $Message_Template_Group_Model
+	) {
+		$this->_messenger_collection_loader    = $Messenger_Collection_Loader;
+		$this->_message_type_collection_loader = $Message_Type_Collection_Loader;
+		$this->_message_template_group_model   = $Message_Template_Group_Model;
+	}
+
+
+	/**
+	 * @return void
+	 */
+	protected function _initialize_collections()
+	{
+		if ($this->_initialized) {
+			return;
+		}
+		$this->_initialized = true;
+		$this->_messenger_collection_loader->load_messengers_from_folder();
+		$this->_message_type_collection_loader->load_message_types_from_folder();
+		$this->get_has_activated_messengers_option(true);
+		$this->_set_active_messengers_and_message_types();
+	}
+
+
+	/**
+	 * @return EE_Messenger_Collection
+	 */
+	public function messenger_collection()
+	{
+		$this->_initialize_collections();
+		return $this->_messenger_collection_loader->messenger_collection();
+	}
+
+
+	/**
+	 * @return EE_messenger[]
+	 */
+	public function active_messengers()
+	{
+		$this->_initialize_collections();
+		return $this->_active_messengers;
+	}
+
+
+	/**
+	 * @param string $messenger_name
+	 * @return \EE_messenger
+	 */
+	public function get_messenger($messenger_name)
+	{
+		return $this->messenger_collection()->get_by_info($messenger_name);
+	}
+
+
+	/**
+	 * This returns the corresponding EE_messenger object for the given string if it is active.
+	 *
+	 * @param string $messenger
+	 * @return EE_messenger | null
+	 */
+	public function get_active_messenger($messenger)
+	{
+		$this->_initialize_collections();
+		return ! empty($this->_active_messengers[ $messenger ]) ? $this->_active_messengers[ $messenger ] : null;
+	}
+
+
+	/**
+	 * @return \EE_messenger[]
+	 */
+	public function installed_messengers()
+	{
+		if (empty($this->_installed_messengers)) {
+			$this->_installed_messengers = array();
+			$this->messenger_collection()->rewind();
+			while ($this->messenger_collection()->valid()) {
+				$this->_installed_messengers[ $this->messenger_collection()->current()->name ] = $this->messenger_collection()->current();
+				$this->messenger_collection()->next();
+			}
+		}
+		return $this->_installed_messengers;
+	}
+
+
+	/**
+	 * @param string $messenger_name
+	 * @return \EE_messenger
+	 * @throws EE_Error
+	 */
+	public function valid_messenger($messenger_name)
+	{
+		$messenger = $this->get_messenger($messenger_name);
+		if ($messenger instanceof EE_messenger) {
+			return $messenger;
+		}
+		throw new EE_Error(
+			sprintf(
+				__('The "%1$s" messenger is either invalid or not installed', 'event_espresso'),
+				$messenger_name
+			)
+		);
+	}
+
+
+	/**
+	 * @return EE_Message_Type_Collection
+	 */
+	public function message_type_collection()
+	{
+		$this->_initialize_collections();
+		return $this->_message_type_collection_loader->message_type_collection();
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function active_message_types()
+	{
+		$this->_initialize_collections();
+		return $this->_active_message_types;
+	}
+
+
+	/**
+	 * @param string $message_type_name
+	 * @return \EE_message_type
+	 */
+	public function get_message_type($message_type_name)
+	{
+		return $this->message_type_collection()->get_by_info($message_type_name);
+	}
+
+
+	/**
+	 * This returns the EE_message_type from the active message types array ( if present );
+	 *
+	 * @param string $messenger_name
+	 * @param string $message_type_name
+	 * @return \EE_message_type|null
+	 */
+	public function get_active_message_type_for_messenger($messenger_name, $message_type_name)
+	{
+		return $this->is_message_type_active_for_messenger($messenger_name, $message_type_name)
+			? $this->get_message_type($message_type_name)
+			: null;
+	}
+
+
+	/**
+	 * Returns whether the given message type is active for the given messenger.
+	 *
+	 * @param string $messenger_name
+	 * @param string $message_type_name
+	 * @return bool
+	 */
+	public function is_message_type_active_for_messenger($messenger_name, $message_type_name)
+	{
+		$this->_initialize_collections();
+		return ! empty($this->_active_message_types[ $messenger_name ]['settings'][ $messenger_name . '-message_types' ][ $message_type_name ]);
+	}
+
+
+	/**
+	 * Returns whether the given messenger is active.
+	 *
+	 * @param string $messenger_name the name of the messenger to check if active.
+	 * @return bool
+	 */
+	public function is_messenger_active($messenger_name)
+	{
+		$this->_initialize_collections();
+		return ! empty($this->_active_message_types[ $messenger_name ]);
+	}
+
+
+	/**
+	 * This returns any settings that might be on a message type for a messenger
+	 *
+	 * @param string $messenger_name    The slug of the messenger
+	 * @param string $message_type_name The slug of the message type getting the settings for.
+	 * @return array
+	 */
+	public function get_message_type_settings_for_messenger($messenger_name, $message_type_name)
+	{
+		$settings = array();
+		if ($this->is_message_type_active_for_messenger($messenger_name, $message_type_name)) {
+			$settings = isset($this->_active_message_types[ $messenger_name ]['settings'][ $messenger_name . '-message_types' ][ $message_type_name ]['settings'])
+				? $this->_active_message_types[ $messenger_name ]['settings'][ $messenger_name . '-message_types' ][ $message_type_name ]['settings']
+				: array();
+		}
+		return $settings;
+	}
+
+
+	/**
+	 * Returns whether the given messenger name has active message types on it.
+	 * Infers whether the messenger is active or not as well.
+	 *
+	 * @param string $messenger_name
+	 * @return bool
+	 */
+	public function messenger_has_active_message_types($messenger_name)
+	{
+		$this->_initialize_collections();
+		return
+			! empty($this->_active_message_types[ $messenger_name ])
+			&& ! empty($this->_active_message_types[ $messenger_name ]['settings'][ $messenger_name . '-message_types' ]);
+	}
+
+
+	/**
+	 * This checks the _active_message_types property for any active message types
+	 * that are present for the given messenger and returns them.
+	 *
+	 * @since 4.9.0
+	 * @param string $messenger_name The messenger being checked
+	 * @return EE_message_type[]|array    (empty array if no active_message_types)
+	 */
+	public function get_active_message_types_for_messenger($messenger_name)
+	{
+		$message_types = array();
+		if (! $this->messenger_has_active_message_types($messenger_name)) {
+			return $message_types;
+		}
+		$installed_message_types = $this->installed_message_types();
+		foreach ($installed_message_types as $message_type_name => $message_type) {
+			if ($this->is_message_type_active_for_messenger($messenger_name, $message_type_name)) {
+				$message_types[ $message_type_name ] = $message_type;
+			}
+		}
+		return $message_types;
+	}
+
+
+	/**
+	 * This does NOT return the _active_message_types property but
+	 * simply returns an array of active message type names from that property.
+	 * (The _active_message_types property is indexed by messenger and active message_types per messenger).
+	 *
+	 * @return array message_type references (string)
+	 */
+	public function list_of_active_message_types()
+	{
+		$active_message_type_names = array();
+		$this->_initialize_collections();
+		foreach ($this->_active_message_types as $messenger => $messenger_settings) {
+			if (! isset($messenger_settings['settings'][ $messenger . '-message_types' ])) {
+				continue;
+			}
+			foreach ($messenger_settings['settings'][ $messenger . '-message_types' ] as $message_type_name => $message_type_config) {
+				if (! in_array($message_type_name, $active_message_type_names)) {
+					$active_message_type_names[] = $message_type_name;
+				}
+			}
+		}
+		return $active_message_type_names;
+	}
+
+
+	/**
+	 * Same as list_of_active_message_types() except this returns actual EE_message_type objects
+	 *
+	 * @since 4.9.0
+	 * @return \EE_message_type[]
+	 */
+	public function get_active_message_type_objects()
+	{
+		$active_message_types      = array();
+		$installed_message_types   = $this->installed_message_types();
+		$active_message_type_names = $this->list_of_active_message_types();
+		foreach ($active_message_type_names as $active_message_type_name) {
+			if (isset($installed_message_types[ $active_message_type_name ])) {
+				$active_message_types[ $active_message_type_name ] = $installed_message_types[ $active_message_type_name ];
+			}
+		}
+		return $active_message_types;
+	}
+
+
+	/**
+	 * @return \EE_message_type[]
+	 */
+	public function installed_message_types()
+	{
+		if (empty($this->_installed_message_types)) {
+			$this->message_type_collection()->rewind();
+			while ($this->message_type_collection()->valid()) {
+				$this->_installed_message_types[ $this->message_type_collection()->current()->name ] = $this->message_type_collection()->current();
+				$this->message_type_collection()->next();
+			}
+		}
+		return $this->_installed_message_types;
+	}
+
+
+	/**
+	 * @param string $message_type_name
+	 * @return \EE_message_type
+	 * @throws EE_Error
+	 */
+	public function valid_message_type($message_type_name)
+	{
+		$message_type = $this->get_message_type($message_type_name);
+		if ($message_type instanceof EE_message_type) {
+			return $message_type;
+		}
+		throw new EE_Error(
+			sprintf(
+				__('The "%1$s" message type is either invalid or not installed', 'event_espresso'),
+				$message_type_name
+			)
+		);
+	}
+
+
+	/**
+	 * valid_message_type_for_messenger
+	 *
+	 * @param EE_messenger $messenger
+	 * @param string       $message_type_name
+	 * @return boolean
+	 * @throws EE_Error
+	 */
+	public function valid_message_type_for_messenger(EE_messenger $messenger, $message_type_name)
+	{
+		$valid_message_types = $messenger->get_valid_message_types();
+		if (! in_array($message_type_name, $valid_message_types)) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'The message type (%1$s) sent to "%2$s" is not valid for the "%3$s" messenger.  Double-check the spelling and verify that message type has been registered as a valid type with the messenger.',
+						'event_espresso'
+					),
+					$message_type_name,
+					__METHOD__,
+					$messenger->name
+				)
+			);
+		}
+		return true;
+	}
+
+
+	/**
+	 * 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.
+	 *
+	 * @param   bool $reset     If true then we ignore whether the option is cached on the _active_message_types
+	 *                          property and pull directly from the db.  Otherwise whatever is currently on the
+	 *                          $_active_message_types property is pulled.
+	 * @return array
+	 */
+	public function get_active_messengers_option($reset = false)
+	{
+		if ($reset) {
+			$this->_active_message_types = get_option('ee_active_messengers', array());
+		}
+		return $this->_active_message_types;
+	}
+
+
+	/**
+	 * Used to update the active messengers array stored in the wp options table.
+	 *
+	 * @param array $active_messenger_settings Incoming data to save.  If empty, then the internal cached property
+	 *                                         representing this data is used.
+	 * @return bool FALSE if not updated, TRUE if updated.
+	 */
+	public function update_active_messengers_option($active_messenger_settings = array())
+	{
+		$active_messenger_settings = empty($active_messenger_settings) ? $this->_active_message_types : $active_messenger_settings;
+		// make sure _active_message_types is updated (this is the internal cache for the settings).
+		$this->_active_message_types = $active_messenger_settings;
+		return update_option('ee_active_messengers', $active_messenger_settings);
+	}
+
+
+	/**
+	 * Used to return has activated message types for messengers array stored in the wp options table.
+	 * If no value is present in the option then an empty array is returned.
+	 * The value is cached on the $_has_activated_messengers_and_message_types property for future calls.
+	 * @see phpdocs on EE_Message_Resource_Manager::HAS_ACTIVATED_MESSAGE_TYPE_FOR_MESSENGER_OPTION_NAME for more details.
+	 *
+	 * @param   bool $reset Used to indicate that any cached value should be ignored.
+	 * @return array
+	 */
+	public function get_has_activated_messengers_option($reset = false)
+	{
+		if ($reset || empty($this->_has_activated_messengers_and_message_types)) {
+			$this->_has_activated_messengers_and_message_types = get_option(self::HAS_ACTIVATED_MESSAGE_TYPE_FOR_MESSENGER_OPTION_NAME, array());
+		}
+		return $this->_has_activated_messengers_and_message_types;
+	}
+
+
+	/**
+	 * Used to update the has activated option in the db.
+	 *
+	 * @see phpdocs on EE_Message_Resource_Manager::HAS_ACTIVATED_MESSAGE_TYPE_FOR_MESSENGER_OPTION_NAME for more details.
+	 *
+	 * @param array $has_activated_messengers Incoming data to save.  If empty, then the internal cached property
+	 *                                        representing this data is used.
+	 * @return bool FALSE if not updated, TRUE if updated.
+	 */
+	public function update_has_activated_messengers_option($has_activated_messengers = array())
+	{
+		// make sure the option has been retrieved from first so we don't overwrite it accidentally.
+		if (empty($has_activated_messengers) && empty($this->_has_activated_messengers_and_message_types)) {
+			$this->get_has_activated_messengers_option();
+		}
+		$has_activated_messengers = empty($has_activated_messengers)
+			? $this->_has_activated_messengers_and_message_types
+			: $has_activated_messengers;
+		return update_option(self::HAS_ACTIVATED_MESSAGE_TYPE_FOR_MESSENGER_OPTION_NAME, $has_activated_messengers);
+	}
+
+
+	/**
+	 * wrapper for _set_active_messengers_and_message_types()
+	 */
+	public function reset_active_messengers_and_message_types()
+	{
+		$this->_set_active_messengers_and_message_types();
+	}
+
+
+	/**
+	 * Generate list of active messengers and message types from collection.
+	 * This sets up the active messengers from what is present in the database.
+	 */
+	protected function _set_active_messengers_and_message_types()
+	{
+		// echo "\n\n " . __LINE__ . ") " . __METHOD__ . "() \n";
+		// list of activated messengers as set via the admin
+		// note calling `get_active_messengers_options` also initializes the _active_message_types property.
+		$this->get_active_messengers_option(true);
+		$this->ensure_messengers_are_active(array(), false, true);
+		$this->update_active_messengers_option();
+		$this->update_has_activated_messengers_option();
+	}
+
+
+	/**
+	 * Ensures that the specified messenger is currently active.
+	 * If not, activates it and its default message types.
+	 *
+	 * @param string $messenger_name
+	 * @param bool   $update_option Whether to update the option in the db or not.
+	 * @return boolean true if either already active or successfully activated.
+	 */
+	public function ensure_messenger_is_active($messenger_name, $update_option = true)
+	{
+		if (! isset($this->_active_messengers[ $messenger_name ])) {
+			try {
+				$this->activate_messenger($messenger_name, array(), $update_option);
+			} catch (EE_Error $e) {
+				EE_Error::add_error(
+					$e->getMessage(),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+				return false;
+			}
+		}
+		return true;
+	}
+
+
+	/**
+	 * This ensures the given array of messenger names is active in the system.
+	 * Note, this method will not activate any NEW message types for the messenger when it is called. Instead,
+	 * it will automatically activate the default message types for the messenger if its not active.
+	 *
+	 * @param array $messenger_names  Array of messenger names for messengers to be activated.  If an empty array
+	 *                                (default) then will attempt to set the active messengers from the
+	 *                                activated_messengers option
+	 *                                (stored in $_active_message_types property).
+	 * @param bool  $update_option    Whether to update the related active messengers option.
+	 * @param bool  $verify           Whether to verify the messengers are installed before activating. Note if this is
+	 *                                set to true and a messenger is indicated as active, but is NOT installed, then it
+	 *                                will automatically be deactivated.
+	 */
+	public function ensure_messengers_are_active($messenger_names = array(), $update_option = true, $verify = false)
+	{
+		$messenger_names = empty($messenger_names) ? array_keys($this->_active_message_types) : $messenger_names;
+
+		$not_installed = array();
+		foreach ($messenger_names as $messenger_name) {
+			if ($verify && ! $this->messenger_collection()->has_by_name($messenger_name)) {
+				$not_installed[] = $messenger_name;
+				$this->deactivate_messenger($messenger_name);
+				continue;
+			}
+			$this->ensure_messenger_is_active($messenger_name, $update_option);
+		}
+
+		if (! empty($not_installed)) {
+			EE_Error::add_error(
+				sprintf(
+					__('The following messengers are either not installed or are invalid:%1$s %2$s', 'event_espresso'),
+					'<br />',
+					implode(', ', $not_installed)
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+	}
+
+
+	/**
+	 * Ensures that the specified message type for the given messenger is currently active, if not activates it.
+	 * This ALSO ensures that the given messenger is active as well!
+	 *
+	 * @param string $message_type_name message type name.
+	 * @param        $messenger_name
+	 * @param bool   $update_option     Whether to update the option in the db or not.
+	 * @return bool  Returns true if already is active or if was activated successfully.
+	 * @throws EE_Error
+	 */
+	public function ensure_message_type_is_active($message_type_name, $messenger_name, $update_option = true)
+	{
+		// grab the messenger to work with.
+		$messenger = $this->valid_messenger($messenger_name);
+		if ($this->valid_message_type_for_messenger($messenger, $message_type_name)) {
+			// ensure messenger is active (that's an inherent coupling between active message types and the
+			// messenger they are being activated for.
+			try {
+				if (! $this->is_message_type_active_for_messenger($messenger_name, $message_type_name)) {
+					// all is good so let's just get it active
+					$this->activate_messenger($messenger, array($message_type_name), $update_option);
+				}
+			} catch (EE_Error $e) {
+				EE_Error::add_error(
+					$e->getMessage(),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+				return false;
+			}
+		}
+		return true;
+	}
+
+
+	/**
+	 * This is a wrapper for `ensure_message_type_is_active` that will handle ensuring multiple message types for a
+	 * messenger are active in one go.
+	 *
+	 * @param array  $message_type_names Array of message type names to ensure are active.
+	 * @param string $messenger_name     The name of the messenger that the message types are to be activated on.
+	 * @param bool   $update_option      Whether to persist the activation to the database or not (default true).
+	 */
+	public function ensure_message_types_are_active($message_type_names, $messenger_name, $update_option = true)
+	{
+		$message_type_names = (array) $message_type_names;
+		foreach ($message_type_names as $message_type_name) {
+			// note, intentionally not updating option here because we're in a loop.
+			// We'll follow the instructions of the incoming $update_option argument after the loop.
+			$this->ensure_message_type_is_active($message_type_name, $messenger_name, false);
+		}
+		if ($update_option) {
+			$this->update_active_messengers_option();
+			$this->update_has_activated_messengers_option();
+		}
+	}
+
+
+	/**
+	 * Activates the specified messenger.
+	 *
+	 * @param EE_messenger|string $messenger    Instantiated EE_messenger OR messenger name if not already loaded!
+	 * @param array  $message_type_names        An array of message type names to activate with this messenger.
+	 *                                          If included we do NOT setup the default message types
+	 *                                          (assuming they are already setup.)
+	 * @param bool   $update_active_messengers_option
+	 * @return array of generated templates
+	 * @throws EE_Error
+	 */
+	public function activate_messenger(
+		$messenger,
+		$message_type_names = array(),
+		$update_active_messengers_option = true
+	) {
+		$templates = array();
+		// grab the messenger to work with.
+		$messenger = $messenger instanceof EE_messenger
+			? $messenger
+			: $this->messenger_collection()->get_by_info($messenger);
+		// it's inactive. Activate it.
+		if ($messenger instanceof EE_messenger) {
+			$this->_active_messengers[ $messenger->name ] = $messenger;
+			// activate incoming message types set to be activated with messenger.
+			$message_type_names = $this->_activate_message_types($messenger, $message_type_names);
+			// setup any initial settings for the messenger if necessary.
+			$this->add_settings_for_messenger($messenger->name);
+			if ($update_active_messengers_option) {
+				$this->update_active_messengers_option();
+				$this->update_has_activated_messengers_option();
+			}
+			// generate new templates if necessary and ensure all related templates that are already in the database are
+			// marked active.  Note, this will also deactivate a message type for a messenger if the template
+			// cannot be successfully created during its attempt (only happens for global template attempts).
+			if (! empty($message_type_names)) {
+				$templates = EEH_MSG_Template::generate_new_templates($messenger->name, $message_type_names, 0, true);
+				EEH_MSG_Template::update_to_active(array($messenger->name), $message_type_names);
+			}
+		}
+		return $templates;
+	}
+
+
+	/**
+	 * Activates given message types for the given EE_messenger object.
+	 * Note: (very important) This method does not persist the activation to the database.
+	 * See code implementing this method in this class for examples of how to persist.
+	 *
+	 * @param \EE_messenger $messenger
+	 * @param  array        $message_type_names
+	 * @return array
+	 */
+	protected function _activate_message_types(EE_messenger $messenger, $message_type_names = array())
+	{
+		// If $message_type_names is empty, AND $this->_active_message_types is empty, then that means
+		// things have never been initialized (which should happen on EEH_Activation::generate_message_templates).
+		// So ONLY then do we need to actually grab defaults and cycle through them.  Otherwise we
+		// only override _active_message_types when an explicit array of $message_type_names has been provided.
+		$message_type_names = empty($message_type_names) && ! isset($this->_active_message_types[ $messenger->name ])
+			? $messenger->get_default_message_types()
+			: (array) $message_type_names;
+
+		// now we ALWAYS need to make sure that the messenger is active for the message types we're activating!
+		if (! isset($this->_active_message_types[ $messenger->name ])) {
+			$this->_active_message_types[ $messenger->name ]['settings'] = array();
+		}
+
+		if ($message_type_names) {
+			// cycle thru message types
+			foreach ($message_type_names as $message_type_name) {
+				// only register the message type as active IF it isn't already active
+				// and if its actually installed.
+				if (
+					! $this->is_message_type_active_for_messenger($messenger->name, $message_type_name)
+				) {
+					$this->add_settings_for_message_type($messenger->name, $message_type_name);
+					$this->_set_messenger_has_activated_message_type(
+						$messenger,
+						$message_type_name
+					);
+				}
+			}
+		}
+		return $message_type_names;
+	}
+
+
+	/**
+	 * add_settings_for_message_type
+	 * NOTE This does NOT automatically persist any settings to the db.  Client code should call
+	 * $this->update_active_messengers_option to persist.
+	 *
+	 * @param  string $messenger_name    The name of the messenger adding the settings for
+	 * @param  string $message_type_name The name of the message type adding the settings for
+	 * @param  array  $new_settings      Any new settings being set for the message type and messenger
+	 */
+	public function add_settings_for_message_type($messenger_name, $message_type_name, $new_settings = array())
+	{
+		// get installed message type from collection
+		$message_type      = $this->message_type_collection()->get_by_info($message_type_name);
+		$existing_settings = $this->get_message_type_settings_for_messenger($messenger_name, $message_type_name);
+		// we need to setup any initial settings for message types
+		if ($message_type instanceof EE_message_type) {
+			$default_settings = $message_type->get_admin_settings_fields();
+			foreach ($default_settings as $field => $values) {
+				if (isset($new_settings[ $field ])) {
+					$existing_settings[ $field ] = $new_settings[ $field ];
+					continue;
+				}
+				if (! isset($existing_settings[ $field ])) {
+					$existing_settings[ $field ] = $values['default'];
+				}
+			}
+		}
+		$this->_active_message_types[ $messenger_name ]['settings'][ $messenger_name . '-message_types' ][ $message_type_name ]['settings'] = $existing_settings;
+	}
+
+
+	/**
+	 * Updates the internal cached _has_activated_messengers_and_message_types property with the given messenger
+	 * and message type.
+	 *
+	 * @see phpdocs on EE_Message_Resource_Manager::HAS_ACTIVATED_MESSAGE_TYPE_FOR_MESSENGER_OPTION_NAME for more details.
+	 *
+	 * @access protected
+	 * @param \EE_messenger $messenger
+	 * @param string        $message_type_name
+	 */
+	protected function _set_messenger_has_activated_message_type(EE_messenger $messenger, $message_type_name)
+	{
+
+		// if _has_activated_messengers_and_message_types is empty then lets ensure its initialized
+		if (empty($this->_has_activated_messengers_and_message_types)) {
+			$this->get_has_activated_messengers_option();
+		}
+
+		// make sure this messenger has a record in the has_activated array
+		if (! isset($this->_has_activated_messengers_and_message_types[ $messenger->name ])) {
+			$this->_has_activated_messengers_and_message_types[ $messenger->name ] = array();
+		}
+		// check if message type has already been added
+		if (! in_array($message_type_name, $this->_has_activated_messengers_and_message_types[ $messenger->name ])) {
+			$this->_has_activated_messengers_and_message_types[ $messenger->name ][] = $message_type_name;
+		}
+	}
+
+
+	/**
+	 * add_settings_for_messenger
+	 * NOTE This does NOT automatically persist any settings to the db.  Client code should call
+	 * $this->update_active_messengers_option to persist.
+	 *
+	 * @param string $messenger_name The name of the messenger the settings is being added for.
+	 * @param array  $new_settings   An array of settings to update the existing settings.
+	 */
+	public function add_settings_for_messenger($messenger_name, $new_settings = array())
+	{
+		$messenger = $this->get_messenger($messenger_name);
+		if ($messenger instanceof EE_messenger) {
+			$msgr_settings = $messenger->get_admin_settings_fields();
+			if (! empty($msgr_settings)) {
+				foreach ($msgr_settings as $field => $value) {
+					// is there a new setting for this?
+					if (isset($new_settings[ $field ])) {
+						$this->_active_message_types[ $messenger->name ]['settings'][ $field ] = $new_settings[ $field ];
+						continue;
+					}
+					// only set the default if it isn't already set.
+					if (! isset($this->_active_message_types[ $messenger->name ]['settings'][ $field ])) {
+						$this->_active_message_types[ $messenger->name ]['settings'][ $field ] = $value;
+					}
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * deactivate_messenger
+	 *
+	 * @param  string|EE_messenger $messenger_name name of messenger
+	 * @return void
+	 */
+	public function deactivate_messenger($messenger_name)
+	{
+		$this->_initialize_collections();
+		if ($messenger_name instanceof EE_messenger) {
+			$messenger_name = $messenger_name->name;
+		}
+		unset($this->_active_messengers[ $messenger_name ]);
+		unset($this->_active_message_types[ $messenger_name ]);
+		$this->_message_template_group_model->deactivate_message_template_groups_for($messenger_name);
+		$this->update_active_messengers_option();
+	}
+
+
+	/**
+	 * Deactivates a message type (note this will deactivate across all messenger's it is active on.
+	 *
+	 * @param  string $message_type_name     name of message type being deactivated
+	 * @param bool    $set_has_active_record By default we always record the has_active record when deactivating a message
+	 *                                       type.  However, this can be overridden if we don't want this set (usually when
+	 *                                       this is called as a part of deregistration of a custom message type)
+	 */
+	public function deactivate_message_type($message_type_name, $set_has_active_record = true)
+	{
+		$this->_initialize_collections();
+		if ($message_type_name instanceof EE_message_type) {
+			$message_type_name = $message_type_name->name;
+		}
+		foreach ($this->_active_message_types as $messenger_name => $settings) {
+			unset(
+				$this->_active_message_types[ $messenger_name ]['settings'][ $messenger_name . '-message_types' ][ $message_type_name ]
+			);
+
+			// we always record (even on deactivation) that a message type has been activated because there should at
+			// least be a record in the "has_activated" option that it WAS active at one point.
+			if ($set_has_active_record) {
+				$messenger = $this->get_messenger($messenger_name);
+				$this->_set_messenger_has_activated_message_type($messenger, $message_type_name);
+			}
+		}
+		$this->_message_template_group_model->deactivate_message_template_groups_for('', $message_type_name);
+		$this->update_active_messengers_option();
+		$this->update_has_activated_messengers_option();
+	}
+
+
+	/**
+	 * Deactivates a message type for a specific messenger as opposed to all messengers.
+	 *
+	 * @param string $message_type_name Name of message type being deactivated.
+	 * @param string $messenger_name    Name of messenger the message type is being deactivated for.
+	 */
+	public function deactivate_message_type_for_messenger($message_type_name, $messenger_name)
+	{
+		$this->_initialize_collections();
+		if ($this->is_message_type_active_for_messenger($messenger_name, $message_type_name)) {
+			unset($this->_active_message_types[ $messenger_name ]['settings'][ $messenger_name . '-message_types' ][ $message_type_name ]);
+		}
+		$this->_message_template_group_model->deactivate_message_template_groups_for(
+			array($messenger_name),
+			array($message_type_name)
+		);
+		$this->update_active_messengers_option();
+	}
+
+
+	/**
+	 * Used to verify if a message can be sent for the given messenger and message type
+	 * and that it is a generating messenger (used for generating message templates).
+	 *
+	 * @param EE_messenger    $messenger    messenger used in trigger
+	 * @param EE_message_type $message_type message type used in trigger
+	 * @return bool true is a generating messenger and can be sent OR FALSE meaning cannot send.
+	 */
+	public function is_generating_messenger_and_active(EE_messenger $messenger, EE_message_type $message_type)
+	{
+		// get the $messengers the message type says it can be used with.
+		foreach ($message_type->with_messengers() as $generating_messenger => $secondary_messengers) {
+			if (
+				$messenger->name === $generating_messenger
+				&& $this->is_message_type_active_for_messenger($messenger->name, $message_type->name)
+			) {
+				return true;
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 * This returns all the contexts that are registered by all message types.
+	 * If $slugs_only is true,
+	 * then just an array indexed by unique context slugs with the latest label representation for that slug.
+	 * array(
+	 *      'context_slug' => 'localized label for context obtained from latest message type in the loop'.
+	 * );
+	 * If $slugs_only is false, then the format is:
+	 * array(
+	 *      'message_type_name' => array(
+	 *          'context_slug' => array(
+	 *              'label' => 'localized label for context',
+	 *              'description' => 'localized description for context'
+	 *          )
+	 *      )
+	 * );
+	 * Keep in mind that although different message types may share the same context slugs,
+	 * it is possible that the context is described differently by the message type.
+	 *
+	 * @since 4.9.0
+	 * @param   bool $slugs_only Whether to return an array of just slugs and labels (true)
+	 *                           or all contexts indexed by message type.
+	 * @return array
+	 */
+	public function get_all_contexts($slugs_only = true)
+	{
+		$key = $slugs_only ? 'slugs' : 'all';
+		// check if contexts has been setup yet.
+		if (empty($this->_contexts[ $key ])) {
+			// So let's get all active message type objects and loop through to get all unique contexts
+			foreach ($this->get_active_message_type_objects() as $message_type) {
+				if ($message_type instanceof EE_message_type) {
+					$message_type_contexts = $message_type->get_contexts();
+					if ($slugs_only) {
+						foreach ($message_type_contexts as $context => $context_details) {
+							$this->_contexts[ $key ][ $context ] = $context_details['label'];
+						}
+					} else {
+						$this->_contexts[ $key ][ $message_type->name ] = $message_type_contexts;
+					}
+				}
+			}
+		}
+		return ! empty($this->_contexts[ $key ]) ? $this->_contexts[ $key ] : array();
+	}
+
+
+	/**
+	 * This checks the internal record of what message types are considered "active" and verifies that
+	 * there is an installed class definition for that message type.  If the active message type does not have a
+	 * corresponding accessible message type class then it will be deactivated from all messengers it is active on and
+	 * any related message templates will be inactivated as well.
+	 *
+	 * @return bool   true means all active message types are valid, false means at least one message type was
+	 *                deactivated.
+	 */
+	public function validate_active_message_types_are_installed()
+	{
+		$list_of_active_message_type_names = $this->list_of_active_message_types();
+		$installed_message_types           = $this->installed_message_types();
+		$all_message_types_valid           = true;
+		// loop through list of active message types and verify they are installed.
+		foreach ($list_of_active_message_type_names as $message_type_name) {
+			if (! isset($installed_message_types[ $message_type_name ])) {
+				$this->remove_message_type_has_been_activated_from_all_messengers(
+					$message_type_name,
+					true
+				);
+				$this->deactivate_message_type($message_type_name, false);
+				$all_message_types_valid = false;
+			}
+		}
+		return $all_message_types_valid;
+	}
+
+
+	/**
+	 * This method checks the `ee_has_activated_messenger` option to see if the message type has ever been
+	 * activated for the given messenger.  This can be called by client code on plugin updates etc to determine whether
+	 * to attempt automatically reactivating message types that should be activated by default or not.
+	 *
+	 * @see phpdocs on EE_Message_Resource_Manager::HAS_ACTIVATED_MESSAGE_TYPE_FOR_MESSENGER_OPTION_NAME for more details.
+	 *
+	 * @param $message_type_name
+	 * @param $messenger_name
+	 * @return bool
+	 */
+	public function has_message_type_been_activated_for_messenger($message_type_name, $messenger_name)
+	{
+		$has_activated = $this->get_has_activated_messengers_option();
+		return isset($has_activated[ $messenger_name ])
+			   && in_array($message_type_name, $has_activated[ $messenger_name ]);
+	}
+
+
+	/**
+	 * This method unsets a message type from the given messenger has activated option.
+	 *
+	 * @see phpdocs on EE_Message_Resource_Manager::HAS_ACTIVATED_MESSAGE_TYPE_FOR_MESSENGER_OPTION_NAME for more details.
+	 *
+	 * @param string $message_type_name
+	 * @param string $messenger_name
+	 * @param bool   $consider_current_state  Whether to consider whether the  message type is currently active or not.
+	 *                                        If it is currently active, then remove.  Otherwise leave it alone.
+	 */
+	public function remove_message_type_has_been_activated_for_messenger(
+		$message_type_name,
+		$messenger_name,
+		$consider_current_state = false
+	) {
+		if (
+			$consider_current_state
+			&& ! $this->is_message_type_active_for_messenger($messenger_name, $message_type_name)
+		) {
+			// when consider current state is true, this means we don't want to change anything on the "has_activated"
+			// record if the message type is currently active for this messenger.  This is used when we want to retain
+			// the record for user initiated inactivations of the message type.
+			return;
+		}
+		$has_activated = $this->get_has_activated_messengers_option();
+		$key_for_message_type = isset($has_activated[ $messenger_name ])
+			? array_search($message_type_name, $has_activated[ $messenger_name ], true)
+			: false;
+		if ($key_for_message_type !== false) {
+			unset($has_activated[ $messenger_name ][ $key_for_message_type ]);
+			$this->update_has_activated_messengers_option($has_activated);
+			// reset the internal cached property
+			$this->get_has_activated_messengers_option(true);
+		}
+	}
+
+
+	/**
+	 * Removes a message type active record from all messengers it is attached to.
+	 *
+	 * @see phpdocs on EE_Message_Resource_Manager::HAS_ACTIVATED_MESSAGE_TYPE_FOR_MESSENGER_OPTION_NAME for more details.
+	 *
+	 * @param      $message_type_name
+	 * @param bool $consider_current_state  Whether to consider whether the  message type is currently active or not.
+	 *                                      If it is currently active, then remove.  Otherwise leave it alone.
+	 */
+	public function remove_message_type_has_been_activated_from_all_messengers(
+		$message_type_name,
+		$consider_current_state = false
+	) {
+		foreach (array_keys($this->get_has_activated_messengers_option()) as $messenger_name) {
+			$this->remove_message_type_has_been_activated_for_messenger(
+				$message_type_name,
+				$messenger_name,
+				$consider_current_state
+			);
+		}
+	}
 }

Spacing +53 added lines, -53 removed lines

@@ -196,7 +196,7 @@ 
     public function get_active_messenger($messenger)
     {
         $this->_initialize_collections();
-        return ! empty($this->_active_messengers[ $messenger ]) ? $this->_active_messengers[ $messenger ] : null;
+        return ! empty($this->_active_messengers[$messenger]) ? $this->_active_messengers[$messenger] : null;
     }
 
 
@@ -209,7 +209,7 @@ 
             $this->_installed_messengers = array();
             $this->messenger_collection()->rewind();
             while ($this->messenger_collection()->valid()) {
-                $this->_installed_messengers[ $this->messenger_collection()->current()->name ] = $this->messenger_collection()->current();
+                $this->_installed_messengers[$this->messenger_collection()->current()->name] = $this->messenger_collection()->current();
                 $this->messenger_collection()->next();
             }
         }
@@ -292,7 +292,7 @@ 
     public function is_message_type_active_for_messenger($messenger_name, $message_type_name)
     {
         $this->_initialize_collections();
-        return ! empty($this->_active_message_types[ $messenger_name ]['settings'][ $messenger_name . '-message_types' ][ $message_type_name ]);
+        return ! empty($this->_active_message_types[$messenger_name]['settings'][$messenger_name.'-message_types'][$message_type_name]);
     }
 
 
@@ -305,7 +305,7 @@ 
     public function is_messenger_active($messenger_name)
     {
         $this->_initialize_collections();
-        return ! empty($this->_active_message_types[ $messenger_name ]);
+        return ! empty($this->_active_message_types[$messenger_name]);
     }
 
 
@@ -320,8 +320,8 @@ 
     {
         $settings = array();
         if ($this->is_message_type_active_for_messenger($messenger_name, $message_type_name)) {
-            $settings = isset($this->_active_message_types[ $messenger_name ]['settings'][ $messenger_name . '-message_types' ][ $message_type_name ]['settings'])
-                ? $this->_active_message_types[ $messenger_name ]['settings'][ $messenger_name . '-message_types' ][ $message_type_name ]['settings']
+            $settings = isset($this->_active_message_types[$messenger_name]['settings'][$messenger_name.'-message_types'][$message_type_name]['settings'])
+                ? $this->_active_message_types[$messenger_name]['settings'][$messenger_name.'-message_types'][$message_type_name]['settings']
                 : array();
         }
         return $settings;
@@ -339,8 +339,8 @@ 
     {
         $this->_initialize_collections();
         return
-            ! empty($this->_active_message_types[ $messenger_name ])
-            && ! empty($this->_active_message_types[ $messenger_name ]['settings'][ $messenger_name . '-message_types' ]);
+            ! empty($this->_active_message_types[$messenger_name])
+            && ! empty($this->_active_message_types[$messenger_name]['settings'][$messenger_name.'-message_types']);
     }
 
 
@@ -355,13 +355,13 @@ 
     public function get_active_message_types_for_messenger($messenger_name)
     {
         $message_types = array();
-        if (! $this->messenger_has_active_message_types($messenger_name)) {
+        if ( ! $this->messenger_has_active_message_types($messenger_name)) {
             return $message_types;
         }
         $installed_message_types = $this->installed_message_types();
         foreach ($installed_message_types as $message_type_name => $message_type) {
             if ($this->is_message_type_active_for_messenger($messenger_name, $message_type_name)) {
-                $message_types[ $message_type_name ] = $message_type;
+                $message_types[$message_type_name] = $message_type;
             }
         }
         return $message_types;
@@ -380,11 +380,11 @@ 
         $active_message_type_names = array();
         $this->_initialize_collections();
         foreach ($this->_active_message_types as $messenger => $messenger_settings) {
-            if (! isset($messenger_settings['settings'][ $messenger . '-message_types' ])) {
+            if ( ! isset($messenger_settings['settings'][$messenger.'-message_types'])) {
                 continue;
             }
-            foreach ($messenger_settings['settings'][ $messenger . '-message_types' ] as $message_type_name => $message_type_config) {
-                if (! in_array($message_type_name, $active_message_type_names)) {
+            foreach ($messenger_settings['settings'][$messenger.'-message_types'] as $message_type_name => $message_type_config) {
+                if ( ! in_array($message_type_name, $active_message_type_names)) {
                     $active_message_type_names[] = $message_type_name;
                 }
             }
@@ -405,8 +405,8 @@ 
         $installed_message_types   = $this->installed_message_types();
         $active_message_type_names = $this->list_of_active_message_types();
         foreach ($active_message_type_names as $active_message_type_name) {
-            if (isset($installed_message_types[ $active_message_type_name ])) {
-                $active_message_types[ $active_message_type_name ] = $installed_message_types[ $active_message_type_name ];
+            if (isset($installed_message_types[$active_message_type_name])) {
+                $active_message_types[$active_message_type_name] = $installed_message_types[$active_message_type_name];
             }
         }
         return $active_message_types;
@@ -421,7 +421,7 @@ 
         if (empty($this->_installed_message_types)) {
             $this->message_type_collection()->rewind();
             while ($this->message_type_collection()->valid()) {
-                $this->_installed_message_types[ $this->message_type_collection()->current()->name ] = $this->message_type_collection()->current();
+                $this->_installed_message_types[$this->message_type_collection()->current()->name] = $this->message_type_collection()->current();
                 $this->message_type_collection()->next();
             }
         }
@@ -460,7 +460,7 @@ 
     public function valid_message_type_for_messenger(EE_messenger $messenger, $message_type_name)
     {
         $valid_message_types = $messenger->get_valid_message_types();
-        if (! in_array($message_type_name, $valid_message_types)) {
+        if ( ! in_array($message_type_name, $valid_message_types)) {
             throw new EE_Error(
                 sprintf(
                     __(
@@ -586,7 +586,7 @@ 
      */
     public function ensure_messenger_is_active($messenger_name, $update_option = true)
     {
-        if (! isset($this->_active_messengers[ $messenger_name ])) {
+        if ( ! isset($this->_active_messengers[$messenger_name])) {
             try {
                 $this->activate_messenger($messenger_name, array(), $update_option);
             } catch (EE_Error $e) {
@@ -631,7 +631,7 @@ 
             $this->ensure_messenger_is_active($messenger_name, $update_option);
         }
 
-        if (! empty($not_installed)) {
+        if ( ! empty($not_installed)) {
             EE_Error::add_error(
                 sprintf(
                     __('The following messengers are either not installed or are invalid:%1$s %2$s', 'event_espresso'),
@@ -664,7 +664,7 @@ 
             // ensure messenger is active (that's an inherent coupling between active message types and the
             // messenger they are being activated for.
             try {
-                if (! $this->is_message_type_active_for_messenger($messenger_name, $message_type_name)) {
+                if ( ! $this->is_message_type_active_for_messenger($messenger_name, $message_type_name)) {
                     // all is good so let's just get it active
                     $this->activate_messenger($messenger, array($message_type_name), $update_option);
                 }
@@ -728,7 +728,7 @@ 
             : $this->messenger_collection()->get_by_info($messenger);
         // it's inactive. Activate it.
         if ($messenger instanceof EE_messenger) {
-            $this->_active_messengers[ $messenger->name ] = $messenger;
+            $this->_active_messengers[$messenger->name] = $messenger;
             // activate incoming message types set to be activated with messenger.
             $message_type_names = $this->_activate_message_types($messenger, $message_type_names);
             // setup any initial settings for the messenger if necessary.
@@ -740,7 +740,7 @@ 
             // generate new templates if necessary and ensure all related templates that are already in the database are
             // marked active.  Note, this will also deactivate a message type for a messenger if the template
             // cannot be successfully created during its attempt (only happens for global template attempts).
-            if (! empty($message_type_names)) {
+            if ( ! empty($message_type_names)) {
                 $templates = EEH_MSG_Template::generate_new_templates($messenger->name, $message_type_names, 0, true);
                 EEH_MSG_Template::update_to_active(array($messenger->name), $message_type_names);
             }
@@ -764,13 +764,13 @@ 
         // things have never been initialized (which should happen on EEH_Activation::generate_message_templates).
         // So ONLY then do we need to actually grab defaults and cycle through them.  Otherwise we
         // only override _active_message_types when an explicit array of $message_type_names has been provided.
-        $message_type_names = empty($message_type_names) && ! isset($this->_active_message_types[ $messenger->name ])
+        $message_type_names = empty($message_type_names) && ! isset($this->_active_message_types[$messenger->name])
             ? $messenger->get_default_message_types()
             : (array) $message_type_names;
 
         // now we ALWAYS need to make sure that the messenger is active for the message types we're activating!
-        if (! isset($this->_active_message_types[ $messenger->name ])) {
-            $this->_active_message_types[ $messenger->name ]['settings'] = array();
+        if ( ! isset($this->_active_message_types[$messenger->name])) {
+            $this->_active_message_types[$messenger->name]['settings'] = array();
         }
 
         if ($message_type_names) {
@@ -811,16 +811,16 @@ 
         if ($message_type instanceof EE_message_type) {
             $default_settings = $message_type->get_admin_settings_fields();
             foreach ($default_settings as $field => $values) {
-                if (isset($new_settings[ $field ])) {
-                    $existing_settings[ $field ] = $new_settings[ $field ];
+                if (isset($new_settings[$field])) {
+                    $existing_settings[$field] = $new_settings[$field];
                     continue;
                 }
-                if (! isset($existing_settings[ $field ])) {
-                    $existing_settings[ $field ] = $values['default'];
+                if ( ! isset($existing_settings[$field])) {
+                    $existing_settings[$field] = $values['default'];
                 }
             }
         }
-        $this->_active_message_types[ $messenger_name ]['settings'][ $messenger_name . '-message_types' ][ $message_type_name ]['settings'] = $existing_settings;
+        $this->_active_message_types[$messenger_name]['settings'][$messenger_name.'-message_types'][$message_type_name]['settings'] = $existing_settings;
     }
 
 
@@ -843,12 +843,12 @@ 
         }
 
         // make sure this messenger has a record in the has_activated array
-        if (! isset($this->_has_activated_messengers_and_message_types[ $messenger->name ])) {
-            $this->_has_activated_messengers_and_message_types[ $messenger->name ] = array();
+        if ( ! isset($this->_has_activated_messengers_and_message_types[$messenger->name])) {
+            $this->_has_activated_messengers_and_message_types[$messenger->name] = array();
         }
         // check if message type has already been added
-        if (! in_array($message_type_name, $this->_has_activated_messengers_and_message_types[ $messenger->name ])) {
-            $this->_has_activated_messengers_and_message_types[ $messenger->name ][] = $message_type_name;
+        if ( ! in_array($message_type_name, $this->_has_activated_messengers_and_message_types[$messenger->name])) {
+            $this->_has_activated_messengers_and_message_types[$messenger->name][] = $message_type_name;
         }
     }
 
@@ -866,16 +866,16 @@ 
         $messenger = $this->get_messenger($messenger_name);
         if ($messenger instanceof EE_messenger) {
             $msgr_settings = $messenger->get_admin_settings_fields();
-            if (! empty($msgr_settings)) {
+            if ( ! empty($msgr_settings)) {
                 foreach ($msgr_settings as $field => $value) {
                     // is there a new setting for this?
-                    if (isset($new_settings[ $field ])) {
-                        $this->_active_message_types[ $messenger->name ]['settings'][ $field ] = $new_settings[ $field ];
+                    if (isset($new_settings[$field])) {
+                        $this->_active_message_types[$messenger->name]['settings'][$field] = $new_settings[$field];
                         continue;
                     }
                     // only set the default if it isn't already set.
-                    if (! isset($this->_active_message_types[ $messenger->name ]['settings'][ $field ])) {
-                        $this->_active_message_types[ $messenger->name ]['settings'][ $field ] = $value;
+                    if ( ! isset($this->_active_message_types[$messenger->name]['settings'][$field])) {
+                        $this->_active_message_types[$messenger->name]['settings'][$field] = $value;
                     }
                 }
             }
@@ -895,8 +895,8 @@ 
         if ($messenger_name instanceof EE_messenger) {
             $messenger_name = $messenger_name->name;
         }
-        unset($this->_active_messengers[ $messenger_name ]);
-        unset($this->_active_message_types[ $messenger_name ]);
+        unset($this->_active_messengers[$messenger_name]);
+        unset($this->_active_message_types[$messenger_name]);
         $this->_message_template_group_model->deactivate_message_template_groups_for($messenger_name);
         $this->update_active_messengers_option();
     }
@@ -918,7 +918,7 @@ 
         }
         foreach ($this->_active_message_types as $messenger_name => $settings) {
             unset(
-                $this->_active_message_types[ $messenger_name ]['settings'][ $messenger_name . '-message_types' ][ $message_type_name ]
+                $this->_active_message_types[$messenger_name]['settings'][$messenger_name.'-message_types'][$message_type_name]
             );
 
             // we always record (even on deactivation) that a message type has been activated because there should at
@@ -944,7 +944,7 @@ 
     {
         $this->_initialize_collections();
         if ($this->is_message_type_active_for_messenger($messenger_name, $message_type_name)) {
-            unset($this->_active_message_types[ $messenger_name ]['settings'][ $messenger_name . '-message_types' ][ $message_type_name ]);
+            unset($this->_active_message_types[$messenger_name]['settings'][$messenger_name.'-message_types'][$message_type_name]);
         }
         $this->_message_template_group_model->deactivate_message_template_groups_for(
             array($messenger_name),
@@ -1005,22 +1005,22 @@ 
     {
         $key = $slugs_only ? 'slugs' : 'all';
         // check if contexts has been setup yet.
-        if (empty($this->_contexts[ $key ])) {
+        if (empty($this->_contexts[$key])) {
             // So let's get all active message type objects and loop through to get all unique contexts
             foreach ($this->get_active_message_type_objects() as $message_type) {
                 if ($message_type instanceof EE_message_type) {
                     $message_type_contexts = $message_type->get_contexts();
                     if ($slugs_only) {
                         foreach ($message_type_contexts as $context => $context_details) {
-                            $this->_contexts[ $key ][ $context ] = $context_details['label'];
+                            $this->_contexts[$key][$context] = $context_details['label'];
                         }
                     } else {
-                        $this->_contexts[ $key ][ $message_type->name ] = $message_type_contexts;
+                        $this->_contexts[$key][$message_type->name] = $message_type_contexts;
                     }
                 }
             }
         }
-        return ! empty($this->_contexts[ $key ]) ? $this->_contexts[ $key ] : array();
+        return ! empty($this->_contexts[$key]) ? $this->_contexts[$key] : array();
     }
 
 
@@ -1040,7 +1040,7 @@ 
         $all_message_types_valid           = true;
         // loop through list of active message types and verify they are installed.
         foreach ($list_of_active_message_type_names as $message_type_name) {
-            if (! isset($installed_message_types[ $message_type_name ])) {
+            if ( ! isset($installed_message_types[$message_type_name])) {
                 $this->remove_message_type_has_been_activated_from_all_messengers(
                     $message_type_name,
                     true
@@ -1067,8 +1067,8 @@ 
     public function has_message_type_been_activated_for_messenger($message_type_name, $messenger_name)
     {
         $has_activated = $this->get_has_activated_messengers_option();
-        return isset($has_activated[ $messenger_name ])
-               && in_array($message_type_name, $has_activated[ $messenger_name ]);
+        return isset($has_activated[$messenger_name])
+               && in_array($message_type_name, $has_activated[$messenger_name]);
     }
 
 
@@ -1097,11 +1097,11 @@ 
             return;
         }
         $has_activated = $this->get_has_activated_messengers_option();
-        $key_for_message_type = isset($has_activated[ $messenger_name ])
-            ? array_search($message_type_name, $has_activated[ $messenger_name ], true)
+        $key_for_message_type = isset($has_activated[$messenger_name])
+            ? array_search($message_type_name, $has_activated[$messenger_name], true)
             : false;
         if ($key_for_message_type !== false) {
-            unset($has_activated[ $messenger_name ][ $key_for_message_type ]);
+            unset($has_activated[$messenger_name][$key_for_message_type]);
             $this->update_has_activated_messengers_option($has_activated);
             // reset the internal cached property
             $this->get_has_activated_messengers_option(true);

core/helpers/EEH_Activation.helper.php

Indentation +1617 added lines, -1617 removed lines

@@ -15,234 +15,234 @@ 
 class EEH_Activation implements ResettableInterface
 {
 
-    /**
-     * constant used to indicate a cron task is no longer in use
-     */
-    const cron_task_no_longer_in_use = 'no_longer_in_use';
-
-    /**
-     * WP_User->ID
-     *
-     * @var int
-     */
-    private static $_default_creator_id;
-
-    /**
-     * indicates whether or not we've already verified core's default data during this request,
-     * because after migrations are done, any addons activated while in maintenance mode
-     * will want to setup their own default data, and they might hook into core's default data
-     * and trigger core to setup its default data. In which case they might all ask for core to init its default data.
-     * This prevents doing that for EVERY single addon.
-     *
-     * @var boolean
-     */
-    protected static $_initialized_db_content_already_in_this_request = false;
-
-    /**
-     * @var \EventEspresso\core\services\database\TableAnalysis $table_analysis
-     */
-    private static $table_analysis;
-
-    /**
-     * @var \EventEspresso\core\services\database\TableManager $table_manager
-     */
-    private static $table_manager;
-
-
-    /**
-     * @return \EventEspresso\core\services\database\TableAnalysis
-     */
-    public static function getTableAnalysis()
-    {
-        if (! self::$table_analysis instanceof \EventEspresso\core\services\database\TableAnalysis) {
-            self::$table_analysis = EE_Registry::instance()->create('TableAnalysis', array(), true);
-        }
-        return self::$table_analysis;
-    }
-
-
-    /**
-     * @return \EventEspresso\core\services\database\TableManager
-     */
-    public static function getTableManager()
-    {
-        if (! self::$table_manager instanceof \EventEspresso\core\services\database\TableManager) {
-            self::$table_manager = EE_Registry::instance()->create('TableManager', array(), true);
-        }
-        return self::$table_manager;
-    }
-
-
-    /**
-     *    _ensure_table_name_has_prefix
-     *
-     * @deprecated instead use TableAnalysis::ensureTableNameHasPrefix()
-     * @access     public
-     * @static
-     * @param $table_name
-     * @return string
-     */
-    public static function ensure_table_name_has_prefix($table_name)
-    {
-        return \EEH_Activation::getTableAnalysis()->ensureTableNameHasPrefix($table_name);
-    }
-
-
-    /**
-     *    system_initialization
-     *    ensures the EE configuration settings are loaded with at least default options set
-     *    and that all critical EE pages have been generated with the appropriate shortcodes in place
-     *
-     * @access public
-     * @static
-     * @return void
-     */
-    public static function system_initialization()
-    {
-        EEH_Activation::reset_and_update_config();
-        // which is fired BEFORE activation of plugin anyways
-        EEH_Activation::verify_default_pages_exist();
-    }
-
-
-    /**
-     * Sets the database schema and creates folders. This should
-     * be called on plugin activation and reactivation
-     *
-     * @return boolean success, whether the database and folders are setup properly
-     * @throws \EE_Error
-     */
-    public static function initialize_db_and_folders()
-    {
-        return EEH_Activation::create_database_tables();
-    }
-
-
-    /**
-     * assuming we have an up-to-date database schema, this will populate it
-     * with default and initial data. This should be called
-     * upon activation of a new plugin, reactivation, and at the end
-     * of running migration scripts
-     *
-     * @throws \EE_Error
-     */
-    public static function initialize_db_content()
-    {
-        // let's avoid doing all this logic repeatedly, especially when addons are requesting it
-        if (EEH_Activation::$_initialized_db_content_already_in_this_request) {
-            return;
-        }
-        EEH_Activation::$_initialized_db_content_already_in_this_request = true;
-
-        EEH_Activation::initialize_system_questions();
-        EEH_Activation::insert_default_status_codes();
-        EEH_Activation::generate_default_message_templates();
-        EEH_Activation::create_no_ticket_prices_array();
-        EEH_Activation::removeEmailConfirmFromAddressGroup();
-
-        EEH_Activation::validate_messages_system();
-        EEH_Activation::insert_default_payment_methods();
-        // in case we've
-        EEH_Activation::remove_cron_tasks();
-        EEH_Activation::create_cron_tasks();
-        // remove all TXN locks since that is being done via extra meta now
-        delete_option('ee_locked_transactions');
-        // also, check for CAF default db content
-        do_action('AHEE__EEH_Activation__initialize_db_content');
-        // also: EEM_Gateways::load_all_gateways() outputs a lot of success messages
-        // which users really won't care about on initial activation
-        EE_Error::overwrite_success();
-    }
-
-
-    /**
-     * Returns an array of cron tasks. Array values are the actions fired by the cron tasks (the "hooks"),
-     * values are the frequency (the "recurrence"). See http://codex.wordpress.org/Function_Reference/wp_schedule_event
-     * If the cron task should NO longer be used, it should have a value of EEH_Activation::cron_task_no_longer_in_use
-     * (null)
-     *
-     * @param string $which_to_include can be 'current' (ones that are currently in use),
-     *                                 'old' (only returns ones that should no longer be used),or 'all',
-     * @return array
-     * @throws \EE_Error
-     */
-    public static function get_cron_tasks($which_to_include)
-    {
-        $cron_tasks = apply_filters(
-            'FHEE__EEH_Activation__get_cron_tasks',
-            array(
-                'AHEE__EE_Cron_Tasks__clean_up_junk_transactions'      => 'hourly',
-            //              'AHEE__EE_Cron_Tasks__finalize_abandoned_transactions' => EEH_Activation::cron_task_no_longer_in_use, actually this is still in use
-                'AHEE__EE_Cron_Tasks__update_transaction_with_payment' => EEH_Activation::cron_task_no_longer_in_use,
-                // there may have been a bug which prevented from these cron tasks from getting unscheduled, so we might want to remove these for a few updates
-                'AHEE_EE_Cron_Tasks__clean_out_old_gateway_logs'       => 'daily',
-            )
-        );
-        if ($which_to_include === 'old') {
-            $cron_tasks = array_filter(
-                $cron_tasks,
-                function ($value) {
-                    return $value === EEH_Activation::cron_task_no_longer_in_use;
-                }
-            );
-        } elseif ($which_to_include === 'current') {
-            $cron_tasks = array_filter($cron_tasks);
-        } elseif (WP_DEBUG && $which_to_include !== 'all') {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'Invalid argument of "%1$s" passed to EEH_Activation::get_cron_tasks. Valid values are "all", "old" and "current".',
-                        'event_espresso'
-                    ),
-                    $which_to_include
-                )
-            );
-        }
-        return $cron_tasks;
-    }
-
-
-    /**
-     * Ensure cron tasks are setup (the removal of crons should be done by remove_crons())
-     *
-     * @throws \EE_Error
-     */
-    public static function create_cron_tasks()
-    {
-
-        foreach (EEH_Activation::get_cron_tasks('current') as $hook_name => $frequency) {
-            if (! wp_next_scheduled($hook_name)) {
-                /**
-                 * This allows client code to define the initial start timestamp for this schedule.
-                 */
-                if (
-                    is_array($frequency)
-                    && count($frequency) === 2
-                    && isset($frequency[0], $frequency[1])
-                ) {
-                    $start_timestamp = $frequency[0];
-                    $frequency = $frequency[1];
-                } else {
-                    $start_timestamp = time();
-                }
-                wp_schedule_event($start_timestamp, $frequency, $hook_name);
-            }
-        }
-    }
-
-
-    /**
-     * Remove the currently-existing and now-removed cron tasks.
-     *
-     * @param boolean $remove_all whether to only remove the old ones, or remove absolutely ALL the EE ones
-     * @throws \EE_Error
-     */
-    public static function remove_cron_tasks($remove_all = true)
-    {
-        $cron_tasks_to_remove = $remove_all ? 'all' : 'old';
-        $crons                = _get_cron_array();
-        $crons                = is_array($crons) ? $crons : array();
-        /* reminder of what $crons look like:
+	/**
+	 * constant used to indicate a cron task is no longer in use
+	 */
+	const cron_task_no_longer_in_use = 'no_longer_in_use';
+
+	/**
+	 * WP_User->ID
+	 *
+	 * @var int
+	 */
+	private static $_default_creator_id;
+
+	/**
+	 * indicates whether or not we've already verified core's default data during this request,
+	 * because after migrations are done, any addons activated while in maintenance mode
+	 * will want to setup their own default data, and they might hook into core's default data
+	 * and trigger core to setup its default data. In which case they might all ask for core to init its default data.
+	 * This prevents doing that for EVERY single addon.
+	 *
+	 * @var boolean
+	 */
+	protected static $_initialized_db_content_already_in_this_request = false;
+
+	/**
+	 * @var \EventEspresso\core\services\database\TableAnalysis $table_analysis
+	 */
+	private static $table_analysis;
+
+	/**
+	 * @var \EventEspresso\core\services\database\TableManager $table_manager
+	 */
+	private static $table_manager;
+
+
+	/**
+	 * @return \EventEspresso\core\services\database\TableAnalysis
+	 */
+	public static function getTableAnalysis()
+	{
+		if (! self::$table_analysis instanceof \EventEspresso\core\services\database\TableAnalysis) {
+			self::$table_analysis = EE_Registry::instance()->create('TableAnalysis', array(), true);
+		}
+		return self::$table_analysis;
+	}
+
+
+	/**
+	 * @return \EventEspresso\core\services\database\TableManager
+	 */
+	public static function getTableManager()
+	{
+		if (! self::$table_manager instanceof \EventEspresso\core\services\database\TableManager) {
+			self::$table_manager = EE_Registry::instance()->create('TableManager', array(), true);
+		}
+		return self::$table_manager;
+	}
+
+
+	/**
+	 *    _ensure_table_name_has_prefix
+	 *
+	 * @deprecated instead use TableAnalysis::ensureTableNameHasPrefix()
+	 * @access     public
+	 * @static
+	 * @param $table_name
+	 * @return string
+	 */
+	public static function ensure_table_name_has_prefix($table_name)
+	{
+		return \EEH_Activation::getTableAnalysis()->ensureTableNameHasPrefix($table_name);
+	}
+
+
+	/**
+	 *    system_initialization
+	 *    ensures the EE configuration settings are loaded with at least default options set
+	 *    and that all critical EE pages have been generated with the appropriate shortcodes in place
+	 *
+	 * @access public
+	 * @static
+	 * @return void
+	 */
+	public static function system_initialization()
+	{
+		EEH_Activation::reset_and_update_config();
+		// which is fired BEFORE activation of plugin anyways
+		EEH_Activation::verify_default_pages_exist();
+	}
+
+
+	/**
+	 * Sets the database schema and creates folders. This should
+	 * be called on plugin activation and reactivation
+	 *
+	 * @return boolean success, whether the database and folders are setup properly
+	 * @throws \EE_Error
+	 */
+	public static function initialize_db_and_folders()
+	{
+		return EEH_Activation::create_database_tables();
+	}
+
+
+	/**
+	 * assuming we have an up-to-date database schema, this will populate it
+	 * with default and initial data. This should be called
+	 * upon activation of a new plugin, reactivation, and at the end
+	 * of running migration scripts
+	 *
+	 * @throws \EE_Error
+	 */
+	public static function initialize_db_content()
+	{
+		// let's avoid doing all this logic repeatedly, especially when addons are requesting it
+		if (EEH_Activation::$_initialized_db_content_already_in_this_request) {
+			return;
+		}
+		EEH_Activation::$_initialized_db_content_already_in_this_request = true;
+
+		EEH_Activation::initialize_system_questions();
+		EEH_Activation::insert_default_status_codes();
+		EEH_Activation::generate_default_message_templates();
+		EEH_Activation::create_no_ticket_prices_array();
+		EEH_Activation::removeEmailConfirmFromAddressGroup();
+
+		EEH_Activation::validate_messages_system();
+		EEH_Activation::insert_default_payment_methods();
+		// in case we've
+		EEH_Activation::remove_cron_tasks();
+		EEH_Activation::create_cron_tasks();
+		// remove all TXN locks since that is being done via extra meta now
+		delete_option('ee_locked_transactions');
+		// also, check for CAF default db content
+		do_action('AHEE__EEH_Activation__initialize_db_content');
+		// also: EEM_Gateways::load_all_gateways() outputs a lot of success messages
+		// which users really won't care about on initial activation
+		EE_Error::overwrite_success();
+	}
+
+
+	/**
+	 * Returns an array of cron tasks. Array values are the actions fired by the cron tasks (the "hooks"),
+	 * values are the frequency (the "recurrence"). See http://codex.wordpress.org/Function_Reference/wp_schedule_event
+	 * If the cron task should NO longer be used, it should have a value of EEH_Activation::cron_task_no_longer_in_use
+	 * (null)
+	 *
+	 * @param string $which_to_include can be 'current' (ones that are currently in use),
+	 *                                 'old' (only returns ones that should no longer be used),or 'all',
+	 * @return array
+	 * @throws \EE_Error
+	 */
+	public static function get_cron_tasks($which_to_include)
+	{
+		$cron_tasks = apply_filters(
+			'FHEE__EEH_Activation__get_cron_tasks',
+			array(
+				'AHEE__EE_Cron_Tasks__clean_up_junk_transactions'      => 'hourly',
+			//              'AHEE__EE_Cron_Tasks__finalize_abandoned_transactions' => EEH_Activation::cron_task_no_longer_in_use, actually this is still in use
+				'AHEE__EE_Cron_Tasks__update_transaction_with_payment' => EEH_Activation::cron_task_no_longer_in_use,
+				// there may have been a bug which prevented from these cron tasks from getting unscheduled, so we might want to remove these for a few updates
+				'AHEE_EE_Cron_Tasks__clean_out_old_gateway_logs'       => 'daily',
+			)
+		);
+		if ($which_to_include === 'old') {
+			$cron_tasks = array_filter(
+				$cron_tasks,
+				function ($value) {
+					return $value === EEH_Activation::cron_task_no_longer_in_use;
+				}
+			);
+		} elseif ($which_to_include === 'current') {
+			$cron_tasks = array_filter($cron_tasks);
+		} elseif (WP_DEBUG && $which_to_include !== 'all') {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'Invalid argument of "%1$s" passed to EEH_Activation::get_cron_tasks. Valid values are "all", "old" and "current".',
+						'event_espresso'
+					),
+					$which_to_include
+				)
+			);
+		}
+		return $cron_tasks;
+	}
+
+
+	/**
+	 * Ensure cron tasks are setup (the removal of crons should be done by remove_crons())
+	 *
+	 * @throws \EE_Error
+	 */
+	public static function create_cron_tasks()
+	{
+
+		foreach (EEH_Activation::get_cron_tasks('current') as $hook_name => $frequency) {
+			if (! wp_next_scheduled($hook_name)) {
+				/**
+				 * This allows client code to define the initial start timestamp for this schedule.
+				 */
+				if (
+					is_array($frequency)
+					&& count($frequency) === 2
+					&& isset($frequency[0], $frequency[1])
+				) {
+					$start_timestamp = $frequency[0];
+					$frequency = $frequency[1];
+				} else {
+					$start_timestamp = time();
+				}
+				wp_schedule_event($start_timestamp, $frequency, $hook_name);
+			}
+		}
+	}
+
+
+	/**
+	 * Remove the currently-existing and now-removed cron tasks.
+	 *
+	 * @param boolean $remove_all whether to only remove the old ones, or remove absolutely ALL the EE ones
+	 * @throws \EE_Error
+	 */
+	public static function remove_cron_tasks($remove_all = true)
+	{
+		$cron_tasks_to_remove = $remove_all ? 'all' : 'old';
+		$crons                = _get_cron_array();
+		$crons                = is_array($crons) ? $crons : array();
+		/* reminder of what $crons look like:
          * Top-level keys are timestamps, and their values are arrays.
          * The 2nd level arrays have keys with each of the cron task hook names to run at that time
          * and their values are arrays.
@@ -259,928 +259,928 @@ 
          *                  ...
          *      ...
          */
-        $ee_cron_tasks_to_remove = EEH_Activation::get_cron_tasks($cron_tasks_to_remove);
-        foreach ($crons as $timestamp => $hooks_to_fire_at_time) {
-            if (is_array($hooks_to_fire_at_time)) {
-                foreach ($hooks_to_fire_at_time as $hook_name => $hook_actions) {
-                    if (
-                        isset($ee_cron_tasks_to_remove[ $hook_name ])
-                        && is_array($ee_cron_tasks_to_remove[ $hook_name ])
-                    ) {
-                        unset($crons[ $timestamp ][ $hook_name ]);
-                    }
-                }
-                // also take care of any empty cron timestamps.
-                if (empty($hooks_to_fire_at_time)) {
-                    unset($crons[ $timestamp ]);
-                }
-            }
-        }
-        _set_cron_array($crons);
-    }
-
-
-    /**
-     *    CPT_initialization
-     *    registers all EE CPTs ( Custom Post Types ) then flushes rewrite rules so that all endpoints exist
-     *
-     * @access public
-     * @static
-     * @return void
-     */
-    public static function CPT_initialization()
-    {
-        // register Custom Post Types
-        EE_Registry::instance()->load_core('Register_CPTs');
-        flush_rewrite_rules();
-    }
-
-
-
-    /**
-     *    reset_and_update_config
-     * The following code was moved over from EE_Config so that it will no longer run on every request.
-     * If there is old calendar config data saved, then it will get converted on activation.
-     * This was basically a DMS before we had DMS's, and will get removed after a few more versions.
-     *
-     * @access public
-     * @static
-     * @return void
-     */
-    public static function reset_and_update_config()
-    {
-        do_action('AHEE__EE_Config___load_core_config__start', array('EEH_Activation', 'load_calendar_config'));
-        add_filter(
-            'FHEE__EE_Config___load_core_config__config_settings',
-            array('EEH_Activation', 'migrate_old_config_data'),
-            10,
-            3
-        );
-        // EE_Config::reset();
-        if (! EE_Config::logging_enabled()) {
-            delete_option(EE_Config::LOG_NAME);
-        }
-    }
-
-
-    /**
-     *    load_calendar_config
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function load_calendar_config()
-    {
-        // grab array of all plugin folders and loop thru it
-        $plugins = glob(WP_PLUGIN_DIR . '/*', GLOB_ONLYDIR);
-        if (empty($plugins)) {
-            return;
-        }
-        foreach ($plugins as $plugin_path) {
-            // grab plugin folder name from path
-            $plugin = basename($plugin_path);
-            // drill down to Espresso plugins
-            // then to calendar related plugins
-            if (
-                strpos($plugin, 'espresso') !== false
-                || strpos($plugin, 'Espresso') !== false
-                || strpos($plugin, 'ee4') !== false
-                || strpos($plugin, 'EE4') !== false
-                || strpos($plugin, 'calendar') !== false
-            ) {
-                // this is what we are looking for
-                $calendar_config = $plugin_path . '/EE_Calendar_Config.php';
-                // does it exist in this folder ?
-                if (is_readable($calendar_config)) {
-                    // YEAH! let's load it
-                    require_once($calendar_config);
-                }
-            }
-        }
-    }
-
-
-
-    /**
-     *    _migrate_old_config_data
-     *
-     * @access    public
-     * @param array|stdClass $settings
-     * @param string         $config
-     * @param \EE_Config     $EE_Config
-     * @return \stdClass
-     */
-    public static function migrate_old_config_data($settings = array(), $config = '', EE_Config $EE_Config)
-    {
-        $convert_from_array = array('addons');
-        // in case old settings were saved as an array
-        if (is_array($settings) && in_array($config, $convert_from_array)) {
-            // convert existing settings to an object
-            $config_array = $settings;
-            $settings = new stdClass();
-            foreach ($config_array as $key => $value) {
-                if ($key === 'calendar' && class_exists('EE_Calendar_Config')) {
-                    $EE_Config->set_config('addons', 'EE_Calendar', 'EE_Calendar_Config', $value);
-                } else {
-                    $settings->{$key} = $value;
-                }
-            }
-            add_filter('FHEE__EE_Config___load_core_config__update_espresso_config', '__return_true');
-        }
-        return $settings;
-    }
-
-
-    /**
-     * deactivate_event_espresso
-     *
-     * @access public
-     * @static
-     * @return void
-     */
-    public static function deactivate_event_espresso()
-    {
-        // check permissions
-        if (current_user_can('activate_plugins')) {
-            deactivate_plugins(EE_PLUGIN_BASENAME, true);
-        }
-    }
-
-
-
-    /**
-     * verify_default_pages_exist
-     *
-     * @access public
-     * @static
-     * @return void
-     * @throws InvalidDataTypeException
-     */
-    public static function verify_default_pages_exist()
-    {
-        $critical_page_problem = false;
-        $critical_pages = array(
-            array(
-                'id'   => 'reg_page_id',
-                'name' => __('Registration Checkout', 'event_espresso'),
-                'post' => null,
-                'code' => 'ESPRESSO_CHECKOUT',
-            ),
-            array(
-                'id'   => 'txn_page_id',
-                'name' => __('Transactions', 'event_espresso'),
-                'post' => null,
-                'code' => 'ESPRESSO_TXN_PAGE',
-            ),
-            array(
-                'id'   => 'thank_you_page_id',
-                'name' => __('Thank You', 'event_espresso'),
-                'post' => null,
-                'code' => 'ESPRESSO_THANK_YOU',
-            ),
-            array(
-                'id'   => 'cancel_page_id',
-                'name' => __('Registration Cancelled', 'event_espresso'),
-                'post' => null,
-                'code' => 'ESPRESSO_CANCELLED',
-            ),
-        );
-        $EE_Core_Config = EE_Registry::instance()->CFG->core;
-        foreach ($critical_pages as $critical_page) {
-            // is critical page ID set in config ?
-            if ($EE_Core_Config->{$critical_page['id']} !== false) {
-                // attempt to find post by ID
-                $critical_page['post'] = get_post($EE_Core_Config->{$critical_page['id']});
-            }
-            // no dice?
-            if ($critical_page['post'] === null) {
-                // attempt to find post by title
-                $critical_page['post'] = self::get_page_by_ee_shortcode($critical_page['code']);
-                // still nothing?
-                if ($critical_page['post'] === null) {
-                    $critical_page = EEH_Activation::create_critical_page($critical_page);
-                    // REALLY? Still nothing ??!?!?
-                    if ($critical_page['post'] === null) {
-                        $msg = __(
-                            'The Event Espresso critical page configuration settings could not be updated.',
-                            'event_espresso'
-                        );
-                        EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-                        break;
-                    }
-                }
-            }
-            // check that Post ID matches critical page ID in config
-            if (
-                isset($critical_page['post']->ID)
-                && $critical_page['post']->ID !== $EE_Core_Config->{$critical_page['id']}
-            ) {
-                // update Config with post ID
-                $EE_Core_Config->{$critical_page['id']} = $critical_page['post']->ID;
-                if (! EE_Config::instance()->update_espresso_config(false, false)) {
-                    $msg = __(
-                        'The Event Espresso critical page configuration settings could not be updated.',
-                        'event_espresso'
-                    );
-                    EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-                }
-            }
-            $critical_page_problem =
-                ! isset($critical_page['post']->post_status)
-                || $critical_page['post']->post_status !== 'publish'
-                || strpos($critical_page['post']->post_content, $critical_page['code']) === false
-                    ? true
-                    : $critical_page_problem;
-        }
-        if ($critical_page_problem) {
-            new PersistentAdminNotice(
-                'critical_page_problem',
-                sprintf(
-                    esc_html__(
-                        'A potential issue has been detected with one or more of your Event Espresso pages. Go to %s to view your Event Espresso pages.',
-                        'event_espresso'
-                    ),
-                    '<a href="' . admin_url('admin.php?page=espresso_general_settings&action=critical_pages') . '">'
-                    . __('Event Espresso Critical Pages Settings', 'event_espresso')
-                    . '</a>'
-                )
-            );
-        }
-        if (EE_Error::has_notices()) {
-            EE_Error::get_notices(false, true, true);
-        }
-    }
-
-
-
-    /**
-     * Returns the first post which uses the specified shortcode
-     *
-     * @param string $ee_shortcode usually one of the critical pages shortcodes, eg
-     *                             ESPRESSO_THANK_YOU. So we will search fora post with the content
-     *                             "[ESPRESSO_THANK_YOU"
-     *                             (we don't search for the closing shortcode bracket because they might have added
-     *                             parameter to the shortcode
-     * @return WP_Post or NULl
-     */
-    public static function get_page_by_ee_shortcode($ee_shortcode)
-    {
-        global $wpdb;
-        $shortcode_and_opening_bracket = '[' . $ee_shortcode;
-        $post_id = $wpdb->get_var("SELECT ID FROM {$wpdb->posts} WHERE post_content LIKE '%$shortcode_and_opening_bracket%' LIMIT 1");
-        if ($post_id) {
-            return get_post($post_id);
-        } else {
-            return null;
-        }
-    }
-
-
-    /**
-     *    This function generates a post for critical espresso pages
-     *
-     * @access public
-     * @static
-     * @param array $critical_page
-     * @return array
-     */
-    public static function create_critical_page($critical_page)
-    {
-
-        $post_args = array(
-            'post_title'     => $critical_page['name'],
-            'post_status'    => 'publish',
-            'post_type'      => 'page',
-            'comment_status' => 'closed',
-            'post_content'   => '[' . $critical_page['code'] . ']',
-        );
-
-        $post_id = wp_insert_post($post_args);
-        if (! $post_id) {
-            $msg = sprintf(
-                __('The Event Espresso  critical page entitled "%s" could not be created.', 'event_espresso'),
-                $critical_page['name']
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return $critical_page;
-        }
-        // get newly created post's details
-        if (! $critical_page['post'] = get_post($post_id)) {
-            $msg = sprintf(
-                __('The Event Espresso critical page entitled "%s" could not be retrieved.', 'event_espresso'),
-                $critical_page['name']
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-        }
-
-        return $critical_page;
-    }
-
-
-
-
-    /**
-     * Tries to find the oldest admin for this site.  If there are no admins for this site then return NULL.
-     * The role being used to check is filterable.
-     *
-     * @since  4.6.0
-     * @global WPDB $wpdb
-     * @return mixed null|int WP_user ID or NULL
-     */
-    public static function get_default_creator_id()
-    {
-        global $wpdb;
-        if (! empty(self::$_default_creator_id)) {
-            return self::$_default_creator_id;
-        }/**/
-        $role_to_check = apply_filters('FHEE__EEH_Activation__get_default_creator_id__role_to_check', 'administrator');
-        // let's allow pre_filtering for early exits by alternative methods for getting id.  We check for truthy result and if so then exit early.
-        $pre_filtered_id = apply_filters(
-            'FHEE__EEH_Activation__get_default_creator_id__pre_filtered_id',
-            false,
-            $role_to_check
-        );
-        if ($pre_filtered_id !== false) {
-            return (int) $pre_filtered_id;
-        }
-        $capabilities_key = \EEH_Activation::getTableAnalysis()->ensureTableNameHasPrefix('capabilities');
-        $query = $wpdb->prepare(
-            "SELECT user_id FROM $wpdb->usermeta WHERE meta_key = '$capabilities_key' AND meta_value LIKE %s ORDER BY user_id ASC LIMIT 0,1",
-            '%' . $role_to_check . '%'
-        );
-        $user_id = $wpdb->get_var($query);
-        $user_id = apply_filters('FHEE__EEH_Activation_Helper__get_default_creator_id__user_id', $user_id);
-        if ($user_id && (int) $user_id) {
-            self::$_default_creator_id = (int) $user_id;
-            return self::$_default_creator_id;
-        } else {
-            return null;
-        }
-    }
-
-
-
-    /**
-     * used by EE and EE addons during plugin activation to create tables.
-     * Its a wrapper for EventEspresso\core\services\database\TableManager::createTable,
-     * but includes extra logic regarding activations.
-     *
-     * @access public
-     * @static
-     * @param string  $table_name              without the $wpdb->prefix
-     * @param string  $sql                     SQL for creating the table (contents between brackets in an SQL create
-     *                                         table query)
-     * @param string  $engine                  like 'ENGINE=MyISAM' or 'ENGINE=InnoDB'
-     * @param boolean $drop_pre_existing_table set to TRUE when you want to make SURE the table is completely empty
-     *                                         and new once this function is done (ie, you really do want to CREATE a
-     *                                         table, and expect it to be empty once you're done) leave as FALSE when
-     *                                         you just want to verify the table exists and matches this definition
-     *                                         (and if it HAS data in it you want to leave it be)
-     * @return void
-     * @throws EE_Error if there are database errors
-     */
-    public static function create_table($table_name, $sql, $engine = 'ENGINE=MyISAM ', $drop_pre_existing_table = false)
-    {
-        if (apply_filters('FHEE__EEH_Activation__create_table__short_circuit', false, $table_name, $sql)) {
-            return;
-        }
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        if (! function_exists('dbDelta')) {
-            require_once(ABSPATH . 'wp-admin/includes/upgrade.php');
-        }
-        $tableAnalysis = \EEH_Activation::getTableAnalysis();
-        $wp_table_name = $tableAnalysis->ensureTableNameHasPrefix($table_name);
-        // do we need to first delete an existing version of this table ?
-        if ($drop_pre_existing_table && $tableAnalysis->tableExists($wp_table_name)) {
-            // ok, delete the table... but ONLY if it's empty
-            $deleted_safely = EEH_Activation::delete_db_table_if_empty($wp_table_name);
-            // table is NOT empty, are you SURE you want to delete this table ???
-            if (! $deleted_safely && defined('EE_DROP_BAD_TABLES') && EE_DROP_BAD_TABLES) {
-                \EEH_Activation::getTableManager()->dropTable($wp_table_name);
-            } elseif (! $deleted_safely) {
-                // so we should be more cautious rather than just dropping tables so easily
-                error_log(
-                    sprintf(
-                        __(
-                            'It appears that database table "%1$s" exists when it shouldn\'t, and therefore may contain erroneous data. If you have previously restored your database from a backup that didn\'t remove the old tables, then we recommend: %2$s 1. create a new COMPLETE backup of your database, %2$s 2. delete ALL tables from your database, %2$s 3. restore to your previous backup. %2$s If, however, you have not restored to a backup, then somehow your "%3$s" WordPress option could not be read. You can probably ignore this message, but should investigate why that option is being removed.',
-                            'event_espresso'
-                        ),
-                        $wp_table_name,
-                        '<br/>',
-                        'espresso_db_update'
-                    )
-                );
-            }
-        }
-        $engine = str_replace('ENGINE=', '', $engine);
-        \EEH_Activation::getTableManager()->createTable($table_name, $sql, $engine);
-    }
-
-
-
-    /**
-     *    add_column_if_it_doesn't_exist
-     *    Checks if this column already exists on the specified table. Handy for addons which want to add a column
-     *
-     * @access     public
-     * @static
-     * @deprecated instead use TableManager::addColumn()
-     * @param string $table_name  (without "wp_", eg "esp_attendee"
-     * @param string $column_name
-     * @param string $column_info if your SQL were 'ALTER TABLE table_name ADD price VARCHAR(10)', this would be
-     *                            'VARCHAR(10)'
-     * @return bool|int
-     */
-    public static function add_column_if_it_doesnt_exist(
-        $table_name,
-        $column_name,
-        $column_info = 'INT UNSIGNED NOT NULL'
-    ) {
-        return \EEH_Activation::getTableManager()->addColumn($table_name, $column_name, $column_info);
-    }
-
-
-    /**
-     * get_fields_on_table
-     * Gets all the fields on the database table.
-     *
-     * @access     public
-     * @deprecated instead use TableManager::getTableColumns()
-     * @static
-     * @param string $table_name , without prefixed $wpdb->prefix
-     * @return array of database column names
-     */
-    public static function get_fields_on_table($table_name = null)
-    {
-        return \EEH_Activation::getTableManager()->getTableColumns($table_name);
-    }
-
-
-    /**
-     * db_table_is_empty
-     *
-     * @access     public\
-     * @deprecated instead use TableAnalysis::tableIsEmpty()
-     * @static
-     * @param string $table_name
-     * @return bool
-     */
-    public static function db_table_is_empty($table_name)
-    {
-        return \EEH_Activation::getTableAnalysis()->tableIsEmpty($table_name);
-    }
-
-
-    /**
-     * delete_db_table_if_empty
-     *
-     * @access public
-     * @static
-     * @param string $table_name
-     * @return bool | int
-     */
-    public static function delete_db_table_if_empty($table_name)
-    {
-        if (\EEH_Activation::getTableAnalysis()->tableIsEmpty($table_name)) {
-            return \EEH_Activation::getTableManager()->dropTable($table_name);
-        }
-        return false;
-    }
-
-
-    /**
-     * delete_unused_db_table
-     *
-     * @access     public
-     * @static
-     * @deprecated instead use TableManager::dropTable()
-     * @param string $table_name
-     * @return bool | int
-     */
-    public static function delete_unused_db_table($table_name)
-    {
-        return \EEH_Activation::getTableManager()->dropTable($table_name);
-    }
-
-
-    /**
-     * drop_index
-     *
-     * @access     public
-     * @static
-     * @deprecated instead use TableManager::dropIndex()
-     * @param string $table_name
-     * @param string $index_name
-     * @return bool | int
-     */
-    public static function drop_index($table_name, $index_name)
-    {
-        return \EEH_Activation::getTableManager()->dropIndex($table_name, $index_name);
-    }
-
-
-
-    /**
-     * create_database_tables
-     *
-     * @access public
-     * @static
-     * @throws EE_Error
-     * @return boolean success (whether database is setup properly or not)
-     */
-    public static function create_database_tables()
-    {
-        EE_Registry::instance()->load_core('Data_Migration_Manager');
-        // find the migration script that sets the database to be compatible with the code
-        $dms_name = EE_Data_Migration_Manager::instance()->get_most_up_to_date_dms();
-        if ($dms_name) {
-            $current_data_migration_script = EE_Registry::instance()->load_dms($dms_name);
-            $current_data_migration_script->set_migrating(false);
-            $current_data_migration_script->schema_changes_before_migration();
-            $current_data_migration_script->schema_changes_after_migration();
-            if ($current_data_migration_script->get_errors()) {
-                if (WP_DEBUG) {
-                    foreach ($current_data_migration_script->get_errors() as $error) {
-                        EE_Error::add_error($error, __FILE__, __FUNCTION__, __LINE__);
-                    }
-                } else {
-                    EE_Error::add_error(
-                        __(
-                            'There were errors creating the Event Espresso database tables and Event Espresso has been 
+		$ee_cron_tasks_to_remove = EEH_Activation::get_cron_tasks($cron_tasks_to_remove);
+		foreach ($crons as $timestamp => $hooks_to_fire_at_time) {
+			if (is_array($hooks_to_fire_at_time)) {
+				foreach ($hooks_to_fire_at_time as $hook_name => $hook_actions) {
+					if (
+						isset($ee_cron_tasks_to_remove[ $hook_name ])
+						&& is_array($ee_cron_tasks_to_remove[ $hook_name ])
+					) {
+						unset($crons[ $timestamp ][ $hook_name ]);
+					}
+				}
+				// also take care of any empty cron timestamps.
+				if (empty($hooks_to_fire_at_time)) {
+					unset($crons[ $timestamp ]);
+				}
+			}
+		}
+		_set_cron_array($crons);
+	}
+
+
+	/**
+	 *    CPT_initialization
+	 *    registers all EE CPTs ( Custom Post Types ) then flushes rewrite rules so that all endpoints exist
+	 *
+	 * @access public
+	 * @static
+	 * @return void
+	 */
+	public static function CPT_initialization()
+	{
+		// register Custom Post Types
+		EE_Registry::instance()->load_core('Register_CPTs');
+		flush_rewrite_rules();
+	}
+
+
+
+	/**
+	 *    reset_and_update_config
+	 * The following code was moved over from EE_Config so that it will no longer run on every request.
+	 * If there is old calendar config data saved, then it will get converted on activation.
+	 * This was basically a DMS before we had DMS's, and will get removed after a few more versions.
+	 *
+	 * @access public
+	 * @static
+	 * @return void
+	 */
+	public static function reset_and_update_config()
+	{
+		do_action('AHEE__EE_Config___load_core_config__start', array('EEH_Activation', 'load_calendar_config'));
+		add_filter(
+			'FHEE__EE_Config___load_core_config__config_settings',
+			array('EEH_Activation', 'migrate_old_config_data'),
+			10,
+			3
+		);
+		// EE_Config::reset();
+		if (! EE_Config::logging_enabled()) {
+			delete_option(EE_Config::LOG_NAME);
+		}
+	}
+
+
+	/**
+	 *    load_calendar_config
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function load_calendar_config()
+	{
+		// grab array of all plugin folders and loop thru it
+		$plugins = glob(WP_PLUGIN_DIR . '/*', GLOB_ONLYDIR);
+		if (empty($plugins)) {
+			return;
+		}
+		foreach ($plugins as $plugin_path) {
+			// grab plugin folder name from path
+			$plugin = basename($plugin_path);
+			// drill down to Espresso plugins
+			// then to calendar related plugins
+			if (
+				strpos($plugin, 'espresso') !== false
+				|| strpos($plugin, 'Espresso') !== false
+				|| strpos($plugin, 'ee4') !== false
+				|| strpos($plugin, 'EE4') !== false
+				|| strpos($plugin, 'calendar') !== false
+			) {
+				// this is what we are looking for
+				$calendar_config = $plugin_path . '/EE_Calendar_Config.php';
+				// does it exist in this folder ?
+				if (is_readable($calendar_config)) {
+					// YEAH! let's load it
+					require_once($calendar_config);
+				}
+			}
+		}
+	}
+
+
+
+	/**
+	 *    _migrate_old_config_data
+	 *
+	 * @access    public
+	 * @param array|stdClass $settings
+	 * @param string         $config
+	 * @param \EE_Config     $EE_Config
+	 * @return \stdClass
+	 */
+	public static function migrate_old_config_data($settings = array(), $config = '', EE_Config $EE_Config)
+	{
+		$convert_from_array = array('addons');
+		// in case old settings were saved as an array
+		if (is_array($settings) && in_array($config, $convert_from_array)) {
+			// convert existing settings to an object
+			$config_array = $settings;
+			$settings = new stdClass();
+			foreach ($config_array as $key => $value) {
+				if ($key === 'calendar' && class_exists('EE_Calendar_Config')) {
+					$EE_Config->set_config('addons', 'EE_Calendar', 'EE_Calendar_Config', $value);
+				} else {
+					$settings->{$key} = $value;
+				}
+			}
+			add_filter('FHEE__EE_Config___load_core_config__update_espresso_config', '__return_true');
+		}
+		return $settings;
+	}
+
+
+	/**
+	 * deactivate_event_espresso
+	 *
+	 * @access public
+	 * @static
+	 * @return void
+	 */
+	public static function deactivate_event_espresso()
+	{
+		// check permissions
+		if (current_user_can('activate_plugins')) {
+			deactivate_plugins(EE_PLUGIN_BASENAME, true);
+		}
+	}
+
+
+
+	/**
+	 * verify_default_pages_exist
+	 *
+	 * @access public
+	 * @static
+	 * @return void
+	 * @throws InvalidDataTypeException
+	 */
+	public static function verify_default_pages_exist()
+	{
+		$critical_page_problem = false;
+		$critical_pages = array(
+			array(
+				'id'   => 'reg_page_id',
+				'name' => __('Registration Checkout', 'event_espresso'),
+				'post' => null,
+				'code' => 'ESPRESSO_CHECKOUT',
+			),
+			array(
+				'id'   => 'txn_page_id',
+				'name' => __('Transactions', 'event_espresso'),
+				'post' => null,
+				'code' => 'ESPRESSO_TXN_PAGE',
+			),
+			array(
+				'id'   => 'thank_you_page_id',
+				'name' => __('Thank You', 'event_espresso'),
+				'post' => null,
+				'code' => 'ESPRESSO_THANK_YOU',
+			),
+			array(
+				'id'   => 'cancel_page_id',
+				'name' => __('Registration Cancelled', 'event_espresso'),
+				'post' => null,
+				'code' => 'ESPRESSO_CANCELLED',
+			),
+		);
+		$EE_Core_Config = EE_Registry::instance()->CFG->core;
+		foreach ($critical_pages as $critical_page) {
+			// is critical page ID set in config ?
+			if ($EE_Core_Config->{$critical_page['id']} !== false) {
+				// attempt to find post by ID
+				$critical_page['post'] = get_post($EE_Core_Config->{$critical_page['id']});
+			}
+			// no dice?
+			if ($critical_page['post'] === null) {
+				// attempt to find post by title
+				$critical_page['post'] = self::get_page_by_ee_shortcode($critical_page['code']);
+				// still nothing?
+				if ($critical_page['post'] === null) {
+					$critical_page = EEH_Activation::create_critical_page($critical_page);
+					// REALLY? Still nothing ??!?!?
+					if ($critical_page['post'] === null) {
+						$msg = __(
+							'The Event Espresso critical page configuration settings could not be updated.',
+							'event_espresso'
+						);
+						EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+						break;
+					}
+				}
+			}
+			// check that Post ID matches critical page ID in config
+			if (
+				isset($critical_page['post']->ID)
+				&& $critical_page['post']->ID !== $EE_Core_Config->{$critical_page['id']}
+			) {
+				// update Config with post ID
+				$EE_Core_Config->{$critical_page['id']} = $critical_page['post']->ID;
+				if (! EE_Config::instance()->update_espresso_config(false, false)) {
+					$msg = __(
+						'The Event Espresso critical page configuration settings could not be updated.',
+						'event_espresso'
+					);
+					EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+				}
+			}
+			$critical_page_problem =
+				! isset($critical_page['post']->post_status)
+				|| $critical_page['post']->post_status !== 'publish'
+				|| strpos($critical_page['post']->post_content, $critical_page['code']) === false
+					? true
+					: $critical_page_problem;
+		}
+		if ($critical_page_problem) {
+			new PersistentAdminNotice(
+				'critical_page_problem',
+				sprintf(
+					esc_html__(
+						'A potential issue has been detected with one or more of your Event Espresso pages. Go to %s to view your Event Espresso pages.',
+						'event_espresso'
+					),
+					'<a href="' . admin_url('admin.php?page=espresso_general_settings&action=critical_pages') . '">'
+					. __('Event Espresso Critical Pages Settings', 'event_espresso')
+					. '</a>'
+				)
+			);
+		}
+		if (EE_Error::has_notices()) {
+			EE_Error::get_notices(false, true, true);
+		}
+	}
+
+
+
+	/**
+	 * Returns the first post which uses the specified shortcode
+	 *
+	 * @param string $ee_shortcode usually one of the critical pages shortcodes, eg
+	 *                             ESPRESSO_THANK_YOU. So we will search fora post with the content
+	 *                             "[ESPRESSO_THANK_YOU"
+	 *                             (we don't search for the closing shortcode bracket because they might have added
+	 *                             parameter to the shortcode
+	 * @return WP_Post or NULl
+	 */
+	public static function get_page_by_ee_shortcode($ee_shortcode)
+	{
+		global $wpdb;
+		$shortcode_and_opening_bracket = '[' . $ee_shortcode;
+		$post_id = $wpdb->get_var("SELECT ID FROM {$wpdb->posts} WHERE post_content LIKE '%$shortcode_and_opening_bracket%' LIMIT 1");
+		if ($post_id) {
+			return get_post($post_id);
+		} else {
+			return null;
+		}
+	}
+
+
+	/**
+	 *    This function generates a post for critical espresso pages
+	 *
+	 * @access public
+	 * @static
+	 * @param array $critical_page
+	 * @return array
+	 */
+	public static function create_critical_page($critical_page)
+	{
+
+		$post_args = array(
+			'post_title'     => $critical_page['name'],
+			'post_status'    => 'publish',
+			'post_type'      => 'page',
+			'comment_status' => 'closed',
+			'post_content'   => '[' . $critical_page['code'] . ']',
+		);
+
+		$post_id = wp_insert_post($post_args);
+		if (! $post_id) {
+			$msg = sprintf(
+				__('The Event Espresso  critical page entitled "%s" could not be created.', 'event_espresso'),
+				$critical_page['name']
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return $critical_page;
+		}
+		// get newly created post's details
+		if (! $critical_page['post'] = get_post($post_id)) {
+			$msg = sprintf(
+				__('The Event Espresso critical page entitled "%s" could not be retrieved.', 'event_espresso'),
+				$critical_page['name']
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+		}
+
+		return $critical_page;
+	}
+
+
+
+
+	/**
+	 * Tries to find the oldest admin for this site.  If there are no admins for this site then return NULL.
+	 * The role being used to check is filterable.
+	 *
+	 * @since  4.6.0
+	 * @global WPDB $wpdb
+	 * @return mixed null|int WP_user ID or NULL
+	 */
+	public static function get_default_creator_id()
+	{
+		global $wpdb;
+		if (! empty(self::$_default_creator_id)) {
+			return self::$_default_creator_id;
+		}/**/
+		$role_to_check = apply_filters('FHEE__EEH_Activation__get_default_creator_id__role_to_check', 'administrator');
+		// let's allow pre_filtering for early exits by alternative methods for getting id.  We check for truthy result and if so then exit early.
+		$pre_filtered_id = apply_filters(
+			'FHEE__EEH_Activation__get_default_creator_id__pre_filtered_id',
+			false,
+			$role_to_check
+		);
+		if ($pre_filtered_id !== false) {
+			return (int) $pre_filtered_id;
+		}
+		$capabilities_key = \EEH_Activation::getTableAnalysis()->ensureTableNameHasPrefix('capabilities');
+		$query = $wpdb->prepare(
+			"SELECT user_id FROM $wpdb->usermeta WHERE meta_key = '$capabilities_key' AND meta_value LIKE %s ORDER BY user_id ASC LIMIT 0,1",
+			'%' . $role_to_check . '%'
+		);
+		$user_id = $wpdb->get_var($query);
+		$user_id = apply_filters('FHEE__EEH_Activation_Helper__get_default_creator_id__user_id', $user_id);
+		if ($user_id && (int) $user_id) {
+			self::$_default_creator_id = (int) $user_id;
+			return self::$_default_creator_id;
+		} else {
+			return null;
+		}
+	}
+
+
+
+	/**
+	 * used by EE and EE addons during plugin activation to create tables.
+	 * Its a wrapper for EventEspresso\core\services\database\TableManager::createTable,
+	 * but includes extra logic regarding activations.
+	 *
+	 * @access public
+	 * @static
+	 * @param string  $table_name              without the $wpdb->prefix
+	 * @param string  $sql                     SQL for creating the table (contents between brackets in an SQL create
+	 *                                         table query)
+	 * @param string  $engine                  like 'ENGINE=MyISAM' or 'ENGINE=InnoDB'
+	 * @param boolean $drop_pre_existing_table set to TRUE when you want to make SURE the table is completely empty
+	 *                                         and new once this function is done (ie, you really do want to CREATE a
+	 *                                         table, and expect it to be empty once you're done) leave as FALSE when
+	 *                                         you just want to verify the table exists and matches this definition
+	 *                                         (and if it HAS data in it you want to leave it be)
+	 * @return void
+	 * @throws EE_Error if there are database errors
+	 */
+	public static function create_table($table_name, $sql, $engine = 'ENGINE=MyISAM ', $drop_pre_existing_table = false)
+	{
+		if (apply_filters('FHEE__EEH_Activation__create_table__short_circuit', false, $table_name, $sql)) {
+			return;
+		}
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		if (! function_exists('dbDelta')) {
+			require_once(ABSPATH . 'wp-admin/includes/upgrade.php');
+		}
+		$tableAnalysis = \EEH_Activation::getTableAnalysis();
+		$wp_table_name = $tableAnalysis->ensureTableNameHasPrefix($table_name);
+		// do we need to first delete an existing version of this table ?
+		if ($drop_pre_existing_table && $tableAnalysis->tableExists($wp_table_name)) {
+			// ok, delete the table... but ONLY if it's empty
+			$deleted_safely = EEH_Activation::delete_db_table_if_empty($wp_table_name);
+			// table is NOT empty, are you SURE you want to delete this table ???
+			if (! $deleted_safely && defined('EE_DROP_BAD_TABLES') && EE_DROP_BAD_TABLES) {
+				\EEH_Activation::getTableManager()->dropTable($wp_table_name);
+			} elseif (! $deleted_safely) {
+				// so we should be more cautious rather than just dropping tables so easily
+				error_log(
+					sprintf(
+						__(
+							'It appears that database table "%1$s" exists when it shouldn\'t, and therefore may contain erroneous data. If you have previously restored your database from a backup that didn\'t remove the old tables, then we recommend: %2$s 1. create a new COMPLETE backup of your database, %2$s 2. delete ALL tables from your database, %2$s 3. restore to your previous backup. %2$s If, however, you have not restored to a backup, then somehow your "%3$s" WordPress option could not be read. You can probably ignore this message, but should investigate why that option is being removed.',
+							'event_espresso'
+						),
+						$wp_table_name,
+						'<br/>',
+						'espresso_db_update'
+					)
+				);
+			}
+		}
+		$engine = str_replace('ENGINE=', '', $engine);
+		\EEH_Activation::getTableManager()->createTable($table_name, $sql, $engine);
+	}
+
+
+
+	/**
+	 *    add_column_if_it_doesn't_exist
+	 *    Checks if this column already exists on the specified table. Handy for addons which want to add a column
+	 *
+	 * @access     public
+	 * @static
+	 * @deprecated instead use TableManager::addColumn()
+	 * @param string $table_name  (without "wp_", eg "esp_attendee"
+	 * @param string $column_name
+	 * @param string $column_info if your SQL were 'ALTER TABLE table_name ADD price VARCHAR(10)', this would be
+	 *                            'VARCHAR(10)'
+	 * @return bool|int
+	 */
+	public static function add_column_if_it_doesnt_exist(
+		$table_name,
+		$column_name,
+		$column_info = 'INT UNSIGNED NOT NULL'
+	) {
+		return \EEH_Activation::getTableManager()->addColumn($table_name, $column_name, $column_info);
+	}
+
+
+	/**
+	 * get_fields_on_table
+	 * Gets all the fields on the database table.
+	 *
+	 * @access     public
+	 * @deprecated instead use TableManager::getTableColumns()
+	 * @static
+	 * @param string $table_name , without prefixed $wpdb->prefix
+	 * @return array of database column names
+	 */
+	public static function get_fields_on_table($table_name = null)
+	{
+		return \EEH_Activation::getTableManager()->getTableColumns($table_name);
+	}
+
+
+	/**
+	 * db_table_is_empty
+	 *
+	 * @access     public\
+	 * @deprecated instead use TableAnalysis::tableIsEmpty()
+	 * @static
+	 * @param string $table_name
+	 * @return bool
+	 */
+	public static function db_table_is_empty($table_name)
+	{
+		return \EEH_Activation::getTableAnalysis()->tableIsEmpty($table_name);
+	}
+
+
+	/**
+	 * delete_db_table_if_empty
+	 *
+	 * @access public
+	 * @static
+	 * @param string $table_name
+	 * @return bool | int
+	 */
+	public static function delete_db_table_if_empty($table_name)
+	{
+		if (\EEH_Activation::getTableAnalysis()->tableIsEmpty($table_name)) {
+			return \EEH_Activation::getTableManager()->dropTable($table_name);
+		}
+		return false;
+	}
+
+
+	/**
+	 * delete_unused_db_table
+	 *
+	 * @access     public
+	 * @static
+	 * @deprecated instead use TableManager::dropTable()
+	 * @param string $table_name
+	 * @return bool | int
+	 */
+	public static function delete_unused_db_table($table_name)
+	{
+		return \EEH_Activation::getTableManager()->dropTable($table_name);
+	}
+
+
+	/**
+	 * drop_index
+	 *
+	 * @access     public
+	 * @static
+	 * @deprecated instead use TableManager::dropIndex()
+	 * @param string $table_name
+	 * @param string $index_name
+	 * @return bool | int
+	 */
+	public static function drop_index($table_name, $index_name)
+	{
+		return \EEH_Activation::getTableManager()->dropIndex($table_name, $index_name);
+	}
+
+
+
+	/**
+	 * create_database_tables
+	 *
+	 * @access public
+	 * @static
+	 * @throws EE_Error
+	 * @return boolean success (whether database is setup properly or not)
+	 */
+	public static function create_database_tables()
+	{
+		EE_Registry::instance()->load_core('Data_Migration_Manager');
+		// find the migration script that sets the database to be compatible with the code
+		$dms_name = EE_Data_Migration_Manager::instance()->get_most_up_to_date_dms();
+		if ($dms_name) {
+			$current_data_migration_script = EE_Registry::instance()->load_dms($dms_name);
+			$current_data_migration_script->set_migrating(false);
+			$current_data_migration_script->schema_changes_before_migration();
+			$current_data_migration_script->schema_changes_after_migration();
+			if ($current_data_migration_script->get_errors()) {
+				if (WP_DEBUG) {
+					foreach ($current_data_migration_script->get_errors() as $error) {
+						EE_Error::add_error($error, __FILE__, __FUNCTION__, __LINE__);
+					}
+				} else {
+					EE_Error::add_error(
+						__(
+							'There were errors creating the Event Espresso database tables and Event Espresso has been 
                             deactivated. To view the errors, please enable WP_DEBUG in your wp-config.php file.',
-                            'event_espresso'
-                        )
-                    );
-                }
-                return false;
-            }
-            EE_Data_Migration_Manager::instance()->update_current_database_state_to();
-        } else {
-            EE_Error::add_error(
-                __(
-                    'Could not determine most up-to-date data migration script from which to pull database schema
+							'event_espresso'
+						)
+					);
+				}
+				return false;
+			}
+			EE_Data_Migration_Manager::instance()->update_current_database_state_to();
+		} else {
+			EE_Error::add_error(
+				__(
+					'Could not determine most up-to-date data migration script from which to pull database schema
                      structure. So database is probably not setup properly',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        return true;
-    }
-
-
-
-    /**
-     * initialize_system_questions
-     *
-     * @access public
-     * @static
-     * @return void
-     */
-    public static function initialize_system_questions()
-    {
-        // QUESTION GROUPS
-        global $wpdb;
-        $table_name = \EEH_Activation::getTableAnalysis()->ensureTableNameHasPrefix('esp_question_group');
-        $SQL = "SELECT QSG_system FROM $table_name WHERE QSG_system != 0";
-        // what we have
-        $question_groups = $wpdb->get_col($SQL);
-        // check the response
-        $question_groups = is_array($question_groups) ? $question_groups : array();
-        // what we should have
-        $QSG_systems = array(1, 2);
-        // loop thru what we should have and compare to what we have
-        foreach ($QSG_systems as $QSG_system) {
-            // reset values array
-            $QSG_values = array();
-            // if we don't have what we should have (but use $QST_system as as string because that's what we got from the db)
-            if (! in_array("$QSG_system", $question_groups)) {
-                // add it
-                switch ($QSG_system) {
-                    case 1:
-                        $QSG_values = array(
-                            'QSG_name'            => __('Personal Information', 'event_espresso'),
-                            'QSG_identifier'      => 'personal-information-' . time(),
-                            'QSG_desc'            => '',
-                            'QSG_order'           => 1,
-                            'QSG_show_group_name' => 1,
-                            'QSG_show_group_desc' => 1,
-                            'QSG_system'          => EEM_Question_Group::system_personal,
-                            'QSG_deleted'         => 0,
-                        );
-                        break;
-                    case 2:
-                        $QSG_values = array(
-                            'QSG_name'            => __('Address Information', 'event_espresso'),
-                            'QSG_identifier'      => 'address-information-' . time(),
-                            'QSG_desc'            => '',
-                            'QSG_order'           => 2,
-                            'QSG_show_group_name' => 1,
-                            'QSG_show_group_desc' => 1,
-                            'QSG_system'          => EEM_Question_Group::system_address,
-                            'QSG_deleted'         => 0,
-                        );
-                        break;
-                }
-                // make sure we have some values before inserting them
-                if (! empty($QSG_values)) {
-                    // insert system question
-                    $wpdb->insert(
-                        $table_name,
-                        $QSG_values,
-                        array('%s', '%s', '%s', '%d', '%d', '%d', '%d', '%d')
-                    );
-                    $QSG_IDs[ $QSG_system ] = $wpdb->insert_id;
-                }
-            }
-        }
-        // QUESTIONS
-        global $wpdb;
-        $table_name = \EEH_Activation::getTableAnalysis()->ensureTableNameHasPrefix('esp_question');
-        $SQL = "SELECT QST_system FROM $table_name WHERE QST_system != ''";
-        // what we have
-        $questions = $wpdb->get_col($SQL);
-        // all system questions
-        $personal_system_group_questions = ['fname', 'lname', 'email'];
-        $address_system_group_questions = ['address', 'address2', 'city', 'country', 'state', 'zip', 'phone'];
-        $system_questions_not_in_group = ['email_confirm'];
-        // merge all of the system questions we should have
-        $QST_systems = array_merge(
-            $personal_system_group_questions,
-            $address_system_group_questions,
-            $system_questions_not_in_group
-        );
-        $order_for_group_1 = 1;
-        $order_for_group_2 = 1;
-        // loop thru what we should have and compare to what we have
-        foreach ($QST_systems as $QST_system) {
-            // reset values array
-            $QST_values = array();
-            // if we don't have what we should have
-            if (! in_array($QST_system, $questions)) {
-                // add it
-                switch ($QST_system) {
-                    case 'fname':
-                        $QST_values = array(
-                            'QST_display_text'  => __('First Name', 'event_espresso'),
-                            'QST_admin_label'   => __('First Name - System Question', 'event_espresso'),
-                            'QST_system'        => 'fname',
-                            'QST_type'          => 'TEXT',
-                            'QST_required'      => 1,
-                            'QST_required_text' => __('This field is required', 'event_espresso'),
-                            'QST_order'         => 1,
-                            'QST_admin_only'    => 0,
-                            'QST_max'           => EEM_Question::instance()->absolute_max_for_system_question($QST_system),
-                            'QST_wp_user'       => self::get_default_creator_id(),
-                            'QST_deleted'       => 0,
-                        );
-                        break;
-                    case 'lname':
-                        $QST_values = array(
-                            'QST_display_text'  => __('Last Name', 'event_espresso'),
-                            'QST_admin_label'   => __('Last Name - System Question', 'event_espresso'),
-                            'QST_system'        => 'lname',
-                            'QST_type'          => 'TEXT',
-                            'QST_required'      => 1,
-                            'QST_required_text' => __('This field is required', 'event_espresso'),
-                            'QST_order'         => 2,
-                            'QST_admin_only'    => 0,
-                            'QST_max'           => EEM_Question::instance()->absolute_max_for_system_question($QST_system),
-                            'QST_wp_user'       => self::get_default_creator_id(),
-                            'QST_deleted'       => 0,
-                        );
-                        break;
-                    case 'email':
-                        $QST_values = array(
-                            'QST_display_text'  => __('Email Address', 'event_espresso'),
-                            'QST_admin_label'   => __('Email Address - System Question', 'event_espresso'),
-                            'QST_system'        => 'email',
-                            'QST_type'          => 'EMAIL',
-                            'QST_required'      => 1,
-                            'QST_required_text' => __('This field is required', 'event_espresso'),
-                            'QST_order'         => 3,
-                            'QST_admin_only'    => 0,
-                            'QST_max'           => EEM_Question::instance()->absolute_max_for_system_question($QST_system),
-                            'QST_wp_user'       => self::get_default_creator_id(),
-                            'QST_deleted'       => 0,
-                        );
-                        break;
-                    case 'email_confirm':
-                        $QST_values = array(
-                            'QST_display_text'  => __('Confirm Email Address', 'event_espresso'),
-                            'QST_admin_label'   => __('Confirm Email Address - System Question', 'event_espresso'),
-                            'QST_system'        => 'email_confirm',
-                            'QST_type'          => 'EMAIL_CONFIRM',
-                            'QST_required'      => 1,
-                            'QST_required_text' => __('This field is required', 'event_espresso'),
-                            'QST_order'         => 4,
-                            'QST_admin_only'    => 0,
-                            'QST_max'           => EEM_Question::instance()->absolute_max_for_system_question($QST_system),
-                            'QST_wp_user'       => self::get_default_creator_id(),
-                            'QST_deleted'       => 0,
-                        );
-                        break;
-                    case 'address':
-                        $QST_values = array(
-                            'QST_display_text'  => __('Address', 'event_espresso'),
-                            'QST_admin_label'   => __('Address - System Question', 'event_espresso'),
-                            'QST_system'        => 'address',
-                            'QST_type'          => 'TEXT',
-                            'QST_required'      => 0,
-                            'QST_required_text' => __('This field is required', 'event_espresso'),
-                            'QST_order'         => 5,
-                            'QST_admin_only'    => 0,
-                            'QST_max'           => EEM_Question::instance()->absolute_max_for_system_question($QST_system),
-                            'QST_wp_user'       => self::get_default_creator_id(),
-                            'QST_deleted'       => 0,
-                        );
-                        break;
-                    case 'address2':
-                        $QST_values = array(
-                            'QST_display_text'  => __('Address2', 'event_espresso'),
-                            'QST_admin_label'   => __('Address2 - System Question', 'event_espresso'),
-                            'QST_system'        => 'address2',
-                            'QST_type'          => 'TEXT',
-                            'QST_required'      => 0,
-                            'QST_required_text' => __('This field is required', 'event_espresso'),
-                            'QST_order'         => 6,
-                            'QST_admin_only'    => 0,
-                            'QST_max'           => EEM_Question::instance()->absolute_max_for_system_question($QST_system),
-                            'QST_wp_user'       => self::get_default_creator_id(),
-                            'QST_deleted'       => 0,
-                        );
-                        break;
-                    case 'city':
-                        $QST_values = array(
-                            'QST_display_text'  => __('City', 'event_espresso'),
-                            'QST_admin_label'   => __('City - System Question', 'event_espresso'),
-                            'QST_system'        => 'city',
-                            'QST_type'          => 'TEXT',
-                            'QST_required'      => 0,
-                            'QST_required_text' => __('This field is required', 'event_espresso'),
-                            'QST_order'         => 7,
-                            'QST_admin_only'    => 0,
-                            'QST_max'           => EEM_Question::instance()->absolute_max_for_system_question($QST_system),
-                            'QST_wp_user'       => self::get_default_creator_id(),
-                            'QST_deleted'       => 0,
-                        );
-                        break;
-                    case 'country':
-                        $QST_values = array(
-                            'QST_display_text'  => __('Country', 'event_espresso'),
-                            'QST_admin_label'   => __('Country - System Question', 'event_espresso'),
-                            'QST_system'        => 'country',
-                            'QST_type'          => 'COUNTRY',
-                            'QST_required'      => 0,
-                            'QST_required_text' => __('This field is required', 'event_espresso'),
-                            'QST_order'         => 8,
-                            'QST_admin_only'    => 0,
-                            'QST_wp_user'       => self::get_default_creator_id(),
-                            'QST_deleted'       => 0,
-                        );
-                        break;
-                    case 'state':
-                        $QST_values = array(
-                            'QST_display_text'  => __('State/Province', 'event_espresso'),
-                            'QST_admin_label'   => __('State/Province - System Question', 'event_espresso'),
-                            'QST_system'        => 'state',
-                            'QST_type'          => 'STATE',
-                            'QST_required'      => 0,
-                            'QST_required_text' => __('This field is required', 'event_espresso'),
-                            'QST_order'         => 9,
-                            'QST_admin_only'    => 0,
-                            'QST_wp_user'       => self::get_default_creator_id(),
-                            'QST_deleted'       => 0,
-                        );
-                        break;
-                    case 'zip':
-                        $QST_values = array(
-                            'QST_display_text'  => __('Zip/Postal Code', 'event_espresso'),
-                            'QST_admin_label'   => __('Zip/Postal Code - System Question', 'event_espresso'),
-                            'QST_system'        => 'zip',
-                            'QST_type'          => 'TEXT',
-                            'QST_required'      => 0,
-                            'QST_required_text' => __('This field is required', 'event_espresso'),
-                            'QST_order'         => 10,
-                            'QST_admin_only'    => 0,
-                            'QST_max'           => EEM_Question::instance()->absolute_max_for_system_question($QST_system),
-                            'QST_wp_user'       => self::get_default_creator_id(),
-                            'QST_deleted'       => 0,
-                        );
-                        break;
-                    case 'phone':
-                        $QST_values = array(
-                            'QST_display_text'  => __('Phone Number', 'event_espresso'),
-                            'QST_admin_label'   => __('Phone Number - System Question', 'event_espresso'),
-                            'QST_system'        => 'phone',
-                            'QST_type'          => 'TEXT',
-                            'QST_required'      => 0,
-                            'QST_required_text' => __('This field is required', 'event_espresso'),
-                            'QST_order'         => 11,
-                            'QST_admin_only'    => 0,
-                            'QST_max'           => EEM_Question::instance()->absolute_max_for_system_question($QST_system),
-                            'QST_wp_user'       => self::get_default_creator_id(),
-                            'QST_deleted'       => 0,
-                        );
-                        break;
-                }
-                if (! empty($QST_values)) {
-                    // insert system question
-                    $wpdb->insert(
-                        $table_name,
-                        $QST_values,
-                        array('%s', '%s', '%s', '%s', '%d', '%s', '%d', '%d', '%d', '%d')
-                    );
-                    $QST_ID = $wpdb->insert_id;
-
-                    // QUESTION GROUP QUESTIONS
-                    if (in_array($QST_system, $personal_system_group_questions)) {
-                        $system_question_we_want = EEM_Question_Group::system_personal;
-                    } elseif (in_array($QST_system, $address_system_group_questions)) {
-                        $system_question_we_want = EEM_Question_Group::system_address;
-                    } else {
-                        // QST_system should not be assigned to any group
-                        continue;
-                    }
-                    if (isset($QSG_IDs[ $system_question_we_want ])) {
-                        $QSG_ID = $QSG_IDs[ $system_question_we_want ];
-                    } else {
-                        $id_col = EEM_Question_Group::instance()
-                                                    ->get_col(array(array('QSG_system' => $system_question_we_want)));
-                        if (is_array($id_col)) {
-                            $QSG_ID = reset($id_col);
-                        } else {
-                            // ok so we didn't find it in the db either?? that's weird because we should have inserted it at the start of this method
-                            EE_Log::instance()->log(
-                                __FILE__,
-                                __FUNCTION__,
-                                sprintf(
-                                    __(
-                                        'Could not associate question %1$s to a question group because no system question
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		return true;
+	}
+
+
+
+	/**
+	 * initialize_system_questions
+	 *
+	 * @access public
+	 * @static
+	 * @return void
+	 */
+	public static function initialize_system_questions()
+	{
+		// QUESTION GROUPS
+		global $wpdb;
+		$table_name = \EEH_Activation::getTableAnalysis()->ensureTableNameHasPrefix('esp_question_group');
+		$SQL = "SELECT QSG_system FROM $table_name WHERE QSG_system != 0";
+		// what we have
+		$question_groups = $wpdb->get_col($SQL);
+		// check the response
+		$question_groups = is_array($question_groups) ? $question_groups : array();
+		// what we should have
+		$QSG_systems = array(1, 2);
+		// loop thru what we should have and compare to what we have
+		foreach ($QSG_systems as $QSG_system) {
+			// reset values array
+			$QSG_values = array();
+			// if we don't have what we should have (but use $QST_system as as string because that's what we got from the db)
+			if (! in_array("$QSG_system", $question_groups)) {
+				// add it
+				switch ($QSG_system) {
+					case 1:
+						$QSG_values = array(
+							'QSG_name'            => __('Personal Information', 'event_espresso'),
+							'QSG_identifier'      => 'personal-information-' . time(),
+							'QSG_desc'            => '',
+							'QSG_order'           => 1,
+							'QSG_show_group_name' => 1,
+							'QSG_show_group_desc' => 1,
+							'QSG_system'          => EEM_Question_Group::system_personal,
+							'QSG_deleted'         => 0,
+						);
+						break;
+					case 2:
+						$QSG_values = array(
+							'QSG_name'            => __('Address Information', 'event_espresso'),
+							'QSG_identifier'      => 'address-information-' . time(),
+							'QSG_desc'            => '',
+							'QSG_order'           => 2,
+							'QSG_show_group_name' => 1,
+							'QSG_show_group_desc' => 1,
+							'QSG_system'          => EEM_Question_Group::system_address,
+							'QSG_deleted'         => 0,
+						);
+						break;
+				}
+				// make sure we have some values before inserting them
+				if (! empty($QSG_values)) {
+					// insert system question
+					$wpdb->insert(
+						$table_name,
+						$QSG_values,
+						array('%s', '%s', '%s', '%d', '%d', '%d', '%d', '%d')
+					);
+					$QSG_IDs[ $QSG_system ] = $wpdb->insert_id;
+				}
+			}
+		}
+		// QUESTIONS
+		global $wpdb;
+		$table_name = \EEH_Activation::getTableAnalysis()->ensureTableNameHasPrefix('esp_question');
+		$SQL = "SELECT QST_system FROM $table_name WHERE QST_system != ''";
+		// what we have
+		$questions = $wpdb->get_col($SQL);
+		// all system questions
+		$personal_system_group_questions = ['fname', 'lname', 'email'];
+		$address_system_group_questions = ['address', 'address2', 'city', 'country', 'state', 'zip', 'phone'];
+		$system_questions_not_in_group = ['email_confirm'];
+		// merge all of the system questions we should have
+		$QST_systems = array_merge(
+			$personal_system_group_questions,
+			$address_system_group_questions,
+			$system_questions_not_in_group
+		);
+		$order_for_group_1 = 1;
+		$order_for_group_2 = 1;
+		// loop thru what we should have and compare to what we have
+		foreach ($QST_systems as $QST_system) {
+			// reset values array
+			$QST_values = array();
+			// if we don't have what we should have
+			if (! in_array($QST_system, $questions)) {
+				// add it
+				switch ($QST_system) {
+					case 'fname':
+						$QST_values = array(
+							'QST_display_text'  => __('First Name', 'event_espresso'),
+							'QST_admin_label'   => __('First Name - System Question', 'event_espresso'),
+							'QST_system'        => 'fname',
+							'QST_type'          => 'TEXT',
+							'QST_required'      => 1,
+							'QST_required_text' => __('This field is required', 'event_espresso'),
+							'QST_order'         => 1,
+							'QST_admin_only'    => 0,
+							'QST_max'           => EEM_Question::instance()->absolute_max_for_system_question($QST_system),
+							'QST_wp_user'       => self::get_default_creator_id(),
+							'QST_deleted'       => 0,
+						);
+						break;
+					case 'lname':
+						$QST_values = array(
+							'QST_display_text'  => __('Last Name', 'event_espresso'),
+							'QST_admin_label'   => __('Last Name - System Question', 'event_espresso'),
+							'QST_system'        => 'lname',
+							'QST_type'          => 'TEXT',
+							'QST_required'      => 1,
+							'QST_required_text' => __('This field is required', 'event_espresso'),
+							'QST_order'         => 2,
+							'QST_admin_only'    => 0,
+							'QST_max'           => EEM_Question::instance()->absolute_max_for_system_question($QST_system),
+							'QST_wp_user'       => self::get_default_creator_id(),
+							'QST_deleted'       => 0,
+						);
+						break;
+					case 'email':
+						$QST_values = array(
+							'QST_display_text'  => __('Email Address', 'event_espresso'),
+							'QST_admin_label'   => __('Email Address - System Question', 'event_espresso'),
+							'QST_system'        => 'email',
+							'QST_type'          => 'EMAIL',
+							'QST_required'      => 1,
+							'QST_required_text' => __('This field is required', 'event_espresso'),
+							'QST_order'         => 3,
+							'QST_admin_only'    => 0,
+							'QST_max'           => EEM_Question::instance()->absolute_max_for_system_question($QST_system),
+							'QST_wp_user'       => self::get_default_creator_id(),
+							'QST_deleted'       => 0,
+						);
+						break;
+					case 'email_confirm':
+						$QST_values = array(
+							'QST_display_text'  => __('Confirm Email Address', 'event_espresso'),
+							'QST_admin_label'   => __('Confirm Email Address - System Question', 'event_espresso'),
+							'QST_system'        => 'email_confirm',
+							'QST_type'          => 'EMAIL_CONFIRM',
+							'QST_required'      => 1,
+							'QST_required_text' => __('This field is required', 'event_espresso'),
+							'QST_order'         => 4,
+							'QST_admin_only'    => 0,
+							'QST_max'           => EEM_Question::instance()->absolute_max_for_system_question($QST_system),
+							'QST_wp_user'       => self::get_default_creator_id(),
+							'QST_deleted'       => 0,
+						);
+						break;
+					case 'address':
+						$QST_values = array(
+							'QST_display_text'  => __('Address', 'event_espresso'),
+							'QST_admin_label'   => __('Address - System Question', 'event_espresso'),
+							'QST_system'        => 'address',
+							'QST_type'          => 'TEXT',
+							'QST_required'      => 0,
+							'QST_required_text' => __('This field is required', 'event_espresso'),
+							'QST_order'         => 5,
+							'QST_admin_only'    => 0,
+							'QST_max'           => EEM_Question::instance()->absolute_max_for_system_question($QST_system),
+							'QST_wp_user'       => self::get_default_creator_id(),
+							'QST_deleted'       => 0,
+						);
+						break;
+					case 'address2':
+						$QST_values = array(
+							'QST_display_text'  => __('Address2', 'event_espresso'),
+							'QST_admin_label'   => __('Address2 - System Question', 'event_espresso'),
+							'QST_system'        => 'address2',
+							'QST_type'          => 'TEXT',
+							'QST_required'      => 0,
+							'QST_required_text' => __('This field is required', 'event_espresso'),
+							'QST_order'         => 6,
+							'QST_admin_only'    => 0,
+							'QST_max'           => EEM_Question::instance()->absolute_max_for_system_question($QST_system),
+							'QST_wp_user'       => self::get_default_creator_id(),
+							'QST_deleted'       => 0,
+						);
+						break;
+					case 'city':
+						$QST_values = array(
+							'QST_display_text'  => __('City', 'event_espresso'),
+							'QST_admin_label'   => __('City - System Question', 'event_espresso'),
+							'QST_system'        => 'city',
+							'QST_type'          => 'TEXT',
+							'QST_required'      => 0,
+							'QST_required_text' => __('This field is required', 'event_espresso'),
+							'QST_order'         => 7,
+							'QST_admin_only'    => 0,
+							'QST_max'           => EEM_Question::instance()->absolute_max_for_system_question($QST_system),
+							'QST_wp_user'       => self::get_default_creator_id(),
+							'QST_deleted'       => 0,
+						);
+						break;
+					case 'country':
+						$QST_values = array(
+							'QST_display_text'  => __('Country', 'event_espresso'),
+							'QST_admin_label'   => __('Country - System Question', 'event_espresso'),
+							'QST_system'        => 'country',
+							'QST_type'          => 'COUNTRY',
+							'QST_required'      => 0,
+							'QST_required_text' => __('This field is required', 'event_espresso'),
+							'QST_order'         => 8,
+							'QST_admin_only'    => 0,
+							'QST_wp_user'       => self::get_default_creator_id(),
+							'QST_deleted'       => 0,
+						);
+						break;
+					case 'state':
+						$QST_values = array(
+							'QST_display_text'  => __('State/Province', 'event_espresso'),
+							'QST_admin_label'   => __('State/Province - System Question', 'event_espresso'),
+							'QST_system'        => 'state',
+							'QST_type'          => 'STATE',
+							'QST_required'      => 0,
+							'QST_required_text' => __('This field is required', 'event_espresso'),
+							'QST_order'         => 9,
+							'QST_admin_only'    => 0,
+							'QST_wp_user'       => self::get_default_creator_id(),
+							'QST_deleted'       => 0,
+						);
+						break;
+					case 'zip':
+						$QST_values = array(
+							'QST_display_text'  => __('Zip/Postal Code', 'event_espresso'),
+							'QST_admin_label'   => __('Zip/Postal Code - System Question', 'event_espresso'),
+							'QST_system'        => 'zip',
+							'QST_type'          => 'TEXT',
+							'QST_required'      => 0,
+							'QST_required_text' => __('This field is required', 'event_espresso'),
+							'QST_order'         => 10,
+							'QST_admin_only'    => 0,
+							'QST_max'           => EEM_Question::instance()->absolute_max_for_system_question($QST_system),
+							'QST_wp_user'       => self::get_default_creator_id(),
+							'QST_deleted'       => 0,
+						);
+						break;
+					case 'phone':
+						$QST_values = array(
+							'QST_display_text'  => __('Phone Number', 'event_espresso'),
+							'QST_admin_label'   => __('Phone Number - System Question', 'event_espresso'),
+							'QST_system'        => 'phone',
+							'QST_type'          => 'TEXT',
+							'QST_required'      => 0,
+							'QST_required_text' => __('This field is required', 'event_espresso'),
+							'QST_order'         => 11,
+							'QST_admin_only'    => 0,
+							'QST_max'           => EEM_Question::instance()->absolute_max_for_system_question($QST_system),
+							'QST_wp_user'       => self::get_default_creator_id(),
+							'QST_deleted'       => 0,
+						);
+						break;
+				}
+				if (! empty($QST_values)) {
+					// insert system question
+					$wpdb->insert(
+						$table_name,
+						$QST_values,
+						array('%s', '%s', '%s', '%s', '%d', '%s', '%d', '%d', '%d', '%d')
+					);
+					$QST_ID = $wpdb->insert_id;
+
+					// QUESTION GROUP QUESTIONS
+					if (in_array($QST_system, $personal_system_group_questions)) {
+						$system_question_we_want = EEM_Question_Group::system_personal;
+					} elseif (in_array($QST_system, $address_system_group_questions)) {
+						$system_question_we_want = EEM_Question_Group::system_address;
+					} else {
+						// QST_system should not be assigned to any group
+						continue;
+					}
+					if (isset($QSG_IDs[ $system_question_we_want ])) {
+						$QSG_ID = $QSG_IDs[ $system_question_we_want ];
+					} else {
+						$id_col = EEM_Question_Group::instance()
+													->get_col(array(array('QSG_system' => $system_question_we_want)));
+						if (is_array($id_col)) {
+							$QSG_ID = reset($id_col);
+						} else {
+							// ok so we didn't find it in the db either?? that's weird because we should have inserted it at the start of this method
+							EE_Log::instance()->log(
+								__FILE__,
+								__FUNCTION__,
+								sprintf(
+									__(
+										'Could not associate question %1$s to a question group because no system question
                                          group existed',
-                                        'event_espresso'
-                                    ),
-                                    $QST_ID
-                                ),
-                                'error'
-                            );
-                            continue;
-                        }
-                    }
-                    // add system questions to groups
-                    $wpdb->insert(
-                        \EEH_Activation::getTableAnalysis()->ensureTableNameHasPrefix('esp_question_group_question'),
-                        array(
-                            'QSG_ID'    => $QSG_ID,
-                            'QST_ID'    => $QST_ID,
-                            'QGQ_order' => ($QSG_ID === 1) ? $order_for_group_1++ : $order_for_group_2++,
-                        ),
-                        array('%d', '%d', '%d')
-                    );
-                }
-            }
-        }
-    }
-
-
-    /**
-     * Makes sure the default payment method (Invoice) is active.
-     * This used to be done automatically as part of constructing the old gateways config
-     *
-     * @throws \EE_Error
-     */
-    public static function insert_default_payment_methods()
-    {
-        if (! EEM_Payment_Method::instance()->count_active(EEM_Payment_Method::scope_cart)) {
-            EE_Registry::instance()->load_lib('Payment_Method_Manager');
-            EE_Payment_Method_Manager::instance()->activate_a_payment_method_of_type('Invoice');
-        } else {
-            EEM_Payment_Method::instance()->verify_button_urls();
-        }
-    }
-
-    /**
-     * insert_default_status_codes
-     *
-     * @access public
-     * @static
-     * @return void
-     */
-    public static function insert_default_status_codes()
-    {
-
-        global $wpdb;
-
-        if (\EEH_Activation::getTableAnalysis()->tableExists(EEM_Status::instance()->table())) {
-            $table_name = EEM_Status::instance()->table();
-
-            $SQL = "DELETE FROM $table_name WHERE STS_ID IN ( 'ACT', 'NAC', 'NOP', 'OPN', 'CLS', 'PND', 'ONG', 'SEC', 'DRF', 'DEL', 'DEN', 'EXP', 'RPP', 'RCN', 'RDC', 'RAP', 'RNA', 'RWL', 'TAB', 'TIN', 'TFL', 'TCM', 'TOP', 'PAP', 'PCN', 'PFL', 'PDC', 'EDR', 'ESN', 'PPN', 'RIC', 'MSN', 'MFL', 'MID', 'MRS', 'MIC', 'MDO', 'MEX' );";
-            $wpdb->query($SQL);
-
-            $SQL = "INSERT INTO $table_name
+										'event_espresso'
+									),
+									$QST_ID
+								),
+								'error'
+							);
+							continue;
+						}
+					}
+					// add system questions to groups
+					$wpdb->insert(
+						\EEH_Activation::getTableAnalysis()->ensureTableNameHasPrefix('esp_question_group_question'),
+						array(
+							'QSG_ID'    => $QSG_ID,
+							'QST_ID'    => $QST_ID,
+							'QGQ_order' => ($QSG_ID === 1) ? $order_for_group_1++ : $order_for_group_2++,
+						),
+						array('%d', '%d', '%d')
+					);
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * Makes sure the default payment method (Invoice) is active.
+	 * This used to be done automatically as part of constructing the old gateways config
+	 *
+	 * @throws \EE_Error
+	 */
+	public static function insert_default_payment_methods()
+	{
+		if (! EEM_Payment_Method::instance()->count_active(EEM_Payment_Method::scope_cart)) {
+			EE_Registry::instance()->load_lib('Payment_Method_Manager');
+			EE_Payment_Method_Manager::instance()->activate_a_payment_method_of_type('Invoice');
+		} else {
+			EEM_Payment_Method::instance()->verify_button_urls();
+		}
+	}
+
+	/**
+	 * insert_default_status_codes
+	 *
+	 * @access public
+	 * @static
+	 * @return void
+	 */
+	public static function insert_default_status_codes()
+	{
+
+		global $wpdb;
+
+		if (\EEH_Activation::getTableAnalysis()->tableExists(EEM_Status::instance()->table())) {
+			$table_name = EEM_Status::instance()->table();
+
+			$SQL = "DELETE FROM $table_name WHERE STS_ID IN ( 'ACT', 'NAC', 'NOP', 'OPN', 'CLS', 'PND', 'ONG', 'SEC', 'DRF', 'DEL', 'DEN', 'EXP', 'RPP', 'RCN', 'RDC', 'RAP', 'RNA', 'RWL', 'TAB', 'TIN', 'TFL', 'TCM', 'TOP', 'PAP', 'PCN', 'PFL', 'PDC', 'EDR', 'ESN', 'PPN', 'RIC', 'MSN', 'MFL', 'MID', 'MRS', 'MIC', 'MDO', 'MEX' );";
+			$wpdb->query($SQL);
+
+			$SQL = "INSERT INTO $table_name
 					(STS_ID, STS_code, STS_type, STS_can_edit, STS_desc, STS_open) VALUES
 					('ACT', 'ACTIVE', 'event', 0, NULL, 1),
 					('NAC', 'NOT_ACTIVE', 'event', 0, NULL, 0),
@@ -1220,477 +1220,477 @@ 
 					('MID', 'IDLE', 'message', 0, NULL, 1),
 					('MRS', 'RESEND', 'message', 0, NULL, 1),
 					('MIC', 'INCOMPLETE', 'message', 0, NULL, 0);";
-            $wpdb->query($SQL);
-        }
-    }
-
-
-    /**
-     * generate_default_message_templates
-     *
-     * @static
-     * @throws EE_Error
-     * @return bool     true means new templates were created.
-     *                  false means no templates were created.
-     *                  This is NOT an error flag. To check for errors you will want
-     *                  to use either EE_Error or a try catch for an EE_Error exception.
-     */
-    public static function generate_default_message_templates()
-    {
-        /** @type EE_Message_Resource_Manager $message_resource_manager */
-        $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        /*
+			$wpdb->query($SQL);
+		}
+	}
+
+
+	/**
+	 * generate_default_message_templates
+	 *
+	 * @static
+	 * @throws EE_Error
+	 * @return bool     true means new templates were created.
+	 *                  false means no templates were created.
+	 *                  This is NOT an error flag. To check for errors you will want
+	 *                  to use either EE_Error or a try catch for an EE_Error exception.
+	 */
+	public static function generate_default_message_templates()
+	{
+		/** @type EE_Message_Resource_Manager $message_resource_manager */
+		$message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		/*
          * This first method is taking care of ensuring any default messengers
          * that should be made active and have templates generated are done.
          */
-        $new_templates_created_for_messenger = self::_activate_and_generate_default_messengers_and_message_templates(
-            $message_resource_manager
-        );
-        /**
-         * This method is verifying there are no NEW default message types
-         * for ACTIVE messengers that need activated (and corresponding templates setup).
-         */
-        $new_templates_created_for_message_type = self::_activate_new_message_types_for_active_messengers_and_generate_default_templates(
-            $message_resource_manager
-        );
-        // after all is done, let's persist these changes to the db.
-        $message_resource_manager->update_has_activated_messengers_option();
-        $message_resource_manager->update_active_messengers_option();
-        // will return true if either of these are true.  Otherwise will return false.
-        return $new_templates_created_for_message_type || $new_templates_created_for_messenger;
-    }
-
-
-
-    /**
-     * @param \EE_Message_Resource_Manager $message_resource_manager
-     * @return array|bool
-     * @throws \EE_Error
-     */
-    protected static function _activate_new_message_types_for_active_messengers_and_generate_default_templates(
-        EE_Message_Resource_Manager $message_resource_manager
-    ) {
-        /** @type EE_messenger[] $active_messengers */
-        $active_messengers = $message_resource_manager->active_messengers();
-        $installed_message_types = $message_resource_manager->installed_message_types();
-        $templates_created = false;
-        foreach ($active_messengers as $active_messenger) {
-            $default_message_type_names_for_messenger = $active_messenger->get_default_message_types();
-            $default_message_type_names_to_activate = array();
-            // looping through each default message type reported by the messenger
-            // and setup the actual message types to activate.
-            foreach ($default_message_type_names_for_messenger as $default_message_type_name_for_messenger) {
-                // if already active or has already been activated before we skip
-                // (otherwise we might reactivate something user's intentionally deactivated.)
-                // we also skip if the message type is not installed.
-                if (
-                    $message_resource_manager->has_message_type_been_activated_for_messenger(
-                        $default_message_type_name_for_messenger,
-                        $active_messenger->name
-                    )
-                    || $message_resource_manager->is_message_type_active_for_messenger(
-                        $active_messenger->name,
-                        $default_message_type_name_for_messenger
-                    )
-                    || ! isset($installed_message_types[ $default_message_type_name_for_messenger ])
-                ) {
-                    continue;
-                }
-                $default_message_type_names_to_activate[] = $default_message_type_name_for_messenger;
-            }
-            // let's activate!
-            $message_resource_manager->ensure_message_types_are_active(
-                $default_message_type_names_to_activate,
-                $active_messenger->name,
-                false
-            );
-            // activate the templates for these message types
-            if (! empty($default_message_type_names_to_activate)) {
-                $templates_created = EEH_MSG_Template::generate_new_templates(
-                    $active_messenger->name,
-                    $default_message_type_names_for_messenger,
-                    '',
-                    true
-                );
-            }
-        }
-        return $templates_created;
-    }
-
-
-
-    /**
-     * This will activate and generate default messengers and default message types for those messengers.
-     *
-     * @param EE_message_Resource_Manager $message_resource_manager
-     * @return array|bool  True means there were default messengers and message type templates generated.
-     *                     False means that there were no templates generated
-     *                     (which could simply mean there are no default message types for a messenger).
-     * @throws EE_Error
-     */
-    protected static function _activate_and_generate_default_messengers_and_message_templates(
-        EE_Message_Resource_Manager $message_resource_manager
-    ) {
-        /** @type EE_messenger[] $messengers_to_generate */
-        $messengers_to_generate = self::_get_default_messengers_to_generate_on_activation($message_resource_manager);
-        $installed_message_types = $message_resource_manager->installed_message_types();
-        $templates_generated = false;
-        foreach ($messengers_to_generate as $messenger_to_generate) {
-            $default_message_type_names_for_messenger = $messenger_to_generate->get_default_message_types();
-            // verify the default message types match an installed message type.
-            foreach ($default_message_type_names_for_messenger as $key => $name) {
-                if (
-                    ! isset($installed_message_types[ $name ])
-                    || $message_resource_manager->has_message_type_been_activated_for_messenger(
-                        $name,
-                        $messenger_to_generate->name
-                    )
-                ) {
-                    unset($default_message_type_names_for_messenger[ $key ]);
-                }
-            }
-            // in previous iterations, the active_messengers option in the db
-            // needed updated before calling create templates. however with the changes this may not be necessary.
-            // This comment is left here just in case we discover that we _do_ need to update before
-            // passing off to create templates (after the refactor is done).
-            // @todo remove this comment when determined not necessary.
-            $message_resource_manager->activate_messenger(
-                $messenger_to_generate,
-                $default_message_type_names_for_messenger,
-                false
-            );
-            // create any templates needing created (or will reactivate templates already generated as necessary).
-            if (! empty($default_message_type_names_for_messenger)) {
-                $templates_generated = EEH_MSG_Template::generate_new_templates(
-                    $messenger_to_generate->name,
-                    $default_message_type_names_for_messenger,
-                    '',
-                    true
-                );
-            }
-        }
-        return $templates_generated;
-    }
-
-
-    /**
-     * This returns the default messengers to generate templates for on activation of EE.
-     * It considers:
-     * - whether a messenger is already active in the db.
-     * - whether a messenger has been made active at any time in the past.
-     *
-     * @static
-     * @param  EE_Message_Resource_Manager $message_resource_manager
-     * @return EE_messenger[]
-     */
-    protected static function _get_default_messengers_to_generate_on_activation(
-        EE_Message_Resource_Manager $message_resource_manager
-    ) {
-        $active_messengers    = $message_resource_manager->active_messengers();
-        $installed_messengers = $message_resource_manager->installed_messengers();
-        $has_activated        = $message_resource_manager->get_has_activated_messengers_option();
-
-        $messengers_to_generate = array();
-        foreach ($installed_messengers as $installed_messenger) {
-            // if installed messenger is a messenger that should be activated on install
-            // and is not already active
-            // and has never been activated
-            if (
-                ! $installed_messenger->activate_on_install
-                || isset($active_messengers[ $installed_messenger->name ])
-                || isset($has_activated[ $installed_messenger->name ])
-            ) {
-                continue;
-            }
-            $messengers_to_generate[ $installed_messenger->name ] = $installed_messenger;
-        }
-        return $messengers_to_generate;
-    }
-
-
-    /**
-     * This simply validates active message types to ensure they actually match installed
-     * message types.  If there's a mismatch then we deactivate the message type and ensure all related db
-     * rows are set inactive.
-     * Note: Messengers are no longer validated here as of 4.9.0 because they get validated automatically whenever
-     * EE_Messenger_Resource_Manager is constructed.  Message Types are a bit more resource heavy for validation so they
-     * are still handled in here.
-     *
-     * @since 4.3.1
-     * @return void
-     */
-    public static function validate_messages_system()
-    {
-        /** @type EE_Message_Resource_Manager $message_resource_manager */
-        $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        $message_resource_manager->validate_active_message_types_are_installed();
-        do_action('AHEE__EEH_Activation__validate_messages_system');
-    }
-
-
-    /**
-     * create_no_ticket_prices_array
-     *
-     * @access public
-     * @static
-     * @return void
-     */
-    public static function create_no_ticket_prices_array()
-    {
-        // this creates an array for tracking events that have no active ticket prices created
-        // this allows us to warn admins of the situation so that it can be corrected
-        $espresso_no_ticket_prices = get_option('ee_no_ticket_prices', false);
-        if (! $espresso_no_ticket_prices) {
-            add_option('ee_no_ticket_prices', array(), '', false);
-        }
-    }
-
-
-    /**
-     * plugin_deactivation
-     *
-     * @access public
-     * @static
-     * @return void
-     */
-    public static function plugin_deactivation()
-    {
-    }
-
-
-    /**
-     * Finds all our EE4 custom post types, and deletes them and their associated data
-     * (like post meta or term relations)
-     *
-     * @global wpdb $wpdb
-     * @throws \EE_Error
-     */
-    public static function delete_all_espresso_cpt_data()
-    {
-        global $wpdb;
-        // get all the CPT post_types
-        $ee_post_types = array();
-        foreach (EE_Registry::instance()->non_abstract_db_models as $model_name) {
-            if (method_exists($model_name, 'instance')) {
-                $model_obj = call_user_func(array($model_name, 'instance'));
-                if ($model_obj instanceof EEM_CPT_Base) {
-                    $ee_post_types[] = $wpdb->prepare("%s", $model_obj->post_type());
-                }
-            }
-        }
-        // get all our CPTs
-        $query   = "SELECT ID FROM {$wpdb->posts} WHERE post_type IN (" . implode(",", $ee_post_types) . ")";
-        $cpt_ids = $wpdb->get_col($query);
-        // delete each post meta and term relations too
-        foreach ($cpt_ids as $post_id) {
-            wp_delete_post($post_id, true);
-        }
-    }
-
-    /**
-     * Deletes all EE custom tables
-     *
-     * @return array
-     */
-    public static function drop_espresso_tables()
-    {
-        $tables = array();
-        // load registry
-        foreach (EE_Registry::instance()->non_abstract_db_models as $model_name) {
-            if (method_exists($model_name, 'instance')) {
-                $model_obj = call_user_func(array($model_name, 'instance'));
-                if ($model_obj instanceof EEM_Base) {
-                    foreach ($model_obj->get_tables() as $table) {
-                        if (
-                            strpos($table->get_table_name(), 'esp_')
-                            &&
-                            (
-                                is_main_site()// main site? nuke them all
-                                || ! $table->is_global()// not main site,but not global either. nuke it
-                            )
-                        ) {
-                            $tables[ $table->get_table_name() ] = $table->get_table_name();
-                        }
-                    }
-                }
-            }
-        }
-
-        // there are some tables whose models were removed.
-        // they should be removed when removing all EE core's data
-        $tables_without_models = array(
-            'esp_promotion',
-            'esp_promotion_applied',
-            'esp_promotion_object',
-            'esp_promotion_rule',
-            'esp_rule',
-        );
-        foreach ($tables_without_models as $table) {
-            $tables[ $table ] = $table;
-        }
-        return \EEH_Activation::getTableManager()->dropTables($tables);
-    }
-
-
-
-    /**
-     * Drops all the tables mentioned in a single MYSQL query. Double-checks
-     * each table name provided has a wpdb prefix attached, and that it exists.
-     * Returns the list actually deleted
-     *
-     * @deprecated in 4.9.13. Instead use TableManager::dropTables()
-     * @global WPDB $wpdb
-     * @param array $table_names
-     * @return array of table names which we deleted
-     */
-    public static function drop_tables($table_names)
-    {
-        return \EEH_Activation::getTableManager()->dropTables($table_names);
-    }
-
-
-
-    /**
-     * plugin_uninstall
-     *
-     * @access public
-     * @static
-     * @param bool $remove_all
-     * @return void
-     */
-    public static function delete_all_espresso_tables_and_data($remove_all = true)
-    {
-        global $wpdb;
-        self::drop_espresso_tables();
-        $wp_options_to_delete = array(
-            'ee_no_ticket_prices'                => true,
-            'ee_active_messengers'               => true,
-            'ee_has_activated_messenger'         => true,
-            RewriteRules::OPTION_KEY_FLUSH_REWRITE_RULES => true,
-            'ee_config'                          => false,
-            'ee_data_migration_current_db_state' => true,
-            'ee_data_migration_mapping_'         => false,
-            'ee_data_migration_script_'          => false,
-            'ee_data_migrations'                 => true,
-            'ee_dms_map'                         => false,
-            'ee_notices'                         => true,
-            'lang_file_check_'                   => false,
-            'ee_maintenance_mode'                => true,
-            'ee_ueip_optin'                      => true,
-            'ee_ueip_has_notified'               => true,
-            'ee_plugin_activation_errors'        => true,
-            'ee_id_mapping_from'                 => false,
-            'espresso_persistent_admin_notices'  => true,
-            'ee_encryption_key'                  => true,
-            'pue_force_upgrade_'                 => false,
-            'pue_json_error_'                    => false,
-            'pue_install_key_'                   => false,
-            'pue_verification_error_'            => false,
-            'pu_dismissed_upgrade_'              => false,
-            'external_updates-'                  => false,
-            'ee_extra_data'                      => true,
-            'ee_ssn_'                            => false,
-            'ee_rss_'                            => false,
-            'ee_rte_n_tx_'                       => false,
-            'ee_pers_admin_notices'              => true,
-            'ee_job_parameters_'                 => false,
-            'ee_upload_directories_incomplete'   => true,
-            'ee_verified_db_collations'          => true,
-        );
-        if (is_main_site()) {
-            $wp_options_to_delete['ee_network_config'] = true;
-        }
-        $undeleted_options = array();
-        foreach ($wp_options_to_delete as $option_name => $no_wildcard) {
-            if ($no_wildcard) {
-                if (! delete_option($option_name)) {
-                    $undeleted_options[] = $option_name;
-                }
-            } else {
-                $option_names_to_delete_from_wildcard = $wpdb->get_col("SELECT option_name FROM $wpdb->options WHERE option_name LIKE '%$option_name%'");
-                foreach ($option_names_to_delete_from_wildcard as $option_name_from_wildcard) {
-                    if (! delete_option($option_name_from_wildcard)) {
-                        $undeleted_options[] = $option_name_from_wildcard;
-                    }
-                }
-            }
-        }
-        // also, let's make sure the "ee_config_option_names" wp option stays out by removing the action that adds it
-        remove_action('shutdown', array(EE_Config::instance(), 'shutdown'), 10);
-        if ($remove_all && $espresso_db_update = get_option('espresso_db_update')) {
-            $db_update_sans_ee4 = array();
-            foreach ($espresso_db_update as $version => $times_activated) {
-                if ((string) $version[0] === '3') {// if its NON EE4
-                    $db_update_sans_ee4[ $version ] = $times_activated;
-                }
-            }
-            update_option('espresso_db_update', $db_update_sans_ee4);
-        }
-        $errors = '';
-        if (! empty($undeleted_options)) {
-            $errors .= sprintf(
-                __('The following wp-options could not be deleted: %s%s', 'event_espresso'),
-                '<br/>',
-                implode(',<br/>', $undeleted_options)
-            );
-        }
-        if (! empty($errors)) {
-            EE_Error::add_attention($errors, __FILE__, __FUNCTION__, __LINE__);
-        }
-    }
-
-    /**
-     * Gets the mysql error code from the last used query by wpdb
-     *
-     * @return int mysql error code, see https://dev.mysql.com/doc/refman/5.5/en/error-messages-server.html
-     */
-    public static function last_wpdb_error_code()
-    {
-        global $wpdb;
-        return $wpdb->use_mysqli ? mysqli_errno($wpdb->dbh) : 0;
-    }
-
-    /**
-     * Checks that the database table exists. Also works on temporary tables (for unit tests mostly).
-     *
-     * @global wpdb  $wpdb
-     * @deprecated instead use TableAnalysis::tableExists()
-     * @param string $table_name with or without $wpdb->prefix
-     * @return boolean
-     */
-    public static function table_exists($table_name)
-    {
-        return \EEH_Activation::getTableAnalysis()->tableExists($table_name);
-    }
-
-    /**
-     * Resets the cache on EEH_Activation
-     */
-    public static function reset()
-    {
-        self::$_default_creator_id                             = null;
-        self::$_initialized_db_content_already_in_this_request = false;
-    }
-
-    /**
-     * Removes 'email_confirm' from the Address info question group on activation
-     * @return void
-     */
-    public static function removeEmailConfirmFromAddressGroup()
-    {
-
-        // Pull the email_confirm question ID.
-        $email_confirm_question_id = EEM_Question::instance()->get_Question_ID_from_system_string(
-            EEM_Attendee::system_question_email_confirm
-        );
-        // Remove the email_confirm question group from the address group questions.
-        EEM_Question_Group_Question::instance()->delete(
-            array(
-                array(
-                    'QST_ID' => $email_confirm_question_id,
-                    'Question_Group.QSG_system' => EEM_Question_Group::system_address,
-                ),
-            )
-        );
-    }
+		$new_templates_created_for_messenger = self::_activate_and_generate_default_messengers_and_message_templates(
+			$message_resource_manager
+		);
+		/**
+		 * This method is verifying there are no NEW default message types
+		 * for ACTIVE messengers that need activated (and corresponding templates setup).
+		 */
+		$new_templates_created_for_message_type = self::_activate_new_message_types_for_active_messengers_and_generate_default_templates(
+			$message_resource_manager
+		);
+		// after all is done, let's persist these changes to the db.
+		$message_resource_manager->update_has_activated_messengers_option();
+		$message_resource_manager->update_active_messengers_option();
+		// will return true if either of these are true.  Otherwise will return false.
+		return $new_templates_created_for_message_type || $new_templates_created_for_messenger;
+	}
+
+
+
+	/**
+	 * @param \EE_Message_Resource_Manager $message_resource_manager
+	 * @return array|bool
+	 * @throws \EE_Error
+	 */
+	protected static function _activate_new_message_types_for_active_messengers_and_generate_default_templates(
+		EE_Message_Resource_Manager $message_resource_manager
+	) {
+		/** @type EE_messenger[] $active_messengers */
+		$active_messengers = $message_resource_manager->active_messengers();
+		$installed_message_types = $message_resource_manager->installed_message_types();
+		$templates_created = false;
+		foreach ($active_messengers as $active_messenger) {
+			$default_message_type_names_for_messenger = $active_messenger->get_default_message_types();
+			$default_message_type_names_to_activate = array();
+			// looping through each default message type reported by the messenger
+			// and setup the actual message types to activate.
+			foreach ($default_message_type_names_for_messenger as $default_message_type_name_for_messenger) {
+				// if already active or has already been activated before we skip
+				// (otherwise we might reactivate something user's intentionally deactivated.)
+				// we also skip if the message type is not installed.
+				if (
+					$message_resource_manager->has_message_type_been_activated_for_messenger(
+						$default_message_type_name_for_messenger,
+						$active_messenger->name
+					)
+					|| $message_resource_manager->is_message_type_active_for_messenger(
+						$active_messenger->name,
+						$default_message_type_name_for_messenger
+					)
+					|| ! isset($installed_message_types[ $default_message_type_name_for_messenger ])
+				) {
+					continue;
+				}
+				$default_message_type_names_to_activate[] = $default_message_type_name_for_messenger;
+			}
+			// let's activate!
+			$message_resource_manager->ensure_message_types_are_active(
+				$default_message_type_names_to_activate,
+				$active_messenger->name,
+				false
+			);
+			// activate the templates for these message types
+			if (! empty($default_message_type_names_to_activate)) {
+				$templates_created = EEH_MSG_Template::generate_new_templates(
+					$active_messenger->name,
+					$default_message_type_names_for_messenger,
+					'',
+					true
+				);
+			}
+		}
+		return $templates_created;
+	}
+
+
+
+	/**
+	 * This will activate and generate default messengers and default message types for those messengers.
+	 *
+	 * @param EE_message_Resource_Manager $message_resource_manager
+	 * @return array|bool  True means there were default messengers and message type templates generated.
+	 *                     False means that there were no templates generated
+	 *                     (which could simply mean there are no default message types for a messenger).
+	 * @throws EE_Error
+	 */
+	protected static function _activate_and_generate_default_messengers_and_message_templates(
+		EE_Message_Resource_Manager $message_resource_manager
+	) {
+		/** @type EE_messenger[] $messengers_to_generate */
+		$messengers_to_generate = self::_get_default_messengers_to_generate_on_activation($message_resource_manager);
+		$installed_message_types = $message_resource_manager->installed_message_types();
+		$templates_generated = false;
+		foreach ($messengers_to_generate as $messenger_to_generate) {
+			$default_message_type_names_for_messenger = $messenger_to_generate->get_default_message_types();
+			// verify the default message types match an installed message type.
+			foreach ($default_message_type_names_for_messenger as $key => $name) {
+				if (
+					! isset($installed_message_types[ $name ])
+					|| $message_resource_manager->has_message_type_been_activated_for_messenger(
+						$name,
+						$messenger_to_generate->name
+					)
+				) {
+					unset($default_message_type_names_for_messenger[ $key ]);
+				}
+			}
+			// in previous iterations, the active_messengers option in the db
+			// needed updated before calling create templates. however with the changes this may not be necessary.
+			// This comment is left here just in case we discover that we _do_ need to update before
+			// passing off to create templates (after the refactor is done).
+			// @todo remove this comment when determined not necessary.
+			$message_resource_manager->activate_messenger(
+				$messenger_to_generate,
+				$default_message_type_names_for_messenger,
+				false
+			);
+			// create any templates needing created (or will reactivate templates already generated as necessary).
+			if (! empty($default_message_type_names_for_messenger)) {
+				$templates_generated = EEH_MSG_Template::generate_new_templates(
+					$messenger_to_generate->name,
+					$default_message_type_names_for_messenger,
+					'',
+					true
+				);
+			}
+		}
+		return $templates_generated;
+	}
+
+
+	/**
+	 * This returns the default messengers to generate templates for on activation of EE.
+	 * It considers:
+	 * - whether a messenger is already active in the db.
+	 * - whether a messenger has been made active at any time in the past.
+	 *
+	 * @static
+	 * @param  EE_Message_Resource_Manager $message_resource_manager
+	 * @return EE_messenger[]
+	 */
+	protected static function _get_default_messengers_to_generate_on_activation(
+		EE_Message_Resource_Manager $message_resource_manager
+	) {
+		$active_messengers    = $message_resource_manager->active_messengers();
+		$installed_messengers = $message_resource_manager->installed_messengers();
+		$has_activated        = $message_resource_manager->get_has_activated_messengers_option();
+
+		$messengers_to_generate = array();
+		foreach ($installed_messengers as $installed_messenger) {
+			// if installed messenger is a messenger that should be activated on install
+			// and is not already active
+			// and has never been activated
+			if (
+				! $installed_messenger->activate_on_install
+				|| isset($active_messengers[ $installed_messenger->name ])
+				|| isset($has_activated[ $installed_messenger->name ])
+			) {
+				continue;
+			}
+			$messengers_to_generate[ $installed_messenger->name ] = $installed_messenger;
+		}
+		return $messengers_to_generate;
+	}
+
+
+	/**
+	 * This simply validates active message types to ensure they actually match installed
+	 * message types.  If there's a mismatch then we deactivate the message type and ensure all related db
+	 * rows are set inactive.
+	 * Note: Messengers are no longer validated here as of 4.9.0 because they get validated automatically whenever
+	 * EE_Messenger_Resource_Manager is constructed.  Message Types are a bit more resource heavy for validation so they
+	 * are still handled in here.
+	 *
+	 * @since 4.3.1
+	 * @return void
+	 */
+	public static function validate_messages_system()
+	{
+		/** @type EE_Message_Resource_Manager $message_resource_manager */
+		$message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		$message_resource_manager->validate_active_message_types_are_installed();
+		do_action('AHEE__EEH_Activation__validate_messages_system');
+	}
+
+
+	/**
+	 * create_no_ticket_prices_array
+	 *
+	 * @access public
+	 * @static
+	 * @return void
+	 */
+	public static function create_no_ticket_prices_array()
+	{
+		// this creates an array for tracking events that have no active ticket prices created
+		// this allows us to warn admins of the situation so that it can be corrected
+		$espresso_no_ticket_prices = get_option('ee_no_ticket_prices', false);
+		if (! $espresso_no_ticket_prices) {
+			add_option('ee_no_ticket_prices', array(), '', false);
+		}
+	}
+
+
+	/**
+	 * plugin_deactivation
+	 *
+	 * @access public
+	 * @static
+	 * @return void
+	 */
+	public static function plugin_deactivation()
+	{
+	}
+
+
+	/**
+	 * Finds all our EE4 custom post types, and deletes them and their associated data
+	 * (like post meta or term relations)
+	 *
+	 * @global wpdb $wpdb
+	 * @throws \EE_Error
+	 */
+	public static function delete_all_espresso_cpt_data()
+	{
+		global $wpdb;
+		// get all the CPT post_types
+		$ee_post_types = array();
+		foreach (EE_Registry::instance()->non_abstract_db_models as $model_name) {
+			if (method_exists($model_name, 'instance')) {
+				$model_obj = call_user_func(array($model_name, 'instance'));
+				if ($model_obj instanceof EEM_CPT_Base) {
+					$ee_post_types[] = $wpdb->prepare("%s", $model_obj->post_type());
+				}
+			}
+		}
+		// get all our CPTs
+		$query   = "SELECT ID FROM {$wpdb->posts} WHERE post_type IN (" . implode(",", $ee_post_types) . ")";
+		$cpt_ids = $wpdb->get_col($query);
+		// delete each post meta and term relations too
+		foreach ($cpt_ids as $post_id) {
+			wp_delete_post($post_id, true);
+		}
+	}
+
+	/**
+	 * Deletes all EE custom tables
+	 *
+	 * @return array
+	 */
+	public static function drop_espresso_tables()
+	{
+		$tables = array();
+		// load registry
+		foreach (EE_Registry::instance()->non_abstract_db_models as $model_name) {
+			if (method_exists($model_name, 'instance')) {
+				$model_obj = call_user_func(array($model_name, 'instance'));
+				if ($model_obj instanceof EEM_Base) {
+					foreach ($model_obj->get_tables() as $table) {
+						if (
+							strpos($table->get_table_name(), 'esp_')
+							&&
+							(
+								is_main_site()// main site? nuke them all
+								|| ! $table->is_global()// not main site,but not global either. nuke it
+							)
+						) {
+							$tables[ $table->get_table_name() ] = $table->get_table_name();
+						}
+					}
+				}
+			}
+		}
+
+		// there are some tables whose models were removed.
+		// they should be removed when removing all EE core's data
+		$tables_without_models = array(
+			'esp_promotion',
+			'esp_promotion_applied',
+			'esp_promotion_object',
+			'esp_promotion_rule',
+			'esp_rule',
+		);
+		foreach ($tables_without_models as $table) {
+			$tables[ $table ] = $table;
+		}
+		return \EEH_Activation::getTableManager()->dropTables($tables);
+	}
+
+
+
+	/**
+	 * Drops all the tables mentioned in a single MYSQL query. Double-checks
+	 * each table name provided has a wpdb prefix attached, and that it exists.
+	 * Returns the list actually deleted
+	 *
+	 * @deprecated in 4.9.13. Instead use TableManager::dropTables()
+	 * @global WPDB $wpdb
+	 * @param array $table_names
+	 * @return array of table names which we deleted
+	 */
+	public static function drop_tables($table_names)
+	{
+		return \EEH_Activation::getTableManager()->dropTables($table_names);
+	}
+
+
+
+	/**
+	 * plugin_uninstall
+	 *
+	 * @access public
+	 * @static
+	 * @param bool $remove_all
+	 * @return void
+	 */
+	public static function delete_all_espresso_tables_and_data($remove_all = true)
+	{
+		global $wpdb;
+		self::drop_espresso_tables();
+		$wp_options_to_delete = array(
+			'ee_no_ticket_prices'                => true,
+			'ee_active_messengers'               => true,
+			'ee_has_activated_messenger'         => true,
+			RewriteRules::OPTION_KEY_FLUSH_REWRITE_RULES => true,
+			'ee_config'                          => false,
+			'ee_data_migration_current_db_state' => true,
+			'ee_data_migration_mapping_'         => false,
+			'ee_data_migration_script_'          => false,
+			'ee_data_migrations'                 => true,
+			'ee_dms_map'                         => false,
+			'ee_notices'                         => true,
+			'lang_file_check_'                   => false,
+			'ee_maintenance_mode'                => true,
+			'ee_ueip_optin'                      => true,
+			'ee_ueip_has_notified'               => true,
+			'ee_plugin_activation_errors'        => true,
+			'ee_id_mapping_from'                 => false,
+			'espresso_persistent_admin_notices'  => true,
+			'ee_encryption_key'                  => true,
+			'pue_force_upgrade_'                 => false,
+			'pue_json_error_'                    => false,
+			'pue_install_key_'                   => false,
+			'pue_verification_error_'            => false,
+			'pu_dismissed_upgrade_'              => false,
+			'external_updates-'                  => false,
+			'ee_extra_data'                      => true,
+			'ee_ssn_'                            => false,
+			'ee_rss_'                            => false,
+			'ee_rte_n_tx_'                       => false,
+			'ee_pers_admin_notices'              => true,
+			'ee_job_parameters_'                 => false,
+			'ee_upload_directories_incomplete'   => true,
+			'ee_verified_db_collations'          => true,
+		);
+		if (is_main_site()) {
+			$wp_options_to_delete['ee_network_config'] = true;
+		}
+		$undeleted_options = array();
+		foreach ($wp_options_to_delete as $option_name => $no_wildcard) {
+			if ($no_wildcard) {
+				if (! delete_option($option_name)) {
+					$undeleted_options[] = $option_name;
+				}
+			} else {
+				$option_names_to_delete_from_wildcard = $wpdb->get_col("SELECT option_name FROM $wpdb->options WHERE option_name LIKE '%$option_name%'");
+				foreach ($option_names_to_delete_from_wildcard as $option_name_from_wildcard) {
+					if (! delete_option($option_name_from_wildcard)) {
+						$undeleted_options[] = $option_name_from_wildcard;
+					}
+				}
+			}
+		}
+		// also, let's make sure the "ee_config_option_names" wp option stays out by removing the action that adds it
+		remove_action('shutdown', array(EE_Config::instance(), 'shutdown'), 10);
+		if ($remove_all && $espresso_db_update = get_option('espresso_db_update')) {
+			$db_update_sans_ee4 = array();
+			foreach ($espresso_db_update as $version => $times_activated) {
+				if ((string) $version[0] === '3') {// if its NON EE4
+					$db_update_sans_ee4[ $version ] = $times_activated;
+				}
+			}
+			update_option('espresso_db_update', $db_update_sans_ee4);
+		}
+		$errors = '';
+		if (! empty($undeleted_options)) {
+			$errors .= sprintf(
+				__('The following wp-options could not be deleted: %s%s', 'event_espresso'),
+				'<br/>',
+				implode(',<br/>', $undeleted_options)
+			);
+		}
+		if (! empty($errors)) {
+			EE_Error::add_attention($errors, __FILE__, __FUNCTION__, __LINE__);
+		}
+	}
+
+	/**
+	 * Gets the mysql error code from the last used query by wpdb
+	 *
+	 * @return int mysql error code, see https://dev.mysql.com/doc/refman/5.5/en/error-messages-server.html
+	 */
+	public static function last_wpdb_error_code()
+	{
+		global $wpdb;
+		return $wpdb->use_mysqli ? mysqli_errno($wpdb->dbh) : 0;
+	}
+
+	/**
+	 * Checks that the database table exists. Also works on temporary tables (for unit tests mostly).
+	 *
+	 * @global wpdb  $wpdb
+	 * @deprecated instead use TableAnalysis::tableExists()
+	 * @param string $table_name with or without $wpdb->prefix
+	 * @return boolean
+	 */
+	public static function table_exists($table_name)
+	{
+		return \EEH_Activation::getTableAnalysis()->tableExists($table_name);
+	}
+
+	/**
+	 * Resets the cache on EEH_Activation
+	 */
+	public static function reset()
+	{
+		self::$_default_creator_id                             = null;
+		self::$_initialized_db_content_already_in_this_request = false;
+	}
+
+	/**
+	 * Removes 'email_confirm' from the Address info question group on activation
+	 * @return void
+	 */
+	public static function removeEmailConfirmFromAddressGroup()
+	{
+
+		// Pull the email_confirm question ID.
+		$email_confirm_question_id = EEM_Question::instance()->get_Question_ID_from_system_string(
+			EEM_Attendee::system_question_email_confirm
+		);
+		// Remove the email_confirm question group from the address group questions.
+		EEM_Question_Group_Question::instance()->delete(
+			array(
+				array(
+					'QST_ID' => $email_confirm_question_id,
+					'Question_Group.QSG_system' => EEM_Question_Group::system_address,
+				),
+			)
+		);
+	}
 }

core/EE_System.core.php

Indentation +1162 added lines, -1162 removed lines

@@ -25,1166 +25,1166 @@
 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;
-
-
-    /**
-     * @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 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');
-    }
-
-
-    /**
-     * 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 = __(
-                '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 .= __(
-                '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) {
-                        unset($_GET['activate']);
-                        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');
-        /** @var EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomies $register_custom_taxonomies */
-        $register_custom_taxonomies = $this->loader->getShared(
-            'EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomies'
-        );
-        $register_custom_taxonomies->registerCustomTaxonomies();
-        /** @var EventEspresso\core\domain\services\custom_post_types\RegisterCustomPostTypes $register_custom_post_types */
-        $register_custom_post_types = $this->loader->getShared(
-            'EventEspresso\core\domain\services\custom_post_types\RegisterCustomPostTypes'
-        );
-        $register_custom_post_types->registerCustomPostTypes();
-        /** @var EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomyTerms $register_custom_taxonomy_terms */
-        $register_custom_taxonomy_terms = $this->loader->getShared(
-            'EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomyTerms'
-        );
-        $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();
-        // integrate WP_Query with the EE models
-        $this->loader->getShared('EE_CPT_Strategy');
-        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');
-    }
-
-
-    /**
-     * 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()
-    {
-        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();
-        $this->router->initializeLast();
-        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;
+
+
+	/**
+	 * @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 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');
+	}
+
+
+	/**
+	 * 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 = __(
+				'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 .= __(
+				'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) {
+						unset($_GET['activate']);
+						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');
+		/** @var EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomies $register_custom_taxonomies */
+		$register_custom_taxonomies = $this->loader->getShared(
+			'EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomies'
+		);
+		$register_custom_taxonomies->registerCustomTaxonomies();
+		/** @var EventEspresso\core\domain\services\custom_post_types\RegisterCustomPostTypes $register_custom_post_types */
+		$register_custom_post_types = $this->loader->getShared(
+			'EventEspresso\core\domain\services\custom_post_types\RegisterCustomPostTypes'
+		);
+		$register_custom_post_types->registerCustomPostTypes();
+		/** @var EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomyTerms $register_custom_taxonomy_terms */
+		$register_custom_taxonomy_terms = $this->loader->getShared(
+			'EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomyTerms'
+		);
+		$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();
+		// integrate WP_Query with the EE models
+		$this->loader->getShared('EE_CPT_Strategy');
+		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');
+	}
+
+
+	/**
+	 * 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()
+	{
+		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();
+		$this->router->initializeLast();
+		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());
+	}
 }

core/EE_Addon.core.php

Indentation +856 added lines, -856 removed lines

@@ -19,807 +19,807 @@ 
 {
 
 
-    /**
-     * prefix to be added onto an addon's plugin slug to make a wp option name
-     * which will be used to store the plugin's activation history
-     */
-    const ee_addon_version_history_option_prefix = 'ee_version_history_';
-
-    /**
-     * @var $_version
-     * @type string
-     */
-    protected $_version = '';
-
-    /**
-     * @var $_min_core_version
-     * @type string
-     */
-    protected $_min_core_version = '';
-
-    /**
-     * derived from plugin 'main_file_path using plugin_basename()
-     *
-     * @type string $_plugin_basename
-     */
-    protected $_plugin_basename = '';
-
-    /**
-     * A non-internationalized name to identify this addon for use in URLs, etc
-     *
-     * @type string $_plugin_slug
-     */
-    protected $_plugin_slug = '';
-
-    /**
-     * A non-internationalized name to identify this addon. Eg 'Calendar','MailChimp',etc/
-     *
-     * @type string _addon_name
-     */
-    protected $_addon_name = '';
-
-    /**
-     * one of the EE_System::req_type_* constants
-     *
-     * @type int $_req_type
-     */
-    protected $_req_type;
-
-    /**
-     * page slug to be used when generating the "Settings" link on the WP plugin page
-     *
-     * @type string $_plugin_action_slug
-     */
-    protected $_plugin_action_slug = '';
-
-    /**
-     * if not empty, inserts a new table row after this plugin's row on the WP Plugins page
-     * that can be used for adding upgrading/marketing info
-     *
-     * @type array $_plugins_page_row
-     */
-    protected $_plugins_page_row = [];
-
-
-    /**
-     *    filepath to the main file, which can be used for register_activation_hook, register_deactivation_hook, etc.
-     *
-     * @type string
-     */
-    protected $_main_plugin_file;
-
-    /**
-     *    This is the slug used to identify this add-on within the plugin update engine.
-     *
-     * @type string
-     */
-    protected $pue_slug = '';
-
-
-    /**
-     * @var EE_Dependency_Map $dependency_map
-     */
-    private $dependency_map;
-
-
-    /**
-     * @var DomainInterface $domain
-     */
-    private $domain;
-
-
-    /**
-     * @param EE_Dependency_Map|null $dependency_map [optional]
-     * @param DomainInterface|null   $domain         [optional]
-     */
-    public function __construct(EE_Dependency_Map $dependency_map = null, DomainInterface $domain = null)
-    {
-        if ($dependency_map instanceof EE_Dependency_Map) {
-            $this->setDependencyMap($dependency_map);
-        }
-        if ($domain instanceof DomainInterface) {
-            $this->setDomain($domain);
-        }
-        add_action('AHEE__EE_System__load_controllers__load_admin_controllers', [$this, 'admin_init']);
-    }
-
-
-    /**
-     * @param EE_Dependency_Map $dependency_map
-     */
-    public function setDependencyMap($dependency_map)
-    {
-        $this->dependency_map = $dependency_map;
-    }
-
-
-    /**
-     * @return EE_Dependency_Map
-     */
-    public function dependencyMap(): ?EE_Dependency_Map
-    {
-        return $this->dependency_map;
-    }
-
-
-    /**
-     * @param DomainInterface $domain
-     */
-    public function setDomain(DomainInterface $domain)
-    {
-        $this->domain = $domain;
-    }
-
-
-    /**
-     * @return DomainInterface
-     */
-    public function domain(): ?DomainInterface
-    {
-        return $this->domain;
-    }
-
-
-    /**
-     * @param string $version
-     */
-    public function set_version(string $version = '')
-    {
-        $this->_version = $version;
-    }
-
-
-    /**
-     * get__version
-     *
-     * @return string
-     */
-    public function version(): string
-    {
-        return $this->_version;
-    }
-
-
-    /**
-     * @param mixed $min_core_version
-     */
-    public function set_min_core_version($min_core_version = null)
-    {
-        $this->_min_core_version = $min_core_version;
-    }
-
-
-    /**
-     * get__min_core_version
-     *
-     * @return string
-     */
-    public function min_core_version(): string
-    {
-        return $this->_min_core_version;
-    }
-
-
-    /**
-     * Sets addon_name
-     *
-     * @param string $addon_name
-     */
-    public function set_name(string $addon_name)
-    {
-        $this->_addon_name = $addon_name;
-    }
-
-
-    /**
-     * Gets addon_name
-     *
-     * @return string
-     */
-    public function name()
-    {
-        return $this->_addon_name;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function plugin_basename(): string
-    {
-
-        return $this->_plugin_basename;
-    }
-
-
-    /**
-     * @param string $plugin_basename
-     */
-    public function set_plugin_basename(string $plugin_basename)
-    {
-
-        $this->_plugin_basename = $plugin_basename;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function plugin_slug(): string
-    {
-
-        return $this->_plugin_slug;
-    }
-
-
-    /**
-     * @param string $plugin_slug
-     */
-    public function set_plugin_slug(string $plugin_slug)
-    {
-
-        $this->_plugin_slug = $plugin_slug;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function plugin_action_slug(): string
-    {
-
-        return $this->_plugin_action_slug;
-    }
-
-
-    /**
-     * @param string $plugin_action_slug
-     */
-    public function set_plugin_action_slug(string $plugin_action_slug)
-    {
-
-        $this->_plugin_action_slug = $plugin_action_slug;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function get_plugins_page_row(): array
-    {
-
-        return $this->_plugins_page_row;
-    }
-
-
-    /**
-     * @param array|string $plugins_page_row
-     */
-    public function set_plugins_page_row(array $plugins_page_row = [])
-    {
-        // sigh.... check for example content that I stupidly merged to master and remove it if found
-        if (
-            ! is_array($plugins_page_row)
-            && strpos($plugins_page_row, '<h3>Promotions Addon Upsell Info</h3>') !== false
-        ) {
-            $plugins_page_row = [];
-        }
-        $this->_plugins_page_row = (array) $plugins_page_row;
-    }
-
-
-    /**
-     * Called when EE core detects this addon has been activated for the first time.
-     * If the site isn't in maintenance mode, should setup the addon's database
-     *
-     * @return void
-     */
-    public function new_install()
-    {
-        $classname = get_class($this);
-        do_action("AHEE__{$classname}__new_install");
-        do_action('AHEE__EE_Addon__new_install', $this);
-        EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
-        add_action(
-            'AHEE__EE_System__perform_activations_upgrades_and_migrations',
-            [$this, 'initialize_db_if_no_migrations_required']
-        );
-    }
-
-
-    /**
-     * Called when EE core detects this addon has been reactivated. When this happens,
-     * it's good to just check that your data is still intact
-     *
-     * @return void
-     */
-    public function reactivation()
-    {
-        $classname = get_class($this);
-        do_action("AHEE__{$classname}__reactivation");
-        do_action('AHEE__EE_Addon__reactivation', $this);
-        EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
-        add_action(
-            'AHEE__EE_System__perform_activations_upgrades_and_migrations',
-            [$this, 'initialize_db_if_no_migrations_required']
-        );
-    }
-
-
-    /**
-     * Called when the registered deactivation hook for this addon fires.
-     *
-     * @throws EE_Error
-     */
-    public function deactivation()
-    {
-        $classname = get_class($this);
-        do_action("AHEE__{$classname}__deactivation");
-        do_action('AHEE__EE_Addon__deactivation', $this);
-        // check if the site no longer needs to be in maintenance mode
-        EE_Register_Addon::deregister($this->name());
-        EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
-    }
-
-
-    /**
-     * Takes care of double-checking that we're not in maintenance mode, and then
-     * initializing this addon's necessary initial data. This is called by default on new activations
-     * and reactivations.
-     *
-     * @param boolean $verify_schema whether to verify the database's schema for this addon, or just its data.
-     *                               This is a resource-intensive job so we prefer to only do it when necessary
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     */
-    public function initialize_db_if_no_migrations_required($verify_schema = true)
-    {
-        if ($verify_schema === '') {
-            // wp core bug imo: if no args are passed to `do_action('some_hook_name')` besides the hook's name
-            // (ie, no 2nd or 3rd arguments), instead of calling the registered callbacks with no arguments, it
-            // calls them with an argument of an empty string (ie ""), which evaluates to false
-            // so we need to treat the empty string as if nothing had been passed, and should instead use the default
-            $verify_schema = true;
-        }
-        if (EE_Maintenance_Mode::instance()->level() !== EE_Maintenance_Mode::level_2_complete_maintenance) {
-            if ($verify_schema) {
-                $this->initialize_db();
-            }
-            $this->initialize_default_data();
-            // @todo: this will probably need to be adjusted in 4.4 as the array changed formats I believe
-            EE_Data_Migration_Manager::instance()->update_current_database_state_to(
-                [
-                    'slug'    => $this->name(),
-                    'version' => $this->version(),
-                ]
-            );
-            /* make sure core's data is a-ok
+	/**
+	 * prefix to be added onto an addon's plugin slug to make a wp option name
+	 * which will be used to store the plugin's activation history
+	 */
+	const ee_addon_version_history_option_prefix = 'ee_version_history_';
+
+	/**
+	 * @var $_version
+	 * @type string
+	 */
+	protected $_version = '';
+
+	/**
+	 * @var $_min_core_version
+	 * @type string
+	 */
+	protected $_min_core_version = '';
+
+	/**
+	 * derived from plugin 'main_file_path using plugin_basename()
+	 *
+	 * @type string $_plugin_basename
+	 */
+	protected $_plugin_basename = '';
+
+	/**
+	 * A non-internationalized name to identify this addon for use in URLs, etc
+	 *
+	 * @type string $_plugin_slug
+	 */
+	protected $_plugin_slug = '';
+
+	/**
+	 * A non-internationalized name to identify this addon. Eg 'Calendar','MailChimp',etc/
+	 *
+	 * @type string _addon_name
+	 */
+	protected $_addon_name = '';
+
+	/**
+	 * one of the EE_System::req_type_* constants
+	 *
+	 * @type int $_req_type
+	 */
+	protected $_req_type;
+
+	/**
+	 * page slug to be used when generating the "Settings" link on the WP plugin page
+	 *
+	 * @type string $_plugin_action_slug
+	 */
+	protected $_plugin_action_slug = '';
+
+	/**
+	 * if not empty, inserts a new table row after this plugin's row on the WP Plugins page
+	 * that can be used for adding upgrading/marketing info
+	 *
+	 * @type array $_plugins_page_row
+	 */
+	protected $_plugins_page_row = [];
+
+
+	/**
+	 *    filepath to the main file, which can be used for register_activation_hook, register_deactivation_hook, etc.
+	 *
+	 * @type string
+	 */
+	protected $_main_plugin_file;
+
+	/**
+	 *    This is the slug used to identify this add-on within the plugin update engine.
+	 *
+	 * @type string
+	 */
+	protected $pue_slug = '';
+
+
+	/**
+	 * @var EE_Dependency_Map $dependency_map
+	 */
+	private $dependency_map;
+
+
+	/**
+	 * @var DomainInterface $domain
+	 */
+	private $domain;
+
+
+	/**
+	 * @param EE_Dependency_Map|null $dependency_map [optional]
+	 * @param DomainInterface|null   $domain         [optional]
+	 */
+	public function __construct(EE_Dependency_Map $dependency_map = null, DomainInterface $domain = null)
+	{
+		if ($dependency_map instanceof EE_Dependency_Map) {
+			$this->setDependencyMap($dependency_map);
+		}
+		if ($domain instanceof DomainInterface) {
+			$this->setDomain($domain);
+		}
+		add_action('AHEE__EE_System__load_controllers__load_admin_controllers', [$this, 'admin_init']);
+	}
+
+
+	/**
+	 * @param EE_Dependency_Map $dependency_map
+	 */
+	public function setDependencyMap($dependency_map)
+	{
+		$this->dependency_map = $dependency_map;
+	}
+
+
+	/**
+	 * @return EE_Dependency_Map
+	 */
+	public function dependencyMap(): ?EE_Dependency_Map
+	{
+		return $this->dependency_map;
+	}
+
+
+	/**
+	 * @param DomainInterface $domain
+	 */
+	public function setDomain(DomainInterface $domain)
+	{
+		$this->domain = $domain;
+	}
+
+
+	/**
+	 * @return DomainInterface
+	 */
+	public function domain(): ?DomainInterface
+	{
+		return $this->domain;
+	}
+
+
+	/**
+	 * @param string $version
+	 */
+	public function set_version(string $version = '')
+	{
+		$this->_version = $version;
+	}
+
+
+	/**
+	 * get__version
+	 *
+	 * @return string
+	 */
+	public function version(): string
+	{
+		return $this->_version;
+	}
+
+
+	/**
+	 * @param mixed $min_core_version
+	 */
+	public function set_min_core_version($min_core_version = null)
+	{
+		$this->_min_core_version = $min_core_version;
+	}
+
+
+	/**
+	 * get__min_core_version
+	 *
+	 * @return string
+	 */
+	public function min_core_version(): string
+	{
+		return $this->_min_core_version;
+	}
+
+
+	/**
+	 * Sets addon_name
+	 *
+	 * @param string $addon_name
+	 */
+	public function set_name(string $addon_name)
+	{
+		$this->_addon_name = $addon_name;
+	}
+
+
+	/**
+	 * Gets addon_name
+	 *
+	 * @return string
+	 */
+	public function name()
+	{
+		return $this->_addon_name;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function plugin_basename(): string
+	{
+
+		return $this->_plugin_basename;
+	}
+
+
+	/**
+	 * @param string $plugin_basename
+	 */
+	public function set_plugin_basename(string $plugin_basename)
+	{
+
+		$this->_plugin_basename = $plugin_basename;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function plugin_slug(): string
+	{
+
+		return $this->_plugin_slug;
+	}
+
+
+	/**
+	 * @param string $plugin_slug
+	 */
+	public function set_plugin_slug(string $plugin_slug)
+	{
+
+		$this->_plugin_slug = $plugin_slug;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function plugin_action_slug(): string
+	{
+
+		return $this->_plugin_action_slug;
+	}
+
+
+	/**
+	 * @param string $plugin_action_slug
+	 */
+	public function set_plugin_action_slug(string $plugin_action_slug)
+	{
+
+		$this->_plugin_action_slug = $plugin_action_slug;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function get_plugins_page_row(): array
+	{
+
+		return $this->_plugins_page_row;
+	}
+
+
+	/**
+	 * @param array|string $plugins_page_row
+	 */
+	public function set_plugins_page_row(array $plugins_page_row = [])
+	{
+		// sigh.... check for example content that I stupidly merged to master and remove it if found
+		if (
+			! is_array($plugins_page_row)
+			&& strpos($plugins_page_row, '<h3>Promotions Addon Upsell Info</h3>') !== false
+		) {
+			$plugins_page_row = [];
+		}
+		$this->_plugins_page_row = (array) $plugins_page_row;
+	}
+
+
+	/**
+	 * Called when EE core detects this addon has been activated for the first time.
+	 * If the site isn't in maintenance mode, should setup the addon's database
+	 *
+	 * @return void
+	 */
+	public function new_install()
+	{
+		$classname = get_class($this);
+		do_action("AHEE__{$classname}__new_install");
+		do_action('AHEE__EE_Addon__new_install', $this);
+		EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
+		add_action(
+			'AHEE__EE_System__perform_activations_upgrades_and_migrations',
+			[$this, 'initialize_db_if_no_migrations_required']
+		);
+	}
+
+
+	/**
+	 * Called when EE core detects this addon has been reactivated. When this happens,
+	 * it's good to just check that your data is still intact
+	 *
+	 * @return void
+	 */
+	public function reactivation()
+	{
+		$classname = get_class($this);
+		do_action("AHEE__{$classname}__reactivation");
+		do_action('AHEE__EE_Addon__reactivation', $this);
+		EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
+		add_action(
+			'AHEE__EE_System__perform_activations_upgrades_and_migrations',
+			[$this, 'initialize_db_if_no_migrations_required']
+		);
+	}
+
+
+	/**
+	 * Called when the registered deactivation hook for this addon fires.
+	 *
+	 * @throws EE_Error
+	 */
+	public function deactivation()
+	{
+		$classname = get_class($this);
+		do_action("AHEE__{$classname}__deactivation");
+		do_action('AHEE__EE_Addon__deactivation', $this);
+		// check if the site no longer needs to be in maintenance mode
+		EE_Register_Addon::deregister($this->name());
+		EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
+	}
+
+
+	/**
+	 * Takes care of double-checking that we're not in maintenance mode, and then
+	 * initializing this addon's necessary initial data. This is called by default on new activations
+	 * and reactivations.
+	 *
+	 * @param boolean $verify_schema whether to verify the database's schema for this addon, or just its data.
+	 *                               This is a resource-intensive job so we prefer to only do it when necessary
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 */
+	public function initialize_db_if_no_migrations_required($verify_schema = true)
+	{
+		if ($verify_schema === '') {
+			// wp core bug imo: if no args are passed to `do_action('some_hook_name')` besides the hook's name
+			// (ie, no 2nd or 3rd arguments), instead of calling the registered callbacks with no arguments, it
+			// calls them with an argument of an empty string (ie ""), which evaluates to false
+			// so we need to treat the empty string as if nothing had been passed, and should instead use the default
+			$verify_schema = true;
+		}
+		if (EE_Maintenance_Mode::instance()->level() !== EE_Maintenance_Mode::level_2_complete_maintenance) {
+			if ($verify_schema) {
+				$this->initialize_db();
+			}
+			$this->initialize_default_data();
+			// @todo: this will probably need to be adjusted in 4.4 as the array changed formats I believe
+			EE_Data_Migration_Manager::instance()->update_current_database_state_to(
+				[
+					'slug'    => $this->name(),
+					'version' => $this->version(),
+				]
+			);
+			/* make sure core's data is a-ok
              * (at the time of writing, we especially want to verify all the caps are present
              * because payment method type capabilities are added dynamically, and it's
              * possible this addon added a payment method. But it's also possible
              * other data needs to be verified)
              */
-            EEH_Activation::initialize_db_content();
-            /** @var EventEspresso\core\domain\services\custom_post_types\RewriteRules $rewrite_rules */
-            $rewrite_rules = LoaderFactory::getLoader()->getShared(
-                'EventEspresso\core\domain\services\custom_post_types\RewriteRules'
-            );
-            $rewrite_rules->flushRewriteRules();
-            // in case there are lots of addons being activated at once, let's force garbage collection
-            // to help avoid memory limit errors
-            // EEH_Debug_Tools::instance()->measure_memory( 'db content initialized for ' . get_class( $this), true );
-            gc_collect_cycles();
-        } else {
-            // ask the data migration manager to init this addon's data
-            // when migrations are finished because we can't do it now
-            EE_Data_Migration_Manager::instance()->enqueue_db_initialization_for($this->name());
-        }
-    }
-
-
-    /**
-     * Used to setup this addon's database tables, but not necessarily any default
-     * data in them. The default is to actually use the most up-to-date data migration script
-     * for this addon, and just use its schema_changes_before_migration() and schema_changes_after_migration()
-     * methods to setup the db.
-     *
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function initialize_db()
-    {
-        // find the migration script that sets the database to be compatible with the code
-        $current_dms_name = EE_Data_Migration_Manager::instance()->get_most_up_to_date_dms($this->name());
-        if ($current_dms_name) {
-            $current_data_migration_script = EE_Registry::instance()->load_dms($current_dms_name);
-            $current_data_migration_script->set_migrating(false);
-            $current_data_migration_script->schema_changes_before_migration();
-            $current_data_migration_script->schema_changes_after_migration();
-            if ($current_data_migration_script->get_errors()) {
-                foreach ($current_data_migration_script->get_errors() as $error) {
-                    EE_Error::add_error($error, __FILE__, __FUNCTION__, __LINE__);
-                }
-            }
-        }
-        // if not DMS was found that should be ok. This addon just doesn't require any database changes
-        EE_Data_Migration_Manager::instance()->update_current_database_state_to(
-            [
-                'slug'    => $this->name(),
-                'version' => $this->version(),
-            ]
-        );
-    }
-
-
-    /**
-     * If you want to setup default data for the addon, override this method, and call
-     * parent::initialize_default_data() from within it. This is normally called
-     * from EE_Addon::initialize_db_if_no_migrations_required(), just after EE_Addon::initialize_db()
-     * and should verify default data is present (but this is also called
-     * on reactivations and just after migrations, so please verify you actually want
-     * to ADD default data, because it may already be present).
-     * However, please call this parent (currently it just fires a hook which other
-     * addons may be depending on)
-     */
-    public function initialize_default_data()
-    {
-        /**
-         * Called when an addon is ensuring its default data is set (possibly called
-         * on a reactivation, so first check for the absence of other data before setting
-         * default data)
-         *
-         * @param EE_Addon $addon the addon that called this
-         */
-        do_action('AHEE__EE_Addon__initialize_default_data__begin', $this);
-        // override to insert default data. It is safe to use the models here
-        // because the site should not be in maintenance mode
-    }
-
-
-    /**
-     * EE Core detected that this addon has been upgraded. We should check if there
-     * are any new migration scripts, and if so put the site into maintenance mode until
-     * they're ran
-     *
-     * @return void
-     */
-    public function upgrade()
-    {
-        $classname = get_class($this);
-        do_action("AHEE__{$classname}__upgrade");
-        do_action('AHEE__EE_Addon__upgrade', $this);
-        EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
-        // also it's possible there is new default data that needs to be added
-        add_action(
-            'AHEE__EE_System__perform_activations_upgrades_and_migrations',
-            [$this, 'initialize_db_if_no_migrations_required']
-        );
-    }
-
-
-    /**
-     * If Core detects this addon has been downgraded, you may want to invoke some special logic here.
-     */
-    public function downgrade()
-    {
-        $classname = get_class($this);
-        do_action("AHEE__{$classname}__downgrade");
-        do_action('AHEE__EE_Addon__downgrade', $this);
-        // it's possible there's old default data that needs to be double-checked
-        add_action(
-            'AHEE__EE_System__perform_activations_upgrades_and_migrations',
-            [$this, 'initialize_db_if_no_migrations_required']
-        );
-    }
-
-
-    /**
-     * set_db_update_option_name
-     * Until we do something better, we'll just check for migration scripts upon
-     * plugin activation only. In the future, we'll want to do it on plugin updates too
-     *
-     * @return bool
-     */
-    public function set_db_update_option_name(): bool
-    {
-        EE_Error::doing_it_wrong(
-            __FUNCTION__,
-            esc_html__(
-                'EE_Addon::set_db_update_option_name was renamed to EE_Addon::set_activation_indicator_option',
-                'event_espresso'
-            ),
-            '4.3.0.alpha.016'
-        );
-        // let's just handle this on the next request, ok? right now we're just not really ready
-        return $this->set_activation_indicator_option();
-    }
-
-
-    /**
-     * Returns the name of the activation indicator option
-     * (an option which is set temporarily to indicate that this addon was just activated)
-     *
-     * @return string
-     * @deprecated since version 4.3.0.alpha.016
-     */
-    public function get_db_update_option_name(): string
-    {
-        EE_Error::doing_it_wrong(
-            __FUNCTION__,
-            esc_html__(
-                'EE_Addon::get_db_update_option was renamed to EE_Addon::get_activation_indicator_option_name',
-                'event_espresso'
-            ),
-            '4.3.0.alpha.016'
-        );
-        return $this->get_activation_indicator_option_name();
-    }
-
-
-    /**
-     * When the addon is activated, this should be called to set a wordpress option that
-     * indicates it was activated. This is especially useful for detecting reactivations.
-     *
-     * @return bool
-     */
-    public function set_activation_indicator_option(): bool
-    {
-        // let's just handle this on the next request, ok? right now we're just not really ready
-        return update_option($this->get_activation_indicator_option_name(), true);
-    }
-
-
-    /**
-     * Gets the name of the wp option which is used to temporarily indicate that this addon was activated
-     *
-     * @return string
-     */
-    public function get_activation_indicator_option_name(): string
-    {
-        return 'ee_activation_' . $this->name();
-    }
-
-
-    /**
-     * Used by EE_System to set the request type of this addon. Should not be used by addon developers
-     *
-     * @param int $req_type
-     */
-    public function set_req_type(int $req_type)
-    {
-        $this->_req_type = $req_type;
-    }
-
-
-    /**
-     * Returns the request type of this addon (ie, EE_System::req_type_normal, EE_System::req_type_new_activation,
-     * EE_System::req_type_reactivation, EE_System::req_type_upgrade, or EE_System::req_type_downgrade). This is set by
-     * EE_System when it is checking for new install or upgrades of addons
-     */
-    public function detect_req_type($redetect = false): int
-    {
-        if ($this->_req_type === null || $redetect) {
-            $this->detect_activation_or_upgrade();
-        }
-        return $this->_req_type;
-    }
-
-
-    /**
-     * Detects the request type for this addon (whether it was just activated, upgrades, a normal request, etc.)
-     * Should only be called once per request
-     *
-     * @return void
-     */
-    public function detect_activation_or_upgrade()
-    {
-        $activation_history_for_addon = $this->get_activation_history();
-        $request_type                 = EE_System::detect_req_type_given_activation_history(
-            $activation_history_for_addon,
-            $this->get_activation_indicator_option_name(),
-            $this->version()
-        );
-        $this->set_req_type($request_type);
-        $classname = get_class($this);
-        switch ($request_type) {
-            case EE_System::req_type_new_activation:
-                do_action("AHEE__{$classname}__detect_activations_or_upgrades__new_activation");
-                do_action('AHEE__EE_Addon__detect_activations_or_upgrades__new_activation', $this);
-                $this->new_install();
-                $this->update_list_of_installed_versions($activation_history_for_addon);
-                break;
-            case EE_System::req_type_reactivation:
-                do_action("AHEE__{$classname}__detect_activations_or_upgrades__reactivation");
-                do_action('AHEE__EE_Addon__detect_activations_or_upgrades__reactivation', $this);
-                $this->reactivation();
-                $this->update_list_of_installed_versions($activation_history_for_addon);
-                break;
-            case EE_System::req_type_upgrade:
-                do_action("AHEE__{$classname}__detect_activations_or_upgrades__upgrade");
-                do_action('AHEE__EE_Addon__detect_activations_or_upgrades__upgrade', $this);
-                $this->upgrade();
-                $this->update_list_of_installed_versions($activation_history_for_addon);
-                break;
-            case EE_System::req_type_downgrade:
-                do_action("AHEE__{$classname}__detect_activations_or_upgrades__downgrade");
-                do_action('AHEE__EE_Addon__detect_activations_or_upgrades__downgrade', $this);
-                $this->downgrade();
-                $this->update_list_of_installed_versions($activation_history_for_addon);
-                break;
-            case EE_System::req_type_normal:
-            default:
-                break;
-        }
-
-        do_action("AHEE__{$classname}__detect_if_activation_or_upgrade__complete");
-    }
-
-
-    /**
-     * Updates the version history for this addon
-     *
-     * @param array  $version_history
-     * @param string $current_version_to_add
-     * @return boolean success
-     */
-    public function update_list_of_installed_versions($version_history = null, $current_version_to_add = null): bool
-    {
-        if (! $version_history) {
-            $version_history = $this->get_activation_history();
-        }
-        if ($current_version_to_add === null) {
-            $current_version_to_add = $this->version();
-        }
-        $version_history[ $current_version_to_add ][] = date('Y-m-d H:i:s', time());
-        return update_option($this->get_activation_history_option_name(), $version_history);
-    }
-
-
-    /**
-     * Gets the name of the wp option that stores the activation history
-     * of this addon
-     *
-     * @return string
-     */
-    public function get_activation_history_option_name(): string
-    {
-        return self::ee_addon_version_history_option_prefix . $this->name();
-    }
-
-
-    /**
-     * Gets the wp option which stores the activation history for this addon
-     *
-     * @return array
-     */
-    public function get_activation_history(): array
-    {
-        return get_option($this->get_activation_history_option_name(), []);
-    }
-
-
-    /**
-     * @param string $config_section
-     */
-    public function set_config_section($config_section = '')
-    {
-        $this->_config_section = ! empty($config_section) ? $config_section : 'addons';
-    }
-
-
-    /**
-     * Sets the filepath to the main plugin file
-     *
-     * @param string $filepath
-     */
-    public function set_main_plugin_file(string $filepath)
-    {
-        $this->_main_plugin_file = $filepath;
-    }
-
-
-    /**
-     * gets the filepath to teh main file
-     *
-     * @return string
-     */
-    public function get_main_plugin_file(): string
-    {
-        return $this->_main_plugin_file;
-    }
-
-
-    /**
-     * Gets the filename (no path) of the main file (the main file loaded
-     * by WP)
-     *
-     * @return string
-     */
-    public function get_main_plugin_file_basename(): string
-    {
-        return plugin_basename($this->get_main_plugin_file());
-    }
-
-
-    /**
-     * Gets the folder name which contains the main plugin file
-     *
-     * @return string
-     */
-    public function get_main_plugin_file_dirname(): string
-    {
-        return dirname($this->get_main_plugin_file());
-    }
-
-
-    /**
-     * sets hooks used in the admin
-     *
-     * @return void
-     */
-    public function admin_init()
-    {
-        // is admin and not in M-Mode ?
-        if (is_admin() && ! EE_Maintenance_Mode::instance()->level()) {
-            add_filter('plugin_action_links', [$this, 'plugin_action_links'], 10, 2);
-            add_filter('after_plugin_row_' . $this->_plugin_basename, [$this, 'after_plugin_row'], 10, 3);
-        }
-    }
-
-
-    /**
-     * plugin_actions
-     * Add a settings link to the Plugins page, so people can go straight from the plugin page to the settings page.
-     *
-     * @param array  $links
-     * @param string $file
-     * @return array
-     */
-    public function plugin_action_links(array $links, string $file): array
-    {
-        if ($file === $this->plugin_basename() && $this->plugin_action_slug() !== '') {
-            // before other links
-            array_unshift(
-                $links,
-                '<a href="admin.php?page=' . $this->plugin_action_slug() . '">'
-                . esc_html__('Settings', 'event_espresso')
-                . '</a>'
-            );
-        }
-        return $links;
-    }
-
-
-    /**
-     * after_plugin_row
-     * Add additional content to the plugins page plugin row
-     * Inserts another row
-     *
-     * @param string $plugin_file
-     * @param array  $plugin_data
-     * @param string $status
-     * @return void
-     */
-    public function after_plugin_row(string $plugin_file, array $plugin_data, string $status)
-    {
-        $after_plugin_row = '';
-        $plugins_page_row = $this->get_plugins_page_row();
-        if (! empty($plugins_page_row) && $plugin_file === $this->plugin_basename()) {
-            $class       = $status ? 'active' : 'inactive';
-            $link_text   = isset($plugins_page_row['link_text']) ? $plugins_page_row['link_text'] : '';
-            $link_url    = isset($plugins_page_row['link_url']) ? $plugins_page_row['link_url'] : '';
-            $description = isset($plugins_page_row['description'])
-                ? $plugins_page_row['description']
-                : '';
-            if (! empty($link_text) && ! empty($link_url) && ! empty($description)) {
-                $after_plugin_row .= '<tr id="' . sanitize_title($plugin_file) . '-ee-addon" class="' . $class . '">';
-                $after_plugin_row .= '<th class="check-column" scope="row"></th>';
-                $after_plugin_row .= '<td class="ee-addon-upsell-info-title-td plugin-title column-primary">';
-                $after_plugin_row .= '<style>
+			EEH_Activation::initialize_db_content();
+			/** @var EventEspresso\core\domain\services\custom_post_types\RewriteRules $rewrite_rules */
+			$rewrite_rules = LoaderFactory::getLoader()->getShared(
+				'EventEspresso\core\domain\services\custom_post_types\RewriteRules'
+			);
+			$rewrite_rules->flushRewriteRules();
+			// in case there are lots of addons being activated at once, let's force garbage collection
+			// to help avoid memory limit errors
+			// EEH_Debug_Tools::instance()->measure_memory( 'db content initialized for ' . get_class( $this), true );
+			gc_collect_cycles();
+		} else {
+			// ask the data migration manager to init this addon's data
+			// when migrations are finished because we can't do it now
+			EE_Data_Migration_Manager::instance()->enqueue_db_initialization_for($this->name());
+		}
+	}
+
+
+	/**
+	 * Used to setup this addon's database tables, but not necessarily any default
+	 * data in them. The default is to actually use the most up-to-date data migration script
+	 * for this addon, and just use its schema_changes_before_migration() and schema_changes_after_migration()
+	 * methods to setup the db.
+	 *
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function initialize_db()
+	{
+		// find the migration script that sets the database to be compatible with the code
+		$current_dms_name = EE_Data_Migration_Manager::instance()->get_most_up_to_date_dms($this->name());
+		if ($current_dms_name) {
+			$current_data_migration_script = EE_Registry::instance()->load_dms($current_dms_name);
+			$current_data_migration_script->set_migrating(false);
+			$current_data_migration_script->schema_changes_before_migration();
+			$current_data_migration_script->schema_changes_after_migration();
+			if ($current_data_migration_script->get_errors()) {
+				foreach ($current_data_migration_script->get_errors() as $error) {
+					EE_Error::add_error($error, __FILE__, __FUNCTION__, __LINE__);
+				}
+			}
+		}
+		// if not DMS was found that should be ok. This addon just doesn't require any database changes
+		EE_Data_Migration_Manager::instance()->update_current_database_state_to(
+			[
+				'slug'    => $this->name(),
+				'version' => $this->version(),
+			]
+		);
+	}
+
+
+	/**
+	 * If you want to setup default data for the addon, override this method, and call
+	 * parent::initialize_default_data() from within it. This is normally called
+	 * from EE_Addon::initialize_db_if_no_migrations_required(), just after EE_Addon::initialize_db()
+	 * and should verify default data is present (but this is also called
+	 * on reactivations and just after migrations, so please verify you actually want
+	 * to ADD default data, because it may already be present).
+	 * However, please call this parent (currently it just fires a hook which other
+	 * addons may be depending on)
+	 */
+	public function initialize_default_data()
+	{
+		/**
+		 * Called when an addon is ensuring its default data is set (possibly called
+		 * on a reactivation, so first check for the absence of other data before setting
+		 * default data)
+		 *
+		 * @param EE_Addon $addon the addon that called this
+		 */
+		do_action('AHEE__EE_Addon__initialize_default_data__begin', $this);
+		// override to insert default data. It is safe to use the models here
+		// because the site should not be in maintenance mode
+	}
+
+
+	/**
+	 * EE Core detected that this addon has been upgraded. We should check if there
+	 * are any new migration scripts, and if so put the site into maintenance mode until
+	 * they're ran
+	 *
+	 * @return void
+	 */
+	public function upgrade()
+	{
+		$classname = get_class($this);
+		do_action("AHEE__{$classname}__upgrade");
+		do_action('AHEE__EE_Addon__upgrade', $this);
+		EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
+		// also it's possible there is new default data that needs to be added
+		add_action(
+			'AHEE__EE_System__perform_activations_upgrades_and_migrations',
+			[$this, 'initialize_db_if_no_migrations_required']
+		);
+	}
+
+
+	/**
+	 * If Core detects this addon has been downgraded, you may want to invoke some special logic here.
+	 */
+	public function downgrade()
+	{
+		$classname = get_class($this);
+		do_action("AHEE__{$classname}__downgrade");
+		do_action('AHEE__EE_Addon__downgrade', $this);
+		// it's possible there's old default data that needs to be double-checked
+		add_action(
+			'AHEE__EE_System__perform_activations_upgrades_and_migrations',
+			[$this, 'initialize_db_if_no_migrations_required']
+		);
+	}
+
+
+	/**
+	 * set_db_update_option_name
+	 * Until we do something better, we'll just check for migration scripts upon
+	 * plugin activation only. In the future, we'll want to do it on plugin updates too
+	 *
+	 * @return bool
+	 */
+	public function set_db_update_option_name(): bool
+	{
+		EE_Error::doing_it_wrong(
+			__FUNCTION__,
+			esc_html__(
+				'EE_Addon::set_db_update_option_name was renamed to EE_Addon::set_activation_indicator_option',
+				'event_espresso'
+			),
+			'4.3.0.alpha.016'
+		);
+		// let's just handle this on the next request, ok? right now we're just not really ready
+		return $this->set_activation_indicator_option();
+	}
+
+
+	/**
+	 * Returns the name of the activation indicator option
+	 * (an option which is set temporarily to indicate that this addon was just activated)
+	 *
+	 * @return string
+	 * @deprecated since version 4.3.0.alpha.016
+	 */
+	public function get_db_update_option_name(): string
+	{
+		EE_Error::doing_it_wrong(
+			__FUNCTION__,
+			esc_html__(
+				'EE_Addon::get_db_update_option was renamed to EE_Addon::get_activation_indicator_option_name',
+				'event_espresso'
+			),
+			'4.3.0.alpha.016'
+		);
+		return $this->get_activation_indicator_option_name();
+	}
+
+
+	/**
+	 * When the addon is activated, this should be called to set a wordpress option that
+	 * indicates it was activated. This is especially useful for detecting reactivations.
+	 *
+	 * @return bool
+	 */
+	public function set_activation_indicator_option(): bool
+	{
+		// let's just handle this on the next request, ok? right now we're just not really ready
+		return update_option($this->get_activation_indicator_option_name(), true);
+	}
+
+
+	/**
+	 * Gets the name of the wp option which is used to temporarily indicate that this addon was activated
+	 *
+	 * @return string
+	 */
+	public function get_activation_indicator_option_name(): string
+	{
+		return 'ee_activation_' . $this->name();
+	}
+
+
+	/**
+	 * Used by EE_System to set the request type of this addon. Should not be used by addon developers
+	 *
+	 * @param int $req_type
+	 */
+	public function set_req_type(int $req_type)
+	{
+		$this->_req_type = $req_type;
+	}
+
+
+	/**
+	 * Returns the request type of this addon (ie, EE_System::req_type_normal, EE_System::req_type_new_activation,
+	 * EE_System::req_type_reactivation, EE_System::req_type_upgrade, or EE_System::req_type_downgrade). This is set by
+	 * EE_System when it is checking for new install or upgrades of addons
+	 */
+	public function detect_req_type($redetect = false): int
+	{
+		if ($this->_req_type === null || $redetect) {
+			$this->detect_activation_or_upgrade();
+		}
+		return $this->_req_type;
+	}
+
+
+	/**
+	 * Detects the request type for this addon (whether it was just activated, upgrades, a normal request, etc.)
+	 * Should only be called once per request
+	 *
+	 * @return void
+	 */
+	public function detect_activation_or_upgrade()
+	{
+		$activation_history_for_addon = $this->get_activation_history();
+		$request_type                 = EE_System::detect_req_type_given_activation_history(
+			$activation_history_for_addon,
+			$this->get_activation_indicator_option_name(),
+			$this->version()
+		);
+		$this->set_req_type($request_type);
+		$classname = get_class($this);
+		switch ($request_type) {
+			case EE_System::req_type_new_activation:
+				do_action("AHEE__{$classname}__detect_activations_or_upgrades__new_activation");
+				do_action('AHEE__EE_Addon__detect_activations_or_upgrades__new_activation', $this);
+				$this->new_install();
+				$this->update_list_of_installed_versions($activation_history_for_addon);
+				break;
+			case EE_System::req_type_reactivation:
+				do_action("AHEE__{$classname}__detect_activations_or_upgrades__reactivation");
+				do_action('AHEE__EE_Addon__detect_activations_or_upgrades__reactivation', $this);
+				$this->reactivation();
+				$this->update_list_of_installed_versions($activation_history_for_addon);
+				break;
+			case EE_System::req_type_upgrade:
+				do_action("AHEE__{$classname}__detect_activations_or_upgrades__upgrade");
+				do_action('AHEE__EE_Addon__detect_activations_or_upgrades__upgrade', $this);
+				$this->upgrade();
+				$this->update_list_of_installed_versions($activation_history_for_addon);
+				break;
+			case EE_System::req_type_downgrade:
+				do_action("AHEE__{$classname}__detect_activations_or_upgrades__downgrade");
+				do_action('AHEE__EE_Addon__detect_activations_or_upgrades__downgrade', $this);
+				$this->downgrade();
+				$this->update_list_of_installed_versions($activation_history_for_addon);
+				break;
+			case EE_System::req_type_normal:
+			default:
+				break;
+		}
+
+		do_action("AHEE__{$classname}__detect_if_activation_or_upgrade__complete");
+	}
+
+
+	/**
+	 * Updates the version history for this addon
+	 *
+	 * @param array  $version_history
+	 * @param string $current_version_to_add
+	 * @return boolean success
+	 */
+	public function update_list_of_installed_versions($version_history = null, $current_version_to_add = null): bool
+	{
+		if (! $version_history) {
+			$version_history = $this->get_activation_history();
+		}
+		if ($current_version_to_add === null) {
+			$current_version_to_add = $this->version();
+		}
+		$version_history[ $current_version_to_add ][] = date('Y-m-d H:i:s', time());
+		return update_option($this->get_activation_history_option_name(), $version_history);
+	}
+
+
+	/**
+	 * Gets the name of the wp option that stores the activation history
+	 * of this addon
+	 *
+	 * @return string
+	 */
+	public function get_activation_history_option_name(): string
+	{
+		return self::ee_addon_version_history_option_prefix . $this->name();
+	}
+
+
+	/**
+	 * Gets the wp option which stores the activation history for this addon
+	 *
+	 * @return array
+	 */
+	public function get_activation_history(): array
+	{
+		return get_option($this->get_activation_history_option_name(), []);
+	}
+
+
+	/**
+	 * @param string $config_section
+	 */
+	public function set_config_section($config_section = '')
+	{
+		$this->_config_section = ! empty($config_section) ? $config_section : 'addons';
+	}
+
+
+	/**
+	 * Sets the filepath to the main plugin file
+	 *
+	 * @param string $filepath
+	 */
+	public function set_main_plugin_file(string $filepath)
+	{
+		$this->_main_plugin_file = $filepath;
+	}
+
+
+	/**
+	 * gets the filepath to teh main file
+	 *
+	 * @return string
+	 */
+	public function get_main_plugin_file(): string
+	{
+		return $this->_main_plugin_file;
+	}
+
+
+	/**
+	 * Gets the filename (no path) of the main file (the main file loaded
+	 * by WP)
+	 *
+	 * @return string
+	 */
+	public function get_main_plugin_file_basename(): string
+	{
+		return plugin_basename($this->get_main_plugin_file());
+	}
+
+
+	/**
+	 * Gets the folder name which contains the main plugin file
+	 *
+	 * @return string
+	 */
+	public function get_main_plugin_file_dirname(): string
+	{
+		return dirname($this->get_main_plugin_file());
+	}
+
+
+	/**
+	 * sets hooks used in the admin
+	 *
+	 * @return void
+	 */
+	public function admin_init()
+	{
+		// is admin and not in M-Mode ?
+		if (is_admin() && ! EE_Maintenance_Mode::instance()->level()) {
+			add_filter('plugin_action_links', [$this, 'plugin_action_links'], 10, 2);
+			add_filter('after_plugin_row_' . $this->_plugin_basename, [$this, 'after_plugin_row'], 10, 3);
+		}
+	}
+
+
+	/**
+	 * plugin_actions
+	 * Add a settings link to the Plugins page, so people can go straight from the plugin page to the settings page.
+	 *
+	 * @param array  $links
+	 * @param string $file
+	 * @return array
+	 */
+	public function plugin_action_links(array $links, string $file): array
+	{
+		if ($file === $this->plugin_basename() && $this->plugin_action_slug() !== '') {
+			// before other links
+			array_unshift(
+				$links,
+				'<a href="admin.php?page=' . $this->plugin_action_slug() . '">'
+				. esc_html__('Settings', 'event_espresso')
+				. '</a>'
+			);
+		}
+		return $links;
+	}
+
+
+	/**
+	 * after_plugin_row
+	 * Add additional content to the plugins page plugin row
+	 * Inserts another row
+	 *
+	 * @param string $plugin_file
+	 * @param array  $plugin_data
+	 * @param string $status
+	 * @return void
+	 */
+	public function after_plugin_row(string $plugin_file, array $plugin_data, string $status)
+	{
+		$after_plugin_row = '';
+		$plugins_page_row = $this->get_plugins_page_row();
+		if (! empty($plugins_page_row) && $plugin_file === $this->plugin_basename()) {
+			$class       = $status ? 'active' : 'inactive';
+			$link_text   = isset($plugins_page_row['link_text']) ? $plugins_page_row['link_text'] : '';
+			$link_url    = isset($plugins_page_row['link_url']) ? $plugins_page_row['link_url'] : '';
+			$description = isset($plugins_page_row['description'])
+				? $plugins_page_row['description']
+				: '';
+			if (! empty($link_text) && ! empty($link_url) && ! empty($description)) {
+				$after_plugin_row .= '<tr id="' . sanitize_title($plugin_file) . '-ee-addon" class="' . $class . '">';
+				$after_plugin_row .= '<th class="check-column" scope="row"></th>';
+				$after_plugin_row .= '<td class="ee-addon-upsell-info-title-td plugin-title column-primary">';
+				$after_plugin_row .= '<style>
 .ee-button,
 .ee-button:active,
 .ee-button:visited {
@@ -856,67 +856,67 @@ 
 }
 .ee-button:active { top:0; }
 </style>';
-                $after_plugin_row .= '
+				$after_plugin_row .= '
 <p class="ee-addon-upsell-info-dv">
 	<a class="ee-button" href="' . $link_url . '">'
-                                     . $link_text
-                                     . ' &nbsp;<span class="dashicons dashicons-arrow-right-alt2" style="margin:0;"></span>'
-                                     . '</a>
+									 . $link_text
+									 . ' &nbsp;<span class="dashicons dashicons-arrow-right-alt2" style="margin:0;"></span>'
+									 . '</a>
 </p>';
-                $after_plugin_row .= '</td>';
-                $after_plugin_row .= '<td class="ee-addon-upsell-info-desc-td column-description desc">';
-                $after_plugin_row .= $description;
-                $after_plugin_row .= '</td>';
-                $after_plugin_row .= '</tr>';
-            } else {
-                $after_plugin_row .= $description;
-            }
-        }
-
-        echo $after_plugin_row;
-    }
-
-
-    /**
-     * A safe space for addons to add additional logic like setting hooks that need to be set early in the request.
-     * Child classes that have logic like that to run can override this method declaration.  This was not made abstract
-     * for back compat reasons.
-     *
-     * This will fire on the `AHEE__EE_System__load_espresso_addons__complete` hook at priority 999.
-     *
-     * It is recommended, if client code is `de-registering` an add-on, then do it on the
-     * `AHEE__EE_System__load_espresso_addons__complete` hook before priority 999 so as to ensure any code logic in this
-     * callback does not get run/set in that request.
-     *
-     * Also, keep in mind that if a registered add-on happens to be deactivated via
-     * EE_System::_deactivate_incompatible_addons() because its incompatible, any code executed in this method
-     * (including setting hooks etc) will have executed before the plugin was deactivated.  If you use
-     * `after_registration` to set any filter and/or action hooks and want to ensure they are removed on this add-on's
-     * deactivation, you can override `EE_Addon::deactivation` and unset your hooks and filters there.  Just remember
-     * to call `parent::deactivation`.
-     *
-     * @since 4.9.26
-     */
-    public function after_registration()
-    {
-        // cricket chirp... cricket chirp...
-    }
-
-
-    /**
-     * @return string
-     */
-    public function getPueSlug(): string
-    {
-        return $this->pue_slug;
-    }
-
-
-    /**
-     * @param string $pue_slug
-     */
-    public function setPueSlug(string $pue_slug)
-    {
-        $this->pue_slug = $pue_slug;
-    }
+				$after_plugin_row .= '</td>';
+				$after_plugin_row .= '<td class="ee-addon-upsell-info-desc-td column-description desc">';
+				$after_plugin_row .= $description;
+				$after_plugin_row .= '</td>';
+				$after_plugin_row .= '</tr>';
+			} else {
+				$after_plugin_row .= $description;
+			}
+		}
+
+		echo $after_plugin_row;
+	}
+
+
+	/**
+	 * A safe space for addons to add additional logic like setting hooks that need to be set early in the request.
+	 * Child classes that have logic like that to run can override this method declaration.  This was not made abstract
+	 * for back compat reasons.
+	 *
+	 * This will fire on the `AHEE__EE_System__load_espresso_addons__complete` hook at priority 999.
+	 *
+	 * It is recommended, if client code is `de-registering` an add-on, then do it on the
+	 * `AHEE__EE_System__load_espresso_addons__complete` hook before priority 999 so as to ensure any code logic in this
+	 * callback does not get run/set in that request.
+	 *
+	 * Also, keep in mind that if a registered add-on happens to be deactivated via
+	 * EE_System::_deactivate_incompatible_addons() because its incompatible, any code executed in this method
+	 * (including setting hooks etc) will have executed before the plugin was deactivated.  If you use
+	 * `after_registration` to set any filter and/or action hooks and want to ensure they are removed on this add-on's
+	 * deactivation, you can override `EE_Addon::deactivation` and unset your hooks and filters there.  Just remember
+	 * to call `parent::deactivation`.
+	 *
+	 * @since 4.9.26
+	 */
+	public function after_registration()
+	{
+		// cricket chirp... cricket chirp...
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function getPueSlug(): string
+	{
+		return $this->pue_slug;
+	}
+
+
+	/**
+	 * @param string $pue_slug
+	 */
+	public function setPueSlug(string $pue_slug)
+	{
+		$this->pue_slug = $pue_slug;
+	}
 }

Spacing +10 added lines, -10 removed lines

@@ -580,7 +580,7 @@ 
      */
     public function get_activation_indicator_option_name(): string
     {
-        return 'ee_activation_' . $this->name();
+        return 'ee_activation_'.$this->name();
     }
 
 
@@ -668,13 +668,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->get_activation_history();
         }
         if ($current_version_to_add === null) {
             $current_version_to_add = $this->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());
         return update_option($this->get_activation_history_option_name(), $version_history);
     }
 
@@ -687,7 +687,7 @@ 
      */
     public function get_activation_history_option_name(): string
     {
-        return self::ee_addon_version_history_option_prefix . $this->name();
+        return self::ee_addon_version_history_option_prefix.$this->name();
     }
 
 
@@ -766,7 +766,7 @@ 
         // is admin and not in M-Mode ?
         if (is_admin() && ! EE_Maintenance_Mode::instance()->level()) {
             add_filter('plugin_action_links', [$this, 'plugin_action_links'], 10, 2);
-            add_filter('after_plugin_row_' . $this->_plugin_basename, [$this, 'after_plugin_row'], 10, 3);
+            add_filter('after_plugin_row_'.$this->_plugin_basename, [$this, 'after_plugin_row'], 10, 3);
         }
     }
 
@@ -785,7 +785,7 @@ 
             // before other links
             array_unshift(
                 $links,
-                '<a href="admin.php?page=' . $this->plugin_action_slug() . '">'
+                '<a href="admin.php?page='.$this->plugin_action_slug().'">'
                 . esc_html__('Settings', 'event_espresso')
                 . '</a>'
             );
@@ -808,15 +808,15 @@ 
     {
         $after_plugin_row = '';
         $plugins_page_row = $this->get_plugins_page_row();
-        if (! empty($plugins_page_row) && $plugin_file === $this->plugin_basename()) {
+        if ( ! empty($plugins_page_row) && $plugin_file === $this->plugin_basename()) {
             $class       = $status ? 'active' : 'inactive';
             $link_text   = isset($plugins_page_row['link_text']) ? $plugins_page_row['link_text'] : '';
             $link_url    = isset($plugins_page_row['link_url']) ? $plugins_page_row['link_url'] : '';
             $description = isset($plugins_page_row['description'])
                 ? $plugins_page_row['description']
                 : '';
-            if (! empty($link_text) && ! empty($link_url) && ! empty($description)) {
-                $after_plugin_row .= '<tr id="' . sanitize_title($plugin_file) . '-ee-addon" class="' . $class . '">';
+            if ( ! empty($link_text) && ! empty($link_url) && ! empty($description)) {
+                $after_plugin_row .= '<tr id="'.sanitize_title($plugin_file).'-ee-addon" class="'.$class.'">';
                 $after_plugin_row .= '<th class="check-column" scope="row"></th>';
                 $after_plugin_row .= '<td class="ee-addon-upsell-info-title-td plugin-title column-primary">';
                 $after_plugin_row .= '<style>
@@ -858,7 +858,7 @@ 
 </style>';
                 $after_plugin_row .= '
 <p class="ee-addon-upsell-info-dv">
-	<a class="ee-button" href="' . $link_url . '">'
+	<a class="ee-button" href="' . $link_url.'">'
                                      . $link_text
                                      . ' &nbsp;<span class="dashicons dashicons-arrow-right-alt2" style="margin:0;"></span>'
                                      . '</a>

admin_pages/messages/Messages_Admin_Page.core.php

Indentation +4555 added lines, -4555 removed lines

@@ -19,2650 +19,2650 @@ 
 class Messages_Admin_Page extends EE_Admin_Page
 {
 
-    /**
-     * @type EE_Message_Resource_Manager $_message_resource_manager
-     */
-    protected $_message_resource_manager;
-
-    /**
-     * @type string $_active_message_type_name
-     */
-    protected $_active_message_type_name = '';
-
-    /**
-     * @type EE_messenger $_active_messenger
-     */
-    protected $_active_messenger;
-    protected $_activate_state;
-    protected $_activate_meta_box_type;
-    protected $_current_message_meta_box;
-    protected $_current_message_meta_box_object;
-    protected $_context_switcher;
-    protected $_shortcodes = array();
-    protected $_active_messengers = array();
-    protected $_active_message_types = array();
-
-    /**
-     * @var EE_Message_Template_Group $_message_template_group
-     */
-    protected $_message_template_group;
-    protected $_m_mt_settings = array();
-
-
-    /**
-     * This is set via the _set_message_template_group method and holds whatever the template pack for the group is.
-     * IF there is no group then it gets automatically set to the Default template pack.
-     *
-     * @since 4.5.0
-     *
-     * @var EE_Messages_Template_Pack
-     */
-    protected $_template_pack;
-
-
-    /**
-     * This is set via the _set_message_template_group method and holds whatever the template pack variation for the
-     * group is.  If there is no group then it automatically gets set to default.
-     *
-     * @since 4.5.0
-     *
-     * @var string
-     */
-    protected $_variation;
-
-
-    /**
-     * @param bool $routing
-     * @throws EE_Error
-     */
-    public function __construct($routing = true)
-    {
-        // make sure messages autoloader is running
-        EED_Messages::set_autoloaders();
-        parent::__construct($routing);
-    }
-
-
-    protected function _init_page_props()
-    {
-        $this->page_slug = EE_MSG_PG_SLUG;
-        $this->page_label = esc_html__('Messages Settings', 'event_espresso');
-        $this->_admin_base_url = EE_MSG_ADMIN_URL;
-        $this->_admin_base_path = EE_MSG_ADMIN;
-
-        $this->_activate_state = isset($this->_req_data['activate_state']) ? (array) $this->_req_data['activate_state']
-            : array();
-
-        $this->_active_messenger = isset($this->_req_data['messenger']) ? $this->_req_data['messenger'] : null;
-        $this->_load_message_resource_manager();
-    }
-
-
-    /**
-     * loads messenger objects into the $_active_messengers property (so we can access the needed methods)
-     *
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     */
-    protected function _load_message_resource_manager()
-    {
-        $this->_message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-    }
-
-
-    /**
-     * @deprecated 4.9.9.rc.014
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function get_messengers_for_list_table()
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            sprintf(
-                esc_html__(
-                    'This method is no longer in use.  There is no replacement for it. The method was used to generate a set of values for use in creating a messenger filter dropdown which is now generated differently via %s',
-                    'event_espresso'
-                ),
-                'Messages_Admin_Page::get_messengers_select_input()'
-            ),
-            '4.9.9.rc.014'
-        );
-
-        $m_values = array();
-        $active_messengers = EEM_Message::instance()->get_all(array('group_by' => 'MSG_messenger'));
-        // setup messengers for selects
-        $i = 1;
-        foreach ($active_messengers as $active_messenger) {
-            if ($active_messenger instanceof EE_Message) {
-                $m_values[ $i ]['id'] = $active_messenger->messenger();
-                $m_values[ $i ]['text'] = ucwords($active_messenger->messenger_label());
-                $i++;
-            }
-        }
-
-        return $m_values;
-    }
-
-
-    /**
-     * @deprecated 4.9.9.rc.014
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function get_message_types_for_list_table()
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            sprintf(
-                esc_html__(
-                    'This method is no longer in use.  There is no replacement for it. The method was used to generate a set of values for use in creating a message type filter dropdown which is now generated differently via %s',
-                    'event_espresso'
-                ),
-                'Messages_Admin_Page::get_message_types_select_input()'
-            ),
-            '4.9.9.rc.014'
-        );
-
-        $mt_values = array();
-        $active_messages = EEM_Message::instance()->get_all(array('group_by' => 'MSG_message_type'));
-        $i = 1;
-        foreach ($active_messages as $active_message) {
-            if ($active_message instanceof EE_Message) {
-                $mt_values[ $i ]['id'] = $active_message->message_type();
-                $mt_values[ $i ]['text'] = ucwords($active_message->message_type_label());
-                $i++;
-            }
-        }
-
-        return $mt_values;
-    }
-
-
-    /**
-     * @deprecated 4.9.9.rc.014
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function get_contexts_for_message_types_for_list_table()
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            sprintf(
-                esc_html__(
-                    'This method is no longer in use.  There is no replacement for it. The method was used to generate a set of values for use in creating a message type context filter dropdown which is now generated differently via %s',
-                    'event_espresso'
-                ),
-                'Messages_Admin_Page::get_contexts_for_message_types_select_input()'
-            ),
-            '4.9.9.rc.014'
-        );
-
-        $contexts = array();
-        $active_message_contexts = EEM_Message::instance()->get_all(array('group_by' => 'MSG_context'));
-        foreach ($active_message_contexts as $active_message) {
-            if ($active_message instanceof EE_Message) {
-                $message_type = $active_message->message_type_object();
-                if ($message_type instanceof EE_message_type) {
-                    $message_type_contexts = $message_type->get_contexts();
-                    foreach ($message_type_contexts as $context => $context_details) {
-                        $contexts[ $context ] = $context_details['label'];
-                    }
-                }
-            }
-        }
-
-        return $contexts;
-    }
-
-
-    /**
-     * Generate select input with provided messenger options array.
-     *
-     * @param array $messenger_options Array of messengers indexed by messenger slug and values are the messenger
-     *                                 labels.
-     * @return string
-     * @throws EE_Error
-     */
-    public function get_messengers_select_input($messenger_options)
-    {
-        // if empty or just one value then just return an empty string
-        if (
-            empty($messenger_options)
-            || ! is_array($messenger_options)
-            || count($messenger_options) === 1
-        ) {
-            return '';
-        }
-        // merge in default
-        $messenger_options = array_merge(
-            array('none_selected' => esc_html__('Show All Messengers', 'event_espresso')),
-            $messenger_options
-        );
-        $input = new EE_Select_Input(
-            $messenger_options,
-            array(
-                'html_name'  => 'ee_messenger_filter_by',
-                'html_id'    => 'ee_messenger_filter_by',
-                'html_class' => 'wide',
-                'default'    => isset($this->_req_data['ee_messenger_filter_by'])
-                    ? sanitize_title($this->_req_data['ee_messenger_filter_by'])
-                    : 'none_selected',
-            )
-        );
-
-        return $input->get_html_for_input();
-    }
-
-
-    /**
-     * Generate select input with provided message type options array.
-     *
-     * @param array $message_type_options Array of message types indexed by message type slug, and values are the
-     *                                    message type labels
-     * @return string
-     * @throws EE_Error
-     */
-    public function get_message_types_select_input($message_type_options)
-    {
-        // if empty or count of options is 1 then just return an empty string
-        if (
-            empty($message_type_options)
-            || ! is_array($message_type_options)
-            || count($message_type_options) === 1
-        ) {
-            return '';
-        }
-        // merge in default
-        $message_type_options = array_merge(
-            array('none_selected' => esc_html__('Show All Message Types', 'event_espresso')),
-            $message_type_options
-        );
-        $input = new EE_Select_Input(
-            $message_type_options,
-            array(
-                'html_name'  => 'ee_message_type_filter_by',
-                'html_id'    => 'ee_message_type_filter_by',
-                'html_class' => 'wide',
-                'default'    => isset($this->_req_data['ee_message_type_filter_by'])
-                    ? sanitize_title($this->_req_data['ee_message_type_filter_by'])
-                    : 'none_selected',
-            )
-        );
-
-        return $input->get_html_for_input();
-    }
-
-
-    /**
-     * Generate select input with provide message type contexts array.
-     *
-     * @param array $context_options Array of message type contexts indexed by context slug, and values are the
-     *                               context label.
-     * @return string
-     * @throws EE_Error
-     */
-    public function get_contexts_for_message_types_select_input($context_options)
-    {
-        // if empty or count of options is one then just return empty string
-        if (
-            empty($context_options)
-            || ! is_array($context_options)
-            || count($context_options) === 1
-        ) {
-            return '';
-        }
-        // merge in default
-        $context_options = array_merge(
-            array('none_selected' => esc_html__('Show all Contexts', 'event_espresso')),
-            $context_options
-        );
-        $input = new EE_Select_Input(
-            $context_options,
-            array(
-                'html_name'  => 'ee_context_filter_by',
-                'html_id'    => 'ee_context_filter_by',
-                'html_class' => 'wide',
-                'default'    => isset($this->_req_data['ee_context_filter_by'])
-                    ? sanitize_title($this->_req_data['ee_context_filter_by'])
-                    : 'none_selected',
-            )
-        );
-
-        return $input->get_html_for_input();
-    }
-
-
-    protected function _ajax_hooks()
-    {
-        add_action('wp_ajax_activate_messenger', array($this, 'activate_messenger_toggle'));
-        add_action('wp_ajax_activate_mt', array($this, 'activate_mt_toggle'));
-        add_action('wp_ajax_ee_msgs_save_settings', array($this, 'save_settings'));
-        add_action('wp_ajax_ee_msgs_update_mt_form', array($this, 'update_mt_form'));
-        add_action('wp_ajax_switch_template_pack', array($this, 'switch_template_pack'));
-        add_action('wp_ajax_toggle_context_template', array($this, 'toggle_context_template'));
-    }
-
-
-    protected function _define_page_props()
-    {
-        $this->_admin_page_title = $this->page_label;
-        $this->_labels = array(
-            'buttons'    => array(
-                'add'    => esc_html__('Add New Message Template', 'event_espresso'),
-                'edit'   => esc_html__('Edit Message Template', 'event_espresso'),
-                'delete' => esc_html__('Delete Message Template', 'event_espresso'),
-            ),
-            'publishbox' => esc_html__('Update Actions', 'event_espresso'),
-        );
-    }
-
-
-    /**
-     *        an array for storing key => value pairs of request actions and their corresponding methods
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _set_page_routes()
-    {
-        $grp_id = ! empty($this->_req_data['GRP_ID']) && ! is_array($this->_req_data['GRP_ID'])
-            ? $this->_req_data['GRP_ID']
-            : 0;
-        $grp_id = empty($grp_id) && ! empty($this->_req_data['id'])
-            ? $this->_req_data['id']
-            : $grp_id;
-        $msg_id = ! empty($this->_req_data['MSG_ID']) && ! is_array($this->_req_data['MSG_ID'])
-            ? $this->_req_data['MSG_ID']
-            : 0;
-
-        $this->_page_routes = array(
-            'default'                          => array(
-                'func'       => '_message_queue_list_table',
-                'capability' => 'ee_read_global_messages',
-            ),
-            'global_mtps'                      => array(
-                'func'       => '_ee_default_messages_overview_list_table',
-                'capability' => 'ee_read_global_messages',
-            ),
-            'custom_mtps'                      => array(
-                'func'       => '_custom_mtps_preview',
-                'capability' => 'ee_read_messages',
-            ),
-            'add_new_message_template'         => array(
-                'func'       => '_add_message_template',
-                'capability' => 'ee_edit_messages',
-                'noheader'   => true,
-            ),
-            'edit_message_template'            => array(
-                'func'       => '_edit_message_template',
-                'capability' => 'ee_edit_message',
-                'obj_id'     => $grp_id,
-            ),
-            'preview_message'                  => array(
-                'func'               => '_preview_message',
-                'capability'         => 'ee_read_message',
-                'obj_id'             => $grp_id,
-                'noheader'           => true,
-                'headers_sent_route' => 'display_preview_message',
-            ),
-            'display_preview_message'          => array(
-                'func'       => '_display_preview_message',
-                'capability' => 'ee_read_message',
-                'obj_id'     => $grp_id,
-            ),
-            'insert_message_template'          => array(
-                'func'       => '_insert_or_update_message_template',
-                'capability' => 'ee_edit_messages',
-                'args'       => array('new_template' => true),
-                'noheader'   => true,
-            ),
-            'update_message_template'          => array(
-                'func'       => '_insert_or_update_message_template',
-                'capability' => 'ee_edit_message',
-                'obj_id'     => $grp_id,
-                'args'       => array('new_template' => false),
-                'noheader'   => true,
-            ),
-            'trash_message_template'           => array(
-                'func'       => '_trash_or_restore_message_template',
-                'capability' => 'ee_delete_message',
-                'obj_id'     => $grp_id,
-                'args'       => array('trash' => true, 'all' => true),
-                'noheader'   => true,
-            ),
-            'trash_message_template_context'   => array(
-                'func'       => '_trash_or_restore_message_template',
-                'capability' => 'ee_delete_message',
-                'obj_id'     => $grp_id,
-                'args'       => array('trash' => true),
-                'noheader'   => true,
-            ),
-            'restore_message_template'         => array(
-                'func'       => '_trash_or_restore_message_template',
-                'capability' => 'ee_delete_message',
-                'obj_id'     => $grp_id,
-                'args'       => array('trash' => false, 'all' => true),
-                'noheader'   => true,
-            ),
-            'restore_message_template_context' => array(
-                'func'       => '_trash_or_restore_message_template',
-                'capability' => 'ee_delete_message',
-                'obj_id'     => $grp_id,
-                'args'       => array('trash' => false),
-                'noheader'   => true,
-            ),
-            'delete_message_template'          => array(
-                'func'       => '_delete_message_template',
-                'capability' => 'ee_delete_message',
-                'obj_id'     => $grp_id,
-                'noheader'   => true,
-            ),
-            'reset_to_default'                 => array(
-                'func'       => '_reset_to_default_template',
-                'capability' => 'ee_edit_message',
-                'obj_id'     => $grp_id,
-                'noheader'   => true,
-            ),
-            'settings'                         => array(
-                'func'       => '_settings',
-                'capability' => 'manage_options',
-            ),
-            'update_global_settings'           => array(
-                'func'       => '_update_global_settings',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-            ),
-            'generate_now'                     => array(
-                'func'       => '_generate_now',
-                'capability' => 'ee_send_message',
-                'noheader'   => true,
-            ),
-            'generate_and_send_now'            => array(
-                'func'       => '_generate_and_send_now',
-                'capability' => 'ee_send_message',
-                'noheader'   => true,
-            ),
-            'queue_for_resending'              => array(
-                'func'       => '_queue_for_resending',
-                'capability' => 'ee_send_message',
-                'noheader'   => true,
-            ),
-            'send_now'                         => array(
-                'func'       => '_send_now',
-                'capability' => 'ee_send_message',
-                'noheader'   => true,
-            ),
-            'delete_ee_message'                => array(
-                'func'       => '_delete_ee_messages',
-                'capability' => 'ee_delete_messages',
-                'noheader'   => true,
-            ),
-            'delete_ee_messages'               => array(
-                'func'       => '_delete_ee_messages',
-                'capability' => 'ee_delete_messages',
-                'noheader'   => true,
-                'obj_id'     => $msg_id,
-            ),
-        );
-    }
-
-
-    protected function _set_page_config()
-    {
-        $this->_page_config = array(
-            'default'                  => array(
-                'nav'           => array(
-                    'label' => esc_html__('Message Activity', 'event_espresso'),
-                    'order' => 10,
-                ),
-                'list_table'    => 'EE_Message_List_Table',
-                // 'qtips' => array( 'EE_Message_List_Table_Tips' ),
-                'require_nonce' => false,
-            ),
-            'global_mtps'              => array(
-                'nav'           => array(
-                    'label' => esc_html__('Default Message Templates', 'event_espresso'),
-                    'order' => 20,
-                ),
-                'list_table'    => 'Messages_Template_List_Table',
-                'help_tabs'     => array(
-                    'messages_overview_help_tab'                                => array(
-                        'title'    => esc_html__('Messages Overview', 'event_espresso'),
-                        'filename' => 'messages_overview',
-                    ),
-                    'messages_overview_messages_table_column_headings_help_tab' => array(
-                        'title'    => esc_html__('Messages Table Column Headings', 'event_espresso'),
-                        'filename' => 'messages_overview_table_column_headings',
-                    ),
-                    'messages_overview_messages_filters_help_tab'               => array(
-                        'title'    => esc_html__('Message Filters', 'event_espresso'),
-                        'filename' => 'messages_overview_filters',
-                    ),
-                    'messages_overview_messages_views_help_tab'                 => array(
-                        'title'    => esc_html__('Message Views', 'event_espresso'),
-                        'filename' => 'messages_overview_views',
-                    ),
-                    'message_overview_message_types_help_tab'                   => array(
-                        'title'    => esc_html__('Message Types', 'event_espresso'),
-                        'filename' => 'messages_overview_types',
-                    ),
-                    'messages_overview_messengers_help_tab'                     => array(
-                        'title'    => esc_html__('Messengers', 'event_espresso'),
-                        'filename' => 'messages_overview_messengers',
-                    ),
-                ),
-                // disabled temporarily. see: https://github.com/eventespresso/eventsmart.com-website/issues/836
-                // 'help_tour'     => array('Messages_Overview_Help_Tour'),
-                'require_nonce' => false,
-            ),
-            'custom_mtps'              => array(
-                'nav'           => array(
-                    'label' => esc_html__('Custom Message Templates', 'event_espresso'),
-                    'order' => 30,
-                ),
-                'help_tabs'     => array(),
-                // disabled temporarily. see: https://github.com/eventespresso/eventsmart.com-website/issues/836
-                // 'help_tour'     => array(),
-                'require_nonce' => false,
-            ),
-            'add_new_message_template' => array(
-                'nav'           => array(
-                    'label'      => esc_html__('Add New Message Templates', 'event_espresso'),
-                    'order'      => 5,
-                    'persistent' => false,
-                ),
-                'require_nonce' => false,
-            ),
-            'edit_message_template'    => array(
-                'labels'        => array(
-                    'buttons'    => array(
-                        'reset' => esc_html__('Reset Templates', 'event_espresso'),
-                    ),
-                    'publishbox' => esc_html__('Update Actions', 'event_espresso'),
-                ),
-                'nav'           => array(
-                    'label'      => esc_html__('Edit Message Templates', 'event_espresso'),
-                    'order'      => 5,
-                    'persistent' => false,
-                    'url'        => '',
-                ),
-                'metaboxes'     => array('_publish_post_box', '_register_edit_meta_boxes'),
-                'has_metaboxes' => true,
-                // disabled temporarily. see: https://github.com/eventespresso/eventsmart.com-website/issues/836
-                // 'help_tour'     => array('Message_Templates_Edit_Help_Tour'),
-                'help_tabs'     => array(
-                    'edit_message_template'            => array(
-                        'title'    => esc_html__('Message Template Editor', 'event_espresso'),
-                        'callback' => 'edit_message_template_help_tab',
-                    ),
-                    'message_templates_help_tab'       => array(
-                        'title'    => esc_html__('Message Templates', 'event_espresso'),
-                        'filename' => 'messages_templates',
-                    ),
-                    'message_template_shortcodes'      => array(
-                        'title'    => esc_html__('Message Shortcodes', 'event_espresso'),
-                        'callback' => 'message_template_shortcodes_help_tab',
-                    ),
-                    'message_preview_help_tab'         => array(
-                        'title'    => esc_html__('Message Preview', 'event_espresso'),
-                        'filename' => 'messages_preview',
-                    ),
-                    'messages_overview_other_help_tab' => array(
-                        'title'    => esc_html__('Messages Other', 'event_espresso'),
-                        'filename' => 'messages_overview_other',
-                    ),
-                ),
-                'require_nonce' => false,
-            ),
-            'display_preview_message'  => array(
-                'nav'           => array(
-                    'label'      => esc_html__('Message Preview', 'event_espresso'),
-                    'order'      => 5,
-                    'url'        => '',
-                    'persistent' => false,
-                ),
-                'help_tabs'     => array(
-                    'preview_message' => array(
-                        'title'    => esc_html__('About Previews', 'event_espresso'),
-                        'callback' => 'preview_message_help_tab',
-                    ),
-                ),
-                'require_nonce' => false,
-            ),
-            'settings'                 => array(
-                'nav'           => array(
-                    'label' => esc_html__('Settings', 'event_espresso'),
-                    'order' => 40,
-                ),
-                'metaboxes'     => array('_messages_settings_metaboxes'),
-                'help_tabs'     => array(
-                    'messages_settings_help_tab'               => array(
-                        'title'    => esc_html__('Messages Settings', 'event_espresso'),
-                        'filename' => 'messages_settings',
-                    ),
-                    'messages_settings_message_types_help_tab' => array(
-                        'title'    => esc_html__('Activating / Deactivating Message Types', 'event_espresso'),
-                        'filename' => 'messages_settings_message_types',
-                    ),
-                    'messages_settings_messengers_help_tab'    => array(
-                        'title'    => esc_html__('Activating / Deactivating Messengers', 'event_espresso'),
-                        'filename' => 'messages_settings_messengers',
-                    ),
-                ),
-                // disabled temporarily. see: https://github.com/eventespresso/eventsmart.com-website/issues/836
-                // 'help_tour'     => array('Messages_Settings_Help_Tour'),
-                'require_nonce' => false,
-            ),
-        );
-    }
-
-
-    protected function _add_screen_options()
-    {
-        // todo
-    }
-
-
-    protected function _add_screen_options_global_mtps()
-    {
-        /**
-         * Note: the reason for the value swap here on $this->_admin_page_title is because $this->_per_page_screen_options
-         * uses the $_admin_page_title property and we want different outputs in the different spots.
-         */
-        $page_title = $this->_admin_page_title;
-        $this->_admin_page_title = esc_html__('Global Message Templates', 'event_espresso');
-        $this->_per_page_screen_option();
-        $this->_admin_page_title = $page_title;
-    }
-
-
-    protected function _add_screen_options_default()
-    {
-        $this->_admin_page_title = esc_html__('Message Activity', 'event_espresso');
-        $this->_per_page_screen_option();
-    }
-
-
-    // none of the below group are currently used for Messages
-    protected function _add_feature_pointers()
-    {
-    }
-
-    public function admin_init()
-    {
-    }
-
-    public function admin_notices()
-    {
-    }
-
-    public function admin_footer_scripts()
-    {
-    }
-
-
-    public function messages_help_tab()
-    {
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_messages_help_tab.template.php');
-    }
-
-
-    public function messengers_help_tab()
-    {
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_messenger_help_tab.template.php');
-    }
-
-
-    public function message_types_help_tab()
-    {
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_message_type_help_tab.template.php');
-    }
-
-
-    public function messages_overview_help_tab()
-    {
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_overview_help_tab.template.php');
-    }
-
-
-    public function message_templates_help_tab()
-    {
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_message_templates_help_tab.template.php');
-    }
-
-
-    public function edit_message_template_help_tab()
-    {
-        $args['img1'] = '<img src="' . EE_MSG_ASSETS_URL . 'images/editor.png' . '" alt="'
-                        . esc_attr__('Editor Title', 'event_espresso')
-                        . '" />';
-        $args['img2'] = '<img src="' . EE_MSG_ASSETS_URL . 'images/switch-context.png' . '" alt="'
-                        . esc_attr__('Context Switcher and Preview', 'event_espresso')
-                        . '" />';
-        $args['img3'] = '<img class="left" src="' . EE_MSG_ASSETS_URL . 'images/form-fields.png' . '" alt="'
-                        . esc_attr__('Message Template Form Fields', 'event_espresso')
-                        . '" />';
-        $args['img4'] = '<img class="right" src="' . EE_MSG_ASSETS_URL . 'images/shortcodes-metabox.png' . '" alt="'
-                        . esc_attr__('Shortcodes Metabox', 'event_espresso')
-                        . '" />';
-        $args['img5'] = '<img class="right" src="' . EE_MSG_ASSETS_URL . 'images/publish-meta-box.png' . '" alt="'
-                        . esc_attr__('Publish Metabox', 'event_espresso')
-                        . '" />';
-        EEH_Template::display_template(
-            EE_MSG_TEMPLATE_PATH . 'ee_msg_messages_templates_editor_help_tab.template.php',
-            $args
-        );
-    }
-
-
-    public function message_template_shortcodes_help_tab()
-    {
-        $this->_set_shortcodes();
-        $args['shortcodes'] = $this->_shortcodes;
-        EEH_Template::display_template(
-            EE_MSG_TEMPLATE_PATH . 'ee_msg_messages_shortcodes_help_tab.template.php',
-            $args
-        );
-    }
-
-
-    public function preview_message_help_tab()
-    {
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_preview_help_tab.template.php');
-    }
-
-
-    public function settings_help_tab()
-    {
-        $args['img1'] = '<img class="inline-text" src="' . EE_MSG_ASSETS_URL . 'images/email-tab-active.png'
-                        . '" alt="' . esc_attr__('Active Email Tab', 'event_espresso') . '" />';
-        $args['img2'] = '<img class="inline-text" src="' . EE_MSG_ASSETS_URL . 'images/email-tab-inactive.png'
-                        . '" alt="' . esc_attr__('Inactive Email Tab', 'event_espresso') . '" />';
-        $args['img3'] = '<div class="switch">'
-                        . '<input class="ee-on-off-toggle ee-toggle-round-flat"'
-                        . ' type="checkbox" checked="checked">'
-                        . '<label for="ee-on-off-toggle-on"></label>'
-                        . '</div>';
-        $args['img4'] = '<div class="switch">'
-                        . '<input class="ee-on-off-toggle ee-toggle-round-flat"'
-                        . ' type="checkbox">'
-                        . '<label for="ee-on-off-toggle-on"></label>'
-                        . '</div>';
-        EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_messages_settings_help_tab.template.php', $args);
-    }
-
-
-    public function load_scripts_styles()
-    {
-        wp_register_style('espresso_ee_msg', EE_MSG_ASSETS_URL . 'ee_message_admin.css', EVENT_ESPRESSO_VERSION);
-        wp_enqueue_style('espresso_ee_msg');
-
-        wp_register_script(
-            'ee-messages-settings',
-            EE_MSG_ASSETS_URL . 'ee-messages-settings.js',
-            array('jquery-ui-droppable', 'ee-serialize-full-array'),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_register_script(
-            'ee-msg-list-table-js',
-            EE_MSG_ASSETS_URL . 'ee_message_admin_list_table.js',
-            array('ee-dialog'),
-            EVENT_ESPRESSO_VERSION
-        );
-    }
-
-
-    public function load_scripts_styles_default()
-    {
-        wp_enqueue_script('ee-msg-list-table-js');
-    }
-
-
-    public function wp_editor_css($mce_css)
-    {
-        // if we're on the edit_message_template route
-        if ($this->_req_action === 'edit_message_template' && $this->_active_messenger instanceof EE_messenger) {
-            $message_type_name = $this->_active_message_type_name;
-
-            // we're going to REPLACE the existing mce css
-            // we need to get the css file location from the active messenger
-            $mce_css = $this->_active_messenger->get_variation(
-                $this->_template_pack,
-                $message_type_name,
-                true,
-                'wpeditor',
-                $this->_variation
-            );
-        }
-
-        return $mce_css;
-    }
-
-
-    public function load_scripts_styles_edit_message_template()
-    {
-
-        $this->_set_shortcodes();
-
-        EE_Registry::$i18n_js_strings['confirm_default_reset'] = sprintf(
-            esc_html__(
-                'Are you sure you want to reset the %s %s message templates?  Remember continuing will reset the templates for all contexts in this messenger and message type group.',
-                'event_espresso'
-            ),
-            $this->_message_template_group->messenger_obj()->label['singular'],
-            $this->_message_template_group->message_type_obj()->label['singular']
-        );
-        EE_Registry::$i18n_js_strings['confirm_switch_template_pack'] = esc_html__(
-            'Switching the template pack for a messages template will reset the content for the template so the new layout is loaded.  Any custom content in the existing template will be lost. Are you sure you wish to do this?',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['server_error'] = esc_html__(
-            'An unknown error occurred on the server while attempting to process your request. Please refresh the page and try again or contact support.',
-            'event_espresso'
-        );
-
-        wp_register_script(
-            'ee_msgs_edit_js',
-            EE_MSG_ASSETS_URL . 'ee_message_editor.js',
-            array('jquery'),
-            EVENT_ESPRESSO_VERSION
-        );
-
-        wp_enqueue_script('ee_admin_js');
-        wp_enqueue_script('ee_msgs_edit_js');
-
-        // add in special css for tiny_mce
-        add_filter('mce_css', array($this, 'wp_editor_css'));
-    }
-
-
-    public function load_scripts_styles_display_preview_message()
-    {
-
-        $this->_set_message_template_group();
-
-        if (isset($this->_req_data['messenger'])) {
-            $this->_active_messenger = $this->_message_resource_manager->get_active_messenger(
-                $this->_req_data['messenger']
-            );
-        }
-
-        $message_type_name = isset($this->_req_data['message_type']) ? $this->_req_data['message_type'] : '';
-
-
-        wp_enqueue_style(
-            'espresso_preview_css',
-            $this->_active_messenger->get_variation(
-                $this->_template_pack,
-                $message_type_name,
-                true,
-                'preview',
-                $this->_variation
-            )
-        );
-    }
-
-
-    public function load_scripts_styles_settings()
-    {
-        wp_register_style(
-            'ee-message-settings',
-            EE_MSG_ASSETS_URL . 'ee_message_settings.css',
-            array(),
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_style('ee-text-links');
-        wp_enqueue_style('ee-message-settings');
-        wp_enqueue_script('ee-messages-settings');
-    }
-
-
-    /**
-     * set views array for List Table
-     */
-    public function _set_list_table_views_global_mtps()
-    {
-        $this->_views = array(
-            'in_use' => array(
-                'slug'  => 'in_use',
-                'label' => esc_html__('In Use', 'event_espresso'),
-                'count' => 0,
-            ),
-        );
-    }
-
-
-    /**
-     * Set views array for the Custom Template List Table
-     */
-    public function _set_list_table_views_custom_mtps()
-    {
-        $this->_set_list_table_views_global_mtps();
-        $this->_views['in_use']['bulk_action'] = array(
-            'trash_message_template' => esc_html__('Move to Trash', 'event_espresso'),
-        );
-    }
-
-
-    /**
-     * set views array for message queue list table
-     *
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function _set_list_table_views_default()
-    {
-        EE_Registry::instance()->load_helper('Template');
-
-        $common_bulk_actions = EE_Registry::instance()->CAP->current_user_can(
-            'ee_send_message',
-            'message_list_table_bulk_actions'
-        )
-            ? array(
-                'generate_now'          => esc_html__('Generate Now', 'event_espresso'),
-                'generate_and_send_now' => esc_html__('Generate and Send Now', 'event_espresso'),
-                'queue_for_resending'   => esc_html__('Queue for Resending', 'event_espresso'),
-                'send_now'              => esc_html__('Send Now', 'event_espresso'),
-            )
-            : array();
-
-        $delete_bulk_action = EE_Registry::instance()->CAP->current_user_can(
-            'ee_delete_messages',
-            'message_list_table_bulk_actions'
-        )
-            ? array('delete_ee_messages' => esc_html__('Delete Messages', 'event_espresso'))
-            : array();
-
-
-        $this->_views = array(
-            'all' => array(
-                'slug'        => 'all',
-                'label'       => esc_html__('All', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => array_merge($common_bulk_actions, $delete_bulk_action),
-            ),
-        );
-
-
-        foreach (EEM_Message::instance()->all_statuses() as $status) {
-            if ($status === EEM_Message::status_debug_only && ! EEM_Message::debug()) {
-                continue;
-            }
-            $status_bulk_actions = $common_bulk_actions;
-            // unset bulk actions not applying to status
-            if (! empty($status_bulk_actions)) {
-                switch ($status) {
-                    case EEM_Message::status_idle:
-                    case EEM_Message::status_resend:
-                        $status_bulk_actions['send_now'] = $common_bulk_actions['send_now'];
-                        break;
-
-                    case EEM_Message::status_failed:
-                    case EEM_Message::status_debug_only:
-                    case EEM_Message::status_messenger_executing:
-                        $status_bulk_actions = array();
-                        break;
-
-                    case EEM_Message::status_incomplete:
-                        unset($status_bulk_actions['queue_for_resending'], $status_bulk_actions['send_now']);
-                        break;
-
-                    case EEM_Message::status_retry:
-                    case EEM_Message::status_sent:
-                        unset($status_bulk_actions['generate_now'], $status_bulk_actions['generate_and_send_now']);
-                        break;
-                }
-            }
-
-            // skip adding messenger executing status to views because it will be included with the Failed view.
-            if ($status === EEM_Message::status_messenger_executing) {
-                continue;
-            }
-
-            $this->_views[ strtolower($status) ] = array(
-                'slug'        => strtolower($status),
-                'label'       => EEH_Template::pretty_status($status, false, 'sentence'),
-                'count'       => 0,
-                'bulk_action' => array_merge($status_bulk_actions, $delete_bulk_action),
-            );
-        }
-    }
-
-
-    protected function _ee_default_messages_overview_list_table()
-    {
-        $this->_admin_page_title = esc_html__('Default Message Templates', 'event_espresso');
-        $this->display_admin_list_table_page_with_no_sidebar();
-    }
-
-
-    protected function _message_queue_list_table()
-    {
-        $this->_search_btn_label = esc_html__('Message Activity', 'event_espresso');
-        $this->_template_args['per_column'] = 6;
-        $this->_template_args['after_list_table'] = $this->_display_legend($this->_message_legend_items());
-        $this->_template_args['before_list_table'] = '<h3>'
-                                                     . EEM_Message::instance()->get_pretty_label_for_results()
-                                                     . '</h3>';
-        $this->display_admin_list_table_page_with_no_sidebar();
-    }
-
-
-    protected function _message_legend_items()
-    {
-
-        $action_css_classes = EEH_MSG_Template::get_message_action_icons();
-        $action_items = array();
-
-        foreach ($action_css_classes as $action_item => $action_details) {
-            if ($action_item === 'see_notifications_for') {
-                continue;
-            }
-            $action_items[ $action_item ] = array(
-                'class' => $action_details['css_class'],
-                'desc'  => $action_details['label'],
-            );
-        }
-
-        /** @type array $status_items status legend setup */
-        $status_items = array(
-            'incomplete_status'          => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_incomplete,
-                'desc'  => EEH_Template::pretty_status(EEM_Message::status_incomplete, false, 'sentence'),
-            ),
-            'idle_status'                => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_idle,
-                'desc'  => EEH_Template::pretty_status(EEM_Message::status_idle, false, 'sentence'),
-            ),
-            'resend_status'              => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_resend,
-                'desc'  => EEH_Template::pretty_status(EEM_Message::status_resend, false, 'sentence'),
-            ),
-            'messenger_executing_status' => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_messenger_executing,
-                'desc'  => EEH_Template::pretty_status(EEM_Message::status_messenger_executing, false, 'sentence'),
-            ),
-            'sent_status'                => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_sent,
-                'desc'  => EEH_Template::pretty_status(EEM_Message::status_sent, false, 'sentence'),
-            ),
-            'retry_status'               => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_retry,
-                'desc'  => EEH_Template::pretty_status(EEM_Message::status_retry, false, 'sentence'),
-            ),
-            'failed_status'              => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_failed,
-                'desc'  => EEH_Template::pretty_status(EEM_Message::status_failed, false, 'sentence'),
-            ),
-        );
-        if (EEM_Message::debug()) {
-            $status_items['debug_only_status'] = array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_debug_only,
-                'desc'  => EEH_Template::pretty_status(EEM_Message::status_debug_only, false, 'sentence'),
-            );
-        }
-
-        return array_merge($action_items, $status_items);
-    }
-
-
-    protected function _custom_mtps_preview()
-    {
-        $this->_admin_page_title = esc_html__('Custom Message Templates (Preview)', 'event_espresso');
-        $this->_template_args['preview_img'] = '<img src="' . EE_MSG_ASSETS_URL . 'images/custom_mtps_preview.png"'
-                                               . ' alt="' . esc_attr__(
-                                                   'Preview Custom Message Templates screenshot',
-                                                   'event_espresso'
-                                               ) . '" />';
-        $this->_template_args['preview_text'] = '<strong>'
-                                                . esc_html__(
-                                                    'Custom Message Templates is a feature that is only available in the premium version of Event Espresso 4 which is available with a support license purchase on EventEspresso.com. With the Custom Message Templates feature, you are able to create custom message templates and assign them on a per-event basis.',
-                                                    'event_espresso'
-                                                )
-                                                . '</strong>';
-
-        $this->display_admin_caf_preview_page('custom_message_types', false);
-    }
-
-
-    /**
-     * get_message_templates
-     * This gets all the message templates for listing on the overview list.
-     *
-     * @access public
-     * @param int    $perpage the amount of templates groups to show per page
-     * @param string $type    the current _view we're getting templates for
-     * @param bool   $count   return count?
-     * @param bool   $all     disregard any paging info (get all data);
-     * @param bool   $global  whether to return just global (true) or custom templates (false)
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function get_message_templates(
-        $perpage = 10,
-        $type = 'in_use',
-        $count = false,
-        $all = false,
-        $global = true
-    ) {
-
-        $MTP = EEM_Message_Template_Group::instance();
-
-        $this->_req_data['orderby'] = empty($this->_req_data['orderby']) ? 'GRP_ID' : $this->_req_data['orderby'];
-        $orderby = $this->_req_data['orderby'];
-
-        $order = (isset($this->_req_data['order']) && ! empty($this->_req_data['order']))
-            ? $this->_req_data['order']
-            : 'ASC';
-
-        $current_page = isset($this->_req_data['paged']) && ! empty($this->_req_data['paged'])
-            ? $this->_req_data['paged']
-            : 1;
-        $per_page = isset($this->_req_data['perpage']) && ! empty($this->_req_data['perpage'])
-            ? $this->_req_data['perpage']
-            : $perpage;
-
-        $offset = ($current_page - 1) * $per_page;
-        $limit = $all ? null : array($offset, $per_page);
-
-
-        // options will match what is in the _views array property
-        switch ($type) {
-            case 'in_use':
-                $templates = $MTP->get_all_active_message_templates($orderby, $order, $limit, $count, $global, true);
-                break;
-            default:
-                $templates = $MTP->get_all_trashed_grouped_message_templates($orderby, $order, $limit, $count, $global);
-        }
-
-        return $templates;
-    }
-
-
-    /**
-     * filters etc might need a list of installed message_types
-     *
-     * @return array an array of message type objects
-     */
-    public function get_installed_message_types()
-    {
-        $installed_message_types = $this->_message_resource_manager->installed_message_types();
-        $installed = array();
-
-        foreach ($installed_message_types as $message_type) {
-            $installed[ $message_type->name ] = $message_type;
-        }
-
-        return $installed;
-    }
-
-
-    /**
-     * _add_message_template
-     *
-     * This is used when creating a custom template. All Custom Templates start based off another template.
-     *
-     * @param string $message_type
-     * @param string $messenger
-     * @param string $GRP_ID
-     *
-     * @throws EE_error
-     */
-    protected function _add_message_template($message_type = '', $messenger = '', $GRP_ID = '')
-    {
-        // set values override any request data
-        $message_type = ! empty($message_type) ? $message_type : '';
-        $message_type = empty($message_type) && ! empty($this->_req_data['message_type'])
-            ? $this->_req_data['message_type']
-            : $message_type;
-
-        $messenger = ! empty($messenger) ? $messenger : '';
-        $messenger = empty($messenger) && ! empty($this->_req_data['messenger'])
-            ? $this->_req_data['messenger']
-            : $messenger;
-
-        $GRP_ID = ! empty($GRP_ID) ? $GRP_ID : '';
-        $GRP_ID = empty($GRP_ID) && ! empty($this->_req_data['GRP_ID']) ? $this->_req_data['GRP_ID'] : $GRP_ID;
-
-        // we need messenger and message type.  They should be coming from the event editor. If not here then return error
-        if (empty($message_type) || empty($messenger)) {
-            throw new EE_Error(
-                esc_html__(
-                    'Sorry, but we can\'t create new templates because we\'re missing the messenger or message type',
-                    'event_espresso'
-                )
-            );
-        }
-
-        // we need the GRP_ID for the template being used as the base for the new template
-        if (empty($GRP_ID)) {
-            throw new EE_Error(
-                esc_html__(
-                    'In order to create a custom message template the GRP_ID of the template being used as a base is needed',
-                    'event_espresso'
-                )
-            );
-        }
-
-        // let's just make sure the template gets generated!
-
-        // we need to reassign some variables for what the insert is expecting
-        $this->_req_data['MTP_messenger'] = $messenger;
-        $this->_req_data['MTP_message_type'] = $message_type;
-        $this->_req_data['GRP_ID'] = $GRP_ID;
-        $this->_insert_or_update_message_template(true);
-    }
-
-
-    /**
-     * public wrapper for the _add_message_template method
-     *
-     * @param string $message_type     message type slug
-     * @param string $messenger        messenger slug
-     * @param int    $GRP_ID           GRP_ID for the related message template group this new template will be based
-     *                                 off of.
-     * @throws EE_error
-     */
-    public function add_message_template($message_type, $messenger, $GRP_ID)
-    {
-        $this->_add_message_template($message_type, $messenger, $GRP_ID);
-    }
-
-
-    /**
-     * _edit_message_template
-     *
-     * @access protected
-     * @return void
-     * @throws InvalidIdentifierException
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _edit_message_template()
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $template_fields = '';
-        $sidebar_fields = '';
-        // we filter the tinyMCE settings to remove the validation since message templates by their nature will not have
-        // valid html in the templates.
-        add_filter('tiny_mce_before_init', array($this, 'filter_tinymce_init'), 10, 2);
-
-        $GRP_ID = isset($this->_req_data['id']) && ! empty($this->_req_data['id'])
-            ? absint($this->_req_data['id'])
-            : false;
-
-        $EVT_ID = isset($this->_req_data['evt_id']) && ! empty($this->_req_data['evt_id'])
-        ? absint($this->_req_data['evt_id'])
-        : false;
-
-        $this->_set_shortcodes(); // this also sets the _message_template property.
-        $message_template_group = $this->_message_template_group;
-        $c_label = $message_template_group->context_label();
-        $c_config = $message_template_group->contexts_config();
-
-        reset($c_config);
-        $context = isset($this->_req_data['context']) && ! empty($this->_req_data['context'])
-            ? strtolower($this->_req_data['context'])
-            : key($c_config);
-
-
-        if (empty($GRP_ID)) {
-            $action = 'insert_message_template';
-            $edit_message_template_form_url = add_query_arg(
-                array('action' => $action, 'noheader' => true),
-                EE_MSG_ADMIN_URL
-            );
-        } else {
-            $action = 'update_message_template';
-            $edit_message_template_form_url = add_query_arg(
-                array('action' => $action, 'noheader' => true),
-                EE_MSG_ADMIN_URL
-            );
-        }
-
-        // set active messenger for this view
-        $this->_active_messenger = $this->_message_resource_manager->get_active_messenger(
-            $message_template_group->messenger()
-        );
-        $this->_active_message_type_name = $message_template_group->message_type();
-
-
-        // Do we have any validation errors?
-        $validators = $this->_get_transient();
-        $v_fields = ! empty($validators) ? array_keys($validators) : array();
-
-
-        // we need to assemble the title from Various details
-        $context_label = sprintf(
-            esc_html__('(%s %s)', 'event_espresso'),
-            $c_config[ $context ]['label'],
-            ucwords($c_label['label'])
-        );
-
-        $title = sprintf(
-            esc_html__(' %s %s Template %s', 'event_espresso'),
-            ucwords($message_template_group->messenger_obj()->label['singular']),
-            ucwords($message_template_group->message_type_obj()->label['singular']),
-            $context_label
-        );
-
-        $this->_template_args['GRP_ID'] = $GRP_ID;
-        $this->_template_args['message_template'] = $message_template_group;
-        $this->_template_args['is_extra_fields'] = false;
-
-
-        // let's get EEH_MSG_Template so we can get template form fields
-        $template_field_structure = EEH_MSG_Template::get_fields(
-            $message_template_group->messenger(),
-            $message_template_group->message_type()
-        );
-
-        if (! $template_field_structure) {
-            $template_field_structure = false;
-            $template_fields = esc_html__(
-                'There was an error in assembling the fields for this display (you should see an error message)',
-                'event_espresso'
-            );
-        }
-
-
-        $message_templates = $message_template_group->context_templates();
-
-
-        // if we have the extra key.. then we need to remove the content index from the template_field_structure as it
-        // will get handled in the "extra" array.
-        if (is_array($template_field_structure[ $context ]) && isset($template_field_structure[ $context ]['extra'])) {
-            foreach ($template_field_structure[ $context ]['extra'] as $reference_field => $new_fields) {
-                unset($template_field_structure[ $context ][ $reference_field ]);
-            }
-        }
-
-        // let's loop through the template_field_structure and actually assemble the input fields!
-        if (! empty($template_field_structure)) {
-            foreach ($template_field_structure[ $context ] as $template_field => $field_setup_array) {
-                // if this is an 'extra' template field then we need to remove any existing fields that are keyed up in
-                // the extra array and reset them.
-                if ($template_field === 'extra') {
-                    $this->_template_args['is_extra_fields'] = true;
-                    foreach ($field_setup_array as $reference_field => $new_fields_array) {
-                        $message_template = $message_templates[ $context ][ $reference_field ];
-                        $content = $message_template instanceof EE_Message_Template
-                            ? $message_template->get('MTP_content')
-                            : '';
-                        foreach ($new_fields_array as $extra_field => $extra_array) {
-                            // let's verify if we need this extra field via the shortcodes parameter.
-                            $continue = false;
-                            if (isset($extra_array['shortcodes_required'])) {
-                                foreach ((array) $extra_array['shortcodes_required'] as $shortcode) {
-                                    if (! array_key_exists($shortcode, $this->_shortcodes)) {
-                                        $continue = true;
-                                    }
-                                }
-                                if ($continue) {
-                                    continue;
-                                }
-                            }
-
-                            $field_id = $reference_field
-                                        . '-'
-                                        . $extra_field
-                                        . '-content';
-                            $template_form_fields[ $field_id ] = $extra_array;
-                            $template_form_fields[ $field_id ]['name'] = 'MTP_template_fields['
-                                                                         . $reference_field
-                                                                         . '][content]['
-                                                                         . $extra_field . ']';
-                            $css_class = isset($extra_array['css_class'])
-                                ? $extra_array['css_class']
-                                : '';
-
-                            $template_form_fields[ $field_id ]['css_class'] = ! empty($v_fields)
-                                                                              && in_array($extra_field, $v_fields, true)
-                                                                              &&
-                                                                              (
-                                                                                  is_array($validators[ $extra_field ])
-                                                                                  && isset($validators[ $extra_field ]['msg'])
-                                                                              )
-                                ? 'validate-error ' . $css_class
-                                : $css_class;
-
-                            $template_form_fields[ $field_id ]['value'] = ! empty($message_templates)
-                                                                          && isset($content[ $extra_field ])
-                                ? $content[ $extra_field ]
-                                : '';
-
-                            // do we have a validation error?  if we do then let's use that value instead
-                            $template_form_fields[ $field_id ]['value'] = isset($validators[ $extra_field ])
-                                ? $validators[ $extra_field ]['value']
-                                : $template_form_fields[ $field_id ]['value'];
-
-
-                            $template_form_fields[ $field_id ]['db-col'] = 'MTP_content';
-
-                            // shortcode selector
-                            $field_name_to_use = $extra_field === 'main'
-                                ? 'content'
-                                : $extra_field;
-                            $template_form_fields[ $field_id ]['append_content'] = $this->_get_shortcode_selector(
-                                $field_name_to_use,
-                                $field_id
-                            );
-
-                            if (isset($extra_array['input']) && $extra_array['input'] === 'wp_editor') {
-                                // we want to decode the entities
-                                $template_form_fields[ $field_id ]['value'] = $template_form_fields[ $field_id ]['value'];
-                            }/**/
-                        }
-                        $templatefield_MTP_id = $reference_field . '-MTP_ID';
-                        $templatefield_templatename_id = $reference_field . '-name';
-
-                        $template_form_fields[ $templatefield_MTP_id ] = array(
-                            'name'       => 'MTP_template_fields[' . $reference_field . '][MTP_ID]',
-                            'label'      => null,
-                            'input'      => 'hidden',
-                            'type'       => 'int',
-                            'required'   => false,
-                            'validation' => false,
-                            'value'      => ! empty($message_templates) ? $message_template->ID() : '',
-                            'css_class'  => '',
-                            'format'     => '%d',
-                            'db-col'     => 'MTP_ID',
-                        );
-
-                        $template_form_fields[ $templatefield_templatename_id ] = array(
-                            'name'       => 'MTP_template_fields[' . $reference_field . '][name]',
-                            'label'      => null,
-                            'input'      => 'hidden',
-                            'type'       => 'string',
-                            'required'   => false,
-                            'validation' => true,
-                            'value'      => $reference_field,
-                            'css_class'  => '',
-                            'format'     => '%s',
-                            'db-col'     => 'MTP_template_field',
-                        );
-                    }
-                    continue; // skip the next stuff, we got the necessary fields here for this dataset.
-                } else {
-                    $field_id = $template_field . '-content';
-                    $template_form_fields[ $field_id ] = $field_setup_array;
-                    $template_form_fields[ $field_id ]['name'] = 'MTP_template_fields[' . $template_field . '][content]';
-                    $message_template = isset($message_templates[ $context ][ $template_field ])
-                        ? $message_templates[ $context ][ $template_field ]
-                        : null;
-                    $template_form_fields[ $field_id ]['value'] = ! empty($message_templates)
-                                                                  && is_array($message_templates[ $context ])
-                                                                  && $message_template instanceof EE_Message_Template
-                        ? $message_template->get('MTP_content')
-                        : '';
-
-                    // do we have a validator error for this field?  if we do then we'll use that value instead
-                    $template_form_fields[ $field_id ]['value'] = isset($validators[ $template_field ])
-                        ? $validators[ $template_field ]['value']
-                        : $template_form_fields[ $field_id ]['value'];
-
-
-                    $template_form_fields[ $field_id ]['db-col'] = 'MTP_content';
-                    $css_class = isset($field_setup_array['css_class'])
-                        ? $field_setup_array['css_class']
-                        : '';
-                    $template_form_fields[ $field_id ]['css_class'] = ! empty($v_fields)
-                                                                      && in_array($template_field, $v_fields, true)
-                                                                      && isset($validators[ $template_field ]['msg'])
-                        ? 'validate-error ' . $css_class
-                        : $css_class;
-
-                    // shortcode selector
-                    $template_form_fields[ $field_id ]['append_content'] = $this->_get_shortcode_selector(
-                        $template_field,
-                        $field_id
-                    );
-                }
-
-                // k took care of content field(s) now let's take care of others.
-
-                $templatefield_MTP_id = $template_field . '-MTP_ID';
-                $templatefield_field_templatename_id = $template_field . '-name';
-
-                // foreach template field there are actually two form fields created
-                $template_form_fields[ $templatefield_MTP_id ] = array(
-                    'name'       => 'MTP_template_fields[' . $template_field . '][MTP_ID]',
-                    'label'      => null,
-                    'input'      => 'hidden',
-                    'type'       => 'int',
-                    'required'   => false,
-                    'validation' => true,
-                    'value'      => $message_template instanceof EE_Message_Template ? $message_template->ID() : '',
-                    'css_class'  => '',
-                    'format'     => '%d',
-                    'db-col'     => 'MTP_ID',
-                );
-
-                $template_form_fields[ $templatefield_field_templatename_id ] = array(
-                    'name'       => 'MTP_template_fields[' . $template_field . '][name]',
-                    'label'      => null,
-                    'input'      => 'hidden',
-                    'type'       => 'string',
-                    'required'   => false,
-                    'validation' => true,
-                    'value'      => $template_field,
-                    'css_class'  => '',
-                    'format'     => '%s',
-                    'db-col'     => 'MTP_template_field',
-                );
-            }
-
-            // add other fields
-            $template_form_fields['ee-msg-current-context'] = array(
-                'name'       => 'MTP_context',
-                'label'      => null,
-                'input'      => 'hidden',
-                'type'       => 'string',
-                'required'   => false,
-                'validation' => true,
-                'value'      => $context,
-                'css_class'  => '',
-                'format'     => '%s',
-                'db-col'     => 'MTP_context',
-            );
-
-            $template_form_fields['ee-msg-grp-id'] = array(
-                'name'       => 'GRP_ID',
-                'label'      => null,
-                'input'      => 'hidden',
-                'type'       => 'int',
-                'required'   => false,
-                'validation' => true,
-                'value'      => $GRP_ID,
-                'css_class'  => '',
-                'format'     => '%d',
-                'db-col'     => 'GRP_ID',
-            );
-
-            $template_form_fields['ee-msg-messenger'] = array(
-                'name'       => 'MTP_messenger',
-                'label'      => null,
-                'input'      => 'hidden',
-                'type'       => 'string',
-                'required'   => false,
-                'validation' => true,
-                'value'      => $message_template_group->messenger(),
-                'css_class'  => '',
-                'format'     => '%s',
-                'db-col'     => 'MTP_messenger',
-            );
-
-            $template_form_fields['ee-msg-message-type'] = array(
-                'name'       => 'MTP_message_type',
-                'label'      => null,
-                'input'      => 'hidden',
-                'type'       => 'string',
-                'required'   => false,
-                'validation' => true,
-                'value'      => $message_template_group->message_type(),
-                'css_class'  => '',
-                'format'     => '%s',
-                'db-col'     => 'MTP_message_type',
-            );
-
-            $sidebar_form_fields['ee-msg-is-global'] = array(
-                'name'       => 'MTP_is_global',
-                'label'      => esc_html__('Global Template', 'event_espresso'),
-                'input'      => 'hidden',
-                'type'       => 'int',
-                'required'   => false,
-                'validation' => true,
-                'value'      => $message_template_group->get('MTP_is_global'),
-                'css_class'  => '',
-                'format'     => '%d',
-                'db-col'     => 'MTP_is_global',
-            );
-
-            $sidebar_form_fields['ee-msg-is-override'] = array(
-                'name'       => 'MTP_is_override',
-                'label'      => esc_html__('Override all custom', 'event_espresso'),
-                'input'      => $message_template_group->is_global() ? 'checkbox' : 'hidden',
-                'type'       => 'int',
-                'required'   => false,
-                'validation' => true,
-                'value'      => $message_template_group->get('MTP_is_override'),
-                'css_class'  => '',
-                'format'     => '%d',
-                'db-col'     => 'MTP_is_override',
-            );
-
-            $sidebar_form_fields['ee-msg-is-active'] = array(
-                'name'       => 'MTP_is_active',
-                'label'      => esc_html__('Active Template', 'event_espresso'),
-                'input'      => 'hidden',
-                'type'       => 'int',
-                'required'   => false,
-                'validation' => true,
-                'value'      => $message_template_group->is_active(),
-                'css_class'  => '',
-                'format'     => '%d',
-                'db-col'     => 'MTP_is_active',
-            );
-
-            $sidebar_form_fields['ee-msg-deleted'] = array(
-                'name'       => 'MTP_deleted',
-                'label'      => null,
-                'input'      => 'hidden',
-                'type'       => 'int',
-                'required'   => false,
-                'validation' => true,
-                'value'      => $message_template_group->get('MTP_deleted'),
-                'css_class'  => '',
-                'format'     => '%d',
-                'db-col'     => 'MTP_deleted',
-            );
-            $sidebar_form_fields['ee-msg-author'] = array(
-                'name'       => 'MTP_user_id',
-                'label'      => esc_html__('Author', 'event_espresso'),
-                'input'      => 'hidden',
-                'type'       => 'int',
-                'required'   => false,
-                'validation' => false,
-                'value'      => $message_template_group->user(),
-                'format'     => '%d',
-                'db-col'     => 'MTP_user_id',
-            );
-
-            $sidebar_form_fields['ee-msg-route'] = array(
-                'name'  => 'action',
-                'input' => 'hidden',
-                'type'  => 'string',
-                'value' => $action,
-            );
-
-            $sidebar_form_fields['ee-msg-id'] = array(
-                'name'  => 'id',
-                'input' => 'hidden',
-                'type'  => 'int',
-                'value' => $GRP_ID,
-            );
-            $sidebar_form_fields['ee-msg-evt-nonce'] = array(
-                'name'  => $action . '_nonce',
-                'input' => 'hidden',
-                'type'  => 'string',
-                'value' => wp_create_nonce($action . '_nonce'),
-            );
-
-            if (isset($this->_req_data['template_switch']) && $this->_req_data['template_switch']) {
-                $sidebar_form_fields['ee-msg-template-switch'] = array(
-                    'name'  => 'template_switch',
-                    'input' => 'hidden',
-                    'type'  => 'int',
-                    'value' => 1,
-                );
-            }
-
-
-            $template_fields = $this->_generate_admin_form_fields($template_form_fields);
-            $sidebar_fields = $this->_generate_admin_form_fields($sidebar_form_fields);
-        } //end if ( !empty($template_field_structure) )
-
-        // set extra content for publish box
-        $this->_template_args['publish_box_extra_content'] = $sidebar_fields;
-        $this->_set_publish_post_box_vars(
-            'id',
-            $GRP_ID,
-            false,
-            add_query_arg(
-                array('action' => 'global_mtps'),
-                $this->_admin_base_url
-            )
-        );
-
-        // add preview button
-        $preview_url = parent::add_query_args_and_nonce(
-            array(
-                'message_type' => $message_template_group->message_type(),
-                'messenger'    => $message_template_group->messenger(),
-                'context'      => $context,
-                'GRP_ID'       => $GRP_ID,
-                'evt_id'       => $EVT_ID,
-                'action'       => 'preview_message',
-            ),
-            $this->_admin_base_url
-        );
-        $preview_button = '<a href="' . $preview_url . '" class="button-secondary messages-preview-button">'
-                          . esc_html__('Preview', 'event_espresso')
-                          . '</a>';
-
-
-        // setup context switcher
-        $context_switcher_args = array(
-            'page'    => 'espresso_messages',
-            'action'  => 'edit_message_template',
-            'id'      => $GRP_ID,
-            'evt_id'  => $EVT_ID,
-            'context' => $context,
-            'extra'   => $preview_button,
-        );
-        $this->_set_context_switcher($message_template_group, $context_switcher_args);
-
-
-        // main box
-        $this->_template_args['template_fields'] = $template_fields;
-        $this->_template_args['sidebar_box_id'] = 'details';
-        $this->_template_args['action'] = $action;
-        $this->_template_args['context'] = $context;
-        $this->_template_args['edit_message_template_form_url'] = $edit_message_template_form_url;
-        $this->_template_args['learn_more_about_message_templates_link'] =
-            $this->_learn_more_about_message_templates_link();
-
-
-        $this->_template_args['before_admin_page_content'] = $this->add_context_switcher();
-        $this->_template_args['before_admin_page_content'] .= $this->add_active_context_element(
-            $message_template_group,
-            $context,
-            $context_label
-        );
-        $this->_template_args['before_admin_page_content'] .= $this->_add_form_element_before();
-        $this->_template_args['after_admin_page_content'] = $this->_add_form_element_after();
-
-        $this->_template_path = $this->_template_args['GRP_ID']
-            ? EE_MSG_TEMPLATE_PATH . 'ee_msg_details_main_edit_meta_box.template.php'
-            : EE_MSG_TEMPLATE_PATH . 'ee_msg_details_main_add_meta_box.template.php';
-
-        // send along EE_Message_Template_Group object for further template use.
-        $this->_template_args['MTP'] = $message_template_group;
-
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            $this->_template_path,
-            $this->_template_args,
-            true
-        );
-
-
-        // finally, let's set the admin_page title
-        $this->_admin_page_title = sprintf(__('Editing %s', 'event_espresso'), $title);
-
-
-        // we need to take care of setting the shortcodes property for use elsewhere.
-        $this->_set_shortcodes();
-
-
-        // final template wrapper
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    public function filter_tinymce_init($mceInit, $editor_id)
-    {
-        return $mceInit;
-    }
-
-
-    public function add_context_switcher()
-    {
-        return $this->_context_switcher;
-    }
-
-
-    /**
-     * Adds the activation/deactivation toggle for the message template context.
-     *
-     * @param EE_Message_Template_Group $message_template_group
-     * @param string                    $context
-     * @param string                    $context_label
-     * @return string
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidIdentifierException
-     */
-    protected function add_active_context_element(
-        EE_Message_Template_Group $message_template_group,
-        $context,
-        $context_label
-    ) {
-        $template_args = array(
-            'context'                   => $context,
-            'nonce'                     => wp_create_nonce('activate_' . $context . '_toggle_nonce'),
-            'is_active'                 => $message_template_group->is_context_active($context),
-            'on_off_action'             => $message_template_group->is_context_active($context)
-                ? 'context-off'
-                : 'context-on',
-            'context_label'             => str_replace(array('(', ')'), '', $context_label),
-            'message_template_group_id' => $message_template_group->ID(),
-        );
-        return EEH_Template::display_template(
-            EE_MSG_TEMPLATE_PATH . 'ee_msg_editor_active_context_element.template.php',
-            $template_args,
-            true
-        );
-    }
-
-
-    /**
-     * Ajax callback for `toggle_context_template` ajax action.
-     * Handles toggling the message context on or off.
-     *
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidIdentifierException
-     * @throws InvalidInterfaceException
-     */
-    public function toggle_context_template()
-    {
-        $success = true;
-        // check for required data
-        if (
-            ! isset(
-                $this->_req_data['message_template_group_id'],
-                $this->_req_data['context'],
-                $this->_req_data['status']
-            )
-        ) {
-            EE_Error::add_error(
-                esc_html__('Required data for doing this action is not available.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $success = false;
-        }
-
-        $nonce = isset($this->_req_data['toggle_context_nonce'])
-            ? sanitize_text_field($this->_req_data['toggle_context_nonce'])
-            : '';
-        $nonce_ref = 'activate_' . $this->_req_data['context'] . '_toggle_nonce';
-        $this->_verify_nonce($nonce, $nonce_ref);
-        $status = $this->_req_data['status'];
-        if ($status !== 'off' && $status !== 'on') {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__('The given status (%s) is not valid. Must be "off" or "on"', 'event_espresso'),
-                    $this->_req_data['status']
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $success = false;
-        }
-        $message_template_group = EEM_Message_Template_Group::instance()->get_one_by_ID(
-            $this->_req_data['message_template_group_id']
-        );
-        if (! $message_template_group instanceof EE_Message_Template_Group) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'Unable to change the active state because the given id "%1$d" does not match a valid "%2$s"',
-                        'event_espresso'
-                    ),
-                    $this->_req_data['message_template_group_id'],
-                    'EE_Message_Template_Group'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $success = false;
-        }
-        if ($success) {
-            $success = $status === 'off'
-                ? $message_template_group->deactivate_context($this->_req_data['context'])
-                : $message_template_group->activate_context($this->_req_data['context']);
-        }
-        $this->_template_args['success'] = $success;
-        $this->_return_json();
-    }
-
-
-    public function _add_form_element_before()
-    {
-        return '<form method="post" action="'
-               . $this->_template_args["edit_message_template_form_url"]
-               . '" id="ee-msg-edit-frm">';
-    }
-
-    public function _add_form_element_after()
-    {
-        return '</form>';
-    }
-
-
-    /**
-     * This executes switching the template pack for a message template.
-     *
-     * @since 4.5.0
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     */
-    public function switch_template_pack()
-    {
-        $GRP_ID = ! empty($this->_req_data['GRP_ID']) ? $this->_req_data['GRP_ID'] : 0;
-        $template_pack = ! empty($this->_req_data['template_pack']) ? $this->_req_data['template_pack'] : '';
-
-        // verify we have needed values.
-        if (empty($GRP_ID) || empty($template_pack)) {
-            $this->_template_args['error'] = true;
-            EE_Error::add_error(
-                esc_html__('The required date for switching templates is not available.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        } else {
-            // get template, set the new template_pack and then reset to default
-            /** @type EE_Message_Template_Group $message_template_group */
-            $message_template_group = EEM_Message_Template_Group::instance()->get_one_by_ID($GRP_ID);
-
-            $message_template_group->set_template_pack_name($template_pack);
-            $this->_req_data['msgr'] = $message_template_group->messenger();
-            $this->_req_data['mt'] = $message_template_group->message_type();
-
-            $query_args = $this->_reset_to_default_template();
-
-            if (empty($query_args['id'])) {
-                EE_Error::add_error(
-                    esc_html__(
-                        'Something went wrong with switching the template pack. Please try again or contact EE support',
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-                $this->_template_args['error'] = true;
-            } else {
-                $template_label = $message_template_group->get_template_pack()->label;
-                $template_pack_labels = $message_template_group->messenger_obj()->get_supports_labels();
-                EE_Error::add_success(
-                    sprintf(
-                        esc_html__(
-                            'This message template has been successfully switched to use the %1$s %2$s.  Please wait while the page reloads with your new template.',
-                            'event_espresso'
-                        ),
-                        $template_label,
-                        $template_pack_labels->template_pack
-                    )
-                );
-                // generate the redirect url for js.
-                $url = self::add_query_args_and_nonce(
-                    $query_args,
-                    $this->_admin_base_url
-                );
-                $this->_template_args['data']['redirect_url'] = $url;
-                $this->_template_args['success'] = true;
-            }
-
-            $this->_return_json();
-        }
-    }
-
-
-    /**
-     * This handles resetting the template for the given messenger/message_type so that users can start from scratch if
-     * they want.
-     *
-     * @access protected
-     * @return array|null
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _reset_to_default_template()
-    {
-
-        $templates = array();
-        $GRP_ID = ! empty($this->_req_data['GRP_ID']) ? $this->_req_data['GRP_ID'] : 0;
-        // we need to make sure we've got the info we need.
-        if (! isset($this->_req_data['msgr'], $this->_req_data['mt'], $this->_req_data['GRP_ID'])) {
-            EE_Error::add_error(
-                esc_html__(
-                    'In order to reset the template to its default we require the messenger, message type, and message template GRP_ID to know what is being reset.  At least one of these is missing.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-
-        // all templates will be reset to whatever the defaults are
-        // for the global template matching the messenger and message type.
-        $success = ! empty($GRP_ID) ? true : false;
-
-        if ($success) {
-            // let's first determine if the incoming template is a global template,
-            // if it isn't then we need to get the global template matching messenger and message type.
-            // $MTPG = EEM_Message_Template_Group::instance()->get_one_by_ID( $GRP_ID );
-
-
-            // note this is ONLY deleting the template fields (Message Template rows) NOT the message template group.
-            $success = $this->_delete_mtp_permanently($GRP_ID, false);
-
-            if ($success) {
-                // if successfully deleted, lets generate the new ones.
-                // Note. We set GLOBAL to true, because resets on ANY template
-                // will use the related global template defaults for regeneration.
-                // This means that if a custom template is reset it resets to whatever the related global template is.
-                // HOWEVER, we DO keep the template pack and template variation set
-                // for the current custom template when resetting.
-                $templates = $this->_generate_new_templates(
-                    $this->_req_data['msgr'],
-                    $this->_req_data['mt'],
-                    $GRP_ID,
-                    true
-                );
-            }
-        }
-
-        // any error messages?
-        if (! $success) {
-            EE_Error::add_error(
-                esc_html__(
-                    'Something went wrong with deleting existing templates. Unable to reset to default',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-
-        // all good, let's add a success message!
-        if ($success && ! empty($templates)) {
-            // the info for the template we generated is the first element in the returned array
-            // $templates = $templates[0];
-            EE_Error::overwrite_success();
-            EE_Error::add_success(__('Templates have been reset to defaults.', 'event_espresso'));
-        }
-
-
-        $query_args = array(
-            'id'      => isset($templates[0]['GRP_ID']) ? $templates[0]['GRP_ID'] : null,
-            'context' => isset($templates[0]['MTP_context']) ? $templates[0]['MTP_context'] : null,
-            'action'  => isset($templates[0]['GRP_ID']) ? 'edit_message_template' : 'global_mtps',
-        );
-
-        // if called via ajax then we return query args otherwise redirect
-        if (defined('DOING_AJAX') && DOING_AJAX) {
-            return $query_args;
-        } else {
-            $this->_redirect_after_action(false, '', '', $query_args, true);
-
-            return null;
-        }
-    }
-
-
-    /**
-     * Retrieve and set the message preview for display.
-     *
-     * @param bool $send if TRUE then we are doing an actual TEST send with the results of the preview.
-     * @return string
-     * @throws ReflectionException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function _preview_message($send = false)
-    {
-        // first make sure we've got the necessary parameters
-        if (
-            ! isset(
-                $this->_req_data['message_type'],
-                $this->_req_data['messenger'],
-                $this->_req_data['messenger'],
-                $this->_req_data['GRP_ID']
-            )
-        ) {
-            EE_Error::add_error(
-                esc_html__('Missing necessary parameters for displaying preview', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-
-        EE_Registry::instance()->REQ->set('GRP_ID', $this->_req_data['GRP_ID']);
-
-        // if we have an evt_id set on the request, use it.
-        $EVT_ID = isset($this->_req_data['evt_id']) && ! empty($this->_req_data['evt_id'])
-        ? absint($this->_req_data['evt_id'])
-        : false;
-
-
-        // get the preview!
-        $preview = EED_Messages::preview_message(
-            $this->_req_data['message_type'],
-            $this->_req_data['context'],
-            $this->_req_data['messenger'],
-            $send
-        );
-
-        if ($send) {
-            return $preview;
-        }
-
-        // let's add a button to go back to the edit view
-        $query_args = array(
-            'id'      => $this->_req_data['GRP_ID'],
-            'evt_id'  => $EVT_ID,
-            'context' => $this->_req_data['context'],
-            'action'  => 'edit_message_template',
-        );
-        $go_back_url = parent::add_query_args_and_nonce($query_args, $this->_admin_base_url);
-        $preview_button = '<a href="'
-                          . $go_back_url
-                          . '" class="button-secondary messages-preview-go-back-button">'
-                          . esc_html__('Go Back to Edit', 'event_espresso')
-                          . '</a>';
-        $message_types = $this->get_installed_message_types();
-        $active_messenger = $this->_message_resource_manager->get_active_messenger(
-            $this->_req_data['messenger']
-        );
-        $active_messenger_label = $active_messenger instanceof EE_messenger
-            ? ucwords($active_messenger->label['singular'])
-            : esc_html__('Unknown Messenger', 'event_espresso');
-        // let's provide a helpful title for context
-        $preview_title = sprintf(
-            esc_html__('Viewing Preview for %s %s Message Template', 'event_espresso'),
-            $active_messenger_label,
-            ucwords($message_types[ $this->_req_data['message_type'] ]->label['singular'])
-        );
-        if (empty($preview)) {
-            $this->noEventsErrorMessage();
-        }
-        // setup display of preview.
-        $this->_admin_page_title = $preview_title;
-        $this->_template_args['admin_page_title'] = $preview_title;
-        $this->_template_args['admin_page_content'] = $preview_button . '<br />' . $preview;
-        $this->_template_args['data']['force_json'] = true;
-
-        return '';
-    }
-
-
-    /**
-     * Used to set an error if there are no events available for generating a preview/test send.
-     *
-     * @param bool $test_send  Whether the error should be generated for the context of a test send.
-     */
-    protected function noEventsErrorMessage($test_send = false)
-    {
-        $events_url = parent::add_query_args_and_nonce(
-            array(
-                'action' => 'default',
-                'page'   => 'espresso_events',
-            ),
-            admin_url('admin.php')
-        );
-        $message = $test_send
-            ? __(
-                'A test message could not be sent for this message template because there are no events created yet. The preview system uses actual events for generating the test message. %1$sGo see your events%2$s!',
-                'event_espresso'
-            )
-            : __(
-                'There is no preview for this message template available because there are no events created yet. The preview system uses actual events for generating the preview. %1$sGo see your events%2$s!',
-                'event_espresso'
-            );
-
-        EE_Error::add_attention(
-            sprintf(
-                $message,
-                "<a href='{$events_url}'>",
-                '</a>'
-            )
-        );
-    }
-
-
-    /**
-     * The initial _preview_message is on a no headers route.  It will optionally call this if necessary otherwise it
-     * gets called automatically.
-     *
-     * @since 4.5.0
-     *
-     * @return string
-     */
-    protected function _display_preview_message()
-    {
-        $this->display_admin_page_with_no_sidebar();
-    }
-
-
-    /**
-     * registers metaboxes that should show up on the "edit_message_template" page
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _register_edit_meta_boxes()
-    {
-        add_meta_box(
-            'mtp_valid_shortcodes',
-            esc_html__('Valid Shortcodes', 'event_espresso'),
-            array($this, 'shortcode_meta_box'),
-            $this->_current_screen->id,
-            'side',
-            'default'
-        );
-        add_meta_box(
-            'mtp_extra_actions',
-            esc_html__('Extra Actions', 'event_espresso'),
-            array($this, 'extra_actions_meta_box'),
-            $this->_current_screen->id,
-            'side',
-            'high'
-        );
-        add_meta_box(
-            'mtp_templates',
-            esc_html__('Template Styles', 'event_espresso'),
-            array($this, 'template_pack_meta_box'),
-            $this->_current_screen->id,
-            'side',
-            'high'
-        );
-    }
-
-
-    /**
-     * metabox content for all template pack and variation selection.
-     *
-     * @since 4.5.0
-     * @return string
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function template_pack_meta_box()
-    {
-        $this->_set_message_template_group();
-
-        $tp_collection = EEH_MSG_Template::get_template_pack_collection();
-
-        $tp_select_values = array();
-
-        foreach ($tp_collection as $tp) {
-            // only include template packs that support this messenger and message type!
-            $supports = $tp->get_supports();
-            if (
-                ! isset($supports[ $this->_message_template_group->messenger() ])
-                || ! in_array(
-                    $this->_message_template_group->message_type(),
-                    $supports[ $this->_message_template_group->messenger() ],
-                    true
-                )
-            ) {
-                // not supported
-                continue;
-            }
-
-            $tp_select_values[] = array(
-                'text' => $tp->label,
-                'id'   => $tp->dbref,
-            );
-        }
-
-        // if empty $tp_select_values then we make sure default is set because EVERY message type should be supported by
-        // the default template pack.  This still allows for the odd template pack to override.
-        if (empty($tp_select_values)) {
-            $tp_select_values[] = array(
-                'text' => esc_html__('Default', 'event_espresso'),
-                'id'   => 'default',
-            );
-        }
-
-        // setup variation select values for the currently selected template.
-        $variations = $this->_message_template_group->get_template_pack()->get_variations(
-            $this->_message_template_group->messenger(),
-            $this->_message_template_group->message_type()
-        );
-        $variations_select_values = array();
-        foreach ($variations as $variation => $label) {
-            $variations_select_values[] = array(
-                'text' => $label,
-                'id'   => $variation,
-            );
-        }
-
-        $template_pack_labels = $this->_message_template_group->messenger_obj()->get_supports_labels();
-
-        $template_args['template_packs_selector'] = EEH_Form_Fields::select_input(
-            'MTP_template_pack',
-            $tp_select_values,
-            $this->_message_template_group->get_template_pack_name()
-        );
-        $template_args['variations_selector'] = EEH_Form_Fields::select_input(
-            'MTP_template_variation',
-            $variations_select_values,
-            $this->_message_template_group->get_template_pack_variation()
-        );
-        $template_args['template_pack_label'] = $template_pack_labels->template_pack;
-        $template_args['template_variation_label'] = $template_pack_labels->template_variation;
-        $template_args['template_pack_description'] = $template_pack_labels->template_pack_description;
-        $template_args['template_variation_description'] = $template_pack_labels->template_variation_description;
-
-        $template = EE_MSG_TEMPLATE_PATH . 'template_pack_and_variations_metabox.template.php';
-
-        EEH_Template::display_template($template, $template_args);
-    }
-
-
-    /**
-     * This meta box holds any extra actions related to Message Templates
-     * For now, this includes Resetting templates to defaults and sending a test email.
-     *
-     * @access  public
-     * @return void
-     * @throws EE_Error
-     */
-    public function extra_actions_meta_box()
-    {
-        $template_form_fields = array();
-
-        $extra_args = array(
-            'msgr'   => $this->_message_template_group->messenger(),
-            'mt'     => $this->_message_template_group->message_type(),
-            'GRP_ID' => $this->_message_template_group->GRP_ID(),
-        );
-        // first we need to see if there are any fields
-        $fields = $this->_message_template_group->messenger_obj()->get_test_settings_fields();
-
-        if (! empty($fields)) {
-            // yup there be fields
-            foreach ($fields as $field => $config) {
-                $field_id = $this->_message_template_group->messenger() . '_' . $field;
-                $existing = $this->_message_template_group->messenger_obj()->get_existing_test_settings();
-                $default = isset($config['default']) ? $config['default'] : '';
-                $default = isset($config['value']) ? $config['value'] : $default;
-
-                // if type is hidden and the value is empty
-                // something may have gone wrong so let's correct with the defaults
-                $fix = $config['input'] === 'hidden'
-                       && isset($existing[ $field ])
-                       && empty($existing[ $field ])
-                    ? $default
-                    : '';
-                $existing[ $field ] = isset($existing[ $field ]) && empty($fix)
-                    ? $existing[ $field ]
-                    : $fix;
-
-                $template_form_fields[ $field_id ] = array(
-                    'name'       => 'test_settings_fld[' . $field . ']',
-                    'label'      => $config['label'],
-                    'input'      => $config['input'],
-                    'type'       => $config['type'],
-                    'required'   => $config['required'],
-                    'validation' => $config['validation'],
-                    'value'      => isset($existing[ $field ]) ? $existing[ $field ] : $default,
-                    'css_class'  => $config['css_class'],
-                    'options'    => isset($config['options']) ? $config['options'] : array(),
-                    'default'    => $default,
-                    'format'     => $config['format'],
-                );
-            }
-        }
-
-        $test_settings_fields = ! empty($template_form_fields)
-            ? $this->_generate_admin_form_fields($template_form_fields, 'string', 'ee_tst_settings_flds')
-            : '';
-
-        $test_settings_html = '';
-        // print out $test_settings_fields
-        if (! empty($test_settings_fields)) {
-            echo $test_settings_fields;
-            $test_settings_html = '<input type="submit" class="button-primary mtp-test-button alignright" ';
-            $test_settings_html .= 'name="test_button" value="';
-            $test_settings_html .= esc_html__('Test Send', 'event_espresso');
-            $test_settings_html .= '" /><div style="clear:both"></div>';
-        }
-
-        // and button
-        $test_settings_html .= '<p>'
-                               . esc_html__('Need to reset this message type and start over?', 'event_espresso')
-                               . '</p>';
-        $test_settings_html .= '<div class="publishing-action alignright resetbutton">';
-        $test_settings_html .= $this->get_action_link_or_button(
-            'reset_to_default',
-            'reset',
-            $extra_args,
-            'button-primary reset-default-button'
-        );
-        $test_settings_html .= '</div><div style="clear:both"></div>';
-        echo $test_settings_html;
-    }
-
-
-    /**
-     * This returns the shortcode selector skeleton for a given context and field.
-     *
-     * @since 4.9.rc.000
-     * @param string $field           The name of the field retrieving shortcodes for.
-     * @param string $linked_input_id The css id of the input that the shortcodes get added to.
-     * @return string
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _get_shortcode_selector($field, $linked_input_id)
-    {
-        $template_args = array(
-            'shortcodes'      => $this->_get_shortcodes(array($field), true),
-            'fieldname'       => $field,
-            'linked_input_id' => $linked_input_id,
-        );
-
-        return EEH_Template::display_template(
-            EE_MSG_TEMPLATE_PATH . 'shortcode_selector_skeleton.template.php',
-            $template_args,
-            true
-        );
-    }
-
-
-    /**
-     * This just takes care of returning the meta box content for shortcodes (only used on the edit message template
-     * page)
-     *
-     * @access public
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function shortcode_meta_box()
-    {
-        $shortcodes = $this->_get_shortcodes(array(), false); // just make sure shortcodes property is set
-        // $messenger = $this->_message_template_group->messenger_obj();
-        // now let's set the content depending on the status of the shortcodes array
-        if (empty($shortcodes)) {
-            $content = '<p>' . esc_html__('There are no valid shortcodes available', 'event_espresso') . '</p>';
-            echo $content;
-        } else {
-            // $alt = 0;
-            ?>
+	/**
+	 * @type EE_Message_Resource_Manager $_message_resource_manager
+	 */
+	protected $_message_resource_manager;
+
+	/**
+	 * @type string $_active_message_type_name
+	 */
+	protected $_active_message_type_name = '';
+
+	/**
+	 * @type EE_messenger $_active_messenger
+	 */
+	protected $_active_messenger;
+	protected $_activate_state;
+	protected $_activate_meta_box_type;
+	protected $_current_message_meta_box;
+	protected $_current_message_meta_box_object;
+	protected $_context_switcher;
+	protected $_shortcodes = array();
+	protected $_active_messengers = array();
+	protected $_active_message_types = array();
+
+	/**
+	 * @var EE_Message_Template_Group $_message_template_group
+	 */
+	protected $_message_template_group;
+	protected $_m_mt_settings = array();
+
+
+	/**
+	 * This is set via the _set_message_template_group method and holds whatever the template pack for the group is.
+	 * IF there is no group then it gets automatically set to the Default template pack.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @var EE_Messages_Template_Pack
+	 */
+	protected $_template_pack;
+
+
+	/**
+	 * This is set via the _set_message_template_group method and holds whatever the template pack variation for the
+	 * group is.  If there is no group then it automatically gets set to default.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @var string
+	 */
+	protected $_variation;
+
+
+	/**
+	 * @param bool $routing
+	 * @throws EE_Error
+	 */
+	public function __construct($routing = true)
+	{
+		// make sure messages autoloader is running
+		EED_Messages::set_autoloaders();
+		parent::__construct($routing);
+	}
+
+
+	protected function _init_page_props()
+	{
+		$this->page_slug = EE_MSG_PG_SLUG;
+		$this->page_label = esc_html__('Messages Settings', 'event_espresso');
+		$this->_admin_base_url = EE_MSG_ADMIN_URL;
+		$this->_admin_base_path = EE_MSG_ADMIN;
+
+		$this->_activate_state = isset($this->_req_data['activate_state']) ? (array) $this->_req_data['activate_state']
+			: array();
+
+		$this->_active_messenger = isset($this->_req_data['messenger']) ? $this->_req_data['messenger'] : null;
+		$this->_load_message_resource_manager();
+	}
+
+
+	/**
+	 * loads messenger objects into the $_active_messengers property (so we can access the needed methods)
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 */
+	protected function _load_message_resource_manager()
+	{
+		$this->_message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+	}
+
+
+	/**
+	 * @deprecated 4.9.9.rc.014
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function get_messengers_for_list_table()
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			sprintf(
+				esc_html__(
+					'This method is no longer in use.  There is no replacement for it. The method was used to generate a set of values for use in creating a messenger filter dropdown which is now generated differently via %s',
+					'event_espresso'
+				),
+				'Messages_Admin_Page::get_messengers_select_input()'
+			),
+			'4.9.9.rc.014'
+		);
+
+		$m_values = array();
+		$active_messengers = EEM_Message::instance()->get_all(array('group_by' => 'MSG_messenger'));
+		// setup messengers for selects
+		$i = 1;
+		foreach ($active_messengers as $active_messenger) {
+			if ($active_messenger instanceof EE_Message) {
+				$m_values[ $i ]['id'] = $active_messenger->messenger();
+				$m_values[ $i ]['text'] = ucwords($active_messenger->messenger_label());
+				$i++;
+			}
+		}
+
+		return $m_values;
+	}
+
+
+	/**
+	 * @deprecated 4.9.9.rc.014
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function get_message_types_for_list_table()
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			sprintf(
+				esc_html__(
+					'This method is no longer in use.  There is no replacement for it. The method was used to generate a set of values for use in creating a message type filter dropdown which is now generated differently via %s',
+					'event_espresso'
+				),
+				'Messages_Admin_Page::get_message_types_select_input()'
+			),
+			'4.9.9.rc.014'
+		);
+
+		$mt_values = array();
+		$active_messages = EEM_Message::instance()->get_all(array('group_by' => 'MSG_message_type'));
+		$i = 1;
+		foreach ($active_messages as $active_message) {
+			if ($active_message instanceof EE_Message) {
+				$mt_values[ $i ]['id'] = $active_message->message_type();
+				$mt_values[ $i ]['text'] = ucwords($active_message->message_type_label());
+				$i++;
+			}
+		}
+
+		return $mt_values;
+	}
+
+
+	/**
+	 * @deprecated 4.9.9.rc.014
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function get_contexts_for_message_types_for_list_table()
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			sprintf(
+				esc_html__(
+					'This method is no longer in use.  There is no replacement for it. The method was used to generate a set of values for use in creating a message type context filter dropdown which is now generated differently via %s',
+					'event_espresso'
+				),
+				'Messages_Admin_Page::get_contexts_for_message_types_select_input()'
+			),
+			'4.9.9.rc.014'
+		);
+
+		$contexts = array();
+		$active_message_contexts = EEM_Message::instance()->get_all(array('group_by' => 'MSG_context'));
+		foreach ($active_message_contexts as $active_message) {
+			if ($active_message instanceof EE_Message) {
+				$message_type = $active_message->message_type_object();
+				if ($message_type instanceof EE_message_type) {
+					$message_type_contexts = $message_type->get_contexts();
+					foreach ($message_type_contexts as $context => $context_details) {
+						$contexts[ $context ] = $context_details['label'];
+					}
+				}
+			}
+		}
+
+		return $contexts;
+	}
+
+
+	/**
+	 * Generate select input with provided messenger options array.
+	 *
+	 * @param array $messenger_options Array of messengers indexed by messenger slug and values are the messenger
+	 *                                 labels.
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function get_messengers_select_input($messenger_options)
+	{
+		// if empty or just one value then just return an empty string
+		if (
+			empty($messenger_options)
+			|| ! is_array($messenger_options)
+			|| count($messenger_options) === 1
+		) {
+			return '';
+		}
+		// merge in default
+		$messenger_options = array_merge(
+			array('none_selected' => esc_html__('Show All Messengers', 'event_espresso')),
+			$messenger_options
+		);
+		$input = new EE_Select_Input(
+			$messenger_options,
+			array(
+				'html_name'  => 'ee_messenger_filter_by',
+				'html_id'    => 'ee_messenger_filter_by',
+				'html_class' => 'wide',
+				'default'    => isset($this->_req_data['ee_messenger_filter_by'])
+					? sanitize_title($this->_req_data['ee_messenger_filter_by'])
+					: 'none_selected',
+			)
+		);
+
+		return $input->get_html_for_input();
+	}
+
+
+	/**
+	 * Generate select input with provided message type options array.
+	 *
+	 * @param array $message_type_options Array of message types indexed by message type slug, and values are the
+	 *                                    message type labels
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function get_message_types_select_input($message_type_options)
+	{
+		// if empty or count of options is 1 then just return an empty string
+		if (
+			empty($message_type_options)
+			|| ! is_array($message_type_options)
+			|| count($message_type_options) === 1
+		) {
+			return '';
+		}
+		// merge in default
+		$message_type_options = array_merge(
+			array('none_selected' => esc_html__('Show All Message Types', 'event_espresso')),
+			$message_type_options
+		);
+		$input = new EE_Select_Input(
+			$message_type_options,
+			array(
+				'html_name'  => 'ee_message_type_filter_by',
+				'html_id'    => 'ee_message_type_filter_by',
+				'html_class' => 'wide',
+				'default'    => isset($this->_req_data['ee_message_type_filter_by'])
+					? sanitize_title($this->_req_data['ee_message_type_filter_by'])
+					: 'none_selected',
+			)
+		);
+
+		return $input->get_html_for_input();
+	}
+
+
+	/**
+	 * Generate select input with provide message type contexts array.
+	 *
+	 * @param array $context_options Array of message type contexts indexed by context slug, and values are the
+	 *                               context label.
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function get_contexts_for_message_types_select_input($context_options)
+	{
+		// if empty or count of options is one then just return empty string
+		if (
+			empty($context_options)
+			|| ! is_array($context_options)
+			|| count($context_options) === 1
+		) {
+			return '';
+		}
+		// merge in default
+		$context_options = array_merge(
+			array('none_selected' => esc_html__('Show all Contexts', 'event_espresso')),
+			$context_options
+		);
+		$input = new EE_Select_Input(
+			$context_options,
+			array(
+				'html_name'  => 'ee_context_filter_by',
+				'html_id'    => 'ee_context_filter_by',
+				'html_class' => 'wide',
+				'default'    => isset($this->_req_data['ee_context_filter_by'])
+					? sanitize_title($this->_req_data['ee_context_filter_by'])
+					: 'none_selected',
+			)
+		);
+
+		return $input->get_html_for_input();
+	}
+
+
+	protected function _ajax_hooks()
+	{
+		add_action('wp_ajax_activate_messenger', array($this, 'activate_messenger_toggle'));
+		add_action('wp_ajax_activate_mt', array($this, 'activate_mt_toggle'));
+		add_action('wp_ajax_ee_msgs_save_settings', array($this, 'save_settings'));
+		add_action('wp_ajax_ee_msgs_update_mt_form', array($this, 'update_mt_form'));
+		add_action('wp_ajax_switch_template_pack', array($this, 'switch_template_pack'));
+		add_action('wp_ajax_toggle_context_template', array($this, 'toggle_context_template'));
+	}
+
+
+	protected function _define_page_props()
+	{
+		$this->_admin_page_title = $this->page_label;
+		$this->_labels = array(
+			'buttons'    => array(
+				'add'    => esc_html__('Add New Message Template', 'event_espresso'),
+				'edit'   => esc_html__('Edit Message Template', 'event_espresso'),
+				'delete' => esc_html__('Delete Message Template', 'event_espresso'),
+			),
+			'publishbox' => esc_html__('Update Actions', 'event_espresso'),
+		);
+	}
+
+
+	/**
+	 *        an array for storing key => value pairs of request actions and their corresponding methods
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _set_page_routes()
+	{
+		$grp_id = ! empty($this->_req_data['GRP_ID']) && ! is_array($this->_req_data['GRP_ID'])
+			? $this->_req_data['GRP_ID']
+			: 0;
+		$grp_id = empty($grp_id) && ! empty($this->_req_data['id'])
+			? $this->_req_data['id']
+			: $grp_id;
+		$msg_id = ! empty($this->_req_data['MSG_ID']) && ! is_array($this->_req_data['MSG_ID'])
+			? $this->_req_data['MSG_ID']
+			: 0;
+
+		$this->_page_routes = array(
+			'default'                          => array(
+				'func'       => '_message_queue_list_table',
+				'capability' => 'ee_read_global_messages',
+			),
+			'global_mtps'                      => array(
+				'func'       => '_ee_default_messages_overview_list_table',
+				'capability' => 'ee_read_global_messages',
+			),
+			'custom_mtps'                      => array(
+				'func'       => '_custom_mtps_preview',
+				'capability' => 'ee_read_messages',
+			),
+			'add_new_message_template'         => array(
+				'func'       => '_add_message_template',
+				'capability' => 'ee_edit_messages',
+				'noheader'   => true,
+			),
+			'edit_message_template'            => array(
+				'func'       => '_edit_message_template',
+				'capability' => 'ee_edit_message',
+				'obj_id'     => $grp_id,
+			),
+			'preview_message'                  => array(
+				'func'               => '_preview_message',
+				'capability'         => 'ee_read_message',
+				'obj_id'             => $grp_id,
+				'noheader'           => true,
+				'headers_sent_route' => 'display_preview_message',
+			),
+			'display_preview_message'          => array(
+				'func'       => '_display_preview_message',
+				'capability' => 'ee_read_message',
+				'obj_id'     => $grp_id,
+			),
+			'insert_message_template'          => array(
+				'func'       => '_insert_or_update_message_template',
+				'capability' => 'ee_edit_messages',
+				'args'       => array('new_template' => true),
+				'noheader'   => true,
+			),
+			'update_message_template'          => array(
+				'func'       => '_insert_or_update_message_template',
+				'capability' => 'ee_edit_message',
+				'obj_id'     => $grp_id,
+				'args'       => array('new_template' => false),
+				'noheader'   => true,
+			),
+			'trash_message_template'           => array(
+				'func'       => '_trash_or_restore_message_template',
+				'capability' => 'ee_delete_message',
+				'obj_id'     => $grp_id,
+				'args'       => array('trash' => true, 'all' => true),
+				'noheader'   => true,
+			),
+			'trash_message_template_context'   => array(
+				'func'       => '_trash_or_restore_message_template',
+				'capability' => 'ee_delete_message',
+				'obj_id'     => $grp_id,
+				'args'       => array('trash' => true),
+				'noheader'   => true,
+			),
+			'restore_message_template'         => array(
+				'func'       => '_trash_or_restore_message_template',
+				'capability' => 'ee_delete_message',
+				'obj_id'     => $grp_id,
+				'args'       => array('trash' => false, 'all' => true),
+				'noheader'   => true,
+			),
+			'restore_message_template_context' => array(
+				'func'       => '_trash_or_restore_message_template',
+				'capability' => 'ee_delete_message',
+				'obj_id'     => $grp_id,
+				'args'       => array('trash' => false),
+				'noheader'   => true,
+			),
+			'delete_message_template'          => array(
+				'func'       => '_delete_message_template',
+				'capability' => 'ee_delete_message',
+				'obj_id'     => $grp_id,
+				'noheader'   => true,
+			),
+			'reset_to_default'                 => array(
+				'func'       => '_reset_to_default_template',
+				'capability' => 'ee_edit_message',
+				'obj_id'     => $grp_id,
+				'noheader'   => true,
+			),
+			'settings'                         => array(
+				'func'       => '_settings',
+				'capability' => 'manage_options',
+			),
+			'update_global_settings'           => array(
+				'func'       => '_update_global_settings',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+			),
+			'generate_now'                     => array(
+				'func'       => '_generate_now',
+				'capability' => 'ee_send_message',
+				'noheader'   => true,
+			),
+			'generate_and_send_now'            => array(
+				'func'       => '_generate_and_send_now',
+				'capability' => 'ee_send_message',
+				'noheader'   => true,
+			),
+			'queue_for_resending'              => array(
+				'func'       => '_queue_for_resending',
+				'capability' => 'ee_send_message',
+				'noheader'   => true,
+			),
+			'send_now'                         => array(
+				'func'       => '_send_now',
+				'capability' => 'ee_send_message',
+				'noheader'   => true,
+			),
+			'delete_ee_message'                => array(
+				'func'       => '_delete_ee_messages',
+				'capability' => 'ee_delete_messages',
+				'noheader'   => true,
+			),
+			'delete_ee_messages'               => array(
+				'func'       => '_delete_ee_messages',
+				'capability' => 'ee_delete_messages',
+				'noheader'   => true,
+				'obj_id'     => $msg_id,
+			),
+		);
+	}
+
+
+	protected function _set_page_config()
+	{
+		$this->_page_config = array(
+			'default'                  => array(
+				'nav'           => array(
+					'label' => esc_html__('Message Activity', 'event_espresso'),
+					'order' => 10,
+				),
+				'list_table'    => 'EE_Message_List_Table',
+				// 'qtips' => array( 'EE_Message_List_Table_Tips' ),
+				'require_nonce' => false,
+			),
+			'global_mtps'              => array(
+				'nav'           => array(
+					'label' => esc_html__('Default Message Templates', 'event_espresso'),
+					'order' => 20,
+				),
+				'list_table'    => 'Messages_Template_List_Table',
+				'help_tabs'     => array(
+					'messages_overview_help_tab'                                => array(
+						'title'    => esc_html__('Messages Overview', 'event_espresso'),
+						'filename' => 'messages_overview',
+					),
+					'messages_overview_messages_table_column_headings_help_tab' => array(
+						'title'    => esc_html__('Messages Table Column Headings', 'event_espresso'),
+						'filename' => 'messages_overview_table_column_headings',
+					),
+					'messages_overview_messages_filters_help_tab'               => array(
+						'title'    => esc_html__('Message Filters', 'event_espresso'),
+						'filename' => 'messages_overview_filters',
+					),
+					'messages_overview_messages_views_help_tab'                 => array(
+						'title'    => esc_html__('Message Views', 'event_espresso'),
+						'filename' => 'messages_overview_views',
+					),
+					'message_overview_message_types_help_tab'                   => array(
+						'title'    => esc_html__('Message Types', 'event_espresso'),
+						'filename' => 'messages_overview_types',
+					),
+					'messages_overview_messengers_help_tab'                     => array(
+						'title'    => esc_html__('Messengers', 'event_espresso'),
+						'filename' => 'messages_overview_messengers',
+					),
+				),
+				// disabled temporarily. see: https://github.com/eventespresso/eventsmart.com-website/issues/836
+				// 'help_tour'     => array('Messages_Overview_Help_Tour'),
+				'require_nonce' => false,
+			),
+			'custom_mtps'              => array(
+				'nav'           => array(
+					'label' => esc_html__('Custom Message Templates', 'event_espresso'),
+					'order' => 30,
+				),
+				'help_tabs'     => array(),
+				// disabled temporarily. see: https://github.com/eventespresso/eventsmart.com-website/issues/836
+				// 'help_tour'     => array(),
+				'require_nonce' => false,
+			),
+			'add_new_message_template' => array(
+				'nav'           => array(
+					'label'      => esc_html__('Add New Message Templates', 'event_espresso'),
+					'order'      => 5,
+					'persistent' => false,
+				),
+				'require_nonce' => false,
+			),
+			'edit_message_template'    => array(
+				'labels'        => array(
+					'buttons'    => array(
+						'reset' => esc_html__('Reset Templates', 'event_espresso'),
+					),
+					'publishbox' => esc_html__('Update Actions', 'event_espresso'),
+				),
+				'nav'           => array(
+					'label'      => esc_html__('Edit Message Templates', 'event_espresso'),
+					'order'      => 5,
+					'persistent' => false,
+					'url'        => '',
+				),
+				'metaboxes'     => array('_publish_post_box', '_register_edit_meta_boxes'),
+				'has_metaboxes' => true,
+				// disabled temporarily. see: https://github.com/eventespresso/eventsmart.com-website/issues/836
+				// 'help_tour'     => array('Message_Templates_Edit_Help_Tour'),
+				'help_tabs'     => array(
+					'edit_message_template'            => array(
+						'title'    => esc_html__('Message Template Editor', 'event_espresso'),
+						'callback' => 'edit_message_template_help_tab',
+					),
+					'message_templates_help_tab'       => array(
+						'title'    => esc_html__('Message Templates', 'event_espresso'),
+						'filename' => 'messages_templates',
+					),
+					'message_template_shortcodes'      => array(
+						'title'    => esc_html__('Message Shortcodes', 'event_espresso'),
+						'callback' => 'message_template_shortcodes_help_tab',
+					),
+					'message_preview_help_tab'         => array(
+						'title'    => esc_html__('Message Preview', 'event_espresso'),
+						'filename' => 'messages_preview',
+					),
+					'messages_overview_other_help_tab' => array(
+						'title'    => esc_html__('Messages Other', 'event_espresso'),
+						'filename' => 'messages_overview_other',
+					),
+				),
+				'require_nonce' => false,
+			),
+			'display_preview_message'  => array(
+				'nav'           => array(
+					'label'      => esc_html__('Message Preview', 'event_espresso'),
+					'order'      => 5,
+					'url'        => '',
+					'persistent' => false,
+				),
+				'help_tabs'     => array(
+					'preview_message' => array(
+						'title'    => esc_html__('About Previews', 'event_espresso'),
+						'callback' => 'preview_message_help_tab',
+					),
+				),
+				'require_nonce' => false,
+			),
+			'settings'                 => array(
+				'nav'           => array(
+					'label' => esc_html__('Settings', 'event_espresso'),
+					'order' => 40,
+				),
+				'metaboxes'     => array('_messages_settings_metaboxes'),
+				'help_tabs'     => array(
+					'messages_settings_help_tab'               => array(
+						'title'    => esc_html__('Messages Settings', 'event_espresso'),
+						'filename' => 'messages_settings',
+					),
+					'messages_settings_message_types_help_tab' => array(
+						'title'    => esc_html__('Activating / Deactivating Message Types', 'event_espresso'),
+						'filename' => 'messages_settings_message_types',
+					),
+					'messages_settings_messengers_help_tab'    => array(
+						'title'    => esc_html__('Activating / Deactivating Messengers', 'event_espresso'),
+						'filename' => 'messages_settings_messengers',
+					),
+				),
+				// disabled temporarily. see: https://github.com/eventespresso/eventsmart.com-website/issues/836
+				// 'help_tour'     => array('Messages_Settings_Help_Tour'),
+				'require_nonce' => false,
+			),
+		);
+	}
+
+
+	protected function _add_screen_options()
+	{
+		// todo
+	}
+
+
+	protected function _add_screen_options_global_mtps()
+	{
+		/**
+		 * Note: the reason for the value swap here on $this->_admin_page_title is because $this->_per_page_screen_options
+		 * uses the $_admin_page_title property and we want different outputs in the different spots.
+		 */
+		$page_title = $this->_admin_page_title;
+		$this->_admin_page_title = esc_html__('Global Message Templates', 'event_espresso');
+		$this->_per_page_screen_option();
+		$this->_admin_page_title = $page_title;
+	}
+
+
+	protected function _add_screen_options_default()
+	{
+		$this->_admin_page_title = esc_html__('Message Activity', 'event_espresso');
+		$this->_per_page_screen_option();
+	}
+
+
+	// none of the below group are currently used for Messages
+	protected function _add_feature_pointers()
+	{
+	}
+
+	public function admin_init()
+	{
+	}
+
+	public function admin_notices()
+	{
+	}
+
+	public function admin_footer_scripts()
+	{
+	}
+
+
+	public function messages_help_tab()
+	{
+		EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_messages_help_tab.template.php');
+	}
+
+
+	public function messengers_help_tab()
+	{
+		EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_messenger_help_tab.template.php');
+	}
+
+
+	public function message_types_help_tab()
+	{
+		EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_message_type_help_tab.template.php');
+	}
+
+
+	public function messages_overview_help_tab()
+	{
+		EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_overview_help_tab.template.php');
+	}
+
+
+	public function message_templates_help_tab()
+	{
+		EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_message_templates_help_tab.template.php');
+	}
+
+
+	public function edit_message_template_help_tab()
+	{
+		$args['img1'] = '<img src="' . EE_MSG_ASSETS_URL . 'images/editor.png' . '" alt="'
+						. esc_attr__('Editor Title', 'event_espresso')
+						. '" />';
+		$args['img2'] = '<img src="' . EE_MSG_ASSETS_URL . 'images/switch-context.png' . '" alt="'
+						. esc_attr__('Context Switcher and Preview', 'event_espresso')
+						. '" />';
+		$args['img3'] = '<img class="left" src="' . EE_MSG_ASSETS_URL . 'images/form-fields.png' . '" alt="'
+						. esc_attr__('Message Template Form Fields', 'event_espresso')
+						. '" />';
+		$args['img4'] = '<img class="right" src="' . EE_MSG_ASSETS_URL . 'images/shortcodes-metabox.png' . '" alt="'
+						. esc_attr__('Shortcodes Metabox', 'event_espresso')
+						. '" />';
+		$args['img5'] = '<img class="right" src="' . EE_MSG_ASSETS_URL . 'images/publish-meta-box.png' . '" alt="'
+						. esc_attr__('Publish Metabox', 'event_espresso')
+						. '" />';
+		EEH_Template::display_template(
+			EE_MSG_TEMPLATE_PATH . 'ee_msg_messages_templates_editor_help_tab.template.php',
+			$args
+		);
+	}
+
+
+	public function message_template_shortcodes_help_tab()
+	{
+		$this->_set_shortcodes();
+		$args['shortcodes'] = $this->_shortcodes;
+		EEH_Template::display_template(
+			EE_MSG_TEMPLATE_PATH . 'ee_msg_messages_shortcodes_help_tab.template.php',
+			$args
+		);
+	}
+
+
+	public function preview_message_help_tab()
+	{
+		EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_preview_help_tab.template.php');
+	}
+
+
+	public function settings_help_tab()
+	{
+		$args['img1'] = '<img class="inline-text" src="' . EE_MSG_ASSETS_URL . 'images/email-tab-active.png'
+						. '" alt="' . esc_attr__('Active Email Tab', 'event_espresso') . '" />';
+		$args['img2'] = '<img class="inline-text" src="' . EE_MSG_ASSETS_URL . 'images/email-tab-inactive.png'
+						. '" alt="' . esc_attr__('Inactive Email Tab', 'event_espresso') . '" />';
+		$args['img3'] = '<div class="switch">'
+						. '<input class="ee-on-off-toggle ee-toggle-round-flat"'
+						. ' type="checkbox" checked="checked">'
+						. '<label for="ee-on-off-toggle-on"></label>'
+						. '</div>';
+		$args['img4'] = '<div class="switch">'
+						. '<input class="ee-on-off-toggle ee-toggle-round-flat"'
+						. ' type="checkbox">'
+						. '<label for="ee-on-off-toggle-on"></label>'
+						. '</div>';
+		EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_messages_settings_help_tab.template.php', $args);
+	}
+
+
+	public function load_scripts_styles()
+	{
+		wp_register_style('espresso_ee_msg', EE_MSG_ASSETS_URL . 'ee_message_admin.css', EVENT_ESPRESSO_VERSION);
+		wp_enqueue_style('espresso_ee_msg');
+
+		wp_register_script(
+			'ee-messages-settings',
+			EE_MSG_ASSETS_URL . 'ee-messages-settings.js',
+			array('jquery-ui-droppable', 'ee-serialize-full-array'),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_register_script(
+			'ee-msg-list-table-js',
+			EE_MSG_ASSETS_URL . 'ee_message_admin_list_table.js',
+			array('ee-dialog'),
+			EVENT_ESPRESSO_VERSION
+		);
+	}
+
+
+	public function load_scripts_styles_default()
+	{
+		wp_enqueue_script('ee-msg-list-table-js');
+	}
+
+
+	public function wp_editor_css($mce_css)
+	{
+		// if we're on the edit_message_template route
+		if ($this->_req_action === 'edit_message_template' && $this->_active_messenger instanceof EE_messenger) {
+			$message_type_name = $this->_active_message_type_name;
+
+			// we're going to REPLACE the existing mce css
+			// we need to get the css file location from the active messenger
+			$mce_css = $this->_active_messenger->get_variation(
+				$this->_template_pack,
+				$message_type_name,
+				true,
+				'wpeditor',
+				$this->_variation
+			);
+		}
+
+		return $mce_css;
+	}
+
+
+	public function load_scripts_styles_edit_message_template()
+	{
+
+		$this->_set_shortcodes();
+
+		EE_Registry::$i18n_js_strings['confirm_default_reset'] = sprintf(
+			esc_html__(
+				'Are you sure you want to reset the %s %s message templates?  Remember continuing will reset the templates for all contexts in this messenger and message type group.',
+				'event_espresso'
+			),
+			$this->_message_template_group->messenger_obj()->label['singular'],
+			$this->_message_template_group->message_type_obj()->label['singular']
+		);
+		EE_Registry::$i18n_js_strings['confirm_switch_template_pack'] = esc_html__(
+			'Switching the template pack for a messages template will reset the content for the template so the new layout is loaded.  Any custom content in the existing template will be lost. Are you sure you wish to do this?',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['server_error'] = esc_html__(
+			'An unknown error occurred on the server while attempting to process your request. Please refresh the page and try again or contact support.',
+			'event_espresso'
+		);
+
+		wp_register_script(
+			'ee_msgs_edit_js',
+			EE_MSG_ASSETS_URL . 'ee_message_editor.js',
+			array('jquery'),
+			EVENT_ESPRESSO_VERSION
+		);
+
+		wp_enqueue_script('ee_admin_js');
+		wp_enqueue_script('ee_msgs_edit_js');
+
+		// add in special css for tiny_mce
+		add_filter('mce_css', array($this, 'wp_editor_css'));
+	}
+
+
+	public function load_scripts_styles_display_preview_message()
+	{
+
+		$this->_set_message_template_group();
+
+		if (isset($this->_req_data['messenger'])) {
+			$this->_active_messenger = $this->_message_resource_manager->get_active_messenger(
+				$this->_req_data['messenger']
+			);
+		}
+
+		$message_type_name = isset($this->_req_data['message_type']) ? $this->_req_data['message_type'] : '';
+
+
+		wp_enqueue_style(
+			'espresso_preview_css',
+			$this->_active_messenger->get_variation(
+				$this->_template_pack,
+				$message_type_name,
+				true,
+				'preview',
+				$this->_variation
+			)
+		);
+	}
+
+
+	public function load_scripts_styles_settings()
+	{
+		wp_register_style(
+			'ee-message-settings',
+			EE_MSG_ASSETS_URL . 'ee_message_settings.css',
+			array(),
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_style('ee-text-links');
+		wp_enqueue_style('ee-message-settings');
+		wp_enqueue_script('ee-messages-settings');
+	}
+
+
+	/**
+	 * set views array for List Table
+	 */
+	public function _set_list_table_views_global_mtps()
+	{
+		$this->_views = array(
+			'in_use' => array(
+				'slug'  => 'in_use',
+				'label' => esc_html__('In Use', 'event_espresso'),
+				'count' => 0,
+			),
+		);
+	}
+
+
+	/**
+	 * Set views array for the Custom Template List Table
+	 */
+	public function _set_list_table_views_custom_mtps()
+	{
+		$this->_set_list_table_views_global_mtps();
+		$this->_views['in_use']['bulk_action'] = array(
+			'trash_message_template' => esc_html__('Move to Trash', 'event_espresso'),
+		);
+	}
+
+
+	/**
+	 * set views array for message queue list table
+	 *
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function _set_list_table_views_default()
+	{
+		EE_Registry::instance()->load_helper('Template');
+
+		$common_bulk_actions = EE_Registry::instance()->CAP->current_user_can(
+			'ee_send_message',
+			'message_list_table_bulk_actions'
+		)
+			? array(
+				'generate_now'          => esc_html__('Generate Now', 'event_espresso'),
+				'generate_and_send_now' => esc_html__('Generate and Send Now', 'event_espresso'),
+				'queue_for_resending'   => esc_html__('Queue for Resending', 'event_espresso'),
+				'send_now'              => esc_html__('Send Now', 'event_espresso'),
+			)
+			: array();
+
+		$delete_bulk_action = EE_Registry::instance()->CAP->current_user_can(
+			'ee_delete_messages',
+			'message_list_table_bulk_actions'
+		)
+			? array('delete_ee_messages' => esc_html__('Delete Messages', 'event_espresso'))
+			: array();
+
+
+		$this->_views = array(
+			'all' => array(
+				'slug'        => 'all',
+				'label'       => esc_html__('All', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => array_merge($common_bulk_actions, $delete_bulk_action),
+			),
+		);
+
+
+		foreach (EEM_Message::instance()->all_statuses() as $status) {
+			if ($status === EEM_Message::status_debug_only && ! EEM_Message::debug()) {
+				continue;
+			}
+			$status_bulk_actions = $common_bulk_actions;
+			// unset bulk actions not applying to status
+			if (! empty($status_bulk_actions)) {
+				switch ($status) {
+					case EEM_Message::status_idle:
+					case EEM_Message::status_resend:
+						$status_bulk_actions['send_now'] = $common_bulk_actions['send_now'];
+						break;
+
+					case EEM_Message::status_failed:
+					case EEM_Message::status_debug_only:
+					case EEM_Message::status_messenger_executing:
+						$status_bulk_actions = array();
+						break;
+
+					case EEM_Message::status_incomplete:
+						unset($status_bulk_actions['queue_for_resending'], $status_bulk_actions['send_now']);
+						break;
+
+					case EEM_Message::status_retry:
+					case EEM_Message::status_sent:
+						unset($status_bulk_actions['generate_now'], $status_bulk_actions['generate_and_send_now']);
+						break;
+				}
+			}
+
+			// skip adding messenger executing status to views because it will be included with the Failed view.
+			if ($status === EEM_Message::status_messenger_executing) {
+				continue;
+			}
+
+			$this->_views[ strtolower($status) ] = array(
+				'slug'        => strtolower($status),
+				'label'       => EEH_Template::pretty_status($status, false, 'sentence'),
+				'count'       => 0,
+				'bulk_action' => array_merge($status_bulk_actions, $delete_bulk_action),
+			);
+		}
+	}
+
+
+	protected function _ee_default_messages_overview_list_table()
+	{
+		$this->_admin_page_title = esc_html__('Default Message Templates', 'event_espresso');
+		$this->display_admin_list_table_page_with_no_sidebar();
+	}
+
+
+	protected function _message_queue_list_table()
+	{
+		$this->_search_btn_label = esc_html__('Message Activity', 'event_espresso');
+		$this->_template_args['per_column'] = 6;
+		$this->_template_args['after_list_table'] = $this->_display_legend($this->_message_legend_items());
+		$this->_template_args['before_list_table'] = '<h3>'
+													 . EEM_Message::instance()->get_pretty_label_for_results()
+													 . '</h3>';
+		$this->display_admin_list_table_page_with_no_sidebar();
+	}
+
+
+	protected function _message_legend_items()
+	{
+
+		$action_css_classes = EEH_MSG_Template::get_message_action_icons();
+		$action_items = array();
+
+		foreach ($action_css_classes as $action_item => $action_details) {
+			if ($action_item === 'see_notifications_for') {
+				continue;
+			}
+			$action_items[ $action_item ] = array(
+				'class' => $action_details['css_class'],
+				'desc'  => $action_details['label'],
+			);
+		}
+
+		/** @type array $status_items status legend setup */
+		$status_items = array(
+			'incomplete_status'          => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_incomplete,
+				'desc'  => EEH_Template::pretty_status(EEM_Message::status_incomplete, false, 'sentence'),
+			),
+			'idle_status'                => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_idle,
+				'desc'  => EEH_Template::pretty_status(EEM_Message::status_idle, false, 'sentence'),
+			),
+			'resend_status'              => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_resend,
+				'desc'  => EEH_Template::pretty_status(EEM_Message::status_resend, false, 'sentence'),
+			),
+			'messenger_executing_status' => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_messenger_executing,
+				'desc'  => EEH_Template::pretty_status(EEM_Message::status_messenger_executing, false, 'sentence'),
+			),
+			'sent_status'                => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_sent,
+				'desc'  => EEH_Template::pretty_status(EEM_Message::status_sent, false, 'sentence'),
+			),
+			'retry_status'               => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_retry,
+				'desc'  => EEH_Template::pretty_status(EEM_Message::status_retry, false, 'sentence'),
+			),
+			'failed_status'              => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_failed,
+				'desc'  => EEH_Template::pretty_status(EEM_Message::status_failed, false, 'sentence'),
+			),
+		);
+		if (EEM_Message::debug()) {
+			$status_items['debug_only_status'] = array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_debug_only,
+				'desc'  => EEH_Template::pretty_status(EEM_Message::status_debug_only, false, 'sentence'),
+			);
+		}
+
+		return array_merge($action_items, $status_items);
+	}
+
+
+	protected function _custom_mtps_preview()
+	{
+		$this->_admin_page_title = esc_html__('Custom Message Templates (Preview)', 'event_espresso');
+		$this->_template_args['preview_img'] = '<img src="' . EE_MSG_ASSETS_URL . 'images/custom_mtps_preview.png"'
+											   . ' alt="' . esc_attr__(
+												   'Preview Custom Message Templates screenshot',
+												   'event_espresso'
+											   ) . '" />';
+		$this->_template_args['preview_text'] = '<strong>'
+												. esc_html__(
+													'Custom Message Templates is a feature that is only available in the premium version of Event Espresso 4 which is available with a support license purchase on EventEspresso.com. With the Custom Message Templates feature, you are able to create custom message templates and assign them on a per-event basis.',
+													'event_espresso'
+												)
+												. '</strong>';
+
+		$this->display_admin_caf_preview_page('custom_message_types', false);
+	}
+
+
+	/**
+	 * get_message_templates
+	 * This gets all the message templates for listing on the overview list.
+	 *
+	 * @access public
+	 * @param int    $perpage the amount of templates groups to show per page
+	 * @param string $type    the current _view we're getting templates for
+	 * @param bool   $count   return count?
+	 * @param bool   $all     disregard any paging info (get all data);
+	 * @param bool   $global  whether to return just global (true) or custom templates (false)
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function get_message_templates(
+		$perpage = 10,
+		$type = 'in_use',
+		$count = false,
+		$all = false,
+		$global = true
+	) {
+
+		$MTP = EEM_Message_Template_Group::instance();
+
+		$this->_req_data['orderby'] = empty($this->_req_data['orderby']) ? 'GRP_ID' : $this->_req_data['orderby'];
+		$orderby = $this->_req_data['orderby'];
+
+		$order = (isset($this->_req_data['order']) && ! empty($this->_req_data['order']))
+			? $this->_req_data['order']
+			: 'ASC';
+
+		$current_page = isset($this->_req_data['paged']) && ! empty($this->_req_data['paged'])
+			? $this->_req_data['paged']
+			: 1;
+		$per_page = isset($this->_req_data['perpage']) && ! empty($this->_req_data['perpage'])
+			? $this->_req_data['perpage']
+			: $perpage;
+
+		$offset = ($current_page - 1) * $per_page;
+		$limit = $all ? null : array($offset, $per_page);
+
+
+		// options will match what is in the _views array property
+		switch ($type) {
+			case 'in_use':
+				$templates = $MTP->get_all_active_message_templates($orderby, $order, $limit, $count, $global, true);
+				break;
+			default:
+				$templates = $MTP->get_all_trashed_grouped_message_templates($orderby, $order, $limit, $count, $global);
+		}
+
+		return $templates;
+	}
+
+
+	/**
+	 * filters etc might need a list of installed message_types
+	 *
+	 * @return array an array of message type objects
+	 */
+	public function get_installed_message_types()
+	{
+		$installed_message_types = $this->_message_resource_manager->installed_message_types();
+		$installed = array();
+
+		foreach ($installed_message_types as $message_type) {
+			$installed[ $message_type->name ] = $message_type;
+		}
+
+		return $installed;
+	}
+
+
+	/**
+	 * _add_message_template
+	 *
+	 * This is used when creating a custom template. All Custom Templates start based off another template.
+	 *
+	 * @param string $message_type
+	 * @param string $messenger
+	 * @param string $GRP_ID
+	 *
+	 * @throws EE_error
+	 */
+	protected function _add_message_template($message_type = '', $messenger = '', $GRP_ID = '')
+	{
+		// set values override any request data
+		$message_type = ! empty($message_type) ? $message_type : '';
+		$message_type = empty($message_type) && ! empty($this->_req_data['message_type'])
+			? $this->_req_data['message_type']
+			: $message_type;
+
+		$messenger = ! empty($messenger) ? $messenger : '';
+		$messenger = empty($messenger) && ! empty($this->_req_data['messenger'])
+			? $this->_req_data['messenger']
+			: $messenger;
+
+		$GRP_ID = ! empty($GRP_ID) ? $GRP_ID : '';
+		$GRP_ID = empty($GRP_ID) && ! empty($this->_req_data['GRP_ID']) ? $this->_req_data['GRP_ID'] : $GRP_ID;
+
+		// we need messenger and message type.  They should be coming from the event editor. If not here then return error
+		if (empty($message_type) || empty($messenger)) {
+			throw new EE_Error(
+				esc_html__(
+					'Sorry, but we can\'t create new templates because we\'re missing the messenger or message type',
+					'event_espresso'
+				)
+			);
+		}
+
+		// we need the GRP_ID for the template being used as the base for the new template
+		if (empty($GRP_ID)) {
+			throw new EE_Error(
+				esc_html__(
+					'In order to create a custom message template the GRP_ID of the template being used as a base is needed',
+					'event_espresso'
+				)
+			);
+		}
+
+		// let's just make sure the template gets generated!
+
+		// we need to reassign some variables for what the insert is expecting
+		$this->_req_data['MTP_messenger'] = $messenger;
+		$this->_req_data['MTP_message_type'] = $message_type;
+		$this->_req_data['GRP_ID'] = $GRP_ID;
+		$this->_insert_or_update_message_template(true);
+	}
+
+
+	/**
+	 * public wrapper for the _add_message_template method
+	 *
+	 * @param string $message_type     message type slug
+	 * @param string $messenger        messenger slug
+	 * @param int    $GRP_ID           GRP_ID for the related message template group this new template will be based
+	 *                                 off of.
+	 * @throws EE_error
+	 */
+	public function add_message_template($message_type, $messenger, $GRP_ID)
+	{
+		$this->_add_message_template($message_type, $messenger, $GRP_ID);
+	}
+
+
+	/**
+	 * _edit_message_template
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws InvalidIdentifierException
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _edit_message_template()
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$template_fields = '';
+		$sidebar_fields = '';
+		// we filter the tinyMCE settings to remove the validation since message templates by their nature will not have
+		// valid html in the templates.
+		add_filter('tiny_mce_before_init', array($this, 'filter_tinymce_init'), 10, 2);
+
+		$GRP_ID = isset($this->_req_data['id']) && ! empty($this->_req_data['id'])
+			? absint($this->_req_data['id'])
+			: false;
+
+		$EVT_ID = isset($this->_req_data['evt_id']) && ! empty($this->_req_data['evt_id'])
+		? absint($this->_req_data['evt_id'])
+		: false;
+
+		$this->_set_shortcodes(); // this also sets the _message_template property.
+		$message_template_group = $this->_message_template_group;
+		$c_label = $message_template_group->context_label();
+		$c_config = $message_template_group->contexts_config();
+
+		reset($c_config);
+		$context = isset($this->_req_data['context']) && ! empty($this->_req_data['context'])
+			? strtolower($this->_req_data['context'])
+			: key($c_config);
+
+
+		if (empty($GRP_ID)) {
+			$action = 'insert_message_template';
+			$edit_message_template_form_url = add_query_arg(
+				array('action' => $action, 'noheader' => true),
+				EE_MSG_ADMIN_URL
+			);
+		} else {
+			$action = 'update_message_template';
+			$edit_message_template_form_url = add_query_arg(
+				array('action' => $action, 'noheader' => true),
+				EE_MSG_ADMIN_URL
+			);
+		}
+
+		// set active messenger for this view
+		$this->_active_messenger = $this->_message_resource_manager->get_active_messenger(
+			$message_template_group->messenger()
+		);
+		$this->_active_message_type_name = $message_template_group->message_type();
+
+
+		// Do we have any validation errors?
+		$validators = $this->_get_transient();
+		$v_fields = ! empty($validators) ? array_keys($validators) : array();
+
+
+		// we need to assemble the title from Various details
+		$context_label = sprintf(
+			esc_html__('(%s %s)', 'event_espresso'),
+			$c_config[ $context ]['label'],
+			ucwords($c_label['label'])
+		);
+
+		$title = sprintf(
+			esc_html__(' %s %s Template %s', 'event_espresso'),
+			ucwords($message_template_group->messenger_obj()->label['singular']),
+			ucwords($message_template_group->message_type_obj()->label['singular']),
+			$context_label
+		);
+
+		$this->_template_args['GRP_ID'] = $GRP_ID;
+		$this->_template_args['message_template'] = $message_template_group;
+		$this->_template_args['is_extra_fields'] = false;
+
+
+		// let's get EEH_MSG_Template so we can get template form fields
+		$template_field_structure = EEH_MSG_Template::get_fields(
+			$message_template_group->messenger(),
+			$message_template_group->message_type()
+		);
+
+		if (! $template_field_structure) {
+			$template_field_structure = false;
+			$template_fields = esc_html__(
+				'There was an error in assembling the fields for this display (you should see an error message)',
+				'event_espresso'
+			);
+		}
+
+
+		$message_templates = $message_template_group->context_templates();
+
+
+		// if we have the extra key.. then we need to remove the content index from the template_field_structure as it
+		// will get handled in the "extra" array.
+		if (is_array($template_field_structure[ $context ]) && isset($template_field_structure[ $context ]['extra'])) {
+			foreach ($template_field_structure[ $context ]['extra'] as $reference_field => $new_fields) {
+				unset($template_field_structure[ $context ][ $reference_field ]);
+			}
+		}
+
+		// let's loop through the template_field_structure and actually assemble the input fields!
+		if (! empty($template_field_structure)) {
+			foreach ($template_field_structure[ $context ] as $template_field => $field_setup_array) {
+				// if this is an 'extra' template field then we need to remove any existing fields that are keyed up in
+				// the extra array and reset them.
+				if ($template_field === 'extra') {
+					$this->_template_args['is_extra_fields'] = true;
+					foreach ($field_setup_array as $reference_field => $new_fields_array) {
+						$message_template = $message_templates[ $context ][ $reference_field ];
+						$content = $message_template instanceof EE_Message_Template
+							? $message_template->get('MTP_content')
+							: '';
+						foreach ($new_fields_array as $extra_field => $extra_array) {
+							// let's verify if we need this extra field via the shortcodes parameter.
+							$continue = false;
+							if (isset($extra_array['shortcodes_required'])) {
+								foreach ((array) $extra_array['shortcodes_required'] as $shortcode) {
+									if (! array_key_exists($shortcode, $this->_shortcodes)) {
+										$continue = true;
+									}
+								}
+								if ($continue) {
+									continue;
+								}
+							}
+
+							$field_id = $reference_field
+										. '-'
+										. $extra_field
+										. '-content';
+							$template_form_fields[ $field_id ] = $extra_array;
+							$template_form_fields[ $field_id ]['name'] = 'MTP_template_fields['
+																		 . $reference_field
+																		 . '][content]['
+																		 . $extra_field . ']';
+							$css_class = isset($extra_array['css_class'])
+								? $extra_array['css_class']
+								: '';
+
+							$template_form_fields[ $field_id ]['css_class'] = ! empty($v_fields)
+																			  && in_array($extra_field, $v_fields, true)
+																			  &&
+																			  (
+																				  is_array($validators[ $extra_field ])
+																				  && isset($validators[ $extra_field ]['msg'])
+																			  )
+								? 'validate-error ' . $css_class
+								: $css_class;
+
+							$template_form_fields[ $field_id ]['value'] = ! empty($message_templates)
+																		  && isset($content[ $extra_field ])
+								? $content[ $extra_field ]
+								: '';
+
+							// do we have a validation error?  if we do then let's use that value instead
+							$template_form_fields[ $field_id ]['value'] = isset($validators[ $extra_field ])
+								? $validators[ $extra_field ]['value']
+								: $template_form_fields[ $field_id ]['value'];
+
+
+							$template_form_fields[ $field_id ]['db-col'] = 'MTP_content';
+
+							// shortcode selector
+							$field_name_to_use = $extra_field === 'main'
+								? 'content'
+								: $extra_field;
+							$template_form_fields[ $field_id ]['append_content'] = $this->_get_shortcode_selector(
+								$field_name_to_use,
+								$field_id
+							);
+
+							if (isset($extra_array['input']) && $extra_array['input'] === 'wp_editor') {
+								// we want to decode the entities
+								$template_form_fields[ $field_id ]['value'] = $template_form_fields[ $field_id ]['value'];
+							}/**/
+						}
+						$templatefield_MTP_id = $reference_field . '-MTP_ID';
+						$templatefield_templatename_id = $reference_field . '-name';
+
+						$template_form_fields[ $templatefield_MTP_id ] = array(
+							'name'       => 'MTP_template_fields[' . $reference_field . '][MTP_ID]',
+							'label'      => null,
+							'input'      => 'hidden',
+							'type'       => 'int',
+							'required'   => false,
+							'validation' => false,
+							'value'      => ! empty($message_templates) ? $message_template->ID() : '',
+							'css_class'  => '',
+							'format'     => '%d',
+							'db-col'     => 'MTP_ID',
+						);
+
+						$template_form_fields[ $templatefield_templatename_id ] = array(
+							'name'       => 'MTP_template_fields[' . $reference_field . '][name]',
+							'label'      => null,
+							'input'      => 'hidden',
+							'type'       => 'string',
+							'required'   => false,
+							'validation' => true,
+							'value'      => $reference_field,
+							'css_class'  => '',
+							'format'     => '%s',
+							'db-col'     => 'MTP_template_field',
+						);
+					}
+					continue; // skip the next stuff, we got the necessary fields here for this dataset.
+				} else {
+					$field_id = $template_field . '-content';
+					$template_form_fields[ $field_id ] = $field_setup_array;
+					$template_form_fields[ $field_id ]['name'] = 'MTP_template_fields[' . $template_field . '][content]';
+					$message_template = isset($message_templates[ $context ][ $template_field ])
+						? $message_templates[ $context ][ $template_field ]
+						: null;
+					$template_form_fields[ $field_id ]['value'] = ! empty($message_templates)
+																  && is_array($message_templates[ $context ])
+																  && $message_template instanceof EE_Message_Template
+						? $message_template->get('MTP_content')
+						: '';
+
+					// do we have a validator error for this field?  if we do then we'll use that value instead
+					$template_form_fields[ $field_id ]['value'] = isset($validators[ $template_field ])
+						? $validators[ $template_field ]['value']
+						: $template_form_fields[ $field_id ]['value'];
+
+
+					$template_form_fields[ $field_id ]['db-col'] = 'MTP_content';
+					$css_class = isset($field_setup_array['css_class'])
+						? $field_setup_array['css_class']
+						: '';
+					$template_form_fields[ $field_id ]['css_class'] = ! empty($v_fields)
+																	  && in_array($template_field, $v_fields, true)
+																	  && isset($validators[ $template_field ]['msg'])
+						? 'validate-error ' . $css_class
+						: $css_class;
+
+					// shortcode selector
+					$template_form_fields[ $field_id ]['append_content'] = $this->_get_shortcode_selector(
+						$template_field,
+						$field_id
+					);
+				}
+
+				// k took care of content field(s) now let's take care of others.
+
+				$templatefield_MTP_id = $template_field . '-MTP_ID';
+				$templatefield_field_templatename_id = $template_field . '-name';
+
+				// foreach template field there are actually two form fields created
+				$template_form_fields[ $templatefield_MTP_id ] = array(
+					'name'       => 'MTP_template_fields[' . $template_field . '][MTP_ID]',
+					'label'      => null,
+					'input'      => 'hidden',
+					'type'       => 'int',
+					'required'   => false,
+					'validation' => true,
+					'value'      => $message_template instanceof EE_Message_Template ? $message_template->ID() : '',
+					'css_class'  => '',
+					'format'     => '%d',
+					'db-col'     => 'MTP_ID',
+				);
+
+				$template_form_fields[ $templatefield_field_templatename_id ] = array(
+					'name'       => 'MTP_template_fields[' . $template_field . '][name]',
+					'label'      => null,
+					'input'      => 'hidden',
+					'type'       => 'string',
+					'required'   => false,
+					'validation' => true,
+					'value'      => $template_field,
+					'css_class'  => '',
+					'format'     => '%s',
+					'db-col'     => 'MTP_template_field',
+				);
+			}
+
+			// add other fields
+			$template_form_fields['ee-msg-current-context'] = array(
+				'name'       => 'MTP_context',
+				'label'      => null,
+				'input'      => 'hidden',
+				'type'       => 'string',
+				'required'   => false,
+				'validation' => true,
+				'value'      => $context,
+				'css_class'  => '',
+				'format'     => '%s',
+				'db-col'     => 'MTP_context',
+			);
+
+			$template_form_fields['ee-msg-grp-id'] = array(
+				'name'       => 'GRP_ID',
+				'label'      => null,
+				'input'      => 'hidden',
+				'type'       => 'int',
+				'required'   => false,
+				'validation' => true,
+				'value'      => $GRP_ID,
+				'css_class'  => '',
+				'format'     => '%d',
+				'db-col'     => 'GRP_ID',
+			);
+
+			$template_form_fields['ee-msg-messenger'] = array(
+				'name'       => 'MTP_messenger',
+				'label'      => null,
+				'input'      => 'hidden',
+				'type'       => 'string',
+				'required'   => false,
+				'validation' => true,
+				'value'      => $message_template_group->messenger(),
+				'css_class'  => '',
+				'format'     => '%s',
+				'db-col'     => 'MTP_messenger',
+			);
+
+			$template_form_fields['ee-msg-message-type'] = array(
+				'name'       => 'MTP_message_type',
+				'label'      => null,
+				'input'      => 'hidden',
+				'type'       => 'string',
+				'required'   => false,
+				'validation' => true,
+				'value'      => $message_template_group->message_type(),
+				'css_class'  => '',
+				'format'     => '%s',
+				'db-col'     => 'MTP_message_type',
+			);
+
+			$sidebar_form_fields['ee-msg-is-global'] = array(
+				'name'       => 'MTP_is_global',
+				'label'      => esc_html__('Global Template', 'event_espresso'),
+				'input'      => 'hidden',
+				'type'       => 'int',
+				'required'   => false,
+				'validation' => true,
+				'value'      => $message_template_group->get('MTP_is_global'),
+				'css_class'  => '',
+				'format'     => '%d',
+				'db-col'     => 'MTP_is_global',
+			);
+
+			$sidebar_form_fields['ee-msg-is-override'] = array(
+				'name'       => 'MTP_is_override',
+				'label'      => esc_html__('Override all custom', 'event_espresso'),
+				'input'      => $message_template_group->is_global() ? 'checkbox' : 'hidden',
+				'type'       => 'int',
+				'required'   => false,
+				'validation' => true,
+				'value'      => $message_template_group->get('MTP_is_override'),
+				'css_class'  => '',
+				'format'     => '%d',
+				'db-col'     => 'MTP_is_override',
+			);
+
+			$sidebar_form_fields['ee-msg-is-active'] = array(
+				'name'       => 'MTP_is_active',
+				'label'      => esc_html__('Active Template', 'event_espresso'),
+				'input'      => 'hidden',
+				'type'       => 'int',
+				'required'   => false,
+				'validation' => true,
+				'value'      => $message_template_group->is_active(),
+				'css_class'  => '',
+				'format'     => '%d',
+				'db-col'     => 'MTP_is_active',
+			);
+
+			$sidebar_form_fields['ee-msg-deleted'] = array(
+				'name'       => 'MTP_deleted',
+				'label'      => null,
+				'input'      => 'hidden',
+				'type'       => 'int',
+				'required'   => false,
+				'validation' => true,
+				'value'      => $message_template_group->get('MTP_deleted'),
+				'css_class'  => '',
+				'format'     => '%d',
+				'db-col'     => 'MTP_deleted',
+			);
+			$sidebar_form_fields['ee-msg-author'] = array(
+				'name'       => 'MTP_user_id',
+				'label'      => esc_html__('Author', 'event_espresso'),
+				'input'      => 'hidden',
+				'type'       => 'int',
+				'required'   => false,
+				'validation' => false,
+				'value'      => $message_template_group->user(),
+				'format'     => '%d',
+				'db-col'     => 'MTP_user_id',
+			);
+
+			$sidebar_form_fields['ee-msg-route'] = array(
+				'name'  => 'action',
+				'input' => 'hidden',
+				'type'  => 'string',
+				'value' => $action,
+			);
+
+			$sidebar_form_fields['ee-msg-id'] = array(
+				'name'  => 'id',
+				'input' => 'hidden',
+				'type'  => 'int',
+				'value' => $GRP_ID,
+			);
+			$sidebar_form_fields['ee-msg-evt-nonce'] = array(
+				'name'  => $action . '_nonce',
+				'input' => 'hidden',
+				'type'  => 'string',
+				'value' => wp_create_nonce($action . '_nonce'),
+			);
+
+			if (isset($this->_req_data['template_switch']) && $this->_req_data['template_switch']) {
+				$sidebar_form_fields['ee-msg-template-switch'] = array(
+					'name'  => 'template_switch',
+					'input' => 'hidden',
+					'type'  => 'int',
+					'value' => 1,
+				);
+			}
+
+
+			$template_fields = $this->_generate_admin_form_fields($template_form_fields);
+			$sidebar_fields = $this->_generate_admin_form_fields($sidebar_form_fields);
+		} //end if ( !empty($template_field_structure) )
+
+		// set extra content for publish box
+		$this->_template_args['publish_box_extra_content'] = $sidebar_fields;
+		$this->_set_publish_post_box_vars(
+			'id',
+			$GRP_ID,
+			false,
+			add_query_arg(
+				array('action' => 'global_mtps'),
+				$this->_admin_base_url
+			)
+		);
+
+		// add preview button
+		$preview_url = parent::add_query_args_and_nonce(
+			array(
+				'message_type' => $message_template_group->message_type(),
+				'messenger'    => $message_template_group->messenger(),
+				'context'      => $context,
+				'GRP_ID'       => $GRP_ID,
+				'evt_id'       => $EVT_ID,
+				'action'       => 'preview_message',
+			),
+			$this->_admin_base_url
+		);
+		$preview_button = '<a href="' . $preview_url . '" class="button-secondary messages-preview-button">'
+						  . esc_html__('Preview', 'event_espresso')
+						  . '</a>';
+
+
+		// setup context switcher
+		$context_switcher_args = array(
+			'page'    => 'espresso_messages',
+			'action'  => 'edit_message_template',
+			'id'      => $GRP_ID,
+			'evt_id'  => $EVT_ID,
+			'context' => $context,
+			'extra'   => $preview_button,
+		);
+		$this->_set_context_switcher($message_template_group, $context_switcher_args);
+
+
+		// main box
+		$this->_template_args['template_fields'] = $template_fields;
+		$this->_template_args['sidebar_box_id'] = 'details';
+		$this->_template_args['action'] = $action;
+		$this->_template_args['context'] = $context;
+		$this->_template_args['edit_message_template_form_url'] = $edit_message_template_form_url;
+		$this->_template_args['learn_more_about_message_templates_link'] =
+			$this->_learn_more_about_message_templates_link();
+
+
+		$this->_template_args['before_admin_page_content'] = $this->add_context_switcher();
+		$this->_template_args['before_admin_page_content'] .= $this->add_active_context_element(
+			$message_template_group,
+			$context,
+			$context_label
+		);
+		$this->_template_args['before_admin_page_content'] .= $this->_add_form_element_before();
+		$this->_template_args['after_admin_page_content'] = $this->_add_form_element_after();
+
+		$this->_template_path = $this->_template_args['GRP_ID']
+			? EE_MSG_TEMPLATE_PATH . 'ee_msg_details_main_edit_meta_box.template.php'
+			: EE_MSG_TEMPLATE_PATH . 'ee_msg_details_main_add_meta_box.template.php';
+
+		// send along EE_Message_Template_Group object for further template use.
+		$this->_template_args['MTP'] = $message_template_group;
+
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(
+			$this->_template_path,
+			$this->_template_args,
+			true
+		);
+
+
+		// finally, let's set the admin_page title
+		$this->_admin_page_title = sprintf(__('Editing %s', 'event_espresso'), $title);
+
+
+		// we need to take care of setting the shortcodes property for use elsewhere.
+		$this->_set_shortcodes();
+
+
+		// final template wrapper
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	public function filter_tinymce_init($mceInit, $editor_id)
+	{
+		return $mceInit;
+	}
+
+
+	public function add_context_switcher()
+	{
+		return $this->_context_switcher;
+	}
+
+
+	/**
+	 * Adds the activation/deactivation toggle for the message template context.
+	 *
+	 * @param EE_Message_Template_Group $message_template_group
+	 * @param string                    $context
+	 * @param string                    $context_label
+	 * @return string
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidIdentifierException
+	 */
+	protected function add_active_context_element(
+		EE_Message_Template_Group $message_template_group,
+		$context,
+		$context_label
+	) {
+		$template_args = array(
+			'context'                   => $context,
+			'nonce'                     => wp_create_nonce('activate_' . $context . '_toggle_nonce'),
+			'is_active'                 => $message_template_group->is_context_active($context),
+			'on_off_action'             => $message_template_group->is_context_active($context)
+				? 'context-off'
+				: 'context-on',
+			'context_label'             => str_replace(array('(', ')'), '', $context_label),
+			'message_template_group_id' => $message_template_group->ID(),
+		);
+		return EEH_Template::display_template(
+			EE_MSG_TEMPLATE_PATH . 'ee_msg_editor_active_context_element.template.php',
+			$template_args,
+			true
+		);
+	}
+
+
+	/**
+	 * Ajax callback for `toggle_context_template` ajax action.
+	 * Handles toggling the message context on or off.
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidIdentifierException
+	 * @throws InvalidInterfaceException
+	 */
+	public function toggle_context_template()
+	{
+		$success = true;
+		// check for required data
+		if (
+			! isset(
+				$this->_req_data['message_template_group_id'],
+				$this->_req_data['context'],
+				$this->_req_data['status']
+			)
+		) {
+			EE_Error::add_error(
+				esc_html__('Required data for doing this action is not available.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$success = false;
+		}
+
+		$nonce = isset($this->_req_data['toggle_context_nonce'])
+			? sanitize_text_field($this->_req_data['toggle_context_nonce'])
+			: '';
+		$nonce_ref = 'activate_' . $this->_req_data['context'] . '_toggle_nonce';
+		$this->_verify_nonce($nonce, $nonce_ref);
+		$status = $this->_req_data['status'];
+		if ($status !== 'off' && $status !== 'on') {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__('The given status (%s) is not valid. Must be "off" or "on"', 'event_espresso'),
+					$this->_req_data['status']
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$success = false;
+		}
+		$message_template_group = EEM_Message_Template_Group::instance()->get_one_by_ID(
+			$this->_req_data['message_template_group_id']
+		);
+		if (! $message_template_group instanceof EE_Message_Template_Group) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'Unable to change the active state because the given id "%1$d" does not match a valid "%2$s"',
+						'event_espresso'
+					),
+					$this->_req_data['message_template_group_id'],
+					'EE_Message_Template_Group'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$success = false;
+		}
+		if ($success) {
+			$success = $status === 'off'
+				? $message_template_group->deactivate_context($this->_req_data['context'])
+				: $message_template_group->activate_context($this->_req_data['context']);
+		}
+		$this->_template_args['success'] = $success;
+		$this->_return_json();
+	}
+
+
+	public function _add_form_element_before()
+	{
+		return '<form method="post" action="'
+			   . $this->_template_args["edit_message_template_form_url"]
+			   . '" id="ee-msg-edit-frm">';
+	}
+
+	public function _add_form_element_after()
+	{
+		return '</form>';
+	}
+
+
+	/**
+	 * This executes switching the template pack for a message template.
+	 *
+	 * @since 4.5.0
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 */
+	public function switch_template_pack()
+	{
+		$GRP_ID = ! empty($this->_req_data['GRP_ID']) ? $this->_req_data['GRP_ID'] : 0;
+		$template_pack = ! empty($this->_req_data['template_pack']) ? $this->_req_data['template_pack'] : '';
+
+		// verify we have needed values.
+		if (empty($GRP_ID) || empty($template_pack)) {
+			$this->_template_args['error'] = true;
+			EE_Error::add_error(
+				esc_html__('The required date for switching templates is not available.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		} else {
+			// get template, set the new template_pack and then reset to default
+			/** @type EE_Message_Template_Group $message_template_group */
+			$message_template_group = EEM_Message_Template_Group::instance()->get_one_by_ID($GRP_ID);
+
+			$message_template_group->set_template_pack_name($template_pack);
+			$this->_req_data['msgr'] = $message_template_group->messenger();
+			$this->_req_data['mt'] = $message_template_group->message_type();
+
+			$query_args = $this->_reset_to_default_template();
+
+			if (empty($query_args['id'])) {
+				EE_Error::add_error(
+					esc_html__(
+						'Something went wrong with switching the template pack. Please try again or contact EE support',
+						'event_espresso'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+				$this->_template_args['error'] = true;
+			} else {
+				$template_label = $message_template_group->get_template_pack()->label;
+				$template_pack_labels = $message_template_group->messenger_obj()->get_supports_labels();
+				EE_Error::add_success(
+					sprintf(
+						esc_html__(
+							'This message template has been successfully switched to use the %1$s %2$s.  Please wait while the page reloads with your new template.',
+							'event_espresso'
+						),
+						$template_label,
+						$template_pack_labels->template_pack
+					)
+				);
+				// generate the redirect url for js.
+				$url = self::add_query_args_and_nonce(
+					$query_args,
+					$this->_admin_base_url
+				);
+				$this->_template_args['data']['redirect_url'] = $url;
+				$this->_template_args['success'] = true;
+			}
+
+			$this->_return_json();
+		}
+	}
+
+
+	/**
+	 * This handles resetting the template for the given messenger/message_type so that users can start from scratch if
+	 * they want.
+	 *
+	 * @access protected
+	 * @return array|null
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _reset_to_default_template()
+	{
+
+		$templates = array();
+		$GRP_ID = ! empty($this->_req_data['GRP_ID']) ? $this->_req_data['GRP_ID'] : 0;
+		// we need to make sure we've got the info we need.
+		if (! isset($this->_req_data['msgr'], $this->_req_data['mt'], $this->_req_data['GRP_ID'])) {
+			EE_Error::add_error(
+				esc_html__(
+					'In order to reset the template to its default we require the messenger, message type, and message template GRP_ID to know what is being reset.  At least one of these is missing.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+
+		// all templates will be reset to whatever the defaults are
+		// for the global template matching the messenger and message type.
+		$success = ! empty($GRP_ID) ? true : false;
+
+		if ($success) {
+			// let's first determine if the incoming template is a global template,
+			// if it isn't then we need to get the global template matching messenger and message type.
+			// $MTPG = EEM_Message_Template_Group::instance()->get_one_by_ID( $GRP_ID );
+
+
+			// note this is ONLY deleting the template fields (Message Template rows) NOT the message template group.
+			$success = $this->_delete_mtp_permanently($GRP_ID, false);
+
+			if ($success) {
+				// if successfully deleted, lets generate the new ones.
+				// Note. We set GLOBAL to true, because resets on ANY template
+				// will use the related global template defaults for regeneration.
+				// This means that if a custom template is reset it resets to whatever the related global template is.
+				// HOWEVER, we DO keep the template pack and template variation set
+				// for the current custom template when resetting.
+				$templates = $this->_generate_new_templates(
+					$this->_req_data['msgr'],
+					$this->_req_data['mt'],
+					$GRP_ID,
+					true
+				);
+			}
+		}
+
+		// any error messages?
+		if (! $success) {
+			EE_Error::add_error(
+				esc_html__(
+					'Something went wrong with deleting existing templates. Unable to reset to default',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+
+		// all good, let's add a success message!
+		if ($success && ! empty($templates)) {
+			// the info for the template we generated is the first element in the returned array
+			// $templates = $templates[0];
+			EE_Error::overwrite_success();
+			EE_Error::add_success(__('Templates have been reset to defaults.', 'event_espresso'));
+		}
+
+
+		$query_args = array(
+			'id'      => isset($templates[0]['GRP_ID']) ? $templates[0]['GRP_ID'] : null,
+			'context' => isset($templates[0]['MTP_context']) ? $templates[0]['MTP_context'] : null,
+			'action'  => isset($templates[0]['GRP_ID']) ? 'edit_message_template' : 'global_mtps',
+		);
+
+		// if called via ajax then we return query args otherwise redirect
+		if (defined('DOING_AJAX') && DOING_AJAX) {
+			return $query_args;
+		} else {
+			$this->_redirect_after_action(false, '', '', $query_args, true);
+
+			return null;
+		}
+	}
+
+
+	/**
+	 * Retrieve and set the message preview for display.
+	 *
+	 * @param bool $send if TRUE then we are doing an actual TEST send with the results of the preview.
+	 * @return string
+	 * @throws ReflectionException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function _preview_message($send = false)
+	{
+		// first make sure we've got the necessary parameters
+		if (
+			! isset(
+				$this->_req_data['message_type'],
+				$this->_req_data['messenger'],
+				$this->_req_data['messenger'],
+				$this->_req_data['GRP_ID']
+			)
+		) {
+			EE_Error::add_error(
+				esc_html__('Missing necessary parameters for displaying preview', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+
+		EE_Registry::instance()->REQ->set('GRP_ID', $this->_req_data['GRP_ID']);
+
+		// if we have an evt_id set on the request, use it.
+		$EVT_ID = isset($this->_req_data['evt_id']) && ! empty($this->_req_data['evt_id'])
+		? absint($this->_req_data['evt_id'])
+		: false;
+
+
+		// get the preview!
+		$preview = EED_Messages::preview_message(
+			$this->_req_data['message_type'],
+			$this->_req_data['context'],
+			$this->_req_data['messenger'],
+			$send
+		);
+
+		if ($send) {
+			return $preview;
+		}
+
+		// let's add a button to go back to the edit view
+		$query_args = array(
+			'id'      => $this->_req_data['GRP_ID'],
+			'evt_id'  => $EVT_ID,
+			'context' => $this->_req_data['context'],
+			'action'  => 'edit_message_template',
+		);
+		$go_back_url = parent::add_query_args_and_nonce($query_args, $this->_admin_base_url);
+		$preview_button = '<a href="'
+						  . $go_back_url
+						  . '" class="button-secondary messages-preview-go-back-button">'
+						  . esc_html__('Go Back to Edit', 'event_espresso')
+						  . '</a>';
+		$message_types = $this->get_installed_message_types();
+		$active_messenger = $this->_message_resource_manager->get_active_messenger(
+			$this->_req_data['messenger']
+		);
+		$active_messenger_label = $active_messenger instanceof EE_messenger
+			? ucwords($active_messenger->label['singular'])
+			: esc_html__('Unknown Messenger', 'event_espresso');
+		// let's provide a helpful title for context
+		$preview_title = sprintf(
+			esc_html__('Viewing Preview for %s %s Message Template', 'event_espresso'),
+			$active_messenger_label,
+			ucwords($message_types[ $this->_req_data['message_type'] ]->label['singular'])
+		);
+		if (empty($preview)) {
+			$this->noEventsErrorMessage();
+		}
+		// setup display of preview.
+		$this->_admin_page_title = $preview_title;
+		$this->_template_args['admin_page_title'] = $preview_title;
+		$this->_template_args['admin_page_content'] = $preview_button . '<br />' . $preview;
+		$this->_template_args['data']['force_json'] = true;
+
+		return '';
+	}
+
+
+	/**
+	 * Used to set an error if there are no events available for generating a preview/test send.
+	 *
+	 * @param bool $test_send  Whether the error should be generated for the context of a test send.
+	 */
+	protected function noEventsErrorMessage($test_send = false)
+	{
+		$events_url = parent::add_query_args_and_nonce(
+			array(
+				'action' => 'default',
+				'page'   => 'espresso_events',
+			),
+			admin_url('admin.php')
+		);
+		$message = $test_send
+			? __(
+				'A test message could not be sent for this message template because there are no events created yet. The preview system uses actual events for generating the test message. %1$sGo see your events%2$s!',
+				'event_espresso'
+			)
+			: __(
+				'There is no preview for this message template available because there are no events created yet. The preview system uses actual events for generating the preview. %1$sGo see your events%2$s!',
+				'event_espresso'
+			);
+
+		EE_Error::add_attention(
+			sprintf(
+				$message,
+				"<a href='{$events_url}'>",
+				'</a>'
+			)
+		);
+	}
+
+
+	/**
+	 * The initial _preview_message is on a no headers route.  It will optionally call this if necessary otherwise it
+	 * gets called automatically.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @return string
+	 */
+	protected function _display_preview_message()
+	{
+		$this->display_admin_page_with_no_sidebar();
+	}
+
+
+	/**
+	 * registers metaboxes that should show up on the "edit_message_template" page
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _register_edit_meta_boxes()
+	{
+		add_meta_box(
+			'mtp_valid_shortcodes',
+			esc_html__('Valid Shortcodes', 'event_espresso'),
+			array($this, 'shortcode_meta_box'),
+			$this->_current_screen->id,
+			'side',
+			'default'
+		);
+		add_meta_box(
+			'mtp_extra_actions',
+			esc_html__('Extra Actions', 'event_espresso'),
+			array($this, 'extra_actions_meta_box'),
+			$this->_current_screen->id,
+			'side',
+			'high'
+		);
+		add_meta_box(
+			'mtp_templates',
+			esc_html__('Template Styles', 'event_espresso'),
+			array($this, 'template_pack_meta_box'),
+			$this->_current_screen->id,
+			'side',
+			'high'
+		);
+	}
+
+
+	/**
+	 * metabox content for all template pack and variation selection.
+	 *
+	 * @since 4.5.0
+	 * @return string
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function template_pack_meta_box()
+	{
+		$this->_set_message_template_group();
+
+		$tp_collection = EEH_MSG_Template::get_template_pack_collection();
+
+		$tp_select_values = array();
+
+		foreach ($tp_collection as $tp) {
+			// only include template packs that support this messenger and message type!
+			$supports = $tp->get_supports();
+			if (
+				! isset($supports[ $this->_message_template_group->messenger() ])
+				|| ! in_array(
+					$this->_message_template_group->message_type(),
+					$supports[ $this->_message_template_group->messenger() ],
+					true
+				)
+			) {
+				// not supported
+				continue;
+			}
+
+			$tp_select_values[] = array(
+				'text' => $tp->label,
+				'id'   => $tp->dbref,
+			);
+		}
+
+		// if empty $tp_select_values then we make sure default is set because EVERY message type should be supported by
+		// the default template pack.  This still allows for the odd template pack to override.
+		if (empty($tp_select_values)) {
+			$tp_select_values[] = array(
+				'text' => esc_html__('Default', 'event_espresso'),
+				'id'   => 'default',
+			);
+		}
+
+		// setup variation select values for the currently selected template.
+		$variations = $this->_message_template_group->get_template_pack()->get_variations(
+			$this->_message_template_group->messenger(),
+			$this->_message_template_group->message_type()
+		);
+		$variations_select_values = array();
+		foreach ($variations as $variation => $label) {
+			$variations_select_values[] = array(
+				'text' => $label,
+				'id'   => $variation,
+			);
+		}
+
+		$template_pack_labels = $this->_message_template_group->messenger_obj()->get_supports_labels();
+
+		$template_args['template_packs_selector'] = EEH_Form_Fields::select_input(
+			'MTP_template_pack',
+			$tp_select_values,
+			$this->_message_template_group->get_template_pack_name()
+		);
+		$template_args['variations_selector'] = EEH_Form_Fields::select_input(
+			'MTP_template_variation',
+			$variations_select_values,
+			$this->_message_template_group->get_template_pack_variation()
+		);
+		$template_args['template_pack_label'] = $template_pack_labels->template_pack;
+		$template_args['template_variation_label'] = $template_pack_labels->template_variation;
+		$template_args['template_pack_description'] = $template_pack_labels->template_pack_description;
+		$template_args['template_variation_description'] = $template_pack_labels->template_variation_description;
+
+		$template = EE_MSG_TEMPLATE_PATH . 'template_pack_and_variations_metabox.template.php';
+
+		EEH_Template::display_template($template, $template_args);
+	}
+
+
+	/**
+	 * This meta box holds any extra actions related to Message Templates
+	 * For now, this includes Resetting templates to defaults and sending a test email.
+	 *
+	 * @access  public
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function extra_actions_meta_box()
+	{
+		$template_form_fields = array();
+
+		$extra_args = array(
+			'msgr'   => $this->_message_template_group->messenger(),
+			'mt'     => $this->_message_template_group->message_type(),
+			'GRP_ID' => $this->_message_template_group->GRP_ID(),
+		);
+		// first we need to see if there are any fields
+		$fields = $this->_message_template_group->messenger_obj()->get_test_settings_fields();
+
+		if (! empty($fields)) {
+			// yup there be fields
+			foreach ($fields as $field => $config) {
+				$field_id = $this->_message_template_group->messenger() . '_' . $field;
+				$existing = $this->_message_template_group->messenger_obj()->get_existing_test_settings();
+				$default = isset($config['default']) ? $config['default'] : '';
+				$default = isset($config['value']) ? $config['value'] : $default;
+
+				// if type is hidden and the value is empty
+				// something may have gone wrong so let's correct with the defaults
+				$fix = $config['input'] === 'hidden'
+					   && isset($existing[ $field ])
+					   && empty($existing[ $field ])
+					? $default
+					: '';
+				$existing[ $field ] = isset($existing[ $field ]) && empty($fix)
+					? $existing[ $field ]
+					: $fix;
+
+				$template_form_fields[ $field_id ] = array(
+					'name'       => 'test_settings_fld[' . $field . ']',
+					'label'      => $config['label'],
+					'input'      => $config['input'],
+					'type'       => $config['type'],
+					'required'   => $config['required'],
+					'validation' => $config['validation'],
+					'value'      => isset($existing[ $field ]) ? $existing[ $field ] : $default,
+					'css_class'  => $config['css_class'],
+					'options'    => isset($config['options']) ? $config['options'] : array(),
+					'default'    => $default,
+					'format'     => $config['format'],
+				);
+			}
+		}
+
+		$test_settings_fields = ! empty($template_form_fields)
+			? $this->_generate_admin_form_fields($template_form_fields, 'string', 'ee_tst_settings_flds')
+			: '';
+
+		$test_settings_html = '';
+		// print out $test_settings_fields
+		if (! empty($test_settings_fields)) {
+			echo $test_settings_fields;
+			$test_settings_html = '<input type="submit" class="button-primary mtp-test-button alignright" ';
+			$test_settings_html .= 'name="test_button" value="';
+			$test_settings_html .= esc_html__('Test Send', 'event_espresso');
+			$test_settings_html .= '" /><div style="clear:both"></div>';
+		}
+
+		// and button
+		$test_settings_html .= '<p>'
+							   . esc_html__('Need to reset this message type and start over?', 'event_espresso')
+							   . '</p>';
+		$test_settings_html .= '<div class="publishing-action alignright resetbutton">';
+		$test_settings_html .= $this->get_action_link_or_button(
+			'reset_to_default',
+			'reset',
+			$extra_args,
+			'button-primary reset-default-button'
+		);
+		$test_settings_html .= '</div><div style="clear:both"></div>';
+		echo $test_settings_html;
+	}
+
+
+	/**
+	 * This returns the shortcode selector skeleton for a given context and field.
+	 *
+	 * @since 4.9.rc.000
+	 * @param string $field           The name of the field retrieving shortcodes for.
+	 * @param string $linked_input_id The css id of the input that the shortcodes get added to.
+	 * @return string
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _get_shortcode_selector($field, $linked_input_id)
+	{
+		$template_args = array(
+			'shortcodes'      => $this->_get_shortcodes(array($field), true),
+			'fieldname'       => $field,
+			'linked_input_id' => $linked_input_id,
+		);
+
+		return EEH_Template::display_template(
+			EE_MSG_TEMPLATE_PATH . 'shortcode_selector_skeleton.template.php',
+			$template_args,
+			true
+		);
+	}
+
+
+	/**
+	 * This just takes care of returning the meta box content for shortcodes (only used on the edit message template
+	 * page)
+	 *
+	 * @access public
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function shortcode_meta_box()
+	{
+		$shortcodes = $this->_get_shortcodes(array(), false); // just make sure shortcodes property is set
+		// $messenger = $this->_message_template_group->messenger_obj();
+		// now let's set the content depending on the status of the shortcodes array
+		if (empty($shortcodes)) {
+			$content = '<p>' . esc_html__('There are no valid shortcodes available', 'event_espresso') . '</p>';
+			echo $content;
+		} else {
+			// $alt = 0;
+			?>
             <div style="float:right; margin-top:10px"><?php
-                            echo $this->_get_help_tab_link('message_template_shortcodes');
-            ?></div>
+							echo $this->_get_help_tab_link('message_template_shortcodes');
+			?></div>
             <p class="small-text"><?php
-                                  printf(
-                                      esc_html__(
-                                          'You can view the shortcodes usable in your template by clicking the %s icon next to each field.',
-                                          'event_espresso'
-                                      ),
-                                      '<span class="dashicons dashicons-menu"></span>'
-                                  );
-                                    ?>
+								  printf(
+									  esc_html__(
+										  'You can view the shortcodes usable in your template by clicking the %s icon next to each field.',
+										  'event_espresso'
+									  ),
+									  '<span class="dashicons dashicons-menu"></span>'
+								  );
+									?>
             </p>
             <?php
-        }
-    }
-
-
-    /**
-     * used to set the $_shortcodes property for when its needed elsewhere.
-     *
-     * @access protected
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _set_shortcodes()
-    {
-
-        // no need to run this if the property is already set
-        if (! empty($this->_shortcodes)) {
-            return;
-        }
-
-        $this->_shortcodes = $this->_get_shortcodes();
-    }
-
-
-    /**
-     * get's all shortcodes for a given template group. (typically used by _set_shortcodes to set the $_shortcodes
-     * property)
-     *
-     * @access  protected
-     * @param  array   $fields include an array of specific field names that you want to be used to get the shortcodes
-     *                         for. Defaults to all (for the given context)
-     * @param  boolean $merged Whether to merge all the shortcodes into one list of unique shortcodes
-     * @return array Shortcodes indexed by fieldname and the an array of shortcode/label pairs OR if merged is
-     *                         true just an array of shortcode/label pairs.
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _get_shortcodes($fields = array(), $merged = true)
-    {
-        $this->_set_message_template_group();
-
-        // we need the messenger and message template to retrieve the valid shortcodes array.
-        $GRP_ID = isset($this->_req_data['id']) && ! empty($this->_req_data['id'])
-            ? absint($this->_req_data['id'])
-            : false;
-        $context = isset($this->_req_data['context'])
-            ? $this->_req_data['context']
-            : key($this->_message_template_group->contexts_config());
-
-        return ! empty($GRP_ID) ? $this->_message_template_group->get_shortcodes($context, $fields, $merged) : array();
-    }
-
-
-    /**
-     * This sets the _message_template property (containing the called message_template object)
-     *
-     * @access protected
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _set_message_template_group()
-    {
-
-        if (! empty($this->_message_template_group)) {
-            return;
-        } //get out if this is already set.
-
-        $GRP_ID = ! empty($this->_req_data['GRP_ID']) ? absint($this->_req_data['GRP_ID']) : false;
-        $GRP_ID = empty($GRP_ID) && ! empty($this->_req_data['id']) ? $this->_req_data['id'] : $GRP_ID;
-
-        // let's get the message templates
-        $MTP = EEM_Message_Template_Group::instance();
-
-        if (empty($GRP_ID)) {
-            $this->_message_template_group = $MTP->create_default_object();
-        } else {
-            $this->_message_template_group = $MTP->get_one_by_ID($GRP_ID);
-        }
-
-        $this->_template_pack = $this->_message_template_group->get_template_pack();
-        $this->_variation = $this->_message_template_group->get_template_pack_variation();
-    }
-
-
-    /**
-     * sets up a context switcher for edit forms
-     *
-     * @access  protected
-     * @param  EE_Message_Template_Group $template_group_object the template group object being displayed on the form
-     * @param array                      $args                  various things the context switcher needs.
-     * @throws EE_Error
-     */
-    protected function _set_context_switcher(EE_Message_Template_Group $template_group_object, $args)
-    {
-        $context_details = $template_group_object->contexts_config();
-        $context_label = $template_group_object->context_label();
-        ob_start();
-        ?>
+		}
+	}
+
+
+	/**
+	 * used to set the $_shortcodes property for when its needed elsewhere.
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _set_shortcodes()
+	{
+
+		// no need to run this if the property is already set
+		if (! empty($this->_shortcodes)) {
+			return;
+		}
+
+		$this->_shortcodes = $this->_get_shortcodes();
+	}
+
+
+	/**
+	 * get's all shortcodes for a given template group. (typically used by _set_shortcodes to set the $_shortcodes
+	 * property)
+	 *
+	 * @access  protected
+	 * @param  array   $fields include an array of specific field names that you want to be used to get the shortcodes
+	 *                         for. Defaults to all (for the given context)
+	 * @param  boolean $merged Whether to merge all the shortcodes into one list of unique shortcodes
+	 * @return array Shortcodes indexed by fieldname and the an array of shortcode/label pairs OR if merged is
+	 *                         true just an array of shortcode/label pairs.
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _get_shortcodes($fields = array(), $merged = true)
+	{
+		$this->_set_message_template_group();
+
+		// we need the messenger and message template to retrieve the valid shortcodes array.
+		$GRP_ID = isset($this->_req_data['id']) && ! empty($this->_req_data['id'])
+			? absint($this->_req_data['id'])
+			: false;
+		$context = isset($this->_req_data['context'])
+			? $this->_req_data['context']
+			: key($this->_message_template_group->contexts_config());
+
+		return ! empty($GRP_ID) ? $this->_message_template_group->get_shortcodes($context, $fields, $merged) : array();
+	}
+
+
+	/**
+	 * This sets the _message_template property (containing the called message_template object)
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _set_message_template_group()
+	{
+
+		if (! empty($this->_message_template_group)) {
+			return;
+		} //get out if this is already set.
+
+		$GRP_ID = ! empty($this->_req_data['GRP_ID']) ? absint($this->_req_data['GRP_ID']) : false;
+		$GRP_ID = empty($GRP_ID) && ! empty($this->_req_data['id']) ? $this->_req_data['id'] : $GRP_ID;
+
+		// let's get the message templates
+		$MTP = EEM_Message_Template_Group::instance();
+
+		if (empty($GRP_ID)) {
+			$this->_message_template_group = $MTP->create_default_object();
+		} else {
+			$this->_message_template_group = $MTP->get_one_by_ID($GRP_ID);
+		}
+
+		$this->_template_pack = $this->_message_template_group->get_template_pack();
+		$this->_variation = $this->_message_template_group->get_template_pack_variation();
+	}
+
+
+	/**
+	 * sets up a context switcher for edit forms
+	 *
+	 * @access  protected
+	 * @param  EE_Message_Template_Group $template_group_object the template group object being displayed on the form
+	 * @param array                      $args                  various things the context switcher needs.
+	 * @throws EE_Error
+	 */
+	protected function _set_context_switcher(EE_Message_Template_Group $template_group_object, $args)
+	{
+		$context_details = $template_group_object->contexts_config();
+		$context_label = $template_group_object->context_label();
+		ob_start();
+		?>
         <div class="ee-msg-switcher-container">
             <form method="get" action="<?php echo EE_MSG_ADMIN_URL; ?>" id="ee-msg-context-switcher-frm">
                 <?php
-                foreach ($args as $name => $value) {
-                    if ($name === 'context' || empty($value) || $name === 'extra') {
-                        continue;
-                    }
-                    ?>
+				foreach ($args as $name => $value) {
+					if ($name === 'context' || empty($value) || $name === 'extra') {
+						continue;
+					}
+					?>
                     <input type="hidden" name="<?php echo $name; ?>" value="<?php echo $value; ?>"/>
                     <?php
-                }
-                // setup nonce_url
-                wp_nonce_field($args['action'] . '_nonce', $args['action'] . '_nonce', false);
-                ?>
+				}
+				// setup nonce_url
+				wp_nonce_field($args['action'] . '_nonce', $args['action'] . '_nonce', false);
+				?>
                 <select name="context">
                     <?php
-                    $context_templates = $template_group_object->context_templates();
-                    if (is_array($context_templates)) :
-                        foreach ($context_templates as $context => $template_fields) :
-                            $checked = ($context === $args['context']) ? 'selected="selected"' : '';
-                            ?>
+					$context_templates = $template_group_object->context_templates();
+					if (is_array($context_templates)) :
+						foreach ($context_templates as $context => $template_fields) :
+							$checked = ($context === $args['context']) ? 'selected="selected"' : '';
+							?>
                             <option value="<?php echo $context; ?>" <?php echo $checked; ?>>
                                 <?php echo $context_details[ $context ]['label']; ?>
                             </option>
                         <?php endforeach;
-                    endif; ?>
+					endif; ?>
                 </select>
                 <?php $button_text = sprintf(__('Switch %s', 'event_espresso'), ucwords($context_label['label'])); ?>
                 <input id="submit-msg-context-switcher-sbmt" class="button-secondary" type="submit"
@@ -2671,1930 +2671,1930 @@ 
             <?php echo $args['extra']; ?>
         </div> <!-- end .ee-msg-switcher-container -->
         <?php
-        $output = ob_get_contents();
-        ob_clean();
-        $this->_context_switcher = $output;
-    }
-
-
-    /**
-     * utility for sanitizing new values coming in.
-     * Note: this is only used when updating a context.
-     *
-     * @access protected
-     *
-     * @param int $index This helps us know which template field to select from the request array.
-     *
-     * @return array
-     */
-    protected function _set_message_template_column_values($index)
-    {
-        if (is_array($this->_req_data['MTP_template_fields'][ $index ]['content'])) {
-            foreach ($this->_req_data['MTP_template_fields'][ $index ]['content'] as $field => $value) {
-                $this->_req_data['MTP_template_fields'][ $index ]['content'][ $field ] = $value;
-            }
-        }
-
-
-        $set_column_values = array(
-            'MTP_ID'             => absint($this->_req_data['MTP_template_fields'][ $index ]['MTP_ID']),
-            'GRP_ID'             => absint($this->_req_data['GRP_ID']),
-            'MTP_user_id'        => absint($this->_req_data['MTP_user_id']),
-            'MTP_messenger'      => strtolower($this->_req_data['MTP_messenger']),
-            'MTP_message_type'   => strtolower($this->_req_data['MTP_message_type']),
-            'MTP_template_field' => strtolower($this->_req_data['MTP_template_fields'][ $index ]['name']),
-            'MTP_context'        => strtolower($this->_req_data['MTP_context']),
-            'MTP_content'        => $this->_req_data['MTP_template_fields'][ $index ]['content'],
-            'MTP_is_global'      => isset($this->_req_data['MTP_is_global'])
-                ? absint($this->_req_data['MTP_is_global'])
-                : 0,
-            'MTP_is_override'    => isset($this->_req_data['MTP_is_override'])
-                ? absint($this->_req_data['MTP_is_override'])
-                : 0,
-            'MTP_deleted'        => absint($this->_req_data['MTP_deleted']),
-            'MTP_is_active'      => absint($this->_req_data['MTP_is_active']),
-        );
-
-
-        return $set_column_values;
-    }
-
-
-    protected function _insert_or_update_message_template($new = false)
-    {
-        $success = 0;
-        $override = false;
-
-        // setup notices description
-        $messenger_slug = ! empty($this->_req_data['MTP_messenger']) ? $this->_req_data['MTP_messenger'] : '';
-
-        // need the message type and messenger objects to be able to use the labels for the notices
-        $messenger_object = $this->_message_resource_manager->get_messenger($messenger_slug);
-        $messenger_label = $messenger_object instanceof EE_messenger
-            ? ucwords($messenger_object->label['singular'])
-            : '';
-
-        $message_type_slug = ! empty($this->_req_data['MTP_message_type'])
-            ? $this->_req_data['MTP_message_type']
-            : '';
-        $message_type_object = $this->_message_resource_manager->get_message_type($message_type_slug);
-
-        $message_type_label = $message_type_object instanceof EE_message_type
-            ? ucwords($message_type_object->label['singular'])
-            : '';
-
-        $context_slug = ! empty($this->_req_data['MTP_context'])
-            ? $this->_req_data['MTP_context']
-            : '';
-        $context = ucwords(str_replace('_', ' ', $context_slug));
-
-        $item_desc = $messenger_label && $message_type_label
-            ? $messenger_label . ' ' . $message_type_label . ' ' . $context . ' '
-            : '';
-        $item_desc .= 'Message Template';
-        $query_args = array();
-        $edit_array = array();
-        $action_desc = '';
-
-        // if this is "new" then we need to generate the default contexts for the selected messenger/message_type for
-        // user to edit.
-        if ($new) {
-            $GRP_ID = ! empty($this->_req_data['GRP_ID']) ? $this->_req_data['GRP_ID'] : 0;
-            if ($edit_array = $this->_generate_new_templates($messenger_slug, $message_type_slug, $GRP_ID)) {
-                if (empty($edit_array)) {
-                    $success = 0;
-                } else {
-                    $success = 1;
-                    $edit_array = $edit_array[0];
-                    $query_args = array(
-                        'id'      => $edit_array['GRP_ID'],
-                        'context' => $edit_array['MTP_context'],
-                        'action'  => 'edit_message_template',
-                    );
-                }
-            }
-            $action_desc = 'created';
-        } else {
-            $MTPG = EEM_Message_Template_Group::instance();
-            $MTP = EEM_Message_Template::instance();
-
-
-            // run update for each template field in displayed context
-            if (! isset($this->_req_data['MTP_template_fields']) && empty($this->_req_data['MTP_template_fields'])) {
-                EE_Error::add_error(
-                    esc_html__(
-                        'There was a problem saving the template fields from the form because I didn\'t receive any actual template field data.',
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-                $success = 0;
-            } else {
-                // first validate all fields!
-                // this filter allows client code to add its own validation to the template fields as well.
-                // returning an empty array means everything passed validation.
-                // errors in validation should be represented in an array with the following shape:
-                // array(
-                //   'fieldname' => array(
-                //          'msg' => 'error message'
-                //          'value' => 'value for field producing error'
-                // )
-                $custom_validation = (array) apply_filters(
-                    'FHEE__Messages_Admin_Page___insert_or_update_message_template__validates',
-                    array(),
-                    $this->_req_data['MTP_template_fields'],
-                    $context_slug,
-                    $messenger_slug,
-                    $message_type_slug
-                );
-
-                $system_validation = $MTPG->validate(
-                    $this->_req_data['MTP_template_fields'],
-                    $context_slug,
-                    $messenger_slug,
-                    $message_type_slug
-                );
-
-                $system_validation = ! is_array($system_validation) && $system_validation ? array()
-                    : $system_validation;
-                $validates = array_merge($custom_validation, $system_validation);
-
-                // if $validate returned error messages (i.e. is_array()) then we need to process them and setup an
-                // appropriate response. HMM, dang this isn't correct, $validates will ALWAYS be an array.
-                //  WE need to make sure there is no actual error messages in validates.
-                if (is_array($validates) && ! empty($validates)) {
-                    // add the transient so when the form loads we know which fields to highlight
-                    $this->_add_transient('edit_message_template', $validates);
-
-                    $success = 0;
-
-                    // setup notices
-                    foreach ($validates as $field => $error) {
-                        if (isset($error['msg'])) {
-                            EE_Error::add_error($error['msg'], __FILE__, __FUNCTION__, __LINE__);
-                        }
-                    }
-                } else {
-                    $set_column_values = array();
-                    foreach ($this->_req_data['MTP_template_fields'] as $template_field => $content) {
-                        $set_column_values = $this->_set_message_template_column_values($template_field);
-
-                        $where_cols_n_values = array(
-                            'MTP_ID' => $this->_req_data['MTP_template_fields'][ $template_field ]['MTP_ID'],
-                        );
-                        // if they aren't allowed to use all JS, restrict them to just posty-y tags
-                        if (! current_user_can('unfiltered_html')) {
-                            if (is_array($set_column_values['MTP_content'])) {
-                                foreach ($set_column_values['MTP_content'] as $key => $value) {
-                                    // remove slashes so wp_kses works properly (its wp_kses_stripslashes() function
-                                    // only removes slashes from double-quotes, so attributes using single quotes always
-                                    // appear invalid.) But currently the models expect slashed data, so after wp_kses
-                                    // runs we need to re-slash the data. Sheesh. See
-                                    // https://events.codebasehq.com/projects/event-espresso/tickets/11211#update-47321587
-                                    $set_column_values['MTP_content'][ $key ] = addslashes(
-                                        wp_kses(
-                                            stripslashes($value),
-                                            wp_kses_allowed_html('post')
-                                        )
-                                    );
-                                }
-                            } else {
-                                $set_column_values['MTP_content'] = wp_kses(
-                                    $set_column_values['MTP_content'],
-                                    wp_kses_allowed_html('post')
-                                );
-                            }
-                        }
-                        $message_template_fields = array(
-                            'GRP_ID'             => $set_column_values['GRP_ID'],
-                            'MTP_template_field' => $set_column_values['MTP_template_field'],
-                            'MTP_context'        => $set_column_values['MTP_context'],
-                            'MTP_content'        => $set_column_values['MTP_content'],
-                        );
-                        if ($updated = $MTP->update($message_template_fields, array($where_cols_n_values))) {
-                            if ($updated === false) {
-                                EE_Error::add_error(
-                                    sprintf(
-                                        esc_html__('%s field was NOT updated for some reason', 'event_espresso'),
-                                        $template_field
-                                    ),
-                                    __FILE__,
-                                    __FUNCTION__,
-                                    __LINE__
-                                );
-                            } else {
-                                $success = 1;
-                            }
-                        } else {
-                            // only do this logic if we don't have a MTP_ID for this field
-                            if (empty($this->_req_data['MTP_template_fields'][ $template_field ]['MTP_ID'])) {
-                                // this has already been through the template field validator and sanitized, so it will be
-                                // safe to insert this field.  Why insert?  This typically happens when we introduce a new
-                                // message template field in a messenger/message type and existing users don't have the
-                                // default setup for it.
-                                // @link https://events.codebasehq.com/projects/event-espresso/tickets/9465
-                                $updated = $MTP->insert($message_template_fields);
-                                if (! $updated || is_wp_error($updated)) {
-                                    EE_Error::add_error(
-                                        sprintf(
-                                            esc_html__('%s field could not be updated.', 'event_espresso'),
-                                            $template_field
-                                        ),
-                                        __FILE__,
-                                        __FUNCTION__,
-                                        __LINE__
-                                    );
-                                    $success = 0;
-                                } else {
-                                    $success = 1;
-                                }
-                            }
-                        }
-                        $action_desc = 'updated';
-                    }
-
-                    // we can use the last set_column_values for the MTPG update (because its the same for all of these specific MTPs)
-                    $mtpg_fields = array(
-                        'MTP_user_id'      => $set_column_values['MTP_user_id'],
-                        'MTP_messenger'    => $set_column_values['MTP_messenger'],
-                        'MTP_message_type' => $set_column_values['MTP_message_type'],
-                        'MTP_is_global'    => $set_column_values['MTP_is_global'],
-                        'MTP_is_override'  => $set_column_values['MTP_is_override'],
-                        'MTP_deleted'      => $set_column_values['MTP_deleted'],
-                        'MTP_is_active'    => $set_column_values['MTP_is_active'],
-                        'MTP_name'         => ! empty($this->_req_data['ee_msg_non_global_fields']['MTP_name'])
-                            ? $this->_req_data['ee_msg_non_global_fields']['MTP_name']
-                            : '',
-                        'MTP_description'  => ! empty($this->_req_data['ee_msg_non_global_fields']['MTP_description'])
-                            ? $this->_req_data['ee_msg_non_global_fields']['MTP_description']
-                            : '',
-                    );
-
-                    $mtpg_where = array('GRP_ID' => $set_column_values['GRP_ID']);
-                    $updated = $MTPG->update($mtpg_fields, array($mtpg_where));
-
-                    if ($updated === false) {
-                        EE_Error::add_error(
-                            sprintf(
-                                esc_html__(
-                                    'The Message Template Group (%d) was NOT updated for some reason',
-                                    'event_espresso'
-                                ),
-                                $set_column_values['GRP_ID']
-                            ),
-                            __FILE__,
-                            __FUNCTION__,
-                            __LINE__
-                        );
-                    } else {
-                        // k now we need to ensure the template_pack and template_variation fields are set.
-                        $template_pack = ! empty($this->_req_data['MTP_template_pack'])
-                            ? $this->_req_data['MTP_template_pack']
-                            : 'default';
-
-                        $template_variation = ! empty($this->_req_data['MTP_template_variation'])
-                            ? $this->_req_data['MTP_template_variation']
-                            : 'default';
-
-                        $mtpg_obj = $MTPG->get_one_by_ID($set_column_values['GRP_ID']);
-                        if ($mtpg_obj instanceof EE_Message_Template_Group) {
-                            $mtpg_obj->set_template_pack_name($template_pack);
-                            $mtpg_obj->set_template_pack_variation($template_variation);
-                        }
-                        $success = 1;
-                    }
-                }
-            }
-        }
-
-        // we return things differently if doing ajax
-        if (defined('DOING_AJAX') && DOING_AJAX) {
-            $this->_template_args['success'] = $success;
-            $this->_template_args['error'] = ! $success ? true : false;
-            $this->_template_args['content'] = '';
-            $this->_template_args['data'] = array(
-                'grpID'        => $edit_array['GRP_ID'],
-                'templateName' => $edit_array['template_name'],
-            );
-            if ($success) {
-                EE_Error::overwrite_success();
-                EE_Error::add_success(
-                    esc_html__(
-                        'The new template has been created and automatically selected for this event.  You can edit the new template by clicking the edit button.  Note before this template is assigned to this event, the event must be saved.',
-                        'event_espresso'
-                    )
-                );
-            }
-
-            $this->_return_json();
-        }
-
-
-        // was a test send triggered?
-        if (isset($this->_req_data['test_button'])) {
-            EE_Error::overwrite_success();
-            $this->_do_test_send($context_slug, $messenger_slug, $message_type_slug);
-            $override = true;
-        }
-
-        if (empty($query_args)) {
-            $query_args = array(
-                'id'      => $this->_req_data['GRP_ID'],
-                'context' => $context_slug,
-                'action'  => 'edit_message_template',
-            );
-        }
-
-        $this->_redirect_after_action($success, $item_desc, $action_desc, $query_args, $override);
-    }
-
-
-    /**
-     * processes a test send request to do an actual messenger delivery test for the given message template being tested
-     *
-     * @param  string $context      what context being tested
-     * @param  string $messenger    messenger being tested
-     * @param  string $message_type message type being tested
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _do_test_send($context, $messenger, $message_type)
-    {
-        // set things up for preview
-        $this->_req_data['messenger'] = $messenger;
-        $this->_req_data['message_type'] = $message_type;
-        $this->_req_data['context'] = $context;
-        $this->_req_data['GRP_ID'] = isset($this->_req_data['GRP_ID']) ? $this->_req_data['GRP_ID'] : '';
-        $active_messenger = $this->_message_resource_manager->get_active_messenger($messenger);
-
-        // let's save any existing fields that might be required by the messenger
-        if (
-            isset($this->_req_data['test_settings_fld'])
-            && $active_messenger instanceof EE_messenger
-            && apply_filters(
-                'FHEE__Messages_Admin_Page__do_test_send__set_existing_test_settings',
-                true,
-                $this->_req_data['test_settings_fld'],
-                $active_messenger
-            )
-        ) {
-            $active_messenger->set_existing_test_settings($this->_req_data['test_settings_fld']);
-        }
-
-        /**
-         * Use filter to add additional controls on whether message can send or not
-         */
-        if (
-            apply_filters(
-                'FHEE__Messages_Admin_Page__do_test_send__can_send',
-                true,
-                $context,
-                $this->_req_data,
-                $messenger,
-                $message_type
-            )
-        ) {
-            if (EEM_Event::instance()->count() > 0) {
-                $success = $this->_preview_message(true);
-                if ($success) {
-                    EE_Error::add_success(__('Test message sent', 'event_espresso'));
-                } else {
-                    EE_Error::add_error(
-                        esc_html__('The test message was not sent', 'event_espresso'),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                }
-            } else {
-                $this->noEventsErrorMessage(true);
-            }
-        }
-    }
-
-
-    /**
-     * _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.
-     *
-     *
-     * @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 this is a custom template being generated then a GRP_ID needs to be included to
-     *                               indicate the message_template_group being used as the base.
-     *
-     * @param bool    $global
-     *
-     * @return array|bool array of data required for the redirect to the correct edit page or bool if
-     *                               encountering problems.
-     * @throws EE_Error
-     */
-    protected function _generate_new_templates($messenger, $message_types, $GRP_ID = 0, $global = false)
-    {
-
-        // if no $message_types are given then that's okay... this may be a messenger that just adds shortcodes, so we
-        // just don't generate any templates.
-        if (empty($message_types)) {
-            return true;
-        }
-
-        return EEH_MSG_Template::generate_new_templates($messenger, $message_types, $GRP_ID, $global);
-    }
-
-
-    /**
-     * [_trash_or_restore_message_template]
-     *
-     * @param  boolean $trash whether to move an item to trash/restore (TRUE) or restore it (FALSE)
-     * @param boolean  $all   whether this is going to trash/restore all contexts within a template group (TRUE) OR just
-     *                        an individual context (FALSE).
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _trash_or_restore_message_template($trash = true, $all = false)
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $MTP = EEM_Message_Template_Group::instance();
-
-        $success = 1;
-
-        // incoming GRP_IDs
-        if ($all) {
-            // Checkboxes
-            if (! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
-                // if array has more than one element then success message should be plural.
-                // todo: what about nonce?
-                $success = count($this->_req_data['checkbox']) > 1 ? 2 : 1;
-
-                // cycle through checkboxes
-                while (list($GRP_ID, $value) = each($this->_req_data['checkbox'])) {
-                    $trashed_or_restored = $trash ? $MTP->delete_by_ID($GRP_ID) : $MTP->restore_by_ID($GRP_ID);
-                    if (! $trashed_or_restored) {
-                        $success = 0;
-                    }
-                }
-            } else {
-                // grab single GRP_ID and handle
-                $GRP_ID = isset($this->_req_data['id']) ? absint($this->_req_data['id']) : 0;
-                if (! empty($GRP_ID)) {
-                    $trashed_or_restored = $trash ? $MTP->delete_by_ID($GRP_ID) : $MTP->restore_by_ID($GRP_ID);
-                    if (! $trashed_or_restored) {
-                        $success = 0;
-                    }
-                } else {
-                    $success = 0;
-                }
-            }
-        }
-
-        $action_desc = $trash
-            ? esc_html__('moved to the trash', 'event_espresso')
-            : esc_html__('restored', 'event_espresso');
-
-        $action_desc = ! empty($this->_req_data['template_switch']) ? esc_html__('switched', 'event_espresso') : $action_desc;
-
-        $item_desc = $all ? _n(
-            'Message Template Group',
-            'Message Template Groups',
-            $success,
-            'event_espresso'
-        ) : _n('Message Template Context', 'Message Template Contexts', $success, 'event_espresso');
-
-        $item_desc = ! empty($this->_req_data['template_switch']) ? _n(
-            'template',
-            'templates',
-            $success,
-            'event_espresso'
-        ) : $item_desc;
-
-        $this->_redirect_after_action($success, $item_desc, $action_desc, array());
-    }
-
-
-    /**
-     * [_delete_message_template]
-     * NOTE: this handles not only the deletion of the groups but also all the templates belonging to that group.
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _delete_message_template()
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-
-        // checkboxes
-        if (! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
-            // if array has more than one element then success message should be plural
-            $success = count($this->_req_data['checkbox']) > 1 ? 2 : 1;
-
-            // cycle through bulk action checkboxes
-            while (list($GRP_ID, $value) = each($this->_req_data['checkbox'])) {
-                $success = $this->_delete_mtp_permanently($GRP_ID);
-            }
-        } else {
-            // grab single grp_id and delete
-            $GRP_ID = absint($this->_req_data['id']);
-            $success = $this->_delete_mtp_permanently($GRP_ID);
-        }
-
-        $this->_redirect_after_action($success, 'Message Templates', 'deleted', array());
-    }
-
-
-    /**
-     * helper for permanently deleting a mtP group and all related message_templates
-     *
-     * @param  int  $GRP_ID        The group being deleted
-     * @param  bool $include_group whether to delete the Message Template Group as well.
-     * @return bool boolean to indicate the success of the deletes or not.
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _delete_mtp_permanently($GRP_ID, $include_group = true)
-    {
-        $success = 1;
-        $MTPG = EEM_Message_Template_Group::instance();
-        // first let's GET this group
-        $MTG = $MTPG->get_one_by_ID($GRP_ID);
-        // then delete permanently all the related Message Templates
-        $deleted = $MTG->delete_related_permanently('Message_Template');
-
-        if ($deleted === 0) {
-            $success = 0;
-        }
-
-        // now delete permanently this particular group
-
-        if ($include_group && ! $MTG->delete_permanently()) {
-            $success = 0;
-        }
-
-        return $success;
-    }
-
-
-    /**
-     *    _learn_more_about_message_templates_link
-     *
-     * @access protected
-     * @return string
-     */
-    protected function _learn_more_about_message_templates_link()
-    {
-        return '<a class="hidden" style="margin:0 20px; cursor:pointer; font-size:12px;" >'
-               . esc_html__('learn more about how message templates works', 'event_espresso')
-               . '</a>';
-    }
-
-
-    /**
-     * Used for setting up messenger/message type activation.  This loads up the initial view.  The rest is handled by
-     * ajax and other routes.
-     *
-     * @return void
-     * @throws DomainException
-     */
-    protected function _settings()
-    {
-
-
-        $this->_set_m_mt_settings();
-
-        $selected_messenger = isset($this->_req_data['selected_messenger'])
-            ? $this->_req_data['selected_messenger']
-            : 'email';
-
-        // let's setup the messenger tabs
-        $this->_template_args['admin_page_header'] = EEH_Tabbed_Content::tab_text_links(
-            $this->_m_mt_settings['messenger_tabs'],
-            'messenger_links',
-            '|',
-            $selected_messenger
-        );
-        $this->_template_args['before_admin_page_content'] = '<div class="ui-widget ui-helper-clearfix">';
-        $this->_template_args['after_admin_page_content'] = '</div><!-- end .ui-widget -->';
-
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    /**
-     * This sets the $_m_mt_settings property for when needed (used on the Messages settings page)
-     *
-     * @access protected
-     * @return void
-     * @throws DomainException
-     */
-    protected function _set_m_mt_settings()
-    {
-        // first if this is already set then lets get out no need to regenerate data.
-        if (! empty($this->_m_mt_settings)) {
-            return;
-        }
-
-        // get all installed messengers and message_types
-        /** @type EE_messenger[] $messengers */
-        $messengers = $this->_message_resource_manager->installed_messengers();
-        /** @type EE_message_type[] $message_types */
-        $message_types = $this->_message_resource_manager->installed_message_types();
-
-
-        // assemble the array for the _tab_text_links helper
-
-        foreach ($messengers as $messenger) {
-            $this->_m_mt_settings['messenger_tabs'][ $messenger->name ] = array(
-                'label' => ucwords($messenger->label['singular']),
-                'class' => $this->_message_resource_manager->is_messenger_active($messenger->name)
-                    ? 'messenger-active'
-                    : '',
-                'href'  => $messenger->name,
-                'title' => esc_html__('Modify this Messenger', 'event_espresso'),
-                'slug'  => $messenger->name,
-                'obj'   => $messenger,
-            );
-
-
-            $message_types_for_messenger = $messenger->get_valid_message_types();
-
-            foreach ($message_types as $message_type) {
-                // first we need to verify that this message type is valid with this messenger. Cause if it isn't then
-                // it shouldn't show in either the inactive OR active metabox.
-                if (! in_array($message_type->name, $message_types_for_messenger, true)) {
-                    continue;
-                }
-
-                $a_or_i = $this->_message_resource_manager->is_message_type_active_for_messenger(
-                    $messenger->name,
-                    $message_type->name
-                )
-                    ? 'active'
-                    : 'inactive';
-
-                $this->_m_mt_settings['message_type_tabs'][ $messenger->name ][ $a_or_i ][ $message_type->name ] = array(
-                    'label'    => ucwords($message_type->label['singular']),
-                    'class'    => 'message-type-' . $a_or_i,
-                    'slug_id'  => $message_type->name . '-messagetype-' . $messenger->name,
-                    'mt_nonce' => wp_create_nonce($message_type->name . '_nonce'),
-                    'href'     => 'espresso_' . $message_type->name . '_message_type_settings',
-                    'title'    => $a_or_i === 'active'
-                        ? esc_html__('Drag this message type to the Inactive window to deactivate', 'event_espresso')
-                        : esc_html__('Drag this message type to the messenger to activate', 'event_espresso'),
-                    'content'  => $a_or_i === 'active'
-                        ? $this->_message_type_settings_content($message_type, $messenger, true)
-                        : $this->_message_type_settings_content($message_type, $messenger),
-                    'slug'     => $message_type->name,
-                    'active'   => $a_or_i === 'active',
-                    'obj'      => $message_type,
-                );
-            }
-        }
-    }
-
-
-    /**
-     * This just prepares the content for the message type settings
-     *
-     * @param  EE_message_type $message_type The message type object
-     * @param  EE_messenger    $messenger    The messenger object
-     * @param  boolean         $active       Whether the message type is active or not
-     * @return string html output for the content
-     * @throws DomainException
-     */
-    protected function _message_type_settings_content($message_type, $messenger, $active = false)
-    {
-        // get message type fields
-        $fields = $message_type->get_admin_settings_fields();
-        $settings_template_args['template_form_fields'] = '';
-
-        if (! empty($fields) && $active) {
-            $existing_settings = $message_type->get_existing_admin_settings($messenger->name);
-            foreach ($fields as $fldname => $fldprops) {
-                $field_id = $messenger->name . '-' . $message_type->name . '-' . $fldname;
-                $template_form_field[ $field_id ] = array(
-                    'name'       => 'message_type_settings[' . $fldname . ']',
-                    'label'      => $fldprops['label'],
-                    'input'      => $fldprops['field_type'],
-                    'type'       => $fldprops['value_type'],
-                    'required'   => $fldprops['required'],
-                    'validation' => $fldprops['validation'],
-                    'value'      => isset($existing_settings[ $fldname ])
-                        ? $existing_settings[ $fldname ]
-                        : $fldprops['default'],
-                    'options'    => isset($fldprops['options'])
-                        ? $fldprops['options']
-                        : array(),
-                    'default'    => isset($existing_settings[ $fldname ])
-                        ? $existing_settings[ $fldname ]
-                        : $fldprops['default'],
-                    'css_class'  => 'no-drag',
-                    'format'     => $fldprops['format'],
-                );
-            }
-
-
-            $settings_template_args['template_form_fields'] = ! empty($template_form_field)
-                ? $this->_generate_admin_form_fields(
-                    $template_form_field,
-                    'string',
-                    'ee_mt_activate_form'
-                )
-                : '';
-        }
-
-        $settings_template_args['description'] = $message_type->description;
-        // we also need some hidden fields
-        $settings_template_args['hidden_fields'] = array(
-            'message_type_settings[messenger]'    => array(
-                'type'  => 'hidden',
-                'value' => $messenger->name,
-            ),
-            'message_type_settings[message_type]' => array(
-                'type'  => 'hidden',
-                'value' => $message_type->name,
-            ),
-            'type'                                => array(
-                'type'  => 'hidden',
-                'value' => 'message_type',
-            ),
-        );
-
-        $settings_template_args['hidden_fields'] = $this->_generate_admin_form_fields(
-            $settings_template_args['hidden_fields'],
-            'array'
-        );
-        $settings_template_args['show_form'] = empty($settings_template_args['template_form_fields'])
-            ? ' hidden'
-            : '';
-
-
-        $template = EE_MSG_TEMPLATE_PATH . 'ee_msg_mt_settings_content.template.php';
-        $content = EEH_Template::display_template($template, $settings_template_args, true);
-
-        return $content;
-    }
-
-
-    /**
-     * Generate all the metaboxes for the message types and register them for the messages settings page.
-     *
-     * @access protected
-     * @return void
-     * @throws DomainException
-     */
-    protected function _messages_settings_metaboxes()
-    {
-        $this->_set_m_mt_settings();
-        $m_boxes = $mt_boxes = array();
-        $m_template_args = $mt_template_args = array();
-
-        $selected_messenger = isset($this->_req_data['selected_messenger'])
-            ? $this->_req_data['selected_messenger']
-            : 'email';
-
-        if (isset($this->_m_mt_settings['messenger_tabs'])) {
-            foreach ($this->_m_mt_settings['messenger_tabs'] as $messenger => $tab_array) {
-                $hide_on_message = $this->_message_resource_manager->is_messenger_active($messenger) ? '' : 'hidden';
-                $hide_off_message = $this->_message_resource_manager->is_messenger_active($messenger) ? 'hidden' : '';
-                // messenger meta boxes
-                $active = $selected_messenger === $messenger;
-                $active_mt_tabs = isset(
-                    $this->_m_mt_settings['message_type_tabs'][ $messenger ]['active']
-                )
-                    ? $this->_m_mt_settings['message_type_tabs'][ $messenger ]['active']
-                    : '';
-                $m_boxes[ $messenger . '_a_box' ] = sprintf(
-                    esc_html__('%s Settings', 'event_espresso'),
-                    $tab_array['label']
-                );
-                $m_template_args[ $messenger . '_a_box' ] = array(
-                    'active_message_types'   => ! empty($active_mt_tabs) ? $this->_get_mt_tabs($active_mt_tabs) : '',
-                    'inactive_message_types' => isset(
-                        $this->_m_mt_settings['message_type_tabs'][ $messenger ]['inactive']
-                    )
-                        ? $this->_get_mt_tabs($this->_m_mt_settings['message_type_tabs'][ $messenger ]['inactive'])
-                        : '',
-                    'content'                => $this->_get_messenger_box_content($tab_array['obj']),
-                    'hidden'                 => $active ? '' : ' hidden',
-                    'hide_on_message'        => $hide_on_message,
-                    'messenger'              => $messenger,
-                    'active'                 => $active,
-                );
-                // message type meta boxes
-                // (which is really just the inactive container for each messenger
-                // showing inactive message types for that messenger)
-                $mt_boxes[ $messenger . '_i_box' ] = esc_html__('Inactive Message Types', 'event_espresso');
-                $mt_template_args[ $messenger . '_i_box' ] = array(
-                    'active_message_types'   => ! empty($active_mt_tabs) ? $this->_get_mt_tabs($active_mt_tabs) : '',
-                    'inactive_message_types' => isset(
-                        $this->_m_mt_settings['message_type_tabs'][ $messenger ]['inactive']
-                    )
-                        ? $this->_get_mt_tabs($this->_m_mt_settings['message_type_tabs'][ $messenger ]['inactive'])
-                        : '',
-                    'hidden'                 => $active ? '' : ' hidden',
-                    'hide_on_message'        => $hide_on_message,
-                    'hide_off_message'       => $hide_off_message,
-                    'messenger'              => $messenger,
-                    'active'                 => $active,
-                );
-            }
-        }
-
-
-        // register messenger metaboxes
-        $m_template_path = EE_MSG_TEMPLATE_PATH . 'ee_msg_details_messenger_mt_meta_box.template.php';
-        foreach ($m_boxes as $box => $label) {
-            $callback_args = array('template_path' => $m_template_path, 'template_args' => $m_template_args[ $box ]);
-            $msgr = str_replace('_a_box', '', $box);
-            add_meta_box(
-                'espresso_' . $msgr . '_settings',
-                $label,
-                function ($post, $metabox) {
-                    echo EEH_Template::display_template(
-                        $metabox["args"]["template_path"],
-                        $metabox["args"]["template_args"],
-                        true
-                    );
-                },
-                $this->_current_screen->id,
-                'normal',
-                'high',
-                $callback_args
-            );
-        }
-
-        // register message type metaboxes
-        $mt_template_path = EE_MSG_TEMPLATE_PATH . 'ee_msg_details_messenger_meta_box.template.php';
-        foreach ($mt_boxes as $box => $label) {
-            $callback_args = array(
-                'template_path' => $mt_template_path,
-                'template_args' => $mt_template_args[ $box ],
-            );
-            $mt = str_replace('_i_box', '', $box);
-            add_meta_box(
-                'espresso_' . $mt . '_inactive_mts',
-                $label,
-                function ($post, $metabox) {
-                    echo EEH_Template::display_template(
-                        $metabox["args"]["template_path"],
-                        $metabox["args"]["template_args"],
-                        true
-                    );
-                },
-                $this->_current_screen->id,
-                'side',
-                'high',
-                $callback_args
-            );
-        }
-
-        // register metabox for global messages settings but only when on the main site.  On single site installs this
-        // will always result in the metabox showing, on multisite installs the metabox will only show on the main site.
-        if (is_main_site()) {
-            add_meta_box(
-                'espresso_global_message_settings',
-                esc_html__('Global Message Settings', 'event_espresso'),
-                array($this, 'global_messages_settings_metabox_content'),
-                $this->_current_screen->id,
-                'normal',
-                'low',
-                array()
-            );
-        }
-    }
-
-
-    /**
-     *  This generates the content for the global messages settings metabox.
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function global_messages_settings_metabox_content()
-    {
-        $form = $this->_generate_global_settings_form();
-        echo $form->form_open(
-            $this->add_query_args_and_nonce(array('action' => 'update_global_settings'), EE_MSG_ADMIN_URL),
-            'POST'
-        )
-             . $form->get_html()
-             . $form->form_close();
-    }
-
-
-    /**
-     * This generates and returns the form object for the global messages settings.
-     *
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _generate_global_settings_form()
-    {
-        EE_Registry::instance()->load_helper('HTML');
-        /** @var EE_Network_Core_Config $network_config */
-        $network_config = EE_Registry::instance()->NET_CFG->core;
-
-        return new EE_Form_Section_Proper(
-            array(
-                'name'            => 'global_messages_settings',
-                'html_id'         => 'global_messages_settings',
-                'html_class'      => 'form-table',
-                'layout_strategy' => new EE_Admin_Two_Column_Layout(),
-                'subsections'     => apply_filters(
-                    'FHEE__Messages_Admin_Page__global_messages_settings_metabox_content__form_subsections',
-                    array(
-                        'do_messages_on_same_request' => new EE_Select_Input(
-                            array(
-                                true  => esc_html__("On the same request", "event_espresso"),
-                                false => esc_html__("On a separate request", "event_espresso"),
-                            ),
-                            array(
-                                'default'         => $network_config->do_messages_on_same_request,
-                                'html_label_text' => esc_html__(
-                                    'Generate and send all messages:',
-                                    'event_espresso'
-                                ),
-                                'html_help_text'  => esc_html__(
-                                    'By default the messages system uses a more efficient means of processing messages on separate requests and utilizes the wp-cron scheduling system.  This makes things execute faster for people registering for your events.  However, if the wp-cron system is disabled on your site and there is no alternative in place, then you can change this so messages are always executed on the same request.',
-                                    'event_espresso'
-                                ),
-                            )
-                        ),
-                        'delete_threshold'            => new EE_Select_Input(
-                            array(
-                                0  => esc_html__('Forever', 'event_espresso'),
-                                3  => esc_html__('3 Months', 'event_espresso'),
-                                6  => esc_html__('6 Months', 'event_espresso'),
-                                9  => esc_html__('9 Months', 'event_espresso'),
-                                12 => esc_html__('12 Months', 'event_espresso'),
-                                24 => esc_html__('24 Months', 'event_espresso'),
-                                36 => esc_html__('36 Months', 'event_espresso'),
-                            ),
-                            array(
-                                'default'         => EE_Registry::instance()->CFG->messages->delete_threshold,
-                                'html_label_text' => esc_html__('Cleanup of old messages:', 'event_espresso'),
-                                'html_help_text'  => esc_html__(
-                                    'You can control how long a record of processed messages is kept via this option.',
-                                    'event_espresso'
-                                ),
-                            )
-                        ),
-                        'update_settings'             => new EE_Submit_Input(
-                            array(
-                                'default'         => esc_html__('Update', 'event_espresso'),
-                                'html_label_text' => '&nbsp',
-                            )
-                        ),
-                    )
-                ),
-            )
-        );
-    }
-
-
-    /**
-     * This handles updating the global settings set on the admin page.
-     *
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     */
-    protected function _update_global_settings()
-    {
-        /** @var EE_Network_Core_Config $network_config */
-        $network_config = EE_Registry::instance()->NET_CFG->core;
-        $messages_config = EE_Registry::instance()->CFG->messages;
-        $form = $this->_generate_global_settings_form();
-        if ($form->was_submitted()) {
-            $form->receive_form_submission();
-            if ($form->is_valid()) {
-                $valid_data = $form->valid_data();
-                foreach ($valid_data as $property => $value) {
-                    $setter = 'set_' . $property;
-                    if (method_exists($network_config, $setter)) {
-                        $network_config->{$setter}($value);
-                    } elseif (
-                        property_exists($network_config, $property)
-                        && $network_config->{$property} !== $value
-                    ) {
-                        $network_config->{$property} = $value;
-                    } elseif (
-                        property_exists($messages_config, $property)
-                        && $messages_config->{$property} !== $value
-                    ) {
-                        $messages_config->{$property} = $value;
-                    }
-                }
-                // only update if the form submission was valid!
-                EE_Registry::instance()->NET_CFG->update_config(true, false);
-                EE_Registry::instance()->CFG->update_espresso_config();
-                EE_Error::overwrite_success();
-                EE_Error::add_success(__('Global message settings were updated', 'event_espresso'));
-            }
-        }
-        $this->_redirect_after_action(0, '', '', array('action' => 'settings'), true);
-    }
-
-
-    /**
-     * this prepares the messenger tabs that can be dragged in and out of messenger boxes to activate/deactivate
-     *
-     * @param  array $tab_array This is an array of message type tab details used to generate the tabs
-     * @return string html formatted tabs
-     * @throws DomainException
-     */
-    protected function _get_mt_tabs($tab_array)
-    {
-        $tab_array = (array) $tab_array;
-        $template = EE_MSG_TEMPLATE_PATH . 'ee_msg_details_mt_settings_tab_item.template.php';
-        $tabs = '';
-
-        foreach ($tab_array as $tab) {
-            $tabs .= EEH_Template::display_template($template, $tab, true);
-        }
-
-        return $tabs;
-    }
-
-
-    /**
-     * This prepares the content of the messenger meta box admin settings
-     *
-     * @param  EE_messenger $messenger The messenger we're setting up content for
-     * @return string html formatted content
-     * @throws DomainException
-     */
-    protected function _get_messenger_box_content(EE_messenger $messenger)
-    {
-
-        $fields = $messenger->get_admin_settings_fields();
-        $settings_template_args['template_form_fields'] = '';
-
-        // is $messenger active?
-        $settings_template_args['active'] = $this->_message_resource_manager->is_messenger_active($messenger->name);
-
-
-        if (! empty($fields)) {
-            $existing_settings = $messenger->get_existing_admin_settings();
-
-            foreach ($fields as $fldname => $fldprops) {
-                $field_id = $messenger->name . '-' . $fldname;
-                $template_form_field[ $field_id ] = array(
-                    'name'       => 'messenger_settings[' . $field_id . ']',
-                    'label'      => $fldprops['label'],
-                    'input'      => $fldprops['field_type'],
-                    'type'       => $fldprops['value_type'],
-                    'required'   => $fldprops['required'],
-                    'validation' => $fldprops['validation'],
-                    'value'      => isset($existing_settings[ $field_id ])
-                        ? $existing_settings[ $field_id ]
-                        : $fldprops['default'],
-                    'css_class'  => '',
-                    'format'     => $fldprops['format'],
-                );
-            }
-
-
-            $settings_template_args['template_form_fields'] = ! empty($template_form_field)
-                ? $this->_generate_admin_form_fields($template_form_field, 'string', 'ee_m_activate_form')
-                : '';
-        }
-
-        // we also need some hidden fields
-        $settings_template_args['hidden_fields'] = array(
-            'messenger_settings[messenger]' => array(
-                'type'  => 'hidden',
-                'value' => $messenger->name,
-            ),
-            'type'                          => array(
-                'type'  => 'hidden',
-                'value' => 'messenger',
-            ),
-        );
-
-        // make sure any active message types that are existing are included in the hidden fields
-        if (isset($this->_m_mt_settings['message_type_tabs'][ $messenger->name ]['active'])) {
-            foreach ($this->_m_mt_settings['message_type_tabs'][ $messenger->name ]['active'] as $mt => $values) {
-                $settings_template_args['hidden_fields'][ 'messenger_settings[message_types][' . $mt . ']' ] = array(
-                    'type'  => 'hidden',
-                    'value' => $mt,
-                );
-            }
-        }
-        $settings_template_args['hidden_fields'] = $this->_generate_admin_form_fields(
-            $settings_template_args['hidden_fields'],
-            'array'
-        );
-        $active = $this->_message_resource_manager->is_messenger_active($messenger->name);
-
-        $settings_template_args['messenger'] = $messenger->name;
-        $settings_template_args['description'] = $messenger->description;
-        $settings_template_args['show_hide_edit_form'] = $active ? '' : ' hidden';
-
-
-        $settings_template_args['show_hide_edit_form'] = $this->_message_resource_manager->is_messenger_active(
-            $messenger->name
-        )
-            ? $settings_template_args['show_hide_edit_form']
-            : ' hidden';
-
-        $settings_template_args['show_hide_edit_form'] = empty($settings_template_args['template_form_fields'])
-            ? ' hidden'
-            : $settings_template_args['show_hide_edit_form'];
-
-
-        $settings_template_args['on_off_action'] = $active ? 'messenger-off' : 'messenger-on';
-        $settings_template_args['nonce'] = wp_create_nonce('activate_' . $messenger->name . '_toggle_nonce');
-        $settings_template_args['on_off_status'] = $active ? true : false;
-        $template = EE_MSG_TEMPLATE_PATH . 'ee_msg_m_settings_content.template.php';
-        $content = EEH_Template::display_template(
-            $template,
-            $settings_template_args,
-            true
-        );
-
-        return $content;
-    }
-
-
-    /**
-     * used by ajax on the messages settings page to activate|deactivate the messenger
-     *
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     */
-    public function activate_messenger_toggle()
-    {
-        $success = true;
-        $this->_prep_default_response_for_messenger_or_message_type_toggle();
-        // let's check that we have required data
-        if (! isset($this->_req_data['messenger'])) {
-            EE_Error::add_error(
-                esc_html__('Messenger name needed to toggle activation. None given', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $success = false;
-        }
-
-        // do a nonce check here since we're not arriving via a normal route
-        $nonce = isset($this->_req_data['activate_nonce'])
-            ? sanitize_text_field($this->_req_data['activate_nonce'])
-            : '';
-        $nonce_ref = 'activate_' . $this->_req_data['messenger'] . '_toggle_nonce';
-
-        $this->_verify_nonce($nonce, $nonce_ref);
-
-
-        if (! isset($this->_req_data['status'])) {
-            EE_Error::add_error(
-                esc_html__(
-                    'Messenger status needed to know whether activation or deactivation is happening. No status is given',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $success = false;
-        }
-
-        // do check to verify we have a valid status.
-        $status = $this->_req_data['status'];
-
-        if ($status !== 'off' && $status !== 'on') {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__('The given status (%s) is not valid. Must be "off" or "on"', 'event_espresso'),
-                    $this->_req_data['status']
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $success = false;
-        }
-
-        if ($success) {
-            // made it here?  Stop dawdling then!!
-            $success = $status === 'off'
-                ? $this->_deactivate_messenger($this->_req_data['messenger'])
-                : $this->_activate_messenger($this->_req_data['messenger']);
-        }
-
-        $this->_template_args['success'] = $success;
-
-        // no special instructions so let's just do the json return (which should automatically do all the special stuff).
-        $this->_return_json();
-    }
-
-
-    /**
-     * used by ajax from the messages settings page to activate|deactivate a message type
-     *
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    public function activate_mt_toggle()
-    {
-        $success = true;
-        $this->_prep_default_response_for_messenger_or_message_type_toggle();
-
-        // let's make sure we have the necessary data
-        if (! isset($this->_req_data['message_type'])) {
-            EE_Error::add_error(
-                esc_html__('Message Type name needed to toggle activation. None given', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $success = false;
-        }
-
-        if (! isset($this->_req_data['messenger'])) {
-            EE_Error::add_error(
-                esc_html__('Messenger name needed to toggle activation. None given', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $success = false;
-        }
-
-        if (! isset($this->_req_data['status'])) {
-            EE_Error::add_error(
-                esc_html__(
-                    'Messenger status needed to know whether activation or deactivation is happening. No status is given',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $success = false;
-        }
-
-
-        // do check to verify we have a valid status.
-        $status = $this->_req_data['status'];
-
-        if ($status !== 'activate' && $status !== 'deactivate') {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__('The given status (%s) is not valid. Must be "active" or "inactive"', 'event_espresso'),
-                    $this->_req_data['status']
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $success = false;
-        }
-
-
-        // do a nonce check here since we're not arriving via a normal route
-        $nonce = isset($this->_req_data['mt_nonce']) ? sanitize_text_field($this->_req_data['mt_nonce']) : '';
-        $nonce_ref = $this->_req_data['message_type'] . '_nonce';
-
-        $this->_verify_nonce($nonce, $nonce_ref);
-
-        if ($success) {
-            // made it here? um, what are you waiting for then?
-            $success = $status === 'deactivate'
-                ? $this->_deactivate_message_type_for_messenger(
-                    $this->_req_data['messenger'],
-                    $this->_req_data['message_type']
-                )
-                : $this->_activate_message_type_for_messenger(
-                    $this->_req_data['messenger'],
-                    $this->_req_data['message_type']
-                );
-        }
-
-        $this->_template_args['success'] = $success;
-        $this->_return_json();
-    }
-
-
-    /**
-     * Takes care of processing activating a messenger and preparing the appropriate response.
-     *
-     * @param string $messenger_name The name of the messenger being activated
-     * @return bool
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _activate_messenger($messenger_name)
-    {
-        /** @var EE_messenger $active_messenger This will be present because it can't be toggled if it isn't */
-        $active_messenger = $this->_message_resource_manager->get_messenger($messenger_name);
-        $message_types_to_activate = $active_messenger instanceof EE_Messenger
-            ? $active_messenger->get_default_message_types()
-            : array();
-
-        // ensure is active
-        $this->_message_resource_manager->activate_messenger($active_messenger, $message_types_to_activate);
-
-        // set response_data for reload
-        foreach ($message_types_to_activate as $message_type_name) {
-            /** @var EE_message_type $message_type */
-            $message_type = $this->_message_resource_manager->get_message_type($message_type_name);
-            if (
-                $this->_message_resource_manager->is_message_type_active_for_messenger(
-                    $messenger_name,
-                    $message_type_name
-                )
-                && $message_type instanceof EE_message_type
-            ) {
-                $this->_template_args['data']['active_mts'][] = $message_type_name;
-                if ($message_type->get_admin_settings_fields()) {
-                    $this->_template_args['data']['mt_reload'][] = $message_type_name;
-                }
-            }
-        }
-
-        // add success message for activating messenger
-        return $this->_setup_response_message_for_activating_messenger_with_message_types($active_messenger);
-    }
-
-
-    /**
-     * Takes care of processing deactivating a messenger and preparing the appropriate response.
-     *
-     * @param string $messenger_name The name of the messenger being activated
-     * @return bool
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _deactivate_messenger($messenger_name)
-    {
-        /** @var EE_messenger $active_messenger This will be present because it can't be toggled if it isn't */
-        $active_messenger = $this->_message_resource_manager->get_messenger($messenger_name);
-        $this->_message_resource_manager->deactivate_messenger($messenger_name);
-
-        return $this->_setup_response_message_for_deactivating_messenger_with_message_types($active_messenger);
-    }
-
-
-    /**
-     * Takes care of processing activating a message type for a messenger and preparing the appropriate response.
-     *
-     * @param string $messenger_name    The name of the messenger the message type is being activated for.
-     * @param string $message_type_name The name of the message type being activated for the messenger
-     * @return bool
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _activate_message_type_for_messenger($messenger_name, $message_type_name)
-    {
-        /** @var EE_messenger $active_messenger This will be present because it can't be toggled if it isn't */
-        $active_messenger = $this->_message_resource_manager->get_messenger($messenger_name);
-        /** @var EE_message_type $message_type_to_activate This will be present because it can't be toggled if it isn't */
-        $message_type_to_activate = $this->_message_resource_manager->get_message_type($message_type_name);
-
-        // ensure is active
-        $this->_message_resource_manager->activate_messenger($active_messenger, $message_type_name);
-
-        // set response for load
-        if (
-            $this->_message_resource_manager->is_message_type_active_for_messenger(
-                $messenger_name,
-                $message_type_name
-            )
-        ) {
-            $this->_template_args['data']['active_mts'][] = $message_type_name;
-            if ($message_type_to_activate->get_admin_settings_fields()) {
-                $this->_template_args['data']['mt_reload'][] = $message_type_name;
-            }
-        }
-
-        return $this->_setup_response_message_for_activating_messenger_with_message_types(
-            $active_messenger,
-            $message_type_to_activate
-        );
-    }
-
-
-    /**
-     * Takes care of processing deactivating a message type for a messenger and preparing the appropriate response.
-     *
-     * @param string $messenger_name    The name of the messenger the message type is being deactivated for.
-     * @param string $message_type_name The name of the message type being deactivated for the messenger
-     * @return bool
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _deactivate_message_type_for_messenger($messenger_name, $message_type_name)
-    {
-        /** @var EE_messenger $active_messenger This will be present because it can't be toggled if it isn't */
-        $active_messenger = $this->_message_resource_manager->get_messenger($messenger_name);
-        /** @var EE_message_type $message_type_to_activate This will be present because it can't be toggled if it isn't */
-        $message_type_to_deactivate = $this->_message_resource_manager->get_message_type($message_type_name);
-        $this->_message_resource_manager->deactivate_message_type_for_messenger($message_type_name, $messenger_name);
-
-        return $this->_setup_response_message_for_deactivating_messenger_with_message_types(
-            $active_messenger,
-            $message_type_to_deactivate
-        );
-    }
-
-
-    /**
-     * This just initializes the defaults for activating messenger and message type responses.
-     */
-    protected function _prep_default_response_for_messenger_or_message_type_toggle()
-    {
-        $this->_template_args['data']['active_mts'] = array();
-        $this->_template_args['data']['mt_reload'] = array();
-    }
-
-
-    /**
-     * Setup appropriate response for activating a messenger and/or message types
-     *
-     * @param EE_messenger         $messenger
-     * @param EE_message_type|null $message_type
-     * @return bool
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _setup_response_message_for_activating_messenger_with_message_types(
-        $messenger,
-        EE_Message_Type $message_type = null
-    ) {
-        // if $messenger isn't a valid messenger object then get out.
-        if (! $messenger instanceof EE_Messenger) {
-            EE_Error::add_error(
-                esc_html__('The messenger being activated is not a valid messenger', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-
-            return false;
-        }
-        // activated
-        if ($this->_template_args['data']['active_mts']) {
-            EE_Error::overwrite_success();
-            // activated a message type with the messenger
-            if ($message_type instanceof EE_message_type) {
-                EE_Error::add_success(
-                    sprintf(
-                        esc_html__(
-                            '%s message type has been successfully activated with the %s messenger',
-                            'event_espresso'
-                        ),
-                        ucwords($message_type->label['singular']),
-                        ucwords($messenger->label['singular'])
-                    )
-                );
-
-                // if message type was invoice then let's make sure we activate the invoice payment method.
-                if ($message_type->name === 'invoice') {
-                    EE_Registry::instance()->load_lib('Payment_Method_Manager');
-                    $pm = EE_Payment_Method_Manager::instance()->activate_a_payment_method_of_type('Invoice');
-                    if ($pm instanceof EE_Payment_Method) {
-                        EE_Error::add_attention(
-                            esc_html__(
-                                'Activating the invoice message type also automatically activates the invoice payment method.  If you do not wish the invoice payment method to be active, or to change its settings, visit the payment method admin page.',
-                                'event_espresso'
-                            )
-                        );
-                    }
-                }
-                // just toggles the entire messenger
-            } else {
-                EE_Error::add_success(
-                    sprintf(
-                        esc_html__('%s messenger has been successfully activated', 'event_espresso'),
-                        ucwords($messenger->label['singular'])
-                    )
-                );
-            }
-
-            return true;
-
-            // possible error condition. This will happen when our active_mts data is empty because it is validated for actual active
-            // message types after the activation process.  However its possible some messengers don't HAVE any default_message_types
-            // in which case we just give a success message for the messenger being successfully activated.
-        } else {
-            if (! $messenger->get_default_message_types()) {
-                // messenger doesn't have any default message types so still a success.
-                EE_Error::add_success(
-                    sprintf(
-                        esc_html__('%s messenger was successfully activated.', 'event_espresso'),
-                        ucwords($messenger->label['singular'])
-                    )
-                );
-
-                return true;
-            } else {
-                EE_Error::add_error(
-                    $message_type instanceof EE_message_type
-                        ? sprintf(
-                            esc_html__(
-                                '%s message type was not successfully activated with the %s messenger',
-                                'event_espresso'
-                            ),
-                            ucwords($message_type->label['singular']),
-                            ucwords($messenger->label['singular'])
-                        )
-                        : sprintf(
-                            esc_html__('%s messenger was not successfully activated', 'event_espresso'),
-                            ucwords($messenger->label['singular'])
-                        ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-
-                return false;
-            }
-        }
-    }
-
-
-    /**
-     * This sets up the appropriate response for deactivating a messenger and/or message type.
-     *
-     * @param EE_messenger         $messenger
-     * @param EE_message_type|null $message_type
-     * @return bool
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _setup_response_message_for_deactivating_messenger_with_message_types(
-        $messenger,
-        EE_message_type $message_type = null
-    ) {
-        EE_Error::overwrite_success();
-
-        // if $messenger isn't a valid messenger object then get out.
-        if (! $messenger instanceof EE_Messenger) {
-            EE_Error::add_error(
-                esc_html__('The messenger being deactivated is not a valid messenger', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-
-            return false;
-        }
-
-        if ($message_type instanceof EE_message_type) {
-            $message_type_name = $message_type->name;
-            EE_Error::add_success(
-                sprintf(
-                    esc_html__(
-                        '%s message type has been successfully deactivated for the %s messenger.',
-                        'event_espresso'
-                    ),
-                    ucwords($message_type->label['singular']),
-                    ucwords($messenger->label['singular'])
-                )
-            );
-        } else {
-            $message_type_name = '';
-            EE_Error::add_success(
-                sprintf(
-                    esc_html__('%s messenger has been successfully deactivated.', 'event_espresso'),
-                    ucwords($messenger->label['singular'])
-                )
-            );
-        }
-
-        // if messenger was html or message type was invoice then let's make sure we deactivate invoice payment method.
-        if ($messenger->name === 'html' || $message_type_name === 'invoice') {
-            EE_Registry::instance()->load_lib('Payment_Method_Manager');
-            $count_updated = EE_Payment_Method_Manager::instance()->deactivate_payment_method('invoice');
-            if ($count_updated > 0) {
-                $msg = $message_type_name === 'invoice'
-                    ? esc_html__(
-                        'Deactivating the invoice message type also automatically deactivates the invoice payment method. In order for invoices to be generated the invoice message type must be active. If you completed this action by mistake, simply reactivate the invoice message type and then visit the payment methods admin page to reactivate the invoice payment method.',
-                        'event_espresso'
-                    )
-                    : esc_html__(
-                        'Deactivating the html messenger also automatically deactivates the invoice payment method.  In order for invoices to be generated the html messenger must be be active.  If you completed this action by mistake, simply reactivate the html messenger, then visit the payment methods admin page to reactivate the invoice payment method.',
-                        'event_espresso'
-                    );
-                EE_Error::add_attention($msg);
-            }
-        }
-
-        return true;
-    }
-
-
-    /**
-     * handles updating a message type form on messenger activation IF the message type has settings fields. (via ajax)
-     *
-     * @throws DomainException
-     */
-    public function update_mt_form()
-    {
-        if (! isset($this->_req_data['messenger']) || ! isset($this->_req_data['message_type'])) {
-            EE_Error::add_error(
-                esc_html__('Require message type or messenger to send an updated form', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $this->_return_json();
-        }
-
-        $message_types = $this->get_installed_message_types();
-
-        $message_type = $message_types[ $this->_req_data['message_type'] ];
-        $messenger = $this->_message_resource_manager->get_active_messenger($this->_req_data['messenger']);
-
-        $content = $this->_message_type_settings_content(
-            $message_type,
-            $messenger,
-            true
-        );
-        $this->_template_args['success'] = true;
-        $this->_template_args['content'] = $content;
-        $this->_return_json();
-    }
-
-
-    /**
-     * this handles saving the settings for a messenger or message type
-     *
-     */
-    public function save_settings()
-    {
-        if (! isset($this->_req_data['type'])) {
-            EE_Error::add_error(
-                esc_html__(
-                    'Cannot save settings because type is unknown (messenger settings or messsage type settings?)',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $this->_template_args['error'] = true;
-            $this->_return_json();
-        }
-
-
-        if ($this->_req_data['type'] === 'messenger') {
-            // this should be an array.
-            $settings = $this->_req_data['messenger_settings'];
-            $messenger = $settings['messenger'];
-            // let's setup the settings data
-            foreach ($settings as $key => $value) {
-                switch ($key) {
-                    case 'messenger':
-                        unset($settings['messenger']);
-                        break;
-                    case 'message_types':
-                        unset($settings['message_types']);
-                        break;
-                    default:
-                        $settings[ $key ] = $value;
-                        break;
-                }
-            }
-            $this->_message_resource_manager->add_settings_for_messenger($messenger, $settings);
-        } elseif ($this->_req_data['type'] === 'message_type') {
-            $settings = $this->_req_data['message_type_settings'];
-            $messenger = $settings['messenger'];
-            $message_type = $settings['message_type'];
-
-            foreach ($settings as $key => $value) {
-                switch ($key) {
-                    case 'messenger':
-                        unset($settings['messenger']);
-                        break;
-                    case 'message_type':
-                        unset($settings['message_type']);
-                        break;
-                    default:
-                        $settings[ $key ] = $value;
-                        break;
-                }
-            }
-
-            $this->_message_resource_manager->add_settings_for_message_type($messenger, $message_type, $settings);
-        }
-
-        // okay we should have the data all setup.  Now we just update!
-        $success = $this->_message_resource_manager->update_active_messengers_option();
-
-        if ($success) {
-            EE_Error::add_success(__('Settings updated', 'event_espresso'));
-        } else {
-            EE_Error::add_error(
-                esc_html__(
-                    'Settings did not get updated',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-
-        $this->_template_args['success'] = $success;
-        $this->_return_json();
-    }
-
-
-
-
-    /**  EE MESSAGE PROCESSING ACTIONS **/
-
-
-    /**
-     * This immediately generates any EE_Message ID's that are selected that are EEM_Message::status_incomplete
-     * However, this does not send immediately, it just queues for sending.
-     *
-     * @since 4.9.0
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     */
-    protected function _generate_now()
-    {
-        EED_Messages::generate_now($this->_get_msg_ids_from_request());
-        $this->_redirect_after_action(false, '', '', array(), true);
-    }
-
-
-    /**
-     * This immediately generates AND sends any EE_Message's selected that are EEM_Message::status_incomplete or that
-     * are EEM_Message::status_resend or EEM_Message::status_idle
-     *
-     * @since 4.9.0
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     */
-    protected function _generate_and_send_now()
-    {
-        EED_Messages::generate_and_send_now($this->_get_msg_ids_from_request());
-        $this->_redirect_after_action(false, '', '', array(), true);
-    }
-
-
-    /**
-     * This queues any EEM_Message::status_sent EE_Message ids in the request for resending.
-     *
-     * @since 4.9.0
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     */
-    protected function _queue_for_resending()
-    {
-        EED_Messages::queue_for_resending($this->_get_msg_ids_from_request());
-        $this->_redirect_after_action(false, '', '', array(), true);
-    }
-
-
-    /**
-     *  This sends immediately any EEM_Message::status_idle or EEM_Message::status_resend messages in the queue
-     *
-     * @since 4.9.0
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     */
-    protected function _send_now()
-    {
-        EED_Messages::send_now($this->_get_msg_ids_from_request());
-        $this->_redirect_after_action(false, '', '', array(), true);
-    }
-
-
-    /**
-     * Deletes EE_messages for IDs in the request.
-     *
-     * @since 4.9.0
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    protected function _delete_ee_messages()
-    {
-        $msg_ids = $this->_get_msg_ids_from_request();
-        $deleted_count = 0;
-        foreach ($msg_ids as $msg_id) {
-            if (EEM_Message::instance()->delete_by_ID($msg_id)) {
-                $deleted_count++;
-            }
-        }
-        if ($deleted_count) {
-            EE_Error::add_success(
-                esc_html(
-                    _n(
-                        'Message successfully deleted',
-                        'Messages successfully deleted',
-                        $deleted_count,
-                        'event_espresso'
-                    )
-                )
-            );
-            $this->_redirect_after_action(
-                false,
-                '',
-                '',
-                array(),
-                true
-            );
-        } else {
-            EE_Error::add_error(
-                _n('The message was not deleted.', 'The messages were not deleted', count($msg_ids), 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $this->_redirect_after_action(false, '', '', array(), true);
-        }
-    }
-
-
-    /**
-     *  This looks for 'MSG_ID' key in the request and returns an array of MSG_ID's if present.
-     *
-     * @since 4.9.0
-     * @return array
-     */
-    protected function _get_msg_ids_from_request()
-    {
-        if (! isset($this->_req_data['MSG_ID'])) {
-            return array();
-        }
-
-        return is_array($this->_req_data['MSG_ID'])
-            ? array_keys($this->_req_data['MSG_ID'])
-            : array($this->_req_data['MSG_ID']);
-    }
+		$output = ob_get_contents();
+		ob_clean();
+		$this->_context_switcher = $output;
+	}
+
+
+	/**
+	 * utility for sanitizing new values coming in.
+	 * Note: this is only used when updating a context.
+	 *
+	 * @access protected
+	 *
+	 * @param int $index This helps us know which template field to select from the request array.
+	 *
+	 * @return array
+	 */
+	protected function _set_message_template_column_values($index)
+	{
+		if (is_array($this->_req_data['MTP_template_fields'][ $index ]['content'])) {
+			foreach ($this->_req_data['MTP_template_fields'][ $index ]['content'] as $field => $value) {
+				$this->_req_data['MTP_template_fields'][ $index ]['content'][ $field ] = $value;
+			}
+		}
+
+
+		$set_column_values = array(
+			'MTP_ID'             => absint($this->_req_data['MTP_template_fields'][ $index ]['MTP_ID']),
+			'GRP_ID'             => absint($this->_req_data['GRP_ID']),
+			'MTP_user_id'        => absint($this->_req_data['MTP_user_id']),
+			'MTP_messenger'      => strtolower($this->_req_data['MTP_messenger']),
+			'MTP_message_type'   => strtolower($this->_req_data['MTP_message_type']),
+			'MTP_template_field' => strtolower($this->_req_data['MTP_template_fields'][ $index ]['name']),
+			'MTP_context'        => strtolower($this->_req_data['MTP_context']),
+			'MTP_content'        => $this->_req_data['MTP_template_fields'][ $index ]['content'],
+			'MTP_is_global'      => isset($this->_req_data['MTP_is_global'])
+				? absint($this->_req_data['MTP_is_global'])
+				: 0,
+			'MTP_is_override'    => isset($this->_req_data['MTP_is_override'])
+				? absint($this->_req_data['MTP_is_override'])
+				: 0,
+			'MTP_deleted'        => absint($this->_req_data['MTP_deleted']),
+			'MTP_is_active'      => absint($this->_req_data['MTP_is_active']),
+		);
+
+
+		return $set_column_values;
+	}
+
+
+	protected function _insert_or_update_message_template($new = false)
+	{
+		$success = 0;
+		$override = false;
+
+		// setup notices description
+		$messenger_slug = ! empty($this->_req_data['MTP_messenger']) ? $this->_req_data['MTP_messenger'] : '';
+
+		// need the message type and messenger objects to be able to use the labels for the notices
+		$messenger_object = $this->_message_resource_manager->get_messenger($messenger_slug);
+		$messenger_label = $messenger_object instanceof EE_messenger
+			? ucwords($messenger_object->label['singular'])
+			: '';
+
+		$message_type_slug = ! empty($this->_req_data['MTP_message_type'])
+			? $this->_req_data['MTP_message_type']
+			: '';
+		$message_type_object = $this->_message_resource_manager->get_message_type($message_type_slug);
+
+		$message_type_label = $message_type_object instanceof EE_message_type
+			? ucwords($message_type_object->label['singular'])
+			: '';
+
+		$context_slug = ! empty($this->_req_data['MTP_context'])
+			? $this->_req_data['MTP_context']
+			: '';
+		$context = ucwords(str_replace('_', ' ', $context_slug));
+
+		$item_desc = $messenger_label && $message_type_label
+			? $messenger_label . ' ' . $message_type_label . ' ' . $context . ' '
+			: '';
+		$item_desc .= 'Message Template';
+		$query_args = array();
+		$edit_array = array();
+		$action_desc = '';
+
+		// if this is "new" then we need to generate the default contexts for the selected messenger/message_type for
+		// user to edit.
+		if ($new) {
+			$GRP_ID = ! empty($this->_req_data['GRP_ID']) ? $this->_req_data['GRP_ID'] : 0;
+			if ($edit_array = $this->_generate_new_templates($messenger_slug, $message_type_slug, $GRP_ID)) {
+				if (empty($edit_array)) {
+					$success = 0;
+				} else {
+					$success = 1;
+					$edit_array = $edit_array[0];
+					$query_args = array(
+						'id'      => $edit_array['GRP_ID'],
+						'context' => $edit_array['MTP_context'],
+						'action'  => 'edit_message_template',
+					);
+				}
+			}
+			$action_desc = 'created';
+		} else {
+			$MTPG = EEM_Message_Template_Group::instance();
+			$MTP = EEM_Message_Template::instance();
+
+
+			// run update for each template field in displayed context
+			if (! isset($this->_req_data['MTP_template_fields']) && empty($this->_req_data['MTP_template_fields'])) {
+				EE_Error::add_error(
+					esc_html__(
+						'There was a problem saving the template fields from the form because I didn\'t receive any actual template field data.',
+						'event_espresso'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+				$success = 0;
+			} else {
+				// first validate all fields!
+				// this filter allows client code to add its own validation to the template fields as well.
+				// returning an empty array means everything passed validation.
+				// errors in validation should be represented in an array with the following shape:
+				// array(
+				//   'fieldname' => array(
+				//          'msg' => 'error message'
+				//          'value' => 'value for field producing error'
+				// )
+				$custom_validation = (array) apply_filters(
+					'FHEE__Messages_Admin_Page___insert_or_update_message_template__validates',
+					array(),
+					$this->_req_data['MTP_template_fields'],
+					$context_slug,
+					$messenger_slug,
+					$message_type_slug
+				);
+
+				$system_validation = $MTPG->validate(
+					$this->_req_data['MTP_template_fields'],
+					$context_slug,
+					$messenger_slug,
+					$message_type_slug
+				);
+
+				$system_validation = ! is_array($system_validation) && $system_validation ? array()
+					: $system_validation;
+				$validates = array_merge($custom_validation, $system_validation);
+
+				// if $validate returned error messages (i.e. is_array()) then we need to process them and setup an
+				// appropriate response. HMM, dang this isn't correct, $validates will ALWAYS be an array.
+				//  WE need to make sure there is no actual error messages in validates.
+				if (is_array($validates) && ! empty($validates)) {
+					// add the transient so when the form loads we know which fields to highlight
+					$this->_add_transient('edit_message_template', $validates);
+
+					$success = 0;
+
+					// setup notices
+					foreach ($validates as $field => $error) {
+						if (isset($error['msg'])) {
+							EE_Error::add_error($error['msg'], __FILE__, __FUNCTION__, __LINE__);
+						}
+					}
+				} else {
+					$set_column_values = array();
+					foreach ($this->_req_data['MTP_template_fields'] as $template_field => $content) {
+						$set_column_values = $this->_set_message_template_column_values($template_field);
+
+						$where_cols_n_values = array(
+							'MTP_ID' => $this->_req_data['MTP_template_fields'][ $template_field ]['MTP_ID'],
+						);
+						// if they aren't allowed to use all JS, restrict them to just posty-y tags
+						if (! current_user_can('unfiltered_html')) {
+							if (is_array($set_column_values['MTP_content'])) {
+								foreach ($set_column_values['MTP_content'] as $key => $value) {
+									// remove slashes so wp_kses works properly (its wp_kses_stripslashes() function
+									// only removes slashes from double-quotes, so attributes using single quotes always
+									// appear invalid.) But currently the models expect slashed data, so after wp_kses
+									// runs we need to re-slash the data. Sheesh. See
+									// https://events.codebasehq.com/projects/event-espresso/tickets/11211#update-47321587
+									$set_column_values['MTP_content'][ $key ] = addslashes(
+										wp_kses(
+											stripslashes($value),
+											wp_kses_allowed_html('post')
+										)
+									);
+								}
+							} else {
+								$set_column_values['MTP_content'] = wp_kses(
+									$set_column_values['MTP_content'],
+									wp_kses_allowed_html('post')
+								);
+							}
+						}
+						$message_template_fields = array(
+							'GRP_ID'             => $set_column_values['GRP_ID'],
+							'MTP_template_field' => $set_column_values['MTP_template_field'],
+							'MTP_context'        => $set_column_values['MTP_context'],
+							'MTP_content'        => $set_column_values['MTP_content'],
+						);
+						if ($updated = $MTP->update($message_template_fields, array($where_cols_n_values))) {
+							if ($updated === false) {
+								EE_Error::add_error(
+									sprintf(
+										esc_html__('%s field was NOT updated for some reason', 'event_espresso'),
+										$template_field
+									),
+									__FILE__,
+									__FUNCTION__,
+									__LINE__
+								);
+							} else {
+								$success = 1;
+							}
+						} else {
+							// only do this logic if we don't have a MTP_ID for this field
+							if (empty($this->_req_data['MTP_template_fields'][ $template_field ]['MTP_ID'])) {
+								// this has already been through the template field validator and sanitized, so it will be
+								// safe to insert this field.  Why insert?  This typically happens when we introduce a new
+								// message template field in a messenger/message type and existing users don't have the
+								// default setup for it.
+								// @link https://events.codebasehq.com/projects/event-espresso/tickets/9465
+								$updated = $MTP->insert($message_template_fields);
+								if (! $updated || is_wp_error($updated)) {
+									EE_Error::add_error(
+										sprintf(
+											esc_html__('%s field could not be updated.', 'event_espresso'),
+											$template_field
+										),
+										__FILE__,
+										__FUNCTION__,
+										__LINE__
+									);
+									$success = 0;
+								} else {
+									$success = 1;
+								}
+							}
+						}
+						$action_desc = 'updated';
+					}
+
+					// we can use the last set_column_values for the MTPG update (because its the same for all of these specific MTPs)
+					$mtpg_fields = array(
+						'MTP_user_id'      => $set_column_values['MTP_user_id'],
+						'MTP_messenger'    => $set_column_values['MTP_messenger'],
+						'MTP_message_type' => $set_column_values['MTP_message_type'],
+						'MTP_is_global'    => $set_column_values['MTP_is_global'],
+						'MTP_is_override'  => $set_column_values['MTP_is_override'],
+						'MTP_deleted'      => $set_column_values['MTP_deleted'],
+						'MTP_is_active'    => $set_column_values['MTP_is_active'],
+						'MTP_name'         => ! empty($this->_req_data['ee_msg_non_global_fields']['MTP_name'])
+							? $this->_req_data['ee_msg_non_global_fields']['MTP_name']
+							: '',
+						'MTP_description'  => ! empty($this->_req_data['ee_msg_non_global_fields']['MTP_description'])
+							? $this->_req_data['ee_msg_non_global_fields']['MTP_description']
+							: '',
+					);
+
+					$mtpg_where = array('GRP_ID' => $set_column_values['GRP_ID']);
+					$updated = $MTPG->update($mtpg_fields, array($mtpg_where));
+
+					if ($updated === false) {
+						EE_Error::add_error(
+							sprintf(
+								esc_html__(
+									'The Message Template Group (%d) was NOT updated for some reason',
+									'event_espresso'
+								),
+								$set_column_values['GRP_ID']
+							),
+							__FILE__,
+							__FUNCTION__,
+							__LINE__
+						);
+					} else {
+						// k now we need to ensure the template_pack and template_variation fields are set.
+						$template_pack = ! empty($this->_req_data['MTP_template_pack'])
+							? $this->_req_data['MTP_template_pack']
+							: 'default';
+
+						$template_variation = ! empty($this->_req_data['MTP_template_variation'])
+							? $this->_req_data['MTP_template_variation']
+							: 'default';
+
+						$mtpg_obj = $MTPG->get_one_by_ID($set_column_values['GRP_ID']);
+						if ($mtpg_obj instanceof EE_Message_Template_Group) {
+							$mtpg_obj->set_template_pack_name($template_pack);
+							$mtpg_obj->set_template_pack_variation($template_variation);
+						}
+						$success = 1;
+					}
+				}
+			}
+		}
+
+		// we return things differently if doing ajax
+		if (defined('DOING_AJAX') && DOING_AJAX) {
+			$this->_template_args['success'] = $success;
+			$this->_template_args['error'] = ! $success ? true : false;
+			$this->_template_args['content'] = '';
+			$this->_template_args['data'] = array(
+				'grpID'        => $edit_array['GRP_ID'],
+				'templateName' => $edit_array['template_name'],
+			);
+			if ($success) {
+				EE_Error::overwrite_success();
+				EE_Error::add_success(
+					esc_html__(
+						'The new template has been created and automatically selected for this event.  You can edit the new template by clicking the edit button.  Note before this template is assigned to this event, the event must be saved.',
+						'event_espresso'
+					)
+				);
+			}
+
+			$this->_return_json();
+		}
+
+
+		// was a test send triggered?
+		if (isset($this->_req_data['test_button'])) {
+			EE_Error::overwrite_success();
+			$this->_do_test_send($context_slug, $messenger_slug, $message_type_slug);
+			$override = true;
+		}
+
+		if (empty($query_args)) {
+			$query_args = array(
+				'id'      => $this->_req_data['GRP_ID'],
+				'context' => $context_slug,
+				'action'  => 'edit_message_template',
+			);
+		}
+
+		$this->_redirect_after_action($success, $item_desc, $action_desc, $query_args, $override);
+	}
+
+
+	/**
+	 * processes a test send request to do an actual messenger delivery test for the given message template being tested
+	 *
+	 * @param  string $context      what context being tested
+	 * @param  string $messenger    messenger being tested
+	 * @param  string $message_type message type being tested
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _do_test_send($context, $messenger, $message_type)
+	{
+		// set things up for preview
+		$this->_req_data['messenger'] = $messenger;
+		$this->_req_data['message_type'] = $message_type;
+		$this->_req_data['context'] = $context;
+		$this->_req_data['GRP_ID'] = isset($this->_req_data['GRP_ID']) ? $this->_req_data['GRP_ID'] : '';
+		$active_messenger = $this->_message_resource_manager->get_active_messenger($messenger);
+
+		// let's save any existing fields that might be required by the messenger
+		if (
+			isset($this->_req_data['test_settings_fld'])
+			&& $active_messenger instanceof EE_messenger
+			&& apply_filters(
+				'FHEE__Messages_Admin_Page__do_test_send__set_existing_test_settings',
+				true,
+				$this->_req_data['test_settings_fld'],
+				$active_messenger
+			)
+		) {
+			$active_messenger->set_existing_test_settings($this->_req_data['test_settings_fld']);
+		}
+
+		/**
+		 * Use filter to add additional controls on whether message can send or not
+		 */
+		if (
+			apply_filters(
+				'FHEE__Messages_Admin_Page__do_test_send__can_send',
+				true,
+				$context,
+				$this->_req_data,
+				$messenger,
+				$message_type
+			)
+		) {
+			if (EEM_Event::instance()->count() > 0) {
+				$success = $this->_preview_message(true);
+				if ($success) {
+					EE_Error::add_success(__('Test message sent', 'event_espresso'));
+				} else {
+					EE_Error::add_error(
+						esc_html__('The test message was not sent', 'event_espresso'),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+				}
+			} else {
+				$this->noEventsErrorMessage(true);
+			}
+		}
+	}
+
+
+	/**
+	 * _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.
+	 *
+	 *
+	 * @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 this is a custom template being generated then a GRP_ID needs to be included to
+	 *                               indicate the message_template_group being used as the base.
+	 *
+	 * @param bool    $global
+	 *
+	 * @return array|bool array of data required for the redirect to the correct edit page or bool if
+	 *                               encountering problems.
+	 * @throws EE_Error
+	 */
+	protected function _generate_new_templates($messenger, $message_types, $GRP_ID = 0, $global = false)
+	{
+
+		// if no $message_types are given then that's okay... this may be a messenger that just adds shortcodes, so we
+		// just don't generate any templates.
+		if (empty($message_types)) {
+			return true;
+		}
+
+		return EEH_MSG_Template::generate_new_templates($messenger, $message_types, $GRP_ID, $global);
+	}
+
+
+	/**
+	 * [_trash_or_restore_message_template]
+	 *
+	 * @param  boolean $trash whether to move an item to trash/restore (TRUE) or restore it (FALSE)
+	 * @param boolean  $all   whether this is going to trash/restore all contexts within a template group (TRUE) OR just
+	 *                        an individual context (FALSE).
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _trash_or_restore_message_template($trash = true, $all = false)
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$MTP = EEM_Message_Template_Group::instance();
+
+		$success = 1;
+
+		// incoming GRP_IDs
+		if ($all) {
+			// Checkboxes
+			if (! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
+				// if array has more than one element then success message should be plural.
+				// todo: what about nonce?
+				$success = count($this->_req_data['checkbox']) > 1 ? 2 : 1;
+
+				// cycle through checkboxes
+				while (list($GRP_ID, $value) = each($this->_req_data['checkbox'])) {
+					$trashed_or_restored = $trash ? $MTP->delete_by_ID($GRP_ID) : $MTP->restore_by_ID($GRP_ID);
+					if (! $trashed_or_restored) {
+						$success = 0;
+					}
+				}
+			} else {
+				// grab single GRP_ID and handle
+				$GRP_ID = isset($this->_req_data['id']) ? absint($this->_req_data['id']) : 0;
+				if (! empty($GRP_ID)) {
+					$trashed_or_restored = $trash ? $MTP->delete_by_ID($GRP_ID) : $MTP->restore_by_ID($GRP_ID);
+					if (! $trashed_or_restored) {
+						$success = 0;
+					}
+				} else {
+					$success = 0;
+				}
+			}
+		}
+
+		$action_desc = $trash
+			? esc_html__('moved to the trash', 'event_espresso')
+			: esc_html__('restored', 'event_espresso');
+
+		$action_desc = ! empty($this->_req_data['template_switch']) ? esc_html__('switched', 'event_espresso') : $action_desc;
+
+		$item_desc = $all ? _n(
+			'Message Template Group',
+			'Message Template Groups',
+			$success,
+			'event_espresso'
+		) : _n('Message Template Context', 'Message Template Contexts', $success, 'event_espresso');
+
+		$item_desc = ! empty($this->_req_data['template_switch']) ? _n(
+			'template',
+			'templates',
+			$success,
+			'event_espresso'
+		) : $item_desc;
+
+		$this->_redirect_after_action($success, $item_desc, $action_desc, array());
+	}
+
+
+	/**
+	 * [_delete_message_template]
+	 * NOTE: this handles not only the deletion of the groups but also all the templates belonging to that group.
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _delete_message_template()
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+
+		// checkboxes
+		if (! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
+			// if array has more than one element then success message should be plural
+			$success = count($this->_req_data['checkbox']) > 1 ? 2 : 1;
+
+			// cycle through bulk action checkboxes
+			while (list($GRP_ID, $value) = each($this->_req_data['checkbox'])) {
+				$success = $this->_delete_mtp_permanently($GRP_ID);
+			}
+		} else {
+			// grab single grp_id and delete
+			$GRP_ID = absint($this->_req_data['id']);
+			$success = $this->_delete_mtp_permanently($GRP_ID);
+		}
+
+		$this->_redirect_after_action($success, 'Message Templates', 'deleted', array());
+	}
+
+
+	/**
+	 * helper for permanently deleting a mtP group and all related message_templates
+	 *
+	 * @param  int  $GRP_ID        The group being deleted
+	 * @param  bool $include_group whether to delete the Message Template Group as well.
+	 * @return bool boolean to indicate the success of the deletes or not.
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _delete_mtp_permanently($GRP_ID, $include_group = true)
+	{
+		$success = 1;
+		$MTPG = EEM_Message_Template_Group::instance();
+		// first let's GET this group
+		$MTG = $MTPG->get_one_by_ID($GRP_ID);
+		// then delete permanently all the related Message Templates
+		$deleted = $MTG->delete_related_permanently('Message_Template');
+
+		if ($deleted === 0) {
+			$success = 0;
+		}
+
+		// now delete permanently this particular group
+
+		if ($include_group && ! $MTG->delete_permanently()) {
+			$success = 0;
+		}
+
+		return $success;
+	}
+
+
+	/**
+	 *    _learn_more_about_message_templates_link
+	 *
+	 * @access protected
+	 * @return string
+	 */
+	protected function _learn_more_about_message_templates_link()
+	{
+		return '<a class="hidden" style="margin:0 20px; cursor:pointer; font-size:12px;" >'
+			   . esc_html__('learn more about how message templates works', 'event_espresso')
+			   . '</a>';
+	}
+
+
+	/**
+	 * Used for setting up messenger/message type activation.  This loads up the initial view.  The rest is handled by
+	 * ajax and other routes.
+	 *
+	 * @return void
+	 * @throws DomainException
+	 */
+	protected function _settings()
+	{
+
+
+		$this->_set_m_mt_settings();
+
+		$selected_messenger = isset($this->_req_data['selected_messenger'])
+			? $this->_req_data['selected_messenger']
+			: 'email';
+
+		// let's setup the messenger tabs
+		$this->_template_args['admin_page_header'] = EEH_Tabbed_Content::tab_text_links(
+			$this->_m_mt_settings['messenger_tabs'],
+			'messenger_links',
+			'|',
+			$selected_messenger
+		);
+		$this->_template_args['before_admin_page_content'] = '<div class="ui-widget ui-helper-clearfix">';
+		$this->_template_args['after_admin_page_content'] = '</div><!-- end .ui-widget -->';
+
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	/**
+	 * This sets the $_m_mt_settings property for when needed (used on the Messages settings page)
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws DomainException
+	 */
+	protected function _set_m_mt_settings()
+	{
+		// first if this is already set then lets get out no need to regenerate data.
+		if (! empty($this->_m_mt_settings)) {
+			return;
+		}
+
+		// get all installed messengers and message_types
+		/** @type EE_messenger[] $messengers */
+		$messengers = $this->_message_resource_manager->installed_messengers();
+		/** @type EE_message_type[] $message_types */
+		$message_types = $this->_message_resource_manager->installed_message_types();
+
+
+		// assemble the array for the _tab_text_links helper
+
+		foreach ($messengers as $messenger) {
+			$this->_m_mt_settings['messenger_tabs'][ $messenger->name ] = array(
+				'label' => ucwords($messenger->label['singular']),
+				'class' => $this->_message_resource_manager->is_messenger_active($messenger->name)
+					? 'messenger-active'
+					: '',
+				'href'  => $messenger->name,
+				'title' => esc_html__('Modify this Messenger', 'event_espresso'),
+				'slug'  => $messenger->name,
+				'obj'   => $messenger,
+			);
+
+
+			$message_types_for_messenger = $messenger->get_valid_message_types();
+
+			foreach ($message_types as $message_type) {
+				// first we need to verify that this message type is valid with this messenger. Cause if it isn't then
+				// it shouldn't show in either the inactive OR active metabox.
+				if (! in_array($message_type->name, $message_types_for_messenger, true)) {
+					continue;
+				}
+
+				$a_or_i = $this->_message_resource_manager->is_message_type_active_for_messenger(
+					$messenger->name,
+					$message_type->name
+				)
+					? 'active'
+					: 'inactive';
+
+				$this->_m_mt_settings['message_type_tabs'][ $messenger->name ][ $a_or_i ][ $message_type->name ] = array(
+					'label'    => ucwords($message_type->label['singular']),
+					'class'    => 'message-type-' . $a_or_i,
+					'slug_id'  => $message_type->name . '-messagetype-' . $messenger->name,
+					'mt_nonce' => wp_create_nonce($message_type->name . '_nonce'),
+					'href'     => 'espresso_' . $message_type->name . '_message_type_settings',
+					'title'    => $a_or_i === 'active'
+						? esc_html__('Drag this message type to the Inactive window to deactivate', 'event_espresso')
+						: esc_html__('Drag this message type to the messenger to activate', 'event_espresso'),
+					'content'  => $a_or_i === 'active'
+						? $this->_message_type_settings_content($message_type, $messenger, true)
+						: $this->_message_type_settings_content($message_type, $messenger),
+					'slug'     => $message_type->name,
+					'active'   => $a_or_i === 'active',
+					'obj'      => $message_type,
+				);
+			}
+		}
+	}
+
+
+	/**
+	 * This just prepares the content for the message type settings
+	 *
+	 * @param  EE_message_type $message_type The message type object
+	 * @param  EE_messenger    $messenger    The messenger object
+	 * @param  boolean         $active       Whether the message type is active or not
+	 * @return string html output for the content
+	 * @throws DomainException
+	 */
+	protected function _message_type_settings_content($message_type, $messenger, $active = false)
+	{
+		// get message type fields
+		$fields = $message_type->get_admin_settings_fields();
+		$settings_template_args['template_form_fields'] = '';
+
+		if (! empty($fields) && $active) {
+			$existing_settings = $message_type->get_existing_admin_settings($messenger->name);
+			foreach ($fields as $fldname => $fldprops) {
+				$field_id = $messenger->name . '-' . $message_type->name . '-' . $fldname;
+				$template_form_field[ $field_id ] = array(
+					'name'       => 'message_type_settings[' . $fldname . ']',
+					'label'      => $fldprops['label'],
+					'input'      => $fldprops['field_type'],
+					'type'       => $fldprops['value_type'],
+					'required'   => $fldprops['required'],
+					'validation' => $fldprops['validation'],
+					'value'      => isset($existing_settings[ $fldname ])
+						? $existing_settings[ $fldname ]
+						: $fldprops['default'],
+					'options'    => isset($fldprops['options'])
+						? $fldprops['options']
+						: array(),
+					'default'    => isset($existing_settings[ $fldname ])
+						? $existing_settings[ $fldname ]
+						: $fldprops['default'],
+					'css_class'  => 'no-drag',
+					'format'     => $fldprops['format'],
+				);
+			}
+
+
+			$settings_template_args['template_form_fields'] = ! empty($template_form_field)
+				? $this->_generate_admin_form_fields(
+					$template_form_field,
+					'string',
+					'ee_mt_activate_form'
+				)
+				: '';
+		}
+
+		$settings_template_args['description'] = $message_type->description;
+		// we also need some hidden fields
+		$settings_template_args['hidden_fields'] = array(
+			'message_type_settings[messenger]'    => array(
+				'type'  => 'hidden',
+				'value' => $messenger->name,
+			),
+			'message_type_settings[message_type]' => array(
+				'type'  => 'hidden',
+				'value' => $message_type->name,
+			),
+			'type'                                => array(
+				'type'  => 'hidden',
+				'value' => 'message_type',
+			),
+		);
+
+		$settings_template_args['hidden_fields'] = $this->_generate_admin_form_fields(
+			$settings_template_args['hidden_fields'],
+			'array'
+		);
+		$settings_template_args['show_form'] = empty($settings_template_args['template_form_fields'])
+			? ' hidden'
+			: '';
+
+
+		$template = EE_MSG_TEMPLATE_PATH . 'ee_msg_mt_settings_content.template.php';
+		$content = EEH_Template::display_template($template, $settings_template_args, true);
+
+		return $content;
+	}
+
+
+	/**
+	 * Generate all the metaboxes for the message types and register them for the messages settings page.
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws DomainException
+	 */
+	protected function _messages_settings_metaboxes()
+	{
+		$this->_set_m_mt_settings();
+		$m_boxes = $mt_boxes = array();
+		$m_template_args = $mt_template_args = array();
+
+		$selected_messenger = isset($this->_req_data['selected_messenger'])
+			? $this->_req_data['selected_messenger']
+			: 'email';
+
+		if (isset($this->_m_mt_settings['messenger_tabs'])) {
+			foreach ($this->_m_mt_settings['messenger_tabs'] as $messenger => $tab_array) {
+				$hide_on_message = $this->_message_resource_manager->is_messenger_active($messenger) ? '' : 'hidden';
+				$hide_off_message = $this->_message_resource_manager->is_messenger_active($messenger) ? 'hidden' : '';
+				// messenger meta boxes
+				$active = $selected_messenger === $messenger;
+				$active_mt_tabs = isset(
+					$this->_m_mt_settings['message_type_tabs'][ $messenger ]['active']
+				)
+					? $this->_m_mt_settings['message_type_tabs'][ $messenger ]['active']
+					: '';
+				$m_boxes[ $messenger . '_a_box' ] = sprintf(
+					esc_html__('%s Settings', 'event_espresso'),
+					$tab_array['label']
+				);
+				$m_template_args[ $messenger . '_a_box' ] = array(
+					'active_message_types'   => ! empty($active_mt_tabs) ? $this->_get_mt_tabs($active_mt_tabs) : '',
+					'inactive_message_types' => isset(
+						$this->_m_mt_settings['message_type_tabs'][ $messenger ]['inactive']
+					)
+						? $this->_get_mt_tabs($this->_m_mt_settings['message_type_tabs'][ $messenger ]['inactive'])
+						: '',
+					'content'                => $this->_get_messenger_box_content($tab_array['obj']),
+					'hidden'                 => $active ? '' : ' hidden',
+					'hide_on_message'        => $hide_on_message,
+					'messenger'              => $messenger,
+					'active'                 => $active,
+				);
+				// message type meta boxes
+				// (which is really just the inactive container for each messenger
+				// showing inactive message types for that messenger)
+				$mt_boxes[ $messenger . '_i_box' ] = esc_html__('Inactive Message Types', 'event_espresso');
+				$mt_template_args[ $messenger . '_i_box' ] = array(
+					'active_message_types'   => ! empty($active_mt_tabs) ? $this->_get_mt_tabs($active_mt_tabs) : '',
+					'inactive_message_types' => isset(
+						$this->_m_mt_settings['message_type_tabs'][ $messenger ]['inactive']
+					)
+						? $this->_get_mt_tabs($this->_m_mt_settings['message_type_tabs'][ $messenger ]['inactive'])
+						: '',
+					'hidden'                 => $active ? '' : ' hidden',
+					'hide_on_message'        => $hide_on_message,
+					'hide_off_message'       => $hide_off_message,
+					'messenger'              => $messenger,
+					'active'                 => $active,
+				);
+			}
+		}
+
+
+		// register messenger metaboxes
+		$m_template_path = EE_MSG_TEMPLATE_PATH . 'ee_msg_details_messenger_mt_meta_box.template.php';
+		foreach ($m_boxes as $box => $label) {
+			$callback_args = array('template_path' => $m_template_path, 'template_args' => $m_template_args[ $box ]);
+			$msgr = str_replace('_a_box', '', $box);
+			add_meta_box(
+				'espresso_' . $msgr . '_settings',
+				$label,
+				function ($post, $metabox) {
+					echo EEH_Template::display_template(
+						$metabox["args"]["template_path"],
+						$metabox["args"]["template_args"],
+						true
+					);
+				},
+				$this->_current_screen->id,
+				'normal',
+				'high',
+				$callback_args
+			);
+		}
+
+		// register message type metaboxes
+		$mt_template_path = EE_MSG_TEMPLATE_PATH . 'ee_msg_details_messenger_meta_box.template.php';
+		foreach ($mt_boxes as $box => $label) {
+			$callback_args = array(
+				'template_path' => $mt_template_path,
+				'template_args' => $mt_template_args[ $box ],
+			);
+			$mt = str_replace('_i_box', '', $box);
+			add_meta_box(
+				'espresso_' . $mt . '_inactive_mts',
+				$label,
+				function ($post, $metabox) {
+					echo EEH_Template::display_template(
+						$metabox["args"]["template_path"],
+						$metabox["args"]["template_args"],
+						true
+					);
+				},
+				$this->_current_screen->id,
+				'side',
+				'high',
+				$callback_args
+			);
+		}
+
+		// register metabox for global messages settings but only when on the main site.  On single site installs this
+		// will always result in the metabox showing, on multisite installs the metabox will only show on the main site.
+		if (is_main_site()) {
+			add_meta_box(
+				'espresso_global_message_settings',
+				esc_html__('Global Message Settings', 'event_espresso'),
+				array($this, 'global_messages_settings_metabox_content'),
+				$this->_current_screen->id,
+				'normal',
+				'low',
+				array()
+			);
+		}
+	}
+
+
+	/**
+	 *  This generates the content for the global messages settings metabox.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function global_messages_settings_metabox_content()
+	{
+		$form = $this->_generate_global_settings_form();
+		echo $form->form_open(
+			$this->add_query_args_and_nonce(array('action' => 'update_global_settings'), EE_MSG_ADMIN_URL),
+			'POST'
+		)
+			 . $form->get_html()
+			 . $form->form_close();
+	}
+
+
+	/**
+	 * This generates and returns the form object for the global messages settings.
+	 *
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _generate_global_settings_form()
+	{
+		EE_Registry::instance()->load_helper('HTML');
+		/** @var EE_Network_Core_Config $network_config */
+		$network_config = EE_Registry::instance()->NET_CFG->core;
+
+		return new EE_Form_Section_Proper(
+			array(
+				'name'            => 'global_messages_settings',
+				'html_id'         => 'global_messages_settings',
+				'html_class'      => 'form-table',
+				'layout_strategy' => new EE_Admin_Two_Column_Layout(),
+				'subsections'     => apply_filters(
+					'FHEE__Messages_Admin_Page__global_messages_settings_metabox_content__form_subsections',
+					array(
+						'do_messages_on_same_request' => new EE_Select_Input(
+							array(
+								true  => esc_html__("On the same request", "event_espresso"),
+								false => esc_html__("On a separate request", "event_espresso"),
+							),
+							array(
+								'default'         => $network_config->do_messages_on_same_request,
+								'html_label_text' => esc_html__(
+									'Generate and send all messages:',
+									'event_espresso'
+								),
+								'html_help_text'  => esc_html__(
+									'By default the messages system uses a more efficient means of processing messages on separate requests and utilizes the wp-cron scheduling system.  This makes things execute faster for people registering for your events.  However, if the wp-cron system is disabled on your site and there is no alternative in place, then you can change this so messages are always executed on the same request.',
+									'event_espresso'
+								),
+							)
+						),
+						'delete_threshold'            => new EE_Select_Input(
+							array(
+								0  => esc_html__('Forever', 'event_espresso'),
+								3  => esc_html__('3 Months', 'event_espresso'),
+								6  => esc_html__('6 Months', 'event_espresso'),
+								9  => esc_html__('9 Months', 'event_espresso'),
+								12 => esc_html__('12 Months', 'event_espresso'),
+								24 => esc_html__('24 Months', 'event_espresso'),
+								36 => esc_html__('36 Months', 'event_espresso'),
+							),
+							array(
+								'default'         => EE_Registry::instance()->CFG->messages->delete_threshold,
+								'html_label_text' => esc_html__('Cleanup of old messages:', 'event_espresso'),
+								'html_help_text'  => esc_html__(
+									'You can control how long a record of processed messages is kept via this option.',
+									'event_espresso'
+								),
+							)
+						),
+						'update_settings'             => new EE_Submit_Input(
+							array(
+								'default'         => esc_html__('Update', 'event_espresso'),
+								'html_label_text' => '&nbsp',
+							)
+						),
+					)
+				),
+			)
+		);
+	}
+
+
+	/**
+	 * This handles updating the global settings set on the admin page.
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 */
+	protected function _update_global_settings()
+	{
+		/** @var EE_Network_Core_Config $network_config */
+		$network_config = EE_Registry::instance()->NET_CFG->core;
+		$messages_config = EE_Registry::instance()->CFG->messages;
+		$form = $this->_generate_global_settings_form();
+		if ($form->was_submitted()) {
+			$form->receive_form_submission();
+			if ($form->is_valid()) {
+				$valid_data = $form->valid_data();
+				foreach ($valid_data as $property => $value) {
+					$setter = 'set_' . $property;
+					if (method_exists($network_config, $setter)) {
+						$network_config->{$setter}($value);
+					} elseif (
+						property_exists($network_config, $property)
+						&& $network_config->{$property} !== $value
+					) {
+						$network_config->{$property} = $value;
+					} elseif (
+						property_exists($messages_config, $property)
+						&& $messages_config->{$property} !== $value
+					) {
+						$messages_config->{$property} = $value;
+					}
+				}
+				// only update if the form submission was valid!
+				EE_Registry::instance()->NET_CFG->update_config(true, false);
+				EE_Registry::instance()->CFG->update_espresso_config();
+				EE_Error::overwrite_success();
+				EE_Error::add_success(__('Global message settings were updated', 'event_espresso'));
+			}
+		}
+		$this->_redirect_after_action(0, '', '', array('action' => 'settings'), true);
+	}
+
+
+	/**
+	 * this prepares the messenger tabs that can be dragged in and out of messenger boxes to activate/deactivate
+	 *
+	 * @param  array $tab_array This is an array of message type tab details used to generate the tabs
+	 * @return string html formatted tabs
+	 * @throws DomainException
+	 */
+	protected function _get_mt_tabs($tab_array)
+	{
+		$tab_array = (array) $tab_array;
+		$template = EE_MSG_TEMPLATE_PATH . 'ee_msg_details_mt_settings_tab_item.template.php';
+		$tabs = '';
+
+		foreach ($tab_array as $tab) {
+			$tabs .= EEH_Template::display_template($template, $tab, true);
+		}
+
+		return $tabs;
+	}
+
+
+	/**
+	 * This prepares the content of the messenger meta box admin settings
+	 *
+	 * @param  EE_messenger $messenger The messenger we're setting up content for
+	 * @return string html formatted content
+	 * @throws DomainException
+	 */
+	protected function _get_messenger_box_content(EE_messenger $messenger)
+	{
+
+		$fields = $messenger->get_admin_settings_fields();
+		$settings_template_args['template_form_fields'] = '';
+
+		// is $messenger active?
+		$settings_template_args['active'] = $this->_message_resource_manager->is_messenger_active($messenger->name);
+
+
+		if (! empty($fields)) {
+			$existing_settings = $messenger->get_existing_admin_settings();
+
+			foreach ($fields as $fldname => $fldprops) {
+				$field_id = $messenger->name . '-' . $fldname;
+				$template_form_field[ $field_id ] = array(
+					'name'       => 'messenger_settings[' . $field_id . ']',
+					'label'      => $fldprops['label'],
+					'input'      => $fldprops['field_type'],
+					'type'       => $fldprops['value_type'],
+					'required'   => $fldprops['required'],
+					'validation' => $fldprops['validation'],
+					'value'      => isset($existing_settings[ $field_id ])
+						? $existing_settings[ $field_id ]
+						: $fldprops['default'],
+					'css_class'  => '',
+					'format'     => $fldprops['format'],
+				);
+			}
+
+
+			$settings_template_args['template_form_fields'] = ! empty($template_form_field)
+				? $this->_generate_admin_form_fields($template_form_field, 'string', 'ee_m_activate_form')
+				: '';
+		}
+
+		// we also need some hidden fields
+		$settings_template_args['hidden_fields'] = array(
+			'messenger_settings[messenger]' => array(
+				'type'  => 'hidden',
+				'value' => $messenger->name,
+			),
+			'type'                          => array(
+				'type'  => 'hidden',
+				'value' => 'messenger',
+			),
+		);
+
+		// make sure any active message types that are existing are included in the hidden fields
+		if (isset($this->_m_mt_settings['message_type_tabs'][ $messenger->name ]['active'])) {
+			foreach ($this->_m_mt_settings['message_type_tabs'][ $messenger->name ]['active'] as $mt => $values) {
+				$settings_template_args['hidden_fields'][ 'messenger_settings[message_types][' . $mt . ']' ] = array(
+					'type'  => 'hidden',
+					'value' => $mt,
+				);
+			}
+		}
+		$settings_template_args['hidden_fields'] = $this->_generate_admin_form_fields(
+			$settings_template_args['hidden_fields'],
+			'array'
+		);
+		$active = $this->_message_resource_manager->is_messenger_active($messenger->name);
+
+		$settings_template_args['messenger'] = $messenger->name;
+		$settings_template_args['description'] = $messenger->description;
+		$settings_template_args['show_hide_edit_form'] = $active ? '' : ' hidden';
+
+
+		$settings_template_args['show_hide_edit_form'] = $this->_message_resource_manager->is_messenger_active(
+			$messenger->name
+		)
+			? $settings_template_args['show_hide_edit_form']
+			: ' hidden';
+
+		$settings_template_args['show_hide_edit_form'] = empty($settings_template_args['template_form_fields'])
+			? ' hidden'
+			: $settings_template_args['show_hide_edit_form'];
+
+
+		$settings_template_args['on_off_action'] = $active ? 'messenger-off' : 'messenger-on';
+		$settings_template_args['nonce'] = wp_create_nonce('activate_' . $messenger->name . '_toggle_nonce');
+		$settings_template_args['on_off_status'] = $active ? true : false;
+		$template = EE_MSG_TEMPLATE_PATH . 'ee_msg_m_settings_content.template.php';
+		$content = EEH_Template::display_template(
+			$template,
+			$settings_template_args,
+			true
+		);
+
+		return $content;
+	}
+
+
+	/**
+	 * used by ajax on the messages settings page to activate|deactivate the messenger
+	 *
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 */
+	public function activate_messenger_toggle()
+	{
+		$success = true;
+		$this->_prep_default_response_for_messenger_or_message_type_toggle();
+		// let's check that we have required data
+		if (! isset($this->_req_data['messenger'])) {
+			EE_Error::add_error(
+				esc_html__('Messenger name needed to toggle activation. None given', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$success = false;
+		}
+
+		// do a nonce check here since we're not arriving via a normal route
+		$nonce = isset($this->_req_data['activate_nonce'])
+			? sanitize_text_field($this->_req_data['activate_nonce'])
+			: '';
+		$nonce_ref = 'activate_' . $this->_req_data['messenger'] . '_toggle_nonce';
+
+		$this->_verify_nonce($nonce, $nonce_ref);
+
+
+		if (! isset($this->_req_data['status'])) {
+			EE_Error::add_error(
+				esc_html__(
+					'Messenger status needed to know whether activation or deactivation is happening. No status is given',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$success = false;
+		}
+
+		// do check to verify we have a valid status.
+		$status = $this->_req_data['status'];
+
+		if ($status !== 'off' && $status !== 'on') {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__('The given status (%s) is not valid. Must be "off" or "on"', 'event_espresso'),
+					$this->_req_data['status']
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$success = false;
+		}
+
+		if ($success) {
+			// made it here?  Stop dawdling then!!
+			$success = $status === 'off'
+				? $this->_deactivate_messenger($this->_req_data['messenger'])
+				: $this->_activate_messenger($this->_req_data['messenger']);
+		}
+
+		$this->_template_args['success'] = $success;
+
+		// no special instructions so let's just do the json return (which should automatically do all the special stuff).
+		$this->_return_json();
+	}
+
+
+	/**
+	 * used by ajax from the messages settings page to activate|deactivate a message type
+	 *
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	public function activate_mt_toggle()
+	{
+		$success = true;
+		$this->_prep_default_response_for_messenger_or_message_type_toggle();
+
+		// let's make sure we have the necessary data
+		if (! isset($this->_req_data['message_type'])) {
+			EE_Error::add_error(
+				esc_html__('Message Type name needed to toggle activation. None given', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$success = false;
+		}
+
+		if (! isset($this->_req_data['messenger'])) {
+			EE_Error::add_error(
+				esc_html__('Messenger name needed to toggle activation. None given', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$success = false;
+		}
+
+		if (! isset($this->_req_data['status'])) {
+			EE_Error::add_error(
+				esc_html__(
+					'Messenger status needed to know whether activation or deactivation is happening. No status is given',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$success = false;
+		}
+
+
+		// do check to verify we have a valid status.
+		$status = $this->_req_data['status'];
+
+		if ($status !== 'activate' && $status !== 'deactivate') {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__('The given status (%s) is not valid. Must be "active" or "inactive"', 'event_espresso'),
+					$this->_req_data['status']
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$success = false;
+		}
+
+
+		// do a nonce check here since we're not arriving via a normal route
+		$nonce = isset($this->_req_data['mt_nonce']) ? sanitize_text_field($this->_req_data['mt_nonce']) : '';
+		$nonce_ref = $this->_req_data['message_type'] . '_nonce';
+
+		$this->_verify_nonce($nonce, $nonce_ref);
+
+		if ($success) {
+			// made it here? um, what are you waiting for then?
+			$success = $status === 'deactivate'
+				? $this->_deactivate_message_type_for_messenger(
+					$this->_req_data['messenger'],
+					$this->_req_data['message_type']
+				)
+				: $this->_activate_message_type_for_messenger(
+					$this->_req_data['messenger'],
+					$this->_req_data['message_type']
+				);
+		}
+
+		$this->_template_args['success'] = $success;
+		$this->_return_json();
+	}
+
+
+	/**
+	 * Takes care of processing activating a messenger and preparing the appropriate response.
+	 *
+	 * @param string $messenger_name The name of the messenger being activated
+	 * @return bool
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _activate_messenger($messenger_name)
+	{
+		/** @var EE_messenger $active_messenger This will be present because it can't be toggled if it isn't */
+		$active_messenger = $this->_message_resource_manager->get_messenger($messenger_name);
+		$message_types_to_activate = $active_messenger instanceof EE_Messenger
+			? $active_messenger->get_default_message_types()
+			: array();
+
+		// ensure is active
+		$this->_message_resource_manager->activate_messenger($active_messenger, $message_types_to_activate);
+
+		// set response_data for reload
+		foreach ($message_types_to_activate as $message_type_name) {
+			/** @var EE_message_type $message_type */
+			$message_type = $this->_message_resource_manager->get_message_type($message_type_name);
+			if (
+				$this->_message_resource_manager->is_message_type_active_for_messenger(
+					$messenger_name,
+					$message_type_name
+				)
+				&& $message_type instanceof EE_message_type
+			) {
+				$this->_template_args['data']['active_mts'][] = $message_type_name;
+				if ($message_type->get_admin_settings_fields()) {
+					$this->_template_args['data']['mt_reload'][] = $message_type_name;
+				}
+			}
+		}
+
+		// add success message for activating messenger
+		return $this->_setup_response_message_for_activating_messenger_with_message_types($active_messenger);
+	}
+
+
+	/**
+	 * Takes care of processing deactivating a messenger and preparing the appropriate response.
+	 *
+	 * @param string $messenger_name The name of the messenger being activated
+	 * @return bool
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _deactivate_messenger($messenger_name)
+	{
+		/** @var EE_messenger $active_messenger This will be present because it can't be toggled if it isn't */
+		$active_messenger = $this->_message_resource_manager->get_messenger($messenger_name);
+		$this->_message_resource_manager->deactivate_messenger($messenger_name);
+
+		return $this->_setup_response_message_for_deactivating_messenger_with_message_types($active_messenger);
+	}
+
+
+	/**
+	 * Takes care of processing activating a message type for a messenger and preparing the appropriate response.
+	 *
+	 * @param string $messenger_name    The name of the messenger the message type is being activated for.
+	 * @param string $message_type_name The name of the message type being activated for the messenger
+	 * @return bool
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _activate_message_type_for_messenger($messenger_name, $message_type_name)
+	{
+		/** @var EE_messenger $active_messenger This will be present because it can't be toggled if it isn't */
+		$active_messenger = $this->_message_resource_manager->get_messenger($messenger_name);
+		/** @var EE_message_type $message_type_to_activate This will be present because it can't be toggled if it isn't */
+		$message_type_to_activate = $this->_message_resource_manager->get_message_type($message_type_name);
+
+		// ensure is active
+		$this->_message_resource_manager->activate_messenger($active_messenger, $message_type_name);
+
+		// set response for load
+		if (
+			$this->_message_resource_manager->is_message_type_active_for_messenger(
+				$messenger_name,
+				$message_type_name
+			)
+		) {
+			$this->_template_args['data']['active_mts'][] = $message_type_name;
+			if ($message_type_to_activate->get_admin_settings_fields()) {
+				$this->_template_args['data']['mt_reload'][] = $message_type_name;
+			}
+		}
+
+		return $this->_setup_response_message_for_activating_messenger_with_message_types(
+			$active_messenger,
+			$message_type_to_activate
+		);
+	}
+
+
+	/**
+	 * Takes care of processing deactivating a message type for a messenger and preparing the appropriate response.
+	 *
+	 * @param string $messenger_name    The name of the messenger the message type is being deactivated for.
+	 * @param string $message_type_name The name of the message type being deactivated for the messenger
+	 * @return bool
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _deactivate_message_type_for_messenger($messenger_name, $message_type_name)
+	{
+		/** @var EE_messenger $active_messenger This will be present because it can't be toggled if it isn't */
+		$active_messenger = $this->_message_resource_manager->get_messenger($messenger_name);
+		/** @var EE_message_type $message_type_to_activate This will be present because it can't be toggled if it isn't */
+		$message_type_to_deactivate = $this->_message_resource_manager->get_message_type($message_type_name);
+		$this->_message_resource_manager->deactivate_message_type_for_messenger($message_type_name, $messenger_name);
+
+		return $this->_setup_response_message_for_deactivating_messenger_with_message_types(
+			$active_messenger,
+			$message_type_to_deactivate
+		);
+	}
+
+
+	/**
+	 * This just initializes the defaults for activating messenger and message type responses.
+	 */
+	protected function _prep_default_response_for_messenger_or_message_type_toggle()
+	{
+		$this->_template_args['data']['active_mts'] = array();
+		$this->_template_args['data']['mt_reload'] = array();
+	}
+
+
+	/**
+	 * Setup appropriate response for activating a messenger and/or message types
+	 *
+	 * @param EE_messenger         $messenger
+	 * @param EE_message_type|null $message_type
+	 * @return bool
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _setup_response_message_for_activating_messenger_with_message_types(
+		$messenger,
+		EE_Message_Type $message_type = null
+	) {
+		// if $messenger isn't a valid messenger object then get out.
+		if (! $messenger instanceof EE_Messenger) {
+			EE_Error::add_error(
+				esc_html__('The messenger being activated is not a valid messenger', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+
+			return false;
+		}
+		// activated
+		if ($this->_template_args['data']['active_mts']) {
+			EE_Error::overwrite_success();
+			// activated a message type with the messenger
+			if ($message_type instanceof EE_message_type) {
+				EE_Error::add_success(
+					sprintf(
+						esc_html__(
+							'%s message type has been successfully activated with the %s messenger',
+							'event_espresso'
+						),
+						ucwords($message_type->label['singular']),
+						ucwords($messenger->label['singular'])
+					)
+				);
+
+				// if message type was invoice then let's make sure we activate the invoice payment method.
+				if ($message_type->name === 'invoice') {
+					EE_Registry::instance()->load_lib('Payment_Method_Manager');
+					$pm = EE_Payment_Method_Manager::instance()->activate_a_payment_method_of_type('Invoice');
+					if ($pm instanceof EE_Payment_Method) {
+						EE_Error::add_attention(
+							esc_html__(
+								'Activating the invoice message type also automatically activates the invoice payment method.  If you do not wish the invoice payment method to be active, or to change its settings, visit the payment method admin page.',
+								'event_espresso'
+							)
+						);
+					}
+				}
+				// just toggles the entire messenger
+			} else {
+				EE_Error::add_success(
+					sprintf(
+						esc_html__('%s messenger has been successfully activated', 'event_espresso'),
+						ucwords($messenger->label['singular'])
+					)
+				);
+			}
+
+			return true;
+
+			// possible error condition. This will happen when our active_mts data is empty because it is validated for actual active
+			// message types after the activation process.  However its possible some messengers don't HAVE any default_message_types
+			// in which case we just give a success message for the messenger being successfully activated.
+		} else {
+			if (! $messenger->get_default_message_types()) {
+				// messenger doesn't have any default message types so still a success.
+				EE_Error::add_success(
+					sprintf(
+						esc_html__('%s messenger was successfully activated.', 'event_espresso'),
+						ucwords($messenger->label['singular'])
+					)
+				);
+
+				return true;
+			} else {
+				EE_Error::add_error(
+					$message_type instanceof EE_message_type
+						? sprintf(
+							esc_html__(
+								'%s message type was not successfully activated with the %s messenger',
+								'event_espresso'
+							),
+							ucwords($message_type->label['singular']),
+							ucwords($messenger->label['singular'])
+						)
+						: sprintf(
+							esc_html__('%s messenger was not successfully activated', 'event_espresso'),
+							ucwords($messenger->label['singular'])
+						),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+
+				return false;
+			}
+		}
+	}
+
+
+	/**
+	 * This sets up the appropriate response for deactivating a messenger and/or message type.
+	 *
+	 * @param EE_messenger         $messenger
+	 * @param EE_message_type|null $message_type
+	 * @return bool
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _setup_response_message_for_deactivating_messenger_with_message_types(
+		$messenger,
+		EE_message_type $message_type = null
+	) {
+		EE_Error::overwrite_success();
+
+		// if $messenger isn't a valid messenger object then get out.
+		if (! $messenger instanceof EE_Messenger) {
+			EE_Error::add_error(
+				esc_html__('The messenger being deactivated is not a valid messenger', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+
+			return false;
+		}
+
+		if ($message_type instanceof EE_message_type) {
+			$message_type_name = $message_type->name;
+			EE_Error::add_success(
+				sprintf(
+					esc_html__(
+						'%s message type has been successfully deactivated for the %s messenger.',
+						'event_espresso'
+					),
+					ucwords($message_type->label['singular']),
+					ucwords($messenger->label['singular'])
+				)
+			);
+		} else {
+			$message_type_name = '';
+			EE_Error::add_success(
+				sprintf(
+					esc_html__('%s messenger has been successfully deactivated.', 'event_espresso'),
+					ucwords($messenger->label['singular'])
+				)
+			);
+		}
+
+		// if messenger was html or message type was invoice then let's make sure we deactivate invoice payment method.
+		if ($messenger->name === 'html' || $message_type_name === 'invoice') {
+			EE_Registry::instance()->load_lib('Payment_Method_Manager');
+			$count_updated = EE_Payment_Method_Manager::instance()->deactivate_payment_method('invoice');
+			if ($count_updated > 0) {
+				$msg = $message_type_name === 'invoice'
+					? esc_html__(
+						'Deactivating the invoice message type also automatically deactivates the invoice payment method. In order for invoices to be generated the invoice message type must be active. If you completed this action by mistake, simply reactivate the invoice message type and then visit the payment methods admin page to reactivate the invoice payment method.',
+						'event_espresso'
+					)
+					: esc_html__(
+						'Deactivating the html messenger also automatically deactivates the invoice payment method.  In order for invoices to be generated the html messenger must be be active.  If you completed this action by mistake, simply reactivate the html messenger, then visit the payment methods admin page to reactivate the invoice payment method.',
+						'event_espresso'
+					);
+				EE_Error::add_attention($msg);
+			}
+		}
+
+		return true;
+	}
+
+
+	/**
+	 * handles updating a message type form on messenger activation IF the message type has settings fields. (via ajax)
+	 *
+	 * @throws DomainException
+	 */
+	public function update_mt_form()
+	{
+		if (! isset($this->_req_data['messenger']) || ! isset($this->_req_data['message_type'])) {
+			EE_Error::add_error(
+				esc_html__('Require message type or messenger to send an updated form', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$this->_return_json();
+		}
+
+		$message_types = $this->get_installed_message_types();
+
+		$message_type = $message_types[ $this->_req_data['message_type'] ];
+		$messenger = $this->_message_resource_manager->get_active_messenger($this->_req_data['messenger']);
+
+		$content = $this->_message_type_settings_content(
+			$message_type,
+			$messenger,
+			true
+		);
+		$this->_template_args['success'] = true;
+		$this->_template_args['content'] = $content;
+		$this->_return_json();
+	}
+
+
+	/**
+	 * this handles saving the settings for a messenger or message type
+	 *
+	 */
+	public function save_settings()
+	{
+		if (! isset($this->_req_data['type'])) {
+			EE_Error::add_error(
+				esc_html__(
+					'Cannot save settings because type is unknown (messenger settings or messsage type settings?)',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$this->_template_args['error'] = true;
+			$this->_return_json();
+		}
+
+
+		if ($this->_req_data['type'] === 'messenger') {
+			// this should be an array.
+			$settings = $this->_req_data['messenger_settings'];
+			$messenger = $settings['messenger'];
+			// let's setup the settings data
+			foreach ($settings as $key => $value) {
+				switch ($key) {
+					case 'messenger':
+						unset($settings['messenger']);
+						break;
+					case 'message_types':
+						unset($settings['message_types']);
+						break;
+					default:
+						$settings[ $key ] = $value;
+						break;
+				}
+			}
+			$this->_message_resource_manager->add_settings_for_messenger($messenger, $settings);
+		} elseif ($this->_req_data['type'] === 'message_type') {
+			$settings = $this->_req_data['message_type_settings'];
+			$messenger = $settings['messenger'];
+			$message_type = $settings['message_type'];
+
+			foreach ($settings as $key => $value) {
+				switch ($key) {
+					case 'messenger':
+						unset($settings['messenger']);
+						break;
+					case 'message_type':
+						unset($settings['message_type']);
+						break;
+					default:
+						$settings[ $key ] = $value;
+						break;
+				}
+			}
+
+			$this->_message_resource_manager->add_settings_for_message_type($messenger, $message_type, $settings);
+		}
+
+		// okay we should have the data all setup.  Now we just update!
+		$success = $this->_message_resource_manager->update_active_messengers_option();
+
+		if ($success) {
+			EE_Error::add_success(__('Settings updated', 'event_espresso'));
+		} else {
+			EE_Error::add_error(
+				esc_html__(
+					'Settings did not get updated',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+
+		$this->_template_args['success'] = $success;
+		$this->_return_json();
+	}
+
+
+
+
+	/**  EE MESSAGE PROCESSING ACTIONS **/
+
+
+	/**
+	 * This immediately generates any EE_Message ID's that are selected that are EEM_Message::status_incomplete
+	 * However, this does not send immediately, it just queues for sending.
+	 *
+	 * @since 4.9.0
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 */
+	protected function _generate_now()
+	{
+		EED_Messages::generate_now($this->_get_msg_ids_from_request());
+		$this->_redirect_after_action(false, '', '', array(), true);
+	}
+
+
+	/**
+	 * This immediately generates AND sends any EE_Message's selected that are EEM_Message::status_incomplete or that
+	 * are EEM_Message::status_resend or EEM_Message::status_idle
+	 *
+	 * @since 4.9.0
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 */
+	protected function _generate_and_send_now()
+	{
+		EED_Messages::generate_and_send_now($this->_get_msg_ids_from_request());
+		$this->_redirect_after_action(false, '', '', array(), true);
+	}
+
+
+	/**
+	 * This queues any EEM_Message::status_sent EE_Message ids in the request for resending.
+	 *
+	 * @since 4.9.0
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 */
+	protected function _queue_for_resending()
+	{
+		EED_Messages::queue_for_resending($this->_get_msg_ids_from_request());
+		$this->_redirect_after_action(false, '', '', array(), true);
+	}
+
+
+	/**
+	 *  This sends immediately any EEM_Message::status_idle or EEM_Message::status_resend messages in the queue
+	 *
+	 * @since 4.9.0
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 */
+	protected function _send_now()
+	{
+		EED_Messages::send_now($this->_get_msg_ids_from_request());
+		$this->_redirect_after_action(false, '', '', array(), true);
+	}
+
+
+	/**
+	 * Deletes EE_messages for IDs in the request.
+	 *
+	 * @since 4.9.0
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	protected function _delete_ee_messages()
+	{
+		$msg_ids = $this->_get_msg_ids_from_request();
+		$deleted_count = 0;
+		foreach ($msg_ids as $msg_id) {
+			if (EEM_Message::instance()->delete_by_ID($msg_id)) {
+				$deleted_count++;
+			}
+		}
+		if ($deleted_count) {
+			EE_Error::add_success(
+				esc_html(
+					_n(
+						'Message successfully deleted',
+						'Messages successfully deleted',
+						$deleted_count,
+						'event_espresso'
+					)
+				)
+			);
+			$this->_redirect_after_action(
+				false,
+				'',
+				'',
+				array(),
+				true
+			);
+		} else {
+			EE_Error::add_error(
+				_n('The message was not deleted.', 'The messages were not deleted', count($msg_ids), 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$this->_redirect_after_action(false, '', '', array(), true);
+		}
+	}
+
+
+	/**
+	 *  This looks for 'MSG_ID' key in the request and returns an array of MSG_ID's if present.
+	 *
+	 * @since 4.9.0
+	 * @return array
+	 */
+	protected function _get_msg_ids_from_request()
+	{
+		if (! isset($this->_req_data['MSG_ID'])) {
+			return array();
+		}
+
+		return is_array($this->_req_data['MSG_ID'])
+			? array_keys($this->_req_data['MSG_ID'])
+			: array($this->_req_data['MSG_ID']);
+	}
 }

languages/event_espresso-translations-js.php

Spacing +599 added lines, -599 removed lines

@@ -2,226 +2,226 @@ 
 /* THIS IS A GENERATED FILE. DO NOT EDIT DIRECTLY. */
 $generated_i18n_strings = array(
 	// Reference: packages/ui-components/src/Pagination/constants.ts:6
-	__( '2', 'event_espresso' ),
+	__('2', 'event_espresso'),
 
 	// Reference: packages/ui-components/src/Pagination/constants.ts:7
-	__( '6', 'event_espresso' ),
+	__('6', 'event_espresso'),
 
 	// Reference: packages/ui-components/src/Pagination/constants.ts:8
-	__( '12', 'event_espresso' ),
+	__('12', 'event_espresso'),
 
 	// Reference: packages/ui-components/src/Pagination/constants.ts:9
-	__( '24', 'event_espresso' ),
+	__('24', 'event_espresso'),
 
 	// Reference: packages/ui-components/src/Pagination/constants.ts:10
-	__( '48', 'event_espresso' ),
+	__('48', 'event_espresso'),
 
 	// Reference: domains/core/admin/blocks/src/components/AvatarImage.tsx:27
-	__( 'contact avatar', 'event_espresso' ),
+	__('contact avatar', 'event_espresso'),
 
 	// Reference: domains/core/admin/blocks/src/components/OrderByControl.tsx:12
-	__( 'Order by', 'event_espresso' ),
+	__('Order by', 'event_espresso'),
 
 	// Reference: domains/core/admin/blocks/src/components/RegStatusControl.tsx:17
 	// Reference: domains/core/admin/blocks/src/event-attendees/controls/SelectStatus.tsx:13
-	__( 'Select Registration Status', 'event_espresso' ),
+	__('Select Registration Status', 'event_espresso'),
 
 	// Reference: domains/core/admin/blocks/src/components/SortOrderControl.tsx:14
-	__( 'Ascending', 'event_espresso' ),
+	__('Ascending', 'event_espresso'),
 
 	// Reference: domains/core/admin/blocks/src/components/SortOrderControl.tsx:18
-	__( 'Descending', 'event_espresso' ),
+	__('Descending', 'event_espresso'),
 
 	// Reference: domains/core/admin/blocks/src/components/SortOrderControl.tsx:24
-	__( 'Sort order:', 'event_espresso' ),
+	__('Sort order:', 'event_espresso'),
 
 	// Reference: domains/core/admin/blocks/src/event-attendees/AttendeesDisplay.tsx:41
-	__( 'There was some error fetching attendees list', 'event_espresso' ),
+	__('There was some error fetching attendees list', 'event_espresso'),
 
 	// Reference: domains/core/admin/blocks/src/event-attendees/AttendeesDisplay.tsx:47
-	__( 'To get started, select what event you want to show attendees from in the block settings.', 'event_espresso' ),
+	__('To get started, select what event you want to show attendees from in the block settings.', 'event_espresso'),
 
 	// Reference: domains/core/admin/blocks/src/event-attendees/AttendeesDisplay.tsx:53
-	__( 'There are no attendees for selected options.', 'event_espresso' ),
+	__('There are no attendees for selected options.', 'event_espresso'),
 
 	// Reference: domains/core/admin/blocks/src/event-attendees/controls/ArchiveSettings.tsx:12
-	__( 'Display on Archives', 'event_espresso' ),
+	__('Display on Archives', 'event_espresso'),
 
 	// Reference: domains/core/admin/blocks/src/event-attendees/controls/ArchiveSettings.tsx:17
-	__( 'Attendees are shown whenever this post is listed in an archive view.', 'event_espresso' ),
+	__('Attendees are shown whenever this post is listed in an archive view.', 'event_espresso'),
 
 	// Reference: domains/core/admin/blocks/src/event-attendees/controls/ArchiveSettings.tsx:18
-	__( 'Attendees are hidden whenever this post is listed in an archive view.', 'event_espresso' ),
+	__('Attendees are hidden whenever this post is listed in an archive view.', 'event_espresso'),
 
 	// Reference: domains/core/admin/blocks/src/event-attendees/controls/AttendeeLimit.tsx:29
-	__( 'Number of Attendees to Display:', 'event_espresso' ),
+	__('Number of Attendees to Display:', 'event_espresso'),
 
 	// Reference: domains/core/admin/blocks/src/event-attendees/controls/AttendeeLimit.tsx:34
 	/* translators: %d attendees count */
-	_n_noop( 'Used to adjust the number of attendees displayed (There is %d total attendee for the current filter settings).', 'Used to adjust the number of attendees displayed (There are %d total attendees for the current filter settings).', 'event_espresso' ),
+	_n_noop('Used to adjust the number of attendees displayed (There is %d total attendee for the current filter settings).', 'Used to adjust the number of attendees displayed (There are %d total attendees for the current filter settings).', 'event_espresso'),
 
 	// Reference: domains/core/admin/blocks/src/event-attendees/controls/GravatarSettings.tsx:27
-	__( 'Display Gravatar', 'event_espresso' ),
+	__('Display Gravatar', 'event_espresso'),
 
 	// Reference: domains/core/admin/blocks/src/event-attendees/controls/GravatarSettings.tsx:32
-	__( 'Gravatar images are shown for each attendee.', 'event_espresso' ),
+	__('Gravatar images are shown for each attendee.', 'event_espresso'),
 
 	// Reference: domains/core/admin/blocks/src/event-attendees/controls/GravatarSettings.tsx:33
-	__( 'No gravatar images are shown for each attendee.', 'event_espresso' ),
+	__('No gravatar images are shown for each attendee.', 'event_espresso'),
 
 	// Reference: domains/core/admin/blocks/src/event-attendees/controls/GravatarSettings.tsx:38
-	__( 'Size of Gravatar', 'event_espresso' ),
+	__('Size of Gravatar', 'event_espresso'),
 
 	// Reference: domains/core/admin/blocks/src/event-attendees/controls/SelectDatetime.tsx:22
-	__( 'Select Datetime', 'event_espresso' ),
+	__('Select Datetime', 'event_espresso'),
 
 	// Reference: domains/core/admin/blocks/src/event-attendees/controls/SelectEvent.tsx:22
-	__( 'Select Event', 'event_espresso' ),
+	__('Select Event', 'event_espresso'),
 
 	// Reference: domains/core/admin/blocks/src/event-attendees/controls/SelectOrderBy.tsx:11
-	__( 'Attendee id', 'event_espresso' ),
+	__('Attendee id', 'event_espresso'),
 
 	// Reference: domains/core/admin/blocks/src/event-attendees/controls/SelectOrderBy.tsx:15
-	__( 'Last name only', 'event_espresso' ),
+	__('Last name only', 'event_espresso'),
 
 	// Reference: domains/core/admin/blocks/src/event-attendees/controls/SelectOrderBy.tsx:19
-	__( 'First name only', 'event_espresso' ),
+	__('First name only', 'event_espresso'),
 
 	// Reference: domains/core/admin/blocks/src/event-attendees/controls/SelectOrderBy.tsx:23
-	__( 'First, then Last name', 'event_espresso' ),
+	__('First, then Last name', 'event_espresso'),
 
 	// Reference: domains/core/admin/blocks/src/event-attendees/controls/SelectOrderBy.tsx:27
-	__( 'Last, then First name', 'event_espresso' ),
+	__('Last, then First name', 'event_espresso'),
 
 	// Reference: domains/core/admin/blocks/src/event-attendees/controls/SelectOrderBy.tsx:41
-	__( 'Order Attendees by:', 'event_espresso' ),
+	__('Order Attendees by:', 'event_espresso'),
 
 	// Reference: domains/core/admin/blocks/src/event-attendees/controls/SelectTicket.tsx:22
-	__( 'Select Ticket', 'event_espresso' ),
+	__('Select Ticket', 'event_espresso'),
 
 	// Reference: domains/core/admin/blocks/src/event-attendees/controls/index.tsx:21
-	__( 'Filter By Settings', 'event_espresso' ),
+	__('Filter By Settings', 'event_espresso'),
 
 	// Reference: domains/core/admin/blocks/src/event-attendees/controls/index.tsx:36
-	__( 'Gravatar Setttings', 'event_espresso' ),
+	__('Gravatar Setttings', 'event_espresso'),
 
 	// Reference: domains/core/admin/blocks/src/event-attendees/controls/index.tsx:39
-	__( 'Archive Settings', 'event_espresso' ),
+	__('Archive Settings', 'event_espresso'),
 
 	// Reference: domains/core/admin/blocks/src/event-attendees/index.tsx:10
-	__( 'Event Attendees', 'event_espresso' ),
+	__('Event Attendees', 'event_espresso'),
 
 	// Reference: domains/core/admin/blocks/src/event-attendees/index.tsx:11
-	__( 'Displays a list of people that have registered for the specified event', 'event_espresso' ),
+	__('Displays a list of people that have registered for the specified event', 'event_espresso'),
 
 	// Reference: domains/core/admin/blocks/src/event-attendees/index.tsx:14
-	__( 'event', 'event_espresso' ),
+	__('event', 'event_espresso'),
 
 	// Reference: domains/core/admin/blocks/src/event-attendees/index.tsx:14
-	__( 'attendees', 'event_espresso' ),
+	__('attendees', 'event_espresso'),
 
 	// Reference: domains/core/admin/blocks/src/event-attendees/index.tsx:14
-	__( 'list', 'event_espresso' ),
+	__('list', 'event_espresso'),
 
 	// Reference: domains/core/admin/blocks/src/services/utils.ts:17
-	__( 'Error', 'event_espresso' ),
+	__('Error', 'event_espresso'),
 
 	// Reference: domains/core/admin/blocks/src/services/utils.ts:24
 	// Reference: packages/ui-components/src/SimpleEntityList/EntityTemplate.tsx:16
-	__( 'Select…', 'event_espresso' ),
+	__('Select…', 'event_espresso'),
 
 	// Reference: domains/core/admin/blocks/src/services/utils.ts:9
-	__( 'Loading…', 'event_espresso' ),
+	__('Loading…', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/EventDescription.tsx:33
-	__( 'Event Description', 'event_espresso' ),
+	__('Event Description', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/EventRegistrationOptions/ActiveStatus.tsx:22
-	__( 'Active status', 'event_espresso' ),
+	__('Active status', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/EventRegistrationOptions/AltRegPage.tsx:14
-	__( 'Alternative Registration Page', 'event_espresso' ),
+	__('Alternative Registration Page', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/EventRegistrationOptions/DefaultRegistrationStatus.tsx:15
-	__( 'Default Registration Status', 'event_espresso' ),
+	__('Default Registration Status', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/EventRegistrationOptions/Donations.tsx:9
-	__( 'Donations Enabled', 'event_espresso' ),
+	__('Donations Enabled', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/EventRegistrationOptions/Donations.tsx:9
-	__( 'Donations Disabled', 'event_espresso' ),
+	__('Donations Disabled', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/EventRegistrationOptions/EventManager.tsx:16
-	__( 'Event Manager', 'event_espresso' ),
+	__('Event Manager', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/EventRegistrationOptions/EventPhoneNumber.tsx:11
-	__( 'Event Phone Number', 'event_espresso' ),
+	__('Event Phone Number', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/EventRegistrationOptions/MaxRegistrations.tsx:12
-	__( 'Max Registrations per Transaction', 'event_espresso' ),
+	__('Max Registrations per Transaction', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/EventRegistrationOptions/TicketSelector.tsx:9
-	__( 'Ticket Selector Enabled', 'event_espresso' ),
+	__('Ticket Selector Enabled', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/EventRegistrationOptions/TicketSelector.tsx:9
-	__( 'Ticket Selector Disabled', 'event_espresso' ),
+	__('Ticket Selector Disabled', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/EventRegistrationOptions/index.tsx:43
-	__( 'Registration Options', 'event_espresso' ),
+	__('Registration Options', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/DateRegistrationsLink.tsx:13
-	__( 'view ALL registrations for this date.', 'event_espresso' ),
+	__('view ALL registrations for this date.', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/dateForm/multiStep/DateFormSteps.tsx:10
-	__( 'primary information about the date', 'event_espresso' ),
+	__('primary information about the date', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/dateForm/multiStep/DateFormSteps.tsx:10
-	__( 'Date Details', 'event_espresso' ),
+	__('Date Details', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/dateForm/multiStep/DateFormSteps.tsx:11
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/defaultTickets/multiStep/TicketFormSteps.tsx:16
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketForm/multiStep/TicketFormSteps.tsx:16
-	__( 'relations between tickets and dates', 'event_espresso' ),
+	__('relations between tickets and dates', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/dateForm/multiStep/DateFormSteps.tsx:11
-	__( 'Assign Tickets', 'event_espresso' ),
+	__('Assign Tickets', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/dateForm/multiStep/FooterButtons.tsx:22
-	__( 'Save and assign tickets', 'event_espresso' ),
+	__('Save and assign tickets', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/dateForm/multiStep/Modal.tsx:27
 	/* translators: %s datetime id */
-	__( 'Edit datetime %s', 'event_espresso' ),
+	__('Edit datetime %s', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/dateForm/multiStep/Modal.tsx:30
-	__( 'New Datetime', 'event_espresso' ),
+	__('New Datetime', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/dateForm/useDateFormConfig.ts:110
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/bulkEdit/details/useBulkEditFormConfig.ts:108
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketForm/useTicketFormConfig.ts:126
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/bulkEdit/details/useBulkEditFormConfig.ts:108
-	__( 'Details', 'event_espresso' ),
+	__('Details', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/dateForm/useDateFormConfig.ts:114
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/bulkEdit/details/useBulkEditFormConfig.ts:112
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/tableView/useHeaderRowGenerator.tsx:81
-	__( 'Capacity', 'event_espresso' ),
+	__('Capacity', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/dateForm/useDateFormConfig.ts:119
-	__( 'The maximum number of registrants that can attend the event at this particular date.', 'event_espresso' ),
+	__('The maximum number of registrants that can attend the event at this particular date.', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/dateForm/useDateFormConfig.ts:123
-	__( 'Set to 0 to close registration or leave blank for no limit.', 'event_espresso' ),
+	__('Set to 0 to close registration or leave blank for no limit.', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/dateForm/useDateFormConfig.ts:129
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketForm/useTicketFormConfig.ts:203
-	__( 'Trash', 'event_espresso' ),
+	__('Trash', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/dateForm/useDateFormConfig.ts:71
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/bulkEdit/details/useBulkEditFormConfig.ts:45
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketForm/useTicketFormConfig.ts:87
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/bulkEdit/details/useBulkEditFormConfig.ts:45
-	__( 'Basics', 'event_espresso' ),
+	__('Basics', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/dateForm/useDateFormConfig.ts:75
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/bulkEdit/details/useBulkEditFormConfig.ts:49
@@ -229,249 +229,249 @@ 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketForm/useTicketFormConfig.ts:91
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/bulkEdit/details/useBulkEditFormConfig.ts:49
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/tableView/useHeaderRowGenerator.tsx:40
-	__( 'Name', 'event_espresso' ),
+	__('Name', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/dateForm/useDateFormConfig.ts:80
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/bulkEdit/details/useBulkEditFormConfig.ts:55
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketForm/useTicketFormConfig.ts:96
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/bulkEdit/details/useBulkEditFormConfig.ts:55
 	// Reference: packages/tpc/src/components/table/useHeaderRowGenerator.ts:47
-	__( 'Description', 'event_espresso' ),
+	__('Description', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/dateForm/useDateFormConfig.ts:88
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/bulkEdit/details/useBulkEditFormConfig.ts:63
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/bulkEdit/details/useBulkEditFormConfig.ts:63
-	__( 'Dates', 'event_espresso' ),
+	__('Dates', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/dateForm/useDateFormConfig.ts:92
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/tableView/useHeaderRowGenerator.tsx:51
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketForm/useTicketFormConfig.ts:108
-	__( 'Start Date', 'event_espresso' ),
+	__('Start Date', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/dateForm/useDateFormConfig.ts:99
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/tableView/useHeaderRowGenerator.tsx:65
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketForm/useTicketFormConfig.ts:115
-	__( 'End Date', 'event_espresso' ),
+	__('End Date', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/DatesList.tsx:35
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/tableView/TableView.tsx:33
-	__( 'Event Dates', 'event_espresso' ),
+	__('Event Dates', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/DatesList.tsx:38
-	__( 'loading event dates…', 'event_espresso' ),
+	__('loading event dates…', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/DatesListButtons.tsx:20
-	__( 'Add a date or a ticket in order to use Ticket Assignment Manager', 'event_espresso' ),
+	__('Add a date or a ticket in order to use Ticket Assignment Manager', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/DatesListButtons.tsx:30
-	__( 'Ticket Assignments', 'event_espresso' ),
+	__('Ticket Assignments', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/actionsMenu/AssignTicketsButton.tsx:25
-	__( 'Number of related tickets', 'event_espresso' ),
+	__('Number of related tickets', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/actionsMenu/AssignTicketsButton.tsx:26
-	__( 'There are no tickets assigned to this datetime. Please click the ticket icon to update the assignments.', 'event_espresso' ),
+	__('There are no tickets assigned to this datetime. Please click the ticket icon to update the assignments.', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/actionsMenu/AssignTicketsButton.tsx:34
-	__( 'assign tickets', 'event_espresso' ),
+	__('assign tickets', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/actionsMenu/dropdown/DateMainMenu.tsx:25
-	__( 'Permanently delete Datetime?', 'event_espresso' ),
+	__('Permanently delete Datetime?', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/actionsMenu/dropdown/DateMainMenu.tsx:25
-	__( 'Move Datetime to Trash?', 'event_espresso' ),
+	__('Move Datetime to Trash?', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/actionsMenu/dropdown/DateMainMenu.tsx:27
-	__( 'Are you sure you want to permanently delete this datetime? This action is permanent and can not be undone.', 'event_espresso' ),
+	__('Are you sure you want to permanently delete this datetime? This action is permanent and can not be undone.', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/actionsMenu/dropdown/DateMainMenu.tsx:30
-	__( 'Are you sure you want to move this datetime to the trash? You can "untrash" this datetime later if you need to.', 'event_espresso' ),
+	__('Are you sure you want to move this datetime to the trash? You can "untrash" this datetime later if you need to.', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/actionsMenu/dropdown/DateMainMenu.tsx:39
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/actionsMenu/dropdown/DeleteTicket.tsx:44
-	__( 'delete permanently', 'event_espresso' ),
+	__('delete permanently', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/actionsMenu/dropdown/DateMainMenu.tsx:39
-	__( 'trash datetime', 'event_espresso' ),
+	__('trash datetime', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/actionsMenu/dropdown/DateMainMenu.tsx:45
-	__( 'event date main menu', 'event_espresso' ),
+	__('event date main menu', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/actionsMenu/dropdown/DateMainMenu.tsx:59
-	__( 'edit datetime', 'event_espresso' ),
+	__('edit datetime', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/actionsMenu/dropdown/DateMainMenu.tsx:60
-	__( 'copy datetime', 'event_espresso' ),
+	__('copy datetime', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/bulkEdit/actions/Actions.tsx:36
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/bulkEdit/actions/Actions.tsx:39
 	// Reference: packages/ui-components/src/bulkEdit/BulkActions.tsx:43
-	__( 'bulk actions', 'event_espresso' ),
+	__('bulk actions', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/bulkEdit/actions/Actions.tsx:40
-	__( 'edit datetime details', 'event_espresso' ),
+	__('edit datetime details', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/bulkEdit/actions/Actions.tsx:44
-	__( 'delete datetimes', 'event_espresso' ),
+	__('delete datetimes', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/bulkEdit/actions/Actions.tsx:44
-	__( 'trash datetimes', 'event_espresso' ),
+	__('trash datetimes', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/bulkEdit/delete/Delete.tsx:14
-	__( 'Are you sure you want to permanently delete these datetimes? This action can NOT be undone!', 'event_espresso' ),
+	__('Are you sure you want to permanently delete these datetimes? This action can NOT be undone!', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/bulkEdit/delete/Delete.tsx:15
-	__( 'Are you sure you want to trash these datetimes?', 'event_espresso' ),
+	__('Are you sure you want to trash these datetimes?', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/bulkEdit/delete/Delete.tsx:16
-	__( 'Delete datetimes permanently', 'event_espresso' ),
+	__('Delete datetimes permanently', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/bulkEdit/delete/Delete.tsx:16
-	__( 'Trash datetimes', 'event_espresso' ),
+	__('Trash datetimes', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/bulkEdit/details/EditDetails.tsx:21
-	__( 'Bulk edit date details', 'event_espresso' ),
+	__('Bulk edit date details', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/bulkEdit/details/EditDetails.tsx:22
-	__( 'any changes will be applied to ALL of the selected dates.', 'event_espresso' ),
+	__('any changes will be applied to ALL of the selected dates.', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/bulkEdit/details/formValidation.ts:12
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/bulkEdit/details/formValidation.ts:12
-	__( 'Name must be at least three characters', 'event_espresso' ),
+	__('Name must be at least three characters', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/bulkEdit/details/useBulkEditFormConfig.ts:67
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/bulkEdit/details/useBulkEditFormConfig.ts:67
-	__( 'Shift dates', 'event_espresso' ),
+	__('Shift dates', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/bulkEdit/details/useBulkEditFormConfig.ts:92
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/bulkEdit/details/useBulkEditFormConfig.ts:92
-	__( 'earlier', 'event_espresso' ),
+	__('earlier', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/bulkEdit/details/useBulkEditFormConfig.ts:96
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/bulkEdit/details/useBulkEditFormConfig.ts:96
-	__( 'later', 'event_espresso' ),
+	__('later', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/cardView/DateCapacity.tsx:37
-	__( 'edit capacity (registration limit)…', 'event_espresso' ),
+	__('edit capacity (registration limit)…', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/cardView/DateCardSidebar.tsx:38
-	__( 'Edit Event Date', 'event_espresso' ),
+	__('Edit Event Date', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/cardView/DateCardSidebar.tsx:42
-	__( 'edit start and end dates', 'event_espresso' ),
+	__('edit start and end dates', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/cardView/DateDetailsPanel.tsx:15
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/cardView/TicketDetailsPanel.tsx:15
-	__( 'sold', 'event_espresso' ),
+	__('sold', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/cardView/DateDetailsPanel.tsx:28
-	__( 'capacity', 'event_espresso' ),
+	__('capacity', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/cardView/DateDetailsPanel.tsx:34
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/cardView/TicketDetailsPanel.tsx:33
-	__( 'reg list', 'event_espresso' ),
+	__('reg list', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/cardView/Details.tsx:46
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/cardView/Details.tsx:45
-	__( 'Edit description', 'event_espresso' ),
+	__('Edit description', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/cardView/Details.tsx:47
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/cardView/Details.tsx:46
-	__( 'edit description…', 'event_espresso' ),
+	__('edit description…', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/config.ts:10
-	__( 'Move Date to Trash', 'event_espresso' ),
+	__('Move Date to Trash', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/config.ts:13
 	// Reference: packages/constants/src/datetime.ts:6
-	__( 'Active', 'event_espresso' ),
+	__('Active', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/config.ts:14
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/config.ts:13
-	__( 'Trashed', 'event_espresso' ),
+	__('Trashed', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/config.ts:15
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/config.ts:14
 	// Reference: packages/constants/src/datetime.ts:8
-	__( 'Expired', 'event_espresso' ),
+	__('Expired', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/config.ts:16
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/config.ts:16
-	__( 'Sold Out', 'event_espresso' ),
+	__('Sold Out', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/config.ts:17
 	// Reference: packages/constants/src/datetime.ts:12
-	__( 'Upcoming', 'event_espresso' ),
+	__('Upcoming', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/config.ts:7
-	__( 'Edit Event Date Details', 'event_espresso' ),
+	__('Edit Event Date Details', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/config.ts:8
-	__( 'View Registrations for this Date', 'event_espresso' ),
+	__('View Registrations for this Date', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/config.ts:9
-	__( 'Manage Ticket Assignments', 'event_espresso' ),
+	__('Manage Ticket Assignments', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/editable/EditableName.tsx:23
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/editable/EditableName.tsx:34
-	__( 'edit title…', 'event_espresso' ),
+	__('edit title…', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/filterBar/ActiveDatesFilters.tsx:17
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/filterBar/ActiveTicketsFilters.tsx:17
-	__( 'ON', 'event_espresso' ),
+	__('ON', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/filterBar/controls/options.ts:10
-	__( 'end dates only', 'event_espresso' ),
+	__('end dates only', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/filterBar/controls/options.ts:11
-	__( 'start and end dates', 'event_espresso' ),
+	__('start and end dates', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/filterBar/controls/options.ts:16
-	__( 'dates above 90% capacity', 'event_espresso' ),
+	__('dates above 90% capacity', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/filterBar/controls/options.ts:17
-	__( 'dates above 75% capacity', 'event_espresso' ),
+	__('dates above 75% capacity', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/filterBar/controls/options.ts:18
-	__( 'dates above 50% capacity', 'event_espresso' ),
+	__('dates above 50% capacity', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/filterBar/controls/options.ts:19
-	__( 'dates below 50% capacity', 'event_espresso' ),
+	__('dates below 50% capacity', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/filterBar/controls/options.ts:23
-	__( 'all dates', 'event_espresso' ),
+	__('all dates', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/filterBar/controls/options.ts:24
-	__( 'all active and upcoming', 'event_espresso' ),
+	__('all active and upcoming', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/filterBar/controls/options.ts:25
-	__( 'active dates only', 'event_espresso' ),
+	__('active dates only', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/filterBar/controls/options.ts:26
-	__( 'upcoming dates only', 'event_espresso' ),
+	__('upcoming dates only', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/filterBar/controls/options.ts:27
-	__( 'next active or upcoming only', 'event_espresso' ),
+	__('next active or upcoming only', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/filterBar/controls/options.ts:28
-	__( 'sold out dates only', 'event_espresso' ),
+	__('sold out dates only', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/filterBar/controls/options.ts:29
-	__( 'recently expired dates', 'event_espresso' ),
+	__('recently expired dates', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/filterBar/controls/options.ts:30
-	__( 'all expired dates', 'event_espresso' ),
+	__('all expired dates', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/filterBar/controls/options.ts:31
-	__( 'trashed dates only', 'event_espresso' ),
+	__('trashed dates only', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/filterBar/controls/options.ts:35
 	// Reference: packages/dates/src/components/DateRangePicker/DateRangePickerLegend.tsx:9
 	// Reference: packages/dates/src/components/DateRangePicker/index.tsx:61
-	__( 'start date', 'event_espresso' ),
+	__('start date', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/filterBar/controls/options.ts:36
-	__( 'name', 'event_espresso' ),
+	__('name', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/filterBar/controls/options.ts:37
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/tableView/useHeaderRowGenerator.tsx:31
@@ -479,141 +479,141 @@ 
 	// Reference: domains/core/admin/eventEditor/src/ui/ticketAssignmentsManager/components/table/HeaderCell.tsx:27
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/tableView/useHeaderRowGenerator.tsx:31
 	// Reference: packages/tpc/src/components/table/useHeaderRowGenerator.ts:23
-	__( 'ID', 'event_espresso' ),
+	__('ID', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/filterBar/controls/options.ts:38
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/filterBar/controls/options.ts:47
-	__( 'custom order', 'event_espresso' ),
+	__('custom order', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/filterBar/controls/options.ts:42
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/filterBar/controls/options.ts:51
-	__( 'display', 'event_espresso' ),
+	__('display', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/filterBar/controls/options.ts:43
-	__( 'recurrence', 'event_espresso' ),
+	__('recurrence', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/filterBar/controls/options.ts:44
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/filterBar/controls/options.ts:53
-	__( 'sales', 'event_espresso' ),
+	__('sales', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/filterBar/controls/options.ts:45
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/filterBar/controls/options.ts:55
-	__( 'sort by', 'event_espresso' ),
+	__('sort by', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/filterBar/controls/options.ts:46
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/filterBar/controls/options.ts:54
 	// Reference: packages/ee-components/src/EntityList/EntityListFilterBar.tsx:46
-	__( 'search', 'event_espresso' ),
+	__('search', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/filterBar/controls/options.ts:47
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/filterBar/controls/options.ts:56
-	__( 'status', 'event_espresso' ),
+	__('status', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/filterBar/controls/options.ts:9
-	__( 'start dates only', 'event_espresso' ),
+	__('start dates only', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/newDateOptions/AddSingleDate.tsx:26
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/newDateOptions/NewDateModal.tsx:12
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/newDateOptions/OptionsModalButton.tsx:16
-	__( 'Add New Date', 'event_espresso' ),
+	__('Add New Date', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/newDateOptions/AddSingleDate.tsx:26
-	__( 'Add Single Date', 'event_espresso' ),
+	__('Add Single Date', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/newDateOptions/AddSingleDate.tsx:43
-	__( 'Add a single date that only occurs once', 'event_espresso' ),
+	__('Add a single date that only occurs once', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/newDateOptions/AddSingleDate.tsx:45
-	__( 'Single Date', 'event_espresso' ),
+	__('Single Date', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/tableView/useHeaderRowGenerator.tsx:106
-	__( 'Reg list', 'event_espresso' ),
+	__('Reg list', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/tableView/useHeaderRowGenerator.tsx:107
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/tableView/useHeaderRowGenerator.tsx:111
-	__( 'Regs', 'event_espresso' ),
+	__('Regs', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/tableView/useHeaderRowGenerator.tsx:122
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/tableView/useHeaderRowGenerator.tsx:126
 	// Reference: packages/tpc/src/components/table/useHeaderRowGenerator.ts:59
-	__( 'Actions', 'event_espresso' ),
+	__('Actions', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/tableView/useHeaderRowGenerator.tsx:52
-	__( 'Start', 'event_espresso' ),
+	__('Start', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/tableView/useHeaderRowGenerator.tsx:66
-	__( 'End', 'event_espresso' ),
+	__('End', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/tableView/useHeaderRowGenerator.tsx:82
-	__( 'Cap', 'event_espresso' ),
+	__('Cap', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/datetimes/datesList/tableView/useHeaderRowGenerator.tsx:94
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/tableView/useHeaderRowGenerator.tsx:98
-	__( 'Sold', 'event_espresso' ),
+	__('Sold', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/registrationForm/RegistrationForm.tsx:9
-	__( 'Registration Form', 'event_espresso' ),
+	__('Registration Form', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/ticketAssignmentsManager/components/ErrorMessage.tsx:18
-	__( 'Tickets must always have at least one date assigned to them but one or more of the tickets below does not have any. 
-Please correct the assignments for the highlighted cells.', 'event_espresso' ),
+	__('Tickets must always have at least one date assigned to them but one or more of the tickets below does not have any. 
+Please correct the assignments for the highlighted cells.', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/ticketAssignmentsManager/components/ErrorMessage.tsx:22
-	__( 'Event Dates must always have at least one Ticket assigned to them but one or more of the Event Dates below does not have any. 
-Please correct the assignments for the highlighted cells.', 'event_espresso' ),
+	__('Event Dates must always have at least one Ticket assigned to them but one or more of the Event Dates below does not have any. 
+Please correct the assignments for the highlighted cells.', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/ticketAssignmentsManager/components/ErrorMessage.tsx:32
-	__( 'Please Update Assignments', 'event_espresso' ),
+	__('Please Update Assignments', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/ticketAssignmentsManager/components/ModalContainer.tsx:26
-	__( 'There seem to be some dates/tickets which have no tickets/dates assigned. Do you want to fix them now?', 'event_espresso' ),
+	__('There seem to be some dates/tickets which have no tickets/dates assigned. Do you want to fix them now?', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/ticketAssignmentsManager/components/ModalContainer.tsx:29
 	// Reference: packages/tpc/src/hooks/useLockedTicketAction.ts:74
 	// Reference: packages/ui-components/src/Modal/ModalWithAlert.tsx:21
-	__( 'Alert!', 'event_espresso' ),
+	__('Alert!', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/ticketAssignmentsManager/components/ModalContainer.tsx:42
 	/* translators: 1 entity id, 2 entity name */
-	__( 'Ticket Assignment Manager for Datetime: %1$s - %2$s', 'event_espresso' ),
+	__('Ticket Assignment Manager for Datetime: %1$s - %2$s', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/ticketAssignmentsManager/components/ModalContainer.tsx:49
 	/* translators: 1 entity id, 2 entity name */
-	__( 'Ticket Assignment Manager for Ticket: %1$s - %2$s', 'event_espresso' ),
+	__('Ticket Assignment Manager for Ticket: %1$s - %2$s', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/ticketAssignmentsManager/components/TicketAssignmentsManagerModal.tsx:28
 	// Reference: domains/core/admin/eventEditor/src/ui/ticketAssignmentsManager/components/table/Table.tsx:13
-	__( 'Ticket Assignment Manager', 'event_espresso' ),
+	__('Ticket Assignment Manager', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/ticketAssignmentsManager/components/config.ts:10
-	__( 'existing relation', 'event_espresso' ),
+	__('existing relation', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/ticketAssignmentsManager/components/config.ts:15
-	__( 'remove existing relation', 'event_espresso' ),
+	__('remove existing relation', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/ticketAssignmentsManager/components/config.ts:20
-	__( 'add new relation', 'event_espresso' ),
+	__('add new relation', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/ticketAssignmentsManager/components/config.ts:25
-	__( 'invalid relation', 'event_espresso' ),
+	__('invalid relation', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/ticketAssignmentsManager/components/config.ts:29
-	__( 'no relation', 'event_espresso' ),
+	__('no relation', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/ticketAssignmentsManager/components/table/BodyCell.tsx:23
-	__( 'assign ticket', 'event_espresso' ),
+	__('assign ticket', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/ticketAssignmentsManager/components/table/useGetHeaderRows.tsx:15
-	__( 'Assignments', 'event_espresso' ),
+	__('Assignments', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/ticketAssignmentsManager/components/table/useGetHeaderRows.tsx:16
-	__( 'Event Dates are listed below', 'event_espresso' ),
+	__('Event Dates are listed below', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/ticketAssignmentsManager/components/table/useGetHeaderRows.tsx:17
-	__( 'Tickets are listed along the top', 'event_espresso' ),
+	__('Tickets are listed along the top', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/ticketAssignmentsManager/components/table/useGetHeaderRows.tsx:18
-	__( 'Click the cell buttons to toggle assigments', 'event_espresso' ),
+	__('Click the cell buttons to toggle assigments', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/ticketAssignmentsManager/components/useSubmitButtonProps.ts:29
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/bulkEdit/prices/buttons/FooterButtons.tsx:16
@@ -622,1316 +622,1316 @@ 
 	// Reference: packages/tpc/src/buttons/useSubmitButtonProps.tsx:29
 	// Reference: packages/ui-components/src/Modal/useSubmitButtonProps.tsx:13
 	// Reference: packages/ui-components/src/Stepper/buttons/Submit.tsx:7
-	__( 'Submit', 'event_espresso' ),
+	__('Submit', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/ticketAssignmentsManager/filters/controls/DatesByMonthControl.tsx:20
-	__( 'All Dates', 'event_espresso' ),
+	__('All Dates', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/ticketAssignmentsManager/filters/controls/DatesByMonthControl.tsx:27
-	__( 'dates by month', 'event_espresso' ),
+	__('dates by month', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/ticketAssignmentsManager/filters/controls/ShowExpiredTicketsControl.tsx:16
-	__( 'show expired tickets', 'event_espresso' ),
+	__('show expired tickets', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/ticketAssignmentsManager/filters/controls/ShowTrashedDatesControl.tsx:13
-	__( 'show trashed dates', 'event_espresso' ),
+	__('show trashed dates', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/ticketAssignmentsManager/filters/controls/ShowTrashedTicketsControl.tsx:16
-	__( 'show trashed tickets', 'event_espresso' ),
+	__('show trashed tickets', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/TicketRegistrationsLink.tsx:13
-	__( 'total registrations.', 'event_espresso' ),
+	__('total registrations.', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/TicketRegistrationsLink.tsx:14
-	__( 'view ALL registrations for this ticket.', 'event_espresso' ),
+	__('view ALL registrations for this ticket.', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/defaultTickets/Container.tsx:38
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/actions/Actions.tsx:21
-	__( 'Default tickets', 'event_espresso' ),
+	__('Default tickets', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/defaultTickets/multiStep/FooterButtons.tsx:26
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketForm/multiStep/FooterButtons.tsx:33
-	__( 'Set ticket prices', 'event_espresso' ),
+	__('Set ticket prices', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/defaultTickets/multiStep/FooterButtons.tsx:31
-	__( 'Skip prices - Save', 'event_espresso' ),
+	__('Skip prices - Save', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/defaultTickets/multiStep/FooterButtons.tsx:37
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketForm/multiStep/FooterButtons.tsx:57
-	__( 'Ticket details', 'event_espresso' ),
+	__('Ticket details', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/defaultTickets/multiStep/FooterButtons.tsx:38
-	__( 'Save', 'event_espresso' ),
+	__('Save', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/defaultTickets/multiStep/Modal.tsx:22
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketForm/multiStep/Modal.tsx:26
 	/* translators: %s ticket id */
-	__( 'Edit ticket %s', 'event_espresso' ),
+	__('Edit ticket %s', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/defaultTickets/multiStep/Modal.tsx:25
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketForm/multiStep/Modal.tsx:29
-	__( 'New Ticket Details', 'event_espresso' ),
+	__('New Ticket Details', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/defaultTickets/multiStep/TicketFormSteps.tsx:10
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketForm/multiStep/TicketFormSteps.tsx:10
-	__( 'primary information about the ticket', 'event_espresso' ),
+	__('primary information about the ticket', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/defaultTickets/multiStep/TicketFormSteps.tsx:10
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketForm/multiStep/TicketFormSteps.tsx:10
-	__( 'Ticket Details', 'event_espresso' ),
+	__('Ticket Details', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/defaultTickets/multiStep/TicketFormSteps.tsx:12
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketForm/multiStep/TicketFormSteps.tsx:12
-	__( 'apply ticket price modifiers and taxes', 'event_espresso' ),
+	__('apply ticket price modifiers and taxes', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/defaultTickets/multiStep/TicketFormSteps.tsx:14
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketForm/multiStep/TicketFormSteps.tsx:14
-	__( 'Price Calculator', 'event_espresso' ),
+	__('Price Calculator', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/defaultTickets/multiStep/TicketFormSteps.tsx:16
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketForm/multiStep/TicketFormSteps.tsx:16
-	__( 'Assign Dates', 'event_espresso' ),
+	__('Assign Dates', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketForm/multiStep/FooterButtons.tsx:39
-	__( 'Skip prices - assign dates', 'event_espresso' ),
+	__('Skip prices - assign dates', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketForm/multiStep/FooterButtons.tsx:50
-	__( 'Save and assign dates', 'event_espresso' ),
+	__('Save and assign dates', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketForm/useTicketFormConfig.ts:104
-	__( 'Ticket Sales', 'event_espresso' ),
+	__('Ticket Sales', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketForm/useTicketFormConfig.ts:130
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/bulkEdit/details/useBulkEditFormConfig.ts:112
-	__( 'Quantity For Sale', 'event_espresso' ),
+	__('Quantity For Sale', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketForm/useTicketFormConfig.ts:136
-	__( 'The maximum number of this ticket available for sale.', 'event_espresso' ),
+	__('The maximum number of this ticket available for sale.', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketForm/useTicketFormConfig.ts:138
-	__( 'Set to 0 to stop sales, or leave blank for no limit.', 'event_espresso' ),
+	__('Set to 0 to stop sales, or leave blank for no limit.', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketForm/useTicketFormConfig.ts:144
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/bulkEdit/details/useBulkEditFormConfig.ts:121
-	__( 'Number of Uses', 'event_espresso' ),
+	__('Number of Uses', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketForm/useTicketFormConfig.ts:150
-	__( 'Controls the total number of times this ticket can be used, regardless of the number of dates it is assigned to.', 'event_espresso' ),
+	__('Controls the total number of times this ticket can be used, regardless of the number of dates it is assigned to.', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketForm/useTicketFormConfig.ts:154
-	__( 'Example: A ticket might have access to 4 different dates, but setting this field to 2 would mean that the ticket could only be used twice. Leave blank for no limit.', 'event_espresso' ),
+	__('Example: A ticket might have access to 4 different dates, but setting this field to 2 would mean that the ticket could only be used twice. Leave blank for no limit.', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketForm/useTicketFormConfig.ts:162
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/bulkEdit/details/useBulkEditFormConfig.ts:129
-	__( 'Minimum Quantity', 'event_espresso' ),
+	__('Minimum Quantity', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketForm/useTicketFormConfig.ts:167
-	__( 'The minimum quantity that can be selected for this ticket. Use this to create ticket bundles or graduated pricing.', 'event_espresso' ),
+	__('The minimum quantity that can be selected for this ticket. Use this to create ticket bundles or graduated pricing.', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketForm/useTicketFormConfig.ts:171
-	__( 'Leave blank for no minimum.', 'event_espresso' ),
+	__('Leave blank for no minimum.', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketForm/useTicketFormConfig.ts:177
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/bulkEdit/details/useBulkEditFormConfig.ts:137
-	__( 'Maximum Quantity', 'event_espresso' ),
+	__('Maximum Quantity', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketForm/useTicketFormConfig.ts:183
-	__( 'The maximum quantity that can be selected for this ticket. Use this to create ticket bundles or graduated pricing.', 'event_espresso' ),
+	__('The maximum quantity that can be selected for this ticket. Use this to create ticket bundles or graduated pricing.', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketForm/useTicketFormConfig.ts:187
-	__( 'Leave blank for no maximum.', 'event_espresso' ),
+	__('Leave blank for no maximum.', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketForm/useTicketFormConfig.ts:193
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/bulkEdit/details/useBulkEditFormConfig.ts:146
-	__( 'Required Ticket', 'event_espresso' ),
+	__('Required Ticket', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketForm/useTicketFormConfig.ts:195
-	__( 'If enabled, the ticket must be selected and will appear first in frontend ticket lists.', 'event_espresso' ),
+	__('If enabled, the ticket must be selected and will appear first in frontend ticket lists.', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketForm/useTicketFormConfig.ts:209
-	__( 'Visibility', 'event_espresso' ),
+	__('Visibility', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketForm/useTicketFormConfig.ts:211
-	__( 'Where the ticket can be viewed throughout the UI.', 'event_espresso' ),
+	__('Where the ticket can be viewed throughout the UI.', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/TicketsList.tsx:36
-	__( 'Available Tickets', 'event_espresso' ),
+	__('Available Tickets', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/TicketsList.tsx:39
-	__( 'loading tickets…', 'event_espresso' ),
+	__('loading tickets…', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/actionsMenu/AssignDatesButton.tsx:26
-	__( 'Number of related dates', 'event_espresso' ),
+	__('Number of related dates', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/actionsMenu/AssignDatesButton.tsx:27
-	__( 'There are no event dates assigned to this ticket. Please click the calendar icon to update the assignments.', 'event_espresso' ),
+	__('There are no event dates assigned to this ticket. Please click the calendar icon to update the assignments.', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/actionsMenu/AssignDatesButton.tsx:37
-	__( 'assign dates', 'event_espresso' ),
+	__('assign dates', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/actionsMenu/dropdown/DeleteTicket.tsx:18
-	__( 'Permanently delete Ticket?', 'event_espresso' ),
+	__('Permanently delete Ticket?', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/actionsMenu/dropdown/DeleteTicket.tsx:18
-	__( 'Move Ticket to Trash?', 'event_espresso' ),
+	__('Move Ticket to Trash?', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/actionsMenu/dropdown/DeleteTicket.tsx:21
-	__( 'Are you sure you want to permanently delete this ticket? This action is permanent and can not be undone.', 'event_espresso' ),
+	__('Are you sure you want to permanently delete this ticket? This action is permanent and can not be undone.', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/actionsMenu/dropdown/DeleteTicket.tsx:22
-	__( 'Are you sure you want to move this ticket to the trash? You can "untrash" this ticket later if you need to.', 'event_espresso' ),
+	__('Are you sure you want to move this ticket to the trash? You can "untrash" this ticket later if you need to.', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/actionsMenu/dropdown/DeleteTicket.tsx:44
 	// Reference: packages/ee-components/src/SimpleTicketCard/actions/Trash.tsx:6
-	__( 'trash ticket', 'event_espresso' ),
+	__('trash ticket', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/actionsMenu/dropdown/TicketMainMenu.tsx:25
-	__( 'ticket main menu', 'event_espresso' ),
+	__('ticket main menu', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/actionsMenu/dropdown/TicketMainMenu.tsx:38
 	// Reference: packages/ee-components/src/SimpleTicketCard/actions/Edit.tsx:15
-	__( 'edit ticket', 'event_espresso' ),
+	__('edit ticket', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/actionsMenu/dropdown/TicketMainMenu.tsx:39
-	__( 'copy ticket', 'event_espresso' ),
+	__('copy ticket', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/bulkEdit/actions/Actions.tsx:43
-	__( 'edit ticket details', 'event_espresso' ),
+	__('edit ticket details', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/bulkEdit/actions/Actions.tsx:47
-	__( 'delete tickets', 'event_espresso' ),
+	__('delete tickets', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/bulkEdit/actions/Actions.tsx:47
-	__( 'trash tickets', 'event_espresso' ),
+	__('trash tickets', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/bulkEdit/actions/Actions.tsx:51
-	__( 'edit ticket prices', 'event_espresso' ),
+	__('edit ticket prices', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/bulkEdit/delete/Delete.tsx:14
-	__( 'Are you sure you want to permanently delete these tickets? This action can NOT be undone!', 'event_espresso' ),
+	__('Are you sure you want to permanently delete these tickets? This action can NOT be undone!', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/bulkEdit/delete/Delete.tsx:15
-	__( 'Are you sure you want to trash these tickets?', 'event_espresso' ),
+	__('Are you sure you want to trash these tickets?', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/bulkEdit/delete/Delete.tsx:16
-	__( 'Delete tickets permanently', 'event_espresso' ),
+	__('Delete tickets permanently', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/bulkEdit/delete/Delete.tsx:16
-	__( 'Trash tickets', 'event_espresso' ),
+	__('Trash tickets', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/bulkEdit/details/EditDetails.tsx:21
-	__( 'Bulk edit ticket details', 'event_espresso' ),
+	__('Bulk edit ticket details', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/bulkEdit/details/EditDetails.tsx:22
-	__( 'any changes will be applied to ALL of the selected tickets.', 'event_espresso' ),
+	__('any changes will be applied to ALL of the selected tickets.', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/bulkEdit/prices/EditPrices.tsx:19
-	__( 'Bulk edit ticket prices', 'event_espresso' ),
+	__('Bulk edit ticket prices', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/bulkEdit/prices/buttons/EditModeButtons.tsx:20
-	__( 'Edit all prices together', 'event_espresso' ),
+	__('Edit all prices together', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/bulkEdit/prices/buttons/EditModeButtons.tsx:21
-	__( 'Edit all the selected ticket prices dynamically', 'event_espresso' ),
+	__('Edit all the selected ticket prices dynamically', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/bulkEdit/prices/buttons/EditModeButtons.tsx:25
-	__( 'Edit prices individually', 'event_espresso' ),
+	__('Edit prices individually', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/bulkEdit/prices/buttons/EditModeButtons.tsx:26
-	__( 'Edit prices for each ticket individually', 'event_espresso' ),
+	__('Edit prices for each ticket individually', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/bulkEdit/prices/buttons/FooterButtons.tsx:14
 	// Reference: packages/ee-components/src/bulkEdit/details/Submit.tsx:34
 	// Reference: packages/form/src/ResetButton.tsx:18
 	// Reference: packages/tpc/src/buttons/useResetButtonProps.tsx:12
-	__( 'Reset', 'event_espresso' ),
+	__('Reset', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/bulkEdit/prices/buttons/FooterButtons.tsx:15
 	// Reference: packages/tpc/src/hooks/useLockedTicketAction.ts:76
 	// Reference: packages/ui-components/src/Modal/useCancelButtonProps.tsx:10
-	__( 'Cancel', 'event_espresso' ),
+	__('Cancel', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/bulkEdit/prices/editSeparately/TPCInstance.tsx:26
 	/* translators: %s ticket name */
-	__( 'Edit prices for Ticket: %s', 'event_espresso' ),
+	__('Edit prices for Ticket: %s', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/cardView/TicketCardSidebar.tsx:37
-	__( 'Edit Ticket Sale Dates', 'event_espresso' ),
+	__('Edit Ticket Sale Dates', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/cardView/TicketCardSidebar.tsx:41
-	__( 'edit ticket sales start and end dates', 'event_espresso' ),
+	__('edit ticket sales start and end dates', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/cardView/TicketDetailsPanel.tsx:28
-	__( 'quantity', 'event_espresso' ),
+	__('quantity', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/cardView/TicketQuantity.tsx:27
-	__( 'edit quantity of tickets available…', 'event_espresso' ),
+	__('edit quantity of tickets available…', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/config.ts:10
-	__( 'Move Ticket to Trash', 'event_espresso' ),
+	__('Move Ticket to Trash', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/config.ts:15
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/tableView/useHeaderRowGenerator.tsx:52
-	__( 'On Sale', 'event_espresso' ),
+	__('On Sale', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/config.ts:17
-	__( 'Pending', 'event_espresso' ),
+	__('Pending', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/config.ts:7
-	__( 'Edit Ticket Details', 'event_espresso' ),
+	__('Edit Ticket Details', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/config.ts:8
-	__( 'Manage Date Assignments', 'event_espresso' ),
+	__('Manage Date Assignments', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/config.ts:9
 	// Reference: packages/tpc/src/components/table/Table.tsx:43
-	__( 'Ticket Price Calculator', 'event_espresso' ),
+	__('Ticket Price Calculator', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/editable/EditablePrice.tsx:39
-	__( 'edit ticket total…', 'event_espresso' ),
+	__('edit ticket total…', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/editable/EditablePrice.tsx:53
-	__( 'set price…', 'event_espresso' ),
+	__('set price…', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/filterBar/controls/IsChainedButton.tsx:23
-	__( 'tickets list is linked to dates list and is showing tickets for above dates only', 'event_espresso' ),
+	__('tickets list is linked to dates list and is showing tickets for above dates only', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/filterBar/controls/IsChainedButton.tsx:24
-	__( 'tickets list is unlinked and is showing tickets for all event dates', 'event_espresso' ),
+	__('tickets list is unlinked and is showing tickets for all event dates', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/filterBar/controls/options.ts:10
-	__( 'ticket sales start and end dates', 'event_espresso' ),
+	__('ticket sales start and end dates', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/filterBar/controls/options.ts:15
-	__( 'tickets with 90% or more sold', 'event_espresso' ),
+	__('tickets with 90% or more sold', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/filterBar/controls/options.ts:16
-	__( 'tickets with 75% or more sold', 'event_espresso' ),
+	__('tickets with 75% or more sold', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/filterBar/controls/options.ts:17
-	__( 'tickets with 50% or more sold', 'event_espresso' ),
+	__('tickets with 50% or more sold', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/filterBar/controls/options.ts:19
-	__( 'tickets with less than 50% sold', 'event_espresso' ),
+	__('tickets with less than 50% sold', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/filterBar/controls/options.ts:28
-	__( 'all tickets for all dates', 'event_espresso' ),
+	__('all tickets for all dates', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/filterBar/controls/options.ts:29
-	__( 'all on sale and sale pending', 'event_espresso' ),
+	__('all on sale and sale pending', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/filterBar/controls/options.ts:30
-	__( 'on sale tickets only', 'event_espresso' ),
+	__('on sale tickets only', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/filterBar/controls/options.ts:31
-	__( 'sale pending tickets only', 'event_espresso' ),
+	__('sale pending tickets only', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/filterBar/controls/options.ts:32
-	__( 'next on sale or sale pending only', 'event_espresso' ),
+	__('next on sale or sale pending only', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/filterBar/controls/options.ts:33
-	__( 'sold out tickets only', 'event_espresso' ),
+	__('sold out tickets only', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/filterBar/controls/options.ts:34
-	__( 'expired tickets only', 'event_espresso' ),
+	__('expired tickets only', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/filterBar/controls/options.ts:35
-	__( 'trashed tickets only', 'event_espresso' ),
+	__('trashed tickets only', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/filterBar/controls/options.ts:40
-	__( 'all tickets for above dates', 'event_espresso' ),
+	__('all tickets for above dates', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/filterBar/controls/options.ts:44
-	__( 'ticket sale date', 'event_espresso' ),
+	__('ticket sale date', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/filterBar/controls/options.ts:45
-	__( 'ticket name', 'event_espresso' ),
+	__('ticket name', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/filterBar/controls/options.ts:46
-	__( 'ticket ID', 'event_espresso' ),
+	__('ticket ID', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/filterBar/controls/options.ts:52
-	__( 'link', 'event_espresso' ),
+	__('link', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/filterBar/controls/options.ts:8
-	__( 'ticket sales start date only', 'event_espresso' ),
+	__('ticket sales start date only', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/filterBar/controls/options.ts:9
-	__( 'ticket sales end date only', 'event_espresso' ),
+	__('ticket sales end date only', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/newTicketOptions/AddSingleTicket.tsx:18
-	__( 'Add New Ticket', 'event_espresso' ),
+	__('Add New Ticket', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/newTicketOptions/AddSingleTicket.tsx:32
-	__( 'Add a single ticket and assign the dates to it', 'event_espresso' ),
+	__('Add a single ticket and assign the dates to it', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/newTicketOptions/AddSingleTicket.tsx:34
-	__( 'Single Ticket', 'event_espresso' ),
+	__('Single Ticket', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/tableView/TableView.tsx:39
-	__( 'Tickets', 'event_espresso' ),
+	__('Tickets', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/tableView/useHeaderRowGenerator.tsx:110
-	__( 'Registrations', 'event_espresso' ),
+	__('Registrations', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/tableView/useHeaderRowGenerator.tsx:51
-	__( 'Goes on Sale', 'event_espresso' ),
+	__('Goes on Sale', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/tableView/useHeaderRowGenerator.tsx:65
-	__( 'Sale Ends', 'event_espresso' ),
+	__('Sale Ends', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/tableView/useHeaderRowGenerator.tsx:66
-	__( 'Ends', 'event_espresso' ),
+	__('Ends', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/tableView/useHeaderRowGenerator.tsx:78
-	__( 'Price', 'event_espresso' ),
+	__('Price', 'event_espresso'),
 
 	// Reference: domains/core/admin/eventEditor/src/ui/tickets/ticketsList/tableView/useHeaderRowGenerator.tsx:88
-	__( 'Quantity', 'event_espresso' ),
+	__('Quantity', 'event_espresso'),
 
 	// Reference: domains/core/admin/wpPluginsPage/src/exitSurvey/Popup.tsx:29
-	__( 'Do you have a moment to share why you are deactivating Event Espresso?', 'event_espresso' ),
+	__('Do you have a moment to share why you are deactivating Event Espresso?', 'event_espresso'),
 
 	// Reference: domains/core/admin/wpPluginsPage/src/exitSurvey/Popup.tsx:40
-	__( 'Skip', 'event_espresso' ),
+	__('Skip', 'event_espresso'),
 
 	// Reference: domains/core/admin/wpPluginsPage/src/exitSurvey/Popup.tsx:42
-	__( 'Sure I\'ll help', 'event_espresso' ),
+	__('Sure I\'ll help', 'event_espresso'),
 
 	// Reference: packages/adapters/src/Pagination/Pagination.tsx:23
-	__( 'pagination', 'event_espresso' ),
+	__('pagination', 'event_espresso'),
 
 	// Reference: packages/adapters/src/TagSelector/TagSelector.tsx:112
-	__( 'toggle menu', 'event_espresso' ),
+	__('toggle menu', 'event_espresso'),
 
 	// Reference: packages/constants/src/datetime.ts:10
-	__( 'Postponed', 'event_espresso' ),
+	__('Postponed', 'event_espresso'),
 
 	// Reference: packages/constants/src/datetime.ts:11
-	__( 'SoldOut', 'event_espresso' ),
+	__('SoldOut', 'event_espresso'),
 
 	// Reference: packages/constants/src/datetime.ts:7
 	// Reference: packages/predicates/src/registration/statusOptions.ts:10
-	__( 'Cancelled', 'event_espresso' ),
+	__('Cancelled', 'event_espresso'),
 
 	// Reference: packages/constants/src/datetime.ts:9
-	__( 'Inactive', 'event_espresso' ),
+	__('Inactive', 'event_espresso'),
 
 	// Reference: packages/dates/src/components/DateRangePicker/DateRangePickerLegend.tsx:13
-	__( 'day in range', 'event_espresso' ),
+	__('day in range', 'event_espresso'),
 
 	// Reference: packages/dates/src/components/DateRangePicker/DateRangePickerLegend.tsx:17
 	// Reference: packages/dates/src/components/DateRangePicker/index.tsx:79
-	__( 'end date', 'event_espresso' ),
+	__('end date', 'event_espresso'),
 
 	// Reference: packages/dates/src/components/DateTimePicker.tsx:13
 	// Reference: packages/dates/src/components/TimePicker.tsx:14
-	__( 'time', 'event_espresso' ),
+	__('time', 'event_espresso'),
 
 	// Reference: packages/dates/src/constants.ts:5
-	__( 'End Date & Time must be set later than the Start Date & Time', 'event_espresso' ),
+	__('End Date & Time must be set later than the Start Date & Time', 'event_espresso'),
 
 	// Reference: packages/dates/src/constants.ts:7
-	__( 'Start Date & Time must be set before the End Date & Time', 'event_espresso' ),
+	__('Start Date & Time must be set before the End Date & Time', 'event_espresso'),
 
 	// Reference: packages/dates/src/utils/misc.ts:15
-	__( 'month(s)', 'event_espresso' ),
+	__('month(s)', 'event_espresso'),
 
 	// Reference: packages/dates/src/utils/misc.ts:16
-	__( 'week(s)', 'event_espresso' ),
+	__('week(s)', 'event_espresso'),
 
 	// Reference: packages/dates/src/utils/misc.ts:17
-	__( 'day(s)', 'event_espresso' ),
+	__('day(s)', 'event_espresso'),
 
 	// Reference: packages/dates/src/utils/misc.ts:18
-	__( 'hour(s)', 'event_espresso' ),
+	__('hour(s)', 'event_espresso'),
 
 	// Reference: packages/dates/src/utils/misc.ts:19
-	__( 'minute(s)', 'event_espresso' ),
+	__('minute(s)', 'event_espresso'),
 
 	// Reference: packages/edtr-services/src/apollo/initialization/useCacheRehydration.ts:105
-	__( 'datetimes initialized', 'event_espresso' ),
+	__('datetimes initialized', 'event_espresso'),
 
 	// Reference: packages/edtr-services/src/apollo/initialization/useCacheRehydration.ts:115
-	__( 'tickets initialized', 'event_espresso' ),
+	__('tickets initialized', 'event_espresso'),
 
 	// Reference: packages/edtr-services/src/apollo/initialization/useCacheRehydration.ts:125
-	__( 'prices initialized', 'event_espresso' ),
+	__('prices initialized', 'event_espresso'),
 
 	// Reference: packages/edtr-services/src/apollo/initialization/useCacheRehydration.ts:95
-	__( 'price types initialized', 'event_espresso' ),
+	__('price types initialized', 'event_espresso'),
 
 	// Reference: packages/edtr-services/src/apollo/mutations/useReorderEntities.ts:72
-	__( 'reordering has been applied', 'event_espresso' ),
+	__('reordering has been applied', 'event_espresso'),
 
 	// Reference: packages/edtr-services/src/utils/dateAndTime.ts:38
 	// Reference: packages/ui-components/src/EditDateRangeButton/EditDateRangeButton.tsx:39
-	__( 'End date has been adjusted', 'event_espresso' ),
+	__('End date has been adjusted', 'event_espresso'),
 
 	// Reference: packages/edtr-services/src/utils/dateAndTime.ts:59
-	__( 'Required', 'event_espresso' ),
+	__('Required', 'event_espresso'),
 
 	// Reference: packages/edtr-services/src/utils/dateAndTime.ts:64
-	__( 'Start Date is required', 'event_espresso' ),
+	__('Start Date is required', 'event_espresso'),
 
 	// Reference: packages/edtr-services/src/utils/dateAndTime.ts:68
-	__( 'End Date is required', 'event_espresso' ),
+	__('End Date is required', 'event_espresso'),
 
 	// Reference: packages/ee-components/src/EntityList/EntityList.tsx:31
-	__( 'no results found', 'event_espresso' ),
+	__('no results found', 'event_espresso'),
 
 	// Reference: packages/ee-components/src/EntityList/EntityList.tsx:32
-	__( 'try changing filter settings', 'event_espresso' ),
+	__('try changing filter settings', 'event_espresso'),
 
 	// Reference: packages/ee-components/src/SimpleTicketCard/SimpleTicketCard.tsx:27
 	// Reference: packages/ui-components/src/CalendarDateSwitcher/CalendarDateSwitcher.tsx:34
-	__( 'starts', 'event_espresso' ),
+	__('starts', 'event_espresso'),
 
 	// Reference: packages/ee-components/src/SimpleTicketCard/SimpleTicketCard.tsx:34
 	// Reference: packages/ui-components/src/CalendarDateSwitcher/CalendarDateSwitcher.tsx:47
-	__( 'ends', 'event_espresso' ),
+	__('ends', 'event_espresso'),
 
 	// Reference: packages/ee-components/src/bulkEdit/ActionCheckbox.tsx:38
 	/* translators: %d entity id */
-	__( 'select entity with id %d', 'event_espresso' ),
+	__('select entity with id %d', 'event_espresso'),
 
 	// Reference: packages/ee-components/src/bulkEdit/ActionCheckbox.tsx:41
-	__( 'select all entities', 'event_espresso' ),
+	__('select all entities', 'event_espresso'),
 
 	// Reference: packages/ee-components/src/bulkEdit/details/BulkEditDetails.tsx:20
-	__( 'Note: ', 'event_espresso' ),
+	__('Note: ', 'event_espresso'),
 
 	// Reference: packages/ee-components/src/bulkEdit/details/BulkEditDetails.tsx:20
-	__( 'any changes will be applied to ALL of the selected entities.', 'event_espresso' ),
+	__('any changes will be applied to ALL of the selected entities.', 'event_espresso'),
 
 	// Reference: packages/ee-components/src/bulkEdit/details/BulkEditDetails.tsx:26
-	__( 'Bulk edit details', 'event_espresso' ),
+	__('Bulk edit details', 'event_espresso'),
 
 	// Reference: packages/ee-components/src/bulkEdit/details/Submit.tsx:17
-	__( 'Are you sure you want to bulk update the details?', 'event_espresso' ),
+	__('Are you sure you want to bulk update the details?', 'event_espresso'),
 
 	// Reference: packages/ee-components/src/bulkEdit/details/Submit.tsx:18
-	__( 'Bulk update details', 'event_espresso' ),
+	__('Bulk update details', 'event_espresso'),
 
 	// Reference: packages/ee-components/src/filterBar/SortByControl/index.tsx:26
-	__( 'reorder dates', 'event_espresso' ),
+	__('reorder dates', 'event_espresso'),
 
 	// Reference: packages/ee-components/src/filterBar/SortByControl/index.tsx:26
-	__( 'reorder tickets', 'event_espresso' ),
+	__('reorder tickets', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/FormElement/FormElementToolbar.tsx:32
-	__( 'delete form element', 'event_espresso' ),
+	__('delete form element', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/FormElement/FormElementToolbar.tsx:49
-	__( 'form element settings', 'event_espresso' ),
+	__('form element settings', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/FormElement/FormElementToolbar.tsx:59
-	__( 'copy form element', 'event_espresso' ),
+	__('copy form element', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/FormElement/FormElementToolbar.tsx:69
-	__( 'click, hold, and drag to reorder form element', 'event_espresso' ),
+	__('click, hold, and drag to reorder form element', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/FormElement/Tabs/FieldOption.tsx:20
-	__( 'remove option', 'event_espresso' ),
+	__('remove option', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/FormElement/Tabs/FieldOption.tsx:42
-	__( 'value', 'event_espresso' ),
+	__('value', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/FormElement/Tabs/FieldOption.tsx:52
-	__( 'label', 'event_espresso' ),
+	__('label', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/FormElement/Tabs/FieldOption.tsx:63
-	__( 'click, hold, and drag to reorder field option', 'event_espresso' ),
+	__('click, hold, and drag to reorder field option', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/FormElement/Tabs/FieldOptions.tsx:61
-	__( 'Options are the choices you give people to select from.', 'event_espresso' ),
+	__('Options are the choices you give people to select from.', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/FormElement/Tabs/FieldOptions.tsx:63
-	__( 'The value is a simple key that will be saved to the database and the label is what is shown to the user.', 'event_espresso' ),
+	__('The value is a simple key that will be saved to the database and the label is what is shown to the user.', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/FormElement/Tabs/FieldOptions.tsx:96
-	__( 'add new option', 'event_espresso' ),
+	__('add new option', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/FormElement/Tabs/FormElementTabs.tsx:22
 	// Reference: packages/form-builder/src/FormSection/Tabs/FormSectionTabs.tsx:21
-	__( 'Settings', 'event_espresso' ),
+	__('Settings', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/FormElement/Tabs/FormElementTabs.tsx:26
 	// Reference: packages/form-builder/src/FormSection/Tabs/FormSectionTabs.tsx:25
-	__( 'Styles', 'event_espresso' ),
+	__('Styles', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/FormElement/Tabs/FormElementTabs.tsx:30
-	__( 'Validation', 'event_espresso' ),
+	__('Validation', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/FormElement/Tabs/FormElementTabs.tsx:34
 	// Reference: packages/form-builder/src/FormSection/Tabs/FormSectionTabs.tsx:29
-	__( 'Rules', 'event_espresso' ),
+	__('Rules', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/FormElement/Tabs/Settings.tsx:18
 	// Reference: packages/form-builder/src/FormSection/Tabs/Settings.tsx:19
-	__( 'admin label', 'event_espresso' ),
+	__('admin label', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/FormElement/Tabs/Settings.tsx:23
-	__( 'admin only', 'event_espresso' ),
+	__('admin only', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/FormElement/Tabs/Settings.tsx:30
-	__( 'content', 'event_espresso' ),
+	__('content', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/FormElement/Tabs/Settings.tsx:39
 	// Reference: packages/form-builder/src/FormSection/Tabs/Settings.tsx:14
-	__( 'public label', 'event_espresso' ),
+	__('public label', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/FormElement/Tabs/Settings.tsx:44
-	__( 'options', 'event_espresso' ),
+	__('options', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/FormElement/Tabs/Settings.tsx:47
-	__( 'placeholder', 'event_espresso' ),
+	__('placeholder', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/FormElement/Tabs/Settings.tsx:52
-	__( 'help text', 'event_espresso' ),
+	__('help text', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/FormElement/Tabs/Styles.tsx:14
 	// Reference: packages/form-builder/src/FormSection/Tabs/Styles.tsx:13
-	__( 'css class', 'event_espresso' ),
+	__('css class', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/FormElement/Tabs/Styles.tsx:19
-	__( 'help text css class', 'event_espresso' ),
+	__('help text css class', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/FormElement/Tabs/Validation.tsx:16
-	__( 'required', 'event_espresso' ),
+	__('required', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/FormElement/Tabs/Validation.tsx:21
-	__( 'required text', 'event_espresso' ),
+	__('required text', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/FormElement/Tabs/Validation.tsx:28
-	__( 'min', 'event_espresso' ),
+	__('min', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/FormElement/Tabs/Validation.tsx:33
-	__( 'max', 'event_espresso' ),
+	__('max', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/FormSection/AddFormElementPopover.tsx:110
-	__( 'add new form element', 'event_espresso' ),
+	__('add new form element', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/FormSection/AddFormElementPopover.tsx:117
 	// Reference: packages/form/src/renderers/RepeatableRenderer.tsx:52
 	// Reference: packages/ui-components/src/SimpleEntityList/EntityTemplate.tsx:27
-	__( 'Add', 'event_espresso' ),
+	__('Add', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/FormSection/AddFormElementPopover.tsx:76
-	__( 'Add Form Element', 'event_espresso' ),
+	__('Add Form Element', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/FormSection/AddFormElementPopover.tsx:85
-	__( 'form element order can be changed after adding by using the drag handles in the form element toolbar', 'event_espresso' ),
+	__('form element order can be changed after adding by using the drag handles in the form element toolbar', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/FormSection/AddFormElementPopover.tsx:92
-	__( 'load existing form section', 'event_espresso' ),
+	__('load existing form section', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/FormSection/FormSectionToolbar.tsx:32
-	__( 'delete form section', 'event_espresso' ),
+	__('delete form section', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/FormSection/FormSectionToolbar.tsx:47
-	__( 'form section settings', 'event_espresso' ),
+	__('form section settings', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/FormSection/FormSectionToolbar.tsx:57
-	__( 'copy form section', 'event_espresso' ),
+	__('copy form section', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/FormSection/FormSectionToolbar.tsx:74
-	__( 'click, hold, and drag to reorder form section', 'event_espresso' ),
+	__('click, hold, and drag to reorder form section', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/FormSection/FormSections.tsx:26
-	__( 'Add Form Section', 'event_espresso' ),
+	__('Add Form Section', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/FormSection/SaveSection.tsx:43
-	__( 'save form section for use in other forms', 'event_espresso' ),
+	__('save form section for use in other forms', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/FormSection/SaveSection.tsx:47
-	__( 'save as', 'event_espresso' ),
+	__('save as', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/FormSection/SaveSection.tsx:51
-	__( 'default', 'event_espresso' ),
+	__('default', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/FormSection/SaveSection.tsx:54
-	__( ' a copy of this form section will be automatically added to ALL new events', 'event_espresso' ),
+	__(' a copy of this form section will be automatically added to ALL new events', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/FormSection/SaveSection.tsx:57
-	__( 'shared', 'event_espresso' ),
+	__('shared', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/FormSection/SaveSection.tsx:60
-	__( 'a copy of this form section will be saved for use in other events but not loaded by default', 'event_espresso' ),
+	__('a copy of this form section will be saved for use in other events but not loaded by default', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/FormSection/Tabs/Settings.tsx:24
-	__( 'show label', 'event_espresso' ),
+	__('show label', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/constants.ts:100
-	__( 'Time', 'event_espresso' ),
+	__('Time', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/constants.ts:102
-	__( 'adds a text input that allows users to enter a time directly via keyboard or a timepicker', 'event_espresso' ),
+	__('adds a text input that allows users to enter a time directly via keyboard or a timepicker', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/constants.ts:105
-	__( 'Week', 'event_espresso' ),
+	__('Week', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/constants.ts:107
-	__( 'adds a text input that allows users to enter a week and year directly via keyboard or a datepicker', 'event_espresso' ),
+	__('adds a text input that allows users to enter a week and year directly via keyboard or a datepicker', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/constants.ts:110
-	__( 'Day Selector', 'event_espresso' ),
+	__('Day Selector', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/constants.ts:112
-	__( 'adds a dropdown selector that allows users to select the day of the month (01 to 31)', 'event_espresso' ),
+	__('adds a dropdown selector that allows users to select the day of the month (01 to 31)', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/constants.ts:115
-	__( 'Month Selector', 'event_espresso' ),
+	__('Month Selector', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/constants.ts:117
-	__( 'adds a dropdown selector that allows users to select the month of the year (01 to 12)', 'event_espresso' ),
+	__('adds a dropdown selector that allows users to select the month of the year (01 to 12)', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/constants.ts:120
-	__( 'Year Selector', 'event_espresso' ),
+	__('Year Selector', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/constants.ts:122
-	__( 'adds a dropdown selector that allows users to select the year from a configurable range', 'event_espresso' ),
+	__('adds a dropdown selector that allows users to select the year from a configurable range', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/constants.ts:125
-	__( 'Radio Buttons', 'event_espresso' ),
+	__('Radio Buttons', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/constants.ts:127
-	__( 'adds one or more radio buttons that allow users to only select one option from those provided', 'event_espresso' ),
+	__('adds one or more radio buttons that allow users to only select one option from those provided', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/constants.ts:130
-	__( 'Decimal Number', 'event_espresso' ),
+	__('Decimal Number', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/constants.ts:132
-	__( 'adds a text input that only accepts numbers whose value is a decimal (float)', 'event_espresso' ),
+	__('adds a text input that only accepts numbers whose value is a decimal (float)', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/constants.ts:135
-	__( 'Whole Number', 'event_espresso' ),
+	__('Whole Number', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/constants.ts:137
-	__( 'adds a text input that only accepts numbers whose value is an integer (whole number)', 'event_espresso' ),
+	__('adds a text input that only accepts numbers whose value is an integer (whole number)', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/constants.ts:140
-	__( 'Number Range', 'event_espresso' ),
+	__('Number Range', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/constants.ts:145
-	__( 'Phone Number', 'event_espresso' ),
+	__('Phone Number', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/constants.ts:150
-	__( 'Dropdown', 'event_espresso' ),
+	__('Dropdown', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/constants.ts:152
-	__( 'adds a dropdown selector that accepts a single value', 'event_espresso' ),
+	__('adds a dropdown selector that accepts a single value', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/constants.ts:155
-	__( 'Multi Select', 'event_espresso' ),
+	__('Multi Select', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/constants.ts:157
-	__( 'adds a dropdown selector that accepts multiple values', 'event_espresso' ),
+	__('adds a dropdown selector that accepts multiple values', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/constants.ts:160
-	__( 'Toggle/Switch', 'event_espresso' ),
+	__('Toggle/Switch', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/constants.ts:162
-	__( 'adds a toggle or a switch to accept true or false value', 'event_espresso' ),
+	__('adds a toggle or a switch to accept true or false value', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/constants.ts:165
-	__( 'Multi Checkbox', 'event_espresso' ),
+	__('Multi Checkbox', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/constants.ts:167
-	__( 'adds checkboxes that allow users to select zero or more options from those provided', 'event_espresso' ),
+	__('adds checkboxes that allow users to select zero or more options from those provided', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/constants.ts:170
-	__( 'Country Selector', 'event_espresso' ),
+	__('Country Selector', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/constants.ts:172
-	__( 'adds a dropdown selector populated with names of countries that are enabled for the site', 'event_espresso' ),
+	__('adds a dropdown selector populated with names of countries that are enabled for the site', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/constants.ts:175
-	__( 'State Selector', 'event_espresso' ),
+	__('State Selector', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/constants.ts:180
-	__( 'Button', 'event_espresso' ),
+	__('Button', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/constants.ts:182
-	__( 'adds a button to the form that can be used for triggering fucntionality (requires custom coding)', 'event_espresso' ),
+	__('adds a button to the form that can be used for triggering fucntionality (requires custom coding)', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/constants.ts:185
-	__( 'Reset Button', 'event_espresso' ),
+	__('Reset Button', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/constants.ts:187
-	__( 'adds a button that will reset the form back to its orginial state.', 'event_espresso' ),
+	__('adds a button that will reset the form back to its orginial state.', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/constants.ts:38
-	__( 'Form Section', 'event_espresso' ),
+	__('Form Section', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/constants.ts:40
-	__( 'Used for creating logical groupings for questions and form elements. Need to add a heading or description? Use the HTML form element.', 'event_espresso' ),
+	__('Used for creating logical groupings for questions and form elements. Need to add a heading or description? Use the HTML form element.', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/constants.ts:45
-	__( 'HTML Block', 'event_espresso' ),
+	__('HTML Block', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/constants.ts:47
-	__( 'allows you to add HTML like headings or text paragraphs to your form', 'event_espresso' ),
+	__('allows you to add HTML like headings or text paragraphs to your form', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/constants.ts:50
-	__( 'Text Input', 'event_espresso' ),
+	__('Text Input', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/constants.ts:52
-	__( 'adds a text input that only accepts plain text', 'event_espresso' ),
+	__('adds a text input that only accepts plain text', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/constants.ts:55
-	__( 'Plain Text Area', 'event_espresso' ),
+	__('Plain Text Area', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/constants.ts:57
-	__( 'adds a textarea block that only accepts plain text', 'event_espresso' ),
+	__('adds a textarea block that only accepts plain text', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/constants.ts:60
-	__( 'HTML Text Area', 'event_espresso' ),
+	__('HTML Text Area', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/constants.ts:62
-	__( 'adds a textarea block that accepts text including simple HTML markup', 'event_espresso' ),
+	__('adds a textarea block that accepts text including simple HTML markup', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/constants.ts:65
-	__( 'Email Address', 'event_espresso' ),
+	__('Email Address', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/constants.ts:67
-	__( 'adds a text input that only accets a valid email address', 'event_espresso' ),
+	__('adds a text input that only accets a valid email address', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/constants.ts:70
-	__( 'Email Confirmation', 'event_espresso' ),
+	__('Email Confirmation', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/constants.ts:75
-	__( 'Password', 'event_espresso' ),
+	__('Password', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/constants.ts:77
-	__( 'adds a text input that accepts text but masks what the user enters', 'event_espresso' ),
+	__('adds a text input that accepts text but masks what the user enters', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/constants.ts:80
-	__( 'URL', 'event_espresso' ),
+	__('URL', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/constants.ts:82
-	__( 'adds a text input for entering a URL address', 'event_espresso' ),
+	__('adds a text input for entering a URL address', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/constants.ts:85
-	__( 'Date', 'event_espresso' ),
+	__('Date', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/constants.ts:87
-	__( 'adds a text input that allows users to enter a date directly via keyboard or a datepicker', 'event_espresso' ),
+	__('adds a text input that allows users to enter a date directly via keyboard or a datepicker', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/constants.ts:90
-	__( 'Local Date', 'event_espresso' ),
+	__('Local Date', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/constants.ts:95
-	__( 'Month', 'event_espresso' ),
+	__('Month', 'event_espresso'),
 
 	// Reference: packages/form-builder/src/constants.ts:97
-	__( 'adds a text input that allows users to enter a month and year directly via keyboard or a datepicker', 'event_espresso' ),
+	__('adds a text input that allows users to enter a month and year directly via keyboard or a datepicker', 'event_espresso'),
 
 	// Reference: packages/form/src/adapters/WPMediaImage.tsx:12
-	__( 'Select Image', 'event_espresso' ),
+	__('Select Image', 'event_espresso'),
 
 	// Reference: packages/form/src/adapters/WPMediaImage.tsx:44
 	// Reference: packages/rich-text-editor/src/components/AdvancedTextEditor/toolbarButtons/WPMedia.tsx:11
 	// Reference: packages/rich-text-editor/src/rte-old/components/toolbarButtons/WPMedia.tsx:12
-	__( 'Select', 'event_espresso' ),
+	__('Select', 'event_espresso'),
 
 	// Reference: packages/form/src/renderers/RepeatableRenderer.tsx:36
 	/* translators: %d the entry number */
-	__( 'Entry %d', 'event_espresso' ),
+	__('Entry %d', 'event_espresso'),
 
 	// Reference: packages/helpers/src/datetimes/getStatusTextLabel.ts:11
 	// Reference: packages/helpers/src/tickets/getStatusTextLabel.ts:17
-	__( 'sold out', 'event_espresso' ),
+	__('sold out', 'event_espresso'),
 
 	// Reference: packages/helpers/src/datetimes/getStatusTextLabel.ts:14
 	// Reference: packages/helpers/src/tickets/getStatusTextLabel.ts:14
-	__( 'expired', 'event_espresso' ),
+	__('expired', 'event_espresso'),
 
 	// Reference: packages/helpers/src/datetimes/getStatusTextLabel.ts:17
-	__( 'upcoming', 'event_espresso' ),
+	__('upcoming', 'event_espresso'),
 
 	// Reference: packages/helpers/src/datetimes/getStatusTextLabel.ts:20
-	__( 'active', 'event_espresso' ),
+	__('active', 'event_espresso'),
 
 	// Reference: packages/helpers/src/datetimes/getStatusTextLabel.ts:23
 	// Reference: packages/helpers/src/tickets/getStatusTextLabel.ts:11
-	__( 'trashed', 'event_espresso' ),
+	__('trashed', 'event_espresso'),
 
 	// Reference: packages/helpers/src/datetimes/getStatusTextLabel.ts:26
-	__( 'cancelled', 'event_espresso' ),
+	__('cancelled', 'event_espresso'),
 
 	// Reference: packages/helpers/src/datetimes/getStatusTextLabel.ts:29
-	__( 'postponed', 'event_espresso' ),
+	__('postponed', 'event_espresso'),
 
 	// Reference: packages/helpers/src/datetimes/getStatusTextLabel.ts:33
-	__( 'inactive', 'event_espresso' ),
+	__('inactive', 'event_espresso'),
 
 	// Reference: packages/helpers/src/tickets/getStatusTextLabel.ts:20
-	__( 'pending', 'event_espresso' ),
+	__('pending', 'event_espresso'),
 
 	// Reference: packages/helpers/src/tickets/getStatusTextLabel.ts:23
-	__( 'on sale', 'event_espresso' ),
+	__('on sale', 'event_espresso'),
 
 	// Reference: packages/predicates/src/registration/statusOptions.ts:14
-	__( 'Declined', 'event_espresso' ),
+	__('Declined', 'event_espresso'),
 
 	// Reference: packages/predicates/src/registration/statusOptions.ts:18
-	__( 'Incomplete', 'event_espresso' ),
+	__('Incomplete', 'event_espresso'),
 
 	// Reference: packages/predicates/src/registration/statusOptions.ts:22
-	__( 'Not Approved', 'event_espresso' ),
+	__('Not Approved', 'event_espresso'),
 
 	// Reference: packages/predicates/src/registration/statusOptions.ts:26
-	__( 'Pending Payment', 'event_espresso' ),
+	__('Pending Payment', 'event_espresso'),
 
 	// Reference: packages/predicates/src/registration/statusOptions.ts:30
-	__( 'Wait List', 'event_espresso' ),
+	__('Wait List', 'event_espresso'),
 
 	// Reference: packages/predicates/src/registration/statusOptions.ts:6
-	__( 'Approved', 'event_espresso' ),
+	__('Approved', 'event_espresso'),
 
 	// Reference: packages/rich-text-editor/src/components/AdvancedTextEditor/toolbarButtons/WPMedia.tsx:9
 	// Reference: packages/rich-text-editor/src/rte-old/components/toolbarButtons/WPMedia.tsx:10
-	__( 'Select media', 'event_espresso' ),
+	__('Select media', 'event_espresso'),
 
 	// Reference: packages/rich-text-editor/src/components/RichTextEditor/RichTextEditor.tsx:84
-	__( 'Write something…', 'event_espresso' ),
+	__('Write something…', 'event_espresso'),
 
 	// Reference: packages/rich-text-editor/src/components/RichTextEditor/Toolbar/Toolbar.tsx:20
-	__( 'RTE Toolbar', 'event_espresso' ),
+	__('RTE Toolbar', 'event_espresso'),
 
 	// Reference: packages/rich-text-editor/src/components/RichTextEditor/Toolbar/controls/blockType/Component.tsx:11
-	__( 'Normal', 'event_espresso' ),
+	__('Normal', 'event_espresso'),
 
 	// Reference: packages/rich-text-editor/src/components/RichTextEditor/Toolbar/controls/blockType/Component.tsx:12
-	__( 'H1', 'event_espresso' ),
+	__('H1', 'event_espresso'),
 
 	// Reference: packages/rich-text-editor/src/components/RichTextEditor/Toolbar/controls/blockType/Component.tsx:13
-	__( 'H2', 'event_espresso' ),
+	__('H2', 'event_espresso'),
 
 	// Reference: packages/rich-text-editor/src/components/RichTextEditor/Toolbar/controls/blockType/Component.tsx:14
-	__( 'H3', 'event_espresso' ),
+	__('H3', 'event_espresso'),
 
 	// Reference: packages/rich-text-editor/src/components/RichTextEditor/Toolbar/controls/blockType/Component.tsx:15
-	__( 'H4', 'event_espresso' ),
+	__('H4', 'event_espresso'),
 
 	// Reference: packages/rich-text-editor/src/components/RichTextEditor/Toolbar/controls/blockType/Component.tsx:16
-	__( 'H5', 'event_espresso' ),
+	__('H5', 'event_espresso'),
 
 	// Reference: packages/rich-text-editor/src/components/RichTextEditor/Toolbar/controls/blockType/Component.tsx:17
-	__( 'H6', 'event_espresso' ),
+	__('H6', 'event_espresso'),
 
 	// Reference: packages/rich-text-editor/src/components/RichTextEditor/Toolbar/controls/blockType/Component.tsx:18
-	__( 'Block quote', 'event_espresso' ),
+	__('Block quote', 'event_espresso'),
 
 	// Reference: packages/rich-text-editor/src/components/RichTextEditor/Toolbar/controls/blockType/Component.tsx:19
-	__( 'Code', 'event_espresso' ),
+	__('Code', 'event_espresso'),
 
 	// Reference: packages/rich-text-editor/src/components/RichTextEditor/Toolbar/controls/colorPicker/Component.tsx:36
-	__( 'Set color', 'event_espresso' ),
+	__('Set color', 'event_espresso'),
 
 	// Reference: packages/rich-text-editor/src/components/RichTextEditor/Toolbar/controls/colorPicker/Component.tsx:45
-	__( 'Text color', 'event_espresso' ),
+	__('Text color', 'event_espresso'),
 
 	// Reference: packages/rich-text-editor/src/components/RichTextEditor/Toolbar/controls/colorPicker/Component.tsx:47
-	__( 'Background color', 'event_espresso' ),
+	__('Background color', 'event_espresso'),
 
 	// Reference: packages/rich-text-editor/src/components/RichTextEditor/Toolbar/controls/image/Component.tsx:39
-	__( 'Add image', 'event_espresso' ),
+	__('Add image', 'event_espresso'),
 
 	// Reference: packages/rich-text-editor/src/components/RichTextEditor/Toolbar/controls/image/Component.tsx:51
-	__( 'Image URL', 'event_espresso' ),
+	__('Image URL', 'event_espresso'),
 
 	// Reference: packages/rich-text-editor/src/components/RichTextEditor/Toolbar/controls/image/Component.tsx:55
-	__( 'Alt text', 'event_espresso' ),
+	__('Alt text', 'event_espresso'),
 
 	// Reference: packages/rich-text-editor/src/components/RichTextEditor/Toolbar/controls/image/Component.tsx:56
-	__( 'Width', 'event_espresso' ),
+	__('Width', 'event_espresso'),
 
 	// Reference: packages/rich-text-editor/src/components/RichTextEditor/Toolbar/controls/image/Component.tsx:60
-	__( 'Height', 'event_espresso' ),
+	__('Height', 'event_espresso'),
 
 	// Reference: packages/rich-text-editor/src/components/RichTextEditor/Toolbar/controls/link/Component.tsx:54
-	__( 'Edit link', 'event_espresso' ),
+	__('Edit link', 'event_espresso'),
 
 	// Reference: packages/rich-text-editor/src/components/RichTextEditor/Toolbar/controls/link/Component.tsx:64
-	__( 'URL title', 'event_espresso' ),
+	__('URL title', 'event_espresso'),
 
 	// Reference: packages/rich-text-editor/src/components/RichTextEditor/Toolbar/controls/list/Component.tsx:11
-	__( 'Unordered list', 'event_espresso' ),
+	__('Unordered list', 'event_espresso'),
 
 	// Reference: packages/rich-text-editor/src/components/RichTextEditor/Toolbar/controls/list/Component.tsx:12
-	__( 'Ordered list', 'event_espresso' ),
+	__('Ordered list', 'event_espresso'),
 
 	// Reference: packages/rich-text-editor/src/components/RichTextEditor/Toolbar/controls/list/Component.tsx:13
 	// Reference: packages/rich-text-editor/src/components/RichTextEditor/Toolbar/controls/textAlign/Component.tsx:13
-	__( 'Indent', 'event_espresso' ),
+	__('Indent', 'event_espresso'),
 
 	// Reference: packages/rich-text-editor/src/components/RichTextEditor/Toolbar/controls/list/Component.tsx:14
 	// Reference: packages/rich-text-editor/src/components/RichTextEditor/Toolbar/controls/textAlign/Component.tsx:14
-	__( 'Outdent', 'event_espresso' ),
+	__('Outdent', 'event_espresso'),
 
 	// Reference: packages/rich-text-editor/src/components/RichTextEditor/Toolbar/controls/textAlign/Component.tsx:11
-	__( 'Unordered textalign', 'event_espresso' ),
+	__('Unordered textalign', 'event_espresso'),
 
 	// Reference: packages/rich-text-editor/src/components/RichTextEditor/Toolbar/controls/textAlign/Component.tsx:12
-	__( 'Ordered textalign', 'event_espresso' ),
+	__('Ordered textalign', 'event_espresso'),
 
 	// Reference: packages/rich-text-editor/src/components/RichTextEditor/render/Image/Toolbar.tsx:32
-	__( 'Image toolbar', 'event_espresso' ),
+	__('Image toolbar', 'event_espresso'),
 
 	// Reference: packages/rich-text-editor/src/components/WithEditMode/WithEditMode.tsx:62
 	// Reference: packages/rich-text-editor/src/rte-old/components/RTEWithEditMode/RTEWithEditMode.tsx:35
-	__( 'Visual editor', 'event_espresso' ),
+	__('Visual editor', 'event_espresso'),
 
 	// Reference: packages/rich-text-editor/src/components/WithEditMode/WithEditMode.tsx:66
 	// Reference: packages/rich-text-editor/src/rte-old/components/RTEWithEditMode/RTEWithEditMode.tsx:39
-	__( 'HTML editor', 'event_espresso' ),
+	__('HTML editor', 'event_espresso'),
 
 	// Reference: packages/rich-text-editor/src/rte-old/components/toolbarButtons/WPMedia.tsx:68
-	__( 'Add Media', 'event_espresso' ),
+	__('Add Media', 'event_espresso'),
 
 	// Reference: packages/tpc/src/buttons/AddPriceModifierButton.tsx:14
-	__( 'add new price modifier after this row', 'event_espresso' ),
+	__('add new price modifier after this row', 'event_espresso'),
 
 	// Reference: packages/tpc/src/buttons/DeleteAllPricesButton.tsx:14
-	__( 'Delete all prices', 'event_espresso' ),
+	__('Delete all prices', 'event_espresso'),
 
 	// Reference: packages/tpc/src/buttons/DeleteAllPricesButton.tsx:27
-	__( 'Are you sure you want to delete all of this ticket\'s prices and make it free? This action is permanent and can not be undone.', 'event_espresso' ),
+	__('Are you sure you want to delete all of this ticket\'s prices and make it free? This action is permanent and can not be undone.', 'event_espresso'),
 
 	// Reference: packages/tpc/src/buttons/DeleteAllPricesButton.tsx:31
-	__( 'Delete all prices?', 'event_espresso' ),
+	__('Delete all prices?', 'event_espresso'),
 
 	// Reference: packages/tpc/src/buttons/DeletePriceModifierButton.tsx:12
-	__( 'delete price modifier', 'event_espresso' ),
+	__('delete price modifier', 'event_espresso'),
 
 	// Reference: packages/tpc/src/buttons/ReverseCalculateButton.tsx:14
-	__( 'Ticket base price is being reverse calculated from bottom to top starting with the ticket total. Entering a new ticket total will reverse calculate the ticket base price after applying all price modifiers in reverse. Click to turn off reverse calculations', 'event_espresso' ),
+	__('Ticket base price is being reverse calculated from bottom to top starting with the ticket total. Entering a new ticket total will reverse calculate the ticket base price after applying all price modifiers in reverse. Click to turn off reverse calculations', 'event_espresso'),
 
 	// Reference: packages/tpc/src/buttons/ReverseCalculateButton.tsx:17
-	__( 'Ticket total is being calculated normally from top to bottom starting from the base price. Entering a new ticket base price will recalculate the ticket total after applying all price modifiers. Click to turn on reverse calculations', 'event_espresso' ),
+	__('Ticket total is being calculated normally from top to bottom starting from the base price. Entering a new ticket base price will recalculate the ticket total after applying all price modifiers. Click to turn on reverse calculations', 'event_espresso'),
 
 	// Reference: packages/tpc/src/buttons/ReverseCalculateButton.tsx:21
-	__( 'Disable reverse calculate', 'event_espresso' ),
+	__('Disable reverse calculate', 'event_espresso'),
 
 	// Reference: packages/tpc/src/buttons/ReverseCalculateButton.tsx:21
-	__( 'Enable reverse calculate', 'event_espresso' ),
+	__('Enable reverse calculate', 'event_espresso'),
 
 	// Reference: packages/tpc/src/buttons/TicketPriceCalculatorButton.tsx:28
-	__( 'ticket price calculator', 'event_espresso' ),
+	__('ticket price calculator', 'event_espresso'),
 
 	// Reference: packages/tpc/src/buttons/taxes/AddDefaultTaxesButton.tsx:9
-	__( 'Add default taxes', 'event_espresso' ),
+	__('Add default taxes', 'event_espresso'),
 
 	// Reference: packages/tpc/src/buttons/taxes/RemoveTaxesButton.tsx:10
-	__( 'Are you sure you want to remove all of this ticket\'s taxes?', 'event_espresso' ),
+	__('Are you sure you want to remove all of this ticket\'s taxes?', 'event_espresso'),
 
 	// Reference: packages/tpc/src/buttons/taxes/RemoveTaxesButton.tsx:14
-	__( 'Remove all taxes?', 'event_espresso' ),
+	__('Remove all taxes?', 'event_espresso'),
 
 	// Reference: packages/tpc/src/buttons/taxes/RemoveTaxesButton.tsx:7
-	__( 'Remove taxes', 'event_espresso' ),
+	__('Remove taxes', 'event_espresso'),
 
 	// Reference: packages/tpc/src/components/DefaultPricesInfo.tsx:29
-	__( 'Modify default prices.', 'event_espresso' ),
+	__('Modify default prices.', 'event_espresso'),
 
 	// Reference: packages/tpc/src/components/DefaultTaxesInfo.tsx:29
-	__( 'New default taxes are available. Click the - Add default taxes - button to add them now.', 'event_espresso' ),
+	__('New default taxes are available. Click the - Add default taxes - button to add them now.', 'event_espresso'),
 
 	// Reference: packages/tpc/src/components/LockedTicketsBanner.tsx:12
-	__( 'Editing of prices is disabled', 'event_espresso' ),
+	__('Editing of prices is disabled', 'event_espresso'),
 
 	// Reference: packages/tpc/src/components/NoPricesBanner/AddDefaultPricesButton.tsx:9
-	__( 'Add default prices', 'event_espresso' ),
+	__('Add default prices', 'event_espresso'),
 
 	// Reference: packages/tpc/src/components/NoPricesBanner/index.tsx:13
-	__( 'This Ticket is Currently Free', 'event_espresso' ),
+	__('This Ticket is Currently Free', 'event_espresso'),
 
 	// Reference: packages/tpc/src/components/NoPricesBanner/index.tsx:21
 	/* translators: %s default prices */
-	__( 'Click the button below to load your %s into the calculator.', 'event_espresso' ),
+	__('Click the button below to load your %s into the calculator.', 'event_espresso'),
 
 	// Reference: packages/tpc/src/components/NoPricesBanner/index.tsx:22
-	__( 'default prices', 'event_espresso' ),
+	__('default prices', 'event_espresso'),
 
 	// Reference: packages/tpc/src/components/NoPricesBanner/index.tsx:29
-	__( 'Additional ticket price modifiers can be added or removed.', 'event_espresso' ),
+	__('Additional ticket price modifiers can be added or removed.', 'event_espresso'),
 
 	// Reference: packages/tpc/src/components/NoPricesBanner/index.tsx:32
-	__( 'Click the save button below to assign which dates this ticket will be available for purchase on.', 'event_espresso' ),
+	__('Click the save button below to assign which dates this ticket will be available for purchase on.', 'event_espresso'),
 
 	// Reference: packages/tpc/src/components/TicketPriceCalculatorModal.tsx:32
 	/* translators: %s ticket name */
-	__( 'Price Calculator for Ticket: %s', 'event_espresso' ),
+	__('Price Calculator for Ticket: %s', 'event_espresso'),
 
 	// Reference: packages/tpc/src/components/table/useFooterRowGenerator.tsx:48
-	__( 'Total', 'event_espresso' ),
+	__('Total', 'event_espresso'),
 
 	// Reference: packages/tpc/src/components/table/useFooterRowGenerator.tsx:57
-	__( 'ticket total', 'event_espresso' ),
+	__('ticket total', 'event_espresso'),
 
 	// Reference: packages/tpc/src/components/table/useHeaderRowGenerator.ts:29
-	__( 'Order', 'event_espresso' ),
+	__('Order', 'event_espresso'),
 
 	// Reference: packages/tpc/src/components/table/useHeaderRowGenerator.ts:35
-	__( 'Price Type', 'event_espresso' ),
+	__('Price Type', 'event_espresso'),
 
 	// Reference: packages/tpc/src/components/table/useHeaderRowGenerator.ts:41
-	__( 'Label', 'event_espresso' ),
+	__('Label', 'event_espresso'),
 
 	// Reference: packages/tpc/src/components/table/useHeaderRowGenerator.ts:53
-	__( 'Amount', 'event_espresso' ),
+	__('Amount', 'event_espresso'),
 
 	// Reference: packages/tpc/src/hooks/useLockedTicketAction.ts:22
-	__( 'Copy ticket', 'event_espresso' ),
+	__('Copy ticket', 'event_espresso'),
 
 	// Reference: packages/tpc/src/hooks/useLockedTicketAction.ts:26
-	__( 'Copy and archive this ticket', 'event_espresso' ),
+	__('Copy and archive this ticket', 'event_espresso'),
 
 	// Reference: packages/tpc/src/hooks/useLockedTicketAction.ts:29
-	__( 'OK', 'event_espresso' ),
+	__('OK', 'event_espresso'),
 
 	// Reference: packages/tpc/src/inputs/PriceAmountInput.tsx:32
-	__( 'amount', 'event_espresso' ),
+	__('amount', 'event_espresso'),
 
 	// Reference: packages/tpc/src/inputs/PriceAmountInput.tsx:44
-	__( 'amount…', 'event_espresso' ),
+	__('amount…', 'event_espresso'),
 
 	// Reference: packages/tpc/src/inputs/PriceDescriptionInput.tsx:14
-	__( 'description…', 'event_espresso' ),
+	__('description…', 'event_espresso'),
 
 	// Reference: packages/tpc/src/inputs/PriceDescriptionInput.tsx:9
-	__( 'price description', 'event_espresso' ),
+	__('price description', 'event_espresso'),
 
 	// Reference: packages/tpc/src/inputs/PriceIdInput.tsx:5
-	__( 'price id', 'event_espresso' ),
+	__('price id', 'event_espresso'),
 
 	// Reference: packages/tpc/src/inputs/PriceNameInput.tsx:13
-	__( 'label…', 'event_espresso' ),
+	__('label…', 'event_espresso'),
 
 	// Reference: packages/tpc/src/inputs/PriceNameInput.tsx:8
-	__( 'price name', 'event_espresso' ),
+	__('price name', 'event_espresso'),
 
 	// Reference: packages/tpc/src/inputs/PriceOrderInput.tsx:14
-	__( 'price order', 'event_espresso' ),
+	__('price order', 'event_espresso'),
 
 	// Reference: packages/tpc/src/inputs/PriceTypeInput.tsx:19
-	__( 'price type', 'event_espresso' ),
+	__('price type', 'event_espresso'),
 
 	// Reference: packages/tpc/src/utils/constants.ts:8
-	__( 'Ticket price modifications are blocked for Tickets that have already been sold to registrants, because doing so would negatively affect internal accounting for the event. If you still need to modify ticket prices, then create a copy of those tickets, edit the prices for the new tickets, and then trash the old tickets.', 'event_espresso' ),
+	__('Ticket price modifications are blocked for Tickets that have already been sold to registrants, because doing so would negatively affect internal accounting for the event. If you still need to modify ticket prices, then create a copy of those tickets, edit the prices for the new tickets, and then trash the old tickets.', 'event_espresso'),
 
 	// Reference: packages/ui-components/src/ActiveFilters/ActiveFilters.tsx:8
-	__( 'active filters:', 'event_espresso' ),
+	__('active filters:', 'event_espresso'),
 
 	// Reference: packages/ui-components/src/ActiveFilters/FilterTag/index.tsx:15
 	/* translators: %s filter name */
-	__( 'remove filter - %s', 'event_espresso' ),
+	__('remove filter - %s', 'event_espresso'),
 
 	// Reference: packages/ui-components/src/CalendarDateRange/CalendarDateRange.tsx:37
-	__( 'to', 'event_espresso' ),
+	__('to', 'event_espresso'),
 
 	// Reference: packages/ui-components/src/CalendarPageDate/CalendarPageDate.tsx:54
-	__( 'TO', 'event_espresso' ),
+	__('TO', 'event_espresso'),
 
 	// Reference: packages/ui-components/src/ColorPicker/ColorPicker.tsx:60
-	__( 'Custom color', 'event_espresso' ),
+	__('Custom color', 'event_espresso'),
 
 	// Reference: packages/ui-components/src/ColorPicker/Swatch.tsx:23
 	/* translators: color name */
-	__( 'Color: %s', 'event_espresso' ),
+	__('Color: %s', 'event_espresso'),
 
 	// Reference: packages/ui-components/src/ColorPicker/constants.ts:13
-	__( 'Cyan bluish gray', 'event_espresso' ),
+	__('Cyan bluish gray', 'event_espresso'),
 
 	// Reference: packages/ui-components/src/ColorPicker/constants.ts:17
-	__( 'White', 'event_espresso' ),
+	__('White', 'event_espresso'),
 
 	// Reference: packages/ui-components/src/ColorPicker/constants.ts:21
-	__( 'Pale pink', 'event_espresso' ),
+	__('Pale pink', 'event_espresso'),
 
 	// Reference: packages/ui-components/src/ColorPicker/constants.ts:25
-	__( 'Vivid red', 'event_espresso' ),
+	__('Vivid red', 'event_espresso'),
 
 	// Reference: packages/ui-components/src/ColorPicker/constants.ts:29
-	__( 'Luminous vivid orange', 'event_espresso' ),
+	__('Luminous vivid orange', 'event_espresso'),
 
 	// Reference: packages/ui-components/src/ColorPicker/constants.ts:33
-	__( 'Luminous vivid amber', 'event_espresso' ),
+	__('Luminous vivid amber', 'event_espresso'),
 
 	// Reference: packages/ui-components/src/ColorPicker/constants.ts:37
-	__( 'Light green cyan', 'event_espresso' ),
+	__('Light green cyan', 'event_espresso'),
 
 	// Reference: packages/ui-components/src/ColorPicker/constants.ts:41
-	__( 'Vivid green cyan', 'event_espresso' ),
+	__('Vivid green cyan', 'event_espresso'),
 
 	// Reference: packages/ui-components/src/ColorPicker/constants.ts:45
-	__( 'Pale cyan blue', 'event_espresso' ),
+	__('Pale cyan blue', 'event_espresso'),
 
 	// Reference: packages/ui-components/src/ColorPicker/constants.ts:49
-	__( 'Vivid cyan blue', 'event_espresso' ),
+	__('Vivid cyan blue', 'event_espresso'),
 
 	// Reference: packages/ui-components/src/ColorPicker/constants.ts:53
-	__( 'Vivid purple', 'event_espresso' ),
+	__('Vivid purple', 'event_espresso'),
 
 	// Reference: packages/ui-components/src/ColorPicker/constants.ts:9
-	__( 'Black', 'event_espresso' ),
+	__('Black', 'event_espresso'),
 
 	// Reference: packages/ui-components/src/Confirm/ConfirmClose.tsx:7
 	// Reference: packages/ui-components/src/Modal/ModalWithAlert.tsx:22
-	__( 'Are you sure you want to close this?', 'event_espresso' ),
+	__('Are you sure you want to close this?', 'event_espresso'),
 
 	// Reference: packages/ui-components/src/Confirm/ConfirmDelete.tsx:7
-	__( 'Are you sure you want to delete this?', 'event_espresso' ),
+	__('Are you sure you want to delete this?', 'event_espresso'),
 
 	// Reference: packages/ui-components/src/Confirm/useConfirmWithButton.tsx:10
-	__( 'Please confirm this action.', 'event_espresso' ),
+	__('Please confirm this action.', 'event_espresso'),
 
 	// Reference: packages/ui-components/src/Confirm/useConfirmationDialog.tsx:32
-	__( 'No', 'event_espresso' ),
+	__('No', 'event_espresso'),
 
 	// Reference: packages/ui-components/src/Confirm/useConfirmationDialog.tsx:33
-	__( 'Yes', 'event_espresso' ),
+	__('Yes', 'event_espresso'),
 
 	// Reference: packages/ui-components/src/CurrencyDisplay/CurrencyDisplay.tsx:34
-	__( 'free', 'event_espresso' ),
+	__('free', 'event_espresso'),
 
 	// Reference: packages/ui-components/src/DateTimeRangePicker/DateTimeRangePicker.tsx:117
 	// Reference: packages/ui-components/src/Popover/PopoverForm/PopoverForm.tsx:44
-	__( 'save', 'event_espresso' ),
+	__('save', 'event_espresso'),
 
 	// Reference: packages/ui-components/src/DebugInfo/DebugInfo.tsx:36
-	__( 'Hide Debug Info', 'event_espresso' ),
+	__('Hide Debug Info', 'event_espresso'),
 
 	// Reference: packages/ui-components/src/DebugInfo/DebugInfo.tsx:36
-	__( 'Show Debug Info', 'event_espresso' ),
+	__('Show Debug Info', 'event_espresso'),
 
 	// Reference: packages/ui-components/src/EditDateRangeButton/EditDateRangeButton.tsx:49
-	__( 'Edit Start and End Dates and Times', 'event_espresso' ),
+	__('Edit Start and End Dates and Times', 'event_espresso'),
 
 	// Reference: packages/ui-components/src/EntityActionsMenu/entityMenuItems/Copy.tsx:8
-	__( 'copy', 'event_espresso' ),
+	__('copy', 'event_espresso'),
 
 	// Reference: packages/ui-components/src/EntityActionsMenu/entityMenuItems/Edit.tsx:8
-	__( 'edit', 'event_espresso' ),
+	__('edit', 'event_espresso'),
 
 	// Reference: packages/ui-components/src/EntityActionsMenu/entityMenuItems/Trash.tsx:8
-	__( 'trash', 'event_espresso' ),
+	__('trash', 'event_espresso'),
 
 	// Reference: packages/ui-components/src/EntityActionsMenu/entityMenuItems/Untrash.tsx:8
-	__( 'untrash', 'event_espresso' ),
+	__('untrash', 'event_espresso'),
 
 	// Reference: packages/ui-components/src/EntityDetailsPanel/EntityDetailsPanelSold.tsx:37
-	__( 'view approved registrations for this date.', 'event_espresso' ),
+	__('view approved registrations for this date.', 'event_espresso'),
 
 	// Reference: packages/ui-components/src/EntityDetailsPanel/EntityDetailsPanelSold.tsx:38
-	__( 'view approved registrations for this ticket.', 'event_espresso' ),
+	__('view approved registrations for this ticket.', 'event_espresso'),
 
 	// Reference: packages/ui-components/src/EntityList/filterBar/buttons/CardViewFilterButton.tsx:21
-	__( 'card view', 'event_espresso' ),
+	__('card view', 'event_espresso'),
 
 	// Reference: packages/ui-components/src/EntityList/filterBar/buttons/TableViewFilterButton.tsx:20
-	__( 'table view', 'event_espresso' ),
+	__('table view', 'event_espresso'),
 
 	// Reference: packages/ui-components/src/EntityList/filterBar/buttons/ToggleBulkActionsButton.tsx:8
-	__( 'hide bulk actions', 'event_espresso' ),
+	__('hide bulk actions', 'event_espresso'),
 
 	// Reference: packages/ui-components/src/EntityList/filterBar/buttons/ToggleBulkActionsButton.tsx:8
-	__( 'show bulk actions', 'event_espresso' ),
+	__('show bulk actions', 'event_espresso'),
 
 	// Reference: packages/ui-components/src/EntityList/filterBar/buttons/ToggleFiltersButton.tsx:9
-	__( 'hide filters', 'event_espresso' ),
+	__('hide filters', 'event_espresso'),
 
 	// Reference: packages/ui-components/src/EntityList/filterBar/buttons/ToggleFiltersButton.tsx:9
-	__( 'show filters', 'event_espresso' ),
+	__('show filters', 'event_espresso'),
 
 	// Reference: packages/ui-components/src/Legend/ToggleLegendButton.tsx:26
-	__( 'hide legend', 'event_espresso' ),
+	__('hide legend', 'event_espresso'),
 
 	// Reference: packages/ui-components/src/Legend/ToggleLegendButton.tsx:26
-	__( 'show legend', 'event_espresso' ),
+	__('show legend', 'event_espresso'),
 
 	// Reference: packages/ui-components/src/LoadingNotice/LoadingNotice.tsx:11
-	__( 'loading…', 'event_espresso' ),
+	__('loading…', 'event_espresso'),
 
 	// Reference: packages/ui-components/src/Modal/Modal.tsx:58
-	__( 'close modal', 'event_espresso' ),
+	__('close modal', 'event_espresso'),
 
 	// Reference: packages/ui-components/src/Pagination/ItemRender.tsx:10
-	__( 'jump to previous', 'event_espresso' ),
+	__('jump to previous', 'event_espresso'),
 
 	// Reference: packages/ui-components/src/Pagination/ItemRender.tsx:11
-	__( 'jump to next', 'event_espresso' ),
+	__('jump to next', 'event_espresso'),
 
 	// Reference: packages/ui-components/src/Pagination/ItemRender.tsx:12
-	__( 'page', 'event_espresso' ),
+	__('page', 'event_espresso'),
 
 	// Reference: packages/ui-components/src/Pagination/ItemRender.tsx:8
-	__( 'previous', 'event_espresso' ),
+	__('previous', 'event_espresso'),
 
 	// Reference: packages/ui-components/src/Pagination/ItemRender.tsx:9
-	__( 'next', 'event_espresso' ),
+	__('next', 'event_espresso'),
 
 	// Reference: packages/ui-components/src/Pagination/PerPage.tsx:37
-	__( 'items per page', 'event_espresso' ),
+	__('items per page', 'event_espresso'),
 
 	// Reference: packages/ui-components/src/Pagination/constants.ts:10
 	/* translators: %s is per page value */
-	__( '%s / page', 'event_espresso' ),
+	__('%s / page', 'event_espresso'),
 
 	// Reference: packages/ui-components/src/Pagination/constants.ts:13
-	__( 'Next Page', 'event_espresso' ),
+	__('Next Page', 'event_espresso'),
 
 	// Reference: packages/ui-components/src/Pagination/constants.ts:14
-	__( 'Previous Page', 'event_espresso' ),
+	__('Previous Page', 'event_espresso'),
 
 	// Reference: packages/ui-components/src/PercentSign/index.tsx:10
-	__( '%', 'event_espresso' ),
+	__('%', 'event_espresso'),
 
 	// Reference: packages/ui-components/src/SimpleEntityList/EntityOptionsRow/index.tsx:23
-	__( 'Select an existing one to use as a template.', 'event_espresso' ),
+	__('Select an existing one to use as a template.', 'event_espresso'),
 
 	// Reference: packages/ui-components/src/SimpleEntityList/EntityOptionsRow/index.tsx:27
-	__( 'or', 'event_espresso' ),
+	__('or', 'event_espresso'),
 
 	// Reference: packages/ui-components/src/SimpleEntityList/EntityOptionsRow/index.tsx:30
-	__( 'Add new and insert details manually', 'event_espresso' ),
+	__('Add new and insert details manually', 'event_espresso'),
 
 	// Reference: packages/ui-components/src/SimpleEntityList/EntityOptionsRow/index.tsx:34
-	__( 'Add New', 'event_espresso' ),
+	__('Add New', 'event_espresso'),
 
 	// Reference: packages/ui-components/src/Stepper/buttons/Next.tsx:8
-	__( 'Next', 'event_espresso' ),
+	__('Next', 'event_espresso'),
 
 	// Reference: packages/ui-components/src/Stepper/buttons/Previous.tsx:8
-	__( 'Previous', 'event_espresso' ),
+	__('Previous', 'event_espresso'),
 
 	// Reference: packages/ui-components/src/Steps/Steps.tsx:31
-	__( 'Steps', 'event_espresso' ),
+	__('Steps', 'event_espresso'),
 
 	// Reference: packages/ui-components/src/TabbableText/index.tsx:19
-	__( 'Click to edit…', 'event_espresso' ),
+	__('Click to edit…', 'event_espresso'),
 
 	// Reference: packages/ui-components/src/TimezoneTimeInfo/Content.tsx:14
-	__( 'The Website\'s Time Zone', 'event_espresso' ),
+	__('The Website\'s Time Zone', 'event_espresso'),
 
 	// Reference: packages/ui-components/src/TimezoneTimeInfo/Content.tsx:19
-	__( 'UTC (Greenwich Mean Time)', 'event_espresso' ),
+	__('UTC (Greenwich Mean Time)', 'event_espresso'),
 
 	// Reference: packages/ui-components/src/TimezoneTimeInfo/Content.tsx:9
-	__( 'Your Local Time Zone', 'event_espresso' ),
+	__('Your Local Time Zone', 'event_espresso'),
 
 	// Reference: packages/ui-components/src/TimezoneTimeInfo/TimezoneTimeInfo.tsx:27
-	__( 'click for timezone information', 'event_espresso' ),
+	__('click for timezone information', 'event_espresso'),
 
 	// Reference: packages/ui-components/src/TimezoneTimeInfo/TimezoneTimeInfo.tsx:32
-	__( 'This Date Converted To:', 'event_espresso' ),
+	__('This Date Converted To:', 'event_espresso'),
 
 	// Reference: packages/ui-components/src/bulkEdit/BulkActions.tsx:51
-	__( 'select all', 'event_espresso' ),
+	__('select all', 'event_espresso'),
 
 	// Reference: packages/ui-components/src/bulkEdit/BulkActions.tsx:54
-	__( 'apply', 'event_espresso' )
+	__('apply', 'event_espresso')
 );
 /* THIS IS THE END OF THE GENERATED FILE */