eventespresso / event-espresso-core

core/EE_Addon.core.php

Indentation +907 added lines, -907 removed lines

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

Spacing +14 added lines, -14 removed lines

@@ -589,7 +589,7 @@ 
      */
     public function get_activation_indicator_option_name(): string
     {
-        return 'ee_activation_' . $this->name();
+        return 'ee_activation_'.$this->name();
     }
 
 
@@ -678,13 +678,13 @@ 
      */
     public function update_list_of_installed_versions($version_history = null, $current_version_to_add = null): bool
     {
-        if (! $version_history) {
+        if ( ! $version_history) {
             $version_history = $this->get_activation_history();
         }
         if ($current_version_to_add === null) {
             $current_version_to_add = $this->version();
         }
-        $version_history[ $current_version_to_add ][] = date('Y-m-d H:i:s', time());
+        $version_history[$current_version_to_add][] = date('Y-m-d H:i:s', time());
         return update_option($this->get_activation_history_option_name(), $version_history);
     }
 
@@ -697,7 +697,7 @@ 
      */
     public function get_activation_history_option_name(): string
     {
-        return self::ee_addon_version_history_option_prefix . $this->name();
+        return self::ee_addon_version_history_option_prefix.$this->name();
     }
 
 
@@ -776,7 +776,7 @@ 
         // is admin and not in M-Mode ?
         if (is_admin() && MaintenanceStatus::isDisabled()) {
             add_filter('plugin_action_links', [$this, 'plugin_action_links'], 10, 2);
-            add_filter('after_plugin_row_' . $this->_plugin_basename, [$this, 'after_plugin_row'], 10, 3);
+            add_filter('after_plugin_row_'.$this->_plugin_basename, [$this, 'after_plugin_row'], 10, 3);
         }
     }
 
@@ -797,23 +797,23 @@ 
         }
         // ensure the plugin action slug starts with 'espresso_'
         $plugin_action_slug = strpos($plugin_action_slug, 'espresso_') !== 0
-            ? 'espresso_' . $plugin_action_slug
+            ? 'espresso_'.$plugin_action_slug
             : $plugin_action_slug;
 
-        $plugin_action_link_url = 'admin.php?page=' . $plugin_action_slug;
+        $plugin_action_link_url = 'admin.php?page='.$plugin_action_slug;
         if ($this->isPaymentMethod()) {
             $pm_slug = $this->paymentMethodSlug();
             $plugin_action_link_url = "admin.php?page=espresso_payment_settings&action=default";
             $plugin_action_link_url .= "&payment_method=$pm_slug#espresso_{$pm_slug}_payment_settings";
         }
         // filter settings link url and text
