eventespresso / event-espresso-core

core/domain/values/TimeFormat.php

Indentation +27 added lines, -27 removed lines

@@ -4,33 +4,33 @@
 
 class TimeFormat extends BaseFormat
 {
-    protected const DEFAULT_FORMAT = 'H:i:s';
-    protected const WORDPRESS_FORMAT_OPTION_NAME = 'time_format';
+	protected const DEFAULT_FORMAT = 'H:i:s';
+	protected const WORDPRESS_FORMAT_OPTION_NAME = 'time_format';
 
-    protected static array $allowed_chars  = [
-        'a',
-        'A',
-        'B',
-        'g',
-        'G',
-        'h',
-        'H',
-        'i',
-        's',
-        'u',
-        'v',
-        'e',
-        'I',
-        'O',
-        'P',
-        'T',
-        'Z',
-        ':',
-        '-',
-        ',',
-        '.',
-        ' ',
-    ];
+	protected static array $allowed_chars  = [
+		'a',
+		'A',
+		'B',
+		'g',
+		'G',
+		'h',
+		'H',
+		'i',
+		's',
+		'u',
+		'v',
+		'e',
+		'I',
+		'O',
+		'P',
+		'T',
+		'Z',
+		':',
+		'-',
+		',',
+		'.',
+		' ',
+	];
 
-    protected static ?string $wordpress_format = null;
+	protected static ?string $wordpress_format = null;
 }

Spacing +1 added lines, -1 removed lines

@@ -7,7 +7,7 @@
     protected const DEFAULT_FORMAT = 'H:i:s';
     protected const WORDPRESS_FORMAT_OPTION_NAME = 'time_format';
 
-    protected static array $allowed_chars  = [
+    protected static array $allowed_chars = [
         'a',
         'A',
         'B',

core/domain/entities/routing/handlers/admin/EspressoBatchJob.php

Indentation +38 added lines, -38 removed lines

@@ -17,46 +17,46 @@
  */
 class EspressoBatchJob extends AdminRoute
 {
-    /**
-     * returns true if the current request matches this route
-     *
-     * @return bool
-     * @since   5.0.0.p
-     */
-    public function matchesCurrentRequest(): bool
-    {
-        global $pagenow;
-        $page = $this->request->getRequestParam('page');
-        return ($pagenow === 'admin.php' || $pagenow === 'admin-ajax.php')
-               && $page === 'espresso_batch'
-               && parent::matchesCurrentRequest();
-    }
+	/**
+	 * returns true if the current request matches this route
+	 *
+	 * @return bool
+	 * @since   5.0.0.p
+	 */
+	public function matchesCurrentRequest(): bool
+	{
+		global $pagenow;
+		$page = $this->request->getRequestParam('page');
+		return ($pagenow === 'admin.php' || $pagenow === 'admin-ajax.php')
+			   && $page === 'espresso_batch'
+			   && parent::matchesCurrentRequest();
+	}
 
 
-    /**
-     * @since 5.0.0.p
-     */
-    protected function registerDependencies()
-    {
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\domain\services\admin\registrations\list_table\QueryBuilder',
-            [
-                'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
-                'EEM_Registration'                            => EE_Dependency_Map::load_from_cache,
-                null,
-            ]
-        );
-    }
+	/**
+	 * @since 5.0.0.p
+	 */
+	protected function registerDependencies()
+	{
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\domain\services\admin\registrations\list_table\QueryBuilder',
+			[
+				'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
+				'EEM_Registration'                            => EE_Dependency_Map::load_from_cache,
+				null,
+			]
+		);
+	}
 
 
-    /**
-     * implements logic required to run during request
-     *
-     * @return bool
-     * @since   5.0.0.p
-     */
-    protected function requestHandler(): bool
-    {
-        return true;
-    }
+	/**
+	 * implements logic required to run during request
+	 *
+	 * @return bool
+	 * @since   5.0.0.p
+	 */
+	protected function requestHandler(): bool
+	{
+		return true;
+	}
 }

core/domain/entities/users/CurrentUser.php

Indentation +71 added lines, -71 removed lines

