eventespresso / event-espresso-core

core/services/request/sanitizers/AllowedTags.php

Indentation +279 added lines, -279 removed lines

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

core/EE_System.core.php

Indentation +1353 added lines, -1353 removed lines

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

Spacing +28 added lines, -28 removed lines

@@ -155,7 +155,7 @@ 
         EE_Maintenance_Mode $maintenance_mode = null
     ) {
         // check if class object is instantiated
-        if (! self::$_instance instanceof EE_System) {
+        if ( ! self::$_instance instanceof EE_System) {
             self::$_instance = new self($registry, $loader, $request, $maintenance_mode);
         }
         return self::$_instance;
@@ -282,7 +282,7 @@ 
         $this->capabilities = $this->loader->getShared('EE_Capabilities');
         add_action(
             'AHEE__EE_Capabilities__init_caps__before_initialization',
-            function () {
+            function() {
                 LoaderFactory::getLoader()->getShared('EE_Payment_Method_Manager');
             }
         );
@@ -323,7 +323,7 @@ 
     {
         // set autoloaders for all of the classes implementing EEI_Plugin_API
         // which provide helpers for EE plugin authors to more easily register certain components with EE.
-        EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder(EE_LIBRARIES . 'plugin_api');
+        EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder(EE_LIBRARIES.'plugin_api');
     }
 
 
@@ -342,14 +342,14 @@ 
         $load_callback,
         $plugin_file_constant
     ) {
-        if (! defined($version_constant)) {
+        if ( ! defined($version_constant)) {
             return;
         }
         $addon_version = constant($version_constant);
         if ($addon_version && version_compare($addon_version, $min_version_required, '<')) {
             remove_action('AHEE__EE_System__load_espresso_addons', $load_callback);
-            if (! function_exists('deactivate_plugins')) {
-                require_once ABSPATH . 'wp-admin/includes/plugin.php';
+            if ( ! function_exists('deactivate_plugins')) {
+                require_once ABSPATH.'wp-admin/includes/plugin.php';
             }
             deactivate_plugins(plugin_basename(constant($plugin_file_constant)));
             $this->request->unSetRequestParams(['activate', 'activate-multi'], true);
@@ -363,7 +363,7 @@ 
                     $min_version_required
                 ),
                 __FILE__,
-                __FUNCTION__ . "({$addon_name})",
+                __FUNCTION__."({$addon_name})",
                 __LINE__
             );
             EE_Error::get_notices(false, true);
@@ -415,7 +415,7 @@ 
                 true
             )
         ) {
-            include_once EE_THIRD_PARTY . 'wp-api-basic-auth/basic-auth.php';
+            include_once EE_THIRD_PARTY.'wp-api-basic-auth/basic-auth.php';
         }
         do_action('AHEE__EE_System__load_espresso_addons__complete');
     }
@@ -517,11 +517,11 @@ 
     private function fix_espresso_db_upgrade_option($espresso_db_update = null)
     {
         do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__begin', $espresso_db_update);
-        if (! $espresso_db_update) {
+        if ( ! $espresso_db_update) {
             $espresso_db_update = get_option('espresso_db_update');
         }
         // check that option is an array
-        if (! is_array($espresso_db_update)) {
+        if ( ! is_array($espresso_db_update)) {
             // if option is FALSE, then it never existed
             if ($espresso_db_update === false) {
                 // make $espresso_db_update an array and save option with autoload OFF
@@ -541,10 +541,10 @@ 
                     // so it must be numerically-indexed, where values are versions installed...
                     // fix it!
                     $version_string = $should_be_array;
-                    $corrected_db_update[ $version_string ] = array('unknown-date');
+                    $corrected_db_update[$version_string] = array('unknown-date');
                 } else {
                     // ok it checks out
-                    $corrected_db_update[ $should_be_version_string ] = $should_be_array;
+                    $corrected_db_update[$should_be_version_string] = $should_be_array;
                 }
             }
             $espresso_db_update = $corrected_db_update;
@@ -628,13 +628,13 @@ 
      */
     public function update_list_of_installed_versions($version_history = null, $current_version_to_add = null)
     {
-        if (! $version_history) {
+        if ( ! $version_history) {
             $version_history = $this->fix_espresso_db_upgrade_option($version_history);
         }
         if ($current_version_to_add === null) {
             $current_version_to_add = espresso_version();
         }
-        $version_history[ $current_version_to_add ][] = date('Y-m-d H:i:s', time());
+        $version_history[$current_version_to_add][] = date('Y-m-d H:i:s', time());
         // re-save
         return update_option('espresso_db_update', $version_history);
     }
@@ -724,7 +724,7 @@ 
         if ($activation_history_for_addon) {
             // it exists, so this isn't a completely new install
             // check if this version already in that list of previously installed versions
-            if (! isset($activation_history_for_addon[ $version_to_upgrade_to ])) {
+            if ( ! isset($activation_history_for_addon[$version_to_upgrade_to])) {
                 // it a version we haven't seen before
                 if ($version_is_higher === 1) {
                     $req_type = EE_System::req_type_upgrade;
@@ -802,7 +802,7 @@ 
             foreach ($activation_history as $version => $times_activated) {
                 // check there is a record of when this version was activated. Otherwise,
                 // mark it as unknown
-                if (! $times_activated) {
+                if ( ! $times_activated) {
                     $times_activated = array('unknown-date');
                 }
                 if (is_string($times_activated)) {
@@ -906,7 +906,7 @@ 
     private function _parse_model_names()
     {
         // get all the files in the EE_MODELS folder that end in .model.php
-        $models = glob(EE_MODELS . '*.model.php');
+        $models = glob(EE_MODELS.'*.model.php');
         $model_names = array();
         $non_abstract_db_models = array();
         foreach ($models as $model) {
@@ -915,9 +915,9 @@ 
             $short_name = str_replace('EEM_', '', $classname);
             $reflectionClass = new ReflectionClass($classname);
             if ($reflectionClass->isSubclassOf('EEM_Base') && ! $reflectionClass->isAbstract()) {
-                $non_abstract_db_models[ $short_name ] = $classname;
+                $non_abstract_db_models[$short_name] = $classname;
             }
-            $model_names[ $short_name ] = $classname;
+            $model_names[$short_name] = $classname;
         }
         $this->registry->models = apply_filters('FHEE__EE_System__parse_model_names', $model_names);
         $this->registry->non_abstract_db_models = apply_filters(
@@ -952,7 +952,7 @@ 
             )
         );
         if ($domain->isCaffeinated()) {
-            require_once EE_CAFF_PATH . 'brewing_regular.php';
+            require_once EE_CAFF_PATH.'brewing_regular.php';
         }
     }
 
@@ -1034,7 +1034,7 @@ 
         $class_names = EEH_Class_Tools::get_class_names_for_all_callbacks_on_hook(
             'AHEE__EE_System__register_shortcodes_modules_and_addons'
         );
-        if (! empty($class_names)) {
+        if ( ! empty($class_names)) {
             $msg = esc_html__(
                 'The following plugins, addons, or modules appear to be incompatible with this version of Event Espresso and were automatically deactivated to avoid fatal errors:',
                 'event_espresso'
@@ -1046,7 +1046,7 @@ 
                             array('EE_', 'EEM_', 'EED_', 'EES_', 'EEW_'),
                             '',
                             $class_name
-                        ) . '</b></li>';
+                        ).'</b></li>';
             }
             $msg .= '</ul>';
             $msg .= esc_html__(
@@ -1115,7 +1115,7 @@ 
     private function _deactivate_incompatible_addons()
     {
         $incompatible_addons = get_option('ee_incompatible_addons', array());
-        if (! empty($incompatible_addons)) {
+        if ( ! empty($incompatible_addons)) {
             $active_plugins = get_option('active_plugins', array());
             foreach ($active_plugins as $active_plugin) {
                 foreach ($incompatible_addons as $incompatible_addon) {
@@ -1224,7 +1224,7 @@ 
         do_action('AHEE__EE_System__core_loaded_and_ready');
         // always load template tags, because it's faster than checking if it's a front-end request, and many page
         // builders require these even on the front-end
-        require_once EE_PUBLIC . 'template_tags.php';
+        require_once EE_PUBLIC.'template_tags.php';
         do_action('AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons');
     }
 
@@ -1241,7 +1241,7 @@ 
         do_action('AHEE__EE_System__initialize');
         add_filter(
             'safe_style_css',
-            function ($styles) {
+            function($styles) {
                 $styles[] = 'display';
                 $styles[] = 'visibility';
                 $styles[] = 'position';
@@ -1308,13 +1308,13 @@ 
     public static function do_not_cache()
     {
         // set no cache constants
-        if (! defined('DONOTCACHEPAGE')) {
+        if ( ! defined('DONOTCACHEPAGE')) {
             define('DONOTCACHEPAGE', true);
         }
-        if (! defined('DONOTCACHCEOBJECT')) {
+        if ( ! defined('DONOTCACHCEOBJECT')) {
             define('DONOTCACHCEOBJECT', true);
         }
-        if (! defined('DONOTCACHEDB')) {
+        if ( ! defined('DONOTCACHEDB')) {
             define('DONOTCACHEDB', true);
         }
         // add no cache headers

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.006');
-        }
+		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.006');
+		}
 
-        /**
-         * espresso_plugin_activation
-         * adds a wp-option to indicate that EE has been activated via the WP admin plugins page
-         */
-        function espresso_plugin_activation()
-        {
-            update_option('ee_espresso_activation', true);
-        }
+		/**
+		 * espresso_plugin_activation
+		 * adds a wp-option to indicate that EE has been activated via the WP admin plugins page
+		 */
+		function espresso_plugin_activation()
+		{
+			update_option('ee_espresso_activation', true);
+		}
 
-        register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
+		register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
 
-        require_once __DIR__ . '/core/bootstrap_espresso.php';
-        bootstrap_espresso();
-    }
+		require_once __DIR__ . '/core/bootstrap_espresso.php';
+		bootstrap_espresso();
+	}
 }
 if (! function_exists('espresso_deactivate_plugin')) {
-    /**
-     *    deactivate_plugin
-     * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
-     *
-     * @access public
-     * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
-     * @return    void
-     */
-    function espresso_deactivate_plugin($plugin_basename = '')
-    {
-        if (! function_exists('deactivate_plugins')) {
-            require_once ABSPATH . 'wp-admin/includes/plugin.php';
-        }
-        unset($_GET['activate'], $_REQUEST['activate']);
-        deactivate_plugins($plugin_basename);
-    }
+	/**
+	 *    deactivate_plugin
+	 * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
+	 *
+	 * @access public
+	 * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
+	 * @return    void
+	 */
+	function espresso_deactivate_plugin($plugin_basename = '')
+	{
+		if (! function_exists('deactivate_plugins')) {
+			require_once ABSPATH . 'wp-admin/includes/plugin.php';
+		}
+		unset($_GET['activate'], $_REQUEST['activate']);
+		deactivate_plugins($plugin_basename);
+	}
 }
\ No newline at end of file

core/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 {

admin_pages/general_settings/General_Settings_Admin_Page.core.php

Indentation +1422 added lines, -1422 removed lines

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