-        $plugin_action_link_url  = apply_filters(
+        $plugin_action_link_url = apply_filters(
             "FHEE__EE_Addon_plugin_action_links__url",
             $plugin_action_link_url,
             $this->plugin_slug(),
             $file
         );
-        if (! $plugin_action_link_url) {
+        if ( ! $plugin_action_link_url) {
             return $links;
         }
         $plugin_action_link_text = apply_filters(
@@ -826,7 +826,7 @@ 
         // before other links
         array_unshift(
             $links,
-            '<a href="' . $plugin_action_link_url . '">' . esc_html($plugin_action_link_text) . '</a>'
+            '<a href="'.$plugin_action_link_url.'">'.esc_html($plugin_action_link_text).'</a>'
         );
         return $links;
     }
@@ -846,17 +846,17 @@ 
     {
         $after_plugin_row = '';
         $plugins_page_row = $this->get_plugins_page_row();
-        if (! empty($plugins_page_row) && $plugin_file === $this->plugin_basename()) {
+        if ( ! empty($plugins_page_row) && $plugin_file === $this->plugin_basename()) {
             $class       = $status ? 'active' : 'inactive';
             $link_text   = $plugins_page_row['link_text'] ?? '';
             $link_url    = $plugins_page_row['link_url'] ?? '';
             $description = $plugins_page_row['description'] ?? '';
-            if (! empty($link_text) && ! empty($link_url) && ! empty($description)) {
-                $after_plugin_row .= '<tr id="' . sanitize_title($plugin_file) . '-ee-addon" class="' . $class . '">';
+            if ( ! empty($link_text) && ! empty($link_url) && ! empty($description)) {
+                $after_plugin_row .= '<tr id="'.sanitize_title($plugin_file).'-ee-addon" class="'.$class.'">';
                 $after_plugin_row .= '<th class="check-column" scope="row"></th>';
                 $after_plugin_row .= '<td class="ee-addon-upsell-info-title-td plugin-title column-primary">';
                 $after_plugin_row .= '<p class="ee-addon-upsell-info-dv">
-	                <a class="button button--primary" href="' . esc_url_raw($link_url) . '">'
+	                <a class="button button--primary" href="' . esc_url_raw($link_url).'">'
                     . $link_text
                     . ' &nbsp;<span class="dashicons dashicons-arrow-right-alt2" style="margin:0;"></span>'
                     . '</a>

core/EE_Bootstrap.core.php

Indentation +62 added lines, -62 removed lines

@@ -12,78 +12,78 @@
  */
 class EE_Bootstrap
 {
-    /**
-     * load_espresso_addons
-     * runs during the WP 'plugins_loaded' action at priority 1
-     * and is the initial loading phase for EE addons
-     * no other logic should be performed at this point
-     */
-    public static function load_espresso_addons()
-    {
-        do_action('AHEE__EE_Bootstrap__load_espresso_addons');
-    }
+	/**
+	 * load_espresso_addons
+	 * runs during the WP 'plugins_loaded' action at priority 1
+	 * and is the initial loading phase for EE addons
+	 * no other logic should be performed at this point
+	 */
+	public static function load_espresso_addons()
+	{
+		do_action('AHEE__EE_Bootstrap__load_espresso_addons');
+	}
 
 
-    /**
-     * detect_activations_or_upgrades
-     * runs during the WP 'plugins_loaded' action at priority 3
-     * Now that all the addons have been loaded,
-     * we can determine if anything needs activating or upgrading
-     */
-    public static function detect_activations_or_upgrades()
-    {
-        do_action('AHEE__EE_Bootstrap__detect_activations_or_upgrades');
-    }
+	/**
+	 * detect_activations_or_upgrades
+	 * runs during the WP 'plugins_loaded' action at priority 3
+	 * Now that all the addons have been loaded,
+	 * we can determine if anything needs activating or upgrading
+	 */
+	public static function detect_activations_or_upgrades()
+	{
+		do_action('AHEE__EE_Bootstrap__detect_activations_or_upgrades');
+	}
 
 
-    /**
-     * load_core_configuration
-     * runs during the WP 'plugins_loaded' action at priority 5
-     * Now that the database is assumed to be at the correct version
-     * we can load and set all the system configurations
-     */
-    public static function load_core_configuration()
-    {
-        do_action('AHEE__EE_Bootstrap__load_core_configuration');
-    }
+	/**
+	 * load_core_configuration
+	 * runs during the WP 'plugins_loaded' action at priority 5
+	 * Now that the database is assumed to be at the correct version
+	 * we can load and set all the system configurations
+	 */
+	public static function load_core_configuration()
+	{
+		do_action('AHEE__EE_Bootstrap__load_core_configuration');
+	}
 
 
-    /**
-     * register_shortcodes_modules_and_widgets
-     * runs during the WP 'plugins_loaded' action at priority 7
-     * and handles registering all o four shortcodes, modules and widgets
-     * so that they are ready to be used throughout the system
-     */
-    public static function register_shortcodes_modules_and_widgets()
-    {
-        do_action('AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets');
-    }
+	/**
+	 * register_shortcodes_modules_and_widgets
+	 * runs during the WP 'plugins_loaded' action at priority 7
+	 * and handles registering all o four shortcodes, modules and widgets
+	 * so that they are ready to be used throughout the system
+	 */
+	public static function register_shortcodes_modules_and_widgets()
+	{
+		do_action('AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets');
+	}
 
 
-    /**
-     * brew_espresso
-     * runs during the WP 'plugins_loaded' action at priority 9
-     * bootstrapping is considered complete at this point,
-     * so let the fun begin...
-     */
-    public static function brew_espresso()
-    {
-        do_action('AHEE__EE_Bootstrap__brew_espresso');
-    }
+	/**
+	 * brew_espresso
+	 * runs during the WP 'plugins_loaded' action at priority 9
+	 * bootstrapping is considered complete at this point,
+	 * so let the fun begin...
+	 */
+	public static function brew_espresso()
+	{
+		do_action('AHEE__EE_Bootstrap__brew_espresso');
+	}
 
 
-    /**
-     * @deprecated 4.9.53
-     */
-    public function run_request_stack()
-    {
-    }
+	/**
+	 * @deprecated 4.9.53
+	 */
+	public function run_request_stack()
+	{
+	}
 
 
-    /**
-     * @deprecated 4.9.53
-     */
-    public function build_request_stack()
-    {
-    }
+	/**
+	 * @deprecated 4.9.53
+	 */
+	public function build_request_stack()
+	{
+	}
 }

core/EE_Front_Controller.core.php

Indentation +512 added lines, -512 removed lines

@@ -19,516 +19,516 @@
  */
 final class EE_Front_Controller
 {
-    /**
-     * @var string
-     */
-    private $_template_path;
-
-    /**
-     * @var string
-     */
-    private $_template;
-
-    /**
-     * @type EE_Registry
-     */
-    protected $Registry;
-
-    /**
-     * @type EE_Request_Handler
-     */
-    protected $Request_Handler;
-
-    /**
-     * @type EE_Module_Request_Router
-     */
-    protected $Module_Request_Router;
-
-    /**
-     * @type CurrentPage
-     */
-    protected $current_page;
-
-
-    /**
-     *    class constructor
-     *    should fire after shortcode, module, addon, or other plugin's default priority init phases have run
-     *
-     * @access    public
-     * @param EE_Registry              $Registry
-     * @param CurrentPage              $EspressoPage
-     * @param EE_Module_Request_Router $Module_Request_Router
-     */
-    public function __construct(
-        EE_Registry $Registry,
-        CurrentPage $EspressoPage,
-        EE_Module_Request_Router $Module_Request_Router
-    ) {
-        $this->Registry              = $Registry;
-        $this->current_page          = $EspressoPage;
-        $this->Module_Request_Router = $Module_Request_Router;
-        // load other resources and begin to actually run shortcodes and modules
-        // analyse the incoming WP request
-        add_action('parse_request', array($this, 'get_request'), 1, 1);
-        // process request with module factory
-        add_action('pre_get_posts', array($this, 'pre_get_posts'), 10, 1);
-        // before headers sent
-        add_action('wp', array($this, 'wp'), 5);
-        // primarily used to process any content shortcodes
-        add_action('template_redirect', array($this, 'templateRedirect'), 999);
-        // header
-        add_action('wp_head', array($this, 'header_meta_tag'), 5);
-        add_action('wp_print_scripts', array($this, 'wp_print_scripts'), 10);
-        add_filter('template_include', array($this, 'template_include'), 1);
-        // display errors
-        add_action('loop_start', array($this, 'display_errors'), 2);
-        // the content
-        // add_filter( 'the_content', array( $this, 'the_content' ), 5, 1 );
-        // exclude our private cpt comments
-        add_filter('comments_clauses', array($this, 'filter_wp_comments'), 10, 1);
-        // make sure any ajax requests will respect the url schema when requests are made against admin-ajax.php (http:// or https://)
-        add_filter('admin_url', array($this, 'maybe_force_admin_ajax_ssl'), 200, 1);
-        // action hook EE
-        do_action('AHEE__EE_Front_Controller__construct__done', $this);
-    }
-
-
-    /**
-     * @return EE_Request_Handler
-     * @deprecated 4.10.14.p
-     */
-    public function Request_Handler()
-    {
-        if (! $this->Request_Handler instanceof EE_Request_Handler) {
-            $this->Request_Handler = LoaderFactory::getLoader()->getShared('EE_Request_Handler');
-        }
-        return $this->Request_Handler;
-    }
-
-
-    /**
-     * @return EE_Module_Request_Router
-     */
-    public function Module_Request_Router()
-    {
-        return $this->Module_Request_Router;
-    }
-
-
-    /**
-     * @return LegacyShortcodesManager
-     * @deprecated 4.10.14.p
-     */
-    public function getLegacyShortcodesManager()
-    {
-        return EE_Config::getLegacyShortcodesManager();
-    }
-
-
-
-
-
-    /***********************************************        INIT ACTION HOOK         ***********************************************/
-    /**
-     * filter_wp_comments
-     * This simply makes sure that any "private" EE CPTs do not have their comments show up in any wp comment
-     * widgets/queries done on frontend
-     *
-     * @param  array $clauses array of comment clauses setup by WP_Comment_Query
-     * @return array array of comment clauses with modifications.
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function filter_wp_comments($clauses)
-    {
-        global $wpdb;
-        if (strpos($clauses['join'], $wpdb->posts) !== false) {
-            /** @var EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions $custom_post_types */
-            $custom_post_types = LoaderFactory::getLoader()->getShared(
-                'EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions'
-            );
-            $cpts = $custom_post_types->getPrivateCustomPostTypes();
-            foreach ($cpts as $cpt => $details) {
-                $clauses['where'] .= $wpdb->prepare(" AND $wpdb->posts.post_type != %s", $cpt);
-            }
-        }
-        return $clauses;
-    }
-
-
-    /**
-     * this just makes sure that if the site is using ssl that we force that for any admin ajax calls from frontend
-     *
-     * @param  string $url incoming url
-     * @return string         final assembled url
-     */
-    public function maybe_force_admin_ajax_ssl($url)
-    {
-        if (is_ssl() && preg_match('/admin-ajax.php/', $url)) {
-            $url = str_replace('http://', 'https://', $url);
-        }
-        return $url;
-    }
-
-
-
-
-
-
-    /***********************************************        WP_LOADED ACTION HOOK         ***********************************************/
-
-
-    /**
-     *    wp_loaded - should fire after shortcode, module, addon, or other plugin's have been registered and their
-     *    default priority init phases have run
-     *
-     * @access    public
-     * @return    void
-     */
-    public function wp_loaded()
-    {
-    }
-
-
-
-
-
-    /***********************************************        PARSE_REQUEST HOOK         ***********************************************/
-    /**
-     *    _get_request
-     *
-     * @access public
-     * @param WP $WP
-     * @return void
-     */
-    public function get_request(WP $WP)
-    {
-        do_action('AHEE__EE_Front_Controller__get_request__start');
-        $this->current_page->parseQueryVars($WP);
-        do_action('AHEE__EE_Front_Controller__get_request__complete');
-        remove_action('parse_request', [$this, 'get_request'], 1);
-    }
-
-
-    /**
-     *    pre_get_posts - basically a module factory for instantiating modules and selecting the final view template
-     *
-     * @access    public
-     * @param WP_Query $WP_Query
-     * @return    void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function pre_get_posts($WP_Query)
-    {
-        // only load Module_Request_Router if this is the main query
-        if (
-            $this->Module_Request_Router instanceof EE_Module_Request_Router
-            && $WP_Query->is_main_query()
-        ) {
-            // cycle thru module routes
-            while ($route = $this->Module_Request_Router->get_route($WP_Query)) {
-                // determine module and method for route
-                $module = $this->Module_Request_Router->resolve_route($route[0], $route[1]);
-                if ($module instanceof EED_Module) {
-                    // get registered view for route
-                    $this->_template_path = $this->Module_Request_Router->get_view($route);
-                    // grab module name
-                    $module_name = $module->module_name();
-                    // map the module to the module objects
-                    $this->Registry->modules->{$module_name} = $module;
-                }
-            }
-        }
-    }
-
-
-
-
-
-    /***********************************************        WP HOOK         ***********************************************/
-
-
-    /**
-     *    wp - basically last chance to do stuff before headers sent
-     *
-     * @access    public
-     * @return    void
-     */
-    public function wp()
-    {
-    }
-
-
-
-    /***********************     GET_HEADER && WP_HEAD HOOK     ***********************/
-
-
-    /**
-     * callback for the "template_redirect" hook point
-     * checks sidebars for EE widgets
-     * loads resources and assets accordingly
-     *
-     * @return void
-     */
-    public function templateRedirect()
-    {
-        global $wp_query;
-        if (empty($wp_query->posts)) {
-            return;
-        }
-        // if we already know this is an espresso page, then load assets
-        $load_assets = $this->current_page->isEspressoPage();
-        // if we are already loading assets then just move along, otherwise check for widgets
-        $load_assets = $load_assets || $this->espresso_widgets_in_active_sidebars();
-        if ($load_assets) {
-            add_action('wp_enqueue_scripts', array($this, 'enqueueStyle'), 10);
-            add_action('wp_enqueue_scripts', array($this, 'enqueueScripts'), 10);
-        }
-
-        if (is_singular(EspressoPostType::EVENTS)) {
-            new FilterNextPreviousEventPostQuery();
-        }
-    }
-
-
-    /**
-     * builds list of active widgets then scans active sidebars looking for them
-     * returns true is an EE widget is found in an active sidebar
-     * Please Note: this does NOT mean that the sidebar or widget
-     * is actually in use in a given template, as that is unfortunately not known
-     * until a sidebar and it's widgets are actually loaded
-     *
-     * @return boolean
-     */
-    private function espresso_widgets_in_active_sidebars()
-    {
-        $espresso_widgets = array();
-        foreach ($this->Registry->widgets as $widget_class => $widget) {
-            $id_base = EspressoWidget::getIdBase($widget_class);
-            if (is_active_widget(false, false, $id_base)) {
-                $espresso_widgets[] = $id_base;
-            }
-        }
-        $all_sidebar_widgets = wp_get_sidebars_widgets();
-        foreach ($all_sidebar_widgets as $sidebar_widgets) {
-            if (is_array($sidebar_widgets) && ! empty($sidebar_widgets)) {
-                foreach ($sidebar_widgets as $sidebar_widget) {
-                    foreach ($espresso_widgets as $espresso_widget) {
-                        if (strpos($sidebar_widget, $espresso_widget) !== false) {
-                            return true;
-                        }
-                    }
-                }
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     *    header_meta_tag
-     *
-     * @access    public
-     * @return    void
-     */
-    public function header_meta_tag()
-    {
-        print(
-        apply_filters(
-            'FHEE__EE_Front_Controller__header_meta_tag',
-            '<meta name="generator" content="Event Espresso Version ' . EVENT_ESPRESSO_VERSION . "\" />\n"
-        )
-        );
-
-        // let's exclude all event type taxonomy term archive pages from search engine indexing
-        // @see https://events.codebasehq.com/projects/event-espresso/tickets/10249
-        // also exclude all critical pages from indexing
-        if (
-            (
-                is_tax('espresso_event_type')
-                && get_option('blog_public') !== '0'
-            )
-            || is_page(EE_Registry::instance()->CFG->core->get_critical_pages_array())
-        ) {
-            print(
-            apply_filters(
-                'FHEE__EE_Front_Controller__header_meta_tag__noindex_for_event_type',
-                '<meta name="robots" content="noindex,follow" />' . "\n"
-            )
-            );
-        }
-    }
-
-
-    /**
-     * wp_print_scripts
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    public function wp_print_scripts()
-    {
-        global $post;
-        if (
-            isset($post->EE_Event)
-            && $post->EE_Event instanceof EE_Event
-            && get_post_type() === EspressoPostType::EVENTS
-            && is_singular()
-        ) {
-            EEH_Schema::add_json_linked_data_for_event($post->EE_Event);
-        }
-    }
-
-
-    public function enqueueStyle()
-    {
-        wp_enqueue_style('espresso_default');
-        wp_enqueue_style('espresso_custom_css');
-    }
-
-
-
-    /***********************************************        WP_FOOTER         ***********************************************/
-
-
-    public function enqueueScripts()
-    {
-        wp_enqueue_script('espresso_core');
-    }
-
-
-    /**
-     * @param WP_Query $query
-     * @return void
-     * @throws DomainException
-     */
-    public function display_errors(WP_Query $query)
-    {
-        if (! $query->is_main_query()) {
-            return;
-        }
-        static $shown_already = false;
-        do_action('AHEE__EE_Front_Controller__display_errors__begin');
-        if (
-            ! $shown_already
-            && apply_filters('FHEE__EE_Front_Controller__display_errors', true)
-            && is_main_query()
-            && ! is_feed()
-            && in_the_loop()
-            && $this->current_page->isEspressoPage()
-        ) {
-            $shown_already = true;
-            if (did_action('wp_head')) {
-                echo wp_kses($this->printNotices(), AllowedTags::getAllowedTags());
-            } else {
-                // block enabled themes run their query loop before headers are sent
-                // so we need to add our notices onto the beginning of the content
-                add_filter('the_content', [$this, 'prependNotices'], 1, 1);
-            }
-        }
-        do_action('AHEE__EE_Front_Controller__display_errors__end');
-    }
-
-
-    /**
-     * @param string $the_content
-     * @return string
-     * @since 4.10.30.p
-     */
-    public function prependNotices($the_content)
-    {
-        $notices = $this->printNotices();
-        return $notices ? $notices . $the_content : $the_content;
-    }
-
-
-    /**
-     * @return false|string
-     * @since 4.10.30.p
-     */
-    public function printNotices()
-    {
-        ob_start();
-        echo wp_kses(EE_Error::get_notices(), AllowedTags::getWithFormTags());
-        EEH_Template::display_template(EE_TEMPLATES . 'espresso-ajax-notices.template.php');
-        return ob_get_clean();
-    }
-
-
-
-    /***********************************************        UTILITIES         ***********************************************/
-
-
-    /**
-     * @param bool|string $template_include_path
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function template_include($template_include_path = '')
-    {
-        if ($this->current_page->isEspressoPage()) {
-            // despite all helpers having autoloaders set, we need to manually load the template loader
-            // because there are some side effects in that class for triggering template tag functions
-            $this->Registry->load_helper('EEH_Template');
-            $this->_template_path = ! empty($this->_template_path)
-                ? basename($this->_template_path)
-                : basename((string) $template_include_path);
-            $template_path = EEH_Template::locate_template($this->_template_path, [], false);
-            $this->_template_path = ! empty($template_path) ? $template_path : $template_include_path;
-            $this->_template = basename($this->_template_path);
-            return $this->_template_path;
-        }
-        return $template_include_path;
-    }
-
-
-    /**
-     * @param bool $with_path
-     * @return    string
-     */
-    public function get_selected_template($with_path = false)
-    {
-        return $with_path ? $this->_template_path : $this->_template;
-    }
-
-
-    /**
-     * @param string $shortcode_class
-     * @param WP     $wp
-     * @throws ReflectionException
-     * @deprecated 4.9.26
-     */
-    public function initialize_shortcode($shortcode_class = '', WP $wp = null)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'Usage is deprecated. Please use \EventEspresso\core\services\shortcodes\LegacyShortcodesManager::initializeShortcode() instead.',
-                'event_espresso'
-            ),
-            '4.9.26'
-        );
-        $this->getLegacyShortcodesManager()->initializeShortcode($shortcode_class, $wp);
-    }
-
-
-    /**
-     * @return void
-     * @deprecated 4.9.57.p
-     */
-    public function loadPersistentAdminNoticeManager()
-    {
-    }
-
-
-    /**
-     * @return void
-     * @deprecated 4.9.64.p
-     */
-    public function employ_CPT_Strategy()
-    {
-    }
+	/**
+	 * @var string
+	 */
+	private $_template_path;
+
+	/**
+	 * @var string
+	 */
+	private $_template;
+
+	/**
+	 * @type EE_Registry
+	 */
+	protected $Registry;
+
+	/**
+	 * @type EE_Request_Handler
+	 */
+	protected $Request_Handler;
+
+	/**
+	 * @type EE_Module_Request_Router
+	 */
+	protected $Module_Request_Router;
+
+	/**
+	 * @type CurrentPage
+	 */
+	protected $current_page;
+
+
+	/**
+	 *    class constructor
+	 *    should fire after shortcode, module, addon, or other plugin's default priority init phases have run
+	 *
+	 * @access    public
+	 * @param EE_Registry              $Registry
+	 * @param CurrentPage              $EspressoPage
+	 * @param EE_Module_Request_Router $Module_Request_Router
+	 */
+	public function __construct(
+		EE_Registry $Registry,
+		CurrentPage $EspressoPage,
+		EE_Module_Request_Router $Module_Request_Router
+	) {
+		$this->Registry              = $Registry;
+		$this->current_page          = $EspressoPage;
+		$this->Module_Request_Router = $Module_Request_Router;
+		// load other resources and begin to actually run shortcodes and modules
+		// analyse the incoming WP request
+		add_action('parse_request', array($this, 'get_request'), 1, 1);
+		// process request with module factory
+		add_action('pre_get_posts', array($this, 'pre_get_posts'), 10, 1);
+		// before headers sent
+		add_action('wp', array($this, 'wp'), 5);
+		// primarily used to process any content shortcodes
+		add_action('template_redirect', array($this, 'templateRedirect'), 999);
+		// header
+		add_action('wp_head', array($this, 'header_meta_tag'), 5);
+		add_action('wp_print_scripts', array($this, 'wp_print_scripts'), 10);
+		add_filter('template_include', array($this, 'template_include'), 1);
+		// display errors
+		add_action('loop_start', array($this, 'display_errors'), 2);
+		// the content
+		// add_filter( 'the_content', array( $this, 'the_content' ), 5, 1 );
+		// exclude our private cpt comments
+		add_filter('comments_clauses', array($this, 'filter_wp_comments'), 10, 1);
+		// make sure any ajax requests will respect the url schema when requests are made against admin-ajax.php (http:// or https://)
+		add_filter('admin_url', array($this, 'maybe_force_admin_ajax_ssl'), 200, 1);
+		// action hook EE
+		do_action('AHEE__EE_Front_Controller__construct__done', $this);
+	}
+
+
+	/**
+	 * @return EE_Request_Handler
+	 * @deprecated 4.10.14.p
+	 */
+	public function Request_Handler()
+	{
+		if (! $this->Request_Handler instanceof EE_Request_Handler) {
+			$this->Request_Handler = LoaderFactory::getLoader()->getShared('EE_Request_Handler');
+		}
+		return $this->Request_Handler;
+	}
+
+
+	/**
+	 * @return EE_Module_Request_Router
+	 */
+	public function Module_Request_Router()
+	{
+		return $this->Module_Request_Router;
+	}
+
+
+	/**
+	 * @return LegacyShortcodesManager
+	 * @deprecated 4.10.14.p
+	 */
+	public function getLegacyShortcodesManager()
+	{
+		return EE_Config::getLegacyShortcodesManager();
+	}
+
+
+
+
+
+	/***********************************************        INIT ACTION HOOK         ***********************************************/
+	/**
+	 * filter_wp_comments
+	 * This simply makes sure that any "private" EE CPTs do not have their comments show up in any wp comment
+	 * widgets/queries done on frontend
+	 *
+	 * @param  array $clauses array of comment clauses setup by WP_Comment_Query
+	 * @return array array of comment clauses with modifications.
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function filter_wp_comments($clauses)
+	{
+		global $wpdb;
+		if (strpos($clauses['join'], $wpdb->posts) !== false) {
+			/** @var EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions $custom_post_types */
+			$custom_post_types = LoaderFactory::getLoader()->getShared(
+				'EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions'
+			);
+			$cpts = $custom_post_types->getPrivateCustomPostTypes();
+			foreach ($cpts as $cpt => $details) {
+				$clauses['where'] .= $wpdb->prepare(" AND $wpdb->posts.post_type != %s", $cpt);
+			}
+		}
+		return $clauses;
+	}
+
+
+	/**
+	 * this just makes sure that if the site is using ssl that we force that for any admin ajax calls from frontend
+	 *
+	 * @param  string $url incoming url
+	 * @return string         final assembled url
+	 */
+	public function maybe_force_admin_ajax_ssl($url)
+	{
+		if (is_ssl() && preg_match('/admin-ajax.php/', $url)) {
+			$url = str_replace('http://', 'https://', $url);
+		}
+		return $url;
+	}
+
+
+
+
+
+
+	/***********************************************        WP_LOADED ACTION HOOK         ***********************************************/
+
+
+	/**
+	 *    wp_loaded - should fire after shortcode, module, addon, or other plugin's have been registered and their
+	 *    default priority init phases have run
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public function wp_loaded()
+	{
+	}
+
+
+
+
+
+	/***********************************************        PARSE_REQUEST HOOK         ***********************************************/
+	/**
+	 *    _get_request
+	 *
+	 * @access public
+	 * @param WP $WP
+	 * @return void
+	 */
+	public function get_request(WP $WP)
+	{
+		do_action('AHEE__EE_Front_Controller__get_request__start');
+		$this->current_page->parseQueryVars($WP);
+		do_action('AHEE__EE_Front_Controller__get_request__complete');
+		remove_action('parse_request', [$this, 'get_request'], 1);
+	}
+
+
+	/**
+	 *    pre_get_posts - basically a module factory for instantiating modules and selecting the final view template
+	 *
+	 * @access    public
+	 * @param WP_Query $WP_Query
+	 * @return    void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function pre_get_posts($WP_Query)
+	{
+		// only load Module_Request_Router if this is the main query
+		if (
+			$this->Module_Request_Router instanceof EE_Module_Request_Router
+			&& $WP_Query->is_main_query()
+		) {
+			// cycle thru module routes
+			while ($route = $this->Module_Request_Router->get_route($WP_Query)) {
+				// determine module and method for route
+				$module = $this->Module_Request_Router->resolve_route($route[0], $route[1]);
+				if ($module instanceof EED_Module) {
+					// get registered view for route
+					$this->_template_path = $this->Module_Request_Router->get_view($route);
+					// grab module name
+					$module_name = $module->module_name();
+					// map the module to the module objects
+					$this->Registry->modules->{$module_name} = $module;
+				}
+			}
+		}
+	}
+
+
+
+
+
+	/***********************************************        WP HOOK         ***********************************************/
+
+
+	/**
+	 *    wp - basically last chance to do stuff before headers sent
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public function wp()
+	{
+	}
+
+
+
+	/***********************     GET_HEADER && WP_HEAD HOOK     ***********************/
+
+
+	/**
+	 * callback for the "template_redirect" hook point
+	 * checks sidebars for EE widgets
+	 * loads resources and assets accordingly
+	 *
+	 * @return void
+	 */
+	public function templateRedirect()
+	{
+		global $wp_query;
+		if (empty($wp_query->posts)) {
+			return;
+		}
+		// if we already know this is an espresso page, then load assets
+		$load_assets = $this->current_page->isEspressoPage();
+		// if we are already loading assets then just move along, otherwise check for widgets
+		$load_assets = $load_assets || $this->espresso_widgets_in_active_sidebars();
+		if ($load_assets) {
+			add_action('wp_enqueue_scripts', array($this, 'enqueueStyle'), 10);
+			add_action('wp_enqueue_scripts', array($this, 'enqueueScripts'), 10);
+		}
+
+		if (is_singular(EspressoPostType::EVENTS)) {
+			new FilterNextPreviousEventPostQuery();
+		}
+	}
+
+
+	/**
+	 * builds list of active widgets then scans active sidebars looking for them
+	 * returns true is an EE widget is found in an active sidebar
+	 * Please Note: this does NOT mean that the sidebar or widget
+	 * is actually in use in a given template, as that is unfortunately not known
+	 * until a sidebar and it's widgets are actually loaded
+	 *
+	 * @return boolean
+	 */
+	private function espresso_widgets_in_active_sidebars()
+	{
+		$espresso_widgets = array();
+		foreach ($this->Registry->widgets as $widget_class => $widget) {
+			$id_base = EspressoWidget::getIdBase($widget_class);
+			if (is_active_widget(false, false, $id_base)) {
+				$espresso_widgets[] = $id_base;
+			}
+		}
+		$all_sidebar_widgets = wp_get_sidebars_widgets();
+		foreach ($all_sidebar_widgets as $sidebar_widgets) {
+			if (is_array($sidebar_widgets) && ! empty($sidebar_widgets)) {
+				foreach ($sidebar_widgets as $sidebar_widget) {
+					foreach ($espresso_widgets as $espresso_widget) {
+						if (strpos($sidebar_widget, $espresso_widget) !== false) {
+							return true;
+						}
+					}
+				}
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 *    header_meta_tag
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public function header_meta_tag()
+	{
+		print(
+		apply_filters(
+			'FHEE__EE_Front_Controller__header_meta_tag',
+			'<meta name="generator" content="Event Espresso Version ' . EVENT_ESPRESSO_VERSION . "\" />\n"
+		)
+		);
+
+		// let's exclude all event type taxonomy term archive pages from search engine indexing
+		// @see https://events.codebasehq.com/projects/event-espresso/tickets/10249
+		// also exclude all critical pages from indexing
+		if (
+			(
+				is_tax('espresso_event_type')
+				&& get_option('blog_public') !== '0'
+			)
+			|| is_page(EE_Registry::instance()->CFG->core->get_critical_pages_array())
+		) {
+			print(
+			apply_filters(
+				'FHEE__EE_Front_Controller__header_meta_tag__noindex_for_event_type',
+				'<meta name="robots" content="noindex,follow" />' . "\n"
+			)
+			);
+		}
+	}
+
+
+	/**
+	 * wp_print_scripts
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function wp_print_scripts()
+	{
+		global $post;
+		if (
+			isset($post->EE_Event)
+			&& $post->EE_Event instanceof EE_Event
+			&& get_post_type() === EspressoPostType::EVENTS
+			&& is_singular()
+		) {
+			EEH_Schema::add_json_linked_data_for_event($post->EE_Event);
+		}
+	}
+
+
+	public function enqueueStyle()
+	{
+		wp_enqueue_style('espresso_default');
+		wp_enqueue_style('espresso_custom_css');
+	}
+
+
+
+	/***********************************************        WP_FOOTER         ***********************************************/
+
+
+	public function enqueueScripts()
+	{
+		wp_enqueue_script('espresso_core');
+	}
+
+
+	/**
+	 * @param WP_Query $query
+	 * @return void
+	 * @throws DomainException
+	 */
+	public function display_errors(WP_Query $query)
+	{
+		if (! $query->is_main_query()) {
+			return;
+		}
+		static $shown_already = false;
+		do_action('AHEE__EE_Front_Controller__display_errors__begin');
+		if (
+			! $shown_already
+			&& apply_filters('FHEE__EE_Front_Controller__display_errors', true)
+			&& is_main_query()
+			&& ! is_feed()
+			&& in_the_loop()
+			&& $this->current_page->isEspressoPage()
+		) {
+			$shown_already = true;
+			if (did_action('wp_head')) {
+				echo wp_kses($this->printNotices(), AllowedTags::getAllowedTags());
+			} else {
+				// block enabled themes run their query loop before headers are sent
+				// so we need to add our notices onto the beginning of the content
+				add_filter('the_content', [$this, 'prependNotices'], 1, 1);
+			}
+		}
+		do_action('AHEE__EE_Front_Controller__display_errors__end');
+	}
+
+
+	/**
+	 * @param string $the_content
+	 * @return string
+	 * @since 4.10.30.p
+	 */
+	public function prependNotices($the_content)
+	{
+		$notices = $this->printNotices();
+		return $notices ? $notices . $the_content : $the_content;
+	}
+
+
+	/**
+	 * @return false|string
+	 * @since 4.10.30.p
+	 */
+	public function printNotices()
+	{
+		ob_start();
+		echo wp_kses(EE_Error::get_notices(), AllowedTags::getWithFormTags());
+		EEH_Template::display_template(EE_TEMPLATES . 'espresso-ajax-notices.template.php');
+		return ob_get_clean();
+	}
+
+
+
+	/***********************************************        UTILITIES         ***********************************************/
+
+
+	/**
+	 * @param bool|string $template_include_path
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function template_include($template_include_path = '')
+	{
+		if ($this->current_page->isEspressoPage()) {
+			// despite all helpers having autoloaders set, we need to manually load the template loader
+			// because there are some side effects in that class for triggering template tag functions
+			$this->Registry->load_helper('EEH_Template');
+			$this->_template_path = ! empty($this->_template_path)
+				? basename($this->_template_path)
+				: basename((string) $template_include_path);
+			$template_path = EEH_Template::locate_template($this->_template_path, [], false);
+			$this->_template_path = ! empty($template_path) ? $template_path : $template_include_path;
+			$this->_template = basename($this->_template_path);
+			return $this->_template_path;
+		}
+		return $template_include_path;
+	}
+
+
+	/**
+	 * @param bool $with_path
+	 * @return    string
+	 */
+	public function get_selected_template($with_path = false)
+	{
+		return $with_path ? $this->_template_path : $this->_template;
+	}
+
+
+	/**
+	 * @param string $shortcode_class
+	 * @param WP     $wp
+	 * @throws ReflectionException
+	 * @deprecated 4.9.26
+	 */
+	public function initialize_shortcode($shortcode_class = '', WP $wp = null)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'Usage is deprecated. Please use \EventEspresso\core\services\shortcodes\LegacyShortcodesManager::initializeShortcode() instead.',
+				'event_espresso'
+			),
+			'4.9.26'
+		);
+		$this->getLegacyShortcodesManager()->initializeShortcode($shortcode_class, $wp);
+	}
+
+
+	/**
+	 * @return void
+	 * @deprecated 4.9.57.p
+	 */
+	public function loadPersistentAdminNoticeManager()
+	{
+	}
+
+
+	/**
+	 * @return void
+	 * @deprecated 4.9.64.p
+	 */
+	public function employ_CPT_Strategy()
+	{
+	}
 }

Spacing +6 added lines, -6 removed lines

@@ -99,7 +99,7 @@ 
      */
     public function Request_Handler()
     {
-        if (! $this->Request_Handler instanceof EE_Request_Handler) {
+        if ( ! $this->Request_Handler instanceof EE_Request_Handler) {
             $this->Request_Handler = LoaderFactory::getLoader()->getShared('EE_Request_Handler');
         }
         return $this->Request_Handler;
@@ -338,7 +338,7 @@ 
         print(
         apply_filters(
             'FHEE__EE_Front_Controller__header_meta_tag',
-            '<meta name="generator" content="Event Espresso Version ' . EVENT_ESPRESSO_VERSION . "\" />\n"
+            '<meta name="generator" content="Event Espresso Version '.EVENT_ESPRESSO_VERSION."\" />\n"
         )
         );
 
@@ -355,7 +355,7 @@ 
             print(
             apply_filters(
                 'FHEE__EE_Front_Controller__header_meta_tag__noindex_for_event_type',
-                '<meta name="robots" content="noindex,follow" />' . "\n"
+                '<meta name="robots" content="noindex,follow" />'."\n"
             )
             );
         }
@@ -406,7 +406,7 @@ 
      */
     public function display_errors(WP_Query $query)
     {
-        if (! $query->is_main_query()) {
+        if ( ! $query->is_main_query()) {
             return;
         }
         static $shown_already = false;
@@ -440,7 +440,7 @@ 
     public function prependNotices($the_content)
     {
         $notices = $this->printNotices();
-        return $notices ? $notices . $the_content : $the_content;
+        return $notices ? $notices.$the_content : $the_content;
     }
 
 
@@ -452,7 +452,7 @@ 
     {
         ob_start();
         echo wp_kses(EE_Error::get_notices(), AllowedTags::getWithFormTags());
-        EEH_Template::display_template(EE_TEMPLATES . 'espresso-ajax-notices.template.php');
+        EEH_Template::display_template(EE_TEMPLATES.'espresso-ajax-notices.template.php');
         return ob_get_clean();
     }
 

core/EE_System.core.php

Indentation +1185 added lines, -1185 removed lines

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

Spacing +22 added lines, -22 removed lines

@@ -133,7 +133,7 @@ 
         ?FeatureFlags $feature = null
     ): EE_System {
         // check if class object is instantiated
-        if (! self::$_instance instanceof EE_System) {
+        if ( ! self::$_instance instanceof EE_System) {
             self::$_instance = new self($loader, $maintenance_mode, $registry, $request, $router, $feature);
         }
         return self::$_instance;
@@ -330,10 +330,10 @@ 
         /** @var Domain $domain */
         $domain = DomainFactory::getEventEspressoCoreDomain();
         if ($domain->isCaffeinated() && ! $brew instanceof EE_Brewing_Regular) {
-            require_once EE_CAFF_PATH . 'brewing_regular.php';
+            require_once EE_CAFF_PATH.'brewing_regular.php';
             /** @var EE_Brewing_Regular $brew */
             $brew = $this->loader->getShared(EE_Brewing_Regular::class);
-            if (! $this->feature->allowed(FeatureFlag::USE_EDD_PLUGIN_LICENSING)) {
+            if ( ! $this->feature->allowed(FeatureFlag::USE_EDD_PLUGIN_LICENSING)) {
                 $brew->initializePUE();
             }
             add_action(
@@ -469,11 +469,11 @@ 
     private function fix_espresso_db_upgrade_option($espresso_db_update = null): array
     {
         do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__begin', $espresso_db_update);
-        if (! $espresso_db_update) {
+        if ( ! $espresso_db_update) {
             $espresso_db_update = get_option('espresso_db_update');
         }
         // check that option is an array
-        if (! is_array($espresso_db_update)) {
+        if ( ! is_array($espresso_db_update)) {
             // if option is FALSE, then it never existed
             if ($espresso_db_update === false) {
                 // make $espresso_db_update an array and save option with autoload OFF
@@ -493,10 +493,10 @@ 
                     // so it must be numerically-indexed, where values are versions installed...
                     // fix it!
                     $version_string                         = $should_be_array;
-                    $corrected_db_update[ $version_string ] = ['unknown-date'];
+                    $corrected_db_update[$version_string] = ['unknown-date'];
                 } else {
                     // ok it checks out
-                    $corrected_db_update[ $should_be_version_string ] = $should_be_array;
+                    $corrected_db_update[$should_be_version_string] = $should_be_array;
                 }
             }
             $espresso_db_update = $corrected_db_update;
@@ -530,7 +530,7 @@ 
     ) {
         $request_type = $this->detect_req_type();
         // only initialize system if we're not in maintenance mode.
-        if (! MaintenanceStatus::isFullSite()) {
+        if ( ! MaintenanceStatus::isFullSite()) {
             /** @var EventEspresso\core\domain\services\custom_post_types\RewriteRules $rewrite_rules */
             $rewrite_rules = $this->loader->getShared(
                 'EventEspresso\core\domain\services\custom_post_types\RewriteRules'
@@ -588,13 +588,13 @@ 
         ?array $version_history = null,
         ?string $current_version_to_add = null
     ): bool {
-        if (! $version_history) {
+        if ( ! $version_history) {
             $version_history = $this->fix_espresso_db_upgrade_option($version_history);
         }
         if ($current_version_to_add === null) {
             $current_version_to_add = espresso_version();
         }
-        $version_history[ $current_version_to_add ][] = date('Y-m-d H:i:s', time());
+        $version_history[$current_version_to_add][] = date('Y-m-d H:i:s', time());
         // re-save
         return update_option('espresso_db_update', $version_history);
     }
@@ -762,7 +762,7 @@ 
             foreach ($activation_history as $version => $activation_dates) {
                 // check there is a record of when this version was activated.
                 // Otherwise, mark it as unknown
-                if (! $activation_dates) {
+                if ( ! $activation_dates) {
                     $activation_dates = ['unknown-date'];
                 }
                 $activation_dates = is_string($activation_dates)
@@ -858,7 +858,7 @@ 
     private function _parse_model_names()
     {
         // get all the files in the EE_MODELS folder that end in .model.php
-        $models                 = glob(EE_MODELS . '*.model.php');
+        $models                 = glob(EE_MODELS.'*.model.php');
         $model_names            = [];
         $non_abstract_db_models = [];
         foreach ($models as $model) {
@@ -867,9 +867,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(
@@ -950,7 +950,7 @@ 
         $class_names = WordPressHooks::getClassNamesForAllCallbacksOnHook(
             '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'
@@ -962,7 +962,7 @@ 
                         ['EE_', 'EEM_', 'EED_', 'EES_', 'EEW_'],
                         '',
                         $class_name
-                    ) . '</b></li>';
+                    ).'</b></li>';
             }
             $msg .= '</ul>';
             $msg .= esc_html__(
@@ -1025,7 +1025,7 @@ 
     private function _deactivate_incompatible_addons()
     {
         $incompatible_addons = get_option('ee_incompatible_addons', []);
-        if (! empty($incompatible_addons)) {
+        if ( ! empty($incompatible_addons)) {
             $active_plugins = get_option('active_plugins', []);
             foreach ($active_plugins as $active_plugin) {
                 foreach ($incompatible_addons as $incompatible_addon) {
@@ -1092,7 +1092,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');
     }
 
@@ -1107,7 +1107,7 @@ 
         do_action('AHEE__EE_System__initialize');
         add_filter(
             'safe_style_css',
-            function ($styles) {
+            function($styles) {
                 $styles[] = 'display';
                 $styles[] = 'visibility';
                 $styles[] = 'position';
@@ -1165,13 +1165,13 @@ 
     public static function do_not_cache()
     {
         // set no cache constants
-        if (! defined('DONOTCACHEPAGE')) {
+        if ( ! defined('DONOTCACHEPAGE')) {
             define('DONOTCACHEPAGE', true);
         }
-        if (! defined('DONOTCACHCEOBJECT')) {
+        if ( ! defined('DONOTCACHCEOBJECT')) {
             define('DONOTCACHCEOBJECT', true);
         }
-        if (! defined('DONOTCACHEDB')) {
+        if ( ! defined('DONOTCACHEDB')) {
             define('DONOTCACHEDB', true);
         }
         // add no cache headers

core/db_models/fields/EE_Boolean_Field.php

Indentation +55 added lines, -55 removed lines

@@ -5,63 +5,63 @@
 
 class EE_Boolean_Field extends EE_Model_Field_Base
 {
-    /**
-     * @param string $table_column
-     * @param string $nicename
-     * @param bool   $nullable
-     * @param null   $default_value
-     */
-    public function __construct($table_column, $nicename, $nullable, $default_value = null)
-    {
-        parent::__construct($table_column, $nicename, $nullable, $default_value);
-        $this->setSchemaType(SchemaType::BOOLEAN);
-        $this->setDataType(DataType::BOOLEAN);
-    }
+	/**
+	 * @param string $table_column
+	 * @param string $nicename
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 */
+	public function __construct($table_column, $nicename, $nullable, $default_value = null)
+	{
+		parent::__construct($table_column, $nicename, $nullable, $default_value);
+		$this->setSchemaType(SchemaType::BOOLEAN);
+		$this->setDataType(DataType::BOOLEAN);
+	}
 
-    /**
-     * Double-checks the value being returned is an boolean.
-     * @since 4.9.74.p
-     * @param mixed $value_of_field_on_model_object
-     * @return boolean
-     */
-    public function prepare_for_get($value_of_field_on_model_object)
-    {
-        return (bool) parent::prepare_for_get($value_of_field_on_model_object);
-    }
+	/**
+	 * Double-checks the value being returned is an boolean.
+	 * @since 4.9.74.p
+	 * @param mixed $value_of_field_on_model_object
+	 * @return boolean
+	 */
+	public function prepare_for_get($value_of_field_on_model_object)
+	{
+		return (bool) parent::prepare_for_get($value_of_field_on_model_object);
+	}
 
-    /**
-     * @since 4.9.74.p
-     * @param $value_inputted_for_field_on_model_object
-     * @return boolean
-     */
-    public function prepare_for_set($value_inputted_for_field_on_model_object)
-    {
-        return filter_var($value_inputted_for_field_on_model_object, FILTER_VALIDATE_BOOLEAN);
-    }
+	/**
+	 * @since 4.9.74.p
+	 * @param $value_inputted_for_field_on_model_object
+	 * @return boolean
+	 */
+	public function prepare_for_set($value_inputted_for_field_on_model_object)
+	{
+		return filter_var($value_inputted_for_field_on_model_object, FILTER_VALIDATE_BOOLEAN);
+	}
 
-    /**
-     * Make sure we're returning booleans
-     *
-     * @param string $value_inputted_for_field_on_model_object
-     * @return boolean
-     */
-    public function prepare_for_set_from_db($value_inputted_for_field_on_model_object)
-    {
-        return filter_var($value_inputted_for_field_on_model_object, FILTER_VALIDATE_BOOLEAN);
-    }
+	/**
+	 * Make sure we're returning booleans
+	 *
+	 * @param string $value_inputted_for_field_on_model_object
+	 * @return boolean
+	 */
+	public function prepare_for_set_from_db($value_inputted_for_field_on_model_object)
+	{
+		return filter_var($value_inputted_for_field_on_model_object, FILTER_VALIDATE_BOOLEAN);
+	}
 
-    /**
-     * Gets a nice Yes/No value for this field
-     *
-     * @param boolean $value_on_field_to_be_outputted
-     * @return string Yes or No
-     */
-    public function prepare_for_pretty_echoing($value_on_field_to_be_outputted)
-    {
-        return apply_filters(
-            'FHEE__EE_Boolean_Field__prepare_for_pretty_echoing__return',
-            $value_on_field_to_be_outputted ? esc_html__('Yes', 'event_espresso') : esc_html__('No', 'event_espresso'),
-            $value_on_field_to_be_outputted
-        );
-    }
+	/**
+	 * Gets a nice Yes/No value for this field
+	 *
+	 * @param boolean $value_on_field_to_be_outputted
+	 * @return string Yes or No
+	 */
+	public function prepare_for_pretty_echoing($value_on_field_to_be_outputted)
+	{
+		return apply_filters(
+			'FHEE__EE_Boolean_Field__prepare_for_pretty_echoing__return',
+			$value_on_field_to_be_outputted ? esc_html__('Yes', 'event_espresso') : esc_html__('No', 'event_espresso'),
+			$value_on_field_to_be_outputted
+		);
+	}
 }

core/db_models/fields/EE_DB_Only_Int_Field.php

Indentation +12 added lines, -12 removed lines

@@ -5,16 +5,16 @@
 
 class EE_DB_Only_Int_Field extends EE_DB_Only_Field_Base
 {
-    /**
-     * @param string $table_column
-     * @param string $nicename
-     * @param bool   $nullable
-     * @param null   $default_value
-     */
-    public function __construct($table_column, $nicename, $nullable, $default_value = null)
-    {
-        parent::__construct($table_column, $nicename, $nullable, $default_value);
-        $this->setSchemaType(SchemaType::INTEGER);
-        $this->setDataType(DataType::INTEGER);
-    }
+	/**
+	 * @param string $table_column
+	 * @param string $nicename
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 */
+	public function __construct($table_column, $nicename, $nullable, $default_value = null)
+	{
+		parent::__construct($table_column, $nicename, $nullable, $default_value);
+		$this->setSchemaType(SchemaType::INTEGER);
+		$this->setDataType(DataType::INTEGER);
+	}
 }

core/db_models/fields/EE_Enum_Integer_Field.php

Indentation +95 added lines, -95 removed lines

@@ -12,109 +12,109 @@
  */
 class EE_Enum_Integer_Field extends EE_Integer_Field
 {
-    public array $_allowed_enum_values;
+	public array $_allowed_enum_values;
 
 
-    /**
-     * @param string  $table_column
-     * @param string  $nicename
-     * @param boolean $nullable
-     * @param int     $default_value
-     * @param array   $allowed_enum_values keys are values to be used in the DB, values are how they should be displayed
-     */
-    public function __construct($table_column, $nicename, $nullable, $default_value, array $allowed_enum_values)
-    {
-        $this->_allowed_enum_values = $allowed_enum_values;
-        parent::__construct($table_column, $nicename, $nullable, $default_value);
-        $this->setSchemaType(SchemaType::OBJECT);
-        $this->setDataType(DataType::INTEGER);
-    }
+	/**
+	 * @param string  $table_column
+	 * @param string  $nicename
+	 * @param boolean $nullable
+	 * @param int     $default_value
+	 * @param array   $allowed_enum_values keys are values to be used in the DB, values are how they should be displayed
+	 */
+	public function __construct($table_column, $nicename, $nullable, $default_value, array $allowed_enum_values)
+	{
+		$this->_allowed_enum_values = $allowed_enum_values;
+		parent::__construct($table_column, $nicename, $nullable, $default_value);
+		$this->setSchemaType(SchemaType::OBJECT);
+		$this->setDataType(DataType::INTEGER);
+	}
 
 
-    /**
-     * Returns the list of allowed enum options, but filterable.
-     * This is used internally
-     *
-     * @return array
-     */
-    protected function _allowed_enum_values(): array
-    {
-        return (array) apply_filters(
-            'FHEE__EE_Enum_Integer_Field___allowed_enum_options',
-            $this->_allowed_enum_values,
-            $this
-        );
-    }
+	/**
+	 * Returns the list of allowed enum options, but filterable.
+	 * This is used internally
+	 *
+	 * @return array
+	 */
+	protected function _allowed_enum_values(): array
+	{
+		return (array) apply_filters(
+			'FHEE__EE_Enum_Integer_Field___allowed_enum_options',
+			$this->_allowed_enum_values,
+			$this
+		);
+	}
 
 
-    /**
-     * When setting, just verify that the value being used matches what we've defined as allowable enum values.
-     * If not, throw an error (but if WP_DEBUG is false, just set the value to default)
-     *
-     * @param int $value_inputted_for_field_on_model_object
-     * @return int
-     */
-    public function prepare_for_set($value_inputted_for_field_on_model_object)
-    {
-        $allowed_enum_values = $this->_allowed_enum_values();
-        if (
-            $value_inputted_for_field_on_model_object !== null
-            && ! array_key_exists($value_inputted_for_field_on_model_object, $allowed_enum_values)
-        ) {
-            if (defined('WP_DEBUG') && WP_DEBUG) {
-                $msg  = sprintf(
-                    esc_html__('System is assigning incompatible value "%1$s" to field "%2$s"', 'event_espresso'),
-                    $value_inputted_for_field_on_model_object,
-                    $this->_name
-                );
-                $msg2 = sprintf(
-                    esc_html__('Allowed values for "%1$s" are "%2$s". You provided "%3$s"', 'event_espresso'),
-                    $this->_name,
-                    implode(', ', array_keys($allowed_enum_values)),
-                    $value_inputted_for_field_on_model_object
-                );
-                EE_Error::add_error("$msg||$msg2", __FILE__, __FUNCTION__, __LINE__);
-            }
-            return $this->get_default_value();
-        }
-        return (int) $value_inputted_for_field_on_model_object;
-    }
+	/**
+	 * When setting, just verify that the value being used matches what we've defined as allowable enum values.
+	 * If not, throw an error (but if WP_DEBUG is false, just set the value to default)
+	 *
+	 * @param int $value_inputted_for_field_on_model_object
+	 * @return int
+	 */
+	public function prepare_for_set($value_inputted_for_field_on_model_object)
+	{
+		$allowed_enum_values = $this->_allowed_enum_values();
+		if (
+			$value_inputted_for_field_on_model_object !== null
+			&& ! array_key_exists($value_inputted_for_field_on_model_object, $allowed_enum_values)
+		) {
+			if (defined('WP_DEBUG') && WP_DEBUG) {
+				$msg  = sprintf(
+					esc_html__('System is assigning incompatible value "%1$s" to field "%2$s"', 'event_espresso'),
+					$value_inputted_for_field_on_model_object,
+					$this->_name
+				);
+				$msg2 = sprintf(
+					esc_html__('Allowed values for "%1$s" are "%2$s". You provided "%3$s"', 'event_espresso'),
+					$this->_name,
+					implode(', ', array_keys($allowed_enum_values)),
+					$value_inputted_for_field_on_model_object
+				);
+				EE_Error::add_error("$msg||$msg2", __FILE__, __FUNCTION__, __LINE__);
+			}
+			return $this->get_default_value();
+		}
+		return (int) $value_inputted_for_field_on_model_object;
+	}
 
 
-    /**
-     * Gets the pretty version of the enum's value.
-     *
-     * @param int | string $value_on_field_to_be_outputted
-     * @param string|null  $schema
-     * @return string
-     */
-    public function prepare_for_pretty_echoing($value_on_field_to_be_outputted, ?string $schema = null)
-    {
-        $options = $this->_allowed_enum_values();
-        return $options[ $value_on_field_to_be_outputted ] ?? $value_on_field_to_be_outputted;
-    }
+	/**
+	 * Gets the pretty version of the enum's value.
+	 *
+	 * @param int | string $value_on_field_to_be_outputted
+	 * @param string|null  $schema
+	 * @return string
+	 */
+	public function prepare_for_pretty_echoing($value_on_field_to_be_outputted, ?string $schema = null)
+	{
+		$options = $this->_allowed_enum_values();
+		return $options[ $value_on_field_to_be_outputted ] ?? $value_on_field_to_be_outputted;
+	}
 
 
-    public function getSchemaProperties(): array
-    {
-        return [
-            'raw'    => [
-                'description' => sprintf(
-                    esc_html__('%s - the value in the database.', 'event_espresso'),
-                    $this->get_nicename()
-                ),
-                'enum'        => array_keys($this->_allowed_enum_values()),
-                'type'        => SchemaType::INTEGER,
-            ],
-            'pretty' => [
-                'description' => sprintf(
-                    esc_html__('%s - the value for display.', 'event_espresso'),
-                    $this->get_nicename()
-                ),
-                'enum'        => array_values($this->_allowed_enum_values()),
-                'type'        => SchemaType::STRING,
-                'read_only'   => true,
-            ],
-        ];
-    }
+	public function getSchemaProperties(): array
+	{
+		return [
+			'raw'    => [
+				'description' => sprintf(
+					esc_html__('%s - the value in the database.', 'event_espresso'),
+					$this->get_nicename()
+				),
+				'enum'        => array_keys($this->_allowed_enum_values()),
+				'type'        => SchemaType::INTEGER,
+			],
+			'pretty' => [
+				'description' => sprintf(
+					esc_html__('%s - the value for display.', 'event_espresso'),
+					$this->get_nicename()
+				),
+				'enum'        => array_values($this->_allowed_enum_values()),
+				'type'        => SchemaType::STRING,
+				'read_only'   => true,
+			],
+		];
+	}
 }

core/db_models/fields/EE_Datetime_Field.php

Indentation +760 added lines, -760 removed lines

@@ -20,764 +20,764 @@
  */
 class EE_Datetime_Field extends EE_Model_Field_Base
 {
-    /**
-     * The pattern we're looking for is if only the characters 0-9 are found and there are only
-     * 10 or more numbers (because 9 numbers even with all 9's would be sometime in 2001 )
-     *
-     * @type string unix_timestamp_regex
-     */
-    const unix_timestamp_regex = '/[0-9]{10,}/';
-
-    /**
-     * @type string mysql_timestamp_format
-     */
-    const mysql_timestamp_format = 'Y-m-d H:i:s';
-
-    /**
-     * @type string mysql_date_format
-     */
-    const mysql_date_format = 'Y-m-d';
-
-    /**
-     * @type string mysql_time_format
-     */
-    const mysql_time_format = 'H:i:s';
-
-    /**
-     * Const for using in the default value. If the field's default is set to this,
-     * then we will return the time of calling `get_default_value()`, not
-     * just the current time at construction
-     */
-    const now = 'now';
-
-    /**
-     * The following properties hold the default formats for date and time.
-     * Defaults are set via the constructor and can be overridden on class instantiation.
-     * However they can also be overridden later by the set_format() method
-     * (and corresponding set_date_format, set_time_format methods);
-     */
-
-    protected string $_date_format        = '';
-
-    protected string $_time_format        = '';
-
-    protected string $_pretty_date_format = '';
-
-    protected string $_pretty_time_format = '';
-
-    protected ?DateTimeZone $_DateTimeZone       = null;
-
-    protected ?DateTimeZone $_UTC_DateTimeZone   = null;
-
-    protected ?DateTimeZone $_blog_DateTimeZone  = null;
-
-
-    /**
-     * This property holds how we want the output returned when getting a datetime string.  It is set for the
-     * set_date_time_output() method.  By default this is empty.  When empty, we are assuming that we want both date
-     * and time returned via getters.
-     *
-     * @var mixed (null|string)
-     */
-    protected $_date_time_output;
-
-
-    /**
-     * timezone string
-     * This gets set by the constructor and can be changed by the "set_timezone()" method so that we know what timezone
-     * incoming strings|timestamps are in.  This can also be used before a get to set what timezone you want strings
-     * coming out of the object to be in.  Default timezone is the current WP timezone option setting
-     */
-    protected ?string $_timezone_string = null;
-
-
-    /**
-     * This holds whatever UTC offset for the blog (we automatically convert timezone strings into their related
-     * offsets for comparison purposes).
-     *
-     * @var int
-     */
-    protected int $_blog_offset = 0;
-
-
-    /**
-     * @param string      $table_column
-     * @param string      $nice_name
-     * @param bool        $nullable
-     * @param string|null $default_value
-     * @param string|null $timezone_string
-     * @param string|null $date_format
-     * @param string|null $time_format
-     * @param string|null $pretty_date_format
-     * @param string|null $pretty_time_format
-     * @throws InvalidArgumentException
-     * @throws Exception
-     */
-    public function __construct(
-        string $table_column,
-        string $nice_name,
-        bool $nullable,
-        ?string $default_value,
-        ?string $timezone_string = '',
-        ?string $date_format = '',
-        ?string $time_format = '',
-        ?string $pretty_date_format = '',
-        ?string $pretty_time_format = ''
-    ) {
-        $this->set_date_format($date_format);
-        $this->set_time_format($time_format);
-        $this->set_date_format($pretty_date_format, true);
-        $this->set_time_format($pretty_time_format, true);
-
-        parent::__construct($table_column, $nice_name, $nullable, $default_value);
-        $this->set_timezone($timezone_string);
-        $this->setSchemaType(SchemaType::STRING);
-        $this->setSchemaFormat(SchemaFormat::DATETIME);
-        $this->setDataType(DataType::STRING); // best to url encode the date using DateTime::ATOM
-    }
-
-
-    /**
-     * @return DateTimeZone
-     * @throws Exception
-     */
-    public function get_UTC_DateTimeZone(): DateTimeZone
-    {
-        return $this->_UTC_DateTimeZone instanceof DateTimeZone
-            ? $this->_UTC_DateTimeZone
-            : $this->_create_timezone_object_from_timezone_string('UTC');
-    }
-
-
-    /**
-     * @return DateTimeZone
-     * @throws Exception
-     */
-    public function get_blog_DateTimeZone(): DateTimeZone
-    {
-        return $this->_blog_DateTimeZone instanceof DateTimeZone
-            ? $this->_blog_DateTimeZone
-            : $this->_create_timezone_object_from_timezone_string();
-    }
-
-
-    /**
-     * this prepares any incoming date data and make sure it's converted to a UTC unix timestamp
-     *
-     * @param string|int|null $value value inputted for field on model object
-     *                               could be a string formatted date time or int unix timestamp
-     * @return DateTime
-     * @throws Exception
-     */
-    public function prepare_for_set($value)
-    {
-        return $this->_get_date_object($value);
-    }
-
-
-    /**
-     * This returns the format string to be used by getters depending on what the $_date_time_output property is set at.
-     * getters need to know whether we're just returning the date or the time or both.  By default we return both.
-     *
-     * @param bool $pretty If we're returning the pretty formats or standard format string.
-     * @return string    The final assembled format string.
-     */
-    protected function _get_date_time_output(bool $pretty = false): string
-    {
-        switch ($this->_date_time_output) {
-            case 'time':
-                return $pretty
-                    ? $this->_pretty_time_format
-                    : $this->_time_format;
-
-            case 'date':
-                return $pretty
-                    ? $this->_pretty_date_format
-                    : $this->_date_format;
-
-            default:
-                return $pretty
-                    ? trim($this->_pretty_date_format . ' ' . $this->_pretty_time_format)
-                    : trim($this->_date_format . ' ' . $this->_time_format);
-        }
-    }
-
-
-    /**
-     * This just sets the $_date_time_output property so we can flag how date and times are formatted before being
-     * returned (using the format properties)
-     *
-     * @param string|null $what acceptable values are 'time' or 'date'.
-     *                          Any other value will be set but will always result
-     *                          in both 'date' and 'time' being returned.
-     * @return void
-     */
-    public function set_date_time_output(?string $what = null)
-    {
-        $this->_date_time_output = $what;
-    }
-
-
-    /**
-     * See $_timezone property for description of what the timezone property is for.  This SETS the timezone internally
-     * for being able to reference what timezone we are running conversions on when converting TO the internal timezone
-     * (UTC Unix Timestamp) for the object OR when converting FROM the internal timezone (UTC Unix Timestamp).
-     * We also set some other properties in this method.
-     *
-     * @param string|null $timezone_string A valid timezone string as described by @link
-     *                                     http://www.php.net/manual/en/timezones.php
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws Exception
-     */
-    public function set_timezone(?string $timezone_string = '')
-    {
-        if (empty($timezone_string) && $this->_timezone_string) {
-            // leave the timezone AS-IS if we already have one and
-            // the function arg didn't provide one
-            return;
-        }
-        $timezone_string        = EEH_DTT_Helper::get_valid_timezone_string($timezone_string);
-        $this->_timezone_string = ! empty($timezone_string)
-            ? $timezone_string
-            : 'UTC';
-        $this->_DateTimeZone    = $this->_create_timezone_object_from_timezone_string($this->_timezone_string);
-    }
-
-
-    /**
-     * _create_timezone_object_from_timezone_name
-     *
-     * @access protected
-     * @param string|null $timezone_string
-     * @return DateTimeZone
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws Exception
-     */
-    protected function _create_timezone_object_from_timezone_string(?string $timezone_string = ''): DateTimeZone
-    {
-        return new DateTimeZone(EEH_DTT_Helper::get_valid_timezone_string($timezone_string));
-    }
-
-
-    /**
-     * This just returns whatever is set for the current timezone.
-     *
-     * @access public
-     * @return string timezone string
-     */
-    public function get_timezone(): string
-    {
-        return (string) $this->_timezone_string;
-    }
-
-
-    /**
-     * set the $_date_format property
-     *
-     * @access public
-     * @param string $format a new date format (corresponding to formats accepted by PHP date() function)
-     * @param bool   $pretty Whether to set pretty format or not.
-     * @return void
-     */
-    public function set_date_format(string $format, bool $pretty = false)
-    {
-        if ($pretty) {
-            $this->_pretty_date_format = new DateFormat($format);
-        } else {
-            $this->_date_format = new DateFormat($format);
-        }
-    }
-
-
-    /**
-     * return the $_date_format property value.
-     *
-     * @param bool $pretty Whether to get pretty format or not.
-     * @return string
-     */
-    public function get_date_format(bool $pretty = false): string
-    {
-        return $pretty
-            ? $this->_pretty_date_format
-            : $this->_date_format;
-    }
-
-
-    /**
-     * set the $_time_format property
-     *
-     * @access public
-     * @param string $format a new time format (corresponding to formats accepted by PHP date() function)
-     * @param bool   $pretty Whether to set pretty format or not.
-     * @return void
-     */
-    public function set_time_format(string $format, bool $pretty = false)
-    {
-        if ($pretty) {
-            $this->_pretty_time_format = new TimeFormat($format);
-        } else {
-            $this->_time_format = new TimeFormat($format);
-        }
-    }
-
-
-    /**
-     * return the $_time_format property value.
-     *
-     * @param bool $pretty Whether to get pretty format or not.
-     * @return string
-     */
-    public function get_time_format(bool $pretty = false): string
-    {
-        return $pretty
-            ? $this->_pretty_time_format
-            : $this->_time_format;
-    }
-
-
-    /**
-     * set the $_pretty_date_format property
-     *
-     * @access public
-     * @param string|null $format a new pretty date format (corresponding to formats accepted by PHP date() function)
-     * @return void
-     */
-    public function set_pretty_date_format(?string $format)
-    {
-        $this->set_date_format($format, true);
-    }
-
-
-    /**
-     * set the $_pretty_time_format property
-     *
-     * @access public
-     * @param string|null $format a new pretty time format (corresponding to formats accepted by PHP date() function)
-     * @return void
-     */
-    public function set_pretty_time_format(?string $format)
-    {
-        $this->set_time_format($format, true);
-    }
-
-
-    /**
-     * Only sets the time portion of the datetime.
-     *
-     * @param string|DateTime $time_to_set_string like 8am OR a DateTime object.
-     * @param DateTime        $current            current DateTime object for the datetime field
-     * @return DateTime
-     */
-    public function prepare_for_set_with_new_time($time_to_set_string, DateTime $current): DateTime
-    {
-        // if $time_to_set_string is datetime object, then let's use it to set the parse array.
-        // Otherwise parse the string.
-        if ($time_to_set_string instanceof DateTime) {
-            $parsed = [
-                'hour'   => $time_to_set_string->format('H'),
-                'minute' => $time_to_set_string->format('i'),
-                'second' => $time_to_set_string->format('s'),
-            ];
-        } else {
-            // parse incoming string
-            $parsed = date_parse_from_format($this->_time_format, $time_to_set_string);
-        }
-        EEH_DTT_Helper::setTimezone($current, $this->_DateTimeZone);
-        return $current->setTime($parsed['hour'], $parsed['minute'], $parsed['second']);
-    }
-
-
-    /**
-     * Only sets the date portion of the datetime.
-     *
-     * @param string|DateTime $date_to_set_string like "Friday, January 8th" or a DateTime object.
-     * @param DateTime        $current            current DateTime object for the datetime field
-     * @return DateTime
-     */
-    public function prepare_for_set_with_new_date($date_to_set_string, DateTime $current): DateTime
-    {
-        // if $time_to_set_string is datetime object, then let's use it to set the parse array.
-        // Otherwise parse the string.
-        if ($date_to_set_string instanceof DateTime) {
-            $parsed = [
-                'year'  => $date_to_set_string->format('Y'),
-                'month' => $date_to_set_string->format('m'),
-                'day'   => $date_to_set_string->format('d'),
-            ];
-        } else {
-            // parse incoming string
-            $parsed = date_parse_from_format($this->_date_format, $date_to_set_string);
-        }
-        EEH_DTT_Helper::setTimezone($current, $this->_DateTimeZone);
-        return $current->setDate($parsed['year'], $parsed['month'], $parsed['day']);
-    }
-
-
-    /**
-     * This prepares the EE_DateTime value to be saved to the db as mysql timestamp (UTC +0 timezone).
-     * When the datetime gets to this stage it should ALREADY be in UTC time
-     *
-     * @param int|string|DateTime|null $DateTime
-     * @return string formatted date time for given timezone
-     * @throws EE_Error
-     */
-    public function prepare_for_get($DateTime): string
-    {
-        return $this->_prepare_for_display($DateTime);
-    }
-
-
-    /**
-     * This differs from prepare_for_get in that it considers whether the internal $_timezone differs
-     * from the set wp timezone.  If so, then it returns the datetime string formatted via
-     * _pretty_date_format, and _pretty_time_format.  However, it also appends a timezone
-     * abbreviation to the date_string.
-     *
-     * @param mixed       $DateTime
-     * @param string|null $schema
-     * @return string
-     * @throws EE_Error
-     */
-    public function prepare_for_pretty_echoing($DateTime, ?string $schema = null): string
-    {
-        $schema = $schema ?: true;
-        return $this->_prepare_for_display($DateTime, $schema);
-    }
-
-
-    /**
-     * This prepares the EE_DateTime value to be saved to the db as mysql timestamp (UTC +0
-     * timezone).
-     *
-     * @param int|string|DateTime|null $DateTime
-     * @param bool|string   $schema
-     * @return string
-     * @throws EE_Error
-     * @throws Exception
-     */
-    protected function _prepare_for_display($DateTime, $schema = false): string
-    {
-        if (! $DateTime instanceof DateTime) {
-            if ($this->_nullable) {
-                return '';
-            }
-            if (WP_DEBUG) {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            'EE_Datetime_Field::_prepare_for_display requires a DateTime class to be the value for the $DateTime argument because the %s field is not nullable.',
-                            'event_espresso'
-                        ),
-                        $this->_nicename
-                    )
-                );
-            }
-            $DateTime = new DbSafeDateTime(EE_Datetime_Field::now);
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'EE_Datetime_Field::_prepare_for_display requires a DateTime class to be the value for the $DateTime argument because the %s field is not nullable.  When WP_DEBUG is false, the value is set to "now" instead of throwing an exception.',
-                        'event_espresso'
-                    ),
-                    $this->_nicename
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        $format_string = $this->_get_date_time_output($schema);
-        EEH_DTT_Helper::setTimezone($DateTime, $this->_DateTimeZone);
-        if ($schema) {
-            $timezone_string = '';
-            if ($this->_display_timezone()) {
-                // must be explicit because schema could equal true.
-                if ($schema === 'no_html') {
-                    $timezone_string = ' (' . $DateTime->format('T') . ')';
-                } else {
-                    $timezone_string = ' <span class="ee_dtt_timezone_string">(' . $DateTime->format('T') . ')</span>';
-                }
-            }
-
-            return $DateTime->format($format_string) . $timezone_string;
-        }
-        return $DateTime->format($format_string);
-    }
-
-
-    /**
-     * This prepares the EE_DateTime value to be saved to the db as mysql timestamp (UTC +0
-     * timezone).
-     *
-     * @param mixed $datetime_value u
-     * @return string mysql timestamp in UTC
-     * @throws EE_Error
-     * @throws Exception
-     */
-    public function prepare_for_use_in_db($datetime_value): ?string
-    {
-        // we allow an empty value or DateTime object, but nothing else.
-        if (! empty($datetime_value) && ! $datetime_value instanceof DateTime) {
-            $datetime_value = $this->_get_date_object($datetime_value);
-            if (! $datetime_value instanceof DateTime) {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            'The incoming value being prepared for setting in the database for the %1$s field must either be empty or a php DateTime object, instead of: %2$s %3$s',
-                            'event_espresso'
-                        ),
-                        $this->get_name(),
-                        '<br />',
-                        print_r($datetime_value, true)
-                    )
-                );
-            }
-        }
-
-        if ($datetime_value instanceof DateTime) {
-            if (! $datetime_value instanceof DbSafeDateTime) {
-                $datetime_value = DbSafeDateTime::createFromDateTime($datetime_value);
-            }
-            EEH_DTT_Helper::setTimezone($datetime_value, $this->get_UTC_DateTimeZone());
-            return $datetime_value->format(
-                EE_Datetime_Field::mysql_timestamp_format
-            );
-        }
-
-        // if $datetime_value is empty, and ! $this->_nullable, use current_time() but set the GMT flag to true
-        return ! $this->_nullable
-            ? current_time('mysql', true)
-            : null;
-    }
-
-
-    /**
-     * This prepares the datetime for internal usage as a PHP DateTime object OR null (if nullable is
-     * allowed)
-     *
-     * @param string $datetime_string mysql timestamp in UTC
-     * @return  bool|DbSafeDateTime|null
-     * @throws EE_Error
-     * @throws Exception
-     */
-    public function prepare_for_set_from_db($datetime_string)
-    {
-        // if $datetime_value is empty, and ! $this->_nullable, just use time()
-        if (empty($datetime_string) && $this->_nullable) {
-            return null;
-        }
-        // datetime strings from the db should ALWAYS be in UTC+0, so use UTC_DateTimeZone when creating
-        $DateTime = empty($datetime_string)
-            ? new DbSafeDateTime(EE_Datetime_Field::now, $this->get_UTC_DateTimeZone())
-            : DbSafeDateTime::createFromFormat(
-                EE_Datetime_Field::mysql_timestamp_format,
-                $datetime_string,
-                $this->get_UTC_DateTimeZone()
-            );
-
-        if (! $DateTime instanceof DbSafeDateTime) {
-            // if still no datetime object, then let's just use now
-            $DateTime = new DbSafeDateTime(EE_Datetime_Field::now, $this->get_UTC_DateTimeZone());
-        }
-        // THEN apply the field's set DateTimeZone
-        EEH_DTT_Helper::setTimezone($DateTime, $this->_DateTimeZone);
-        return $DateTime;
-    }
-
-
-    /**
-     * All this method does is determine if we're going to display the timezone string or not on any output.
-     * To determine this we check if the set timezone offset is different than the blog's set timezone offset.
-     * If so, then true.
-     *
-     * @return bool true for yes false for no
-     * @throws Exception
-     */
-    protected function _display_timezone(): bool
-    {
-        // first let's do a comparison of timezone strings.
-        // If they match then we can get out without any further calculations
-        $blog_string = get_option('timezone_string');
-        if ($blog_string === $this->_timezone_string) {
-            return false;
-        }
-        // now we need to calc the offset for the timezone string so we can compare with the blog offset.
-        $this_offset = $this->get_timezone_offset($this->_DateTimeZone);
-        $blog_offset = $this->get_timezone_offset($this->get_blog_DateTimeZone());
-        // now compare
-        return $blog_offset !== $this_offset;
-    }
-
-
-    /**
-     * This method returns a php DateTime object for setting on the EE_Base_Class model.
-     * EE passes around DateTime objects because they are MUCH easier to manipulate and deal
-     * with.
-     *
-     * @param int|string|DateTime|null $date_string This should be the incoming date string. It's assumed to be in
-     *                                              the format that is set on the date_field (or DateTime object)!
-     * @return DateTime|null
-     * @throws Exception
-     */
-    protected function _get_date_object($date_string)
-    {
-        // first if this is an empty date_string and nullable is allowed, just return null.
-        if ($this->_nullable && empty($date_string)) {
-            return null;
-        }
-
-        // if incoming date
-        if ($date_string instanceof DateTime) {
-            EEH_DTT_Helper::setTimezone($date_string, $this->_DateTimeZone);
-            return $date_string;
-        }
-        // if empty date_string and made it here.
-        // Return a datetime object for now in the given timezone.
-        if (empty($date_string)) {
-            return new DbSafeDateTime(EE_Datetime_Field::now, $this->_DateTimeZone);
-        }
-        // if $date_string is matches something that looks like a Unix timestamp let's just use it.
-        if (preg_match(EE_Datetime_Field::unix_timestamp_regex, $date_string)) {
-            try {
-                // This is operating under the assumption that the incoming Unix timestamp
-                // is an ACTUAL Unix timestamp and not the calculated one output by current_time('timestamp');
-                $DateTime = new DbSafeDateTime(EE_Datetime_Field::now, $this->_DateTimeZone);
-                $DateTime->setTimestamp($date_string);
-
-                return $DateTime;
-            } catch (Exception $e) {
-                // should be rare, but if things got fooled then let's just continue
-            }
-        }
-        // not a unix timestamp.  So we will use the set format on this object and set timezone to
-        // create the DateTime object.
-        $format = $this->_date_format . ' ' . $this->_time_format;
-        try {
-            $DateTime = DbSafeDateTime::createFromFormat($format, $date_string, $this->_DateTimeZone);
-            if (! $DateTime instanceof DbSafeDateTime) {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            '"%1$s" does not represent a valid Date Time in the format "%2$s".',
-                            'event_espresso'
-                        ),
-                        $date_string,
-                        $format
-                    )
-                );
-            }
-        } catch (Exception $e) {
-            // if we made it here then likely then something went really wrong.
-            // Instead of throwing an exception, let's just return a DateTime object for now, in the set timezone.
-            $DateTime = new DbSafeDateTime(EE_Datetime_Field::now, $this->_DateTimeZone);
-        }
-
-        return $DateTime;
-    }
-
-
-    /**
-     * get_timezone_transitions
-     *
-     * @param DateTimeZone $DateTimeZone
-     * @param int|null     $time
-     * @param bool|null    $first_only
-     * @return array
-     */
-    public function get_timezone_transitions(
-        DateTimeZone $DateTimeZone,
-        ?int $time = null,
-        bool $first_only = true
-    ): array {
-        return EEH_DTT_Helper::get_timezone_transitions($DateTimeZone, $time, $first_only);
-    }
-
-
-    /**
-     * get_timezone_offset
-     *
-     * @param DateTimeZone    $DateTimeZone
-     * @param int|string|null $time
-     * @return mixed
-     * @throws DomainException
-     */
-    public function get_timezone_offset(DateTimeZone $DateTimeZone, $time = null)
-    {
-        return EEH_DTT_Helper::get_timezone_offset($DateTimeZone, $time);
-    }
-
-
-    /**
-     * This will take an incoming timezone string and return the abbreviation for that timezone
-     *
-     * @param string|null $timezone_string
-     * @return string           abbreviation
-     * @throws Exception
-     */
-    public function get_timezone_abbrev(?string $timezone_string = ''): string
-    {
-        $timezone_string = EEH_DTT_Helper::get_valid_timezone_string($timezone_string);
-        $dateTime        = new DateTime(EE_Datetime_Field::now, new DateTimeZone($timezone_string));
-        return $dateTime->format('T');
-    }
-
-
-    /**
-     * Overrides the parent to allow for having a dynamic "now" value
-     *
-     * @return mixed
-     */
-    public function get_default_value()
-    {
-        if ($this->_default_value === EE_Datetime_Field::now) {
-            return time();
-        }
-        return parent::get_default_value();
-    }
-
-
-    /**
-     * Gets the default datetime object from the field's default time
-     *
-     * @return DbSafeDateTime|DateTime|null
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws Exception
-     * @since 4.9.66.p
-     */
-    public function getDefaultDateTimeObj()
-    {
-        $default_raw = $this->get_default_value();
-        if ($default_raw instanceof DateTime) {
-            return $default_raw;
-        }
-        if (is_null($default_raw)) {
-            return null;
-        }
-        $timezone_string = EEH_DTT_Helper::get_valid_timezone_string($this->get_timezone());
-        $timezone        = new DateTimeZone($timezone_string);
-
-        // can't pass unix timestamps directly to Datetime constructor
-        if (is_numeric($default_raw)) {
-            $datetime = new DbSafeDateTime();
-            $datetime->setTimestamp($default_raw);
-            return $datetime;
-        }
-        return new DbSafeDateTime($default_raw, $timezone);
-    }
-
-
-    public function getSchemaDescription(): string
-    {
-        return sprintf(
-            esc_html__('%s - the value for this field is in the timezone of the site.', 'event_espresso'),
-            $this->get_nicename()
-        );
-    }
+	/**
+	 * The pattern we're looking for is if only the characters 0-9 are found and there are only
+	 * 10 or more numbers (because 9 numbers even with all 9's would be sometime in 2001 )
+	 *
+	 * @type string unix_timestamp_regex
+	 */
+	const unix_timestamp_regex = '/[0-9]{10,}/';
+
+	/**
+	 * @type string mysql_timestamp_format
+	 */
+	const mysql_timestamp_format = 'Y-m-d H:i:s';
+
+	/**
+	 * @type string mysql_date_format
+	 */
+	const mysql_date_format = 'Y-m-d';
+
+	/**
+	 * @type string mysql_time_format
+	 */
+	const mysql_time_format = 'H:i:s';
+
+	/**
+	 * Const for using in the default value. If the field's default is set to this,
+	 * then we will return the time of calling `get_default_value()`, not
+	 * just the current time at construction
+	 */
+	const now = 'now';
+
+	/**
+	 * The following properties hold the default formats for date and time.
+	 * Defaults are set via the constructor and can be overridden on class instantiation.
+	 * However they can also be overridden later by the set_format() method
+	 * (and corresponding set_date_format, set_time_format methods);
+	 */
+
+	protected string $_date_format        = '';
+
+	protected string $_time_format        = '';
+
+	protected string $_pretty_date_format = '';
+
+	protected string $_pretty_time_format = '';
+
+	protected ?DateTimeZone $_DateTimeZone       = null;
+
+	protected ?DateTimeZone $_UTC_DateTimeZone   = null;
+
+	protected ?DateTimeZone $_blog_DateTimeZone  = null;
+
+
+	/**
+	 * This property holds how we want the output returned when getting a datetime string.  It is set for the
+	 * set_date_time_output() method.  By default this is empty.  When empty, we are assuming that we want both date
+	 * and time returned via getters.
+	 *
+	 * @var mixed (null|string)
+	 */
+	protected $_date_time_output;
+
+
+	/**
+	 * timezone string
+	 * This gets set by the constructor and can be changed by the "set_timezone()" method so that we know what timezone
+	 * incoming strings|timestamps are in.  This can also be used before a get to set what timezone you want strings
+	 * coming out of the object to be in.  Default timezone is the current WP timezone option setting
+	 */
+	protected ?string $_timezone_string = null;
+
+
+	/**
+	 * This holds whatever UTC offset for the blog (we automatically convert timezone strings into their related
+	 * offsets for comparison purposes).
+	 *
+	 * @var int
+	 */
+	protected int $_blog_offset = 0;
+
+
+	/**
+	 * @param string      $table_column
+	 * @param string      $nice_name
+	 * @param bool        $nullable
+	 * @param string|null $default_value
+	 * @param string|null $timezone_string
+	 * @param string|null $date_format
+	 * @param string|null $time_format
+	 * @param string|null $pretty_date_format
+	 * @param string|null $pretty_time_format
+	 * @throws InvalidArgumentException
+	 * @throws Exception
+	 */
+	public function __construct(
+		string $table_column,
+		string $nice_name,
+		bool $nullable,
+		?string $default_value,
+		?string $timezone_string = '',
+		?string $date_format = '',
+		?string $time_format = '',
+		?string $pretty_date_format = '',
+		?string $pretty_time_format = ''
+	) {
+		$this->set_date_format($date_format);
+		$this->set_time_format($time_format);
+		$this->set_date_format($pretty_date_format, true);
+		$this->set_time_format($pretty_time_format, true);
+
+		parent::__construct($table_column, $nice_name, $nullable, $default_value);
+		$this->set_timezone($timezone_string);
+		$this->setSchemaType(SchemaType::STRING);
+		$this->setSchemaFormat(SchemaFormat::DATETIME);
+		$this->setDataType(DataType::STRING); // best to url encode the date using DateTime::ATOM
+	}
+
+
+	/**
+	 * @return DateTimeZone
+	 * @throws Exception
+	 */
+	public function get_UTC_DateTimeZone(): DateTimeZone
+	{
+		return $this->_UTC_DateTimeZone instanceof DateTimeZone
+			? $this->_UTC_DateTimeZone
+			: $this->_create_timezone_object_from_timezone_string('UTC');
+	}
+
+
+	/**
+	 * @return DateTimeZone
+	 * @throws Exception
+	 */
+	public function get_blog_DateTimeZone(): DateTimeZone
+	{
+		return $this->_blog_DateTimeZone instanceof DateTimeZone
+			? $this->_blog_DateTimeZone
+			: $this->_create_timezone_object_from_timezone_string();
+	}
+
+
+	/**
+	 * this prepares any incoming date data and make sure it's converted to a UTC unix timestamp
+	 *
+	 * @param string|int|null $value value inputted for field on model object
+	 *                               could be a string formatted date time or int unix timestamp
+	 * @return DateTime
+	 * @throws Exception
+	 */
+	public function prepare_for_set($value)
+	{
+		return $this->_get_date_object($value);
+	}
+
+
+	/**
+	 * This returns the format string to be used by getters depending on what the $_date_time_output property is set at.
+	 * getters need to know whether we're just returning the date or the time or both.  By default we return both.
+	 *
+	 * @param bool $pretty If we're returning the pretty formats or standard format string.
+	 * @return string    The final assembled format string.
+	 */
+	protected function _get_date_time_output(bool $pretty = false): string
+	{
+		switch ($this->_date_time_output) {
+			case 'time':
+				return $pretty
+					? $this->_pretty_time_format
+					: $this->_time_format;
+
+			case 'date':
+				return $pretty
+					? $this->_pretty_date_format
+					: $this->_date_format;
+
+			default:
+				return $pretty
+					? trim($this->_pretty_date_format . ' ' . $this->_pretty_time_format)
+					: trim($this->_date_format . ' ' . $this->_time_format);
+		}
+	}
+
+
+	/**
+	 * This just sets the $_date_time_output property so we can flag how date and times are formatted before being
+	 * returned (using the format properties)
+	 *
+	 * @param string|null $what acceptable values are 'time' or 'date'.
+	 *                          Any other value will be set but will always result
+	 *                          in both 'date' and 'time' being returned.
+	 * @return void
+	 */
+	public function set_date_time_output(?string $what = null)
+	{
+		$this->_date_time_output = $what;
+	}
+
+
+	/**
+	 * See $_timezone property for description of what the timezone property is for.  This SETS the timezone internally
+	 * for being able to reference what timezone we are running conversions on when converting TO the internal timezone
+	 * (UTC Unix Timestamp) for the object OR when converting FROM the internal timezone (UTC Unix Timestamp).
+	 * We also set some other properties in this method.
+	 *
+	 * @param string|null $timezone_string A valid timezone string as described by @link
+	 *                                     http://www.php.net/manual/en/timezones.php
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws Exception
+	 */
+	public function set_timezone(?string $timezone_string = '')
+	{
+		if (empty($timezone_string) && $this->_timezone_string) {
+			// leave the timezone AS-IS if we already have one and
+			// the function arg didn't provide one
+			return;
+		}
+		$timezone_string        = EEH_DTT_Helper::get_valid_timezone_string($timezone_string);
+		$this->_timezone_string = ! empty($timezone_string)
+			? $timezone_string
+			: 'UTC';
+		$this->_DateTimeZone    = $this->_create_timezone_object_from_timezone_string($this->_timezone_string);
+	}
+
+
+	/**
+	 * _create_timezone_object_from_timezone_name
+	 *
+	 * @access protected
+	 * @param string|null $timezone_string
+	 * @return DateTimeZone
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws Exception
+	 */
+	protected function _create_timezone_object_from_timezone_string(?string $timezone_string = ''): DateTimeZone
+	{
+		return new DateTimeZone(EEH_DTT_Helper::get_valid_timezone_string($timezone_string));
+	}
+
+
+	/**
+	 * This just returns whatever is set for the current timezone.
+	 *
+	 * @access public
+	 * @return string timezone string
+	 */
+	public function get_timezone(): string
+	{
+		return (string) $this->_timezone_string;
+	}
+
+
+	/**
+	 * set the $_date_format property
+	 *
+	 * @access public
+	 * @param string $format a new date format (corresponding to formats accepted by PHP date() function)
+	 * @param bool   $pretty Whether to set pretty format or not.
+	 * @return void
+	 */
+	public function set_date_format(string $format, bool $pretty = false)
+	{
+		if ($pretty) {
+			$this->_pretty_date_format = new DateFormat($format);
+		} else {
+			$this->_date_format = new DateFormat($format);
+		}
+	}
+
+
+	/**
+	 * return the $_date_format property value.
+	 *
+	 * @param bool $pretty Whether to get pretty format or not.
+	 * @return string
+	 */
+	public function get_date_format(bool $pretty = false): string
+	{
+		return $pretty
+			? $this->_pretty_date_format
+			: $this->_date_format;
+	}
+
+
+	/**
+	 * set the $_time_format property
+	 *
+	 * @access public
+	 * @param string $format a new time format (corresponding to formats accepted by PHP date() function)
+	 * @param bool   $pretty Whether to set pretty format or not.
+	 * @return void
+	 */
+	public function set_time_format(string $format, bool $pretty = false)
+	{
+		if ($pretty) {
+			$this->_pretty_time_format = new TimeFormat($format);
+		} else {
+			$this->_time_format = new TimeFormat($format);
+		}
+	}
+
+
+	/**
+	 * return the $_time_format property value.
+	 *
+	 * @param bool $pretty Whether to get pretty format or not.
+	 * @return string
+	 */
+	public function get_time_format(bool $pretty = false): string
+	{
+		return $pretty
+			? $this->_pretty_time_format
+			: $this->_time_format;
+	}
+
+
+	/**
+	 * set the $_pretty_date_format property
+	 *
+	 * @access public
+	 * @param string|null $format a new pretty date format (corresponding to formats accepted by PHP date() function)
+	 * @return void
+	 */
+	public function set_pretty_date_format(?string $format)
+	{
+		$this->set_date_format($format, true);
+	}
+
+
+	/**
+	 * set the $_pretty_time_format property
+	 *
+	 * @access public
+	 * @param string|null $format a new pretty time format (corresponding to formats accepted by PHP date() function)
+	 * @return void
+	 */
+	public function set_pretty_time_format(?string $format)
+	{
+		$this->set_time_format($format, true);
+	}
+
+
+	/**
+	 * Only sets the time portion of the datetime.
+	 *
+	 * @param string|DateTime $time_to_set_string like 8am OR a DateTime object.
+	 * @param DateTime        $current            current DateTime object for the datetime field
+	 * @return DateTime
+	 */
+	public function prepare_for_set_with_new_time($time_to_set_string, DateTime $current): DateTime
+	{
+		// if $time_to_set_string is datetime object, then let's use it to set the parse array.
+		// Otherwise parse the string.
+		if ($time_to_set_string instanceof DateTime) {
+			$parsed = [
+				'hour'   => $time_to_set_string->format('H'),
+				'minute' => $time_to_set_string->format('i'),
+				'second' => $time_to_set_string->format('s'),
+			];
+		} else {
+			// parse incoming string
+			$parsed = date_parse_from_format($this->_time_format, $time_to_set_string);
+		}
+		EEH_DTT_Helper::setTimezone($current, $this->_DateTimeZone);
+		return $current->setTime($parsed['hour'], $parsed['minute'], $parsed['second']);
+	}
+
+
+	/**
+	 * Only sets the date portion of the datetime.
+	 *
+	 * @param string|DateTime $date_to_set_string like "Friday, January 8th" or a DateTime object.
+	 * @param DateTime        $current            current DateTime object for the datetime field
+	 * @return DateTime
+	 */
+	public function prepare_for_set_with_new_date($date_to_set_string, DateTime $current): DateTime
+	{
+		// if $time_to_set_string is datetime object, then let's use it to set the parse array.
+		// Otherwise parse the string.
+		if ($date_to_set_string instanceof DateTime) {
+			$parsed = [
+				'year'  => $date_to_set_string->format('Y'),
+				'month' => $date_to_set_string->format('m'),
+				'day'   => $date_to_set_string->format('d'),
+			];
+		} else {
+			// parse incoming string
+			$parsed = date_parse_from_format($this->_date_format, $date_to_set_string);
+		}
+		EEH_DTT_Helper::setTimezone($current, $this->_DateTimeZone);
+		return $current->setDate($parsed['year'], $parsed['month'], $parsed['day']);
+	}
+
+
+	/**
+	 * This prepares the EE_DateTime value to be saved to the db as mysql timestamp (UTC +0 timezone).
+	 * When the datetime gets to this stage it should ALREADY be in UTC time
+	 *
+	 * @param int|string|DateTime|null $DateTime
+	 * @return string formatted date time for given timezone
+	 * @throws EE_Error
+	 */
+	public function prepare_for_get($DateTime): string
+	{
+		return $this->_prepare_for_display($DateTime);
+	}
+
+
+	/**
+	 * This differs from prepare_for_get in that it considers whether the internal $_timezone differs
+	 * from the set wp timezone.  If so, then it returns the datetime string formatted via
+	 * _pretty_date_format, and _pretty_time_format.  However, it also appends a timezone
+	 * abbreviation to the date_string.
+	 *
+	 * @param mixed       $DateTime
+	 * @param string|null $schema
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function prepare_for_pretty_echoing($DateTime, ?string $schema = null): string
+	{
+		$schema = $schema ?: true;
+		return $this->_prepare_for_display($DateTime, $schema);
+	}
+
+
+	/**
+	 * This prepares the EE_DateTime value to be saved to the db as mysql timestamp (UTC +0
+	 * timezone).
+	 *
+	 * @param int|string|DateTime|null $DateTime
+	 * @param bool|string   $schema
+	 * @return string
+	 * @throws EE_Error
+	 * @throws Exception
+	 */
+	protected function _prepare_for_display($DateTime, $schema = false): string
+	{
+		if (! $DateTime instanceof DateTime) {
+			if ($this->_nullable) {
+				return '';
+			}
+			if (WP_DEBUG) {
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							'EE_Datetime_Field::_prepare_for_display requires a DateTime class to be the value for the $DateTime argument because the %s field is not nullable.',
+							'event_espresso'
+						),
+						$this->_nicename
+					)
+				);
+			}
+			$DateTime = new DbSafeDateTime(EE_Datetime_Field::now);
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'EE_Datetime_Field::_prepare_for_display requires a DateTime class to be the value for the $DateTime argument because the %s field is not nullable.  When WP_DEBUG is false, the value is set to "now" instead of throwing an exception.',
+						'event_espresso'
+					),
+					$this->_nicename
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		$format_string = $this->_get_date_time_output($schema);
+		EEH_DTT_Helper::setTimezone($DateTime, $this->_DateTimeZone);
+		if ($schema) {
+			$timezone_string = '';
+			if ($this->_display_timezone()) {
+				// must be explicit because schema could equal true.
+				if ($schema === 'no_html') {
+					$timezone_string = ' (' . $DateTime->format('T') . ')';
+				} else {
+					$timezone_string = ' <span class="ee_dtt_timezone_string">(' . $DateTime->format('T') . ')</span>';
+				}
+			}
+
+			return $DateTime->format($format_string) . $timezone_string;
+		}
+		return $DateTime->format($format_string);
+	}
+
+
+	/**
+	 * This prepares the EE_DateTime value to be saved to the db as mysql timestamp (UTC +0
+	 * timezone).
+	 *
+	 * @param mixed $datetime_value u
+	 * @return string mysql timestamp in UTC
+	 * @throws EE_Error
+	 * @throws Exception
+	 */
+	public function prepare_for_use_in_db($datetime_value): ?string
+	{
+		// we allow an empty value or DateTime object, but nothing else.
+		if (! empty($datetime_value) && ! $datetime_value instanceof DateTime) {
+			$datetime_value = $this->_get_date_object($datetime_value);
+			if (! $datetime_value instanceof DateTime) {
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							'The incoming value being prepared for setting in the database for the %1$s field must either be empty or a php DateTime object, instead of: %2$s %3$s',
+							'event_espresso'
+						),
+						$this->get_name(),
+						'<br />',
+						print_r($datetime_value, true)
+					)
+				);
+			}
+		}
+
+		if ($datetime_value instanceof DateTime) {
+			if (! $datetime_value instanceof DbSafeDateTime) {
+				$datetime_value = DbSafeDateTime::createFromDateTime($datetime_value);
+			}
+			EEH_DTT_Helper::setTimezone($datetime_value, $this->get_UTC_DateTimeZone());
+			return $datetime_value->format(
+				EE_Datetime_Field::mysql_timestamp_format
+			);
+		}
+
+		// if $datetime_value is empty, and ! $this->_nullable, use current_time() but set the GMT flag to true
+		return ! $this->_nullable
+			? current_time('mysql', true)
+			: null;
+	}
+
+
+	/**
+	 * This prepares the datetime for internal usage as a PHP DateTime object OR null (if nullable is
+	 * allowed)
+	 *
+	 * @param string $datetime_string mysql timestamp in UTC
+	 * @return  bool|DbSafeDateTime|null
+	 * @throws EE_Error
+	 * @throws Exception
+	 */
+	public function prepare_for_set_from_db($datetime_string)
+	{
+		// if $datetime_value is empty, and ! $this->_nullable, just use time()
+		if (empty($datetime_string) && $this->_nullable) {
+			return null;
+		}
+		// datetime strings from the db should ALWAYS be in UTC+0, so use UTC_DateTimeZone when creating
+		$DateTime = empty($datetime_string)
+			? new DbSafeDateTime(EE_Datetime_Field::now, $this->get_UTC_DateTimeZone())
+			: DbSafeDateTime::createFromFormat(
+				EE_Datetime_Field::mysql_timestamp_format,
+				$datetime_string,
+				$this->get_UTC_DateTimeZone()
+			);
+
+		if (! $DateTime instanceof DbSafeDateTime) {
+			// if still no datetime object, then let's just use now
+			$DateTime = new DbSafeDateTime(EE_Datetime_Field::now, $this->get_UTC_DateTimeZone());
+		}
+		// THEN apply the field's set DateTimeZone
+		EEH_DTT_Helper::setTimezone($DateTime, $this->_DateTimeZone);
+		return $DateTime;
+	}
+
+
+	/**
+	 * All this method does is determine if we're going to display the timezone string or not on any output.
+	 * To determine this we check if the set timezone offset is different than the blog's set timezone offset.
+	 * If so, then true.
+	 *
+	 * @return bool true for yes false for no
+	 * @throws Exception
+	 */
+	protected function _display_timezone(): bool
+	{
+		// first let's do a comparison of timezone strings.
+		// If they match then we can get out without any further calculations
+		$blog_string = get_option('timezone_string');
+		if ($blog_string === $this->_timezone_string) {
+			return false;
+		}
+		// now we need to calc the offset for the timezone string so we can compare with the blog offset.
+		$this_offset = $this->get_timezone_offset($this->_DateTimeZone);
+		$blog_offset = $this->get_timezone_offset($this->get_blog_DateTimeZone());
+		// now compare
+		return $blog_offset !== $this_offset;
+	}
+
+
+	/**
+	 * This method returns a php DateTime object for setting on the EE_Base_Class model.
+	 * EE passes around DateTime objects because they are MUCH easier to manipulate and deal
+	 * with.
+	 *
+	 * @param int|string|DateTime|null $date_string This should be the incoming date string. It's assumed to be in
+	 *                                              the format that is set on the date_field (or DateTime object)!
+	 * @return DateTime|null
+	 * @throws Exception
+	 */
+	protected function _get_date_object($date_string)
+	{
+		// first if this is an empty date_string and nullable is allowed, just return null.
+		if ($this->_nullable && empty($date_string)) {
+			return null;
+		}
+
+		// if incoming date
+		if ($date_string instanceof DateTime) {
+			EEH_DTT_Helper::setTimezone($date_string, $this->_DateTimeZone);
+			return $date_string;
+		}
+		// if empty date_string and made it here.
+		// Return a datetime object for now in the given timezone.
+		if (empty($date_string)) {
+			return new DbSafeDateTime(EE_Datetime_Field::now, $this->_DateTimeZone);
+		}
+		// if $date_string is matches something that looks like a Unix timestamp let's just use it.
+		if (preg_match(EE_Datetime_Field::unix_timestamp_regex, $date_string)) {
+			try {
+				// This is operating under the assumption that the incoming Unix timestamp
+				// is an ACTUAL Unix timestamp and not the calculated one output by current_time('timestamp');
+				$DateTime = new DbSafeDateTime(EE_Datetime_Field::now, $this->_DateTimeZone);
+				$DateTime->setTimestamp($date_string);
+
+				return $DateTime;
+			} catch (Exception $e) {
+				// should be rare, but if things got fooled then let's just continue
+			}
+		}
+		// not a unix timestamp.  So we will use the set format on this object and set timezone to
+		// create the DateTime object.
+		$format = $this->_date_format . ' ' . $this->_time_format;
+		try {
+			$DateTime = DbSafeDateTime::createFromFormat($format, $date_string, $this->_DateTimeZone);
+			if (! $DateTime instanceof DbSafeDateTime) {
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							'"%1$s" does not represent a valid Date Time in the format "%2$s".',
+							'event_espresso'
+						),
+						$date_string,
+						$format
+					)
+				);
+			}
+		} catch (Exception $e) {
+			// if we made it here then likely then something went really wrong.
+			// Instead of throwing an exception, let's just return a DateTime object for now, in the set timezone.
+			$DateTime = new DbSafeDateTime(EE_Datetime_Field::now, $this->_DateTimeZone);
+		}
+
+		return $DateTime;
+	}
+
+
+	/**
+	 * get_timezone_transitions
+	 *
+	 * @param DateTimeZone $DateTimeZone
+	 * @param int|null     $time
+	 * @param bool|null    $first_only
+	 * @return array
+	 */
+	public function get_timezone_transitions(
+		DateTimeZone $DateTimeZone,
+		?int $time = null,
+		bool $first_only = true
+	): array {
+		return EEH_DTT_Helper::get_timezone_transitions($DateTimeZone, $time, $first_only);
+	}
+
+
+	/**
+	 * get_timezone_offset
+	 *
+	 * @param DateTimeZone    $DateTimeZone
+	 * @param int|string|null $time
+	 * @return mixed
+	 * @throws DomainException
+	 */
+	public function get_timezone_offset(DateTimeZone $DateTimeZone, $time = null)
+	{
+		return EEH_DTT_Helper::get_timezone_offset($DateTimeZone, $time);
+	}
+
+
+	/**
+	 * This will take an incoming timezone string and return the abbreviation for that timezone
+	 *
+	 * @param string|null $timezone_string
+	 * @return string           abbreviation
+	 * @throws Exception
+	 */
+	public function get_timezone_abbrev(?string $timezone_string = ''): string
+	{
+		$timezone_string = EEH_DTT_Helper::get_valid_timezone_string($timezone_string);
+		$dateTime        = new DateTime(EE_Datetime_Field::now, new DateTimeZone($timezone_string));
+		return $dateTime->format('T');
+	}
+
+
+	/**
+	 * Overrides the parent to allow for having a dynamic "now" value
+	 *
+	 * @return mixed
+	 */
+	public function get_default_value()
+	{
+		if ($this->_default_value === EE_Datetime_Field::now) {
+			return time();
+		}
+		return parent::get_default_value();
+	}
+
+
+	/**
+	 * Gets the default datetime object from the field's default time
+	 *
+	 * @return DbSafeDateTime|DateTime|null
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws Exception
+	 * @since 4.9.66.p
+	 */
+	public function getDefaultDateTimeObj()
+	{
+		$default_raw = $this->get_default_value();
+		if ($default_raw instanceof DateTime) {
+			return $default_raw;
+		}
+		if (is_null($default_raw)) {
+			return null;
+		}
+		$timezone_string = EEH_DTT_Helper::get_valid_timezone_string($this->get_timezone());
+		$timezone        = new DateTimeZone($timezone_string);
+
+		// can't pass unix timestamps directly to Datetime constructor
+		if (is_numeric($default_raw)) {
+			$datetime = new DbSafeDateTime();
+			$datetime->setTimestamp($default_raw);
+			return $datetime;
+		}
+		return new DbSafeDateTime($default_raw, $timezone);
+	}
+
+
+	public function getSchemaDescription(): string
+	{
+		return sprintf(
+			esc_html__('%s - the value for this field is in the timezone of the site.', 'event_espresso'),
+			$this->get_nicename()
+		);
+	}
 }

core/db_models/fields/EE_Infinite_Integer_Field.php

Indentation +66 added lines, -66 removed lines

@@ -12,78 +12,78 @@
  */
 class EE_Infinite_Integer_Field extends EE_Model_Field_Base
 {
-    /**
-     * @param string $table_column
-     * @param string $nicename
-     * @param bool   $nullable
-     * @param null   $default_value
-     */
-    public function __construct($table_column, $nicename, $nullable, $default_value = null)
-    {
-        parent::__construct($table_column, $nicename, $nullable, $default_value);
-        $this->setSchemaType([SchemaType::INTEGER, SchemaType::NULL]);
-        $this->setDataType(DataType::INTEGER);
-    }
+	/**
+	 * @param string $table_column
+	 * @param string $nicename
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 */
+	public function __construct($table_column, $nicename, $nullable, $default_value = null)
+	{
+		parent::__construct($table_column, $nicename, $nullable, $default_value);
+		$this->setSchemaType([SchemaType::INTEGER, SchemaType::NULL]);
+		$this->setDataType(DataType::INTEGER);
+	}
 
 
-    public function prepare_for_use_in_db($value_of_field_on_model_object)
-    {
-        if ($value_of_field_on_model_object === EE_INF) {
-            return EE_INF_IN_DB;
-        }
-        return (int) $value_of_field_on_model_object;
-    }
+	public function prepare_for_use_in_db($value_of_field_on_model_object)
+	{
+		if ($value_of_field_on_model_object === EE_INF) {
+			return EE_INF_IN_DB;
+		}
+		return (int) $value_of_field_on_model_object;
+	}
 
 
-    public function prepare_for_set($value_inputted_for_field_on_model_object)
-    {
-        if (
-            $value_inputted_for_field_on_model_object === EE_INF_IN_DB ||
-            $value_inputted_for_field_on_model_object === EE_INF ||
-            $value_inputted_for_field_on_model_object === "EE_INF" ||
-            $value_inputted_for_field_on_model_object === ""
-        ) {
-            return EE_INF;
-        }
-        return (int) $value_inputted_for_field_on_model_object;
-    }
+	public function prepare_for_set($value_inputted_for_field_on_model_object)
+	{
+		if (
+			$value_inputted_for_field_on_model_object === EE_INF_IN_DB ||
+			$value_inputted_for_field_on_model_object === EE_INF ||
+			$value_inputted_for_field_on_model_object === "EE_INF" ||
+			$value_inputted_for_field_on_model_object === ""
+		) {
+			return EE_INF;
+		}
+		return (int) $value_inputted_for_field_on_model_object;
+	}
 
 
-    public function prepare_for_set_from_db($value_inputted_for_field_on_model_object)
-    {
-        $intval = (int) $value_inputted_for_field_on_model_object;
-        if ($intval == EE_INF_IN_DB) {
-            return EE_INF;
-        }
-        return $intval;
-    }
+	public function prepare_for_set_from_db($value_inputted_for_field_on_model_object)
+	{
+		$intval = (int) $value_inputted_for_field_on_model_object;
+		if ($intval == EE_INF_IN_DB) {
+			return EE_INF;
+		}
+		return $intval;
+	}
 
 
-    /**
-     * For outputting this field's value. If you want to output it into an input or something,
-     * use $schema=='input', as it will replace EE_INF with ''. If you want a readable version, use $schema=='text'
-     * as it will replace EE_INF with i18n Infinite
-     *
-     * @param mixed       $value_on_field_to_be_outputted
-     * @param string|null $schema input, symbol, text; or any string you want to show if the value equals EE_INF
-     * @return string
-     */
-    public function prepare_for_pretty_echoing($value_on_field_to_be_outputted, ?string $schema = null)
-    {
-        if ($value_on_field_to_be_outputted === EE_INF) {
-            switch ($schema) {
-                case 'input':
-                case 'form_input':
-                    return '';
-                case 'symbol':
-                    return "∞";
-                case 'text':
-                case null:
-                    return esc_html__("Unlimited", "event_espresso");
-                default:
-                    return $schema;
-            }
-        }
-        return $value_on_field_to_be_outputted;
-    }
+	/**
+	 * For outputting this field's value. If you want to output it into an input or something,
+	 * use $schema=='input', as it will replace EE_INF with ''. If you want a readable version, use $schema=='text'
+	 * as it will replace EE_INF with i18n Infinite
+	 *
+	 * @param mixed       $value_on_field_to_be_outputted
+	 * @param string|null $schema input, symbol, text; or any string you want to show if the value equals EE_INF
+	 * @return string
+	 */
+	public function prepare_for_pretty_echoing($value_on_field_to_be_outputted, ?string $schema = null)
+	{
+		if ($value_on_field_to_be_outputted === EE_INF) {
+			switch ($schema) {
+				case 'input':
+				case 'form_input':
+					return '';
+				case 'symbol':
+					return "∞";
+				case 'text':
+				case null:
+					return esc_html__("Unlimited", "event_espresso");
+				default:
+					return $schema;
+			}
+		}
+		return $value_on_field_to_be_outputted;
+	}
 }