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/EED_Module.module.php

Indentation +137 added lines, -137 removed lines

@@ -15,141 +15,141 @@
 abstract class EED_Module extends EE_Configurable implements ResettableInterface
 {
 
-    /**
-     * rendered output to be returned to WP
-     *
-     * @var    string $output
-     */
-    protected $output = '';
-
-    /**
-     * the current active espresso template theme
-     *
-     * @var    string $theme
-     */
-    protected $theme = '';
-
-
-    /**
-     * @return void
-     */
-    public static function reset()
-    {
-        $module_name = get_called_class();
-        new $module_name();
-    }
-
-
-    /**
-     *    set_hooks - for hooking into EE Core, other modules, etc
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function set_hooks()
-    {
-    }
-
-
-    /**
-     *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function set_hooks_admin()
-    {
-    }
-
-
-    /**
-     *    run - initial module setup
-     *    this method is primarily used for activating resources in the EE_Front_Controller thru the use of filters
-     *
-     * @access    public
-     * @var            WP $WP
-     * @return    void
-     */
-    abstract public function run($WP);
-
-
-    /**
-     * EED_Module constructor.
-     */
-    final public function __construct()
-    {
-        $this->theme = EE_Config::get_current_theme();
-        $module_name = $this->module_name();
-        EE_Registry::instance()->modules->{$module_name} = $this;
-    }
-
-
-    /**
-     * @param string $module_name
-     * @return EED_Module|mixed
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected static function get_instance($module_name = '')
-    {
-        $module_name = ! empty($module_name)
-            ? $module_name
-            : get_called_class();
-        if (
-            ! isset(EE_Registry::instance()->modules->{$module_name})
-            || ! EE_Registry::instance()->modules->{$module_name} instanceof EED_Module
-        ) {
-            EE_Registry::instance()->add_module($module_name);
-        }
-        return EE_Registry::instance()->get_module($module_name);
-    }
-
-
-    /**
-     *    module_name
-     *
-     * @access    public
-     * @return    string
-     */
-    public function module_name()
-    {
-        return get_class($this);
-    }
-
-
-    /**
-     * @return string
-     */
-    public function theme()
-    {
-        return $this->theme;
-    }
-
-
-    /**
-     * @return RequestInterface
-     * @since   4.10.14.p
-     */
-    protected static function getRequest()
-    {
-        static $request;
-        if (! $request instanceof RequestInterface) {
-            $request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-        }
-        return $request;
-    }
-
-
-    /**
-     * @return ResponseInterface
-     * @since   4.10.14.p
-     */
-    protected static function getResponse()
-    {
-        static $response;
-        if (! $response instanceof RequestInterface) {
-            $response = LoaderFactory::getLoader()->getShared(ResponseInterface::class);
-        }
-        return $response;
-    }
+	/**
+	 * rendered output to be returned to WP
+	 *
+	 * @var    string $output
+	 */
+	protected $output = '';
+
+	/**
+	 * the current active espresso template theme
+	 *
+	 * @var    string $theme
+	 */
+	protected $theme = '';
+
+
+	/**
+	 * @return void
+	 */
+	public static function reset()
+	{
+		$module_name = get_called_class();
+		new $module_name();
+	}
+
+
+	/**
+	 *    set_hooks - for hooking into EE Core, other modules, etc
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function set_hooks()
+	{
+	}
+
+
+	/**
+	 *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function set_hooks_admin()
+	{
+	}
+
+
+	/**
+	 *    run - initial module setup
+	 *    this method is primarily used for activating resources in the EE_Front_Controller thru the use of filters
+	 *
+	 * @access    public
+	 * @var            WP $WP
+	 * @return    void
+	 */
+	abstract public function run($WP);
+
+
+	/**
+	 * EED_Module constructor.
+	 */
+	final public function __construct()
+	{
+		$this->theme = EE_Config::get_current_theme();
+		$module_name = $this->module_name();
+		EE_Registry::instance()->modules->{$module_name} = $this;
+	}
+
+
+	/**
+	 * @param string $module_name
+	 * @return EED_Module|mixed
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected static function get_instance($module_name = '')
+	{
+		$module_name = ! empty($module_name)
+			? $module_name
+			: get_called_class();
+		if (
+			! isset(EE_Registry::instance()->modules->{$module_name})
+			|| ! EE_Registry::instance()->modules->{$module_name} instanceof EED_Module
+		) {
+			EE_Registry::instance()->add_module($module_name);
+		}
+		return EE_Registry::instance()->get_module($module_name);
+	}
+
+
+	/**
+	 *    module_name
+	 *
+	 * @access    public
+	 * @return    string
+	 */
+	public function module_name()
+	{
+		return get_class($this);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function theme()
+	{
+		return $this->theme;
+	}
+
+
+	/**
+	 * @return RequestInterface
+	 * @since   4.10.14.p
+	 */
+	protected static function getRequest()
+	{
+		static $request;
+		if (! $request instanceof RequestInterface) {
+			$request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
+		}
+		return $request;
+	}
+
+
+	/**
+	 * @return ResponseInterface
+	 * @since   4.10.14.p
+	 */
+	protected static function getResponse()
+	{
+		static $response;
+		if (! $response instanceof RequestInterface) {
+			$response = LoaderFactory::getLoader()->getShared(ResponseInterface::class);
+		}
+		return $response;
+	}
 }

modules/events_archive/EED_Events_Archive.module.php

Indentation +1052 added lines, -1052 removed lines

@@ -17,1047 +17,1047 @@ 
 class EED_Events_Archive extends EED_Module
 {
 
-    const EVENT_DETAILS_PRIORITY   = 100;
-
-    const EVENT_DATETIMES_PRIORITY = 110;
-
-    const EVENT_TICKETS_PRIORITY   = 120;
-
-    const EVENT_VENUES_PRIORITY    = 130;
-
-
-    public static $espresso_event_list_ID    = 0;
-
-    public static $espresso_grid_event_lists = [];
-
-    /**
-     * @type bool $using_get_the_excerpt
-     */
-    protected static $using_get_the_excerpt = false;
-
-    /**
-     * Used to flag when the event list is being called from an external iframe.
-     *
-     * @var bool $iframe
-     */
-    protected static $iframe = false;
-
-    /**
-     * @var EventListIframeEmbedButton $_iframe_embed_button
-     */
-    private static $_iframe_embed_button;
-
-    /**
-     * @type EE_Template_Part_Manager $template_parts
-     */
-    protected $template_parts;
-
-
-    /**
-     * @return EED_Events_Archive
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function instance()
-    {
-        return parent::get_instance(__CLASS__);
-    }
-
-
-    /**
-     * for hooking into EE Core, other modules, etc
-     *
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function set_hooks()
-    {
-        /** @var CustomPostTypeDefinitions $custom_post_type_definitions */
-        $custom_post_type_definitions = LoaderFactory::getLoader()->getShared(CustomPostTypeDefinitions::class);
-        $custom_post_types            = $custom_post_type_definitions->getDefinitions();
-        EE_Config::register_route(
-            $custom_post_types['espresso_events']['plural_slug'],
-            'Events_Archive',
-            'run'
-        );
-        EE_Config::register_route(
-            'event_list',
-            'Events_Archive',
-            'event_list'
-        );
-        EE_Config::register_route(
-            'iframe',
-            'Events_Archive',
-            'event_list_iframe',
-            'event_list'
-        );
-        add_action('wp_loaded', ['EED_Events_Archive', 'set_definitions'], 2);
-    }
-
-
-    /**
-     * for hooking into EE Admin Core, other modules, etc
-     *
-     * @return void
-     */
-    public static function set_hooks_admin()
-    {
-        add_action('wp_loaded', ['EED_Events_Archive', 'set_definitions'], 2);
-        // hook into the end of the \EE_Admin_Page::_load_page_dependencies()
-        // to load assets for "espresso_events" page on the "default" route (action)
-        add_action(
-            'FHEE__EE_Admin_Page___load_page_dependencies__after_load__espresso_events__default',
-            ['EED_Events_Archive', 'event_list_iframe_embed_button'],
-            10
-        );
-    }
-
-
-    /**
-     * @return void
-     */
-    public static function set_definitions()
-    {
-        define('EVENTS_ARCHIVE_ASSETS_URL', plugin_dir_url(__FILE__) . 'assets/');
-        define('EVENTS_ARCHIVE_TEMPLATES_PATH', str_replace('\\', '/', plugin_dir_path(__FILE__)) . 'templates/');
-    }
-
-
-    /**
-     * set up EE_Events_Archive_Config
-     */
-    protected function set_config()
-    {
-        $this->set_config_section('template_settings');
-        $this->set_config_class('EE_Events_Archive_Config');
-        $this->set_config_name('EED_Events_Archive');
-    }
-
-
-    /**
-     * @return EventListIframeEmbedButton
-     */
-    public static function get_iframe_embed_button()
-    {
-        if (! self::$_iframe_embed_button instanceof EventListIframeEmbedButton) {
-            self::$_iframe_embed_button = new EventListIframeEmbedButton();
-        }
-        return self::$_iframe_embed_button;
-    }
-
-
-    /**
-     * @return void
-     */
-    public static function event_list_iframe_embed_button()
-    {
-        $iframe_embed_button = EED_Events_Archive::get_iframe_embed_button();
-        $iframe_embed_button->addEmbedButton();
-    }
-
-
-    /**
-     * @param EE_Events_Archive_Config|null $config
-     * @return EE_Template_Part_Manager
-     * @throws EE_Error
-     */
-    public function initialize_template_parts(EE_Events_Archive_Config $config = null)
-    {
-        $config = $config instanceof EE_Events_Archive_Config ? $config : $this->config();
-        EEH_Autoloader::instance()->register_template_part_autoloaders();
-        $template_parts = new EE_Template_Part_Manager();
-        $template_parts->add_template_part(
-            'tickets',
-            esc_html__('Ticket Selector', 'event_espresso'),
-            'content-espresso_events-tickets.php',
-            $config->display_order_tickets
-        );
-        $template_parts->add_template_part(
-            'datetimes',
-            esc_html__('Dates and Times', 'event_espresso'),
-            'content-espresso_events-datetimes.php',
-            $config->display_order_datetimes
-        );
-        $template_parts->add_template_part(
-            'event',
-            esc_html__('Event Description', 'event_espresso'),
-            'content-espresso_events-details.php',
-            $config->display_order_event
-        );
-        $template_parts->add_template_part(
-            'venue',
-            esc_html__('Venue Information', 'event_espresso'),
-            'content-espresso_events-venues.php',
-            $config->display_order_venue
-        );
-        do_action('AHEE__EED_Event_Archive__initialize_template_parts', $template_parts);
-        return $template_parts;
-    }
-
-
-    /**
-     * initial module setup
-     * this gets called by the EE_Front_Controller if the module route is found in the incoming request
-     *
-     * @param WP $WP
-     * @return void
-     */
-    public function run($WP)
-    {
-        do_action('AHEE__EED_Events_Archive__before_run');
-        // ensure valid EE_Events_Archive_Config() object exists
-        $this->set_config();
-        /** @type EE_Events_Archive_Config $config */
-        $config = $this->config();
-        // load other required components
-        $this->load_event_list_assets();
-        // filter the WP posts_join, posts_where, and posts_orderby SQL clauses
-        // add query filters
-        EEH_Event_Query::add_query_filters();
-        // set params that will get used by the filters
-        EEH_Event_Query::set_query_params(
-            '',                             // month
-            '',                             // category
-            $config->display_expired_events // show_expired
-        );
-        // check what template is loaded
-        add_filter('template_include', [$this, 'template_include'], 999, 1);
-    }
-
-
-    /**
-     * most likely called by the ESPRESSO_EVENTS shortcode which uses this module to do some of it's lifting
-     *
-     * @return void
-     */
-    public function event_list()
-    {
-        // ensure valid EE_Events_Archive_Config() object exists
-        $this->set_config();
-        // load other required components
-        $this->load_event_list_assets();
-    }
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function event_list_iframe()
-    {
-        EED_Events_Archive::$iframe = true;
-        $event_list_iframe          = new EventsArchiveIframe($this);
-        $event_list_iframe->display();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public static function is_iframe()
-    {
-        return EED_Events_Archive::$iframe;
-    }
-
-
-    /**
-     * @return string
-     */
-    public static function link_target()
-    {
-        return EED_Events_Archive::$iframe ? ' target="_blank"' : '';
-    }
-
-
-    /**
-     * @param string $template
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function template_include($template = '')
-    {
-        // don't add content filter for dedicated EE child themes or private posts
-        if (! EEH_Template::is_espresso_theme()) {
-            /** @type EE_Events_Archive_Config $config */
-            $config = $this->config();
-            // add status banner ?
-            if ($config->display_status_banner) {
-                add_filter('the_title', ['EED_Events_Archive', 'the_title'], 100, 2);
-            }
-            // if NOT a custom template
-            if (
-                apply_filters('FHEE__EED_Event_Archive__template_include__allow_custom_selected_template', false)
-                || EE_Registry::instance()
-                              ->load_core('Front_Controller')
-                              ->get_selected_template() !== 'archive-espresso_events.php'
-            ) {
-                add_filter('FHEE__EED_Events_Archive__template_include__events_list_active', '__return_true');
-                // load functions.php file for the theme (loaded by WP if using child theme)
-                EEH_Template::load_espresso_theme_functions();
-                EED_Events_Archive::addEventDetailsFilters();
-                // don't display entry meta because the existing theme will take care of that
-                add_filter('FHEE__content_espresso_events_details_template__display_entry_meta', '__return_false');
-            }
-        }
-        return $template;
-    }
-
-
-    /**
-     * kinda hacky, but if a theme is using get_the_excerpt(),
-     * then we need to remove our filters on the_content()
-     *
-     * @param string $excerpt
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function get_the_excerpt($excerpt = '')
-    {
-        if (post_password_required()) {
-            return $excerpt;
-        }
-        if (apply_filters('FHEE__EED_Events_Archive__get_the_excerpt__theme_uses_get_the_excerpt', false)) {
-            EED_Events_Archive::removeEventDetailsFilters(false);
-            $excerpt = EED_Events_Archive::event_details($excerpt);
-        } else {
-            EED_Events_Archive::$using_get_the_excerpt = true;
-            add_filter('wp_trim_excerpt', ['EED_Events_Archive', 'end_get_the_excerpt'], 999, 1);
-        }
-        return $excerpt;
-    }
-
-
-    /**
-     * @param string $text
-     * @return string
-     */
-    public static function end_get_the_excerpt($text = '')
-    {
-        EED_Events_Archive::$using_get_the_excerpt = false;
-        return $text;
-    }
-
-
-    /**
-     * @param string $title
-     * @param string $id
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function the_title($title = '', $id = '')
-    {
-        global $post;
-        if ($post instanceof WP_Post) {
-            return (EED_Events_Archive::isBlockTheme() || in_the_loop()) && $post->ID == $id
-                ? espresso_event_status_banner($post->ID) . $title
-                : $title;
-        }
-        return $title;
-    }
-
-
-    /**
-     * @param string $content
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function event_details($content)
-    {
-        global $post;
-        static $current_post_ID = 0;
-        if (
-            $current_post_ID !== $post->ID
-            && $post->post_type === 'espresso_events'
-            && ! EED_Events_Archive::$using_get_the_excerpt
-            && ! post_password_required()
-            && (
-                apply_filters('FHEE__EES_Espresso_Events__process_shortcode__true', false)
-                || ! apply_filters('FHEE__content_espresso_events__template_loaded', false)
-            )
-        ) {
-            // Set current post ID to prevent showing content twice, but only if headers have definitely been sent.
-            // Reason being is that some plugins, like Yoast, need to run through a copy of the loop early
-            // BEFORE headers are sent in order to examine the post content and generate content for the HTML header.
-            // We want to allow those plugins to still do their thing and have access to our content, but depending on
-            // how your event content is being displayed (shortcode, CPT route, etc), this filter can get applied twice,
-            // so the following allows this filter to be applied multiple times, but only once for real
-            $current_post_ID = did_action('loop_start') ? $post->ID : 0;
-            if (EE_Registry::instance()->CFG->template_settings->EED_Events_Archive->use_sortable_display_order) {
-                $content = EED_Events_Archive::use_sortable_display_order();
-            } else {
-                $content = EED_Events_Archive::use_filterable_display_order();
-            }
-        }
-        return $content;
-    }
-
-
-    /**
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected static function use_sortable_display_order()
-    {
-        // no further password checks required atm
-        add_filter('FHEE__EED_Events_Archive__event_details__no_post_password_required', '__return_true');
-        // remove this callback from being applied to the_content()
-        EED_Events_Archive::removeEventDetailsFilters();
-        // now add additional content depending on whether event is using the_excerpt() or the_content()
-        EED_Events_Archive::instance()->template_parts = EED_Events_Archive::instance()->initialize_template_parts();
-        $content = EEH_Template::locate_template('content-espresso_events-details.php');
-        $content = EED_Events_Archive::instance()->template_parts->apply_template_part_filters($content);
-        // re-add our main filters (or else the next event won't have them)
-        EED_Events_Archive::addEventDetailsFilters();
-        remove_filter(
-            'FHEE__EED_Events_Archive__event_details__no_post_password_required',
-            '__return_true'
-        );
-        return $content;
-    }
-
-
-    /**
-     * @return string
-     */
-    protected static function use_filterable_display_order()
-    {
-        // remove this callback from being applied to the_content()
-        EED_Events_Archive::removeEventDetailsFilters();
-        // now add additional content depending on whether event is using the_excerpt() or the_content()
-        EED_Events_Archive::_add_additional_excerpt_filters();
-        EED_Events_Archive::_add_additional_content_filters();
-        do_action('AHEE__EED_Events_Archive__use_filterable_display_order__after_add_filters');
-        // now load our template
-        $content = EEH_Template::locate_template('content-espresso_events-details.php');
-        // re-add our main filters (or else the next event won't have them)
-        EED_Events_Archive::addEventDetailsFilters();
-        // but remove the other filters so that they don't get applied to the next post
-        EED_Events_Archive::_remove_additional_events_archive_filters();
-        do_action('AHEE__EED_Events_Archive__use_filterable_display_order__after_remove_filters');
-        // we're not returning the $content directly because the template we are loading uses the_content (or the_excerpt)
-        // return ! empty( $template ) ? $template : $content;
-        return $content;
-    }
-
-
-    /**
-     * adds datetimes ABOVE content
-     *
-     * @param string $content
-     * @return string
-     */
-    public static function event_datetimes($content)
-    {
-        if (post_password_required()) {
-            return $content;
-        }
-        return EEH_Template::locate_template('content-espresso_events-datetimes.php') . $content;
-    }
-
-
-    /**
-     * adds tickets ABOVE content (which includes datetimes)
-     *
-     * @param string $content
-     * @return string
-     */
-    public static function event_tickets($content)
-    {
-        if (post_password_required()) {
-            return $content;
-        }
-        return EEH_Template::locate_template('content-espresso_events-tickets.php') . $content;
-    }
-
-
-    /**
-     * adds venues BELOW content
-     *
-     * @param string $content
-     * @return string
-     */
-    public static function event_venue($content)
-    {
-        return EED_Events_Archive::event_venues($content);
-    }
-
-
-    /**
-     * adds venues BELOW content
-     *
-     * @param string $content
-     * @return string
-     */
-    public static function event_venues($content)
-    {
-        if (post_password_required()) {
-            return $content;
-        }
-        return $content . EEH_Template::locate_template('content-espresso_events-venues.php');
-    }
-
-
-    /**
-     * @return bool
-     * @since $VID:$
-     */
-    public static function isBlockTheme()
-    {
-        return function_exists('wp_is_block_theme') && wp_is_block_theme();
-    }
-
-
-    /**
-     * @return string
-     * @since $VID:$
-     */
-    public static function getExcerptFilter()
-    {
-        static $excerpt_filter = null;
-        if ($excerpt_filter === null) {
-            $excerpt_filter = EED_Events_Archive::isBlockTheme() ? 'get_the_excerpt' : 'the_excerpt';
-        }
-        return $excerpt_filter;
-    }
-
-
-    /**
-     * @since $VID:$
-     */
-    protected static function addEventDetailsFilters()
-    {
-        add_filter(
-            'the_content',
-            ['EED_Events_Archive', 'event_details'],
-            EED_Events_Archive::EVENT_DETAILS_PRIORITY
-        );
-        // but because we don't know if the theme is using the_excerpt()
-        add_filter(
-            EED_Events_Archive::getExcerptFilter(),
-            ['EED_Events_Archive', 'event_details'],
-            EED_Events_Archive::EVENT_DETAILS_PRIORITY
-        );
-        // and just in case they are running get_the_excerpt() which DESTROYS things
-        add_filter('get_the_excerpt', ['EED_Events_Archive', 'get_the_excerpt'], 1, 1);
-    }
-
-
-    /**
-     * @param bool $and_get_the_excerpt
-     * @since $VID:$
-     */
-    protected static function removeEventDetailsFilters($and_get_the_excerpt = true)
-    {
-        // we need to first remove all callbacks from being applied to the_content()
-        // (otherwise it will recurse and blow up the interweb)
-        remove_filter(
-            'the_content',
-            ['EED_Events_Archive', 'event_details'],
-            EED_Events_Archive::EVENT_DETAILS_PRIORITY
-        );
-        remove_filter(
-            EED_Events_Archive::getExcerptFilter(),
-            ['EED_Events_Archive', 'event_details'],
-            EED_Events_Archive::EVENT_DETAILS_PRIORITY
-        );
-        if ($and_get_the_excerpt) {
-            remove_filter('get_the_excerpt', ['EED_Events_Archive', 'get_the_excerpt'], 1);
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private static function _add_additional_excerpt_filters()
-    {
-        add_filter(
-            EED_Events_Archive::getExcerptFilter(),
-            ['EED_Events_Archive', 'event_datetimes'],
-            EED_Events_Archive::EVENT_DATETIMES_PRIORITY
-        );
-        add_filter(
-            EED_Events_Archive::getExcerptFilter(),
-            ['EED_Events_Archive', 'event_tickets'],
-            EED_Events_Archive::EVENT_TICKETS_PRIORITY
-        );
-        add_filter(
-            EED_Events_Archive::getExcerptFilter(),
-            ['EED_Events_Archive', 'event_venues'],
-            EED_Events_Archive::EVENT_VENUES_PRIORITY
-        );
-    }
-
-
-    /**
-     * @return void
-     */
-    private static function _add_additional_content_filters()
-    {
-        add_filter(
-            'the_content',
-            ['EED_Events_Archive', 'event_datetimes'],
-            EED_Events_Archive::EVENT_DATETIMES_PRIORITY
-        );
-        add_filter(
-            'the_content',
-            ['EED_Events_Archive', 'event_tickets'],
-            EED_Events_Archive::EVENT_TICKETS_PRIORITY
-        );
-        add_filter(
-            'the_content',
-            ['EED_Events_Archive', 'event_venues'],
-            EED_Events_Archive::EVENT_VENUES_PRIORITY
-        );
-    }
-
-
-    /**
-     * @return void
-     */
-    private static function _remove_additional_events_archive_filters()
-    {
-        remove_filter(
-            EED_Events_Archive::getExcerptFilter(),
-            ['EED_Events_Archive', 'event_datetimes'],
-            EED_Events_Archive::EVENT_DATETIMES_PRIORITY
-        );
-        remove_filter(
-            EED_Events_Archive::getExcerptFilter(),
-            ['EED_Events_Archive', 'event_tickets'],
-            EED_Events_Archive::EVENT_TICKETS_PRIORITY
-        );
-        remove_filter(
-            EED_Events_Archive::getExcerptFilter(),
-            ['EED_Events_Archive', 'event_venues'],
-            EED_Events_Archive::EVENT_VENUES_PRIORITY
-        );
-        remove_filter(
-            'the_content',
-            ['EED_Events_Archive', 'event_datetimes'],
-            EED_Events_Archive::EVENT_DATETIMES_PRIORITY
-        );
-        remove_filter(
-            'the_content',
-            ['EED_Events_Archive', 'event_tickets'],
-            EED_Events_Archive::EVENT_TICKETS_PRIORITY
-        );
-        remove_filter(
-            'the_content',
-            ['EED_Events_Archive', 'event_venues'],
-            EED_Events_Archive::EVENT_VENUES_PRIORITY
-        );
-    }
-
-
-    /**
-     * @return void
-     */
-    public static function remove_all_events_archive_filters()
-    {
-        // remove_filter( 'get_the_excerpt', array( 'EED_Events_Archive', 'get_the_excerpt' ), 1 );
-        remove_filter('the_title', ['EED_Events_Archive', 'the_title'], 1);
-        remove_filter(
-            EED_Events_Archive::getExcerptFilter(),
-            ['EED_Events_Archive', 'event_details'],
-            EED_Events_Archive::EVENT_DETAILS_PRIORITY
-        );
-        remove_filter(
-            EED_Events_Archive::getExcerptFilter(),
-            ['EED_Events_Archive', 'event_datetimes'],
-            EED_Events_Archive::EVENT_DATETIMES_PRIORITY
-        );
-        remove_filter(
-            EED_Events_Archive::getExcerptFilter(),
-            ['EED_Events_Archive', 'event_tickets'],
-            EED_Events_Archive::EVENT_TICKETS_PRIORITY
-        );
-        remove_filter(
-            EED_Events_Archive::getExcerptFilter(),
-            ['EED_Events_Archive', 'event_venues'],
-            EED_Events_Archive::EVENT_VENUES_PRIORITY
-        );
-        remove_filter(
-            'the_content',
-            ['EED_Events_Archive', 'event_details'],
-            EED_Events_Archive::EVENT_DETAILS_PRIORITY
-        );
-        remove_filter(
-            'the_content',
-            ['EED_Events_Archive', 'event_datetimes'],
-            EED_Events_Archive::EVENT_DATETIMES_PRIORITY
-        );
-        remove_filter(
-            'the_content',
-            ['EED_Events_Archive', 'event_tickets'],
-            EED_Events_Archive::EVENT_TICKETS_PRIORITY
-        );
-        remove_filter(
-            'the_content',
-            ['EED_Events_Archive', 'event_venues'],
-            EED_Events_Archive::EVENT_VENUES_PRIORITY
-        );
-        // don't display entry meta because the existing theme will take care of that
-        remove_filter(
-            'FHEE__content_espresso_events_details_template__display_entry_meta',
-            '__return_false'
-        );
-    }
-
-
-    /**
-     * @return void
-     */
-    public function load_event_list_assets()
-    {
-        do_action('AHEE__EED_Events_Archive__before_load_assets');
-        add_filter('FHEE_load_EE_Session', '__return_true');
-        add_filter('FHEE__EED_Ticket_Selector__load_tckt_slctr_assets', '__return_true');
-        add_action('wp_enqueue_scripts', [$this, 'wp_enqueue_scripts'], 10);
-        if (EE_Registry::instance()->CFG->map_settings->use_google_maps) {
-            add_action('wp_enqueue_scripts', ['EEH_Maps', 'espresso_google_map_js'], 11);
-        }
-    }
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     */
-    public function wp_enqueue_scripts()
-    {
-        // get some style
-        if (apply_filters('FHEE_enable_default_espresso_css', false)) {
-            // first check uploads folder
-            if (EEH_File::is_readable(get_stylesheet_directory() . $this->theme . '/style.css')) {
-                wp_register_style(
-                    $this->theme,
-                    get_stylesheet_directory_uri() . $this->theme . '/style.css',
-                    ['dashicons', 'espresso_default']
-                );
-            }
-            wp_enqueue_style($this->theme);
-        }
-    }
-
-
-    /**
-     * @static
-     * @return void
-     */
-    public static function template_settings_form()
-    {
-        $template_settings                     = EE_Registry::instance()->CFG->template_settings;
-        $template_settings->EED_Events_Archive = isset($template_settings->EED_Events_Archive)
-            ? $template_settings->EED_Events_Archive : new EE_Events_Archive_Config();
-        $template_settings->EED_Events_Archive = apply_filters(
-            'FHEE__EED_Events_Archive__template_settings_form__event_list_config',
-            $template_settings->EED_Events_Archive
-        );
-        $events_archive_settings               = [
-            'display_status_banner'   => 0,
-            'display_description'     => 1,
-            'display_ticket_selector' => 0,
-            'display_datetimes'       => 1,
-            'display_venue'           => 0,
-            'display_expired_events'  => 0,
-        ];
-        $events_archive_settings               = array_merge(
-            $events_archive_settings,
-            (array) $template_settings->EED_Events_Archive
-        );
-        EEH_Template::display_template(
-            EVENTS_ARCHIVE_TEMPLATES_PATH . 'admin-event-list-settings.template.php',
-            $events_archive_settings
-        );
-    }
-
-
-    /**
-     * @param EE_Template_Config $CFG
-     * @param array              $REQ
-     * @return EE_Template_Config
-     */
-    public static function update_template_settings($CFG, $REQ)
-    {
-        $CFG->EED_Events_Archive = new EE_Events_Archive_Config();
-        // unless we are resetting the config...
-        if (
-            ! isset($REQ['EED_Events_Archive_reset_event_list_settings'])
-            || absint($REQ['EED_Events_Archive_reset_event_list_settings']) !== 1
-        ) {
-            $CFG->EED_Events_Archive->display_status_banner   = isset($REQ['EED_Events_Archive_display_status_banner'])
-                ? absint($REQ['EED_Events_Archive_display_status_banner'])
-                : 0;
-            $CFG->EED_Events_Archive->display_description     = isset($REQ['EED_Events_Archive_display_description'])
-                ? absint($REQ['EED_Events_Archive_display_description'])
-                : 1;
-            $CFG->EED_Events_Archive->display_ticket_selector = isset($REQ['EED_Events_Archive_display_ticket_selector'])
-                ? absint($REQ['EED_Events_Archive_display_ticket_selector'])
-                : 0;
-            $CFG->EED_Events_Archive->display_datetimes       = isset($REQ['EED_Events_Archive_display_datetimes'])
-                ? absint($REQ['EED_Events_Archive_display_datetimes'])
-                : 1;
-            $CFG->EED_Events_Archive->display_venue           = isset($REQ['EED_Events_Archive_display_venue'])
-                ? absint($REQ['EED_Events_Archive_display_venue'])
-                : 0;
-            $CFG->EED_Events_Archive->display_expired_events  = isset($REQ['EED_Events_Archive_display_expired_events'])
-                ? absint($REQ['EED_Events_Archive_display_expired_events'])
-                : 0;
-        }
-        return $CFG;
-    }
-
-
-    /**
-     * @param string $extra_class
-     * @return string
-     */
-    public static function event_list_css($extra_class = '')
-    {
-        $event_list_css   = ! empty($extra_class) ? [$extra_class] : [];
-        $event_list_css[] = 'espresso-event-list-event';
-        return implode(' ', $event_list_css);
-    }
-
-
-    /**
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function event_categories()
-    {
-        return EE_Registry::instance()->load_model('Term')->get_all_ee_categories();
-    }
-
-
-    /**
-     * @param $value
-     * @return bool
-     */
-    public static function display_description($value)
-    {
-        $config              = EE_Registry::instance()->CFG->template_settings->EED_Events_Archive;
-        $display_description = isset($config->display_description) ? $config->display_description : 1;
-        return $display_description === $value;
-    }
-
-
-    /**
-     * @return bool
-     */
-    public static function display_ticket_selector()
-    {
-        $config = EE_Registry::instance()->CFG->template_settings->EED_Events_Archive;
-        return isset($config->display_ticket_selector) && $config->display_ticket_selector;
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function display_venue()
-    {
-        $config = EE_Registry::instance()->CFG->template_settings->EED_Events_Archive;
-        return isset($config->display_venue) && $config->display_venue && EEH_Venue_View::venue_name();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public static function display_datetimes()
-    {
-        $config = EE_Registry::instance()->CFG->template_settings->EED_Events_Archive;
-        return isset($config->display_datetimes) && $config->display_datetimes;
-    }
-
-
-    /**
-     * @return string
-     */
-    public static function event_list_title()
-    {
-        return apply_filters(
-            'FHEE__archive_espresso_events_template__upcoming_events_h1',
-            esc_html__('Upcoming Events', 'event_espresso')
-        );
-    }
-
-
-    // GRAVEYARD
-
-
-    /**
-     * @since 4.4.0
-     */
-    public static function _doing_it_wrong_notice($function = '')
-    {
-        EE_Error::doing_it_wrong(
-            __FUNCTION__,
-            sprintf(
-                esc_html__(
-                    'EED_Events_Archive::%1$s was moved to EEH_Event_Query::%1$s:%2$sPlease update your existing code because the method it calls will be removed in version %3$s',
-                    'event_espresso'
-                ),
-                $function,
-                '<br />',
-                '4.6.0'
-            ),
-            '4.4.0'
-        );
-    }
-
-
-    /**
-     * @deprecated
-     * @since 4.4.0
-     */
-    public function get_post_data()
-    {
-        EEH_Event_Query::set_query_params();
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @since 4.4.0
-     * @deprecated
-     */
-    public function posts_fields($SQL, WP_Query $wp_query)
-    {
-        EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
-        return EEH_Event_Query::posts_fields($SQL, $wp_query);
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @since 4.4.0
-     * @deprecated
-     */
-    public static function posts_fields_sql_for_orderby($orderby_params = [])
-    {
-        EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
-        return EEH_Event_Query::posts_fields_sql_for_orderby($orderby_params);
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @since 4.4.0
-     * @deprecated
-     */
-    public function posts_join($SQL, WP_Query $wp_query)
-    {
-        EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
-        return EEH_Event_Query::posts_join($SQL, $wp_query);
-    }
-
-
-    /**
-     * @deprecated
-     * @since 4.4.0
-     */
-    public static function posts_join_sql_for_terms($join_terms = null)
-    {
-        EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
-        return EEH_Event_Query::posts_join_sql_for_terms($join_terms);
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @since 4.4.0
-     * @deprecated
-     */
-    public static function posts_join_for_orderby($orderby_params = [])
-    {
-        EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
-        return EEH_Event_Query::posts_join_for_orderby($orderby_params);
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @since 4.4.0
-     * @deprecated
-     */
-    public function posts_where($SQL, WP_Query $wp_query)
-    {
-        EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
-        return EEH_Event_Query::posts_where($SQL, $wp_query);
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @since 4.4.0
-     * @deprecated
-     */
-    public static function posts_where_sql_for_show_expired($show_expired = false)
-    {
-        EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
-        return EEH_Event_Query::posts_where_sql_for_show_expired($show_expired);
-    }
-
-
-    /**
-     * @deprecated
-     * @since 4.4.0
-     */
-    public static function posts_where_sql_for_event_category_slug($event_category_slug = null)
-    {
-        EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
-        return EEH_Event_Query::posts_where_sql_for_event_category_slug($event_category_slug);
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @since 4.4.0
-     * @deprecated
-     */
-    public static function posts_where_sql_for_event_list_month($month = null)
-    {
-        EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
-        return EEH_Event_Query::posts_where_sql_for_event_list_month($month);
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @since 4.4.0
-     * @deprecated
-     */
-    public function posts_orderby($SQL, WP_Query $wp_query)
-    {
-        EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
-        return EEH_Event_Query::posts_orderby($SQL, $wp_query);
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @since 4.4.0
-     * @deprecated
-     */
-    public static function posts_orderby_sql($orderby_params = [], $sort = 'ASC')
-    {
-        EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
-        return EEH_Event_Query::posts_orderby_sql($orderby_params, $sort);
-    }
+	const EVENT_DETAILS_PRIORITY   = 100;
+
+	const EVENT_DATETIMES_PRIORITY = 110;
+
+	const EVENT_TICKETS_PRIORITY   = 120;
+
+	const EVENT_VENUES_PRIORITY    = 130;
+
+
+	public static $espresso_event_list_ID    = 0;
+
+	public static $espresso_grid_event_lists = [];
+
+	/**
+	 * @type bool $using_get_the_excerpt
+	 */
+	protected static $using_get_the_excerpt = false;
+
+	/**
+	 * Used to flag when the event list is being called from an external iframe.
+	 *
+	 * @var bool $iframe
+	 */
+	protected static $iframe = false;
+
+	/**
+	 * @var EventListIframeEmbedButton $_iframe_embed_button
+	 */
+	private static $_iframe_embed_button;
+
+	/**
+	 * @type EE_Template_Part_Manager $template_parts
+	 */
+	protected $template_parts;
+
+
+	/**
+	 * @return EED_Events_Archive
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function instance()
+	{
+		return parent::get_instance(__CLASS__);
+	}
+
+
+	/**
+	 * for hooking into EE Core, other modules, etc
+	 *
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function set_hooks()
+	{
+		/** @var CustomPostTypeDefinitions $custom_post_type_definitions */
+		$custom_post_type_definitions = LoaderFactory::getLoader()->getShared(CustomPostTypeDefinitions::class);
+		$custom_post_types            = $custom_post_type_definitions->getDefinitions();
+		EE_Config::register_route(
+			$custom_post_types['espresso_events']['plural_slug'],
+			'Events_Archive',
+			'run'
+		);
+		EE_Config::register_route(
+			'event_list',
+			'Events_Archive',
+			'event_list'
+		);
+		EE_Config::register_route(
+			'iframe',
+			'Events_Archive',
+			'event_list_iframe',
+			'event_list'
+		);
+		add_action('wp_loaded', ['EED_Events_Archive', 'set_definitions'], 2);
+	}
+
+
+	/**
+	 * for hooking into EE Admin Core, other modules, etc
+	 *
+	 * @return void
+	 */
+	public static function set_hooks_admin()
+	{
+		add_action('wp_loaded', ['EED_Events_Archive', 'set_definitions'], 2);
+		// hook into the end of the \EE_Admin_Page::_load_page_dependencies()
+		// to load assets for "espresso_events" page on the "default" route (action)
+		add_action(
+			'FHEE__EE_Admin_Page___load_page_dependencies__after_load__espresso_events__default',
+			['EED_Events_Archive', 'event_list_iframe_embed_button'],
+			10
+		);
+	}
+
+
+	/**
+	 * @return void
+	 */
+	public static function set_definitions()
+	{
+		define('EVENTS_ARCHIVE_ASSETS_URL', plugin_dir_url(__FILE__) . 'assets/');
+		define('EVENTS_ARCHIVE_TEMPLATES_PATH', str_replace('\\', '/', plugin_dir_path(__FILE__)) . 'templates/');
+	}
+
+
+	/**
+	 * set up EE_Events_Archive_Config
+	 */
+	protected function set_config()
+	{
+		$this->set_config_section('template_settings');
+		$this->set_config_class('EE_Events_Archive_Config');
+		$this->set_config_name('EED_Events_Archive');
+	}
+
+
+	/**
+	 * @return EventListIframeEmbedButton
+	 */
+	public static function get_iframe_embed_button()
+	{
+		if (! self::$_iframe_embed_button instanceof EventListIframeEmbedButton) {
+			self::$_iframe_embed_button = new EventListIframeEmbedButton();
+		}
+		return self::$_iframe_embed_button;
+	}
+
+
+	/**
+	 * @return void
+	 */
+	public static function event_list_iframe_embed_button()
+	{
+		$iframe_embed_button = EED_Events_Archive::get_iframe_embed_button();
+		$iframe_embed_button->addEmbedButton();
+	}
+
+
+	/**
+	 * @param EE_Events_Archive_Config|null $config
+	 * @return EE_Template_Part_Manager
+	 * @throws EE_Error
+	 */
+	public function initialize_template_parts(EE_Events_Archive_Config $config = null)
+	{
+		$config = $config instanceof EE_Events_Archive_Config ? $config : $this->config();
+		EEH_Autoloader::instance()->register_template_part_autoloaders();
+		$template_parts = new EE_Template_Part_Manager();
+		$template_parts->add_template_part(
+			'tickets',
+			esc_html__('Ticket Selector', 'event_espresso'),
+			'content-espresso_events-tickets.php',
+			$config->display_order_tickets
+		);
+		$template_parts->add_template_part(
+			'datetimes',
+			esc_html__('Dates and Times', 'event_espresso'),
+			'content-espresso_events-datetimes.php',
+			$config->display_order_datetimes
+		);
+		$template_parts->add_template_part(
+			'event',
+			esc_html__('Event Description', 'event_espresso'),
+			'content-espresso_events-details.php',
+			$config->display_order_event
+		);
+		$template_parts->add_template_part(
+			'venue',
+			esc_html__('Venue Information', 'event_espresso'),
+			'content-espresso_events-venues.php',
+			$config->display_order_venue
+		);
+		do_action('AHEE__EED_Event_Archive__initialize_template_parts', $template_parts);
+		return $template_parts;
+	}
+
+
+	/**
+	 * initial module setup
+	 * this gets called by the EE_Front_Controller if the module route is found in the incoming request
+	 *
+	 * @param WP $WP
+	 * @return void
+	 */
+	public function run($WP)
+	{
+		do_action('AHEE__EED_Events_Archive__before_run');
+		// ensure valid EE_Events_Archive_Config() object exists
+		$this->set_config();
+		/** @type EE_Events_Archive_Config $config */
+		$config = $this->config();
+		// load other required components
+		$this->load_event_list_assets();
+		// filter the WP posts_join, posts_where, and posts_orderby SQL clauses
+		// add query filters
+		EEH_Event_Query::add_query_filters();
+		// set params that will get used by the filters
+		EEH_Event_Query::set_query_params(
+			'',                             // month
+			'',                             // category
+			$config->display_expired_events // show_expired
+		);
+		// check what template is loaded
+		add_filter('template_include', [$this, 'template_include'], 999, 1);
+	}
+
+
+	/**
+	 * most likely called by the ESPRESSO_EVENTS shortcode which uses this module to do some of it's lifting
+	 *
+	 * @return void
+	 */
+	public function event_list()
+	{
+		// ensure valid EE_Events_Archive_Config() object exists
+		$this->set_config();
+		// load other required components
+		$this->load_event_list_assets();
+	}
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function event_list_iframe()
+	{
+		EED_Events_Archive::$iframe = true;
+		$event_list_iframe          = new EventsArchiveIframe($this);
+		$event_list_iframe->display();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public static function is_iframe()
+	{
+		return EED_Events_Archive::$iframe;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public static function link_target()
+	{
+		return EED_Events_Archive::$iframe ? ' target="_blank"' : '';
+	}
+
+
+	/**
+	 * @param string $template
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function template_include($template = '')
+	{
+		// don't add content filter for dedicated EE child themes or private posts
+		if (! EEH_Template::is_espresso_theme()) {
+			/** @type EE_Events_Archive_Config $config */
+			$config = $this->config();
+			// add status banner ?
+			if ($config->display_status_banner) {
+				add_filter('the_title', ['EED_Events_Archive', 'the_title'], 100, 2);
+			}
+			// if NOT a custom template
+			if (
+				apply_filters('FHEE__EED_Event_Archive__template_include__allow_custom_selected_template', false)
+				|| EE_Registry::instance()
+							  ->load_core('Front_Controller')
+							  ->get_selected_template() !== 'archive-espresso_events.php'
+			) {
+				add_filter('FHEE__EED_Events_Archive__template_include__events_list_active', '__return_true');
+				// load functions.php file for the theme (loaded by WP if using child theme)
+				EEH_Template::load_espresso_theme_functions();
+				EED_Events_Archive::addEventDetailsFilters();
+				// don't display entry meta because the existing theme will take care of that
+				add_filter('FHEE__content_espresso_events_details_template__display_entry_meta', '__return_false');
+			}
+		}
+		return $template;
+	}
+
+
+	/**
+	 * kinda hacky, but if a theme is using get_the_excerpt(),
+	 * then we need to remove our filters on the_content()
+	 *
+	 * @param string $excerpt
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function get_the_excerpt($excerpt = '')
+	{
+		if (post_password_required()) {
+			return $excerpt;
+		}
+		if (apply_filters('FHEE__EED_Events_Archive__get_the_excerpt__theme_uses_get_the_excerpt', false)) {
+			EED_Events_Archive::removeEventDetailsFilters(false);
+			$excerpt = EED_Events_Archive::event_details($excerpt);
+		} else {
+			EED_Events_Archive::$using_get_the_excerpt = true;
+			add_filter('wp_trim_excerpt', ['EED_Events_Archive', 'end_get_the_excerpt'], 999, 1);
+		}
+		return $excerpt;
+	}
+
+
+	/**
+	 * @param string $text
+	 * @return string
+	 */
+	public static function end_get_the_excerpt($text = '')
+	{
+		EED_Events_Archive::$using_get_the_excerpt = false;
+		return $text;
+	}
+
+
+	/**
+	 * @param string $title
+	 * @param string $id
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function the_title($title = '', $id = '')
+	{
+		global $post;
+		if ($post instanceof WP_Post) {
+			return (EED_Events_Archive::isBlockTheme() || in_the_loop()) && $post->ID == $id
+				? espresso_event_status_banner($post->ID) . $title
+				: $title;
+		}
+		return $title;
+	}
+
+
+	/**
+	 * @param string $content
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function event_details($content)
+	{
+		global $post;
+		static $current_post_ID = 0;
+		if (
+			$current_post_ID !== $post->ID
+			&& $post->post_type === 'espresso_events'
+			&& ! EED_Events_Archive::$using_get_the_excerpt
+			&& ! post_password_required()
+			&& (
+				apply_filters('FHEE__EES_Espresso_Events__process_shortcode__true', false)
+				|| ! apply_filters('FHEE__content_espresso_events__template_loaded', false)
+			)
+		) {
+			// Set current post ID to prevent showing content twice, but only if headers have definitely been sent.
+			// Reason being is that some plugins, like Yoast, need to run through a copy of the loop early
+			// BEFORE headers are sent in order to examine the post content and generate content for the HTML header.
+			// We want to allow those plugins to still do their thing and have access to our content, but depending on
+			// how your event content is being displayed (shortcode, CPT route, etc), this filter can get applied twice,
+			// so the following allows this filter to be applied multiple times, but only once for real
+			$current_post_ID = did_action('loop_start') ? $post->ID : 0;
+			if (EE_Registry::instance()->CFG->template_settings->EED_Events_Archive->use_sortable_display_order) {
+				$content = EED_Events_Archive::use_sortable_display_order();
+			} else {
+				$content = EED_Events_Archive::use_filterable_display_order();
+			}
+		}
+		return $content;
+	}
+
+
+	/**
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected static function use_sortable_display_order()
+	{
+		// no further password checks required atm
+		add_filter('FHEE__EED_Events_Archive__event_details__no_post_password_required', '__return_true');
+		// remove this callback from being applied to the_content()
+		EED_Events_Archive::removeEventDetailsFilters();
+		// now add additional content depending on whether event is using the_excerpt() or the_content()
+		EED_Events_Archive::instance()->template_parts = EED_Events_Archive::instance()->initialize_template_parts();
+		$content = EEH_Template::locate_template('content-espresso_events-details.php');
+		$content = EED_Events_Archive::instance()->template_parts->apply_template_part_filters($content);
+		// re-add our main filters (or else the next event won't have them)
+		EED_Events_Archive::addEventDetailsFilters();
+		remove_filter(
+			'FHEE__EED_Events_Archive__event_details__no_post_password_required',
+			'__return_true'
+		);
+		return $content;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	protected static function use_filterable_display_order()
+	{
+		// remove this callback from being applied to the_content()
+		EED_Events_Archive::removeEventDetailsFilters();
+		// now add additional content depending on whether event is using the_excerpt() or the_content()
+		EED_Events_Archive::_add_additional_excerpt_filters();
+		EED_Events_Archive::_add_additional_content_filters();
+		do_action('AHEE__EED_Events_Archive__use_filterable_display_order__after_add_filters');
+		// now load our template
+		$content = EEH_Template::locate_template('content-espresso_events-details.php');
+		// re-add our main filters (or else the next event won't have them)
+		EED_Events_Archive::addEventDetailsFilters();
+		// but remove the other filters so that they don't get applied to the next post
+		EED_Events_Archive::_remove_additional_events_archive_filters();
+		do_action('AHEE__EED_Events_Archive__use_filterable_display_order__after_remove_filters');
+		// we're not returning the $content directly because the template we are loading uses the_content (or the_excerpt)
+		// return ! empty( $template ) ? $template : $content;
+		return $content;
+	}
+
+
+	/**
+	 * adds datetimes ABOVE content
+	 *
+	 * @param string $content
+	 * @return string
+	 */
+	public static function event_datetimes($content)
+	{
+		if (post_password_required()) {
+			return $content;
+		}
+		return EEH_Template::locate_template('content-espresso_events-datetimes.php') . $content;
+	}
+
+
+	/**
+	 * adds tickets ABOVE content (which includes datetimes)
+	 *
+	 * @param string $content
+	 * @return string
+	 */
+	public static function event_tickets($content)
+	{
+		if (post_password_required()) {
+			return $content;
+		}
+		return EEH_Template::locate_template('content-espresso_events-tickets.php') . $content;
+	}
+
+
+	/**
+	 * adds venues BELOW content
+	 *
+	 * @param string $content
+	 * @return string
+	 */
+	public static function event_venue($content)
+	{
+		return EED_Events_Archive::event_venues($content);
+	}
+
+
+	/**
+	 * adds venues BELOW content
+	 *
+	 * @param string $content
+	 * @return string
+	 */
+	public static function event_venues($content)
+	{
+		if (post_password_required()) {
+			return $content;
+		}
+		return $content . EEH_Template::locate_template('content-espresso_events-venues.php');
+	}
+
+
+	/**
+	 * @return bool
+	 * @since $VID:$
+	 */
+	public static function isBlockTheme()
+	{
+		return function_exists('wp_is_block_theme') && wp_is_block_theme();
+	}
+
+
+	/**
+	 * @return string
+	 * @since $VID:$
+	 */
+	public static function getExcerptFilter()
+	{
+		static $excerpt_filter = null;
+		if ($excerpt_filter === null) {
+			$excerpt_filter = EED_Events_Archive::isBlockTheme() ? 'get_the_excerpt' : 'the_excerpt';
+		}
+		return $excerpt_filter;
+	}
+
+
+	/**
+	 * @since $VID:$
+	 */
+	protected static function addEventDetailsFilters()
+	{
+		add_filter(
+			'the_content',
+			['EED_Events_Archive', 'event_details'],
+			EED_Events_Archive::EVENT_DETAILS_PRIORITY
+		);
+		// but because we don't know if the theme is using the_excerpt()
+		add_filter(
+			EED_Events_Archive::getExcerptFilter(),
+			['EED_Events_Archive', 'event_details'],
+			EED_Events_Archive::EVENT_DETAILS_PRIORITY
+		);
+		// and just in case they are running get_the_excerpt() which DESTROYS things
+		add_filter('get_the_excerpt', ['EED_Events_Archive', 'get_the_excerpt'], 1, 1);
+	}
+
+
+	/**
+	 * @param bool $and_get_the_excerpt
+	 * @since $VID:$
+	 */
+	protected static function removeEventDetailsFilters($and_get_the_excerpt = true)
+	{
+		// we need to first remove all callbacks from being applied to the_content()
+		// (otherwise it will recurse and blow up the interweb)
+		remove_filter(
+			'the_content',
+			['EED_Events_Archive', 'event_details'],
+			EED_Events_Archive::EVENT_DETAILS_PRIORITY
+		);
+		remove_filter(
+			EED_Events_Archive::getExcerptFilter(),
+			['EED_Events_Archive', 'event_details'],
+			EED_Events_Archive::EVENT_DETAILS_PRIORITY
+		);
+		if ($and_get_the_excerpt) {
+			remove_filter('get_the_excerpt', ['EED_Events_Archive', 'get_the_excerpt'], 1);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private static function _add_additional_excerpt_filters()
+	{
+		add_filter(
+			EED_Events_Archive::getExcerptFilter(),
+			['EED_Events_Archive', 'event_datetimes'],
+			EED_Events_Archive::EVENT_DATETIMES_PRIORITY
+		);
+		add_filter(
+			EED_Events_Archive::getExcerptFilter(),
+			['EED_Events_Archive', 'event_tickets'],
+			EED_Events_Archive::EVENT_TICKETS_PRIORITY
+		);
+		add_filter(
+			EED_Events_Archive::getExcerptFilter(),
+			['EED_Events_Archive', 'event_venues'],
+			EED_Events_Archive::EVENT_VENUES_PRIORITY
+		);
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private static function _add_additional_content_filters()
+	{
+		add_filter(
+			'the_content',
+			['EED_Events_Archive', 'event_datetimes'],
+			EED_Events_Archive::EVENT_DATETIMES_PRIORITY
+		);
+		add_filter(
+			'the_content',
+			['EED_Events_Archive', 'event_tickets'],
+			EED_Events_Archive::EVENT_TICKETS_PRIORITY
+		);
+		add_filter(
+			'the_content',
+			['EED_Events_Archive', 'event_venues'],
+			EED_Events_Archive::EVENT_VENUES_PRIORITY
+		);
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private static function _remove_additional_events_archive_filters()
+	{
+		remove_filter(
+			EED_Events_Archive::getExcerptFilter(),
+			['EED_Events_Archive', 'event_datetimes'],
+			EED_Events_Archive::EVENT_DATETIMES_PRIORITY
+		);
+		remove_filter(
+			EED_Events_Archive::getExcerptFilter(),
+			['EED_Events_Archive', 'event_tickets'],
+			EED_Events_Archive::EVENT_TICKETS_PRIORITY
+		);
+		remove_filter(
+			EED_Events_Archive::getExcerptFilter(),
+			['EED_Events_Archive', 'event_venues'],
+			EED_Events_Archive::EVENT_VENUES_PRIORITY
+		);
+		remove_filter(
+			'the_content',
+			['EED_Events_Archive', 'event_datetimes'],
+			EED_Events_Archive::EVENT_DATETIMES_PRIORITY
+		);
+		remove_filter(
+			'the_content',
+			['EED_Events_Archive', 'event_tickets'],
+			EED_Events_Archive::EVENT_TICKETS_PRIORITY
+		);
+		remove_filter(
+			'the_content',
+			['EED_Events_Archive', 'event_venues'],
+			EED_Events_Archive::EVENT_VENUES_PRIORITY
+		);
+	}
+
+
+	/**
+	 * @return void
+	 */
+	public static function remove_all_events_archive_filters()
+	{
+		// remove_filter( 'get_the_excerpt', array( 'EED_Events_Archive', 'get_the_excerpt' ), 1 );
+		remove_filter('the_title', ['EED_Events_Archive', 'the_title'], 1);
+		remove_filter(
+			EED_Events_Archive::getExcerptFilter(),
+			['EED_Events_Archive', 'event_details'],
+			EED_Events_Archive::EVENT_DETAILS_PRIORITY
+		);
+		remove_filter(
+			EED_Events_Archive::getExcerptFilter(),
+			['EED_Events_Archive', 'event_datetimes'],
+			EED_Events_Archive::EVENT_DATETIMES_PRIORITY
+		);
+		remove_filter(
+			EED_Events_Archive::getExcerptFilter(),
+			['EED_Events_Archive', 'event_tickets'],
+			EED_Events_Archive::EVENT_TICKETS_PRIORITY
+		);
+		remove_filter(
+			EED_Events_Archive::getExcerptFilter(),
+			['EED_Events_Archive', 'event_venues'],
+			EED_Events_Archive::EVENT_VENUES_PRIORITY
+		);
+		remove_filter(
+			'the_content',
+			['EED_Events_Archive', 'event_details'],
+			EED_Events_Archive::EVENT_DETAILS_PRIORITY
+		);
+		remove_filter(
+			'the_content',
+			['EED_Events_Archive', 'event_datetimes'],
+			EED_Events_Archive::EVENT_DATETIMES_PRIORITY
+		);
+		remove_filter(
+			'the_content',
+			['EED_Events_Archive', 'event_tickets'],
+			EED_Events_Archive::EVENT_TICKETS_PRIORITY
+		);
+		remove_filter(
+			'the_content',
+			['EED_Events_Archive', 'event_venues'],
+			EED_Events_Archive::EVENT_VENUES_PRIORITY
+		);
+		// don't display entry meta because the existing theme will take care of that
+		remove_filter(
+			'FHEE__content_espresso_events_details_template__display_entry_meta',
+			'__return_false'
+		);
+	}
+
+
+	/**
+	 * @return void
+	 */
+	public function load_event_list_assets()
+	{
+		do_action('AHEE__EED_Events_Archive__before_load_assets');
+		add_filter('FHEE_load_EE_Session', '__return_true');
+		add_filter('FHEE__EED_Ticket_Selector__load_tckt_slctr_assets', '__return_true');
+		add_action('wp_enqueue_scripts', [$this, 'wp_enqueue_scripts'], 10);
+		if (EE_Registry::instance()->CFG->map_settings->use_google_maps) {
+			add_action('wp_enqueue_scripts', ['EEH_Maps', 'espresso_google_map_js'], 11);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function wp_enqueue_scripts()
+	{
+		// get some style
+		if (apply_filters('FHEE_enable_default_espresso_css', false)) {
+			// first check uploads folder
+			if (EEH_File::is_readable(get_stylesheet_directory() . $this->theme . '/style.css')) {
+				wp_register_style(
+					$this->theme,
+					get_stylesheet_directory_uri() . $this->theme . '/style.css',
+					['dashicons', 'espresso_default']
+				);
+			}
+			wp_enqueue_style($this->theme);
+		}
+	}
+
+
+	/**
+	 * @static
+	 * @return void
+	 */
+	public static function template_settings_form()
+	{
+		$template_settings                     = EE_Registry::instance()->CFG->template_settings;
+		$template_settings->EED_Events_Archive = isset($template_settings->EED_Events_Archive)
+			? $template_settings->EED_Events_Archive : new EE_Events_Archive_Config();
+		$template_settings->EED_Events_Archive = apply_filters(
+			'FHEE__EED_Events_Archive__template_settings_form__event_list_config',
+			$template_settings->EED_Events_Archive
+		);
+		$events_archive_settings               = [
+			'display_status_banner'   => 0,
+			'display_description'     => 1,
+			'display_ticket_selector' => 0,
+			'display_datetimes'       => 1,
+			'display_venue'           => 0,
+			'display_expired_events'  => 0,
+		];
+		$events_archive_settings               = array_merge(
+			$events_archive_settings,
+			(array) $template_settings->EED_Events_Archive
+		);
+		EEH_Template::display_template(
+			EVENTS_ARCHIVE_TEMPLATES_PATH . 'admin-event-list-settings.template.php',
+			$events_archive_settings
+		);
+	}
+
+
+	/**
+	 * @param EE_Template_Config $CFG
+	 * @param array              $REQ
+	 * @return EE_Template_Config
+	 */
+	public static function update_template_settings($CFG, $REQ)
+	{
+		$CFG->EED_Events_Archive = new EE_Events_Archive_Config();
+		// unless we are resetting the config...
+		if (
+			! isset($REQ['EED_Events_Archive_reset_event_list_settings'])
+			|| absint($REQ['EED_Events_Archive_reset_event_list_settings']) !== 1
+		) {
+			$CFG->EED_Events_Archive->display_status_banner   = isset($REQ['EED_Events_Archive_display_status_banner'])
+				? absint($REQ['EED_Events_Archive_display_status_banner'])
+				: 0;
+			$CFG->EED_Events_Archive->display_description     = isset($REQ['EED_Events_Archive_display_description'])
+				? absint($REQ['EED_Events_Archive_display_description'])
+				: 1;
+			$CFG->EED_Events_Archive->display_ticket_selector = isset($REQ['EED_Events_Archive_display_ticket_selector'])
+				? absint($REQ['EED_Events_Archive_display_ticket_selector'])
+				: 0;
+			$CFG->EED_Events_Archive->display_datetimes       = isset($REQ['EED_Events_Archive_display_datetimes'])
+				? absint($REQ['EED_Events_Archive_display_datetimes'])
+				: 1;
+			$CFG->EED_Events_Archive->display_venue           = isset($REQ['EED_Events_Archive_display_venue'])
+				? absint($REQ['EED_Events_Archive_display_venue'])
+				: 0;
+			$CFG->EED_Events_Archive->display_expired_events  = isset($REQ['EED_Events_Archive_display_expired_events'])
+				? absint($REQ['EED_Events_Archive_display_expired_events'])
+				: 0;
+		}
+		return $CFG;
+	}
+
+
+	/**
+	 * @param string $extra_class
+	 * @return string
+	 */
+	public static function event_list_css($extra_class = '')
+	{
+		$event_list_css   = ! empty($extra_class) ? [$extra_class] : [];
+		$event_list_css[] = 'espresso-event-list-event';
+		return implode(' ', $event_list_css);
+	}
+
+
+	/**
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function event_categories()
+	{
+		return EE_Registry::instance()->load_model('Term')->get_all_ee_categories();
+	}
+
+
+	/**
+	 * @param $value
+	 * @return bool
+	 */
+	public static function display_description($value)
+	{
+		$config              = EE_Registry::instance()->CFG->template_settings->EED_Events_Archive;
+		$display_description = isset($config->display_description) ? $config->display_description : 1;
+		return $display_description === $value;
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public static function display_ticket_selector()
+	{
+		$config = EE_Registry::instance()->CFG->template_settings->EED_Events_Archive;
+		return isset($config->display_ticket_selector) && $config->display_ticket_selector;
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function display_venue()
+	{
+		$config = EE_Registry::instance()->CFG->template_settings->EED_Events_Archive;
+		return isset($config->display_venue) && $config->display_venue && EEH_Venue_View::venue_name();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public static function display_datetimes()
+	{
+		$config = EE_Registry::instance()->CFG->template_settings->EED_Events_Archive;
+		return isset($config->display_datetimes) && $config->display_datetimes;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public static function event_list_title()
+	{
+		return apply_filters(
+			'FHEE__archive_espresso_events_template__upcoming_events_h1',
+			esc_html__('Upcoming Events', 'event_espresso')
+		);
+	}
+
+
+	// GRAVEYARD
+
+
+	/**
+	 * @since 4.4.0
+	 */
+	public static function _doing_it_wrong_notice($function = '')
+	{
+		EE_Error::doing_it_wrong(
+			__FUNCTION__,
+			sprintf(
+				esc_html__(
+					'EED_Events_Archive::%1$s was moved to EEH_Event_Query::%1$s:%2$sPlease update your existing code because the method it calls will be removed in version %3$s',
+					'event_espresso'
+				),
+				$function,
+				'<br />',
+				'4.6.0'
+			),
+			'4.4.0'
+		);
+	}
+
+
+	/**
+	 * @deprecated
+	 * @since 4.4.0
+	 */
+	public function get_post_data()
+	{
+		EEH_Event_Query::set_query_params();
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @since 4.4.0
+	 * @deprecated
+	 */
+	public function posts_fields($SQL, WP_Query $wp_query)
+	{
+		EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
+		return EEH_Event_Query::posts_fields($SQL, $wp_query);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @since 4.4.0
+	 * @deprecated
+	 */
+	public static function posts_fields_sql_for_orderby($orderby_params = [])
+	{
+		EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
+		return EEH_Event_Query::posts_fields_sql_for_orderby($orderby_params);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @since 4.4.0
+	 * @deprecated
+	 */
+	public function posts_join($SQL, WP_Query $wp_query)
+	{
+		EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
+		return EEH_Event_Query::posts_join($SQL, $wp_query);
+	}
+
+
+	/**
+	 * @deprecated
+	 * @since 4.4.0
+	 */
+	public static function posts_join_sql_for_terms($join_terms = null)
+	{
+		EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
+		return EEH_Event_Query::posts_join_sql_for_terms($join_terms);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @since 4.4.0
+	 * @deprecated
+	 */
+	public static function posts_join_for_orderby($orderby_params = [])
+	{
+		EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
+		return EEH_Event_Query::posts_join_for_orderby($orderby_params);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @since 4.4.0
+	 * @deprecated
+	 */
+	public function posts_where($SQL, WP_Query $wp_query)
+	{
+		EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
+		return EEH_Event_Query::posts_where($SQL, $wp_query);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @since 4.4.0
+	 * @deprecated
+	 */
+	public static function posts_where_sql_for_show_expired($show_expired = false)
+	{
+		EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
+		return EEH_Event_Query::posts_where_sql_for_show_expired($show_expired);
+	}
+
+
+	/**
+	 * @deprecated
+	 * @since 4.4.0
+	 */
+	public static function posts_where_sql_for_event_category_slug($event_category_slug = null)
+	{
+		EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
+		return EEH_Event_Query::posts_where_sql_for_event_category_slug($event_category_slug);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @since 4.4.0
+	 * @deprecated
+	 */
+	public static function posts_where_sql_for_event_list_month($month = null)
+	{
+		EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
+		return EEH_Event_Query::posts_where_sql_for_event_list_month($month);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @since 4.4.0
+	 * @deprecated
+	 */
+	public function posts_orderby($SQL, WP_Query $wp_query)
+	{
+		EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
+		return EEH_Event_Query::posts_orderby($SQL, $wp_query);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @since 4.4.0
+	 * @deprecated
+	 */
+	public static function posts_orderby_sql($orderby_params = [], $sort = 'ASC')
+	{
+		EED_Events_Archive::_doing_it_wrong_notice(__FUNCTION__);
+		return EEH_Event_Query::posts_orderby_sql($orderby_params, $sort);
+	}
 }
 
 
@@ -1066,9 +1066,9 @@ 
  */
 function espresso_get_event_list_ID()
 {
-    EED_Events_Archive::$espresso_event_list_ID++;
-    EED_Events_Archive::$espresso_grid_event_lists[] = EED_Events_Archive::$espresso_event_list_ID;
-    return EED_Events_Archive::$espresso_event_list_ID;
+	EED_Events_Archive::$espresso_event_list_ID++;
+	EED_Events_Archive::$espresso_grid_event_lists[] = EED_Events_Archive::$espresso_event_list_ID;
+	return EED_Events_Archive::$espresso_event_list_ID;
 }
 
 
@@ -1077,7 +1077,7 @@ 
  */
 function espresso_event_list_title()
 {
-    return EED_Events_Archive::event_list_title();
+	return EED_Events_Archive::event_list_title();
 }
 
 
@@ -1087,7 +1087,7 @@ 
  */
 function espresso_event_list_css($extra_class = '')
 {
-    return EED_Events_Archive::event_list_css($extra_class);
+	return EED_Events_Archive::event_list_css($extra_class);
 }
 
 
@@ -1098,7 +1098,7 @@ 
  */
 function espresso_get_event_categories()
 {
-    return EED_Events_Archive::event_categories();
+	return EED_Events_Archive::event_categories();
 }
 
 
@@ -1107,7 +1107,7 @@ 
  */
 function espresso_display_full_description_in_event_list()
 {
-    return EED_Events_Archive::display_description(2);
+	return EED_Events_Archive::display_description(2);
 }
 
 
@@ -1116,7 +1116,7 @@ 
  */
 function espresso_display_excerpt_in_event_list()
 {
-    return EED_Events_Archive::display_description(1);
+	return EED_Events_Archive::display_description(1);
 }
 
 
@@ -1125,7 +1125,7 @@ 
  */
 function espresso_display_ticket_selector_in_event_list()
 {
-    return EED_Events_Archive::display_ticket_selector();
+	return EED_Events_Archive::display_ticket_selector();
 }
 
 
@@ -1136,7 +1136,7 @@ 
  */
 function espresso_display_venue_in_event_list()
 {
-    return EED_Events_Archive::display_venue();
+	return EED_Events_Archive::display_venue();
 }
 
 
@@ -1145,5 +1145,5 @@ 
  */
 function espresso_display_datetimes_in_event_list()
 {
-    return EED_Events_Archive::display_datetimes();
+	return EED_Events_Archive::display_datetimes();
 }

Spacing +15 added lines, -15 removed lines

@@ -120,8 +120,8 @@ 
      */
     public static function set_definitions()
     {
-        define('EVENTS_ARCHIVE_ASSETS_URL', plugin_dir_url(__FILE__) . 'assets/');
-        define('EVENTS_ARCHIVE_TEMPLATES_PATH', str_replace('\\', '/', plugin_dir_path(__FILE__)) . 'templates/');
+        define('EVENTS_ARCHIVE_ASSETS_URL', plugin_dir_url(__FILE__).'assets/');
+        define('EVENTS_ARCHIVE_TEMPLATES_PATH', str_replace('\\', '/', plugin_dir_path(__FILE__)).'templates/');
     }
 
 
@@ -141,7 +141,7 @@ 
      */
     public static function get_iframe_embed_button()
     {
-        if (! self::$_iframe_embed_button instanceof EventListIframeEmbedButton) {
+        if ( ! self::$_iframe_embed_button instanceof EventListIframeEmbedButton) {
             self::$_iframe_embed_button = new EventListIframeEmbedButton();
         }
         return self::$_iframe_embed_button;
@@ -218,8 +218,8 @@ 
         EEH_Event_Query::add_query_filters();
         // set params that will get used by the filters
         EEH_Event_Query::set_query_params(
-            '',                             // month
-            '',                             // category
+            '', // month
+            '', // category
             $config->display_expired_events // show_expired
         );
         // check what template is loaded
@@ -281,7 +281,7 @@ 
     public function template_include($template = '')
     {
         // don't add content filter for dedicated EE child themes or private posts
-        if (! EEH_Template::is_espresso_theme()) {
+        if ( ! EEH_Template::is_espresso_theme()) {
             /** @type EE_Events_Archive_Config $config */
             $config = $this->config();
             // add status banner ?
@@ -355,7 +355,7 @@ 
         global $post;
         if ($post instanceof WP_Post) {
             return (EED_Events_Archive::isBlockTheme() || in_the_loop()) && $post->ID == $id
-                ? espresso_event_status_banner($post->ID) . $title
+                ? espresso_event_status_banner($post->ID).$title
                 : $title;
         }
         return $title;
@@ -459,7 +459,7 @@ 
         if (post_password_required()) {
             return $content;
         }
-        return EEH_Template::locate_template('content-espresso_events-datetimes.php') . $content;
+        return EEH_Template::locate_template('content-espresso_events-datetimes.php').$content;
     }
 
 
@@ -474,7 +474,7 @@ 
         if (post_password_required()) {
             return $content;
         }
-        return EEH_Template::locate_template('content-espresso_events-tickets.php') . $content;
+        return EEH_Template::locate_template('content-espresso_events-tickets.php').$content;
     }
 
 
@@ -501,7 +501,7 @@ 
         if (post_password_required()) {
             return $content;
         }
-        return $content . EEH_Template::locate_template('content-espresso_events-venues.php');
+        return $content.EEH_Template::locate_template('content-espresso_events-venues.php');
     }
 
 
@@ -737,10 +737,10 @@ 
         // get some style
         if (apply_filters('FHEE_enable_default_espresso_css', false)) {
             // first check uploads folder
-            if (EEH_File::is_readable(get_stylesheet_directory() . $this->theme . '/style.css')) {
+            if (EEH_File::is_readable(get_stylesheet_directory().$this->theme.'/style.css')) {
                 wp_register_style(
                     $this->theme,
-                    get_stylesheet_directory_uri() . $this->theme . '/style.css',
+                    get_stylesheet_directory_uri().$this->theme.'/style.css',
                     ['dashicons', 'espresso_default']
                 );
             }
@@ -762,7 +762,7 @@ 
             'FHEE__EED_Events_Archive__template_settings_form__event_list_config',
             $template_settings->EED_Events_Archive
         );
-        $events_archive_settings               = [
+        $events_archive_settings = [
             'display_status_banner'   => 0,
             'display_description'     => 1,
             'display_ticket_selector' => 0,
@@ -770,12 +770,12 @@ 
             'display_venue'           => 0,
             'display_expired_events'  => 0,
         ];
-        $events_archive_settings               = array_merge(
+        $events_archive_settings = array_merge(
             $events_archive_settings,
             (array) $template_settings->EED_Events_Archive
         );
         EEH_Template::display_template(
-            EVENTS_ARCHIVE_TEMPLATES_PATH . 'admin-event-list-settings.template.php',
+            EVENTS_ARCHIVE_TEMPLATES_PATH.'admin-event-list-settings.template.php',
             $events_archive_settings
         );
     }

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.011');
-        }
+		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.011');
+		}
 
-        /**
-         * 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