eventespresso / event-espresso-core

core/EE_Addon.core.php

Indentation +848 added lines, -848 removed lines

@@ -19,859 +19,859 @@
 {
 
 
-    /**
-     * 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 = array();
-
-
-    /**
-     *    filepath to the main file, which can be used for register_activation_hook, register_deactivation_hook, etc.
-     *
-     * @type string
-     */
-    protected $_main_plugin_file;
-
-    /**
-     *    This is the slug used to identify this add-on within the plugin update engine.
-     *
-     * @type string
-     */
-    protected $pue_slug;
-
-
-    /**
-     * @var EE_Dependency_Map $dependency_map
-     */
-    private $dependency_map;
-
-
-    /**
-     * @var DomainInterface $domain
-     */
-    private $domain;
-
-
-    /**
-     * @param EE_Dependency_Map $dependency_map [optional]
-     * @param DomainInterface   $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', array($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()
-    {
-        return $this->dependency_map;
-    }
-
-
-    /**
-     * @param DomainInterface $domain
-     */
-    public function setDomain(DomainInterface $domain)
-    {
-        $this->domain = $domain;
-    }
-
-    /**
-     * @return DomainInterface
-     */
-    public function domain()
-    {
-        return $this->domain;
-    }
-
-
-    /**
-     * @param mixed $version
-     */
-    public function set_version($version = null)
-    {
-        $this->_version = $version;
-    }
-
-
-    /**
-     * get__version
-     *
-     * @return string
-     */
-    public function version()
-    {
-        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()
-    {
-        return $this->_min_core_version;
-    }
-
-
-    /**
-     * Sets addon_name
-     *
-     * @param string $addon_name
-     * @return bool
-     */
-    public function set_name($addon_name)
-    {
-        return $this->_addon_name = $addon_name;
-    }
-
-
-    /**
-     * Gets addon_name
-     *
-     * @return string
-     */
-    public function name()
-    {
-        return $this->_addon_name;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function plugin_basename()
-    {
-
-        return $this->_plugin_basename;
-    }
-
-
-    /**
-     * @param string $plugin_basename
-     */
-    public function set_plugin_basename($plugin_basename)
-    {
-
-        $this->_plugin_basename = $plugin_basename;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function plugin_slug()
-    {
-
-        return $this->_plugin_slug;
-    }
-
-
-    /**
-     * @param string $plugin_slug
-     */
-    public function set_plugin_slug($plugin_slug)
-    {
-
-        $this->_plugin_slug = $plugin_slug;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function plugin_action_slug()
-    {
-
-        return $this->_plugin_action_slug;
-    }
-
-
-    /**
-     * @param string $plugin_action_slug
-     */
-    public function set_plugin_action_slug($plugin_action_slug)
-    {
-
-        $this->_plugin_action_slug = $plugin_action_slug;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function get_plugins_page_row()
-    {
-
-        return $this->_plugins_page_row;
-    }
-
-
-    /**
-     * @param array $plugins_page_row
-     */
-    public function set_plugins_page_row($plugins_page_row = array())
-    {
-        // 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 = array();
-        }
-        $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',
-            array($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',
-            array($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 (EE_Maintenance_Mode::instance()->level() !== EE_Maintenance_Mode::level_2_complete_maintenance) {
-            if ($verify_schema) {
-                $this->initialize_db();
-            }
-            $this->initialize_default_data();
-            // @todo: this will probably need to be adjusted in 4.4 as the array changed formats I believe
-            EE_Data_Migration_Manager::instance()->update_current_database_state_to(
-                array(
-                    'slug'    => $this->name(),
-                    'version' => $this->version(),
-                )
-            );
-            /* make sure core's data is a-ok
+	/**
+	 * prefix to be added onto an addon's plugin slug to make a wp option name
+	 * which will be used to store the plugin's activation history
+	 */
+	const ee_addon_version_history_option_prefix = 'ee_version_history_';
+
+	/**
+	 * @var $_version
+	 * @type string
+	 */
+	protected $_version = '';
+
+	/**
+	 * @var $_min_core_version
+	 * @type string
+	 */
+	protected $_min_core_version = '';
+
+	/**
+	 * derived from plugin 'main_file_path using plugin_basename()
+	 *
+	 * @type string $_plugin_basename
+	 */
+	protected $_plugin_basename = '';
+
+	/**
+	 * A non-internationalized name to identify this addon for use in URLs, etc
+	 *
+	 * @type string $_plugin_slug
+	 */
+	protected $_plugin_slug = '';
+
+	/**
+	 * A non-internationalized name to identify this addon. Eg 'Calendar','MailChimp',etc/
+	 *
+	 * @type string _addon_name
+	 */
+	protected $_addon_name = '';
+
+	/**
+	 * one of the EE_System::req_type_* constants
+	 *
+	 * @type int $_req_type
+	 */
+	protected $_req_type;
+
+	/**
+	 * page slug to be used when generating the "Settings" link on the WP plugin page
+	 *
+	 * @type string $_plugin_action_slug
+	 */
+	protected $_plugin_action_slug = '';
+
+	/**
+	 * if not empty, inserts a new table row after this plugin's row on the WP Plugins page
+	 * that can be used for adding upgrading/marketing info
+	 *
+	 * @type array $_plugins_page_row
+	 */
+	protected $_plugins_page_row = array();
+
+
+	/**
+	 *    filepath to the main file, which can be used for register_activation_hook, register_deactivation_hook, etc.
+	 *
+	 * @type string
+	 */
+	protected $_main_plugin_file;
+
+	/**
+	 *    This is the slug used to identify this add-on within the plugin update engine.
+	 *
+	 * @type string
+	 */
+	protected $pue_slug;
+
+
+	/**
+	 * @var EE_Dependency_Map $dependency_map
+	 */
+	private $dependency_map;
+
+
+	/**
+	 * @var DomainInterface $domain
+	 */
+	private $domain;
+
+
+	/**
+	 * @param EE_Dependency_Map $dependency_map [optional]
+	 * @param DomainInterface   $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', array($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()
+	{
+		return $this->dependency_map;
+	}
+
+
+	/**
+	 * @param DomainInterface $domain
+	 */
+	public function setDomain(DomainInterface $domain)
+	{
+		$this->domain = $domain;
+	}
+
+	/**
+	 * @return DomainInterface
+	 */
+	public function domain()
+	{
+		return $this->domain;
+	}
+
+
+	/**
+	 * @param mixed $version
+	 */
+	public function set_version($version = null)
+	{
+		$this->_version = $version;
+	}
+
+
+	/**
+	 * get__version
+	 *
+	 * @return string
+	 */
+	public function version()
+	{
+		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()
+	{
+		return $this->_min_core_version;
+	}
+
+
+	/**
+	 * Sets addon_name
+	 *
+	 * @param string $addon_name
+	 * @return bool
+	 */
+	public function set_name($addon_name)
+	{
+		return $this->_addon_name = $addon_name;
+	}
+
+
+	/**
+	 * Gets addon_name
+	 *
+	 * @return string
+	 */
+	public function name()
+	{
+		return $this->_addon_name;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function plugin_basename()
+	{
+
+		return $this->_plugin_basename;
+	}
+
+
+	/**
+	 * @param string $plugin_basename
+	 */
+	public function set_plugin_basename($plugin_basename)
+	{
+
+		$this->_plugin_basename = $plugin_basename;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function plugin_slug()
+	{
+
+		return $this->_plugin_slug;
+	}
+
+
+	/**
+	 * @param string $plugin_slug
+	 */
+	public function set_plugin_slug($plugin_slug)
+	{
+
+		$this->_plugin_slug = $plugin_slug;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function plugin_action_slug()
+	{
+
+		return $this->_plugin_action_slug;
+	}
+
+
+	/**
+	 * @param string $plugin_action_slug
+	 */
+	public function set_plugin_action_slug($plugin_action_slug)
+	{
+
+		$this->_plugin_action_slug = $plugin_action_slug;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function get_plugins_page_row()
+	{
+
+		return $this->_plugins_page_row;
+	}
+
+
+	/**
+	 * @param array $plugins_page_row
+	 */
+	public function set_plugins_page_row($plugins_page_row = array())
+	{
+		// 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 = array();
+		}
+		$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',
+			array($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',
+			array($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 (EE_Maintenance_Mode::instance()->level() !== EE_Maintenance_Mode::level_2_complete_maintenance) {
+			if ($verify_schema) {
+				$this->initialize_db();
+			}
+			$this->initialize_default_data();
+			// @todo: this will probably need to be adjusted in 4.4 as the array changed formats I believe
+			EE_Data_Migration_Manager::instance()->update_current_database_state_to(
+				array(
+					'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.
-     */
-    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(
-            array(
-                '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',
-            array($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',
-            array($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()
-    {
-        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)
-     *
-     * @deprecated since version 4.3.0.alpha.016
-     * @return string
-     */
-    public function get_db_update_option_name()
-    {
-        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()
-    {
-        // 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()
-    {
-        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($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)
-    {
-        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)
-    {
-        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());
-        // resave
-        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()
-    {
-        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()
-    {
-        return get_option($this->get_activation_history_option_name(), null);
-    }
-
-
-    /**
-     * @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($filepath)
-    {
-        $this->_main_plugin_file = $filepath;
-    }
-
-    /**
-     * gets the filepath to teh main file
-     *
-     * @return string
-     */
-    public function get_main_plugin_file()
-    {
-        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()
-    {
-        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()
-    {
-        return dirname($this->get_main_plugin_file());
-    }
-
-
-    /**
-     * sets hooks used in the admin
-     *
-     * @return void
-     */
-    public function admin_init()
-    {
-        // is admin and not in M-Mode ?
-        if (is_admin() && ! EE_Maintenance_Mode::instance()->level()) {
-            add_filter('plugin_action_links', array($this, 'plugin_action_links'), 10, 2);
-            add_filter('after_plugin_row_' . $this->_plugin_basename, array($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 $links
-     * @param $file
-     * @return array
-     */
-    public function plugin_action_links($links, $file)
-    {
-        if ($file === $this->plugin_basename() && $this->plugin_action_slug() !== '') {
-            // before other links
-            array_unshift(
-                $links,
-                '<a href="admin.php?page=' . $this->plugin_action_slug() . '">'
-                . esc_html__('Settings', 'event_espresso')
-                . '</a>'
-            );
-        }
-        return $links;
-    }
-
-
-    /**
-     * after_plugin_row
-     * Add additional content to the plugins page plugin row
-     * Inserts another row
-     *
-     * @param $plugin_file
-     * @param $plugin_data
-     * @param $status
-     * @return void
-     */
-    public function after_plugin_row($plugin_file, $plugin_data, $status)
-    {
-        $after_plugin_row = '';
-        $plugins_page_row = $this->get_plugins_page_row();
-        if (! empty($plugins_page_row) && $plugin_file === $this->plugin_basename()) {
-            $class = $status ? 'active' : 'inactive';
-            $link_text = isset($plugins_page_row['link_text']) ? $plugins_page_row['link_text'] : '';
-            $link_url = isset($plugins_page_row['link_url']) ? $plugins_page_row['link_url'] : '';
-            $description = isset($plugins_page_row['description'])
-                ? $plugins_page_row['description']
-                : '';
-            if (! empty($link_text) && ! empty($link_url) && ! empty($description)) {
-                $after_plugin_row .= '<tr id="' . sanitize_title($plugin_file) . '-ee-addon" class="' . $class . '">';
-                $after_plugin_row .= '<th class="check-column" scope="row"></th>';
-                $after_plugin_row .= '<td class="ee-addon-upsell-info-title-td plugin-title column-primary">';
-                $after_plugin_row .= '<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.
+	 */
+	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(
+			array(
+				'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',
+			array($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',
+			array($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()
+	{
+		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)
+	 *
+	 * @deprecated since version 4.3.0.alpha.016
+	 * @return string
+	 */
+	public function get_db_update_option_name()
+	{
+		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()
+	{
+		// 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()
+	{
+		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($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)
+	{
+		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)
+	{
+		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());
+		// resave
+		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()
+	{
+		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()
+	{
+		return get_option($this->get_activation_history_option_name(), null);
+	}
+
+
+	/**
+	 * @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($filepath)
+	{
+		$this->_main_plugin_file = $filepath;
+	}
+
+	/**
+	 * gets the filepath to teh main file
+	 *
+	 * @return string
+	 */
+	public function get_main_plugin_file()
+	{
+		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()
+	{
+		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()
+	{
+		return dirname($this->get_main_plugin_file());
+	}
+
+
+	/**
+	 * sets hooks used in the admin
+	 *
+	 * @return void
+	 */
+	public function admin_init()
+	{
+		// is admin and not in M-Mode ?
+		if (is_admin() && ! EE_Maintenance_Mode::instance()->level()) {
+			add_filter('plugin_action_links', array($this, 'plugin_action_links'), 10, 2);
+			add_filter('after_plugin_row_' . $this->_plugin_basename, array($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 $links
+	 * @param $file
+	 * @return array
+	 */
+	public function plugin_action_links($links, $file)
+	{
+		if ($file === $this->plugin_basename() && $this->plugin_action_slug() !== '') {
+			// before other links
+			array_unshift(
+				$links,
+				'<a href="admin.php?page=' . $this->plugin_action_slug() . '">'
+				. esc_html__('Settings', 'event_espresso')
+				. '</a>'
+			);
+		}
+		return $links;
+	}
+
+
+	/**
+	 * after_plugin_row
+	 * Add additional content to the plugins page plugin row
+	 * Inserts another row
+	 *
+	 * @param $plugin_file
+	 * @param $plugin_data
+	 * @param $status
+	 * @return void
+	 */
+	public function after_plugin_row($plugin_file, $plugin_data, $status)
+	{
+		$after_plugin_row = '';
+		$plugins_page_row = $this->get_plugins_page_row();
+		if (! empty($plugins_page_row) && $plugin_file === $this->plugin_basename()) {
+			$class = $status ? 'active' : 'inactive';
+			$link_text = isset($plugins_page_row['link_text']) ? $plugins_page_row['link_text'] : '';
+			$link_url = isset($plugins_page_row['link_url']) ? $plugins_page_row['link_url'] : '';
+			$description = isset($plugins_page_row['description'])
+				? $plugins_page_row['description']
+				: '';
+			if (! empty($link_text) && ! empty($link_url) && ! empty($description)) {
+				$after_plugin_row .= '<tr id="' . sanitize_title($plugin_file) . '-ee-addon" class="' . $class . '">';
+				$after_plugin_row .= '<th class="check-column" scope="row"></th>';
+				$after_plugin_row .= '<td class="ee-addon-upsell-info-title-td plugin-title column-primary">';
+				$after_plugin_row .= '<p class="ee-addon-upsell-info-dv">
 	                <a class="ee-button" 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 $after_plugin_row;
-    }
-
-
-    /**
-     * A safe space for addons to add additional logic like setting hooks that need to be set early in the request.
-     * Child classes that have logic like that to run can override this method declaration.  This was not made abstract
-     * for back compat reasons.
-     *
-     * This will fire on the `AHEE__EE_System__load_espresso_addons__complete` hook at priority 999.
-     *
-     * It is recommended, if client code is `de-registering` an add-on, then do it on the
-     * `AHEE__EE_System__load_espresso_addons__complete` hook before priority 999 so as to ensure any code logic in this
-     * callback does not get run/set in that request.
-     *
-     * Also, keep in mind that if a registered add-on happens to be deactivated via
-     * EE_System::_deactivate_incompatible_addons() because its incompatible, any code executed in this method
-     * (including setting hooks etc) will have executed before the plugin was deactivated.  If you use
-     * `after_registration` to set any filter and/or action hooks and want to ensure they are removed on this add-on's
-     * deactivation, you can override `EE_Addon::deactivation` and unset your hooks and filters there.  Just remember
-     * to call `parent::deactivation`.
-     *
-     * @since 4.9.26
-     */
-    public function after_registration()
-    {
-        // cricket chirp... cricket chirp...
-    }
-
-    /**
-     * @return string
-     */
-    public function getPueSlug()
-    {
-        return $this->pue_slug;
-    }
-    /**
-     * @param string $pue_slug
-     */
-    public function setPueSlug($pue_slug)
-    {
-        $this->pue_slug = $pue_slug;
-    }
+				$after_plugin_row .= '</td>';
+				$after_plugin_row .= '<td class="ee-addon-upsell-info-desc-td column-description desc">';
+				$after_plugin_row .= $description;
+				$after_plugin_row .= '</td>';
+				$after_plugin_row .= '</tr>';
+			} else {
+				$after_plugin_row .= $description;
+			}
+		}
+
+		echo $after_plugin_row;
+	}
+
+
+	/**
+	 * A safe space for addons to add additional logic like setting hooks that need to be set early in the request.
+	 * Child classes that have logic like that to run can override this method declaration.  This was not made abstract
+	 * for back compat reasons.
+	 *
+	 * This will fire on the `AHEE__EE_System__load_espresso_addons__complete` hook at priority 999.
+	 *
+	 * It is recommended, if client code is `de-registering` an add-on, then do it on the
+	 * `AHEE__EE_System__load_espresso_addons__complete` hook before priority 999 so as to ensure any code logic in this
+	 * callback does not get run/set in that request.
+	 *
+	 * Also, keep in mind that if a registered add-on happens to be deactivated via
+	 * EE_System::_deactivate_incompatible_addons() because its incompatible, any code executed in this method
+	 * (including setting hooks etc) will have executed before the plugin was deactivated.  If you use
+	 * `after_registration` to set any filter and/or action hooks and want to ensure they are removed on this add-on's
+	 * deactivation, you can override `EE_Addon::deactivation` and unset your hooks and filters there.  Just remember
+	 * to call `parent::deactivation`.
+	 *
+	 * @since 4.9.26
+	 */
+	public function after_registration()
+	{
+		// cricket chirp... cricket chirp...
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getPueSlug()
+	{
+		return $this->pue_slug;
+	}
+	/**
+	 * @param string $pue_slug
+	 */
+	public function setPueSlug($pue_slug)
+	{
+		$this->pue_slug = $pue_slug;
+	}
 }

Spacing +10 added lines, -10 removed lines

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

core/services/request/sanitizers/AllowedTags.php

Indentation +224 added lines, -224 removed lines

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

core/bootstrap_espresso.php

Indentation +77 added lines, -77 removed lines

@@ -14,22 +14,22 @@ 
  */
 function espresso_load_error_handling()
 {
-    static $error_handling_loaded = false;
-    if ($error_handling_loaded) {
-        return;
-    }
-    // load debugging tools
-    if (WP_DEBUG === true && is_readable(EE_HELPERS . 'EEH_Debug_Tools.helper.php')) {
-        require_once EE_HELPERS . 'EEH_Debug_Tools.helper.php';
-        EEH_Debug_Tools::instance();
-    }
-    // load error handling
-    if (is_readable(EE_CORE . 'EE_Error.core.php')) {
-        require_once EE_CORE . 'EE_Error.core.php';
-    } else {
-        wp_die(esc_html__('The EE_Error core class could not be loaded.', 'event_espresso'));
-    }
-    $error_handling_loaded = true;
+	static $error_handling_loaded = false;
+	if ($error_handling_loaded) {
+		return;
+	}
+	// load debugging tools
+	if (WP_DEBUG === true && is_readable(EE_HELPERS . 'EEH_Debug_Tools.helper.php')) {
+		require_once EE_HELPERS . 'EEH_Debug_Tools.helper.php';
+		EEH_Debug_Tools::instance();
+	}
+	// load error handling
+	if (is_readable(EE_CORE . 'EE_Error.core.php')) {
+		require_once EE_CORE . 'EE_Error.core.php';
+	} else {
+		wp_die(esc_html__('The EE_Error core class could not be loaded.', 'event_espresso'));
+	}
+	$error_handling_loaded = true;
 }
 
 
@@ -43,19 +43,19 @@ 
  */
 function espresso_load_required($classname, $full_path_to_file)
 {
-    if (is_readable($full_path_to_file)) {
-        require_once $full_path_to_file;
-    } else {
-        throw new EE_Error(
-            sprintf(
-                esc_html__(
-                    'The %s class file could not be located or is not readable due to file permissions.',
-                    'event_espresso'
-                ),
-                $classname
-            )
-        );
-    }
+	if (is_readable($full_path_to_file)) {
+		require_once $full_path_to_file;
+	} else {
+		throw new EE_Error(
+			sprintf(
+				esc_html__(
+					'The %s class file could not be located or is not readable due to file permissions.',
+					'event_espresso'
+				),
+				$classname
+			)
+		);
+	}
 }
 
 
@@ -73,52 +73,52 @@ 
  */
 function bootstrap_espresso()
 {
-    require_once __DIR__ . '/espresso_definitions.php';
-    try {
-        espresso_load_error_handling();
-        // include WordPress shims for functions introduced in later versions of WordPress
-        espresso_load_required(
-            '',
-            EE_CORE . 'wordpress-shims.php'
-        );
-        espresso_load_required(
-            '',
-            EE_CORE . 'third-party-compatibility.php'
-        );
-        espresso_load_required(
-            'EEH_Base',
-            EE_CORE . 'helpers/EEH_Base.helper.php'
-        );
-        espresso_load_required(
-            'EEH_File',
-            EE_CORE . 'interfaces/EEHI_File.interface.php'
-        );
-        espresso_load_required(
-            'EEH_File',
-            EE_CORE . 'helpers/EEH_File.helper.php'
-        );
-        espresso_load_required(
-            'EEH_Array',
-            EE_CORE . 'helpers/EEH_Array.helper.php'
-        );
-        espresso_load_required(
-            'EE_Base',
-            EE_CORE . 'EE_Base.core.php'
-        );
-        // instantiate and configure PSR4 autoloader
-        espresso_load_required(
-            'Psr4Autoloader',
-            EE_CORE . 'Psr4Autoloader.php'
-        );
-        espresso_load_required(
-            'EE_Psr4AutoloaderInit',
-            EE_CORE . 'EE_Psr4AutoloaderInit.core.php'
-        );
-        $AutoloaderInit = new EE_Psr4AutoloaderInit();
-        $AutoloaderInit->initializeAutoloader();
-        new EventEspresso\core\services\bootstrap\BootstrapCore();
-    } catch (Exception $e) {
-        require_once EE_CORE . 'exceptions/ExceptionStackTraceDisplay.php';
-        new EventEspresso\core\exceptions\ExceptionStackTraceDisplay($e);
-    }
+	require_once __DIR__ . '/espresso_definitions.php';
+	try {
+		espresso_load_error_handling();
+		// include WordPress shims for functions introduced in later versions of WordPress
+		espresso_load_required(
+			'',
+			EE_CORE . 'wordpress-shims.php'
+		);
+		espresso_load_required(
+			'',
+			EE_CORE . 'third-party-compatibility.php'
+		);
+		espresso_load_required(
+			'EEH_Base',
+			EE_CORE . 'helpers/EEH_Base.helper.php'
+		);
+		espresso_load_required(
+			'EEH_File',
+			EE_CORE . 'interfaces/EEHI_File.interface.php'
+		);
+		espresso_load_required(
+			'EEH_File',
+			EE_CORE . 'helpers/EEH_File.helper.php'
+		);
+		espresso_load_required(
+			'EEH_Array',
+			EE_CORE . 'helpers/EEH_Array.helper.php'
+		);
+		espresso_load_required(
+			'EE_Base',
+			EE_CORE . 'EE_Base.core.php'
+		);
+		// instantiate and configure PSR4 autoloader
+		espresso_load_required(
+			'Psr4Autoloader',
+			EE_CORE . 'Psr4Autoloader.php'
+		);
+		espresso_load_required(
+			'EE_Psr4AutoloaderInit',
+			EE_CORE . 'EE_Psr4AutoloaderInit.core.php'
+		);
+		$AutoloaderInit = new EE_Psr4AutoloaderInit();
+		$AutoloaderInit->initializeAutoloader();
+		new EventEspresso\core\services\bootstrap\BootstrapCore();
+	} catch (Exception $e) {
+		require_once EE_CORE . 'exceptions/ExceptionStackTraceDisplay.php';
+		new EventEspresso\core\exceptions\ExceptionStackTraceDisplay($e);
+	}
 }

Spacing +15 added lines, -15 removed lines

@@ -19,13 +19,13 @@ 
         return;
     }
     // load debugging tools
-    if (WP_DEBUG === true && is_readable(EE_HELPERS . 'EEH_Debug_Tools.helper.php')) {
-        require_once EE_HELPERS . 'EEH_Debug_Tools.helper.php';
+    if (WP_DEBUG === true && is_readable(EE_HELPERS.'EEH_Debug_Tools.helper.php')) {
+        require_once EE_HELPERS.'EEH_Debug_Tools.helper.php';
         EEH_Debug_Tools::instance();
     }
     // load error handling
-    if (is_readable(EE_CORE . 'EE_Error.core.php')) {
-        require_once EE_CORE . 'EE_Error.core.php';
+    if (is_readable(EE_CORE.'EE_Error.core.php')) {
+        require_once EE_CORE.'EE_Error.core.php';
     } else {
         wp_die(esc_html__('The EE_Error core class could not be loaded.', 'event_espresso'));
     }
@@ -73,52 +73,52 @@ 
  */
 function bootstrap_espresso()
 {
-    require_once __DIR__ . '/espresso_definitions.php';
+    require_once __DIR__.'/espresso_definitions.php';
     try {
         espresso_load_error_handling();
         // include WordPress shims for functions introduced in later versions of WordPress
         espresso_load_required(
             '',
-            EE_CORE . 'wordpress-shims.php'
+            EE_CORE.'wordpress-shims.php'
         );
         espresso_load_required(
             '',
-            EE_CORE . 'third-party-compatibility.php'
+            EE_CORE.'third-party-compatibility.php'
         );
         espresso_load_required(
             'EEH_Base',
-            EE_CORE . 'helpers/EEH_Base.helper.php'
+            EE_CORE.'helpers/EEH_Base.helper.php'
         );
         espresso_load_required(
             'EEH_File',
-            EE_CORE . 'interfaces/EEHI_File.interface.php'
+            EE_CORE.'interfaces/EEHI_File.interface.php'
         );
         espresso_load_required(
             'EEH_File',
-            EE_CORE . 'helpers/EEH_File.helper.php'
+            EE_CORE.'helpers/EEH_File.helper.php'
         );
         espresso_load_required(
             'EEH_Array',
-            EE_CORE . 'helpers/EEH_Array.helper.php'
+            EE_CORE.'helpers/EEH_Array.helper.php'
         );
         espresso_load_required(
             'EE_Base',
-            EE_CORE . 'EE_Base.core.php'
+            EE_CORE.'EE_Base.core.php'
         );
         // instantiate and configure PSR4 autoloader
         espresso_load_required(
             'Psr4Autoloader',
-            EE_CORE . 'Psr4Autoloader.php'
+            EE_CORE.'Psr4Autoloader.php'
         );
         espresso_load_required(
             'EE_Psr4AutoloaderInit',
-            EE_CORE . 'EE_Psr4AutoloaderInit.core.php'
+            EE_CORE.'EE_Psr4AutoloaderInit.core.php'
         );
         $AutoloaderInit = new EE_Psr4AutoloaderInit();
         $AutoloaderInit->initializeAutoloader();
         new EventEspresso\core\services\bootstrap\BootstrapCore();
     } catch (Exception $e) {
-        require_once EE_CORE . 'exceptions/ExceptionStackTraceDisplay.php';
+        require_once EE_CORE.'exceptions/ExceptionStackTraceDisplay.php';
         new EventEspresso\core\exceptions\ExceptionStackTraceDisplay($e);
     }
 }

core/exceptions/ExceptionStackTraceDisplay.php

Indentation +277 added lines, -277 removed lines

@@ -20,163 +20,163 @@ 
 class ExceptionStackTraceDisplay
 {
 
-    /**
-     * @var   string
-     * @since 4.10.24.p
-     */
-    private $class_name = '';
+	/**
+	 * @var   string
+	 * @since 4.10.24.p
+	 */
+	private $class_name = '';
 
-    /**
-     * @var   string
-     * @since 4.10.24.p
-     */
-    private $error_code = '';
+	/**
+	 * @var   string
+	 * @since 4.10.24.p
+	 */
+	private $error_code = '';
 
 
-    /**
-     * @param Exception $exception
-     * @throws Exception
-     */
-    public function __construct(Exception $exception)
-    {
-        if (WP_DEBUG && ! defined('EE_TESTS_DIR')) {
-            $this->displayException($exception);
-        } else {
-            throw $exception;
-        }
-    }
+	/**
+	 * @param Exception $exception
+	 * @throws Exception
+	 */
+	public function __construct(Exception $exception)
+	{
+		if (WP_DEBUG && ! defined('EE_TESTS_DIR')) {
+			$this->displayException($exception);
+		} else {
+			throw $exception;
+		}
+	}
 
 
-    /**
-     * @access protected
-     * @param Exception $exception
-     * @throws ReflectionException
-     */
-    protected function displayException(Exception $exception)
-    {
-        // get separate user and developer messages if they exist
-        $msg = explode('||', $exception->getMessage());
-        $user_msg = $msg[0];
-        $dev_msg = isset($msg[1]) ? $msg[1] : $msg[0];
-        $msg = WP_DEBUG ? $dev_msg : $user_msg;
-        // process trace info
-        $trace_details = $this->traceDetails($exception);
-        $code          = $exception->getCode() ?: $this->error_code;
-        // add helpful developer messages if debugging is on
-        // or generic non-identifying messages for non-privileged users
-        $error_message = WP_DEBUG
-            ? $this->developerError($exception, $msg, $code, $trace_details)
-            : $this->genericError($msg, $code);
-        // start gathering output
-        $output = '
+	/**
+	 * @access protected
+	 * @param Exception $exception
+	 * @throws ReflectionException
+	 */
+	protected function displayException(Exception $exception)
+	{
+		// get separate user and developer messages if they exist
+		$msg = explode('||', $exception->getMessage());
+		$user_msg = $msg[0];
+		$dev_msg = isset($msg[1]) ? $msg[1] : $msg[0];
+		$msg = WP_DEBUG ? $dev_msg : $user_msg;
+		// process trace info
+		$trace_details = $this->traceDetails($exception);
+		$code          = $exception->getCode() ?: $this->error_code;
+		// add helpful developer messages if debugging is on
+		// or generic non-identifying messages for non-privileged users
+		$error_message = WP_DEBUG
+			? $this->developerError($exception, $msg, $code, $trace_details)
+			: $this->genericError($msg, $code);
+		// start gathering output
+		$output = '
         <div id="ee-error-message" class="error">
             ' . $error_message . '
         </div>';
-        $scripts = $this->printScripts(true);
-        if (defined('DOING_AJAX')) {
-            echo wp_json_encode(array('error' => $output . $scripts));
-            exit();
-        }
-        echo wp_kses($output . $scripts, AllowedTags::getWithScriptAndStyleTags());
-    }
+		$scripts = $this->printScripts(true);
+		if (defined('DOING_AJAX')) {
+			echo wp_json_encode(array('error' => $output . $scripts));
+			exit();
+		}
+		echo wp_kses($output . $scripts, AllowedTags::getWithScriptAndStyleTags());
+	}
 
 
-    private function genericError($msg, $code)
-    {
-        return '
+	private function genericError($msg, $code)
+	{
+		return '
         <p>
             <span class="ee-error-user-msg-spn">' . trim($msg) . '</span> &nbsp; <sup>' . $code . '</sup>
         </p>';
-    }
+	}
 
 
-    /**
-     * @param Exception $exception
-     * @param $msg
-     * @param $code
-     * @param $trace_details
-     * @return string
-     * @throws ReflectionException
-     */
-    private function developerError(Exception $exception, $msg, $code, $trace_details)
-    {
-        $time = time();
-        return '
+	/**
+	 * @param Exception $exception
+	 * @param $msg
+	 * @param $code
+	 * @param $trace_details
+	 * @return string
+	 * @throws ReflectionException
+	 */
+	private function developerError(Exception $exception, $msg, $code, $trace_details)
+	{
+		$time = time();
+		return '
         <div class="ee-error-dev-msg-dv">
             <p class="ee-error-dev-msg-pg">
                 '
-                . sprintf(
-                    esc_html__('%1$sAn %2$s was thrown!%3$s code: %4$s', 'event_espresso'),
-                    '<strong class="ee-error-dev-msg-str">',
-                    get_class($exception),
-                    '</strong>  &nbsp; <span>',
-                    $code . '</span>'
-                )
-                . '<br />
+				. sprintf(
+					esc_html__('%1$sAn %2$s was thrown!%3$s code: %4$s', 'event_espresso'),
+					'<strong class="ee-error-dev-msg-str">',
+					get_class($exception),
+					'</strong>  &nbsp; <span>',
+					$code . '</span>'
+				)
+				. '<br />
                 <span class="big-text">"' . trim($msg) . '"</span><br/>
                 <a id="display-ee-error-trace-1'
-                   . $time
-                   . '" class="display-ee-error-trace-lnk small-text" rel="ee-error-trace-1'
-                   . $time
-                   . '">
+				   . $time
+				   . '" class="display-ee-error-trace-lnk small-text" rel="ee-error-trace-1'
+				   . $time
+				   . '">
                     ' . esc_html__('click to view backtrace and class/method details', 'event_espresso') . '
                 </a><br />
                 '
-                . $exception->getFile()
-                . sprintf(
-                    esc_html__('%1$s( line no: %2$s )%3$s', 'event_espresso'),
-                    ' &nbsp; <span class="small-text lt-grey-text">',
-                    $exception->getLine(),
-                    '</span>'
-                )
-                . '
+				. $exception->getFile()
+				. sprintf(
+					esc_html__('%1$s( line no: %2$s )%3$s', 'event_espresso'),
+					' &nbsp; <span class="small-text lt-grey-text">',
+					$exception->getLine(),
+					'</span>'
+				)
+				. '
             </p>
             <div id="ee-error-trace-1'
-                   . $time
-                   . '-dv" class="ee-error-trace-dv ee-error-trace-dv--hidden">
+				   . $time
+				   . '-dv" class="ee-error-trace-dv ee-error-trace-dv--hidden">
                 '
-                   . $trace_details
-                   . $this->classDetails() . '
+				   . $trace_details
+				   . $this->classDetails() . '
             </div>
         </div>';
-    }
+	}
 
 
-    /**
-     * @throws ReflectionException
-     */
-    private function classDetails()
-    {
-        if (empty($this->class_name)) {
-            return '';
-        }
-        $a = new ReflectionClass($this->class_name);
-        return '
+	/**
+	 * @throws ReflectionException
+	 */
+	private function classDetails()
+	{
+		if (empty($this->class_name)) {
+			return '';
+		}
+		$a = new ReflectionClass($this->class_name);
+		return '
             <div style="padding:3px; margin:0 0 1em; border:1px solid #999; background:#fff; border-radius:3px;">
                 <div style="padding:1em 2em; border:1px solid #999; background:#fcfcfc;">
                     <h3>' . esc_html__('Class Details', 'event_espresso') . '</h3>
                     <pre>' . $a . '</pre>
                 </div>
             </div>';
-    }
+	}
 
-    /**
-     * @param Exception $exception
-     * @return string
-     * @throws ReflectionException
-     * @since 4.10.24.p
-     */
-    private function traceDetails(Exception $exception)
-    {
-        $trace = $exception->getTrace();
-        if (empty($trace)) {
-            return esc_html__(
-                'Sorry, but no trace information was available for this exception.',
-                'event_espresso'
-            );
-        }
+	/**
+	 * @param Exception $exception
+	 * @return string
+	 * @throws ReflectionException
+	 * @since 4.10.24.p
+	 */
+	private function traceDetails(Exception $exception)
+	{
+		$trace = $exception->getTrace();
+		if (empty($trace)) {
+			return esc_html__(
+				'Sorry, but no trace information was available for this exception.',
+				'event_espresso'
+			);
+		}
 
-        $trace_details = '
+		$trace_details = '
         <div id="ee-trace-details">
             <table>
                 <tr>
@@ -185,180 +185,180 @@ 
                     <th scope="col" class="ee-align-left" style="width:40%;">File</th>
                     <th scope="col" class="ee-align-left">
                     ' . esc_html__('Class', 'event_espresso')
-                              . '->'
-                              . esc_html__('Method( arguments )', 'event_espresso') . '
+							  . '->'
+							  . esc_html__('Method( arguments )', 'event_espresso') . '
                     </th>
                 </tr>';
-        $last_on_stack = count($trace) - 1;
-        // reverse array so that stack is in proper chronological order
-        $sorted_trace = array_reverse($trace);
-        foreach ($sorted_trace as $nmbr => $trace) {
-            $this->class_name = isset($trace['class']) ? $trace['class'] : '';
-            $file     = isset($trace['file']) ? $trace['file'] : '';
-            $type     = isset($trace['type']) ? $trace['type'] : '';
-            $function = isset($trace['function']) ? $trace['function'] : '';
-            $args     = isset($trace['args']) ? $this->_convert_args_to_string($trace['args']) : '';
-            $args     = isset($trace['args']) && count($trace['args']) > 4 ? ' <br />' . $args . '<br />' : $args;
-            $line     = isset($trace['line']) ? $trace['line'] : '';
-            if (empty($file) && ! empty($this->class_name)) {
-                $a    = new ReflectionClass($this->class_name);
-                $file = $a->getFileName();
-                if (empty($line) && ! empty($function)) {
-                    try {
-                        // if $function is a closure, this throws an exception
-                        $b    = new ReflectionMethod($this->class_name, $function);
-                        $line = $b->getStartLine();
-                    } catch (Exception $closure_exception) {
-                        $line = 'unknown';
-                    }
-                }
-            }
-            if ($nmbr === $last_on_stack) {
-                $file       = $exception->getFile() ?: $file;
-                $line       = $exception->getLine() ?: $line;
-                $this->error_code = $this->generate_error_code($file, $trace['function'], $line);
-            }
-            $file          = EEH_File::standardise_directory_separators($file);
-            $nmbr          = ! empty($nmbr) ? $nmbr : '&nbsp;';
-            $line          = ! empty($line) ? $line : '&nbsp;';
-            $file          = ! empty($file) ? $file : '&nbsp;';
-            $type          = ! empty($type) ? $type : '';
-            $function      = ! empty($function) ? $function : '';
-            $args          = ! empty($args) ? '( ' . $args . ' )' : '()';
-            $trace_details .= '
+		$last_on_stack = count($trace) - 1;
+		// reverse array so that stack is in proper chronological order
+		$sorted_trace = array_reverse($trace);
+		foreach ($sorted_trace as $nmbr => $trace) {
+			$this->class_name = isset($trace['class']) ? $trace['class'] : '';
+			$file     = isset($trace['file']) ? $trace['file'] : '';
+			$type     = isset($trace['type']) ? $trace['type'] : '';
+			$function = isset($trace['function']) ? $trace['function'] : '';
+			$args     = isset($trace['args']) ? $this->_convert_args_to_string($trace['args']) : '';
+			$args     = isset($trace['args']) && count($trace['args']) > 4 ? ' <br />' . $args . '<br />' : $args;
+			$line     = isset($trace['line']) ? $trace['line'] : '';
+			if (empty($file) && ! empty($this->class_name)) {
+				$a    = new ReflectionClass($this->class_name);
+				$file = $a->getFileName();
+				if (empty($line) && ! empty($function)) {
+					try {
+						// if $function is a closure, this throws an exception
+						$b    = new ReflectionMethod($this->class_name, $function);
+						$line = $b->getStartLine();
+					} catch (Exception $closure_exception) {
+						$line = 'unknown';
+					}
+				}
+			}
+			if ($nmbr === $last_on_stack) {
+				$file       = $exception->getFile() ?: $file;
+				$line       = $exception->getLine() ?: $line;
+				$this->error_code = $this->generate_error_code($file, $trace['function'], $line);
+			}
+			$file          = EEH_File::standardise_directory_separators($file);
+			$nmbr          = ! empty($nmbr) ? $nmbr : '&nbsp;';
+			$line          = ! empty($line) ? $line : '&nbsp;';
+			$file          = ! empty($file) ? $file : '&nbsp;';
+			$type          = ! empty($type) ? $type : '';
+			$function      = ! empty($function) ? $function : '';
+			$args          = ! empty($args) ? '( ' . $args . ' )' : '()';
+			$trace_details .= '
                 <tr>
                     <td class="ee-align-right">' . $nmbr . '</td>
                     <td class="ee-align-right">' . $line . '</td>
                     <td class="ee-align-left">' . $file . '</td>
                     <td class="ee-align-left">' . $this->class_name . $type . $function . $args . '</td>
                 </tr>';
-        }
-        $trace_details .= '
+		}
+		$trace_details .= '
             </table>
         </div>';
-        return $trace_details;
-    }
+		return $trace_details;
+	}
 
 
-    // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
-    // phpcs:disable PSR2.Methods.MethodDeclaration.Underscore
+	// phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
+	// phpcs:disable PSR2.Methods.MethodDeclaration.Underscore
 
-    /**
-     * generate string from exception trace args
-     *
-     * @param array $arguments
-     * @param int   $indent
-     * @param bool  $array
-     * @return string
-     */
-    private function _convert_args_to_string($arguments = array(), $indent = 0, $array = false)
-    {
-        $args = array();
-        $args_count = count($arguments);
-        if ($args_count > 2) {
-            $indent++;
-            $args[] = '<br />';
-        }
-        $x = 0;
-        foreach ($arguments as $arg) {
-            $x++;
-            for ($i = 0; $i < $indent; $i++) {
-                $args[] = ' &nbsp;&nbsp; ';
-            }
-            if (is_string($arg)) {
-                if (! $array && strlen($arg) > 75) {
-                    $args[] = '<br />';
-                    for ($i = 0; $i <= $indent; $i++) {
-                        $args[] = ' &nbsp;&nbsp; ';
-                    }
-                    $args[] = "'" . $arg . "'<br />";
-                } else {
-                    $args[] = " '" . $arg . "'";
-                }
-            } elseif (is_array($arg)) {
-                $arg_count = count($arg);
-                if ($arg_count > 2) {
-                    $indent++;
-                    $args[] = ' array(' . $this->_convert_args_to_string($arg, $indent, true) . ')';
-                    $indent--;
-                } elseif ($arg_count === 0) {
-                    $args[] = ' array()';
-                } else {
-                    $args[] = ' array( ' . $this->_convert_args_to_string($arg) . ' )';
-                }
-            } elseif ($arg === null) {
-                $args[] = ' null';
-            } elseif (is_bool($arg)) {
-                $args[] = $arg ? ' true' : ' false';
-            } elseif (is_object($arg)) {
-                $args[] = get_class($arg);
-            } elseif (is_resource($arg)) {
-                $args[] = get_resource_type($arg);
-            } else {
-                $args[] = $arg;
-            }
-            if ($x === $args_count) {
-                if ($args_count > 2) {
-                    $args[] = '<br />';
-                    $indent--;
-                    for ($i = 1; $i < $indent; $i++) {
-                        $args[] = ' &nbsp;&nbsp; ';
-                    }
-                }
-            } else {
-                $args[] = $args_count > 2 ? ',<br />' : ', ';
-            }
-        }
-        return implode('', $args);
-    }
+	/**
+	 * generate string from exception trace args
+	 *
+	 * @param array $arguments
+	 * @param int   $indent
+	 * @param bool  $array
+	 * @return string
+	 */
+	private function _convert_args_to_string($arguments = array(), $indent = 0, $array = false)
+	{
+		$args = array();
+		$args_count = count($arguments);
+		if ($args_count > 2) {
+			$indent++;
+			$args[] = '<br />';
+		}
+		$x = 0;
+		foreach ($arguments as $arg) {
+			$x++;
+			for ($i = 0; $i < $indent; $i++) {
+				$args[] = ' &nbsp;&nbsp; ';
+			}
+			if (is_string($arg)) {
+				if (! $array && strlen($arg) > 75) {
+					$args[] = '<br />';
+					for ($i = 0; $i <= $indent; $i++) {
+						$args[] = ' &nbsp;&nbsp; ';
+					}
+					$args[] = "'" . $arg . "'<br />";
+				} else {
+					$args[] = " '" . $arg . "'";
+				}
+			} elseif (is_array($arg)) {
+				$arg_count = count($arg);
+				if ($arg_count > 2) {
+					$indent++;
+					$args[] = ' array(' . $this->_convert_args_to_string($arg, $indent, true) . ')';
+					$indent--;
+				} elseif ($arg_count === 0) {
+					$args[] = ' array()';
+				} else {
+					$args[] = ' array( ' . $this->_convert_args_to_string($arg) . ' )';
+				}
+			} elseif ($arg === null) {
+				$args[] = ' null';
+			} elseif (is_bool($arg)) {
+				$args[] = $arg ? ' true' : ' false';
+			} elseif (is_object($arg)) {
+				$args[] = get_class($arg);
+			} elseif (is_resource($arg)) {
+				$args[] = get_resource_type($arg);
+			} else {
+				$args[] = $arg;
+			}
+			if ($x === $args_count) {
+				if ($args_count > 2) {
+					$args[] = '<br />';
+					$indent--;
+					for ($i = 1; $i < $indent; $i++) {
+						$args[] = ' &nbsp;&nbsp; ';
+					}
+				}
+			} else {
+				$args[] = $args_count > 2 ? ',<br />' : ', ';
+			}
+		}
+		return implode('', $args);
+	}
 
 
-    /**
-     * create error code from filepath, function name,
-     * and line number where exception or error was thrown
-     *
-     * @access protected
-     * @param string $file
-     * @param string $func
-     * @param string $line
-     * @return string
-     */
-    protected function generate_error_code($file = '', $func = '', $line = '')
-    {
-        $file_bits = explode('.', basename($file));
-        $error_code = ! empty($file_bits[0]) ? $file_bits[0] : '';
-        $error_code .= ! empty($func) ? ' - ' . $func : '';
-        $error_code .= ! empty($line) ? ' - ' . $line : '';
-        return $error_code;
-    }
+	/**
+	 * create error code from filepath, function name,
+	 * and line number where exception or error was thrown
+	 *
+	 * @access protected
+	 * @param string $file
+	 * @param string $func
+	 * @param string $line
+	 * @return string
+	 */
+	protected function generate_error_code($file = '', $func = '', $line = '')
+	{
+		$file_bits = explode('.', basename($file));
+		$error_code = ! empty($file_bits[0]) ? $file_bits[0] : '';
+		$error_code .= ! empty($func) ? ' - ' . $func : '';
+		$error_code .= ! empty($line) ? ' - ' . $line : '';
+		return $error_code;
+	}
 
 
-    /**
-     * _print_scripts
-     *
-     * @param bool $force_print
-     * @return string
-     */
-    private function printScripts($force_print = false)
-    {
-        if (! $force_print && (did_action('admin_enqueue_scripts') || did_action('wp_enqueue_scripts'))) {
-            //  if script is already enqueued then we can just get out
-            if (wp_script_is('ee_error_js')) {
-                return '';
-            }
-            if (wp_script_is('ee_error_js', 'registered')) {
-                wp_enqueue_style('espresso_default');
-                wp_enqueue_style('espresso_custom_css');
-                wp_enqueue_script('ee_error_js');
-                wp_localize_script('ee_error_js', 'ee_settings', array('wp_debug' => WP_DEBUG));
-                return '';
-            }
-        }
-        $jquery = includes_url() . 'js/jquery/jquery.js';
-        $core = EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js?ver=' . espresso_version();
-        $ee_error = EE_GLOBAL_ASSETS_URL . 'scripts/EE_Error.js?ver=' . espresso_version();
-        $style = EE_GLOBAL_ASSETS_URL . 'css/ee-exception-stack-display.css';
-        return '
+	/**
+	 * _print_scripts
+	 *
+	 * @param bool $force_print
+	 * @return string
+	 */
+	private function printScripts($force_print = false)
+	{
+		if (! $force_print && (did_action('admin_enqueue_scripts') || did_action('wp_enqueue_scripts'))) {
+			//  if script is already enqueued then we can just get out
+			if (wp_script_is('ee_error_js')) {
+				return '';
+			}
+			if (wp_script_is('ee_error_js', 'registered')) {
+				wp_enqueue_style('espresso_default');
+				wp_enqueue_style('espresso_custom_css');
+				wp_enqueue_script('ee_error_js');
+				wp_localize_script('ee_error_js', 'ee_settings', array('wp_debug' => WP_DEBUG));
+				return '';
+			}
+		}
+		$jquery = includes_url() . 'js/jquery/jquery.js';
+		$core = EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js?ver=' . espresso_version();
+		$ee_error = EE_GLOBAL_ASSETS_URL . 'scripts/EE_Error.js?ver=' . espresso_version();
+		$style = EE_GLOBAL_ASSETS_URL . 'css/ee-exception-stack-display.css';
+		return '
             <script>
             const ee_settings = {"wp_debug":"' . WP_DEBUG . '"};
             </script>
@@ -367,5 +367,5 @@ 
             <script src="' . esc_url_raw($ee_error) . '" type="text/javascript"></script>
             <link href="' . esc_url_raw($style) . '" rel="stylesheet" />
         ';
-    }
+	}
 }

Spacing +34 added lines, -34 removed lines

@@ -70,14 +70,14 @@ 
         // start gathering output
         $output = '
         <div id="ee-error-message" class="error">
-            ' . $error_message . '
+            ' . $error_message.'
         </div>';
         $scripts = $this->printScripts(true);
         if (defined('DOING_AJAX')) {
-            echo wp_json_encode(array('error' => $output . $scripts));
+            echo wp_json_encode(array('error' => $output.$scripts));
             exit();
         }
-        echo wp_kses($output . $scripts, AllowedTags::getWithScriptAndStyleTags());
+        echo wp_kses($output.$scripts, AllowedTags::getWithScriptAndStyleTags());
     }
 
 
@@ -85,7 +85,7 @@ 
     {
         return '
         <p>
-            <span class="ee-error-user-msg-spn">' . trim($msg) . '</span> &nbsp; <sup>' . $code . '</sup>
+            <span class="ee-error-user-msg-spn">' . trim($msg).'</span> &nbsp; <sup>'.$code.'</sup>
         </p>';
     }
 
@@ -110,16 +110,16 @@ 
                     '<strong class="ee-error-dev-msg-str">',
                     get_class($exception),
                     '</strong>  &nbsp; <span>',
-                    $code . '</span>'
+                    $code.'</span>'
                 )
                 . '<br />
-                <span class="big-text">"' . trim($msg) . '"</span><br/>
+                <span class="big-text">"' . trim($msg).'"</span><br/>
                 <a id="display-ee-error-trace-1'
                    . $time
                    . '" class="display-ee-error-trace-lnk small-text" rel="ee-error-trace-1'
                    . $time
                    . '">
-                    ' . esc_html__('click to view backtrace and class/method details', 'event_espresso') . '
+                    ' . esc_html__('click to view backtrace and class/method details', 'event_espresso').'
                 </a><br />
                 '
                 . $exception->getFile()
@@ -136,7 +136,7 @@ 
                    . '-dv" class="ee-error-trace-dv ee-error-trace-dv--hidden">
                 '
                    . $trace_details
-                   . $this->classDetails() . '
+                   . $this->classDetails().'
             </div>
         </div>';
     }
@@ -154,8 +154,8 @@ 
         return '
             <div style="padding:3px; margin:0 0 1em; border:1px solid #999; background:#fff; border-radius:3px;">
                 <div style="padding:1em 2em; border:1px solid #999; background:#fcfcfc;">
-                    <h3>' . esc_html__('Class Details', 'event_espresso') . '</h3>
-                    <pre>' . $a . '</pre>
+                    <h3>' . esc_html__('Class Details', 'event_espresso').'</h3>
+                    <pre>' . $a.'</pre>
                 </div>
             </div>';
     }
@@ -186,7 +186,7 @@ 
                     <th scope="col" class="ee-align-left">
                     ' . esc_html__('Class', 'event_espresso')
                               . '->'
-                              . esc_html__('Method( arguments )', 'event_espresso') . '
+                              . esc_html__('Method( arguments )', 'event_espresso').'
                     </th>
                 </tr>';
         $last_on_stack = count($trace) - 1;
@@ -198,7 +198,7 @@ 
             $type     = isset($trace['type']) ? $trace['type'] : '';
             $function = isset($trace['function']) ? $trace['function'] : '';
             $args     = isset($trace['args']) ? $this->_convert_args_to_string($trace['args']) : '';
-            $args     = isset($trace['args']) && count($trace['args']) > 4 ? ' <br />' . $args . '<br />' : $args;
+            $args     = isset($trace['args']) && count($trace['args']) > 4 ? ' <br />'.$args.'<br />' : $args;
             $line     = isset($trace['line']) ? $trace['line'] : '';
             if (empty($file) && ! empty($this->class_name)) {
                 $a    = new ReflectionClass($this->class_name);
@@ -224,13 +224,13 @@ 
             $file          = ! empty($file) ? $file : '&nbsp;';
             $type          = ! empty($type) ? $type : '';
             $function      = ! empty($function) ? $function : '';
-            $args          = ! empty($args) ? '( ' . $args . ' )' : '()';
+            $args          = ! empty($args) ? '( '.$args.' )' : '()';
             $trace_details .= '
                 <tr>
-                    <td class="ee-align-right">' . $nmbr . '</td>
-                    <td class="ee-align-right">' . $line . '</td>
-                    <td class="ee-align-left">' . $file . '</td>
-                    <td class="ee-align-left">' . $this->class_name . $type . $function . $args . '</td>
+                    <td class="ee-align-right">' . $nmbr.'</td>
+                    <td class="ee-align-right">' . $line.'</td>
+                    <td class="ee-align-left">' . $file.'</td>
+                    <td class="ee-align-left">' . $this->class_name.$type.$function.$args.'</td>
                 </tr>';
         }
         $trace_details .= '
@@ -266,25 +266,25 @@ 
                 $args[] = ' &nbsp;&nbsp; ';
             }
             if (is_string($arg)) {
-                if (! $array && strlen($arg) > 75) {
+                if ( ! $array && strlen($arg) > 75) {
                     $args[] = '<br />';
                     for ($i = 0; $i <= $indent; $i++) {
                         $args[] = ' &nbsp;&nbsp; ';
                     }
-                    $args[] = "'" . $arg . "'<br />";
+                    $args[] = "'".$arg."'<br />";
                 } else {
-                    $args[] = " '" . $arg . "'";
+                    $args[] = " '".$arg."'";
                 }
             } elseif (is_array($arg)) {
                 $arg_count = count($arg);
                 if ($arg_count > 2) {
                     $indent++;
-                    $args[] = ' array(' . $this->_convert_args_to_string($arg, $indent, true) . ')';
+                    $args[] = ' array('.$this->_convert_args_to_string($arg, $indent, true).')';
                     $indent--;
                 } elseif ($arg_count === 0) {
                     $args[] = ' array()';
                 } else {
-                    $args[] = ' array( ' . $this->_convert_args_to_string($arg) . ' )';
+                    $args[] = ' array( '.$this->_convert_args_to_string($arg).' )';
                 }
             } elseif ($arg === null) {
                 $args[] = ' null';
@@ -327,8 +327,8 @@ 
     {
         $file_bits = explode('.', basename($file));
         $error_code = ! empty($file_bits[0]) ? $file_bits[0] : '';
-        $error_code .= ! empty($func) ? ' - ' . $func : '';
-        $error_code .= ! empty($line) ? ' - ' . $line : '';
+        $error_code .= ! empty($func) ? ' - '.$func : '';
+        $error_code .= ! empty($line) ? ' - '.$line : '';
         return $error_code;
     }
 
@@ -341,7 +341,7 @@ 
      */
     private function printScripts($force_print = false)
     {
-        if (! $force_print && (did_action('admin_enqueue_scripts') || did_action('wp_enqueue_scripts'))) {
+        if ( ! $force_print && (did_action('admin_enqueue_scripts') || did_action('wp_enqueue_scripts'))) {
             //  if script is already enqueued then we can just get out
             if (wp_script_is('ee_error_js')) {
                 return '';
@@ -354,18 +354,18 @@ 
                 return '';
             }
         }
-        $jquery = includes_url() . 'js/jquery/jquery.js';
-        $core = EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js?ver=' . espresso_version();
-        $ee_error = EE_GLOBAL_ASSETS_URL . 'scripts/EE_Error.js?ver=' . espresso_version();
-        $style = EE_GLOBAL_ASSETS_URL . 'css/ee-exception-stack-display.css';
+        $jquery = includes_url().'js/jquery/jquery.js';
+        $core = EE_GLOBAL_ASSETS_URL.'scripts/espresso_core.js?ver='.espresso_version();
+        $ee_error = EE_GLOBAL_ASSETS_URL.'scripts/EE_Error.js?ver='.espresso_version();
+        $style = EE_GLOBAL_ASSETS_URL.'css/ee-exception-stack-display.css';
         return '
             <script>
-            const ee_settings = {"wp_debug":"' . WP_DEBUG . '"};
+            const ee_settings = {"wp_debug":"' . WP_DEBUG.'"};
             </script>
-            <script src="' . esc_url_raw($jquery) . '" type="text/javascript"></script>
-            <script src="' . esc_url_raw($core) . '" type="text/javascript"></script>
-            <script src="' . esc_url_raw($ee_error) . '" type="text/javascript"></script>
-            <link href="' . esc_url_raw($style) . '" rel="stylesheet" />
+            <script src="' . esc_url_raw($jquery).'" type="text/javascript"></script>
+            <script src="' . esc_url_raw($core).'" type="text/javascript"></script>
+            <script src="' . esc_url_raw($ee_error).'" type="text/javascript"></script>
+            <link href="' . esc_url_raw($style).'" rel="stylesheet" />
         ';
     }
 }

espresso.php

Indentation +80 added lines, -80 removed lines

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

core/EE_Front_Controller.core.php

Indentation +509 added lines, -509 removed lines

@@ -18,513 +18,513 @@
 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_print_footer_scripts', array($this, 'enqueueScripts'), 10);
-        }
-    }
-
-
-    /**
-     * 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() === 'espresso_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');
-    }
-
-
-    /**
-     * display_errors
-     *
-     * @access public
-     * @return void
-     * @throws DomainException
-     */
-    public function display_errors()
-    {
-        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 $this->printNotices();
-            } 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 string $template_include_path
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function template_include($template_include_path = null)
-    {
-        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(
-                    $template_include_path
-                );
-            $template_path = EEH_Template::locate_template($this->_template_path, array(), 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_print_footer_scripts', array($this, 'enqueueScripts'), 10);
+		}
+	}
+
+
+	/**
+	 * 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() === 'espresso_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');
+	}
+
+
+	/**
+	 * display_errors
+	 *
+	 * @access public
+	 * @return void
+	 * @throws DomainException
+	 */
+	public function display_errors()
+	{
+		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 $this->printNotices();
+			} 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 string $template_include_path
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function template_include($template_include_path = null)
+	{
+		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(
+					$template_include_path
+				);
+			$template_path = EEH_Template::locate_template($this->_template_path, array(), 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()
+	{
+	}
 }