@@ -13,75 +13,75 @@
  */
 class CurrentUser
 {
-    private EventManagers $event_managers;
-
-    private ?WP_User $current_user     = null;
-
-    private bool $is_event_manager = false;
-
-    private bool $is_logged_in     = false;
-
-    private bool $is_super_admin   = false;
-
-
-    /**
-     * CurrentUser constructor.
-     *
-     * @param EventManagers $event_managers
-     */
-    public function __construct(EventManagers $event_managers)
-    {
-        $this->event_managers = $event_managers;
-        $this->setCurrentUser();
-    }
-
-
-    public function setCurrentUser(): void
-    {
-        if (! $this->current_user instanceof WP_User) {
-            $this->current_user     = wp_get_current_user();
-            $event_manager_roles    = array_keys($this->event_managers->roles());
-            $current_user_roles     = $this->current_user->roles;
-            $this->is_event_manager = ! empty(array_intersect($event_manager_roles, $current_user_roles));
-            $this->is_super_admin   = is_super_admin($this->current_user->ID);
-            $this->is_logged_in     = $this->current_user->exists();
-        }
-    }
-
-
-    /**
-     * @return WP_User
-     */
-    public function currentUser(): ?WP_User
-    {
-        return $this->current_user;
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isEventManager(): bool
-    {
-        return $this->is_event_manager;
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isLoggedIn(): bool
-    {
-        return $this->is_logged_in;
-    }
-
-
-    /**
-     * @return bool
-     * @since 5.0.8.p
-     */
-    public function isSuperAdmin(): bool
-    {
-        return $this->is_super_admin;
-    }
+	private EventManagers $event_managers;
+
+	private ?WP_User $current_user     = null;
+
+	private bool $is_event_manager = false;
+
+	private bool $is_logged_in     = false;
+
+	private bool $is_super_admin   = false;
+
+
+	/**
+	 * CurrentUser constructor.
+	 *
+	 * @param EventManagers $event_managers
+	 */
+	public function __construct(EventManagers $event_managers)
+	{
+		$this->event_managers = $event_managers;
+		$this->setCurrentUser();
+	}
+
+
+	public function setCurrentUser(): void
+	{
+		if (! $this->current_user instanceof WP_User) {
+			$this->current_user     = wp_get_current_user();
+			$event_manager_roles    = array_keys($this->event_managers->roles());
+			$current_user_roles     = $this->current_user->roles;
+			$this->is_event_manager = ! empty(array_intersect($event_manager_roles, $current_user_roles));
+			$this->is_super_admin   = is_super_admin($this->current_user->ID);
+			$this->is_logged_in     = $this->current_user->exists();
+		}
+	}
+
+
+	/**
+	 * @return WP_User
+	 */
+	public function currentUser(): ?WP_User
+	{
+		return $this->current_user;
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isEventManager(): bool
+	{
+		return $this->is_event_manager;
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isLoggedIn(): bool
+	{
+		return $this->is_logged_in;
+	}
+
+
+	/**
+	 * @return bool
+	 * @since 5.0.8.p
+	 */
+	public function isSuperAdmin(): bool
+	{
+		return $this->is_super_admin;
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -15,7 +15,7 @@ 
 {
     private EventManagers $event_managers;
 
-    private ?WP_User $current_user     = null;
+    private ?WP_User $current_user = null;
 
     private bool $is_event_manager = false;
 
@@ -38,7 +38,7 @@ 
 
     public function setCurrentUser(): void
     {
-        if (! $this->current_user instanceof WP_User) {
+        if ( ! $this->current_user instanceof WP_User) {
             $this->current_user     = wp_get_current_user();
             $event_manager_roles    = array_keys($this->event_managers->roles());
             $current_user_roles     = $this->current_user->roles;

core/domain/entities/config/legacy/EE_Core_Config.php

Indentation +273 added lines, -273 removed lines

@@ -5,277 +5,277 @@
  */
 class EE_Core_Config extends EE_Config_Base
 {
-    const OPTION_NAME_UXIP = 'ee_ueip_optin';
-
-
-    public int $current_blog_id = 1;
-
-    public $ee_ueip_optin;
-
-    public $ee_ueip_has_notified;
-
-    /**
-     * Not to be confused with the 4 critical page variables (See
-     * get_critical_pages_array()), this is just an array of wp posts that have EE
-     * shortcodes in them. Keys are slugs, values are arrays with only 1 element: where the key is the shortcode
-     * in the page, and the value is the page's ID. The key 'posts' is basically a duplicate of this same array.
-     *
-     * @var array
-     */
-    public array $post_shortcodes = [];
-
-    public array $module_route_map = [];
-
-    public array $module_forward_map = [];
-
-    public array $module_view_map = [];
-
-    /**
-     * The next 4 vars are the IDs of critical EE pages.
-     *
-     * @var int
-     */
-    public int $reg_page_id = 0;
-
-    public int $txn_page_id = 0;
-
-    public int $thank_you_page_id = 0;
-
-    public int $cancel_page_id = 0;
-
-    /**
-     * The next 4 vars are the URLs of critical EE pages.
-     *
-     * @var string
-     */
-    public string $reg_page_url = '';
-
-    public string $txn_page_url = '';
-
-    public string $thank_you_page_url = '';
-
-    public string $cancel_page_url = '';
-
-    /**
-     * The next vars relate to the custom slugs for EE CPT routes
-     */
-    public string $event_cpt_slug;
-
-    /**
-     * This caches the _ee_ueip_option in case this config is reset in the same
-     * request across blog switches in a multisite context.
-     * Avoids extra queries to the db for this option.
-     *
-     * @var bool|null
-     */
-    public static $ee_ueip_option = null;
-
-
-    public function __construct()
-    {
-        // set default organization settings
-        $this->current_blog_id      = get_current_blog_id() ?: 1;
-        $this->ee_ueip_optin        = $this->_get_main_ee_ueip_optin();
-        $this->ee_ueip_has_notified = is_main_site() ? get_option('ee_ueip_has_notified', false) : true;
-        // cpt slugs
-        $this->event_cpt_slug = esc_html__('events', 'event_espresso');
-        // ueip constant check
-        if (defined('EE_DISABLE_UXIP') && EE_DISABLE_UXIP) {
-            $this->ee_ueip_optin        = false;
-            $this->ee_ueip_has_notified = true;
-        }
-    }
-
-
-    /**
-     * @return array
-     */
-    public function get_critical_pages_array(): array
-    {
-        return [
-            $this->reg_page_id,
-            $this->txn_page_id,
-            $this->thank_you_page_id,
-            $this->cancel_page_id,
-        ];
-    }
-
-
-    /**
-     * @return array
-     */
-    public function get_critical_pages_shortcodes_array(): array
-    {
-        return [
-            $this->reg_page_id       => 'ESPRESSO_CHECKOUT',
-            $this->txn_page_id       => 'ESPRESSO_TXN_PAGE',
-            $this->thank_you_page_id => 'ESPRESSO_THANK_YOU',
-            $this->cancel_page_id    => 'ESPRESSO_CANCELLED',
-        ];
-    }
-
-
-    /**
-     *  gets/returns URL for EE reg_page
-     *
-     * @return string
-     */
-    public function reg_page_url(): string
-    {
-        if (! $this->reg_page_url) {
-            $this->reg_page_url = add_query_arg(
-                ['uts' => time()],
-                get_permalink($this->reg_page_id)
-            ) . '#checkout';
-        }
-        return $this->reg_page_url;
-    }
-
-
-    /**
-     *  gets/returns URL for EE txn_page
-     *
-     * @param array $query_args like what gets passed to add_query_arg() as the first argument
-     * @return string
-     */
-    public function txn_page_url(array $query_args = []): string
-    {
-        if (! $this->txn_page_url) {
-            $this->txn_page_url = get_permalink($this->txn_page_id);
-        }
-        if ($query_args) {
-            return add_query_arg($query_args, $this->txn_page_url);
-        }
-        return $this->txn_page_url;
-    }
-
-
-    /**
-     *  gets/returns URL for EE thank_you_page
-     *
-     * @param array $query_args like what gets passed to
-     *                          add_query_arg() as the first argument
-     * @return string
-     */
-    public function thank_you_page_url(array $query_args = []): string
-    {
-        if (! $this->thank_you_page_url) {
-            $this->thank_you_page_url = get_permalink($this->thank_you_page_id);
-        }
-        if ($query_args) {
-            return add_query_arg($query_args, $this->thank_you_page_url);
-        }
-        return $this->thank_you_page_url;
-    }
-
-
-    /**
-     *  gets/returns URL for EE cancel_page
-     *
-     * @return string
-     */
-    public function cancel_page_url(): string
-    {
-        if (! $this->cancel_page_url) {
-            $this->cancel_page_url = get_permalink($this->cancel_page_id);
-        }
-        return $this->cancel_page_url;
-    }
-
-
-    /**
-     * Resets all critical page urls to their original state.  Used primarily by the __sleep() magic method currently.
-     *
-     * @since 4.7.5
-     */
-    protected function _reset_urls()
-    {
-        $this->reg_page_url       = '';
-        $this->txn_page_url       = '';
-        $this->cancel_page_url    = '';
-        $this->thank_you_page_url = '';
-    }
-
-
-    /**
-     * Used to return what the optin value is set for the EE User Experience Program.
-     * This accounts for multisite and this value being requested for a subsite.  In multisite, the value is set
-     * on the main site only.
-     *
-     * @return bool
-     */
-    protected function _get_main_ee_ueip_optin()
-    {
-        // if this is the main site then we can just bypass our direct query.
-        if (is_main_site()) {
-            return get_option(self::OPTION_NAME_UXIP, false);
-        }
-        // is this already cached for this request?  If so use it.
-        if (EE_Core_Config::$ee_ueip_option !== null) {
-            return EE_Core_Config::$ee_ueip_option;
-        }
-        global $wpdb;
-        $current_network_main_site = is_multisite() ? get_current_site() : null;
-        $current_main_site_id      = $current_network_main_site instanceof WP_Network
-            ? $current_network_main_site->blog_id
-            : 1;
-        $option                    = self::OPTION_NAME_UXIP;
-        // set correct table for query
-        $table_name = $wpdb->get_blog_prefix($current_main_site_id) . 'options';
-        // rather than getting blog option for the $current_main_site_id, we do a direct $wpdb query because
-        // get_blog_option() does a switch_to_blog and that could cause infinite recursion because EE_Core_Config might be
-        // re-constructed on the blog switch.  Note, we are still executing any core wp filters on this option retrieval.
-        // this bit of code is basically a direct copy of get_option without any caching because we are NOT switched to the blog
-        // for the purpose of caching.
-        $pre = apply_filters('pre_option_' . $option, false, $option);
-        if ($pre !== false) {
-            EE_Core_Config::$ee_ueip_option = $pre;
-            return EE_Core_Config::$ee_ueip_option;
-        }
-        $row = $wpdb->get_row(
-            $wpdb->prepare(
-                "SELECT option_value FROM $table_name WHERE option_name = %s LIMIT 1",
-                $option
-            )
-        );
-        if (is_object($row)) {
-            $value = $row->option_value;
-        } else { // option does not exist so use default.
-            EE_Core_Config::$ee_ueip_option = apply_filters('default_option_' . $option, false, $option);
-            return EE_Core_Config::$ee_ueip_option;
-        }
-        EE_Core_Config::$ee_ueip_option = apply_filters('option_' . $option, maybe_unserialize($value), $option);
-        return EE_Core_Config::$ee_ueip_option;
-    }
-
-
-    /**
-     * Utility function for escaping the value of a property and returning.
-     *
-     * @param string $property property name (checks to see if exists).
-     * @return mixed if a detected type found return the escaped value, otherwise just the raw value is returned.
-     * @throws EE_Error
-     */
-    public function get_pretty(string $property)
-    {
-        if ($property === self::OPTION_NAME_UXIP) {
-            return $this->ee_ueip_optin ? 'yes' : 'no';
-        }
-        return parent::get_pretty($property);
-    }
-
-
-    /**
-     * Currently used to ensure critical page urls have initial values saved to the db instead of any current set values
-     * on the object.
-     *
-     * @return array
-     */
-    public function __sleep()
-    {
-        // reset all url properties
-        $this->_reset_urls();
-        // return what to save to db
-        return array_keys(get_object_vars($this));
-    }
+	const OPTION_NAME_UXIP = 'ee_ueip_optin';
+
+
+	public int $current_blog_id = 1;
+
+	public $ee_ueip_optin;
+
+	public $ee_ueip_has_notified;
+
+	/**
+	 * Not to be confused with the 4 critical page variables (See
+	 * get_critical_pages_array()), this is just an array of wp posts that have EE
+	 * shortcodes in them. Keys are slugs, values are arrays with only 1 element: where the key is the shortcode
+	 * in the page, and the value is the page's ID. The key 'posts' is basically a duplicate of this same array.
+	 *
+	 * @var array
+	 */
+	public array $post_shortcodes = [];
+
+	public array $module_route_map = [];
+
+	public array $module_forward_map = [];
+
+	public array $module_view_map = [];
+
+	/**
+	 * The next 4 vars are the IDs of critical EE pages.
+	 *
+	 * @var int
+	 */
+	public int $reg_page_id = 0;
+
+	public int $txn_page_id = 0;
+
+	public int $thank_you_page_id = 0;
+
+	public int $cancel_page_id = 0;
+
+	/**
+	 * The next 4 vars are the URLs of critical EE pages.
+	 *
+	 * @var string
+	 */
+	public string $reg_page_url = '';
+
+	public string $txn_page_url = '';
+
+	public string $thank_you_page_url = '';
+
+	public string $cancel_page_url = '';
+
+	/**
+	 * The next vars relate to the custom slugs for EE CPT routes
+	 */
+	public string $event_cpt_slug;
+
+	/**
+	 * This caches the _ee_ueip_option in case this config is reset in the same
+	 * request across blog switches in a multisite context.
+	 * Avoids extra queries to the db for this option.
+	 *
+	 * @var bool|null
+	 */
+	public static $ee_ueip_option = null;
+
+
+	public function __construct()
+	{
+		// set default organization settings
+		$this->current_blog_id      = get_current_blog_id() ?: 1;
+		$this->ee_ueip_optin        = $this->_get_main_ee_ueip_optin();
+		$this->ee_ueip_has_notified = is_main_site() ? get_option('ee_ueip_has_notified', false) : true;
+		// cpt slugs
+		$this->event_cpt_slug = esc_html__('events', 'event_espresso');
+		// ueip constant check
+		if (defined('EE_DISABLE_UXIP') && EE_DISABLE_UXIP) {
+			$this->ee_ueip_optin        = false;
+			$this->ee_ueip_has_notified = true;
+		}
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function get_critical_pages_array(): array
+	{
+		return [
+			$this->reg_page_id,
+			$this->txn_page_id,
+			$this->thank_you_page_id,
+			$this->cancel_page_id,
+		];
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function get_critical_pages_shortcodes_array(): array
+	{
+		return [
+			$this->reg_page_id       => 'ESPRESSO_CHECKOUT',
+			$this->txn_page_id       => 'ESPRESSO_TXN_PAGE',
+			$this->thank_you_page_id => 'ESPRESSO_THANK_YOU',
+			$this->cancel_page_id    => 'ESPRESSO_CANCELLED',
+		];
+	}
+
+
+	/**
+	 *  gets/returns URL for EE reg_page
+	 *
+	 * @return string
+	 */
+	public function reg_page_url(): string
+	{
+		if (! $this->reg_page_url) {
+			$this->reg_page_url = add_query_arg(
+				['uts' => time()],
+				get_permalink($this->reg_page_id)
+			) . '#checkout';
+		}
+		return $this->reg_page_url;
+	}
+
+
+	/**
+	 *  gets/returns URL for EE txn_page
+	 *
+	 * @param array $query_args like what gets passed to add_query_arg() as the first argument
+	 * @return string
+	 */
+	public function txn_page_url(array $query_args = []): string
+	{
+		if (! $this->txn_page_url) {
+			$this->txn_page_url = get_permalink($this->txn_page_id);
+		}
+		if ($query_args) {
+			return add_query_arg($query_args, $this->txn_page_url);
+		}
+		return $this->txn_page_url;
+	}
+
+
+	/**
+	 *  gets/returns URL for EE thank_you_page
+	 *
+	 * @param array $query_args like what gets passed to
+	 *                          add_query_arg() as the first argument
+	 * @return string
+	 */
+	public function thank_you_page_url(array $query_args = []): string
+	{
+		if (! $this->thank_you_page_url) {
+			$this->thank_you_page_url = get_permalink($this->thank_you_page_id);
+		}
+		if ($query_args) {
+			return add_query_arg($query_args, $this->thank_you_page_url);
+		}
+		return $this->thank_you_page_url;
+	}
+
+
+	/**
+	 *  gets/returns URL for EE cancel_page
+	 *
+	 * @return string
+	 */
+	public function cancel_page_url(): string
+	{
+		if (! $this->cancel_page_url) {
+			$this->cancel_page_url = get_permalink($this->cancel_page_id);
+		}
+		return $this->cancel_page_url;
+	}
+
+
+	/**
+	 * Resets all critical page urls to their original state.  Used primarily by the __sleep() magic method currently.
+	 *
+	 * @since 4.7.5
+	 */
+	protected function _reset_urls()
+	{
+		$this->reg_page_url       = '';
+		$this->txn_page_url       = '';
+		$this->cancel_page_url    = '';
+		$this->thank_you_page_url = '';
+	}
+
+
+	/**
+	 * Used to return what the optin value is set for the EE User Experience Program.
+	 * This accounts for multisite and this value being requested for a subsite.  In multisite, the value is set
+	 * on the main site only.
+	 *
+	 * @return bool
+	 */
+	protected function _get_main_ee_ueip_optin()
+	{
+		// if this is the main site then we can just bypass our direct query.
+		if (is_main_site()) {
+			return get_option(self::OPTION_NAME_UXIP, false);
+		}
+		// is this already cached for this request?  If so use it.
+		if (EE_Core_Config::$ee_ueip_option !== null) {
+			return EE_Core_Config::$ee_ueip_option;
+		}
+		global $wpdb;
+		$current_network_main_site = is_multisite() ? get_current_site() : null;
+		$current_main_site_id      = $current_network_main_site instanceof WP_Network
+			? $current_network_main_site->blog_id
+			: 1;
+		$option                    = self::OPTION_NAME_UXIP;
+		// set correct table for query
+		$table_name = $wpdb->get_blog_prefix($current_main_site_id) . 'options';
+		// rather than getting blog option for the $current_main_site_id, we do a direct $wpdb query because
+		// get_blog_option() does a switch_to_blog and that could cause infinite recursion because EE_Core_Config might be
+		// re-constructed on the blog switch.  Note, we are still executing any core wp filters on this option retrieval.
+		// this bit of code is basically a direct copy of get_option without any caching because we are NOT switched to the blog
+		// for the purpose of caching.
+		$pre = apply_filters('pre_option_' . $option, false, $option);
+		if ($pre !== false) {
+			EE_Core_Config::$ee_ueip_option = $pre;
+			return EE_Core_Config::$ee_ueip_option;
+		}
+		$row = $wpdb->get_row(
+			$wpdb->prepare(
+				"SELECT option_value FROM $table_name WHERE option_name = %s LIMIT 1",
+				$option
+			)
+		);
+		if (is_object($row)) {
+			$value = $row->option_value;
+		} else { // option does not exist so use default.
+			EE_Core_Config::$ee_ueip_option = apply_filters('default_option_' . $option, false, $option);
+			return EE_Core_Config::$ee_ueip_option;
+		}
+		EE_Core_Config::$ee_ueip_option = apply_filters('option_' . $option, maybe_unserialize($value), $option);
+		return EE_Core_Config::$ee_ueip_option;
+	}
+
+
+	/**
+	 * Utility function for escaping the value of a property and returning.
+	 *
+	 * @param string $property property name (checks to see if exists).
+	 * @return mixed if a detected type found return the escaped value, otherwise just the raw value is returned.
+	 * @throws EE_Error
+	 */
+	public function get_pretty(string $property)
+	{
+		if ($property === self::OPTION_NAME_UXIP) {
+			return $this->ee_ueip_optin ? 'yes' : 'no';
+		}
+		return parent::get_pretty($property);
+	}
+
+
+	/**
+	 * Currently used to ensure critical page urls have initial values saved to the db instead of any current set values
+	 * on the object.
+	 *
+	 * @return array
+	 */
+	public function __sleep()
+	{
+		// reset all url properties
+		$this->_reset_urls();
+		// return what to save to db
+		return array_keys(get_object_vars($this));
+	}
 }

Spacing +9 added lines, -9 removed lines

@@ -122,11 +122,11 @@ 
      */
     public function reg_page_url(): string
     {
-        if (! $this->reg_page_url) {
+        if ( ! $this->reg_page_url) {
             $this->reg_page_url = add_query_arg(
                 ['uts' => time()],
                 get_permalink($this->reg_page_id)
-            ) . '#checkout';
+            ).'#checkout';
         }
         return $this->reg_page_url;
     }
@@ -140,7 +140,7 @@ 
      */
     public function txn_page_url(array $query_args = []): string
     {
-        if (! $this->txn_page_url) {
+        if ( ! $this->txn_page_url) {
             $this->txn_page_url = get_permalink($this->txn_page_id);
         }
         if ($query_args) {
@@ -159,7 +159,7 @@ 
      */
     public function thank_you_page_url(array $query_args = []): string
     {
-        if (! $this->thank_you_page_url) {
+        if ( ! $this->thank_you_page_url) {
             $this->thank_you_page_url = get_permalink($this->thank_you_page_id);
         }
         if ($query_args) {
@@ -176,7 +176,7 @@ 
      */
     public function cancel_page_url(): string
     {
-        if (! $this->cancel_page_url) {
+        if ( ! $this->cancel_page_url) {
             $this->cancel_page_url = get_permalink($this->cancel_page_id);
         }
         return $this->cancel_page_url;
@@ -221,13 +221,13 @@ 
             : 1;
         $option                    = self::OPTION_NAME_UXIP;
         // set correct table for query
-        $table_name = $wpdb->get_blog_prefix($current_main_site_id) . 'options';
+        $table_name = $wpdb->get_blog_prefix($current_main_site_id).'options';
         // rather than getting blog option for the $current_main_site_id, we do a direct $wpdb query because
         // get_blog_option() does a switch_to_blog and that could cause infinite recursion because EE_Core_Config might be
         // re-constructed on the blog switch.  Note, we are still executing any core wp filters on this option retrieval.
         // this bit of code is basically a direct copy of get_option without any caching because we are NOT switched to the blog
         // for the purpose of caching.
-        $pre = apply_filters('pre_option_' . $option, false, $option);
+        $pre = apply_filters('pre_option_'.$option, false, $option);
         if ($pre !== false) {
             EE_Core_Config::$ee_ueip_option = $pre;
             return EE_Core_Config::$ee_ueip_option;
@@ -241,10 +241,10 @@ 
         if (is_object($row)) {
             $value = $row->option_value;
         } else { // option does not exist so use default.
-            EE_Core_Config::$ee_ueip_option = apply_filters('default_option_' . $option, false, $option);
+            EE_Core_Config::$ee_ueip_option = apply_filters('default_option_'.$option, false, $option);
             return EE_Core_Config::$ee_ueip_option;
         }
-        EE_Core_Config::$ee_ueip_option = apply_filters('option_' . $option, maybe_unserialize($value), $option);
+        EE_Core_Config::$ee_ueip_option = apply_filters('option_'.$option, maybe_unserialize($value), $option);
         return EE_Core_Config::$ee_ueip_option;
     }
 

core/domain/entities/config/legacy/EE_Config_Base.php

Indentation +123 added lines, -123 removed lines

@@ -10,127 +10,127 @@
  */
 abstract class EE_Config_Base
 {
-    /**
-     * Utility function for escaping the value of a property and returning.
-     *
-     * @param string $property property name (checks to see if exists).
-     * @return mixed if a detected type found return the escaped value, otherwise just the raw value is returned.
-     * @throws EE_Error
-     */
-    public function get_pretty(string $property)
-    {
-        if (! property_exists($this, $property)) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        '%1$s::get_pretty() has been called with the property %2$s which does not exist on the %1$s config class.',
-                        'event_espresso'
-                    ),
-                    get_class($this),
-                    $property
-                )
-            );
-        }
-        // just handling escaping of strings for now.
-        if (is_string($this->{$property})) {
-            return stripslashes($this->{$property});
-        }
-        return $this->{$property};
-    }
-
-
-    /**
-     * @throws ReflectionException
-     */
-    public function populate()
-    {
-        // grab defaults via a new instance of this class.
-        $class_name      = get_class($this);
-        $mirror          = $this->getReflector();
-        $defaults        = $mirror->getDefaultProperties($class_name);
-        $static_defaults = $mirror->getStaticProperties($class_name);
-        // loop through the properties for this class and see if they are set.  If they are NOT, then grab the
-        // default from our $defaults object.
-        foreach ($defaults as $property => $value) {
-            $is_static_property  = array_key_exists($property, $static_defaults);
-            // double $$ is not a typo, it's how to access a static variable dynamically.
-            if ($is_static_property && $class_name::$$property !== null) {
-                continue;
-            }
-            $reflection_property = $mirror->getProperty($class_name, $property);
-            $is_public_property  = $reflection_property->isPublic();
-            if ($is_public_property && ! $is_static_property && $this->{$property} !== null) {
-                continue;
-            }
-            $camelGetter = EEH_Inflector::camelize_all_but_first($property);
-            if (method_exists($this, $camelGetter) && $this->{$camelGetter}() !== null) {
-                continue;
-            }
-            $setter = "set_$property";
-            if (method_exists($this, $setter)) {
-                $this->$setter($value);
-                continue;
-            }
-            $camelSetter = 'set' . EEH_Inflector::camelize($property);
-            if (method_exists($this, $camelSetter)) {
-                $this->$camelSetter($value);
-                continue;
-            }
-            if ($is_static_property) {
-                // double $$ is not a typo, it's how to access a static variable dynamically.
-                $class_name::$$property = $static_defaults[ $property ];
-                continue;
-            }
-            if ($is_public_property) {
-                $this->{$property} = $value;
-            }
-        }
-        // cleanup
-        unset($defaults);
-    }
-
-
-    private function getReflector(): Mirror
-    {
-        static $mirror = null;
-        if ($mirror === null) {
-            $mirror = LoaderFactory::getShared(Mirror::class);
-        }
-        return $mirror;
-    }
-
-
-    /**
-     * @param mixed $a
-     * @return bool
-     */
-    public function __isset($a)
-    {
-        return false;
-    }
-
-
-    /**
-     * @param mixed $a
-     * @return bool
-     */
-    public function __unset($a)
-    {
-        return false;
-    }
-
-
-    public function __clone()
-    {
-    }
-
-
-    public function __wakeup()
-    {
-    }
-
-
-    public function __destruct()
-    {
-    }
+	/**
+	 * Utility function for escaping the value of a property and returning.
+	 *
+	 * @param string $property property name (checks to see if exists).
+	 * @return mixed if a detected type found return the escaped value, otherwise just the raw value is returned.
+	 * @throws EE_Error
+	 */
+	public function get_pretty(string $property)
+	{
+		if (! property_exists($this, $property)) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'%1$s::get_pretty() has been called with the property %2$s which does not exist on the %1$s config class.',
+						'event_espresso'
+					),
+					get_class($this),
+					$property
+				)
+			);
+		}
+		// just handling escaping of strings for now.
+		if (is_string($this->{$property})) {
+			return stripslashes($this->{$property});
+		}
+		return $this->{$property};
+	}
+
+
+	/**
+	 * @throws ReflectionException
+	 */
+	public function populate()
+	{
+		// grab defaults via a new instance of this class.
+		$class_name      = get_class($this);
+		$mirror          = $this->getReflector();
+		$defaults        = $mirror->getDefaultProperties($class_name);
+		$static_defaults = $mirror->getStaticProperties($class_name);
+		// loop through the properties for this class and see if they are set.  If they are NOT, then grab the
+		// default from our $defaults object.
+		foreach ($defaults as $property => $value) {
+			$is_static_property  = array_key_exists($property, $static_defaults);
+			// double $$ is not a typo, it's how to access a static variable dynamically.
+			if ($is_static_property && $class_name::$$property !== null) {
+				continue;
+			}
+			$reflection_property = $mirror->getProperty($class_name, $property);
+			$is_public_property  = $reflection_property->isPublic();
+			if ($is_public_property && ! $is_static_property && $this->{$property} !== null) {
+				continue;
+			}
+			$camelGetter = EEH_Inflector::camelize_all_but_first($property);
+			if (method_exists($this, $camelGetter) && $this->{$camelGetter}() !== null) {
+				continue;
+			}
+			$setter = "set_$property";
+			if (method_exists($this, $setter)) {
+				$this->$setter($value);
+				continue;
+			}
+			$camelSetter = 'set' . EEH_Inflector::camelize($property);
+			if (method_exists($this, $camelSetter)) {
+				$this->$camelSetter($value);
+				continue;
+			}
+			if ($is_static_property) {
+				// double $$ is not a typo, it's how to access a static variable dynamically.
+				$class_name::$$property = $static_defaults[ $property ];
+				continue;
+			}
+			if ($is_public_property) {
+				$this->{$property} = $value;
+			}
+		}
+		// cleanup
+		unset($defaults);
+	}
+
+
+	private function getReflector(): Mirror
+	{
+		static $mirror = null;
+		if ($mirror === null) {
+			$mirror = LoaderFactory::getShared(Mirror::class);
+		}
+		return $mirror;
+	}
+
+
+	/**
+	 * @param mixed $a
+	 * @return bool
+	 */
+	public function __isset($a)
+	{
+		return false;
+	}
+
+
+	/**
+	 * @param mixed $a
+	 * @return bool
+	 */
+	public function __unset($a)
+	{
+		return false;
+	}
+
+
+	public function __clone()
+	{
+	}
+
+
+	public function __wakeup()
+	{
+	}
+
+
+	public function __destruct()
+	{
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -19,7 +19,7 @@ 
      */
     public function get_pretty(string $property)
     {
-        if (! property_exists($this, $property)) {
+        if ( ! property_exists($this, $property)) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -52,7 +52,7 @@ 
         // loop through the properties for this class and see if they are set.  If they are NOT, then grab the
         // default from our $defaults object.
         foreach ($defaults as $property => $value) {
-            $is_static_property  = array_key_exists($property, $static_defaults);
+            $is_static_property = array_key_exists($property, $static_defaults);
             // double $$ is not a typo, it's how to access a static variable dynamically.
             if ($is_static_property && $class_name::$$property !== null) {
                 continue;
@@ -71,14 +71,14 @@ 
                 $this->$setter($value);
                 continue;
             }
-            $camelSetter = 'set' . EEH_Inflector::camelize($property);
+            $camelSetter = 'set'.EEH_Inflector::camelize($property);
             if (method_exists($this, $camelSetter)) {
                 $this->$camelSetter($value);
                 continue;
             }
             if ($is_static_property) {
                 // double $$ is not a typo, it's how to access a static variable dynamically.
-                $class_name::$$property = $static_defaults[ $property ];
+                $class_name::$$property = $static_defaults[$property];
                 continue;
             }
             if ($is_public_property) {

core/admin/EE_Admin_Page_Loader.core.php

Indentation +443 added lines, -443 removed lines

@@ -18,447 +18,447 @@
  */
 class EE_Admin_Page_Loader
 {
-    /**
-     * @var AdminMenuManager $menu_manager
-     */
-    protected $menu_manager;
-
-    /**
-     * @var LoaderInterface $loader
-     */
-    protected $loader;
-
-    /**
-     * _installed_pages
-     * objects for page_init objects detected and loaded
-     *
-     * @access private
-     * @var EE_Admin_Page_Init[]
-     */
-    private $_installed_pages = [];
-
-
-    /**
-     * this is used to hold the registry of menu slugs for all the installed admin pages
-     *
-     * @var array
-     */
-    private $_menu_slugs = [];
-
-
-    /**
-     * _caffeinated_extends
-     * This array is the generated configuration array for which core EE_Admin pages are extended (and the bits and
-     * pieces needed to do so).  This property is defined in the _set_caffeinated method.
-     *
-     * @var array
-     */
-    private $_caffeinated_extends = [];
-
-
-    /**
-     * This property will hold the hook file for setting up the filter that does all the connections between admin
-     * pages.
-     *
-     * @var string
-     */
-    public $hook_file;
-
-    /**
-     * @var bool
-     * @since 5.0.0.p
-     */
-    private bool $full_site_maintenance = false;
-
-
-    /**
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function __construct(?LoaderInterface $loader)
-    {
-        $this->loader = $loader instanceof LoaderInterface ? $loader : LoaderFactory::getLoader();
-        $this->menu_manager = $this->loader->getShared(AdminMenuManager::class);
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since 5.0.0.p
-     */
-    public function init()
-    {
-        $this->menu_manager->initialize();
-        $this->full_site_maintenance = MaintenanceStatus::isFullSite();
-        // let's do a scan and see what installed pages we have
-        $this->findAndLoadAdminPages();
-    }
-
-
-    /**
-     * When caffeinated system is detected, this method is called to setup the caffeinated directory constants used by
-     * files in the caffeinated folder.
-     *
-     * @access private
-     * @return void
-     */
-    private function defineCaffeinatedConstants()
-    {
-        if (! defined('EE_CORE_CAF_ADMIN')) {
-            define('EE_CORE_CAF_ADMIN', EE_PLUGIN_DIR_PATH . 'caffeinated/admin/');
-            define('EE_CORE_CAF_ADMIN_URL', EE_PLUGIN_DIR_URL . 'caffeinated/admin/');
-            define('EE_CORE_CAF_ADMIN_NEW', EE_CORE_CAF_ADMIN . 'new/');
-            define('EE_CORE_CAF_ADMIN_EXTEND', EE_CORE_CAF_ADMIN . 'extend/');
-            define('EE_CORE_CAF_ADMIN_EXTEND_URL', EE_CORE_CAF_ADMIN_URL . 'extend/');
-            define('EE_CORE_CAF_ADMIN_HOOKS', EE_CORE_CAF_ADMIN . 'hooks/');
-        }
-    }
-
-
-    /**
-     * This just gets the list of installed EE_Admin_pages.
-     *
-     * @access private
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function findAndLoadAdminPages()
-    {
-        $admin_pages = $this->findAdminPages();
-        $isCaffeinated = ! (defined('EE_DECAF') && EE_DECAF) && is_dir(EE_PLUGIN_DIR_PATH . 'caffeinated/admin');
-        // first let's check if there IS a caffeinated folder.
-        if ($isCaffeinated) {
-            // this just checks the caffeinated folder and takes care of setting up any caffeinated stuff.
-            $admin_pages = $this->findCaffeinatedAdminPages($admin_pages);
-            // then extensions and hooks, although they don't get added to the admin pages array
-            $this->findAdminPageExtensions();
-            $this->findAdminPageHooks();
-        }
-        // allow plugins to add in their own pages (note at this point they will need to have an autoloader defined for their class) OR hook into EEH_Autoloader::load_admin_page() to add their path.;
-        // loop through admin pages and setup the $_installed_pages array.
-        $hooks_ref = [];
-        $menu_pages = [];
-        foreach ($admin_pages as $page => $path) {
-            // don't load the page init class IF IT's ALREADY LOADED !!!
-            if (
-                isset($this->_installed_pages[ $page ])
-                && $this->_installed_pages[ $page ] instanceof EE_Admin_Page_Init
-            ) {
-                continue;
-            }
-            // build list of installed pages
-            $admin_page_init = $this->loadAdminPageInit($page);
-            $this->_installed_pages[ $page ] = $admin_page_init;
-            $admin_menu = $this->menu_manager->getAdminMenu($admin_page_init);
-            $admin_page_init->setCapability($admin_menu->capability(), $admin_menu->menuSlug());
-            // skip if in full maintenance mode and maintenance_mode_parent is NOT set
-            if ($this->full_site_maintenance && ! $admin_menu->maintenanceModeParent()) {
-                unset($admin_pages[ $page ]);
-                continue;
-            }
-            $menu_slug = $admin_menu->menuSlug();
-            $this->_menu_slugs[ $menu_slug ] = $page;
-            $menu_pages[ $menu_slug ] = $admin_page_init;
-
-            // now that we've got the admin_init objects...
-            // let's see if there are any caffeinated pages extending the originals.
-            // If there are then let's hook into the init admin filter and load our extentions instead.
-            // Set flag for register hooks on extended pages b/c extended pages use the default INIT.
-            $extended_hooks = $admin_page_init->register_hooks(
-                $this->loadCaffeinatedExtensions($admin_page_init, $page, $menu_slug)
-            );
-            $hooks_ref = array_merge($hooks_ref, $extended_hooks);
-        }
-        // the hooks_ref is all the pages where we have $extended _Hooks files
-        // that will extend a class in a different folder.
-        // So we want to make sure we load the file for the parent.
-        // first make sure we've got unique values
-        $hooks_ref = array_unique($hooks_ref);
-        // now let's loop and require!
-        foreach ($hooks_ref as $path) {
-            // if we're not caffeinated, then we don't need to do any of the following.
-            if (! $isCaffeinated && strpos($path, 'caffeinated') !== false) {
-                continue;
-            }
-            require_once($path);
-        }
-        // make sure we have menu slugs global setup. Used in EE_Admin_Page->page_setup() to ensure we don't do a full class load for an admin page that isn't requested.
-        global $ee_menu_slugs;
-        $ee_menu_slugs = $this->_menu_slugs;
-        // we need to loop again to run any early code
-        foreach ($this->_installed_pages as $page) {
-            $page->do_initial_loads();
-        }
-        $this->menu_manager->setInstalledPages($menu_pages);
-        do_action('AHEE__EE_Admin_Page_Loader___get_installed_pages_loaded', $this->_installed_pages);
-    }
-
-
-    /**
-     * @return array
-     * @throws EE_Error
-     * @since   5.0.0.p
-     */
-    private function findAdminPages(): array
-    {
-        // grab everything in the  admin core directory
-        $admin_page_folders = $this->findAdminPageFolders(EE_ADMIN_PAGES . '*');
-        $admin_page_folders = apply_filters(
-            'FHEE__EE_Admin_Page_Loader__findAdminPages__admin_page_folders',
-            $admin_page_folders
-        );
-        if (! empty($admin_page_folders)) {
-            return $admin_page_folders;
-        }
-        $error_msg = esc_html__(
-            'There are no EE_Admin pages detected, it looks like EE did not install properly',
-            'event_espresso'
-        );
-        $error_msg .= '||';
-        $error_msg .= sprintf(
-            esc_html__(
-                'Check that the %s folder exists and is writable. Maybe try deactivating, then reactivating Event Espresso again.',
-                'event_espresso'
-            ),
-            EE_ADMIN_PAGES
-        );
-        throw new RuntimeException($error_msg);
-    }
-
-
-    /**
-     * get_admin_page_object
-     *
-     * @param string $page_slug
-     * @return EE_Admin_Page
-     */
-    public function get_admin_page_object(string $page_slug = ''): ?EE_Admin_Page
-    {
-        return isset($this->_installed_pages[ $page_slug ])
-               && $this->_installed_pages[ $page_slug ] instanceof EE_Admin_Page_Init
-            ? $this->_installed_pages[ $page_slug ]->loaded_page_object()
-            : null;
-    }
-
-
-    /**
-     * generates an "Admin Page Init" class based on the directory  name
-     *
-     * @param string $dir_name
-     * @return string
-     */
-    private function getClassnameForAdminPageInit(string $dir_name = ''): string
-    {
-        $class_name = str_replace('_', ' ', strtolower($dir_name));
-        return str_replace(' ', '_', ucwords($class_name)) . '_Admin_Page_Init';
-    }
-
-
-    /**
-     * _load_admin_page
-     * Loads and instantiates page_init object for a single EE_admin page.
-     *
-     * @param string $page page_reference
-     * @return EE_Admin_Page_Init
-     * @throws EE_Error
-     */
-    private function loadAdminPageInit(string $page = ''): EE_Admin_Page_Init
-    {
-        $class_name = $this->getClassnameForAdminPageInit($page);
-        if (class_exists($class_name)) {
-            $admin_page_init = $this->loader->getShared($class_name);
-            // verify returned object
-            if ($admin_page_init instanceof EE_Admin_Page_Init) {
-                return $admin_page_init;
-            }
-        }
-        $error_msg = sprintf(
-            esc_html__('Something went wrong with loading the %s admin page.', 'event_espresso'),
-            $page
-        );
-        $error_msg .= '||'; // separates public from developer messages
-        $error_msg .= "\r\n";
-        $error_msg .= sprintf(
-            esc_html__('There is no Init class in place for the %s admin page.', 'event_espresso'),
-            $page
-        );
-        $error_msg .= '<br />';
-        $error_msg .= sprintf(
-            esc_html__(
-                'Make sure you have %1$s defined. If this is a non-EE-core admin page then you also must have an autoloader in place for your class',
-                'event_espresso'
-            ),
-            '<strong>' . $class_name . '</strong>'
-        );
-        throw new EE_Error($error_msg);
-    }
-
-
-    /**
-     * This method is the "workhorse" for detecting and setting up caffeinated functionality.
-     * In this method there are three checks being done:
-     * 1. Do we have any NEW admin page sets.  If we do, lets add them into the menu setup (via the $admin_pages
-     * array) etc.  (new page sets are found in caffeinated/new/{page})
-     * 2. Do we have any EXTENDED page sets.  Basically an extended EE_Admin Page extends the core {child}_Admin_Page
-     * class.  eg. would be caffeinated/extend/events/Extend_Events_Admin_Page.core.php and in there would be a class:
-     * Extend_Events_Admin_Page extends Events_Admin_Page.
-     * 3. Do we have any files just for setting up hooks into other core pages.  The files can be any name in
-     * "caffeinated/hooks" EXCEPT they need a ".class.php" extension and the file name must correspond with the
-     * classname inside.  These classes are instantiated really early so that any hooks in them are run before the
-     * corresponding apply_filters/do_actions that are found in any future loaded EE_Admin pages (INCLUDING caffeinated
-     * admin_pages)
-     *
-     * @param array $admin_pages the original installed_refs array that may contain our NEW EE_Admin_Pages to be
-     *                              loaded.
-     * @return array
-     * @throws EE_Error
-     */
-    private function findCaffeinatedAdminPages(array $admin_pages): array
-    {
-        $this->defineCaffeinatedConstants();
-
-        $exclude = ['tickets'];
-        $feature = $this->loader->getShared(FeatureFlags::class);
-        if (! $feature->allowed('use_edd_plugin_licensing')) {
-            $exclude[] = 'license_keys';
-        }
-        // okay let's setup an "New" pages first (we'll return installed refs later)
-        $admin_pages += $this->findAdminPageFolders(EE_CORE_CAF_ADMIN . 'new/*', $exclude);
-
-        return apply_filters(
-            'FHEE__EE_Admin_Page_Loader___get_installed_pages__installed_refs',
-            $admin_pages
-        );
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @since   5.0.0.p
-     */
-    private function findAdminPageExtensions()
-    {
-        // let's see if there are any EXTENDS to set up in the $_caffeinated_extends array
-        // (that will be used later for hooking into the _initialize_admin_age in the related core_init admin page)
-        $extensions = $this->findAdminPageFolders(EE_CORE_CAF_ADMIN . 'extend/*');
-        if ($extensions) {
-            foreach ($extensions as $folder => $extension) {
-                // convert lowercase_snake_case to Uppercase_Snake_Case
-                $filename = str_replace(' ', '_', ucwords(str_replace('_', ' ', $folder)));
-                $filename = "Extend_{$filename}_Admin_Page";
-                $filepath = EE_CORE_CAF_ADMIN . "extend/$folder/$filename.core.php";
-                // save filename and filepath for later
-                $this->_caffeinated_extends[ $folder ]['path']       = str_replace(['\\', '/'], '/', $filepath);
-                $this->_caffeinated_extends[ $folder ]['admin_page'] = $filename;
-            }
-        }
-        $this->_caffeinated_extends = apply_filters(
-            'FHEE__EE_Admin_Page_Loader___get_installed_pages__caffeinated_extends',
-            $this->_caffeinated_extends
-        );
-    }
-
-
-    private function loadCaffeinatedExtensions(
-        EE_Admin_Page_Init $admin_page_init,
-        string $page,
-        string $menu_slug
-    ): bool {
-        if (! isset($this->_caffeinated_extends[ $page ])) {
-            return false;
-        }
-        $admin_page_name = $admin_page_init->get_admin_page_name();
-        $caf_path        = $this->_caffeinated_extends[ $page ]['path'];
-        $caf_admin_page  = $this->_caffeinated_extends[ $page ]['admin_page'];
-        add_filter(
-            "FHEE__EE_Admin_Page_Init___initialize_admin_page__path_to_file__{$menu_slug}_$admin_page_name",
-            static function ($path_to_file) use ($caf_path) {
-                return $caf_path;
-            }
-        );
-        add_filter(
-            "FHEE__EE_Admin_Page_Init___initialize_admin_page__admin_page__{$menu_slug}_$admin_page_name",
-            static function ($admin_page) use ($caf_admin_page) {
-                return $caf_admin_page;
-            }
-        );
-        return true;
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @since   5.0.0.p
-     */
-    private function findAdminPageHooks()
-    {
-        // let's see if there are any HOOK files and instantiate them if there are (so that hooks are loaded early!).
-        $ee_admin_hooks   = [];
-        $admin_page_hooks = $this->findAdminPageFolders(EE_CORE_CAF_ADMIN . 'hooks/*.class.php', [], 0, false);
-        if ($admin_page_hooks) {
-            foreach ($admin_page_hooks as $hook) {
-                if (is_readable($hook)) {
-                    require_once $hook;
-                    $classname = str_replace([EE_CORE_CAF_ADMIN . 'hooks/', '.class.php'], '', $hook);
-                    if (class_exists($classname)) {
-                        $ee_admin_hooks[] = $this->loader->getShared($classname);
-                    }
-                }
-            }
-        }
-        apply_filters('FHEE__EE_Admin_Page_Loader__set_caffeinated__ee_admin_hooks', $ee_admin_hooks);
-    }
-
-
-    /**
-     * _default_header_link
-     * This is just a dummy method to use with header submenu items
-     *
-     * @return bool false
-     */
-    public function _default_header_link(): bool
-    {
-        return false;
-    }
-
-
-    /**
-     * @param string $path
-     * @param int    $flags
-     * @param array  $exclude
-     * @param bool   $register_autoloaders
-     * @return array
-     * @throws EE_Error
-     * @since 5.0.0.p
-     */
-    private function findAdminPageFolders(
-        string $path,
-        array $exclude = [],
-        int $flags = GLOB_ONLYDIR,
-        bool $register_autoloaders = true
-    ): array {
-        $folders = [];
-        $subfolders = glob($path, $flags);
-        if ($subfolders) {
-            foreach ($subfolders as $admin_screen) {
-                $admin_screen_name = basename($admin_screen);
-                // files and anything in the exclude array need not apply
-                if (! in_array($admin_screen_name, $exclude, true)) {
-                    // these folders represent the different EE admin pages
-                    $folders[ $admin_screen_name ] = $admin_screen;
-                    if ($register_autoloaders) {
-                        // set autoloaders for our admin page classes based on included path information
-                        EEH_Autoloader::register_autoloaders_for_each_file_in_folder($admin_screen);
-                    }
-                }
-            }
-        }
-        return $folders;
-    }
+	/**
+	 * @var AdminMenuManager $menu_manager
+	 */
+	protected $menu_manager;
+
+	/**
+	 * @var LoaderInterface $loader
+	 */
+	protected $loader;
+
+	/**
+	 * _installed_pages
+	 * objects for page_init objects detected and loaded
+	 *
+	 * @access private
+	 * @var EE_Admin_Page_Init[]
+	 */
+	private $_installed_pages = [];
+
+
+	/**
+	 * this is used to hold the registry of menu slugs for all the installed admin pages
+	 *
+	 * @var array
+	 */
+	private $_menu_slugs = [];
+
+
+	/**
+	 * _caffeinated_extends
+	 * This array is the generated configuration array for which core EE_Admin pages are extended (and the bits and
+	 * pieces needed to do so).  This property is defined in the _set_caffeinated method.
+	 *
+	 * @var array
+	 */
+	private $_caffeinated_extends = [];
+
+
+	/**
+	 * This property will hold the hook file for setting up the filter that does all the connections between admin
+	 * pages.
+	 *
+	 * @var string
+	 */
+	public $hook_file;
+
+	/**
+	 * @var bool
+	 * @since 5.0.0.p
+	 */
+	private bool $full_site_maintenance = false;
+
+
+	/**
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function __construct(?LoaderInterface $loader)
+	{
+		$this->loader = $loader instanceof LoaderInterface ? $loader : LoaderFactory::getLoader();
+		$this->menu_manager = $this->loader->getShared(AdminMenuManager::class);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since 5.0.0.p
+	 */
+	public function init()
+	{
+		$this->menu_manager->initialize();
+		$this->full_site_maintenance = MaintenanceStatus::isFullSite();
+		// let's do a scan and see what installed pages we have
+		$this->findAndLoadAdminPages();
+	}
+
+
+	/**
+	 * When caffeinated system is detected, this method is called to setup the caffeinated directory constants used by
+	 * files in the caffeinated folder.
+	 *
+	 * @access private
+	 * @return void
+	 */
+	private function defineCaffeinatedConstants()
+	{
+		if (! defined('EE_CORE_CAF_ADMIN')) {
+			define('EE_CORE_CAF_ADMIN', EE_PLUGIN_DIR_PATH . 'caffeinated/admin/');
+			define('EE_CORE_CAF_ADMIN_URL', EE_PLUGIN_DIR_URL . 'caffeinated/admin/');
+			define('EE_CORE_CAF_ADMIN_NEW', EE_CORE_CAF_ADMIN . 'new/');
+			define('EE_CORE_CAF_ADMIN_EXTEND', EE_CORE_CAF_ADMIN . 'extend/');
+			define('EE_CORE_CAF_ADMIN_EXTEND_URL', EE_CORE_CAF_ADMIN_URL . 'extend/');
+			define('EE_CORE_CAF_ADMIN_HOOKS', EE_CORE_CAF_ADMIN . 'hooks/');
+		}
+	}
+
+
+	/**
+	 * This just gets the list of installed EE_Admin_pages.
+	 *
+	 * @access private
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function findAndLoadAdminPages()
+	{
+		$admin_pages = $this->findAdminPages();
+		$isCaffeinated = ! (defined('EE_DECAF') && EE_DECAF) && is_dir(EE_PLUGIN_DIR_PATH . 'caffeinated/admin');
+		// first let's check if there IS a caffeinated folder.
+		if ($isCaffeinated) {
+			// this just checks the caffeinated folder and takes care of setting up any caffeinated stuff.
+			$admin_pages = $this->findCaffeinatedAdminPages($admin_pages);
+			// then extensions and hooks, although they don't get added to the admin pages array
+			$this->findAdminPageExtensions();
+			$this->findAdminPageHooks();
+		}
+		// allow plugins to add in their own pages (note at this point they will need to have an autoloader defined for their class) OR hook into EEH_Autoloader::load_admin_page() to add their path.;
+		// loop through admin pages and setup the $_installed_pages array.
+		$hooks_ref = [];
+		$menu_pages = [];
+		foreach ($admin_pages as $page => $path) {
+			// don't load the page init class IF IT's ALREADY LOADED !!!
+			if (
+				isset($this->_installed_pages[ $page ])
+				&& $this->_installed_pages[ $page ] instanceof EE_Admin_Page_Init
+			) {
+				continue;
+			}
+			// build list of installed pages
+			$admin_page_init = $this->loadAdminPageInit($page);
+			$this->_installed_pages[ $page ] = $admin_page_init;
+			$admin_menu = $this->menu_manager->getAdminMenu($admin_page_init);
+			$admin_page_init->setCapability($admin_menu->capability(), $admin_menu->menuSlug());
+			// skip if in full maintenance mode and maintenance_mode_parent is NOT set
+			if ($this->full_site_maintenance && ! $admin_menu->maintenanceModeParent()) {
+				unset($admin_pages[ $page ]);
+				continue;
+			}
+			$menu_slug = $admin_menu->menuSlug();
+			$this->_menu_slugs[ $menu_slug ] = $page;
+			$menu_pages[ $menu_slug ] = $admin_page_init;
+
+			// now that we've got the admin_init objects...
+			// let's see if there are any caffeinated pages extending the originals.
+			// If there are then let's hook into the init admin filter and load our extentions instead.
+			// Set flag for register hooks on extended pages b/c extended pages use the default INIT.
+			$extended_hooks = $admin_page_init->register_hooks(
+				$this->loadCaffeinatedExtensions($admin_page_init, $page, $menu_slug)
+			);
+			$hooks_ref = array_merge($hooks_ref, $extended_hooks);
+		}
+		// the hooks_ref is all the pages where we have $extended _Hooks files
+		// that will extend a class in a different folder.
+		// So we want to make sure we load the file for the parent.
+		// first make sure we've got unique values
+		$hooks_ref = array_unique($hooks_ref);
+		// now let's loop and require!
+		foreach ($hooks_ref as $path) {
+			// if we're not caffeinated, then we don't need to do any of the following.
+			if (! $isCaffeinated && strpos($path, 'caffeinated') !== false) {
+				continue;
+			}
+			require_once($path);
+		}
+		// make sure we have menu slugs global setup. Used in EE_Admin_Page->page_setup() to ensure we don't do a full class load for an admin page that isn't requested.
+		global $ee_menu_slugs;
+		$ee_menu_slugs = $this->_menu_slugs;
+		// we need to loop again to run any early code
+		foreach ($this->_installed_pages as $page) {
+			$page->do_initial_loads();
+		}
+		$this->menu_manager->setInstalledPages($menu_pages);
+		do_action('AHEE__EE_Admin_Page_Loader___get_installed_pages_loaded', $this->_installed_pages);
+	}
+
+
+	/**
+	 * @return array
+	 * @throws EE_Error
+	 * @since   5.0.0.p
+	 */
+	private function findAdminPages(): array
+	{
+		// grab everything in the  admin core directory
+		$admin_page_folders = $this->findAdminPageFolders(EE_ADMIN_PAGES . '*');
+		$admin_page_folders = apply_filters(
+			'FHEE__EE_Admin_Page_Loader__findAdminPages__admin_page_folders',
+			$admin_page_folders
+		);
+		if (! empty($admin_page_folders)) {
+			return $admin_page_folders;
+		}
+		$error_msg = esc_html__(
+			'There are no EE_Admin pages detected, it looks like EE did not install properly',
+			'event_espresso'
+		);
+		$error_msg .= '||';
+		$error_msg .= sprintf(
+			esc_html__(
+				'Check that the %s folder exists and is writable. Maybe try deactivating, then reactivating Event Espresso again.',
+				'event_espresso'
+			),
+			EE_ADMIN_PAGES
+		);
+		throw new RuntimeException($error_msg);
+	}
+
+
+	/**
+	 * get_admin_page_object
+	 *
+	 * @param string $page_slug
+	 * @return EE_Admin_Page
+	 */
+	public function get_admin_page_object(string $page_slug = ''): ?EE_Admin_Page
+	{
+		return isset($this->_installed_pages[ $page_slug ])
+			   && $this->_installed_pages[ $page_slug ] instanceof EE_Admin_Page_Init
+			? $this->_installed_pages[ $page_slug ]->loaded_page_object()
+			: null;
+	}
+
+
+	/**
+	 * generates an "Admin Page Init" class based on the directory  name
+	 *
+	 * @param string $dir_name
+	 * @return string
+	 */
+	private function getClassnameForAdminPageInit(string $dir_name = ''): string
+	{
+		$class_name = str_replace('_', ' ', strtolower($dir_name));
+		return str_replace(' ', '_', ucwords($class_name)) . '_Admin_Page_Init';
+	}
+
+
+	/**
+	 * _load_admin_page
+	 * Loads and instantiates page_init object for a single EE_admin page.
+	 *
+	 * @param string $page page_reference
+	 * @return EE_Admin_Page_Init
+	 * @throws EE_Error
+	 */
+	private function loadAdminPageInit(string $page = ''): EE_Admin_Page_Init
+	{
+		$class_name = $this->getClassnameForAdminPageInit($page);
+		if (class_exists($class_name)) {
+			$admin_page_init = $this->loader->getShared($class_name);
+			// verify returned object
+			if ($admin_page_init instanceof EE_Admin_Page_Init) {
+				return $admin_page_init;
+			}
+		}
+		$error_msg = sprintf(
+			esc_html__('Something went wrong with loading the %s admin page.', 'event_espresso'),
+			$page
+		);
+		$error_msg .= '||'; // separates public from developer messages
+		$error_msg .= "\r\n";
+		$error_msg .= sprintf(
+			esc_html__('There is no Init class in place for the %s admin page.', 'event_espresso'),
+			$page
+		);
+		$error_msg .= '<br />';
+		$error_msg .= sprintf(
+			esc_html__(
+				'Make sure you have %1$s defined. If this is a non-EE-core admin page then you also must have an autoloader in place for your class',
+				'event_espresso'
+			),
+			'<strong>' . $class_name . '</strong>'
+		);
+		throw new EE_Error($error_msg);
+	}
+
+
+	/**
+	 * This method is the "workhorse" for detecting and setting up caffeinated functionality.
+	 * In this method there are three checks being done:
+	 * 1. Do we have any NEW admin page sets.  If we do, lets add them into the menu setup (via the $admin_pages
+	 * array) etc.  (new page sets are found in caffeinated/new/{page})
+	 * 2. Do we have any EXTENDED page sets.  Basically an extended EE_Admin Page extends the core {child}_Admin_Page
+	 * class.  eg. would be caffeinated/extend/events/Extend_Events_Admin_Page.core.php and in there would be a class:
+	 * Extend_Events_Admin_Page extends Events_Admin_Page.
+	 * 3. Do we have any files just for setting up hooks into other core pages.  The files can be any name in
+	 * "caffeinated/hooks" EXCEPT they need a ".class.php" extension and the file name must correspond with the
+	 * classname inside.  These classes are instantiated really early so that any hooks in them are run before the
+	 * corresponding apply_filters/do_actions that are found in any future loaded EE_Admin pages (INCLUDING caffeinated
+	 * admin_pages)
+	 *
+	 * @param array $admin_pages the original installed_refs array that may contain our NEW EE_Admin_Pages to be
+	 *                              loaded.
+	 * @return array
+	 * @throws EE_Error
+	 */
+	private function findCaffeinatedAdminPages(array $admin_pages): array
+	{
+		$this->defineCaffeinatedConstants();
+
+		$exclude = ['tickets'];
+		$feature = $this->loader->getShared(FeatureFlags::class);
+		if (! $feature->allowed('use_edd_plugin_licensing')) {
+			$exclude[] = 'license_keys';
+		}
+		// okay let's setup an "New" pages first (we'll return installed refs later)
+		$admin_pages += $this->findAdminPageFolders(EE_CORE_CAF_ADMIN . 'new/*', $exclude);
+
+		return apply_filters(
+			'FHEE__EE_Admin_Page_Loader___get_installed_pages__installed_refs',
+			$admin_pages
+		);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @since   5.0.0.p
+	 */
+	private function findAdminPageExtensions()
+	{
+		// let's see if there are any EXTENDS to set up in the $_caffeinated_extends array
+		// (that will be used later for hooking into the _initialize_admin_age in the related core_init admin page)
+		$extensions = $this->findAdminPageFolders(EE_CORE_CAF_ADMIN . 'extend/*');
+		if ($extensions) {
+			foreach ($extensions as $folder => $extension) {
+				// convert lowercase_snake_case to Uppercase_Snake_Case
+				$filename = str_replace(' ', '_', ucwords(str_replace('_', ' ', $folder)));
+				$filename = "Extend_{$filename}_Admin_Page";
+				$filepath = EE_CORE_CAF_ADMIN . "extend/$folder/$filename.core.php";
+				// save filename and filepath for later
+				$this->_caffeinated_extends[ $folder ]['path']       = str_replace(['\\', '/'], '/', $filepath);
+				$this->_caffeinated_extends[ $folder ]['admin_page'] = $filename;
+			}
+		}
+		$this->_caffeinated_extends = apply_filters(
+			'FHEE__EE_Admin_Page_Loader___get_installed_pages__caffeinated_extends',
+			$this->_caffeinated_extends
+		);
+	}
+
+
+	private function loadCaffeinatedExtensions(
+		EE_Admin_Page_Init $admin_page_init,
+		string $page,
+		string $menu_slug
+	): bool {
+		if (! isset($this->_caffeinated_extends[ $page ])) {
+			return false;
+		}
+		$admin_page_name = $admin_page_init->get_admin_page_name();
+		$caf_path        = $this->_caffeinated_extends[ $page ]['path'];
+		$caf_admin_page  = $this->_caffeinated_extends[ $page ]['admin_page'];
+		add_filter(
+			"FHEE__EE_Admin_Page_Init___initialize_admin_page__path_to_file__{$menu_slug}_$admin_page_name",
+			static function ($path_to_file) use ($caf_path) {
+				return $caf_path;
+			}
+		);
+		add_filter(
+			"FHEE__EE_Admin_Page_Init___initialize_admin_page__admin_page__{$menu_slug}_$admin_page_name",
+			static function ($admin_page) use ($caf_admin_page) {
+				return $caf_admin_page;
+			}
+		);
+		return true;
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @since   5.0.0.p
+	 */
+	private function findAdminPageHooks()
+	{
+		// let's see if there are any HOOK files and instantiate them if there are (so that hooks are loaded early!).
+		$ee_admin_hooks   = [];
+		$admin_page_hooks = $this->findAdminPageFolders(EE_CORE_CAF_ADMIN . 'hooks/*.class.php', [], 0, false);
+		if ($admin_page_hooks) {
+			foreach ($admin_page_hooks as $hook) {
+				if (is_readable($hook)) {
+					require_once $hook;
+					$classname = str_replace([EE_CORE_CAF_ADMIN . 'hooks/', '.class.php'], '', $hook);
+					if (class_exists($classname)) {
+						$ee_admin_hooks[] = $this->loader->getShared($classname);
+					}
+				}
+			}
+		}
+		apply_filters('FHEE__EE_Admin_Page_Loader__set_caffeinated__ee_admin_hooks', $ee_admin_hooks);
+	}
+
+
+	/**
+	 * _default_header_link
+	 * This is just a dummy method to use with header submenu items
+	 *
+	 * @return bool false
+	 */
+	public function _default_header_link(): bool
+	{
+		return false;
+	}
+
+
+	/**
+	 * @param string $path
+	 * @param int    $flags
+	 * @param array  $exclude
+	 * @param bool   $register_autoloaders
+	 * @return array
+	 * @throws EE_Error
+	 * @since 5.0.0.p
+	 */
+	private function findAdminPageFolders(
+		string $path,
+		array $exclude = [],
+		int $flags = GLOB_ONLYDIR,
+		bool $register_autoloaders = true
+	): array {
+		$folders = [];
+		$subfolders = glob($path, $flags);
+		if ($subfolders) {
+			foreach ($subfolders as $admin_screen) {
+				$admin_screen_name = basename($admin_screen);
+				// files and anything in the exclude array need not apply
+				if (! in_array($admin_screen_name, $exclude, true)) {
+					// these folders represent the different EE admin pages
+					$folders[ $admin_screen_name ] = $admin_screen;
+					if ($register_autoloaders) {
+						// set autoloaders for our admin page classes based on included path information
+						EEH_Autoloader::register_autoloaders_for_each_file_in_folder($admin_screen);
+					}
+				}
+			}
+		}
+		return $folders;
+	}
 }

Spacing +37 added lines, -37 removed lines

@@ -106,13 +106,13 @@ 
      */
     private function defineCaffeinatedConstants()
     {
-        if (! defined('EE_CORE_CAF_ADMIN')) {
-            define('EE_CORE_CAF_ADMIN', EE_PLUGIN_DIR_PATH . 'caffeinated/admin/');
-            define('EE_CORE_CAF_ADMIN_URL', EE_PLUGIN_DIR_URL . 'caffeinated/admin/');
-            define('EE_CORE_CAF_ADMIN_NEW', EE_CORE_CAF_ADMIN . 'new/');
-            define('EE_CORE_CAF_ADMIN_EXTEND', EE_CORE_CAF_ADMIN . 'extend/');
-            define('EE_CORE_CAF_ADMIN_EXTEND_URL', EE_CORE_CAF_ADMIN_URL . 'extend/');
-            define('EE_CORE_CAF_ADMIN_HOOKS', EE_CORE_CAF_ADMIN . 'hooks/');
+        if ( ! defined('EE_CORE_CAF_ADMIN')) {
+            define('EE_CORE_CAF_ADMIN', EE_PLUGIN_DIR_PATH.'caffeinated/admin/');
+            define('EE_CORE_CAF_ADMIN_URL', EE_PLUGIN_DIR_URL.'caffeinated/admin/');
+            define('EE_CORE_CAF_ADMIN_NEW', EE_CORE_CAF_ADMIN.'new/');
+            define('EE_CORE_CAF_ADMIN_EXTEND', EE_CORE_CAF_ADMIN.'extend/');
+            define('EE_CORE_CAF_ADMIN_EXTEND_URL', EE_CORE_CAF_ADMIN_URL.'extend/');
+            define('EE_CORE_CAF_ADMIN_HOOKS', EE_CORE_CAF_ADMIN.'hooks/');
         }
     }
 
@@ -131,7 +131,7 @@ 
     private function findAndLoadAdminPages()
     {
         $admin_pages = $this->findAdminPages();
-        $isCaffeinated = ! (defined('EE_DECAF') && EE_DECAF) && is_dir(EE_PLUGIN_DIR_PATH . 'caffeinated/admin');
+        $isCaffeinated = ! (defined('EE_DECAF') && EE_DECAF) && is_dir(EE_PLUGIN_DIR_PATH.'caffeinated/admin');
         // first let's check if there IS a caffeinated folder.
         if ($isCaffeinated) {
             // this just checks the caffeinated folder and takes care of setting up any caffeinated stuff.
@@ -147,24 +147,24 @@ 
         foreach ($admin_pages as $page => $path) {
             // don't load the page init class IF IT's ALREADY LOADED !!!
             if (
-                isset($this->_installed_pages[ $page ])
-                && $this->_installed_pages[ $page ] instanceof EE_Admin_Page_Init
+                isset($this->_installed_pages[$page])
+                && $this->_installed_pages[$page] instanceof EE_Admin_Page_Init
             ) {
                 continue;
             }
             // build list of installed pages
             $admin_page_init = $this->loadAdminPageInit($page);
-            $this->_installed_pages[ $page ] = $admin_page_init;
+            $this->_installed_pages[$page] = $admin_page_init;
             $admin_menu = $this->menu_manager->getAdminMenu($admin_page_init);
             $admin_page_init->setCapability($admin_menu->capability(), $admin_menu->menuSlug());
             // skip if in full maintenance mode and maintenance_mode_parent is NOT set
             if ($this->full_site_maintenance && ! $admin_menu->maintenanceModeParent()) {
-                unset($admin_pages[ $page ]);
+                unset($admin_pages[$page]);
                 continue;
             }
             $menu_slug = $admin_menu->menuSlug();
-            $this->_menu_slugs[ $menu_slug ] = $page;
-            $menu_pages[ $menu_slug ] = $admin_page_init;
+            $this->_menu_slugs[$menu_slug] = $page;
+            $menu_pages[$menu_slug] = $admin_page_init;
 
             // now that we've got the admin_init objects...
             // let's see if there are any caffeinated pages extending the originals.
@@ -183,7 +183,7 @@ 
         // now let's loop and require!
         foreach ($hooks_ref as $path) {
             // if we're not caffeinated, then we don't need to do any of the following.
-            if (! $isCaffeinated && strpos($path, 'caffeinated') !== false) {
+            if ( ! $isCaffeinated && strpos($path, 'caffeinated') !== false) {
                 continue;
             }
             require_once($path);
@@ -208,12 +208,12 @@ 
     private function findAdminPages(): array
     {
         // grab everything in the  admin core directory
-        $admin_page_folders = $this->findAdminPageFolders(EE_ADMIN_PAGES . '*');
+        $admin_page_folders = $this->findAdminPageFolders(EE_ADMIN_PAGES.'*');
         $admin_page_folders = apply_filters(
             'FHEE__EE_Admin_Page_Loader__findAdminPages__admin_page_folders',
             $admin_page_folders
         );
-        if (! empty($admin_page_folders)) {
+        if ( ! empty($admin_page_folders)) {
             return $admin_page_folders;
         }
         $error_msg = esc_html__(
@@ -240,9 +240,9 @@ 
      */
     public function get_admin_page_object(string $page_slug = ''): ?EE_Admin_Page
     {
-        return isset($this->_installed_pages[ $page_slug ])
-               && $this->_installed_pages[ $page_slug ] instanceof EE_Admin_Page_Init
-            ? $this->_installed_pages[ $page_slug ]->loaded_page_object()
+        return isset($this->_installed_pages[$page_slug])
+               && $this->_installed_pages[$page_slug] instanceof EE_Admin_Page_Init
+            ? $this->_installed_pages[$page_slug]->loaded_page_object()
             : null;
     }
 
@@ -256,7 +256,7 @@ 
     private function getClassnameForAdminPageInit(string $dir_name = ''): string
     {
         $class_name = str_replace('_', ' ', strtolower($dir_name));
-        return str_replace(' ', '_', ucwords($class_name)) . '_Admin_Page_Init';
+        return str_replace(' ', '_', ucwords($class_name)).'_Admin_Page_Init';
     }
 
 
@@ -294,7 +294,7 @@ 
                 'Make sure you have %1$s defined. If this is a non-EE-core admin page then you also must have an autoloader in place for your class',
                 'event_espresso'
             ),
-            '<strong>' . $class_name . '</strong>'
+            '<strong>'.$class_name.'</strong>'
         );
         throw new EE_Error($error_msg);
     }
@@ -325,11 +325,11 @@ 
 
         $exclude = ['tickets'];
         $feature = $this->loader->getShared(FeatureFlags::class);
-        if (! $feature->allowed('use_edd_plugin_licensing')) {
+        if ( ! $feature->allowed('use_edd_plugin_licensing')) {
             $exclude[] = 'license_keys';
         }
         // okay let's setup an "New" pages first (we'll return installed refs later)
-        $admin_pages += $this->findAdminPageFolders(EE_CORE_CAF_ADMIN . 'new/*', $exclude);
+        $admin_pages += $this->findAdminPageFolders(EE_CORE_CAF_ADMIN.'new/*', $exclude);
 
         return apply_filters(
             'FHEE__EE_Admin_Page_Loader___get_installed_pages__installed_refs',
@@ -346,16 +346,16 @@ 
     {
         // let's see if there are any EXTENDS to set up in the $_caffeinated_extends array
         // (that will be used later for hooking into the _initialize_admin_age in the related core_init admin page)
-        $extensions = $this->findAdminPageFolders(EE_CORE_CAF_ADMIN . 'extend/*');
+        $extensions = $this->findAdminPageFolders(EE_CORE_CAF_ADMIN.'extend/*');
         if ($extensions) {
             foreach ($extensions as $folder => $extension) {
                 // convert lowercase_snake_case to Uppercase_Snake_Case
                 $filename = str_replace(' ', '_', ucwords(str_replace('_', ' ', $folder)));
                 $filename = "Extend_{$filename}_Admin_Page";
-                $filepath = EE_CORE_CAF_ADMIN . "extend/$folder/$filename.core.php";
+                $filepath = EE_CORE_CAF_ADMIN."extend/$folder/$filename.core.php";
                 // save filename and filepath for later
-                $this->_caffeinated_extends[ $folder ]['path']       = str_replace(['\\', '/'], '/', $filepath);
-                $this->_caffeinated_extends[ $folder ]['admin_page'] = $filename;
+                $this->_caffeinated_extends[$folder]['path']       = str_replace(['\\', '/'], '/', $filepath);
+                $this->_caffeinated_extends[$folder]['admin_page'] = $filename;
             }
         }
         $this->_caffeinated_extends = apply_filters(
@@ -370,21 +370,21 @@ 
         string $page,
         string $menu_slug
     ): bool {
-        if (! isset($this->_caffeinated_extends[ $page ])) {
+        if ( ! isset($this->_caffeinated_extends[$page])) {
             return false;
         }
         $admin_page_name = $admin_page_init->get_admin_page_name();
-        $caf_path        = $this->_caffeinated_extends[ $page ]['path'];
-        $caf_admin_page  = $this->_caffeinated_extends[ $page ]['admin_page'];
+        $caf_path        = $this->_caffeinated_extends[$page]['path'];
+        $caf_admin_page  = $this->_caffeinated_extends[$page]['admin_page'];
         add_filter(
             "FHEE__EE_Admin_Page_Init___initialize_admin_page__path_to_file__{$menu_slug}_$admin_page_name",
-            static function ($path_to_file) use ($caf_path) {
+            static function($path_to_file) use ($caf_path) {
                 return $caf_path;
             }
         );
         add_filter(
             "FHEE__EE_Admin_Page_Init___initialize_admin_page__admin_page__{$menu_slug}_$admin_page_name",
-            static function ($admin_page) use ($caf_admin_page) {
+            static function($admin_page) use ($caf_admin_page) {
                 return $caf_admin_page;
             }
         );
@@ -400,12 +400,12 @@ 
     {
         // let's see if there are any HOOK files and instantiate them if there are (so that hooks are loaded early!).
         $ee_admin_hooks   = [];
-        $admin_page_hooks = $this->findAdminPageFolders(EE_CORE_CAF_ADMIN . 'hooks/*.class.php', [], 0, false);
+        $admin_page_hooks = $this->findAdminPageFolders(EE_CORE_CAF_ADMIN.'hooks/*.class.php', [], 0, false);
         if ($admin_page_hooks) {
             foreach ($admin_page_hooks as $hook) {
                 if (is_readable($hook)) {
                     require_once $hook;
-                    $classname = str_replace([EE_CORE_CAF_ADMIN . 'hooks/', '.class.php'], '', $hook);
+                    $classname = str_replace([EE_CORE_CAF_ADMIN.'hooks/', '.class.php'], '', $hook);
                     if (class_exists($classname)) {
                         $ee_admin_hooks[] = $this->loader->getShared($classname);
                     }
@@ -449,9 +449,9 @@ 
             foreach ($subfolders as $admin_screen) {
                 $admin_screen_name = basename($admin_screen);
                 // files and anything in the exclude array need not apply
-                if (! in_array($admin_screen_name, $exclude, true)) {
+                if ( ! in_array($admin_screen_name, $exclude, true)) {
                     // these folders represent the different EE admin pages
-                    $folders[ $admin_screen_name ] = $admin_screen;
+                    $folders[$admin_screen_name] = $admin_screen;
                     if ($register_autoloaders) {
                         // set autoloaders for our admin page classes based on included path information
                         EEH_Autoloader::register_autoloaders_for_each_file_in_folder($admin_screen);

core/admin/EE_Admin_Page_Init.core.php

Indentation +489 added lines, -489 removed lines

@@ -18,494 +18,494 @@
  */
 abstract class EE_Admin_Page_Init extends EE_Base
 {
-    /**
-     * This holds the menu map object for this admin page.
-     */
-    protected ?AdminMenuItem $_menu_map           = null;
-
-    protected ?EE_Admin_Page $_loaded_page_object = null;
+	/**
+	 * This holds the menu map object for this admin page.
+	 */
+	protected ?AdminMenuItem $_menu_map           = null;
+
+	protected ?EE_Admin_Page $_loaded_page_object = null;
 
-    protected ?LoaderInterface $loader              = null;
-
-    protected ?RequestInterface $request             = null;
-
-    private bool $_load_page          = false;
-
-    protected bool $_routing            = false;
-
-    /**
-     * Menu map has a capability.  However, this allows admin pages to have separate capability requirements for menus
-     * and accessing pages.  If capability is NOT set, then it defaults to the menu_map capability.
-     *
-     * @var string
-     */
-    public string $capability = '';
-
-    /**
-     * identity properties (set in _set_defaults and _set_init_properties)
-     */
-    public string $label         = '';
-
-    protected string $_file_name    = '';
-
-    protected string $_folder_name  = '';
-
-    protected string $_folder_path  = '';
-
-    protected string $_wp_page_slug = '';
-
-    public string $hook_file     = '';
-
-    public string $menu_slug     = '';
-
-    /**
-     * @deprecated
-     */
-    public string $menu_label    = '';
-
-    protected array $_files_hooked = [];
-
-    protected array $_hook_paths   = [];
-
-
-    /**
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function __construct(RequestInterface $request = null)
-    {
-        $this->loader  = LoaderFactory::getLoader();
-        $this->request = $request instanceof RequestInterface
-            ? $request
-            : $this->loader->getShared(RequestInterface::class);
-        // set global defaults
-        $this->_set_defaults();
-        // set properties that are always available with objects.
-        $this->_set_init_properties();
-        // global styles/scripts across all wp admin pages
-        add_action('admin_enqueue_scripts', [$this, 'load_wp_global_scripts_styles'], 5);
-        // load initial stuff.
-        $this->_set_file_and_folder_name();
-    }
-
-
-    /**
-     * _set_init_properties
-     * Child classes use to set the following properties:
-     * $label
-     *
-     * @abstract
-     * @return void
-     */
-    abstract protected function _set_init_properties();
-
-
-    /**
-     * @return AdminMenuItem|null
-     * @since       4.4.0
-     * @deprecated  5.0.0.p
-     */
-    public function get_menu_map()
-    {
-        return $this->adminMenu();
-    }
-
-
-    /**
-     * _set_menu_map is a function that child classes use to set the menu_map property (which should be an instance of
-     * EE_Admin_Page_Menu_Map.  Their menu can either be EE_Admin_Page_Main_Menu or AdminMenuSubItem.
-     *
-     * @since       4.4.0
-     * @deprecated  5.0.0.p
-     */
-    protected function _set_menu_map()
-    {
-    }
-
-
-    /**
-     * @since   5.0.0.p
-     */
-    public function setupLegacyAdminMenuItem()
-    {
-        // will be overridden by child classes not using new system
-        $this->_set_menu_map();
-    }
-
-
-    /**
-     * Child classes should return an array of properties used to construct the AdminMenuItem
-     *
-     * @return array
-     * @since 5.0.0.p
-     */
-    public function getMenuProperties(): array
-    {
-        return [];
-    }
-
-
-    /**
-     * @param AdminMenuItem $menu
-     * @return void
-     * @since 5.0.0.p
-     */
-    public function setAdminMenu(AdminMenuItem $menu): void
-    {
-        $this->_menu_map = $menu;
-    }
-
-
-    /**
-     * returns the menu map for this admin page
-     *
-     * @return AdminMenuItem|null
-     * @since 5.0.0.p
-     */
-    public function adminMenu(): ?AdminMenuItem
-    {
-        return $this->_menu_map;
-    }
-
-
-    /**
-     * @param string $wp_page_slug
-     * @since 5.0.0.p
-     */
-    public function setWpPageSlug(string $wp_page_slug): void
-    {
-        $this->_wp_page_slug = $wp_page_slug;
-    }
-
-
-    /**
-     * This loads scripts and styles for the EE_Admin system
-     * that must be available on ALL WP admin pages (i.e. EE_menu items)
-     *
-     * @return void
-     */
-    public function load_wp_global_scripts_styles()
-    {
-        wp_register_style(
-            'espresso_admin_base',
-            EE_ADMIN_URL . 'assets/ee-admin-base.css',
-            ['dashicons'],
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_register_style(
-            'espresso_menu',
-            EE_ADMIN_URL . 'assets/ee-admin-menu.css',
-            ['espresso_admin_base'],
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_style('espresso_admin_base');
-        wp_enqueue_style('espresso_menu');
-    }
-
-
-    /**
-     * this sets default properties (might be overridden in _set_init_properties);
-     *
-     * @return  void
-     */
-    private function _set_defaults()
-    {
-        $this->_file_name    = '';
-        $this->_folder_name  = '';
-        $this->_wp_page_slug = '';
-        $this->capability    = '';
-        $this->_routing      = true;
-        $this->_load_page    = false;
-        $this->_files_hooked = [];
-        $this->_hook_paths   = [];
-    }
-
-
-    public function setCapability($capability, $menu_slug)
-    {
-        $this->capability = apply_filters('FHEE_' . $menu_slug . '_capability', $capability);
-    }
-
-
-    /**
-     * @deprecated 5.0.0.p
-     */
-    protected function _set_capability()
-    {
-        if ($this->_menu_map instanceof AdminMenuItem) {
-            $this->setCapability($this->_menu_map->capability(), $this->_menu_map->menuSlug());
-        }
-    }
-
-
-    /**
-     * initialize_admin_page
-     * This method is what executes the loading of the specific page class for the given dir_name as called by the
-     * EE_Admin_Init class.
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function initialize_admin_page()
-    {
-        // let's check user access first
-        $this->_check_user_access();
-        if (! $this->_loaded_page_object instanceof EE_Admin_Page) {
-            return;
-        }
-        $this->_loaded_page_object->route_admin_request();
-    }
-
-
-    /**
-     * @param string $wp_page_slug
-     * @throws EE_Error
-     */
-    public function set_page_dependencies(string $wp_page_slug)
-    {
-        if (! $this->_load_page) {
-            return;
-        }
-        if (! $this->_loaded_page_object instanceof EE_Admin_Page) {
-            $msg[] = esc_html__(
-                'We can\'t load the page because we\'re missing a valid page object that tells us what to load',
-                'event_espresso'
-            );
-            $msg[] = $msg[0] . "\r\n"
-                     . sprintf(
-                         esc_html__(
-                             'The custom slug you have set for this page is %s. This means we\'re looking for the class %s_Admin_Page (found in %s_Admin_Page.core.php) within your %s directory',
-                             'event_espresso'
-                         ),
-                         $this->_file_name,
-                         $this->_file_name,
-                         $this->_folder_path . $this->_file_name,
-                         $this->_menu_map->menuSlug()
-                     );
-            throw new EE_Error(implode('||', $msg));
-        }
-        $this->_loaded_page_object->set_wp_page_slug($wp_page_slug);
-        $page_hook = "load-$wp_page_slug";
-        // hook into page load hook so all page specific stuff gets loaded.
-        if (! empty($wp_page_slug)) {
-            add_action($page_hook, [$this->_loaded_page_object, 'load_page_dependencies']);
-        }
-    }
-
-
-    /**
-     * This executes the initial page loads for EE_Admin pages to take care of any ajax or other code needing to run
-     * before the load-page... hook. Note, the page loads are happening around the wp_init hook.
-     *
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function do_initial_loads()
-    {
-        // no loading or initializing if menu map is setup incorrectly.
-        if (! $this->_menu_map instanceof AdminMenuItem) {
-            return;
-        }
-        $this->_initialize_admin_page();
-    }
-
-
-    /**
-     * all we're doing here is setting the $_file_name property for later use.
-     *
-     * @return void
-     */
-    private function _set_file_and_folder_name()
-    {
-        $bt = debug_backtrace();
-        // for more reliable determination of folder name
-        // we're using this to get the actual folder name of the CALLING class (i.e. the child class that extends this).  Why?  Because $this->menu_slug may be different than the folder name (to avoid conflicts with other plugins)
-        $class = get_class($this);
-        foreach ($bt as $index => $values) {
-            if (isset($values['class']) && $values['class'] == $class) {
-                $file_index         = $index - 1;
-                $this->_folder_name = basename(dirname($bt[ $file_index ]['file']));
-                if (! empty($this->_folder_name)) {
-                    break;
-                }
-            }
-        }
-        $this->_folder_path = EE_ADMIN_PAGES . $this->_folder_name . '/';
-        $this->_file_name   = preg_replace('/^ee/', 'EE', $this->_folder_name);
-        $this->_file_name   = ucwords(str_replace('_', ' ', $this->_file_name));
-        $this->_file_name   = str_replace(' ', '_', $this->_file_name);
-    }
-
-
-    /**
-     * This automatically checks if we have a hook class in the loaded child directory.  If we DO then we will register
-     * it with the appropriate pages.  That way all we have to do is make sure the file is named correctly and
-     * "dropped" in. Example: if we wanted to set this up for Messages hooking into Events then we would do:
-     * events_Messages_Hooks.class.php
-     *
-     * @param bool $extend This indicates whether we're checking the extend directory for any register_hooks
-     *                     files/classes
-     * @return array
-     */
-    public function register_hooks(bool $extend = false): array
-    {
-        // get a list of files in the directory that have the "Hook" in their name an
-        // if this is an extended check (i.e. caf is active) then we will scan the caffeinated/extend directory first and any hook files that are found will be have their reference added to the $_files_hook array property.  Then, we make sure that when we loop through the core decaf directories to find hook files that we skip over any hooks files that have already been set by caf.
-        if ($extend) {
-            $hook_files_glob_path = apply_filters(
-                'FHEE__EE_Admin_Page_Init__register_hooks__hook_files_glob_path__extend',
-                EE_CORE_CAF_ADMIN_EXTEND
-                . $this->_folder_name
-                . '/*'
-                . $this->_file_name
-                . '_Hooks_Extend.class.php'
-            );
-            $this->_hook_paths    = $this->_register_hook_files($hook_files_glob_path, $extend);
-        }
-        // loop through decaf folders
-        $hook_files_glob_path = apply_filters(
-            'FHEE__EE_Admin_Page_Init__register_hooks__hook_files_glob_path',
-            $this->_folder_path . '*' . $this->_file_name . '_Hooks.class.php'
-        );
-        $this->_hook_paths    = array_merge(
-            $this->_register_hook_files($hook_files_glob_path),
-            $this->_hook_paths
-        );  // making sure any extended hook paths are later in the array than the core hook paths!
-        return $this->_hook_paths;
-    }
-
-
-    protected function _register_hook_files($hook_files_glob_path, $extend = false): array
-    {
-        $hook_paths = glob($hook_files_glob_path);
-        if (empty($hook_paths)) {
-            return [];
-        }
-        foreach ($hook_paths as $file) {
-            // lets get the linked admin.
-            $hook_file = $extend
-                ? str_replace(EE_CORE_CAF_ADMIN_EXTEND . $this->_folder_name . '/', '', $file)
-                : str_replace($this->_folder_path, '', $file);
-            $replace   = $extend
-                ? '_' . $this->_file_name . '_Hooks_Extend.class.php'
-                : '_' . $this->_file_name . '_Hooks.class.php';
-            $rel_admin = str_replace($replace, '', $hook_file);
-            $rel_admin = strtolower($rel_admin);
-            // make sure we haven't already got a hook setup for this page path
-            if (in_array($rel_admin, $this->_files_hooked)) {
-                continue;
-            }
-            require_once $file;
-            $this->hook_file = $hook_file;
-            $rel_admin_hook  = 'FHEE_do_other_page_hooks_' . $rel_admin;
-            add_filter($rel_admin_hook, [$this, 'load_admin_hook']);
-            $this->_files_hooked[] = $rel_admin;
-        }
-        return $hook_paths;
-    }
-
-
-    public function load_admin_hook($registered_pages)
-    {
-        return array_merge((array) $this->hook_file, $registered_pages);
-    }
-
-
-    /**
-     * _initialize_admin_page
-     *
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @see  initialize_admin_page() for info
-     */
-    protected function _initialize_admin_page()
-    {
-        // JUST CHECK WE'RE ON RIGHT PAGE.
-        $page      = $this->request->getRequestParam('page');
-        $page      = $this->request->getRequestParam('current_page', $page);
-        $menu_slug = $this->_menu_map->menuSlug();
-
-        // leaving the following in for the time being
-        // because not sure if preventing multiple admin page loading will result in bad things happening
-        $darren_logic                       = false;  // true    false
-        $not_the_droids_you_are_looking_for = $darren_logic
-            ? $this->_routing && ($page === '' || $page !== $menu_slug)
-            : $page === '' || $page !== $menu_slug;
-        if ($not_the_droids_you_are_looking_for) {
-            // not on the right page so let's get out.
-            return;
-        }
-        $this->_load_page = true;
-
-        // we don't need to do a page_request check here because it's only called via WP menu system.
-        $admin_page  = $this->_file_name . '_Admin_Page';
-        $hook_suffix = "{$menu_slug}_$admin_page";
-        $admin_page  = apply_filters(
-            "FHEE__EE_Admin_Page_Init___initialize_admin_page__admin_page__$hook_suffix",
-            $admin_page
-        );
-        if (empty($admin_page)) {
-            return;
-        }
-        // define requested admin page class name then load the file and instantiate
-        $path_to_file = str_replace(['\\', '/'], '/', $this->_folder_path . $admin_page . '.core.php');
-        // so if the file would be in EE_ADMIN/attendees/Attendee_Admin_Page.core.php, the filter would be:
-        // FHEE__EE_Admin_Page_Init___initialize_admin_page__path_to_file__attendees_Attendee_Admin_Page
-        $path_to_file = apply_filters(
-            "FHEE__EE_Admin_Page_Init___initialize_admin_page__path_to_file__$hook_suffix",
-            $path_to_file
-        );
-        if (! is_readable($path_to_file)) {
-            return;
-        }
-        // This is a place where EE plugins can hook in to make sure their own files are required in the appropriate place
-        do_action('AHEE__EE_Admin_Page___initialize_admin_page__before_initialization');
-        do_action("AHEE__EE_Admin_Page___initialize_admin_page__before_initialization_$menu_slug");
-        require_once($path_to_file);
-        $this->_loaded_page_object = $this->loader->getShared($admin_page, [$this->_routing]);
-        $this->_loaded_page_object->initializePage();
-
-        do_action('AHEE__EE_Admin_Page___initialize_admin_page__after_initialization');
-        do_action("AHEE__EE_Admin_Page___initialize_admin_page__after_initialization_$menu_slug");
-    }
-
-
-    public function get_admin_page_name(): string
-    {
-        return $this->_file_name . '_Admin_Page';
-    }
-
-
-    /**
-     * @return EE_Admin_Page|null
-     */
-    public function loaded_page_object(): ?EE_Admin_Page
-    {
-        return $this->_loaded_page_object;
-    }
-
-
-    /**
-     * _check_user_access
-     * verifies user access for this admin page.  If no user access is available then let's gracefully exit with a
-     * WordPress die message.
-     *
-     * @return void  wp_die if fail
-     */
-    private function _check_user_access()
-    {
-        if (! $this->_menu_map->currentUserHasAccess()) {
-            wp_die(
-                esc_html__('You don\'t have access to this page.', 'event_espresso'),
-                '',
-                ['back_link' => true]
-            );
-        }
-    }
+	protected ?LoaderInterface $loader              = null;
+
+	protected ?RequestInterface $request             = null;
+
+	private bool $_load_page          = false;
+
+	protected bool $_routing            = false;
+
+	/**
+	 * Menu map has a capability.  However, this allows admin pages to have separate capability requirements for menus
+	 * and accessing pages.  If capability is NOT set, then it defaults to the menu_map capability.
+	 *
+	 * @var string
+	 */
+	public string $capability = '';
+
+	/**
+	 * identity properties (set in _set_defaults and _set_init_properties)
+	 */
+	public string $label         = '';
+
+	protected string $_file_name    = '';
+
+	protected string $_folder_name  = '';
+
+	protected string $_folder_path  = '';
+
+	protected string $_wp_page_slug = '';
+
+	public string $hook_file     = '';
+
+	public string $menu_slug     = '';
+
+	/**
+	 * @deprecated
+	 */
+	public string $menu_label    = '';
+
+	protected array $_files_hooked = [];
+
+	protected array $_hook_paths   = [];
+
+
+	/**
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function __construct(RequestInterface $request = null)
+	{
+		$this->loader  = LoaderFactory::getLoader();
+		$this->request = $request instanceof RequestInterface
+			? $request
+			: $this->loader->getShared(RequestInterface::class);
+		// set global defaults
+		$this->_set_defaults();
+		// set properties that are always available with objects.
+		$this->_set_init_properties();
+		// global styles/scripts across all wp admin pages
+		add_action('admin_enqueue_scripts', [$this, 'load_wp_global_scripts_styles'], 5);
+		// load initial stuff.
+		$this->_set_file_and_folder_name();
+	}
+
+
+	/**
+	 * _set_init_properties
+	 * Child classes use to set the following properties:
+	 * $label
+	 *
+	 * @abstract
+	 * @return void
+	 */
+	abstract protected function _set_init_properties();
+
+
+	/**
+	 * @return AdminMenuItem|null
+	 * @since       4.4.0
+	 * @deprecated  5.0.0.p
+	 */
+	public function get_menu_map()
+	{
+		return $this->adminMenu();
+	}
+
+
+	/**
+	 * _set_menu_map is a function that child classes use to set the menu_map property (which should be an instance of
+	 * EE_Admin_Page_Menu_Map.  Their menu can either be EE_Admin_Page_Main_Menu or AdminMenuSubItem.
+	 *
+	 * @since       4.4.0
+	 * @deprecated  5.0.0.p
+	 */
+	protected function _set_menu_map()
+	{
+	}
+
+
+	/**
+	 * @since   5.0.0.p
+	 */
+	public function setupLegacyAdminMenuItem()
+	{
+		// will be overridden by child classes not using new system
+		$this->_set_menu_map();
+	}
+
+
+	/**
+	 * Child classes should return an array of properties used to construct the AdminMenuItem
+	 *
+	 * @return array
+	 * @since 5.0.0.p
+	 */
+	public function getMenuProperties(): array
+	{
+		return [];
+	}
+
+
+	/**
+	 * @param AdminMenuItem $menu
+	 * @return void
+	 * @since 5.0.0.p
+	 */
+	public function setAdminMenu(AdminMenuItem $menu): void
+	{
+		$this->_menu_map = $menu;
+	}
+
+
+	/**
+	 * returns the menu map for this admin page
+	 *
+	 * @return AdminMenuItem|null
+	 * @since 5.0.0.p
+	 */
+	public function adminMenu(): ?AdminMenuItem
+	{
+		return $this->_menu_map;
+	}
+
+
+	/**
+	 * @param string $wp_page_slug
+	 * @since 5.0.0.p
+	 */
+	public function setWpPageSlug(string $wp_page_slug): void
+	{
+		$this->_wp_page_slug = $wp_page_slug;
+	}
+
+
+	/**
+	 * This loads scripts and styles for the EE_Admin system
+	 * that must be available on ALL WP admin pages (i.e. EE_menu items)
+	 *
+	 * @return void
+	 */
+	public function load_wp_global_scripts_styles()
+	{
+		wp_register_style(
+			'espresso_admin_base',
+			EE_ADMIN_URL . 'assets/ee-admin-base.css',
+			['dashicons'],
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_register_style(
+			'espresso_menu',
+			EE_ADMIN_URL . 'assets/ee-admin-menu.css',
+			['espresso_admin_base'],
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_style('espresso_admin_base');
+		wp_enqueue_style('espresso_menu');
+	}
+
+
+	/**
+	 * this sets default properties (might be overridden in _set_init_properties);
+	 *
+	 * @return  void
+	 */
+	private function _set_defaults()
+	{
+		$this->_file_name    = '';
+		$this->_folder_name  = '';
+		$this->_wp_page_slug = '';
+		$this->capability    = '';
+		$this->_routing      = true;
+		$this->_load_page    = false;
+		$this->_files_hooked = [];
+		$this->_hook_paths   = [];
+	}
+
+
+	public function setCapability($capability, $menu_slug)
+	{
+		$this->capability = apply_filters('FHEE_' . $menu_slug . '_capability', $capability);
+	}
+
+
+	/**
+	 * @deprecated 5.0.0.p
+	 */
+	protected function _set_capability()
+	{
+		if ($this->_menu_map instanceof AdminMenuItem) {
+			$this->setCapability($this->_menu_map->capability(), $this->_menu_map->menuSlug());
+		}
+	}
+
+
+	/**
+	 * initialize_admin_page
+	 * This method is what executes the loading of the specific page class for the given dir_name as called by the
+	 * EE_Admin_Init class.
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function initialize_admin_page()
+	{
+		// let's check user access first
+		$this->_check_user_access();
+		if (! $this->_loaded_page_object instanceof EE_Admin_Page) {
+			return;
+		}
+		$this->_loaded_page_object->route_admin_request();
+	}
+
+
+	/**
+	 * @param string $wp_page_slug
+	 * @throws EE_Error
+	 */
+	public function set_page_dependencies(string $wp_page_slug)
+	{
+		if (! $this->_load_page) {
+			return;
+		}
+		if (! $this->_loaded_page_object instanceof EE_Admin_Page) {
+			$msg[] = esc_html__(
+				'We can\'t load the page because we\'re missing a valid page object that tells us what to load',
+				'event_espresso'
+			);
+			$msg[] = $msg[0] . "\r\n"
+					 . sprintf(
+						 esc_html__(
+							 'The custom slug you have set for this page is %s. This means we\'re looking for the class %s_Admin_Page (found in %s_Admin_Page.core.php) within your %s directory',
+							 'event_espresso'
+						 ),
+						 $this->_file_name,
+						 $this->_file_name,
+						 $this->_folder_path . $this->_file_name,
+						 $this->_menu_map->menuSlug()
+					 );
+			throw new EE_Error(implode('||', $msg));
+		}
+		$this->_loaded_page_object->set_wp_page_slug($wp_page_slug);
+		$page_hook = "load-$wp_page_slug";
+		// hook into page load hook so all page specific stuff gets loaded.
+		if (! empty($wp_page_slug)) {
+			add_action($page_hook, [$this->_loaded_page_object, 'load_page_dependencies']);
+		}
+	}
+
+
+	/**
+	 * This executes the initial page loads for EE_Admin pages to take care of any ajax or other code needing to run
+	 * before the load-page... hook. Note, the page loads are happening around the wp_init hook.
+	 *
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function do_initial_loads()
+	{
+		// no loading or initializing if menu map is setup incorrectly.
+		if (! $this->_menu_map instanceof AdminMenuItem) {
+			return;
+		}
+		$this->_initialize_admin_page();
+	}
+
+
+	/**
+	 * all we're doing here is setting the $_file_name property for later use.
+	 *
+	 * @return void
+	 */
+	private function _set_file_and_folder_name()
+	{
+		$bt = debug_backtrace();
+		// for more reliable determination of folder name
+		// we're using this to get the actual folder name of the CALLING class (i.e. the child class that extends this).  Why?  Because $this->menu_slug may be different than the folder name (to avoid conflicts with other plugins)
+		$class = get_class($this);
+		foreach ($bt as $index => $values) {
+			if (isset($values['class']) && $values['class'] == $class) {
+				$file_index         = $index - 1;
+				$this->_folder_name = basename(dirname($bt[ $file_index ]['file']));
+				if (! empty($this->_folder_name)) {
+					break;
+				}
+			}
+		}
+		$this->_folder_path = EE_ADMIN_PAGES . $this->_folder_name . '/';
+		$this->_file_name   = preg_replace('/^ee/', 'EE', $this->_folder_name);
+		$this->_file_name   = ucwords(str_replace('_', ' ', $this->_file_name));
+		$this->_file_name   = str_replace(' ', '_', $this->_file_name);
+	}
+
+
+	/**
+	 * This automatically checks if we have a hook class in the loaded child directory.  If we DO then we will register
+	 * it with the appropriate pages.  That way all we have to do is make sure the file is named correctly and
+	 * "dropped" in. Example: if we wanted to set this up for Messages hooking into Events then we would do:
+	 * events_Messages_Hooks.class.php
+	 *
+	 * @param bool $extend This indicates whether we're checking the extend directory for any register_hooks
+	 *                     files/classes
+	 * @return array
+	 */
+	public function register_hooks(bool $extend = false): array
+	{
+		// get a list of files in the directory that have the "Hook" in their name an
+		// if this is an extended check (i.e. caf is active) then we will scan the caffeinated/extend directory first and any hook files that are found will be have their reference added to the $_files_hook array property.  Then, we make sure that when we loop through the core decaf directories to find hook files that we skip over any hooks files that have already been set by caf.
+		if ($extend) {
+			$hook_files_glob_path = apply_filters(
+				'FHEE__EE_Admin_Page_Init__register_hooks__hook_files_glob_path__extend',
+				EE_CORE_CAF_ADMIN_EXTEND
+				. $this->_folder_name
+				. '/*'
+				. $this->_file_name
+				. '_Hooks_Extend.class.php'
+			);
+			$this->_hook_paths    = $this->_register_hook_files($hook_files_glob_path, $extend);
+		}
+		// loop through decaf folders
+		$hook_files_glob_path = apply_filters(
+			'FHEE__EE_Admin_Page_Init__register_hooks__hook_files_glob_path',
+			$this->_folder_path . '*' . $this->_file_name . '_Hooks.class.php'
+		);
+		$this->_hook_paths    = array_merge(
+			$this->_register_hook_files($hook_files_glob_path),
+			$this->_hook_paths
+		);  // making sure any extended hook paths are later in the array than the core hook paths!
+		return $this->_hook_paths;
+	}
+
+
+	protected function _register_hook_files($hook_files_glob_path, $extend = false): array
+	{
+		$hook_paths = glob($hook_files_glob_path);
+		if (empty($hook_paths)) {
+			return [];
+		}
+		foreach ($hook_paths as $file) {
+			// lets get the linked admin.
+			$hook_file = $extend
+				? str_replace(EE_CORE_CAF_ADMIN_EXTEND . $this->_folder_name . '/', '', $file)
+				: str_replace($this->_folder_path, '', $file);
+			$replace   = $extend
+				? '_' . $this->_file_name . '_Hooks_Extend.class.php'
+				: '_' . $this->_file_name . '_Hooks.class.php';
+			$rel_admin = str_replace($replace, '', $hook_file);
+			$rel_admin = strtolower($rel_admin);
+			// make sure we haven't already got a hook setup for this page path
+			if (in_array($rel_admin, $this->_files_hooked)) {
+				continue;
+			}
+			require_once $file;
+			$this->hook_file = $hook_file;
+			$rel_admin_hook  = 'FHEE_do_other_page_hooks_' . $rel_admin;
+			add_filter($rel_admin_hook, [$this, 'load_admin_hook']);
+			$this->_files_hooked[] = $rel_admin;
+		}
+		return $hook_paths;
+	}
+
+
+	public function load_admin_hook($registered_pages)
+	{
+		return array_merge((array) $this->hook_file, $registered_pages);
+	}
+
+
+	/**
+	 * _initialize_admin_page
+	 *
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @see  initialize_admin_page() for info
+	 */
+	protected function _initialize_admin_page()
+	{
+		// JUST CHECK WE'RE ON RIGHT PAGE.
+		$page      = $this->request->getRequestParam('page');
+		$page      = $this->request->getRequestParam('current_page', $page);
+		$menu_slug = $this->_menu_map->menuSlug();
+
+		// leaving the following in for the time being
+		// because not sure if preventing multiple admin page loading will result in bad things happening
+		$darren_logic                       = false;  // true    false
+		$not_the_droids_you_are_looking_for = $darren_logic
+			? $this->_routing && ($page === '' || $page !== $menu_slug)
+			: $page === '' || $page !== $menu_slug;
+		if ($not_the_droids_you_are_looking_for) {
+			// not on the right page so let's get out.
+			return;
+		}
+		$this->_load_page = true;
+
+		// we don't need to do a page_request check here because it's only called via WP menu system.
+		$admin_page  = $this->_file_name . '_Admin_Page';
+		$hook_suffix = "{$menu_slug}_$admin_page";
+		$admin_page  = apply_filters(
+			"FHEE__EE_Admin_Page_Init___initialize_admin_page__admin_page__$hook_suffix",
+			$admin_page
+		);
+		if (empty($admin_page)) {
+			return;
+		}
+		// define requested admin page class name then load the file and instantiate
+		$path_to_file = str_replace(['\\', '/'], '/', $this->_folder_path . $admin_page . '.core.php');
+		// so if the file would be in EE_ADMIN/attendees/Attendee_Admin_Page.core.php, the filter would be:
+		// FHEE__EE_Admin_Page_Init___initialize_admin_page__path_to_file__attendees_Attendee_Admin_Page
+		$path_to_file = apply_filters(
+			"FHEE__EE_Admin_Page_Init___initialize_admin_page__path_to_file__$hook_suffix",
+			$path_to_file
+		);
+		if (! is_readable($path_to_file)) {
+			return;
+		}
+		// This is a place where EE plugins can hook in to make sure their own files are required in the appropriate place
+		do_action('AHEE__EE_Admin_Page___initialize_admin_page__before_initialization');
+		do_action("AHEE__EE_Admin_Page___initialize_admin_page__before_initialization_$menu_slug");
+		require_once($path_to_file);
+		$this->_loaded_page_object = $this->loader->getShared($admin_page, [$this->_routing]);
+		$this->_loaded_page_object->initializePage();
+
+		do_action('AHEE__EE_Admin_Page___initialize_admin_page__after_initialization');
+		do_action("AHEE__EE_Admin_Page___initialize_admin_page__after_initialization_$menu_slug");
+	}
+
+
+	public function get_admin_page_name(): string
+	{
+		return $this->_file_name . '_Admin_Page';
+	}
+
+
+	/**
+	 * @return EE_Admin_Page|null
+	 */
+	public function loaded_page_object(): ?EE_Admin_Page
+	{
+		return $this->_loaded_page_object;
+	}
+
+
+	/**
+	 * _check_user_access
+	 * verifies user access for this admin page.  If no user access is available then let's gracefully exit with a
+	 * WordPress die message.
+	 *
+	 * @return void  wp_die if fail
+	 */
+	private function _check_user_access()
+	{
+		if (! $this->_menu_map->currentUserHasAccess()) {
+			wp_die(
+				esc_html__('You don\'t have access to this page.', 'event_espresso'),
+				'',
+				['back_link' => true]
+			);
+		}
+	}
 }

Spacing +33 added lines, -33 removed lines

@@ -25,13 +25,13 @@ 
 
     protected ?EE_Admin_Page $_loaded_page_object = null;
 
-    protected ?LoaderInterface $loader              = null;
+    protected ?LoaderInterface $loader = null;
 
-    protected ?RequestInterface $request             = null;
+    protected ?RequestInterface $request = null;
 
-    private bool $_load_page          = false;
+    private bool $_load_page = false;
 
-    protected bool $_routing            = false;
+    protected bool $_routing = false;
 
     /**
      * Menu map has a capability.  However, this allows admin pages to have separate capability requirements for menus
@@ -44,7 +44,7 @@ 
     /**
      * identity properties (set in _set_defaults and _set_init_properties)
      */
-    public string $label         = '';
+    public string $label = '';
 
     protected string $_file_name    = '';
 
@@ -61,7 +61,7 @@ 
     /**
      * @deprecated
      */
-    public string $menu_label    = '';
+    public string $menu_label = '';
 
     protected array $_files_hooked = [];
 
@@ -189,13 +189,13 @@ 
     {
         wp_register_style(
             'espresso_admin_base',
-            EE_ADMIN_URL . 'assets/ee-admin-base.css',
+            EE_ADMIN_URL.'assets/ee-admin-base.css',
             ['dashicons'],
             EVENT_ESPRESSO_VERSION
         );
         wp_register_style(
             'espresso_menu',
-            EE_ADMIN_URL . 'assets/ee-admin-menu.css',
+            EE_ADMIN_URL.'assets/ee-admin-menu.css',
             ['espresso_admin_base'],
             EVENT_ESPRESSO_VERSION
         );
@@ -224,7 +224,7 @@ 
 
     public function setCapability($capability, $menu_slug)
     {
-        $this->capability = apply_filters('FHEE_' . $menu_slug . '_capability', $capability);
+        $this->capability = apply_filters('FHEE_'.$menu_slug.'_capability', $capability);
     }
 
 
@@ -252,7 +252,7 @@ 
     {
         // let's check user access first
         $this->_check_user_access();
-        if (! $this->_loaded_page_object instanceof EE_Admin_Page) {
+        if ( ! $this->_loaded_page_object instanceof EE_Admin_Page) {
             return;
         }
         $this->_loaded_page_object->route_admin_request();
@@ -265,15 +265,15 @@ 
      */
     public function set_page_dependencies(string $wp_page_slug)
     {
-        if (! $this->_load_page) {
+        if ( ! $this->_load_page) {
             return;
         }
-        if (! $this->_loaded_page_object instanceof EE_Admin_Page) {
+        if ( ! $this->_loaded_page_object instanceof EE_Admin_Page) {
             $msg[] = esc_html__(
                 'We can\'t load the page because we\'re missing a valid page object that tells us what to load',
                 'event_espresso'
             );
-            $msg[] = $msg[0] . "\r\n"
+            $msg[] = $msg[0]."\r\n"
                      . sprintf(
                          esc_html__(
                              'The custom slug you have set for this page is %s. This means we\'re looking for the class %s_Admin_Page (found in %s_Admin_Page.core.php) within your %s directory',
@@ -281,7 +281,7 @@ 
                          ),
                          $this->_file_name,
                          $this->_file_name,
-                         $this->_folder_path . $this->_file_name,
+                         $this->_folder_path.$this->_file_name,
                          $this->_menu_map->menuSlug()
                      );
             throw new EE_Error(implode('||', $msg));
@@ -289,7 +289,7 @@ 
         $this->_loaded_page_object->set_wp_page_slug($wp_page_slug);
         $page_hook = "load-$wp_page_slug";
         // hook into page load hook so all page specific stuff gets loaded.
-        if (! empty($wp_page_slug)) {
+        if ( ! empty($wp_page_slug)) {
             add_action($page_hook, [$this->_loaded_page_object, 'load_page_dependencies']);
         }
     }
@@ -309,7 +309,7 @@ 
     public function do_initial_loads()
     {
         // no loading or initializing if menu map is setup incorrectly.
-        if (! $this->_menu_map instanceof AdminMenuItem) {
+        if ( ! $this->_menu_map instanceof AdminMenuItem) {
             return;
         }
         $this->_initialize_admin_page();
@@ -330,13 +330,13 @@ 
         foreach ($bt as $index => $values) {
             if (isset($values['class']) && $values['class'] == $class) {
                 $file_index         = $index - 1;
-                $this->_folder_name = basename(dirname($bt[ $file_index ]['file']));
-                if (! empty($this->_folder_name)) {
+                $this->_folder_name = basename(dirname($bt[$file_index]['file']));
+                if ( ! empty($this->_folder_name)) {
                     break;
                 }
             }
         }
-        $this->_folder_path = EE_ADMIN_PAGES . $this->_folder_name . '/';
+        $this->_folder_path = EE_ADMIN_PAGES.$this->_folder_name.'/';
         $this->_file_name   = preg_replace('/^ee/', 'EE', $this->_folder_name);
         $this->_file_name   = ucwords(str_replace('_', ' ', $this->_file_name));
         $this->_file_name   = str_replace(' ', '_', $this->_file_name);
@@ -366,17 +366,17 @@ 
                 . $this->_file_name
                 . '_Hooks_Extend.class.php'
             );
-            $this->_hook_paths    = $this->_register_hook_files($hook_files_glob_path, $extend);
+            $this->_hook_paths = $this->_register_hook_files($hook_files_glob_path, $extend);
         }
         // loop through decaf folders
         $hook_files_glob_path = apply_filters(
             'FHEE__EE_Admin_Page_Init__register_hooks__hook_files_glob_path',
-            $this->_folder_path . '*' . $this->_file_name . '_Hooks.class.php'
+            $this->_folder_path.'*'.$this->_file_name.'_Hooks.class.php'
         );
-        $this->_hook_paths    = array_merge(
+        $this->_hook_paths = array_merge(
             $this->_register_hook_files($hook_files_glob_path),
             $this->_hook_paths
-        );  // making sure any extended hook paths are later in the array than the core hook paths!
+        ); // making sure any extended hook paths are later in the array than the core hook paths!
         return $this->_hook_paths;
     }
 
@@ -390,11 +390,11 @@ 
         foreach ($hook_paths as $file) {
             // lets get the linked admin.
             $hook_file = $extend
-                ? str_replace(EE_CORE_CAF_ADMIN_EXTEND . $this->_folder_name . '/', '', $file)
+                ? str_replace(EE_CORE_CAF_ADMIN_EXTEND.$this->_folder_name.'/', '', $file)
                 : str_replace($this->_folder_path, '', $file);
             $replace   = $extend
-                ? '_' . $this->_file_name . '_Hooks_Extend.class.php'
-                : '_' . $this->_file_name . '_Hooks.class.php';
+                ? '_'.$this->_file_name.'_Hooks_Extend.class.php'
+                : '_'.$this->_file_name.'_Hooks.class.php';
             $rel_admin = str_replace($replace, '', $hook_file);
             $rel_admin = strtolower($rel_admin);
             // make sure we haven't already got a hook setup for this page path
@@ -403,7 +403,7 @@ 
             }
             require_once $file;
             $this->hook_file = $hook_file;
-            $rel_admin_hook  = 'FHEE_do_other_page_hooks_' . $rel_admin;
+            $rel_admin_hook  = 'FHEE_do_other_page_hooks_'.$rel_admin;
             add_filter($rel_admin_hook, [$this, 'load_admin_hook']);
             $this->_files_hooked[] = $rel_admin;
         }
@@ -433,7 +433,7 @@ 
 
         // leaving the following in for the time being
         // because not sure if preventing multiple admin page loading will result in bad things happening
-        $darren_logic                       = false;  // true    false
+        $darren_logic                       = false; // true    false
         $not_the_droids_you_are_looking_for = $darren_logic
             ? $this->_routing && ($page === '' || $page !== $menu_slug)
             : $page === '' || $page !== $menu_slug;
@@ -444,7 +444,7 @@ 
         $this->_load_page = true;
 
         // we don't need to do a page_request check here because it's only called via WP menu system.
-        $admin_page  = $this->_file_name . '_Admin_Page';
+        $admin_page  = $this->_file_name.'_Admin_Page';
         $hook_suffix = "{$menu_slug}_$admin_page";
         $admin_page  = apply_filters(
             "FHEE__EE_Admin_Page_Init___initialize_admin_page__admin_page__$hook_suffix",
@@ -454,14 +454,14 @@ 
             return;
         }
         // define requested admin page class name then load the file and instantiate
-        $path_to_file = str_replace(['\\', '/'], '/', $this->_folder_path . $admin_page . '.core.php');
+        $path_to_file = str_replace(['\\', '/'], '/', $this->_folder_path.$admin_page.'.core.php');
         // so if the file would be in EE_ADMIN/attendees/Attendee_Admin_Page.core.php, the filter would be:
         // FHEE__EE_Admin_Page_Init___initialize_admin_page__path_to_file__attendees_Attendee_Admin_Page
         $path_to_file = apply_filters(
             "FHEE__EE_Admin_Page_Init___initialize_admin_page__path_to_file__$hook_suffix",
             $path_to_file
         );
-        if (! is_readable($path_to_file)) {
+        if ( ! is_readable($path_to_file)) {
             return;
         }
         // This is a place where EE plugins can hook in to make sure their own files are required in the appropriate place
@@ -478,7 +478,7 @@ 
 
     public function get_admin_page_name(): string
     {
-        return $this->_file_name . '_Admin_Page';
+        return $this->_file_name.'_Admin_Page';
     }
 
 
@@ -500,7 +500,7 @@ 
      */
     private function _check_user_access()
     {
-        if (! $this->_menu_map->currentUserHasAccess()) {
+        if ( ! $this->_menu_map->currentUserHasAccess()) {
             wp_die(
                 esc_html__('You don\'t have access to this page.', 'event_espresso'),
                 '',

core/admin/templates/admin_wrapper_ajax.template.php

Indentation +6 added lines, -6 removed lines

@@ -19,11 +19,11 @@
 
     <div class="ee-notices"><?php echo isset($ajax_notices) ? $ajax_notices  : '';// already escaped ?></div>
     <?php
-    do_action('AHEE__admin_wrapper__template__before_admin_page_content');
-    echo wp_kses($before_admin_page_content, AllowedTags::getWithFormTags());
-    echo wp_kses($admin_page_content, AllowedTags::getWithFullTags());
-    echo wp_kses($after_admin_page_content, AllowedTags::getWithFormTags());
-    do_action('AHEE__admin_wrapper__template__after_admin_page_content');
-    ?>
+	do_action('AHEE__admin_wrapper__template__before_admin_page_content');
+	echo wp_kses($before_admin_page_content, AllowedTags::getWithFormTags());
+	echo wp_kses($admin_page_content, AllowedTags::getWithFullTags());
+	echo wp_kses($after_admin_page_content, AllowedTags::getWithFormTags());
+	do_action('AHEE__admin_wrapper__template__after_admin_page_content');
+	?>
 </div>
 <!-- espresso-admin -->

Spacing +2 added lines, -2 removed lines

@@ -14,10 +14,10 @@
 
 <div class="wrap espresso-admin">
     <h1>
-        <?php echo esc_html__('Event Espresso', 'event_espresso') . ' ' . wp_kses($admin_page_title, AllowedTags::getWithFormTags()); ?>
+        <?php echo esc_html__('Event Espresso', 'event_espresso').' '.wp_kses($admin_page_title, AllowedTags::getWithFormTags()); ?>
     </h1>
 
-    <div class="ee-notices"><?php echo isset($ajax_notices) ? $ajax_notices  : '';// already escaped ?></div>
+    <div class="ee-notices"><?php echo isset($ajax_notices) ? $ajax_notices : ''; // already escaped ?></div>
     <?php
     do_action('AHEE__admin_wrapper__template__before_admin_page_content');
     echo wp_kses($before_admin_page_content, AllowedTags::getWithFormTags());

core/admin/EE_Admin_List_Table.core.php

Indentation +972 added lines, -972 removed lines

@@ -6,7 +6,7 @@ 
 use EventEspresso\core\services\request\sanitizers\AllowedTags;
 
 if (! class_exists('WP_List_Table')) {
-    require_once ABSPATH . 'wp-admin/includes/class-wp-list-table.php';
+	require_once ABSPATH . 'wp-admin/includes/class-wp-list-table.php';
 }
 
 
@@ -24,465 +24,465 @@ 
  */
 abstract class EE_Admin_List_Table extends WP_List_Table
 {
-    const ACTION_COPY    = 'duplicate';
-
-    const ACTION_DELETE  = 'delete';
-
-    const ACTION_EDIT    = 'edit';
-
-    const ACTION_RESTORE = 'restore';
-
-    const ACTION_TRASH   = 'trash';
-
-    protected static array $actions = [
-        self::ACTION_COPY,
-        self::ACTION_DELETE,
-        self::ACTION_EDIT,
-        self::ACTION_RESTORE,
-        self::ACTION_TRASH,
-    ];
-
-    /**
-     * holds the data that will be processed for the table
-     *
-     * @var array $_data
-     */
-    protected array $_data;
-
-
-    /**
-     * This holds the value of all the data available for the given view (for all pages).
-     *
-     * @var int $_all_data_count
-     */
-    protected int $_all_data_count;
-
-
-    /**
-     * Will contain the count of trashed items for the view label.
-     *
-     * @var int $_trashed_count
-     */
-    protected int $_trashed_count;
-
-
-    /**
-     * This is what will be referenced as the slug for the current screen
-     *
-     * @var string $_screen
-     */
-    protected string $_screen;
-
-
-    /**
-     * this is the EE_Admin_Page object
-     *
-     * @var EE_Admin_Page $_admin_page
-     */
-    protected EE_Admin_Page $_admin_page;
-
-
-    /**
-     * The current view
-     *
-     * @var string $_view
-     */
-    protected string $_view;
-
-
-    /**
-     * array of possible views for this table
-     *
-     * @var array $_views
-     */
-    protected array $_views;
-
-
-    /**
-     * An array of key => value pairs containing information about the current table
-     * array(
-     *        'plural' => 'plural label',
-     *        'singular' => 'singular label',
-     *        'ajax' => false, //whether to use ajax or not
-     *        'screen' => null, //string used to reference what screen this is
-     *        (WP_List_table converts to screen object)
-     * )
-     *
-     * @var array $_wp_list_args
-     */
-    protected array $_wp_list_args;
-
-    /**
-     * an array of column names
-     * array(
-     *    'internal-name' => 'Title'
-     * )
-     *
-     * @var array $_columns
-     */
-    protected array $_columns;
-
-    /**
-     * An array of sortable columns
-     * array(
-     *    'internal-name' => 'orderby' //or
-     *    'internal-name' => array( 'orderby', true )
-     * )
-     *
-     * @var array $_sortable_columns
-     */
-    protected array $_sortable_columns;
-
-    /**
-     * callback method used to perform AJAX row reordering
-     *
-     * @var string|null $_ajax_sorting_callback
-     */
-    protected ?string $_ajax_sorting_callback = null;
-
-    /**
-     * An array of hidden columns (if needed)
-     * array('internal-name', 'internal-name')
-     *
-     * @var array $_hidden_columns
-     */
-    protected array $_hidden_columns;
-
-    /**
-     * holds the per_page value
-     *
-     * @var int $_per_page
-     */
-    protected int $_per_page;
-
-    /**
-     * holds what page number is currently being viewed
-     *
-     * @var int $_current_page
-     */
-    protected int $_current_page;
-
-    /**
-     * the reference string for the nonce_action
-     *
-     * @var string $_nonce_action_ref
-     */
-    protected string $_nonce_action_ref;
-
-    /**
-     * property to hold incoming request data (as set by the admin_page_core)
-     *
-     * @var array $_req_data
-     */
-    protected array $_req_data;
-
-
-    /**
-     * yes / no array for admin form fields
-     *
-     * @var array $_yes_no
-     */
-    protected array $_yes_no = [];
-
-    /**
-     * Array describing buttons that should appear at the bottom of the page
-     * Keys are strings that represent the button's function (specifically a key in _labels['buttons']),
-     * and the values are another array with the following keys
-     * array(
-     *    'route' => 'page_route',
-     *    'extra_request' => array('evt_id' => 1 ); //extra request vars that need to be included in the button.
-     * )
-     *
-     * @var array $_bottom_buttons
-     */
-    protected array $_bottom_buttons = [];
-
-
-    /**
-     * Used to indicate what should be the primary column for the list table.
-     * If not present then falls back to what WP calculates
-     * as the primary column.
-     *
-     * @type string $_primary_column
-     */
-    protected string $_primary_column = '';
-
-
-    /**
-     * Used to indicate whether the table has a checkbox column or not.
-     *
-     * @type bool $_has_checkbox_column
-     */
-    protected bool $_has_checkbox_column = false;
-
-    /**
-     * @var AdminListTableFilters|null
-     */
-    protected ?AdminListTableFilters $admin_list_table_filters = null;
-
-    protected ?RequestInterface $request = null;
-
-
-    /**
-     * @param EE_Admin_Page              $admin_page we use this for obtaining everything we need in the list table
-     * @param AdminListTableFilters|null $filters    to display list table filters
-     */
-    public function __construct(EE_Admin_Page $admin_page, ?AdminListTableFilters $filters = null)
-    {
-        $this->request     = $this->request ?? LoaderFactory::getShared(RequestInterface::class);
-        $this->_admin_page = $admin_page;
-        // kept for back compat
-        $this->_req_data     = $this->_admin_page->get_request_data();
-        $this->_view         = $this->_admin_page->get_view();
-        $this->_views        = $this->_admin_page->get_list_table_view_RLs();
-        $this->_current_page = $this->get_pagenum();
-        $this->_screen       = $this->_admin_page->get_current_page() . '_' . $this->_admin_page->get_current_view();
-        $this->_yes_no       = [
-            esc_html__('No', 'event_espresso'),
-            esc_html__('Yes', 'event_espresso'),
-        ];
-
-        $this->_per_page = $this->get_items_per_page($this->_screen . '_per_page');
-
-        $this->admin_list_table_filters = $filters instanceof AdminListTableFilters
-            ? $filters
-            : LoaderFactory::getShared(AdminListTableFilters::class);
-
-        $this->_setup_data();
-        $this->_add_view_counts();
-        // ensure changes made to views in child classes get ported back to the admin page
-        $this->_admin_page->updateViews($this->_views);
-
-        $this->_nonce_action_ref = $this->_view;
-
-        $this->_set_properties();
-
-        // set primary column
-        add_filter('list_table_primary_column', [$this, 'set_primary_column']);
-
-        // set parent defaults
-        parent::__construct($this->_wp_list_args);
-
-        $this->prepare_items();
-    }
-
-
-    /**
-     * _setup_data
-     * this method is used to setup the $_data, $_all_data_count, and _per_page properties
-     *
-     * @return void
-     * @uses $this->_admin_page
-     */
-    abstract protected function _setup_data();
-
-
-    /**
-     * set the properties that this class needs to be able to execute wp_list_table properly
-     * properties set:
-     * _wp_list_args = what the arguments required for the parent _wp_list_table.
-     * _columns = set the columns in an array.
-     * _sortable_columns = columns that are sortable (array).
-     * _hidden_columns = columns that are hidden (array)
-     * _default_orderby = the default orderby for sorting.
-     *
-     * @abstract
-     * @access protected
-     * @return void
-     */
-    abstract protected function _set_properties();
-
-
-    /**
-     * _get_table_filters
-     * We use this to assemble and return any filters that are associated with this table that help further refine what
-     * gets shown in the table.
-     *
-     * @abstract
-     * @access protected
-     * @return string[]
-     */
-    abstract protected function _get_table_filters();
-
-
-    /**
-     * this is a method that child class will do to add counts to the views array so when views are displayed the
-     * counts of the views is accurate.
-     *
-     * @abstract
-     * @access protected
-     * @return void
-     */
-    abstract protected function _add_view_counts();
-
-
-    /**
-     * _get_hidden_fields
-     * returns a html string of hidden fields so if any table filters are used the current view will be respected.
-     *
-     * @return string
-     */
-    protected function _get_hidden_fields()
-    {
-        $page   = $this->request->getRequestParam('page', '');
-        $action = $this->request->getRequestParam('route', '');
-        $action = $this->request->getRequestParam('action', $action);
-        // if action is STILL empty, then we set it to default
-        $action = empty($action) || $action === '-1' ? 'default' : $action;
-        $field  = '<input type="hidden" name="page" value="' . esc_attr($page) . '" />' . "\n";
-        $field  .= '<input type="hidden" name="route" value="' . esc_attr($action) . '" />' . "\n";
-        $field  .= '<input type="hidden" name="perpage" value="' . esc_attr($this->_per_page) . '" />' . "\n";
-
-        $bulk_actions = $this->_get_bulk_actions();
-        foreach ($bulk_actions as $bulk_action => $label) {
-            $field .= '<input type="hidden" name="' . $bulk_action . '_nonce"'
-                . ' value="' . wp_create_nonce($bulk_action . '_nonce') . '" />' . "\n";
-        }
-
-        return $field;
-    }
-
-
-    /**
-     * _set_column_info
-     * we're using this to set the column headers property.
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _set_column_info()
-    {
-        $columns   = $this->get_columns();
-        $hidden    = $this->get_hidden_columns();
-        $_sortable = $this->get_sortable_columns();
-
-        /**
-         * Dynamic hook allowing for adding sortable columns in this list table.
-         * Note that $this->screen->id is in the format
-         * {sanitize_title($top_level_menu_label)}_page_{$espresso_admin_page_slug}.  So for the messages list
-         * table it is: event-espresso_page_espresso_messages.
-         * However, take note that if the top level menu label has been translated (i.e. "Event Espresso"). then the
-         * hook prefix ("event-espresso") will be different.
-         *
-         * @var array $_sortable
-         */
-        $_sortable = apply_filters(
-            "FHEE_manage_{$this->screen->id}_sortable_columns",
-            $_sortable,
-            $this->_screen,
-            $this
-        );
-
-        $sortable = [];
-        foreach ($_sortable as $id => $data) {
-            if (empty($data)) {
-                continue;
-            }
-            // fix for offset errors with WP_List_Table default get_columninfo()
-            if (is_array($data)) {
-                $_data[0] = key($data);
-                $_data[1] = $data[1] ?? false;
-            } else {
-                $_data[0] = $data;
-            }
-
-            $data = (array) $data;
-
-            if (! isset($data[1])) {
-                $_data[1] = false;
-            }
-
-            $sortable[ $id ] = $_data;
-        }
-        $primary               = $this->get_primary_column_name();
-        $this->_column_headers = [$columns, $hidden, $sortable, $primary];
-    }
-
-
-    /**
-     * Added for WP4.1 backward compat (@see https://events.codebasehq.com/projects/event-espresso/tickets/8814)
-     *
-     * @return string
-     */
-    protected function get_primary_column_name()
-    {
-        foreach (class_parents($this) as $parent) {
-            if ($parent === 'WP_List_Table' && method_exists($parent, 'get_primary_column_name')) {
-                return parent::get_primary_column_name();
-            }
-        }
-        return $this->_primary_column;
-    }
-
-
-    /**
-     * Added for WP4.1 backward compat (@see https://events.codebasehq.com/projects/event-espresso/tickets/8814)
-     *
-     * @param EE_Base_Class $item
-     * @param string        $column_name
-     * @param string        $primary
-     * @return string
-     */
-    protected function handle_row_actions($item, $column_name, $primary)
-    {
-        foreach (class_parents($this) as $parent) {
-            if ($parent === 'WP_List_Table' && method_exists($parent, 'handle_row_actions')) {
-                return parent::handle_row_actions($item, $column_name, $primary);
-            }
-        }
-        return '';
-    }
-
-
-    /**
-     * _get_bulk_actions
-     * This is a wrapper called by WP_List_Table::get_bulk_actions()
-     *
-     * @access protected
-     * @return array bulk_actions
-     */
-    protected function _get_bulk_actions(): array
-    {
-        $actions = [];
-        // the _views property should have the bulk_actions, so let's go through and extract them into a properly
-        // formatted array for the wp_list_table();
-        foreach ($this->_views as $view => $args) {
-            if ($this->_view === $view && isset($args['bulk_action']) && is_array($args['bulk_action'])) {
-                // each bulk action will correspond with a admin page route, so we can check whatever the capability is
-                // for that page route and skip adding the bulk action if no access for the current logged in user.
-                foreach ($args['bulk_action'] as $route => $label) {
-                    if ($this->_admin_page->check_user_access($route, true)) {
-                        $actions[ $route ] = $label;
-                    }
-                }
-            }
-        }
-        return $actions;
-    }
-
-
-    /**
-     * Generate the table navigation above or below the table.
-     * Overrides the parent table nav in WP_List_Table so we can hide the bulk action div if there are no bulk actions.
-     *
-     * @throws EE_Error
-     * @since 4.9.44.rc.001
-     */
-    public function display_tablenav($which)
-    {
-        if ('top' === $which) {
-            wp_nonce_field('bulk-' . $this->_args['plural']);
-        }
-
-        ob_start();
-        $this->extra_tablenav($which);
-        $ee_tablenav = ob_get_clean();
-
-        ob_start();
-        $this->bulk_actions();
-        $bulkactions = ob_get_clean();
-
-        ?>
+	const ACTION_COPY    = 'duplicate';
+
+	const ACTION_DELETE  = 'delete';
+
+	const ACTION_EDIT    = 'edit';
+
+	const ACTION_RESTORE = 'restore';
+
+	const ACTION_TRASH   = 'trash';
+
+	protected static array $actions = [
+		self::ACTION_COPY,
+		self::ACTION_DELETE,
+		self::ACTION_EDIT,
+		self::ACTION_RESTORE,
+		self::ACTION_TRASH,
+	];
+
+	/**
+	 * holds the data that will be processed for the table
+	 *
+	 * @var array $_data
+	 */
+	protected array $_data;
+
+
+	/**
+	 * This holds the value of all the data available for the given view (for all pages).
+	 *
+	 * @var int $_all_data_count
+	 */
+	protected int $_all_data_count;
+
+
+	/**
+	 * Will contain the count of trashed items for the view label.
+	 *
+	 * @var int $_trashed_count
+	 */
+	protected int $_trashed_count;
+
+
+	/**
+	 * This is what will be referenced as the slug for the current screen
+	 *
+	 * @var string $_screen
+	 */
+	protected string $_screen;
+
+
+	/**
+	 * this is the EE_Admin_Page object
+	 *
+	 * @var EE_Admin_Page $_admin_page
+	 */
+	protected EE_Admin_Page $_admin_page;
+
+
+	/**
+	 * The current view
+	 *
+	 * @var string $_view
+	 */
+	protected string $_view;
+
+
+	/**
+	 * array of possible views for this table
+	 *
+	 * @var array $_views
+	 */
+	protected array $_views;
+
+
+	/**
+	 * An array of key => value pairs containing information about the current table
+	 * array(
+	 *        'plural' => 'plural label',
+	 *        'singular' => 'singular label',
+	 *        'ajax' => false, //whether to use ajax or not
+	 *        'screen' => null, //string used to reference what screen this is
+	 *        (WP_List_table converts to screen object)
+	 * )
+	 *
+	 * @var array $_wp_list_args
+	 */
+	protected array $_wp_list_args;
+
+	/**
+	 * an array of column names
+	 * array(
+	 *    'internal-name' => 'Title'
+	 * )
+	 *
+	 * @var array $_columns
+	 */
+	protected array $_columns;
+
+	/**
+	 * An array of sortable columns
+	 * array(
+	 *    'internal-name' => 'orderby' //or
+	 *    'internal-name' => array( 'orderby', true )
+	 * )
+	 *
+	 * @var array $_sortable_columns
+	 */
+	protected array $_sortable_columns;
+
+	/**
+	 * callback method used to perform AJAX row reordering
+	 *
+	 * @var string|null $_ajax_sorting_callback
+	 */
+	protected ?string $_ajax_sorting_callback = null;
+
+	/**
+	 * An array of hidden columns (if needed)
+	 * array('internal-name', 'internal-name')
+	 *
+	 * @var array $_hidden_columns
+	 */
+	protected array $_hidden_columns;
+
+	/**
+	 * holds the per_page value
+	 *
+	 * @var int $_per_page
+	 */
+	protected int $_per_page;
+
+	/**
+	 * holds what page number is currently being viewed
+	 *
+	 * @var int $_current_page
+	 */
+	protected int $_current_page;
+
+	/**
+	 * the reference string for the nonce_action
+	 *
+	 * @var string $_nonce_action_ref
+	 */
+	protected string $_nonce_action_ref;
+
+	/**
+	 * property to hold incoming request data (as set by the admin_page_core)
+	 *
+	 * @var array $_req_data
+	 */
+	protected array $_req_data;
+
+
+	/**
+	 * yes / no array for admin form fields
+	 *
+	 * @var array $_yes_no
+	 */
+	protected array $_yes_no = [];
+
+	/**
+	 * Array describing buttons that should appear at the bottom of the page
+	 * Keys are strings that represent the button's function (specifically a key in _labels['buttons']),
+	 * and the values are another array with the following keys
+	 * array(
+	 *    'route' => 'page_route',
+	 *    'extra_request' => array('evt_id' => 1 ); //extra request vars that need to be included in the button.
+	 * )
+	 *
+	 * @var array $_bottom_buttons
+	 */
+	protected array $_bottom_buttons = [];
+
+
+	/**
+	 * Used to indicate what should be the primary column for the list table.
+	 * If not present then falls back to what WP calculates
+	 * as the primary column.
+	 *
+	 * @type string $_primary_column
+	 */
+	protected string $_primary_column = '';
+
+
+	/**
+	 * Used to indicate whether the table has a checkbox column or not.
+	 *
+	 * @type bool $_has_checkbox_column
+	 */
+	protected bool $_has_checkbox_column = false;
+
+	/**
+	 * @var AdminListTableFilters|null
+	 */
+	protected ?AdminListTableFilters $admin_list_table_filters = null;
+
+	protected ?RequestInterface $request = null;
+
+
+	/**
+	 * @param EE_Admin_Page              $admin_page we use this for obtaining everything we need in the list table
+	 * @param AdminListTableFilters|null $filters    to display list table filters
+	 */
+	public function __construct(EE_Admin_Page $admin_page, ?AdminListTableFilters $filters = null)
+	{
+		$this->request     = $this->request ?? LoaderFactory::getShared(RequestInterface::class);
+		$this->_admin_page = $admin_page;
+		// kept for back compat
+		$this->_req_data     = $this->_admin_page->get_request_data();
+		$this->_view         = $this->_admin_page->get_view();
+		$this->_views        = $this->_admin_page->get_list_table_view_RLs();
+		$this->_current_page = $this->get_pagenum();
+		$this->_screen       = $this->_admin_page->get_current_page() . '_' . $this->_admin_page->get_current_view();
+		$this->_yes_no       = [
+			esc_html__('No', 'event_espresso'),
+			esc_html__('Yes', 'event_espresso'),
+		];
+
+		$this->_per_page = $this->get_items_per_page($this->_screen . '_per_page');
+
+		$this->admin_list_table_filters = $filters instanceof AdminListTableFilters
+			? $filters
+			: LoaderFactory::getShared(AdminListTableFilters::class);
+
+		$this->_setup_data();
+		$this->_add_view_counts();
+		// ensure changes made to views in child classes get ported back to the admin page
+		$this->_admin_page->updateViews($this->_views);
+
+		$this->_nonce_action_ref = $this->_view;
+
+		$this->_set_properties();
+
+		// set primary column
+		add_filter('list_table_primary_column', [$this, 'set_primary_column']);
+
+		// set parent defaults
+		parent::__construct($this->_wp_list_args);
+
+		$this->prepare_items();
+	}
+
+
+	/**
+	 * _setup_data
+	 * this method is used to setup the $_data, $_all_data_count, and _per_page properties
+	 *
+	 * @return void
+	 * @uses $this->_admin_page
+	 */
+	abstract protected function _setup_data();
+
+
+	/**
+	 * set the properties that this class needs to be able to execute wp_list_table properly
+	 * properties set:
+	 * _wp_list_args = what the arguments required for the parent _wp_list_table.
+	 * _columns = set the columns in an array.
+	 * _sortable_columns = columns that are sortable (array).
+	 * _hidden_columns = columns that are hidden (array)
+	 * _default_orderby = the default orderby for sorting.
+	 *
+	 * @abstract
+	 * @access protected
+	 * @return void
+	 */
+	abstract protected function _set_properties();
+
+
+	/**
+	 * _get_table_filters
+	 * We use this to assemble and return any filters that are associated with this table that help further refine what
+	 * gets shown in the table.
+	 *
+	 * @abstract
+	 * @access protected
+	 * @return string[]
+	 */
+	abstract protected function _get_table_filters();
+
+
+	/**
+	 * this is a method that child class will do to add counts to the views array so when views are displayed the
+	 * counts of the views is accurate.
+	 *
+	 * @abstract
+	 * @access protected
+	 * @return void
+	 */
+	abstract protected function _add_view_counts();
+
+
+	/**
+	 * _get_hidden_fields
+	 * returns a html string of hidden fields so if any table filters are used the current view will be respected.
+	 *
+	 * @return string
+	 */
+	protected function _get_hidden_fields()
+	{
+		$page   = $this->request->getRequestParam('page', '');
+		$action = $this->request->getRequestParam('route', '');
+		$action = $this->request->getRequestParam('action', $action);
+		// if action is STILL empty, then we set it to default
+		$action = empty($action) || $action === '-1' ? 'default' : $action;
+		$field  = '<input type="hidden" name="page" value="' . esc_attr($page) . '" />' . "\n";
+		$field  .= '<input type="hidden" name="route" value="' . esc_attr($action) . '" />' . "\n";
+		$field  .= '<input type="hidden" name="perpage" value="' . esc_attr($this->_per_page) . '" />' . "\n";
+
+		$bulk_actions = $this->_get_bulk_actions();
+		foreach ($bulk_actions as $bulk_action => $label) {
+			$field .= '<input type="hidden" name="' . $bulk_action . '_nonce"'
+				. ' value="' . wp_create_nonce($bulk_action . '_nonce') . '" />' . "\n";
+		}
+
+		return $field;
+	}
+
+
+	/**
+	 * _set_column_info
+	 * we're using this to set the column headers property.
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _set_column_info()
+	{
+		$columns   = $this->get_columns();
+		$hidden    = $this->get_hidden_columns();
+		$_sortable = $this->get_sortable_columns();
+
+		/**
+		 * Dynamic hook allowing for adding sortable columns in this list table.
+		 * Note that $this->screen->id is in the format
+		 * {sanitize_title($top_level_menu_label)}_page_{$espresso_admin_page_slug}.  So for the messages list
+		 * table it is: event-espresso_page_espresso_messages.
+		 * However, take note that if the top level menu label has been translated (i.e. "Event Espresso"). then the
+		 * hook prefix ("event-espresso") will be different.
+		 *
+		 * @var array $_sortable
+		 */
+		$_sortable = apply_filters(
+			"FHEE_manage_{$this->screen->id}_sortable_columns",
+			$_sortable,
+			$this->_screen,
+			$this
+		);
+
+		$sortable = [];
+		foreach ($_sortable as $id => $data) {
+			if (empty($data)) {
+				continue;
+			}
+			// fix for offset errors with WP_List_Table default get_columninfo()
+			if (is_array($data)) {
+				$_data[0] = key($data);
+				$_data[1] = $data[1] ?? false;
+			} else {
+				$_data[0] = $data;
+			}
+
+			$data = (array) $data;
+
+			if (! isset($data[1])) {
+				$_data[1] = false;
+			}
+
+			$sortable[ $id ] = $_data;
+		}
+		$primary               = $this->get_primary_column_name();
+		$this->_column_headers = [$columns, $hidden, $sortable, $primary];
+	}
+
+
+	/**
+	 * Added for WP4.1 backward compat (@see https://events.codebasehq.com/projects/event-espresso/tickets/8814)
+	 *
+	 * @return string
+	 */
+	protected function get_primary_column_name()
+	{
+		foreach (class_parents($this) as $parent) {
+			if ($parent === 'WP_List_Table' && method_exists($parent, 'get_primary_column_name')) {
+				return parent::get_primary_column_name();
+			}
+		}
+		return $this->_primary_column;
+	}
+
+
+	/**
+	 * Added for WP4.1 backward compat (@see https://events.codebasehq.com/projects/event-espresso/tickets/8814)
+	 *
+	 * @param EE_Base_Class $item
+	 * @param string        $column_name
+	 * @param string        $primary
+	 * @return string
+	 */
+	protected function handle_row_actions($item, $column_name, $primary)
+	{
+		foreach (class_parents($this) as $parent) {
+			if ($parent === 'WP_List_Table' && method_exists($parent, 'handle_row_actions')) {
+				return parent::handle_row_actions($item, $column_name, $primary);
+			}
+		}
+		return '';
+	}
+
+
+	/**
+	 * _get_bulk_actions
+	 * This is a wrapper called by WP_List_Table::get_bulk_actions()
+	 *
+	 * @access protected
+	 * @return array bulk_actions
+	 */
+	protected function _get_bulk_actions(): array
+	{
+		$actions = [];
+		// the _views property should have the bulk_actions, so let's go through and extract them into a properly
+		// formatted array for the wp_list_table();
+		foreach ($this->_views as $view => $args) {
+			if ($this->_view === $view && isset($args['bulk_action']) && is_array($args['bulk_action'])) {
+				// each bulk action will correspond with a admin page route, so we can check whatever the capability is
+				// for that page route and skip adding the bulk action if no access for the current logged in user.
+				foreach ($args['bulk_action'] as $route => $label) {
+					if ($this->_admin_page->check_user_access($route, true)) {
+						$actions[ $route ] = $label;
+					}
+				}
+			}
+		}
+		return $actions;
+	}
+
+
+	/**
+	 * Generate the table navigation above or below the table.
+	 * Overrides the parent table nav in WP_List_Table so we can hide the bulk action div if there are no bulk actions.
+	 *
+	 * @throws EE_Error
+	 * @since 4.9.44.rc.001
+	 */
+	public function display_tablenav($which)
+	{
+		if ('top' === $which) {
+			wp_nonce_field('bulk-' . $this->_args['plural']);
+		}
+
+		ob_start();
+		$this->extra_tablenav($which);
+		$ee_tablenav = ob_get_clean();
+
+		ob_start();
+		$this->bulk_actions();
+		$bulkactions = ob_get_clean();
+
+		?>
     <?php if ($ee_tablenav && $which === 'top') : ?>
     <div class="tablenav <?php echo esc_attr($which); ?> ee-tablenav">
         <?php echo wp_kses($ee_tablenav, AllowedTags::getWithFormTags()); ?>
@@ -502,484 +502,484 @@ 
     </div>
     <?php endif; ?>
         <?php
-        if ($which === 'top') {
-            echo wp_kses($this->_get_hidden_fields(), AllowedTags::getWithFormTags());
-        }
-    }
-
-
-    /**
-     * _filters
-     * This receives the filters array from children _get_table_filters() and assembles the string including the filter
-     * button.
-     *
-     * @access private
-     * @return void  echos html showing filters
-     */
-    private function _filters(): void
-    {
-        $classname = get_class($this);
-        $filters   = apply_filters(
-            "FHEE__{$classname}__filters",
-            $this->_get_table_filters(),
-            $this,
-            $this->_screen
-        );
-
-        if (empty($filters)) {
-            return;
-        }
-
-        $this->admin_list_table_filters->filters(
-            $filters,
-            $this->get_admin_page()->get_current_page_view_url()
-        );
-    }
-
-
-    /**
-     * Callback for 'list_table_primary_column' WordPress filter
-     * If child EE_Admin_List_Table classes set the _primary_column property then that will be set as the primary
-     * column when class is instantiated.
-     *
-     * @param string $column_name
-     * @return string
-     * @see WP_List_Table::get_primary_column_name
-     */
-    public function set_primary_column($column_name)
-    {
-        return ! empty($this->_primary_column) ? $this->_primary_column : $column_name;
-    }
-
-
-    /**
-     *
-     */
-    public function prepare_items()
-    {
-        $this->_set_column_info();
-        $this->process_bulk_action();
-
-        $this->items = $this->_data;
-        $this->set_pagination_args(
-            [
-                'total_items' => $this->_all_data_count,
-                'per_page'    => $this->_per_page,
-                'total_pages' => (int) ceil($this->_all_data_count / $this->_per_page),
-            ]
-        );
-    }
-
-
-    /**
-     * @param object|array $item
-     * @return string html content for the column
-     */
-    protected function column_cb($item)
-    {
-        return '';
-    }
-
-
-    /**
-     * This column is the default for when there is no defined column method for a registered column.
-     * This can be overridden by child classes, but allows for hooking in for custom columns.
-     *
-     * @param EE_Base_Class $item
-     * @param string        $column_name The column being called.
-     * @return string html content for the column
-     */
-    public function column_default($item, $column_name)
-    {
-        /**
-         * Dynamic hook allowing for adding additional column content in this list table.
-         * Note that $this->screen->id is in the format
-         * {sanitize_title($top_level_menu_label)}_page_{$espresso_admin_page_slug}.  So for the messages list
-         * table it is: event-espresso_page_espresso_messages.
-         * However, take note that if the top level menu label has been translated (i.e. "Event Espresso"). then the
-         * hook prefix ("event-espresso") will be different.
-         */
-        ob_start();
-        do_action(
-            'AHEE__EE_Admin_List_Table__column_' . $column_name . '__' . $this->screen->id,
-            $item,
-            $this->_screen
-        );
-        $content = ob_get_clean();
-        return $column_name === 'actions' ? $this->actionsModalMenu($content) : $content;
-    }
-
-
-    /**
-     * Get a list of columns. The format is:
-     * 'internal-name' => 'Title'
-     *
-     * @return array
-     * @since  3.1.0
-     * @access public
-     * @abstract
-     */
-    public function get_columns()
-    {
-        /**
-         * Dynamic hook allowing for adding additional columns in this list table.
-         * Note that $this->screen->id is in the format
-         * {sanitize_title($top_level_menu_label)}_page_{$espresso_admin_page_slug}.  So for the messages list
-         * table it is: event-espresso_page_espresso_messages.
-         * However, take note that if the top level menu label has been translated (i.e. "Event Espresso"). then the
-         * hook prefix ("event-espresso") will be different.
-         *
-         * @var array
-         */
-        return apply_filters("FHEE_manage_{$this->screen->id}_columns", $this->_columns, $this->_screen, $this);
-    }
-
-
-    /**
-     * Get an associative array ( id => link ) with the list
-     * of views available on this table.
-     *
-     * @return array
-     * @since  3.1.0
-     * @access protected
-     */
-    public function get_views()
-    {
-        return $this->_views;
-    }
-
-
-    /**
-     * Generate the views html.
-     */
-    public function display_views()
-    {
-        $views           = $this->get_views();
-        $assembled_views = [];
-
-        if (empty($views)) {
-            return;
-        }
-        echo "<ul class='subsubsub'>\n";
-        foreach ($views as $view) {
-            $count = ! empty($view['count']) ? absint($view['count']) : 0;
-            if (isset($view['slug'], $view['class'], $view['url'], $view['label'])) {
-                $filter                           = "<li";
-                $filter                           .= $view['class'] ? " class='" . esc_attr($view['class']) . "'" : '';
-                $filter                           .= ">";
-                $filter                           .= '<a href="' . esc_url_raw($view['url']) . '">' . esc_html(
-                    $view['label']
-                ) . '</a>';
-                $filter                           .= '<span class="count">(' . $count . ')</span>';
-                $filter                           .= '</li>';
-                $assembled_views[ $view['slug'] ] = $filter;
-            }
-        }
-
-        echo ! empty($assembled_views)
-            ? implode("<li style='margin:0 .5rem;'>|</li>", $assembled_views)
-            : '';
-        echo "</ul>";
-    }
-
-
-    /**
-     * Generates content for a single row of the table
-     *
-     * @param EE_Base_Class $item The current item
-     * @since  4.1
-     * @access public
-     */
-    public function single_row($item)
-    {
-        $row_class = $this->_get_row_class($item);
-        echo '<tr class="' . esc_attr($row_class) . '">';
-        $this->single_row_columns($item); // already escaped
-        echo '</tr>';
-    }
-
-
-    /**
-     * This simply sets up the row class for the table rows.
-     * Allows for easier overriding of child methods for setting up sorting.
-     *
-     * @param EE_Base_Class $item the current item
-     * @return string
-     */
-    protected function _get_row_class($item)
-    {
-        static $row_class = '';
-        $row_class = ($row_class === '' ? 'alternate' : '');
-
-        $new_row_class = $row_class;
-
-        if (! empty($this->_ajax_sorting_callback)) {
-            $new_row_class .= ' rowsortable';
-        }
-
-        return $new_row_class;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function get_sortable_columns()
-    {
-        return (array) $this->_sortable_columns;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function get_ajax_sorting_callback()
-    {
-        return $this->_ajax_sorting_callback;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function get_hidden_columns(): array
-    {
-        $user_id     = get_current_user_id();
-        $has_default = get_user_option('default' . $this->screen->id . 'columnshidden', $user_id);
-        if (empty($has_default) && ! empty($this->_hidden_columns)) {
-            update_user_option($user_id, 'default' . $this->screen->id . 'columnshidden', true);
-            update_user_option($user_id, 'manage' . $this->screen->id . 'columnshidden', $this->_hidden_columns, true);
-        }
-        $ref = 'manage' . $this->screen->id . 'columnshidden';
-        return (array) get_user_option($ref, $user_id);
-    }
-
-
-    /**
-     * Generates the columns for a single row of the table.
-     * Overridden from wp_list_table so as to allow us to filter the column content for a given
-     * column.
-     *
-     * @param EE_Base_Class $item The current item
-     * @since 3.1.0
-     */
-    public function single_row_columns($item)
-    {
-        [$columns, $hidden, $sortable, $primary] = $this->get_column_info();
-
-        foreach ($columns as $column_name => $column_display_name) {
-            /**
-             * With WordPress version 4.3.RC+ WordPress started using the hidden css class to control whether columns
-             * are hidden or not instead of using "display:none;".  This bit of code provides backward compat.
-             */
-            $hidden_class = in_array($column_name, $hidden) ? ' hidden' : '';
-
-            $classes = $column_name . ' column-' . $column_name . $hidden_class;
-            if ($primary === $column_name) {
-                $classes .= ' has-row-actions column-primary';
-            }
-
-            $data = ' data-colname="' . wp_strip_all_tags($column_display_name) . '"';
-
-            $class = 'class="' . esc_attr($classes) . '"';
-
-            $attributes = "$class$data";
-
-            if ($column_name === 'cb') {
-                echo '<th scope="row" class="check-column">';
-                echo apply_filters(
-                    'FHEE__EE_Admin_List_Table__single_row_columns__column_cb_content',
-                    $this->column_cb($item), // already escaped
-                    $item,
-                    $this
-                );
-                echo '</th>';
-            } elseif (method_exists($this, "column_$column_name")) {
-                echo "<td $attributes>"; // already escaped
-                echo apply_filters(
-                    'FHEE__EE_Admin_List_Table__single_row_columns__column_' . $column_name . '__column_content',
-                    call_user_func([$this, "column_$column_name"], $item),
-                    $item,
-                    $this
-                );
-                echo wp_kses($this->handle_row_actions($item, $column_name, $primary), AllowedTags::getWithFormTags());
-                echo "</td>";
-            } else {
-                echo "<td $attributes>"; // already escaped
-                echo apply_filters(
-                    'FHEE__EE_Admin_List_Table__single_row_columns__column_default__column_content',
-                    $this->column_default($item, $column_name),
-                    $item,
-                    $column_name,
-                    $this
-                );
-                echo wp_kses($this->handle_row_actions($item, $column_name, $primary), AllowedTags::getWithFormTags());
-                echo "</td>";
-            }
-        }
-    }
-
-
-    /**
-     * Extra controls to be displayed between bulk actions and pagination
-     *
-     * @access public
-     * @param string $which
-     * @throws EE_Error
-     */
-    public function extra_tablenav($which)
-    {
-        if ($which === 'top') {
-            $this->_filters();
-        } elseif ($this->_bottom_buttons) {
-            echo '<div class="list-table-bottom-buttons alignleft actions">';
-            foreach ($this->_bottom_buttons as $type => $action) {
-                $route         = $action['route'] ?? '';
-                $extra_request = $action['extra_request'] ?? [];
-                $btn_class     = $action['btn_class'] ?? 'button button--secondary';
-                // already escaped
-                echo wp_kses(
-                    $this->_admin_page->get_action_link_or_button(
-                        $route,
-                        $type,
-                        $extra_request,
-                        $btn_class
-                    ),
-                    AllowedTags::getWithFormTags()
-                );
-            }
-            do_action('AHEE__EE_Admin_List_Table__extra_tablenav__after_bottom_buttons', $this, $this->_screen);
-            echo '</div>';
-        }
-    }
-
-
-    /**
-     * Get an associative array ( option_name => option_title ) with the list
-     * of bulk actions available on this table.
-     *
-     * @return array
-     * @since  3.1.0
-     * @access protected
-     */
-    public function get_bulk_actions()
-    {
-        return (array) $this->_get_bulk_actions();
-    }
-
-
-    /**
-     * Processing bulk actions.
-     */
-    public function process_bulk_action()
-    {
-        // this is not used it is handled by the child EE_Admin_Page class (routes).  However, including here for
-        // reference in case there is a case where it gets used.
-    }
-
-
-    /**
-     * returns the EE admin page this list table is associated with
-     *
-     * @return EE_Admin_Page
-     */
-    public function get_admin_page()
-    {
-        return $this->_admin_page;
-    }
-
-
-    /**
-     * A "helper" function for all children to provide an html string of
-     * actions to output in their content.  It is preferable for child classes
-     * to use this method for generating their actions content so that it's
-     * filterable by plugins
-     *
-     * @param string        $action_container           what are the html container
-     *                                                  elements for this actions string?
-     * @param string        $action_class               What class is for the container
-     *                                                  element.
-     * @param string        $action_items               The contents for the action items
-     *                                                  container.  This is filtered before
-     *                                                  returned.
-     * @param string        $action_id                  What id (optional) is used for the
-     *                                                  container element.
-     * @param EE_Base_Class $item                       The object for the column displaying
-     *                                                  the actions.
-     * @return string The assembled action elements container.
-     */
-    protected function _action_string(
-        $action_items,
-        $item,
-        $action_container = 'ul',
-        $action_class = '',
-        $action_id = ''
-    ) {
-        $action_class = ! empty($action_class) ? ' class="' . esc_attr($action_class) . '"' : '';
-        $action_id    = ! empty($action_id) ? ' id="' . esc_attr($action_id) . '"' : '';
-        $open_tag     = ! empty($action_container) ? '<' . $action_container . $action_class . $action_id . '>' : '';
-        $close_tag    = ! empty($action_container) ? '</' . $action_container . '>' : '';
-        try {
-            $content = apply_filters(
-                'FHEE__EE_Admin_List_Table___action_string__action_items',
-                $action_items,
-                $item,
-                $this
-            );
-        } catch (Exception $e) {
-            if (WP_DEBUG) {
-                EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
-            }
-            $content = $action_items;
-        }
-        return "$open_tag$content$close_tag";
-    }
-
-
-    /**
-     * @return string
-     */
-    protected function getReturnUrl()
-    {
-        $host = $this->_admin_page->get_request()->getServerParam('HTTP_HOST');
-        $uri  = $this->_admin_page->get_request()->getServerParam('REQUEST_URI');
-        return urlencode(esc_url_raw("//$host$uri"));
-    }
-
-
-    /**
-     * @param string $id
-     * @param string $content
-     * @param string $align  start (default), center, end
-     * @param string $layout row (default) or stack
-     * @return string
-     * @since   5.0.0.p
-     */
-    protected function columnContent(
-        string $id,
-        string $content,
-        string $align = 'start',
-        string $layout = 'row'
-    ): string {
-        if (! isset($this->_columns[ $id ])) {
-            throw new DomainException('missing column id');
-        }
-        $heading = $id !== 'cb' ? $this->_columns[ $id ] : '';
-        $align   = in_array($align, ['start', 'center', 'end']) ? $align : 'start';
-        $align   = "ee-responsive-table-cell--$align";
-        $layout  = $layout === 'row' ? 'ee-layout-row' : 'ee-layout-stack';
-
-        $html = "<div class='ee-responsive-table-cell ee-responsive-table-cell--column-$id $align $layout'>";
-        $html .= "<div class='ee-responsive-table-cell__heading'>$heading</div>";
-        $html .= "<div class='ee-responsive-table-cell__content $layout'>$content</div>";
-        $html .= "</div>";
-        return $html;
-    }
-
-
-    protected function actionsModalMenu($actions): string
-    {
-        return '
+		if ($which === 'top') {
+			echo wp_kses($this->_get_hidden_fields(), AllowedTags::getWithFormTags());
+		}
+	}
+
+
+	/**
+	 * _filters
+	 * This receives the filters array from children _get_table_filters() and assembles the string including the filter
+	 * button.
+	 *
+	 * @access private
+	 * @return void  echos html showing filters
+	 */
+	private function _filters(): void
+	{
+		$classname = get_class($this);
+		$filters   = apply_filters(
+			"FHEE__{$classname}__filters",
+			$this->_get_table_filters(),
+			$this,
+			$this->_screen
+		);
+
+		if (empty($filters)) {
+			return;
+		}
+
+		$this->admin_list_table_filters->filters(
+			$filters,
+			$this->get_admin_page()->get_current_page_view_url()
+		);
+	}
+
+
+	/**
+	 * Callback for 'list_table_primary_column' WordPress filter
+	 * If child EE_Admin_List_Table classes set the _primary_column property then that will be set as the primary
+	 * column when class is instantiated.
+	 *
+	 * @param string $column_name
+	 * @return string
+	 * @see WP_List_Table::get_primary_column_name
+	 */
+	public function set_primary_column($column_name)
+	{
+		return ! empty($this->_primary_column) ? $this->_primary_column : $column_name;
+	}
+
+
+	/**
+	 *
+	 */
+	public function prepare_items()
+	{
+		$this->_set_column_info();
+		$this->process_bulk_action();
+
+		$this->items = $this->_data;
+		$this->set_pagination_args(
+			[
+				'total_items' => $this->_all_data_count,
+				'per_page'    => $this->_per_page,
+				'total_pages' => (int) ceil($this->_all_data_count / $this->_per_page),
+			]
+		);
+	}
+
+
+	/**
+	 * @param object|array $item
+	 * @return string html content for the column
+	 */
+	protected function column_cb($item)
+	{
+		return '';
+	}
+
+
+	/**
+	 * This column is the default for when there is no defined column method for a registered column.
+	 * This can be overridden by child classes, but allows for hooking in for custom columns.
+	 *
+	 * @param EE_Base_Class $item
+	 * @param string        $column_name The column being called.
+	 * @return string html content for the column
+	 */
+	public function column_default($item, $column_name)
+	{
+		/**
+		 * Dynamic hook allowing for adding additional column content in this list table.
+		 * Note that $this->screen->id is in the format
+		 * {sanitize_title($top_level_menu_label)}_page_{$espresso_admin_page_slug}.  So for the messages list
+		 * table it is: event-espresso_page_espresso_messages.
+		 * However, take note that if the top level menu label has been translated (i.e. "Event Espresso"). then the
+		 * hook prefix ("event-espresso") will be different.
+		 */
+		ob_start();
+		do_action(
+			'AHEE__EE_Admin_List_Table__column_' . $column_name . '__' . $this->screen->id,
+			$item,
+			$this->_screen
+		);
+		$content = ob_get_clean();
+		return $column_name === 'actions' ? $this->actionsModalMenu($content) : $content;
+	}
+
+
+	/**
+	 * Get a list of columns. The format is:
+	 * 'internal-name' => 'Title'
+	 *
+	 * @return array
+	 * @since  3.1.0
+	 * @access public
+	 * @abstract
+	 */
+	public function get_columns()
+	{
+		/**
+		 * Dynamic hook allowing for adding additional columns in this list table.
+		 * Note that $this->screen->id is in the format
+		 * {sanitize_title($top_level_menu_label)}_page_{$espresso_admin_page_slug}.  So for the messages list
+		 * table it is: event-espresso_page_espresso_messages.
+		 * However, take note that if the top level menu label has been translated (i.e. "Event Espresso"). then the
+		 * hook prefix ("event-espresso") will be different.
+		 *
+		 * @var array
+		 */
+		return apply_filters("FHEE_manage_{$this->screen->id}_columns", $this->_columns, $this->_screen, $this);
+	}
+
+
+	/**
+	 * Get an associative array ( id => link ) with the list
+	 * of views available on this table.
+	 *
+	 * @return array
+	 * @since  3.1.0
+	 * @access protected
+	 */
+	public function get_views()
+	{
+		return $this->_views;
+	}
+
+
+	/**
+	 * Generate the views html.
+	 */
+	public function display_views()
+	{
+		$views           = $this->get_views();
+		$assembled_views = [];
+
+		if (empty($views)) {
+			return;
+		}
+		echo "<ul class='subsubsub'>\n";
+		foreach ($views as $view) {
+			$count = ! empty($view['count']) ? absint($view['count']) : 0;
+			if (isset($view['slug'], $view['class'], $view['url'], $view['label'])) {
+				$filter                           = "<li";
+				$filter                           .= $view['class'] ? " class='" . esc_attr($view['class']) . "'" : '';
+				$filter                           .= ">";
+				$filter                           .= '<a href="' . esc_url_raw($view['url']) . '">' . esc_html(
+					$view['label']
+				) . '</a>';
+				$filter                           .= '<span class="count">(' . $count . ')</span>';
+				$filter                           .= '</li>';
+				$assembled_views[ $view['slug'] ] = $filter;
+			}
+		}
+
+		echo ! empty($assembled_views)
+			? implode("<li style='margin:0 .5rem;'>|</li>", $assembled_views)
+			: '';
+		echo "</ul>";
+	}
+
+
+	/**
+	 * Generates content for a single row of the table
+	 *
+	 * @param EE_Base_Class $item The current item
+	 * @since  4.1
+	 * @access public
+	 */
+	public function single_row($item)
+	{
+		$row_class = $this->_get_row_class($item);
+		echo '<tr class="' . esc_attr($row_class) . '">';
+		$this->single_row_columns($item); // already escaped
+		echo '</tr>';
+	}
+
+
+	/**
+	 * This simply sets up the row class for the table rows.
+	 * Allows for easier overriding of child methods for setting up sorting.
+	 *
+	 * @param EE_Base_Class $item the current item
+	 * @return string
+	 */
+	protected function _get_row_class($item)
+	{
+		static $row_class = '';
+		$row_class = ($row_class === '' ? 'alternate' : '');
+
+		$new_row_class = $row_class;
+
+		if (! empty($this->_ajax_sorting_callback)) {
+			$new_row_class .= ' rowsortable';
+		}
+
+		return $new_row_class;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function get_sortable_columns()
+	{
+		return (array) $this->_sortable_columns;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function get_ajax_sorting_callback()
+	{
+		return $this->_ajax_sorting_callback;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function get_hidden_columns(): array
+	{
+		$user_id     = get_current_user_id();
+		$has_default = get_user_option('default' . $this->screen->id . 'columnshidden', $user_id);
+		if (empty($has_default) && ! empty($this->_hidden_columns)) {
+			update_user_option($user_id, 'default' . $this->screen->id . 'columnshidden', true);
+			update_user_option($user_id, 'manage' . $this->screen->id . 'columnshidden', $this->_hidden_columns, true);
+		}
+		$ref = 'manage' . $this->screen->id . 'columnshidden';
+		return (array) get_user_option($ref, $user_id);
+	}
+
+
+	/**
+	 * Generates the columns for a single row of the table.
+	 * Overridden from wp_list_table so as to allow us to filter the column content for a given
+	 * column.
+	 *
+	 * @param EE_Base_Class $item The current item
+	 * @since 3.1.0
+	 */
+	public function single_row_columns($item)
+	{
+		[$columns, $hidden, $sortable, $primary] = $this->get_column_info();
+
+		foreach ($columns as $column_name => $column_display_name) {
+			/**
+			 * With WordPress version 4.3.RC+ WordPress started using the hidden css class to control whether columns
+			 * are hidden or not instead of using "display:none;".  This bit of code provides backward compat.
+			 */
+			$hidden_class = in_array($column_name, $hidden) ? ' hidden' : '';
+
+			$classes = $column_name . ' column-' . $column_name . $hidden_class;
+			if ($primary === $column_name) {
+				$classes .= ' has-row-actions column-primary';
+			}
+
+			$data = ' data-colname="' . wp_strip_all_tags($column_display_name) . '"';
+
+			$class = 'class="' . esc_attr($classes) . '"';
+
+			$attributes = "$class$data";
+
+			if ($column_name === 'cb') {
+				echo '<th scope="row" class="check-column">';
+				echo apply_filters(
+					'FHEE__EE_Admin_List_Table__single_row_columns__column_cb_content',
+					$this->column_cb($item), // already escaped
+					$item,
+					$this
+				);
+				echo '</th>';
+			} elseif (method_exists($this, "column_$column_name")) {
+				echo "<td $attributes>"; // already escaped
+				echo apply_filters(
+					'FHEE__EE_Admin_List_Table__single_row_columns__column_' . $column_name . '__column_content',
+					call_user_func([$this, "column_$column_name"], $item),
+					$item,
+					$this
+				);
+				echo wp_kses($this->handle_row_actions($item, $column_name, $primary), AllowedTags::getWithFormTags());
+				echo "</td>";
+			} else {
+				echo "<td $attributes>"; // already escaped
+				echo apply_filters(
+					'FHEE__EE_Admin_List_Table__single_row_columns__column_default__column_content',
+					$this->column_default($item, $column_name),
+					$item,
+					$column_name,
+					$this
+				);
+				echo wp_kses($this->handle_row_actions($item, $column_name, $primary), AllowedTags::getWithFormTags());
+				echo "</td>";
+			}
+		}
+	}
+
+
+	/**
+	 * Extra controls to be displayed between bulk actions and pagination
+	 *
+	 * @access public
+	 * @param string $which
+	 * @throws EE_Error
+	 */
+	public function extra_tablenav($which)
+	{
+		if ($which === 'top') {
+			$this->_filters();
+		} elseif ($this->_bottom_buttons) {
+			echo '<div class="list-table-bottom-buttons alignleft actions">';
+			foreach ($this->_bottom_buttons as $type => $action) {
+				$route         = $action['route'] ?? '';
+				$extra_request = $action['extra_request'] ?? [];
+				$btn_class     = $action['btn_class'] ?? 'button button--secondary';
+				// already escaped
+				echo wp_kses(
+					$this->_admin_page->get_action_link_or_button(
+						$route,
+						$type,
+						$extra_request,
+						$btn_class
+					),
+					AllowedTags::getWithFormTags()
+				);
+			}
+			do_action('AHEE__EE_Admin_List_Table__extra_tablenav__after_bottom_buttons', $this, $this->_screen);
+			echo '</div>';
+		}
+	}
+
+
+	/**
+	 * Get an associative array ( option_name => option_title ) with the list
+	 * of bulk actions available on this table.
+	 *
+	 * @return array
+	 * @since  3.1.0
+	 * @access protected
+	 */
+	public function get_bulk_actions()
+	{
+		return (array) $this->_get_bulk_actions();
+	}
+
+
+	/**
+	 * Processing bulk actions.
+	 */
+	public function process_bulk_action()
+	{
+		// this is not used it is handled by the child EE_Admin_Page class (routes).  However, including here for
+		// reference in case there is a case where it gets used.
+	}
+
+
+	/**
+	 * returns the EE admin page this list table is associated with
+	 *
+	 * @return EE_Admin_Page
+	 */
+	public function get_admin_page()
+	{
+		return $this->_admin_page;
+	}
+
+
+	/**
+	 * A "helper" function for all children to provide an html string of
+	 * actions to output in their content.  It is preferable for child classes
+	 * to use this method for generating their actions content so that it's
+	 * filterable by plugins
+	 *
+	 * @param string        $action_container           what are the html container
+	 *                                                  elements for this actions string?
+	 * @param string        $action_class               What class is for the container
+	 *                                                  element.
+	 * @param string        $action_items               The contents for the action items
+	 *                                                  container.  This is filtered before
+	 *                                                  returned.
+	 * @param string        $action_id                  What id (optional) is used for the
+	 *                                                  container element.
+	 * @param EE_Base_Class $item                       The object for the column displaying
+	 *                                                  the actions.
+	 * @return string The assembled action elements container.
+	 */
+	protected function _action_string(
+		$action_items,
+		$item,
+		$action_container = 'ul',
+		$action_class = '',
+		$action_id = ''
+	) {
+		$action_class = ! empty($action_class) ? ' class="' . esc_attr($action_class) . '"' : '';
+		$action_id    = ! empty($action_id) ? ' id="' . esc_attr($action_id) . '"' : '';
+		$open_tag     = ! empty($action_container) ? '<' . $action_container . $action_class . $action_id . '>' : '';
+		$close_tag    = ! empty($action_container) ? '</' . $action_container . '>' : '';
+		try {
+			$content = apply_filters(
+				'FHEE__EE_Admin_List_Table___action_string__action_items',
+				$action_items,
+				$item,
+				$this
+			);
+		} catch (Exception $e) {
+			if (WP_DEBUG) {
+				EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
+			}
+			$content = $action_items;
+		}
+		return "$open_tag$content$close_tag";
+	}
+
+
+	/**
+	 * @return string
+	 */
+	protected function getReturnUrl()
+	{
+		$host = $this->_admin_page->get_request()->getServerParam('HTTP_HOST');
+		$uri  = $this->_admin_page->get_request()->getServerParam('REQUEST_URI');
+		return urlencode(esc_url_raw("//$host$uri"));
+	}
+
+
+	/**
+	 * @param string $id
+	 * @param string $content
+	 * @param string $align  start (default), center, end
+	 * @param string $layout row (default) or stack
+	 * @return string
+	 * @since   5.0.0.p
+	 */
+	protected function columnContent(
+		string $id,
+		string $content,
+		string $align = 'start',
+		string $layout = 'row'
+	): string {
+		if (! isset($this->_columns[ $id ])) {
+			throw new DomainException('missing column id');
+		}
+		$heading = $id !== 'cb' ? $this->_columns[ $id ] : '';
+		$align   = in_array($align, ['start', 'center', 'end']) ? $align : 'start';
+		$align   = "ee-responsive-table-cell--$align";
+		$layout  = $layout === 'row' ? 'ee-layout-row' : 'ee-layout-stack';
+
+		$html = "<div class='ee-responsive-table-cell ee-responsive-table-cell--column-$id $align $layout'>";
+		$html .= "<div class='ee-responsive-table-cell__heading'>$heading</div>";
+		$html .= "<div class='ee-responsive-table-cell__content $layout'>$content</div>";
+		$html .= "</div>";
+		return $html;
+	}
+
+
+	protected function actionsModalMenu($actions): string
+	{
+		return '
         <div class="ee-modal-menu">
             <button class="ee-modal-menu__button button button--secondary button--icon-only ee-aria-tooltip"
                     aria-label="' . esc_attr__('list table actions menu', 'event_espresso') . '"
@@ -991,44 +991,44 @@ 
                 ' . $actions . '
             </div>
         </div>';
-    }
+	}
 
 
-    public function actionsColumnHeader(): string
-    {
-        return '
+	public function actionsColumnHeader(): string
+	{
+		return '
             <span class="ee-actions-column-header-wrap">
                 <span class="dashicons dashicons-screenoptions"></span>
                 <span class="ee-actions-column-header">' . esc_html__('Actions', 'event_espresso') . '</span>
             </span>';
-    }
-
-
-    protected function getActionLink(string $url, string $display_text, string $label, $class = ''): string
-    {
-        $class = ! empty($class) ? "$class ee-list-table-action" : 'ee-list-table-action';
-        $class = ! empty($label) ? "$class ee-aria-tooltip" : $class;
-        $label = ! empty($label) ? " aria-label='$label'" : '';
-        return "<a href='$url' class='$class'$label>$display_text</a>";
-    }
-
-
-    /**
-     * Override the search box method of WP List Table to include a reset button
-     *
-     * @param string $text     The 'submit' button label.
-     * @param string $input_id ID attribute value for the search input field.
-     */
-    public function search_box($text, $input_id)
-    {
-        if (empty($_REQUEST['s']) && ! $this->has_items()) {
-            return;
-        }
-
-        $this->admin_list_table_filters->searchBox(
-            $text,
-            $input_id,
-            $this->get_admin_page()->get_current_page_view_url()
-        );
-    }
+	}
+
+
+	protected function getActionLink(string $url, string $display_text, string $label, $class = ''): string
+	{
+		$class = ! empty($class) ? "$class ee-list-table-action" : 'ee-list-table-action';
+		$class = ! empty($label) ? "$class ee-aria-tooltip" : $class;
+		$label = ! empty($label) ? " aria-label='$label'" : '';
+		return "<a href='$url' class='$class'$label>$display_text</a>";
+	}
+
+
+	/**
+	 * Override the search box method of WP List Table to include a reset button
+	 *
+	 * @param string $text     The 'submit' button label.
+	 * @param string $input_id ID attribute value for the search input field.
+	 */
+	public function search_box($text, $input_id)
+	{
+		if (empty($_REQUEST['s']) && ! $this->has_items()) {
+			return;
+		}
+
+		$this->admin_list_table_filters->searchBox(
+			$text,
+			$input_id,
+			$this->get_admin_page()->get_current_page_view_url()
+		);
+	}
 }

Spacing +39 added lines, -39 removed lines

@@ -5,8 +5,8 @@ 
 use EventEspresso\core\services\request\RequestInterface;
 use EventEspresso\core\services\request\sanitizers\AllowedTags;
 
-if (! class_exists('WP_List_Table')) {
-    require_once ABSPATH . 'wp-admin/includes/class-wp-list-table.php';
+if ( ! class_exists('WP_List_Table')) {
+    require_once ABSPATH.'wp-admin/includes/class-wp-list-table.php';
 }
 
 
@@ -236,13 +236,13 @@ 
         $this->_view         = $this->_admin_page->get_view();
         $this->_views        = $this->_admin_page->get_list_table_view_RLs();
         $this->_current_page = $this->get_pagenum();
-        $this->_screen       = $this->_admin_page->get_current_page() . '_' . $this->_admin_page->get_current_view();
+        $this->_screen       = $this->_admin_page->get_current_page().'_'.$this->_admin_page->get_current_view();
         $this->_yes_no       = [
             esc_html__('No', 'event_espresso'),
             esc_html__('Yes', 'event_espresso'),
         ];
 
-        $this->_per_page = $this->get_items_per_page($this->_screen . '_per_page');
+        $this->_per_page = $this->get_items_per_page($this->_screen.'_per_page');
 
         $this->admin_list_table_filters = $filters instanceof AdminListTableFilters
             ? $filters
@@ -329,14 +329,14 @@ 
         $action = $this->request->getRequestParam('action', $action);
         // if action is STILL empty, then we set it to default
         $action = empty($action) || $action === '-1' ? 'default' : $action;
-        $field  = '<input type="hidden" name="page" value="' . esc_attr($page) . '" />' . "\n";
-        $field  .= '<input type="hidden" name="route" value="' . esc_attr($action) . '" />' . "\n";
-        $field  .= '<input type="hidden" name="perpage" value="' . esc_attr($this->_per_page) . '" />' . "\n";
+        $field  = '<input type="hidden" name="page" value="'.esc_attr($page).'" />'."\n";
+        $field  .= '<input type="hidden" name="route" value="'.esc_attr($action).'" />'."\n";
+        $field  .= '<input type="hidden" name="perpage" value="'.esc_attr($this->_per_page).'" />'."\n";
 
         $bulk_actions = $this->_get_bulk_actions();
         foreach ($bulk_actions as $bulk_action => $label) {
-            $field .= '<input type="hidden" name="' . $bulk_action . '_nonce"'
-                . ' value="' . wp_create_nonce($bulk_action . '_nonce') . '" />' . "\n";
+            $field .= '<input type="hidden" name="'.$bulk_action.'_nonce"'
+                . ' value="'.wp_create_nonce($bulk_action.'_nonce').'" />'."\n";
         }
 
         return $field;
@@ -388,11 +388,11 @@ 
 
             $data = (array) $data;
 
-            if (! isset($data[1])) {
+            if ( ! isset($data[1])) {
                 $_data[1] = false;
             }
 
-            $sortable[ $id ] = $_data;
+            $sortable[$id] = $_data;
         }
         $primary               = $this->get_primary_column_name();
         $this->_column_headers = [$columns, $hidden, $sortable, $primary];
@@ -452,7 +452,7 @@ 
                 // for that page route and skip adding the bulk action if no access for the current logged in user.
                 foreach ($args['bulk_action'] as $route => $label) {
                     if ($this->_admin_page->check_user_access($route, true)) {
-                        $actions[ $route ] = $label;
+                        $actions[$route] = $label;
                     }
                 }
             }
@@ -471,7 +471,7 @@ 
     public function display_tablenav($which)
     {
         if ('top' === $which) {
-            wp_nonce_field('bulk-' . $this->_args['plural']);
+            wp_nonce_field('bulk-'.$this->_args['plural']);
         }
 
         ob_start();
@@ -601,7 +601,7 @@ 
          */
         ob_start();
         do_action(
-            'AHEE__EE_Admin_List_Table__column_' . $column_name . '__' . $this->screen->id,
+            'AHEE__EE_Admin_List_Table__column_'.$column_name.'__'.$this->screen->id,
             $item,
             $this->_screen
         );
@@ -664,15 +664,15 @@ 
         foreach ($views as $view) {
             $count = ! empty($view['count']) ? absint($view['count']) : 0;
             if (isset($view['slug'], $view['class'], $view['url'], $view['label'])) {
-                $filter                           = "<li";
-                $filter                           .= $view['class'] ? " class='" . esc_attr($view['class']) . "'" : '';
+                $filter = "<li";
+                $filter                           .= $view['class'] ? " class='".esc_attr($view['class'])."'" : '';
                 $filter                           .= ">";
-                $filter                           .= '<a href="' . esc_url_raw($view['url']) . '">' . esc_html(
+                $filter                           .= '<a href="'.esc_url_raw($view['url']).'">'.esc_html(
                     $view['label']
-                ) . '</a>';
-                $filter                           .= '<span class="count">(' . $count . ')</span>';
+                ).'</a>';
+                $filter                           .= '<span class="count">('.$count.')</span>';
                 $filter                           .= '</li>';
-                $assembled_views[ $view['slug'] ] = $filter;
+                $assembled_views[$view['slug']] = $filter;
             }
         }
 
@@ -693,7 +693,7 @@ 
     public function single_row($item)
     {
         $row_class = $this->_get_row_class($item);
-        echo '<tr class="' . esc_attr($row_class) . '">';
+        echo '<tr class="'.esc_attr($row_class).'">';
         $this->single_row_columns($item); // already escaped
         echo '</tr>';
     }
@@ -713,7 +713,7 @@ 
 
         $new_row_class = $row_class;
 
-        if (! empty($this->_ajax_sorting_callback)) {
+        if ( ! empty($this->_ajax_sorting_callback)) {
             $new_row_class .= ' rowsortable';
         }
 
@@ -745,12 +745,12 @@ 
     public function get_hidden_columns(): array
     {
         $user_id     = get_current_user_id();
-        $has_default = get_user_option('default' . $this->screen->id . 'columnshidden', $user_id);
+        $has_default = get_user_option('default'.$this->screen->id.'columnshidden', $user_id);
         if (empty($has_default) && ! empty($this->_hidden_columns)) {
-            update_user_option($user_id, 'default' . $this->screen->id . 'columnshidden', true);
-            update_user_option($user_id, 'manage' . $this->screen->id . 'columnshidden', $this->_hidden_columns, true);
+            update_user_option($user_id, 'default'.$this->screen->id.'columnshidden', true);
+            update_user_option($user_id, 'manage'.$this->screen->id.'columnshidden', $this->_hidden_columns, true);
         }
-        $ref = 'manage' . $this->screen->id . 'columnshidden';
+        $ref = 'manage'.$this->screen->id.'columnshidden';
         return (array) get_user_option($ref, $user_id);
     }
 
@@ -774,14 +774,14 @@ 
              */
             $hidden_class = in_array($column_name, $hidden) ? ' hidden' : '';
 
-            $classes = $column_name . ' column-' . $column_name . $hidden_class;
+            $classes = $column_name.' column-'.$column_name.$hidden_class;
             if ($primary === $column_name) {
                 $classes .= ' has-row-actions column-primary';
             }
 
-            $data = ' data-colname="' . wp_strip_all_tags($column_display_name) . '"';
+            $data = ' data-colname="'.wp_strip_all_tags($column_display_name).'"';
 
-            $class = 'class="' . esc_attr($classes) . '"';
+            $class = 'class="'.esc_attr($classes).'"';
 
             $attributes = "$class$data";
 
@@ -797,7 +797,7 @@ 
             } elseif (method_exists($this, "column_$column_name")) {
                 echo "<td $attributes>"; // already escaped
                 echo apply_filters(
-                    'FHEE__EE_Admin_List_Table__single_row_columns__column_' . $column_name . '__column_content',
+                    'FHEE__EE_Admin_List_Table__single_row_columns__column_'.$column_name.'__column_content',
                     call_user_func([$this, "column_$column_name"], $item),
                     $item,
                     $this
@@ -915,10 +915,10 @@ 
         $action_class = '',
         $action_id = ''
     ) {
-        $action_class = ! empty($action_class) ? ' class="' . esc_attr($action_class) . '"' : '';
-        $action_id    = ! empty($action_id) ? ' id="' . esc_attr($action_id) . '"' : '';
-        $open_tag     = ! empty($action_container) ? '<' . $action_container . $action_class . $action_id . '>' : '';
-        $close_tag    = ! empty($action_container) ? '</' . $action_container . '>' : '';
+        $action_class = ! empty($action_class) ? ' class="'.esc_attr($action_class).'"' : '';
+        $action_id    = ! empty($action_id) ? ' id="'.esc_attr($action_id).'"' : '';
+        $open_tag     = ! empty($action_container) ? '<'.$action_container.$action_class.$action_id.'>' : '';
+        $close_tag    = ! empty($action_container) ? '</'.$action_container.'>' : '';
         try {
             $content = apply_filters(
                 'FHEE__EE_Admin_List_Table___action_string__action_items',
@@ -961,10 +961,10 @@ 
         string $align = 'start',
         string $layout = 'row'
     ): string {
-        if (! isset($this->_columns[ $id ])) {
+        if ( ! isset($this->_columns[$id])) {
             throw new DomainException('missing column id');
         }
-        $heading = $id !== 'cb' ? $this->_columns[ $id ] : '';
+        $heading = $id !== 'cb' ? $this->_columns[$id] : '';
         $align   = in_array($align, ['start', 'center', 'end']) ? $align : 'start';
         $align   = "ee-responsive-table-cell--$align";
         $layout  = $layout === 'row' ? 'ee-layout-row' : 'ee-layout-stack';
@@ -982,13 +982,13 @@ 
         return '
         <div class="ee-modal-menu">
             <button class="ee-modal-menu__button button button--secondary button--icon-only ee-aria-tooltip"
-                    aria-label="' . esc_attr__('list table actions menu', 'event_espresso') . '"
+                    aria-label="' . esc_attr__('list table actions menu', 'event_espresso').'"
             >
                 <span class="dashicons dashicons-menu"></span>
             </button>
             <div class="ee-modal-menu__content ee-admin-container">
                 <span class="ee-modal-menu__close dashicons dashicons-no"></span>
-                ' . $actions . '
+                ' . $actions.'
             </div>
         </div>';
     }
@@ -999,7 +999,7 @@ 
         return '
             <span class="ee-actions-column-header-wrap">
                 <span class="dashicons dashicons-screenoptions"></span>
-                <span class="ee-actions-column-header">' . esc_html__('Actions', 'event_espresso') . '</span>
+                <span class="ee-actions-column-header">' . esc_html__('Actions', 'event_espresso').'</span>
             </span>';
     }