eventespresso / event-espresso-core

core/EE_Data_Migration_Manager.core.php

Indentation +1316 added lines, -1316 removed lines

@@ -32,1320 +32,1320 @@
 class EE_Data_Migration_Manager implements ResettableInterface
 {
 
-    /**
-     *
-     * @var EE_Registry
-     */
-    // protected $EE;
-    /**
-     * name of the WordPress option which stores an array of data about
-     */
-    const data_migrations_option_name = 'ee_data_migration';
-
-
-    const data_migration_script_option_prefix         = 'ee_data_migration_script_';
-
-    const data_migration_script_mapping_option_prefix = 'ee_dms_map_';
-
-    /**
-     * name of the WordPress option which stores the database' current version. IE, the code may be at version 4.2.0,
-     * but as migrations are performed the database will progress from 3.1.35 to 4.1.0 etc.
-     */
-    const current_database_state = 'ee_data_migration_current_db_state';
-
-    /**
-     * Special status string returned when we're positive there are no more data migration
-     * scripts that can be run.
-     */
-    const status_no_more_migration_scripts = 'no_more_migration_scripts';
-
-    /**
-     * string indicating the migration should continue
-     */
-    const status_continue = 'status_continue';
-
-    /**
-     * string indicating the migration has completed and should be ended
-     */
-    const status_completed = 'status_completed';
-
-    /**
-     * string indicating a fatal error occurred and the data migration should be completely aborted
-     */
-    const status_fatal_error = 'status_fatal_error';
-
-    /**
-     * the number of 'items' (usually DB rows) to migrate on each 'step' (ajax request sent
-     * during migration)
-     */
-    const step_size = 50;
-
-    /**
-     * option name that stores the queue of ee plugins needing to have
-     * their data initialized (or re-initialized) once we are done migrations
-     */
-    const db_init_queue_option_name = 'ee_db_init_queue';
-
-    /**
-     * Array of information concerning data migrations that have run in the history
-     * of this EE installation. Keys should be the name of the version the script upgraded to
-     *
-     * @var EE_Data_Migration_Script_Base[]
-     */
-    private $_data_migrations_ran = null;
-
-    /**
-     * The last run script. It's nice to store this somewhere accessible, as its easiest
-     * to know which was the last run by which is the newest wp option; but in most of the code
-     * we just use the local $_data_migration_ran array, which organized the scripts differently
-     *
-     * @var EE_Data_Migration_Script_Base
-     */
-    private $_last_ran_script = null;
-
-    /**
-     * Similarly to _last_ran_script, but this is the last INCOMPLETE migration script.
-     *
-     * @var EE_Data_Migration_Script_Base
-     */
-    private $_last_ran_incomplete_script = null;
-
-    /**
-     * array where keys are classnames, and values are filepaths of all the known migration scripts
-     *
-     * @var array
-     */
-    private $_data_migration_class_to_filepath_map;
-
-    /**
-     * the following 4 properties are fully set on construction.
-     * Note: the first two apply to whether to continue running ALL migration scripts (ie, even though we're finished
-     * one, we may want to start the next one); whereas the last two indicate whether to continue running a single
-     * data migration script
-     *
-     * @var array
-     */
-    public $stati_that_indicate_to_continue_migrations              = [];
-
-    public $stati_that_indicate_to_stop_migrations                  = [];
-
-    public $stati_that_indicate_to_continue_single_migration_script = [];
-
-    public $stati_that_indicate_to_stop_single_migration_script     = [];
-
-    /**
-     * @var TableManager $table_manager
-     */
-    protected $_table_manager;
-
-    /**
-     * @var TableAnalysis $table_analysis
-     */
-    protected $_table_analysis;
-
-    /**
-     * @var array $script_migration_versions
-     */
-    protected $script_migration_versions;
-
-    /**
-     * @var EE_Data_Migration_Manager $_instance
-     * @access    private
-     */
-    private static $_instance = null;
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @access    public
-     * @return EE_Data_Migration_Manager instance
-     */
-    public static function instance()
-    {
-        // check if class object is instantiated
-        if (! self::$_instance instanceof EE_Data_Migration_Manager) {
-            self::$_instance = new self();
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * resets the singleton to its brand-new state (but does NOT delete old references to the old singleton. Meaning,
-     * all new usages of the singleton should be made with Classname::instance()) and returns it
-     *
-     * @return EE_Data_Migration_Manager
-     */
-    public static function reset()
-    {
-        self::$_instance = null;
-        return self::instance();
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function __construct()
-    {
-        $this->stati_that_indicate_to_continue_migrations              = [
-            self::status_continue,
-            self::status_completed,
-        ];
-        $this->stati_that_indicate_to_stop_migrations                  = [
-            self::status_fatal_error,
-            self::status_no_more_migration_scripts,
-        ];
-        $this->stati_that_indicate_to_continue_single_migration_script = [
-            self::status_continue,
-        ];
-        $this->stati_that_indicate_to_stop_single_migration_script     = [
-            self::status_completed,
-            self::status_fatal_error
-            // note: status_no_more_migration_scripts doesn't apply
-        ];
-        // make sure we've included the base migration script, because we may need the EE_DMS_Unknown_1_0_0 class
-        // to be defined, because right now it doesn't get autoloaded on its own
-        EE_Registry::instance()->load_core('Data_Migration_Class_Base', [], true);
-        EE_Registry::instance()->load_core('Data_Migration_Script_Base', [], true);
-        EE_Registry::instance()->load_core('DMS_Unknown_1_0_0', [], true);
-        EE_Registry::instance()->load_core('Data_Migration_Script_Stage', [], true);
-        EE_Registry::instance()->load_core('Data_Migration_Script_Stage_Table', [], true);
-        $this->_table_manager  = EE_Registry::instance()->create('TableManager', [], true);
-        $this->_table_analysis = EE_Registry::instance()->create('TableAnalysis', [], true);
-    }
-
-
-    /**
-     * Deciphers, from an option's name, what plugin and version it relates to (see _save_migrations_ran to see what
-     * the option names are like, but generally they're like
-     * 'ee_data_migration_script_Core.4.1.0' in 4.2 or 'ee_data_migration_script_4.1.0' before that).
-     * The option name shouldn't ever be like 'ee_data_migration_script_Core.4.1.0.reg' because it's derived,
-     * indirectly, from the data migration's classname, which should always be like EE_DMS_%s_%d_%d_%d.dms.php
-     * (ex: EE_DMS_Core_4_1_0.dms.php)
-     *
-     * @param string $option_name (see EE_Data_Migration_Manage::_save_migrations_ran() where the option name is set)
-     * @return array where the first item is the plugin slug (eg 'Core','Calendar', etc.) and the 2nd is the version of
-     *                            that plugin (eg '4.1.0')
-     */
-    private function _get_plugin_slug_and_version_string_from_dms_option_name($option_name)
-    {
-        $plugin_slug_and_version_string = str_replace(
-            EE_Data_Migration_Manager::data_migration_script_option_prefix,
-            "",
-            $option_name
-        );
-        // check if $plugin_slug_and_version_string is like '4.1.0' (4.1-style) or 'Core.4.1.0' (4.2-style)
-        $parts = explode(".", $plugin_slug_and_version_string);
-
-        if (count($parts) == 4) {
-            // it's 4.2-style.eg Core.4.1.0
-            $plugin_slug    = $parts[0];                                     // eg Core
-            $version_string = $parts[1] . "." . $parts[2] . "." . $parts[3]; // eg 4.1.0
-        } else {
-            // it's 4.1-style: eg 4.1.0
-            $plugin_slug    = 'Core';
-            $version_string = $plugin_slug_and_version_string;// eg 4.1.0
-        }
-        return [$plugin_slug, $version_string];
-    }
-
-
-    /**
-     * Gets the DMS class from the WordPress option, otherwise throws an EE_Error if it's not
-     * for a known DMS class.
-     *
-     * @param string $dms_option_name
-     * @param string $dms_option_value (serialized)
-     * @return EE_Data_Migration_Script_Base
-     * @throws EE_Error
-     */
-    private function _get_dms_class_from_wp_option($dms_option_name, $dms_option_value)
-    {
-        $data_migration_data = maybe_unserialize($dms_option_value);
-        if (isset($data_migration_data['class']) && class_exists($data_migration_data['class'])) {
-            // During multisite migrations, it's possible we already grabbed another instance of this class
-            // but for a different blog. Make sure we don't reuse them (as they store info specific
-            // to their respective blog, like which database table to migrate).
-            $class = LoaderFactory::getLoader()->getNew($data_migration_data['class']);
-            if ($class instanceof EE_Data_Migration_Script_Base) {
-                $class->instantiate_from_array_of_properties($data_migration_data);
-                return $class;
-            } else {
-                // huh, so it's an object but not a data migration script?? that shouldn't happen
-                // just leave it as an array (which will probably just get ignored)
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            "Trying to retrieve DMS class from wp option. No DMS by the name '%s' exists",
-                            'event_espresso'
-                        ),
-                        $data_migration_data['class']
-                    )
-                );
-            }
-        } else {
-            // so the data doesn't specify a class. So it must either be a legacy array of info or some array (which we'll probably just ignore), or a class that no longer exists
-            throw new EE_Error(
-                sprintf(
-                    esc_html__("The wp option  with key '%s' does not represent a DMS", 'event_espresso'),
-                    $dms_option_name
-                )
-            );
-        }
-    }
-
-
-    /**
-     * Gets the array describing what data migrations have run.
-     * Also has a side effect of recording which was the last run,
-     * and which was the last run which hasn't finished yet
-     *
-     * @return array where each element should be an array of EE_Data_Migration_Script_Base
-     *               (but also has a few legacy arrays in there - which should probably be ignored)
-     * @throws EE_Error
-     */
-    public function get_data_migrations_ran()
-    {
-        if (! $this->_data_migrations_ran) {
-            // setup autoloaders for each of the scripts in there
-            $this->get_all_data_migration_scripts_available();
-            $data_migrations_options =
-                $this->get_all_migration_script_options();// get_option(EE_Data_Migration_Manager::data_migrations_option_name,get_option('espresso_data_migrations',array()));
-
-            $data_migrations_ran = [];
-            // convert into data migration script classes where possible
-            foreach ($data_migrations_options as $data_migration_option) {
-                list($plugin_slug, $version_string) = $this->_get_plugin_slug_and_version_string_from_dms_option_name(
-                    $data_migration_option['option_name']
-                );
-
-                try {
-                    $class                                                  = $this->_get_dms_class_from_wp_option(
-                        $data_migration_option['option_name'],
-                        $data_migration_option['option_value']
-                    );
-                    $data_migrations_ran[ $plugin_slug ][ $version_string ] = $class;
-                    // ok so far THIS is the 'last-run-script'... unless we find another on next iteration
-                    $this->_last_ran_script = $class;
-                    if (! $class->is_completed()) {
-                        // sometimes we also like to know which was the last incomplete script (or if there are any at all)
-                        $this->_last_ran_incomplete_script = $class;
-                    }
-                } catch (EE_Error $e) {
-                    // ok so it's not a DMS. We'll just keep it, although other code will need to expect non-DMSs
-                    $data_migrations_ran[ $plugin_slug ][ $version_string ] = maybe_unserialize(
-                        $data_migration_option['option_value']
-                    );
-                }
-            }
-            // so here the array of $data_migrations_ran is actually a mix of classes and a few legacy arrays
-            $this->_data_migrations_ran = $data_migrations_ran;
-            if (! $this->_data_migrations_ran || ! is_array($this->_data_migrations_ran)) {
-                $this->_data_migrations_ran = [];
-            }
-        }
-        return $this->_data_migrations_ran;
-    }
-
-
-    /**
-     *
-     * @param string $script_name eg 'DMS_Core_4_1_0'
-     * @param string $old_table   eg 'wp_events_detail'
-     * @param string $old_pk      eg 'wp_esp_posts'
-     * @param        $new_table
-     * @return mixed string or int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_mapping_new_pk($script_name, $old_table, $old_pk, $new_table)
-    {
-        $script  = EE_Registry::instance()->load_dms($script_name);
-        return $script->get_mapping_new_pk($old_table, $old_pk, $new_table);
-    }
-
-
-    /**
-     * Gets all the options containing migration scripts that have been run. Ordering is important: it's assumed that
-     * the last option returned in this array is the most-recently run DMS option
-     *
-     * @return array
-     */
-    public function get_all_migration_script_options()
-    {
-        global $wpdb;
-        return $wpdb->get_results(
-            "SELECT * FROM {$wpdb->options} WHERE option_name like '"
-            . EE_Data_Migration_Manager::data_migration_script_option_prefix
-            . "%' ORDER BY option_id ASC",
-            ARRAY_A
-        );
-    }
-
-
-    /**
-     * Gets the array of folders which contain data migration scripts. Also adds them to be auto-loaded
-     *
-     * @return array where each value is the full folder path of a folder containing data migration scripts, WITH
-     *               slashes at the end of the folder name.
-     */
-    public function get_data_migration_script_folders()
-    {
-        return apply_filters(
-            'FHEE__EE_Data_Migration_Manager__get_data_migration_script_folders',
-            ['Core' => EE_CORE . 'data_migration_scripts']
-        );
-    }
-
-
-    /**
-     * Gets the version the migration script upgrades to
-     *
-     * @param string $migration_script_name eg 'EE_DMS_Core_4_1_0'
-     * @return array {
-     *      @type string  $slug     like 'Core','Calendar',etc
-     *      @type string  $version  like 4.3.0
-     * }
-     * @throws EE_Error
-     */
-    public function script_migrates_to_version($migration_script_name, $eeAddonClass = '')
-    {
-        if (isset($this->script_migration_versions[ $migration_script_name ])) {
-            return $this->script_migration_versions[ $migration_script_name ];
-        }
-        $dms_info                                                  = $this->parse_dms_classname($migration_script_name);
-        $this->script_migration_versions[ $migration_script_name ] = [
-            'slug'    => $eeAddonClass !== '' ? $eeAddonClass : $dms_info['slug'],
-            'version' => $dms_info['major_version']
-                         . "."
-                         . $dms_info['minor_version']
-                         . "."
-                         . $dms_info['micro_version'],
-        ];
-        return $this->script_migration_versions[ $migration_script_name ];
-    }
-
-
-    /**
-     * Gets the juicy details out of a dms filename like 'EE_DMS_Core_4_1_0'
-     *
-     * @param string $classname
-     * @return array with keys 'slug','major_version','minor_version', and 'micro_version' (the last 3 are integers)
-     * @throws EE_Error
-     */
-    public function parse_dms_classname($classname)
-    {
-        $matches = [];
-        preg_match('~EE_DMS_(.*)_([0-9]*)_([0-9]*)_([0-9]*)~', $classname, $matches);
-        if (! $matches || ! (isset($matches[1]) && isset($matches[2]) && isset($matches[3]))) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        "%s is not a valid Data Migration Script. The classname should be like EE_DMS_w_x_y_z, where w is either 'Core' or the slug of an addon and x, y and z are numbers, ",
-                        "event_espresso"
-                    ),
-                    $classname
-                )
-            );
-        }
-        return [
-            'slug'          => $matches[1],
-            'major_version' => intval($matches[2]),
-            'minor_version' => intval($matches[3]),
-            'micro_version' => intval($matches[4]),
-        ];
-    }
-
-
-    /**
-     * Ensures that the option indicating the current DB version is set. This should only be
-     * a concern when activating EE for the first time, THEORETICALLY.
-     * If we detect that we're activating EE4 over top of EE3.1, then we set the current db state to 3.1.x, otherwise
-     * to 4.1.x.
-     *
-     * @return string of current db state
-     */
-    public function ensure_current_database_state_is_set()
-    {
-        $espresso_db_core_updates = get_option('espresso_db_update', []);
-        $db_state                 = get_option(EE_Data_Migration_Manager::current_database_state);
-        if (! $db_state) {
-            // mark the DB as being in the state as the last version in there.
-            // this is done to trigger maintenance mode and do data migration scripts
-            // if the admin installed this version of EE over 3.1.x or 4.0.x
-            // otherwise, the normal maintenance mode code is fine
-            $previous_versions_installed = array_keys($espresso_db_core_updates);
-            $previous_version_installed  = end($previous_versions_installed);
-            if (version_compare('4.1.0', $previous_version_installed)) {
-                // last installed version was less than 4.1, so we want the data migrations to happen.
-                // SO, we're going to say the DB is at that state
-                $db_state = ['Core' => $previous_version_installed];
-            } else {
-                $db_state = ['Core' => EVENT_ESPRESSO_VERSION];
-            }
-            update_option(EE_Data_Migration_Manager::current_database_state, $db_state);
-        }
-        // in 4.1, $db_state would have only been a simple string like '4.1.0',
-        // but in 4.2+ it should be an array with at least key 'Core' and the value of that plugin's
-        // db, and possibly other keys for other addons like 'Calendar','Permissions',etc
-        if (! is_array($db_state)) {
-            $db_state = ['Core' => $db_state];
-            update_option(EE_Data_Migration_Manager::current_database_state, $db_state);
-        }
-        return $db_state;
-    }
-
-
-    /**
-     * Checks if there are any data migration scripts that ought to be run.
-     * If found, returns the instantiated classes.
-     * If none are found (ie, they've all already been run, or they don't apply), returns an empty array
-     *
-     * @return EE_Data_Migration_Script_Base[]
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    public function check_for_applicable_data_migration_scripts()
-    {
-        // get the option describing what options have already run
-        $scripts_ran = $this->get_data_migrations_ran();
-        // $scripts_ran = array('4.1.0.core'=>array('monkey'=>null));
-        $script_class_and_filepaths_available = $this->get_all_data_migration_scripts_available();
-
-
-        $current_database_state = $this->ensure_current_database_state_is_set();
-        // determine which have already been run
-        $script_classes_that_should_run_per_iteration = [];
-        $iteration                                    = 0;
-        $next_database_state_to_consider              = $current_database_state;
-        $theoretical_database_state = null;
-        do {
-            // the next state after the currently-considered one
-            // will start off looking the same as the current, but we may make additions...
-            $theoretical_database_state = $next_database_state_to_consider;
-            // the next db state to consider is
-            // "what would the DB be like had we run all the scripts we found that applied last time?"
-            foreach ($script_class_and_filepaths_available as $classname => $filepath) {
-                $migrates_to_version         = $this->script_migrates_to_version($classname);
-                $script_converts_plugin_slug = $migrates_to_version['slug'];
-                $script_converts_to_version  = $migrates_to_version['version'];
-                // check if this version script is DONE or not; or if it's never been run
-                if (
-                    ! $scripts_ran
-                    || ! isset($scripts_ran[ $script_converts_plugin_slug ][ $script_converts_to_version ])
-                ) {
-                    // we haven't run this conversion script before
-                    // now check if it applies...
-                    // note that we've added an autoloader for it on get_all_data_migration_scripts_available
-                    // Also, make sure we get a new one. It's possible this is being ran during a multisite migration,
-                    // in which case we don't want to reuse a DMS script from a different blog!
-                    $script = LoaderFactory::getLoader()->getNew($classname);
-                    /* @var $script EE_Data_Migration_Script_Base */
-                    $can_migrate = $script->can_migrate_from_version($theoretical_database_state);
-                    if ($can_migrate) {
-                        $script_classes_that_should_run_per_iteration[ $iteration ][ $script->priority() ][] = $script;
-                        $migrates_to_version                                                                 =
-                            $script->migrates_to_version();
-                        $next_database_state_to_consider[ $migrates_to_version['slug'] ]                     =
-                            $migrates_to_version['version'];
-                        unset($script_class_and_filepaths_available[ $classname ]);
-                    }
-                } elseif (
-                    $scripts_ran[ $script_converts_plugin_slug ][ $script_converts_to_version ]
-                          instanceof
-                          EE_Data_Migration_Script_Base
-                ) {
-                    // this script has been run, or at least started
-                    $script = $scripts_ran[ $script_converts_plugin_slug ][ $script_converts_to_version ];
-                    if ($script->get_status() !== self::status_completed) {
-                        // this script is already underway... keep going with it
-                        $script_classes_that_should_run_per_iteration[ $iteration ][ $script->priority() ][] = $script;
-                        $migrates_to_version                                                                 =
-                            $script->migrates_to_version();
-                        $next_database_state_to_consider[ $migrates_to_version['slug'] ]                     =
-                            $migrates_to_version['version'];
-                        unset($script_class_and_filepaths_available[ $classname ]);
-                    }
-                    // else it must have a status that indicates it has finished,
-                    // so we don't want to try and run it again
-                }
-                // else it exists, but it's not  a proper data migration script maybe the script got renamed?
-                // or was simply removed from EE? either way, it's certainly not runnable!
-            }
-            $iteration++;
-        } while ($next_database_state_to_consider !== $theoretical_database_state && $iteration < 6);
-        // ok we have all the scripts that should run, now let's make them into flat array
-        $scripts_that_should_run = [];
-        foreach ($script_classes_that_should_run_per_iteration as $scripts_at_priority) {
-            ksort($scripts_at_priority);
-            foreach ($scripts_at_priority as $scripts) {
-                foreach ($scripts as $script) {
-                    $scripts_that_should_run[ get_class($script) ] = $script;
-                }
-            }
-        }
-
-        do_action(
-            'AHEE__EE_Data_Migration_Manager__check_for_applicable_data_migration_scripts__scripts_that_should_run',
-            $scripts_that_should_run
-        );
-        return $scripts_that_should_run;
-    }
-
-
-    /**
-     * Gets the script which is currently being run, if there is one. If $include_completed_scripts is set to TRUE
-     * it will return the last run script even if it's complete.
-     * This means: if you want to find the currently-executing script, leave it as FALSE.
-     * If you really just want to find the script which ran most recently, regardless of status, leave it as TRUE.
-     *
-     * @param bool $include_completed_scripts
-     * @return EE_Data_Migration_Script_Base
-     * @throws EE_Error
-     */
-    public function get_last_ran_script($include_completed_scripts = false)
-    {
-        // make sure we've set up the class properties _last_ran_script and _last_ran_incomplete_script
-        if (! $this->_data_migrations_ran) {
-            $this->get_data_migrations_ran();
-        }
-        if ($include_completed_scripts) {
-            return $this->_last_ran_script;
-        } else {
-            return $this->_last_ran_incomplete_script;
-        }
-    }
-
-
-    /**
-     * Runs the data migration scripts (well, each request to this method calls one of the
-     * data migration scripts' migration_step() functions).
-     *
-     * @param int   $step_size
-     * @return array {
-     *                                  // where the first item is one EE_Data_Migration_Script_Base's stati,
-     *                                  //and the second item is a string describing what was done
-     * @type int    $records_to_migrate from the current migration script
-     * @type int    $records_migrated
-     * @type string $status             one of EE_Data_Migration_Manager::status_*
-     * @type string $script             verbose name of the current DMS
-     * @type string $message            string describing what was done during this step
-     *                                  }
-     * @throws EE_Error
-     */
-    public function migration_step($step_size = 0)
-    {
-
-        // bandaid fix for issue https://events.codebasehq.com/projects/event-espresso/tickets/7535
-        if (class_exists('EE_CPT_Strategy')) {
-            remove_action('pre_get_posts', [EE_CPT_Strategy::instance(), 'pre_get_posts'], 5);
-        }
-
-        try {
-            $currently_executing_script = $this->get_last_ran_script();
-            if (! $currently_executing_script) {
-                // Find the next script that needs to execute
-                $scripts = $this->check_for_applicable_data_migration_scripts();
-                if (! $scripts) {
-                    // huh, no more scripts to run... apparently we're done!
-                    // but don't forget to make sure initial data is there
-                    // we should be good to allow them to exit maintenance mode now
-                    EE_Maintenance_Mode::instance()->set_maintenance_level(
-                        EE_Maintenance_Mode::level_0_not_in_maintenance
-                    );
-                    // saving migrations run should actually be unnecessary,
-                    // but leaving in place just in case... remember this migration was finished
-                    // (even if we time out while initializing db for core and plugins)
-                    $this->_save_migrations_ran();
-                    // make sure DB was updated AFTER we've recorded the migration was done
-                    $this->initialize_db_for_enqueued_ee_plugins();
-                    return [
-                        'records_to_migrate' => 1,
-                        'records_migrated'   => 1,
-                        'status'             => self::status_no_more_migration_scripts,
-                        'script'             => esc_html__("Data Migration Completed Successfully", "event_espresso"),
-                        'message'            => esc_html__("All done!", "event_espresso"),
-                    ];
-                }
-                $currently_executing_script = array_shift($scripts);
-                // and add to the array/wp option showing the scripts run
-
-                $migrates_to                                            =
-                    $this->script_migrates_to_version(get_class($currently_executing_script));
-                $plugin_slug                                            = $migrates_to['slug'];
-                $version                                                = $migrates_to['version'];
-                $this->_data_migrations_ran[ $plugin_slug ][ $version ] = $currently_executing_script;
-            }
-            $current_script_name = get_class($currently_executing_script);
-        } catch (Exception $e) {
-            // an exception occurred while trying to get migration scripts
-
-            $message = sprintf(
-                esc_html__("Error Message: %sStack Trace:%s", "event_espresso"),
-                $e->getMessage() . '<br>',
-                $e->getTraceAsString()
-            );
-            // record it on the array of data migration scripts run. This will be overwritten next time we try and try to run data migrations
-            // but that's ok-- it's just an FYI to support that we couldn't even run any data migrations
-            $this->add_error_to_migrations_ran(
-                sprintf(esc_html__("Could not run data migrations because: %s", "event_espresso"), $message)
-            );
-            return [
-                'records_to_migrate' => 1,
-                'records_migrated'   => 0,
-                'status'             => self::status_fatal_error,
-                'script'             => esc_html__("Error loading data migration scripts", "event_espresso"),
-                'message'            => $message,
-            ];
-        }
-        // can we wrap it up and verify default data?
-        $init_dbs = false;
-        // ok so we definitely have a data migration script
-        try {
-            // how big of a bite do we want to take? Allow users to easily override via their wp-config
-            if (absint($step_size) < 1) {
-                $step_size = defined('EE_MIGRATION_STEP_SIZE') && absint(EE_MIGRATION_STEP_SIZE)
-                    ? EE_MIGRATION_STEP_SIZE
-                    : EE_Data_Migration_Manager::step_size;
-            }
-            // do what we came to do!
-            $currently_executing_script->migration_step($step_size);
-            switch ($currently_executing_script->get_status()) {
-                case EE_Data_Migration_Manager::status_continue:
-                    $response_array = [
-                        'records_to_migrate' => $currently_executing_script->count_records_to_migrate(),
-                        'records_migrated'   => $currently_executing_script->count_records_migrated(),
-                        'status'             => EE_Data_Migration_Manager::status_continue,
-                        'message'            => $currently_executing_script->get_feedback_message(),
-                        'script'             => $currently_executing_script->pretty_name(),
-                    ];
-                    break;
-                case EE_Data_Migration_Manager::status_completed:
-                    // ok so THAT script has completed
-                    $this->update_current_database_state_to($this->script_migrates_to_version($current_script_name));
-                    $response_array = [
-                        'records_to_migrate' => $currently_executing_script->count_records_to_migrate(),
-                        'records_migrated'   => $currently_executing_script->count_records_migrated(),
-                        'status'             => EE_Data_Migration_Manager::status_completed,
-                        'message'            => $currently_executing_script->get_feedback_message(),
-                        'script'             => sprintf(
-                            esc_html__("%s Completed", 'event_espresso'),
-                            $currently_executing_script->pretty_name()
-                        ),
-                    ];
-                    // check if there are any more after this one.
-                    $scripts_remaining = $this->check_for_applicable_data_migration_scripts();
-                    if (! $scripts_remaining) {
-                        // we should be good to allow them to exit maintenance mode now
-                        EE_Maintenance_Mode::instance()->set_maintenance_level(
-                            EE_Maintenance_Mode::level_0_not_in_maintenance
-                        );
-                        // huh, no more scripts to run... apparently we're done!
-                        // but don't forget to make sure initial data is there
-                        $init_dbs                 = true;
-                        $response_array['status'] = self::status_no_more_migration_scripts;
-                    }
-                    break;
-                default:
-                    $response_array = [
-                        'records_to_migrate' => $currently_executing_script->count_records_to_migrate(),
-                        'records_migrated'   => $currently_executing_script->count_records_migrated(),
-                        'status'             => $currently_executing_script->get_status(),
-                        'message'            => sprintf(
-                            esc_html__("Minor errors occurred during %s: %s", "event_espresso"),
-                            $currently_executing_script->pretty_name(),
-                            implode(", ", $currently_executing_script->get_errors())
-                        ),
-                        'script'             => $currently_executing_script->pretty_name(),
-                    ];
-                    break;
-            }
-        } catch (Exception $e) {
-            // ok so some exception was thrown which killed the data migration script
-            // double-check we have a real script
-            if ($currently_executing_script instanceof EE_Data_Migration_Script_Base) {
-                $script_name = $currently_executing_script->pretty_name();
-                $currently_executing_script->set_broken();
-                $currently_executing_script->add_error($e->getMessage());
-            } else {
-                $script_name = esc_html__("Error getting Migration Script", "event_espresso");
-            }
-            $response_array = [
-                'records_to_migrate' => 1,
-                'records_migrated'   => 0,
-                'status'             => self::status_fatal_error,
-                'message'            => sprintf(
-                    esc_html__("A fatal error occurred during the migration: %s", "event_espresso"),
-                    $e->getMessage()
-                ),
-                'script'             => $script_name,
-            ];
-        }
-        $successful_save = $this->_save_migrations_ran();
-        if ($successful_save !== true) {
-            // ok so the current wp option didn't save. that's tricky, because we'd like to update it
-            // and mark it as having a fatal error, but remember- WE CAN'T SAVE THIS WP OPTION!
-            // however, if we throw an exception, and return that, then the next request
-            // won't have as much info in it, and it may be able to save
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        "The error '%s' occurred updating the status of the migration. This is a FATAL ERROR, but the error is preventing the system from remembering that. Please contact event espresso support.",
-                        "event_espresso"
-                    ),
-                    $successful_save
-                )
-            );
-        }
-        // if we're all done, initialize EE plugins' default data etc.
-        if ($init_dbs) {
-            $this->initialize_db_for_enqueued_ee_plugins();
-        }
-        return $response_array;
-    }
-
-
-    /**
-     * Echo out JSON response to migration script AJAX requests. Takes precautions
-     * to buffer output so that we don't throw junk into our json.
-     *
-     * @return array with keys:
-     * 'records_to_migrate' which counts ALL the records for the current migration, and should remain constant. (ie,
-     * it's NOT the count of hwo many remain)
-     * 'records_migrated' which also counts ALL the records which have been migrated (ie, percent_complete =
-     * records_migrated/records_to_migrate)
-     * 'status'=>a string, one of EE_Data_migration_Manager::status_*
-     * 'message'=>a string, containing any message you want to show to the user. We may decide to split this up into
-     * errors, notifications, and successes
-     * 'script'=>a pretty name of the script currently running
-     */
-    public function response_to_migration_ajax_request()
-    {
-        ob_start();
-        try {
-            $response = $this->migration_step();
-        } catch (Exception $e) {
-            $response = [
-                'records_to_migrate' => 0,
-                'records_migrated'   => 0,
-                'status'             => EE_Data_Migration_Manager::status_fatal_error,
-                'message'            => sprintf(
-                    esc_html__("Unknown fatal error occurred: %s", "event_espresso"),
-                    $e->getMessage()
-                ),
-                'script'             => 'Unknown',
-            ];
-            $this->add_error_to_migrations_ran($e->getMessage() . "; Stack trace:" . $e->getTraceAsString());
-        }
-        $warnings_etc = @ob_get_contents();
-        ob_end_clean();
-        $response['message'] .= $warnings_etc;
-        return $response;
-    }
-
-
-    /**
-     * Updates the WordPress option that keeps track of which EE version the database
-     * is at (ie, the code may be at 4.1.0, but the database is still at 3.1.35)
-     *
-     * @param array $slug_and_version {
-     * @type string $slug             like 'Core' or 'Calendar',
-     * @type string $version          like '4.1.0'
-     *                                }
-     * @return void
-     */
-    public function update_current_database_state_to($slug_and_version = null)
-    {
-        if (! $slug_and_version) {
-            // no version was provided, assume it should be at the current code version
-            $slug_and_version = ['slug' => 'Core', 'version' => espresso_version()];
-        }
-        $current_database_state                              = get_option(self::current_database_state);
-        $current_database_state[ $slug_and_version['slug'] ] = $slug_and_version['version'];
-        update_option(self::current_database_state, $current_database_state);
-    }
-
-
-    /**
-     * Determines if the database is currently at a state matching what's indicated in $slug and $version.
-     *
-     * @param array $slug_and_version {
-     * @type string $slug             like 'Core' or 'Calendar',
-     * @type string $version          like '4.1.0'
-     *                                }
-     * @return boolean
-     */
-    public function database_needs_updating_to($slug_and_version)
-    {
-
-        $slug                   = $slug_and_version['slug'];
-        $version                = $slug_and_version['version'];
-        $current_database_state = get_option(self::current_database_state);
-        if (! isset($current_database_state[ $slug ])) {
-            return true;
-        } else {
-            // just compare the first 3 parts of version string, eg "4.7.1", not "4.7.1.dev.032" because DBs shouldn't change on nano version changes
-            $version_parts_current_db_state     = array_slice(explode('.', $current_database_state[ $slug ]), 0, 3);
-            $version_parts_of_provided_db_state = array_slice(explode('.', $version), 0, 3);
-            $needs_updating                     = false;
-            foreach ($version_parts_current_db_state as $offset => $version_part_in_current_db_state) {
-                if ($version_part_in_current_db_state < $version_parts_of_provided_db_state[ $offset ]) {
-                    $needs_updating = true;
-                    break;
-                }
-            }
-            return $needs_updating;
-        }
-    }
-
-
-    /**
-     * Gets all the data migration scripts available in the core folder and folders
-     * in addons. Has the side effect of adding them for autoloading
-     *
-     * @return array keys are expected classnames, values are their filepaths
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     */
-    public function get_all_data_migration_scripts_available()
-    {
-        if (! $this->_data_migration_class_to_filepath_map) {
-            $this->_data_migration_class_to_filepath_map = [];
-            foreach ($this->get_data_migration_script_folders() as $eeAddonClass => $folder_path) {
-                // strip any placeholders added to classname to make it a unique array key
-                $eeAddonClass = trim($eeAddonClass, '*');
-                $eeAddonClass = $eeAddonClass === 'Core' || class_exists($eeAddonClass)
-                    ? $eeAddonClass
-                    : '';
-                $folder_path  = EEH_File::end_with_directory_separator($folder_path);
-                $files        = glob($folder_path . '*.dms.php');
-                if (empty($files)) {
-                    continue;
-                }
-                foreach ($files as $file) {
-                    $pos_of_last_slash = strrpos($file, '/');
-                    $classname         = str_replace('.dms.php', '', substr($file, $pos_of_last_slash + 1));
-                    $migrates_to       = $this->script_migrates_to_version($classname, $eeAddonClass);
-                    $slug              = $migrates_to['slug'];
-                    // check that the slug as contained in the DMS is associated with
-                    // the slug of an addon or core
-                    if ($slug !== 'Core' && EE_Registry::instance()->get_addon_by_name($slug) === null) {
-                        EE_Error::doing_it_wrong(
-                            __FUNCTION__,
-                            sprintf(
-                                esc_html__(
-                                    'The data migration script "%s" migrates the "%s" data, but there is no EE addon with that name. There is only: %s. ',
-                                    'event_espresso'
-                                ),
-                                $classname,
-                                $slug,
-                                implode(', ', array_keys(EE_Registry::instance()->get_addons_by_name()))
-                            ),
-                            '4.3.0.alpha.019'
-                        );
-                    }
-                    $this->_data_migration_class_to_filepath_map[ $classname ] = $file;
-                }
-            }
-            EEH_Autoloader::register_autoloader($this->_data_migration_class_to_filepath_map);
-        }
-        return $this->_data_migration_class_to_filepath_map;
-    }
-
-
-    /**
-     * Once we have an addon that works with EE4.1, we will actually want to fetch the PUE slugs
-     * from each addon, and check if they need updating,
-     *
-     * @return boolean
-     */
-    public function addons_need_updating()
-    {
-        return false;
-    }
-
-
-    /**
-     * Adds this error string to the data_migrations_ran array, but we don't necessarily know
-     * where to put it, so we just throw it in there... better than nothing...
-     *
-     * @param string $error_message
-     */
-    public function add_error_to_migrations_ran($error_message)
-    {
-        // get last-run migration script
-        global $wpdb;
-        $last_migration_script_option = $wpdb->get_row(
-            "SELECT * FROM $wpdb->options WHERE option_name like '"
-            . EE_Data_Migration_Manager::data_migration_script_option_prefix
-            . "%' ORDER BY option_id DESC LIMIT 1",
-            ARRAY_A
-        );
-
-        $last_ran_migration_script_properties = isset($last_migration_script_option['option_value'])
-            ? maybe_unserialize($last_migration_script_option['option_value']) : null;
-        // now, tread lightly because we're here because a FATAL non-catchable error
-        // was thrown last time when we were trying to run a data migration script
-        // so the fatal error could have happened while getting the migration script
-        // or doing running it...
-        $versions_migrated_to = isset($last_migration_script_option['option_name']) ? str_replace(
-            EE_Data_Migration_Manager::data_migration_script_option_prefix,
-            "",
-            $last_migration_script_option['option_name']
-        ) : null;
-
-        // check if it THINKS it's a data migration script and especially if it's one that HASN'T finished yet
-        // because if it has finished, then it obviously couldn't be the cause of this error, right? (because it's all done)
-        if (
-            isset($last_ran_migration_script_properties['class'])
-            && isset($last_ran_migration_script_properties['_status'])
-            && $last_ran_migration_script_properties['_status'] != self::status_completed
-        ) {
-            // ok then just add this error to its list of errors
-            $last_ran_migration_script_properties['_errors'][] = $error_message;
-            $last_ran_migration_script_properties['_status']   = self::status_fatal_error;
-        } else {
-            // so we don't even know which script was last running
-            // use the data migration error stub, which is designed specifically for this type of thing
-            $general_migration_error = new EE_DMS_Unknown_1_0_0();
-            $general_migration_error->add_error($error_message);
-            $general_migration_error->set_broken();
-            $last_ran_migration_script_properties = $general_migration_error->properties_as_array();
-            $versions_migrated_to                 = 'Unknown.1.0.0';
-            // now just to make sure appears as last (in case the were previously a fatal error like this)
-            // delete the old one
-            delete_option(self::data_migration_script_option_prefix . $versions_migrated_to);
-        }
-        update_option(
-            self::data_migration_script_option_prefix . $versions_migrated_to,
-            $last_ran_migration_script_properties
-        );
-    }
-
-
-    /**
-     * saves what data migrations have run to the database
-     *
-     * @return bool|string TRUE if successfully saved migrations ran, string if an error occurred
-     * @throws EE_Error
-     */
-    protected function _save_migrations_ran()
-    {
-        if ($this->_data_migrations_ran == null) {
-            $this->get_data_migrations_ran();
-        }
-        // now, we don't want to save actual classes to the DB because that's messy
-        $successful_updates = true;
-        foreach ($this->_data_migrations_ran as $plugin_slug => $migrations_ran_for_plugin) {
-            foreach ($migrations_ran_for_plugin as $version_string => $array_or_migration_obj) {
-                $plugin_slug_for_use_in_option_name = $plugin_slug . ".";
-                $option_name                        =
-                    self::data_migration_script_option_prefix . $plugin_slug_for_use_in_option_name . $version_string;
-                $old_option_value                   = get_option($option_name);
-                if ($array_or_migration_obj instanceof EE_Data_Migration_Script_Base) {
-                    $script_array_for_saving = $array_or_migration_obj->properties_as_array();
-                    if ($old_option_value != $script_array_for_saving) {
-                        $successful_updates = update_option($option_name, $script_array_for_saving);
-                    }
-                } else {// we don't know what this array-thing is. So just save it as-is
-                    if ($old_option_value != $array_or_migration_obj) {
-                        $successful_updates = update_option($option_name, $array_or_migration_obj);
-                    }
-                }
-                if (! $successful_updates) {
-                    global $wpdb;
-                    return $wpdb->last_error;
-                }
-            }
-        }
-        return true;
-        // $updated = update_option(self::data_migrations_option_name, $array_of_migrations);
-        // if ($updated !== true) {
-        //     global $wpdb;
-        //     return $wpdb->last_error;
-        // } else {
-        //     return true;
-        // }
-        // wp_mail(
-        //     "michael@eventespresso.com",
-        //     time() . " price debug info",
-        //     "updated: $updated, last error: $last_error, byte length of option: " . strlen(
-        //         serialize($array_of_migrations)
-        //     )
-        // );
-    }
-
-
-    /**
-     * Takes an array of data migration script properties and re-creates the class from
-     * them. The argument $properties_array is assumed to have been made by
-     * EE_Data_Migration_Script_Base::properties_as_array()
-     *
-     * @param array $properties_array
-     * @return EE_Data_Migration_Script_Base
-     * @throws EE_Error
-     */
-    public function _instantiate_script_from_properties_array($properties_array)
-    {
-        if (! isset($properties_array['class'])) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__("Properties array  has no 'class' properties. Here's what it has: %s", "event_espresso"),
-                    implode(",", $properties_array)
-                )
-            );
-        }
-        $class_name = $properties_array['class'];
-        if (! class_exists($class_name)) {
-            throw new EE_Error(sprintf(
-                esc_html__("There is no migration script named %s", "event_espresso"),
-                $class_name
-            ));
-        }
-        $class = new $class_name();
-        if (! $class instanceof EE_Data_Migration_Script_Base) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        "Class '%s' is supposed to be a migration script. Its not, its a '%s'",
-                        "event_espresso"
-                    ),
-                    $class_name,
-                    get_class($class)
-                )
-            );
-        }
-        $class->instantiate_from_array_of_properties($properties_array);
-        return $class;
-    }
-
-
-    /**
-     * Gets the classname for the most up-to-date DMS (ie, the one that will finally
-     * leave the DB in a state usable by the current plugin code).
-     *
-     * @param string $plugin_slug the slug for the ee plugin we are searching for. Default is 'Core'
-     * @return string
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    public function get_most_up_to_date_dms($plugin_slug = 'Core')
-    {
-        $class_to_filepath_map         = $this->get_all_data_migration_scripts_available();
-        $most_up_to_date_dms_classname = null;
-        foreach ($class_to_filepath_map as $classname => $filepath) {
-            if ($most_up_to_date_dms_classname === null) {
-                $migrates_to      = $this->script_migrates_to_version($classname);
-                $this_plugin_slug = $migrates_to['slug'];
-                if ($this_plugin_slug == $plugin_slug) {
-                    // if it's for core, it wins
-                    $most_up_to_date_dms_classname = $classname;
-                }
-                // if it wasn't for core, we must keep searching for one that is!
-                continue;
-            }
-            $champion_migrates_to  = $this->script_migrates_to_version($most_up_to_date_dms_classname);
-            $contender_migrates_to = $this->script_migrates_to_version($classname);
-            if (
-                $contender_migrates_to['slug'] == $plugin_slug
-                && version_compare(
-                    $champion_migrates_to['version'],
-                    $contender_migrates_to['version'],
-                    '<'
-                )
-            ) {
-                // so the contenders version is higher, and it's for Core
-                $most_up_to_date_dms_classname = $classname;
-            }
-        }
-        return $most_up_to_date_dms_classname;
-    }
-
-
-    /**
-     * Gets the migration script specified but ONLY if it has already run.
-     *
-     * Eg, if you wanted to see if 'EE_DMS_Core_4_1_0' has run, you would run the following code:
-     * <code> $core_4_1_0_dms_ran = EE_Data_Migration_Manager::instance()->get_migration_ran( '4.1.0', 'Core' ) !==
-     * NULL;</code> This is especially useful in addons' data migration scripts, this way they can tell if a core (or
-     * other addon) DMS has run, in case the current DMS depends on it.
-     *
-     * @param string $version     the version the DMS searched for migrates to. Usually just the content before the 3rd
-     *                            period. Eg '4.1.0'
-     * @param string $plugin_slug like 'Core', 'Mailchimp', 'Calendar', etc
-     * @return EE_Data_Migration_Script_Base
-     * @throws EE_Error
-     */
-    public function get_migration_ran($version, $plugin_slug = 'Core')
-    {
-        $migrations_ran = $this->get_data_migrations_ran();
-        if (isset($migrations_ran[ $plugin_slug ]) && isset($migrations_ran[ $plugin_slug ][ $version ])) {
-            return $migrations_ran[ $plugin_slug ][ $version ];
-        } else {
-            return null;
-        }
-    }
-
-
-    /**
-     * Resets the borked data migration scripts, so they're no longer borked, and we can again attempt to migrate
-     *
-     * @return bool
-     * @throws EE_Error
-     */
-    public function reattempt()
-    {
-        // find if the last-run script was borked
-        // set it as being non-borked (we shouldn't ever get DMSs that we don't recognize)
-        // add an 'error' saying that we attempted to reset
-        // does it have a stage that was borked too? if so make it no longer borked
-        // add an 'error' saying we attempted to reset
-        $last_ran_script = $this->get_last_ran_script();
-        if ($last_ran_script instanceof EE_DMS_Unknown_1_0_0) {
-            // if it was an error DMS, just mark it as complete (if another error occurs it will overwrite it)
-            $last_ran_script->set_completed();
-        } elseif ($last_ran_script instanceof EE_Data_Migration_Script_Base) {
-            $last_ran_script->reattempt();
-        } else {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'Unable to reattempt the last ran migration script because it was not a valid migration script. || It was %s',
-                        'event_espresso'
-                    ),
-                    print_r($last_ran_script, true)
-                )
-            );
-        }
-        return $this->_save_migrations_ran();
-    }
-
-
-    /**
-     * Gets whether this particular migration has run or not
-     *
-     * @param string $version     the version the DMS searched for migrates to. Usually just the content before the 3rd
-     *                            period. Eg '4.1.0'
-     * @param string $plugin_slug like 'Core', 'Mailchimp', 'Calendar', etc
-     * @return boolean
-     * @throws EE_Error
-     */
-    public function migration_has_ran($version, $plugin_slug = 'Core')
-    {
-        return $this->get_migration_ran($version, $plugin_slug) !== null;
-    }
-
-
-    /**
-     * Enqueues this ee plugin to have its data initialized
-     *
-     * @param string $plugin_slug either 'Core' or EE_Addon::name()'s return value
-     */
-    public function enqueue_db_initialization_for($plugin_slug)
-    {
-        $queue = $this->get_db_initialization_queue();
-        if (! in_array($plugin_slug, $queue)) {
-            $queue[] = $plugin_slug;
-        }
-        update_option(self::db_init_queue_option_name, $queue);
-    }
-
-
-    /**
-     * Calls EE_Addon::initialize_db_if_no_migrations_required() on each addon
-     * specified in EE_Data_Migration_Manager::get_db_init_queue(), and if 'Core' is
-     * in the queue, calls EE_System::initialize_db_if_no_migrations_required().
-     *
-     * @throws EE_Error
-     */
-    public function initialize_db_for_enqueued_ee_plugins()
-    {
-        $queue = $this->get_db_initialization_queue();
-        foreach ($queue as $plugin_slug) {
-            $most_up_to_date_dms = $this->get_most_up_to_date_dms($plugin_slug);
-            if (! $most_up_to_date_dms) {
-                // if there is NO DMS for this plugin, obviously there's no schema to verify anyways
-                $verify_db = false;
-            } else {
-                $most_up_to_date_dms_migrates_to = $this->script_migrates_to_version($most_up_to_date_dms);
-                $verify_db                       = $this->database_needs_updating_to($most_up_to_date_dms_migrates_to);
-            }
-            if ($plugin_slug == 'Core') {
-                EE_System::instance()->initialize_db_if_no_migrations_required(
-                    false,
-                    $verify_db
-                );
-            } else {
-                // just loop through the addons to make sure their database is set up
-                foreach (EE_Registry::instance()->addons as $addon) {
-                    if ($addon->name() == $plugin_slug) {
-                        $addon->initialize_db_if_no_migrations_required($verify_db);
-                        break;
-                    }
-                }
-            }
-        }
-        // because we just initialized the DBs for the enqueued ee plugins
-        // we don't need to keep remembering which ones needed to be initialized
-        delete_option(self::db_init_queue_option_name);
-    }
-
-
-    /**
-     * Gets a numerically-indexed array of plugin slugs that need to have their databases
-     * (re-)initialized after migrations are complete. ie, each element should be either
-     * 'Core', or the return value of EE_Addon::name() for an addon
-     *
-     * @return array
-     */
-    public function get_db_initialization_queue()
-    {
-        return get_option(self::db_init_queue_option_name, []);
-    }
-
-
-    /**
-     * Gets the injected table analyzer, or throws an exception
-     *
-     * @return TableAnalysis
-     * @throws EE_Error
-     */
-    protected function _get_table_analysis()
-    {
-        if ($this->_table_analysis instanceof TableAnalysis) {
-            return $this->_table_analysis;
-        } else {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__('Table analysis class on class %1$s is not set properly.', 'event_espresso'),
-                    get_class($this)
-                )
-            );
-        }
-    }
-
-
-    /**
-     * Gets the injected table manager, or throws an exception
-     *
-     * @return TableManager
-     * @throws EE_Error
-     */
-    protected function _get_table_manager()
-    {
-        if ($this->_table_manager instanceof TableManager) {
-            return $this->_table_manager;
-        } else {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__('Table manager class on class %1$s is not set properly.', 'event_espresso'),
-                    get_class($this)
-                )
-            );
-        }
-    }
+	/**
+	 *
+	 * @var EE_Registry
+	 */
+	// protected $EE;
+	/**
+	 * name of the WordPress option which stores an array of data about
+	 */
+	const data_migrations_option_name = 'ee_data_migration';
+
+
+	const data_migration_script_option_prefix         = 'ee_data_migration_script_';
+
+	const data_migration_script_mapping_option_prefix = 'ee_dms_map_';
+
+	/**
+	 * name of the WordPress option which stores the database' current version. IE, the code may be at version 4.2.0,
+	 * but as migrations are performed the database will progress from 3.1.35 to 4.1.0 etc.
+	 */
+	const current_database_state = 'ee_data_migration_current_db_state';
+
+	/**
+	 * Special status string returned when we're positive there are no more data migration
+	 * scripts that can be run.
+	 */
+	const status_no_more_migration_scripts = 'no_more_migration_scripts';
+
+	/**
+	 * string indicating the migration should continue
+	 */
+	const status_continue = 'status_continue';
+
+	/**
+	 * string indicating the migration has completed and should be ended
+	 */
+	const status_completed = 'status_completed';
+
+	/**
+	 * string indicating a fatal error occurred and the data migration should be completely aborted
+	 */
+	const status_fatal_error = 'status_fatal_error';
+
+	/**
+	 * the number of 'items' (usually DB rows) to migrate on each 'step' (ajax request sent
+	 * during migration)
+	 */
+	const step_size = 50;
+
+	/**
+	 * option name that stores the queue of ee plugins needing to have
+	 * their data initialized (or re-initialized) once we are done migrations
+	 */
+	const db_init_queue_option_name = 'ee_db_init_queue';
+
+	/**
+	 * Array of information concerning data migrations that have run in the history
+	 * of this EE installation. Keys should be the name of the version the script upgraded to
+	 *
+	 * @var EE_Data_Migration_Script_Base[]
+	 */
+	private $_data_migrations_ran = null;
+
+	/**
+	 * The last run script. It's nice to store this somewhere accessible, as its easiest
+	 * to know which was the last run by which is the newest wp option; but in most of the code
+	 * we just use the local $_data_migration_ran array, which organized the scripts differently
+	 *
+	 * @var EE_Data_Migration_Script_Base
+	 */
+	private $_last_ran_script = null;
+
+	/**
+	 * Similarly to _last_ran_script, but this is the last INCOMPLETE migration script.
+	 *
+	 * @var EE_Data_Migration_Script_Base
+	 */
+	private $_last_ran_incomplete_script = null;
+
+	/**
+	 * array where keys are classnames, and values are filepaths of all the known migration scripts
+	 *
+	 * @var array
+	 */
+	private $_data_migration_class_to_filepath_map;
+
+	/**
+	 * the following 4 properties are fully set on construction.
+	 * Note: the first two apply to whether to continue running ALL migration scripts (ie, even though we're finished
+	 * one, we may want to start the next one); whereas the last two indicate whether to continue running a single
+	 * data migration script
+	 *
+	 * @var array
+	 */
+	public $stati_that_indicate_to_continue_migrations              = [];
+
+	public $stati_that_indicate_to_stop_migrations                  = [];
+
+	public $stati_that_indicate_to_continue_single_migration_script = [];
+
+	public $stati_that_indicate_to_stop_single_migration_script     = [];
+
+	/**
+	 * @var TableManager $table_manager
+	 */
+	protected $_table_manager;
+
+	/**
+	 * @var TableAnalysis $table_analysis
+	 */
+	protected $_table_analysis;
+
+	/**
+	 * @var array $script_migration_versions
+	 */
+	protected $script_migration_versions;
+
+	/**
+	 * @var EE_Data_Migration_Manager $_instance
+	 * @access    private
+	 */
+	private static $_instance = null;
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @access    public
+	 * @return EE_Data_Migration_Manager instance
+	 */
+	public static function instance()
+	{
+		// check if class object is instantiated
+		if (! self::$_instance instanceof EE_Data_Migration_Manager) {
+			self::$_instance = new self();
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * resets the singleton to its brand-new state (but does NOT delete old references to the old singleton. Meaning,
+	 * all new usages of the singleton should be made with Classname::instance()) and returns it
+	 *
+	 * @return EE_Data_Migration_Manager
+	 */
+	public static function reset()
+	{
+		self::$_instance = null;
+		return self::instance();
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function __construct()
+	{
+		$this->stati_that_indicate_to_continue_migrations              = [
+			self::status_continue,
+			self::status_completed,
+		];
+		$this->stati_that_indicate_to_stop_migrations                  = [
+			self::status_fatal_error,
+			self::status_no_more_migration_scripts,
+		];
+		$this->stati_that_indicate_to_continue_single_migration_script = [
+			self::status_continue,
+		];
+		$this->stati_that_indicate_to_stop_single_migration_script     = [
+			self::status_completed,
+			self::status_fatal_error
+			// note: status_no_more_migration_scripts doesn't apply
+		];
+		// make sure we've included the base migration script, because we may need the EE_DMS_Unknown_1_0_0 class
+		// to be defined, because right now it doesn't get autoloaded on its own
+		EE_Registry::instance()->load_core('Data_Migration_Class_Base', [], true);
+		EE_Registry::instance()->load_core('Data_Migration_Script_Base', [], true);
+		EE_Registry::instance()->load_core('DMS_Unknown_1_0_0', [], true);
+		EE_Registry::instance()->load_core('Data_Migration_Script_Stage', [], true);
+		EE_Registry::instance()->load_core('Data_Migration_Script_Stage_Table', [], true);
+		$this->_table_manager  = EE_Registry::instance()->create('TableManager', [], true);
+		$this->_table_analysis = EE_Registry::instance()->create('TableAnalysis', [], true);
+	}
+
+
+	/**
+	 * Deciphers, from an option's name, what plugin and version it relates to (see _save_migrations_ran to see what
+	 * the option names are like, but generally they're like
+	 * 'ee_data_migration_script_Core.4.1.0' in 4.2 or 'ee_data_migration_script_4.1.0' before that).
+	 * The option name shouldn't ever be like 'ee_data_migration_script_Core.4.1.0.reg' because it's derived,
+	 * indirectly, from the data migration's classname, which should always be like EE_DMS_%s_%d_%d_%d.dms.php
+	 * (ex: EE_DMS_Core_4_1_0.dms.php)
+	 *
+	 * @param string $option_name (see EE_Data_Migration_Manage::_save_migrations_ran() where the option name is set)
+	 * @return array where the first item is the plugin slug (eg 'Core','Calendar', etc.) and the 2nd is the version of
+	 *                            that plugin (eg '4.1.0')
+	 */
+	private function _get_plugin_slug_and_version_string_from_dms_option_name($option_name)
+	{
+		$plugin_slug_and_version_string = str_replace(
+			EE_Data_Migration_Manager::data_migration_script_option_prefix,
+			"",
+			$option_name
+		);
+		// check if $plugin_slug_and_version_string is like '4.1.0' (4.1-style) or 'Core.4.1.0' (4.2-style)
+		$parts = explode(".", $plugin_slug_and_version_string);
+
+		if (count($parts) == 4) {
+			// it's 4.2-style.eg Core.4.1.0
+			$plugin_slug    = $parts[0];                                     // eg Core
+			$version_string = $parts[1] . "." . $parts[2] . "." . $parts[3]; // eg 4.1.0
+		} else {
+			// it's 4.1-style: eg 4.1.0
+			$plugin_slug    = 'Core';
+			$version_string = $plugin_slug_and_version_string;// eg 4.1.0
+		}
+		return [$plugin_slug, $version_string];
+	}
+
+
+	/**
+	 * Gets the DMS class from the WordPress option, otherwise throws an EE_Error if it's not
+	 * for a known DMS class.
+	 *
+	 * @param string $dms_option_name
+	 * @param string $dms_option_value (serialized)
+	 * @return EE_Data_Migration_Script_Base
+	 * @throws EE_Error
+	 */
+	private function _get_dms_class_from_wp_option($dms_option_name, $dms_option_value)
+	{
+		$data_migration_data = maybe_unserialize($dms_option_value);
+		if (isset($data_migration_data['class']) && class_exists($data_migration_data['class'])) {
+			// During multisite migrations, it's possible we already grabbed another instance of this class
+			// but for a different blog. Make sure we don't reuse them (as they store info specific
+			// to their respective blog, like which database table to migrate).
+			$class = LoaderFactory::getLoader()->getNew($data_migration_data['class']);
+			if ($class instanceof EE_Data_Migration_Script_Base) {
+				$class->instantiate_from_array_of_properties($data_migration_data);
+				return $class;
+			} else {
+				// huh, so it's an object but not a data migration script?? that shouldn't happen
+				// just leave it as an array (which will probably just get ignored)
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							"Trying to retrieve DMS class from wp option. No DMS by the name '%s' exists",
+							'event_espresso'
+						),
+						$data_migration_data['class']
+					)
+				);
+			}
+		} else {
+			// so the data doesn't specify a class. So it must either be a legacy array of info or some array (which we'll probably just ignore), or a class that no longer exists
+			throw new EE_Error(
+				sprintf(
+					esc_html__("The wp option  with key '%s' does not represent a DMS", 'event_espresso'),
+					$dms_option_name
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * Gets the array describing what data migrations have run.
+	 * Also has a side effect of recording which was the last run,
+	 * and which was the last run which hasn't finished yet
+	 *
+	 * @return array where each element should be an array of EE_Data_Migration_Script_Base
+	 *               (but also has a few legacy arrays in there - which should probably be ignored)
+	 * @throws EE_Error
+	 */
+	public function get_data_migrations_ran()
+	{
+		if (! $this->_data_migrations_ran) {
+			// setup autoloaders for each of the scripts in there
+			$this->get_all_data_migration_scripts_available();
+			$data_migrations_options =
+				$this->get_all_migration_script_options();// get_option(EE_Data_Migration_Manager::data_migrations_option_name,get_option('espresso_data_migrations',array()));
+
+			$data_migrations_ran = [];
+			// convert into data migration script classes where possible
+			foreach ($data_migrations_options as $data_migration_option) {
+				list($plugin_slug, $version_string) = $this->_get_plugin_slug_and_version_string_from_dms_option_name(
+					$data_migration_option['option_name']
+				);
+
+				try {
+					$class                                                  = $this->_get_dms_class_from_wp_option(
+						$data_migration_option['option_name'],
+						$data_migration_option['option_value']
+					);
+					$data_migrations_ran[ $plugin_slug ][ $version_string ] = $class;
+					// ok so far THIS is the 'last-run-script'... unless we find another on next iteration
+					$this->_last_ran_script = $class;
+					if (! $class->is_completed()) {
+						// sometimes we also like to know which was the last incomplete script (or if there are any at all)
+						$this->_last_ran_incomplete_script = $class;
+					}
+				} catch (EE_Error $e) {
+					// ok so it's not a DMS. We'll just keep it, although other code will need to expect non-DMSs
+					$data_migrations_ran[ $plugin_slug ][ $version_string ] = maybe_unserialize(
+						$data_migration_option['option_value']
+					);
+				}
+			}
+			// so here the array of $data_migrations_ran is actually a mix of classes and a few legacy arrays
+			$this->_data_migrations_ran = $data_migrations_ran;
+			if (! $this->_data_migrations_ran || ! is_array($this->_data_migrations_ran)) {
+				$this->_data_migrations_ran = [];
+			}
+		}
+		return $this->_data_migrations_ran;
+	}
+
+
+	/**
+	 *
+	 * @param string $script_name eg 'DMS_Core_4_1_0'
+	 * @param string $old_table   eg 'wp_events_detail'
+	 * @param string $old_pk      eg 'wp_esp_posts'
+	 * @param        $new_table
+	 * @return mixed string or int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_mapping_new_pk($script_name, $old_table, $old_pk, $new_table)
+	{
+		$script  = EE_Registry::instance()->load_dms($script_name);
+		return $script->get_mapping_new_pk($old_table, $old_pk, $new_table);
+	}
+
+
+	/**
+	 * Gets all the options containing migration scripts that have been run. Ordering is important: it's assumed that
+	 * the last option returned in this array is the most-recently run DMS option
+	 *
+	 * @return array
+	 */
+	public function get_all_migration_script_options()
+	{
+		global $wpdb;
+		return $wpdb->get_results(
+			"SELECT * FROM {$wpdb->options} WHERE option_name like '"
+			. EE_Data_Migration_Manager::data_migration_script_option_prefix
+			. "%' ORDER BY option_id ASC",
+			ARRAY_A
+		);
+	}
+
+
+	/**
+	 * Gets the array of folders which contain data migration scripts. Also adds them to be auto-loaded
+	 *
+	 * @return array where each value is the full folder path of a folder containing data migration scripts, WITH
+	 *               slashes at the end of the folder name.
+	 */
+	public function get_data_migration_script_folders()
+	{
+		return apply_filters(
+			'FHEE__EE_Data_Migration_Manager__get_data_migration_script_folders',
+			['Core' => EE_CORE . 'data_migration_scripts']
+		);
+	}
+
+
+	/**
+	 * Gets the version the migration script upgrades to
+	 *
+	 * @param string $migration_script_name eg 'EE_DMS_Core_4_1_0'
+	 * @return array {
+	 *      @type string  $slug     like 'Core','Calendar',etc
+	 *      @type string  $version  like 4.3.0
+	 * }
+	 * @throws EE_Error
+	 */
+	public function script_migrates_to_version($migration_script_name, $eeAddonClass = '')
+	{
+		if (isset($this->script_migration_versions[ $migration_script_name ])) {
+			return $this->script_migration_versions[ $migration_script_name ];
+		}
+		$dms_info                                                  = $this->parse_dms_classname($migration_script_name);
+		$this->script_migration_versions[ $migration_script_name ] = [
+			'slug'    => $eeAddonClass !== '' ? $eeAddonClass : $dms_info['slug'],
+			'version' => $dms_info['major_version']
+						 . "."
+						 . $dms_info['minor_version']
+						 . "."
+						 . $dms_info['micro_version'],
+		];
+		return $this->script_migration_versions[ $migration_script_name ];
+	}
+
+
+	/**
+	 * Gets the juicy details out of a dms filename like 'EE_DMS_Core_4_1_0'
+	 *
+	 * @param string $classname
+	 * @return array with keys 'slug','major_version','minor_version', and 'micro_version' (the last 3 are integers)
+	 * @throws EE_Error
+	 */
+	public function parse_dms_classname($classname)
+	{
+		$matches = [];
+		preg_match('~EE_DMS_(.*)_([0-9]*)_([0-9]*)_([0-9]*)~', $classname, $matches);
+		if (! $matches || ! (isset($matches[1]) && isset($matches[2]) && isset($matches[3]))) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						"%s is not a valid Data Migration Script. The classname should be like EE_DMS_w_x_y_z, where w is either 'Core' or the slug of an addon and x, y and z are numbers, ",
+						"event_espresso"
+					),
+					$classname
+				)
+			);
+		}
+		return [
+			'slug'          => $matches[1],
+			'major_version' => intval($matches[2]),
+			'minor_version' => intval($matches[3]),
+			'micro_version' => intval($matches[4]),
+		];
+	}
+
+
+	/**
+	 * Ensures that the option indicating the current DB version is set. This should only be
+	 * a concern when activating EE for the first time, THEORETICALLY.
+	 * If we detect that we're activating EE4 over top of EE3.1, then we set the current db state to 3.1.x, otherwise
+	 * to 4.1.x.
+	 *
+	 * @return string of current db state
+	 */
+	public function ensure_current_database_state_is_set()
+	{
+		$espresso_db_core_updates = get_option('espresso_db_update', []);
+		$db_state                 = get_option(EE_Data_Migration_Manager::current_database_state);
+		if (! $db_state) {
+			// mark the DB as being in the state as the last version in there.
+			// this is done to trigger maintenance mode and do data migration scripts
+			// if the admin installed this version of EE over 3.1.x or 4.0.x
+			// otherwise, the normal maintenance mode code is fine
+			$previous_versions_installed = array_keys($espresso_db_core_updates);
+			$previous_version_installed  = end($previous_versions_installed);
+			if (version_compare('4.1.0', $previous_version_installed)) {
+				// last installed version was less than 4.1, so we want the data migrations to happen.
+				// SO, we're going to say the DB is at that state
+				$db_state = ['Core' => $previous_version_installed];
+			} else {
+				$db_state = ['Core' => EVENT_ESPRESSO_VERSION];
+			}
+			update_option(EE_Data_Migration_Manager::current_database_state, $db_state);
+		}
+		// in 4.1, $db_state would have only been a simple string like '4.1.0',
+		// but in 4.2+ it should be an array with at least key 'Core' and the value of that plugin's
+		// db, and possibly other keys for other addons like 'Calendar','Permissions',etc
+		if (! is_array($db_state)) {
+			$db_state = ['Core' => $db_state];
+			update_option(EE_Data_Migration_Manager::current_database_state, $db_state);
+		}
+		return $db_state;
+	}
+
+
+	/**
+	 * Checks if there are any data migration scripts that ought to be run.
+	 * If found, returns the instantiated classes.
+	 * If none are found (ie, they've all already been run, or they don't apply), returns an empty array
+	 *
+	 * @return EE_Data_Migration_Script_Base[]
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	public function check_for_applicable_data_migration_scripts()
+	{
+		// get the option describing what options have already run
+		$scripts_ran = $this->get_data_migrations_ran();
+		// $scripts_ran = array('4.1.0.core'=>array('monkey'=>null));
+		$script_class_and_filepaths_available = $this->get_all_data_migration_scripts_available();
+
+
+		$current_database_state = $this->ensure_current_database_state_is_set();
+		// determine which have already been run
+		$script_classes_that_should_run_per_iteration = [];
+		$iteration                                    = 0;
+		$next_database_state_to_consider              = $current_database_state;
+		$theoretical_database_state = null;
+		do {
+			// the next state after the currently-considered one
+			// will start off looking the same as the current, but we may make additions...
+			$theoretical_database_state = $next_database_state_to_consider;
+			// the next db state to consider is
+			// "what would the DB be like had we run all the scripts we found that applied last time?"
+			foreach ($script_class_and_filepaths_available as $classname => $filepath) {
+				$migrates_to_version         = $this->script_migrates_to_version($classname);
+				$script_converts_plugin_slug = $migrates_to_version['slug'];
+				$script_converts_to_version  = $migrates_to_version['version'];
+				// check if this version script is DONE or not; or if it's never been run
+				if (
+					! $scripts_ran
+					|| ! isset($scripts_ran[ $script_converts_plugin_slug ][ $script_converts_to_version ])
+				) {
+					// we haven't run this conversion script before
+					// now check if it applies...
+					// note that we've added an autoloader for it on get_all_data_migration_scripts_available
+					// Also, make sure we get a new one. It's possible this is being ran during a multisite migration,
+					// in which case we don't want to reuse a DMS script from a different blog!
+					$script = LoaderFactory::getLoader()->getNew($classname);
+					/* @var $script EE_Data_Migration_Script_Base */
+					$can_migrate = $script->can_migrate_from_version($theoretical_database_state);
+					if ($can_migrate) {
+						$script_classes_that_should_run_per_iteration[ $iteration ][ $script->priority() ][] = $script;
+						$migrates_to_version                                                                 =
+							$script->migrates_to_version();
+						$next_database_state_to_consider[ $migrates_to_version['slug'] ]                     =
+							$migrates_to_version['version'];
+						unset($script_class_and_filepaths_available[ $classname ]);
+					}
+				} elseif (
+					$scripts_ran[ $script_converts_plugin_slug ][ $script_converts_to_version ]
+						  instanceof
+						  EE_Data_Migration_Script_Base
+				) {
+					// this script has been run, or at least started
+					$script = $scripts_ran[ $script_converts_plugin_slug ][ $script_converts_to_version ];
+					if ($script->get_status() !== self::status_completed) {
+						// this script is already underway... keep going with it
+						$script_classes_that_should_run_per_iteration[ $iteration ][ $script->priority() ][] = $script;
+						$migrates_to_version                                                                 =
+							$script->migrates_to_version();
+						$next_database_state_to_consider[ $migrates_to_version['slug'] ]                     =
+							$migrates_to_version['version'];
+						unset($script_class_and_filepaths_available[ $classname ]);
+					}
+					// else it must have a status that indicates it has finished,
+					// so we don't want to try and run it again
+				}
+				// else it exists, but it's not  a proper data migration script maybe the script got renamed?
+				// or was simply removed from EE? either way, it's certainly not runnable!
+			}
+			$iteration++;
+		} while ($next_database_state_to_consider !== $theoretical_database_state && $iteration < 6);
+		// ok we have all the scripts that should run, now let's make them into flat array
+		$scripts_that_should_run = [];
+		foreach ($script_classes_that_should_run_per_iteration as $scripts_at_priority) {
+			ksort($scripts_at_priority);
+			foreach ($scripts_at_priority as $scripts) {
+				foreach ($scripts as $script) {
+					$scripts_that_should_run[ get_class($script) ] = $script;
+				}
+			}
+		}
+
+		do_action(
+			'AHEE__EE_Data_Migration_Manager__check_for_applicable_data_migration_scripts__scripts_that_should_run',
+			$scripts_that_should_run
+		);
+		return $scripts_that_should_run;
+	}
+
+
+	/**
+	 * Gets the script which is currently being run, if there is one. If $include_completed_scripts is set to TRUE
+	 * it will return the last run script even if it's complete.
+	 * This means: if you want to find the currently-executing script, leave it as FALSE.
+	 * If you really just want to find the script which ran most recently, regardless of status, leave it as TRUE.
+	 *
+	 * @param bool $include_completed_scripts
+	 * @return EE_Data_Migration_Script_Base
+	 * @throws EE_Error
+	 */
+	public function get_last_ran_script($include_completed_scripts = false)
+	{
+		// make sure we've set up the class properties _last_ran_script and _last_ran_incomplete_script
+		if (! $this->_data_migrations_ran) {
+			$this->get_data_migrations_ran();
+		}
+		if ($include_completed_scripts) {
+			return $this->_last_ran_script;
+		} else {
+			return $this->_last_ran_incomplete_script;
+		}
+	}
+
+
+	/**
+	 * Runs the data migration scripts (well, each request to this method calls one of the
+	 * data migration scripts' migration_step() functions).
+	 *
+	 * @param int   $step_size
+	 * @return array {
+	 *                                  // where the first item is one EE_Data_Migration_Script_Base's stati,
+	 *                                  //and the second item is a string describing what was done
+	 * @type int    $records_to_migrate from the current migration script
+	 * @type int    $records_migrated
+	 * @type string $status             one of EE_Data_Migration_Manager::status_*
+	 * @type string $script             verbose name of the current DMS
+	 * @type string $message            string describing what was done during this step
+	 *                                  }
+	 * @throws EE_Error
+	 */
+	public function migration_step($step_size = 0)
+	{
+
+		// bandaid fix for issue https://events.codebasehq.com/projects/event-espresso/tickets/7535
+		if (class_exists('EE_CPT_Strategy')) {
+			remove_action('pre_get_posts', [EE_CPT_Strategy::instance(), 'pre_get_posts'], 5);
+		}
+
+		try {
+			$currently_executing_script = $this->get_last_ran_script();
+			if (! $currently_executing_script) {
+				// Find the next script that needs to execute
+				$scripts = $this->check_for_applicable_data_migration_scripts();
+				if (! $scripts) {
+					// huh, no more scripts to run... apparently we're done!
+					// but don't forget to make sure initial data is there
+					// we should be good to allow them to exit maintenance mode now
+					EE_Maintenance_Mode::instance()->set_maintenance_level(
+						EE_Maintenance_Mode::level_0_not_in_maintenance
+					);
+					// saving migrations run should actually be unnecessary,
+					// but leaving in place just in case... remember this migration was finished
+					// (even if we time out while initializing db for core and plugins)
+					$this->_save_migrations_ran();
+					// make sure DB was updated AFTER we've recorded the migration was done
+					$this->initialize_db_for_enqueued_ee_plugins();
+					return [
+						'records_to_migrate' => 1,
+						'records_migrated'   => 1,
+						'status'             => self::status_no_more_migration_scripts,
+						'script'             => esc_html__("Data Migration Completed Successfully", "event_espresso"),
+						'message'            => esc_html__("All done!", "event_espresso"),
+					];
+				}
+				$currently_executing_script = array_shift($scripts);
+				// and add to the array/wp option showing the scripts run
+
+				$migrates_to                                            =
+					$this->script_migrates_to_version(get_class($currently_executing_script));
+				$plugin_slug                                            = $migrates_to['slug'];
+				$version                                                = $migrates_to['version'];
+				$this->_data_migrations_ran[ $plugin_slug ][ $version ] = $currently_executing_script;
+			}
+			$current_script_name = get_class($currently_executing_script);
+		} catch (Exception $e) {
+			// an exception occurred while trying to get migration scripts
+
+			$message = sprintf(
+				esc_html__("Error Message: %sStack Trace:%s", "event_espresso"),
+				$e->getMessage() . '<br>',
+				$e->getTraceAsString()
+			);
+			// record it on the array of data migration scripts run. This will be overwritten next time we try and try to run data migrations
+			// but that's ok-- it's just an FYI to support that we couldn't even run any data migrations
+			$this->add_error_to_migrations_ran(
+				sprintf(esc_html__("Could not run data migrations because: %s", "event_espresso"), $message)
+			);
+			return [
+				'records_to_migrate' => 1,
+				'records_migrated'   => 0,
+				'status'             => self::status_fatal_error,
+				'script'             => esc_html__("Error loading data migration scripts", "event_espresso"),
+				'message'            => $message,
+			];
+		}
+		// can we wrap it up and verify default data?
+		$init_dbs = false;
+		// ok so we definitely have a data migration script
+		try {
+			// how big of a bite do we want to take? Allow users to easily override via their wp-config
+			if (absint($step_size) < 1) {
+				$step_size = defined('EE_MIGRATION_STEP_SIZE') && absint(EE_MIGRATION_STEP_SIZE)
+					? EE_MIGRATION_STEP_SIZE
+					: EE_Data_Migration_Manager::step_size;
+			}
+			// do what we came to do!
+			$currently_executing_script->migration_step($step_size);
+			switch ($currently_executing_script->get_status()) {
+				case EE_Data_Migration_Manager::status_continue:
+					$response_array = [
+						'records_to_migrate' => $currently_executing_script->count_records_to_migrate(),
+						'records_migrated'   => $currently_executing_script->count_records_migrated(),
+						'status'             => EE_Data_Migration_Manager::status_continue,
+						'message'            => $currently_executing_script->get_feedback_message(),
+						'script'             => $currently_executing_script->pretty_name(),
+					];
+					break;
+				case EE_Data_Migration_Manager::status_completed:
+					// ok so THAT script has completed
+					$this->update_current_database_state_to($this->script_migrates_to_version($current_script_name));
+					$response_array = [
+						'records_to_migrate' => $currently_executing_script->count_records_to_migrate(),
+						'records_migrated'   => $currently_executing_script->count_records_migrated(),
+						'status'             => EE_Data_Migration_Manager::status_completed,
+						'message'            => $currently_executing_script->get_feedback_message(),
+						'script'             => sprintf(
+							esc_html__("%s Completed", 'event_espresso'),
+							$currently_executing_script->pretty_name()
+						),
+					];
+					// check if there are any more after this one.
+					$scripts_remaining = $this->check_for_applicable_data_migration_scripts();
+					if (! $scripts_remaining) {
+						// we should be good to allow them to exit maintenance mode now
+						EE_Maintenance_Mode::instance()->set_maintenance_level(
+							EE_Maintenance_Mode::level_0_not_in_maintenance
+						);
+						// huh, no more scripts to run... apparently we're done!
+						// but don't forget to make sure initial data is there
+						$init_dbs                 = true;
+						$response_array['status'] = self::status_no_more_migration_scripts;
+					}
+					break;
+				default:
+					$response_array = [
+						'records_to_migrate' => $currently_executing_script->count_records_to_migrate(),
+						'records_migrated'   => $currently_executing_script->count_records_migrated(),
+						'status'             => $currently_executing_script->get_status(),
+						'message'            => sprintf(
+							esc_html__("Minor errors occurred during %s: %s", "event_espresso"),
+							$currently_executing_script->pretty_name(),
+							implode(", ", $currently_executing_script->get_errors())
+						),
+						'script'             => $currently_executing_script->pretty_name(),
+					];
+					break;
+			}
+		} catch (Exception $e) {
+			// ok so some exception was thrown which killed the data migration script
+			// double-check we have a real script
+			if ($currently_executing_script instanceof EE_Data_Migration_Script_Base) {
+				$script_name = $currently_executing_script->pretty_name();
+				$currently_executing_script->set_broken();
+				$currently_executing_script->add_error($e->getMessage());
+			} else {
+				$script_name = esc_html__("Error getting Migration Script", "event_espresso");
+			}
+			$response_array = [
+				'records_to_migrate' => 1,
+				'records_migrated'   => 0,
+				'status'             => self::status_fatal_error,
+				'message'            => sprintf(
+					esc_html__("A fatal error occurred during the migration: %s", "event_espresso"),
+					$e->getMessage()
+				),
+				'script'             => $script_name,
+			];
+		}
+		$successful_save = $this->_save_migrations_ran();
+		if ($successful_save !== true) {
+			// ok so the current wp option didn't save. that's tricky, because we'd like to update it
+			// and mark it as having a fatal error, but remember- WE CAN'T SAVE THIS WP OPTION!
+			// however, if we throw an exception, and return that, then the next request
+			// won't have as much info in it, and it may be able to save
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						"The error '%s' occurred updating the status of the migration. This is a FATAL ERROR, but the error is preventing the system from remembering that. Please contact event espresso support.",
+						"event_espresso"
+					),
+					$successful_save
+				)
+			);
+		}
+		// if we're all done, initialize EE plugins' default data etc.
+		if ($init_dbs) {
+			$this->initialize_db_for_enqueued_ee_plugins();
+		}
+		return $response_array;
+	}
+
+
+	/**
+	 * Echo out JSON response to migration script AJAX requests. Takes precautions
+	 * to buffer output so that we don't throw junk into our json.
+	 *
+	 * @return array with keys:
+	 * 'records_to_migrate' which counts ALL the records for the current migration, and should remain constant. (ie,
+	 * it's NOT the count of hwo many remain)
+	 * 'records_migrated' which also counts ALL the records which have been migrated (ie, percent_complete =
+	 * records_migrated/records_to_migrate)
+	 * 'status'=>a string, one of EE_Data_migration_Manager::status_*
+	 * 'message'=>a string, containing any message you want to show to the user. We may decide to split this up into
+	 * errors, notifications, and successes
+	 * 'script'=>a pretty name of the script currently running
+	 */
+	public function response_to_migration_ajax_request()
+	{
+		ob_start();
+		try {
+			$response = $this->migration_step();
+		} catch (Exception $e) {
+			$response = [
+				'records_to_migrate' => 0,
+				'records_migrated'   => 0,
+				'status'             => EE_Data_Migration_Manager::status_fatal_error,
+				'message'            => sprintf(
+					esc_html__("Unknown fatal error occurred: %s", "event_espresso"),
+					$e->getMessage()
+				),
+				'script'             => 'Unknown',
+			];
+			$this->add_error_to_migrations_ran($e->getMessage() . "; Stack trace:" . $e->getTraceAsString());
+		}
+		$warnings_etc = @ob_get_contents();
+		ob_end_clean();
+		$response['message'] .= $warnings_etc;
+		return $response;
+	}
+
+
+	/**
+	 * Updates the WordPress option that keeps track of which EE version the database
+	 * is at (ie, the code may be at 4.1.0, but the database is still at 3.1.35)
+	 *
+	 * @param array $slug_and_version {
+	 * @type string $slug             like 'Core' or 'Calendar',
+	 * @type string $version          like '4.1.0'
+	 *                                }
+	 * @return void
+	 */
+	public function update_current_database_state_to($slug_and_version = null)
+	{
+		if (! $slug_and_version) {
+			// no version was provided, assume it should be at the current code version
+			$slug_and_version = ['slug' => 'Core', 'version' => espresso_version()];
+		}
+		$current_database_state                              = get_option(self::current_database_state);
+		$current_database_state[ $slug_and_version['slug'] ] = $slug_and_version['version'];
+		update_option(self::current_database_state, $current_database_state);
+	}
+
+
+	/**
+	 * Determines if the database is currently at a state matching what's indicated in $slug and $version.
+	 *
+	 * @param array $slug_and_version {
+	 * @type string $slug             like 'Core' or 'Calendar',
+	 * @type string $version          like '4.1.0'
+	 *                                }
+	 * @return boolean
+	 */
+	public function database_needs_updating_to($slug_and_version)
+	{
+
+		$slug                   = $slug_and_version['slug'];
+		$version                = $slug_and_version['version'];
+		$current_database_state = get_option(self::current_database_state);
+		if (! isset($current_database_state[ $slug ])) {
+			return true;
+		} else {
+			// just compare the first 3 parts of version string, eg "4.7.1", not "4.7.1.dev.032" because DBs shouldn't change on nano version changes
+			$version_parts_current_db_state     = array_slice(explode('.', $current_database_state[ $slug ]), 0, 3);
+			$version_parts_of_provided_db_state = array_slice(explode('.', $version), 0, 3);
+			$needs_updating                     = false;
+			foreach ($version_parts_current_db_state as $offset => $version_part_in_current_db_state) {
+				if ($version_part_in_current_db_state < $version_parts_of_provided_db_state[ $offset ]) {
+					$needs_updating = true;
+					break;
+				}
+			}
+			return $needs_updating;
+		}
+	}
+
+
+	/**
+	 * Gets all the data migration scripts available in the core folder and folders
+	 * in addons. Has the side effect of adding them for autoloading
+	 *
+	 * @return array keys are expected classnames, values are their filepaths
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 */
+	public function get_all_data_migration_scripts_available()
+	{
+		if (! $this->_data_migration_class_to_filepath_map) {
+			$this->_data_migration_class_to_filepath_map = [];
+			foreach ($this->get_data_migration_script_folders() as $eeAddonClass => $folder_path) {
+				// strip any placeholders added to classname to make it a unique array key
+				$eeAddonClass = trim($eeAddonClass, '*');
+				$eeAddonClass = $eeAddonClass === 'Core' || class_exists($eeAddonClass)
+					? $eeAddonClass
+					: '';
+				$folder_path  = EEH_File::end_with_directory_separator($folder_path);
+				$files        = glob($folder_path . '*.dms.php');
+				if (empty($files)) {
+					continue;
+				}
+				foreach ($files as $file) {
+					$pos_of_last_slash = strrpos($file, '/');
+					$classname         = str_replace('.dms.php', '', substr($file, $pos_of_last_slash + 1));
+					$migrates_to       = $this->script_migrates_to_version($classname, $eeAddonClass);
+					$slug              = $migrates_to['slug'];
+					// check that the slug as contained in the DMS is associated with
+					// the slug of an addon or core
+					if ($slug !== 'Core' && EE_Registry::instance()->get_addon_by_name($slug) === null) {
+						EE_Error::doing_it_wrong(
+							__FUNCTION__,
+							sprintf(
+								esc_html__(
+									'The data migration script "%s" migrates the "%s" data, but there is no EE addon with that name. There is only: %s. ',
+									'event_espresso'
+								),
+								$classname,
+								$slug,
+								implode(', ', array_keys(EE_Registry::instance()->get_addons_by_name()))
+							),
+							'4.3.0.alpha.019'
+						);
+					}
+					$this->_data_migration_class_to_filepath_map[ $classname ] = $file;
+				}
+			}
+			EEH_Autoloader::register_autoloader($this->_data_migration_class_to_filepath_map);
+		}
+		return $this->_data_migration_class_to_filepath_map;
+	}
+
+
+	/**
+	 * Once we have an addon that works with EE4.1, we will actually want to fetch the PUE slugs
+	 * from each addon, and check if they need updating,
+	 *
+	 * @return boolean
+	 */
+	public function addons_need_updating()
+	{
+		return false;
+	}
+
+
+	/**
+	 * Adds this error string to the data_migrations_ran array, but we don't necessarily know
+	 * where to put it, so we just throw it in there... better than nothing...
+	 *
+	 * @param string $error_message
+	 */
+	public function add_error_to_migrations_ran($error_message)
+	{
+		// get last-run migration script
+		global $wpdb;
+		$last_migration_script_option = $wpdb->get_row(
+			"SELECT * FROM $wpdb->options WHERE option_name like '"
+			. EE_Data_Migration_Manager::data_migration_script_option_prefix
+			. "%' ORDER BY option_id DESC LIMIT 1",
+			ARRAY_A
+		);
+
+		$last_ran_migration_script_properties = isset($last_migration_script_option['option_value'])
+			? maybe_unserialize($last_migration_script_option['option_value']) : null;
+		// now, tread lightly because we're here because a FATAL non-catchable error
+		// was thrown last time when we were trying to run a data migration script
+		// so the fatal error could have happened while getting the migration script
+		// or doing running it...
+		$versions_migrated_to = isset($last_migration_script_option['option_name']) ? str_replace(
+			EE_Data_Migration_Manager::data_migration_script_option_prefix,
+			"",
+			$last_migration_script_option['option_name']
+		) : null;
+
+		// check if it THINKS it's a data migration script and especially if it's one that HASN'T finished yet
+		// because if it has finished, then it obviously couldn't be the cause of this error, right? (because it's all done)
+		if (
+			isset($last_ran_migration_script_properties['class'])
+			&& isset($last_ran_migration_script_properties['_status'])
+			&& $last_ran_migration_script_properties['_status'] != self::status_completed
+		) {
+			// ok then just add this error to its list of errors
+			$last_ran_migration_script_properties['_errors'][] = $error_message;
+			$last_ran_migration_script_properties['_status']   = self::status_fatal_error;
+		} else {
+			// so we don't even know which script was last running
+			// use the data migration error stub, which is designed specifically for this type of thing
+			$general_migration_error = new EE_DMS_Unknown_1_0_0();
+			$general_migration_error->add_error($error_message);
+			$general_migration_error->set_broken();
+			$last_ran_migration_script_properties = $general_migration_error->properties_as_array();
+			$versions_migrated_to                 = 'Unknown.1.0.0';
+			// now just to make sure appears as last (in case the were previously a fatal error like this)
+			// delete the old one
+			delete_option(self::data_migration_script_option_prefix . $versions_migrated_to);
+		}
+		update_option(
+			self::data_migration_script_option_prefix . $versions_migrated_to,
+			$last_ran_migration_script_properties
+		);
+	}
+
+
+	/**
+	 * saves what data migrations have run to the database
+	 *
+	 * @return bool|string TRUE if successfully saved migrations ran, string if an error occurred
+	 * @throws EE_Error
+	 */
+	protected function _save_migrations_ran()
+	{
+		if ($this->_data_migrations_ran == null) {
+			$this->get_data_migrations_ran();
+		}
+		// now, we don't want to save actual classes to the DB because that's messy
+		$successful_updates = true;
+		foreach ($this->_data_migrations_ran as $plugin_slug => $migrations_ran_for_plugin) {
+			foreach ($migrations_ran_for_plugin as $version_string => $array_or_migration_obj) {
+				$plugin_slug_for_use_in_option_name = $plugin_slug . ".";
+				$option_name                        =
+					self::data_migration_script_option_prefix . $plugin_slug_for_use_in_option_name . $version_string;
+				$old_option_value                   = get_option($option_name);
+				if ($array_or_migration_obj instanceof EE_Data_Migration_Script_Base) {
+					$script_array_for_saving = $array_or_migration_obj->properties_as_array();
+					if ($old_option_value != $script_array_for_saving) {
+						$successful_updates = update_option($option_name, $script_array_for_saving);
+					}
+				} else {// we don't know what this array-thing is. So just save it as-is
+					if ($old_option_value != $array_or_migration_obj) {
+						$successful_updates = update_option($option_name, $array_or_migration_obj);
+					}
+				}
+				if (! $successful_updates) {
+					global $wpdb;
+					return $wpdb->last_error;
+				}
+			}
+		}
+		return true;
+		// $updated = update_option(self::data_migrations_option_name, $array_of_migrations);
+		// if ($updated !== true) {
+		//     global $wpdb;
+		//     return $wpdb->last_error;
+		// } else {
+		//     return true;
+		// }
+		// wp_mail(
+		//     "michael@eventespresso.com",
+		//     time() . " price debug info",
+		//     "updated: $updated, last error: $last_error, byte length of option: " . strlen(
+		//         serialize($array_of_migrations)
+		//     )
+		// );
+	}
+
+
+	/**
+	 * Takes an array of data migration script properties and re-creates the class from
+	 * them. The argument $properties_array is assumed to have been made by
+	 * EE_Data_Migration_Script_Base::properties_as_array()
+	 *
+	 * @param array $properties_array
+	 * @return EE_Data_Migration_Script_Base
+	 * @throws EE_Error
+	 */
+	public function _instantiate_script_from_properties_array($properties_array)
+	{
+		if (! isset($properties_array['class'])) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__("Properties array  has no 'class' properties. Here's what it has: %s", "event_espresso"),
+					implode(",", $properties_array)
+				)
+			);
+		}
+		$class_name = $properties_array['class'];
+		if (! class_exists($class_name)) {
+			throw new EE_Error(sprintf(
+				esc_html__("There is no migration script named %s", "event_espresso"),
+				$class_name
+			));
+		}
+		$class = new $class_name();
+		if (! $class instanceof EE_Data_Migration_Script_Base) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						"Class '%s' is supposed to be a migration script. Its not, its a '%s'",
+						"event_espresso"
+					),
+					$class_name,
+					get_class($class)
+				)
+			);
+		}
+		$class->instantiate_from_array_of_properties($properties_array);
+		return $class;
+	}
+
+
+	/**
+	 * Gets the classname for the most up-to-date DMS (ie, the one that will finally
+	 * leave the DB in a state usable by the current plugin code).
+	 *
+	 * @param string $plugin_slug the slug for the ee plugin we are searching for. Default is 'Core'
+	 * @return string
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	public function get_most_up_to_date_dms($plugin_slug = 'Core')
+	{
+		$class_to_filepath_map         = $this->get_all_data_migration_scripts_available();
+		$most_up_to_date_dms_classname = null;
+		foreach ($class_to_filepath_map as $classname => $filepath) {
+			if ($most_up_to_date_dms_classname === null) {
+				$migrates_to      = $this->script_migrates_to_version($classname);
+				$this_plugin_slug = $migrates_to['slug'];
+				if ($this_plugin_slug == $plugin_slug) {
+					// if it's for core, it wins
+					$most_up_to_date_dms_classname = $classname;
+				}
+				// if it wasn't for core, we must keep searching for one that is!
+				continue;
+			}
+			$champion_migrates_to  = $this->script_migrates_to_version($most_up_to_date_dms_classname);
+			$contender_migrates_to = $this->script_migrates_to_version($classname);
+			if (
+				$contender_migrates_to['slug'] == $plugin_slug
+				&& version_compare(
+					$champion_migrates_to['version'],
+					$contender_migrates_to['version'],
+					'<'
+				)
+			) {
+				// so the contenders version is higher, and it's for Core
+				$most_up_to_date_dms_classname = $classname;
+			}
+		}
+		return $most_up_to_date_dms_classname;
+	}
+
+
+	/**
+	 * Gets the migration script specified but ONLY if it has already run.
+	 *
+	 * Eg, if you wanted to see if 'EE_DMS_Core_4_1_0' has run, you would run the following code:
+	 * <code> $core_4_1_0_dms_ran = EE_Data_Migration_Manager::instance()->get_migration_ran( '4.1.0', 'Core' ) !==
+	 * NULL;</code> This is especially useful in addons' data migration scripts, this way they can tell if a core (or
+	 * other addon) DMS has run, in case the current DMS depends on it.
+	 *
+	 * @param string $version     the version the DMS searched for migrates to. Usually just the content before the 3rd
+	 *                            period. Eg '4.1.0'
+	 * @param string $plugin_slug like 'Core', 'Mailchimp', 'Calendar', etc
+	 * @return EE_Data_Migration_Script_Base
+	 * @throws EE_Error
+	 */
+	public function get_migration_ran($version, $plugin_slug = 'Core')
+	{
+		$migrations_ran = $this->get_data_migrations_ran();
+		if (isset($migrations_ran[ $plugin_slug ]) && isset($migrations_ran[ $plugin_slug ][ $version ])) {
+			return $migrations_ran[ $plugin_slug ][ $version ];
+		} else {
+			return null;
+		}
+	}
+
+
+	/**
+	 * Resets the borked data migration scripts, so they're no longer borked, and we can again attempt to migrate
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function reattempt()
+	{
+		// find if the last-run script was borked
+		// set it as being non-borked (we shouldn't ever get DMSs that we don't recognize)
+		// add an 'error' saying that we attempted to reset
+		// does it have a stage that was borked too? if so make it no longer borked
+		// add an 'error' saying we attempted to reset
+		$last_ran_script = $this->get_last_ran_script();
+		if ($last_ran_script instanceof EE_DMS_Unknown_1_0_0) {
+			// if it was an error DMS, just mark it as complete (if another error occurs it will overwrite it)
+			$last_ran_script->set_completed();
+		} elseif ($last_ran_script instanceof EE_Data_Migration_Script_Base) {
+			$last_ran_script->reattempt();
+		} else {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'Unable to reattempt the last ran migration script because it was not a valid migration script. || It was %s',
+						'event_espresso'
+					),
+					print_r($last_ran_script, true)
+				)
+			);
+		}
+		return $this->_save_migrations_ran();
+	}
+
+
+	/**
+	 * Gets whether this particular migration has run or not
+	 *
+	 * @param string $version     the version the DMS searched for migrates to. Usually just the content before the 3rd
+	 *                            period. Eg '4.1.0'
+	 * @param string $plugin_slug like 'Core', 'Mailchimp', 'Calendar', etc
+	 * @return boolean
+	 * @throws EE_Error
+	 */
+	public function migration_has_ran($version, $plugin_slug = 'Core')
+	{
+		return $this->get_migration_ran($version, $plugin_slug) !== null;
+	}
+
+
+	/**
+	 * Enqueues this ee plugin to have its data initialized
+	 *
+	 * @param string $plugin_slug either 'Core' or EE_Addon::name()'s return value
+	 */
+	public function enqueue_db_initialization_for($plugin_slug)
+	{
+		$queue = $this->get_db_initialization_queue();
+		if (! in_array($plugin_slug, $queue)) {
+			$queue[] = $plugin_slug;
+		}
+		update_option(self::db_init_queue_option_name, $queue);
+	}
+
+
+	/**
+	 * Calls EE_Addon::initialize_db_if_no_migrations_required() on each addon
+	 * specified in EE_Data_Migration_Manager::get_db_init_queue(), and if 'Core' is
+	 * in the queue, calls EE_System::initialize_db_if_no_migrations_required().
+	 *
+	 * @throws EE_Error
+	 */
+	public function initialize_db_for_enqueued_ee_plugins()
+	{
+		$queue = $this->get_db_initialization_queue();
+		foreach ($queue as $plugin_slug) {
+			$most_up_to_date_dms = $this->get_most_up_to_date_dms($plugin_slug);
+			if (! $most_up_to_date_dms) {
+				// if there is NO DMS for this plugin, obviously there's no schema to verify anyways
+				$verify_db = false;
+			} else {
+				$most_up_to_date_dms_migrates_to = $this->script_migrates_to_version($most_up_to_date_dms);
+				$verify_db                       = $this->database_needs_updating_to($most_up_to_date_dms_migrates_to);
+			}
+			if ($plugin_slug == 'Core') {
+				EE_System::instance()->initialize_db_if_no_migrations_required(
+					false,
+					$verify_db
+				);
+			} else {
+				// just loop through the addons to make sure their database is set up
+				foreach (EE_Registry::instance()->addons as $addon) {
+					if ($addon->name() == $plugin_slug) {
+						$addon->initialize_db_if_no_migrations_required($verify_db);
+						break;
+					}
+				}
+			}
+		}
+		// because we just initialized the DBs for the enqueued ee plugins
+		// we don't need to keep remembering which ones needed to be initialized
+		delete_option(self::db_init_queue_option_name);
+	}
+
+
+	/**
+	 * Gets a numerically-indexed array of plugin slugs that need to have their databases
+	 * (re-)initialized after migrations are complete. ie, each element should be either
+	 * 'Core', or the return value of EE_Addon::name() for an addon
+	 *
+	 * @return array
+	 */
+	public function get_db_initialization_queue()
+	{
+		return get_option(self::db_init_queue_option_name, []);
+	}
+
+
+	/**
+	 * Gets the injected table analyzer, or throws an exception
+	 *
+	 * @return TableAnalysis
+	 * @throws EE_Error
+	 */
+	protected function _get_table_analysis()
+	{
+		if ($this->_table_analysis instanceof TableAnalysis) {
+			return $this->_table_analysis;
+		} else {
+			throw new EE_Error(
+				sprintf(
+					esc_html__('Table analysis class on class %1$s is not set properly.', 'event_espresso'),
+					get_class($this)
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * Gets the injected table manager, or throws an exception
+	 *
+	 * @return TableManager
+	 * @throws EE_Error
+	 */
+	protected function _get_table_manager()
+	{
+		if ($this->_table_manager instanceof TableManager) {
+			return $this->_table_manager;
+		} else {
+			throw new EE_Error(
+				sprintf(
+					esc_html__('Table manager class on class %1$s is not set properly.', 'event_espresso'),
+					get_class($this)
+				)
+			);
+		}
+	}
 }

Spacing +60 added lines, -60 removed lines

@@ -163,7 +163,7 @@ 
     public static function instance()
     {
         // check if class object is instantiated
-        if (! self::$_instance instanceof EE_Data_Migration_Manager) {
+        if ( ! self::$_instance instanceof EE_Data_Migration_Manager) {
             self::$_instance = new self();
         }
         return self::$_instance;
@@ -189,11 +189,11 @@ 
      */
     private function __construct()
     {
-        $this->stati_that_indicate_to_continue_migrations              = [
+        $this->stati_that_indicate_to_continue_migrations = [
             self::status_continue,
             self::status_completed,
         ];
-        $this->stati_that_indicate_to_stop_migrations                  = [
+        $this->stati_that_indicate_to_stop_migrations = [
             self::status_fatal_error,
             self::status_no_more_migration_scripts,
         ];
@@ -241,12 +241,12 @@ 
 
         if (count($parts) == 4) {
             // it's 4.2-style.eg Core.4.1.0
-            $plugin_slug    = $parts[0];                                     // eg Core
-            $version_string = $parts[1] . "." . $parts[2] . "." . $parts[3]; // eg 4.1.0
+            $plugin_slug    = $parts[0]; // eg Core
+            $version_string = $parts[1].".".$parts[2].".".$parts[3]; // eg 4.1.0
         } else {
             // it's 4.1-style: eg 4.1.0
             $plugin_slug    = 'Core';
-            $version_string = $plugin_slug_and_version_string;// eg 4.1.0
+            $version_string = $plugin_slug_and_version_string; // eg 4.1.0
         }
         return [$plugin_slug, $version_string];
     }
@@ -308,11 +308,11 @@ 
      */
     public function get_data_migrations_ran()
     {
-        if (! $this->_data_migrations_ran) {
+        if ( ! $this->_data_migrations_ran) {
             // setup autoloaders for each of the scripts in there
             $this->get_all_data_migration_scripts_available();
             $data_migrations_options =
-                $this->get_all_migration_script_options();// get_option(EE_Data_Migration_Manager::data_migrations_option_name,get_option('espresso_data_migrations',array()));
+                $this->get_all_migration_script_options(); // get_option(EE_Data_Migration_Manager::data_migrations_option_name,get_option('espresso_data_migrations',array()));
 
             $data_migrations_ran = [];
             // convert into data migration script classes where possible
@@ -322,27 +322,27 @@ 
                 );
 
                 try {
-                    $class                                                  = $this->_get_dms_class_from_wp_option(
+                    $class = $this->_get_dms_class_from_wp_option(
                         $data_migration_option['option_name'],
                         $data_migration_option['option_value']
                     );
-                    $data_migrations_ran[ $plugin_slug ][ $version_string ] = $class;
+                    $data_migrations_ran[$plugin_slug][$version_string] = $class;
                     // ok so far THIS is the 'last-run-script'... unless we find another on next iteration
                     $this->_last_ran_script = $class;
-                    if (! $class->is_completed()) {
+                    if ( ! $class->is_completed()) {
                         // sometimes we also like to know which was the last incomplete script (or if there are any at all)
                         $this->_last_ran_incomplete_script = $class;
                     }
                 } catch (EE_Error $e) {
                     // ok so it's not a DMS. We'll just keep it, although other code will need to expect non-DMSs
-                    $data_migrations_ran[ $plugin_slug ][ $version_string ] = maybe_unserialize(
+                    $data_migrations_ran[$plugin_slug][$version_string] = maybe_unserialize(
                         $data_migration_option['option_value']
                     );
                 }
             }
             // so here the array of $data_migrations_ran is actually a mix of classes and a few legacy arrays
             $this->_data_migrations_ran = $data_migrations_ran;
-            if (! $this->_data_migrations_ran || ! is_array($this->_data_migrations_ran)) {
+            if ( ! $this->_data_migrations_ran || ! is_array($this->_data_migrations_ran)) {
                 $this->_data_migrations_ran = [];
             }
         }
@@ -362,7 +362,7 @@ 
      */
     public function get_mapping_new_pk($script_name, $old_table, $old_pk, $new_table)
     {
-        $script  = EE_Registry::instance()->load_dms($script_name);
+        $script = EE_Registry::instance()->load_dms($script_name);
         return $script->get_mapping_new_pk($old_table, $old_pk, $new_table);
     }
 
@@ -395,7 +395,7 @@ 
     {
         return apply_filters(
             'FHEE__EE_Data_Migration_Manager__get_data_migration_script_folders',
-            ['Core' => EE_CORE . 'data_migration_scripts']
+            ['Core' => EE_CORE.'data_migration_scripts']
         );
     }
 
@@ -412,11 +412,11 @@ 
      */
     public function script_migrates_to_version($migration_script_name, $eeAddonClass = '')
     {
-        if (isset($this->script_migration_versions[ $migration_script_name ])) {
-            return $this->script_migration_versions[ $migration_script_name ];
+        if (isset($this->script_migration_versions[$migration_script_name])) {
+            return $this->script_migration_versions[$migration_script_name];
         }
         $dms_info                                                  = $this->parse_dms_classname($migration_script_name);
-        $this->script_migration_versions[ $migration_script_name ] = [
+        $this->script_migration_versions[$migration_script_name] = [
             'slug'    => $eeAddonClass !== '' ? $eeAddonClass : $dms_info['slug'],
             'version' => $dms_info['major_version']
                          . "."
@@ -424,7 +424,7 @@ 
                          . "."
                          . $dms_info['micro_version'],
         ];
-        return $this->script_migration_versions[ $migration_script_name ];
+        return $this->script_migration_versions[$migration_script_name];
     }
 
 
@@ -439,7 +439,7 @@ 
     {
         $matches = [];
         preg_match('~EE_DMS_(.*)_([0-9]*)_([0-9]*)_([0-9]*)~', $classname, $matches);
-        if (! $matches || ! (isset($matches[1]) && isset($matches[2]) && isset($matches[3]))) {
+        if ( ! $matches || ! (isset($matches[1]) && isset($matches[2]) && isset($matches[3]))) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -471,7 +471,7 @@ 
     {
         $espresso_db_core_updates = get_option('espresso_db_update', []);
         $db_state                 = get_option(EE_Data_Migration_Manager::current_database_state);
-        if (! $db_state) {
+        if ( ! $db_state) {
             // mark the DB as being in the state as the last version in there.
             // this is done to trigger maintenance mode and do data migration scripts
             // if the admin installed this version of EE over 3.1.x or 4.0.x
@@ -490,7 +490,7 @@ 
         // in 4.1, $db_state would have only been a simple string like '4.1.0',
         // but in 4.2+ it should be an array with at least key 'Core' and the value of that plugin's
         // db, and possibly other keys for other addons like 'Calendar','Permissions',etc
-        if (! is_array($db_state)) {
+        if ( ! is_array($db_state)) {
             $db_state = ['Core' => $db_state];
             update_option(EE_Data_Migration_Manager::current_database_state, $db_state);
         }
@@ -534,7 +534,7 @@ 
                 // check if this version script is DONE or not; or if it's never been run
                 if (
                     ! $scripts_ran
-                    || ! isset($scripts_ran[ $script_converts_plugin_slug ][ $script_converts_to_version ])
+                    || ! isset($scripts_ran[$script_converts_plugin_slug][$script_converts_to_version])
                 ) {
                     // we haven't run this conversion script before
                     // now check if it applies...
@@ -545,28 +545,28 @@ 
                     /* @var $script EE_Data_Migration_Script_Base */
                     $can_migrate = $script->can_migrate_from_version($theoretical_database_state);
                     if ($can_migrate) {
-                        $script_classes_that_should_run_per_iteration[ $iteration ][ $script->priority() ][] = $script;
+                        $script_classes_that_should_run_per_iteration[$iteration][$script->priority()][] = $script;
                         $migrates_to_version                                                                 =
                             $script->migrates_to_version();
-                        $next_database_state_to_consider[ $migrates_to_version['slug'] ]                     =
+                        $next_database_state_to_consider[$migrates_to_version['slug']]                     =
                             $migrates_to_version['version'];
-                        unset($script_class_and_filepaths_available[ $classname ]);
+                        unset($script_class_and_filepaths_available[$classname]);
                     }
                 } elseif (
-                    $scripts_ran[ $script_converts_plugin_slug ][ $script_converts_to_version ]
+                    $scripts_ran[$script_converts_plugin_slug][$script_converts_to_version]
                           instanceof
                           EE_Data_Migration_Script_Base
                 ) {
                     // this script has been run, or at least started
-                    $script = $scripts_ran[ $script_converts_plugin_slug ][ $script_converts_to_version ];
+                    $script = $scripts_ran[$script_converts_plugin_slug][$script_converts_to_version];
                     if ($script->get_status() !== self::status_completed) {
                         // this script is already underway... keep going with it
-                        $script_classes_that_should_run_per_iteration[ $iteration ][ $script->priority() ][] = $script;
+                        $script_classes_that_should_run_per_iteration[$iteration][$script->priority()][] = $script;
                         $migrates_to_version                                                                 =
                             $script->migrates_to_version();
-                        $next_database_state_to_consider[ $migrates_to_version['slug'] ]                     =
+                        $next_database_state_to_consider[$migrates_to_version['slug']]                     =
                             $migrates_to_version['version'];
-                        unset($script_class_and_filepaths_available[ $classname ]);
+                        unset($script_class_and_filepaths_available[$classname]);
                     }
                     // else it must have a status that indicates it has finished,
                     // so we don't want to try and run it again
@@ -575,14 +575,14 @@ 
                 // or was simply removed from EE? either way, it's certainly not runnable!
             }
             $iteration++;
-        } while ($next_database_state_to_consider !== $theoretical_database_state && $iteration < 6);
+        }while ($next_database_state_to_consider !== $theoretical_database_state && $iteration < 6);
         // ok we have all the scripts that should run, now let's make them into flat array
         $scripts_that_should_run = [];
         foreach ($script_classes_that_should_run_per_iteration as $scripts_at_priority) {
             ksort($scripts_at_priority);
             foreach ($scripts_at_priority as $scripts) {
                 foreach ($scripts as $script) {
-                    $scripts_that_should_run[ get_class($script) ] = $script;
+                    $scripts_that_should_run[get_class($script)] = $script;
                 }
             }
         }
@@ -608,7 +608,7 @@ 
     public function get_last_ran_script($include_completed_scripts = false)
     {
         // make sure we've set up the class properties _last_ran_script and _last_ran_incomplete_script
-        if (! $this->_data_migrations_ran) {
+        if ( ! $this->_data_migrations_ran) {
             $this->get_data_migrations_ran();
         }
         if ($include_completed_scripts) {
@@ -645,10 +645,10 @@ 
 
         try {
             $currently_executing_script = $this->get_last_ran_script();
-            if (! $currently_executing_script) {
+            if ( ! $currently_executing_script) {
                 // Find the next script that needs to execute
                 $scripts = $this->check_for_applicable_data_migration_scripts();
-                if (! $scripts) {
+                if ( ! $scripts) {
                     // huh, no more scripts to run... apparently we're done!
                     // but don't forget to make sure initial data is there
                     // we should be good to allow them to exit maintenance mode now
@@ -676,7 +676,7 @@ 
                     $this->script_migrates_to_version(get_class($currently_executing_script));
                 $plugin_slug                                            = $migrates_to['slug'];
                 $version                                                = $migrates_to['version'];
-                $this->_data_migrations_ran[ $plugin_slug ][ $version ] = $currently_executing_script;
+                $this->_data_migrations_ran[$plugin_slug][$version] = $currently_executing_script;
             }
             $current_script_name = get_class($currently_executing_script);
         } catch (Exception $e) {
@@ -684,7 +684,7 @@ 
 
             $message = sprintf(
                 esc_html__("Error Message: %sStack Trace:%s", "event_espresso"),
-                $e->getMessage() . '<br>',
+                $e->getMessage().'<br>',
                 $e->getTraceAsString()
             );
             // record it on the array of data migration scripts run. This will be overwritten next time we try and try to run data migrations
@@ -737,7 +737,7 @@ 
                     ];
                     // check if there are any more after this one.
                     $scripts_remaining = $this->check_for_applicable_data_migration_scripts();
-                    if (! $scripts_remaining) {
+                    if ( ! $scripts_remaining) {
                         // we should be good to allow them to exit maintenance mode now
                         EE_Maintenance_Mode::instance()->set_maintenance_level(
                             EE_Maintenance_Mode::level_0_not_in_maintenance
@@ -837,7 +837,7 @@ 
                 ),
                 'script'             => 'Unknown',
             ];
-            $this->add_error_to_migrations_ran($e->getMessage() . "; Stack trace:" . $e->getTraceAsString());
+            $this->add_error_to_migrations_ran($e->getMessage()."; Stack trace:".$e->getTraceAsString());
         }
         $warnings_etc = @ob_get_contents();
         ob_end_clean();
@@ -858,12 +858,12 @@ 
      */
     public function update_current_database_state_to($slug_and_version = null)
     {
-        if (! $slug_and_version) {
+        if ( ! $slug_and_version) {
             // no version was provided, assume it should be at the current code version
             $slug_and_version = ['slug' => 'Core', 'version' => espresso_version()];
         }
         $current_database_state                              = get_option(self::current_database_state);
-        $current_database_state[ $slug_and_version['slug'] ] = $slug_and_version['version'];
+        $current_database_state[$slug_and_version['slug']] = $slug_and_version['version'];
         update_option(self::current_database_state, $current_database_state);
     }
 
@@ -883,15 +883,15 @@ 
         $slug                   = $slug_and_version['slug'];
         $version                = $slug_and_version['version'];
         $current_database_state = get_option(self::current_database_state);
-        if (! isset($current_database_state[ $slug ])) {
+        if ( ! isset($current_database_state[$slug])) {
             return true;
         } else {
             // just compare the first 3 parts of version string, eg "4.7.1", not "4.7.1.dev.032" because DBs shouldn't change on nano version changes
-            $version_parts_current_db_state     = array_slice(explode('.', $current_database_state[ $slug ]), 0, 3);
+            $version_parts_current_db_state     = array_slice(explode('.', $current_database_state[$slug]), 0, 3);
             $version_parts_of_provided_db_state = array_slice(explode('.', $version), 0, 3);
             $needs_updating                     = false;
             foreach ($version_parts_current_db_state as $offset => $version_part_in_current_db_state) {
-                if ($version_part_in_current_db_state < $version_parts_of_provided_db_state[ $offset ]) {
+                if ($version_part_in_current_db_state < $version_parts_of_provided_db_state[$offset]) {
                     $needs_updating = true;
                     break;
                 }
@@ -913,7 +913,7 @@ 
      */
     public function get_all_data_migration_scripts_available()
     {
-        if (! $this->_data_migration_class_to_filepath_map) {
+        if ( ! $this->_data_migration_class_to_filepath_map) {
             $this->_data_migration_class_to_filepath_map = [];
             foreach ($this->get_data_migration_script_folders() as $eeAddonClass => $folder_path) {
                 // strip any placeholders added to classname to make it a unique array key
@@ -922,7 +922,7 @@ 
                     ? $eeAddonClass
                     : '';
                 $folder_path  = EEH_File::end_with_directory_separator($folder_path);
-                $files        = glob($folder_path . '*.dms.php');
+                $files        = glob($folder_path.'*.dms.php');
                 if (empty($files)) {
                     continue;
                 }
@@ -948,7 +948,7 @@ 
                             '4.3.0.alpha.019'
                         );
                     }
-                    $this->_data_migration_class_to_filepath_map[ $classname ] = $file;
+                    $this->_data_migration_class_to_filepath_map[$classname] = $file;
                 }
             }
             EEH_Autoloader::register_autoloader($this->_data_migration_class_to_filepath_map);
@@ -1018,10 +1018,10 @@ 
             $versions_migrated_to                 = 'Unknown.1.0.0';
             // now just to make sure appears as last (in case the were previously a fatal error like this)
             // delete the old one
-            delete_option(self::data_migration_script_option_prefix . $versions_migrated_to);
+            delete_option(self::data_migration_script_option_prefix.$versions_migrated_to);
         }
         update_option(
-            self::data_migration_script_option_prefix . $versions_migrated_to,
+            self::data_migration_script_option_prefix.$versions_migrated_to,
             $last_ran_migration_script_properties
         );
     }
@@ -1042,9 +1042,9 @@ 
         $successful_updates = true;
         foreach ($this->_data_migrations_ran as $plugin_slug => $migrations_ran_for_plugin) {
             foreach ($migrations_ran_for_plugin as $version_string => $array_or_migration_obj) {
-                $plugin_slug_for_use_in_option_name = $plugin_slug . ".";
+                $plugin_slug_for_use_in_option_name = $plugin_slug.".";
                 $option_name                        =
-                    self::data_migration_script_option_prefix . $plugin_slug_for_use_in_option_name . $version_string;
+                    self::data_migration_script_option_prefix.$plugin_slug_for_use_in_option_name.$version_string;
                 $old_option_value                   = get_option($option_name);
                 if ($array_or_migration_obj instanceof EE_Data_Migration_Script_Base) {
                     $script_array_for_saving = $array_or_migration_obj->properties_as_array();
@@ -1056,7 +1056,7 @@ 
                         $successful_updates = update_option($option_name, $array_or_migration_obj);
                     }
                 }
-                if (! $successful_updates) {
+                if ( ! $successful_updates) {
                     global $wpdb;
                     return $wpdb->last_error;
                 }
@@ -1091,7 +1091,7 @@ 
      */
     public function _instantiate_script_from_properties_array($properties_array)
     {
-        if (! isset($properties_array['class'])) {
+        if ( ! isset($properties_array['class'])) {
             throw new EE_Error(
                 sprintf(
                     esc_html__("Properties array  has no 'class' properties. Here's what it has: %s", "event_espresso"),
@@ -1100,14 +1100,14 @@ 
             );
         }
         $class_name = $properties_array['class'];
-        if (! class_exists($class_name)) {
+        if ( ! class_exists($class_name)) {
             throw new EE_Error(sprintf(
                 esc_html__("There is no migration script named %s", "event_espresso"),
                 $class_name
             ));
         }
         $class = new $class_name();
-        if (! $class instanceof EE_Data_Migration_Script_Base) {
+        if ( ! $class instanceof EE_Data_Migration_Script_Base) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -1183,8 +1183,8 @@ 
     public function get_migration_ran($version, $plugin_slug = 'Core')
     {
         $migrations_ran = $this->get_data_migrations_ran();
-        if (isset($migrations_ran[ $plugin_slug ]) && isset($migrations_ran[ $plugin_slug ][ $version ])) {
-            return $migrations_ran[ $plugin_slug ][ $version ];
+        if (isset($migrations_ran[$plugin_slug]) && isset($migrations_ran[$plugin_slug][$version])) {
+            return $migrations_ran[$plugin_slug][$version];
         } else {
             return null;
         }
@@ -1248,7 +1248,7 @@ 
     public function enqueue_db_initialization_for($plugin_slug)
     {
         $queue = $this->get_db_initialization_queue();
-        if (! in_array($plugin_slug, $queue)) {
+        if ( ! in_array($plugin_slug, $queue)) {
             $queue[] = $plugin_slug;
         }
         update_option(self::db_init_queue_option_name, $queue);
@@ -1267,7 +1267,7 @@ 
         $queue = $this->get_db_initialization_queue();
         foreach ($queue as $plugin_slug) {
             $most_up_to_date_dms = $this->get_most_up_to_date_dms($plugin_slug);
-            if (! $most_up_to_date_dms) {
+            if ( ! $most_up_to_date_dms) {
                 // if there is NO DMS for this plugin, obviously there's no schema to verify anyways
                 $verify_db = false;
             } else {

core/helpers/EEH_MSG_Template.helper.php

Indentation +1249 added lines, -1249 removed lines

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

core/services/request/sanitizers/AllowedTags.php

Indentation +280 added lines, -280 removed lines

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

espresso.php

Indentation +80 added lines, -80 removed lines

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

core/libraries/messages/EE_messenger.lib.php

Indentation +740 added lines, -740 removed lines

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