eventespresso / event-espresso-core

core/business/EE_Transaction_Processor.class.php

Indentation +964 added lines, -964 removed lines

@@ -16,968 +16,968 @@
  */
 class EE_Transaction_Processor extends EE_Processor_Base
 {
-    /**
-     * @var EE_Registration_Processor $_instance
-     * @access    private
-     */
-    private static $_instance;
-
-    /**
-     * array of query WHERE params to use when retrieving cached registrations from a transaction
-     *
-     * @var array $registration_query_params
-     * @access private
-     */
-    private $_registration_query_params = [];
-
-    /**
-     * @deprecated
-     * @var string
-     */
-    protected $_old_txn_status;
-
-    /**
-     * @deprecated
-     * @var string
-     */
-    protected $_new_txn_status;
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @access    public
-     * @param array $registration_query_params
-     * @return EE_Transaction_Processor instance
-     */
-    public static function instance($registration_query_params = [])
-    {
-        // check if class object is instantiated
-        if (! self::$_instance instanceof EE_Transaction_Processor) {
-            self::$_instance = new self($registration_query_params);
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * @param array $registration_query_params
-     */
-    private function __construct($registration_query_params = [])
-    {
-        // make sure some query params are set for retrieving registrations
-        $this->_set_registration_query_params($registration_query_params);
-    }
-
-
-    /**
-     * @access private
-     * @param array $registration_query_params
-     */
-    private function _set_registration_query_params($registration_query_params)
-    {
-        $this->_registration_query_params = ! empty($registration_query_params)
-            ? $registration_query_params
-            : ['order_by' => ['REG_count' => 'ASC']];
-    }
-
-
-    /**
-     * manually_update_registration_statuses
-     *
-     * @access public
-     * @param EE_Transaction $transaction
-     * @param string         $new_reg_status
-     * @param array          $registration_query_params array of query WHERE params to use
-     *                                                  when retrieving cached registrations from a transaction
-     * @return    boolean
-     * @throws \EE_Error
-     */
-    public function manually_update_registration_statuses(
-        EE_Transaction $transaction,
-        $new_reg_status = '',
-        $registration_query_params = []
-    ) {
-        $status_updates = $this->_call_method_on_registrations_via_Registration_Processor(
-            'manually_update_registration_status',
-            $transaction,
-            $registration_query_params,
-            $new_reg_status
-        );
-        // send messages
-        /** @type EE_Registration_Processor $registration_processor */
-        $registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
-        $registration_processor->trigger_registration_update_notifications(
-            $transaction->primary_registration(),
-            ['manually_updated' => true]
-        );
-        do_action(
-            'AHEE__EE_Transaction_Processor__manually_update_registration_statuses',
-            $transaction,
-            $status_updates
-        );
-        return $status_updates;
-    }
-
-
-    /**
-     * toggle_registration_statuses_for_default_approved_events
-     *
-     * @access public
-     * @param EE_Transaction $transaction
-     * @param array          $registration_query_params array of query WHERE params to use
-     *                                                  when retrieving cached registrations from a transaction
-     * @return    boolean
-     * @throws \EE_Error
-     */
-    public function toggle_registration_statuses_for_default_approved_events(
-        EE_Transaction $transaction,
-        $registration_query_params = []
-    ) {
-        $status_updates = $this->_call_method_on_registrations_via_Registration_Processor(
-            'toggle_registration_status_for_default_approved_events',
-            $transaction,
-            $registration_query_params
-        );
-        do_action(
-            'AHEE__EE_Transaction_Processor__toggle_registration_statuses_for_default_approved_events',
-            $transaction,
-            $status_updates
-        );
-        return $status_updates;
-    }
-
-
-    /**
-     * toggle_registration_statuses_if_no_monies_owing
-     *
-     * @access public
-     * @param EE_Transaction $transaction
-     * @param array          $registration_query_params array of query WHERE params to use
-     *                                                  when retrieving cached registrations from a transaction
-     * @return    boolean
-     * @throws \EE_Error
-     */
-    public function toggle_registration_statuses_if_no_monies_owing(
-        EE_Transaction $transaction,
-        $registration_query_params = []
-    ) {
-        $status_updates = $this->_call_method_on_registrations_via_Registration_Processor(
-            'toggle_registration_status_if_no_monies_owing',
-            $transaction,
-            $registration_query_params
-        );
-        do_action(
-            'AHEE__EE_Transaction_Processor__toggle_registration_statuses_if_no_monies_owing',
-            $transaction,
-            $status_updates
-        );
-        return $status_updates;
-    }
-
-
-    /**
-     * update_transaction_and_registrations_after_checkout_or_payment
-     * cycles thru related registrations and calls update_registration_after_checkout_or_payment() on each
-     *
-     * @param EE_Transaction     $transaction
-     * @param \EE_Payment | NULL $payment
-     * @param array              $registration_query_params    array of query WHERE params to use
-     *                                                         when retrieving cached registrations from a transaction
-     * @param bool               $trigger_notifications        whether or not to call
-     *                                                         \EE_Registration_Processor::trigger_registration_update_notifications()
-     * @return array
-     * @throws \EE_Error
-     */
-    public function update_transaction_and_registrations_after_checkout_or_payment(
-        EE_Transaction $transaction,
-        $payment = null,
-        $registration_query_params = [],
-        $trigger_notifications = true
-    ) {
-        // make sure some query params are set for retrieving registrations
-        $this->_set_registration_query_params($registration_query_params);
-        // get final reg step status
-        $finalized = $transaction->final_reg_step_completed();
-        // if the 'finalize_registration' step has been initiated (has a timestamp)
-        // but has not yet been fully completed (TRUE)
-        if (is_int($finalized) && $finalized !== false && $finalized !== true) {
-            $transaction->set_reg_step_completed('finalize_registration');
-            $finalized = true;
-        }
-        $transaction->save();
-        // array of details to aid in decision making by systems
-        $update_params = [
-            'old_txn_status'  => $transaction->old_txn_status(),
-            'new_txn_status'  => $transaction->status_ID(),
-            'finalized'       => $finalized,
-            'revisit'         => $this->_revisit,
-            'payment_updates' => $payment instanceof EE_Payment
-                ? true
-                : false,
-            'last_payment'    => $payment,
-        ];
-        // now update the registrations and add the results to our $update_params
-        $update_params['status_updates'] = $this->_call_method_on_registrations_via_Registration_Processor(
-            'update_registration_after_checkout_or_payment',
-            $transaction,
-            $this->_registration_query_params,
-            $update_params
-        );
-        if ($trigger_notifications) {
-            // send messages
-            /** @type EE_Registration_Processor $registration_processor */
-            $registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
-            $registration_processor->trigger_registration_update_notifications(
-                $transaction->primary_registration(),
-                $update_params
-            );
-        }
-        do_action(
-            'AHEE__EE_Transaction_Processor__update_transaction_and_registrations_after_checkout_or_payment',
-            $transaction,
-            $update_params
-        );
-        return $update_params;
-    }
-
-
-    /**
-     * update_transaction_after_registration_reopened
-     * readjusts TXN and Line Item totals after a registration is changed from
-     * cancelled or declined to another reg status such as pending payment or approved
-     *
-     * @param \EE_Registration $registration
-     * @param array            $closed_reg_statuses
-     * @param bool             $update_txn
-     * @return bool
-     * @throws \EE_Error
-     */
-    public function update_transaction_after_reinstating_canceled_registration(
-        EE_Registration $registration,
-        $closed_reg_statuses = [],
-        $update_txn = true
-    ) {
-        // these reg statuses should not be considered in any calculations involving monies owing
-        $closed_reg_statuses = ! empty($closed_reg_statuses)
-            ? $closed_reg_statuses
-            : EEM_Registration::closed_reg_statuses();
-        if (in_array($registration->status_ID(), $closed_reg_statuses, true)) {
-            return false;
-        }
-        try {
-            $transaction      = $this->get_transaction_for_registration($registration);
-            $ticket_line_item = $this->get_ticket_line_item_for_transaction_registration(
-                $transaction,
-                $registration
-            );
-            // un-cancel the ticket
-            $success = EEH_Line_Item::reinstate_canceled_ticket_line_item($ticket_line_item);
-        } catch (EE_Error $e) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'The Ticket Line Item for Registration %1$d could not be reinstated because :%2$s%3$s',
-                        'event_espresso'
-                    ),
-                    $registration->ID(),
-                    '<br />',
-                    $e->getMessage()
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        if ($update_txn) {
-            return $transaction->save()
-                ? $success
-                : false;
-        }
-        return $success;
-    }
-
-
-    /**
-     * update_transaction_after_canceled_or_declined_registration
-     * readjusts TXN and Line Item totals after a registration is cancelled or declined
-     *
-     * @param \EE_Registration $registration
-     * @param array            $closed_reg_statuses
-     * @param bool             $update_txn
-     * @return bool
-     * @throws \EE_Error
-     */
-    public function update_transaction_after_canceled_or_declined_registration(
-        EE_Registration $registration,
-        $closed_reg_statuses = [],
-        $update_txn = true
-    ) {
-        // these reg statuses should not be considered in any calculations involving monies owing
-        $closed_reg_statuses = ! empty($closed_reg_statuses)
-            ? $closed_reg_statuses
-            : EEM_Registration::closed_reg_statuses();
-        if (! in_array($registration->status_ID(), $closed_reg_statuses, true)) {
-            return false;
-        }
-        try {
-            $transaction = $this->get_transaction_for_registration($registration);
-            if (
-                apply_filters(
-                    'FHEE__EE_Transaction_Processor__update_transaction_after_canceled_or_declined_registration__cancel_ticket_line_item',
-                    true,
-                    $registration,
-                    $transaction
-                )
-            ) {
-                $ticket_line_item = $this->get_ticket_line_item_for_transaction_registration(
-                    $transaction,
-                    $registration
-                );
-                EEH_Line_Item::cancel_ticket_line_item($ticket_line_item);
-            }
-        } catch (EE_Error $e) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'The Ticket Line Item for Registration %1$d could not be cancelled because :%2$s%3$s',
-                        'event_espresso'
-                    ),
-                    $registration->ID(),
-                    '<br />',
-                    $e->getMessage()
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        if ($update_txn) {
-            return $transaction->save()
-                ? true
-                : false;
-        }
-        return true;
-    }
-
-
-    /**
-     * get_transaction_for_registration
-     *
-     * @access    public
-     * @param EE_Registration $registration
-     * @return    EE_Transaction
-     * @throws    EE_Error
-     */
-    public function get_transaction_for_registration(EE_Registration $registration)
-    {
-        $transaction = $registration->transaction();
-        if (! $transaction instanceof EE_Transaction) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__('The Transaction for Registration %1$d was not found or is invalid.', 'event_espresso'),
-                    $registration->ID()
-                )
-            );
-        }
-        return $transaction;
-    }
-
-
-    /**
-     * get_ticket_line_item_for_transaction_registration
-     *
-     * @access    public
-     * @param EE_Transaction  $transaction
-     * @param EE_Registration $registration
-     * @return    EE_Line_Item
-     * @throws    EE_Error
-     */
-    public function get_ticket_line_item_for_transaction_registration(
-        EE_Transaction $transaction,
-        EE_Registration $registration
-    ) {
-        EE_Registry::instance()->load_helper('Line_Item');
-        $ticket_line_item = EEM_Line_Item::instance()->get_ticket_line_item_for_transaction(
-            $transaction->ID(),
-            $registration->ticket_ID()
-        );
-        if (! $ticket_line_item instanceof EE_Line_Item) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'The Line Item for Transaction %1$d and Ticket %2$d was not found or is invalid.',
-                        'event_espresso'
-                    ),
-                    $transaction->ID(),
-                    $registration->ticket_ID()
-                )
-            );
-        }
-        return $ticket_line_item;
-    }
-
-
-    /**
-     * cancel_transaction_if_all_registrations_canceled
-     * cycles thru related registrations and checks their statuses
-     * if ALL registrations are Cancelled or Declined, then this sets the TXN status to
-     *
-     * @access    public
-     * @param EE_Transaction $transaction
-     * @param string         $new_TXN_status
-     * @param array          $registration_query_params    - array of query WHERE params to use when
-     *                                                     retrieving cached registrations from a transaction
-     * @param array          $closed_reg_statuses
-     * @param bool           $update_txn
-     * @return    bool            true if TXN status was updated, false if not
-     */
-    public function toggle_transaction_status_if_all_registrations_canceled_or_declined(
-        EE_Transaction $transaction,
-        $new_TXN_status = '',
-        $registration_query_params = [],
-        $closed_reg_statuses = [],
-        $update_txn = true
-    ) {
-        // make sure some query params are set for retrieving registrations
-        $this->_set_registration_query_params($registration_query_params);
-        // these reg statuses should not be considered in any calculations involving monies owing
-        $closed_reg_statuses = ! empty($closed_reg_statuses)
-            ? $closed_reg_statuses
-            : EEM_Registration::closed_reg_statuses();
-        // loop through cached registrations
-        foreach ($transaction->registrations($this->_registration_query_params) as $registration) {
-            if (
-                $registration instanceof EE_Registration
-                && ! in_array($registration->status_ID(), $closed_reg_statuses)
-            ) {
-                return false;
-            }
-        }
-        if (in_array($new_TXN_status, EEM_Transaction::txn_status_array())) {
-            $transaction->set_status($new_TXN_status);
-        }
-        if ($update_txn) {
-            return $transaction->save()
-                ? true
-                : false;
-        }
-        return true;
-    }
-
-
-    /**
-     * _call_method_on_registrations_via_Registration_Processor
-     * cycles thru related registrations and calls the requested method on each
-     *
-     * @access private
-     * @param string         $method_name
-     * @param EE_Transaction $transaction
-     * @param array          $registration_query_params array of query WHERE params to use
-     *                                                  when retrieving cached registrations from a transaction
-     * @param string         $additional_param
-     * @return boolean
-     * @throws \EE_Error
-     */
-    private function _call_method_on_registrations_via_Registration_Processor(
-        $method_name,
-        EE_Transaction $transaction,
-        $registration_query_params = [],
-        $additional_param = null
-    ) {
-        $response = false;
-        /** @type EE_Registration_Processor $registration_processor */
-        $registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
-        // check that method exists
-        if (! method_exists($registration_processor, $method_name)) {
-            throw new EE_Error(esc_html__('Method does not exist.', 'event_espresso'));
-        }
-        // make sure some query params are set for retrieving registrations
-        $this->_set_registration_query_params($registration_query_params);
-        // loop through cached registrations
-        foreach ($transaction->registrations($this->_registration_query_params) as $registration) {
-            if ($registration instanceof EE_Registration) {
-                if ($additional_param) {
-                    $response = $registration_processor->{$method_name}($registration, $additional_param)
-                        ? true
-                        : $response;
-                } else {
-                    $response = $registration_processor->{$method_name}($registration)
-                        ? true
-                        : $response;
-                }
-            }
-        }
-        return $response;
-    }
-
-
-    /**
-     * set_transaction_payment_method_based_on_registration_statuses
-     * sets or unsets the PMD_ID field on the TXN based on the related REG statuses
-     * basically if ALL Registrations are "Not Approved", then the EE_Transaction.PMD_ID is set to null,
-     * but if any Registration has a different status, then EE_Transaction.PMD_ID is set to either:
-     *        the first "default" Payment Method
-     *        the first active Payment Method
-     *    whichever is found first.
-     *
-     * @param EE_Registration $edited_registration
-     * @return void
-     * @throws \EE_Error
-     */
-    public function set_transaction_payment_method_based_on_registration_statuses(
-        EE_Registration $edited_registration
-    ) {
-        if ($edited_registration instanceof EE_Registration) {
-            $transaction = $edited_registration->transaction();
-            if ($transaction instanceof EE_Transaction) {
-                $all_not_approved = true;
-                foreach ($transaction->registrations() as $registration) {
-                    if ($registration instanceof EE_Registration) {
-                        // if any REG != "Not Approved" then toggle to false
-                        $all_not_approved = $registration->is_not_approved()
-                            ? $all_not_approved
-                            : false;
-                    }
-                }
-                // if ALL Registrations are "Not Approved"
-                if ($all_not_approved) {
-                    $transaction->set_payment_method_ID(null);
-                    $transaction->save();
-                } else {
-                    $available_payment_methods = EEM_Payment_Method::instance()->get_all_for_transaction(
-                        $transaction,
-                        EEM_Payment_Method::scope_cart
-                    );
-                    if (! empty($available_payment_methods)) {
-                        $PMD_ID = 0;
-                        foreach ($available_payment_methods as $available_payment_method) {
-                            if (
-                                $available_payment_method instanceof EE_Payment_Method
-                                && $available_payment_method->open_by_default()
-                            ) {
-                                $PMD_ID = $available_payment_method->ID();
-                                break;
-                            }
-                        }
-                        if (! $PMD_ID) {
-                            $first_payment_method = reset($available_payment_methods);
-                            if ($first_payment_method instanceof EE_Payment_Method) {
-                                $PMD_ID = $first_payment_method->ID();
-                            } else {
-                                EE_Error::add_error(
-                                    esc_html__(
-                                        'A valid Payment Method could not be determined. Please ensure that at least one Payment Method is activated.',
-                                        'event_espresso'
-                                    ),
-                                    __FILE__,
-                                    __LINE__,
-                                    __FUNCTION__
-                                );
-                            }
-                        }
-                        $transaction->set_payment_method_ID($PMD_ID);
-                        $transaction->save();
-                    } else {
-                        EE_Error::add_error(
-                            esc_html__(
-                                'Please activate at least one Payment Method in order for things to operate correctly.',
-                                'event_espresso'
-                            ),
-                            __FILE__,
-                            __LINE__,
-                            __FUNCTION__
-                        );
-                    }
-                }
-            }
-        }
-    }
-
-
-
-    /********************************** DEPRECATED METHODS **********************************/
-
-
-    /**
-     * @return string
-     * @deprecated 4.9.12
-     */
-    public function old_txn_status()
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This logic has been moved into \EE_Transaction::old_txn_status(), please use that method instead.',
-                'event_espresso'
-            ),
-            '4.9.12'
-        );
-        return $this->_old_txn_status;
-    }
-
-
-    /**
-     * @param string $old_txn_status
-     * @deprecated 4.9.12
-     */
-    public function set_old_txn_status($old_txn_status)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This logic has been moved into \EE_Transaction::set_old_txn_status(), please use that method instead.',
-                'event_espresso'
-            ),
-            '4.9.12'
-        );
-        // only set the first time
-        if ($this->_old_txn_status === null) {
-            $this->_old_txn_status = $old_txn_status;
-        }
-    }
-
-
-    /**
-     * @return string
-     * @deprecated 4.9.12
-     */
-    public function new_txn_status()
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This logic has been removed. Please just use \EE_Transaction::status_ID() instead.',
-                'event_espresso'
-            ),
-            '4.9.12'
-        );
-        return $this->_new_txn_status;
-    }
-
-
-    /**
-     * @param string $new_txn_status
-     * @deprecated 4.9.12
-     */
-    public function set_new_txn_status($new_txn_status)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This logic has been removed. Please just use \EE_Transaction::set_status() instead.',
-                'event_espresso'
-            ),
-            '4.9.12'
-        );
-        $this->_new_txn_status = $new_txn_status;
-    }
-
-
-    /**
-     * reg_status_updated
-     *
-     * @return bool
-     * @deprecated 4.9.12
-     */
-    public function txn_status_updated()
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This logic has been moved into \EE_Transaction::txn_status_updated(), please use that method instead.',
-                'event_espresso'
-            ),
-            '4.9.12'
-        );
-        return $this->_new_txn_status !== $this->_old_txn_status && $this->_old_txn_status !== null
-            ? true
-            : false;
-    }
-
-
-    /**
-     * all_reg_steps_completed
-     * returns:
-     *    true if ALL reg steps have been marked as completed
-     *        or false if any step is not completed
-     *
-     * @param EE_Transaction $transaction
-     * @return boolean
-     * @deprecated 4.9.12
-     */
-    public function all_reg_steps_completed(EE_Transaction $transaction)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This logic has been moved into \EE_Transaction::all_reg_steps_completed(), please use that method instead.',
-                'event_espresso'
-            ),
-            '4.9.12',
-            '5.0.0'
-        );
-        return $transaction->all_reg_steps_completed();
-    }
-
-
-    /**
-     * all_reg_steps_completed_except
-     * returns:
-     *        true if ALL reg steps, except a particular step that you wish to skip over, have been marked as completed
-     *        or false if any other step is not completed
-     *        or false if ALL steps are completed including the exception you are testing !!!
-     *
-     * @param EE_Transaction $transaction
-     * @param string         $exception
-     * @return boolean
-     * @deprecated 4.9.12
-     */
-    public function all_reg_steps_completed_except(EE_Transaction $transaction, $exception = '')
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This logic has been moved into \EE_Transaction::all_reg_steps_completed_except(), please use that method instead.',
-                'event_espresso'
-            ),
-            '4.9.12',
-            '5.0.0'
-        );
-        return $transaction->all_reg_steps_completed_except($exception);
-    }
-
-
-    /**
-     * all_reg_steps_completed_except
-     * returns:
-     *        true if ALL reg steps, except the final step, have been marked as completed
-     *        or false if any step is not completed
-     *    or false if ALL steps are completed including the final step !!!
-     *
-     * @param EE_Transaction $transaction
-     * @return boolean
-     * @deprecated 4.9.12
-     */
-    public function all_reg_steps_completed_except_final_step(EE_Transaction $transaction)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This logic has been moved into \EE_Transaction::all_reg_steps_completed_except_final_step(), please use that method instead.',
-                'event_espresso'
-            ),
-            '4.9.12',
-            '5.0.0'
-        );
-        return $transaction->all_reg_steps_completed_except_final_step();
-    }
-
-
-    /**
-     * reg_step_completed
-     * returns:
-     *    true if a specific reg step has been marked as completed
-     *    a Unix timestamp if it has been initialized but not yet completed,
-     *    or false if it has not yet been initialized
-     *
-     * @param EE_Transaction $transaction
-     * @param string         $reg_step_slug
-     * @return boolean | int
-     * @deprecated 4.9.12
-     */
-    public function reg_step_completed(EE_Transaction $transaction, $reg_step_slug)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This logic has been moved into \EE_Transaction::reg_step_completed(), please use that method instead.',
-                'event_espresso'
-            ),
-            '4.9.12',
-            '5.0.0'
-        );
-        return $transaction->reg_step_completed($reg_step_slug);
-    }
-
-
-    /**
-     * completed_final_reg_step
-     * returns:
-     *    true if the finalize_registration reg step has been marked as completed
-     *    a Unix timestamp if it has been initialized but not yet completed,
-     *    or false if it has not yet been initialized
-     *
-     * @param EE_Transaction $transaction
-     * @return boolean | int
-     * @deprecated 4.9.12
-     */
-    public function final_reg_step_completed(EE_Transaction $transaction)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This logic has been moved into \EE_Transaction::final_reg_step_completed(), please use that method instead.',
-                'event_espresso'
-            ),
-            '4.9.12',
-            '5.0.0'
-        );
-        return $transaction->final_reg_step_completed();
-    }
-
-
-    /**
-     * set_reg_step_initiated
-     * given a valid TXN_reg_step, this sets it's value to a unix timestamp
-     *
-     * @param \EE_Transaction $transaction
-     * @param string          $reg_step_slug
-     * @return boolean
-     * @throws \EE_Error
-     * @deprecated 4.9.12
-     * @access     public
-     */
-    public function set_reg_step_initiated(EE_Transaction $transaction, $reg_step_slug)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This logic has been moved into \EE_Transaction::set_reg_step_initiated(), please use that method instead.',
-                'event_espresso'
-            ),
-            '4.9.12',
-            '5.0.0'
-        );
-        return $transaction->set_reg_step_initiated($reg_step_slug);
-    }
-
-
-    /**
-     * set_reg_step_completed
-     * given a valid TXN_reg_step, this sets the step as completed
-     *
-     * @param \EE_Transaction $transaction
-     * @param string          $reg_step_slug
-     * @return boolean
-     * @throws \EE_Error
-     * @deprecated 4.9.12
-     * @access     public
-     */
-    public function set_reg_step_completed(EE_Transaction $transaction, $reg_step_slug)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This logic has been moved into \EE_Transaction::set_reg_step_completed(), please use that method instead.',
-                'event_espresso'
-            ),
-            '4.9.12',
-            '5.0.0'
-        );
-        return $transaction->set_reg_step_completed($reg_step_slug);
-    }
-
-
-    /**
-     * set_reg_step_completed
-     * given a valid TXN_reg_step slug, this sets the step as NOT completed
-     *
-     * @param \EE_Transaction $transaction
-     * @param string          $reg_step_slug
-     * @return boolean
-     * @throws \EE_Error
-     * @deprecated 4.9.12
-     * @access     public
-     */
-    public function set_reg_step_not_completed(EE_Transaction $transaction, $reg_step_slug)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This logic has been moved into \EE_Transaction::set_reg_step_not_completed(), please use that method instead.',
-                'event_espresso'
-            ),
-            '4.9.12',
-            '5.0.0'
-        );
-        return $transaction->set_reg_step_not_completed($reg_step_slug);
-    }
-
-
-    /**
-     * remove_reg_step
-     * given a valid TXN_reg_step slug, this will remove (unset)
-     * the reg step from the TXN reg step array
-     *
-     * @param \EE_Transaction $transaction
-     * @param string          $reg_step_slug
-     * @return void
-     * @deprecated 4.9.12
-     * @access     public
-     */
-    public function remove_reg_step(EE_Transaction $transaction, $reg_step_slug)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This logic has been moved into \EE_Transaction::remove_reg_step(), please use that method instead.',
-                'event_espresso'
-            ),
-            '4.9.12',
-            '5.0.0'
-        );
-        $transaction->remove_reg_step($reg_step_slug);
-    }
-
-
-    /**
-     *    toggle_failed_transaction_status
-     * upgrades a TXNs status from failed to abandoned,
-     * meaning that contact information has been captured for at least one registrant
-     *
-     * @param EE_Transaction $transaction
-     * @return    boolean
-     * @throws \EE_Error
-     * @deprecated 4.9.12
-     * @access     public
-     */
-    public function toggle_failed_transaction_status(EE_Transaction $transaction)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This logic has been moved into \EE_Transaction::toggle_failed_transaction_status(), please use that method instead.',
-                'event_espresso'
-            ),
-            '4.9.12',
-            '5.0.0'
-        );
-        return $transaction->toggle_failed_transaction_status();
-    }
-
-
-    /**
-     * toggle_abandoned_transaction_status
-     * upgrades a TXNs status from failed or abandoned to incomplete
-     *
-     * @param EE_Transaction $transaction
-     * @return boolean
-     * @deprecated 4.9.12
-     * @access     public
-     */
-    public function toggle_abandoned_transaction_status(EE_Transaction $transaction)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This logic has been moved into \EE_Transaction::toggle_abandoned_transaction_status(), please use that method instead.',
-                'event_espresso'
-            ),
-            '4.9.12',
-            '5.0.0'
-        );
-        return $transaction->toggle_abandoned_transaction_status();
-    }
+	/**
+	 * @var EE_Registration_Processor $_instance
+	 * @access    private
+	 */
+	private static $_instance;
+
+	/**
+	 * array of query WHERE params to use when retrieving cached registrations from a transaction
+	 *
+	 * @var array $registration_query_params
+	 * @access private
+	 */
+	private $_registration_query_params = [];
+
+	/**
+	 * @deprecated
+	 * @var string
+	 */
+	protected $_old_txn_status;
+
+	/**
+	 * @deprecated
+	 * @var string
+	 */
+	protected $_new_txn_status;
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @access    public
+	 * @param array $registration_query_params
+	 * @return EE_Transaction_Processor instance
+	 */
+	public static function instance($registration_query_params = [])
+	{
+		// check if class object is instantiated
+		if (! self::$_instance instanceof EE_Transaction_Processor) {
+			self::$_instance = new self($registration_query_params);
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * @param array $registration_query_params
+	 */
+	private function __construct($registration_query_params = [])
+	{
+		// make sure some query params are set for retrieving registrations
+		$this->_set_registration_query_params($registration_query_params);
+	}
+
+
+	/**
+	 * @access private
+	 * @param array $registration_query_params
+	 */
+	private function _set_registration_query_params($registration_query_params)
+	{
+		$this->_registration_query_params = ! empty($registration_query_params)
+			? $registration_query_params
+			: ['order_by' => ['REG_count' => 'ASC']];
+	}
+
+
+	/**
+	 * manually_update_registration_statuses
+	 *
+	 * @access public
+	 * @param EE_Transaction $transaction
+	 * @param string         $new_reg_status
+	 * @param array          $registration_query_params array of query WHERE params to use
+	 *                                                  when retrieving cached registrations from a transaction
+	 * @return    boolean
+	 * @throws \EE_Error
+	 */
+	public function manually_update_registration_statuses(
+		EE_Transaction $transaction,
+		$new_reg_status = '',
+		$registration_query_params = []
+	) {
+		$status_updates = $this->_call_method_on_registrations_via_Registration_Processor(
+			'manually_update_registration_status',
+			$transaction,
+			$registration_query_params,
+			$new_reg_status
+		);
+		// send messages
+		/** @type EE_Registration_Processor $registration_processor */
+		$registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
+		$registration_processor->trigger_registration_update_notifications(
+			$transaction->primary_registration(),
+			['manually_updated' => true]
+		);
+		do_action(
+			'AHEE__EE_Transaction_Processor__manually_update_registration_statuses',
+			$transaction,
+			$status_updates
+		);
+		return $status_updates;
+	}
+
+
+	/**
+	 * toggle_registration_statuses_for_default_approved_events
+	 *
+	 * @access public
+	 * @param EE_Transaction $transaction
+	 * @param array          $registration_query_params array of query WHERE params to use
+	 *                                                  when retrieving cached registrations from a transaction
+	 * @return    boolean
+	 * @throws \EE_Error
+	 */
+	public function toggle_registration_statuses_for_default_approved_events(
+		EE_Transaction $transaction,
+		$registration_query_params = []
+	) {
+		$status_updates = $this->_call_method_on_registrations_via_Registration_Processor(
+			'toggle_registration_status_for_default_approved_events',
+			$transaction,
+			$registration_query_params
+		);
+		do_action(
+			'AHEE__EE_Transaction_Processor__toggle_registration_statuses_for_default_approved_events',
+			$transaction,
+			$status_updates
+		);
+		return $status_updates;
+	}
+
+
+	/**
+	 * toggle_registration_statuses_if_no_monies_owing
+	 *
+	 * @access public
+	 * @param EE_Transaction $transaction
+	 * @param array          $registration_query_params array of query WHERE params to use
+	 *                                                  when retrieving cached registrations from a transaction
+	 * @return    boolean
+	 * @throws \EE_Error
+	 */
+	public function toggle_registration_statuses_if_no_monies_owing(
+		EE_Transaction $transaction,
+		$registration_query_params = []
+	) {
+		$status_updates = $this->_call_method_on_registrations_via_Registration_Processor(
+			'toggle_registration_status_if_no_monies_owing',
+			$transaction,
+			$registration_query_params
+		);
+		do_action(
+			'AHEE__EE_Transaction_Processor__toggle_registration_statuses_if_no_monies_owing',
+			$transaction,
+			$status_updates
+		);
+		return $status_updates;
+	}
+
+
+	/**
+	 * update_transaction_and_registrations_after_checkout_or_payment
+	 * cycles thru related registrations and calls update_registration_after_checkout_or_payment() on each
+	 *
+	 * @param EE_Transaction     $transaction
+	 * @param \EE_Payment | NULL $payment
+	 * @param array              $registration_query_params    array of query WHERE params to use
+	 *                                                         when retrieving cached registrations from a transaction
+	 * @param bool               $trigger_notifications        whether or not to call
+	 *                                                         \EE_Registration_Processor::trigger_registration_update_notifications()
+	 * @return array
+	 * @throws \EE_Error
+	 */
+	public function update_transaction_and_registrations_after_checkout_or_payment(
+		EE_Transaction $transaction,
+		$payment = null,
+		$registration_query_params = [],
+		$trigger_notifications = true
+	) {
+		// make sure some query params are set for retrieving registrations
+		$this->_set_registration_query_params($registration_query_params);
+		// get final reg step status
+		$finalized = $transaction->final_reg_step_completed();
+		// if the 'finalize_registration' step has been initiated (has a timestamp)
+		// but has not yet been fully completed (TRUE)
+		if (is_int($finalized) && $finalized !== false && $finalized !== true) {
+			$transaction->set_reg_step_completed('finalize_registration');
+			$finalized = true;
+		}
+		$transaction->save();
+		// array of details to aid in decision making by systems
+		$update_params = [
+			'old_txn_status'  => $transaction->old_txn_status(),
+			'new_txn_status'  => $transaction->status_ID(),
+			'finalized'       => $finalized,
+			'revisit'         => $this->_revisit,
+			'payment_updates' => $payment instanceof EE_Payment
+				? true
+				: false,
+			'last_payment'    => $payment,
+		];
+		// now update the registrations and add the results to our $update_params
+		$update_params['status_updates'] = $this->_call_method_on_registrations_via_Registration_Processor(
+			'update_registration_after_checkout_or_payment',
+			$transaction,
+			$this->_registration_query_params,
+			$update_params
+		);
+		if ($trigger_notifications) {
+			// send messages
+			/** @type EE_Registration_Processor $registration_processor */
+			$registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
+			$registration_processor->trigger_registration_update_notifications(
+				$transaction->primary_registration(),
+				$update_params
+			);
+		}
+		do_action(
+			'AHEE__EE_Transaction_Processor__update_transaction_and_registrations_after_checkout_or_payment',
+			$transaction,
+			$update_params
+		);
+		return $update_params;
+	}
+
+
+	/**
+	 * update_transaction_after_registration_reopened
+	 * readjusts TXN and Line Item totals after a registration is changed from
+	 * cancelled or declined to another reg status such as pending payment or approved
+	 *
+	 * @param \EE_Registration $registration
+	 * @param array            $closed_reg_statuses
+	 * @param bool             $update_txn
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	public function update_transaction_after_reinstating_canceled_registration(
+		EE_Registration $registration,
+		$closed_reg_statuses = [],
+		$update_txn = true
+	) {
+		// these reg statuses should not be considered in any calculations involving monies owing
+		$closed_reg_statuses = ! empty($closed_reg_statuses)
+			? $closed_reg_statuses
+			: EEM_Registration::closed_reg_statuses();
+		if (in_array($registration->status_ID(), $closed_reg_statuses, true)) {
+			return false;
+		}
+		try {
+			$transaction      = $this->get_transaction_for_registration($registration);
+			$ticket_line_item = $this->get_ticket_line_item_for_transaction_registration(
+				$transaction,
+				$registration
+			);
+			// un-cancel the ticket
+			$success = EEH_Line_Item::reinstate_canceled_ticket_line_item($ticket_line_item);
+		} catch (EE_Error $e) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'The Ticket Line Item for Registration %1$d could not be reinstated because :%2$s%3$s',
+						'event_espresso'
+					),
+					$registration->ID(),
+					'<br />',
+					$e->getMessage()
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		if ($update_txn) {
+			return $transaction->save()
+				? $success
+				: false;
+		}
+		return $success;
+	}
+
+
+	/**
+	 * update_transaction_after_canceled_or_declined_registration
+	 * readjusts TXN and Line Item totals after a registration is cancelled or declined
+	 *
+	 * @param \EE_Registration $registration
+	 * @param array            $closed_reg_statuses
+	 * @param bool             $update_txn
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	public function update_transaction_after_canceled_or_declined_registration(
+		EE_Registration $registration,
+		$closed_reg_statuses = [],
+		$update_txn = true
+	) {
+		// these reg statuses should not be considered in any calculations involving monies owing
+		$closed_reg_statuses = ! empty($closed_reg_statuses)
+			? $closed_reg_statuses
+			: EEM_Registration::closed_reg_statuses();
+		if (! in_array($registration->status_ID(), $closed_reg_statuses, true)) {
+			return false;
+		}
+		try {
+			$transaction = $this->get_transaction_for_registration($registration);
+			if (
+				apply_filters(
+					'FHEE__EE_Transaction_Processor__update_transaction_after_canceled_or_declined_registration__cancel_ticket_line_item',
+					true,
+					$registration,
+					$transaction
+				)
+			) {
+				$ticket_line_item = $this->get_ticket_line_item_for_transaction_registration(
+					$transaction,
+					$registration
+				);
+				EEH_Line_Item::cancel_ticket_line_item($ticket_line_item);
+			}
+		} catch (EE_Error $e) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'The Ticket Line Item for Registration %1$d could not be cancelled because :%2$s%3$s',
+						'event_espresso'
+					),
+					$registration->ID(),
+					'<br />',
+					$e->getMessage()
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		if ($update_txn) {
+			return $transaction->save()
+				? true
+				: false;
+		}
+		return true;
+	}
+
+
+	/**
+	 * get_transaction_for_registration
+	 *
+	 * @access    public
+	 * @param EE_Registration $registration
+	 * @return    EE_Transaction
+	 * @throws    EE_Error
+	 */
+	public function get_transaction_for_registration(EE_Registration $registration)
+	{
+		$transaction = $registration->transaction();
+		if (! $transaction instanceof EE_Transaction) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__('The Transaction for Registration %1$d was not found or is invalid.', 'event_espresso'),
+					$registration->ID()
+				)
+			);
+		}
+		return $transaction;
+	}
+
+
+	/**
+	 * get_ticket_line_item_for_transaction_registration
+	 *
+	 * @access    public
+	 * @param EE_Transaction  $transaction
+	 * @param EE_Registration $registration
+	 * @return    EE_Line_Item
+	 * @throws    EE_Error
+	 */
+	public function get_ticket_line_item_for_transaction_registration(
+		EE_Transaction $transaction,
+		EE_Registration $registration
+	) {
+		EE_Registry::instance()->load_helper('Line_Item');
+		$ticket_line_item = EEM_Line_Item::instance()->get_ticket_line_item_for_transaction(
+			$transaction->ID(),
+			$registration->ticket_ID()
+		);
+		if (! $ticket_line_item instanceof EE_Line_Item) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'The Line Item for Transaction %1$d and Ticket %2$d was not found or is invalid.',
+						'event_espresso'
+					),
+					$transaction->ID(),
+					$registration->ticket_ID()
+				)
+			);
+		}
+		return $ticket_line_item;
+	}
+
+
+	/**
+	 * cancel_transaction_if_all_registrations_canceled
+	 * cycles thru related registrations and checks their statuses
+	 * if ALL registrations are Cancelled or Declined, then this sets the TXN status to
+	 *
+	 * @access    public
+	 * @param EE_Transaction $transaction
+	 * @param string         $new_TXN_status
+	 * @param array          $registration_query_params    - array of query WHERE params to use when
+	 *                                                     retrieving cached registrations from a transaction
+	 * @param array          $closed_reg_statuses
+	 * @param bool           $update_txn
+	 * @return    bool            true if TXN status was updated, false if not
+	 */
+	public function toggle_transaction_status_if_all_registrations_canceled_or_declined(
+		EE_Transaction $transaction,
+		$new_TXN_status = '',
+		$registration_query_params = [],
+		$closed_reg_statuses = [],
+		$update_txn = true
+	) {
+		// make sure some query params are set for retrieving registrations
+		$this->_set_registration_query_params($registration_query_params);
+		// these reg statuses should not be considered in any calculations involving monies owing
+		$closed_reg_statuses = ! empty($closed_reg_statuses)
+			? $closed_reg_statuses
+			: EEM_Registration::closed_reg_statuses();
+		// loop through cached registrations
+		foreach ($transaction->registrations($this->_registration_query_params) as $registration) {
+			if (
+				$registration instanceof EE_Registration
+				&& ! in_array($registration->status_ID(), $closed_reg_statuses)
+			) {
+				return false;
+			}
+		}
+		if (in_array($new_TXN_status, EEM_Transaction::txn_status_array())) {
+			$transaction->set_status($new_TXN_status);
+		}
+		if ($update_txn) {
+			return $transaction->save()
+				? true
+				: false;
+		}
+		return true;
+	}
+
+
+	/**
+	 * _call_method_on_registrations_via_Registration_Processor
+	 * cycles thru related registrations and calls the requested method on each
+	 *
+	 * @access private
+	 * @param string         $method_name
+	 * @param EE_Transaction $transaction
+	 * @param array          $registration_query_params array of query WHERE params to use
+	 *                                                  when retrieving cached registrations from a transaction
+	 * @param string         $additional_param
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
+	private function _call_method_on_registrations_via_Registration_Processor(
+		$method_name,
+		EE_Transaction $transaction,
+		$registration_query_params = [],
+		$additional_param = null
+	) {
+		$response = false;
+		/** @type EE_Registration_Processor $registration_processor */
+		$registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
+		// check that method exists
+		if (! method_exists($registration_processor, $method_name)) {
+			throw new EE_Error(esc_html__('Method does not exist.', 'event_espresso'));
+		}
+		// make sure some query params are set for retrieving registrations
+		$this->_set_registration_query_params($registration_query_params);
+		// loop through cached registrations
+		foreach ($transaction->registrations($this->_registration_query_params) as $registration) {
+			if ($registration instanceof EE_Registration) {
+				if ($additional_param) {
+					$response = $registration_processor->{$method_name}($registration, $additional_param)
+						? true
+						: $response;
+				} else {
+					$response = $registration_processor->{$method_name}($registration)
+						? true
+						: $response;
+				}
+			}
+		}
+		return $response;
+	}
+
+
+	/**
+	 * set_transaction_payment_method_based_on_registration_statuses
+	 * sets or unsets the PMD_ID field on the TXN based on the related REG statuses
+	 * basically if ALL Registrations are "Not Approved", then the EE_Transaction.PMD_ID is set to null,
+	 * but if any Registration has a different status, then EE_Transaction.PMD_ID is set to either:
+	 *        the first "default" Payment Method
+	 *        the first active Payment Method
+	 *    whichever is found first.
+	 *
+	 * @param EE_Registration $edited_registration
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function set_transaction_payment_method_based_on_registration_statuses(
+		EE_Registration $edited_registration
+	) {
+		if ($edited_registration instanceof EE_Registration) {
+			$transaction = $edited_registration->transaction();
+			if ($transaction instanceof EE_Transaction) {
+				$all_not_approved = true;
+				foreach ($transaction->registrations() as $registration) {
+					if ($registration instanceof EE_Registration) {
+						// if any REG != "Not Approved" then toggle to false
+						$all_not_approved = $registration->is_not_approved()
+							? $all_not_approved
+							: false;
+					}
+				}
+				// if ALL Registrations are "Not Approved"
+				if ($all_not_approved) {
+					$transaction->set_payment_method_ID(null);
+					$transaction->save();
+				} else {
+					$available_payment_methods = EEM_Payment_Method::instance()->get_all_for_transaction(
+						$transaction,
+						EEM_Payment_Method::scope_cart
+					);
+					if (! empty($available_payment_methods)) {
+						$PMD_ID = 0;
+						foreach ($available_payment_methods as $available_payment_method) {
+							if (
+								$available_payment_method instanceof EE_Payment_Method
+								&& $available_payment_method->open_by_default()
+							) {
+								$PMD_ID = $available_payment_method->ID();
+								break;
+							}
+						}
+						if (! $PMD_ID) {
+							$first_payment_method = reset($available_payment_methods);
+							if ($first_payment_method instanceof EE_Payment_Method) {
+								$PMD_ID = $first_payment_method->ID();
+							} else {
+								EE_Error::add_error(
+									esc_html__(
+										'A valid Payment Method could not be determined. Please ensure that at least one Payment Method is activated.',
+										'event_espresso'
+									),
+									__FILE__,
+									__LINE__,
+									__FUNCTION__
+								);
+							}
+						}
+						$transaction->set_payment_method_ID($PMD_ID);
+						$transaction->save();
+					} else {
+						EE_Error::add_error(
+							esc_html__(
+								'Please activate at least one Payment Method in order for things to operate correctly.',
+								'event_espresso'
+							),
+							__FILE__,
+							__LINE__,
+							__FUNCTION__
+						);
+					}
+				}
+			}
+		}
+	}
+
+
+
+	/********************************** DEPRECATED METHODS **********************************/
+
+
+	/**
+	 * @return string
+	 * @deprecated 4.9.12
+	 */
+	public function old_txn_status()
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This logic has been moved into \EE_Transaction::old_txn_status(), please use that method instead.',
+				'event_espresso'
+			),
+			'4.9.12'
+		);
+		return $this->_old_txn_status;
+	}
+
+
+	/**
+	 * @param string $old_txn_status
+	 * @deprecated 4.9.12
+	 */
+	public function set_old_txn_status($old_txn_status)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This logic has been moved into \EE_Transaction::set_old_txn_status(), please use that method instead.',
+				'event_espresso'
+			),
+			'4.9.12'
+		);
+		// only set the first time
+		if ($this->_old_txn_status === null) {
+			$this->_old_txn_status = $old_txn_status;
+		}
+	}
+
+
+	/**
+	 * @return string
+	 * @deprecated 4.9.12
+	 */
+	public function new_txn_status()
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This logic has been removed. Please just use \EE_Transaction::status_ID() instead.',
+				'event_espresso'
+			),
+			'4.9.12'
+		);
+		return $this->_new_txn_status;
+	}
+
+
+	/**
+	 * @param string $new_txn_status
+	 * @deprecated 4.9.12
+	 */
+	public function set_new_txn_status($new_txn_status)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This logic has been removed. Please just use \EE_Transaction::set_status() instead.',
+				'event_espresso'
+			),
+			'4.9.12'
+		);
+		$this->_new_txn_status = $new_txn_status;
+	}
+
+
+	/**
+	 * reg_status_updated
+	 *
+	 * @return bool
+	 * @deprecated 4.9.12
+	 */
+	public function txn_status_updated()
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This logic has been moved into \EE_Transaction::txn_status_updated(), please use that method instead.',
+				'event_espresso'
+			),
+			'4.9.12'
+		);
+		return $this->_new_txn_status !== $this->_old_txn_status && $this->_old_txn_status !== null
+			? true
+			: false;
+	}
+
+
+	/**
+	 * all_reg_steps_completed
+	 * returns:
+	 *    true if ALL reg steps have been marked as completed
+	 *        or false if any step is not completed
+	 *
+	 * @param EE_Transaction $transaction
+	 * @return boolean
+	 * @deprecated 4.9.12
+	 */
+	public function all_reg_steps_completed(EE_Transaction $transaction)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This logic has been moved into \EE_Transaction::all_reg_steps_completed(), please use that method instead.',
+				'event_espresso'
+			),
+			'4.9.12',
+			'5.0.0'
+		);
+		return $transaction->all_reg_steps_completed();
+	}
+
+
+	/**
+	 * all_reg_steps_completed_except
+	 * returns:
+	 *        true if ALL reg steps, except a particular step that you wish to skip over, have been marked as completed
+	 *        or false if any other step is not completed
+	 *        or false if ALL steps are completed including the exception you are testing !!!
+	 *
+	 * @param EE_Transaction $transaction
+	 * @param string         $exception
+	 * @return boolean
+	 * @deprecated 4.9.12
+	 */
+	public function all_reg_steps_completed_except(EE_Transaction $transaction, $exception = '')
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This logic has been moved into \EE_Transaction::all_reg_steps_completed_except(), please use that method instead.',
+				'event_espresso'
+			),
+			'4.9.12',
+			'5.0.0'
+		);
+		return $transaction->all_reg_steps_completed_except($exception);
+	}
+
+
+	/**
+	 * all_reg_steps_completed_except
+	 * returns:
+	 *        true if ALL reg steps, except the final step, have been marked as completed
+	 *        or false if any step is not completed
+	 *    or false if ALL steps are completed including the final step !!!
+	 *
+	 * @param EE_Transaction $transaction
+	 * @return boolean
+	 * @deprecated 4.9.12
+	 */
+	public function all_reg_steps_completed_except_final_step(EE_Transaction $transaction)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This logic has been moved into \EE_Transaction::all_reg_steps_completed_except_final_step(), please use that method instead.',
+				'event_espresso'
+			),
+			'4.9.12',
+			'5.0.0'
+		);
+		return $transaction->all_reg_steps_completed_except_final_step();
+	}
+
+
+	/**
+	 * reg_step_completed
+	 * returns:
+	 *    true if a specific reg step has been marked as completed
+	 *    a Unix timestamp if it has been initialized but not yet completed,
+	 *    or false if it has not yet been initialized
+	 *
+	 * @param EE_Transaction $transaction
+	 * @param string         $reg_step_slug
+	 * @return boolean | int
+	 * @deprecated 4.9.12
+	 */
+	public function reg_step_completed(EE_Transaction $transaction, $reg_step_slug)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This logic has been moved into \EE_Transaction::reg_step_completed(), please use that method instead.',
+				'event_espresso'
+			),
+			'4.9.12',
+			'5.0.0'
+		);
+		return $transaction->reg_step_completed($reg_step_slug);
+	}
+
+
+	/**
+	 * completed_final_reg_step
+	 * returns:
+	 *    true if the finalize_registration reg step has been marked as completed
+	 *    a Unix timestamp if it has been initialized but not yet completed,
+	 *    or false if it has not yet been initialized
+	 *
+	 * @param EE_Transaction $transaction
+	 * @return boolean | int
+	 * @deprecated 4.9.12
+	 */
+	public function final_reg_step_completed(EE_Transaction $transaction)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This logic has been moved into \EE_Transaction::final_reg_step_completed(), please use that method instead.',
+				'event_espresso'
+			),
+			'4.9.12',
+			'5.0.0'
+		);
+		return $transaction->final_reg_step_completed();
+	}
+
+
+	/**
+	 * set_reg_step_initiated
+	 * given a valid TXN_reg_step, this sets it's value to a unix timestamp
+	 *
+	 * @param \EE_Transaction $transaction
+	 * @param string          $reg_step_slug
+	 * @return boolean
+	 * @throws \EE_Error
+	 * @deprecated 4.9.12
+	 * @access     public
+	 */
+	public function set_reg_step_initiated(EE_Transaction $transaction, $reg_step_slug)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This logic has been moved into \EE_Transaction::set_reg_step_initiated(), please use that method instead.',
+				'event_espresso'
+			),
+			'4.9.12',
+			'5.0.0'
+		);
+		return $transaction->set_reg_step_initiated($reg_step_slug);
+	}
+
+
+	/**
+	 * set_reg_step_completed
+	 * given a valid TXN_reg_step, this sets the step as completed
+	 *
+	 * @param \EE_Transaction $transaction
+	 * @param string          $reg_step_slug
+	 * @return boolean
+	 * @throws \EE_Error
+	 * @deprecated 4.9.12
+	 * @access     public
+	 */
+	public function set_reg_step_completed(EE_Transaction $transaction, $reg_step_slug)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This logic has been moved into \EE_Transaction::set_reg_step_completed(), please use that method instead.',
+				'event_espresso'
+			),
+			'4.9.12',
+			'5.0.0'
+		);
+		return $transaction->set_reg_step_completed($reg_step_slug);
+	}
+
+
+	/**
+	 * set_reg_step_completed
+	 * given a valid TXN_reg_step slug, this sets the step as NOT completed
+	 *
+	 * @param \EE_Transaction $transaction
+	 * @param string          $reg_step_slug
+	 * @return boolean
+	 * @throws \EE_Error
+	 * @deprecated 4.9.12
+	 * @access     public
+	 */
+	public function set_reg_step_not_completed(EE_Transaction $transaction, $reg_step_slug)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This logic has been moved into \EE_Transaction::set_reg_step_not_completed(), please use that method instead.',
+				'event_espresso'
+			),
+			'4.9.12',
+			'5.0.0'
+		);
+		return $transaction->set_reg_step_not_completed($reg_step_slug);
+	}
+
+
+	/**
+	 * remove_reg_step
+	 * given a valid TXN_reg_step slug, this will remove (unset)
+	 * the reg step from the TXN reg step array
+	 *
+	 * @param \EE_Transaction $transaction
+	 * @param string          $reg_step_slug
+	 * @return void
+	 * @deprecated 4.9.12
+	 * @access     public
+	 */
+	public function remove_reg_step(EE_Transaction $transaction, $reg_step_slug)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This logic has been moved into \EE_Transaction::remove_reg_step(), please use that method instead.',
+				'event_espresso'
+			),
+			'4.9.12',
+			'5.0.0'
+		);
+		$transaction->remove_reg_step($reg_step_slug);
+	}
+
+
+	/**
+	 *    toggle_failed_transaction_status
+	 * upgrades a TXNs status from failed to abandoned,
+	 * meaning that contact information has been captured for at least one registrant
+	 *
+	 * @param EE_Transaction $transaction
+	 * @return    boolean
+	 * @throws \EE_Error
+	 * @deprecated 4.9.12
+	 * @access     public
+	 */
+	public function toggle_failed_transaction_status(EE_Transaction $transaction)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This logic has been moved into \EE_Transaction::toggle_failed_transaction_status(), please use that method instead.',
+				'event_espresso'
+			),
+			'4.9.12',
+			'5.0.0'
+		);
+		return $transaction->toggle_failed_transaction_status();
+	}
+
+
+	/**
+	 * toggle_abandoned_transaction_status
+	 * upgrades a TXNs status from failed or abandoned to incomplete
+	 *
+	 * @param EE_Transaction $transaction
+	 * @return boolean
+	 * @deprecated 4.9.12
+	 * @access     public
+	 */
+	public function toggle_abandoned_transaction_status(EE_Transaction $transaction)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This logic has been moved into \EE_Transaction::toggle_abandoned_transaction_status(), please use that method instead.',
+				'event_espresso'
+			),
+			'4.9.12',
+			'5.0.0'
+		);
+		return $transaction->toggle_abandoned_transaction_status();
+	}
 }

Spacing +7 added lines, -7 removed lines

@@ -52,7 +52,7 @@ 
     public static function instance($registration_query_params = [])
     {
         // check if class object is instantiated
-        if (! self::$_instance instanceof EE_Transaction_Processor) {
+        if ( ! self::$_instance instanceof EE_Transaction_Processor) {
             self::$_instance = new self($registration_query_params);
         }
         return self::$_instance;
@@ -317,7 +317,7 @@ 
         $closed_reg_statuses = ! empty($closed_reg_statuses)
             ? $closed_reg_statuses
             : EEM_Registration::closed_reg_statuses();
-        if (! in_array($registration->status_ID(), $closed_reg_statuses, true)) {
+        if ( ! in_array($registration->status_ID(), $closed_reg_statuses, true)) {
             return false;
         }
         try {
@@ -373,7 +373,7 @@ 
     public function get_transaction_for_registration(EE_Registration $registration)
     {
         $transaction = $registration->transaction();
-        if (! $transaction instanceof EE_Transaction) {
+        if ( ! $transaction instanceof EE_Transaction) {
             throw new EE_Error(
                 sprintf(
                     esc_html__('The Transaction for Registration %1$d was not found or is invalid.', 'event_espresso'),
@@ -403,7 +403,7 @@ 
             $transaction->ID(),
             $registration->ticket_ID()
         );
-        if (! $ticket_line_item instanceof EE_Line_Item) {
+        if ( ! $ticket_line_item instanceof EE_Line_Item) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -490,7 +490,7 @@ 
         /** @type EE_Registration_Processor $registration_processor */
         $registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
         // check that method exists
-        if (! method_exists($registration_processor, $method_name)) {
+        if ( ! method_exists($registration_processor, $method_name)) {
             throw new EE_Error(esc_html__('Method does not exist.', 'event_espresso'));
         }
         // make sure some query params are set for retrieving registrations
@@ -550,7 +550,7 @@ 
                         $transaction,
                         EEM_Payment_Method::scope_cart
                     );
-                    if (! empty($available_payment_methods)) {
+                    if ( ! empty($available_payment_methods)) {
                         $PMD_ID = 0;
                         foreach ($available_payment_methods as $available_payment_method) {
                             if (
@@ -561,7 +561,7 @@ 
                                 break;
                             }
                         }
-                        if (! $PMD_ID) {
+                        if ( ! $PMD_ID) {
                             $first_payment_method = reset($available_payment_methods);
                             if ($first_payment_method instanceof EE_Payment_Method) {
                                 $PMD_ID = $first_payment_method->ID();

core/admin/EE_Admin_Page.core.php

Indentation +4217 added lines, -4217 removed lines

@@ -25,4309 +25,4309 @@
  */
 abstract class EE_Admin_Page extends EE_Base implements InterminableInterface
 {
-    protected ?EE_Admin_Config     $admin_config       = null;
+	protected ?EE_Admin_Config     $admin_config       = null;
 
-    protected ?EE_Admin_Hooks      $_hook_obj          = null;
+	protected ?EE_Admin_Hooks      $_hook_obj          = null;
 
-    protected ?EE_Admin_List_Table $_list_table_object = null;
+	protected ?EE_Admin_List_Table $_list_table_object = null;
 
-    protected ?EE_Capabilities     $capabilities       = null;
+	protected ?EE_Capabilities     $capabilities       = null;
 
-    protected ?EE_Registry         $EE                 = null;
+	protected ?EE_Registry         $EE                 = null;
 
-    protected ?FeatureFlags        $feature            = null;
+	protected ?FeatureFlags        $feature            = null;
 
-    protected ?LoaderInterface     $loader             = null;
+	protected ?LoaderInterface     $loader             = null;
 
-    protected ?RequestInterface    $request            = null;
+	protected ?RequestInterface    $request            = null;
 
-    protected ?WP_Screen           $_current_screen    = null;
+	protected ?WP_Screen           $_current_screen    = null;
 
-    /**
-     * @var array
-     * @since 5.0.0.p
-     */
-    private array $publish_post_meta_box_hidden_fields = [];
+	/**
+	 * @var array
+	 * @since 5.0.0.p
+	 */
+	private array $publish_post_meta_box_hidden_fields = [];
 
-    /**
-     * some default things shared by all child classes
-     *
-     * @var string[]
-     */
-    protected array $_default_espresso_metaboxes = [
-        '_espresso_news_post_box',
-        '_espresso_links_post_box',
-        '_espresso_ratings_request',
-        '_espresso_sponsors_post_box',
-    ];
+	/**
+	 * some default things shared by all child classes
+	 *
+	 * @var string[]
+	 */
+	protected array $_default_espresso_metaboxes = [
+		'_espresso_news_post_box',
+		'_espresso_links_post_box',
+		'_espresso_ratings_request',
+		'_espresso_sponsors_post_box',
+	];
 
-    /**
-     * Used to hold default query args for list table routes to help preserve stickiness of filters for carried out
-     * actions.
-     *
-     * @since 4.6.x
-     */
-    protected array $_default_route_query_args = [];
+	/**
+	 * Used to hold default query args for list table routes to help preserve stickiness of filters for carried out
+	 * actions.
+	 *
+	 * @since 4.6.x
+	 */
+	protected array $_default_route_query_args = [];
 
-    protected array $_labels                   = [];
+	protected array $_labels                   = [];
 
-    protected array $_nav_tabs                 = [];
+	protected array $_nav_tabs                 = [];
 
-    protected array $_page_config              = [];
+	protected array $_page_config              = [];
 
-    /**
-     * action => method pairs used for routing incoming requests
-     *
-     * @var array
-     */
-    protected array $_page_routes   = [];
+	/**
+	 * action => method pairs used for routing incoming requests
+	 *
+	 * @var array
+	 */
+	protected array $_page_routes   = [];
 
-    protected array $_req_data      = [];
+	protected array $_req_data      = [];
 
-    protected array $_route_config  = [];
+	protected array $_route_config  = [];
 
-    protected array $_template_args = [];
+	protected array $_template_args = [];
 
-    protected array $_views         = [];
+	protected array $_views         = [];
 
-    /**
-     * yes / no array for admin form fields
-     *
-     * @var array|array[]
-     */
-    protected array $_yes_no_values = [];
+	/**
+	 * yes / no array for admin form fields
+	 *
+	 * @var array|array[]
+	 */
+	protected array $_yes_no_values = [];
 
-    /**
-     * this starts at null so we can have no header routes progress through two states.
-     */
-    protected ?bool $_is_UI_request = null;
+	/**
+	 * this starts at null so we can have no header routes progress through two states.
+	 */
+	protected ?bool $_is_UI_request = null;
 
-    protected bool  $_is_caf        = false;                                                                                                                                                                                                                                  // This is just a property that flags whether the given route is a caffeinated route or not.
+	protected bool  $_is_caf        = false;                                                                                                                                                                                                                                  // This is just a property that flags whether the given route is a caffeinated route or not.
 
-    protected bool  $_routing       = false;
+	protected bool  $_routing       = false;
 
-    /**
-     * whether or not initializePage() has run
-     *
-     * @var bool
-     */
-    protected bool $initialized = false;
+	/**
+	 * whether or not initializePage() has run
+	 *
+	 * @var bool
+	 */
+	protected bool $initialized = false;
 
 
-    protected string $_admin_base_path      = '';
+	protected string $_admin_base_path      = '';
 
-    protected string $_admin_base_url       = '';
+	protected string $_admin_base_url       = '';
 
-    protected string $_admin_page_title     = '';
+	protected string $_admin_page_title     = '';
 
-    protected string $_column_template_path = '';
+	protected string $_column_template_path = '';
 
-    protected bool   $_cpt_route            = false;
+	protected bool   $_cpt_route            = false;
 
-    /**
-     * set via request page and action args.
-     */
-    protected string $_current_page          = '';
+	/**
+	 * set via request page and action args.
+	 */
+	protected string $_current_page          = '';
 
-    protected string $_current_page_view_url = '';
+	protected string $_current_page_view_url = '';
 
-    protected string $_current_view          = '';
+	protected string $_current_view          = '';
 
-    protected string $_default_nav_tab_name  = 'overview';
+	protected string $_default_nav_tab_name  = 'overview';
 
-    /**
-     * sanitized request action
-     */
-    protected string $_req_action = '';
-
-    /**
-     * sanitized request action nonce
-     */
-    protected string $_req_nonce        = '';
-
-    protected string $_search_btn_label = '';
-
-    protected string $_template_path    = '';
-
-    protected string $_view             = '';
-
-    /**
-     * set early within EE_Admin_Init
-     *
-     * @var string
-     */
-    protected string $_wp_page_slug = '';
-
-    /**
-     * if the current class is an admin page extension, like: Extend_Events_Admin_Page,
-     * then this would be the parent classname: Events_Admin_Page
-     *
-     * @var string
-     */
-    public string $base_class_name = '';
-
-    public string $class_name      = '';
-
-    /**
-     * unprocessed value for the 'action' request param (default '')
-     *
-     * @var string
-     */
-    protected string $raw_req_action = '';
-
-    /**
-     * unprocessed value for the 'page' request param (default '')
-     *
-     * @var string
-     */
-    protected string $raw_req_page = '';
-
-    public string    $page_folder  = '';
-
-    public string    $page_label   = '';
-
-    public string    $page_slug    = '';
-
-
-    /**
-     * the current page route and route config
-     *
-     * @var array|callable|string|null
-     */
-    protected $_route = null;
-
-
-    /**
-     * @Constructor
-     * @param bool $routing indicate whether we want to just load the object and handle routing or just load the object.
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function __construct($routing = true)
-    {
-        $this->loader       = LoaderFactory::getLoader();
-        $this->admin_config = $this->loader->getShared(EE_Admin_Config::class);
-        $this->feature      = $this->loader->getShared(FeatureFlags::class);
-        $this->request      = $this->loader->getShared(RequestInterface::class);
-        $this->capabilities = $this->loader->getShared(EE_Capabilities::class);
-        // routing enabled?
-        $this->_routing = $routing;
-
-        $this->class_name      = get_class($this);
-        $this->base_class_name = strpos($this->class_name, 'Extend_') === 0
-            ? str_replace('Extend_', '', $this->class_name)
-            : '';
-
-        if (strpos($this->_get_dir(), 'caffeinated') !== false) {
-            $this->_is_caf = true;
-        }
-        $this->_yes_no_values = [
-            ['id' => true, 'text' => esc_html__('Yes', 'event_espresso')],
-            ['id' => false, 'text' => esc_html__('No', 'event_espresso')],
-        ];
-        // set the _req_data property.
-        $this->_req_data = $this->request->requestParams();
-    }
-
-
-    /**
-     * @return EE_Admin_Config
-     */
-    public function adminConfig(): EE_Admin_Config
-    {
-        return $this->admin_config;
-    }
-
-
-    /**
-     * @return FeatureFlags
-     */
-    public function feature(): FeatureFlags
-    {
-        return $this->feature;
-    }
-
-
-    /**
-     * This logic used to be in the constructor, but that caused a chicken <--> egg scenario
-     * for child classes that needed to set properties prior to these methods getting called,
-     * but also needed the parent class to have its construction completed as well.
-     * Bottom line is that constructors should ONLY be used for setting initial properties
-     * and any complex initialization logic should only run after instantiation is complete.
-     * This method gets called immediately after construction from within
-     *      EE_Admin_Page_Init::_initialize_admin_page()
-     *
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws Throwable
-     * @since 5.0.0.p
-     */
-    public function initializePage()
-    {
-        if ($this->initialized) {
-            return;
-        }
-        // set initial page props (child method)
-        $this->_init_page_props();
-        // set global defaults
-        $this->_set_defaults();
-        // set early because incoming requests could be ajax related and we need to register those hooks.
-        $this->_global_ajax_hooks();
-        $this->_ajax_hooks();
-        // other_page_hooks have to be early too.
-        $this->_do_other_page_hooks();
-        // set up page dependencies
-        $this->_before_page_setup();
-        $this->_page_setup();
-        $this->initialized = true;
-    }
-
-
-    /**
-     * _init_page_props
-     * Child classes use to set at least the following properties:
-     * $page_slug.
-     * $page_label.
-     *
-     * @abstract
-     * @return void
-     */
-    abstract protected function _init_page_props();
-
-
-    /**
-     * _ajax_hooks
-     * child classes put all their add_action('wp_ajax_{name_of_hook}') hooks in here.
-     * Note: within the ajax callback methods.
-     *
-     * @abstract
-     * @return void
-     */
-    abstract protected function _ajax_hooks();
-
-
-    /**
-     * _define_page_props
-     * child classes define page properties in here.  Must include at least:
-     * $_admin_base_url = base_url for all admin pages
-     * $_admin_page_title = default admin_page_title for admin pages
-     * $_labels = array of default labels for various automatically generated elements:
-     *    array(
-     *        'buttons' => array(
-     *            'add' => esc_html__('label for add new button'),
-     *            'edit' => esc_html__('label for edit button'),
-     *            'delete' => esc_html__('label for delete button')
-     *            )
-     *        )
-     *
-     * @abstract
-     * @return void
-     */
-    abstract protected function _define_page_props();
-
-
-    /**
-     * _set_page_routes
-     * child classes use this to define the page routes for all subpages handled by the class.  Page routes are
-     * assigned to a action => method pairs in an array and to the $_page_routes property.  Each page route must also
-     * have a 'default' route. Here's the format
-     * $this->_page_routes = array(
-     *        'default' => array(
-     *            'func' => '_default_method_handling_route',
-     *            'args' => array('array','of','args'),
-     *            'noheader' => true, //add this in if this page route is processed before any headers are loaded (i.e.
-     *            ajax request, backend processing)
-     *            'headers_sent_route'=>'headers_route_reference', //add this if noheader=>true, and you want to load a
-     *            headers route after.  The string you enter here should match the defined route reference for a
-     *            headers sent route.
-     *            'capability' => 'route_capability', //indicate a string for minimum capability required to access
-     *            this route.
-     *            'obj_id' => 10 // if this route has an object id, then this can include it (used for capability
-     *            checks).
-     *        ),
-     *        'insert_item' => '_method_for_handling_insert_item' //this can be used if all we need to have is a
-     *        handling method.
-     *        )
-     * )
-     *
-     * @abstract
-     * @return void
-     */
-    abstract protected function _set_page_routes();
-
-
-    /**
-     * _set_page_config
-     * child classes use this to define the _page_config array for all subpages handled by the class. Each key in the
-     * array corresponds to the page_route for the loaded page. Format:
-     * $this->_page_config = array(
-     *        'default' => array(
-     *            'labels' => array(
-     *                'buttons' => array(
-     *                    'add' => esc_html__('label for adding item'),
-     *                    'edit' => esc_html__('label for editing item'),
-     *                    'delete' => esc_html__('label for deleting item')
-     *                ),
-     *                'publishbox' => esc_html__('Localized Title for Publish metabox', 'event_espresso')
-     *            ), //optional an array of custom labels for various automatically generated elements to use on the
-     *            page. If this isn't present then the defaults will be used as set for the $this->_labels in
-     *            _define_page_props() method
-     *            'nav' => array(
-     *                'label' => esc_html__('Label for Tab', 'event_espresso').
-     *                'url' => 'http://someurl', //automatically generated UNLESS you define
-     *                'css_class' => 'css-class', //automatically generated UNLESS you define
-     *                'order' => 10, //required to indicate tab position.
-     *                'persistent' => false //if you want the nav tab to ONLY display when the specific route is
-     *                displayed then add this parameter.
-     *            'list_table' => 'name_of_list_table' //string for list table class to be loaded for this admin_page.
-     *            'metaboxes' => array('metabox1', 'metabox2'), //if present this key indicates we want to load
-     *            metaboxes set for eventespresso admin pages.
-     *            'has_metaboxes' => true, //this boolean flag can simply be used to indicate if the route will have
-     *            metaboxes.  Typically this is used if the 'metaboxes' index is not used because metaboxes are added
-     *            later.  We just use this flag to make sure the necessary js gets enqueued on page load.
-     *            'has_help_popups' => false //defaults(true) //this boolean flag can simply be used to indicate if the
-     *            given route has help popups setup and if it does then we need to make sure thickbox is enqueued.
-     *            'columns' => array(4, 2), //this key triggers the setup of a page that uses columns (metaboxes).  The
-     *            array indicates the max number of columns (4) and the default number of columns on page load (2).
-     *            There is an option in the "screen_options" dropdown that is setup so users can pick what columns they
-     *            want to display.
-     *            'help_tabs' => array( //this is used for adding help tabs to a page
-     *                'tab_id' => array(
-     *                    'title' => 'tab_title',
-     *                    'filename' => 'name_of_file_containing_content', //this is the primary method for setting
-     *                    help tab content.  The fallback if it isn't present is to try a the callback.  Filename
-     *                    should match a file in the admin folder's "help_tabs" dir (ie..
-     *                    events/help_tabs/name_of_file_containing_content.help_tab.php)
-     *                    'callback' => 'callback_method_for_content', //if 'filename' isn't present then system will
-     *                    attempt to use the callback which should match the name of a method in the class
-     *                    ),
-     *                'tab2_id' => array(
-     *                    'title' => 'tab2 title',
-     *                    'filename' => 'file_name_2'
-     *                    'callback' => 'callback_method_for_content',
-     *                 ),
-     *            'help_sidebar' => 'callback_for_sidebar_content', //this is used for setting up the sidebar in the
-     *            help tab area on an admin page. @return void
-     *
-     * @abstract
-     */
-    abstract protected function _set_page_config();
-
-
-    /**
-     * _add_screen_options
-     * Child classes can add any extra wp_screen_options within this method using built-in WP functions/methods for
-     * doing so. Note child classes can also define _add_screen_options_($this->_current_view) to limit screen options
-     * to a particular view.
-     *
-     * @link   http://chrismarslender.com/wp-tutorials/wordpress-screen-options-tutorial/
-     *         see also WP_Screen object documents...
-     * @link   http://codex.wordpress.org/Class_Reference/WP_Screen
-     * @abstract
-     * @return void
-     */
-    abstract protected function _add_screen_options();
-
-
-    /**
-     * _add_feature_pointers
-     * Child classes should use this method for implementing any "feature pointers" (using built-in WP styling js).
-     * Note child classes can also define _add_feature_pointers_($this->_current_view) to limit screen options to a
-     * particular view. Note: this is just a placeholder for now.  Implementation will come down the road See:
-     * WP_Internal_Pointers class in wp-admin/includes/template.php for example (its a final class so can't be
-     * extended) also see:
-     *
-     * @link   http://eamann.com/tech/wordpress-portland/
-     * @abstract
-     * @return void
-     */
-    abstract protected function _add_feature_pointers();
-
-
-    /**
-     * load_scripts_styles
-     * child classes put their wp_enqueue_script and wp_enqueue_style hooks in here for anything they need loaded for
-     * their pages/subpages.  Note this is for all pages/subpages of the system.  You can also load only specific
-     * scripts/styles per view by putting them in a dynamic function in this format
-     * (load_scripts_styles_{$this->_current_view}) which matches your page route (action request arg)
-     *
-     * @abstract
-     * @return void
-     */
-    abstract public function load_scripts_styles();
-
-
-    /**
-     * admin_init
-     * Anything that should be set/executed at 'admin_init' WP hook runtime should be put in here.  This will apply to
-     * all pages/views loaded by child class.
-     *
-     * @abstract
-     * @return void
-     */
-    abstract public function admin_init();
-
-
-    /**
-     * admin_notices
-     * Anything triggered by the 'admin_notices' WP hook should be put in here.  This particular method will apply to
-     * all pages/views loaded by child class.
-     *
-     * @abstract
-     * @return void
-     */
-    abstract public function admin_notices();
-
-
-    /**
-     * admin_footer_scripts
-     * Anything triggered by the 'admin_print_footer_scripts' WP hook should be put in here. This particular method
-     * will apply to all pages/views loaded by child class.
-     *
-     * @return void
-     */
-    abstract public function admin_footer_scripts();
-
-
-    /**
-     * admin_footer
-     * anything triggered by the 'admin_footer' WP action hook should be added to here. This particular method will
-     * apply to all pages/views loaded by child class.
-     *
-     * @return void
-     */
-    public function admin_footer()
-    {
-    }
-
-
-    /**
-     * _global_ajax_hooks
-     * all global add_action('wp_ajax_{name_of_hook}') hooks in here.
-     * Note: within the ajax callback methods.
-     *
-     * @abstract
-     * @return void
-     */
-    protected function _global_ajax_hooks()
-    {
-        // for lazy loading of metabox content
-        add_action('wp_ajax_espresso-ajax-content', [$this, 'ajax_metabox_content']);
-
-        add_action(
-            'wp_ajax_espresso_hide_status_change_notice',
-            [$this, 'hideStatusChangeNotice']
-        );
-        add_action(
-            'wp_ajax_nopriv_espresso_hide_status_change_notice',
-            [$this, 'hideStatusChangeNotice']
-        );
-    }
-
-
-    public function ajax_metabox_content()
-    {
-        $content_id  = $this->request->getRequestParam('contentid', '');
-        $content_url = $this->request->getRequestParam('contenturl', '', DataType::URL);
-        EE_Admin_Page::cached_rss_display($content_id, $content_url);
-        wp_die();
-    }
-
-
-    public function hideStatusChangeNotice()
-    {
-        $response = [];
-        try {
-            /** @var StatusChangeNotice $status_change_notice */
-            $status_change_notice = $this->loader->getShared(
-                'EventEspresso\core\domain\services\admin\notices\status_change\StatusChangeNotice'
-            );
-            $response['success']  = $status_change_notice->dismiss() > -1;
-        } catch (Exception $exception) {
-            $response['errors'] = $exception->getMessage();
-        }
-        echo wp_json_encode($response);
-        exit();
-    }
-
-
-    /**
-     * allows extending classes do something specific before the parent constructor runs _page_setup().
-     *
-     * @return void
-     */
-    protected function _before_page_setup()
-    {
-        // default is to do nothing
-    }
-
-
-    /**
-     * Makes sure any things that need to be loaded early get handled.
-     * We also escape early here if the page requested doesn't match the object.
-     *
-     * @final
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws Throwable
-     */
-    final protected function _page_setup()
-    {
-        // requires?
-        // admin_init stuff - global - we're setting this REALLY early
-        // so if EE_Admin pages have to hook into other WP pages they can.
-        // But keep in mind, not everything is available from the EE_Admin Page object at this point.
-        add_action('admin_init', [$this, 'admin_init_global'], 5);
-        // next verify if we need to load anything...
-        $this->_current_page = $this->request->getRequestParam('page', '', DataType::KEY);
-        $this->_current_page = $this->request->getRequestParam('current_page', $this->_current_page, DataType::KEY);
-        $this->page_folder   = strtolower(
-            str_replace(['_Admin_Page', 'Extend_'], '', $this->class_name)
-        );
-        global $ee_menu_slugs;
-        $ee_menu_slugs = (array) $ee_menu_slugs;
-        if (
-            ! $this->request->isAjax()
-            && (! $this->_current_page || ! isset($ee_menu_slugs[ $this->_current_page ]))
-        ) {
-            return;
-        }
-        // because WP List tables have two duplicate select inputs for choosing bulk actions,
-        // we need to copy the action from the second to the first
-        $action     = $this->request->getRequestParam('action', '-1', DataType::KEY);
-        $action2    = $this->request->getRequestParam('action2', '-1', DataType::KEY);
-        $action     = $action !== '-1' ? $action : $action2;
-        $req_action = $action !== '-1' ? $action : 'default';
-
-        // if a specific 'route' has been set, and the action is 'default' OR we are doing_ajax
-        // then let's use the route as the action.
-        // This covers cases where we're coming in from a list table that isn't on the default route.
-        $route             = $this->request->getRequestParam('route');
-        $this->_req_action = $route && ($req_action === 'default' || $this->request->isAjax())
-            ? $route
-            : $req_action;
-        $this->_current_view = $this->_req_action;
-        $this->_req_nonce    = $this->_req_action . '_nonce';
-        $this->_define_page_props();
-        $this->_current_page_view_url = add_query_arg(
-            ['page' => $this->_current_page, 'action' => $this->_current_view],
-            $this->_admin_base_url
-        );
-        // set page configs
-        $this->_set_page_routes();
-        $this->_set_page_config();
-        // let's include any referrer data in our default_query_args for this route for "stickiness".
-        if ($this->request->requestParamIsSet('wp_referer')) {
-            $wp_referer = $this->request->getRequestParam('wp_referer');
-            if ($wp_referer) {
-                $this->_default_route_query_args['wp_referer'] = $wp_referer;
-            }
-        }
-        // for CPT and other extended functionality.
-        // If there is an _extend_page_config_for_cpt
-        // then let's run that to modify all the various page configuration arrays.
-        if (method_exists($this, '_extend_page_config_for_cpt')) {
-            $this->_extend_page_config_for_cpt();
-        }
-        // filter routes and page_config so addons can add their stuff. Filtering done per class
-        $this->_page_routes = apply_filters(
-            'FHEE__' . $this->class_name . '__page_setup__page_routes',
-            $this->_page_routes,
-            $this
-        );
-        $this->_page_config = apply_filters(
-            'FHEE__' . $this->class_name . '__page_setup__page_config',
-            $this->_page_config,
-            $this
-        );
-        if ($this->base_class_name !== '') {
-            $this->_page_routes = apply_filters(
-                'FHEE__' . $this->base_class_name . '__page_setup__page_routes',
-                $this->_page_routes,
-                $this
-            );
-            $this->_page_config = apply_filters(
-                'FHEE__' . $this->base_class_name . '__page_setup__page_config',
-                $this->_page_config,
-                $this
-            );
-        }
-        // if AHEE__EE_Admin_Page__route_admin_request_$this->_current_view method is present
-        // then we call it hooked into the AHEE__EE_Admin_Page__route_admin_request action
-        if (method_exists($this, 'AHEE__EE_Admin_Page__route_admin_request_' . $this->_current_view)) {
-            add_action(
-                'AHEE__EE_Admin_Page__route_admin_request',
-                [$this, 'AHEE__EE_Admin_Page__route_admin_request_' . $this->_current_view],
-                10,
-                2
-            );
-        }
-        // next route only if routing enabled
-        if ($this->_routing && ! $this->request->isAjax()) {
-            $this->_verify_routes();
-            // next let's just check user_access and kill if no access
-            $this->check_user_access();
-            if ($this->_is_UI_request) {
-                // admin_init stuff - global, all views for this page class, specific view
-                add_action('admin_init', [$this, 'admin_init']);
-                if (method_exists($this, 'admin_init_' . $this->_current_view)) {
-                    add_action('admin_init', [$this, 'admin_init_' . $this->_current_view], 15);
-                }
-            } else {
-                // hijack regular WP loading and route admin request immediately
-                @ini_set('memory_limit', apply_filters('admin_memory_limit', WP_MAX_MEMORY_LIMIT));
-                $this->route_admin_request();
-            }
-        }
-    }
-
-
-    /**
-     * Provides a way for related child admin pages to load stuff on the loaded admin page.
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    private function _do_other_page_hooks()
-    {
-        $registered_pages = apply_filters('FHEE_do_other_page_hooks_' . $this->page_slug, []);
-        foreach ($registered_pages as $page) {
-            // now let's setup the file name and class that should be present
-            $classname = str_replace('.class.php', '', $page);
-            // autoloaders should take care of loading file
-            if (! class_exists($classname)) {
-                $error_msg[] = sprintf(
-                    esc_html__(
-                        'Something went wrong with loading the %s admin hooks page.',
-                        'event_espresso'
-                    ),
-                    $page
-                );
-                $error_msg[] = $error_msg[0]
-                               . "\r\n"
-                               . sprintf(
-                                   esc_html__(
-                                       'There is no class in place for the %1$s admin hooks page.%2$sMake sure you have %3$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'
-                                   ),
-                                   $page,
-                                   '<br />',
-                                   '<strong>' . $classname . '</strong>'
-                               );
-                throw new EE_Error(implode('||', $error_msg));
-            }
-            // don't load the same class twice
-            static $loaded = [];
-            if (in_array($classname, $loaded, true)) {
-                continue;
-            }
-            $loaded[] = $classname;
-            // notice we are passing the instance of this class to the hook object.
-            $this->loader->getShared($classname, [$this]);
-        }
-    }
-
-
-    /**
-     * @throws ReflectionException
-     * @throws EE_Error
-     */
-    public function load_page_dependencies()
-    {
-        try {
-            $this->_load_page_dependencies();
-        } catch (EE_Error $e) {
-            $e->get_error();
-        }
-    }
-
-
-    /**
-     * load_page_dependencies
-     * loads things specific to this page class when its loaded.  Really helps with efficiency.
-     *
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _load_page_dependencies()
-    {
-        // let's set the current_screen and screen options to override what WP set
-        $this->_current_screen = get_current_screen();
-        // load admin_notices - global, page class, and view specific
-        add_action('admin_notices', [$this, 'admin_notices_global'], 5);
-        add_action('admin_notices', [$this, 'admin_notices']);
-        if (method_exists($this, 'admin_notices_' . $this->_current_view)) {
-            add_action('admin_notices', [$this, 'admin_notices_' . $this->_current_view], 15);
-        }
-        // load network admin_notices - global, page class, and view specific
-        add_action('network_admin_notices', [$this, 'network_admin_notices_global'], 5);
-        if (method_exists($this, 'network_admin_notices_' . $this->_current_view)) {
-            add_action('network_admin_notices', [$this, 'network_admin_notices_' . $this->_current_view]);
-        }
-        // this will save any per_page screen options if they are present
-        $this->_set_per_page_screen_options();
-        // setup list table properties
-        $this->_set_list_table();
-        // child classes can "register" a metabox to be automatically handled via the _page_config array property.
-        // However in some cases the metaboxes will need to be added within a route handling callback.
-        add_action('add_meta_boxes', [$this, 'addRegisteredMetaBoxes'], 99);
-        // hack because promos admin was loading the edited promotion object in the metaboxes callback
-        // which should NOT be generated on non-UI requests like POST updates/inserts
-        if (
-            $this->class_name === 'Promotions_Admin_Page'
-            && ($this->_req_action === 'edit' || $this->_req_action === 'create_new')
-        ) {
-            $this->addRegisteredMetaBoxes();
-        }
-        $this->_add_screen_columns();
-        // add screen options - global, page child class, and view specific
-        $this->_add_global_screen_options();
-        $this->_add_screen_options();
-        $add_screen_options = "_add_screen_options_$this->_current_view";
-        if (method_exists($this, $add_screen_options)) {
-            $this->{$add_screen_options}();
-        }
-        // add help tab(s) - set via page_config and qtips.
-        $this->_add_help_tabs();
-        $this->_add_qtips();
-        // add feature_pointers - global, page child class, and view specific
-        $this->_add_feature_pointers();
-        $this->_add_global_feature_pointers();
-        $add_feature_pointer = "_add_feature_pointer_$this->_current_view";
-        if (method_exists($this, $add_feature_pointer)) {
-            $this->{$add_feature_pointer}();
-        }
-        // enqueue scripts/styles - global, page class, and view specific
-        add_action('admin_enqueue_scripts', [$this, 'load_global_scripts_styles'], 5);
-        add_action('admin_enqueue_scripts', [$this, 'load_scripts_styles']);
-        if (method_exists($this, "load_scripts_styles_$this->_current_view")) {
-            add_action('admin_enqueue_scripts', [$this, "load_scripts_styles_$this->_current_view"], 15);
-        }
-        add_action('admin_enqueue_scripts', [$this, 'admin_footer_scripts_eei18n_js_strings'], 100);
-        // admin_print_footer_scripts - global, page child class, and view specific.
-        // NOTE, despite the name, whenever possible, scripts should NOT be loaded using this.
-        // In most cases that's doing_it_wrong().  But adding hidden container elements etc.
-        // is a good use case. Notice the late priority we're giving these
-        add_action('admin_print_footer_scripts', [$this, 'admin_footer_scripts_global'], 99);
-        add_action('admin_print_footer_scripts', [$this, 'admin_footer_scripts'], 100);
-        if (method_exists($this, "admin_footer_scripts_$this->_current_view")) {
-            add_action('admin_print_footer_scripts', [$this, "admin_footer_scripts_$this->_current_view"], 101);
-        }
-        // admin footer scripts
-        add_action('admin_footer', [$this, 'admin_footer_global'], 99);
-        add_action('admin_footer', [$this, 'admin_footer'], 100);
-        if (method_exists($this, "admin_footer_$this->_current_view")) {
-            add_action('admin_footer', [$this, "admin_footer_$this->_current_view"], 101);
-        }
-        do_action('FHEE__EE_Admin_Page___load_page_dependencies__after_load', $this->page_slug);
-        // targeted hook
-        do_action(
-            "FHEE__EE_Admin_Page___load_page_dependencies__after_load__{$this->page_slug}__$this->_req_action"
-        );
-    }
-
-
-    /**
-     * _set_defaults
-     * This sets some global defaults for class properties.
-     */
-    private function _set_defaults()
-    {
-        // init template args
-        $this->set_template_args(
-            [
-                'admin_page_header'  => '',
-                'admin_page_content' => '',
-                'post_body_content'  => '',
-                'before_list_table'  => '',
-                'after_list_table'   => '',
-            ]
-        );
-    }
-
-
-    /**
-     * route_admin_request
-     *
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws Throwable
-     * @see    _route_admin_request()
-     */
-    public function route_admin_request()
-    {
-        try {
-            $this->_route_admin_request();
-        } catch (EE_Error $e) {
-            $e->get_error();
-        }
-    }
-
-
-    public function set_wp_page_slug($wp_page_slug)
-    {
-        $this->_wp_page_slug = $wp_page_slug;
-        // if in network admin then we need to append "-network" to the page slug. Why? Because that's how WP rolls...
-        if (is_network_admin()) {
-            $this->_wp_page_slug .= '-network';
-        }
-    }
-
-
-    /**
-     * _verify_routes
-     * All this method does is verify the incoming request and make sure that routes exist for it.  We do this early so
-     * we know if we need to drop out.
-     *
-     * @return bool
-     * @throws EE_Error
-     */
-    protected function _verify_routes(): bool
-    {
-        if (! $this->_current_page && ! $this->request->isAjax()) {
-            return false;
-        }
-        // check that the page_routes array is not empty
-        if (empty($this->_page_routes)) {
-            // user error msg
-            $error_msg = sprintf(
-                esc_html__('No page routes have been set for the %s admin page.', 'event_espresso'),
-                $this->_admin_page_title
-            );
-            // developer error msg
-            $error_msg .= '||' . $error_msg
-                          . esc_html__(
-                              ' Make sure the "set_page_routes()" method exists, and is setting the "_page_routes" array properly.',
-                              'event_espresso'
-                          );
-            throw new EE_Error($error_msg);
-        }
-        // route 'editpost' routes to CPT 'edit' routes
-        $alt_edit_route = $this instanceof EE_Admin_Page_CPT ? $this->cpt_editpost_route : 'edit';
-        if (
-            $this->_req_action === 'editpost'
-            && ! isset($this->_page_routes['editpost'])
-            && isset($this->_page_routes[$alt_edit_route])
-        ) {
-            $this->_req_action = $alt_edit_route;
-        }
-        // and that the requested page route exists
-        if (array_key_exists($this->_req_action, $this->_page_routes)) {
-            $this->_route        = $this->_page_routes[ $this->_req_action ];
-            $this->_route_config = $this->_page_config[ $this->_req_action ] ?? [];
-        } else {
-            // user error msg
-            $error_msg = sprintf(
-                esc_html__(
-                    'The requested page route does not exist for the %s admin page.',
-                    'event_espresso'
-                ),
-                $this->_admin_page_title
-            );
-            // developer error msg
-            $error_msg .= '||' . $error_msg
-                          . sprintf(
-                              esc_html__(
-                                  ' Create a key in the "_page_routes" array named "%s" and set its value to the appropriate method.',
-                                  'event_espresso'
-                              ),
-                              $this->_req_action
-                          );
-            throw new EE_Error($error_msg);
-        }
-        // and that a default route exists
-        if (! array_key_exists('default', $this->_page_routes)) {
-            // user error msg
-            $error_msg = sprintf(
-                esc_html__(
-                    'A default page route has not been set for the % admin page.',
-                    'event_espresso'
-                ),
-                $this->_admin_page_title
-            );
-            // developer error msg
-            $error_msg .= '||' . $error_msg
-                          . esc_html__(
-                              ' Create a key in the "_page_routes" array named "default" and set its value to your default page method.',
-                              'event_espresso'
-                          );
-            throw new EE_Error($error_msg);
-        }
-
-        // first lets' catch if the UI request has EVER been set.
-        if ($this->_is_UI_request === null) {
-            // lets set if this is a UI request or not.
-            $this->_is_UI_request = ! $this->request->getRequestParam('noheader', false, DataType::BOOL);
-            // wait a minute... we might have a noheader in the route array
-            $this->_is_UI_request = ! (isset($this->_route['noheader']) && $this->_route['noheader'])
-                ? $this->_is_UI_request
-                : false;
-        }
-        $this->_set_current_labels();
-        return true;
-    }
-
-
-    /**
-     * this method simply verifies a given route and makes sure its an actual route available for the loaded page
-     *
-     * @param string $route the route name we're verifying
-     * @return bool we'll throw an exception if this isn't a valid route.
-     * @throws EE_Error
-     */
-    protected function _verify_route(string $route): bool
-    {
-        if (array_key_exists($this->_req_action, $this->_page_routes)) {
-            return true;
-        }
-        // user error msg
-        $error_msg = sprintf(
-            esc_html__('The given page route does not exist for the %s admin page.', 'event_espresso'),
-            $this->_admin_page_title
-        );
-        // developer error msg
-        $error_msg .= '||' . $error_msg
-                      . sprintf(
-                          esc_html__(
-                              ' Check the route you are using in your method (%s) and make sure it matches a route set in your "_page_routes" array property',
-                              'event_espresso'
-                          ),
-                          $route
-                      );
-        throw new EE_Error($error_msg);
-    }
-
-
-    /**
-     * perform nonce verification
-     * This method has be encapsulated here so that any ajax requests that bypass normal routes can verify their nonces
-     * using this method (and save retyping!)
-     *
-     * @param string $nonce     The nonce sent
-     * @param string $nonce_ref The nonce reference string (name0)
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _verify_nonce(string $nonce, string $nonce_ref)
-    {
-        // verify nonce against expected value
-        if (! wp_verify_nonce($nonce, $nonce_ref)) {
-            // these are not the droids you are looking for !!!
-            $msg = sprintf(
-                esc_html__('%sNonce Fail.%s', 'event_espresso'),
-                '<a href="https://www.youtube.com/watch?v=56_S0WeTkzs">',
-                '</a>'
-            );
-            if (WP_DEBUG) {
-                $msg .= "\n  ";
-                $msg .= sprintf(
-                    esc_html__(
-                        'In order to dynamically generate nonces for your actions, use the %s::add_query_args_and_nonce() method. May the Nonce be with you!',
-                        'event_espresso'
-                    ),
-                    __CLASS__
-                );
-            }
-            if (! $this->request->isAjax()) {
-                wp_die($msg);
-            }
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            $this->_return_json();
-        }
-    }
-
-
-    /**
-     * _route_admin_request()
-     * Meat and potatoes of the class.  Basically, this dude checks out what's being requested and sees if there are
-     * some doodads to work the magic and handle the flingjangy. Translation:  Checks if the requested action is listed
-     * in the page routes and then will try to load the corresponding method.
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws Throwable
-     */
-    protected function _route_admin_request()
-    {
-        if (! $this->_is_UI_request) {
-            $this->_verify_routes();
-        }
-        $nonce_check = ! isset($this->_route_config['require_nonce']) || $this->_route_config['require_nonce'];
-        if ($this->_req_action !== 'default' && $nonce_check) {
-            // set nonce from post data
-            $nonce = $this->request->getRequestParam($this->_req_nonce, '');
-            $this->_verify_nonce($nonce, $this->_req_nonce);
-        }
-        // set the nav_tabs array but ONLY if this is  UI_request
-        if ($this->_is_UI_request) {
-            $this->_set_nav_tabs();
-        }
-        // grab callback function
-        $func = $this->_route['func'] ?? $this->_route;
-        // check if callback has args
-        $args = $this->_route['args'] ?? [];
-
-        // action right before calling route
-        // (hook is something like 'AHEE__Registrations_Admin_Page__route_admin_request')
-        if (! did_action('AHEE__EE_Admin_Page__route_admin_request')) {
-            do_action('AHEE__EE_Admin_Page__route_admin_request', $this->_current_view, $this);
-        }
-        // strip _wp_http_referer from the server REQUEST_URI
-        // else it grows in length on every submission due to recursion,
-        // ultimately causing a "Request-URI Too Large" error
-        $this->request->unSetRequestParam('_wp_http_referer');
-        $this->request->unSetServerParam('_wp_http_referer');
-        $cleaner_request_uri = remove_query_arg(
-            '_wp_http_referer',
-            wp_unslash($this->request->getServerParam('REQUEST_URI'))
-        );
-        $this->request->setRequestParam('_wp_http_referer', $cleaner_request_uri, true);
-        $this->request->setServerParam('REQUEST_URI', $cleaner_request_uri, true);
-        $route_callback = [];
-        if (! empty($func)) {
-            if (is_array($func)) {
-                $route_callback = $func;
-            } elseif (is_string($func)) {
-                if (strpos($func, '::') !== false) {
-                    $route_callback = explode('::', $func);
-                } elseif (method_exists($this, $func)) {
-                    $route_callback = [$this, $func];
-                } else {
-                    $route_callback = $func;
-                }
-            }
-            [$class, $method] = $route_callback;
-            // is it neither a class method NOR a standalone function?
-            if (! is_callable($route_callback)) {
-                // user error msg
-                $error_msg = esc_html__(
-                    'An error occurred. The  requested page route could not be found.',
-                    'event_espresso'
-                );
-                // developer error msg
-                $error_msg .= '||';
-                $error_msg .= sprintf(
-                    esc_html__(
-                        'Page route "%s" could not be called. Check that the spelling for method names and actions in the "_page_routes" array are all correct.',
-                        'event_espresso'
-                    ),
-                    $method
-                );
-                throw new DomainException($error_msg);
-            }
-            if ($class !== $this && ! in_array($this, $args)) {
-                // send along this admin page object for access by addons.
-                $args['admin_page'] = $this;
-            }
-
-            try {
-                call_user_func_array($route_callback, $args);
-            } catch (Throwable $throwable) {
-                $nice_args = [];
-                foreach ($args as $key => $arg) {
-                    $nice_args[ $key ] = is_object($arg) ? get_class($arg) : $key;
-                }
-                new ExceptionStackTraceDisplay(
-                    new RuntimeException(
-                        sprintf(
-                            esc_html__(
-                                'Page route "%1$s" with the supplied arguments (%2$s) threw the following exception: %3$s',
-                                'event_espresso'
-                            ),
-                            $method,
-                            implode(', ', $nice_args),
-                            $throwable->getMessage()
-                        ),
-                        $throwable->getCode(),
-                        $throwable
-                    )
-                );
-            }
-        }
-        // if we've routed and this route has a no headers route AND a sent_headers_route,
-        // then we need to reset the routing properties to the new route.
-        // now if UI request is FALSE and noheader is true AND we have a headers_sent_route in the route array then let's set UI_request to true because the no header route has a second func after headers have been sent.
-        if (
-            $this->_is_UI_request === false
-            && is_array($this->_route)
-            && ! empty($this->_route['headers_sent_route'])
-        ) {
-            $this->_reset_routing_properties($this->_route['headers_sent_route']);
-        }
-    }
-
-
-    /**
-     * This method just allows the resetting of page properties in the case where a no headers
-     * route redirects to a headers route in its route config.
-     *
-     * @param string $new_route New (non header) route to redirect to.
-     * @return void
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws Throwable
-     * @since   4.3.0
-     */
-    protected function _reset_routing_properties(string $new_route)
-    {
-        $this->_is_UI_request = true;
-        // now we set the current route to whatever the headers_sent_route is set at
-        $this->request->setRequestParam('action', $new_route);
-        // rerun page setup
-        $this->_page_setup();
-    }
-
-
-    /**
-     * _add_query_arg
-     * adds nonce to array of arguments then calls WP add_query_arg function
-     *(internally just uses EEH_URL's function with the same name)
-     *
-     * @param array  $args
-     * @param string $url
-     * @param bool   $sticky                  if true, then the existing Request params will be appended to the
-     *                                        generated url in an associative array indexed by the key 'wp_referer';
-     *                                        Example usage: If the current page is:
-     *                                        http://mydomain.com/wp-admin/admin.php?page=espresso_registrations
-     *                                        &action=default&event_id=20&month_range=March%202015
-     *                                        &_wpnonce=5467821
-     *                                        and you call:
-     *                                        EE_Admin_Page::add_query_args_and_nonce(
-     *                                        array(
-     *                                        'action' => 'resend_something',
-     *                                        'page=>espresso_registrations'
-     *                                        ),
-     *                                        $some_url,
-     *                                        true
-     *                                        );
-     *                                        It will produce a url in this structure:
-     *                                        http://{$some_url}/?page=espresso_registrations&action=resend_something
-     *                                        &wp_referer[action]=default&wp_referer[event_id]=20&wpreferer[
-     *                                        month_range]=March%202015
-     * @param bool   $exclude_nonce           If true, the the nonce will be excluded from the generated nonce.
-     * @param int    $context
-     * @return string
-     */
-    public static function add_query_args_and_nonce(
-        array $args = [],
-        string $url = '',
-        bool $sticky = false,
-        bool $exclude_nonce = false,
-        int $context = EEH_URL::CONTEXT_NONE
-    ): string {
-        // if there is a _wp_http_referer include the values from the request but only if sticky = true
-        if ($sticky) {
-            /** @var RequestInterface $request */
-            $request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-            $request->unSetRequestParams(['_wp_http_referer', 'wp_referer'], true);
-            $request->unSetServerParam('_wp_http_referer', true);
-            foreach ($request->requestParams() as $key => $value) {
-                // do not add nonces
-                if (strpos($key, 'nonce') !== false) {
-                    continue;
-                }
-                $args[ 'wp_referer[' . $key . ']' ] = is_string($value) ? htmlspecialchars($value) : $value;
-            }
-        }
-        return EEH_URL::add_query_args_and_nonce($args, $url, $exclude_nonce, $context);
-    }
-
-
-    /**
-     * This returns a generated link that will load the related help tab.
-     *
-     * @param string $help_tab_id the id for the connected help tab
-     * @param string $icon_style  (optional) include css class for the style you want to use for the help icon.
-     * @param string $help_text   (optional) send help text you want to use for the link if default not to be used
-     * @return string              generated link
-     * @uses EEH_Template::get_help_tab_link()
-     */
-    protected function _get_help_tab_link(string $help_tab_id, string $icon_style = '', string $help_text = ''): string
-    {
-        return EEH_Template::get_help_tab_link(
-            $help_tab_id,
-            $this->page_slug,
-            $this->_req_action,
-            $icon_style,
-            $help_text
-        );
-    }
-
-
-    /**
-     * _add_help_tabs
-     * Note child classes define their help tabs within the page_config array.
-     *
-     * @link   http://codex.wordpress.org/Function_Reference/add_help_tab
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _add_help_tabs()
-    {
-        if (isset($this->_page_config[ $this->_req_action ])) {
-            $config = $this->_page_config[ $this->_req_action ];
-            // let's see if there is a help_sidebar set for the current route and we'll set that up for usage as well.
-            if (is_array($config) && isset($config['help_sidebar'])) {
-                // check that the callback given is valid
-                if (! method_exists($this, $config['help_sidebar'])) {
-                    throw new EE_Error(
-                        sprintf(
-                            esc_html__(
-                                'The _page_config array has a callback set for the "help_sidebar" option.  However the callback given (%s) is not a valid callback.  Doublecheck the spelling and make sure this method exists for the class %s',
-                                'event_espresso'
-                            ),
-                            $config['help_sidebar'],
-                            $this->class_name
-                        )
-                    );
-                }
-                $content = apply_filters(
-                    'FHEE__' . $this->class_name . '__add_help_tabs__help_sidebar',
-                    $this->{$config['help_sidebar']}()
-                );
-                $this->_current_screen->set_help_sidebar($content);
-            }
-            if (! isset($config['help_tabs'])) {
-                return;
-            } //no help tabs for this route
-            foreach ((array) $config['help_tabs'] as $tab_id => $cfg) {
-                // we're here so there ARE help tabs!
-                // make sure we've got what we need
-                if (! isset($cfg['title'])) {
-                    throw new EE_Error(
-                        esc_html__(
-                            'The _page_config array is not set up properly for help tabs.  It is missing a title',
-                            'event_espresso'
-                        )
-                    );
-                }
-                if (! isset($cfg['filename']) && ! isset($cfg['callback']) && ! isset($cfg['content'])) {
-                    throw new EE_Error(
-                        esc_html__(
-                            'The _page_config array is not setup properly for help tabs. It is missing a either a filename reference, or a callback reference or a content reference so there is no way to know the content for the help tab',
-                            'event_espresso'
-                        )
-                    );
-                }
-                // first priority goes to content.
-                if (! empty($cfg['content'])) {
-                    $content = $cfg['content'];
-                    // second priority goes to filename
-                } elseif (! empty($cfg['filename'])) {
-                    $file_path = $this->_get_dir() . '/help_tabs/' . $cfg['filename'] . '.help_tab.php';
-                    // it's possible that the file is located on decaf route (and above sets up for caf route, if this is the case then lets check decaf route too)
-                    $file_path = ! is_readable($file_path) ? EE_ADMIN_PAGES
-                                                             . basename($this->_get_dir())
-                                                             . '/help_tabs/'
-                                                             . $cfg['filename']
-                                                             . '.help_tab.php' : $file_path;
-                    // if file is STILL not readable then let's do a EE_Error so its more graceful than a fatal error.
-                    if (! isset($cfg['callback']) && ! is_readable($file_path)) {
-                        EE_Error::add_error(
-                            sprintf(
-                                esc_html__(
-                                    'The filename given for the help tab %s is not a valid file and there is no other configuration for the tab content.  Please check that the string you set for the help tab on this route (%s) is the correct spelling.  The file should be in %s',
-                                    'event_espresso'
-                                ),
-                                $tab_id,
-                                key($config),
-                                $file_path
-                            ),
-                            __FILE__,
-                            __FUNCTION__,
-                            __LINE__
-                        );
-                        return;
-                    }
-                    $template_args['admin_page_obj'] = $this;
-                    $content                         = EEH_Template::display_template(
-                        $file_path,
-                        $template_args,
-                        true
-                    );
-                } else {
-                    $content = '';
-                }
-                // check if callback is valid
-                if (
-                    empty($content)
-                    && (
-                        ! isset($cfg['callback']) || ! method_exists($this, $cfg['callback'])
-                    )
-                ) {
-                    EE_Error::add_error(
-                        sprintf(
-                            esc_html__(
-                                'The callback given for a %s help tab on this page does not content OR a corresponding method for generating the content.  Check the spelling or make sure the method is present.',
-                                'event_espresso'
-                            ),
-                            $cfg['title']
-                        ),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                    return;
-                }
-                // setup config array for help tab method
-                $id  = $this->page_slug . '-' . $this->_req_action . '-' . $tab_id;
-                $_ht = [
-                    'id'       => $id,
-                    'title'    => $cfg['title'],
-                    'callback' => isset($cfg['callback']) && empty($content) ? [$this, $cfg['callback']] : null,
-                    'content'  => $content,
-                ];
-                $this->_current_screen->add_help_tab($_ht);
-            }
-        }
-    }
-
-
-    /**
-     * This simply sets up any qtips that have been defined in the page config
-     *
-     * @return void
-     * @throws ReflectionException
-     * @throws EE_Error
-     */
-    protected function _add_qtips()
-    {
-        if (isset($this->_route_config['qtips'])) {
-            $qtips = (array) $this->_route_config['qtips'];
-            // load qtip loader
-            $path = [
-                $this->_get_dir() . '/qtips/',
-                EE_ADMIN_PAGES . basename($this->_get_dir()) . '/qtips/',
-            ];
-            EEH_Qtip_Loader::instance()->register($qtips, $path);
-        }
-    }
-
-
-    /**
-     * _set_nav_tabs
-     * This sets up the nav tabs from the page_routes array.  This method can be overwritten by child classes if you
-     * wish to add additional tabs or modify accordingly.
-     *
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    protected function _set_nav_tabs()
-    {
-        $i        = 0;
-        $only_tab = count($this->_page_config) < 2;
-        foreach ($this->_page_config as $slug => $config) {
-            if (! is_array($config) || empty($config['nav'])) {
-                continue;
-            }
-            // no nav tab for this config
-            // check for persistent flag
-            if ($slug !== $this->_req_action && isset($config['nav']['persistent']) && ! $config['nav']['persistent']) {
-                // nav tab is only to appear when route requested.
-                continue;
-            }
-            if (! $this->check_user_access($slug, true)) {
-                // no nav tab because current user does not have access.
-                continue;
-            }
-            $css_class = $config['css_class'] ?? '';
-            $css_class .= $only_tab ? ' ee-only-tab' : '';
-            $css_class .= " ee-nav-tab__$slug";
-
-            $this->_nav_tabs[ $slug ] = [
-                'url'       => $config['nav']['url'] ?? EE_Admin_Page::add_query_args_and_nonce(
-                        ['action' => $slug],
-                        $this->_admin_base_url
-                    ),
-                'link_text' => $this->navTabLabel($config['nav'], $slug),
-                'css_class' => $this->_req_action === $slug ? $css_class . ' nav-tab-active' : $css_class,
-                'order'     => $config['nav']['order'] ?? $i,
-            ];
-            $i++;
-        }
-        // if $this->_nav_tabs is empty then lets set the default
-        if (empty($this->_nav_tabs)) {
-            $this->_nav_tabs[ $this->_default_nav_tab_name ] = [
-                'url'       => $this->_admin_base_url,
-                'link_text' => ucwords(str_replace('_', ' ', $this->_default_nav_tab_name)),
-                'css_class' => 'nav-tab-active',
-                'order'     => 10,
-            ];
-        }
-        // now let's sort the tabs according to order
-        usort($this->_nav_tabs, [$this, '_sort_nav_tabs']);
-    }
-
-
-    private function navTabLabel(array $nav_tab, string $slug): string
-    {
-        $label = $nav_tab['label'] ?? ucwords(str_replace('_', ' ', $slug));
-        $icon  = $nav_tab['icon'] ?? null;
-        $icon  = $icon ? '<span class="dashicons ' . $icon . '"></span>' : '';
-        return '
+	/**
+	 * sanitized request action
+	 */
+	protected string $_req_action = '';
+
+	/**
+	 * sanitized request action nonce
+	 */
+	protected string $_req_nonce        = '';
+
+	protected string $_search_btn_label = '';
+
+	protected string $_template_path    = '';
+
+	protected string $_view             = '';
+
+	/**
+	 * set early within EE_Admin_Init
+	 *
+	 * @var string
+	 */
+	protected string $_wp_page_slug = '';
+
+	/**
+	 * if the current class is an admin page extension, like: Extend_Events_Admin_Page,
+	 * then this would be the parent classname: Events_Admin_Page
+	 *
+	 * @var string
+	 */
+	public string $base_class_name = '';
+
+	public string $class_name      = '';
+
+	/**
+	 * unprocessed value for the 'action' request param (default '')
+	 *
+	 * @var string
+	 */
+	protected string $raw_req_action = '';
+
+	/**
+	 * unprocessed value for the 'page' request param (default '')
+	 *
+	 * @var string
+	 */
+	protected string $raw_req_page = '';
+
+	public string    $page_folder  = '';
+
+	public string    $page_label   = '';
+
+	public string    $page_slug    = '';
+
+
+	/**
+	 * the current page route and route config
+	 *
+	 * @var array|callable|string|null
+	 */
+	protected $_route = null;
+
+
+	/**
+	 * @Constructor
+	 * @param bool $routing indicate whether we want to just load the object and handle routing or just load the object.
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function __construct($routing = true)
+	{
+		$this->loader       = LoaderFactory::getLoader();
+		$this->admin_config = $this->loader->getShared(EE_Admin_Config::class);
+		$this->feature      = $this->loader->getShared(FeatureFlags::class);
+		$this->request      = $this->loader->getShared(RequestInterface::class);
+		$this->capabilities = $this->loader->getShared(EE_Capabilities::class);
+		// routing enabled?
+		$this->_routing = $routing;
+
+		$this->class_name      = get_class($this);
+		$this->base_class_name = strpos($this->class_name, 'Extend_') === 0
+			? str_replace('Extend_', '', $this->class_name)
+			: '';
+
+		if (strpos($this->_get_dir(), 'caffeinated') !== false) {
+			$this->_is_caf = true;
+		}
+		$this->_yes_no_values = [
+			['id' => true, 'text' => esc_html__('Yes', 'event_espresso')],
+			['id' => false, 'text' => esc_html__('No', 'event_espresso')],
+		];
+		// set the _req_data property.
+		$this->_req_data = $this->request->requestParams();
+	}
+
+
+	/**
+	 * @return EE_Admin_Config
+	 */
+	public function adminConfig(): EE_Admin_Config
+	{
+		return $this->admin_config;
+	}
+
+
+	/**
+	 * @return FeatureFlags
+	 */
+	public function feature(): FeatureFlags
+	{
+		return $this->feature;
+	}
+
+
+	/**
+	 * This logic used to be in the constructor, but that caused a chicken <--> egg scenario
+	 * for child classes that needed to set properties prior to these methods getting called,
+	 * but also needed the parent class to have its construction completed as well.
+	 * Bottom line is that constructors should ONLY be used for setting initial properties
+	 * and any complex initialization logic should only run after instantiation is complete.
+	 * This method gets called immediately after construction from within
+	 *      EE_Admin_Page_Init::_initialize_admin_page()
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws Throwable
+	 * @since 5.0.0.p
+	 */
+	public function initializePage()
+	{
+		if ($this->initialized) {
+			return;
+		}
+		// set initial page props (child method)
+		$this->_init_page_props();
+		// set global defaults
+		$this->_set_defaults();
+		// set early because incoming requests could be ajax related and we need to register those hooks.
+		$this->_global_ajax_hooks();
+		$this->_ajax_hooks();
+		// other_page_hooks have to be early too.
+		$this->_do_other_page_hooks();
+		// set up page dependencies
+		$this->_before_page_setup();
+		$this->_page_setup();
+		$this->initialized = true;
+	}
+
+
+	/**
+	 * _init_page_props
+	 * Child classes use to set at least the following properties:
+	 * $page_slug.
+	 * $page_label.
+	 *
+	 * @abstract
+	 * @return void
+	 */
+	abstract protected function _init_page_props();
+
+
+	/**
+	 * _ajax_hooks
+	 * child classes put all their add_action('wp_ajax_{name_of_hook}') hooks in here.
+	 * Note: within the ajax callback methods.
+	 *
+	 * @abstract
+	 * @return void
+	 */
+	abstract protected function _ajax_hooks();
+
+
+	/**
+	 * _define_page_props
+	 * child classes define page properties in here.  Must include at least:
+	 * $_admin_base_url = base_url for all admin pages
+	 * $_admin_page_title = default admin_page_title for admin pages
+	 * $_labels = array of default labels for various automatically generated elements:
+	 *    array(
+	 *        'buttons' => array(
+	 *            'add' => esc_html__('label for add new button'),
+	 *            'edit' => esc_html__('label for edit button'),
+	 *            'delete' => esc_html__('label for delete button')
+	 *            )
+	 *        )
+	 *
+	 * @abstract
+	 * @return void
+	 */
+	abstract protected function _define_page_props();
+
+
+	/**
+	 * _set_page_routes
+	 * child classes use this to define the page routes for all subpages handled by the class.  Page routes are
+	 * assigned to a action => method pairs in an array and to the $_page_routes property.  Each page route must also
+	 * have a 'default' route. Here's the format
+	 * $this->_page_routes = array(
+	 *        'default' => array(
+	 *            'func' => '_default_method_handling_route',
+	 *            'args' => array('array','of','args'),
+	 *            'noheader' => true, //add this in if this page route is processed before any headers are loaded (i.e.
+	 *            ajax request, backend processing)
+	 *            'headers_sent_route'=>'headers_route_reference', //add this if noheader=>true, and you want to load a
+	 *            headers route after.  The string you enter here should match the defined route reference for a
+	 *            headers sent route.
+	 *            'capability' => 'route_capability', //indicate a string for minimum capability required to access
+	 *            this route.
+	 *            'obj_id' => 10 // if this route has an object id, then this can include it (used for capability
+	 *            checks).
+	 *        ),
+	 *        'insert_item' => '_method_for_handling_insert_item' //this can be used if all we need to have is a
+	 *        handling method.
+	 *        )
+	 * )
+	 *
+	 * @abstract
+	 * @return void
+	 */
+	abstract protected function _set_page_routes();
+
+
+	/**
+	 * _set_page_config
+	 * child classes use this to define the _page_config array for all subpages handled by the class. Each key in the
+	 * array corresponds to the page_route for the loaded page. Format:
+	 * $this->_page_config = array(
+	 *        'default' => array(
+	 *            'labels' => array(
+	 *                'buttons' => array(
+	 *                    'add' => esc_html__('label for adding item'),
+	 *                    'edit' => esc_html__('label for editing item'),
+	 *                    'delete' => esc_html__('label for deleting item')
+	 *                ),
+	 *                'publishbox' => esc_html__('Localized Title for Publish metabox', 'event_espresso')
+	 *            ), //optional an array of custom labels for various automatically generated elements to use on the
+	 *            page. If this isn't present then the defaults will be used as set for the $this->_labels in
+	 *            _define_page_props() method
+	 *            'nav' => array(
+	 *                'label' => esc_html__('Label for Tab', 'event_espresso').
+	 *                'url' => 'http://someurl', //automatically generated UNLESS you define
+	 *                'css_class' => 'css-class', //automatically generated UNLESS you define
+	 *                'order' => 10, //required to indicate tab position.
+	 *                'persistent' => false //if you want the nav tab to ONLY display when the specific route is
+	 *                displayed then add this parameter.
+	 *            'list_table' => 'name_of_list_table' //string for list table class to be loaded for this admin_page.
+	 *            'metaboxes' => array('metabox1', 'metabox2'), //if present this key indicates we want to load
+	 *            metaboxes set for eventespresso admin pages.
+	 *            'has_metaboxes' => true, //this boolean flag can simply be used to indicate if the route will have
+	 *            metaboxes.  Typically this is used if the 'metaboxes' index is not used because metaboxes are added
+	 *            later.  We just use this flag to make sure the necessary js gets enqueued on page load.
+	 *            'has_help_popups' => false //defaults(true) //this boolean flag can simply be used to indicate if the
+	 *            given route has help popups setup and if it does then we need to make sure thickbox is enqueued.
+	 *            'columns' => array(4, 2), //this key triggers the setup of a page that uses columns (metaboxes).  The
+	 *            array indicates the max number of columns (4) and the default number of columns on page load (2).
+	 *            There is an option in the "screen_options" dropdown that is setup so users can pick what columns they
+	 *            want to display.
+	 *            'help_tabs' => array( //this is used for adding help tabs to a page
+	 *                'tab_id' => array(
+	 *                    'title' => 'tab_title',
+	 *                    'filename' => 'name_of_file_containing_content', //this is the primary method for setting
+	 *                    help tab content.  The fallback if it isn't present is to try a the callback.  Filename
+	 *                    should match a file in the admin folder's "help_tabs" dir (ie..
+	 *                    events/help_tabs/name_of_file_containing_content.help_tab.php)
+	 *                    'callback' => 'callback_method_for_content', //if 'filename' isn't present then system will
+	 *                    attempt to use the callback which should match the name of a method in the class
+	 *                    ),
+	 *                'tab2_id' => array(
+	 *                    'title' => 'tab2 title',
+	 *                    'filename' => 'file_name_2'
+	 *                    'callback' => 'callback_method_for_content',
+	 *                 ),
+	 *            'help_sidebar' => 'callback_for_sidebar_content', //this is used for setting up the sidebar in the
+	 *            help tab area on an admin page. @return void
+	 *
+	 * @abstract
+	 */
+	abstract protected function _set_page_config();
+
+
+	/**
+	 * _add_screen_options
+	 * Child classes can add any extra wp_screen_options within this method using built-in WP functions/methods for
+	 * doing so. Note child classes can also define _add_screen_options_($this->_current_view) to limit screen options
+	 * to a particular view.
+	 *
+	 * @link   http://chrismarslender.com/wp-tutorials/wordpress-screen-options-tutorial/
+	 *         see also WP_Screen object documents...
+	 * @link   http://codex.wordpress.org/Class_Reference/WP_Screen
+	 * @abstract
+	 * @return void
+	 */
+	abstract protected function _add_screen_options();
+
+
+	/**
+	 * _add_feature_pointers
+	 * Child classes should use this method for implementing any "feature pointers" (using built-in WP styling js).
+	 * Note child classes can also define _add_feature_pointers_($this->_current_view) to limit screen options to a
+	 * particular view. Note: this is just a placeholder for now.  Implementation will come down the road See:
+	 * WP_Internal_Pointers class in wp-admin/includes/template.php for example (its a final class so can't be
+	 * extended) also see:
+	 *
+	 * @link   http://eamann.com/tech/wordpress-portland/
+	 * @abstract
+	 * @return void
+	 */
+	abstract protected function _add_feature_pointers();
+
+
+	/**
+	 * load_scripts_styles
+	 * child classes put their wp_enqueue_script and wp_enqueue_style hooks in here for anything they need loaded for
+	 * their pages/subpages.  Note this is for all pages/subpages of the system.  You can also load only specific
+	 * scripts/styles per view by putting them in a dynamic function in this format
+	 * (load_scripts_styles_{$this->_current_view}) which matches your page route (action request arg)
+	 *
+	 * @abstract
+	 * @return void
+	 */
+	abstract public function load_scripts_styles();
+
+
+	/**
+	 * admin_init
+	 * Anything that should be set/executed at 'admin_init' WP hook runtime should be put in here.  This will apply to
+	 * all pages/views loaded by child class.
+	 *
+	 * @abstract
+	 * @return void
+	 */
+	abstract public function admin_init();
+
+
+	/**
+	 * admin_notices
+	 * Anything triggered by the 'admin_notices' WP hook should be put in here.  This particular method will apply to
+	 * all pages/views loaded by child class.
+	 *
+	 * @abstract
+	 * @return void
+	 */
+	abstract public function admin_notices();
+
+
+	/**
+	 * admin_footer_scripts
+	 * Anything triggered by the 'admin_print_footer_scripts' WP hook should be put in here. This particular method
+	 * will apply to all pages/views loaded by child class.
+	 *
+	 * @return void
+	 */
+	abstract public function admin_footer_scripts();
+
+
+	/**
+	 * admin_footer
+	 * anything triggered by the 'admin_footer' WP action hook should be added to here. This particular method will
+	 * apply to all pages/views loaded by child class.
+	 *
+	 * @return void
+	 */
+	public function admin_footer()
+	{
+	}
+
+
+	/**
+	 * _global_ajax_hooks
+	 * all global add_action('wp_ajax_{name_of_hook}') hooks in here.
+	 * Note: within the ajax callback methods.
+	 *
+	 * @abstract
+	 * @return void
+	 */
+	protected function _global_ajax_hooks()
+	{
+		// for lazy loading of metabox content
+		add_action('wp_ajax_espresso-ajax-content', [$this, 'ajax_metabox_content']);
+
+		add_action(
+			'wp_ajax_espresso_hide_status_change_notice',
+			[$this, 'hideStatusChangeNotice']
+		);
+		add_action(
+			'wp_ajax_nopriv_espresso_hide_status_change_notice',
+			[$this, 'hideStatusChangeNotice']
+		);
+	}
+
+
+	public function ajax_metabox_content()
+	{
+		$content_id  = $this->request->getRequestParam('contentid', '');
+		$content_url = $this->request->getRequestParam('contenturl', '', DataType::URL);
+		EE_Admin_Page::cached_rss_display($content_id, $content_url);
+		wp_die();
+	}
+
+
+	public function hideStatusChangeNotice()
+	{
+		$response = [];
+		try {
+			/** @var StatusChangeNotice $status_change_notice */
+			$status_change_notice = $this->loader->getShared(
+				'EventEspresso\core\domain\services\admin\notices\status_change\StatusChangeNotice'
+			);
+			$response['success']  = $status_change_notice->dismiss() > -1;
+		} catch (Exception $exception) {
+			$response['errors'] = $exception->getMessage();
+		}
+		echo wp_json_encode($response);
+		exit();
+	}
+
+
+	/**
+	 * allows extending classes do something specific before the parent constructor runs _page_setup().
+	 *
+	 * @return void
+	 */
+	protected function _before_page_setup()
+	{
+		// default is to do nothing
+	}
+
+
+	/**
+	 * Makes sure any things that need to be loaded early get handled.
+	 * We also escape early here if the page requested doesn't match the object.
+	 *
+	 * @final
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws Throwable
+	 */
+	final protected function _page_setup()
+	{
+		// requires?
+		// admin_init stuff - global - we're setting this REALLY early
+		// so if EE_Admin pages have to hook into other WP pages they can.
+		// But keep in mind, not everything is available from the EE_Admin Page object at this point.
+		add_action('admin_init', [$this, 'admin_init_global'], 5);
+		// next verify if we need to load anything...
+		$this->_current_page = $this->request->getRequestParam('page', '', DataType::KEY);
+		$this->_current_page = $this->request->getRequestParam('current_page', $this->_current_page, DataType::KEY);
+		$this->page_folder   = strtolower(
+			str_replace(['_Admin_Page', 'Extend_'], '', $this->class_name)
+		);
+		global $ee_menu_slugs;
+		$ee_menu_slugs = (array) $ee_menu_slugs;
+		if (
+			! $this->request->isAjax()
+			&& (! $this->_current_page || ! isset($ee_menu_slugs[ $this->_current_page ]))
+		) {
+			return;
+		}
+		// because WP List tables have two duplicate select inputs for choosing bulk actions,
+		// we need to copy the action from the second to the first
+		$action     = $this->request->getRequestParam('action', '-1', DataType::KEY);
+		$action2    = $this->request->getRequestParam('action2', '-1', DataType::KEY);
+		$action     = $action !== '-1' ? $action : $action2;
+		$req_action = $action !== '-1' ? $action : 'default';
+
+		// if a specific 'route' has been set, and the action is 'default' OR we are doing_ajax
+		// then let's use the route as the action.
+		// This covers cases where we're coming in from a list table that isn't on the default route.
+		$route             = $this->request->getRequestParam('route');
+		$this->_req_action = $route && ($req_action === 'default' || $this->request->isAjax())
+			? $route
+			: $req_action;
+		$this->_current_view = $this->_req_action;
+		$this->_req_nonce    = $this->_req_action . '_nonce';
+		$this->_define_page_props();
+		$this->_current_page_view_url = add_query_arg(
+			['page' => $this->_current_page, 'action' => $this->_current_view],
+			$this->_admin_base_url
+		);
+		// set page configs
+		$this->_set_page_routes();
+		$this->_set_page_config();
+		// let's include any referrer data in our default_query_args for this route for "stickiness".
+		if ($this->request->requestParamIsSet('wp_referer')) {
+			$wp_referer = $this->request->getRequestParam('wp_referer');
+			if ($wp_referer) {
+				$this->_default_route_query_args['wp_referer'] = $wp_referer;
+			}
+		}
+		// for CPT and other extended functionality.
+		// If there is an _extend_page_config_for_cpt
+		// then let's run that to modify all the various page configuration arrays.
+		if (method_exists($this, '_extend_page_config_for_cpt')) {
+			$this->_extend_page_config_for_cpt();
+		}
+		// filter routes and page_config so addons can add their stuff. Filtering done per class
+		$this->_page_routes = apply_filters(
+			'FHEE__' . $this->class_name . '__page_setup__page_routes',
+			$this->_page_routes,
+			$this
+		);
+		$this->_page_config = apply_filters(
+			'FHEE__' . $this->class_name . '__page_setup__page_config',
+			$this->_page_config,
+			$this
+		);
+		if ($this->base_class_name !== '') {
+			$this->_page_routes = apply_filters(
+				'FHEE__' . $this->base_class_name . '__page_setup__page_routes',
+				$this->_page_routes,
+				$this
+			);
+			$this->_page_config = apply_filters(
+				'FHEE__' . $this->base_class_name . '__page_setup__page_config',
+				$this->_page_config,
+				$this
+			);
+		}
+		// if AHEE__EE_Admin_Page__route_admin_request_$this->_current_view method is present
+		// then we call it hooked into the AHEE__EE_Admin_Page__route_admin_request action
+		if (method_exists($this, 'AHEE__EE_Admin_Page__route_admin_request_' . $this->_current_view)) {
+			add_action(
+				'AHEE__EE_Admin_Page__route_admin_request',
+				[$this, 'AHEE__EE_Admin_Page__route_admin_request_' . $this->_current_view],
+				10,
+				2
+			);
+		}
+		// next route only if routing enabled
+		if ($this->_routing && ! $this->request->isAjax()) {
+			$this->_verify_routes();
+			// next let's just check user_access and kill if no access
+			$this->check_user_access();
+			if ($this->_is_UI_request) {
+				// admin_init stuff - global, all views for this page class, specific view
+				add_action('admin_init', [$this, 'admin_init']);
+				if (method_exists($this, 'admin_init_' . $this->_current_view)) {
+					add_action('admin_init', [$this, 'admin_init_' . $this->_current_view], 15);
+				}
+			} else {
+				// hijack regular WP loading and route admin request immediately
+				@ini_set('memory_limit', apply_filters('admin_memory_limit', WP_MAX_MEMORY_LIMIT));
+				$this->route_admin_request();
+			}
+		}
+	}
+
+
+	/**
+	 * Provides a way for related child admin pages to load stuff on the loaded admin page.
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private function _do_other_page_hooks()
+	{
+		$registered_pages = apply_filters('FHEE_do_other_page_hooks_' . $this->page_slug, []);
+		foreach ($registered_pages as $page) {
+			// now let's setup the file name and class that should be present
+			$classname = str_replace('.class.php', '', $page);
+			// autoloaders should take care of loading file
+			if (! class_exists($classname)) {
+				$error_msg[] = sprintf(
+					esc_html__(
+						'Something went wrong with loading the %s admin hooks page.',
+						'event_espresso'
+					),
+					$page
+				);
+				$error_msg[] = $error_msg[0]
+							   . "\r\n"
+							   . sprintf(
+								   esc_html__(
+									   'There is no class in place for the %1$s admin hooks page.%2$sMake sure you have %3$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'
+								   ),
+								   $page,
+								   '<br />',
+								   '<strong>' . $classname . '</strong>'
+							   );
+				throw new EE_Error(implode('||', $error_msg));
+			}
+			// don't load the same class twice
+			static $loaded = [];
+			if (in_array($classname, $loaded, true)) {
+				continue;
+			}
+			$loaded[] = $classname;
+			// notice we are passing the instance of this class to the hook object.
+			$this->loader->getShared($classname, [$this]);
+		}
+	}
+
+
+	/**
+	 * @throws ReflectionException
+	 * @throws EE_Error
+	 */
+	public function load_page_dependencies()
+	{
+		try {
+			$this->_load_page_dependencies();
+		} catch (EE_Error $e) {
+			$e->get_error();
+		}
+	}
+
+
+	/**
+	 * load_page_dependencies
+	 * loads things specific to this page class when its loaded.  Really helps with efficiency.
+	 *
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _load_page_dependencies()
+	{
+		// let's set the current_screen and screen options to override what WP set
+		$this->_current_screen = get_current_screen();
+		// load admin_notices - global, page class, and view specific
+		add_action('admin_notices', [$this, 'admin_notices_global'], 5);
+		add_action('admin_notices', [$this, 'admin_notices']);
+		if (method_exists($this, 'admin_notices_' . $this->_current_view)) {
+			add_action('admin_notices', [$this, 'admin_notices_' . $this->_current_view], 15);
+		}
+		// load network admin_notices - global, page class, and view specific
+		add_action('network_admin_notices', [$this, 'network_admin_notices_global'], 5);
+		if (method_exists($this, 'network_admin_notices_' . $this->_current_view)) {
+			add_action('network_admin_notices', [$this, 'network_admin_notices_' . $this->_current_view]);
+		}
+		// this will save any per_page screen options if they are present
+		$this->_set_per_page_screen_options();
+		// setup list table properties
+		$this->_set_list_table();
+		// child classes can "register" a metabox to be automatically handled via the _page_config array property.
+		// However in some cases the metaboxes will need to be added within a route handling callback.
+		add_action('add_meta_boxes', [$this, 'addRegisteredMetaBoxes'], 99);
+		// hack because promos admin was loading the edited promotion object in the metaboxes callback
+		// which should NOT be generated on non-UI requests like POST updates/inserts
+		if (
+			$this->class_name === 'Promotions_Admin_Page'
+			&& ($this->_req_action === 'edit' || $this->_req_action === 'create_new')
+		) {
+			$this->addRegisteredMetaBoxes();
+		}
+		$this->_add_screen_columns();
+		// add screen options - global, page child class, and view specific
+		$this->_add_global_screen_options();
+		$this->_add_screen_options();
+		$add_screen_options = "_add_screen_options_$this->_current_view";
+		if (method_exists($this, $add_screen_options)) {
+			$this->{$add_screen_options}();
+		}
+		// add help tab(s) - set via page_config and qtips.
+		$this->_add_help_tabs();
+		$this->_add_qtips();
+		// add feature_pointers - global, page child class, and view specific
+		$this->_add_feature_pointers();
+		$this->_add_global_feature_pointers();
+		$add_feature_pointer = "_add_feature_pointer_$this->_current_view";
+		if (method_exists($this, $add_feature_pointer)) {
+			$this->{$add_feature_pointer}();
+		}
+		// enqueue scripts/styles - global, page class, and view specific
+		add_action('admin_enqueue_scripts', [$this, 'load_global_scripts_styles'], 5);
+		add_action('admin_enqueue_scripts', [$this, 'load_scripts_styles']);
+		if (method_exists($this, "load_scripts_styles_$this->_current_view")) {
+			add_action('admin_enqueue_scripts', [$this, "load_scripts_styles_$this->_current_view"], 15);
+		}
+		add_action('admin_enqueue_scripts', [$this, 'admin_footer_scripts_eei18n_js_strings'], 100);
+		// admin_print_footer_scripts - global, page child class, and view specific.
+		// NOTE, despite the name, whenever possible, scripts should NOT be loaded using this.
+		// In most cases that's doing_it_wrong().  But adding hidden container elements etc.
+		// is a good use case. Notice the late priority we're giving these
+		add_action('admin_print_footer_scripts', [$this, 'admin_footer_scripts_global'], 99);
+		add_action('admin_print_footer_scripts', [$this, 'admin_footer_scripts'], 100);
+		if (method_exists($this, "admin_footer_scripts_$this->_current_view")) {
+			add_action('admin_print_footer_scripts', [$this, "admin_footer_scripts_$this->_current_view"], 101);
+		}
+		// admin footer scripts
+		add_action('admin_footer', [$this, 'admin_footer_global'], 99);
+		add_action('admin_footer', [$this, 'admin_footer'], 100);
+		if (method_exists($this, "admin_footer_$this->_current_view")) {
+			add_action('admin_footer', [$this, "admin_footer_$this->_current_view"], 101);
+		}
+		do_action('FHEE__EE_Admin_Page___load_page_dependencies__after_load', $this->page_slug);
+		// targeted hook
+		do_action(
+			"FHEE__EE_Admin_Page___load_page_dependencies__after_load__{$this->page_slug}__$this->_req_action"
+		);
+	}
+
+
+	/**
+	 * _set_defaults
+	 * This sets some global defaults for class properties.
+	 */
+	private function _set_defaults()
+	{
+		// init template args
+		$this->set_template_args(
+			[
+				'admin_page_header'  => '',
+				'admin_page_content' => '',
+				'post_body_content'  => '',
+				'before_list_table'  => '',
+				'after_list_table'   => '',
+			]
+		);
+	}
+
+
+	/**
+	 * route_admin_request
+	 *
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws Throwable
+	 * @see    _route_admin_request()
+	 */
+	public function route_admin_request()
+	{
+		try {
+			$this->_route_admin_request();
+		} catch (EE_Error $e) {
+			$e->get_error();
+		}
+	}
+
+
+	public function set_wp_page_slug($wp_page_slug)
+	{
+		$this->_wp_page_slug = $wp_page_slug;
+		// if in network admin then we need to append "-network" to the page slug. Why? Because that's how WP rolls...
+		if (is_network_admin()) {
+			$this->_wp_page_slug .= '-network';
+		}
+	}
+
+
+	/**
+	 * _verify_routes
+	 * All this method does is verify the incoming request and make sure that routes exist for it.  We do this early so
+	 * we know if we need to drop out.
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	protected function _verify_routes(): bool
+	{
+		if (! $this->_current_page && ! $this->request->isAjax()) {
+			return false;
+		}
+		// check that the page_routes array is not empty
+		if (empty($this->_page_routes)) {
+			// user error msg
+			$error_msg = sprintf(
+				esc_html__('No page routes have been set for the %s admin page.', 'event_espresso'),
+				$this->_admin_page_title
+			);
+			// developer error msg
+			$error_msg .= '||' . $error_msg
+						  . esc_html__(
+							  ' Make sure the "set_page_routes()" method exists, and is setting the "_page_routes" array properly.',
+							  'event_espresso'
+						  );
+			throw new EE_Error($error_msg);
+		}
+		// route 'editpost' routes to CPT 'edit' routes
+		$alt_edit_route = $this instanceof EE_Admin_Page_CPT ? $this->cpt_editpost_route : 'edit';
+		if (
+			$this->_req_action === 'editpost'
+			&& ! isset($this->_page_routes['editpost'])
+			&& isset($this->_page_routes[$alt_edit_route])
+		) {
+			$this->_req_action = $alt_edit_route;
+		}
+		// and that the requested page route exists
+		if (array_key_exists($this->_req_action, $this->_page_routes)) {
+			$this->_route        = $this->_page_routes[ $this->_req_action ];
+			$this->_route_config = $this->_page_config[ $this->_req_action ] ?? [];
+		} else {
+			// user error msg
+			$error_msg = sprintf(
+				esc_html__(
+					'The requested page route does not exist for the %s admin page.',
+					'event_espresso'
+				),
+				$this->_admin_page_title
+			);
+			// developer error msg
+			$error_msg .= '||' . $error_msg
+						  . sprintf(
+							  esc_html__(
+								  ' Create a key in the "_page_routes" array named "%s" and set its value to the appropriate method.',
+								  'event_espresso'
+							  ),
+							  $this->_req_action
+						  );
+			throw new EE_Error($error_msg);
+		}
+		// and that a default route exists
+		if (! array_key_exists('default', $this->_page_routes)) {
+			// user error msg
+			$error_msg = sprintf(
+				esc_html__(
+					'A default page route has not been set for the % admin page.',
+					'event_espresso'
+				),
+				$this->_admin_page_title
+			);
+			// developer error msg
+			$error_msg .= '||' . $error_msg
+						  . esc_html__(
+							  ' Create a key in the "_page_routes" array named "default" and set its value to your default page method.',
+							  'event_espresso'
+						  );
+			throw new EE_Error($error_msg);
+		}
+
+		// first lets' catch if the UI request has EVER been set.
+		if ($this->_is_UI_request === null) {
+			// lets set if this is a UI request or not.
+			$this->_is_UI_request = ! $this->request->getRequestParam('noheader', false, DataType::BOOL);
+			// wait a minute... we might have a noheader in the route array
+			$this->_is_UI_request = ! (isset($this->_route['noheader']) && $this->_route['noheader'])
+				? $this->_is_UI_request
+				: false;
+		}
+		$this->_set_current_labels();
+		return true;
+	}
+
+
+	/**
+	 * this method simply verifies a given route and makes sure its an actual route available for the loaded page
+	 *
+	 * @param string $route the route name we're verifying
+	 * @return bool we'll throw an exception if this isn't a valid route.
+	 * @throws EE_Error
+	 */
+	protected function _verify_route(string $route): bool
+	{
+		if (array_key_exists($this->_req_action, $this->_page_routes)) {
+			return true;
+		}
+		// user error msg
+		$error_msg = sprintf(
+			esc_html__('The given page route does not exist for the %s admin page.', 'event_espresso'),
+			$this->_admin_page_title
+		);
+		// developer error msg
+		$error_msg .= '||' . $error_msg
+					  . sprintf(
+						  esc_html__(
+							  ' Check the route you are using in your method (%s) and make sure it matches a route set in your "_page_routes" array property',
+							  'event_espresso'
+						  ),
+						  $route
+					  );
+		throw new EE_Error($error_msg);
+	}
+
+
+	/**
+	 * perform nonce verification
+	 * This method has be encapsulated here so that any ajax requests that bypass normal routes can verify their nonces
+	 * using this method (and save retyping!)
+	 *
+	 * @param string $nonce     The nonce sent
+	 * @param string $nonce_ref The nonce reference string (name0)
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _verify_nonce(string $nonce, string $nonce_ref)
+	{
+		// verify nonce against expected value
+		if (! wp_verify_nonce($nonce, $nonce_ref)) {
+			// these are not the droids you are looking for !!!
+			$msg = sprintf(
+				esc_html__('%sNonce Fail.%s', 'event_espresso'),
+				'<a href="https://www.youtube.com/watch?v=56_S0WeTkzs">',
+				'</a>'
+			);
+			if (WP_DEBUG) {
+				$msg .= "\n  ";
+				$msg .= sprintf(
+					esc_html__(
+						'In order to dynamically generate nonces for your actions, use the %s::add_query_args_and_nonce() method. May the Nonce be with you!',
+						'event_espresso'
+					),
+					__CLASS__
+				);
+			}
+			if (! $this->request->isAjax()) {
+				wp_die($msg);
+			}
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			$this->_return_json();
+		}
+	}
+
+
+	/**
+	 * _route_admin_request()
+	 * Meat and potatoes of the class.  Basically, this dude checks out what's being requested and sees if there are
+	 * some doodads to work the magic and handle the flingjangy. Translation:  Checks if the requested action is listed
+	 * in the page routes and then will try to load the corresponding method.
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws Throwable
+	 */
+	protected function _route_admin_request()
+	{
+		if (! $this->_is_UI_request) {
+			$this->_verify_routes();
+		}
+		$nonce_check = ! isset($this->_route_config['require_nonce']) || $this->_route_config['require_nonce'];
+		if ($this->_req_action !== 'default' && $nonce_check) {
+			// set nonce from post data
+			$nonce = $this->request->getRequestParam($this->_req_nonce, '');
+			$this->_verify_nonce($nonce, $this->_req_nonce);
+		}
+		// set the nav_tabs array but ONLY if this is  UI_request
+		if ($this->_is_UI_request) {
+			$this->_set_nav_tabs();
+		}
+		// grab callback function
+		$func = $this->_route['func'] ?? $this->_route;
+		// check if callback has args
+		$args = $this->_route['args'] ?? [];
+
+		// action right before calling route
+		// (hook is something like 'AHEE__Registrations_Admin_Page__route_admin_request')
+		if (! did_action('AHEE__EE_Admin_Page__route_admin_request')) {
+			do_action('AHEE__EE_Admin_Page__route_admin_request', $this->_current_view, $this);
+		}
+		// strip _wp_http_referer from the server REQUEST_URI
+		// else it grows in length on every submission due to recursion,
+		// ultimately causing a "Request-URI Too Large" error
+		$this->request->unSetRequestParam('_wp_http_referer');
+		$this->request->unSetServerParam('_wp_http_referer');
+		$cleaner_request_uri = remove_query_arg(
+			'_wp_http_referer',
+			wp_unslash($this->request->getServerParam('REQUEST_URI'))
+		);
+		$this->request->setRequestParam('_wp_http_referer', $cleaner_request_uri, true);
+		$this->request->setServerParam('REQUEST_URI', $cleaner_request_uri, true);
+		$route_callback = [];
+		if (! empty($func)) {
+			if (is_array($func)) {
+				$route_callback = $func;
+			} elseif (is_string($func)) {
+				if (strpos($func, '::') !== false) {
+					$route_callback = explode('::', $func);
+				} elseif (method_exists($this, $func)) {
+					$route_callback = [$this, $func];
+				} else {
+					$route_callback = $func;
+				}
+			}
+			[$class, $method] = $route_callback;
+			// is it neither a class method NOR a standalone function?
+			if (! is_callable($route_callback)) {
+				// user error msg
+				$error_msg = esc_html__(
+					'An error occurred. The  requested page route could not be found.',
+					'event_espresso'
+				);
+				// developer error msg
+				$error_msg .= '||';
+				$error_msg .= sprintf(
+					esc_html__(
+						'Page route "%s" could not be called. Check that the spelling for method names and actions in the "_page_routes" array are all correct.',
+						'event_espresso'
+					),
+					$method
+				);
+				throw new DomainException($error_msg);
+			}
+			if ($class !== $this && ! in_array($this, $args)) {
+				// send along this admin page object for access by addons.
+				$args['admin_page'] = $this;
+			}
+
+			try {
+				call_user_func_array($route_callback, $args);
+			} catch (Throwable $throwable) {
+				$nice_args = [];
+				foreach ($args as $key => $arg) {
+					$nice_args[ $key ] = is_object($arg) ? get_class($arg) : $key;
+				}
+				new ExceptionStackTraceDisplay(
+					new RuntimeException(
+						sprintf(
+							esc_html__(
+								'Page route "%1$s" with the supplied arguments (%2$s) threw the following exception: %3$s',
+								'event_espresso'
+							),
+							$method,
+							implode(', ', $nice_args),
+							$throwable->getMessage()
+						),
+						$throwable->getCode(),
+						$throwable
+					)
+				);
+			}
+		}
+		// if we've routed and this route has a no headers route AND a sent_headers_route,
+		// then we need to reset the routing properties to the new route.
+		// now if UI request is FALSE and noheader is true AND we have a headers_sent_route in the route array then let's set UI_request to true because the no header route has a second func after headers have been sent.
+		if (
+			$this->_is_UI_request === false
+			&& is_array($this->_route)
+			&& ! empty($this->_route['headers_sent_route'])
+		) {
+			$this->_reset_routing_properties($this->_route['headers_sent_route']);
+		}
+	}
+
+
+	/**
+	 * This method just allows the resetting of page properties in the case where a no headers
+	 * route redirects to a headers route in its route config.
+	 *
+	 * @param string $new_route New (non header) route to redirect to.
+	 * @return void
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws Throwable
+	 * @since   4.3.0
+	 */
+	protected function _reset_routing_properties(string $new_route)
+	{
+		$this->_is_UI_request = true;
+		// now we set the current route to whatever the headers_sent_route is set at
+		$this->request->setRequestParam('action', $new_route);
+		// rerun page setup
+		$this->_page_setup();
+	}
+
+
+	/**
+	 * _add_query_arg
+	 * adds nonce to array of arguments then calls WP add_query_arg function
+	 *(internally just uses EEH_URL's function with the same name)
+	 *
+	 * @param array  $args
+	 * @param string $url
+	 * @param bool   $sticky                  if true, then the existing Request params will be appended to the
+	 *                                        generated url in an associative array indexed by the key 'wp_referer';
+	 *                                        Example usage: If the current page is:
+	 *                                        http://mydomain.com/wp-admin/admin.php?page=espresso_registrations
+	 *                                        &action=default&event_id=20&month_range=March%202015
+	 *                                        &_wpnonce=5467821
+	 *                                        and you call:
+	 *                                        EE_Admin_Page::add_query_args_and_nonce(
+	 *                                        array(
+	 *                                        'action' => 'resend_something',
+	 *                                        'page=>espresso_registrations'
+	 *                                        ),
+	 *                                        $some_url,
+	 *                                        true
+	 *                                        );
+	 *                                        It will produce a url in this structure:
+	 *                                        http://{$some_url}/?page=espresso_registrations&action=resend_something
+	 *                                        &wp_referer[action]=default&wp_referer[event_id]=20&wpreferer[
+	 *                                        month_range]=March%202015
+	 * @param bool   $exclude_nonce           If true, the the nonce will be excluded from the generated nonce.
+	 * @param int    $context
+	 * @return string
+	 */
+	public static function add_query_args_and_nonce(
+		array $args = [],
+		string $url = '',
+		bool $sticky = false,
+		bool $exclude_nonce = false,
+		int $context = EEH_URL::CONTEXT_NONE
+	): string {
+		// if there is a _wp_http_referer include the values from the request but only if sticky = true
+		if ($sticky) {
+			/** @var RequestInterface $request */
+			$request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
+			$request->unSetRequestParams(['_wp_http_referer', 'wp_referer'], true);
+			$request->unSetServerParam('_wp_http_referer', true);
+			foreach ($request->requestParams() as $key => $value) {
+				// do not add nonces
+				if (strpos($key, 'nonce') !== false) {
+					continue;
+				}
+				$args[ 'wp_referer[' . $key . ']' ] = is_string($value) ? htmlspecialchars($value) : $value;
+			}
+		}
+		return EEH_URL::add_query_args_and_nonce($args, $url, $exclude_nonce, $context);
+	}
+
+
+	/**
+	 * This returns a generated link that will load the related help tab.
+	 *
+	 * @param string $help_tab_id the id for the connected help tab
+	 * @param string $icon_style  (optional) include css class for the style you want to use for the help icon.
+	 * @param string $help_text   (optional) send help text you want to use for the link if default not to be used
+	 * @return string              generated link
+	 * @uses EEH_Template::get_help_tab_link()
+	 */
+	protected function _get_help_tab_link(string $help_tab_id, string $icon_style = '', string $help_text = ''): string
+	{
+		return EEH_Template::get_help_tab_link(
+			$help_tab_id,
+			$this->page_slug,
+			$this->_req_action,
+			$icon_style,
+			$help_text
+		);
+	}
+
+
+	/**
+	 * _add_help_tabs
+	 * Note child classes define their help tabs within the page_config array.
+	 *
+	 * @link   http://codex.wordpress.org/Function_Reference/add_help_tab
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _add_help_tabs()
+	{
+		if (isset($this->_page_config[ $this->_req_action ])) {
+			$config = $this->_page_config[ $this->_req_action ];
+			// let's see if there is a help_sidebar set for the current route and we'll set that up for usage as well.
+			if (is_array($config) && isset($config['help_sidebar'])) {
+				// check that the callback given is valid
+				if (! method_exists($this, $config['help_sidebar'])) {
+					throw new EE_Error(
+						sprintf(
+							esc_html__(
+								'The _page_config array has a callback set for the "help_sidebar" option.  However the callback given (%s) is not a valid callback.  Doublecheck the spelling and make sure this method exists for the class %s',
+								'event_espresso'
+							),
+							$config['help_sidebar'],
+							$this->class_name
+						)
+					);
+				}
+				$content = apply_filters(
+					'FHEE__' . $this->class_name . '__add_help_tabs__help_sidebar',
+					$this->{$config['help_sidebar']}()
+				);
+				$this->_current_screen->set_help_sidebar($content);
+			}
+			if (! isset($config['help_tabs'])) {
+				return;
+			} //no help tabs for this route
+			foreach ((array) $config['help_tabs'] as $tab_id => $cfg) {
+				// we're here so there ARE help tabs!
+				// make sure we've got what we need
+				if (! isset($cfg['title'])) {
+					throw new EE_Error(
+						esc_html__(
+							'The _page_config array is not set up properly for help tabs.  It is missing a title',
+							'event_espresso'
+						)
+					);
+				}
+				if (! isset($cfg['filename']) && ! isset($cfg['callback']) && ! isset($cfg['content'])) {
+					throw new EE_Error(
+						esc_html__(
+							'The _page_config array is not setup properly for help tabs. It is missing a either a filename reference, or a callback reference or a content reference so there is no way to know the content for the help tab',
+							'event_espresso'
+						)
+					);
+				}
+				// first priority goes to content.
+				if (! empty($cfg['content'])) {
+					$content = $cfg['content'];
+					// second priority goes to filename
+				} elseif (! empty($cfg['filename'])) {
+					$file_path = $this->_get_dir() . '/help_tabs/' . $cfg['filename'] . '.help_tab.php';
+					// it's possible that the file is located on decaf route (and above sets up for caf route, if this is the case then lets check decaf route too)
+					$file_path = ! is_readable($file_path) ? EE_ADMIN_PAGES
+															 . basename($this->_get_dir())
+															 . '/help_tabs/'
+															 . $cfg['filename']
+															 . '.help_tab.php' : $file_path;
+					// if file is STILL not readable then let's do a EE_Error so its more graceful than a fatal error.
+					if (! isset($cfg['callback']) && ! is_readable($file_path)) {
+						EE_Error::add_error(
+							sprintf(
+								esc_html__(
+									'The filename given for the help tab %s is not a valid file and there is no other configuration for the tab content.  Please check that the string you set for the help tab on this route (%s) is the correct spelling.  The file should be in %s',
+									'event_espresso'
+								),
+								$tab_id,
+								key($config),
+								$file_path
+							),
+							__FILE__,
+							__FUNCTION__,
+							__LINE__
+						);
+						return;
+					}
+					$template_args['admin_page_obj'] = $this;
+					$content                         = EEH_Template::display_template(
+						$file_path,
+						$template_args,
+						true
+					);
+				} else {
+					$content = '';
+				}
+				// check if callback is valid
+				if (
+					empty($content)
+					&& (
+						! isset($cfg['callback']) || ! method_exists($this, $cfg['callback'])
+					)
+				) {
+					EE_Error::add_error(
+						sprintf(
+							esc_html__(
+								'The callback given for a %s help tab on this page does not content OR a corresponding method for generating the content.  Check the spelling or make sure the method is present.',
+								'event_espresso'
+							),
+							$cfg['title']
+						),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+					return;
+				}
+				// setup config array for help tab method
+				$id  = $this->page_slug . '-' . $this->_req_action . '-' . $tab_id;
+				$_ht = [
+					'id'       => $id,
+					'title'    => $cfg['title'],
+					'callback' => isset($cfg['callback']) && empty($content) ? [$this, $cfg['callback']] : null,
+					'content'  => $content,
+				];
+				$this->_current_screen->add_help_tab($_ht);
+			}
+		}
+	}
+
+
+	/**
+	 * This simply sets up any qtips that have been defined in the page config
+	 *
+	 * @return void
+	 * @throws ReflectionException
+	 * @throws EE_Error
+	 */
+	protected function _add_qtips()
+	{
+		if (isset($this->_route_config['qtips'])) {
+			$qtips = (array) $this->_route_config['qtips'];
+			// load qtip loader
+			$path = [
+				$this->_get_dir() . '/qtips/',
+				EE_ADMIN_PAGES . basename($this->_get_dir()) . '/qtips/',
+			];
+			EEH_Qtip_Loader::instance()->register($qtips, $path);
+		}
+	}
+
+
+	/**
+	 * _set_nav_tabs
+	 * This sets up the nav tabs from the page_routes array.  This method can be overwritten by child classes if you
+	 * wish to add additional tabs or modify accordingly.
+	 *
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	protected function _set_nav_tabs()
+	{
+		$i        = 0;
+		$only_tab = count($this->_page_config) < 2;
+		foreach ($this->_page_config as $slug => $config) {
+			if (! is_array($config) || empty($config['nav'])) {
+				continue;
+			}
+			// no nav tab for this config
+			// check for persistent flag
+			if ($slug !== $this->_req_action && isset($config['nav']['persistent']) && ! $config['nav']['persistent']) {
+				// nav tab is only to appear when route requested.
+				continue;
+			}
+			if (! $this->check_user_access($slug, true)) {
+				// no nav tab because current user does not have access.
+				continue;
+			}
+			$css_class = $config['css_class'] ?? '';
+			$css_class .= $only_tab ? ' ee-only-tab' : '';
+			$css_class .= " ee-nav-tab__$slug";
+
+			$this->_nav_tabs[ $slug ] = [
+				'url'       => $config['nav']['url'] ?? EE_Admin_Page::add_query_args_and_nonce(
+						['action' => $slug],
+						$this->_admin_base_url
+					),
+				'link_text' => $this->navTabLabel($config['nav'], $slug),
+				'css_class' => $this->_req_action === $slug ? $css_class . ' nav-tab-active' : $css_class,
+				'order'     => $config['nav']['order'] ?? $i,
+			];
+			$i++;
+		}
+		// if $this->_nav_tabs is empty then lets set the default
+		if (empty($this->_nav_tabs)) {
+			$this->_nav_tabs[ $this->_default_nav_tab_name ] = [
+				'url'       => $this->_admin_base_url,
+				'link_text' => ucwords(str_replace('_', ' ', $this->_default_nav_tab_name)),
+				'css_class' => 'nav-tab-active',
+				'order'     => 10,
+			];
+		}
+		// now let's sort the tabs according to order
+		usort($this->_nav_tabs, [$this, '_sort_nav_tabs']);
+	}
+
+
+	private function navTabLabel(array $nav_tab, string $slug): string
+	{
+		$label = $nav_tab['label'] ?? ucwords(str_replace('_', ' ', $slug));
+		$icon  = $nav_tab['icon'] ?? null;
+		$icon  = $icon ? '<span class="dashicons ' . $icon . '"></span>' : '';
+		return '
             <span class="ee-admin-screen-tab__label">
                 ' . $icon . '
                 <span class="ee-nav-label__text">' . $label . '</span>
             </span>';
-    }
-
-
-    /**
-     * _set_current_labels
-     * This method modifies the _labels property with any optional specific labels indicated in the _page_routes
-     * property array
-     *
-     * @return void
-     */
-    private function _set_current_labels()
-    {
-        if (isset($this->_route_config['labels'])) {
-            foreach ($this->_route_config['labels'] as $label => $text) {
-                if (is_array($text)) {
-                    foreach ($text as $sublabel => $subtext) {
-                        $this->_labels[ $label ][ $sublabel ] = $subtext;
-                    }
-                } else {
-                    $this->_labels[ $label ] = $text;
-                }
-            }
-        }
-    }
-
-
-    /**
-     *        verifies user access for this admin page
-     *
-     * @param string $route_to_check if present then the capability for the route matching this string is checked.
-     * @param bool   $verify_only    Default is FALSE which means if user check fails then wp_die().  Otherwise just
-     *                               return false if verify fail.
-     * @return bool
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function check_user_access(string $route_to_check = '', bool $verify_only = false): bool
-    {
-        // hack to allow editpost capability to be used for edit CPT pages
-        $req_action = $this instanceof EE_Admin_Page_CPT && $this->_req_action === 'edit'
-            ? 'editpost'
-            : $this->_req_action;
-        $route_to_check = ! empty($route_to_check) ? $route_to_check : $req_action;
-        $capability     = ! empty($route_to_check)
-                          && isset($this->_page_routes[ $route_to_check ])
-                          && is_array($this->_page_routes[ $route_to_check ])
-                          && ! empty($this->_page_routes[ $route_to_check ]['capability'])
-            ? $this->_page_routes[ $route_to_check ]['capability']
-            : null;
-
-        if (empty($capability) && empty($route_to_check)) {
-            $capability = ! empty($this->_route['capability']) ? $this->_route['capability'] : 'manage_options';
-        } else {
-            $capability = empty($capability) ? 'manage_options' : $capability;
-        }
-
-        $id = $this->_route['obj_id'] ?? 0;
-
-        if (
-            ! $this->request->isAjax()
-            && (
-                ! function_exists('is_admin')
-                || ! $this->capabilities->current_user_can($capability, "{$this->page_slug}_$route_to_check", $id)
-            )
-        ) {
-            if ($verify_only) {
-                return false;
-            }
-            if (is_user_logged_in()) {
-                wp_die(esc_html__('You do not have access to this route.', 'event_espresso'));
-            }
-            return false;
-        }
-        return true;
-    }
-
-
-    /**
-     * @param string                 $box_id
-     * @param string                 $title
-     * @param callable|string|null   $callback
-     * @param string|array|WP_Screen $screen
-     * @param string                 $context       Post edit screen contexts include 'normal', 'side', and 'advanced'.
-     *                                              Comments screen contexts include 'normal' and 'side'.
-     *                                              Menus meta boxes (accordion sections) all use the 'side' context.
-     * @param string                 $priority      Accepts 'high', 'core', 'default', or 'low'.
-     * @param array|null             $callback_args
-     */
-    protected function addMetaBox(
-        string $box_id,
-        string $title,
-        $callback,
-        $screen,
-        string $context = 'normal',
-        string $priority = 'default',
-        ?array $callback_args = null
-    ) {
-        if (! (is_callable($callback) || ! function_exists($callback))) {
-            return;
-        }
-
-        add_meta_box($box_id, $title, $callback, $screen, $context, $priority, $callback_args);
-        add_filter(
-            "postbox_classes_{$this->_wp_page_slug}_$box_id",
-            function ($classes) {
-                $classes[] = 'ee-admin-container';
-                return $classes;
-            }
-        );
-    }
-
-
-    /**
-     * admin_init_global
-     * This runs all the code that we want executed within the WP admin_init hook.
-     * This method executes for ALL EE Admin pages.
-     *
-     * @return void
-     */
-    public function admin_init_global()
-    {
-    }
-
-
-    /**
-     * wp_loaded_global
-     * This runs all the code that we want executed within the WP wp_loaded hook.  This method is optional for an
-     * EE_Admin page and will execute on every EE Admin Page load
-     *
-     * @return void
-     */
-    public function wp_loaded()
-    {
-    }
-
-
-    /**
-     * admin_notices
-     * Anything triggered by the 'admin_notices' WP hook should be put in here.  This particular method will apply on
-     * ALL EE_Admin pages.
-     *
-     * @return void
-     */
-    public function admin_notices_global()
-    {
-        $this->_display_no_javascript_warning();
-        $this->_display_espresso_notices();
-    }
-
-
-    public function network_admin_notices_global()
-    {
-        $this->_display_no_javascript_warning();
-        $this->_display_espresso_notices();
-    }
-
-
-    /**
-     * admin_footer_scripts_global
-     * Anything triggered by the 'admin_print_footer_scripts' WP hook should be put in here. This particular method
-     * will apply on ALL EE_Admin pages.
-     *
-     * @return void
-     */
-    public function admin_footer_scripts_global()
-    {
-        $this->_add_admin_page_ajax_loading_img();
-        $this->_add_admin_page_overlay();
-        // if metaboxes are present we need to add the nonce field
-        if (
-            isset($this->_route_config['metaboxes'])
-            || isset($this->_route_config['list_table'])
-            || (isset($this->_route_config['has_metaboxes']) && $this->_route_config['has_metaboxes'])
-        ) {
-            wp_nonce_field('closedpostboxes', 'closedpostboxesnonce', false);
-            wp_nonce_field('meta-box-order', 'meta-box-order-nonce', false);
-        }
-    }
-
-
-    /**
-     * admin_footer_global
-     * Anything triggered by the wp 'admin_footer' wp hook should be put in here.
-     * This particular method will apply on ALL EE_Admin Pages.
-     *
-     * @return void
-     */
-    public function admin_footer_global()
-    {
-        // dialog container for dialog helper
-        echo '
+	}
+
+
+	/**
+	 * _set_current_labels
+	 * This method modifies the _labels property with any optional specific labels indicated in the _page_routes
+	 * property array
+	 *
+	 * @return void
+	 */
+	private function _set_current_labels()
+	{
+		if (isset($this->_route_config['labels'])) {
+			foreach ($this->_route_config['labels'] as $label => $text) {
+				if (is_array($text)) {
+					foreach ($text as $sublabel => $subtext) {
+						$this->_labels[ $label ][ $sublabel ] = $subtext;
+					}
+				} else {
+					$this->_labels[ $label ] = $text;
+				}
+			}
+		}
+	}
+
+
+	/**
+	 *        verifies user access for this admin page
+	 *
+	 * @param string $route_to_check if present then the capability for the route matching this string is checked.
+	 * @param bool   $verify_only    Default is FALSE which means if user check fails then wp_die().  Otherwise just
+	 *                               return false if verify fail.
+	 * @return bool
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function check_user_access(string $route_to_check = '', bool $verify_only = false): bool
+	{
+		// hack to allow editpost capability to be used for edit CPT pages
+		$req_action = $this instanceof EE_Admin_Page_CPT && $this->_req_action === 'edit'
+			? 'editpost'
+			: $this->_req_action;
+		$route_to_check = ! empty($route_to_check) ? $route_to_check : $req_action;
+		$capability     = ! empty($route_to_check)
+						  && isset($this->_page_routes[ $route_to_check ])
+						  && is_array($this->_page_routes[ $route_to_check ])
+						  && ! empty($this->_page_routes[ $route_to_check ]['capability'])
+			? $this->_page_routes[ $route_to_check ]['capability']
+			: null;
+
+		if (empty($capability) && empty($route_to_check)) {
+			$capability = ! empty($this->_route['capability']) ? $this->_route['capability'] : 'manage_options';
+		} else {
+			$capability = empty($capability) ? 'manage_options' : $capability;
+		}
+
+		$id = $this->_route['obj_id'] ?? 0;
+
+		if (
+			! $this->request->isAjax()
+			&& (
+				! function_exists('is_admin')
+				|| ! $this->capabilities->current_user_can($capability, "{$this->page_slug}_$route_to_check", $id)
+			)
+		) {
+			if ($verify_only) {
+				return false;
+			}
+			if (is_user_logged_in()) {
+				wp_die(esc_html__('You do not have access to this route.', 'event_espresso'));
+			}
+			return false;
+		}
+		return true;
+	}
+
+
+	/**
+	 * @param string                 $box_id
+	 * @param string                 $title
+	 * @param callable|string|null   $callback
+	 * @param string|array|WP_Screen $screen
+	 * @param string                 $context       Post edit screen contexts include 'normal', 'side', and 'advanced'.
+	 *                                              Comments screen contexts include 'normal' and 'side'.
+	 *                                              Menus meta boxes (accordion sections) all use the 'side' context.
+	 * @param string                 $priority      Accepts 'high', 'core', 'default', or 'low'.
+	 * @param array|null             $callback_args
+	 */
+	protected function addMetaBox(
+		string $box_id,
+		string $title,
+		$callback,
+		$screen,
+		string $context = 'normal',
+		string $priority = 'default',
+		?array $callback_args = null
+	) {
+		if (! (is_callable($callback) || ! function_exists($callback))) {
+			return;
+		}
+
+		add_meta_box($box_id, $title, $callback, $screen, $context, $priority, $callback_args);
+		add_filter(
+			"postbox_classes_{$this->_wp_page_slug}_$box_id",
+			function ($classes) {
+				$classes[] = 'ee-admin-container';
+				return $classes;
+			}
+		);
+	}
+
+
+	/**
+	 * admin_init_global
+	 * This runs all the code that we want executed within the WP admin_init hook.
+	 * This method executes for ALL EE Admin pages.
+	 *
+	 * @return void
+	 */
+	public function admin_init_global()
+	{
+	}
+
+
+	/**
+	 * wp_loaded_global
+	 * This runs all the code that we want executed within the WP wp_loaded hook.  This method is optional for an
+	 * EE_Admin page and will execute on every EE Admin Page load
+	 *
+	 * @return void
+	 */
+	public function wp_loaded()
+	{
+	}
+
+
+	/**
+	 * admin_notices
+	 * Anything triggered by the 'admin_notices' WP hook should be put in here.  This particular method will apply on
+	 * ALL EE_Admin pages.
+	 *
+	 * @return void
+	 */
+	public function admin_notices_global()
+	{
+		$this->_display_no_javascript_warning();
+		$this->_display_espresso_notices();
+	}
+
+
+	public function network_admin_notices_global()
+	{
+		$this->_display_no_javascript_warning();
+		$this->_display_espresso_notices();
+	}
+
+
+	/**
+	 * admin_footer_scripts_global
+	 * Anything triggered by the 'admin_print_footer_scripts' WP hook should be put in here. This particular method
+	 * will apply on ALL EE_Admin pages.
+	 *
+	 * @return void
+	 */
+	public function admin_footer_scripts_global()
+	{
+		$this->_add_admin_page_ajax_loading_img();
+		$this->_add_admin_page_overlay();
+		// if metaboxes are present we need to add the nonce field
+		if (
+			isset($this->_route_config['metaboxes'])
+			|| isset($this->_route_config['list_table'])
+			|| (isset($this->_route_config['has_metaboxes']) && $this->_route_config['has_metaboxes'])
+		) {
+			wp_nonce_field('closedpostboxes', 'closedpostboxesnonce', false);
+			wp_nonce_field('meta-box-order', 'meta-box-order-nonce', false);
+		}
+	}
+
+
+	/**
+	 * admin_footer_global
+	 * Anything triggered by the wp 'admin_footer' wp hook should be put in here.
+	 * This particular method will apply on ALL EE_Admin Pages.
+	 *
+	 * @return void
+	 */
+	public function admin_footer_global()
+	{
+		// dialog container for dialog helper
+		echo '
         <div class="ee-admin-dialog-container auto-hide hidden">
             <div class="ee-notices"></div>
             <div class="ee-admin-dialog-container-inner-content"></div>
         </div>
         ';
 
-        // current set timezone for timezone js
-        echo '<span id="current_timezone" class="hidden">' . esc_html(EEH_DTT_Helper::get_timezone()) . '</span>';
-    }
-
-
-    /**
-     * This function sees if there is a method for help popup content existing for the given route.  If there is then
-     * we'll use the retrieved array to output the content using the template. For child classes: If you want to have
-     * help popups then in your templates or your content you set "triggers" for the content using the
-     * "_set_help_trigger('help_trigger_id')" where "help_trigger_id" is what you will use later in your custom method
-     * for the help popup content on that page. Then in your Child_Admin_Page class you need to define a help popup
-     * method for the content in the format "_help_popup_content_{route_name}()"  So if you are setting help content
-     * for the
-     * 'edit_event' route you should have a method named "_help_popup_content_edit_route". In your defined
-     * "help_popup_content_..." method.  You must prepare and return an array in the following format array(
-     *    'help_trigger_id' => array(
-     *        'title' => esc_html__('localized title for popup', 'event_espresso'),
-     *        'content' => esc_html__('localized content for popup', 'event_espresso')
-     *    )
-     * );
-     * Then the EE_Admin_Parent will take care of making sure that is setup properly on the correct route.
-     *
-     * @param array $help_array
-     * @param bool  $display
-     * @return string content
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    protected function _set_help_popup_content(array $help_array = [], bool $display = false): string
-    {
-        $content    = '';
-        $help_array = empty($help_array) ? $this->_get_help_content() : $help_array;
-        // loop through the array and setup content
-        foreach ($help_array as $trigger => $help) {
-            // make sure the array is setup properly
-            if (! isset($help['title'], $help['content'])) {
-                throw new EE_Error(
-                    esc_html__(
-                        'Does not look like the popup content array has been setup correctly.  Might want to double check that.  Read the comments for the _get_help_popup_content method found in "EE_Admin_Page" class',
-                        'event_espresso'
-                    )
-                );
-            }
-            // we're good so let's setup the template vars and then assign parsed template content to our content.
-            $template_args = [
-                'help_popup_id'      => $trigger,
-                'help_popup_title'   => $help['title'],
-                'help_popup_content' => $help['content'],
-            ];
-            $content       .= EEH_Template::display_template(
-                EE_ADMIN_TEMPLATE . 'admin_help_popup.template.php',
-                $template_args,
-                true
-            );
-        }
-        if ($display) {
-            echo wp_kses($content, AllowedTags::getWithFormTags());
-            return '';
-        }
-        return $content;
-    }
-
-
-    /**
-     * All this does is retrieve the help content array if set by the EE_Admin_Page child
-     *
-     * @return array properly formatted array for help popup content
-     * @throws EE_Error
-     */
-    private function _get_help_content(): array
-    {
-        // what is the method we're looking for?
-        $method_name = '_help_popup_content_' . $this->_req_action;
-        // if method doesn't exist let's get out.
-        if (! method_exists($this, $method_name)) {
-            return [];
-        }
-        // k we're good to go let's retrieve the help array
-        $help_array = $this->{$method_name}();
-        // make sure we've got an array!
-        if (! is_array($help_array)) {
-            throw new EE_Error(
-                esc_html__(
-                    'Something went wrong with help popup content generation. Expecting an array and well, this ain\'t no array bub.',
-                    'event_espresso'
-                )
-            );
-        }
-        return $help_array;
-    }
-
-
-    /**
-     * EE Admin Pages can use this to set a properly formatted trigger for a help popup.
-     * By default the trigger html is printed.  Otherwise it can be returned if the $display flag is set "false"
-     * See comments made on the _set_help_content method for understanding other parts to the help popup tool.
-     *
-     * @param string $trigger_id reference for retrieving the trigger content for the popup
-     * @param bool   $display    if false then we return the trigger string
-     * @param array  $dimensions an array of dimensions for the box (array(h,w))
-     * @return string
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    protected function _set_help_trigger(string $trigger_id, bool $display = true, array $dimensions = ['400', '640'])
-    {
-        if ($this->request->isAjax()) {
-            return '';
-        }
-        // let's check and see if there is any content set for this popup.  If there isn't then we'll include a default title and content so that developers know something needs to be corrected
-        $help_array   = $this->_get_help_content();
-        $help_content = '';
-        if (empty($help_array) || ! isset($help_array[ $trigger_id ])) {
-            $help_array[ $trigger_id ] = [
-                'title'   => esc_html__('Missing Content', 'event_espresso'),
-                'content' => esc_html__(
-                    'A trigger has been set that doesn\'t have any corresponding content. Make sure you have set the help content. (see the "_set_help_popup_content" method in the EE_Admin_Page for instructions.)',
-                    'event_espresso'
-                ),
-            ];
-            $help_content              = $this->_set_help_popup_content($help_array);
-        }
-        $height   = esc_attr($dimensions[0]) ?? 400;
-        $width    = esc_attr($dimensions[1]) ?? 640;
-        $inlineId = esc_attr($trigger_id);
-        // let's setup the trigger
-        $content = "
+		// current set timezone for timezone js
+		echo '<span id="current_timezone" class="hidden">' . esc_html(EEH_DTT_Helper::get_timezone()) . '</span>';
+	}
+
+
+	/**
+	 * This function sees if there is a method for help popup content existing for the given route.  If there is then
+	 * we'll use the retrieved array to output the content using the template. For child classes: If you want to have
+	 * help popups then in your templates or your content you set "triggers" for the content using the
+	 * "_set_help_trigger('help_trigger_id')" where "help_trigger_id" is what you will use later in your custom method
+	 * for the help popup content on that page. Then in your Child_Admin_Page class you need to define a help popup
+	 * method for the content in the format "_help_popup_content_{route_name}()"  So if you are setting help content
+	 * for the
+	 * 'edit_event' route you should have a method named "_help_popup_content_edit_route". In your defined
+	 * "help_popup_content_..." method.  You must prepare and return an array in the following format array(
+	 *    'help_trigger_id' => array(
+	 *        'title' => esc_html__('localized title for popup', 'event_espresso'),
+	 *        'content' => esc_html__('localized content for popup', 'event_espresso')
+	 *    )
+	 * );
+	 * Then the EE_Admin_Parent will take care of making sure that is setup properly on the correct route.
+	 *
+	 * @param array $help_array
+	 * @param bool  $display
+	 * @return string content
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	protected function _set_help_popup_content(array $help_array = [], bool $display = false): string
+	{
+		$content    = '';
+		$help_array = empty($help_array) ? $this->_get_help_content() : $help_array;
+		// loop through the array and setup content
+		foreach ($help_array as $trigger => $help) {
+			// make sure the array is setup properly
+			if (! isset($help['title'], $help['content'])) {
+				throw new EE_Error(
+					esc_html__(
+						'Does not look like the popup content array has been setup correctly.  Might want to double check that.  Read the comments for the _get_help_popup_content method found in "EE_Admin_Page" class',
+						'event_espresso'
+					)
+				);
+			}
+			// we're good so let's setup the template vars and then assign parsed template content to our content.
+			$template_args = [
+				'help_popup_id'      => $trigger,
+				'help_popup_title'   => $help['title'],
+				'help_popup_content' => $help['content'],
+			];
+			$content       .= EEH_Template::display_template(
+				EE_ADMIN_TEMPLATE . 'admin_help_popup.template.php',
+				$template_args,
+				true
+			);
+		}
+		if ($display) {
+			echo wp_kses($content, AllowedTags::getWithFormTags());
+			return '';
+		}
+		return $content;
+	}
+
+
+	/**
+	 * All this does is retrieve the help content array if set by the EE_Admin_Page child
+	 *
+	 * @return array properly formatted array for help popup content
+	 * @throws EE_Error
+	 */
+	private function _get_help_content(): array
+	{
+		// what is the method we're looking for?
+		$method_name = '_help_popup_content_' . $this->_req_action;
+		// if method doesn't exist let's get out.
+		if (! method_exists($this, $method_name)) {
+			return [];
+		}
+		// k we're good to go let's retrieve the help array
+		$help_array = $this->{$method_name}();
+		// make sure we've got an array!
+		if (! is_array($help_array)) {
+			throw new EE_Error(
+				esc_html__(
+					'Something went wrong with help popup content generation. Expecting an array and well, this ain\'t no array bub.',
+					'event_espresso'
+				)
+			);
+		}
+		return $help_array;
+	}
+
+
+	/**
+	 * EE Admin Pages can use this to set a properly formatted trigger for a help popup.
+	 * By default the trigger html is printed.  Otherwise it can be returned if the $display flag is set "false"
+	 * See comments made on the _set_help_content method for understanding other parts to the help popup tool.
+	 *
+	 * @param string $trigger_id reference for retrieving the trigger content for the popup
+	 * @param bool   $display    if false then we return the trigger string
+	 * @param array  $dimensions an array of dimensions for the box (array(h,w))
+	 * @return string
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	protected function _set_help_trigger(string $trigger_id, bool $display = true, array $dimensions = ['400', '640'])
+	{
+		if ($this->request->isAjax()) {
+			return '';
+		}
+		// let's check and see if there is any content set for this popup.  If there isn't then we'll include a default title and content so that developers know something needs to be corrected
+		$help_array   = $this->_get_help_content();
+		$help_content = '';
+		if (empty($help_array) || ! isset($help_array[ $trigger_id ])) {
+			$help_array[ $trigger_id ] = [
+				'title'   => esc_html__('Missing Content', 'event_espresso'),
+				'content' => esc_html__(
+					'A trigger has been set that doesn\'t have any corresponding content. Make sure you have set the help content. (see the "_set_help_popup_content" method in the EE_Admin_Page for instructions.)',
+					'event_espresso'
+				),
+			];
+			$help_content              = $this->_set_help_popup_content($help_array);
+		}
+		$height   = esc_attr($dimensions[0]) ?? 400;
+		$width    = esc_attr($dimensions[1]) ?? 640;
+		$inlineId = esc_attr($trigger_id);
+		// let's setup the trigger
+		$content = "
         <a class='ee-dialog' href='?height=$height&width=$width&inlineId=$inlineId' target='_blank'>
             <span class='question ee-help-popup-question'></span>
         </a>";
-        $content .= $help_content;
-        if ($display) {
-            echo wp_kses($content, AllowedTags::getWithFormTags());
-            return '';
-        }
-        return $content;
-    }
-
-
-    /**
-     * _add_global_screen_options
-     * Add any extra wp_screen_options within this method using built-in WP functions/methods for doing so.
-     * This particular method will add_screen_options on ALL EE_Admin Pages
-     *
-     * @link   http://chrismarslender.com/wp-tutorials/wordpress-screen-options-tutorial/
-     *         see also WP_Screen object documents...
-     * @link   http://codex.wordpress.org/Class_Reference/WP_Screen
-     * @abstract
-     * @return void
-     */
-    private function _add_global_screen_options()
-    {
-    }
-
-
-    /**
-     * _add_global_feature_pointers
-     * This method is used for implementing any "feature pointers" (using built-in WP styling js).
-     * This particular method will implement feature pointers for ALL EE_Admin pages.
-     * Note: this is just a placeholder for now.  Implementation will come down the road
-     *
-     * @see    WP_Internal_Pointers class in wp-admin/includes/template.php for example (its a final class so can't be
-     *         extended) also see:
-     * @link   http://eamann.com/tech/wordpress-portland/
-     * @abstract
-     * @return void
-     */
-    private function _add_global_feature_pointers()
-    {
-    }
-
-
-    /**
-     * load_global_scripts_styles
-     * The scripts and styles enqueued in here will be loaded on every EE Admin page
-     *
-     * @return void
-     */
-    public function load_global_scripts_styles()
-    {
-        // add debugging styles
-        if (WP_DEBUG) {
-            add_action('admin_head', [$this, 'add_xdebug_style']);
-        }
-        // taking care of metaboxes
-        if (
-            empty($this->_cpt_route)
-            && (isset($this->_route_config['metaboxes']) || isset($this->_route_config['has_metaboxes']))
-        ) {
-            wp_enqueue_script('dashboard');
-        }
-
-        wp_enqueue_script(JqueryAssetManager::JS_HANDLE_JQUERY_UI_TOUCH_PUNCH);
-        wp_enqueue_script(EspressoLegacyAdminAssetManager::JS_HANDLE_EE_ADMIN);
-        // LOCALIZED DATA
-        // localize script for ajax lazy loading
-        wp_localize_script(
-            EspressoLegacyAdminAssetManager::JS_HANDLE_EE_ADMIN,
-            'eeLazyLoadingContainers',
-            apply_filters(
-                'FHEE__EE_Admin_Page_Core__load_global_scripts_styles__loader_containers',
-                ['espresso_news_post_box_content']
-            )
-        );
-        StatusChangeNotice::loadAssets();
-
-        add_filter(
-            'admin_body_class',
-            function ($classes) {
-                if (strpos($classes, 'espresso-admin') === false) {
-                    $classes .= ' espresso-admin';
-                }
-                return $classes;
-            }
-        );
-    }
-
-
-    /**
-     *        admin_footer_scripts_eei18n_js_strings
-     *
-     * @return        void
-     */
-    public function admin_footer_scripts_eei18n_js_strings()
-    {
-        EE_Registry::$i18n_js_strings['ajax_url']       = WP_AJAX_URL;
-        EE_Registry::$i18n_js_strings['confirm_delete'] = wp_strip_all_tags(
-            __(
-                'Are you absolutely sure you want to delete this item?\nThis action will delete ALL DATA associated with this item!!!\nThis can NOT be undone!!!',
-                'event_espresso'
-            )
-        );
-        EE_Registry::$i18n_js_strings['January']        = wp_strip_all_tags(__('January', 'event_espresso'));
-        EE_Registry::$i18n_js_strings['February']       = wp_strip_all_tags(__('February', 'event_espresso'));
-        EE_Registry::$i18n_js_strings['March']          = wp_strip_all_tags(__('March', 'event_espresso'));
-        EE_Registry::$i18n_js_strings['April']          = wp_strip_all_tags(__('April', 'event_espresso'));
-        EE_Registry::$i18n_js_strings['May']            = wp_strip_all_tags(__('May', 'event_espresso'));
-        EE_Registry::$i18n_js_strings['June']           = wp_strip_all_tags(__('June', 'event_espresso'));
-        EE_Registry::$i18n_js_strings['July']           = wp_strip_all_tags(__('July', 'event_espresso'));
-        EE_Registry::$i18n_js_strings['August']         = wp_strip_all_tags(__('August', 'event_espresso'));
-        EE_Registry::$i18n_js_strings['September']      = wp_strip_all_tags(__('September', 'event_espresso'));
-        EE_Registry::$i18n_js_strings['October']        = wp_strip_all_tags(__('October', 'event_espresso'));
-        EE_Registry::$i18n_js_strings['November']       = wp_strip_all_tags(__('November', 'event_espresso'));
-        EE_Registry::$i18n_js_strings['December']       = wp_strip_all_tags(__('December', 'event_espresso'));
-        EE_Registry::$i18n_js_strings['Jan']            = wp_strip_all_tags(__('Jan', 'event_espresso'));
-        EE_Registry::$i18n_js_strings['Feb']            = wp_strip_all_tags(__('Feb', 'event_espresso'));
-        EE_Registry::$i18n_js_strings['Mar']            = wp_strip_all_tags(__('Mar', 'event_espresso'));
-        EE_Registry::$i18n_js_strings['Apr']            = wp_strip_all_tags(__('Apr', 'event_espresso'));
-        EE_Registry::$i18n_js_strings['May']            = wp_strip_all_tags(__('May', 'event_espresso'));
-        EE_Registry::$i18n_js_strings['Jun']            = wp_strip_all_tags(__('Jun', 'event_espresso'));
-        EE_Registry::$i18n_js_strings['Jul']            = wp_strip_all_tags(__('Jul', 'event_espresso'));
-        EE_Registry::$i18n_js_strings['Aug']            = wp_strip_all_tags(__('Aug', 'event_espresso'));
-        EE_Registry::$i18n_js_strings['Sep']            = wp_strip_all_tags(__('Sep', 'event_espresso'));
-        EE_Registry::$i18n_js_strings['Oct']            = wp_strip_all_tags(__('Oct', 'event_espresso'));
-        EE_Registry::$i18n_js_strings['Nov']            = wp_strip_all_tags(__('Nov', 'event_espresso'));
-        EE_Registry::$i18n_js_strings['Dec']            = wp_strip_all_tags(__('Dec', 'event_espresso'));
-        EE_Registry::$i18n_js_strings['Sunday']         = wp_strip_all_tags(__('Sunday', 'event_espresso'));
-        EE_Registry::$i18n_js_strings['Monday']         = wp_strip_all_tags(__('Monday', 'event_espresso'));
-        EE_Registry::$i18n_js_strings['Tuesday']        = wp_strip_all_tags(__('Tuesday', 'event_espresso'));
-        EE_Registry::$i18n_js_strings['Wednesday']      = wp_strip_all_tags(__('Wednesday', 'event_espresso'));
-        EE_Registry::$i18n_js_strings['Thursday']       = wp_strip_all_tags(__('Thursday', 'event_espresso'));
-        EE_Registry::$i18n_js_strings['Friday']         = wp_strip_all_tags(__('Friday', 'event_espresso'));
-        EE_Registry::$i18n_js_strings['Saturday']       = wp_strip_all_tags(__('Saturday', 'event_espresso'));
-        EE_Registry::$i18n_js_strings['Sun']            = wp_strip_all_tags(__('Sun', 'event_espresso'));
-        EE_Registry::$i18n_js_strings['Mon']            = wp_strip_all_tags(__('Mon', 'event_espresso'));
-        EE_Registry::$i18n_js_strings['Tue']            = wp_strip_all_tags(__('Tue', 'event_espresso'));
-        EE_Registry::$i18n_js_strings['Wed']            = wp_strip_all_tags(__('Wed', 'event_espresso'));
-        EE_Registry::$i18n_js_strings['Thu']            = wp_strip_all_tags(__('Thu', 'event_espresso'));
-        EE_Registry::$i18n_js_strings['Fri']            = wp_strip_all_tags(__('Fri', 'event_espresso'));
-        EE_Registry::$i18n_js_strings['Sat']            = wp_strip_all_tags(__('Sat', 'event_espresso'));
-    }
-
-
-    /**
-     *        load enhanced xdebug styles for ppl with failing eyesight
-     *
-     * @return        void
-     */
-    public function add_xdebug_style()
-    {
-        echo '<style>.xdebug-error { font-size:1.5em; }</style>';
-    }
-
-
-    /************************/
-    /** LIST TABLE METHODS **/
-    /************************/
-    /**
-     * this sets up the list table if the current view requires it.
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _set_list_table()
-    {
-        // first is this a list_table view?
-        if (! isset($this->_route_config['list_table'])) {
-            return;
-        } //not a list_table view so get out.
-        // list table functions are per view specific (because some admin pages might have more than one list table!)
-        $list_table_view = '_set_list_table_views_' . $this->_req_action;
-        if (! method_exists($this, $list_table_view) || $this->{$list_table_view}() === false) {
-            // user error msg
-            $error_msg = esc_html__(
-                'An error occurred. The requested list table views could not be found.',
-                'event_espresso'
-            );
-            // developer error msg
-            $error_msg .= '||'
-                          . sprintf(
-                              esc_html__(
-                                  'List table views for "%s" route could not be setup. Check that you have the corresponding method, "%s" set up for defining list_table_views for this route.',
-                                  'event_espresso'
-                              ),
-                              $this->_req_action,
-                              $list_table_view
-                          );
-            throw new EE_Error($error_msg);
-        }
-        // let's provide the ability to filter the views per PAGE AND ROUTE, per PAGE, and globally
-        $this->_views = apply_filters(
-            'FHEE_list_table_views_' . $this->page_slug . '_' . $this->_req_action,
-            $this->_views
-        );
-        $this->_views = apply_filters('FHEE_list_table_views_' . $this->page_slug, $this->_views);
-        $this->_views = apply_filters('FHEE_list_table_views', $this->_views);
-        $this->_set_list_table_view();
-        $this->_set_list_table_object();
-    }
-
-
-    /**
-     * set current view for List Table
-     *
-     * @return void
-     */
-    protected function _set_list_table_view()
-    {
-        $this->_view = isset($this->_views['in_use']) ? 'in_use' : 'all';
-        $status      = $this->request->getRequestParam('status', null, DataType::KEY);
-        $this->_view = $status && array_key_exists($status, $this->_views)
-            ? $status
-            : $this->_view;
-    }
-
-
-    /**
-     * _set_list_table_object
-     * WP_List_Table objects need to be loaded fairly early so automatic stuff WP does is taken care of.
-     *
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws InvalidInterfaceException
-     */
-    protected function _set_list_table_object()
-    {
-        if (isset($this->_route_config['list_table'])) {
-            if (! class_exists($this->_route_config['list_table'])) {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            'The %s class defined for the list table does not exist.  Please check the spelling of the class ref in the $_page_config property on %s.',
-                            'event_espresso'
-                        ),
-                        $this->_route_config['list_table'],
-                        $this->class_name
-                    )
-                );
-            }
-            $this->_list_table_object = $this->loader->getShared(
-                $this->_route_config['list_table'],
-                [
-                    $this,
-                    LoaderFactory::getShared(AdminListTableFilters::class),
-                ]
-            );
-        }
-    }
-
-
-    /**
-     * get_list_table_view_RLs - get it? View RL ?? VU-RL???  URL ??
-     *
-     * @param array $extra_query_args                     Optional. An array of extra query args to add to the generated
-     *                                                    urls.  The array should be indexed by the view it is being
-     *                                                    added to.
-     * @return array
-     */
-    public function get_list_table_view_RLs(array $extra_query_args = []): array
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        if (empty($this->_views)) {
-            $this->_views = [];
-        }
-        // cycle thru views
-        foreach ($this->_views as $key => $view) {
-            $query_args = [];
-            // check for current view
-            $this->_views[ $key ]['class']               = $this->_view === $view['slug'] ? 'current' : '';
-            $query_args['action']                        = $this->_req_action;
-            $query_args[ $this->_req_action . '_nonce' ] = wp_create_nonce($query_args['action'] . '_nonce');
-            $query_args['status']                        = $view['slug'];
-            // merge any other arguments sent in.
-            if (isset($extra_query_args[ $view['slug'] ])) {
-                foreach ($extra_query_args[ $view['slug'] ] as $extra_query_arg) {
-                    $query_args[] = $extra_query_arg;
-                }
-            }
-            $this->_views[ $key ]['url'] = EE_Admin_Page::add_query_args_and_nonce($query_args, $this->_admin_base_url);
-        }
-        return $this->_views;
-    }
-
-
-    /**
-     * generates a dropdown box for selecting the number of visible rows in an admin page list table
-     *
-     * @param int $max_entries total number of rows in the table
-     * @return string
-     * @todo   : Note: ideally this should be added to the screen options dropdown as that would be consistent with how
-     *                         WP does it.
-     */
-    protected function _entries_per_page_dropdown(int $max_entries = 0): string
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $values   = [10, 25, 50, 100];
-        $per_page = $this->request->getRequestParam('per_page', 10, DataType::INT);
-        if ($max_entries) {
-            $values[] = $max_entries;
-            sort($values);
-        }
-        $entries_per_page_dropdown = '
+		$content .= $help_content;
+		if ($display) {
+			echo wp_kses($content, AllowedTags::getWithFormTags());
+			return '';
+		}
+		return $content;
+	}
+
+
+	/**
+	 * _add_global_screen_options
+	 * Add any extra wp_screen_options within this method using built-in WP functions/methods for doing so.
+	 * This particular method will add_screen_options on ALL EE_Admin Pages
+	 *
+	 * @link   http://chrismarslender.com/wp-tutorials/wordpress-screen-options-tutorial/
+	 *         see also WP_Screen object documents...
+	 * @link   http://codex.wordpress.org/Class_Reference/WP_Screen
+	 * @abstract
+	 * @return void
+	 */
+	private function _add_global_screen_options()
+	{
+	}
+
+
+	/**
+	 * _add_global_feature_pointers
+	 * This method is used for implementing any "feature pointers" (using built-in WP styling js).
+	 * This particular method will implement feature pointers for ALL EE_Admin pages.
+	 * Note: this is just a placeholder for now.  Implementation will come down the road
+	 *
+	 * @see    WP_Internal_Pointers class in wp-admin/includes/template.php for example (its a final class so can't be
+	 *         extended) also see:
+	 * @link   http://eamann.com/tech/wordpress-portland/
+	 * @abstract
+	 * @return void
+	 */
+	private function _add_global_feature_pointers()
+	{
+	}
+
+
+	/**
+	 * load_global_scripts_styles
+	 * The scripts and styles enqueued in here will be loaded on every EE Admin page
+	 *
+	 * @return void
+	 */
+	public function load_global_scripts_styles()
+	{
+		// add debugging styles
+		if (WP_DEBUG) {
+			add_action('admin_head', [$this, 'add_xdebug_style']);
+		}
+		// taking care of metaboxes
+		if (
+			empty($this->_cpt_route)
+			&& (isset($this->_route_config['metaboxes']) || isset($this->_route_config['has_metaboxes']))
+		) {
+			wp_enqueue_script('dashboard');
+		}
+
+		wp_enqueue_script(JqueryAssetManager::JS_HANDLE_JQUERY_UI_TOUCH_PUNCH);
+		wp_enqueue_script(EspressoLegacyAdminAssetManager::JS_HANDLE_EE_ADMIN);
+		// LOCALIZED DATA
+		// localize script for ajax lazy loading
+		wp_localize_script(
+			EspressoLegacyAdminAssetManager::JS_HANDLE_EE_ADMIN,
+			'eeLazyLoadingContainers',
+			apply_filters(
+				'FHEE__EE_Admin_Page_Core__load_global_scripts_styles__loader_containers',
+				['espresso_news_post_box_content']
+			)
+		);
+		StatusChangeNotice::loadAssets();
+
+		add_filter(
+			'admin_body_class',
+			function ($classes) {
+				if (strpos($classes, 'espresso-admin') === false) {
+					$classes .= ' espresso-admin';
+				}
+				return $classes;
+			}
+		);
+	}
+
+
+	/**
+	 *        admin_footer_scripts_eei18n_js_strings
+	 *
+	 * @return        void
+	 */
+	public function admin_footer_scripts_eei18n_js_strings()
+	{
+		EE_Registry::$i18n_js_strings['ajax_url']       = WP_AJAX_URL;
+		EE_Registry::$i18n_js_strings['confirm_delete'] = wp_strip_all_tags(
+			__(
+				'Are you absolutely sure you want to delete this item?\nThis action will delete ALL DATA associated with this item!!!\nThis can NOT be undone!!!',
+				'event_espresso'
+			)
+		);
+		EE_Registry::$i18n_js_strings['January']        = wp_strip_all_tags(__('January', 'event_espresso'));
+		EE_Registry::$i18n_js_strings['February']       = wp_strip_all_tags(__('February', 'event_espresso'));
+		EE_Registry::$i18n_js_strings['March']          = wp_strip_all_tags(__('March', 'event_espresso'));
+		EE_Registry::$i18n_js_strings['April']          = wp_strip_all_tags(__('April', 'event_espresso'));
+		EE_Registry::$i18n_js_strings['May']            = wp_strip_all_tags(__('May', 'event_espresso'));
+		EE_Registry::$i18n_js_strings['June']           = wp_strip_all_tags(__('June', 'event_espresso'));
+		EE_Registry::$i18n_js_strings['July']           = wp_strip_all_tags(__('July', 'event_espresso'));
+		EE_Registry::$i18n_js_strings['August']         = wp_strip_all_tags(__('August', 'event_espresso'));
+		EE_Registry::$i18n_js_strings['September']      = wp_strip_all_tags(__('September', 'event_espresso'));
+		EE_Registry::$i18n_js_strings['October']        = wp_strip_all_tags(__('October', 'event_espresso'));
+		EE_Registry::$i18n_js_strings['November']       = wp_strip_all_tags(__('November', 'event_espresso'));
+		EE_Registry::$i18n_js_strings['December']       = wp_strip_all_tags(__('December', 'event_espresso'));
+		EE_Registry::$i18n_js_strings['Jan']            = wp_strip_all_tags(__('Jan', 'event_espresso'));
+		EE_Registry::$i18n_js_strings['Feb']            = wp_strip_all_tags(__('Feb', 'event_espresso'));
+		EE_Registry::$i18n_js_strings['Mar']            = wp_strip_all_tags(__('Mar', 'event_espresso'));
+		EE_Registry::$i18n_js_strings['Apr']            = wp_strip_all_tags(__('Apr', 'event_espresso'));
+		EE_Registry::$i18n_js_strings['May']            = wp_strip_all_tags(__('May', 'event_espresso'));
+		EE_Registry::$i18n_js_strings['Jun']            = wp_strip_all_tags(__('Jun', 'event_espresso'));
+		EE_Registry::$i18n_js_strings['Jul']            = wp_strip_all_tags(__('Jul', 'event_espresso'));
+		EE_Registry::$i18n_js_strings['Aug']            = wp_strip_all_tags(__('Aug', 'event_espresso'));
+		EE_Registry::$i18n_js_strings['Sep']            = wp_strip_all_tags(__('Sep', 'event_espresso'));
+		EE_Registry::$i18n_js_strings['Oct']            = wp_strip_all_tags(__('Oct', 'event_espresso'));
+		EE_Registry::$i18n_js_strings['Nov']            = wp_strip_all_tags(__('Nov', 'event_espresso'));
+		EE_Registry::$i18n_js_strings['Dec']            = wp_strip_all_tags(__('Dec', 'event_espresso'));
+		EE_Registry::$i18n_js_strings['Sunday']         = wp_strip_all_tags(__('Sunday', 'event_espresso'));
+		EE_Registry::$i18n_js_strings['Monday']         = wp_strip_all_tags(__('Monday', 'event_espresso'));
+		EE_Registry::$i18n_js_strings['Tuesday']        = wp_strip_all_tags(__('Tuesday', 'event_espresso'));
+		EE_Registry::$i18n_js_strings['Wednesday']      = wp_strip_all_tags(__('Wednesday', 'event_espresso'));
+		EE_Registry::$i18n_js_strings['Thursday']       = wp_strip_all_tags(__('Thursday', 'event_espresso'));
+		EE_Registry::$i18n_js_strings['Friday']         = wp_strip_all_tags(__('Friday', 'event_espresso'));
+		EE_Registry::$i18n_js_strings['Saturday']       = wp_strip_all_tags(__('Saturday', 'event_espresso'));
+		EE_Registry::$i18n_js_strings['Sun']            = wp_strip_all_tags(__('Sun', 'event_espresso'));
+		EE_Registry::$i18n_js_strings['Mon']            = wp_strip_all_tags(__('Mon', 'event_espresso'));
+		EE_Registry::$i18n_js_strings['Tue']            = wp_strip_all_tags(__('Tue', 'event_espresso'));
+		EE_Registry::$i18n_js_strings['Wed']            = wp_strip_all_tags(__('Wed', 'event_espresso'));
+		EE_Registry::$i18n_js_strings['Thu']            = wp_strip_all_tags(__('Thu', 'event_espresso'));
+		EE_Registry::$i18n_js_strings['Fri']            = wp_strip_all_tags(__('Fri', 'event_espresso'));
+		EE_Registry::$i18n_js_strings['Sat']            = wp_strip_all_tags(__('Sat', 'event_espresso'));
+	}
+
+
+	/**
+	 *        load enhanced xdebug styles for ppl with failing eyesight
+	 *
+	 * @return        void
+	 */
+	public function add_xdebug_style()
+	{
+		echo '<style>.xdebug-error { font-size:1.5em; }</style>';
+	}
+
+
+	/************************/
+	/** LIST TABLE METHODS **/
+	/************************/
+	/**
+	 * this sets up the list table if the current view requires it.
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _set_list_table()
+	{
+		// first is this a list_table view?
+		if (! isset($this->_route_config['list_table'])) {
+			return;
+		} //not a list_table view so get out.
+		// list table functions are per view specific (because some admin pages might have more than one list table!)
+		$list_table_view = '_set_list_table_views_' . $this->_req_action;
+		if (! method_exists($this, $list_table_view) || $this->{$list_table_view}() === false) {
+			// user error msg
+			$error_msg = esc_html__(
+				'An error occurred. The requested list table views could not be found.',
+				'event_espresso'
+			);
+			// developer error msg
+			$error_msg .= '||'
+						  . sprintf(
+							  esc_html__(
+								  'List table views for "%s" route could not be setup. Check that you have the corresponding method, "%s" set up for defining list_table_views for this route.',
+								  'event_espresso'
+							  ),
+							  $this->_req_action,
+							  $list_table_view
+						  );
+			throw new EE_Error($error_msg);
+		}
+		// let's provide the ability to filter the views per PAGE AND ROUTE, per PAGE, and globally
+		$this->_views = apply_filters(
+			'FHEE_list_table_views_' . $this->page_slug . '_' . $this->_req_action,
+			$this->_views
+		);
+		$this->_views = apply_filters('FHEE_list_table_views_' . $this->page_slug, $this->_views);
+		$this->_views = apply_filters('FHEE_list_table_views', $this->_views);
+		$this->_set_list_table_view();
+		$this->_set_list_table_object();
+	}
+
+
+	/**
+	 * set current view for List Table
+	 *
+	 * @return void
+	 */
+	protected function _set_list_table_view()
+	{
+		$this->_view = isset($this->_views['in_use']) ? 'in_use' : 'all';
+		$status      = $this->request->getRequestParam('status', null, DataType::KEY);
+		$this->_view = $status && array_key_exists($status, $this->_views)
+			? $status
+			: $this->_view;
+	}
+
+
+	/**
+	 * _set_list_table_object
+	 * WP_List_Table objects need to be loaded fairly early so automatic stuff WP does is taken care of.
+	 *
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _set_list_table_object()
+	{
+		if (isset($this->_route_config['list_table'])) {
+			if (! class_exists($this->_route_config['list_table'])) {
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							'The %s class defined for the list table does not exist.  Please check the spelling of the class ref in the $_page_config property on %s.',
+							'event_espresso'
+						),
+						$this->_route_config['list_table'],
+						$this->class_name
+					)
+				);
+			}
+			$this->_list_table_object = $this->loader->getShared(
+				$this->_route_config['list_table'],
+				[
+					$this,
+					LoaderFactory::getShared(AdminListTableFilters::class),
+				]
+			);
+		}
+	}
+
+
+	/**
+	 * get_list_table_view_RLs - get it? View RL ?? VU-RL???  URL ??
+	 *
+	 * @param array $extra_query_args                     Optional. An array of extra query args to add to the generated
+	 *                                                    urls.  The array should be indexed by the view it is being
+	 *                                                    added to.
+	 * @return array
+	 */
+	public function get_list_table_view_RLs(array $extra_query_args = []): array
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		if (empty($this->_views)) {
+			$this->_views = [];
+		}
+		// cycle thru views
+		foreach ($this->_views as $key => $view) {
+			$query_args = [];
+			// check for current view
+			$this->_views[ $key ]['class']               = $this->_view === $view['slug'] ? 'current' : '';
+			$query_args['action']                        = $this->_req_action;
+			$query_args[ $this->_req_action . '_nonce' ] = wp_create_nonce($query_args['action'] . '_nonce');
+			$query_args['status']                        = $view['slug'];
+			// merge any other arguments sent in.
+			if (isset($extra_query_args[ $view['slug'] ])) {
+				foreach ($extra_query_args[ $view['slug'] ] as $extra_query_arg) {
+					$query_args[] = $extra_query_arg;
+				}
+			}
+			$this->_views[ $key ]['url'] = EE_Admin_Page::add_query_args_and_nonce($query_args, $this->_admin_base_url);
+		}
+		return $this->_views;
+	}
+
+
+	/**
+	 * generates a dropdown box for selecting the number of visible rows in an admin page list table
+	 *
+	 * @param int $max_entries total number of rows in the table
+	 * @return string
+	 * @todo   : Note: ideally this should be added to the screen options dropdown as that would be consistent with how
+	 *                         WP does it.
+	 */
+	protected function _entries_per_page_dropdown(int $max_entries = 0): string
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$values   = [10, 25, 50, 100];
+		$per_page = $this->request->getRequestParam('per_page', 10, DataType::INT);
+		if ($max_entries) {
+			$values[] = $max_entries;
+			sort($values);
+		}
+		$entries_per_page_dropdown = '
 			<div id="entries-per-page-dv" class="alignleft actions">
 				<label class="hide-if-no-js">
 					Show
 					<select id="entries-per-page-slct" name="entries-per-page-slct">';
-        foreach ($values as $value) {
-            if ($value < $max_entries) {
-                $selected                  = $value === $per_page ? ' selected="' . $per_page . '"' : '';
-                $entries_per_page_dropdown .= '
+		foreach ($values as $value) {
+			if ($value < $max_entries) {
+				$selected                  = $value === $per_page ? ' selected="' . $per_page . '"' : '';
+				$entries_per_page_dropdown .= '
 						<option value="' . $value . '"' . $selected . '>' . $value . '&nbsp;&nbsp;</option>';
-            }
-        }
-        $selected                  = $max_entries === $per_page ? ' selected="' . $per_page . '"' : '';
-        $entries_per_page_dropdown .= '
+			}
+		}
+		$selected                  = $max_entries === $per_page ? ' selected="' . $per_page . '"' : '';
+		$entries_per_page_dropdown .= '
 						<option value="' . $max_entries . '"' . $selected . '>All&nbsp;&nbsp;</option>';
-        $entries_per_page_dropdown .= '
+		$entries_per_page_dropdown .= '
 					</select>
 					entries
 				</label>
 				<input id="entries-per-page-btn" class="button button--secondary" type="submit" value="Go" >
 			</div>
 		';
-        return $entries_per_page_dropdown;
-    }
-
-
-    /**
-     *        _set_search_attributes
-     *
-     * @return        void
-     */
-    public function _set_search_attributes()
-    {
-        $this->_template_args['search']['btn_label'] = sprintf(
-            esc_html__('Search %s', 'event_espresso'),
-            empty($this->_search_btn_label) ? $this->page_label
-                : $this->_search_btn_label
-        );
-        $this->_template_args['search']['callback']  = 'search_' . $this->page_slug;
-    }
-
-
-
-    /*** END LIST TABLE METHODS **/
-
-    /**
-     * @return void
-     * @throws EE_Error
-     */
-    public function addRegisteredMetaBoxes()
-    {
-        remove_action('add_meta_boxes', [$this, 'addRegisteredMetaBoxes'], 99);
-        $this->_add_registered_meta_boxes();
-    }
-
-
-    /**
-     * _add_registered_metaboxes
-     *  this loads any registered metaboxes via the 'metaboxes' index in the _page_config property array.
-     *
-     * @link   http://codex.wordpress.org/Function_Reference/add_meta_box
-     * @return void
-     * @throws EE_Error
-     */
-    private function _add_registered_meta_boxes()
-    {
-        // we only add meta boxes if the page_route calls for it
-        if (isset($this->_route_config['metaboxes']) && is_array($this->_route_config['metaboxes'])) {
-            // this simply loops through the callbacks provided
-            // and checks if there is a corresponding callback registered by the child
-            // if there is then we go ahead and process the metabox loader.
-            foreach ($this->_route_config['metaboxes'] as $key => $metabox_callback) {
-                // first check for Closures
-                if ($metabox_callback instanceof Closure) {
-                    $result = $metabox_callback();
-                } elseif (is_callable($metabox_callback)) {
-                    $result = call_user_func($metabox_callback);
-                } elseif (method_exists($this, $metabox_callback)) {
-                    $result = $this->{$metabox_callback}();
-                } else {
-                    $result = false;
-                }
-                if ($result === false) {
-                    // user error msg
-                    $error_msg = esc_html__(
-                        'An error occurred. The  requested metabox could not be found.',
-                        'event_espresso'
-                    );
-                    // developer error msg
-                    $error_msg .= '||'
-                                  . sprintf(
-                                      esc_html__(
-                                          'The metabox with the string "%s" could not be called. Check that the spelling for method names and actions in the "_page_config[\'metaboxes\']" array are all correct.',
-                                          'event_espresso'
-                                      ),
-                                      $metabox_callback
-                                  );
-                    throw new EE_Error($error_msg);
-                }
-                unset($this->_route_config['metaboxes'][ $key ]);
-            }
-        }
-    }
-
-
-    /**
-     * _add_screen_columns
-     * This will check the _page_config array and if there is "columns" key index indicated, we'll set the template as
-     * the dynamic column template and we'll setup the column options for the page.
-     *
-     * @return void
-     */
-    private function _add_screen_columns()
-    {
-        if (
-            isset($this->_route_config['columns'])
-            && is_array($this->_route_config['columns'])
-            && count($this->_route_config['columns']) === 2
-        ) {
-            add_screen_option(
-                'layout_columns',
-                [
-                    'max'     => (int) $this->_route_config['columns'][0],
-                    'default' => (int) $this->_route_config['columns'][1],
-                ]
-            );
-            $this->_template_args['num_columns']                 = $this->_route_config['columns'][0];
-            $screen_id                                           = $this->_current_screen->id;
-            $screen_columns                                      = (int) get_user_option("screen_layout_$screen_id");
-            $total_columns                                       = ! empty($screen_columns)
-                ? $screen_columns
-                : $this->_route_config['columns'][1];
-            $this->_template_args['current_screen_widget_class'] = 'columns-' . $total_columns;
-            $this->_template_args['current_page']                = $this->_wp_page_slug;
-            $this->_template_args['screen']                      = $this->_current_screen;
-            $this->_column_template_path                         = EE_ADMIN_TEMPLATE
-                                                                   . 'admin_details_metabox_column_wrapper.template.php';
-            // finally if we don't have has_metaboxes set in the route config
-            // let's make sure it IS set other wise the necessary hidden fields for this won't be loaded.
-            $this->_route_config['has_metaboxes'] = true;
-        }
-    }
-
-
-
-    /** GLOBALLY AVAILABLE METABOXES **/
-
-
-    /**
-     * In this section we put any globally available EE metaboxes for all EE Admin pages.  They are called by simply
-     * referencing the callback in the _page_config array property.  This way you can be very specific about what pages
-     * these get loaded on.
-     */
-    private function _espresso_news_post_box()
-    {
-        $news_box_title = apply_filters(
-            'FHEE__EE_Admin_Page___espresso_news_post_box__news_box_title',
-            esc_html__('New @ Event Espresso', 'event_espresso')
-        );
-        $this->addMetaBox(
-            'espresso_news_post_box',
-            $news_box_title,
-            [
-                $this,
-                'espresso_news_post_box',
-            ],
-            $this->_wp_page_slug,
-            'side',
-            'low'
-        );
-    }
-
-
-    /**
-     * Code for setting up espresso ratings request metabox.
-     */
-    protected function _espresso_ratings_request()
-    {
-        if (! apply_filters('FHEE_show_ratings_request_meta_box', true)) {
-            return;
-        }
-        $ratings_box_title = apply_filters(
-            'FHEE__EE_Admin_Page___espresso_news_post_box__news_box_title',
-            esc_html__('Keep Event Espresso Decaf Free', 'event_espresso')
-        );
-        $this->addMetaBox(
-            'espresso_ratings_request',
-            $ratings_box_title,
-            [
-                $this,
-                'espresso_ratings_request',
-            ],
-            $this->_wp_page_slug,
-            'side'
-        );
-    }
-
-
-    /**
-     * Code for setting up espresso ratings request metabox content.
-     *
-     * @throws DomainException
-     */
-    public function espresso_ratings_request()
-    {
-        EEH_Template::display_template(EE_ADMIN_TEMPLATE . 'espresso_ratings_request_content.template.php');
-    }
-
-
-    public static function cached_rss_display(string $rss_id, string $url): bool
-    {
-        $loading   = '<p class="widget-loading hide-if-no-js">'
-                     . esc_html__('Loading&#8230;', 'event_espresso')
-                     . '</p><p class="hide-if-js">'
-                     . esc_html__('This widget requires JavaScript.', 'event_espresso')
-                     . '</p>';
-        $pre       = '<div class="espresso-rss-display">' . "\n\t";
-        $pre       .= '<span id="' . esc_attr($rss_id) . '_url" class="hidden">' . esc_url_raw($url) . '</span>';
-        $post      = '</div>' . "\n";
-        $cache_key = 'ee_rss_' . md5($rss_id);
-        $output    = get_transient($cache_key);
-        if ($output !== false) {
-            echo wp_kses($pre . $output . $post, AllowedTags::getWithFormTags());
-            return true;
-        }
-        if (! (defined('DOING_AJAX') && DOING_AJAX)) {
-            echo wp_kses($pre . $loading . $post, AllowedTags::getWithFormTags());
-            return false;
-        }
-        ob_start();
-        wp_widget_rss_output($url, ['show_date' => 0, 'items' => 5]);
-        set_transient($cache_key, ob_get_flush(), 12 * HOUR_IN_SECONDS);
-        return true;
-    }
-
-
-    public function espresso_news_post_box()
-    {
-        ?>
+		return $entries_per_page_dropdown;
+	}
+
+
+	/**
+	 *        _set_search_attributes
+	 *
+	 * @return        void
+	 */
+	public function _set_search_attributes()
+	{
+		$this->_template_args['search']['btn_label'] = sprintf(
+			esc_html__('Search %s', 'event_espresso'),
+			empty($this->_search_btn_label) ? $this->page_label
+				: $this->_search_btn_label
+		);
+		$this->_template_args['search']['callback']  = 'search_' . $this->page_slug;
+	}
+
+
+
+	/*** END LIST TABLE METHODS **/
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function addRegisteredMetaBoxes()
+	{
+		remove_action('add_meta_boxes', [$this, 'addRegisteredMetaBoxes'], 99);
+		$this->_add_registered_meta_boxes();
+	}
+
+
+	/**
+	 * _add_registered_metaboxes
+	 *  this loads any registered metaboxes via the 'metaboxes' index in the _page_config property array.
+	 *
+	 * @link   http://codex.wordpress.org/Function_Reference/add_meta_box
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private function _add_registered_meta_boxes()
+	{
+		// we only add meta boxes if the page_route calls for it
+		if (isset($this->_route_config['metaboxes']) && is_array($this->_route_config['metaboxes'])) {
+			// this simply loops through the callbacks provided
+			// and checks if there is a corresponding callback registered by the child
+			// if there is then we go ahead and process the metabox loader.
+			foreach ($this->_route_config['metaboxes'] as $key => $metabox_callback) {
+				// first check for Closures
+				if ($metabox_callback instanceof Closure) {
+					$result = $metabox_callback();
+				} elseif (is_callable($metabox_callback)) {
+					$result = call_user_func($metabox_callback);
+				} elseif (method_exists($this, $metabox_callback)) {
+					$result = $this->{$metabox_callback}();
+				} else {
+					$result = false;
+				}
+				if ($result === false) {
+					// user error msg
+					$error_msg = esc_html__(
+						'An error occurred. The  requested metabox could not be found.',
+						'event_espresso'
+					);
+					// developer error msg
+					$error_msg .= '||'
+								  . sprintf(
+									  esc_html__(
+										  'The metabox with the string "%s" could not be called. Check that the spelling for method names and actions in the "_page_config[\'metaboxes\']" array are all correct.',
+										  'event_espresso'
+									  ),
+									  $metabox_callback
+								  );
+					throw new EE_Error($error_msg);
+				}
+				unset($this->_route_config['metaboxes'][ $key ]);
+			}
+		}
+	}
+
+
+	/**
+	 * _add_screen_columns
+	 * This will check the _page_config array and if there is "columns" key index indicated, we'll set the template as
+	 * the dynamic column template and we'll setup the column options for the page.
+	 *
+	 * @return void
+	 */
+	private function _add_screen_columns()
+	{
+		if (
+			isset($this->_route_config['columns'])
+			&& is_array($this->_route_config['columns'])
+			&& count($this->_route_config['columns']) === 2
+		) {
+			add_screen_option(
+				'layout_columns',
+				[
+					'max'     => (int) $this->_route_config['columns'][0],
+					'default' => (int) $this->_route_config['columns'][1],
+				]
+			);
+			$this->_template_args['num_columns']                 = $this->_route_config['columns'][0];
+			$screen_id                                           = $this->_current_screen->id;
+			$screen_columns                                      = (int) get_user_option("screen_layout_$screen_id");
+			$total_columns                                       = ! empty($screen_columns)
+				? $screen_columns
+				: $this->_route_config['columns'][1];
+			$this->_template_args['current_screen_widget_class'] = 'columns-' . $total_columns;
+			$this->_template_args['current_page']                = $this->_wp_page_slug;
+			$this->_template_args['screen']                      = $this->_current_screen;
+			$this->_column_template_path                         = EE_ADMIN_TEMPLATE
+																   . 'admin_details_metabox_column_wrapper.template.php';
+			// finally if we don't have has_metaboxes set in the route config
+			// let's make sure it IS set other wise the necessary hidden fields for this won't be loaded.
+			$this->_route_config['has_metaboxes'] = true;
+		}
+	}
+
+
+
+	/** GLOBALLY AVAILABLE METABOXES **/
+
+
+	/**
+	 * In this section we put any globally available EE metaboxes for all EE Admin pages.  They are called by simply
+	 * referencing the callback in the _page_config array property.  This way you can be very specific about what pages
+	 * these get loaded on.
+	 */
+	private function _espresso_news_post_box()
+	{
+		$news_box_title = apply_filters(
+			'FHEE__EE_Admin_Page___espresso_news_post_box__news_box_title',
+			esc_html__('New @ Event Espresso', 'event_espresso')
+		);
+		$this->addMetaBox(
+			'espresso_news_post_box',
+			$news_box_title,
+			[
+				$this,
+				'espresso_news_post_box',
+			],
+			$this->_wp_page_slug,
+			'side',
+			'low'
+		);
+	}
+
+
+	/**
+	 * Code for setting up espresso ratings request metabox.
+	 */
+	protected function _espresso_ratings_request()
+	{
+		if (! apply_filters('FHEE_show_ratings_request_meta_box', true)) {
+			return;
+		}
+		$ratings_box_title = apply_filters(
+			'FHEE__EE_Admin_Page___espresso_news_post_box__news_box_title',
+			esc_html__('Keep Event Espresso Decaf Free', 'event_espresso')
+		);
+		$this->addMetaBox(
+			'espresso_ratings_request',
+			$ratings_box_title,
+			[
+				$this,
+				'espresso_ratings_request',
+			],
+			$this->_wp_page_slug,
+			'side'
+		);
+	}
+
+
+	/**
+	 * Code for setting up espresso ratings request metabox content.
+	 *
+	 * @throws DomainException
+	 */
+	public function espresso_ratings_request()
+	{
+		EEH_Template::display_template(EE_ADMIN_TEMPLATE . 'espresso_ratings_request_content.template.php');
+	}
+
+
+	public static function cached_rss_display(string $rss_id, string $url): bool
+	{
+		$loading   = '<p class="widget-loading hide-if-no-js">'
+					 . esc_html__('Loading&#8230;', 'event_espresso')
+					 . '</p><p class="hide-if-js">'
+					 . esc_html__('This widget requires JavaScript.', 'event_espresso')
+					 . '</p>';
+		$pre       = '<div class="espresso-rss-display">' . "\n\t";
+		$pre       .= '<span id="' . esc_attr($rss_id) . '_url" class="hidden">' . esc_url_raw($url) . '</span>';
+		$post      = '</div>' . "\n";
+		$cache_key = 'ee_rss_' . md5($rss_id);
+		$output    = get_transient($cache_key);
+		if ($output !== false) {
+			echo wp_kses($pre . $output . $post, AllowedTags::getWithFormTags());
+			return true;
+		}
+		if (! (defined('DOING_AJAX') && DOING_AJAX)) {
+			echo wp_kses($pre . $loading . $post, AllowedTags::getWithFormTags());
+			return false;
+		}
+		ob_start();
+		wp_widget_rss_output($url, ['show_date' => 0, 'items' => 5]);
+		set_transient($cache_key, ob_get_flush(), 12 * HOUR_IN_SECONDS);
+		return true;
+	}
+
+
+	public function espresso_news_post_box()
+	{
+		?>
 <div class="padding">
 	<div id="espresso_news_post_box_content" class="infolinks">
 		<?php
-                // Get RSS Feed(s)
-                EE_Admin_Page::cached_rss_display(
-                    'espresso_news_post_box_content',
-                    esc_url_raw(
-                        apply_filters(
-                            'FHEE__EE_Admin_Page__espresso_news_post_box__feed_url',
-                            'https://eventespresso.com/feed/'
-                        )
-                    )
-                );
-                ?>
+				// Get RSS Feed(s)
+				EE_Admin_Page::cached_rss_display(
+					'espresso_news_post_box_content',
+					esc_url_raw(
+						apply_filters(
+							'FHEE__EE_Admin_Page__espresso_news_post_box__feed_url',
+							'https://eventespresso.com/feed/'
+						)
+					)
+				);
+				?>
 	</div>
 	<?php do_action('AHEE__EE_Admin_Page__espresso_news_post_box__after_content'); ?>
 </div>
 <?php
-    }
-
-
-    private function _espresso_links_post_box()
-    {
-        // Hiding until we actually have content to put in here...
-        // $this->addMetaBox('espresso_links_post_box', esc_html__('Helpful Plugin Links', 'event_espresso'), array( $this, 'espresso_links_post_box'), $this->_wp_page_slug, 'side');
-    }
-
-
-    public function espresso_links_post_box()
-    {
-        // Hiding until we actually have content to put in here...
-        // EEH_Template::display_template(
-        //     EE_ADMIN_TEMPLATE . 'admin_general_metabox_contents_espresso_links.template.php'
-        // );
-    }
-
-
-    protected function _espresso_sponsors_post_box()
-    {
-        if (apply_filters('FHEE_show_sponsors_meta_box', true)) {
-            $this->addMetaBox(
-                'espresso_sponsors_post_box',
-                esc_html__('Event Espresso Highlights', 'event_espresso'),
-                [$this, 'espresso_sponsors_post_box'],
-                $this->_wp_page_slug,
-                'side'
-            );
-        }
-    }
-
-
-    public function espresso_sponsors_post_box()
-    {
-        EEH_Template::display_template(
-            EE_ADMIN_TEMPLATE . 'admin_general_metabox_contents_espresso_sponsors.template.php'
-        );
-    }
-
-
-    /**
-     * if there is [ 'label' => [ 'publishbox' => 'some title' ]]
-     * present in the _page_config array, then we'll use that for the metabox label.
-     * Otherwise we'll just use publish
-     * (publishbox itself could be an array of labels indexed by routes)
-     *
-     * @return string
-     * @since   5.0.0.p
-     */
-    protected function getPublishBoxTitle(): string
-    {
-        $publish_box_title = esc_html__('Publish', 'event_espresso');
-        if (! empty($this->_labels['publishbox'])) {
-            if (is_array($this->_labels['publishbox'])) {
-                $publish_box_title = $this->_labels['publishbox'][ $this->_req_action ] ?? $publish_box_title;
-            } else {
-                $publish_box_title = $this->_labels['publishbox'];
-            }
-        }
-        return apply_filters(
-            'FHEE__EE_Admin_Page___publish_post_box__box_label',
-            $publish_box_title,
-            $this->_req_action,
-            $this
-        );
-    }
-
-
-    /**
-     * @throws EE_Error
-     */
-    private function _publish_post_box()
-    {
-        $title = $this->getPublishBoxTitle();
-        if (empty($this->_template_args['save_buttons'])) {
-            $this->_set_publish_post_box_vars(sanitize_key($title), "espresso_{$this->page_slug}_editor_overview");
-        } else {
-            $this->addPublishPostMetaBoxHiddenFields(
-                sanitize_key($title),
-                ['type' => 'hidden', 'value' => "espresso_{$this->page_slug}_editor_overview"]
-            );
-        }
-        $this->addMetaBox(
-            "espresso_{$this->page_slug}_editor_overview",
-            $title,
-            [$this, 'editor_overview'],
-            $this->_current_screen->id,
-            'side',
-            'high'
-        );
-    }
-
-
-    public function editor_overview()
-    {
-        /**
-         * @var string $publish_box_extra_content
-         * @var string $publish_hidden_fields
-         * @var string $publish_delete_link
-         * @var string $save_buttons
-         */
-        // if we have extra content set let's add it in if not make sure its empty
-        $this->_template_args['publish_box_extra_content'] = $this->_template_args['publish_box_extra_content'] ?? '';
-        echo EEH_Template::display_template(
-            EE_ADMIN_TEMPLATE . 'admin_details_publish_metabox.template.php',
-            $this->_template_args,
-            true
-        );
-    }
-
-
-    /** end of globally available metaboxes section **/
-
-
-    /**
-     * Sets the _template_args arguments used by the _publish_post_box shortcut
-     * Note: currently there is no validation for this.  However, if you want the delete button, the
-     * save, and save and close buttons to work properly, then you will want to include a
-     * values for the name and id arguments.
-     *
-     * @param string|null $name                     key used for the action ID (i.e. event_id)
-     * @param int|string  $id                       id attached to the item published
-     * @param string|null $delete                   page route callback for the delete action
-     * @param string|null $save_close_redirect_URL  custom URL to redirect to after Save & Close has been completed
-     * @param bool        $both_btns                whether to display BOTH the "Save & Close" and "Save" buttons
-     *                                              or just the "Save" button
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @todo  Add in validation for name/id arguments.
-     */
-    protected function _set_publish_post_box_vars(
-        ?string $name = '',
-        $id = 0,
-        ?string $delete = '',
-        ?string $save_close_redirect_URL = '',
-        bool $both_btns = true
-    ) {
-        // if Save & Close, use a custom redirect URL or default to the main page?
-        $save_close_redirect_URL = ! empty($save_close_redirect_URL)
-            ? $save_close_redirect_URL
-            : $this->_admin_base_url;
-        // create the Save & Close and Save buttons
-        $this->_set_save_buttons($both_btns, [], [], $save_close_redirect_URL);
-        // if we have extra content set let's add it in if not make sure its empty
-        $this->_template_args['publish_box_extra_content'] = $this->_template_args['publish_box_extra_content'] ?? '';
-        if ($delete && ! empty($id) && empty($this->_template_args['publish_delete_link'])) {
-            // make sure we have a default if just true is sent.
-            $delete                                      = ! empty($delete) ? $delete : 'delete';
-            $this->_template_args['publish_delete_link'] = $this->get_action_link_or_button(
-                $delete,
-                $delete,
-                [$name => $id],
-                'submitdelete deletion button button--outline button--caution'
-            );
-        }
-        if (! isset($this->_template_args['publish_delete_link'])) {
-            $this->_template_args['publish_delete_link'] = '';
-        }
-        if (! empty($name) && ! empty($id)) {
-            $this->addPublishPostMetaBoxHiddenFields($name, ['type' => 'hidden', 'value' => $id]);
-        }
-        $hidden_fields = $this->_generate_admin_form_fields($this->publish_post_meta_box_hidden_fields, 'array');
-        // add hidden fields
-        $this->_template_args['publish_hidden_fields'] = $this->_template_args['publish_hidden_fields'] ?? '';
-        foreach ($hidden_fields as $hidden_field) {
-            $this->_template_args['publish_hidden_fields'] .= $hidden_field['field'] ?? '';
-        }
-    }
-
-
-    /**
-     * @param string|null $name
-     * @param int|string  $id
-     * @param string|null $delete
-     * @param string|null $save_close_redirect_URL
-     * @param bool        $both_btns
-     * @throws EE_Error
-     */
-    public function set_publish_post_box_vars(
-        ?string $name = '',
-        $id = 0,
-        ?string $delete = '',
-        ?string $save_close_redirect_URL = '',
-        bool $both_btns = false
-    ) {
-        $this->_set_publish_post_box_vars($name, $id, $delete, $save_close_redirect_URL, $both_btns);
-    }
-
-
-    protected function addPublishPostMetaBoxHiddenFields(string $field_name, array $field_attributes)
-    {
-        $this->publish_post_meta_box_hidden_fields[ $field_name ] = $field_attributes;
-    }
-
-
-    /**
-     * displays an error message to ppl who have javascript disabled
-     *
-     * @return void
-     */
-    private function _display_no_javascript_warning()
-    {
-        ?>
+	}
+
+
+	private function _espresso_links_post_box()
+	{
+		// Hiding until we actually have content to put in here...
+		// $this->addMetaBox('espresso_links_post_box', esc_html__('Helpful Plugin Links', 'event_espresso'), array( $this, 'espresso_links_post_box'), $this->_wp_page_slug, 'side');
+	}
+
+
+	public function espresso_links_post_box()
+	{
+		// Hiding until we actually have content to put in here...
+		// EEH_Template::display_template(
+		//     EE_ADMIN_TEMPLATE . 'admin_general_metabox_contents_espresso_links.template.php'
+		// );
+	}
+
+
+	protected function _espresso_sponsors_post_box()
+	{
+		if (apply_filters('FHEE_show_sponsors_meta_box', true)) {
+			$this->addMetaBox(
+				'espresso_sponsors_post_box',
+				esc_html__('Event Espresso Highlights', 'event_espresso'),
+				[$this, 'espresso_sponsors_post_box'],
+				$this->_wp_page_slug,
+				'side'
+			);
+		}
+	}
+
+
+	public function espresso_sponsors_post_box()
+	{
+		EEH_Template::display_template(
+			EE_ADMIN_TEMPLATE . 'admin_general_metabox_contents_espresso_sponsors.template.php'
+		);
+	}
+
+
+	/**
+	 * if there is [ 'label' => [ 'publishbox' => 'some title' ]]
+	 * present in the _page_config array, then we'll use that for the metabox label.
+	 * Otherwise we'll just use publish
+	 * (publishbox itself could be an array of labels indexed by routes)
+	 *
+	 * @return string
+	 * @since   5.0.0.p
+	 */
+	protected function getPublishBoxTitle(): string
+	{
+		$publish_box_title = esc_html__('Publish', 'event_espresso');
+		if (! empty($this->_labels['publishbox'])) {
+			if (is_array($this->_labels['publishbox'])) {
+				$publish_box_title = $this->_labels['publishbox'][ $this->_req_action ] ?? $publish_box_title;
+			} else {
+				$publish_box_title = $this->_labels['publishbox'];
+			}
+		}
+		return apply_filters(
+			'FHEE__EE_Admin_Page___publish_post_box__box_label',
+			$publish_box_title,
+			$this->_req_action,
+			$this
+		);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 */
+	private function _publish_post_box()
+	{
+		$title = $this->getPublishBoxTitle();
+		if (empty($this->_template_args['save_buttons'])) {
+			$this->_set_publish_post_box_vars(sanitize_key($title), "espresso_{$this->page_slug}_editor_overview");
+		} else {
+			$this->addPublishPostMetaBoxHiddenFields(
+				sanitize_key($title),
+				['type' => 'hidden', 'value' => "espresso_{$this->page_slug}_editor_overview"]
+			);
+		}
+		$this->addMetaBox(
+			"espresso_{$this->page_slug}_editor_overview",
+			$title,
+			[$this, 'editor_overview'],
+			$this->_current_screen->id,
+			'side',
+			'high'
+		);
+	}
+
+
+	public function editor_overview()
+	{
+		/**
+		 * @var string $publish_box_extra_content
+		 * @var string $publish_hidden_fields
+		 * @var string $publish_delete_link
+		 * @var string $save_buttons
+		 */
+		// if we have extra content set let's add it in if not make sure its empty
+		$this->_template_args['publish_box_extra_content'] = $this->_template_args['publish_box_extra_content'] ?? '';
+		echo EEH_Template::display_template(
+			EE_ADMIN_TEMPLATE . 'admin_details_publish_metabox.template.php',
+			$this->_template_args,
+			true
+		);
+	}
+
+
+	/** end of globally available metaboxes section **/
+
+
+	/**
+	 * Sets the _template_args arguments used by the _publish_post_box shortcut
+	 * Note: currently there is no validation for this.  However, if you want the delete button, the
+	 * save, and save and close buttons to work properly, then you will want to include a
+	 * values for the name and id arguments.
+	 *
+	 * @param string|null $name                     key used for the action ID (i.e. event_id)
+	 * @param int|string  $id                       id attached to the item published
+	 * @param string|null $delete                   page route callback for the delete action
+	 * @param string|null $save_close_redirect_URL  custom URL to redirect to after Save & Close has been completed
+	 * @param bool        $both_btns                whether to display BOTH the "Save & Close" and "Save" buttons
+	 *                                              or just the "Save" button
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @todo  Add in validation for name/id arguments.
+	 */
+	protected function _set_publish_post_box_vars(
+		?string $name = '',
+		$id = 0,
+		?string $delete = '',
+		?string $save_close_redirect_URL = '',
+		bool $both_btns = true
+	) {
+		// if Save & Close, use a custom redirect URL or default to the main page?
+		$save_close_redirect_URL = ! empty($save_close_redirect_URL)
+			? $save_close_redirect_URL
+			: $this->_admin_base_url;
+		// create the Save & Close and Save buttons
+		$this->_set_save_buttons($both_btns, [], [], $save_close_redirect_URL);
+		// if we have extra content set let's add it in if not make sure its empty
+		$this->_template_args['publish_box_extra_content'] = $this->_template_args['publish_box_extra_content'] ?? '';
+		if ($delete && ! empty($id) && empty($this->_template_args['publish_delete_link'])) {
+			// make sure we have a default if just true is sent.
+			$delete                                      = ! empty($delete) ? $delete : 'delete';
+			$this->_template_args['publish_delete_link'] = $this->get_action_link_or_button(
+				$delete,
+				$delete,
+				[$name => $id],
+				'submitdelete deletion button button--outline button--caution'
+			);
+		}
+		if (! isset($this->_template_args['publish_delete_link'])) {
+			$this->_template_args['publish_delete_link'] = '';
+		}
+		if (! empty($name) && ! empty($id)) {
+			$this->addPublishPostMetaBoxHiddenFields($name, ['type' => 'hidden', 'value' => $id]);
+		}
+		$hidden_fields = $this->_generate_admin_form_fields($this->publish_post_meta_box_hidden_fields, 'array');
+		// add hidden fields
+		$this->_template_args['publish_hidden_fields'] = $this->_template_args['publish_hidden_fields'] ?? '';
+		foreach ($hidden_fields as $hidden_field) {
+			$this->_template_args['publish_hidden_fields'] .= $hidden_field['field'] ?? '';
+		}
+	}
+
+
+	/**
+	 * @param string|null $name
+	 * @param int|string  $id
+	 * @param string|null $delete
+	 * @param string|null $save_close_redirect_URL
+	 * @param bool        $both_btns
+	 * @throws EE_Error
+	 */
+	public function set_publish_post_box_vars(
+		?string $name = '',
+		$id = 0,
+		?string $delete = '',
+		?string $save_close_redirect_URL = '',
+		bool $both_btns = false
+	) {
+		$this->_set_publish_post_box_vars($name, $id, $delete, $save_close_redirect_URL, $both_btns);
+	}
+
+
+	protected function addPublishPostMetaBoxHiddenFields(string $field_name, array $field_attributes)
+	{
+		$this->publish_post_meta_box_hidden_fields[ $field_name ] = $field_attributes;
+	}
+
+
+	/**
+	 * displays an error message to ppl who have javascript disabled
+	 *
+	 * @return void
+	 */
+	private function _display_no_javascript_warning()
+	{
+		?>
 <noscript>
 	<div id="no-js-message" class="error">
 		<p style="font-size:1.3em;">
 			<span style="color:red;"><?php esc_html_e('Warning!', 'event_espresso'); ?></span>
 			<?php esc_html_e(
-                        'Javascript is currently turned off for your browser. Javascript must be enabled in order for all of the features on this page to function properly. Please turn your javascript back on.',
-                        'event_espresso'
-                    ); ?>
+						'Javascript is currently turned off for your browser. Javascript must be enabled in order for all of the features on this page to function properly. Please turn your javascript back on.',
+						'event_espresso'
+					); ?>
 		</p>
 	</div>
 </noscript>
 <?php
-    }
-
-
-    /**
-     * displays espresso success and/or error notices
-     *
-     * @return void
-     */
-    protected function _display_espresso_notices()
-    {
-        $notices = (array) $this->_get_transient(true);
-        foreach ($notices as $notice) {
-            echo $notice ? stripslashes($notice) : '';
-        }
-    }
-
-
-    /**
-     * spinny things pacify the masses
-     *
-     * @return void
-     */
-    protected function _add_admin_page_ajax_loading_img()
-    {
-        ?>
+	}
+
+
+	/**
+	 * displays espresso success and/or error notices
+	 *
+	 * @return void
+	 */
+	protected function _display_espresso_notices()
+	{
+		$notices = (array) $this->_get_transient(true);
+		foreach ($notices as $notice) {
+			echo $notice ? stripslashes($notice) : '';
+		}
+	}
+
+
+	/**
+	 * spinny things pacify the masses
+	 *
+	 * @return void
+	 */
+	protected function _add_admin_page_ajax_loading_img()
+	{
+		?>
 <div id="espresso-ajax-loading" class="ajax-loading-grey">
 	<span class="ee-spinner ee-spin"></span><span class="hidden"><?php
-                esc_html_e('loading...', 'event_espresso'); ?></span>
+				esc_html_e('loading...', 'event_espresso'); ?></span>
 </div>
 <?php
-    }
+	}
 
 
-    /**
-     * add admin page overlay for modal boxes
-     *
-     * @return void
-     */
-    protected function _add_admin_page_overlay()
-    {
-        ?>
+	/**
+	 * add admin page overlay for modal boxes
+	 *
+	 * @return void
+	 */
+	protected function _add_admin_page_overlay()
+	{
+		?>
 <div id="espresso-admin-page-overlay-dv" class=""></div>
 <?php
-    }
-
-
-    /**
-     * facade for $this->addMetaBox()
-     *
-     * @param string   $action        where the metabox gets displayed
-     * @param string   $title         Title of Metabox (output in metabox header)
-     * @param callable $callback      If not empty and $create_fun is set to false then we'll use a custom callback
-     *                                instead of the one created in here.
-     * @param array    $callback_args an array of args supplied for the metabox
-     * @param string   $column        what metabox column
-     * @param string   $priority      give this metabox a priority (using accepted priorities for wp meta boxes)
-     * @param bool     $create_func   default is true.  Basically we can say we don't WANT to have the runtime function
-     *                                created but just set our own callback for wp's add_meta_box.
-     * @throws DomainException
-     */
-    public function _add_admin_page_meta_box(
-        string $action,
-        string $title,
-        callable $callback,
-        array $callback_args,
-        string $column = 'normal',
-        string $priority = 'high',
-        bool $create_func = true
-    ) {
-        // if we have empty callback args and we want to automatically create the metabox callback then we need to make sure the callback args are generated.
-        if (empty($callback_args) && $create_func) {
-            $callback_args = [
-                'template_path' => $this->_template_path,
-                'template_args' => $this->_template_args,
-            ];
-        }
-        // if $create_func is true (default) then we automatically create the function for displaying the actual meta box.  If false then we take the $callback reference passed through and use it instead (so callers can define their own callback function/method if they wish)
-        $call_back_func = $create_func
-            ? static function ($post, $metabox) {
-                do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-                echo EEH_Template::display_template(
-                    $metabox['args']['template_path'],
-                    $metabox['args']['template_args'],
-                    true
-                );
-            }
-            : $callback;
-        $this->addMetaBox(
-            str_replace('_', '-', $action) . '-mbox',
-            $title,
-            $call_back_func,
-            $this->_wp_page_slug,
-            $column,
-            $priority,
-            $callback_args
-        );
-    }
-
-
-    /**
-     * generates HTML wrapper for and admin details page that contains metaboxes in columns
-     *
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function display_admin_page_with_metabox_columns()
-    {
-        $this->_template_args['post_body_content']  = $this->_template_args['admin_page_content'];
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            $this->_column_template_path,
-            $this->_template_args,
-            true
-        );
-        // the final wrapper
-        $this->admin_page_wrapper();
-    }
-
-
-    /**
-     * generates  HTML wrapper for an admin details page
-     *
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function display_admin_page_with_sidebar()
-    {
-        $this->_display_admin_page(true);
-    }
-
-
-    /**
-     * generates  HTML wrapper for an admin details page (except no sidebar)
-     *
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function display_admin_page_with_no_sidebar()
-    {
-        $this->_display_admin_page();
-    }
-
-
-    /**
-     * generates HTML wrapper for an EE about admin page (no sidebar)
-     *
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function display_about_admin_page()
-    {
-        $this->_display_admin_page(false, true);
-    }
-
-
-    /**
-     * display_admin_page
-     * contains the code for actually displaying an admin page
-     *
-     * @param bool $sidebar true with sidebar, false without
-     * @param bool $about   use the about admin wrapper instead of the default.
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _display_admin_page(bool $sidebar = false, bool $about = false): void
-    {
-        // custom remove metaboxes hook to add or remove any metaboxes to/from Admin pages.
-        do_action('AHEE__EE_Admin_Page___display_admin_page__modify_metaboxes');
-
-        // set current wp page slug - looks like: event-espresso_page_event_categories
-        // keep in mind "event-espresso" COULD be something else if the top level menu label has been translated.
-        $post_body_content = $this->_template_args['before_admin_page_content'] ?? '';
-
-        $this->_template_args['add_page_frame'] = $this->_req_action !== 'system_status'
-                                                  && $this->_req_action !== 'data_reset'
-                                                  && $this->_wp_page_slug !== 'event-espresso_page_espresso_packages'
-                                                  && strpos($post_body_content, 'wp-list-table') === false;
-
-        $this->_template_args['current_page']                 = $this->_wp_page_slug;
-        $this->_template_args['admin_page_wrapper_div_id']    = $this->_cpt_route
-            ? 'poststuff'
-            : 'espresso-default-admin';
-        $this->_template_args['admin_page_wrapper_div_class'] = str_replace(
-                                                                    'event-espresso_page_espresso_',
-                                                                    '',
-                                                                    $this->_wp_page_slug
-                                                                ) . ' ' . $this->_req_action . '-route';
-
-        $template_path = $sidebar
-            ? EE_ADMIN_TEMPLATE . 'admin_details_wrapper.template.php'
-            : EE_ADMIN_TEMPLATE . 'admin_details_wrapper_no_sidebar.template.php';
-        if ($this->request->isAjax()) {
-            $template_path = EE_ADMIN_TEMPLATE . 'admin_details_wrapper_no_sidebar_ajax.template.php';
-        }
-        $template_path = ! empty($this->_column_template_path) ? $this->_column_template_path : $template_path;
-
-        $this->_template_args['post_body_content']         = $this->_template_args['admin_page_content'] ?? '';
-        $this->_template_args['before_admin_page_content'] = $post_body_content;
-        $this->_template_args['after_admin_page_content']  = $this->_template_args['after_admin_page_content'] ?? '';
-        $this->_template_args['admin_page_content']        = EEH_Template::display_template(
-            $template_path,
-            $this->_template_args,
-            true
-        );
-        // the final template wrapper
-        $this->admin_page_wrapper($about);
-    }
-
-
-    /**
-     * This is used to display caf preview pages.
-     *
-     * @param string $utm_campaign_source what is the key used for google analytics link
-     * @param bool   $display_sidebar     whether to use the sidebar template or the full template for the page.  TRUE
-     *                                    = SHOW sidebar, FALSE = no sidebar. Default no sidebar.
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @since 4.3.2
-     */
-    public function display_admin_caf_preview_page(string $utm_campaign_source = '', bool $display_sidebar = true)
-    {
-        // let's generate a default preview action button if there isn't one already present.
-        $this->_labels['buttons']['buy_now']           = esc_html__(
-            'Upgrade to Event Espresso 4 Right Now',
-            'event_espresso'
-        );
-        $buy_now_url                                   = add_query_arg(
-            [
-                'ee_ver'       => 'ee4',
-                'utm_source'   => 'ee4_plugin_admin',
-                'utm_medium'   => 'link',
-                'utm_campaign' => $utm_campaign_source,
-                'utm_content'  => 'buy_now_button',
-            ],
-            'https://eventespresso.com/pricing/'
-        );
-        $this->_template_args['preview_action_button'] = ! isset($this->_template_args['preview_action_button'])
-            ? $this->get_action_link_or_button(
-                '',
-                'buy_now',
-                [],
-                'button button--primary button--big',
-                esc_url_raw($buy_now_url),
-                true
-            )
-            : $this->_template_args['preview_action_button'];
-        $this->_template_args['admin_page_content']    = EEH_Template::display_template(
-            EE_ADMIN_TEMPLATE . 'admin_caf_full_page_preview.template.php',
-            $this->_template_args,
-            true
-        );
-        $this->_display_admin_page($display_sidebar);
-    }
-
-
-    /**
-     * display_admin_list_table_page_with_sidebar
-     * generates HTML wrapper for an admin_page with list_table
-     *
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function display_admin_list_table_page_with_sidebar()
-    {
-        $this->_display_admin_list_table_page(true);
-    }
-
-
-    /**
-     * display_admin_list_table_page_with_no_sidebar
-     * generates HTML wrapper for an admin_page with list_table (but with no sidebar)
-     *
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function display_admin_list_table_page_with_no_sidebar()
-    {
-        $this->_display_admin_list_table_page();
-    }
-
-
-    /**
-     * generates html wrapper for an admin_list_table page
-     *
-     * @param bool $sidebar whether to display with sidebar or not.
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _display_admin_list_table_page(bool $sidebar = false)
-    {
-        // setup search attributes
-        $this->_set_search_attributes();
-        $this->_template_args['current_page']     = $this->_wp_page_slug;
-        $template_path                            = EE_ADMIN_TEMPLATE . 'admin_list_wrapper.template.php';
-        $this->_template_args['table_url']        = $this->request->isAjax()
-            ? add_query_arg(['noheader' => 'true', 'route' => $this->_req_action], $this->_admin_base_url)
-            : add_query_arg(['route' => $this->_req_action], $this->_admin_base_url);
-        $this->_template_args['list_table']       = $this->_list_table_object;
-        $this->_template_args['current_route']    = $this->_req_action;
-        $this->_template_args['list_table_class'] = get_class($this->_list_table_object);
-        $ajax_sorting_callback                    = $this->_list_table_object->get_ajax_sorting_callback();
-        if (! empty($ajax_sorting_callback)) {
-            $sortable_list_table_form_fields = wp_nonce_field(
-                $ajax_sorting_callback . '_nonce',
-                $ajax_sorting_callback . '_nonce',
-                false,
-                false
-            );
-            $sortable_list_table_form_fields .= '<input type="hidden" id="ajax_table_sort_page" name="ajax_table_sort_page" value="'
-                                                . $this->page_slug
-                                                . '" />';
-            $sortable_list_table_form_fields .= '<input type="hidden" id="ajax_table_sort_action" name="ajax_table_sort_action" value="'
-                                                . $ajax_sorting_callback
-                                                . '" />';
-        } else {
-            $sortable_list_table_form_fields = '';
-        }
-        $this->_template_args['sortable_list_table_form_fields'] = $sortable_list_table_form_fields;
-
-        $hidden_form_fields = $this->_template_args['list_table_hidden_fields'] ?? '';
-
-        $nonce_ref          = $this->_req_action . '_nonce';
-        $hidden_form_fields .= '
+	}
+
+
+	/**
+	 * facade for $this->addMetaBox()
+	 *
+	 * @param string   $action        where the metabox gets displayed
+	 * @param string   $title         Title of Metabox (output in metabox header)
+	 * @param callable $callback      If not empty and $create_fun is set to false then we'll use a custom callback
+	 *                                instead of the one created in here.
+	 * @param array    $callback_args an array of args supplied for the metabox
+	 * @param string   $column        what metabox column
+	 * @param string   $priority      give this metabox a priority (using accepted priorities for wp meta boxes)
+	 * @param bool     $create_func   default is true.  Basically we can say we don't WANT to have the runtime function
+	 *                                created but just set our own callback for wp's add_meta_box.
+	 * @throws DomainException
+	 */
+	public function _add_admin_page_meta_box(
+		string $action,
+		string $title,
+		callable $callback,
+		array $callback_args,
+		string $column = 'normal',
+		string $priority = 'high',
+		bool $create_func = true
+	) {
+		// if we have empty callback args and we want to automatically create the metabox callback then we need to make sure the callback args are generated.
+		if (empty($callback_args) && $create_func) {
+			$callback_args = [
+				'template_path' => $this->_template_path,
+				'template_args' => $this->_template_args,
+			];
+		}
+		// if $create_func is true (default) then we automatically create the function for displaying the actual meta box.  If false then we take the $callback reference passed through and use it instead (so callers can define their own callback function/method if they wish)
+		$call_back_func = $create_func
+			? static function ($post, $metabox) {
+				do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+				echo EEH_Template::display_template(
+					$metabox['args']['template_path'],
+					$metabox['args']['template_args'],
+					true
+				);
+			}
+			: $callback;
+		$this->addMetaBox(
+			str_replace('_', '-', $action) . '-mbox',
+			$title,
+			$call_back_func,
+			$this->_wp_page_slug,
+			$column,
+			$priority,
+			$callback_args
+		);
+	}
+
+
+	/**
+	 * generates HTML wrapper for and admin details page that contains metaboxes in columns
+	 *
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function display_admin_page_with_metabox_columns()
+	{
+		$this->_template_args['post_body_content']  = $this->_template_args['admin_page_content'];
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(
+			$this->_column_template_path,
+			$this->_template_args,
+			true
+		);
+		// the final wrapper
+		$this->admin_page_wrapper();
+	}
+
+
+	/**
+	 * generates  HTML wrapper for an admin details page
+	 *
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function display_admin_page_with_sidebar()
+	{
+		$this->_display_admin_page(true);
+	}
+
+
+	/**
+	 * generates  HTML wrapper for an admin details page (except no sidebar)
+	 *
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function display_admin_page_with_no_sidebar()
+	{
+		$this->_display_admin_page();
+	}
+
+
+	/**
+	 * generates HTML wrapper for an EE about admin page (no sidebar)
+	 *
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function display_about_admin_page()
+	{
+		$this->_display_admin_page(false, true);
+	}
+
+
+	/**
+	 * display_admin_page
+	 * contains the code for actually displaying an admin page
+	 *
+	 * @param bool $sidebar true with sidebar, false without
+	 * @param bool $about   use the about admin wrapper instead of the default.
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _display_admin_page(bool $sidebar = false, bool $about = false): void
+	{
+		// custom remove metaboxes hook to add or remove any metaboxes to/from Admin pages.
+		do_action('AHEE__EE_Admin_Page___display_admin_page__modify_metaboxes');
+
+		// set current wp page slug - looks like: event-espresso_page_event_categories
+		// keep in mind "event-espresso" COULD be something else if the top level menu label has been translated.
+		$post_body_content = $this->_template_args['before_admin_page_content'] ?? '';
+
+		$this->_template_args['add_page_frame'] = $this->_req_action !== 'system_status'
+												  && $this->_req_action !== 'data_reset'
+												  && $this->_wp_page_slug !== 'event-espresso_page_espresso_packages'
+												  && strpos($post_body_content, 'wp-list-table') === false;
+
+		$this->_template_args['current_page']                 = $this->_wp_page_slug;
+		$this->_template_args['admin_page_wrapper_div_id']    = $this->_cpt_route
+			? 'poststuff'
+			: 'espresso-default-admin';
+		$this->_template_args['admin_page_wrapper_div_class'] = str_replace(
+																	'event-espresso_page_espresso_',
+																	'',
+																	$this->_wp_page_slug
+																) . ' ' . $this->_req_action . '-route';
+
+		$template_path = $sidebar
+			? EE_ADMIN_TEMPLATE . 'admin_details_wrapper.template.php'
+			: EE_ADMIN_TEMPLATE . 'admin_details_wrapper_no_sidebar.template.php';
+		if ($this->request->isAjax()) {
+			$template_path = EE_ADMIN_TEMPLATE . 'admin_details_wrapper_no_sidebar_ajax.template.php';
+		}
+		$template_path = ! empty($this->_column_template_path) ? $this->_column_template_path : $template_path;
+
+		$this->_template_args['post_body_content']         = $this->_template_args['admin_page_content'] ?? '';
+		$this->_template_args['before_admin_page_content'] = $post_body_content;
+		$this->_template_args['after_admin_page_content']  = $this->_template_args['after_admin_page_content'] ?? '';
+		$this->_template_args['admin_page_content']        = EEH_Template::display_template(
+			$template_path,
+			$this->_template_args,
+			true
+		);
+		// the final template wrapper
+		$this->admin_page_wrapper($about);
+	}
+
+
+	/**
+	 * This is used to display caf preview pages.
+	 *
+	 * @param string $utm_campaign_source what is the key used for google analytics link
+	 * @param bool   $display_sidebar     whether to use the sidebar template or the full template for the page.  TRUE
+	 *                                    = SHOW sidebar, FALSE = no sidebar. Default no sidebar.
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @since 4.3.2
+	 */
+	public function display_admin_caf_preview_page(string $utm_campaign_source = '', bool $display_sidebar = true)
+	{
+		// let's generate a default preview action button if there isn't one already present.
+		$this->_labels['buttons']['buy_now']           = esc_html__(
+			'Upgrade to Event Espresso 4 Right Now',
+			'event_espresso'
+		);
+		$buy_now_url                                   = add_query_arg(
+			[
+				'ee_ver'       => 'ee4',
+				'utm_source'   => 'ee4_plugin_admin',
+				'utm_medium'   => 'link',
+				'utm_campaign' => $utm_campaign_source,
+				'utm_content'  => 'buy_now_button',
+			],
+			'https://eventespresso.com/pricing/'
+		);
+		$this->_template_args['preview_action_button'] = ! isset($this->_template_args['preview_action_button'])
+			? $this->get_action_link_or_button(
+				'',
+				'buy_now',
+				[],
+				'button button--primary button--big',
+				esc_url_raw($buy_now_url),
+				true
+			)
+			: $this->_template_args['preview_action_button'];
+		$this->_template_args['admin_page_content']    = EEH_Template::display_template(
+			EE_ADMIN_TEMPLATE . 'admin_caf_full_page_preview.template.php',
+			$this->_template_args,
+			true
+		);
+		$this->_display_admin_page($display_sidebar);
+	}
+
+
+	/**
+	 * display_admin_list_table_page_with_sidebar
+	 * generates HTML wrapper for an admin_page with list_table
+	 *
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function display_admin_list_table_page_with_sidebar()
+	{
+		$this->_display_admin_list_table_page(true);
+	}
+
+
+	/**
+	 * display_admin_list_table_page_with_no_sidebar
+	 * generates HTML wrapper for an admin_page with list_table (but with no sidebar)
+	 *
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function display_admin_list_table_page_with_no_sidebar()
+	{
+		$this->_display_admin_list_table_page();
+	}
+
+
+	/**
+	 * generates html wrapper for an admin_list_table page
+	 *
+	 * @param bool $sidebar whether to display with sidebar or not.
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _display_admin_list_table_page(bool $sidebar = false)
+	{
+		// setup search attributes
+		$this->_set_search_attributes();
+		$this->_template_args['current_page']     = $this->_wp_page_slug;
+		$template_path                            = EE_ADMIN_TEMPLATE . 'admin_list_wrapper.template.php';
+		$this->_template_args['table_url']        = $this->request->isAjax()
+			? add_query_arg(['noheader' => 'true', 'route' => $this->_req_action], $this->_admin_base_url)
+			: add_query_arg(['route' => $this->_req_action], $this->_admin_base_url);
+		$this->_template_args['list_table']       = $this->_list_table_object;
+		$this->_template_args['current_route']    = $this->_req_action;
+		$this->_template_args['list_table_class'] = get_class($this->_list_table_object);
+		$ajax_sorting_callback                    = $this->_list_table_object->get_ajax_sorting_callback();
+		if (! empty($ajax_sorting_callback)) {
+			$sortable_list_table_form_fields = wp_nonce_field(
+				$ajax_sorting_callback . '_nonce',
+				$ajax_sorting_callback . '_nonce',
+				false,
+				false
+			);
+			$sortable_list_table_form_fields .= '<input type="hidden" id="ajax_table_sort_page" name="ajax_table_sort_page" value="'
+												. $this->page_slug
+												. '" />';
+			$sortable_list_table_form_fields .= '<input type="hidden" id="ajax_table_sort_action" name="ajax_table_sort_action" value="'
+												. $ajax_sorting_callback
+												. '" />';
+		} else {
+			$sortable_list_table_form_fields = '';
+		}
+		$this->_template_args['sortable_list_table_form_fields'] = $sortable_list_table_form_fields;
+
+		$hidden_form_fields = $this->_template_args['list_table_hidden_fields'] ?? '';
+
+		$nonce_ref          = $this->_req_action . '_nonce';
+		$hidden_form_fields .= '
             <input type="hidden" name="' . $nonce_ref . '" value="' . wp_create_nonce($nonce_ref) . '">';
 
-        $this->_template_args['list_table_hidden_fields'] = $hidden_form_fields;
-        // display message about search results?
-        $search                                    = $this->request->getRequestParam('s');
-        $this->_template_args['before_list_table'] .= ! empty($search)
-            ? '<p class="ee-search-results">' . sprintf(
-                esc_html__('Displaying search results for the search string: %1$s', 'event_espresso'),
-                trim($search, '%')
-            ) . '</p>'
-            : '';
-        // filter before_list_table template arg
-        $this->_template_args['before_list_table'] = apply_filters(
-            'FHEE__EE_Admin_Page___display_admin_list_table_page__before_list_table__template_arg',
-            $this->_template_args['before_list_table'],
-            $this->page_slug,
-            $this->request->requestParams(),
-            $this->_req_action
-        );
-        // convert to array and filter again
-        // arrays are easier to inject new items in a specific location,
-        // but would not be backwards compatible, so we have to add a new filter
-        $this->_template_args['before_list_table'] = implode(
-            " \n",
-            (array) apply_filters(
-                'FHEE__EE_Admin_Page___display_admin_list_table_page__before_list_table__template_args_array',
-                (array) $this->_template_args['before_list_table'],
-                $this->page_slug,
-                $this->request->requestParams(),
-                $this->_req_action
-            )
-        );
-        // filter after_list_table template arg
-        $this->_template_args['after_list_table'] = apply_filters(
-            'FHEE__EE_Admin_Page___display_admin_list_table_page__after_list_table__template_arg',
-            $this->_template_args['after_list_table'],
-            $this->page_slug,
-            $this->request->requestParams(),
-            $this->_req_action
-        );
-        // convert to array and filter again
-        // arrays are easier to inject new items in a specific location,
-        // but would not be backwards compatible, so we have to add a new filter
-        $this->_template_args['after_list_table']   = implode(
-            " \n",
-            (array) apply_filters(
-                'FHEE__EE_Admin_Page___display_admin_list_table_page__after_list_table__template_args_array',
-                (array) $this->_template_args['after_list_table'],
-                $this->page_slug,
-                $this->request->requestParams(),
-                $this->_req_action
-            )
-        );
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            $template_path,
-            $this->_template_args,
-            true
-        );
-        // the final template wrapper
-        if ($sidebar) {
-            $this->display_admin_page_with_sidebar();
-        } else {
-            $this->display_admin_page_with_no_sidebar();
-        }
-    }
-
-
-    /**
-     * This just prepares a legend using the given items and the admin_details_legend.template.php file and returns the
-     * html string for the legend.
-     * $items are expected in an array in the following format:
-     * $legend_items = array(
-     *        'item_id' => array(
-     *            'icon' => 'http://url_to_icon_being_described.png',
-     *            'desc' => esc_html__('localized description of item');
-     *        )
-     * );
-     *
-     * @param array $items see above for format of array
-     * @return string html string of legend
-     * @throws DomainException
-     */
-    protected function _display_legend(array $items): string
-    {
-        $this->_template_args['items'] = (array) apply_filters(
-            'FHEE__EE_Admin_Page___display_legend__items',
-            $items,
-            $this
-        );
-        /** @var StatusChangeNotice $status_change_notice */
-        $status_change_notice                         = $this->loader->getShared(
-            'EventEspresso\core\domain\services\admin\notices\status_change\StatusChangeNotice'
-        );
-        $this->_template_args['status_change_notice'] = $status_change_notice->display(
-            '__admin-legend',
-            $this->page_slug
-        );
-        return EEH_Template::display_template(
-            EE_ADMIN_TEMPLATE . 'admin_details_legend.template.php',
-            $this->_template_args,
-            true
-        );
-    }
-
-
-    /**
-     * This is used whenever we're DOING_AJAX to return a formatted json array that our calling javascript can expect
-     * The returned json object is created from an array in the following format:
-     * array(
-     *  'error' => FALSE, //(default FALSE), contains any errors and/or exceptions (exceptions return json early),
-     *  'success' => FALSE, //(default FALSE) - contains any special success message.
-     *  'notices' => '', // - contains any EE_Error formatted notices
-     *  'content' => 'string can be html', //this is a string of formatted content (can be html)
-     *  'data' => array() //this can be any key/value pairs that a method returns for later json parsing by the js.
-     *  We're also going to include the template args with every package (so js can pick out any specific template args
-     *  that might be included in here)
-     * )
-     * The json object is populated by whatever is set in the $_template_args property.
-     *
-     * @param bool  $sticky_notices    Used to indicate whether you want to ensure notices are added to a transient
-     *                                 instead of displayed.
-     * @param array $notices_arguments Use this to pass any additional args on to the _process_notices.
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _return_json(bool $sticky_notices = false, array $notices_arguments = [])
-    {
-        // make sure any EE_Error notices have been handled.
-        $this->_process_notices($notices_arguments, true, $sticky_notices);
-        $data = $this->_template_args['data'] ?? [];
-        unset($this->_template_args['data']);
-        $json = [
-            'error'     => $this->_template_args['error'] ?? false,
-            'success'   => $this->_template_args['success'] ?? false,
-            'errors'    => $this->_template_args['errors'] ?? false,
-            'attention' => $this->_template_args['attention'] ?? false,
-            'notices'   => EE_Error::get_notices(),
-            'content'   => $this->_template_args['admin_page_content'] ?? '',
-            'data'      => array_merge($data, ['template_args' => $this->_template_args]),
-            'isEEajax'  => true,
-            // special flag so any ajax.Success methods in js can identify this return package as a EEajax package.
-        ];
-        // make sure there are no php errors or headers_sent.  Then we can set correct json header.
-        if (null === error_get_last() || ! headers_sent()) {
-            header('Content-Type: application/json; charset=UTF-8');
-        }
-        echo wp_json_encode($json);
-        exit();
-    }
-
-
-    /**
-     * Simply a wrapper for the protected method so we can call this outside the class (ONLY when doing ajax)
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function return_json()
-    {
-        if ($this->request->isAjax()) {
-            $this->_return_json();
-        } else {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__('The public %s method can only be called when DOING_AJAX = TRUE', 'event_espresso'),
-                    __FUNCTION__
-                )
-            );
-        }
-    }
-
-
-    /**
-     * This provides a way for child hook classes to send along themselves by reference so methods/properties within
-     * them can be accessed by EE_Admin_child pages. This is assigned to the $_hook_obj property.
-     *
-     * @param EE_Admin_Hooks $hook_obj This will be the object for the EE_Admin_Hooks child
-     * @deprecated  5.0.8.p
-     */
-    public function set_hook_object(EE_Admin_Hooks $hook_obj)
-    {
-        $this->_hook_obj = $hook_obj;
-    }
-
-
-    /**
-     *        generates  HTML wrapper with Tabbed nav for an admin page
-     *
-     * @param bool $about whether to use the special about page wrapper or default.
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function admin_page_wrapper(bool $about = false)
-    {
-        $this->_template_args['nav_tabs']         = $this->_get_main_nav_tabs();
-        $this->_template_args['admin_page_title'] = $this->_admin_page_title;
-
-        $this->_template_args['before_admin_page_content'] = apply_filters(
-            "FHEE_before_admin_page_content$this->_current_page$this->_current_view",
-            $this->_template_args['before_admin_page_content'] ?? ''
-        );
-
-        $this->_template_args['after_admin_page_content'] = apply_filters(
-            "FHEE_after_admin_page_content$this->_current_page$this->_current_view",
-            $this->_template_args['after_admin_page_content'] ?? ''
-        );
-        $this->_template_args['after_admin_page_content'] .= $this->_set_help_popup_content();
-
-        if ($this->request->isAjax()) {
-            $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            // $template_path,
-                EE_ADMIN_TEMPLATE . 'admin_wrapper_ajax.template.php',
-                $this->_template_args,
-                true
-            );
-            $this->_return_json();
-        }
-        // load settings page wrapper template
-        $template_path = $about
-            ? EE_ADMIN_TEMPLATE . 'about_admin_wrapper.template.php'
-            : EE_ADMIN_TEMPLATE . 'admin_wrapper.template.php';
-
-        EEH_Template::display_template($template_path, $this->_template_args);
-    }
-
-
-    /**
-     * This returns the admin_nav tabs html using the configuration in the _nav_tabs property
-     *
-     * @return string html
-     * @throws EE_Error
-     */
-    protected function _get_main_nav_tabs(): string
-    {
-        // let's generate the html using the EEH_Tabbed_Content helper.
-        // We do this here so that it's possible for child classes to add in nav tabs dynamically at the last minute
-        // (rather than setting in the page_routes array)
-        return EEH_Tabbed_Content::display_admin_nav_tabs($this->_nav_tabs, $this->page_slug);
-    }
-
-
-    /**
-     *        sort nav tabs
-     *
-     * @param array $a
-     * @param array $b
-     * @return int
-     */
-    private function _sort_nav_tabs(array $a, array $b): int
-    {
-        if ($a['order'] === $b['order']) {
-            return 0;
-        }
-        return ($a['order'] < $b['order']) ? -1 : 1;
-    }
-
-
-    /**
-     * generates HTML for the forms used on admin pages
-     *
-     * @param array  $input_vars - array of input field details
-     * @param string $generator  indicates which generator to use: options are 'string' or 'array'
-     * @param bool   $id
-     * @return array|string
-     * @uses   EEH_Form_Fields::get_form_fields (/helper/EEH_Form_Fields.helper.php)
-     * @uses   EEH_Form_Fields::get_form_fields_array (/helper/EEH_Form_Fields.helper.php)
-     */
-    protected function _generate_admin_form_fields(
-        array $input_vars = [],
-        string $generator = 'string',
-        bool $id = false
-    ) {
-        return $generator === 'string'
-            ? EEH_Form_Fields::get_form_fields($input_vars, $id)
-            : EEH_Form_Fields::get_form_fields_array($input_vars);
-    }
-
-
-    /**
-     * generates the "Save" and "Save & Close" buttons for edit forms
-     *
-     * @param bool             $both     if true then both buttons will be generated.  If false then just the "Save &
-     *                                   Close" button.
-     * @param array            $text     if included, generator will use the given text for the buttons ( array([0] =>
-     *                                   'Save', [1] => 'save & close')
-     * @param array            $actions  if included allows us to set the actions that each button will carry out (i.e.
-     *                                   via the "name" value in the button).  We can also use this to just dump
-     *                                   default actions by submitting some other value.
-     * @param bool|string|null $referrer if false then we just do the default action on save and close.  Other wise it
-     *                                   will use the $referrer string. IF null, then we don't do ANYTHING on save and
-     *                                   close (normal form handling).
-     */
-    protected function _set_save_buttons(bool $both = true, array $text = [], array $actions = [], $referrer = null)
-    {
-        $referrer_url  = ! empty($referrer) ? $referrer : $this->request->getServerParam('REQUEST_URI');
-        $button_text   = ! empty($text)
-            ? $text
-            : [
-                esc_html__('Save', 'event_espresso'),
-                esc_html__('Save and Close', 'event_espresso'),
-            ];
-        $default_names = ['save', 'save_and_close'];
-        $buttons       = '';
-        foreach ($button_text as $key => $button) {
-            $ref     = $default_names[ $key ];
-            $name    = ! empty($actions) ? $actions[ $key ] : $ref;
-            $buttons .= '<input type="submit" class="button button--primary ' . $ref . '" '
-                        . 'value="' . $button . '" name="' . $name . '" '
-                        . 'id="' . $this->_current_view . '_' . $ref . '" />';
-            if (! $both) {
-                break;
-            }
-        }
-        // add in a hidden index for the current page (so save and close redirects properly)
-        $buttons .= '<input type="hidden" id="save_and_close_referrer" name="save_and_close_referrer" value="'
-                    . $referrer_url
-                    . '" />';
-
-        $this->_template_args['save_buttons'] = $buttons;
-    }
-
-
-    /**
-     * Wrapper for the protected function.  Allows plugins/addons to call this to set the form tags.
-     *
-     * @param string $route
-     * @param array  $additional_hidden_fields
-     * @see   $this->_set_add_edit_form_tags() for details on params
-     * @since 4.6.0
-     */
-    public function set_add_edit_form_tags(string $route = '', array $additional_hidden_fields = [])
-    {
-        $this->_set_add_edit_form_tags($route, $additional_hidden_fields);
-    }
-
-
-    /**
-     * set form open and close tags on add/edit pages.
-     *
-     * @param string $route                    the route you want the form to direct to
-     * @param array  $additional_hidden_fields any additional hidden fields required in the form header
-     * @return void
-     */
-    protected function _set_add_edit_form_tags(string $route = '', array $additional_hidden_fields = [])
-    {
-        if (empty($route)) {
-            $user_msg = esc_html__(
-                'An error occurred. No action was set for this page\'s form.',
-                'event_espresso'
-            );
-            $dev_msg  = $user_msg . "\n"
-                        . sprintf(
-                            esc_html__('The $route argument is required for the %s->%s method.', 'event_espresso'),
-                            __FUNCTION__,
-                            __CLASS__
-                        );
-            EE_Error::add_error($user_msg . '||' . $dev_msg, __FILE__, __FUNCTION__, __LINE__);
-        }
-        // open form
-        $action                                            = $this->_admin_base_url;
-        $this->_template_args['before_admin_page_content'] = "
+		$this->_template_args['list_table_hidden_fields'] = $hidden_form_fields;
+		// display message about search results?
+		$search                                    = $this->request->getRequestParam('s');
+		$this->_template_args['before_list_table'] .= ! empty($search)
+			? '<p class="ee-search-results">' . sprintf(
+				esc_html__('Displaying search results for the search string: %1$s', 'event_espresso'),
+				trim($search, '%')
+			) . '</p>'
+			: '';
+		// filter before_list_table template arg
+		$this->_template_args['before_list_table'] = apply_filters(
+			'FHEE__EE_Admin_Page___display_admin_list_table_page__before_list_table__template_arg',
+			$this->_template_args['before_list_table'],
+			$this->page_slug,
+			$this->request->requestParams(),
+			$this->_req_action
+		);
+		// convert to array and filter again
+		// arrays are easier to inject new items in a specific location,
+		// but would not be backwards compatible, so we have to add a new filter
+		$this->_template_args['before_list_table'] = implode(
+			" \n",
+			(array) apply_filters(
+				'FHEE__EE_Admin_Page___display_admin_list_table_page__before_list_table__template_args_array',
+				(array) $this->_template_args['before_list_table'],
+				$this->page_slug,
+				$this->request->requestParams(),
+				$this->_req_action
+			)
+		);
+		// filter after_list_table template arg
+		$this->_template_args['after_list_table'] = apply_filters(
+			'FHEE__EE_Admin_Page___display_admin_list_table_page__after_list_table__template_arg',
+			$this->_template_args['after_list_table'],
+			$this->page_slug,
+			$this->request->requestParams(),
+			$this->_req_action
+		);
+		// convert to array and filter again
+		// arrays are easier to inject new items in a specific location,
+		// but would not be backwards compatible, so we have to add a new filter
+		$this->_template_args['after_list_table']   = implode(
+			" \n",
+			(array) apply_filters(
+				'FHEE__EE_Admin_Page___display_admin_list_table_page__after_list_table__template_args_array',
+				(array) $this->_template_args['after_list_table'],
+				$this->page_slug,
+				$this->request->requestParams(),
+				$this->_req_action
+			)
+		);
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(
+			$template_path,
+			$this->_template_args,
+			true
+		);
+		// the final template wrapper
+		if ($sidebar) {
+			$this->display_admin_page_with_sidebar();
+		} else {
+			$this->display_admin_page_with_no_sidebar();
+		}
+	}
+
+
+	/**
+	 * This just prepares a legend using the given items and the admin_details_legend.template.php file and returns the
+	 * html string for the legend.
+	 * $items are expected in an array in the following format:
+	 * $legend_items = array(
+	 *        'item_id' => array(
+	 *            'icon' => 'http://url_to_icon_being_described.png',
+	 *            'desc' => esc_html__('localized description of item');
+	 *        )
+	 * );
+	 *
+	 * @param array $items see above for format of array
+	 * @return string html string of legend
+	 * @throws DomainException
+	 */
+	protected function _display_legend(array $items): string
+	{
+		$this->_template_args['items'] = (array) apply_filters(
+			'FHEE__EE_Admin_Page___display_legend__items',
+			$items,
+			$this
+		);
+		/** @var StatusChangeNotice $status_change_notice */
+		$status_change_notice                         = $this->loader->getShared(
+			'EventEspresso\core\domain\services\admin\notices\status_change\StatusChangeNotice'
+		);
+		$this->_template_args['status_change_notice'] = $status_change_notice->display(
+			'__admin-legend',
+			$this->page_slug
+		);
+		return EEH_Template::display_template(
+			EE_ADMIN_TEMPLATE . 'admin_details_legend.template.php',
+			$this->_template_args,
+			true
+		);
+	}
+
+
+	/**
+	 * This is used whenever we're DOING_AJAX to return a formatted json array that our calling javascript can expect
+	 * The returned json object is created from an array in the following format:
+	 * array(
+	 *  'error' => FALSE, //(default FALSE), contains any errors and/or exceptions (exceptions return json early),
+	 *  'success' => FALSE, //(default FALSE) - contains any special success message.
+	 *  'notices' => '', // - contains any EE_Error formatted notices
+	 *  'content' => 'string can be html', //this is a string of formatted content (can be html)
+	 *  'data' => array() //this can be any key/value pairs that a method returns for later json parsing by the js.
+	 *  We're also going to include the template args with every package (so js can pick out any specific template args
+	 *  that might be included in here)
+	 * )
+	 * The json object is populated by whatever is set in the $_template_args property.
+	 *
+	 * @param bool  $sticky_notices    Used to indicate whether you want to ensure notices are added to a transient
+	 *                                 instead of displayed.
+	 * @param array $notices_arguments Use this to pass any additional args on to the _process_notices.
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _return_json(bool $sticky_notices = false, array $notices_arguments = [])
+	{
+		// make sure any EE_Error notices have been handled.
+		$this->_process_notices($notices_arguments, true, $sticky_notices);
+		$data = $this->_template_args['data'] ?? [];
+		unset($this->_template_args['data']);
+		$json = [
+			'error'     => $this->_template_args['error'] ?? false,
+			'success'   => $this->_template_args['success'] ?? false,
+			'errors'    => $this->_template_args['errors'] ?? false,
+			'attention' => $this->_template_args['attention'] ?? false,
+			'notices'   => EE_Error::get_notices(),
+			'content'   => $this->_template_args['admin_page_content'] ?? '',
+			'data'      => array_merge($data, ['template_args' => $this->_template_args]),
+			'isEEajax'  => true,
+			// special flag so any ajax.Success methods in js can identify this return package as a EEajax package.
+		];
+		// make sure there are no php errors or headers_sent.  Then we can set correct json header.
+		if (null === error_get_last() || ! headers_sent()) {
+			header('Content-Type: application/json; charset=UTF-8');
+		}
+		echo wp_json_encode($json);
+		exit();
+	}
+
+
+	/**
+	 * Simply a wrapper for the protected method so we can call this outside the class (ONLY when doing ajax)
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function return_json()
+	{
+		if ($this->request->isAjax()) {
+			$this->_return_json();
+		} else {
+			throw new EE_Error(
+				sprintf(
+					esc_html__('The public %s method can only be called when DOING_AJAX = TRUE', 'event_espresso'),
+					__FUNCTION__
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * This provides a way for child hook classes to send along themselves by reference so methods/properties within
+	 * them can be accessed by EE_Admin_child pages. This is assigned to the $_hook_obj property.
+	 *
+	 * @param EE_Admin_Hooks $hook_obj This will be the object for the EE_Admin_Hooks child
+	 * @deprecated  5.0.8.p
+	 */
+	public function set_hook_object(EE_Admin_Hooks $hook_obj)
+	{
+		$this->_hook_obj = $hook_obj;
+	}
+
+
+	/**
+	 *        generates  HTML wrapper with Tabbed nav for an admin page
+	 *
+	 * @param bool $about whether to use the special about page wrapper or default.
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function admin_page_wrapper(bool $about = false)
+	{
+		$this->_template_args['nav_tabs']         = $this->_get_main_nav_tabs();
+		$this->_template_args['admin_page_title'] = $this->_admin_page_title;
+
+		$this->_template_args['before_admin_page_content'] = apply_filters(
+			"FHEE_before_admin_page_content$this->_current_page$this->_current_view",
+			$this->_template_args['before_admin_page_content'] ?? ''
+		);
+
+		$this->_template_args['after_admin_page_content'] = apply_filters(
+			"FHEE_after_admin_page_content$this->_current_page$this->_current_view",
+			$this->_template_args['after_admin_page_content'] ?? ''
+		);
+		$this->_template_args['after_admin_page_content'] .= $this->_set_help_popup_content();
+
+		if ($this->request->isAjax()) {
+			$this->_template_args['admin_page_content'] = EEH_Template::display_template(
+			// $template_path,
+				EE_ADMIN_TEMPLATE . 'admin_wrapper_ajax.template.php',
+				$this->_template_args,
+				true
+			);
+			$this->_return_json();
+		}
+		// load settings page wrapper template
+		$template_path = $about
+			? EE_ADMIN_TEMPLATE . 'about_admin_wrapper.template.php'
+			: EE_ADMIN_TEMPLATE . 'admin_wrapper.template.php';
+
+		EEH_Template::display_template($template_path, $this->_template_args);
+	}
+
+
+	/**
+	 * This returns the admin_nav tabs html using the configuration in the _nav_tabs property
+	 *
+	 * @return string html
+	 * @throws EE_Error
+	 */
+	protected function _get_main_nav_tabs(): string
+	{
+		// let's generate the html using the EEH_Tabbed_Content helper.
+		// We do this here so that it's possible for child classes to add in nav tabs dynamically at the last minute
+		// (rather than setting in the page_routes array)
+		return EEH_Tabbed_Content::display_admin_nav_tabs($this->_nav_tabs, $this->page_slug);
+	}
+
+
+	/**
+	 *        sort nav tabs
+	 *
+	 * @param array $a
+	 * @param array $b
+	 * @return int
+	 */
+	private function _sort_nav_tabs(array $a, array $b): int
+	{
+		if ($a['order'] === $b['order']) {
+			return 0;
+		}
+		return ($a['order'] < $b['order']) ? -1 : 1;
+	}
+
+
+	/**
+	 * generates HTML for the forms used on admin pages
+	 *
+	 * @param array  $input_vars - array of input field details
+	 * @param string $generator  indicates which generator to use: options are 'string' or 'array'
+	 * @param bool   $id
+	 * @return array|string
+	 * @uses   EEH_Form_Fields::get_form_fields (/helper/EEH_Form_Fields.helper.php)
+	 * @uses   EEH_Form_Fields::get_form_fields_array (/helper/EEH_Form_Fields.helper.php)
+	 */
+	protected function _generate_admin_form_fields(
+		array $input_vars = [],
+		string $generator = 'string',
+		bool $id = false
+	) {
+		return $generator === 'string'
+			? EEH_Form_Fields::get_form_fields($input_vars, $id)
+			: EEH_Form_Fields::get_form_fields_array($input_vars);
+	}
+
+
+	/**
+	 * generates the "Save" and "Save & Close" buttons for edit forms
+	 *
+	 * @param bool             $both     if true then both buttons will be generated.  If false then just the "Save &
+	 *                                   Close" button.
+	 * @param array            $text     if included, generator will use the given text for the buttons ( array([0] =>
+	 *                                   'Save', [1] => 'save & close')
+	 * @param array            $actions  if included allows us to set the actions that each button will carry out (i.e.
+	 *                                   via the "name" value in the button).  We can also use this to just dump
+	 *                                   default actions by submitting some other value.
+	 * @param bool|string|null $referrer if false then we just do the default action on save and close.  Other wise it
+	 *                                   will use the $referrer string. IF null, then we don't do ANYTHING on save and
+	 *                                   close (normal form handling).
+	 */
+	protected function _set_save_buttons(bool $both = true, array $text = [], array $actions = [], $referrer = null)
+	{
+		$referrer_url  = ! empty($referrer) ? $referrer : $this->request->getServerParam('REQUEST_URI');
+		$button_text   = ! empty($text)
+			? $text
+			: [
+				esc_html__('Save', 'event_espresso'),
+				esc_html__('Save and Close', 'event_espresso'),
+			];
+		$default_names = ['save', 'save_and_close'];
+		$buttons       = '';
+		foreach ($button_text as $key => $button) {
+			$ref     = $default_names[ $key ];
+			$name    = ! empty($actions) ? $actions[ $key ] : $ref;
+			$buttons .= '<input type="submit" class="button button--primary ' . $ref . '" '
+						. 'value="' . $button . '" name="' . $name . '" '
+						. 'id="' . $this->_current_view . '_' . $ref . '" />';
+			if (! $both) {
+				break;
+			}
+		}
+		// add in a hidden index for the current page (so save and close redirects properly)
+		$buttons .= '<input type="hidden" id="save_and_close_referrer" name="save_and_close_referrer" value="'
+					. $referrer_url
+					. '" />';
+
+		$this->_template_args['save_buttons'] = $buttons;
+	}
+
+
+	/**
+	 * Wrapper for the protected function.  Allows plugins/addons to call this to set the form tags.
+	 *
+	 * @param string $route
+	 * @param array  $additional_hidden_fields
+	 * @see   $this->_set_add_edit_form_tags() for details on params
+	 * @since 4.6.0
+	 */
+	public function set_add_edit_form_tags(string $route = '', array $additional_hidden_fields = [])
+	{
+		$this->_set_add_edit_form_tags($route, $additional_hidden_fields);
+	}
+
+
+	/**
+	 * set form open and close tags on add/edit pages.
+	 *
+	 * @param string $route                    the route you want the form to direct to
+	 * @param array  $additional_hidden_fields any additional hidden fields required in the form header
+	 * @return void
+	 */
+	protected function _set_add_edit_form_tags(string $route = '', array $additional_hidden_fields = [])
+	{
+		if (empty($route)) {
+			$user_msg = esc_html__(
+				'An error occurred. No action was set for this page\'s form.',
+				'event_espresso'
+			);
+			$dev_msg  = $user_msg . "\n"
+						. sprintf(
+							esc_html__('The $route argument is required for the %s->%s method.', 'event_espresso'),
+							__FUNCTION__,
+							__CLASS__
+						);
+			EE_Error::add_error($user_msg . '||' . $dev_msg, __FILE__, __FUNCTION__, __LINE__);
+		}
+		// open form
+		$action                                            = $this->_admin_base_url;
+		$this->_template_args['before_admin_page_content'] = "
             <form name='form' method='post' action='$action' id='{$route}_event_form' class='ee-admin-page-form' >
             ";
-        // add nonce
-        $nonce                                             =
-            wp_nonce_field($route . '_nonce', $route . '_nonce', false, false);
-        $this->_template_args['before_admin_page_content'] .= "\n\t" . $nonce;
-        // add REQUIRED form action
-        $hidden_fields = [
-            'action' => ['type' => 'hidden', 'value' => $route],
-        ];
-        // merge arrays
-        $hidden_fields = is_array($additional_hidden_fields)
-            ? array_merge($hidden_fields, $additional_hidden_fields)
-            : $hidden_fields;
-        // generate form fields
-        $form_fields = $this->_generate_admin_form_fields($hidden_fields, 'array');
-        // add fields to form
-        foreach ((array) $form_fields as $form_field) {
-            $this->_template_args['before_admin_page_content'] .= "\n\t" . $form_field['field'];
-        }
-        // close form
-        $this->_template_args['after_admin_page_content'] = '</form>';
-    }
-
-
-    /**
-     * Public Wrapper for _redirect_after_action() method since its
-     * discovered it would be useful for external code to have access.
-     *
-     * @param bool|int $success
-     * @param string   $what
-     * @param string   $action_desc
-     * @param array    $query_args
-     * @param bool     $override_overwrite
-     * @throws EE_Error
-     * @see   EE_Admin_Page::_redirect_after_action() for params.
-     * @since 4.5.0
-     */
-    public function redirect_after_action(
-        $success = false,
-        string $what = 'item',
-        string $action_desc = 'processed',
-        array $query_args = [],
-        bool $override_overwrite = false
-    ) {
-        $this->_redirect_after_action(
-            $success,
-            $what,
-            $action_desc,
-            $query_args,
-            $override_overwrite
-        );
-    }
-
-
-    /**
-     * Helper method for merging existing request data with the returned redirect url.
-     * This is typically used for redirects after an action so that if the original view was a filtered view those
-     * filters are still applied.
-     *
-     * @param array $new_route_data
-     * @return array
-     */
-    protected function mergeExistingRequestParamsWithRedirectArgs(array $new_route_data): array
-    {
-        foreach ($this->request->requestParams() as $ref => $value) {
-            // unset nonces
-            if (strpos($ref, 'nonce') !== false) {
-                $this->request->unSetRequestParam($ref);
-                continue;
-            }
-            // urlencode values.
-            $value = is_array($value) ? array_map('urlencode', $value) : urlencode($value);
-            $this->request->setRequestParam($ref, $value);
-        }
-        return array_merge($this->request->requestParams(), $new_route_data);
-    }
-
-
-    /**
-     * @param int|float|string $success            - whether success was for two or more records, or just one, or none
-     * @param string           $what               - what the action was performed on
-     * @param string           $action_desc        - what was done ie: updated, deleted, etc
-     * @param array            $query_args         - an array of query_args to be added to the URL to redirect to
-     * @param BOOL             $override_overwrite - by default all EE_Error::success messages are overwritten,
-     *                                             this allows you to override this so that they show.
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _redirect_after_action(
-        $success = 0,
-        string $what = 'item',
-        string $action_desc = 'processed',
-        array $query_args = [],
-        bool $override_overwrite = false
-    ) {
-        $notices = EE_Error::get_notices(false);
-        // overwrite default success messages //BUT ONLY if overwrite not overridden
-        if (! $override_overwrite || ! empty($notices['errors'])) {
-            EE_Error::overwrite_success();
-        }
-        if (! $override_overwrite && ! empty($what) && ! empty($action_desc) && empty($notices['errors'])) {
-            // how many records affected ? more than one record ? or just one ?
-            EE_Error::add_success(
-                sprintf(
-                    esc_html(
-                        _n(
-                            'The "%1$s" has been successfully %2$s.',
-                            'The "%1$s" have been successfully %2$s.',
-                            $success,
-                            'event_espresso'
-                        )
-                    ),
-                    $what,
-                    $action_desc
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        // check that $query_args isn't something crazy
-        $query_args = is_array($query_args) ? $query_args : [];
-        /**
-         * Allow injecting actions before the query_args are modified for possible different
-         * redirections on save and close actions
-         *
-         * @param array $query_args       The original query_args array coming into the
-         *                                method.
-         * @since 4.2.0
-         */
-        do_action(
-            "AHEE__{$this->class_name}___redirect_after_action__before_redirect_modification_$this->_req_action",
-            $query_args
-        );
-        // set redirect url.
-        // Note if there is a "page" index in the $query_args then we go with vanilla admin.php route,
-        // otherwise we go with whatever is set as the _admin_base_url
-        $redirect_url = isset($query_args['page']) ? admin_url('admin.php') : $this->_admin_base_url;
-        // calculate where we're going (if we have a "save and close" button pushed)
-        if (
-            $this->request->requestParamIsSet('save_and_close')
-            && $this->request->requestParamIsSet('save_and_close_referrer')
-        ) {
-            // even though we have the save_and_close referrer, we need to parse the url for the action in order to generate a nonce
-            $parsed_url = parse_url($this->request->getRequestParam('save_and_close_referrer', '', DataType::URL));
-            // regenerate query args array from referrer URL
-            parse_str($parsed_url['query'], $query_args);
-            // correct page and action will be in the query args now
-            $redirect_url = admin_url('admin.php');
-        }
-        // merge any default query_args set in _default_route_query_args property
-        if (! empty($this->_default_route_query_args) && ! $this->_is_UI_request) {
-            $args_to_merge = [];
-            foreach ($this->_default_route_query_args as $query_param => $query_value) {
-                // is there a wp_referer array in our _default_route_query_args property?
-                if ($query_param === 'wp_referer') {
-                    $query_value = (array) $query_value;
-                    foreach ($query_value as $reference => $value) {
-                        if (strpos($reference, 'nonce') !== false) {
-                            continue;
-                        }
-                        // finally we will override any arguments in the referer with
-                        // what might be set on the _default_route_query_args array.
-                        if (isset($this->_default_route_query_args[ $reference ])) {
-                            $args_to_merge[ $reference ] = urlencode($this->_default_route_query_args[ $reference ]);
-                        } else {
-                            $args_to_merge[ $reference ] = urlencode($value);
-                        }
-                    }
-                    continue;
-                }
-                $args_to_merge[ $query_param ] = $query_value;
-            }
-            // now let's merge these arguments but override with what was specifically sent in to the
-            // redirect.
-            $query_args = array_merge($args_to_merge, $query_args);
-        }
-        $this->_process_notices($query_args);
-        // generate redirect url
-        // if redirecting to anything other than the main page, add a nonce
-        if (isset($query_args['action'])) {
-            // manually generate wp_nonce and merge that with the query vars
-            // becuz the wp_nonce_url function wrecks havoc on some vars
-            $query_args['_wpnonce'] = wp_create_nonce($query_args['action'] . '_nonce');
-        }
-        // we're adding some hooks and filters in here for processing any things just before redirects
-        // (example: an admin page has done an insert or update and we want to run something after that).
-        do_action('AHEE_redirect_' . $this->class_name . $this->_req_action, $query_args);
-        $redirect_url = apply_filters(
-            'FHEE_redirect_' . $this->class_name . $this->_req_action,
-            EE_Admin_Page::add_query_args_and_nonce($query_args, $redirect_url),
-            $query_args
-        );
-        // check if we're doing ajax.  If we are then lets just return the results and js can handle how it wants.
-        if ($this->request->isAjax()) {
-            $default_data                    = [
-                'close'        => true,
-                'redirect_url' => $redirect_url,
-                'where'        => 'main',
-                'what'         => 'append',
-            ];
-            $this->_template_args['success'] = $success;
-            $this->_template_args['data']    = ! empty($this->_template_args['data']) ? array_merge(
-                $default_data,
-                $this->_template_args['data']
-            ) : $default_data;
-            $this->_return_json();
-        }
-        wp_safe_redirect($redirect_url);
-        exit();
-    }
-
-
-    /**
-     * process any notices before redirecting (or returning ajax request)
-     * This method sets the $this->_template_args['notices'] attribute;
-     *
-     * @param array $query_args         any query args that need to be used for notice transient ('action')
-     * @param bool  $skip_route_verify  This is typically used when we are processing notices REALLY early and
-     *                                  page_routes haven't been defined yet.
-     * @param bool  $sticky_notices     This is used to flag that regardless of whether this is doing_ajax or not, we
-     *                                  still save a transient for the notice.
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _process_notices(
-        array $query_args = [],
-        bool $skip_route_verify = false,
-        bool $sticky_notices = true
-    ) {
-        // first let's set individual error properties if doing_ajax and the properties aren't already set.
-        if ($this->request->isAjax()) {
-            $notices = EE_Error::get_notices(false);
-            if (empty($this->_template_args['success'])) {
-                $this->_template_args['success'] = $notices['success'] ?? false;
-            }
-            if (empty($this->_template_args['errors'])) {
-                $this->_template_args['errors'] = $notices['errors'] ?? false;
-            }
-            if (empty($this->_template_args['attention'])) {
-                $this->_template_args['attention'] = $notices['attention'] ?? false;
-            }
-        }
-        $this->_template_args['notices'] = EE_Error::get_notices();
-        // IF this isn't ajax we need to create a transient for the notices using the route (however, overridden if $sticky_notices == true)
-        if (! $this->request->isAjax() || $sticky_notices) {
-            $route = $query_args['action'] ?? 'default';
-            $this->_add_transient(
-                $route,
-                (array) $this->_template_args['notices'],
-                true,
-                $skip_route_verify
-            );
-        }
-    }
-
-
-    /**
-     * get_action_link_or_button
-     * returns the button html for adding, editing, or deleting an item (depending on given type)
-     *
-     * @param string $action        use this to indicate which action the url is generated with.
-     * @param string $type          accepted strings must be defined in the $_labels['button'] array(as the key)
-     *                              property.
-     * @param array  $extra_request if the button requires extra params you can include them in $key=>$value pairs.
-     * @param string $class         Use this to give the class for the button. Defaults to 'button--primary'
-     * @param string $base_url      If this is not provided
-     *                              the _admin_base_url will be used as the default for the button base_url.
-     *                              Otherwise this value will be used.
-     * @param bool   $exclude_nonce If true then no nonce will be in the generated button link.
-     * @return string
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function get_action_link_or_button(
-        string $action,
-        string $type = 'add',
-        array $extra_request = [],
-        string $class = 'button button--primary',
-        string $base_url = '',
-        bool $exclude_nonce = false
-    ): string {
-        // first let's validate the action (if $base_url is FALSE otherwise validation will happen further along)
-        if (empty($base_url) && ! isset($this->_page_routes[ $action ])) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'There is no page route for given action for the button.  This action was given: %s',
-                        'event_espresso'
-                    ),
-                    $action
-                )
-            );
-        }
-        if (! isset($this->_labels['buttons'][ $type ])) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'There is no label for the given button type (%s). Labels are set in the <code>_page_config</code> property.',
-                        'event_espresso'
-                    ),
-                    $type
-                )
-            );
-        }
-        // finally check user access for this button.
-        $has_access = $this->check_user_access($action, true);
-        if (! $has_access) {
-            return '';
-        }
-        $_base_url  = ! $base_url ? $this->_admin_base_url : $base_url;
-        $query_args = [
-            'action' => $action,
-        ];
-        // merge extra_request args but make sure our original action takes precedence and doesn't get overwritten.
-        if (! empty($extra_request)) {
-            $query_args = array_merge($extra_request, $query_args);
-        }
-        $url = EE_Admin_Page::add_query_args_and_nonce($query_args, $_base_url, false, $exclude_nonce);
-        return EEH_Template::get_button_or_link($url, $this->_labels['buttons'][ $type ], $class);
-    }
-
-
-    /**
-     * _per_page_screen_option
-     * Utility function for adding in a per_page_option in the screen_options_dropdown.
-     *
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    protected function _per_page_screen_option()
-    {
-        $option = 'per_page';
-        $args   = [
-            'label'   => apply_filters(
-                'FHEE__EE_Admin_Page___per_page_screen_options___label',
-                $this->_admin_page_title,
-                $this
-            ),
-            'default' => (int) apply_filters(
-                'FHEE__EE_Admin_Page___per_page_screen_options__default',
-                20
-            ),
-            'option'  => $this->_current_page . '_' . $this->_current_view . '_per_page',
-        ];
-        // ONLY add the screen option if the user has access to it.
-        if ($this->check_user_access($this->_current_view, true)) {
-            add_screen_option($option, $args);
-        }
-    }
-
-
-    /**
-     * set_per_page_screen_option
-     * All this does is make sure that WordPress saves any per_page screen options (if set) for the current page.
-     * we have to do this rather than running inside the 'set-screen-options' hook because it runs earlier than
-     * admin_menu.
-     *
-     * @return void
-     */
-    private function _set_per_page_screen_options()
-    {
-        if ($this->request->requestParamIsSet('wp_screen_options')) {
-            check_admin_referer('screen-options-nonce', 'screenoptionnonce');
-            if (! $user = wp_get_current_user()) {
-                return;
-            }
-            $option = $this->request->getRequestParam('wp_screen_options[option]', '', DataType::KEY);
-            if (! $option) {
-                return;
-            }
-            $value      = $this->request->getRequestParam('wp_screen_options[value]', 0, DataType::INT);
-            $map_option = $option;
-            $option     = str_replace('-', '_', $option);
-            switch ($map_option) {
-                case $this->_current_page . '_' . $this->_current_view . '_per_page':
-                    $max_value = apply_filters(
-                        'FHEE__EE_Admin_Page___set_per_page_screen_options__max_value',
-                        999,
-                        $this->_current_page,
-                        $this->_current_view
-                    );
-                    if ($value < 1) {
-                        return;
-                    }
-                    $value = min($value, $max_value);
-                    break;
-                default:
-                    $value = apply_filters(
-                        'FHEE__EE_Admin_Page___set_per_page_screen_options__value',
-                        false,
-                        $option,
-                        $value
-                    );
-                    if (false === $value) {
-                        return;
-                    }
-                    break;
-            }
-            update_user_meta($user->ID, $option, $value);
-            wp_safe_redirect(remove_query_arg(['pagenum', 'apage', 'paged'], wp_get_referer()));
-            exit;
-        }
-    }
-
-
-    /**
-     * This just allows for setting the $_template_args property if it needs to be set outside the object
-     *
-     * @param array $data array that will be assigned to template args.
-     */
-    public function set_template_args(array $data)
-    {
-        $this->_template_args = array_merge($this->_template_args, $data);
-    }
-
-
-    /**
-     * This makes available the WP transient system for temporarily moving data between routes
-     *
-     * @param string $route             the route that should receive the transient
-     * @param array  $data              the data that gets sent
-     * @param bool   $notices           If this is for notices then we use this to indicate so, otherwise its just a
-     *                                  normal route transient.
-     * @param bool   $skip_route_verify Used to indicate we want to skip route verification.  This is usually ONLY used
-     *                                  when we are adding a transient before page_routes have been defined.
-     * @return void
-     * @throws EE_Error
-     */
-    protected function _add_transient(
-        string $route,
-        array $data,
-        bool $notices = false,
-        bool $skip_route_verify = false
-    ) {
-        $user_id = get_current_user_id();
-        if (! $skip_route_verify) {
-            $this->_verify_route($route);
-        }
-        // now let's set the string for what kind of transient we're setting
-        $transient = $notices ? "ee_rte_n_tx_{$route}_$user_id" : "rte_tx_{$route}_$user_id";
-        $data      = $notices ? ['notices' => $data] : $data;
-        // is there already a transient for this route?  If there is then let's ADD to that transient
-        $existing = is_multisite() && is_network_admin()
-            ? get_site_transient($transient)
-            : get_transient($transient);
-        if ($existing) {
-            $data = array_merge($data, (array) $existing);
-        }
-        if (is_multisite() && is_network_admin()) {
-            set_site_transient($transient, $data, 8);
-        } else {
-            set_transient($transient, $data, 8);
-        }
-    }
-
-
-    /**
-     * this retrieves the temporary transient that has been set for moving data between routes.
-     *
-     * @param bool   $notices true we get notices transient. False we just return normal route transient
-     * @param string $route
-     * @return mixed data
-     */
-    protected function _get_transient(bool $notices = false, string $route = '')
-    {
-        $user_id   = get_current_user_id();
-        $route     = ! $route ? $this->_req_action : $route;
-        $transient = $notices
-            ? 'ee_rte_n_tx_' . $route . '_' . $user_id
-            : 'rte_tx_' . $route . '_' . $user_id;
-        $data      = is_multisite() && is_network_admin()
-            ? get_site_transient($transient)
-            : get_transient($transient);
-        // delete transient after retrieval (just in case it hasn't expired);
-        if (is_multisite() && is_network_admin()) {
-            delete_site_transient($transient);
-        } else {
-            delete_transient($transient);
-        }
-        return $notices && isset($data['notices']) ? $data['notices'] : $data;
-    }
-
-
-    /**
-     * The purpose of this method is just to run garbage collection on any EE transients that might have expired but
-     * would not be called later. This will be assigned to run on a specific EE Admin page. (place the method in the
-     * default route callback on the EE_Admin page you want it run.)
-     *
-     * @return void
-     */
-    protected function _transient_garbage_collection()
-    {
-        global $wpdb;
-        // retrieve all existing transients
-        $query =
-            "SELECT option_name FROM $wpdb->options WHERE option_name LIKE '%rte_tx_%' OR option_name LIKE '%rte_n_tx_%'";
-        if ($results = $wpdb->get_results($query)) {
-            foreach ($results as $result) {
-                $transient = str_replace('_transient_', '', $result->option_name);
-                get_transient($transient);
-                if (is_multisite() && is_network_admin()) {
-                    get_site_transient($transient);
-                }
-            }
-        }
-    }
-
-
-    /**
-     * get_view
-     *
-     * @return string content of _view property
-     */
-    public function get_view(): string
-    {
-        return $this->_view;
-    }
-
-
-    /**
-     * getter for the protected $_views property
-     *
-     * @return array
-     */
-    public function get_views(): array
-    {
-        return $this->_views;
-    }
-
-
-    /**
-     * get_current_page
-     *
-     * @return string _current_page property value
-     */
-    public function get_current_page(): string
-    {
-        return $this->_current_page;
-    }
-
-
-    /**
-     * get_current_view
-     *
-     * @return string _current_view property value
-     */
-    public function get_current_view(): string
-    {
-        return $this->_current_view;
-    }
-
-
-    /**
-     * get_current_screen
-     *
-     * @return object The current WP_Screen object
-     */
-    public function get_current_screen()
-    {
-        return $this->_current_screen;
-    }
-
-
-    /**
-     * get_current_page_view_url
-     *
-     * @return string This returns the url for the current_page_view.
-     */
-    public function get_current_page_view_url(): string
-    {
-        return $this->_current_page_view_url;
-    }
-
-
-    /**
-     * just returns the Request
-     *
-     * @return RequestInterface
-     */
-    public function get_request(): ?RequestInterface
-    {
-        return $this->request;
-    }
-
-
-    /**
-     * just returns the _req_data property
-     *
-     * @return array
-     */
-    public function get_request_data(): array
-    {
-        return $this->request->requestParams();
-    }
-
-
-    /**
-     * returns the _req_data protected property
-     *
-     * @return string
-     */
-    public function get_req_action(): string
-    {
-        return $this->_req_action;
-    }
-
-
-    /**
-     * @return bool  value of $_is_caf property
-     */
-    public function is_caf(): bool
-    {
-        return $this->_is_caf;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function default_espresso_metaboxes(): array
-    {
-        return $this->_default_espresso_metaboxes;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function admin_base_url(): string
-    {
-        return $this->_admin_base_url;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function wp_page_slug(): string
-    {
-        return $this->_wp_page_slug;
-    }
-
-
-    /**
-     * updates  espresso configuration settings
-     *
-     * @param string                   $tab
-     * @param EE_Config_Base|EE_Config $config
-     * @param string                   $file file where error occurred
-     * @param string                   $func function  where error occurred
-     * @param string                   $line line no where error occurred
-     * @return bool
-     */
-    protected function _update_espresso_configuration(
-        string $tab,
-        $config,
-        string $file = '',
-        string $func = '',
-        string $line = ''
-    ): bool {
-        // remove any options that are NOT going to be saved with the config settings.
-        if (isset($config->core->ee_ueip_optin)) {
-            // TODO: remove the following two lines and make sure values are migrated from 3.1
-            update_option('ee_ueip_optin', $config->core->ee_ueip_optin);
-            update_option('ee_ueip_has_notified', true);
-        }
-        // and save it (note we're also doing the network save here)
-        $net_saved    = ! is_main_site() || EE_Network_Config::instance()->update_config(false, false);
-        $config_saved = EE_Config::instance()->update_espresso_config(false, false);
-        if ($config_saved && $net_saved) {
-            EE_Error::add_success(sprintf(esc_html__('"%s" have been successfully updated.', 'event_espresso'), $tab));
-            return true;
-        }
-        EE_Error::add_error(
-            sprintf(esc_html__('The "%s" were not updated.', 'event_espresso'), $tab),
-            $file,
-            $func,
-            $line
-        );
-        return false;
-    }
-
-
-    /**
-     * Returns an array to be used for EE_FOrm_Fields.helper.php's select_input as the $values argument.
-     *
-     * @return array
-     */
-    public function get_yes_no_values(): array
-    {
-        return $this->_yes_no_values;
-    }
-
-
-    /**
-     * @return string
-     * @throws ReflectionException
-     * @since 5.0.0.p
-     */
-    protected function _get_dir(): string
-    {
-        $reflector = new ReflectionClass($this->class_name);
-        return dirname($reflector->getFileName());
-    }
-
-
-    /**
-     * A helper for getting a "next link".
-     *
-     * @param string $url   The url to link to
-     * @param string $class The class to use.
-     * @return string
-     */
-    protected function _next_link(string $url, string $class = 'dashicons dashicons-arrow-right'): string
-    {
-        return '<a class="' . $class . '" href="' . $url . '"></a>';
-    }
-
-
-    /**
-     * A helper for getting a "previous link".
-     *
-     * @param string $url   The url to link to
-     * @param string $class The class to use.
-     * @return string
-     */
-    protected function _previous_link(string $url, string $class = 'dashicons dashicons-arrow-left'): string
-    {
-        return '<a class="' . $class . '" href="' . $url . '"></a>';
-    }
-
-
-
-
-
-
-
-    // below are some messages related methods that should be available across the EE_Admin system.  Note, these methods are NOT page specific
-
-
-    /**
-     * This processes an request to resend a registration and assumes we have a _REG_ID for doing so. So if the caller
-     * knows that the _REG_ID isn't in the req_data array but CAN obtain it, the caller should ADD the _REG_ID to the
-     * _req_data array.
-     *
-     * @return bool success/fail
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _process_resend_registration(): bool
-    {
-        $this->_template_args['success'] = EED_Messages::process_resend($this->request->requestParams());
-        do_action(
-            'AHEE__EE_Admin_Page___process_resend_registration',
-            $this->_template_args['success'],
-            $this->request->requestParams()
-        );
-        return $this->_template_args['success'];
-    }
-
-
-    /**
-     * This automatically processes any payment message notifications when manual payment has been applied.
-     *
-     * @param EE_Payment $payment
-     * @return bool success/fail
-     */
-    protected function _process_payment_notification(EE_Payment $payment): bool
-    {
-        add_filter('FHEE__EE_Payment_Processor__process_registration_payments__display_notifications', '__return_true');
-        do_action('AHEE__EE_Admin_Page___process_admin_payment_notification', $payment);
-        $this->_template_args['success'] = apply_filters(
-            'FHEE__EE_Admin_Page___process_admin_payment_notification__success',
-            false,
-            $payment
-        );
-        return $this->_template_args['success'];
-    }
-
-
-    /**
-     * @param EEM_Base      $entity_model
-     * @param string        $entity_PK_name name of the primary key field used as a request param, ie: id, ID, etc
-     * @param string        $action         one of the EE_Admin_List_Table::ACTION_* constants: delete, restore, trash
-     * @param string        $delete_column  name of the field that denotes whether entity is trashed
-     * @param callable|null $callback       called after entity is trashed, restored, or deleted
-     * @return int|float
-     * @throws EE_Error
-     */
-    protected function trashRestoreDeleteEntities(
-        EEM_Base $entity_model,
-        string $entity_PK_name,
-        string $action = EE_Admin_List_Table::ACTION_DELETE,
-        string $delete_column = '',
-        ?callable $callback = null
-    ) {
-        $entity_PK      = $entity_model->get_primary_key_field();
-        $entity_PK_name = $entity_PK_name ?: $entity_PK->get_name();
-        $entity_PK_type = $this->resolveEntityFieldDataType($entity_PK);
-        // grab ID if deleting a single entity
-        if ($this->request->requestParamIsSet($entity_PK_name)) {
-            $ID = $this->request->getRequestParam($entity_PK_name, 0, $entity_PK_type);
-            return $this->trashRestoreDeleteEntity($entity_model, $ID, $action, $delete_column, $callback) ? 1 : 0;
-        }
-        // or grab checkbox array if bulk deleting
-        $checkboxes = $this->request->getRequestParam('checkbox', [], $entity_PK_type, true);
-        if (empty($checkboxes)) {
-            return 0;
-        }
-        $success = 0;
-        $IDs     = array_keys($checkboxes);
-        // cycle thru bulk action checkboxes
-        foreach ($IDs as $ID) {
-            // increment $success
-            if ($this->trashRestoreDeleteEntity($entity_model, $ID, $action, $delete_column, $callback)) {
-                $success++;
-            }
-        }
-        $count = (int) count($checkboxes);
-        // if multiple entities were deleted successfully, then $deleted will be full count of deletions,
-        // otherwise it will be a fraction of ( actual deletions / total entities to be deleted )
-        return $success === $count ? $count : $success / $count;
-    }
-
-
-    /**
-     * @param EE_Primary_Key_Field_Base $entity_PK
-     * @return string
-     * @throws EE_Error
-     * @since   4.10.30.p
-     */
-    private function resolveEntityFieldDataType(EE_Primary_Key_Field_Base $entity_PK): string
-    {
-        $entity_PK_type = $entity_PK->getSchemaType();
-        switch ($entity_PK_type) {
-            case 'boolean':
-                return DataType::BOOL;
-            case 'integer':
-                return DataType::INT;
-            case 'number':
-                return DataType::FLOAT;
-            case 'string':
-                return DataType::STRING;
-        }
-        throw new RuntimeException(
-            sprintf(
-                esc_html__(
-                    '"%1$s" is an invalid schema type for the %2$s primary key.',
-                    'event_espresso'
-                ),
-                $entity_PK_type,
-                $entity_PK->get_name()
-            )
-        );
-    }
-
-
-    /**
-     * @param EEM_Base      $entity_model
-     * @param int|string    $entity_ID
-     * @param string        $action        one of the EE_Admin_List_Table::ACTION_* constants: delete, restore, trash
-     * @param string        $delete_column name of the field that denotes whether entity is trashed
-     * @param callable|null $callback      called after entity is trashed, restored, or deleted
-     * @return bool
-     */
-    protected function trashRestoreDeleteEntity(
-        EEM_Base $entity_model,
-        $entity_ID,
-        string $action,
-        string $delete_column,
-        ?callable $callback = null
-    ): bool {
-        $entity_ID = absint($entity_ID);
-        if (! $entity_ID) {
-            $this->trashRestoreDeleteError($action, $entity_model);
-        }
-        $result = 0;
-        try {
-            $entity = $entity_model->get_one_by_ID($entity_ID);
-            if (! $entity instanceof EE_Base_Class) {
-                throw new DomainException(
-                    sprintf(
-                        esc_html__(
-                            'Missing or invalid %1$s entity with ID of "%2$s" returned from db.',
-                            'event_espresso'
-                        ),
-                        str_replace('EEM_', '', $entity_model->get_this_model_name()),
-                        $entity_ID
-                    )
-                );
-            }
-            switch ($action) {
-                case EE_Admin_List_Table::ACTION_DELETE:
-                    $result = (bool) $entity->delete_permanently();
-                    break;
-                case EE_Admin_List_Table::ACTION_RESTORE:
-                    $result = $entity->delete_or_restore(false);
-                    break;
-                case EE_Admin_List_Table::ACTION_TRASH:
-                    $result = $entity->delete_or_restore();
-                    break;
-            }
-        } catch (Exception $exception) {
-            $this->trashRestoreDeleteError($action, $entity_model, $exception);
-        }
-        if (is_callable($callback)) {
-            call_user_func_array($callback, [$entity_model, $entity_ID, $action, $result, $delete_column]);
-        }
-        return $result;
-    }
-
-
-    /**
-     * @param EEM_Base $entity_model
-     * @param string   $delete_column
-     * @since 4.10.30.p
-     */
-    private function validateDeleteColumn(EEM_Base $entity_model, string $delete_column)
-    {
-        if (empty($delete_column)) {
-            throw new DomainException(
-                sprintf(
-                    esc_html__(
-                        'You need to specify the name of the "delete column" on the %2$s model, in order to trash or restore an entity.',
-                        'event_espresso'
-                    ),
-                    $entity_model->get_this_model_name()
-                )
-            );
-        }
-        if (! $entity_model->has_field($delete_column)) {
-            throw new DomainException(
-                sprintf(
-                    esc_html__(
-                        'The %1$s field does not exist on the %2$s model.',
-                        'event_espresso'
-                    ),
-                    $delete_column,
-                    $entity_model->get_this_model_name()
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @param EEM_Base       $entity_model
-     * @param Exception|null $exception
-     * @param string         $action
-     * @since 4.10.30.p
-     */
-    private function trashRestoreDeleteError(string $action, EEM_Base $entity_model, Exception $exception = null)
-    {
-        if ($exception instanceof Exception) {
-            throw new RuntimeException(
-                sprintf(
-                    esc_html__(
-                        'Could not %1$s the %2$s because the following error occurred: %3$s',
-                        'event_espresso'
-                    ),
-                    $action,
-                    $entity_model->get_this_model_name(),
-                    $exception->getMessage()
-                )
-            );
-        }
-        throw new RuntimeException(
-            sprintf(
-                esc_html__(
-                    'Could not %1$s the %2$s because an invalid ID was received.',
-                    'event_espresso'
-                ),
-                $action,
-                $entity_model->get_this_model_name()
-            )
-        );
-    }
+		// add nonce
+		$nonce                                             =
+			wp_nonce_field($route . '_nonce', $route . '_nonce', false, false);
+		$this->_template_args['before_admin_page_content'] .= "\n\t" . $nonce;
+		// add REQUIRED form action
+		$hidden_fields = [
+			'action' => ['type' => 'hidden', 'value' => $route],
+		];
+		// merge arrays
+		$hidden_fields = is_array($additional_hidden_fields)
+			? array_merge($hidden_fields, $additional_hidden_fields)
+			: $hidden_fields;
+		// generate form fields
+		$form_fields = $this->_generate_admin_form_fields($hidden_fields, 'array');
+		// add fields to form
+		foreach ((array) $form_fields as $form_field) {
+			$this->_template_args['before_admin_page_content'] .= "\n\t" . $form_field['field'];
+		}
+		// close form
+		$this->_template_args['after_admin_page_content'] = '</form>';
+	}
+
+
+	/**
+	 * Public Wrapper for _redirect_after_action() method since its
+	 * discovered it would be useful for external code to have access.
+	 *
+	 * @param bool|int $success
+	 * @param string   $what
+	 * @param string   $action_desc
+	 * @param array    $query_args
+	 * @param bool     $override_overwrite
+	 * @throws EE_Error
+	 * @see   EE_Admin_Page::_redirect_after_action() for params.
+	 * @since 4.5.0
+	 */
+	public function redirect_after_action(
+		$success = false,
+		string $what = 'item',
+		string $action_desc = 'processed',
+		array $query_args = [],
+		bool $override_overwrite = false
+	) {
+		$this->_redirect_after_action(
+			$success,
+			$what,
+			$action_desc,
+			$query_args,
+			$override_overwrite
+		);
+	}
+
+
+	/**
+	 * Helper method for merging existing request data with the returned redirect url.
+	 * This is typically used for redirects after an action so that if the original view was a filtered view those
+	 * filters are still applied.
+	 *
+	 * @param array $new_route_data
+	 * @return array
+	 */
+	protected function mergeExistingRequestParamsWithRedirectArgs(array $new_route_data): array
+	{
+		foreach ($this->request->requestParams() as $ref => $value) {
+			// unset nonces
+			if (strpos($ref, 'nonce') !== false) {
+				$this->request->unSetRequestParam($ref);
+				continue;
+			}
+			// urlencode values.
+			$value = is_array($value) ? array_map('urlencode', $value) : urlencode($value);
+			$this->request->setRequestParam($ref, $value);
+		}
+		return array_merge($this->request->requestParams(), $new_route_data);
+	}
+
+
+	/**
+	 * @param int|float|string $success            - whether success was for two or more records, or just one, or none
+	 * @param string           $what               - what the action was performed on
+	 * @param string           $action_desc        - what was done ie: updated, deleted, etc
+	 * @param array            $query_args         - an array of query_args to be added to the URL to redirect to
+	 * @param BOOL             $override_overwrite - by default all EE_Error::success messages are overwritten,
+	 *                                             this allows you to override this so that they show.
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _redirect_after_action(
+		$success = 0,
+		string $what = 'item',
+		string $action_desc = 'processed',
+		array $query_args = [],
+		bool $override_overwrite = false
+	) {
+		$notices = EE_Error::get_notices(false);
+		// overwrite default success messages //BUT ONLY if overwrite not overridden
+		if (! $override_overwrite || ! empty($notices['errors'])) {
+			EE_Error::overwrite_success();
+		}
+		if (! $override_overwrite && ! empty($what) && ! empty($action_desc) && empty($notices['errors'])) {
+			// how many records affected ? more than one record ? or just one ?
+			EE_Error::add_success(
+				sprintf(
+					esc_html(
+						_n(
+							'The "%1$s" has been successfully %2$s.',
+							'The "%1$s" have been successfully %2$s.',
+							$success,
+							'event_espresso'
+						)
+					),
+					$what,
+					$action_desc
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		// check that $query_args isn't something crazy
+		$query_args = is_array($query_args) ? $query_args : [];
+		/**
+		 * Allow injecting actions before the query_args are modified for possible different
+		 * redirections on save and close actions
+		 *
+		 * @param array $query_args       The original query_args array coming into the
+		 *                                method.
+		 * @since 4.2.0
+		 */
+		do_action(
+			"AHEE__{$this->class_name}___redirect_after_action__before_redirect_modification_$this->_req_action",
+			$query_args
+		);
+		// set redirect url.
+		// Note if there is a "page" index in the $query_args then we go with vanilla admin.php route,
+		// otherwise we go with whatever is set as the _admin_base_url
+		$redirect_url = isset($query_args['page']) ? admin_url('admin.php') : $this->_admin_base_url;
+		// calculate where we're going (if we have a "save and close" button pushed)
+		if (
+			$this->request->requestParamIsSet('save_and_close')
+			&& $this->request->requestParamIsSet('save_and_close_referrer')
+		) {
+			// even though we have the save_and_close referrer, we need to parse the url for the action in order to generate a nonce
+			$parsed_url = parse_url($this->request->getRequestParam('save_and_close_referrer', '', DataType::URL));
+			// regenerate query args array from referrer URL
+			parse_str($parsed_url['query'], $query_args);
+			// correct page and action will be in the query args now
+			$redirect_url = admin_url('admin.php');
+		}
+		// merge any default query_args set in _default_route_query_args property
+		if (! empty($this->_default_route_query_args) && ! $this->_is_UI_request) {
+			$args_to_merge = [];
+			foreach ($this->_default_route_query_args as $query_param => $query_value) {
+				// is there a wp_referer array in our _default_route_query_args property?
+				if ($query_param === 'wp_referer') {
+					$query_value = (array) $query_value;
+					foreach ($query_value as $reference => $value) {
+						if (strpos($reference, 'nonce') !== false) {
+							continue;
+						}
+						// finally we will override any arguments in the referer with
+						// what might be set on the _default_route_query_args array.
+						if (isset($this->_default_route_query_args[ $reference ])) {
+							$args_to_merge[ $reference ] = urlencode($this->_default_route_query_args[ $reference ]);
+						} else {
+							$args_to_merge[ $reference ] = urlencode($value);
+						}
+					}
+					continue;
+				}
+				$args_to_merge[ $query_param ] = $query_value;
+			}
+			// now let's merge these arguments but override with what was specifically sent in to the
+			// redirect.
+			$query_args = array_merge($args_to_merge, $query_args);
+		}
+		$this->_process_notices($query_args);
+		// generate redirect url
+		// if redirecting to anything other than the main page, add a nonce
+		if (isset($query_args['action'])) {
+			// manually generate wp_nonce and merge that with the query vars
+			// becuz the wp_nonce_url function wrecks havoc on some vars
+			$query_args['_wpnonce'] = wp_create_nonce($query_args['action'] . '_nonce');
+		}
+		// we're adding some hooks and filters in here for processing any things just before redirects
+		// (example: an admin page has done an insert or update and we want to run something after that).
+		do_action('AHEE_redirect_' . $this->class_name . $this->_req_action, $query_args);
+		$redirect_url = apply_filters(
+			'FHEE_redirect_' . $this->class_name . $this->_req_action,
+			EE_Admin_Page::add_query_args_and_nonce($query_args, $redirect_url),
+			$query_args
+		);
+		// check if we're doing ajax.  If we are then lets just return the results and js can handle how it wants.
+		if ($this->request->isAjax()) {
+			$default_data                    = [
+				'close'        => true,
+				'redirect_url' => $redirect_url,
+				'where'        => 'main',
+				'what'         => 'append',
+			];
+			$this->_template_args['success'] = $success;
+			$this->_template_args['data']    = ! empty($this->_template_args['data']) ? array_merge(
+				$default_data,
+				$this->_template_args['data']
+			) : $default_data;
+			$this->_return_json();
+		}
+		wp_safe_redirect($redirect_url);
+		exit();
+	}
+
+
+	/**
+	 * process any notices before redirecting (or returning ajax request)
+	 * This method sets the $this->_template_args['notices'] attribute;
+	 *
+	 * @param array $query_args         any query args that need to be used for notice transient ('action')
+	 * @param bool  $skip_route_verify  This is typically used when we are processing notices REALLY early and
+	 *                                  page_routes haven't been defined yet.
+	 * @param bool  $sticky_notices     This is used to flag that regardless of whether this is doing_ajax or not, we
+	 *                                  still save a transient for the notice.
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _process_notices(
+		array $query_args = [],
+		bool $skip_route_verify = false,
+		bool $sticky_notices = true
+	) {
+		// first let's set individual error properties if doing_ajax and the properties aren't already set.
+		if ($this->request->isAjax()) {
+			$notices = EE_Error::get_notices(false);
+			if (empty($this->_template_args['success'])) {
+				$this->_template_args['success'] = $notices['success'] ?? false;
+			}
+			if (empty($this->_template_args['errors'])) {
+				$this->_template_args['errors'] = $notices['errors'] ?? false;
+			}
+			if (empty($this->_template_args['attention'])) {
+				$this->_template_args['attention'] = $notices['attention'] ?? false;
+			}
+		}
+		$this->_template_args['notices'] = EE_Error::get_notices();
+		// IF this isn't ajax we need to create a transient for the notices using the route (however, overridden if $sticky_notices == true)
+		if (! $this->request->isAjax() || $sticky_notices) {
+			$route = $query_args['action'] ?? 'default';
+			$this->_add_transient(
+				$route,
+				(array) $this->_template_args['notices'],
+				true,
+				$skip_route_verify
+			);
+		}
+	}
+
+
+	/**
+	 * get_action_link_or_button
+	 * returns the button html for adding, editing, or deleting an item (depending on given type)
+	 *
+	 * @param string $action        use this to indicate which action the url is generated with.
+	 * @param string $type          accepted strings must be defined in the $_labels['button'] array(as the key)
+	 *                              property.
+	 * @param array  $extra_request if the button requires extra params you can include them in $key=>$value pairs.
+	 * @param string $class         Use this to give the class for the button. Defaults to 'button--primary'
+	 * @param string $base_url      If this is not provided
+	 *                              the _admin_base_url will be used as the default for the button base_url.
+	 *                              Otherwise this value will be used.
+	 * @param bool   $exclude_nonce If true then no nonce will be in the generated button link.
+	 * @return string
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function get_action_link_or_button(
+		string $action,
+		string $type = 'add',
+		array $extra_request = [],
+		string $class = 'button button--primary',
+		string $base_url = '',
+		bool $exclude_nonce = false
+	): string {
+		// first let's validate the action (if $base_url is FALSE otherwise validation will happen further along)
+		if (empty($base_url) && ! isset($this->_page_routes[ $action ])) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'There is no page route for given action for the button.  This action was given: %s',
+						'event_espresso'
+					),
+					$action
+				)
+			);
+		}
+		if (! isset($this->_labels['buttons'][ $type ])) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'There is no label for the given button type (%s). Labels are set in the <code>_page_config</code> property.',
+						'event_espresso'
+					),
+					$type
+				)
+			);
+		}
+		// finally check user access for this button.
+		$has_access = $this->check_user_access($action, true);
+		if (! $has_access) {
+			return '';
+		}
+		$_base_url  = ! $base_url ? $this->_admin_base_url : $base_url;
+		$query_args = [
+			'action' => $action,
+		];
+		// merge extra_request args but make sure our original action takes precedence and doesn't get overwritten.
+		if (! empty($extra_request)) {
+			$query_args = array_merge($extra_request, $query_args);
+		}
+		$url = EE_Admin_Page::add_query_args_and_nonce($query_args, $_base_url, false, $exclude_nonce);
+		return EEH_Template::get_button_or_link($url, $this->_labels['buttons'][ $type ], $class);
+	}
+
+
+	/**
+	 * _per_page_screen_option
+	 * Utility function for adding in a per_page_option in the screen_options_dropdown.
+	 *
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	protected function _per_page_screen_option()
+	{
+		$option = 'per_page';
+		$args   = [
+			'label'   => apply_filters(
+				'FHEE__EE_Admin_Page___per_page_screen_options___label',
+				$this->_admin_page_title,
+				$this
+			),
+			'default' => (int) apply_filters(
+				'FHEE__EE_Admin_Page___per_page_screen_options__default',
+				20
+			),
+			'option'  => $this->_current_page . '_' . $this->_current_view . '_per_page',
+		];
+		// ONLY add the screen option if the user has access to it.
+		if ($this->check_user_access($this->_current_view, true)) {
+			add_screen_option($option, $args);
+		}
+	}
+
+
+	/**
+	 * set_per_page_screen_option
+	 * All this does is make sure that WordPress saves any per_page screen options (if set) for the current page.
+	 * we have to do this rather than running inside the 'set-screen-options' hook because it runs earlier than
+	 * admin_menu.
+	 *
+	 * @return void
+	 */
+	private function _set_per_page_screen_options()
+	{
+		if ($this->request->requestParamIsSet('wp_screen_options')) {
+			check_admin_referer('screen-options-nonce', 'screenoptionnonce');
+			if (! $user = wp_get_current_user()) {
+				return;
+			}
+			$option = $this->request->getRequestParam('wp_screen_options[option]', '', DataType::KEY);
+			if (! $option) {
+				return;
+			}
+			$value      = $this->request->getRequestParam('wp_screen_options[value]', 0, DataType::INT);
+			$map_option = $option;
+			$option     = str_replace('-', '_', $option);
+			switch ($map_option) {
+				case $this->_current_page . '_' . $this->_current_view . '_per_page':
+					$max_value = apply_filters(
+						'FHEE__EE_Admin_Page___set_per_page_screen_options__max_value',
+						999,
+						$this->_current_page,
+						$this->_current_view
+					);
+					if ($value < 1) {
+						return;
+					}
+					$value = min($value, $max_value);
+					break;
+				default:
+					$value = apply_filters(
+						'FHEE__EE_Admin_Page___set_per_page_screen_options__value',
+						false,
+						$option,
+						$value
+					);
+					if (false === $value) {
+						return;
+					}
+					break;
+			}
+			update_user_meta($user->ID, $option, $value);
+			wp_safe_redirect(remove_query_arg(['pagenum', 'apage', 'paged'], wp_get_referer()));
+			exit;
+		}
+	}
+
+
+	/**
+	 * This just allows for setting the $_template_args property if it needs to be set outside the object
+	 *
+	 * @param array $data array that will be assigned to template args.
+	 */
+	public function set_template_args(array $data)
+	{
+		$this->_template_args = array_merge($this->_template_args, $data);
+	}
+
+
+	/**
+	 * This makes available the WP transient system for temporarily moving data between routes
+	 *
+	 * @param string $route             the route that should receive the transient
+	 * @param array  $data              the data that gets sent
+	 * @param bool   $notices           If this is for notices then we use this to indicate so, otherwise its just a
+	 *                                  normal route transient.
+	 * @param bool   $skip_route_verify Used to indicate we want to skip route verification.  This is usually ONLY used
+	 *                                  when we are adding a transient before page_routes have been defined.
+	 * @return void
+	 * @throws EE_Error
+	 */
+	protected function _add_transient(
+		string $route,
+		array $data,
+		bool $notices = false,
+		bool $skip_route_verify = false
+	) {
+		$user_id = get_current_user_id();
+		if (! $skip_route_verify) {
+			$this->_verify_route($route);
+		}
+		// now let's set the string for what kind of transient we're setting
+		$transient = $notices ? "ee_rte_n_tx_{$route}_$user_id" : "rte_tx_{$route}_$user_id";
+		$data      = $notices ? ['notices' => $data] : $data;
+		// is there already a transient for this route?  If there is then let's ADD to that transient
+		$existing = is_multisite() && is_network_admin()
+			? get_site_transient($transient)
+			: get_transient($transient);
+		if ($existing) {
+			$data = array_merge($data, (array) $existing);
+		}
+		if (is_multisite() && is_network_admin()) {
+			set_site_transient($transient, $data, 8);
+		} else {
+			set_transient($transient, $data, 8);
+		}
+	}
+
+
+	/**
+	 * this retrieves the temporary transient that has been set for moving data between routes.
+	 *
+	 * @param bool   $notices true we get notices transient. False we just return normal route transient
+	 * @param string $route
+	 * @return mixed data
+	 */
+	protected function _get_transient(bool $notices = false, string $route = '')
+	{
+		$user_id   = get_current_user_id();
+		$route     = ! $route ? $this->_req_action : $route;
+		$transient = $notices
+			? 'ee_rte_n_tx_' . $route . '_' . $user_id
+			: 'rte_tx_' . $route . '_' . $user_id;
+		$data      = is_multisite() && is_network_admin()
+			? get_site_transient($transient)
+			: get_transient($transient);
+		// delete transient after retrieval (just in case it hasn't expired);
+		if (is_multisite() && is_network_admin()) {
+			delete_site_transient($transient);
+		} else {
+			delete_transient($transient);
+		}
+		return $notices && isset($data['notices']) ? $data['notices'] : $data;
+	}
+
+
+	/**
+	 * The purpose of this method is just to run garbage collection on any EE transients that might have expired but
+	 * would not be called later. This will be assigned to run on a specific EE Admin page. (place the method in the
+	 * default route callback on the EE_Admin page you want it run.)
+	 *
+	 * @return void
+	 */
+	protected function _transient_garbage_collection()
+	{
+		global $wpdb;
+		// retrieve all existing transients
+		$query =
+			"SELECT option_name FROM $wpdb->options WHERE option_name LIKE '%rte_tx_%' OR option_name LIKE '%rte_n_tx_%'";
+		if ($results = $wpdb->get_results($query)) {
+			foreach ($results as $result) {
+				$transient = str_replace('_transient_', '', $result->option_name);
+				get_transient($transient);
+				if (is_multisite() && is_network_admin()) {
+					get_site_transient($transient);
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * get_view
+	 *
+	 * @return string content of _view property
+	 */
+	public function get_view(): string
+	{
+		return $this->_view;
+	}
+
+
+	/**
+	 * getter for the protected $_views property
+	 *
+	 * @return array
+	 */
+	public function get_views(): array
+	{
+		return $this->_views;
+	}
+
+
+	/**
+	 * get_current_page
+	 *
+	 * @return string _current_page property value
+	 */
+	public function get_current_page(): string
+	{
+		return $this->_current_page;
+	}
+
+
+	/**
+	 * get_current_view
+	 *
+	 * @return string _current_view property value
+	 */
+	public function get_current_view(): string
+	{
+		return $this->_current_view;
+	}
+
+
+	/**
+	 * get_current_screen
+	 *
+	 * @return object The current WP_Screen object
+	 */
+	public function get_current_screen()
+	{
+		return $this->_current_screen;
+	}
+
+
+	/**
+	 * get_current_page_view_url
+	 *
+	 * @return string This returns the url for the current_page_view.
+	 */
+	public function get_current_page_view_url(): string
+	{
+		return $this->_current_page_view_url;
+	}
+
+
+	/**
+	 * just returns the Request
+	 *
+	 * @return RequestInterface
+	 */
+	public function get_request(): ?RequestInterface
+	{
+		return $this->request;
+	}
+
+
+	/**
+	 * just returns the _req_data property
+	 *
+	 * @return array
+	 */
+	public function get_request_data(): array
+	{
+		return $this->request->requestParams();
+	}
+
+
+	/**
+	 * returns the _req_data protected property
+	 *
+	 * @return string
+	 */
+	public function get_req_action(): string
+	{
+		return $this->_req_action;
+	}
+
+
+	/**
+	 * @return bool  value of $_is_caf property
+	 */
+	public function is_caf(): bool
+	{
+		return $this->_is_caf;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function default_espresso_metaboxes(): array
+	{
+		return $this->_default_espresso_metaboxes;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function admin_base_url(): string
+	{
+		return $this->_admin_base_url;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function wp_page_slug(): string
+	{
+		return $this->_wp_page_slug;
+	}
+
+
+	/**
+	 * updates  espresso configuration settings
+	 *
+	 * @param string                   $tab
+	 * @param EE_Config_Base|EE_Config $config
+	 * @param string                   $file file where error occurred
+	 * @param string                   $func function  where error occurred
+	 * @param string                   $line line no where error occurred
+	 * @return bool
+	 */
+	protected function _update_espresso_configuration(
+		string $tab,
+		$config,
+		string $file = '',
+		string $func = '',
+		string $line = ''
+	): bool {
+		// remove any options that are NOT going to be saved with the config settings.
+		if (isset($config->core->ee_ueip_optin)) {
+			// TODO: remove the following two lines and make sure values are migrated from 3.1
+			update_option('ee_ueip_optin', $config->core->ee_ueip_optin);
+			update_option('ee_ueip_has_notified', true);
+		}
+		// and save it (note we're also doing the network save here)
+		$net_saved    = ! is_main_site() || EE_Network_Config::instance()->update_config(false, false);
+		$config_saved = EE_Config::instance()->update_espresso_config(false, false);
+		if ($config_saved && $net_saved) {
+			EE_Error::add_success(sprintf(esc_html__('"%s" have been successfully updated.', 'event_espresso'), $tab));
+			return true;
+		}
+		EE_Error::add_error(
+			sprintf(esc_html__('The "%s" were not updated.', 'event_espresso'), $tab),
+			$file,
+			$func,
+			$line
+		);
+		return false;
+	}
+
+
+	/**
+	 * Returns an array to be used for EE_FOrm_Fields.helper.php's select_input as the $values argument.
+	 *
+	 * @return array
+	 */
+	public function get_yes_no_values(): array
+	{
+		return $this->_yes_no_values;
+	}
+
+
+	/**
+	 * @return string
+	 * @throws ReflectionException
+	 * @since 5.0.0.p
+	 */
+	protected function _get_dir(): string
+	{
+		$reflector = new ReflectionClass($this->class_name);
+		return dirname($reflector->getFileName());
+	}
+
+
+	/**
+	 * A helper for getting a "next link".
+	 *
+	 * @param string $url   The url to link to
+	 * @param string $class The class to use.
+	 * @return string
+	 */
+	protected function _next_link(string $url, string $class = 'dashicons dashicons-arrow-right'): string
+	{
+		return '<a class="' . $class . '" href="' . $url . '"></a>';
+	}
+
+
+	/**
+	 * A helper for getting a "previous link".
+	 *
+	 * @param string $url   The url to link to
+	 * @param string $class The class to use.
+	 * @return string
+	 */
+	protected function _previous_link(string $url, string $class = 'dashicons dashicons-arrow-left'): string
+	{
+		return '<a class="' . $class . '" href="' . $url . '"></a>';
+	}
+
+
+
+
+
+
+
+	// below are some messages related methods that should be available across the EE_Admin system.  Note, these methods are NOT page specific
+
+
+	/**
+	 * This processes an request to resend a registration and assumes we have a _REG_ID for doing so. So if the caller
+	 * knows that the _REG_ID isn't in the req_data array but CAN obtain it, the caller should ADD the _REG_ID to the
+	 * _req_data array.
+	 *
+	 * @return bool success/fail
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _process_resend_registration(): bool
+	{
+		$this->_template_args['success'] = EED_Messages::process_resend($this->request->requestParams());
+		do_action(
+			'AHEE__EE_Admin_Page___process_resend_registration',
+			$this->_template_args['success'],
+			$this->request->requestParams()
+		);
+		return $this->_template_args['success'];
+	}
+
+
+	/**
+	 * This automatically processes any payment message notifications when manual payment has been applied.
+	 *
+	 * @param EE_Payment $payment
+	 * @return bool success/fail
+	 */
+	protected function _process_payment_notification(EE_Payment $payment): bool
+	{
+		add_filter('FHEE__EE_Payment_Processor__process_registration_payments__display_notifications', '__return_true');
+		do_action('AHEE__EE_Admin_Page___process_admin_payment_notification', $payment);
+		$this->_template_args['success'] = apply_filters(
+			'FHEE__EE_Admin_Page___process_admin_payment_notification__success',
+			false,
+			$payment
+		);
+		return $this->_template_args['success'];
+	}
+
+
+	/**
+	 * @param EEM_Base      $entity_model
+	 * @param string        $entity_PK_name name of the primary key field used as a request param, ie: id, ID, etc
+	 * @param string        $action         one of the EE_Admin_List_Table::ACTION_* constants: delete, restore, trash
+	 * @param string        $delete_column  name of the field that denotes whether entity is trashed
+	 * @param callable|null $callback       called after entity is trashed, restored, or deleted
+	 * @return int|float
+	 * @throws EE_Error
+	 */
+	protected function trashRestoreDeleteEntities(
+		EEM_Base $entity_model,
+		string $entity_PK_name,
+		string $action = EE_Admin_List_Table::ACTION_DELETE,
+		string $delete_column = '',
+		?callable $callback = null
+	) {
+		$entity_PK      = $entity_model->get_primary_key_field();
+		$entity_PK_name = $entity_PK_name ?: $entity_PK->get_name();
+		$entity_PK_type = $this->resolveEntityFieldDataType($entity_PK);
+		// grab ID if deleting a single entity
+		if ($this->request->requestParamIsSet($entity_PK_name)) {
+			$ID = $this->request->getRequestParam($entity_PK_name, 0, $entity_PK_type);
+			return $this->trashRestoreDeleteEntity($entity_model, $ID, $action, $delete_column, $callback) ? 1 : 0;
+		}
+		// or grab checkbox array if bulk deleting
+		$checkboxes = $this->request->getRequestParam('checkbox', [], $entity_PK_type, true);
+		if (empty($checkboxes)) {
+			return 0;
+		}
+		$success = 0;
+		$IDs     = array_keys($checkboxes);
+		// cycle thru bulk action checkboxes
+		foreach ($IDs as $ID) {
+			// increment $success
+			if ($this->trashRestoreDeleteEntity($entity_model, $ID, $action, $delete_column, $callback)) {
+				$success++;
+			}
+		}
+		$count = (int) count($checkboxes);
+		// if multiple entities were deleted successfully, then $deleted will be full count of deletions,
+		// otherwise it will be a fraction of ( actual deletions / total entities to be deleted )
+		return $success === $count ? $count : $success / $count;
+	}
+
+
+	/**
+	 * @param EE_Primary_Key_Field_Base $entity_PK
+	 * @return string
+	 * @throws EE_Error
+	 * @since   4.10.30.p
+	 */
+	private function resolveEntityFieldDataType(EE_Primary_Key_Field_Base $entity_PK): string
+	{
+		$entity_PK_type = $entity_PK->getSchemaType();
+		switch ($entity_PK_type) {
+			case 'boolean':
+				return DataType::BOOL;
+			case 'integer':
+				return DataType::INT;
+			case 'number':
+				return DataType::FLOAT;
+			case 'string':
+				return DataType::STRING;
+		}
+		throw new RuntimeException(
+			sprintf(
+				esc_html__(
+					'"%1$s" is an invalid schema type for the %2$s primary key.',
+					'event_espresso'
+				),
+				$entity_PK_type,
+				$entity_PK->get_name()
+			)
+		);
+	}
+
+
+	/**
+	 * @param EEM_Base      $entity_model
+	 * @param int|string    $entity_ID
+	 * @param string        $action        one of the EE_Admin_List_Table::ACTION_* constants: delete, restore, trash
+	 * @param string        $delete_column name of the field that denotes whether entity is trashed
+	 * @param callable|null $callback      called after entity is trashed, restored, or deleted
+	 * @return bool
+	 */
+	protected function trashRestoreDeleteEntity(
+		EEM_Base $entity_model,
+		$entity_ID,
+		string $action,
+		string $delete_column,
+		?callable $callback = null
+	): bool {
+		$entity_ID = absint($entity_ID);
+		if (! $entity_ID) {
+			$this->trashRestoreDeleteError($action, $entity_model);
+		}
+		$result = 0;
+		try {
+			$entity = $entity_model->get_one_by_ID($entity_ID);
+			if (! $entity instanceof EE_Base_Class) {
+				throw new DomainException(
+					sprintf(
+						esc_html__(
+							'Missing or invalid %1$s entity with ID of "%2$s" returned from db.',
+							'event_espresso'
+						),
+						str_replace('EEM_', '', $entity_model->get_this_model_name()),
+						$entity_ID
+					)
+				);
+			}
+			switch ($action) {
+				case EE_Admin_List_Table::ACTION_DELETE:
+					$result = (bool) $entity->delete_permanently();
+					break;
+				case EE_Admin_List_Table::ACTION_RESTORE:
+					$result = $entity->delete_or_restore(false);
+					break;
+				case EE_Admin_List_Table::ACTION_TRASH:
+					$result = $entity->delete_or_restore();
+					break;
+			}
+		} catch (Exception $exception) {
+			$this->trashRestoreDeleteError($action, $entity_model, $exception);
+		}
+		if (is_callable($callback)) {
+			call_user_func_array($callback, [$entity_model, $entity_ID, $action, $result, $delete_column]);
+		}
+		return $result;
+	}
+
+
+	/**
+	 * @param EEM_Base $entity_model
+	 * @param string   $delete_column
+	 * @since 4.10.30.p
+	 */
+	private function validateDeleteColumn(EEM_Base $entity_model, string $delete_column)
+	{
+		if (empty($delete_column)) {
+			throw new DomainException(
+				sprintf(
+					esc_html__(
+						'You need to specify the name of the "delete column" on the %2$s model, in order to trash or restore an entity.',
+						'event_espresso'
+					),
+					$entity_model->get_this_model_name()
+				)
+			);
+		}
+		if (! $entity_model->has_field($delete_column)) {
+			throw new DomainException(
+				sprintf(
+					esc_html__(
+						'The %1$s field does not exist on the %2$s model.',
+						'event_espresso'
+					),
+					$delete_column,
+					$entity_model->get_this_model_name()
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @param EEM_Base       $entity_model
+	 * @param Exception|null $exception
+	 * @param string         $action
+	 * @since 4.10.30.p
+	 */
+	private function trashRestoreDeleteError(string $action, EEM_Base $entity_model, Exception $exception = null)
+	{
+		if ($exception instanceof Exception) {
+			throw new RuntimeException(
+				sprintf(
+					esc_html__(
+						'Could not %1$s the %2$s because the following error occurred: %3$s',
+						'event_espresso'
+					),
+					$action,
+					$entity_model->get_this_model_name(),
+					$exception->getMessage()
+				)
+			);
+		}
+		throw new RuntimeException(
+			sprintf(
+				esc_html__(
+					'Could not %1$s the %2$s because an invalid ID was received.',
+					'event_espresso'
+				),
+				$action,
+				$entity_model->get_this_model_name()
+			)
+		);
+	}
 }

Spacing +173 added lines, -173 removed lines

@@ -102,7 +102,7 @@ 
      */
     protected ?bool $_is_UI_request = null;
 
-    protected bool  $_is_caf        = false;                                                                                                                                                                                                                                  // This is just a property that flags whether the given route is a caffeinated route or not.
+    protected bool  $_is_caf        = false; // This is just a property that flags whether the given route is a caffeinated route or not.
 
     protected bool  $_routing       = false;
 
@@ -597,7 +597,7 @@ 
         $ee_menu_slugs = (array) $ee_menu_slugs;
         if (
             ! $this->request->isAjax()
-            && (! $this->_current_page || ! isset($ee_menu_slugs[ $this->_current_page ]))
+            && ( ! $this->_current_page || ! isset($ee_menu_slugs[$this->_current_page]))
         ) {
             return;
         }
@@ -616,7 +616,7 @@ 
             ? $route
             : $req_action;
         $this->_current_view = $this->_req_action;
-        $this->_req_nonce    = $this->_req_action . '_nonce';
+        $this->_req_nonce    = $this->_req_action.'_nonce';
         $this->_define_page_props();
         $this->_current_page_view_url = add_query_arg(
             ['page' => $this->_current_page, 'action' => $this->_current_view],
@@ -640,33 +640,33 @@ 
         }
         // filter routes and page_config so addons can add their stuff. Filtering done per class
         $this->_page_routes = apply_filters(
-            'FHEE__' . $this->class_name . '__page_setup__page_routes',
+            'FHEE__'.$this->class_name.'__page_setup__page_routes',
             $this->_page_routes,
             $this
         );
         $this->_page_config = apply_filters(
-            'FHEE__' . $this->class_name . '__page_setup__page_config',
+            'FHEE__'.$this->class_name.'__page_setup__page_config',
             $this->_page_config,
             $this
         );
         if ($this->base_class_name !== '') {
             $this->_page_routes = apply_filters(
-                'FHEE__' . $this->base_class_name . '__page_setup__page_routes',
+                'FHEE__'.$this->base_class_name.'__page_setup__page_routes',
                 $this->_page_routes,
                 $this
             );
             $this->_page_config = apply_filters(
-                'FHEE__' . $this->base_class_name . '__page_setup__page_config',
+                'FHEE__'.$this->base_class_name.'__page_setup__page_config',
                 $this->_page_config,
                 $this
             );
         }
         // if AHEE__EE_Admin_Page__route_admin_request_$this->_current_view method is present
         // then we call it hooked into the AHEE__EE_Admin_Page__route_admin_request action
-        if (method_exists($this, 'AHEE__EE_Admin_Page__route_admin_request_' . $this->_current_view)) {
+        if (method_exists($this, 'AHEE__EE_Admin_Page__route_admin_request_'.$this->_current_view)) {
             add_action(
                 'AHEE__EE_Admin_Page__route_admin_request',
-                [$this, 'AHEE__EE_Admin_Page__route_admin_request_' . $this->_current_view],
+                [$this, 'AHEE__EE_Admin_Page__route_admin_request_'.$this->_current_view],
                 10,
                 2
             );
@@ -679,8 +679,8 @@ 
             if ($this->_is_UI_request) {
                 // admin_init stuff - global, all views for this page class, specific view
                 add_action('admin_init', [$this, 'admin_init']);
-                if (method_exists($this, 'admin_init_' . $this->_current_view)) {
-                    add_action('admin_init', [$this, 'admin_init_' . $this->_current_view], 15);
+                if (method_exists($this, 'admin_init_'.$this->_current_view)) {
+                    add_action('admin_init', [$this, 'admin_init_'.$this->_current_view], 15);
                 }
             } else {
                 // hijack regular WP loading and route admin request immediately
@@ -699,12 +699,12 @@ 
      */
     private function _do_other_page_hooks()
     {
-        $registered_pages = apply_filters('FHEE_do_other_page_hooks_' . $this->page_slug, []);
+        $registered_pages = apply_filters('FHEE_do_other_page_hooks_'.$this->page_slug, []);
         foreach ($registered_pages as $page) {
             // now let's setup the file name and class that should be present
             $classname = str_replace('.class.php', '', $page);
             // autoloaders should take care of loading file
-            if (! class_exists($classname)) {
+            if ( ! class_exists($classname)) {
                 $error_msg[] = sprintf(
                     esc_html__(
                         'Something went wrong with loading the %s admin hooks page.',
@@ -721,7 +721,7 @@ 
                                    ),
                                    $page,
                                    '<br />',
-                                   '<strong>' . $classname . '</strong>'
+                                   '<strong>'.$classname.'</strong>'
                                );
                 throw new EE_Error(implode('||', $error_msg));
             }
@@ -770,13 +770,13 @@ 
         // load admin_notices - global, page class, and view specific
         add_action('admin_notices', [$this, 'admin_notices_global'], 5);
         add_action('admin_notices', [$this, 'admin_notices']);
-        if (method_exists($this, 'admin_notices_' . $this->_current_view)) {
-            add_action('admin_notices', [$this, 'admin_notices_' . $this->_current_view], 15);
+        if (method_exists($this, 'admin_notices_'.$this->_current_view)) {
+            add_action('admin_notices', [$this, 'admin_notices_'.$this->_current_view], 15);
         }
         // load network admin_notices - global, page class, and view specific
         add_action('network_admin_notices', [$this, 'network_admin_notices_global'], 5);
-        if (method_exists($this, 'network_admin_notices_' . $this->_current_view)) {
-            add_action('network_admin_notices', [$this, 'network_admin_notices_' . $this->_current_view]);
+        if (method_exists($this, 'network_admin_notices_'.$this->_current_view)) {
+            add_action('network_admin_notices', [$this, 'network_admin_notices_'.$this->_current_view]);
         }
         // this will save any per_page screen options if they are present
         $this->_set_per_page_screen_options();
@@ -902,7 +902,7 @@ 
      */
     protected function _verify_routes(): bool
     {
-        if (! $this->_current_page && ! $this->request->isAjax()) {
+        if ( ! $this->_current_page && ! $this->request->isAjax()) {
             return false;
         }
         // check that the page_routes array is not empty
@@ -913,7 +913,7 @@ 
                 $this->_admin_page_title
             );
             // developer error msg
-            $error_msg .= '||' . $error_msg
+            $error_msg .= '||'.$error_msg
                           . esc_html__(
                               ' Make sure the "set_page_routes()" method exists, and is setting the "_page_routes" array properly.',
                               'event_espresso'
@@ -931,8 +931,8 @@ 
         }
         // and that the requested page route exists
         if (array_key_exists($this->_req_action, $this->_page_routes)) {
-            $this->_route        = $this->_page_routes[ $this->_req_action ];
-            $this->_route_config = $this->_page_config[ $this->_req_action ] ?? [];
+            $this->_route        = $this->_page_routes[$this->_req_action];
+            $this->_route_config = $this->_page_config[$this->_req_action] ?? [];
         } else {
             // user error msg
             $error_msg = sprintf(
@@ -943,7 +943,7 @@ 
                 $this->_admin_page_title
             );
             // developer error msg
-            $error_msg .= '||' . $error_msg
+            $error_msg .= '||'.$error_msg
                           . sprintf(
                               esc_html__(
                                   ' Create a key in the "_page_routes" array named "%s" and set its value to the appropriate method.',
@@ -954,7 +954,7 @@ 
             throw new EE_Error($error_msg);
         }
         // and that a default route exists
-        if (! array_key_exists('default', $this->_page_routes)) {
+        if ( ! array_key_exists('default', $this->_page_routes)) {
             // user error msg
             $error_msg = sprintf(
                 esc_html__(
@@ -964,7 +964,7 @@ 
                 $this->_admin_page_title
             );
             // developer error msg
-            $error_msg .= '||' . $error_msg
+            $error_msg .= '||'.$error_msg
                           . esc_html__(
                               ' Create a key in the "_page_routes" array named "default" and set its value to your default page method.',
                               'event_espresso'
@@ -1004,7 +1004,7 @@ 
             $this->_admin_page_title
         );
         // developer error msg
-        $error_msg .= '||' . $error_msg
+        $error_msg .= '||'.$error_msg
                       . sprintf(
                           esc_html__(
                               ' Check the route you are using in your method (%s) and make sure it matches a route set in your "_page_routes" array property',
@@ -1032,7 +1032,7 @@ 
     protected function _verify_nonce(string $nonce, string $nonce_ref)
     {
         // verify nonce against expected value
-        if (! wp_verify_nonce($nonce, $nonce_ref)) {
+        if ( ! wp_verify_nonce($nonce, $nonce_ref)) {
             // these are not the droids you are looking for !!!
             $msg = sprintf(
                 esc_html__('%sNonce Fail.%s', 'event_espresso'),
@@ -1049,7 +1049,7 @@ 
                     __CLASS__
                 );
             }
-            if (! $this->request->isAjax()) {
+            if ( ! $this->request->isAjax()) {
                 wp_die($msg);
             }
             EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
@@ -1074,7 +1074,7 @@ 
      */
     protected function _route_admin_request()
     {
-        if (! $this->_is_UI_request) {
+        if ( ! $this->_is_UI_request) {
             $this->_verify_routes();
         }
         $nonce_check = ! isset($this->_route_config['require_nonce']) || $this->_route_config['require_nonce'];
@@ -1094,7 +1094,7 @@ 
 
         // action right before calling route
         // (hook is something like 'AHEE__Registrations_Admin_Page__route_admin_request')
-        if (! did_action('AHEE__EE_Admin_Page__route_admin_request')) {
+        if ( ! did_action('AHEE__EE_Admin_Page__route_admin_request')) {
             do_action('AHEE__EE_Admin_Page__route_admin_request', $this->_current_view, $this);
         }
         // strip _wp_http_referer from the server REQUEST_URI
@@ -1109,7 +1109,7 @@ 
         $this->request->setRequestParam('_wp_http_referer', $cleaner_request_uri, true);
         $this->request->setServerParam('REQUEST_URI', $cleaner_request_uri, true);
         $route_callback = [];
-        if (! empty($func)) {
+        if ( ! empty($func)) {
             if (is_array($func)) {
                 $route_callback = $func;
             } elseif (is_string($func)) {
@@ -1123,7 +1123,7 @@ 
             }
             [$class, $method] = $route_callback;
             // is it neither a class method NOR a standalone function?
-            if (! is_callable($route_callback)) {
+            if ( ! is_callable($route_callback)) {
                 // user error msg
                 $error_msg = esc_html__(
                     'An error occurred. The  requested page route could not be found.',
@@ -1150,7 +1150,7 @@ 
             } catch (Throwable $throwable) {
                 $nice_args = [];
                 foreach ($args as $key => $arg) {
-                    $nice_args[ $key ] = is_object($arg) ? get_class($arg) : $key;
+                    $nice_args[$key] = is_object($arg) ? get_class($arg) : $key;
                 }
                 new ExceptionStackTraceDisplay(
                     new RuntimeException(
@@ -1254,7 +1254,7 @@ 
                 if (strpos($key, 'nonce') !== false) {
                     continue;
                 }
-                $args[ 'wp_referer[' . $key . ']' ] = is_string($value) ? htmlspecialchars($value) : $value;
+                $args['wp_referer['.$key.']'] = is_string($value) ? htmlspecialchars($value) : $value;
             }
         }
         return EEH_URL::add_query_args_and_nonce($args, $url, $exclude_nonce, $context);
@@ -1294,12 +1294,12 @@ 
      */
     protected function _add_help_tabs()
     {
-        if (isset($this->_page_config[ $this->_req_action ])) {
-            $config = $this->_page_config[ $this->_req_action ];
+        if (isset($this->_page_config[$this->_req_action])) {
+            $config = $this->_page_config[$this->_req_action];
             // let's see if there is a help_sidebar set for the current route and we'll set that up for usage as well.
             if (is_array($config) && isset($config['help_sidebar'])) {
                 // check that the callback given is valid
-                if (! method_exists($this, $config['help_sidebar'])) {
+                if ( ! method_exists($this, $config['help_sidebar'])) {
                     throw new EE_Error(
                         sprintf(
                             esc_html__(
@@ -1312,18 +1312,18 @@ 
                     );
                 }
                 $content = apply_filters(
-                    'FHEE__' . $this->class_name . '__add_help_tabs__help_sidebar',
+                    'FHEE__'.$this->class_name.'__add_help_tabs__help_sidebar',
                     $this->{$config['help_sidebar']}()
                 );
                 $this->_current_screen->set_help_sidebar($content);
             }
-            if (! isset($config['help_tabs'])) {
+            if ( ! isset($config['help_tabs'])) {
                 return;
             } //no help tabs for this route
             foreach ((array) $config['help_tabs'] as $tab_id => $cfg) {
                 // we're here so there ARE help tabs!
                 // make sure we've got what we need
-                if (! isset($cfg['title'])) {
+                if ( ! isset($cfg['title'])) {
                     throw new EE_Error(
                         esc_html__(
                             'The _page_config array is not set up properly for help tabs.  It is missing a title',
@@ -1331,7 +1331,7 @@ 
                         )
                     );
                 }
-                if (! isset($cfg['filename']) && ! isset($cfg['callback']) && ! isset($cfg['content'])) {
+                if ( ! isset($cfg['filename']) && ! isset($cfg['callback']) && ! isset($cfg['content'])) {
                     throw new EE_Error(
                         esc_html__(
                             'The _page_config array is not setup properly for help tabs. It is missing a either a filename reference, or a callback reference or a content reference so there is no way to know the content for the help tab',
@@ -1340,11 +1340,11 @@ 
                     );
                 }
                 // first priority goes to content.
-                if (! empty($cfg['content'])) {
+                if ( ! empty($cfg['content'])) {
                     $content = $cfg['content'];
                     // second priority goes to filename
-                } elseif (! empty($cfg['filename'])) {
-                    $file_path = $this->_get_dir() . '/help_tabs/' . $cfg['filename'] . '.help_tab.php';
+                } elseif ( ! empty($cfg['filename'])) {
+                    $file_path = $this->_get_dir().'/help_tabs/'.$cfg['filename'].'.help_tab.php';
                     // it's possible that the file is located on decaf route (and above sets up for caf route, if this is the case then lets check decaf route too)
                     $file_path = ! is_readable($file_path) ? EE_ADMIN_PAGES
                                                              . basename($this->_get_dir())
@@ -1352,7 +1352,7 @@ 
                                                              . $cfg['filename']
                                                              . '.help_tab.php' : $file_path;
                     // if file is STILL not readable then let's do a EE_Error so its more graceful than a fatal error.
-                    if (! isset($cfg['callback']) && ! is_readable($file_path)) {
+                    if ( ! isset($cfg['callback']) && ! is_readable($file_path)) {
                         EE_Error::add_error(
                             sprintf(
                                 esc_html__(
@@ -1400,7 +1400,7 @@ 
                     return;
                 }
                 // setup config array for help tab method
-                $id  = $this->page_slug . '-' . $this->_req_action . '-' . $tab_id;
+                $id  = $this->page_slug.'-'.$this->_req_action.'-'.$tab_id;
                 $_ht = [
                     'id'       => $id,
                     'title'    => $cfg['title'],
@@ -1426,8 +1426,8 @@ 
             $qtips = (array) $this->_route_config['qtips'];
             // load qtip loader
             $path = [
-                $this->_get_dir() . '/qtips/',
-                EE_ADMIN_PAGES . basename($this->_get_dir()) . '/qtips/',
+                $this->_get_dir().'/qtips/',
+                EE_ADMIN_PAGES.basename($this->_get_dir()).'/qtips/',
             ];
             EEH_Qtip_Loader::instance()->register($qtips, $path);
         }
@@ -1449,7 +1449,7 @@ 
         $i        = 0;
         $only_tab = count($this->_page_config) < 2;
         foreach ($this->_page_config as $slug => $config) {
-            if (! is_array($config) || empty($config['nav'])) {
+            if ( ! is_array($config) || empty($config['nav'])) {
                 continue;
             }
             // no nav tab for this config
@@ -1458,7 +1458,7 @@ 
                 // nav tab is only to appear when route requested.
                 continue;
             }
-            if (! $this->check_user_access($slug, true)) {
+            if ( ! $this->check_user_access($slug, true)) {
                 // no nav tab because current user does not have access.
                 continue;
             }
@@ -1466,20 +1466,20 @@ 
             $css_class .= $only_tab ? ' ee-only-tab' : '';
             $css_class .= " ee-nav-tab__$slug";
 
-            $this->_nav_tabs[ $slug ] = [
+            $this->_nav_tabs[$slug] = [
                 'url'       => $config['nav']['url'] ?? EE_Admin_Page::add_query_args_and_nonce(
                         ['action' => $slug],
                         $this->_admin_base_url
                     ),
                 'link_text' => $this->navTabLabel($config['nav'], $slug),
-                'css_class' => $this->_req_action === $slug ? $css_class . ' nav-tab-active' : $css_class,
+                'css_class' => $this->_req_action === $slug ? $css_class.' nav-tab-active' : $css_class,
                 'order'     => $config['nav']['order'] ?? $i,
             ];
             $i++;
         }
         // if $this->_nav_tabs is empty then lets set the default
         if (empty($this->_nav_tabs)) {
-            $this->_nav_tabs[ $this->_default_nav_tab_name ] = [
+            $this->_nav_tabs[$this->_default_nav_tab_name] = [
                 'url'       => $this->_admin_base_url,
                 'link_text' => ucwords(str_replace('_', ' ', $this->_default_nav_tab_name)),
                 'css_class' => 'nav-tab-active',
@@ -1495,11 +1495,11 @@ 
     {
         $label = $nav_tab['label'] ?? ucwords(str_replace('_', ' ', $slug));
         $icon  = $nav_tab['icon'] ?? null;
-        $icon  = $icon ? '<span class="dashicons ' . $icon . '"></span>' : '';
+        $icon  = $icon ? '<span class="dashicons '.$icon.'"></span>' : '';
         return '
             <span class="ee-admin-screen-tab__label">
-                ' . $icon . '
-                <span class="ee-nav-label__text">' . $label . '</span>
+                ' . $icon.'
+                <span class="ee-nav-label__text">' . $label.'</span>
             </span>';
     }
 
@@ -1517,10 +1517,10 @@ 
             foreach ($this->_route_config['labels'] as $label => $text) {
                 if (is_array($text)) {
                     foreach ($text as $sublabel => $subtext) {
-                        $this->_labels[ $label ][ $sublabel ] = $subtext;
+                        $this->_labels[$label][$sublabel] = $subtext;
                     }
                 } else {
-                    $this->_labels[ $label ] = $text;
+                    $this->_labels[$label] = $text;
                 }
             }
         }
@@ -1546,10 +1546,10 @@ 
             : $this->_req_action;
         $route_to_check = ! empty($route_to_check) ? $route_to_check : $req_action;
         $capability     = ! empty($route_to_check)
-                          && isset($this->_page_routes[ $route_to_check ])
-                          && is_array($this->_page_routes[ $route_to_check ])
-                          && ! empty($this->_page_routes[ $route_to_check ]['capability'])
-            ? $this->_page_routes[ $route_to_check ]['capability']
+                          && isset($this->_page_routes[$route_to_check])
+                          && is_array($this->_page_routes[$route_to_check])
+                          && ! empty($this->_page_routes[$route_to_check]['capability'])
+            ? $this->_page_routes[$route_to_check]['capability']
             : null;
 
         if (empty($capability) && empty($route_to_check)) {
@@ -1599,14 +1599,14 @@ 
         string $priority = 'default',
         ?array $callback_args = null
     ) {
-        if (! (is_callable($callback) || ! function_exists($callback))) {
+        if ( ! (is_callable($callback) || ! function_exists($callback))) {
             return;
         }
 
         add_meta_box($box_id, $title, $callback, $screen, $context, $priority, $callback_args);
         add_filter(
             "postbox_classes_{$this->_wp_page_slug}_$box_id",
-            function ($classes) {
+            function($classes) {
                 $classes[] = 'ee-admin-container';
                 return $classes;
             }
@@ -1700,7 +1700,7 @@ 
         ';
 
         // current set timezone for timezone js
-        echo '<span id="current_timezone" class="hidden">' . esc_html(EEH_DTT_Helper::get_timezone()) . '</span>';
+        echo '<span id="current_timezone" class="hidden">'.esc_html(EEH_DTT_Helper::get_timezone()).'</span>';
     }
 
 
@@ -1734,7 +1734,7 @@ 
         // loop through the array and setup content
         foreach ($help_array as $trigger => $help) {
             // make sure the array is setup properly
-            if (! isset($help['title'], $help['content'])) {
+            if ( ! isset($help['title'], $help['content'])) {
                 throw new EE_Error(
                     esc_html__(
                         'Does not look like the popup content array has been setup correctly.  Might want to double check that.  Read the comments for the _get_help_popup_content method found in "EE_Admin_Page" class',
@@ -1748,8 +1748,8 @@ 
                 'help_popup_title'   => $help['title'],
                 'help_popup_content' => $help['content'],
             ];
-            $content       .= EEH_Template::display_template(
-                EE_ADMIN_TEMPLATE . 'admin_help_popup.template.php',
+            $content .= EEH_Template::display_template(
+                EE_ADMIN_TEMPLATE.'admin_help_popup.template.php',
                 $template_args,
                 true
             );
@@ -1771,15 +1771,15 @@ 
     private function _get_help_content(): array
     {
         // what is the method we're looking for?
-        $method_name = '_help_popup_content_' . $this->_req_action;
+        $method_name = '_help_popup_content_'.$this->_req_action;
         // if method doesn't exist let's get out.
-        if (! method_exists($this, $method_name)) {
+        if ( ! method_exists($this, $method_name)) {
             return [];
         }
         // k we're good to go let's retrieve the help array
         $help_array = $this->{$method_name}();
         // make sure we've got an array!
-        if (! is_array($help_array)) {
+        if ( ! is_array($help_array)) {
             throw new EE_Error(
                 esc_html__(
                     'Something went wrong with help popup content generation. Expecting an array and well, this ain\'t no array bub.',
@@ -1811,15 +1811,15 @@ 
         // let's check and see if there is any content set for this popup.  If there isn't then we'll include a default title and content so that developers know something needs to be corrected
         $help_array   = $this->_get_help_content();
         $help_content = '';
-        if (empty($help_array) || ! isset($help_array[ $trigger_id ])) {
-            $help_array[ $trigger_id ] = [
+        if (empty($help_array) || ! isset($help_array[$trigger_id])) {
+            $help_array[$trigger_id] = [
                 'title'   => esc_html__('Missing Content', 'event_espresso'),
                 'content' => esc_html__(
                     'A trigger has been set that doesn\'t have any corresponding content. Make sure you have set the help content. (see the "_set_help_popup_content" method in the EE_Admin_Page for instructions.)',
                     'event_espresso'
                 ),
             ];
-            $help_content              = $this->_set_help_popup_content($help_array);
+            $help_content = $this->_set_help_popup_content($help_array);
         }
         $height   = esc_attr($dimensions[0]) ?? 400;
         $width    = esc_attr($dimensions[1]) ?? 640;
@@ -1907,7 +1907,7 @@ 
 
         add_filter(
             'admin_body_class',
-            function ($classes) {
+            function($classes) {
                 if (strpos($classes, 'espresso-admin') === false) {
                     $classes .= ' espresso-admin';
                 }
@@ -1998,12 +1998,12 @@ 
     protected function _set_list_table()
     {
         // first is this a list_table view?
-        if (! isset($this->_route_config['list_table'])) {
+        if ( ! isset($this->_route_config['list_table'])) {
             return;
         } //not a list_table view so get out.
         // list table functions are per view specific (because some admin pages might have more than one list table!)
-        $list_table_view = '_set_list_table_views_' . $this->_req_action;
-        if (! method_exists($this, $list_table_view) || $this->{$list_table_view}() === false) {
+        $list_table_view = '_set_list_table_views_'.$this->_req_action;
+        if ( ! method_exists($this, $list_table_view) || $this->{$list_table_view}() === false) {
             // user error msg
             $error_msg = esc_html__(
                 'An error occurred. The requested list table views could not be found.',
@@ -2023,10 +2023,10 @@ 
         }
         // let's provide the ability to filter the views per PAGE AND ROUTE, per PAGE, and globally
         $this->_views = apply_filters(
-            'FHEE_list_table_views_' . $this->page_slug . '_' . $this->_req_action,
+            'FHEE_list_table_views_'.$this->page_slug.'_'.$this->_req_action,
             $this->_views
         );
-        $this->_views = apply_filters('FHEE_list_table_views_' . $this->page_slug, $this->_views);
+        $this->_views = apply_filters('FHEE_list_table_views_'.$this->page_slug, $this->_views);
         $this->_views = apply_filters('FHEE_list_table_views', $this->_views);
         $this->_set_list_table_view();
         $this->_set_list_table_object();
@@ -2061,7 +2061,7 @@ 
     protected function _set_list_table_object()
     {
         if (isset($this->_route_config['list_table'])) {
-            if (! class_exists($this->_route_config['list_table'])) {
+            if ( ! class_exists($this->_route_config['list_table'])) {
                 throw new EE_Error(
                     sprintf(
                         esc_html__(
@@ -2102,17 +2102,17 @@ 
         foreach ($this->_views as $key => $view) {
             $query_args = [];
             // check for current view
-            $this->_views[ $key ]['class']               = $this->_view === $view['slug'] ? 'current' : '';
+            $this->_views[$key]['class']               = $this->_view === $view['slug'] ? 'current' : '';
             $query_args['action']                        = $this->_req_action;
-            $query_args[ $this->_req_action . '_nonce' ] = wp_create_nonce($query_args['action'] . '_nonce');
+            $query_args[$this->_req_action.'_nonce'] = wp_create_nonce($query_args['action'].'_nonce');
             $query_args['status']                        = $view['slug'];
             // merge any other arguments sent in.
-            if (isset($extra_query_args[ $view['slug'] ])) {
-                foreach ($extra_query_args[ $view['slug'] ] as $extra_query_arg) {
+            if (isset($extra_query_args[$view['slug']])) {
+                foreach ($extra_query_args[$view['slug']] as $extra_query_arg) {
                     $query_args[] = $extra_query_arg;
                 }
             }
-            $this->_views[ $key ]['url'] = EE_Admin_Page::add_query_args_and_nonce($query_args, $this->_admin_base_url);
+            $this->_views[$key]['url'] = EE_Admin_Page::add_query_args_and_nonce($query_args, $this->_admin_base_url);
         }
         return $this->_views;
     }
@@ -2142,14 +2142,14 @@ 
 					<select id="entries-per-page-slct" name="entries-per-page-slct">';
         foreach ($values as $value) {
             if ($value < $max_entries) {
-                $selected                  = $value === $per_page ? ' selected="' . $per_page . '"' : '';
+                $selected = $value === $per_page ? ' selected="'.$per_page.'"' : '';
                 $entries_per_page_dropdown .= '
-						<option value="' . $value . '"' . $selected . '>' . $value . '&nbsp;&nbsp;</option>';
+						<option value="' . $value.'"'.$selected.'>'.$value.'&nbsp;&nbsp;</option>';
             }
         }
-        $selected                  = $max_entries === $per_page ? ' selected="' . $per_page . '"' : '';
+        $selected = $max_entries === $per_page ? ' selected="'.$per_page.'"' : '';
         $entries_per_page_dropdown .= '
-						<option value="' . $max_entries . '"' . $selected . '>All&nbsp;&nbsp;</option>';
+						<option value="' . $max_entries.'"'.$selected.'>All&nbsp;&nbsp;</option>';
         $entries_per_page_dropdown .= '
 					</select>
 					entries
@@ -2173,7 +2173,7 @@ 
             empty($this->_search_btn_label) ? $this->page_label
                 : $this->_search_btn_label
         );
-        $this->_template_args['search']['callback']  = 'search_' . $this->page_slug;
+        $this->_template_args['search']['callback'] = 'search_'.$this->page_slug;
     }
 
 
@@ -2234,7 +2234,7 @@ 
                                   );
                     throw new EE_Error($error_msg);
                 }
-                unset($this->_route_config['metaboxes'][ $key ]);
+                unset($this->_route_config['metaboxes'][$key]);
             }
         }
     }
@@ -2267,7 +2267,7 @@ 
             $total_columns                                       = ! empty($screen_columns)
                 ? $screen_columns
                 : $this->_route_config['columns'][1];
-            $this->_template_args['current_screen_widget_class'] = 'columns-' . $total_columns;
+            $this->_template_args['current_screen_widget_class'] = 'columns-'.$total_columns;
             $this->_template_args['current_page']                = $this->_wp_page_slug;
             $this->_template_args['screen']                      = $this->_current_screen;
             $this->_column_template_path                         = EE_ADMIN_TEMPLATE
@@ -2313,7 +2313,7 @@ 
      */
     protected function _espresso_ratings_request()
     {
-        if (! apply_filters('FHEE_show_ratings_request_meta_box', true)) {
+        if ( ! apply_filters('FHEE_show_ratings_request_meta_box', true)) {
             return;
         }
         $ratings_box_title = apply_filters(
@@ -2340,28 +2340,28 @@ 
      */
     public function espresso_ratings_request()
     {
-        EEH_Template::display_template(EE_ADMIN_TEMPLATE . 'espresso_ratings_request_content.template.php');
+        EEH_Template::display_template(EE_ADMIN_TEMPLATE.'espresso_ratings_request_content.template.php');
     }
 
 
     public static function cached_rss_display(string $rss_id, string $url): bool
     {
-        $loading   = '<p class="widget-loading hide-if-no-js">'
+        $loading = '<p class="widget-loading hide-if-no-js">'
                      . esc_html__('Loading&#8230;', 'event_espresso')
                      . '</p><p class="hide-if-js">'
                      . esc_html__('This widget requires JavaScript.', 'event_espresso')
                      . '</p>';
-        $pre       = '<div class="espresso-rss-display">' . "\n\t";
-        $pre       .= '<span id="' . esc_attr($rss_id) . '_url" class="hidden">' . esc_url_raw($url) . '</span>';
-        $post      = '</div>' . "\n";
-        $cache_key = 'ee_rss_' . md5($rss_id);
+        $pre       = '<div class="espresso-rss-display">'."\n\t";
+        $pre .= '<span id="'.esc_attr($rss_id).'_url" class="hidden">'.esc_url_raw($url).'</span>';
+        $post      = '</div>'."\n";
+        $cache_key = 'ee_rss_'.md5($rss_id);
         $output    = get_transient($cache_key);
         if ($output !== false) {
-            echo wp_kses($pre . $output . $post, AllowedTags::getWithFormTags());
+            echo wp_kses($pre.$output.$post, AllowedTags::getWithFormTags());
             return true;
         }
-        if (! (defined('DOING_AJAX') && DOING_AJAX)) {
-            echo wp_kses($pre . $loading . $post, AllowedTags::getWithFormTags());
+        if ( ! (defined('DOING_AJAX') && DOING_AJAX)) {
+            echo wp_kses($pre.$loading.$post, AllowedTags::getWithFormTags());
             return false;
         }
         ob_start();
@@ -2428,7 +2428,7 @@ 
     public function espresso_sponsors_post_box()
     {
         EEH_Template::display_template(
-            EE_ADMIN_TEMPLATE . 'admin_general_metabox_contents_espresso_sponsors.template.php'
+            EE_ADMIN_TEMPLATE.'admin_general_metabox_contents_espresso_sponsors.template.php'
         );
     }
 
@@ -2445,9 +2445,9 @@ 
     protected function getPublishBoxTitle(): string
     {
         $publish_box_title = esc_html__('Publish', 'event_espresso');
-        if (! empty($this->_labels['publishbox'])) {
+        if ( ! empty($this->_labels['publishbox'])) {
             if (is_array($this->_labels['publishbox'])) {
-                $publish_box_title = $this->_labels['publishbox'][ $this->_req_action ] ?? $publish_box_title;
+                $publish_box_title = $this->_labels['publishbox'][$this->_req_action] ?? $publish_box_title;
             } else {
                 $publish_box_title = $this->_labels['publishbox'];
             }
@@ -2497,7 +2497,7 @@ 
         // if we have extra content set let's add it in if not make sure its empty
         $this->_template_args['publish_box_extra_content'] = $this->_template_args['publish_box_extra_content'] ?? '';
         echo EEH_Template::display_template(
-            EE_ADMIN_TEMPLATE . 'admin_details_publish_metabox.template.php',
+            EE_ADMIN_TEMPLATE.'admin_details_publish_metabox.template.php',
             $this->_template_args,
             true
         );
@@ -2550,10 +2550,10 @@ 
                 'submitdelete deletion button button--outline button--caution'
             );
         }
-        if (! isset($this->_template_args['publish_delete_link'])) {
+        if ( ! isset($this->_template_args['publish_delete_link'])) {
             $this->_template_args['publish_delete_link'] = '';
         }
-        if (! empty($name) && ! empty($id)) {
+        if ( ! empty($name) && ! empty($id)) {
             $this->addPublishPostMetaBoxHiddenFields($name, ['type' => 'hidden', 'value' => $id]);
         }
         $hidden_fields = $this->_generate_admin_form_fields($this->publish_post_meta_box_hidden_fields, 'array');
@@ -2586,7 +2586,7 @@ 
 
     protected function addPublishPostMetaBoxHiddenFields(string $field_name, array $field_attributes)
     {
-        $this->publish_post_meta_box_hidden_fields[ $field_name ] = $field_attributes;
+        $this->publish_post_meta_box_hidden_fields[$field_name] = $field_attributes;
     }
 
 
@@ -2688,7 +2688,7 @@ 
         }
         // if $create_func is true (default) then we automatically create the function for displaying the actual meta box.  If false then we take the $callback reference passed through and use it instead (so callers can define their own callback function/method if they wish)
         $call_back_func = $create_func
-            ? static function ($post, $metabox) {
+            ? static function($post, $metabox) {
                 do_action('AHEE_log', __FILE__, __FUNCTION__, '');
                 echo EEH_Template::display_template(
                     $metabox['args']['template_path'],
@@ -2698,7 +2698,7 @@ 
             }
             : $callback;
         $this->addMetaBox(
-            str_replace('_', '-', $action) . '-mbox',
+            str_replace('_', '-', $action).'-mbox',
             $title,
             $call_back_func,
             $this->_wp_page_slug,
@@ -2814,13 +2814,13 @@ 
                                                                     'event-espresso_page_espresso_',
                                                                     '',
                                                                     $this->_wp_page_slug
-                                                                ) . ' ' . $this->_req_action . '-route';
+                                                                ).' '.$this->_req_action.'-route';
 
         $template_path = $sidebar
             ? EE_ADMIN_TEMPLATE . 'admin_details_wrapper.template.php'
-            : EE_ADMIN_TEMPLATE . 'admin_details_wrapper_no_sidebar.template.php';
+            : EE_ADMIN_TEMPLATE.'admin_details_wrapper_no_sidebar.template.php';
         if ($this->request->isAjax()) {
-            $template_path = EE_ADMIN_TEMPLATE . 'admin_details_wrapper_no_sidebar_ajax.template.php';
+            $template_path = EE_ADMIN_TEMPLATE.'admin_details_wrapper_no_sidebar_ajax.template.php';
         }
         $template_path = ! empty($this->_column_template_path) ? $this->_column_template_path : $template_path;
 
@@ -2854,11 +2854,11 @@ 
     public function display_admin_caf_preview_page(string $utm_campaign_source = '', bool $display_sidebar = true)
     {
         // let's generate a default preview action button if there isn't one already present.
-        $this->_labels['buttons']['buy_now']           = esc_html__(
+        $this->_labels['buttons']['buy_now'] = esc_html__(
             'Upgrade to Event Espresso 4 Right Now',
             'event_espresso'
         );
-        $buy_now_url                                   = add_query_arg(
+        $buy_now_url = add_query_arg(
             [
                 'ee_ver'       => 'ee4',
                 'utm_source'   => 'ee4_plugin_admin',
@@ -2878,8 +2878,8 @@ 
                 true
             )
             : $this->_template_args['preview_action_button'];
-        $this->_template_args['admin_page_content']    = EEH_Template::display_template(
-            EE_ADMIN_TEMPLATE . 'admin_caf_full_page_preview.template.php',
+        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
+            EE_ADMIN_TEMPLATE.'admin_caf_full_page_preview.template.php',
             $this->_template_args,
             true
         );
@@ -2937,7 +2937,7 @@ 
         // setup search attributes
         $this->_set_search_attributes();
         $this->_template_args['current_page']     = $this->_wp_page_slug;
-        $template_path                            = EE_ADMIN_TEMPLATE . 'admin_list_wrapper.template.php';
+        $template_path                            = EE_ADMIN_TEMPLATE.'admin_list_wrapper.template.php';
         $this->_template_args['table_url']        = $this->request->isAjax()
             ? add_query_arg(['noheader' => 'true', 'route' => $this->_req_action], $this->_admin_base_url)
             : add_query_arg(['route' => $this->_req_action], $this->_admin_base_url);
@@ -2945,10 +2945,10 @@ 
         $this->_template_args['current_route']    = $this->_req_action;
         $this->_template_args['list_table_class'] = get_class($this->_list_table_object);
         $ajax_sorting_callback                    = $this->_list_table_object->get_ajax_sorting_callback();
-        if (! empty($ajax_sorting_callback)) {
+        if ( ! empty($ajax_sorting_callback)) {
             $sortable_list_table_form_fields = wp_nonce_field(
-                $ajax_sorting_callback . '_nonce',
-                $ajax_sorting_callback . '_nonce',
+                $ajax_sorting_callback.'_nonce',
+                $ajax_sorting_callback.'_nonce',
                 false,
                 false
             );
@@ -2965,18 +2965,18 @@ 
 
         $hidden_form_fields = $this->_template_args['list_table_hidden_fields'] ?? '';
 
-        $nonce_ref          = $this->_req_action . '_nonce';
+        $nonce_ref          = $this->_req_action.'_nonce';
         $hidden_form_fields .= '
-            <input type="hidden" name="' . $nonce_ref . '" value="' . wp_create_nonce($nonce_ref) . '">';
+            <input type="hidden" name="' . $nonce_ref.'" value="'.wp_create_nonce($nonce_ref).'">';
 
         $this->_template_args['list_table_hidden_fields'] = $hidden_form_fields;
         // display message about search results?
-        $search                                    = $this->request->getRequestParam('s');
+        $search = $this->request->getRequestParam('s');
         $this->_template_args['before_list_table'] .= ! empty($search)
-            ? '<p class="ee-search-results">' . sprintf(
+            ? '<p class="ee-search-results">'.sprintf(
                 esc_html__('Displaying search results for the search string: %1$s', 'event_espresso'),
                 trim($search, '%')
-            ) . '</p>'
+            ).'</p>'
             : '';
         // filter before_list_table template arg
         $this->_template_args['before_list_table'] = apply_filters(
@@ -3010,7 +3010,7 @@ 
         // convert to array and filter again
         // arrays are easier to inject new items in a specific location,
         // but would not be backwards compatible, so we have to add a new filter
-        $this->_template_args['after_list_table']   = implode(
+        $this->_template_args['after_list_table'] = implode(
             " \n",
             (array) apply_filters(
                 'FHEE__EE_Admin_Page___display_admin_list_table_page__after_list_table__template_args_array',
@@ -3065,7 +3065,7 @@ 
             $this->page_slug
         );
         return EEH_Template::display_template(
-            EE_ADMIN_TEMPLATE . 'admin_details_legend.template.php',
+            EE_ADMIN_TEMPLATE.'admin_details_legend.template.php',
             $this->_template_args,
             true
         );
@@ -3188,7 +3188,7 @@ 
         if ($this->request->isAjax()) {
             $this->_template_args['admin_page_content'] = EEH_Template::display_template(
             // $template_path,
-                EE_ADMIN_TEMPLATE . 'admin_wrapper_ajax.template.php',
+                EE_ADMIN_TEMPLATE.'admin_wrapper_ajax.template.php',
                 $this->_template_args,
                 true
             );
@@ -3197,7 +3197,7 @@ 
         // load settings page wrapper template
         $template_path = $about
             ? EE_ADMIN_TEMPLATE . 'about_admin_wrapper.template.php'
-            : EE_ADMIN_TEMPLATE . 'admin_wrapper.template.php';
+            : EE_ADMIN_TEMPLATE.'admin_wrapper.template.php';
 
         EEH_Template::display_template($template_path, $this->_template_args);
     }
@@ -3281,12 +3281,12 @@ 
         $default_names = ['save', 'save_and_close'];
         $buttons       = '';
         foreach ($button_text as $key => $button) {
-            $ref     = $default_names[ $key ];
-            $name    = ! empty($actions) ? $actions[ $key ] : $ref;
-            $buttons .= '<input type="submit" class="button button--primary ' . $ref . '" '
-                        . 'value="' . $button . '" name="' . $name . '" '
-                        . 'id="' . $this->_current_view . '_' . $ref . '" />';
-            if (! $both) {
+            $ref     = $default_names[$key];
+            $name    = ! empty($actions) ? $actions[$key] : $ref;
+            $buttons .= '<input type="submit" class="button button--primary '.$ref.'" '
+                        . 'value="'.$button.'" name="'.$name.'" '
+                        . 'id="'.$this->_current_view.'_'.$ref.'" />';
+            if ( ! $both) {
                 break;
             }
         }
@@ -3327,13 +3327,13 @@ 
                 'An error occurred. No action was set for this page\'s form.',
                 'event_espresso'
             );
-            $dev_msg  = $user_msg . "\n"
+            $dev_msg = $user_msg."\n"
                         . sprintf(
                             esc_html__('The $route argument is required for the %s->%s method.', 'event_espresso'),
                             __FUNCTION__,
                             __CLASS__
                         );
-            EE_Error::add_error($user_msg . '||' . $dev_msg, __FILE__, __FUNCTION__, __LINE__);
+            EE_Error::add_error($user_msg.'||'.$dev_msg, __FILE__, __FUNCTION__, __LINE__);
         }
         // open form
         $action                                            = $this->_admin_base_url;
@@ -3341,9 +3341,9 @@ 
             <form name='form' method='post' action='$action' id='{$route}_event_form' class='ee-admin-page-form' >
             ";
         // add nonce
-        $nonce                                             =
-            wp_nonce_field($route . '_nonce', $route . '_nonce', false, false);
-        $this->_template_args['before_admin_page_content'] .= "\n\t" . $nonce;
+        $nonce =
+            wp_nonce_field($route.'_nonce', $route.'_nonce', false, false);
+        $this->_template_args['before_admin_page_content'] .= "\n\t".$nonce;
         // add REQUIRED form action
         $hidden_fields = [
             'action' => ['type' => 'hidden', 'value' => $route],
@@ -3356,7 +3356,7 @@ 
         $form_fields = $this->_generate_admin_form_fields($hidden_fields, 'array');
         // add fields to form
         foreach ((array) $form_fields as $form_field) {
-            $this->_template_args['before_admin_page_content'] .= "\n\t" . $form_field['field'];
+            $this->_template_args['before_admin_page_content'] .= "\n\t".$form_field['field'];
         }
         // close form
         $this->_template_args['after_admin_page_content'] = '</form>';
@@ -3439,10 +3439,10 @@ 
     ) {
         $notices = EE_Error::get_notices(false);
         // overwrite default success messages //BUT ONLY if overwrite not overridden
-        if (! $override_overwrite || ! empty($notices['errors'])) {
+        if ( ! $override_overwrite || ! empty($notices['errors'])) {
             EE_Error::overwrite_success();
         }
-        if (! $override_overwrite && ! empty($what) && ! empty($action_desc) && empty($notices['errors'])) {
+        if ( ! $override_overwrite && ! empty($what) && ! empty($action_desc) && empty($notices['errors'])) {
             // how many records affected ? more than one record ? or just one ?
             EE_Error::add_success(
                 sprintf(
@@ -3493,7 +3493,7 @@ 
             $redirect_url = admin_url('admin.php');
         }
         // merge any default query_args set in _default_route_query_args property
-        if (! empty($this->_default_route_query_args) && ! $this->_is_UI_request) {
+        if ( ! empty($this->_default_route_query_args) && ! $this->_is_UI_request) {
             $args_to_merge = [];
             foreach ($this->_default_route_query_args as $query_param => $query_value) {
                 // is there a wp_referer array in our _default_route_query_args property?
@@ -3505,15 +3505,15 @@ 
                         }
                         // finally we will override any arguments in the referer with
                         // what might be set on the _default_route_query_args array.
-                        if (isset($this->_default_route_query_args[ $reference ])) {
-                            $args_to_merge[ $reference ] = urlencode($this->_default_route_query_args[ $reference ]);
+                        if (isset($this->_default_route_query_args[$reference])) {
+                            $args_to_merge[$reference] = urlencode($this->_default_route_query_args[$reference]);
                         } else {
-                            $args_to_merge[ $reference ] = urlencode($value);
+                            $args_to_merge[$reference] = urlencode($value);
                         }
                     }
                     continue;
                 }
-                $args_to_merge[ $query_param ] = $query_value;
+                $args_to_merge[$query_param] = $query_value;
             }
             // now let's merge these arguments but override with what was specifically sent in to the
             // redirect.
@@ -3525,19 +3525,19 @@ 
         if (isset($query_args['action'])) {
             // manually generate wp_nonce and merge that with the query vars
             // becuz the wp_nonce_url function wrecks havoc on some vars
-            $query_args['_wpnonce'] = wp_create_nonce($query_args['action'] . '_nonce');
+            $query_args['_wpnonce'] = wp_create_nonce($query_args['action'].'_nonce');
         }
         // we're adding some hooks and filters in here for processing any things just before redirects
         // (example: an admin page has done an insert or update and we want to run something after that).
-        do_action('AHEE_redirect_' . $this->class_name . $this->_req_action, $query_args);
+        do_action('AHEE_redirect_'.$this->class_name.$this->_req_action, $query_args);
         $redirect_url = apply_filters(
-            'FHEE_redirect_' . $this->class_name . $this->_req_action,
+            'FHEE_redirect_'.$this->class_name.$this->_req_action,
             EE_Admin_Page::add_query_args_and_nonce($query_args, $redirect_url),
             $query_args
         );
         // check if we're doing ajax.  If we are then lets just return the results and js can handle how it wants.
         if ($this->request->isAjax()) {
-            $default_data                    = [
+            $default_data = [
                 'close'        => true,
                 'redirect_url' => $redirect_url,
                 'where'        => 'main',
@@ -3590,7 +3590,7 @@ 
         }
         $this->_template_args['notices'] = EE_Error::get_notices();
         // IF this isn't ajax we need to create a transient for the notices using the route (however, overridden if $sticky_notices == true)
-        if (! $this->request->isAjax() || $sticky_notices) {
+        if ( ! $this->request->isAjax() || $sticky_notices) {
             $route = $query_args['action'] ?? 'default';
             $this->_add_transient(
                 $route,
@@ -3630,7 +3630,7 @@ 
         bool $exclude_nonce = false
     ): string {
         // first let's validate the action (if $base_url is FALSE otherwise validation will happen further along)
-        if (empty($base_url) && ! isset($this->_page_routes[ $action ])) {
+        if (empty($base_url) && ! isset($this->_page_routes[$action])) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -3641,7 +3641,7 @@ 
                 )
             );
         }
-        if (! isset($this->_labels['buttons'][ $type ])) {
+        if ( ! isset($this->_labels['buttons'][$type])) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -3654,7 +3654,7 @@ 
         }
         // finally check user access for this button.
         $has_access = $this->check_user_access($action, true);
-        if (! $has_access) {
+        if ( ! $has_access) {
             return '';
         }
         $_base_url  = ! $base_url ? $this->_admin_base_url : $base_url;
@@ -3662,11 +3662,11 @@ 
             'action' => $action,
         ];
         // merge extra_request args but make sure our original action takes precedence and doesn't get overwritten.
-        if (! empty($extra_request)) {
+        if ( ! empty($extra_request)) {
             $query_args = array_merge($extra_request, $query_args);
         }
         $url = EE_Admin_Page::add_query_args_and_nonce($query_args, $_base_url, false, $exclude_nonce);
-        return EEH_Template::get_button_or_link($url, $this->_labels['buttons'][ $type ], $class);
+        return EEH_Template::get_button_or_link($url, $this->_labels['buttons'][$type], $class);
     }
 
 
@@ -3692,7 +3692,7 @@ 
                 'FHEE__EE_Admin_Page___per_page_screen_options__default',
                 20
             ),
-            'option'  => $this->_current_page . '_' . $this->_current_view . '_per_page',
+            'option'  => $this->_current_page.'_'.$this->_current_view.'_per_page',
         ];
         // ONLY add the screen option if the user has access to it.
         if ($this->check_user_access($this->_current_view, true)) {
@@ -3713,18 +3713,18 @@ 
     {
         if ($this->request->requestParamIsSet('wp_screen_options')) {
             check_admin_referer('screen-options-nonce', 'screenoptionnonce');
-            if (! $user = wp_get_current_user()) {
+            if ( ! $user = wp_get_current_user()) {
                 return;
             }
             $option = $this->request->getRequestParam('wp_screen_options[option]', '', DataType::KEY);
-            if (! $option) {
+            if ( ! $option) {
                 return;
             }
             $value      = $this->request->getRequestParam('wp_screen_options[value]', 0, DataType::INT);
             $map_option = $option;
             $option     = str_replace('-', '_', $option);
             switch ($map_option) {
-                case $this->_current_page . '_' . $this->_current_view . '_per_page':
+                case $this->_current_page.'_'.$this->_current_view.'_per_page':
                     $max_value = apply_filters(
                         'FHEE__EE_Admin_Page___set_per_page_screen_options__max_value',
                         999,
@@ -3785,7 +3785,7 @@ 
         bool $skip_route_verify = false
     ) {
         $user_id = get_current_user_id();
-        if (! $skip_route_verify) {
+        if ( ! $skip_route_verify) {
             $this->_verify_route($route);
         }
         // now let's set the string for what kind of transient we're setting
@@ -3818,8 +3818,8 @@ 
         $user_id   = get_current_user_id();
         $route     = ! $route ? $this->_req_action : $route;
         $transient = $notices
-            ? 'ee_rte_n_tx_' . $route . '_' . $user_id
-            : 'rte_tx_' . $route . '_' . $user_id;
+            ? 'ee_rte_n_tx_'.$route.'_'.$user_id
+            : 'rte_tx_'.$route.'_'.$user_id;
         $data      = is_multisite() && is_network_admin()
             ? get_site_transient($transient)
             : get_transient($transient);
@@ -4065,7 +4065,7 @@ 
      */
     protected function _next_link(string $url, string $class = 'dashicons dashicons-arrow-right'): string
     {
-        return '<a class="' . $class . '" href="' . $url . '"></a>';
+        return '<a class="'.$class.'" href="'.$url.'"></a>';
     }
 
 
@@ -4078,7 +4078,7 @@ 
      */
     protected function _previous_link(string $url, string $class = 'dashicons dashicons-arrow-left'): string
     {
-        return '<a class="' . $class . '" href="' . $url . '"></a>';
+        return '<a class="'.$class.'" href="'.$url.'"></a>';
     }
 
 
@@ -4226,13 +4226,13 @@ 
         ?callable $callback = null
     ): bool {
         $entity_ID = absint($entity_ID);
-        if (! $entity_ID) {
+        if ( ! $entity_ID) {
             $this->trashRestoreDeleteError($action, $entity_model);
         }
         $result = 0;
         try {
             $entity = $entity_model->get_one_by_ID($entity_ID);
-            if (! $entity instanceof EE_Base_Class) {
+            if ( ! $entity instanceof EE_Base_Class) {
                 throw new DomainException(
                     sprintf(
                         esc_html__(
@@ -4283,7 +4283,7 @@ 
                 )
             );
         }
-        if (! $entity_model->has_field($delete_column)) {
+        if ( ! $entity_model->has_field($delete_column)) {
             throw new DomainException(
                 sprintf(
                     esc_html__(

core/admin/EE_Admin_Page_CPT_Init.core.php

Indentation +37 added lines, -37 removed lines

@@ -12,45 +12,45 @@
  */
 abstract class EE_Admin_Page_CPT_Init extends EE_Admin_Page_Init
 {
-    public function do_initial_loads()
-    {
-        // we want to use the corresponding admin page object (but not route it!).
-        // To do this we just set _routing to false.
-        // That way this page object is being loaded on all pages to make sure we hook into admin properly.
-        // But note... we are ONLY doing this if the given page is NOT pages we WANT to load ;)
-        // This is important because we have hooks that help redirect custom post type saves
-        $page           = $this->request->getRequestParam('page');
-        $page           = $this->request->getRequestParam('current_page', $page);
-        $this->_routing = $page === $this->_menu_map->menuSlug();
-        $this->_initialize_admin_page();
-        if ($this->_routing) {
-            // added for 4.1 to completely disable autosave for our pages.
-            // This can be removed once we fully enable autosave functionality
-            remove_filter('wp_print_scripts', 'wp_just_in_time_script_localization');
-            add_filter('wp_print_scripts', [$this, 'wp_just_in_time_script_localization'], 100);
-            // end removal of autosave functionality.
-        }
-    }
+	public function do_initial_loads()
+	{
+		// we want to use the corresponding admin page object (but not route it!).
+		// To do this we just set _routing to false.
+		// That way this page object is being loaded on all pages to make sure we hook into admin properly.
+		// But note... we are ONLY doing this if the given page is NOT pages we WANT to load ;)
+		// This is important because we have hooks that help redirect custom post type saves
+		$page           = $this->request->getRequestParam('page');
+		$page           = $this->request->getRequestParam('current_page', $page);
+		$this->_routing = $page === $this->_menu_map->menuSlug();
+		$this->_initialize_admin_page();
+		if ($this->_routing) {
+			// added for 4.1 to completely disable autosave for our pages.
+			// This can be removed once we fully enable autosave functionality
+			remove_filter('wp_print_scripts', 'wp_just_in_time_script_localization');
+			add_filter('wp_print_scripts', [$this, 'wp_just_in_time_script_localization'], 100);
+			// end removal of autosave functionality.
+		}
+	}
 
 
-    public function wp_just_in_time_script_localization()
-    {
-        wp_localize_script(
-            'autosave',
-            'autosaveL10n',
-            [
-                'autosaveInterval' => 172800,
-                'savingText'       => wp_strip_all_tags(__('Saving Draft…', 'event_espresso')),
-                'saveAlert'        => wp_strip_all_tags(
-                    __('The changes you made will be lost if you navigate away from this page.', 'event_espresso')
-                ),
-            ]
-        );
-    }
+	public function wp_just_in_time_script_localization()
+	{
+		wp_localize_script(
+			'autosave',
+			'autosaveL10n',
+			[
+				'autosaveInterval' => 172800,
+				'savingText'       => wp_strip_all_tags(__('Saving Draft…', 'event_espresso')),
+				'saveAlert'        => wp_strip_all_tags(
+					__('The changes you made will be lost if you navigate away from this page.', 'event_espresso')
+				),
+			]
+		);
+	}
 
 
-    public function adjust_post_lock_window($interval)
-    {
-        return 172800;
-    }
+	public function adjust_post_lock_window($interval)
+	{
+		return 172800;
+	}
 }

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 +27 added lines, -27 removed lines

@@ -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/EE_Admin.core.php

Indentation +987 added lines, -987 removed lines

@@ -20,991 +20,991 @@
  */
 final class EE_Admin implements InterminableInterface
 {
-    private static ?EE_Admin $_instance = null;
-
-    private ?PersistentAdminNoticeManager $persistent_admin_notice_manager = null;
-
-    protected LoaderInterface $loader;
-
-    protected RequestInterface $request;
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @param LoaderInterface|null  $loader
-     * @param RequestInterface|null $request
-     * @return EE_Admin|null
-     * @throws EE_Error
-     */
-    public static function instance(?LoaderInterface $loader = null, ?RequestInterface $request = null): ?EE_Admin
-    {
-        // check if class object is instantiated
-        if (! EE_Admin::$_instance instanceof EE_Admin) {
-            EE_Admin::$_instance = new EE_Admin($loader, $request);
-        }
-        return EE_Admin::$_instance;
-    }
-
-
-    /**
-     * @return EE_Admin|null
-     * @throws EE_Error
-     */
-    public static function reset(): ?EE_Admin
-    {
-        EE_Admin::$_instance = null;
-        $loader = LoaderFactory::getLoader();
-        $request = $loader->getShared('EventEspresso\core\services\request\Request');
-        return EE_Admin::instance($loader, $request);
-    }
-
-
-    /**
-     * @param LoaderInterface  $loader
-     * @param RequestInterface $request
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    protected function __construct(LoaderInterface $loader, RequestInterface $request)
-    {
-        $this->loader = $loader;
-        $this->request = $request;
-        // define global EE_Admin constants
-        $this->_define_all_constants();
-        // set autoloaders for our admin page classes based on included path information
-        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_ADMIN);
-        // reset Environment config (we only do this on admin page loads);
-        EE_Registry::instance()->CFG->environment->recheck_values();
-        // load EE_Request_Handler early
-        add_action('AHEE__EE_System__initialize_last', [$this, 'init']);
-        add_action('admin_init', [$this, 'admin_init'], 100);
-        if (! $this->request->isAjax()) {
-            // admin hooks
-            add_action('admin_notices', [$this, 'display_admin_notices']);
-            add_action('network_admin_notices', [$this, 'display_admin_notices']);
-            add_filter('pre_update_option', [$this, 'check_for_invalid_datetime_formats'], 100, 2);
-            add_filter('plugin_action_links', [$this, 'filter_plugin_actions'], 10, 2);
-            add_filter('admin_footer_text', [$this, 'espresso_admin_footer']);
-            add_action('display_post_states', [$this, 'displayStateForCriticalPages'], 10, 2);
-            add_filter('plugin_row_meta', [$this, 'addLinksToPluginRowMeta'], 10, 2);
-        }
-        do_action('AHEE__EE_Admin__loaded');
-    }
-
-
-    /**
-     * _define_all_constants
-     * define constants that are set globally for all admin pages
-     *
-     * @return void
-     */
-    private function _define_all_constants()
-    {
-        if (! defined('EE_ADMIN_URL')) {
-            define('EE_ADMIN_URL', EE_PLUGIN_DIR_URL . 'core/admin/');
-            define('EE_ADMIN_PAGES_URL', EE_PLUGIN_DIR_URL . 'admin_pages/');
-            define('EE_ADMIN_TEMPLATE', EE_ADMIN . 'templates/');
-            define('WP_ADMIN_PATH', ABSPATH . 'wp-admin/');
-            define('WP_AJAX_URL', admin_url('admin-ajax.php'));
-        }
-    }
-
-
-    /**
-     * filter_plugin_actions - adds links to the Plugins page listing
-     *
-     * @param array  $links
-     * @param string $plugin
-     * @return    array
-     */
-    public function filter_plugin_actions($links, $plugin)
-    {
-        // set $main_file in stone
-        static $main_file;
-        // if $main_file is not set yet
-        if (! $main_file) {
-            $main_file = EE_PLUGIN_BASENAME;
-        }
-        if ($plugin === $main_file) {
-            // compare current plugin to this one
-            if (EE_Maintenance_Mode::instance()->level() === EE_Maintenance_Mode::level_2_complete_maintenance) {
-                $maintenance_link = '<a href="admin.php?page=espresso_maintenance_settings"'
-                                    . ' title="Event Espresso is in maintenance mode.  Click this link to learn why.">'
-                                    . esc_html__('Maintenance Mode Active', 'event_espresso')
-                                    . '</a>';
-                array_unshift($links, $maintenance_link);
-            } else {
-                $org_settings_link = '<a href="admin.php?page=espresso_general_settings">'
-                                     . esc_html__('Settings', 'event_espresso')
-                                     . '</a>';
-                $events_link       = '<a href="admin.php?page=espresso_events">'
-                                     . esc_html__('Events', 'event_espresso')
-                                     . '</a>';
-                // add before other links
-                array_unshift($links, $org_settings_link, $events_link);
-            }
-        }
-        return $links;
-    }
-
-
-    /**
-     * hide_admin_pages_except_maintenance_mode
-     *
-     * @param array $admin_page_folder_names
-     * @return array
-     */
-    public function hide_admin_pages_except_maintenance_mode($admin_page_folder_names = [])
-    {
-        return [
-            'maintenance' => EE_ADMIN_PAGES . 'maintenance/',
-            'about'       => EE_ADMIN_PAGES . 'about/',
-            'support'     => EE_ADMIN_PAGES . 'support/',
-        ];
-    }
-
-
-    /**
-     * init- should fire after shortcode, module,  addon, other plugin (default priority), and even
-     * EE_Front_Controller's init phases have run
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws ServiceNotFoundException
-     */
-    public function init()
-    {
-        // only enable most of the EE_Admin IF we're not in full maintenance mode
-        if (EE_Maintenance_Mode::instance()->models_can_query()) {
-            $this->initModelsReady();
-        }
-        // run the admin page factory but ONLY if:
-        // - it is a regular non ajax admin request
-        // - we are doing an ee admin ajax request
-        if ($this->request->isAdmin() || $this->request->isAdminAjax() || $this->request->isActivation()) {
-            try {
-                // this loads the controller for the admin pages which will setup routing etc
-                $admin_page_loader = $this->loader->getShared('EE_Admin_Page_Loader', [$this->loader]);
-                /** @var EE_Admin_Page_Loader $admin_page_loader */
-                $admin_page_loader->init();
-            } catch (EE_Error $e) {
-                $e->get_error();
-            }
-        }
-        if ($this->request->isAjax()) {
-            return;
-        }
-        add_filter('content_save_pre', [$this, 'its_eSpresso']);
-        // make sure our CPTs and custom taxonomy metaboxes get shown for first time users
-        add_action('admin_head', [$this, 'enable_hidden_ee_nav_menu_metaboxes']);
-        add_action('admin_head', [$this, 'register_custom_nav_menu_boxes']);
-        // exclude EE critical pages from all nav menus and wp_list_pages
-        add_filter('nav_menu_meta_box_object', [$this, 'remove_pages_from_nav_menu']);
-    }
-
-
-    /**
-     * Gets the loader (and if it wasn't previously set, sets it)
-     *
-     * @return LoaderInterface
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function getLoader()
-    {
-        return $this->loader;
-    }
-
-
-    /**
-     * Method that's fired on admin requests (including admin ajax) but only when the models are usable
-     * (ie, the site isn't in maintenance mode)
-     *
-     * @return void
-     * @throws EE_Error
-     * @since 4.9.63.p
-     */
-    protected function initModelsReady()
-    {
-        // ok so we want to enable the entire admin
-        $this->persistent_admin_notice_manager = $this->loader->getShared(
-            'EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
-        );
-        $this->persistent_admin_notice_manager->setReturnUrl(
-            EE_Admin_Page::add_query_args_and_nonce(
-                [
-                    'page'   => $this->request->getRequestParam('page', ''),
-                    'action' => $this->request->getRequestParam('action', ''),
-                ],
-                EE_ADMIN_URL
-            )
-        );
-        $this->maybeSetDatetimeWarningNotice();
-        // at a glance dashboard widget
-        add_filter('dashboard_glance_items', [$this, 'dashboard_glance_items']);
-        // filter for get_edit_post_link used on comments for custom post types
-        add_filter('get_edit_post_link', [$this, 'modify_edit_post_link'], 10, 2);
-    }
-
-
-    /**
-     *    get_persistent_admin_notices
-     *
-     * @access    public
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function maybeSetDatetimeWarningNotice()
-    {
-        // add dismissible notice for datetime changes.  Only valid if site does not have a timezone_string set.
-        // @todo This needs to stay in core for a bit to catch anyone upgrading from a version without this to a version
-        // with this.  But after enough time (indeterminate at this point) we can just remove this notice.
-        // this was added with https://events.codebasehq.com/projects/event-espresso/tickets/10626
-        if (
-            apply_filters('FHEE__EE_Admin__maybeSetDatetimeWarningNotice', true)
-            && ! get_option('timezone_string')
-            && EEM_Event::instance()->count() > 0
-        ) {
-            new PersistentAdminNotice(
-                'datetime_fix_notice',
-                sprintf(
-                    esc_html__(
-                        '%1$sImportant announcement related to your install of Event Espresso%2$s: There are some changes made to your site that could affect how dates display for your events and other related items with dates and times.  Read more about it %3$shere%4$s. If your dates and times are displaying incorrectly (incorrect offset), you can fix it using the tool on %5$sthis page%4$s.',
-                        'event_espresso'
-                    ),
-                    '<strong>',
-                    '</strong>',
-                    '<a href="https://eventespresso.com/2017/08/important-upcoming-changes-dates-times">',
-                    '</a>',
-                    '<a href="' . EE_Admin_Page::add_query_args_and_nonce(
-                        [
-                            'page'   => 'espresso_maintenance_settings',
-                            'action' => 'datetime_tools',
-                        ],
-                        admin_url('admin.php')
-                    ) . '">'
-                ),
-                false,
-                'manage_options',
-                'datetime_fix_persistent_notice'
-            );
-        }
-    }
-
-
-    /**
-     * this simply hooks into the nav menu setup of pages metabox and makes sure that we remove EE critical pages from
-     * the list of options. the wp function "wp_nav_menu_item_post_type_meta_box" found in
-     * wp-admin/includes/nav-menu.php looks for the "_default_query" property on the post_type object and it uses that
-     * to override any queries found in the existing query for the given post type.  Note that _default_query is not a
-     * normal property on the post_type object.  It's found ONLY in this particular context.
-     *
-     * @param WP_Post $post_type WP post type object
-     * @return WP_Post
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function remove_pages_from_nav_menu($post_type)
-    {
-        // if this isn't the "pages" post type let's get out
-        if ($post_type->name !== 'page') {
-            return $post_type;
-        }
-        $critical_pages            = EE_Registry::instance()->CFG->core->get_critical_pages_array();
-        $post_type->_default_query = [
-            'post__not_in' => $critical_pages,
-        ];
-        return $post_type;
-    }
-
-
-    /**
-     * WP by default only shows three metaboxes in "nav-menus.php" for first times users.
-     * We want to make sure our metaboxes get shown as well
-     *
-     * @return void
-     */
-    public function enable_hidden_ee_nav_menu_metaboxes()
-    {
-        global $wp_meta_boxes, $pagenow;
-        if (! is_array($wp_meta_boxes) || $pagenow !== 'nav-menus.php') {
-            return;
-        }
-        $user = wp_get_current_user();
-        // has this been done yet?
-        if (get_user_option('ee_nav_menu_initialized', $user->ID)) {
-            return;
-        }
-
-        $hidden_meta_boxes  = get_user_option('metaboxhidden_nav-menus', $user->ID);
-        $initial_meta_boxes = apply_filters(
-            'FHEE__EE_Admin__enable_hidden_ee_nav_menu_boxes__initial_meta_boxes',
-            [
-                'nav-menu-theme-locations',
-                'add-page',
-                'add-custom-links',
-                'add-category',
-                'add-espresso_events',
-                'add-espresso_venues',
-                'add-espresso_event_categories',
-                'add-espresso_venue_categories',
-                'add-post-type-post',
-                'add-post-type-page',
-            ]
-        );
-
-        if (is_array($hidden_meta_boxes)) {
-            foreach ($hidden_meta_boxes as $key => $meta_box_id) {
-                if (in_array($meta_box_id, $initial_meta_boxes, true)) {
-                    unset($hidden_meta_boxes[ $key ]);
-                }
-            }
-        }
-        update_user_option($user->ID, 'metaboxhidden_nav-menus', $hidden_meta_boxes, true);
-        update_user_option($user->ID, 'ee_nav_menu_initialized', 1, true);
-    }
-
-
-    /**
-     * This method simply registers custom nav menu boxes for "nav_menus.php route"
-     * Currently EE is using this to make sure there are menu options for our CPT archive page routes.
-     *
-     * @return void
-     * @todo   modify this so its more dynamic and automatic for all ee CPTs and setups and can also be hooked into by
-     *         addons etc.
-     */
-    public function register_custom_nav_menu_boxes()
-    {
-        add_meta_box(
-            'add-extra-nav-menu-pages',
-            esc_html__('Event Espresso Pages', 'event_espresso'),
-            [$this, 'ee_cpt_archive_pages'],
-            'nav-menus',
-            'side',
-            'core'
-        );
-        add_filter(
-            "postbox_classes_nav-menus_add-extra-nav-menu-pages",
-            function ($classes) {
-                $classes[] = 'ee-admin-container';
-                return $classes;
-            }
-        );
-    }
-
-
-    /**
-     * Use this to edit the post link for our cpts so that the edit link points to the correct page.
-     *
-     * @param string $link the original link generated by wp
-     * @param int    $id   post id
-     * @return string  the (maybe) modified link
-     * @since   4.3.0
-     */
-    public function modify_edit_post_link($link, $id)
-    {
-        if (! $post = get_post($id)) {
-            return $link;
-        }
-        if ($post->post_type === 'espresso_attendees') {
-            $query_args = [
-                'action' => 'edit_attendee',
-                'post'   => $id,
-            ];
-            return EEH_URL::add_query_args_and_nonce(
-                $query_args,
-                admin_url('admin.php?page=espresso_registrations')
-            );
-        }
-        return $link;
-    }
-
-
-    public function ee_cpt_archive_pages()
-    {
-        global $nav_menu_selected_id;
-        $removed_args = [
-            'action',
-            'customlink-tab',
-            'edit-menu-item',
-            'menu-item',
-            'page-tab',
-            '_wpnonce',
-        ];
-        $nav_tab_link = $nav_menu_selected_id
-            ? esc_url(
-                add_query_arg(
-                    'extra-nav-menu-pages-tab',
-                    'event-archives',
-                    remove_query_arg($removed_args)
-                )
-            )
-            : '';
-        $select_all_link = esc_url(
-            add_query_arg(
-                [
-                    'extra-nav-menu-pages-tab' => 'event-archives',
-                    'selectall'                => 1,
-                ],
-                remove_query_arg($removed_args)
-            )
-        );
-        $pages = $this->_get_extra_nav_menu_pages_items();
-        $args['walker'] = new Walker_Nav_Menu_Checklist(false);
-        $nav_menu_pages_items = walk_nav_menu_tree(
-            array_map(
-                [$this, '_setup_extra_nav_menu_pages_items'],
-                $pages
-            ),
-            0,
-            (object) $args
-        );
-        EEH_Template::display_template(
-            EE_ADMIN_TEMPLATE . 'cpt_archive_page.template.php',
-            [
-                'nav_menu_selected_id' => $nav_menu_selected_id,
-                'nav_menu_pages_items' => $nav_menu_pages_items,
-                'nav_tab_link'         => $nav_tab_link,
-                'select_all_link'      => $select_all_link,
-            ]
-        );
-    }
-
-
-    /**
-     * Returns an array of event archive nav items.
-     *
-     * @return array
-     * @todo  for now this method is just in place so when it gets abstracted further we can substitute in whatever
-     *        method we use for getting the extra nav menu items
-     */
-    private function _get_extra_nav_menu_pages_items()
-    {
-        $menuitems[] = [
-            'title'       => esc_html__('Event List', 'event_espresso'),
-            'url'         => get_post_type_archive_link('espresso_events'),
-            'description' => esc_html__('Archive page for all events.', 'event_espresso'),
-        ];
-        return apply_filters('FHEE__EE_Admin__get_extra_nav_menu_pages_items', $menuitems);
-    }
-
-
-    /**
-     * Setup nav menu walker item for usage in the event archive nav menu metabox.  It receives a menu_item array with
-     * the properties and converts it to the menu item object.
-     *
-     * @param $menu_item_values
-     * @return stdClass
-     * @see wp_setup_nav_menu_item() in wp-includes/nav-menu.php
-     */
-    private function _setup_extra_nav_menu_pages_items($menu_item_values)
-    {
-        $menu_item = new stdClass();
-        $keys      = [
-            'ID'               => 0,
-            'db_id'            => 0,
-            'menu_item_parent' => 0,
-            'object_id'        => -1,
-            'post_parent'      => 0,
-            'type'             => 'custom',
-            'object'           => '',
-            'type_label'       => esc_html__('Extra Nav Menu Item', 'event_espresso'),
-            'title'            => '',
-            'url'              => '',
-            'target'           => '',
-            'attr_title'       => '',
-            'description'      => '',
-            'classes'          => [],
-            'xfn'              => '',
-        ];
-        foreach ($keys as $key => $value) {
-            $menu_item->{$key} = $menu_item_values[ $key ] ?? $value;
-        }
-        return $menu_item;
-    }
-
-
-    /**
-     * admin_init
-     *
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function admin_init()
-    {
-        /**
-         * our cpt models must be instantiated on WordPress post processing routes (wp-admin/post.php),
-         * so any hooking into core WP routes is taken care of.  So in this next few lines of code:
-         * - check if doing post processing.
-         * - check if doing post processing of one of EE CPTs
-         * - instantiate the corresponding EE CPT model for the post_type being processed.
-         */
-        $action    = $this->request->getRequestParam('action');
-        $post_type = $this->request->getRequestParam('post_type');
-        if ($post_type && $action === 'editpost') {
-            /** @var CustomPostTypeDefinitions $custom_post_types */
-            $custom_post_types = $this->loader->getShared(CustomPostTypeDefinitions::class);
-            $custom_post_types->getCustomPostTypeModels($post_type);
-        }
-
-
-        if (! $this->request->isAjax()) {
-            /**
-             * This code excludes EE critical pages anywhere `wp_dropdown_pages` is used to create a dropdown for selecting
-             * critical pages.  The only place critical pages need included in a generated dropdown is on the "Critical
-             * Pages" tab in the EE General Settings Admin page.
-             * This is for user-proofing.
-             */
-            add_filter('wp_dropdown_pages', [$this, 'modify_dropdown_pages']);
-            if (EE_Maintenance_Mode::instance()->models_can_query()) {
-                $this->adminInitModelsReady();
-            }
-        }
-    }
-
-
-    /**
-     * Runs on admin_init but only if models are usable (ie, we're not in maintenance mode)
-     */
-    protected function adminInitModelsReady()
-    {
-        if (function_exists('wp_add_privacy_policy_content')) {
-            $this->loader->getShared('EventEspresso\core\services\privacy\policy\PrivacyPolicyManager');
-        }
-    }
-
-
-    /**
-     * Callback for wp_dropdown_pages hook to remove ee critical pages from the dropdown selection.
-     *
-     * @param string $output Current output.
-     * @return string
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function modify_dropdown_pages($output)
-    {
-        // get critical pages
-        $critical_pages = EE_Registry::instance()->CFG->core->get_critical_pages_array();
-
-        // split current output by line break for easier parsing.
-        $split_output = explode("\n", $output);
-
-        // loop through to remove any critical pages from the array.
-        foreach ($critical_pages as $page_id) {
-            $needle = 'value="' . $page_id . '"';
-            foreach ($split_output as $key => $haystack) {
-                if (strpos($haystack, $needle) !== false) {
-                    unset($split_output[ $key ]);
-                }
-            }
-        }
-        // replace output with the new contents
-        return implode("\n", $split_output);
-    }
-
-
-    /**
-     * display_admin_notices
-     *
-     * @return void
-     */
-    public function display_admin_notices()
-    {
-        echo EE_Error::get_notices(); // already escaped
-    }
-
-
-    /**
-     * @param array $elements
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function dashboard_glance_items($elements)
-    {
-        $elements                        = is_array($elements) ? $elements : [$elements];
-        $events                          = EEM_Event::instance()->count();
-        $items['events']['url']          = EE_Admin_Page::add_query_args_and_nonce(
-            ['page' => 'espresso_events'],
-            admin_url('admin.php')
-        );
-        $items['events']['text']         = sprintf(
-            esc_html(
-                _n('%s Event', '%s Events', $events, 'event_espresso')
-            ),
-            number_format_i18n($events)
-        );
-        $items['events']['title']        = esc_html__('Click to view all Events', 'event_espresso');
-        $registrations                   = EEM_Registration::instance()->count(
-            [
-                [
-                    'STS_ID' => ['!=', EEM_Registration::status_id_incomplete],
-                ],
-            ]
-        );
-        $items['registrations']['url']   = EE_Admin_Page::add_query_args_and_nonce(
-            ['page' => 'espresso_registrations'],
-            admin_url('admin.php')
-        );
-        $items['registrations']['text']  = sprintf(
-            esc_html(
-                _n('%s Registration', '%s Registrations', $registrations, 'event_espresso')
-            ),
-            number_format_i18n($registrations)
-        );
-        $items['registrations']['title'] = esc_html__('Click to view all registrations', 'event_espresso');
-
-        $items = (array) apply_filters('FHEE__EE_Admin__dashboard_glance_items__items', $items);
-
-        foreach ($items as $type => $item_properties) {
-            $elements[] = sprintf(
-                '<a class="ee-dashboard-link-' . $type . '" href="%s" title="%s">%s</a>',
-                $item_properties['url'],
-                $item_properties['title'],
-                $item_properties['text']
-            );
-        }
-        return $elements;
-    }
-
-
-    /**
-     * check_for_invalid_datetime_formats
-     * if an admin changes their date or time format settings on the WP General Settings admin page, verify that
-     * their selected format can be parsed by PHP
-     *
-     * @param    $value
-     * @param    $option
-     * @return    string
-     */
-    public function check_for_invalid_datetime_formats($value, $option)
-    {
-        // check for date_format or time_format
-        switch ($option) {
-            case 'date_format':
-                $date_time_format = $value . ' ' . get_option('time_format');
-                break;
-            case 'time_format':
-                $date_time_format = get_option('date_format') . ' ' . $value;
-                break;
-            default:
-                $date_time_format = false;
-        }
-        // do we have a date_time format to check ?
-        if ($date_time_format) {
-            $error_msg = EEH_DTT_Helper::validate_format_string($date_time_format);
-
-            if (is_array($error_msg)) {
-                $msg = '<p>'
-                       . sprintf(
-                           esc_html__(
-                               'The following date time "%s" ( %s ) is difficult to be properly parsed by PHP for the following reasons:',
-                               'event_espresso'
-                           ),
-                           date($date_time_format),
-                           $date_time_format
-                       )
-                       . '</p><p><ul>';
-
-
-                foreach ($error_msg as $error) {
-                    $msg .= '<li>' . $error . '</li>';
-                }
-
-                $msg .= '</ul></p><p>'
-                        . sprintf(
-                            esc_html__(
-                                '%sPlease note that your date and time formats have been reset to "F j, Y" and "g:i a" respectively.%s',
-                                'event_espresso'
-                            ),
-                            '<span style="color:#D54E21;">',
-                            '</span>'
-                        )
-                        . '</p>';
-
-                // trigger WP settings error
-                add_settings_error(
-                    'date_format',
-                    'date_format',
-                    $msg
-                );
-
-                // set format to something valid
-                switch ($option) {
-                    case 'date_format':
-                        $value = 'F j, Y';
-                        break;
-                    case 'time_format':
-                        $value = 'g:i a';
-                        break;
-                }
-            }
-        }
-        return $value;
-    }
-
-
-    /**
-     * its_eSpresso - converts the less commonly used spelling of "Expresso" to "Espresso"
-     *
-     * @param $content
-     * @return    string
-     */
-    public function its_eSpresso($content)
-    {
-        return str_replace('[EXPRESSO_', '[ESPRESSO_', $content);
-    }
-
-
-    /**
-     * espresso_admin_footer
-     *
-     * @return    string
-     */
-    public function espresso_admin_footer()
-    {
-        return EEH_Template::powered_by_event_espresso('aln-cntr', '', ['utm_content' => 'admin_footer']);
-    }
-
-
-    /**
-     * Hooks into the "post states" filter in a wp post type list table.
-     *
-     * @param array   $post_states
-     * @param WP_Post $post
-     * @return array
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function displayStateForCriticalPages($post_states, $post)
-    {
-        $post_states = (array) $post_states;
-        if (! $post instanceof WP_Post || $post->post_type !== 'page') {
-            return $post_states;
-        }
-        /** @var EE_Core_Config $config */
-        $config = $this->loader->getShared('EE_Config')->core;
-        if (in_array($post->ID, $config->get_critical_pages_array(), true)) {
-            $post_states[] = sprintf(
-            /* Translators: Using company name - Event Espresso Critical Page */
-                esc_html__('%s Critical Page', 'event_espresso'),
-                'Event Espresso'
-            );
-        }
-        return $post_states;
-    }
-
-
-    /**
-     * Show documentation links on the plugins page
-     *
-     * @param mixed $meta Plugin Row Meta
-     * @param mixed $file Plugin Base file
-     * @return array
-     */
-    public function addLinksToPluginRowMeta($meta, $file)
-    {
-        if (EE_PLUGIN_BASENAME === $file) {
-            $row_meta = [
-                'docs' => '<a href="https://eventespresso.com/support/documentation/versioned-docs/?doc_ver=ee4"'
-                          . ' aria-label="'
-                          . esc_attr__('View Event Espresso documentation', 'event_espresso')
-                          . '">'
-                          . esc_html__('Docs', 'event_espresso')
-                          . '</a>',
-                'api'  => '<a href="https://github.com/eventespresso/event-espresso-core/tree/master/docs/C--REST-API"'
-                          . ' aria-label="'
-                          . esc_attr__('View Event Espresso API docs', 'event_espresso')
-                          . '">'
-                          . esc_html__('API docs', 'event_espresso')
-                          . '</a>',
-            ];
-            return array_merge($meta, $row_meta);
-        }
-        return (array) $meta;
-    }
-
-     /**************************************************************************************/
-     /************************************* DEPRECATED *************************************/
-     /**************************************************************************************/
-
-
-    /**
-     * This is the action hook for the AHEE__EE_Admin_Page__route_admin_request hook that fires off right before an
-     * EE_Admin_Page route is called.
-     *
-     * @return void
-     */
-    public function route_admin_request()
-    {
-    }
-
-
-    /**
-     * wp_loaded should fire on the WordPress wp_loaded hook.  This fires on a VERY late priority.
-     *
-     * @return void
-     */
-    public function wp_loaded()
-    {
-    }
-
-
-    /**
-     * static method for registering ee admin page.
-     * This method is deprecated in favor of the new location in EE_Register_Admin_Page::register.
-     *
-     * @param       $page_basename
-     * @param       $page_path
-     * @param array $config
-     * @return void
-     * @throws EE_Error
-     * @see        EE_Register_Admin_Page::register()
-     * @since      4.3.0
-     * @deprecated 4.3.0    Use EE_Register_Admin_Page::register() instead
-     */
-    public static function register_ee_admin_page($page_basename, $page_path, $config = [])
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            sprintf(
-                esc_html__(
-                    'Usage is deprecated.  Use EE_Register_Admin_Page::register() for registering the %s admin page.',
-                    'event_espresso'
-                ),
-                $page_basename
-            ),
-            '4.3'
-        );
-        if (class_exists('EE_Register_Admin_Page')) {
-            $config['page_path'] = $page_path;
-        }
-        EE_Register_Admin_Page::register($page_basename, $config);
-    }
-
-
-    /**
-     * @param int     $post_ID
-     * @param WP_Post $post
-     * @return void
-     * @deprecated 4.8.41
-     */
-    public static function parse_post_content_on_save($post_ID, $post)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__('Usage is deprecated', 'event_espresso'),
-            '4.8.41'
-        );
-    }
-
-
-    /**
-     * @param  $option
-     * @param  $old_value
-     * @param  $value
-     * @return void
-     * @deprecated 4.8.41
-     */
-    public function reset_page_for_posts_on_change($option, $old_value, $value)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__('Usage is deprecated', 'event_espresso'),
-            '4.8.41'
-        );
-    }
-
-
-    /**
-     * @return void
-     * @deprecated 4.9.27
-     */
-    public function get_persistent_admin_notices()
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            sprintf(
-                esc_html__('Usage is deprecated. Use "%1$s" instead.', 'event_espresso'),
-                '\EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
-            ),
-            '4.9.27'
-        );
-    }
-
-
-    /**
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws DomainException
-     * @deprecated 4.9.27
-     */
-    public function dismiss_ee_nag_notice_callback()
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            sprintf(
-                esc_html__('Usage is deprecated. Use "%1$s" instead.', 'event_espresso'),
-                '\EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
-            ),
-            '4.9.27'
-        );
-        $this->persistent_admin_notice_manager->dismissNotice();
-    }
-
-
-    /**
-     * @return void
-     * @deprecated 5.0.0.p
-     */
-    public function enqueue_admin_scripts()
-    {
-    }
-
-
-
-    /**
-     * @return RequestInterface
-     * @deprecated 5.0.0.p
-     */
-    public function get_request()
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            sprintf(
-                esc_html__('Usage is deprecated. Use "%1$s" instead.', 'event_espresso'),
-                'EventEspresso\core\services\request\Request'
-            ),
-            '5.0.0.p'
-        );
-        return $this->request;
-    }
-
-
-    /**
-     * @deprecated 5.0.0.p
-     */
-    public function hookIntoWpPluginsPage()
-    {
-    }
+	private static ?EE_Admin $_instance = null;
+
+	private ?PersistentAdminNoticeManager $persistent_admin_notice_manager = null;
+
+	protected LoaderInterface $loader;
+
+	protected RequestInterface $request;
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @param LoaderInterface|null  $loader
+	 * @param RequestInterface|null $request
+	 * @return EE_Admin|null
+	 * @throws EE_Error
+	 */
+	public static function instance(?LoaderInterface $loader = null, ?RequestInterface $request = null): ?EE_Admin
+	{
+		// check if class object is instantiated
+		if (! EE_Admin::$_instance instanceof EE_Admin) {
+			EE_Admin::$_instance = new EE_Admin($loader, $request);
+		}
+		return EE_Admin::$_instance;
+	}
+
+
+	/**
+	 * @return EE_Admin|null
+	 * @throws EE_Error
+	 */
+	public static function reset(): ?EE_Admin
+	{
+		EE_Admin::$_instance = null;
+		$loader = LoaderFactory::getLoader();
+		$request = $loader->getShared('EventEspresso\core\services\request\Request');
+		return EE_Admin::instance($loader, $request);
+	}
+
+
+	/**
+	 * @param LoaderInterface  $loader
+	 * @param RequestInterface $request
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	protected function __construct(LoaderInterface $loader, RequestInterface $request)
+	{
+		$this->loader = $loader;
+		$this->request = $request;
+		// define global EE_Admin constants
+		$this->_define_all_constants();
+		// set autoloaders for our admin page classes based on included path information
+		EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_ADMIN);
+		// reset Environment config (we only do this on admin page loads);
+		EE_Registry::instance()->CFG->environment->recheck_values();
+		// load EE_Request_Handler early
+		add_action('AHEE__EE_System__initialize_last', [$this, 'init']);
+		add_action('admin_init', [$this, 'admin_init'], 100);
+		if (! $this->request->isAjax()) {
+			// admin hooks
+			add_action('admin_notices', [$this, 'display_admin_notices']);
+			add_action('network_admin_notices', [$this, 'display_admin_notices']);
+			add_filter('pre_update_option', [$this, 'check_for_invalid_datetime_formats'], 100, 2);
+			add_filter('plugin_action_links', [$this, 'filter_plugin_actions'], 10, 2);
+			add_filter('admin_footer_text', [$this, 'espresso_admin_footer']);
+			add_action('display_post_states', [$this, 'displayStateForCriticalPages'], 10, 2);
+			add_filter('plugin_row_meta', [$this, 'addLinksToPluginRowMeta'], 10, 2);
+		}
+		do_action('AHEE__EE_Admin__loaded');
+	}
+
+
+	/**
+	 * _define_all_constants
+	 * define constants that are set globally for all admin pages
+	 *
+	 * @return void
+	 */
+	private function _define_all_constants()
+	{
+		if (! defined('EE_ADMIN_URL')) {
+			define('EE_ADMIN_URL', EE_PLUGIN_DIR_URL . 'core/admin/');
+			define('EE_ADMIN_PAGES_URL', EE_PLUGIN_DIR_URL . 'admin_pages/');
+			define('EE_ADMIN_TEMPLATE', EE_ADMIN . 'templates/');
+			define('WP_ADMIN_PATH', ABSPATH . 'wp-admin/');
+			define('WP_AJAX_URL', admin_url('admin-ajax.php'));
+		}
+	}
+
+
+	/**
+	 * filter_plugin_actions - adds links to the Plugins page listing
+	 *
+	 * @param array  $links
+	 * @param string $plugin
+	 * @return    array
+	 */
+	public function filter_plugin_actions($links, $plugin)
+	{
+		// set $main_file in stone
+		static $main_file;
+		// if $main_file is not set yet
+		if (! $main_file) {
+			$main_file = EE_PLUGIN_BASENAME;
+		}
+		if ($plugin === $main_file) {
+			// compare current plugin to this one
+			if (EE_Maintenance_Mode::instance()->level() === EE_Maintenance_Mode::level_2_complete_maintenance) {
+				$maintenance_link = '<a href="admin.php?page=espresso_maintenance_settings"'
+									. ' title="Event Espresso is in maintenance mode.  Click this link to learn why.">'
+									. esc_html__('Maintenance Mode Active', 'event_espresso')
+									. '</a>';
+				array_unshift($links, $maintenance_link);
+			} else {
+				$org_settings_link = '<a href="admin.php?page=espresso_general_settings">'
+									 . esc_html__('Settings', 'event_espresso')
+									 . '</a>';
+				$events_link       = '<a href="admin.php?page=espresso_events">'
+									 . esc_html__('Events', 'event_espresso')
+									 . '</a>';
+				// add before other links
+				array_unshift($links, $org_settings_link, $events_link);
+			}
+		}
+		return $links;
+	}
+
+
+	/**
+	 * hide_admin_pages_except_maintenance_mode
+	 *
+	 * @param array $admin_page_folder_names
+	 * @return array
+	 */
+	public function hide_admin_pages_except_maintenance_mode($admin_page_folder_names = [])
+	{
+		return [
+			'maintenance' => EE_ADMIN_PAGES . 'maintenance/',
+			'about'       => EE_ADMIN_PAGES . 'about/',
+			'support'     => EE_ADMIN_PAGES . 'support/',
+		];
+	}
+
+
+	/**
+	 * init- should fire after shortcode, module,  addon, other plugin (default priority), and even
+	 * EE_Front_Controller's init phases have run
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws ServiceNotFoundException
+	 */
+	public function init()
+	{
+		// only enable most of the EE_Admin IF we're not in full maintenance mode
+		if (EE_Maintenance_Mode::instance()->models_can_query()) {
+			$this->initModelsReady();
+		}
+		// run the admin page factory but ONLY if:
+		// - it is a regular non ajax admin request
+		// - we are doing an ee admin ajax request
+		if ($this->request->isAdmin() || $this->request->isAdminAjax() || $this->request->isActivation()) {
+			try {
+				// this loads the controller for the admin pages which will setup routing etc
+				$admin_page_loader = $this->loader->getShared('EE_Admin_Page_Loader', [$this->loader]);
+				/** @var EE_Admin_Page_Loader $admin_page_loader */
+				$admin_page_loader->init();
+			} catch (EE_Error $e) {
+				$e->get_error();
+			}
+		}
+		if ($this->request->isAjax()) {
+			return;
+		}
+		add_filter('content_save_pre', [$this, 'its_eSpresso']);
+		// make sure our CPTs and custom taxonomy metaboxes get shown for first time users
+		add_action('admin_head', [$this, 'enable_hidden_ee_nav_menu_metaboxes']);
+		add_action('admin_head', [$this, 'register_custom_nav_menu_boxes']);
+		// exclude EE critical pages from all nav menus and wp_list_pages
+		add_filter('nav_menu_meta_box_object', [$this, 'remove_pages_from_nav_menu']);
+	}
+
+
+	/**
+	 * Gets the loader (and if it wasn't previously set, sets it)
+	 *
+	 * @return LoaderInterface
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function getLoader()
+	{
+		return $this->loader;
+	}
+
+
+	/**
+	 * Method that's fired on admin requests (including admin ajax) but only when the models are usable
+	 * (ie, the site isn't in maintenance mode)
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @since 4.9.63.p
+	 */
+	protected function initModelsReady()
+	{
+		// ok so we want to enable the entire admin
+		$this->persistent_admin_notice_manager = $this->loader->getShared(
+			'EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
+		);
+		$this->persistent_admin_notice_manager->setReturnUrl(
+			EE_Admin_Page::add_query_args_and_nonce(
+				[
+					'page'   => $this->request->getRequestParam('page', ''),
+					'action' => $this->request->getRequestParam('action', ''),
+				],
+				EE_ADMIN_URL
+			)
+		);
+		$this->maybeSetDatetimeWarningNotice();
+		// at a glance dashboard widget
+		add_filter('dashboard_glance_items', [$this, 'dashboard_glance_items']);
+		// filter for get_edit_post_link used on comments for custom post types
+		add_filter('get_edit_post_link', [$this, 'modify_edit_post_link'], 10, 2);
+	}
+
+
+	/**
+	 *    get_persistent_admin_notices
+	 *
+	 * @access    public
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function maybeSetDatetimeWarningNotice()
+	{
+		// add dismissible notice for datetime changes.  Only valid if site does not have a timezone_string set.
+		// @todo This needs to stay in core for a bit to catch anyone upgrading from a version without this to a version
+		// with this.  But after enough time (indeterminate at this point) we can just remove this notice.
+		// this was added with https://events.codebasehq.com/projects/event-espresso/tickets/10626
+		if (
+			apply_filters('FHEE__EE_Admin__maybeSetDatetimeWarningNotice', true)
+			&& ! get_option('timezone_string')
+			&& EEM_Event::instance()->count() > 0
+		) {
+			new PersistentAdminNotice(
+				'datetime_fix_notice',
+				sprintf(
+					esc_html__(
+						'%1$sImportant announcement related to your install of Event Espresso%2$s: There are some changes made to your site that could affect how dates display for your events and other related items with dates and times.  Read more about it %3$shere%4$s. If your dates and times are displaying incorrectly (incorrect offset), you can fix it using the tool on %5$sthis page%4$s.',
+						'event_espresso'
+					),
+					'<strong>',
+					'</strong>',
+					'<a href="https://eventespresso.com/2017/08/important-upcoming-changes-dates-times">',
+					'</a>',
+					'<a href="' . EE_Admin_Page::add_query_args_and_nonce(
+						[
+							'page'   => 'espresso_maintenance_settings',
+							'action' => 'datetime_tools',
+						],
+						admin_url('admin.php')
+					) . '">'
+				),
+				false,
+				'manage_options',
+				'datetime_fix_persistent_notice'
+			);
+		}
+	}
+
+
+	/**
+	 * this simply hooks into the nav menu setup of pages metabox and makes sure that we remove EE critical pages from
+	 * the list of options. the wp function "wp_nav_menu_item_post_type_meta_box" found in
+	 * wp-admin/includes/nav-menu.php looks for the "_default_query" property on the post_type object and it uses that
+	 * to override any queries found in the existing query for the given post type.  Note that _default_query is not a
+	 * normal property on the post_type object.  It's found ONLY in this particular context.
+	 *
+	 * @param WP_Post $post_type WP post type object
+	 * @return WP_Post
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function remove_pages_from_nav_menu($post_type)
+	{
+		// if this isn't the "pages" post type let's get out
+		if ($post_type->name !== 'page') {
+			return $post_type;
+		}
+		$critical_pages            = EE_Registry::instance()->CFG->core->get_critical_pages_array();
+		$post_type->_default_query = [
+			'post__not_in' => $critical_pages,
+		];
+		return $post_type;
+	}
+
+
+	/**
+	 * WP by default only shows three metaboxes in "nav-menus.php" for first times users.
+	 * We want to make sure our metaboxes get shown as well
+	 *
+	 * @return void
+	 */
+	public function enable_hidden_ee_nav_menu_metaboxes()
+	{
+		global $wp_meta_boxes, $pagenow;
+		if (! is_array($wp_meta_boxes) || $pagenow !== 'nav-menus.php') {
+			return;
+		}
+		$user = wp_get_current_user();
+		// has this been done yet?
+		if (get_user_option('ee_nav_menu_initialized', $user->ID)) {
+			return;
+		}
+
+		$hidden_meta_boxes  = get_user_option('metaboxhidden_nav-menus', $user->ID);
+		$initial_meta_boxes = apply_filters(
+			'FHEE__EE_Admin__enable_hidden_ee_nav_menu_boxes__initial_meta_boxes',
+			[
+				'nav-menu-theme-locations',
+				'add-page',
+				'add-custom-links',
+				'add-category',
+				'add-espresso_events',
+				'add-espresso_venues',
+				'add-espresso_event_categories',
+				'add-espresso_venue_categories',
+				'add-post-type-post',
+				'add-post-type-page',
+			]
+		);
+
+		if (is_array($hidden_meta_boxes)) {
+			foreach ($hidden_meta_boxes as $key => $meta_box_id) {
+				if (in_array($meta_box_id, $initial_meta_boxes, true)) {
+					unset($hidden_meta_boxes[ $key ]);
+				}
+			}
+		}
+		update_user_option($user->ID, 'metaboxhidden_nav-menus', $hidden_meta_boxes, true);
+		update_user_option($user->ID, 'ee_nav_menu_initialized', 1, true);
+	}
+
+
+	/**
+	 * This method simply registers custom nav menu boxes for "nav_menus.php route"
+	 * Currently EE is using this to make sure there are menu options for our CPT archive page routes.
+	 *
+	 * @return void
+	 * @todo   modify this so its more dynamic and automatic for all ee CPTs and setups and can also be hooked into by
+	 *         addons etc.
+	 */
+	public function register_custom_nav_menu_boxes()
+	{
+		add_meta_box(
+			'add-extra-nav-menu-pages',
+			esc_html__('Event Espresso Pages', 'event_espresso'),
+			[$this, 'ee_cpt_archive_pages'],
+			'nav-menus',
+			'side',
+			'core'
+		);
+		add_filter(
+			"postbox_classes_nav-menus_add-extra-nav-menu-pages",
+			function ($classes) {
+				$classes[] = 'ee-admin-container';
+				return $classes;
+			}
+		);
+	}
+
+
+	/**
+	 * Use this to edit the post link for our cpts so that the edit link points to the correct page.
+	 *
+	 * @param string $link the original link generated by wp
+	 * @param int    $id   post id
+	 * @return string  the (maybe) modified link
+	 * @since   4.3.0
+	 */
+	public function modify_edit_post_link($link, $id)
+	{
+		if (! $post = get_post($id)) {
+			return $link;
+		}
+		if ($post->post_type === 'espresso_attendees') {
+			$query_args = [
+				'action' => 'edit_attendee',
+				'post'   => $id,
+			];
+			return EEH_URL::add_query_args_and_nonce(
+				$query_args,
+				admin_url('admin.php?page=espresso_registrations')
+			);
+		}
+		return $link;
+	}
+
+
+	public function ee_cpt_archive_pages()
+	{
+		global $nav_menu_selected_id;
+		$removed_args = [
+			'action',
+			'customlink-tab',
+			'edit-menu-item',
+			'menu-item',
+			'page-tab',
+			'_wpnonce',
+		];
+		$nav_tab_link = $nav_menu_selected_id
+			? esc_url(
+				add_query_arg(
+					'extra-nav-menu-pages-tab',
+					'event-archives',
+					remove_query_arg($removed_args)
+				)
+			)
+			: '';
+		$select_all_link = esc_url(
+			add_query_arg(
+				[
+					'extra-nav-menu-pages-tab' => 'event-archives',
+					'selectall'                => 1,
+				],
+				remove_query_arg($removed_args)
+			)
+		);
+		$pages = $this->_get_extra_nav_menu_pages_items();
+		$args['walker'] = new Walker_Nav_Menu_Checklist(false);
+		$nav_menu_pages_items = walk_nav_menu_tree(
+			array_map(
+				[$this, '_setup_extra_nav_menu_pages_items'],
+				$pages
+			),
+			0,
+			(object) $args
+		);
+		EEH_Template::display_template(
+			EE_ADMIN_TEMPLATE . 'cpt_archive_page.template.php',
+			[
+				'nav_menu_selected_id' => $nav_menu_selected_id,
+				'nav_menu_pages_items' => $nav_menu_pages_items,
+				'nav_tab_link'         => $nav_tab_link,
+				'select_all_link'      => $select_all_link,
+			]
+		);
+	}
+
+
+	/**
+	 * Returns an array of event archive nav items.
+	 *
+	 * @return array
+	 * @todo  for now this method is just in place so when it gets abstracted further we can substitute in whatever
+	 *        method we use for getting the extra nav menu items
+	 */
+	private function _get_extra_nav_menu_pages_items()
+	{
+		$menuitems[] = [
+			'title'       => esc_html__('Event List', 'event_espresso'),
+			'url'         => get_post_type_archive_link('espresso_events'),
+			'description' => esc_html__('Archive page for all events.', 'event_espresso'),
+		];
+		return apply_filters('FHEE__EE_Admin__get_extra_nav_menu_pages_items', $menuitems);
+	}
+
+
+	/**
+	 * Setup nav menu walker item for usage in the event archive nav menu metabox.  It receives a menu_item array with
+	 * the properties and converts it to the menu item object.
+	 *
+	 * @param $menu_item_values
+	 * @return stdClass
+	 * @see wp_setup_nav_menu_item() in wp-includes/nav-menu.php
+	 */
+	private function _setup_extra_nav_menu_pages_items($menu_item_values)
+	{
+		$menu_item = new stdClass();
+		$keys      = [
+			'ID'               => 0,
+			'db_id'            => 0,
+			'menu_item_parent' => 0,
+			'object_id'        => -1,
+			'post_parent'      => 0,
+			'type'             => 'custom',
+			'object'           => '',
+			'type_label'       => esc_html__('Extra Nav Menu Item', 'event_espresso'),
+			'title'            => '',
+			'url'              => '',
+			'target'           => '',
+			'attr_title'       => '',
+			'description'      => '',
+			'classes'          => [],
+			'xfn'              => '',
+		];
+		foreach ($keys as $key => $value) {
+			$menu_item->{$key} = $menu_item_values[ $key ] ?? $value;
+		}
+		return $menu_item;
+	}
+
+
+	/**
+	 * admin_init
+	 *
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function admin_init()
+	{
+		/**
+		 * our cpt models must be instantiated on WordPress post processing routes (wp-admin/post.php),
+		 * so any hooking into core WP routes is taken care of.  So in this next few lines of code:
+		 * - check if doing post processing.
+		 * - check if doing post processing of one of EE CPTs
+		 * - instantiate the corresponding EE CPT model for the post_type being processed.
+		 */
+		$action    = $this->request->getRequestParam('action');
+		$post_type = $this->request->getRequestParam('post_type');
+		if ($post_type && $action === 'editpost') {
+			/** @var CustomPostTypeDefinitions $custom_post_types */
+			$custom_post_types = $this->loader->getShared(CustomPostTypeDefinitions::class);
+			$custom_post_types->getCustomPostTypeModels($post_type);
+		}
+
+
+		if (! $this->request->isAjax()) {
+			/**
+			 * This code excludes EE critical pages anywhere `wp_dropdown_pages` is used to create a dropdown for selecting
+			 * critical pages.  The only place critical pages need included in a generated dropdown is on the "Critical
+			 * Pages" tab in the EE General Settings Admin page.
+			 * This is for user-proofing.
+			 */
+			add_filter('wp_dropdown_pages', [$this, 'modify_dropdown_pages']);
+			if (EE_Maintenance_Mode::instance()->models_can_query()) {
+				$this->adminInitModelsReady();
+			}
+		}
+	}
+
+
+	/**
+	 * Runs on admin_init but only if models are usable (ie, we're not in maintenance mode)
+	 */
+	protected function adminInitModelsReady()
+	{
+		if (function_exists('wp_add_privacy_policy_content')) {
+			$this->loader->getShared('EventEspresso\core\services\privacy\policy\PrivacyPolicyManager');
+		}
+	}
+
+
+	/**
+	 * Callback for wp_dropdown_pages hook to remove ee critical pages from the dropdown selection.
+	 *
+	 * @param string $output Current output.
+	 * @return string
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function modify_dropdown_pages($output)
+	{
+		// get critical pages
+		$critical_pages = EE_Registry::instance()->CFG->core->get_critical_pages_array();
+
+		// split current output by line break for easier parsing.
+		$split_output = explode("\n", $output);
+
+		// loop through to remove any critical pages from the array.
+		foreach ($critical_pages as $page_id) {
+			$needle = 'value="' . $page_id . '"';
+			foreach ($split_output as $key => $haystack) {
+				if (strpos($haystack, $needle) !== false) {
+					unset($split_output[ $key ]);
+				}
+			}
+		}
+		// replace output with the new contents
+		return implode("\n", $split_output);
+	}
+
+
+	/**
+	 * display_admin_notices
+	 *
+	 * @return void
+	 */
+	public function display_admin_notices()
+	{
+		echo EE_Error::get_notices(); // already escaped
+	}
+
+
+	/**
+	 * @param array $elements
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function dashboard_glance_items($elements)
+	{
+		$elements                        = is_array($elements) ? $elements : [$elements];
+		$events                          = EEM_Event::instance()->count();
+		$items['events']['url']          = EE_Admin_Page::add_query_args_and_nonce(
+			['page' => 'espresso_events'],
+			admin_url('admin.php')
+		);
+		$items['events']['text']         = sprintf(
+			esc_html(
+				_n('%s Event', '%s Events', $events, 'event_espresso')
+			),
+			number_format_i18n($events)
+		);
+		$items['events']['title']        = esc_html__('Click to view all Events', 'event_espresso');
+		$registrations                   = EEM_Registration::instance()->count(
+			[
+				[
+					'STS_ID' => ['!=', EEM_Registration::status_id_incomplete],
+				],
+			]
+		);
+		$items['registrations']['url']   = EE_Admin_Page::add_query_args_and_nonce(
+			['page' => 'espresso_registrations'],
+			admin_url('admin.php')
+		);
+		$items['registrations']['text']  = sprintf(
+			esc_html(
+				_n('%s Registration', '%s Registrations', $registrations, 'event_espresso')
+			),
+			number_format_i18n($registrations)
+		);
+		$items['registrations']['title'] = esc_html__('Click to view all registrations', 'event_espresso');
+
+		$items = (array) apply_filters('FHEE__EE_Admin__dashboard_glance_items__items', $items);
+
+		foreach ($items as $type => $item_properties) {
+			$elements[] = sprintf(
+				'<a class="ee-dashboard-link-' . $type . '" href="%s" title="%s">%s</a>',
+				$item_properties['url'],
+				$item_properties['title'],
+				$item_properties['text']
+			);
+		}
+		return $elements;
+	}
+
+
+	/**
+	 * check_for_invalid_datetime_formats
+	 * if an admin changes their date or time format settings on the WP General Settings admin page, verify that
+	 * their selected format can be parsed by PHP
+	 *
+	 * @param    $value
+	 * @param    $option
+	 * @return    string
+	 */
+	public function check_for_invalid_datetime_formats($value, $option)
+	{
+		// check for date_format or time_format
+		switch ($option) {
+			case 'date_format':
+				$date_time_format = $value . ' ' . get_option('time_format');
+				break;
+			case 'time_format':
+				$date_time_format = get_option('date_format') . ' ' . $value;
+				break;
+			default:
+				$date_time_format = false;
+		}
+		// do we have a date_time format to check ?
+		if ($date_time_format) {
+			$error_msg = EEH_DTT_Helper::validate_format_string($date_time_format);
+
+			if (is_array($error_msg)) {
+				$msg = '<p>'
+					   . sprintf(
+						   esc_html__(
+							   'The following date time "%s" ( %s ) is difficult to be properly parsed by PHP for the following reasons:',
+							   'event_espresso'
+						   ),
+						   date($date_time_format),
+						   $date_time_format
+					   )
+					   . '</p><p><ul>';
+
+
+				foreach ($error_msg as $error) {
+					$msg .= '<li>' . $error . '</li>';
+				}
+
+				$msg .= '</ul></p><p>'
+						. sprintf(
+							esc_html__(
+								'%sPlease note that your date and time formats have been reset to "F j, Y" and "g:i a" respectively.%s',
+								'event_espresso'
+							),
+							'<span style="color:#D54E21;">',
+							'</span>'
+						)
+						. '</p>';
+
+				// trigger WP settings error
+				add_settings_error(
+					'date_format',
+					'date_format',
+					$msg
+				);
+
+				// set format to something valid
+				switch ($option) {
+					case 'date_format':
+						$value = 'F j, Y';
+						break;
+					case 'time_format':
+						$value = 'g:i a';
+						break;
+				}
+			}
+		}
+		return $value;
+	}
+
+
+	/**
+	 * its_eSpresso - converts the less commonly used spelling of "Expresso" to "Espresso"
+	 *
+	 * @param $content
+	 * @return    string
+	 */
+	public function its_eSpresso($content)
+	{
+		return str_replace('[EXPRESSO_', '[ESPRESSO_', $content);
+	}
+
+
+	/**
+	 * espresso_admin_footer
+	 *
+	 * @return    string
+	 */
+	public function espresso_admin_footer()
+	{
+		return EEH_Template::powered_by_event_espresso('aln-cntr', '', ['utm_content' => 'admin_footer']);
+	}
+
+
+	/**
+	 * Hooks into the "post states" filter in a wp post type list table.
+	 *
+	 * @param array   $post_states
+	 * @param WP_Post $post
+	 * @return array
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function displayStateForCriticalPages($post_states, $post)
+	{
+		$post_states = (array) $post_states;
+		if (! $post instanceof WP_Post || $post->post_type !== 'page') {
+			return $post_states;
+		}
+		/** @var EE_Core_Config $config */
+		$config = $this->loader->getShared('EE_Config')->core;
+		if (in_array($post->ID, $config->get_critical_pages_array(), true)) {
+			$post_states[] = sprintf(
+			/* Translators: Using company name - Event Espresso Critical Page */
+				esc_html__('%s Critical Page', 'event_espresso'),
+				'Event Espresso'
+			);
+		}
+		return $post_states;
+	}
+
+
+	/**
+	 * Show documentation links on the plugins page
+	 *
+	 * @param mixed $meta Plugin Row Meta
+	 * @param mixed $file Plugin Base file
+	 * @return array
+	 */
+	public function addLinksToPluginRowMeta($meta, $file)
+	{
+		if (EE_PLUGIN_BASENAME === $file) {
+			$row_meta = [
+				'docs' => '<a href="https://eventespresso.com/support/documentation/versioned-docs/?doc_ver=ee4"'
+						  . ' aria-label="'
+						  . esc_attr__('View Event Espresso documentation', 'event_espresso')
+						  . '">'
+						  . esc_html__('Docs', 'event_espresso')
+						  . '</a>',
+				'api'  => '<a href="https://github.com/eventespresso/event-espresso-core/tree/master/docs/C--REST-API"'
+						  . ' aria-label="'
+						  . esc_attr__('View Event Espresso API docs', 'event_espresso')
+						  . '">'
+						  . esc_html__('API docs', 'event_espresso')
+						  . '</a>',
+			];
+			return array_merge($meta, $row_meta);
+		}
+		return (array) $meta;
+	}
+
+	 /**************************************************************************************/
+	 /************************************* DEPRECATED *************************************/
+	 /**************************************************************************************/
+
+
+	/**
+	 * This is the action hook for the AHEE__EE_Admin_Page__route_admin_request hook that fires off right before an
+	 * EE_Admin_Page route is called.
+	 *
+	 * @return void
+	 */
+	public function route_admin_request()
+	{
+	}
+
+
+	/**
+	 * wp_loaded should fire on the WordPress wp_loaded hook.  This fires on a VERY late priority.
+	 *
+	 * @return void
+	 */
+	public function wp_loaded()
+	{
+	}
+
+
+	/**
+	 * static method for registering ee admin page.
+	 * This method is deprecated in favor of the new location in EE_Register_Admin_Page::register.
+	 *
+	 * @param       $page_basename
+	 * @param       $page_path
+	 * @param array $config
+	 * @return void
+	 * @throws EE_Error
+	 * @see        EE_Register_Admin_Page::register()
+	 * @since      4.3.0
+	 * @deprecated 4.3.0    Use EE_Register_Admin_Page::register() instead
+	 */
+	public static function register_ee_admin_page($page_basename, $page_path, $config = [])
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			sprintf(
+				esc_html__(
+					'Usage is deprecated.  Use EE_Register_Admin_Page::register() for registering the %s admin page.',
+					'event_espresso'
+				),
+				$page_basename
+			),
+			'4.3'
+		);
+		if (class_exists('EE_Register_Admin_Page')) {
+			$config['page_path'] = $page_path;
+		}
+		EE_Register_Admin_Page::register($page_basename, $config);
+	}
+
+
+	/**
+	 * @param int     $post_ID
+	 * @param WP_Post $post
+	 * @return void
+	 * @deprecated 4.8.41
+	 */
+	public static function parse_post_content_on_save($post_ID, $post)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__('Usage is deprecated', 'event_espresso'),
+			'4.8.41'
+		);
+	}
+
+
+	/**
+	 * @param  $option
+	 * @param  $old_value
+	 * @param  $value
+	 * @return void
+	 * @deprecated 4.8.41
+	 */
+	public function reset_page_for_posts_on_change($option, $old_value, $value)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__('Usage is deprecated', 'event_espresso'),
+			'4.8.41'
+		);
+	}
+
+
+	/**
+	 * @return void
+	 * @deprecated 4.9.27
+	 */
+	public function get_persistent_admin_notices()
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			sprintf(
+				esc_html__('Usage is deprecated. Use "%1$s" instead.', 'event_espresso'),
+				'\EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
+			),
+			'4.9.27'
+		);
+	}
+
+
+	/**
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws DomainException
+	 * @deprecated 4.9.27
+	 */
+	public function dismiss_ee_nag_notice_callback()
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			sprintf(
+				esc_html__('Usage is deprecated. Use "%1$s" instead.', 'event_espresso'),
+				'\EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
+			),
+			'4.9.27'
+		);
+		$this->persistent_admin_notice_manager->dismissNotice();
+	}
+
+
+	/**
+	 * @return void
+	 * @deprecated 5.0.0.p
+	 */
+	public function enqueue_admin_scripts()
+	{
+	}
+
+
+
+	/**
+	 * @return RequestInterface
+	 * @deprecated 5.0.0.p
+	 */
+	public function get_request()
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			sprintf(
+				esc_html__('Usage is deprecated. Use "%1$s" instead.', 'event_espresso'),
+				'EventEspresso\core\services\request\Request'
+			),
+			'5.0.0.p'
+		);
+		return $this->request;
+	}
+
+
+	/**
+	 * @deprecated 5.0.0.p
+	 */
+	public function hookIntoWpPluginsPage()
+	{
+	}
 }

Spacing +30 added lines, -30 removed lines

@@ -39,7 +39,7 @@ 
     public static function instance(?LoaderInterface $loader = null, ?RequestInterface $request = null): ?EE_Admin
     {
         // check if class object is instantiated
-        if (! EE_Admin::$_instance instanceof EE_Admin) {
+        if ( ! EE_Admin::$_instance instanceof EE_Admin) {
             EE_Admin::$_instance = new EE_Admin($loader, $request);
         }
         return EE_Admin::$_instance;
@@ -80,7 +80,7 @@ 
         // load EE_Request_Handler early
         add_action('AHEE__EE_System__initialize_last', [$this, 'init']);
         add_action('admin_init', [$this, 'admin_init'], 100);
-        if (! $this->request->isAjax()) {
+        if ( ! $this->request->isAjax()) {
             // admin hooks
             add_action('admin_notices', [$this, 'display_admin_notices']);
             add_action('network_admin_notices', [$this, 'display_admin_notices']);
@@ -102,11 +102,11 @@ 
      */
     private function _define_all_constants()
     {
-        if (! defined('EE_ADMIN_URL')) {
-            define('EE_ADMIN_URL', EE_PLUGIN_DIR_URL . 'core/admin/');
-            define('EE_ADMIN_PAGES_URL', EE_PLUGIN_DIR_URL . 'admin_pages/');
-            define('EE_ADMIN_TEMPLATE', EE_ADMIN . 'templates/');
-            define('WP_ADMIN_PATH', ABSPATH . 'wp-admin/');
+        if ( ! defined('EE_ADMIN_URL')) {
+            define('EE_ADMIN_URL', EE_PLUGIN_DIR_URL.'core/admin/');
+            define('EE_ADMIN_PAGES_URL', EE_PLUGIN_DIR_URL.'admin_pages/');
+            define('EE_ADMIN_TEMPLATE', EE_ADMIN.'templates/');
+            define('WP_ADMIN_PATH', ABSPATH.'wp-admin/');
             define('WP_AJAX_URL', admin_url('admin-ajax.php'));
         }
     }
@@ -124,7 +124,7 @@ 
         // set $main_file in stone
         static $main_file;
         // if $main_file is not set yet
-        if (! $main_file) {
+        if ( ! $main_file) {
             $main_file = EE_PLUGIN_BASENAME;
         }
         if ($plugin === $main_file) {
@@ -159,9 +159,9 @@ 
     public function hide_admin_pages_except_maintenance_mode($admin_page_folder_names = [])
     {
         return [
-            'maintenance' => EE_ADMIN_PAGES . 'maintenance/',
-            'about'       => EE_ADMIN_PAGES . 'about/',
-            'support'     => EE_ADMIN_PAGES . 'support/',
+            'maintenance' => EE_ADMIN_PAGES.'maintenance/',
+            'about'       => EE_ADMIN_PAGES.'about/',
+            'support'     => EE_ADMIN_PAGES.'support/',
         ];
     }
 
@@ -287,13 +287,13 @@ 
                     '</strong>',
                     '<a href="https://eventespresso.com/2017/08/important-upcoming-changes-dates-times">',
                     '</a>',
-                    '<a href="' . EE_Admin_Page::add_query_args_and_nonce(
+                    '<a href="'.EE_Admin_Page::add_query_args_and_nonce(
                         [
                             'page'   => 'espresso_maintenance_settings',
                             'action' => 'datetime_tools',
                         ],
                         admin_url('admin.php')
-                    ) . '">'
+                    ).'">'
                 ),
                 false,
                 'manage_options',
@@ -339,7 +339,7 @@ 
     public function enable_hidden_ee_nav_menu_metaboxes()
     {
         global $wp_meta_boxes, $pagenow;
-        if (! is_array($wp_meta_boxes) || $pagenow !== 'nav-menus.php') {
+        if ( ! is_array($wp_meta_boxes) || $pagenow !== 'nav-menus.php') {
             return;
         }
         $user = wp_get_current_user();
@@ -368,7 +368,7 @@ 
         if (is_array($hidden_meta_boxes)) {
             foreach ($hidden_meta_boxes as $key => $meta_box_id) {
                 if (in_array($meta_box_id, $initial_meta_boxes, true)) {
-                    unset($hidden_meta_boxes[ $key ]);
+                    unset($hidden_meta_boxes[$key]);
                 }
             }
         }
@@ -397,7 +397,7 @@ 
         );
         add_filter(
             "postbox_classes_nav-menus_add-extra-nav-menu-pages",
-            function ($classes) {
+            function($classes) {
                 $classes[] = 'ee-admin-container';
                 return $classes;
             }
@@ -415,7 +415,7 @@ 
      */
     public function modify_edit_post_link($link, $id)
     {
-        if (! $post = get_post($id)) {
+        if ( ! $post = get_post($id)) {
             return $link;
         }
         if ($post->post_type === 'espresso_attendees') {
@@ -472,7 +472,7 @@ 
             (object) $args
         );
         EEH_Template::display_template(
-            EE_ADMIN_TEMPLATE . 'cpt_archive_page.template.php',
+            EE_ADMIN_TEMPLATE.'cpt_archive_page.template.php',
             [
                 'nav_menu_selected_id' => $nav_menu_selected_id,
                 'nav_menu_pages_items' => $nav_menu_pages_items,
@@ -530,7 +530,7 @@ 
             'xfn'              => '',
         ];
         foreach ($keys as $key => $value) {
-            $menu_item->{$key} = $menu_item_values[ $key ] ?? $value;
+            $menu_item->{$key} = $menu_item_values[$key] ?? $value;
         }
         return $menu_item;
     }
@@ -562,7 +562,7 @@ 
         }
 
 
-        if (! $this->request->isAjax()) {
+        if ( ! $this->request->isAjax()) {
             /**
              * This code excludes EE critical pages anywhere `wp_dropdown_pages` is used to create a dropdown for selecting
              * critical pages.  The only place critical pages need included in a generated dropdown is on the "Critical
@@ -607,10 +607,10 @@ 
 
         // loop through to remove any critical pages from the array.
         foreach ($critical_pages as $page_id) {
-            $needle = 'value="' . $page_id . '"';
+            $needle = 'value="'.$page_id.'"';
             foreach ($split_output as $key => $haystack) {
                 if (strpos($haystack, $needle) !== false) {
-                    unset($split_output[ $key ]);
+                    unset($split_output[$key]);
                 }
             }
         }
@@ -647,7 +647,7 @@ 
             ['page' => 'espresso_events'],
             admin_url('admin.php')
         );
-        $items['events']['text']         = sprintf(
+        $items['events']['text'] = sprintf(
             esc_html(
                 _n('%s Event', '%s Events', $events, 'event_espresso')
             ),
@@ -661,11 +661,11 @@ 
                 ],
             ]
         );
-        $items['registrations']['url']   = EE_Admin_Page::add_query_args_and_nonce(
+        $items['registrations']['url'] = EE_Admin_Page::add_query_args_and_nonce(
             ['page' => 'espresso_registrations'],
             admin_url('admin.php')
         );
-        $items['registrations']['text']  = sprintf(
+        $items['registrations']['text'] = sprintf(
             esc_html(
                 _n('%s Registration', '%s Registrations', $registrations, 'event_espresso')
             ),
@@ -677,7 +677,7 @@ 
 
         foreach ($items as $type => $item_properties) {
             $elements[] = sprintf(
-                '<a class="ee-dashboard-link-' . $type . '" href="%s" title="%s">%s</a>',
+                '<a class="ee-dashboard-link-'.$type.'" href="%s" title="%s">%s</a>',
                 $item_properties['url'],
                 $item_properties['title'],
                 $item_properties['text']
@@ -701,10 +701,10 @@ 
         // check for date_format or time_format
         switch ($option) {
             case 'date_format':
-                $date_time_format = $value . ' ' . get_option('time_format');
+                $date_time_format = $value.' '.get_option('time_format');
                 break;
             case 'time_format':
-                $date_time_format = get_option('date_format') . ' ' . $value;
+                $date_time_format = get_option('date_format').' '.$value;
                 break;
             default:
                 $date_time_format = false;
@@ -727,7 +727,7 @@ 
 
 
                 foreach ($error_msg as $error) {
-                    $msg .= '<li>' . $error . '</li>';
+                    $msg .= '<li>'.$error.'</li>';
                 }
 
                 $msg .= '</ul></p><p>'
@@ -799,7 +799,7 @@ 
     public function displayStateForCriticalPages($post_states, $post)
     {
         $post_states = (array) $post_states;
-        if (! $post instanceof WP_Post || $post->post_type !== 'page') {
+        if ( ! $post instanceof WP_Post || $post->post_type !== 'page') {
             return $post_states;
         }
         /** @var EE_Core_Config $config */

core/admin/EE_Admin_Hooks.core.php

Indentation +714 added lines, -714 removed lines

@@ -15,718 +15,718 @@
 abstract class EE_Admin_Hooks extends EE_Base
 {
 
-    /**
-     * This just holds an instance of the page object for this hook
-     *
-     * @var EE_Admin_Page|EE_Admin_Page_CPT|null
-     * @deprecated  5.0.8.p
-     */
-    protected $_page_object = null;
-
-    /**
-     * This holds the EE_Admin_Page object from the calling admin page that this object hooks into.
-     *
-     * @var EE_Admin_Page|EE_Admin_Page_CPT|null
-     */
-    protected                   $_adminpage_obj = null;
-
-    protected ?EE_Registry      $EE             = null;
-
-    protected ?RequestInterface $request        = null;
-
-    /**
-     * This is set by child classes and is an associative array of ajax hooks in the format:
-     * array(
-     *    'ajax_action_ref' => 'executing_method'; //must be public
-     * )
-     */
-    protected array $_ajax_func = [];
-
-    /**
-     * This is an array of methods that get executed on a page routes admin_init hook. Use the following format:
-     * array(
-     *    'page_route' => 'executing_method' //must be public
-     * )
-     */
-    protected array $_init_func = [];
-
-    /**
-     * This is an array of methods that output metabox content for the given page route.  Use the following format:
-     * [
-     *      0 => [
-     *          'page_route' => 'string_for_page_route',    must correspond to a page route in the class being connected
-     *                                                      with (i.e. "edit_event") If this is in an array then the
-     *                                                      same params below will be used but the metabox will be
-     *                                                      added to each route.
-     *          'func' =>  'executing_method',              must be public (i.e. public function executing_method
-     *                                                      ($post, $callback_args){} ).
-     *                                                      Note if you include callback args in the array then you
-     *                                                      need to declare them in the method arguments.
-     *          'id' => 'identifier_for_metabox',           so it can be removed by addons
-     *                                                      (optional, class will set it automatically)
-     *          'priority' => 'default',                    default 'default' (optional)
-     *          'label' => esc_html__('Localized Title', 'event_espresso'),
-     *          'context' => 'advanced'                     advanced is default (optional),
-     *      ]
-     *      'callback_args' => array() //any callback args to include (optional)
-     * ]
-     * Why are we indexing numerically?  Because it's possible there may be more than one metabox per page_route.
-     */
-    protected array $_metaboxes = [];
-
-    /**
-     * This is an array of values that indicate any metaboxes we want removed from a given page route.  Usually this is
-     * used when caffeinated functionality is replacing decaffeinated functionality.  Use the following format for the
-     * array: array(
-     *    0 => array(
-     *        'page_route' => 'string_for_page_route' //can be string or array of strings that match a page_route(s)
-     *        that are in the class being connected with (i.e. 'edit', or 'create_new').
-     *        'id' => 'identifier_for_metabox', //what the id is of the metabox being removed
-     *        'context' => 'normal', //the context for the metabox being removed (has to match)
-     *        'screen' => 'screen_id', //(optional), if not included then this class will attempt to remove the metabox
-     *        using the currently loaded screen object->id  however, there may be cases where you have to specify the
-     *        id for the screen the metabox is on.
-     *    )
-     * )
-     */
-    protected array $_remove_metaboxes = [];
-
-    protected array $_req_data         = [];
-
-    /**
-     * This parent class takes care of loading the scripts and styles if the child class has set the properties for
-     * them in the following format.  Note, the first array index ('register') is for defining all the registers.  The
-     * second array index is for indicating what routes each script/style loads on. array(
-     * 'registers' => array(
-     *        'script_ref' => array( // if more than one script is to be loaded its best to use the 'dependency'
-     *        argument to link scripts together.
-     *            'type' => 'js' // 'js' or 'css' (defaults to js).  This tells us what type of wp_function to use
-     *            'url' => 'http://urltoscript.css.js',
-     *            'depends' => array('jquery'), //an array of dependencies for the scripts. REMEMBER, if a script has
-     *            already been registered elsewhere in the system.  You can just use the depends array to make sure it
-     *            gets loaded before the one you are setting here.
-     *            'footer' => TRUE //defaults to true (styles don't use this parameter)
-     *        ),
-     *    'enqueues' => array( //this time each key corresponds to the script ref followed by an array of page routes
-     *    the script gets enqueued on.
-     *        'script_ref' => array('route_one', 'route_two')
-     *    ),
-     *    'localize' => array( //this allows you to set a localized object.  Indicate which script the object is being
-     *    attached to and then include an array indexed by the name of the object and the array of key/value pairs for
-     *    the object.
-     *        'scrip_ref' => array(
-     *            'NAME_OF_JS_OBJECT' => array(
-     *                'translate_ref' => esc_html__('localized_string', 'event_espresso'),
-     *                'some_data' => 5
-     *            )
-     *        )
-     *    )
-     * )
-     */
-    protected array $_scripts_styles = [];
-
-    protected array $_scripts        = [];
-
-    protected array $_styles         = [];
-
-    /**
-     * this optional property can be set by child classes to override the priority for the automatic action/filter hook
-     * loading in the `_load_routed_hooks()` method.  Please follow this format: array(
-     *    'wp_hook_reference' => 1
-     *    )
-     * )
-     */
-    protected array $_wp_action_filters_priority = [];
-
-    /**
-     * this is just a flag set automatically to indicate whether we've got an extended hook class running (i.e.
-     * espresso_events_Registration_Form_Hooks_Extend extends espresso_events_Registration_Form_Hooks).  This flag is
-     * used later to make sure we require the needed files.
-     */
-    protected bool $_extend = false;
-
-    /**
-     * we're just going to use this to hold the name of the caller class (child class name)
-     */
-    public string    $caller         = '';
-
-    protected string $_current_route = '';
-
-
-    /**
-     * child classes MUST set this property so that the page object can be loaded correctly
-     */
-    protected string $_name = '';
-
-
-    /**
-     * constructor
-     *
-     * @param EE_Admin_Page $admin_page
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function __construct(EE_Admin_Page $admin_page)
-    {
-        $this->_adminpage_obj = $admin_page;
-        $this->request        = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-        $this->_req_data      = $this->request->requestParams();
-        $current_page         = $this->request->getRequestParam('page');
-        $current_page         = $this->request->getRequestParam('current_page', $current_page);
-        // first let's verify we're on the right page
-        if ($current_page !== $this->_adminpage_obj->page_slug) {
-            return;
-        }
-        $this->_set_defaults();
-        $this->_set_hooks_properties();
-        // get out nothing more to be done here.
-        // allow for extends to modify properties
-        if (method_exists($this, '_extend_properties')) {
-            $this->_extend_properties();
-        }
-        // $this->_set_page_object();
-        $this->_init_hooks();
-        $this->_load_custom_methods();
-        $this->_load_routed_hooks();
-        add_action('admin_enqueue_scripts', [$this, 'enqueue_scripts_styles']);
-        add_action('admin_enqueue_scripts', [$this, 'add_metaboxes'], 20);
-        add_action('admin_enqueue_scripts', [$this, 'remove_metaboxes'], 15);
-        $this->_ajax_hooks();
-    }
-
-
-    /**
-     * used by child classes to set the following properties:
-     * $_ajax_func (optional)
-     * $_init_func (optional)
-     * $_metaboxes (optional)
-     * $_scripts (optional)
-     * $_styles (optional)
-     * $_name (required)
-     * Also in this method will be registered any scripts or styles loaded on the targeted page (as indicated in the
-     * _scripts/_styles properties) Also children should place in this method any filters/actions that have to happen
-     * really early on page load (just after admin_init) if they want to have them registered for handling early.
-     *
-     * @abstract
-     * @return void
-     */
-    abstract protected function _set_hooks_properties();
-
-
-    /**
-     * The hooks for enqueue_scripts and enqueue_styles will be run in here.  Child classes need to define their
-     * scripts and styles in the relevant $_scripts and $_styles properties.  Child classes must have also already
-     * registered the scripts and styles using wp_register_script and wp_register_style functions.
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    public function enqueue_scripts_styles()
-    {
-        if (! empty($this->_scripts_styles)) {
-            // first let's do all the registrations
-            if (! isset($this->_scripts_styles['registers'])) {
-                $msg[] = esc_html__(
-                    'There is no "registers" index in the <code>$this->_scripts_styles</code> property.',
-                    'event_espresso'
-                );
-                $msg[] = sprintf(
-                    esc_html__(
-                        'Make sure you read the phpdoc comments above the definition of the $_scripts_styles property in the <code>EE_Admin_Hooks</code> class and modify according in the %s child',
-                        'event_espresso'
-                    ),
-                    '<strong>' . $this->caller . '</strong>'
-                );
-                throw new EE_Error(implode('||', $msg));
-            }
-            $defaults = [
-                'type'    => 'js',
-                'url'     => '',
-                'depends' => [],
-                'version' => EVENT_ESPRESSO_VERSION,
-                'footer'  => true,
-            ];
-            foreach ($this->_scripts_styles['registers'] as $ref => $details) {
-                $details = wp_parse_args($details, $defaults);
-                $type    = $details['type'];
-                $url     = $details['url'];
-                $depends = $details['depends'];
-                $version = $details['version'];
-                $footer  = $details['footer'];
-                // let's make sure that we set the 'registers' type if it's not set!
-                // We need it later to determine which enqueue we do
-                $this->_scripts_styles['registers'][ $ref ]['type'] = $type;
-                // let's make sure we're not missing any REQUIRED parameters
-                if (empty($url)) {
-                    $msg[] = sprintf(
-                        esc_html__('Missing the url for the requested %s', 'event_espresso'),
-                        $type == 'js' ? 'script' : 'stylesheet'
-                    );
-                    $msg[] = sprintf(
-                        esc_html__(
-                            'Double-check your <code>$this->_scripts_styles</code> array in %s and make sure that there is a "url" set for the %s ref',
-                            'event_espresso'
-                        ),
-                        '<strong>' . $this->caller . '</strong>',
-                        $ref
-                    );
-                    throw new EE_Error(implode('||', $msg));
-                }
-                // made it here so let's do the appropriate registration
-                $type == 'js'
-                    ? wp_register_script($ref, $url, $depends, $version, $footer)
-                    : wp_register_style(
-                    $ref,
-                    $url,
-                    $depends,
-                    $version
-                );
-            }
-            // k now let's do the enqueues
-            if (! isset($this->_scripts_styles['enqueues'])) {
-                return;
-            }  //not sure if we should throw an error here or not.
-
-            foreach ($this->_scripts_styles['enqueues'] as $ref => $routes) {
-                // make sure $routes is an array
-                $routes = (array) $routes;
-                if (in_array($this->_current_route, $routes)) {
-                    $this->_scripts_styles['registers'][ $ref ]['type'] == 'js' ? wp_enqueue_script($ref)
-                        : wp_enqueue_style($ref);
-                    // if we have a localization for the script let's do that too.
-                    if (isset($this->_scripts_styles['localize'][ $ref ])) {
-                        foreach ($this->_scripts_styles['localize'][ $ref ] as $object_name => $indexes) {
-                            wp_localize_script(
-                                $ref,
-                                $object_name,
-                                $this->_scripts_styles['localize'][ $ref ][ $object_name ]
-                            );
-                        }
-                    }
-                }
-            }
-            // let's do the deregisters
-            if (! isset($this->_scripts_styles['deregisters'])) {
-                return;
-            }
-            foreach ($this->_scripts_styles['deregisters'] as $ref => $details) {
-                $defaults = ['type' => 'js'];
-                $details  = wp_parse_args($details, $defaults);
-                $details['type'] === 'js' ? wp_deregister_script($ref) : wp_deregister_style($ref);
-            }
-        }
-    }
-
-
-    /**
-     * just set the defaults for the hooks properties.
-     *
-     * @return void
-     */
-    private function _set_defaults()
-    {
-        $this->_ajax_func                  = [];
-        $this->_init_func                  = [];
-        $this->_metaboxes                  = [];
-        $this->_scripts                    = [];
-        $this->_styles                     = [];
-        $this->_wp_action_filters_priority = [];
-        $this->_current_route              = $this->getCurrentRoute();
-        $this->caller                      = get_class($this);
-        $this->_extend                     = (bool) stripos($this->caller, 'Extend');
-    }
-
-
-    /**
-     * A helper for determining the current route.
-     *
-     * @return string
-     */
-    private function getCurrentRoute(): string
-    {
-        $action = $this->request->getRequestParam('action');
-        // list tables do something else with 'action' for bulk actions.
-        $action = $action !== '-1' && $action !== '' ? $action : 'default';
-        $route  = $this->request->getRequestParam('route');
-        // we set a 'route' variable in some cases where action is being used by something else.
-        return $action === 'default' && $route !== '' ? $route : $action;
-    }
-
-
-    /**
-     * this sets the _page_object property
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws Throwable
-     * @deprecated  5.0.8.p
-     */
-    protected function _set_page_object()
-    {
-        if ($this->_page_object instanceof EE_Admin_Page) {
-            return;
-        }
-        // first make sure $this->_name is set
-        if (empty($this->_name)) {
-            $msg[] = esc_html__('We can\'t load the page object', 'event_espresso');
-            $msg[] = sprintf(
-                esc_html__("This is because the %s child class has not set the '_name' property", 'event_espresso'),
-                $this->caller
-            );
-            throw new EE_Error(implode('||', $msg));
-        }
-        // change "the_message" to "the message"
-        $class_name = str_replace('_', ' ', $this->_name);
-        // change "the message" to "The_Message_Admin_Page"
-        $class_name = str_replace(' ', '_', ucwords($class_name)) . '_Admin_Page';
-        // first default file (if exists)
-        $decaf_file = EE_ADMIN_PAGES . "$this->_name/$class_name.core.php";
-        if (is_readable($decaf_file)) {
-            require_once($decaf_file);
-        }
-        // now we have to do require for extended file (if needed)
-        if ($this->_extend) {
-            require_once EE_CORE_CAF_ADMIN_EXTEND . "$this->_name/Extend_$class_name.core.php";
-            // and extend the class name as well
-            $class_name = 'Extend_' . $class_name;
-        }
-        // let's make sure the class exists
-        if (! class_exists($class_name)) {
-            $msg[] = esc_html__('We can\'t load the page object', 'event_espresso');
-            $msg[] = sprintf(
-                esc_html__(
-                    'The class name that was given is %s. Check the spelling and make sure its correct, also there needs to be an autoloader setup for the class',
-                    'event_espresso'
-                ),
-                $class_name
-            );
-            throw new EE_Error(implode('||', $msg));
-        }
-        // do NOT load admin pages that are ALREADY LOADED!!!
-        if ($class_name !== $this->_adminpage_obj->class_name) {
-            return;
-        }
-        $this->_page_object = LoaderFactory::getLoader()->getShared($class_name, [false]);
-        $this->_page_object->initializePage();
-    }
-
-
-    /**
-     * Child "hook" classes can declare any methods that they want executed when a specific page route is loaded.  The
-     * advantage of this is when doing things like running our own db interactions on saves etc.  Remember that
-     * $this->_req_data (all the _POST and _GET data) is available to your methods.
-     *
-     * @return void
-     */
-    private function _load_custom_methods()
-    {
-        /**
-         * method cannot be named 'default' (@see http://us3.php
-         * .net/manual/en/reserved.keywords.php) so need to
-         * handle routes that are "default"
-         *
-         * @since 4.3.0
-         */
-        $method_callback = $this->_current_route == 'default' ? 'default_callback' : $this->_current_route;
-        // these run before the Admin_Page route executes.
-        if (is_callable($this, $method_callback)) {
-            call_user_func([$this, $method_callback]);
-        }
-        // these run via the _redirect_after_action method in EE_Admin_Page which usually happens after non_UI methods in EE_Admin_Page classes.  There are two redirect actions, the first fires before $query_args might be manipulated by "save and close" actions and the second fires right before the actual redirect happens.
-        // first the actions
-        // note that these action hooks will have the $query_args value available.
-        $admin_class_name = get_class($this->_adminpage_obj);
-        if (method_exists($this, '_redirect_action_early_' . $this->_current_route)) {
-            add_action(
-                'AHEE__'
-                . $admin_class_name
-                . '___redirect_after_action__before_redirect_modification_'
-                . $this->_current_route,
-                [$this, '_redirect_action_early_' . $this->_current_route]
-            );
-        }
-        if (method_exists($this, '_redirect_action_' . $this->_current_route)) {
-            add_action(
-                'AHEE_redirect_' . $admin_class_name . $this->_current_route,
-                [$this, '_redirect_action_' . $this->_current_route]
-            );
-        }
-        // let's hook into the _redirect itself and allow for changing where the user goes after redirect.  This will have $query_args and $redirect_url available.
-        if (method_exists($this, '_redirect_filter_' . $this->_current_route)) {
-            add_filter(
-                'FHEE_redirect_' . $admin_class_name . $this->_current_route,
-                [$this, '_redirect_filter_' . $this->_current_route],
-                10,
-                2
-            );
-        }
-    }
-
-
-    /**
-     * This method will search for a corresponding method with a name matching the route and the wp_hook to run.  This
-     * allows child hook classes to target hooking into a specific wp action or filter hook ONLY on a certain route.
-     * just remember, methods MUST be public Future hooks should be added in here to be access by child classes.
-     *
-     * @return void
-     */
-    private function _load_routed_hooks()
-    {
-        // this array provides the hook action names that will be referenced.  Key is the action. Value is an array with the type (action or filter) and the number of parameters for the hook.  We'll default all priorities for automatic hooks to 10.
-        $hook_filter_array = [
-            'admin_footer'                                                                            => [
-                'type'     => 'action',
-                'argnum'   => 1,
-                'priority' => 10,
-            ],
-            'FHEE_list_table_views_' . $this->_adminpage_obj->page_slug . '_' . $this->_current_route => [
-                'type'     => 'filter',
-                'argnum'   => 1,
-                'priority' => 10,
-            ],
-            'FHEE_list_table_views_' . $this->_adminpage_obj->page_slug                               => [
-                'type'     => 'filter',
-                'argnum'   => 1,
-                'priority' => 10,
-            ],
-            'FHEE_list_table_views'                                                                   => [
-                'type'     => 'filter',
-                'argnum'   => 1,
-                'priority' => 10,
-            ],
-            'AHEE__EE_Admin_Page___display_admin_page__modify_metaboxes'                              => [
-                'type'     => 'action',
-                'argnum'   => 1,
-                'priority' => 10,
-            ],
-        ];
-        foreach ($hook_filter_array as $hook => $args) {
-            if (method_exists($this, $this->_current_route . '_' . $hook)) {
-                if (isset($this->_wp_action_filters_priority[ $hook ])) {
-                    $args['priority'] = $this->_wp_action_filters_priority[ $hook ];
-                }
-                if ($args['type'] == 'action') {
-                    add_action(
-                        $hook,
-                        [$this, $this->_current_route . '_' . $hook],
-                        $args['priority'],
-                        $args['argnum']
-                    );
-                } else {
-                    add_filter(
-                        $hook,
-                        [$this, $this->_current_route . '_' . $hook],
-                        $args['priority'],
-                        $args['argnum']
-                    );
-                }
-            }
-        }
-    }
-
-
-    /**
-     * Loop through the $_ajax_func array and add_actions for the array.
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    private function _ajax_hooks()
-    {
-        if (empty($this->_ajax_func)) {
-            return;
-        } //get out there's nothing to take care of.
-        foreach ($this->_ajax_func as $action => $method) {
-            // make sure method exists
-            if (! method_exists($this, $method)) {
-                $msg[] = esc_html__(
-                             'There is no corresponding method for the hook labeled in the _ajax_func array',
-                             'event_espresso'
-                         ) . '<br />';
-                $msg[] = sprintf(
-                    esc_html__(
-                        'The method name given in the array is %s, check the spelling and make sure it exists in the %s class',
-                        'event_espresso'
-                    ),
-                    $method,
-                    $this->caller
-                );
-                throw new EE_Error(implode('||', $msg));
-            }
-            add_action('wp_ajax_' . $action, [$this, $method]);
-        }
-    }
-
-
-    /**
-     * Loop through the $_init_func array and add_actions for the array.
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    protected function _init_hooks()
-    {
-        if (empty($this->_init_func)) {
-            return;
-        }
-        // get out there's nothing to take care of.
-        // We need to determine what page_route we are on!
-        foreach ($this->_init_func as $route => $method) {
-            // make sure method exists
-            if (! method_exists($this, $method)) {
-                $msg[] = esc_html__(
-                             'There is no corresponding method for the hook labeled in the _init_func array',
-                             'event_espresso'
-                         ) . '<br />';
-                $msg[] = sprintf(
-                    esc_html__(
-                        'The method name given in the array is %s, check the spelling and make sure it exists in the %s class',
-                        'event_espresso'
-                    ),
-                    $method,
-                    $this->caller
-                );
-                throw new EE_Error(implode('||', $msg));
-            }
-            if ($route == $this->_current_route) {
-                add_action('admin_init', [$this, $method]);
-            }
-        }
-    }
-
-
-    /**
-     * Loop through the _metaboxes property and add_metaboxes accordingly
-     * //todo we could eventually make this a config component class (i.e. new EE_Metabox);
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    public function add_metaboxes()
-    {
-        if (empty($this->_metaboxes)) {
-            return;
-        } //get out we don't have any metaboxes to set for this connection
-        $this->_handle_metabox_array($this->_metaboxes);
-    }
-
-
-    /**
-     * @param array     $boxes
-     * @param bool|null $add
-     * @throws EE_Error
-     */
-    private function _handle_metabox_array(array $boxes, ?bool $add = true)
-    {
-        foreach ($boxes as $box) {
-            if (! isset($box['page_route'])) {
-                continue;
-            }
-            // we don't have a valid array
-            // let's make sure $box['page_route'] is an array so the "foreach" will work.
-            $box['page_route'] = (array) $box['page_route'];
-            foreach ($box['page_route'] as $route) {
-                if ($route != $this->_current_route) {
-                    continue;
-                } //get out we only add metaboxes for set route.
-                if ($add) {
-                    $this->_add_metabox($box);
-                } else {
-                    $this->_remove_metabox($box);
-                }
-            }
-        }
-    }
-
-
-    /**
-     * Loop through the _remove_metaboxes property and remove metaboxes accordingly.
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    public function remove_metaboxes()
-    {
-        if (empty($this->_remove_metaboxes)) {
-            return;
-        } //get out there are no metaboxes to remove
-        $this->_handle_metabox_array($this->_remove_metaboxes, false);
-    }
-
-
-    /**
-     * This just handles adding a metabox
-     *
-     * @param array $args an array of args that have been set for this metabox by the child class
-     * @throws EE_Error
-     */
-    private function _add_metabox(array $args)
-    {
-        $current_screen    = get_current_screen();
-        $screen_id         = is_object($current_screen) ? $current_screen->id : null;
-        $callback          = $args['func'] ?? 'some_invalid_callback';
-        $callback_function = is_array($callback) ? end($callback) : $callback;
-        // set defaults
-        $defaults      = [
-            'callback_args' => [],
-            'context'       => 'advanced',
-            'func'          => $callback,
-            'id'            => $this->caller . '_' . $callback_function . '_metabox',
-            'label'         => $this->caller,
-            'page'          => $args['page'] ?? $screen_id,
-            'priority'      => 'default',
-        ];
-        $args          = wp_parse_args($args, $defaults);
-        $callback_args = $args['callback_args'];
-        $context       = $args['context'];
-        $id            = $args['id'];
-        $label         = $args['label'];
-        $page          = $args['page'];
-        $priority      = $args['priority'];
-        // make sure method exists
-        if (! method_exists($this, $callback_function)) {
-            $msg[] =
-                esc_html__('There is no corresponding method to display the metabox content', 'event_espresso')
-                . '<br />';
-            $msg[] = sprintf(
-                esc_html__(
-                    'The method name given in the array is %s, check the spelling and make sure it exists in the %s class',
-                    'event_espresso'
-                ),
-                $callback_function,
-                $this->caller
-            );
-            throw new EE_Error(implode('||', $msg));
-        }
-        // everything checks out so let's add the metabox
-        add_meta_box($id, $label, [$this, $callback_function], $page, $context, $priority, $callback_args);
-        add_filter(
-            "postbox_classes_{$page}_$id",
-            function ($classes) {
-                $classes[] = 'ee-admin-container';
-                return $classes;
-            }
-        );
-    }
-
-
-    private function _remove_metabox($args)
-    {
-        $current_screen = get_current_screen();
-        $screen_id      = is_object($current_screen) ? $current_screen->id : null;
-        $func           = $args['func'] ?? 'some_invalid_callback';
-        // set defaults
-        $defaults = [
-            'context' => 'default',
-            'id'      => $args['id'] ?? "{$this->_current_route}_{$this->caller}_{$func}_metabox",
-            'screen'  => $args['screen'] ?? $screen_id,
-        ];
-        $args     = wp_parse_args($args, $defaults);
-        $context  = $args['context'];
-        $id       = $args['id'];
-        $screen   = $args['screen'];
-        // everything checks out so lets remove the box!
-        remove_meta_box($id, $screen, $context);
-    }
+	/**
+	 * This just holds an instance of the page object for this hook
+	 *
+	 * @var EE_Admin_Page|EE_Admin_Page_CPT|null
+	 * @deprecated  5.0.8.p
+	 */
+	protected $_page_object = null;
+
+	/**
+	 * This holds the EE_Admin_Page object from the calling admin page that this object hooks into.
+	 *
+	 * @var EE_Admin_Page|EE_Admin_Page_CPT|null
+	 */
+	protected                   $_adminpage_obj = null;
+
+	protected ?EE_Registry      $EE             = null;
+
+	protected ?RequestInterface $request        = null;
+
+	/**
+	 * This is set by child classes and is an associative array of ajax hooks in the format:
+	 * array(
+	 *    'ajax_action_ref' => 'executing_method'; //must be public
+	 * )
+	 */
+	protected array $_ajax_func = [];
+
+	/**
+	 * This is an array of methods that get executed on a page routes admin_init hook. Use the following format:
+	 * array(
+	 *    'page_route' => 'executing_method' //must be public
+	 * )
+	 */
+	protected array $_init_func = [];
+
+	/**
+	 * This is an array of methods that output metabox content for the given page route.  Use the following format:
+	 * [
+	 *      0 => [
+	 *          'page_route' => 'string_for_page_route',    must correspond to a page route in the class being connected
+	 *                                                      with (i.e. "edit_event") If this is in an array then the
+	 *                                                      same params below will be used but the metabox will be
+	 *                                                      added to each route.
+	 *          'func' =>  'executing_method',              must be public (i.e. public function executing_method
+	 *                                                      ($post, $callback_args){} ).
+	 *                                                      Note if you include callback args in the array then you
+	 *                                                      need to declare them in the method arguments.
+	 *          'id' => 'identifier_for_metabox',           so it can be removed by addons
+	 *                                                      (optional, class will set it automatically)
+	 *          'priority' => 'default',                    default 'default' (optional)
+	 *          'label' => esc_html__('Localized Title', 'event_espresso'),
+	 *          'context' => 'advanced'                     advanced is default (optional),
+	 *      ]
+	 *      'callback_args' => array() //any callback args to include (optional)
+	 * ]
+	 * Why are we indexing numerically?  Because it's possible there may be more than one metabox per page_route.
+	 */
+	protected array $_metaboxes = [];
+
+	/**
+	 * This is an array of values that indicate any metaboxes we want removed from a given page route.  Usually this is
+	 * used when caffeinated functionality is replacing decaffeinated functionality.  Use the following format for the
+	 * array: array(
+	 *    0 => array(
+	 *        'page_route' => 'string_for_page_route' //can be string or array of strings that match a page_route(s)
+	 *        that are in the class being connected with (i.e. 'edit', or 'create_new').
+	 *        'id' => 'identifier_for_metabox', //what the id is of the metabox being removed
+	 *        'context' => 'normal', //the context for the metabox being removed (has to match)
+	 *        'screen' => 'screen_id', //(optional), if not included then this class will attempt to remove the metabox
+	 *        using the currently loaded screen object->id  however, there may be cases where you have to specify the
+	 *        id for the screen the metabox is on.
+	 *    )
+	 * )
+	 */
+	protected array $_remove_metaboxes = [];
+
+	protected array $_req_data         = [];
+
+	/**
+	 * This parent class takes care of loading the scripts and styles if the child class has set the properties for
+	 * them in the following format.  Note, the first array index ('register') is for defining all the registers.  The
+	 * second array index is for indicating what routes each script/style loads on. array(
+	 * 'registers' => array(
+	 *        'script_ref' => array( // if more than one script is to be loaded its best to use the 'dependency'
+	 *        argument to link scripts together.
+	 *            'type' => 'js' // 'js' or 'css' (defaults to js).  This tells us what type of wp_function to use
+	 *            'url' => 'http://urltoscript.css.js',
+	 *            'depends' => array('jquery'), //an array of dependencies for the scripts. REMEMBER, if a script has
+	 *            already been registered elsewhere in the system.  You can just use the depends array to make sure it
+	 *            gets loaded before the one you are setting here.
+	 *            'footer' => TRUE //defaults to true (styles don't use this parameter)
+	 *        ),
+	 *    'enqueues' => array( //this time each key corresponds to the script ref followed by an array of page routes
+	 *    the script gets enqueued on.
+	 *        'script_ref' => array('route_one', 'route_two')
+	 *    ),
+	 *    'localize' => array( //this allows you to set a localized object.  Indicate which script the object is being
+	 *    attached to and then include an array indexed by the name of the object and the array of key/value pairs for
+	 *    the object.
+	 *        'scrip_ref' => array(
+	 *            'NAME_OF_JS_OBJECT' => array(
+	 *                'translate_ref' => esc_html__('localized_string', 'event_espresso'),
+	 *                'some_data' => 5
+	 *            )
+	 *        )
+	 *    )
+	 * )
+	 */
+	protected array $_scripts_styles = [];
+
+	protected array $_scripts        = [];
+
+	protected array $_styles         = [];
+
+	/**
+	 * this optional property can be set by child classes to override the priority for the automatic action/filter hook
+	 * loading in the `_load_routed_hooks()` method.  Please follow this format: array(
+	 *    'wp_hook_reference' => 1
+	 *    )
+	 * )
+	 */
+	protected array $_wp_action_filters_priority = [];
+
+	/**
+	 * this is just a flag set automatically to indicate whether we've got an extended hook class running (i.e.
+	 * espresso_events_Registration_Form_Hooks_Extend extends espresso_events_Registration_Form_Hooks).  This flag is
+	 * used later to make sure we require the needed files.
+	 */
+	protected bool $_extend = false;
+
+	/**
+	 * we're just going to use this to hold the name of the caller class (child class name)
+	 */
+	public string    $caller         = '';
+
+	protected string $_current_route = '';
+
+
+	/**
+	 * child classes MUST set this property so that the page object can be loaded correctly
+	 */
+	protected string $_name = '';
+
+
+	/**
+	 * constructor
+	 *
+	 * @param EE_Admin_Page $admin_page
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function __construct(EE_Admin_Page $admin_page)
+	{
+		$this->_adminpage_obj = $admin_page;
+		$this->request        = LoaderFactory::getLoader()->getShared(RequestInterface::class);
+		$this->_req_data      = $this->request->requestParams();
+		$current_page         = $this->request->getRequestParam('page');
+		$current_page         = $this->request->getRequestParam('current_page', $current_page);
+		// first let's verify we're on the right page
+		if ($current_page !== $this->_adminpage_obj->page_slug) {
+			return;
+		}
+		$this->_set_defaults();
+		$this->_set_hooks_properties();
+		// get out nothing more to be done here.
+		// allow for extends to modify properties
+		if (method_exists($this, '_extend_properties')) {
+			$this->_extend_properties();
+		}
+		// $this->_set_page_object();
+		$this->_init_hooks();
+		$this->_load_custom_methods();
+		$this->_load_routed_hooks();
+		add_action('admin_enqueue_scripts', [$this, 'enqueue_scripts_styles']);
+		add_action('admin_enqueue_scripts', [$this, 'add_metaboxes'], 20);
+		add_action('admin_enqueue_scripts', [$this, 'remove_metaboxes'], 15);
+		$this->_ajax_hooks();
+	}
+
+
+	/**
+	 * used by child classes to set the following properties:
+	 * $_ajax_func (optional)
+	 * $_init_func (optional)
+	 * $_metaboxes (optional)
+	 * $_scripts (optional)
+	 * $_styles (optional)
+	 * $_name (required)
+	 * Also in this method will be registered any scripts or styles loaded on the targeted page (as indicated in the
+	 * _scripts/_styles properties) Also children should place in this method any filters/actions that have to happen
+	 * really early on page load (just after admin_init) if they want to have them registered for handling early.
+	 *
+	 * @abstract
+	 * @return void
+	 */
+	abstract protected function _set_hooks_properties();
+
+
+	/**
+	 * The hooks for enqueue_scripts and enqueue_styles will be run in here.  Child classes need to define their
+	 * scripts and styles in the relevant $_scripts and $_styles properties.  Child classes must have also already
+	 * registered the scripts and styles using wp_register_script and wp_register_style functions.
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function enqueue_scripts_styles()
+	{
+		if (! empty($this->_scripts_styles)) {
+			// first let's do all the registrations
+			if (! isset($this->_scripts_styles['registers'])) {
+				$msg[] = esc_html__(
+					'There is no "registers" index in the <code>$this->_scripts_styles</code> property.',
+					'event_espresso'
+				);
+				$msg[] = sprintf(
+					esc_html__(
+						'Make sure you read the phpdoc comments above the definition of the $_scripts_styles property in the <code>EE_Admin_Hooks</code> class and modify according in the %s child',
+						'event_espresso'
+					),
+					'<strong>' . $this->caller . '</strong>'
+				);
+				throw new EE_Error(implode('||', $msg));
+			}
+			$defaults = [
+				'type'    => 'js',
+				'url'     => '',
+				'depends' => [],
+				'version' => EVENT_ESPRESSO_VERSION,
+				'footer'  => true,
+			];
+			foreach ($this->_scripts_styles['registers'] as $ref => $details) {
+				$details = wp_parse_args($details, $defaults);
+				$type    = $details['type'];
+				$url     = $details['url'];
+				$depends = $details['depends'];
+				$version = $details['version'];
+				$footer  = $details['footer'];
+				// let's make sure that we set the 'registers' type if it's not set!
+				// We need it later to determine which enqueue we do
+				$this->_scripts_styles['registers'][ $ref ]['type'] = $type;
+				// let's make sure we're not missing any REQUIRED parameters
+				if (empty($url)) {
+					$msg[] = sprintf(
+						esc_html__('Missing the url for the requested %s', 'event_espresso'),
+						$type == 'js' ? 'script' : 'stylesheet'
+					);
+					$msg[] = sprintf(
+						esc_html__(
+							'Double-check your <code>$this->_scripts_styles</code> array in %s and make sure that there is a "url" set for the %s ref',
+							'event_espresso'
+						),
+						'<strong>' . $this->caller . '</strong>',
+						$ref
+					);
+					throw new EE_Error(implode('||', $msg));
+				}
+				// made it here so let's do the appropriate registration
+				$type == 'js'
+					? wp_register_script($ref, $url, $depends, $version, $footer)
+					: wp_register_style(
+					$ref,
+					$url,
+					$depends,
+					$version
+				);
+			}
+			// k now let's do the enqueues
+			if (! isset($this->_scripts_styles['enqueues'])) {
+				return;
+			}  //not sure if we should throw an error here or not.
+
+			foreach ($this->_scripts_styles['enqueues'] as $ref => $routes) {
+				// make sure $routes is an array
+				$routes = (array) $routes;
+				if (in_array($this->_current_route, $routes)) {
+					$this->_scripts_styles['registers'][ $ref ]['type'] == 'js' ? wp_enqueue_script($ref)
+						: wp_enqueue_style($ref);
+					// if we have a localization for the script let's do that too.
+					if (isset($this->_scripts_styles['localize'][ $ref ])) {
+						foreach ($this->_scripts_styles['localize'][ $ref ] as $object_name => $indexes) {
+							wp_localize_script(
+								$ref,
+								$object_name,
+								$this->_scripts_styles['localize'][ $ref ][ $object_name ]
+							);
+						}
+					}
+				}
+			}
+			// let's do the deregisters
+			if (! isset($this->_scripts_styles['deregisters'])) {
+				return;
+			}
+			foreach ($this->_scripts_styles['deregisters'] as $ref => $details) {
+				$defaults = ['type' => 'js'];
+				$details  = wp_parse_args($details, $defaults);
+				$details['type'] === 'js' ? wp_deregister_script($ref) : wp_deregister_style($ref);
+			}
+		}
+	}
+
+
+	/**
+	 * just set the defaults for the hooks properties.
+	 *
+	 * @return void
+	 */
+	private function _set_defaults()
+	{
+		$this->_ajax_func                  = [];
+		$this->_init_func                  = [];
+		$this->_metaboxes                  = [];
+		$this->_scripts                    = [];
+		$this->_styles                     = [];
+		$this->_wp_action_filters_priority = [];
+		$this->_current_route              = $this->getCurrentRoute();
+		$this->caller                      = get_class($this);
+		$this->_extend                     = (bool) stripos($this->caller, 'Extend');
+	}
+
+
+	/**
+	 * A helper for determining the current route.
+	 *
+	 * @return string
+	 */
+	private function getCurrentRoute(): string
+	{
+		$action = $this->request->getRequestParam('action');
+		// list tables do something else with 'action' for bulk actions.
+		$action = $action !== '-1' && $action !== '' ? $action : 'default';
+		$route  = $this->request->getRequestParam('route');
+		// we set a 'route' variable in some cases where action is being used by something else.
+		return $action === 'default' && $route !== '' ? $route : $action;
+	}
+
+
+	/**
+	 * this sets the _page_object property
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws Throwable
+	 * @deprecated  5.0.8.p
+	 */
+	protected function _set_page_object()
+	{
+		if ($this->_page_object instanceof EE_Admin_Page) {
+			return;
+		}
+		// first make sure $this->_name is set
+		if (empty($this->_name)) {
+			$msg[] = esc_html__('We can\'t load the page object', 'event_espresso');
+			$msg[] = sprintf(
+				esc_html__("This is because the %s child class has not set the '_name' property", 'event_espresso'),
+				$this->caller
+			);
+			throw new EE_Error(implode('||', $msg));
+		}
+		// change "the_message" to "the message"
+		$class_name = str_replace('_', ' ', $this->_name);
+		// change "the message" to "The_Message_Admin_Page"
+		$class_name = str_replace(' ', '_', ucwords($class_name)) . '_Admin_Page';
+		// first default file (if exists)
+		$decaf_file = EE_ADMIN_PAGES . "$this->_name/$class_name.core.php";
+		if (is_readable($decaf_file)) {
+			require_once($decaf_file);
+		}
+		// now we have to do require for extended file (if needed)
+		if ($this->_extend) {
+			require_once EE_CORE_CAF_ADMIN_EXTEND . "$this->_name/Extend_$class_name.core.php";
+			// and extend the class name as well
+			$class_name = 'Extend_' . $class_name;
+		}
+		// let's make sure the class exists
+		if (! class_exists($class_name)) {
+			$msg[] = esc_html__('We can\'t load the page object', 'event_espresso');
+			$msg[] = sprintf(
+				esc_html__(
+					'The class name that was given is %s. Check the spelling and make sure its correct, also there needs to be an autoloader setup for the class',
+					'event_espresso'
+				),
+				$class_name
+			);
+			throw new EE_Error(implode('||', $msg));
+		}
+		// do NOT load admin pages that are ALREADY LOADED!!!
+		if ($class_name !== $this->_adminpage_obj->class_name) {
+			return;
+		}
+		$this->_page_object = LoaderFactory::getLoader()->getShared($class_name, [false]);
+		$this->_page_object->initializePage();
+	}
+
+
+	/**
+	 * Child "hook" classes can declare any methods that they want executed when a specific page route is loaded.  The
+	 * advantage of this is when doing things like running our own db interactions on saves etc.  Remember that
+	 * $this->_req_data (all the _POST and _GET data) is available to your methods.
+	 *
+	 * @return void
+	 */
+	private function _load_custom_methods()
+	{
+		/**
+		 * method cannot be named 'default' (@see http://us3.php
+		 * .net/manual/en/reserved.keywords.php) so need to
+		 * handle routes that are "default"
+		 *
+		 * @since 4.3.0
+		 */
+		$method_callback = $this->_current_route == 'default' ? 'default_callback' : $this->_current_route;
+		// these run before the Admin_Page route executes.
+		if (is_callable($this, $method_callback)) {
+			call_user_func([$this, $method_callback]);
+		}
+		// these run via the _redirect_after_action method in EE_Admin_Page which usually happens after non_UI methods in EE_Admin_Page classes.  There are two redirect actions, the first fires before $query_args might be manipulated by "save and close" actions and the second fires right before the actual redirect happens.
+		// first the actions
+		// note that these action hooks will have the $query_args value available.
+		$admin_class_name = get_class($this->_adminpage_obj);
+		if (method_exists($this, '_redirect_action_early_' . $this->_current_route)) {
+			add_action(
+				'AHEE__'
+				. $admin_class_name
+				. '___redirect_after_action__before_redirect_modification_'
+				. $this->_current_route,
+				[$this, '_redirect_action_early_' . $this->_current_route]
+			);
+		}
+		if (method_exists($this, '_redirect_action_' . $this->_current_route)) {
+			add_action(
+				'AHEE_redirect_' . $admin_class_name . $this->_current_route,
+				[$this, '_redirect_action_' . $this->_current_route]
+			);
+		}
+		// let's hook into the _redirect itself and allow for changing where the user goes after redirect.  This will have $query_args and $redirect_url available.
+		if (method_exists($this, '_redirect_filter_' . $this->_current_route)) {
+			add_filter(
+				'FHEE_redirect_' . $admin_class_name . $this->_current_route,
+				[$this, '_redirect_filter_' . $this->_current_route],
+				10,
+				2
+			);
+		}
+	}
+
+
+	/**
+	 * This method will search for a corresponding method with a name matching the route and the wp_hook to run.  This
+	 * allows child hook classes to target hooking into a specific wp action or filter hook ONLY on a certain route.
+	 * just remember, methods MUST be public Future hooks should be added in here to be access by child classes.
+	 *
+	 * @return void
+	 */
+	private function _load_routed_hooks()
+	{
+		// this array provides the hook action names that will be referenced.  Key is the action. Value is an array with the type (action or filter) and the number of parameters for the hook.  We'll default all priorities for automatic hooks to 10.
+		$hook_filter_array = [
+			'admin_footer'                                                                            => [
+				'type'     => 'action',
+				'argnum'   => 1,
+				'priority' => 10,
+			],
+			'FHEE_list_table_views_' . $this->_adminpage_obj->page_slug . '_' . $this->_current_route => [
+				'type'     => 'filter',
+				'argnum'   => 1,
+				'priority' => 10,
+			],
+			'FHEE_list_table_views_' . $this->_adminpage_obj->page_slug                               => [
+				'type'     => 'filter',
+				'argnum'   => 1,
+				'priority' => 10,
+			],
+			'FHEE_list_table_views'                                                                   => [
+				'type'     => 'filter',
+				'argnum'   => 1,
+				'priority' => 10,
+			],
+			'AHEE__EE_Admin_Page___display_admin_page__modify_metaboxes'                              => [
+				'type'     => 'action',
+				'argnum'   => 1,
+				'priority' => 10,
+			],
+		];
+		foreach ($hook_filter_array as $hook => $args) {
+			if (method_exists($this, $this->_current_route . '_' . $hook)) {
+				if (isset($this->_wp_action_filters_priority[ $hook ])) {
+					$args['priority'] = $this->_wp_action_filters_priority[ $hook ];
+				}
+				if ($args['type'] == 'action') {
+					add_action(
+						$hook,
+						[$this, $this->_current_route . '_' . $hook],
+						$args['priority'],
+						$args['argnum']
+					);
+				} else {
+					add_filter(
+						$hook,
+						[$this, $this->_current_route . '_' . $hook],
+						$args['priority'],
+						$args['argnum']
+					);
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * Loop through the $_ajax_func array and add_actions for the array.
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private function _ajax_hooks()
+	{
+		if (empty($this->_ajax_func)) {
+			return;
+		} //get out there's nothing to take care of.
+		foreach ($this->_ajax_func as $action => $method) {
+			// make sure method exists
+			if (! method_exists($this, $method)) {
+				$msg[] = esc_html__(
+							 'There is no corresponding method for the hook labeled in the _ajax_func array',
+							 'event_espresso'
+						 ) . '<br />';
+				$msg[] = sprintf(
+					esc_html__(
+						'The method name given in the array is %s, check the spelling and make sure it exists in the %s class',
+						'event_espresso'
+					),
+					$method,
+					$this->caller
+				);
+				throw new EE_Error(implode('||', $msg));
+			}
+			add_action('wp_ajax_' . $action, [$this, $method]);
+		}
+	}
+
+
+	/**
+	 * Loop through the $_init_func array and add_actions for the array.
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	protected function _init_hooks()
+	{
+		if (empty($this->_init_func)) {
+			return;
+		}
+		// get out there's nothing to take care of.
+		// We need to determine what page_route we are on!
+		foreach ($this->_init_func as $route => $method) {
+			// make sure method exists
+			if (! method_exists($this, $method)) {
+				$msg[] = esc_html__(
+							 'There is no corresponding method for the hook labeled in the _init_func array',
+							 'event_espresso'
+						 ) . '<br />';
+				$msg[] = sprintf(
+					esc_html__(
+						'The method name given in the array is %s, check the spelling and make sure it exists in the %s class',
+						'event_espresso'
+					),
+					$method,
+					$this->caller
+				);
+				throw new EE_Error(implode('||', $msg));
+			}
+			if ($route == $this->_current_route) {
+				add_action('admin_init', [$this, $method]);
+			}
+		}
+	}
+
+
+	/**
+	 * Loop through the _metaboxes property and add_metaboxes accordingly
+	 * //todo we could eventually make this a config component class (i.e. new EE_Metabox);
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function add_metaboxes()
+	{
+		if (empty($this->_metaboxes)) {
+			return;
+		} //get out we don't have any metaboxes to set for this connection
+		$this->_handle_metabox_array($this->_metaboxes);
+	}
+
+
+	/**
+	 * @param array     $boxes
+	 * @param bool|null $add
+	 * @throws EE_Error
+	 */
+	private function _handle_metabox_array(array $boxes, ?bool $add = true)
+	{
+		foreach ($boxes as $box) {
+			if (! isset($box['page_route'])) {
+				continue;
+			}
+			// we don't have a valid array
+			// let's make sure $box['page_route'] is an array so the "foreach" will work.
+			$box['page_route'] = (array) $box['page_route'];
+			foreach ($box['page_route'] as $route) {
+				if ($route != $this->_current_route) {
+					continue;
+				} //get out we only add metaboxes for set route.
+				if ($add) {
+					$this->_add_metabox($box);
+				} else {
+					$this->_remove_metabox($box);
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * Loop through the _remove_metaboxes property and remove metaboxes accordingly.
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function remove_metaboxes()
+	{
+		if (empty($this->_remove_metaboxes)) {
+			return;
+		} //get out there are no metaboxes to remove
+		$this->_handle_metabox_array($this->_remove_metaboxes, false);
+	}
+
+
+	/**
+	 * This just handles adding a metabox
+	 *
+	 * @param array $args an array of args that have been set for this metabox by the child class
+	 * @throws EE_Error
+	 */
+	private function _add_metabox(array $args)
+	{
+		$current_screen    = get_current_screen();
+		$screen_id         = is_object($current_screen) ? $current_screen->id : null;
+		$callback          = $args['func'] ?? 'some_invalid_callback';
+		$callback_function = is_array($callback) ? end($callback) : $callback;
+		// set defaults
+		$defaults      = [
+			'callback_args' => [],
+			'context'       => 'advanced',
+			'func'          => $callback,
+			'id'            => $this->caller . '_' . $callback_function . '_metabox',
+			'label'         => $this->caller,
+			'page'          => $args['page'] ?? $screen_id,
+			'priority'      => 'default',
+		];
+		$args          = wp_parse_args($args, $defaults);
+		$callback_args = $args['callback_args'];
+		$context       = $args['context'];
+		$id            = $args['id'];
+		$label         = $args['label'];
+		$page          = $args['page'];
+		$priority      = $args['priority'];
+		// make sure method exists
+		if (! method_exists($this, $callback_function)) {
+			$msg[] =
+				esc_html__('There is no corresponding method to display the metabox content', 'event_espresso')
+				. '<br />';
+			$msg[] = sprintf(
+				esc_html__(
+					'The method name given in the array is %s, check the spelling and make sure it exists in the %s class',
+					'event_espresso'
+				),
+				$callback_function,
+				$this->caller
+			);
+			throw new EE_Error(implode('||', $msg));
+		}
+		// everything checks out so let's add the metabox
+		add_meta_box($id, $label, [$this, $callback_function], $page, $context, $priority, $callback_args);
+		add_filter(
+			"postbox_classes_{$page}_$id",
+			function ($classes) {
+				$classes[] = 'ee-admin-container';
+				return $classes;
+			}
+		);
+	}
+
+
+	private function _remove_metabox($args)
+	{
+		$current_screen = get_current_screen();
+		$screen_id      = is_object($current_screen) ? $current_screen->id : null;
+		$func           = $args['func'] ?? 'some_invalid_callback';
+		// set defaults
+		$defaults = [
+			'context' => 'default',
+			'id'      => $args['id'] ?? "{$this->_current_route}_{$this->caller}_{$func}_metabox",
+			'screen'  => $args['screen'] ?? $screen_id,
+		];
+		$args     = wp_parse_args($args, $defaults);
+		$context  = $args['context'];
+		$id       = $args['id'];
+		$screen   = $args['screen'];
+		// everything checks out so lets remove the box!
+		remove_meta_box($id, $screen, $context);
+	}
 }

Spacing +41 added lines, -41 removed lines

@@ -223,9 +223,9 @@ 
      */
     public function enqueue_scripts_styles()
     {
-        if (! empty($this->_scripts_styles)) {
+        if ( ! empty($this->_scripts_styles)) {
             // first let's do all the registrations
-            if (! isset($this->_scripts_styles['registers'])) {
+            if ( ! isset($this->_scripts_styles['registers'])) {
                 $msg[] = esc_html__(
                     'There is no "registers" index in the <code>$this->_scripts_styles</code> property.',
                     'event_espresso'
@@ -235,7 +235,7 @@ 
                         'Make sure you read the phpdoc comments above the definition of the $_scripts_styles property in the <code>EE_Admin_Hooks</code> class and modify according in the %s child',
                         'event_espresso'
                     ),
-                    '<strong>' . $this->caller . '</strong>'
+                    '<strong>'.$this->caller.'</strong>'
                 );
                 throw new EE_Error(implode('||', $msg));
             }
@@ -255,7 +255,7 @@ 
                 $footer  = $details['footer'];
                 // let's make sure that we set the 'registers' type if it's not set!
                 // We need it later to determine which enqueue we do
-                $this->_scripts_styles['registers'][ $ref ]['type'] = $type;
+                $this->_scripts_styles['registers'][$ref]['type'] = $type;
                 // let's make sure we're not missing any REQUIRED parameters
                 if (empty($url)) {
                     $msg[] = sprintf(
@@ -267,7 +267,7 @@ 
                             'Double-check your <code>$this->_scripts_styles</code> array in %s and make sure that there is a "url" set for the %s ref',
                             'event_espresso'
                         ),
-                        '<strong>' . $this->caller . '</strong>',
+                        '<strong>'.$this->caller.'</strong>',
                         $ref
                     );
                     throw new EE_Error(implode('||', $msg));
@@ -283,7 +283,7 @@ 
                 );
             }
             // k now let's do the enqueues
-            if (! isset($this->_scripts_styles['enqueues'])) {
+            if ( ! isset($this->_scripts_styles['enqueues'])) {
                 return;
             }  //not sure if we should throw an error here or not.
 
@@ -291,22 +291,22 @@ 
                 // make sure $routes is an array
                 $routes = (array) $routes;
                 if (in_array($this->_current_route, $routes)) {
-                    $this->_scripts_styles['registers'][ $ref ]['type'] == 'js' ? wp_enqueue_script($ref)
+                    $this->_scripts_styles['registers'][$ref]['type'] == 'js' ? wp_enqueue_script($ref)
                         : wp_enqueue_style($ref);
                     // if we have a localization for the script let's do that too.
-                    if (isset($this->_scripts_styles['localize'][ $ref ])) {
-                        foreach ($this->_scripts_styles['localize'][ $ref ] as $object_name => $indexes) {
+                    if (isset($this->_scripts_styles['localize'][$ref])) {
+                        foreach ($this->_scripts_styles['localize'][$ref] as $object_name => $indexes) {
                             wp_localize_script(
                                 $ref,
                                 $object_name,
-                                $this->_scripts_styles['localize'][ $ref ][ $object_name ]
+                                $this->_scripts_styles['localize'][$ref][$object_name]
                             );
                         }
                     }
                 }
             }
             // let's do the deregisters
-            if (! isset($this->_scripts_styles['deregisters'])) {
+            if ( ! isset($this->_scripts_styles['deregisters'])) {
                 return;
             }
             foreach ($this->_scripts_styles['deregisters'] as $ref => $details) {
@@ -379,20 +379,20 @@ 
         // change "the_message" to "the message"
         $class_name = str_replace('_', ' ', $this->_name);
         // change "the message" to "The_Message_Admin_Page"
-        $class_name = str_replace(' ', '_', ucwords($class_name)) . '_Admin_Page';
+        $class_name = str_replace(' ', '_', ucwords($class_name)).'_Admin_Page';
         // first default file (if exists)
-        $decaf_file = EE_ADMIN_PAGES . "$this->_name/$class_name.core.php";
+        $decaf_file = EE_ADMIN_PAGES."$this->_name/$class_name.core.php";
         if (is_readable($decaf_file)) {
             require_once($decaf_file);
         }
         // now we have to do require for extended file (if needed)
         if ($this->_extend) {
-            require_once EE_CORE_CAF_ADMIN_EXTEND . "$this->_name/Extend_$class_name.core.php";
+            require_once EE_CORE_CAF_ADMIN_EXTEND."$this->_name/Extend_$class_name.core.php";
             // and extend the class name as well
-            $class_name = 'Extend_' . $class_name;
+            $class_name = 'Extend_'.$class_name;
         }
         // let's make sure the class exists
-        if (! class_exists($class_name)) {
+        if ( ! class_exists($class_name)) {
             $msg[] = esc_html__('We can\'t load the page object', 'event_espresso');
             $msg[] = sprintf(
                 esc_html__(
@@ -437,26 +437,26 @@ 
         // first the actions
         // note that these action hooks will have the $query_args value available.
         $admin_class_name = get_class($this->_adminpage_obj);
-        if (method_exists($this, '_redirect_action_early_' . $this->_current_route)) {
+        if (method_exists($this, '_redirect_action_early_'.$this->_current_route)) {
             add_action(
                 'AHEE__'
                 . $admin_class_name
                 . '___redirect_after_action__before_redirect_modification_'
                 . $this->_current_route,
-                [$this, '_redirect_action_early_' . $this->_current_route]
+                [$this, '_redirect_action_early_'.$this->_current_route]
             );
         }
-        if (method_exists($this, '_redirect_action_' . $this->_current_route)) {
+        if (method_exists($this, '_redirect_action_'.$this->_current_route)) {
             add_action(
-                'AHEE_redirect_' . $admin_class_name . $this->_current_route,
-                [$this, '_redirect_action_' . $this->_current_route]
+                'AHEE_redirect_'.$admin_class_name.$this->_current_route,
+                [$this, '_redirect_action_'.$this->_current_route]
             );
         }
         // let's hook into the _redirect itself and allow for changing where the user goes after redirect.  This will have $query_args and $redirect_url available.
-        if (method_exists($this, '_redirect_filter_' . $this->_current_route)) {
+        if (method_exists($this, '_redirect_filter_'.$this->_current_route)) {
             add_filter(
-                'FHEE_redirect_' . $admin_class_name . $this->_current_route,
-                [$this, '_redirect_filter_' . $this->_current_route],
+                'FHEE_redirect_'.$admin_class_name.$this->_current_route,
+                [$this, '_redirect_filter_'.$this->_current_route],
                 10,
                 2
             );
@@ -480,12 +480,12 @@ 
                 'argnum'   => 1,
                 'priority' => 10,
             ],
-            'FHEE_list_table_views_' . $this->_adminpage_obj->page_slug . '_' . $this->_current_route => [
+            'FHEE_list_table_views_'.$this->_adminpage_obj->page_slug.'_'.$this->_current_route => [
                 'type'     => 'filter',
                 'argnum'   => 1,
                 'priority' => 10,
             ],
-            'FHEE_list_table_views_' . $this->_adminpage_obj->page_slug                               => [
+            'FHEE_list_table_views_'.$this->_adminpage_obj->page_slug                               => [
                 'type'     => 'filter',
                 'argnum'   => 1,
                 'priority' => 10,
@@ -502,21 +502,21 @@ 
             ],
         ];
         foreach ($hook_filter_array as $hook => $args) {
-            if (method_exists($this, $this->_current_route . '_' . $hook)) {
-                if (isset($this->_wp_action_filters_priority[ $hook ])) {
-                    $args['priority'] = $this->_wp_action_filters_priority[ $hook ];
+            if (method_exists($this, $this->_current_route.'_'.$hook)) {
+                if (isset($this->_wp_action_filters_priority[$hook])) {
+                    $args['priority'] = $this->_wp_action_filters_priority[$hook];
                 }
                 if ($args['type'] == 'action') {
                     add_action(
                         $hook,
-                        [$this, $this->_current_route . '_' . $hook],
+                        [$this, $this->_current_route.'_'.$hook],
                         $args['priority'],
                         $args['argnum']
                     );
                 } else {
                     add_filter(
                         $hook,
-                        [$this, $this->_current_route . '_' . $hook],
+                        [$this, $this->_current_route.'_'.$hook],
                         $args['priority'],
                         $args['argnum']
                     );
@@ -539,11 +539,11 @@ 
         } //get out there's nothing to take care of.
         foreach ($this->_ajax_func as $action => $method) {
             // make sure method exists
-            if (! method_exists($this, $method)) {
+            if ( ! method_exists($this, $method)) {
                 $msg[] = esc_html__(
                              'There is no corresponding method for the hook labeled in the _ajax_func array',
                              'event_espresso'
-                         ) . '<br />';
+                         ).'<br />';
                 $msg[] = sprintf(
                     esc_html__(
                         'The method name given in the array is %s, check the spelling and make sure it exists in the %s class',
@@ -554,7 +554,7 @@ 
                 );
                 throw new EE_Error(implode('||', $msg));
             }
-            add_action('wp_ajax_' . $action, [$this, $method]);
+            add_action('wp_ajax_'.$action, [$this, $method]);
         }
     }
 
@@ -574,11 +574,11 @@ 
         // We need to determine what page_route we are on!
         foreach ($this->_init_func as $route => $method) {
             // make sure method exists
-            if (! method_exists($this, $method)) {
+            if ( ! method_exists($this, $method)) {
                 $msg[] = esc_html__(
                              'There is no corresponding method for the hook labeled in the _init_func array',
                              'event_espresso'
-                         ) . '<br />';
+                         ).'<br />';
                 $msg[] = sprintf(
                     esc_html__(
                         'The method name given in the array is %s, check the spelling and make sure it exists in the %s class',
@@ -620,7 +620,7 @@ 
     private function _handle_metabox_array(array $boxes, ?bool $add = true)
     {
         foreach ($boxes as $box) {
-            if (! isset($box['page_route'])) {
+            if ( ! isset($box['page_route'])) {
                 continue;
             }
             // we don't have a valid array
@@ -668,11 +668,11 @@ 
         $callback          = $args['func'] ?? 'some_invalid_callback';
         $callback_function = is_array($callback) ? end($callback) : $callback;
         // set defaults
-        $defaults      = [
+        $defaults = [
             'callback_args' => [],
             'context'       => 'advanced',
             'func'          => $callback,
-            'id'            => $this->caller . '_' . $callback_function . '_metabox',
+            'id'            => $this->caller.'_'.$callback_function.'_metabox',
             'label'         => $this->caller,
             'page'          => $args['page'] ?? $screen_id,
             'priority'      => 'default',
@@ -685,7 +685,7 @@ 
         $page          = $args['page'];
         $priority      = $args['priority'];
         // make sure method exists
-        if (! method_exists($this, $callback_function)) {
+        if ( ! method_exists($this, $callback_function)) {
             $msg[] =
                 esc_html__('There is no corresponding method to display the metabox content', 'event_espresso')
                 . '<br />';
@@ -703,7 +703,7 @@ 
         add_meta_box($id, $label, [$this, $callback_function], $page, $context, $priority, $callback_args);
         add_filter(
             "postbox_classes_{$page}_$id",
-            function ($classes) {
+            function($classes) {
                 $classes[] = 'ee-admin-container';
                 return $classes;
             }

core/admin/EE_Admin_Page_CPT.core.php

Indentation +1424 added lines, -1424 removed lines

@@ -31,449 +31,449 @@ 
  */
 abstract class EE_Admin_Page_CPT extends EE_Admin_Page
 {
-    /**
-     * @var EE_CPT_Base|null
-     */
-    protected $_cpt_model_obj;
-
-    protected ?WP_Post_Type $_cpt_object = null;
-
-
-    /**
-     * This property allows cpt classes to define multiple routes as cpt routes.
-     * //in this array we define what the custom post type for this route is.
-     * array(
-     * 'route_name' => 'custom_post_type_slug'
-     * )
-     *
-     * @var array
-     */
-    protected array $_cpt_routes = [];
-
-
-    /**
-     * This simply defines what the corresponding routes WP will be redirected to after completing a post save/update.
-     * in this format:
-     * array(
-     * 'post_type_slug' => 'edit_route'
-     * )
-     *
-     * @var array
-     */
-    protected array $_cpt_edit_routes = [];
-
-
-    /**
-     * If child classes set the name of their main model via the $_cpt_obj_models property, EE_Admin_Page_CPT will
-     * attempt to retrieve the related object model for the edit pages and assign it to _cpt_page_object. the
-     * _cpt_model_names property should be in the following format: array(
-     * 'route_defined_by_action_param' => 'Model_Name')
-     *
-     * @var array $_cpt_model_names
-     */
-    protected array $_cpt_model_names = [];
-
-
-    /**
-     * This will hold an array of autosave containers that will be used to obtain input values and hook into the WP
-     * autosave so we can save our inputs on the save_post hook!  Children classes should add to this array by using
-     * the _register_autosave_containers() method so that we don't override any other containers already registered.
-     * Registration of containers should be done before load_page_dependencies() is run.
-     *
-     * @var array
-     */
-    protected array $_autosave_containers = [];
-
-    protected array $_autosave_fields     = [];
-
-    /**
-     * Array mapping from admin actions to their equivalent wp core pages for custom post types. So when a user visits
-     * a page for an action, it will appear as if they were visiting the wp core page for that custom post type
-     *
-     * @var array
-     */
-    protected array $_pagenow_map= [];
-
-
-    /**
-     * This is the route that will be used for the edit post route.
-     *
-     * @var string
-     */
-    protected string $cpt_editpost_route = 'edit';
-
-
-    /**
-     * This is hooked into the WordPress do_action('save_post') hook and runs after the custom post type has been
-     * saved.  Child classes are required to declare this method.  Typically you would use this to save any additional
-     * data. Keep in mind also that "save_post" runs on EVERY post update to the database. ALSO very important.  When a
-     * post transitions from scheduled to published, the save_post action is fired but you will NOT have any _POST data
-     * containing any extra info you may have from other meta saves.  So MAKE sure that you handle this accordingly.
-     *
-     * @abstract
-     * @param string  $post_id The ID of the cpt that was saved (so you can link relationally)
-     * @param WP_Post $post    The post object of the cpt that was saved.
-     * @return void
-     */
-    abstract protected function _insert_update_cpt_item($post_id, $post);
-
-
-    /**
-     * This is hooked into the WordPress do_action('trashed_post') hook and runs after a cpt has been trashed.
-     *
-     * @abstract
-     * @param string $post_id The ID of the cpt that was trashed
-     * @return void
-     */
-    abstract public function trash_cpt_item($post_id);
-
-
-    /**
-     * This is hooked into the WordPress do_action('untrashed_post') hook and runs after a cpt has been untrashed
-     *
-     * @param string $post_id theID of the cpt that was untrashed
-     * @return void
-     */
-    abstract public function restore_cpt_item($post_id);
-
-
-    /**
-     * This is hooked into the WordPress do_action('delete_cpt_item') hook and runs after a cpt has been fully deleted
-     * from the db
-     *
-     * @param string $post_id the ID of the cpt that was deleted
-     * @return void
-     */
-    abstract public function delete_cpt_item($post_id);
-
-
-    /**
-     * @return LoaderInterface
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function getLoader(): LoaderInterface
-    {
-        if (! $this->loader instanceof LoaderInterface) {
-            $this->loader = LoaderFactory::getLoader();
-        }
-        return $this->loader;
-    }
-
-
-    /**
-     * Just utilizing the method EE_Admin exposes for doing things before page setup.
-     *
-     * @return void
-     */
-    protected function _before_page_setup()
-    {
-        $this->raw_req_action = $this->request->getRequestParam('action');
-        $this->raw_req_page   = $this->request->getRequestParam('page');
-        $this->_cpt_routes    = array_merge(
-            [
-                'create_new' => $this->page_slug,
-                'edit'       => $this->page_slug,
-                'trash'      => $this->page_slug,
-            ],
-            $this->_cpt_routes
-        );
-        $cpt_route_action     = $this->_cpt_routes[ $this->raw_req_action ] ?? null;
-        // let's see if the current route has a value for cpt_object_slug. if it does, we use that instead of the page
-        $page              = $this->raw_req_page ?: $this->page_slug;
-        $page              = $cpt_route_action ?: $page;
-        $this->_cpt_object = get_post_type_object($page);
-        // tweak pagenow for page loading.
-        if (empty($this->_pagenow_map)) {
-            $this->_pagenow_map = [
-                'create_new' => 'post-new.php',
-                'edit'       => 'post.php',
-                'trash'      => 'post.php',
-            ];
-        }
-        add_action('current_screen', [$this, 'modify_pagenow']);
-        // TODO the below will need to be reworked to account for the cpt routes that are NOT based off of page but action param.
-        // get current page from autosave
-        $current_page        = $this->request->getRequestParam('ee_autosave_data[ee-cpt-hidden-inputs][current_page]');
-        $this->_current_page = $this->request->getRequestParam('current_page', $current_page);
-    }
-
-
-    /**
-     * Simply ensure that we simulate the correct post route for cpt screens
-     *
-     * @param WP_Screen|null $current_screen
-     * @return void
-     */
-    public function modify_pagenow(?WP_Screen $current_screen)
-    {
-        // possibly reset pagenow.
-        if (
-            $this->page_slug === $this->raw_req_page
-            && isset($this->_pagenow_map[ $this->raw_req_action ])
-        ) {
-            global $pagenow, $hook_suffix;
-            $pagenow     = $this->_pagenow_map[ $this->raw_req_action ];
-            $hook_suffix = $pagenow;
-        }
-    }
-
-
-    /**
-     * This method is used to register additional autosave containers to the _autosave_containers property.
-     *
-     * @param array $ids  an array of ids for containers that hold form inputs we want autosave to pickup.  Typically
-     *                    you would send along the id of a metabox container.
-     * @return void
-     * @todo We should automate this at some point by creating a wrapper for add_post_metabox and in our wrapper we
-     *                    automatically register the id for the post metabox as a container.
-     */
-    protected function _register_autosave_containers($ids)
-    {
-        $this->_autosave_containers = array_merge($this->_autosave_fields, (array) $ids);
-    }
-
-
-    /**
-     * Something nifty.  We're going to loop through all the registered metaboxes and if the CALLBACK is an instance of
-     * EE_Admin_Page OR EE_Admin_Hooks, then we'll add the id to our _autosave_containers array.
-     */
-    protected function _set_autosave_containers()
-    {
-        global $wp_meta_boxes;
-        $containers = [];
-        if (empty($wp_meta_boxes)) {
-            return;
-        }
-        $current_metaboxes = $wp_meta_boxes[ $this->page_slug ] ?? [];
-        foreach ($current_metaboxes as $box_context) {
-            foreach ($box_context as $box_details) {
-                foreach ($box_details as $box) {
-                    if (
-                        is_array($box) && is_array($box['callback'])
-                        && (
-                            $box['callback'][0] instanceof EE_Admin_Page
-                            || $box['callback'][0] instanceof EE_Admin_Hooks
-                        )
-                    ) {
-                        $containers[] = $box['id'];
-                    }
-                }
-            }
-        }
-        $this->_autosave_containers = array_merge($this->_autosave_containers, $containers);
-        // add hidden inputs container
-        $this->_autosave_containers[] = 'ee-cpt-hidden-inputs';
-    }
-
-
-    protected function _load_autosave_scripts_styles()
-    {
-        /*wp_register_script('cpt-autosave', EE_ADMIN_URL . 'assets/ee-cpt-autosave.js', array('ee-serialize-full-array', 'event_editor_js'), EVENT_ESPRESSO_VERSION, TRUE );
+	/**
+	 * @var EE_CPT_Base|null
+	 */
+	protected $_cpt_model_obj;
+
+	protected ?WP_Post_Type $_cpt_object = null;
+
+
+	/**
+	 * This property allows cpt classes to define multiple routes as cpt routes.
+	 * //in this array we define what the custom post type for this route is.
+	 * array(
+	 * 'route_name' => 'custom_post_type_slug'
+	 * )
+	 *
+	 * @var array
+	 */
+	protected array $_cpt_routes = [];
+
+
+	/**
+	 * This simply defines what the corresponding routes WP will be redirected to after completing a post save/update.
+	 * in this format:
+	 * array(
+	 * 'post_type_slug' => 'edit_route'
+	 * )
+	 *
+	 * @var array
+	 */
+	protected array $_cpt_edit_routes = [];
+
+
+	/**
+	 * If child classes set the name of their main model via the $_cpt_obj_models property, EE_Admin_Page_CPT will
+	 * attempt to retrieve the related object model for the edit pages and assign it to _cpt_page_object. the
+	 * _cpt_model_names property should be in the following format: array(
+	 * 'route_defined_by_action_param' => 'Model_Name')
+	 *
+	 * @var array $_cpt_model_names
+	 */
+	protected array $_cpt_model_names = [];
+
+
+	/**
+	 * This will hold an array of autosave containers that will be used to obtain input values and hook into the WP
+	 * autosave so we can save our inputs on the save_post hook!  Children classes should add to this array by using
+	 * the _register_autosave_containers() method so that we don't override any other containers already registered.
+	 * Registration of containers should be done before load_page_dependencies() is run.
+	 *
+	 * @var array
+	 */
+	protected array $_autosave_containers = [];
+
+	protected array $_autosave_fields     = [];
+
+	/**
+	 * Array mapping from admin actions to their equivalent wp core pages for custom post types. So when a user visits
+	 * a page for an action, it will appear as if they were visiting the wp core page for that custom post type
+	 *
+	 * @var array
+	 */
+	protected array $_pagenow_map= [];
+
+
+	/**
+	 * This is the route that will be used for the edit post route.
+	 *
+	 * @var string
+	 */
+	protected string $cpt_editpost_route = 'edit';
+
+
+	/**
+	 * This is hooked into the WordPress do_action('save_post') hook and runs after the custom post type has been
+	 * saved.  Child classes are required to declare this method.  Typically you would use this to save any additional
+	 * data. Keep in mind also that "save_post" runs on EVERY post update to the database. ALSO very important.  When a
+	 * post transitions from scheduled to published, the save_post action is fired but you will NOT have any _POST data
+	 * containing any extra info you may have from other meta saves.  So MAKE sure that you handle this accordingly.
+	 *
+	 * @abstract
+	 * @param string  $post_id The ID of the cpt that was saved (so you can link relationally)
+	 * @param WP_Post $post    The post object of the cpt that was saved.
+	 * @return void
+	 */
+	abstract protected function _insert_update_cpt_item($post_id, $post);
+
+
+	/**
+	 * This is hooked into the WordPress do_action('trashed_post') hook and runs after a cpt has been trashed.
+	 *
+	 * @abstract
+	 * @param string $post_id The ID of the cpt that was trashed
+	 * @return void
+	 */
+	abstract public function trash_cpt_item($post_id);
+
+
+	/**
+	 * This is hooked into the WordPress do_action('untrashed_post') hook and runs after a cpt has been untrashed
+	 *
+	 * @param string $post_id theID of the cpt that was untrashed
+	 * @return void
+	 */
+	abstract public function restore_cpt_item($post_id);
+
+
+	/**
+	 * This is hooked into the WordPress do_action('delete_cpt_item') hook and runs after a cpt has been fully deleted
+	 * from the db
+	 *
+	 * @param string $post_id the ID of the cpt that was deleted
+	 * @return void
+	 */
+	abstract public function delete_cpt_item($post_id);
+
+
+	/**
+	 * @return LoaderInterface
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function getLoader(): LoaderInterface
+	{
+		if (! $this->loader instanceof LoaderInterface) {
+			$this->loader = LoaderFactory::getLoader();
+		}
+		return $this->loader;
+	}
+
+
+	/**
+	 * Just utilizing the method EE_Admin exposes for doing things before page setup.
+	 *
+	 * @return void
+	 */
+	protected function _before_page_setup()
+	{
+		$this->raw_req_action = $this->request->getRequestParam('action');
+		$this->raw_req_page   = $this->request->getRequestParam('page');
+		$this->_cpt_routes    = array_merge(
+			[
+				'create_new' => $this->page_slug,
+				'edit'       => $this->page_slug,
+				'trash'      => $this->page_slug,
+			],
+			$this->_cpt_routes
+		);
+		$cpt_route_action     = $this->_cpt_routes[ $this->raw_req_action ] ?? null;
+		// let's see if the current route has a value for cpt_object_slug. if it does, we use that instead of the page
+		$page              = $this->raw_req_page ?: $this->page_slug;
+		$page              = $cpt_route_action ?: $page;
+		$this->_cpt_object = get_post_type_object($page);
+		// tweak pagenow for page loading.
+		if (empty($this->_pagenow_map)) {
+			$this->_pagenow_map = [
+				'create_new' => 'post-new.php',
+				'edit'       => 'post.php',
+				'trash'      => 'post.php',
+			];
+		}
+		add_action('current_screen', [$this, 'modify_pagenow']);
+		// TODO the below will need to be reworked to account for the cpt routes that are NOT based off of page but action param.
+		// get current page from autosave
+		$current_page        = $this->request->getRequestParam('ee_autosave_data[ee-cpt-hidden-inputs][current_page]');
+		$this->_current_page = $this->request->getRequestParam('current_page', $current_page);
+	}
+
+
+	/**
+	 * Simply ensure that we simulate the correct post route for cpt screens
+	 *
+	 * @param WP_Screen|null $current_screen
+	 * @return void
+	 */
+	public function modify_pagenow(?WP_Screen $current_screen)
+	{
+		// possibly reset pagenow.
+		if (
+			$this->page_slug === $this->raw_req_page
+			&& isset($this->_pagenow_map[ $this->raw_req_action ])
+		) {
+			global $pagenow, $hook_suffix;
+			$pagenow     = $this->_pagenow_map[ $this->raw_req_action ];
+			$hook_suffix = $pagenow;
+		}
+	}
+
+
+	/**
+	 * This method is used to register additional autosave containers to the _autosave_containers property.
+	 *
+	 * @param array $ids  an array of ids for containers that hold form inputs we want autosave to pickup.  Typically
+	 *                    you would send along the id of a metabox container.
+	 * @return void
+	 * @todo We should automate this at some point by creating a wrapper for add_post_metabox and in our wrapper we
+	 *                    automatically register the id for the post metabox as a container.
+	 */
+	protected function _register_autosave_containers($ids)
+	{
+		$this->_autosave_containers = array_merge($this->_autosave_fields, (array) $ids);
+	}
+
+
+	/**
+	 * Something nifty.  We're going to loop through all the registered metaboxes and if the CALLBACK is an instance of
+	 * EE_Admin_Page OR EE_Admin_Hooks, then we'll add the id to our _autosave_containers array.
+	 */
+	protected function _set_autosave_containers()
+	{
+		global $wp_meta_boxes;
+		$containers = [];
+		if (empty($wp_meta_boxes)) {
+			return;
+		}
+		$current_metaboxes = $wp_meta_boxes[ $this->page_slug ] ?? [];
+		foreach ($current_metaboxes as $box_context) {
+			foreach ($box_context as $box_details) {
+				foreach ($box_details as $box) {
+					if (
+						is_array($box) && is_array($box['callback'])
+						&& (
+							$box['callback'][0] instanceof EE_Admin_Page
+							|| $box['callback'][0] instanceof EE_Admin_Hooks
+						)
+					) {
+						$containers[] = $box['id'];
+					}
+				}
+			}
+		}
+		$this->_autosave_containers = array_merge($this->_autosave_containers, $containers);
+		// add hidden inputs container
+		$this->_autosave_containers[] = 'ee-cpt-hidden-inputs';
+	}
+
+
+	protected function _load_autosave_scripts_styles()
+	{
+		/*wp_register_script('cpt-autosave', EE_ADMIN_URL . 'assets/ee-cpt-autosave.js', array('ee-serialize-full-array', 'event_editor_js'), EVENT_ESPRESSO_VERSION, TRUE );
         wp_enqueue_script('cpt-autosave');/**/ // todo re-enable when we start doing autosave again in 4.2
 
-        // filter _autosave_containers
-        $containers = apply_filters(
-            'FHEE__EE_Admin_Page_CPT___load_autosave_scripts_styles__containers',
-            $this->_autosave_containers,
-            $this
-        );
-        $containers = apply_filters(
-            'FHEE__EE_Admin_Page_CPT__' . get_class($this) . '___load_autosave_scripts_styles__containers',
-            $containers,
-            $this
-        );
-
-        wp_localize_script(
-            'event_editor_js',
-            'EE_AUTOSAVE_IDS',
-            $containers
-        ); // todo once we enable autosaves, this needs to be switched to localize with "cpt-autosave"
-
-        $unsaved_data_msg = [
-            'eventmsg'     => sprintf(
-                wp_strip_all_tags(
-                    __(
-                        "The changes you made to this %s will be lost if you navigate away from this page.",
-                        'event_espresso'
-                    )
-                ),
-                $this->_cpt_object->labels->singular_name
-            ),
-            'inputChanged' => 0,
-        ];
-        wp_localize_script('event_editor_js', 'UNSAVED_DATA_MSG', $unsaved_data_msg);
-    }
-
-
-    /**
-     * overloading the EE_Admin_Page parent load_page_dependencies so we can get the cpt stuff added in appropriately
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws Throwable
-     */
-    protected function _load_page_dependencies()
-    {
-        // we only add stuff if this is a cpt_route!
-        if (! $this->_cpt_route) {
-            parent::_load_page_dependencies();
-            return;
-        }
-        // now let's do some automatic filters into the wp_system
-        // and we'll check to make sure the CHILD class
-        // automatically has the required methods in place.
-        // the following filters are for setting all the redirects
-        // on DEFAULT WP custom post type actions
-        // let's add a hidden input to the post-edit form
-        // so we know when we have to trigger our custom redirects!
-        // Otherwise the redirects will happen on ALL post saves which wouldn't be good of course!
-        add_action('edit_form_after_title', [$this, 'cpt_post_form_hidden_input']);
-        // inject our Admin page nav tabs...
-        // let's make sure the nav tabs are set if they aren't already
-        // if ( empty( $this->_nav_tabs ) ) $this->_set_nav_tabs();
-        add_action('edit_form_top', [$this, 'inject_nav_tabs']);
-        // modify the post_updated messages array
-        add_action('post_updated_messages', [$this, 'post_update_messages']);
-        // This basically allows us to change the title of the "publish" metabox area
-        // on CPT pages by setting a 'publishbox' value in the $_labels property array in the child class.
-        $screen = $this->_cpt_routes[ $this->_req_action ];
-        if (! empty($this->_labels['publishbox'])) {
-            $this->addMetaBox(
-                'submitdiv',
-                $this->getPublishBoxTitle(),
-                'post_submit_meta_box',
-                $screen,
-                'side',
-                'core'
-            );
-        }
-        // let's add page_templates metabox if this cpt added support for it.
-        if ($this->_supports_page_templates($this->_cpt_object->name)) {
-            $this->addMetaBox(
-                'page_templates',
-                esc_html__('Page Template', 'event_espresso'),
-                [$this, 'page_template_meta_box'],
-                $screen,
-                'side'
-            );
-        }
-        // add preview button
-        add_filter('get_sample_permalink_html', [PreviewButton::class, 'addButton'], 5, 2);
-        // add shortlink button to cpt edit screens.
-        //  We can do this as a universal thing BECAUSE, cpts use the same format for shortlinks as posts!
-        add_filter('get_sample_permalink_html', [EventShortlinkButton::class, 'addButton'], 10, 2);
-        // this is a filter that allows the addition of extra html after the permalink field on the wp post edit-form
-        add_filter('get_sample_permalink_html', [TicketSelectorShortcodeButton::class, 'addButton'], 12, 4);
-        // insert our own post_stati dropdown
-        add_action('post_submitbox_misc_actions', [$this, 'custom_post_stati_dropdown']);
-        // This allows adding additional information to the publish post submitbox on the wp post edit form
-        if (method_exists($this, 'extra_misc_actions_publish_box')) {
-            add_action('post_submitbox_misc_actions', [$this, 'extra_misc_actions_publish_box']);
-        }
-        // This allows for adding additional stuff after the title field on the wp post edit form.
-        // This is also before the wp_editor for post description field.
-        if (method_exists($this, 'edit_form_after_title')) {
-            add_action('edit_form_after_title', [$this, 'edit_form_after_title']);
-        }
-        /**
-         * Filtering WP's esc_url to capture urls pointing to core wp routes so they point to our route.
-         */
-        add_filter('clean_url', [$this, 'switch_core_wp_urls_with_ours']);
-        parent::_load_page_dependencies();
-        // notice we are ALSO going to load the pagenow hook set for this route
-        // (see _before_page_setup for the reset of the pagenow global ).
-        // This is for any plugins that are doing things properly
-        // and hooking into the load page hook for core wp cpt routes.
-        global $pagenow;
-        add_action('load-' . $pagenow, [$this, 'modify_current_screen'], 20);
-        do_action('load-' . $pagenow);
-        add_action('admin_enqueue_scripts', [$this, 'setup_autosave_hooks'], 30);
-        // we route REALLY early.
-        try {
-            $this->_route_admin_request();
-        } catch (EE_Error $e) {
-            $e->get_error();
-        }
-    }
-
-
-    /**
-     * Since we don't want users going to default core wp routes, this will check any wp urls run through the
-     * esc_url() method and if we see a url matching a pattern for our routes, we'll modify it to point to OUR
-     * route instead.
-     *
-     * @param string $good_protocol_url The escaped url.
-     * @return string possibly a new url for our route.
-     */
-    public function switch_core_wp_urls_with_ours(string $good_protocol_url): string
-    {
-        $routes_to_match = [
-            0 => [
-                'edit.php?post_type=espresso_attendees',
-                'admin.php?page=espresso_registrations&action=contact_list',
-            ],
-            1 => [
-                'edit.php?post_type=' . $this->_cpt_object->name,
-                'admin.php?page=' . $this->_cpt_object->name,
-            ],
-        ];
-        foreach ($routes_to_match as $route_matches) {
-            if (strpos($good_protocol_url, $route_matches[0]) !== false) {
-                return str_replace($route_matches[0], $route_matches[1], $good_protocol_url);
-            }
-        }
-        return $good_protocol_url;
-    }
-
-
-    /**
-     * Determine whether the current cpt supports page templates or not.
-     *
-     * @param string $cpt_name The cpt slug we're checking on.
-     * @return bool True supported, false not.
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @since %VER%
-     */
-    private function _supports_page_templates(string $cpt_name): bool
-    {
-        /** @var EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions $custom_post_types */
-        $custom_post_types = $this->loader->getShared(
-            'EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions'
-        );
-        $cpt_args          = $custom_post_types->getDefinitions();
-        $cpt_args          = isset($cpt_args[ $cpt_name ]) ? $cpt_args[ $cpt_name ]['args'] : [];
-        $cpt_has_support   = ! empty($cpt_args['page_templates']);
-
-        $post_templates = wp_get_theme()->get_post_templates();
-        // if there are $post_templates for this cpt, then we return false for this method because
-        // that means we aren't going to load our page template manager and leave that up to the native
-        // cpt template manager.
-        return ! isset($post_templates[ $cpt_name ]) ? $cpt_has_support : false;
-    }
-
-
-    /**
-     * Callback for the page_templates metabox selector.
-     *
-     * @return void
-     * @since %VER%
-     */
-    public function page_template_meta_box()
-    {
-        global $post;
-        $template = '';
-
-        $page_template_count = count(get_page_templates());
-        if ($page_template_count) {
-            $page_template = get_post_meta($post->ID, '_wp_page_template', true);
-            $template      = ! empty($page_template) ? $page_template : '';
-        }
-        ?>
+		// filter _autosave_containers
+		$containers = apply_filters(
+			'FHEE__EE_Admin_Page_CPT___load_autosave_scripts_styles__containers',
+			$this->_autosave_containers,
+			$this
+		);
+		$containers = apply_filters(
+			'FHEE__EE_Admin_Page_CPT__' . get_class($this) . '___load_autosave_scripts_styles__containers',
+			$containers,
+			$this
+		);
+
+		wp_localize_script(
+			'event_editor_js',
+			'EE_AUTOSAVE_IDS',
+			$containers
+		); // todo once we enable autosaves, this needs to be switched to localize with "cpt-autosave"
+
+		$unsaved_data_msg = [
+			'eventmsg'     => sprintf(
+				wp_strip_all_tags(
+					__(
+						"The changes you made to this %s will be lost if you navigate away from this page.",
+						'event_espresso'
+					)
+				),
+				$this->_cpt_object->labels->singular_name
+			),
+			'inputChanged' => 0,
+		];
+		wp_localize_script('event_editor_js', 'UNSAVED_DATA_MSG', $unsaved_data_msg);
+	}
+
+
+	/**
+	 * overloading the EE_Admin_Page parent load_page_dependencies so we can get the cpt stuff added in appropriately
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws Throwable
+	 */
+	protected function _load_page_dependencies()
+	{
+		// we only add stuff if this is a cpt_route!
+		if (! $this->_cpt_route) {
+			parent::_load_page_dependencies();
+			return;
+		}
+		// now let's do some automatic filters into the wp_system
+		// and we'll check to make sure the CHILD class
+		// automatically has the required methods in place.
+		// the following filters are for setting all the redirects
+		// on DEFAULT WP custom post type actions
+		// let's add a hidden input to the post-edit form
+		// so we know when we have to trigger our custom redirects!
+		// Otherwise the redirects will happen on ALL post saves which wouldn't be good of course!
+		add_action('edit_form_after_title', [$this, 'cpt_post_form_hidden_input']);
+		// inject our Admin page nav tabs...
+		// let's make sure the nav tabs are set if they aren't already
+		// if ( empty( $this->_nav_tabs ) ) $this->_set_nav_tabs();
+		add_action('edit_form_top', [$this, 'inject_nav_tabs']);
+		// modify the post_updated messages array
+		add_action('post_updated_messages', [$this, 'post_update_messages']);
+		// This basically allows us to change the title of the "publish" metabox area
+		// on CPT pages by setting a 'publishbox' value in the $_labels property array in the child class.
+		$screen = $this->_cpt_routes[ $this->_req_action ];
+		if (! empty($this->_labels['publishbox'])) {
+			$this->addMetaBox(
+				'submitdiv',
+				$this->getPublishBoxTitle(),
+				'post_submit_meta_box',
+				$screen,
+				'side',
+				'core'
+			);
+		}
+		// let's add page_templates metabox if this cpt added support for it.
+		if ($this->_supports_page_templates($this->_cpt_object->name)) {
+			$this->addMetaBox(
+				'page_templates',
+				esc_html__('Page Template', 'event_espresso'),
+				[$this, 'page_template_meta_box'],
+				$screen,
+				'side'
+			);
+		}
+		// add preview button
+		add_filter('get_sample_permalink_html', [PreviewButton::class, 'addButton'], 5, 2);
+		// add shortlink button to cpt edit screens.
+		//  We can do this as a universal thing BECAUSE, cpts use the same format for shortlinks as posts!
+		add_filter('get_sample_permalink_html', [EventShortlinkButton::class, 'addButton'], 10, 2);
+		// this is a filter that allows the addition of extra html after the permalink field on the wp post edit-form
+		add_filter('get_sample_permalink_html', [TicketSelectorShortcodeButton::class, 'addButton'], 12, 4);
+		// insert our own post_stati dropdown
+		add_action('post_submitbox_misc_actions', [$this, 'custom_post_stati_dropdown']);
+		// This allows adding additional information to the publish post submitbox on the wp post edit form
+		if (method_exists($this, 'extra_misc_actions_publish_box')) {
+			add_action('post_submitbox_misc_actions', [$this, 'extra_misc_actions_publish_box']);
+		}
+		// This allows for adding additional stuff after the title field on the wp post edit form.
+		// This is also before the wp_editor for post description field.
+		if (method_exists($this, 'edit_form_after_title')) {
+			add_action('edit_form_after_title', [$this, 'edit_form_after_title']);
+		}
+		/**
+		 * Filtering WP's esc_url to capture urls pointing to core wp routes so they point to our route.
+		 */
+		add_filter('clean_url', [$this, 'switch_core_wp_urls_with_ours']);
+		parent::_load_page_dependencies();
+		// notice we are ALSO going to load the pagenow hook set for this route
+		// (see _before_page_setup for the reset of the pagenow global ).
+		// This is for any plugins that are doing things properly
+		// and hooking into the load page hook for core wp cpt routes.
+		global $pagenow;
+		add_action('load-' . $pagenow, [$this, 'modify_current_screen'], 20);
+		do_action('load-' . $pagenow);
+		add_action('admin_enqueue_scripts', [$this, 'setup_autosave_hooks'], 30);
+		// we route REALLY early.
+		try {
+			$this->_route_admin_request();
+		} catch (EE_Error $e) {
+			$e->get_error();
+		}
+	}
+
+
+	/**
+	 * Since we don't want users going to default core wp routes, this will check any wp urls run through the
+	 * esc_url() method and if we see a url matching a pattern for our routes, we'll modify it to point to OUR
+	 * route instead.
+	 *
+	 * @param string $good_protocol_url The escaped url.
+	 * @return string possibly a new url for our route.
+	 */
+	public function switch_core_wp_urls_with_ours(string $good_protocol_url): string
+	{
+		$routes_to_match = [
+			0 => [
+				'edit.php?post_type=espresso_attendees',
+				'admin.php?page=espresso_registrations&action=contact_list',
+			],
+			1 => [
+				'edit.php?post_type=' . $this->_cpt_object->name,
+				'admin.php?page=' . $this->_cpt_object->name,
+			],
+		];
+		foreach ($routes_to_match as $route_matches) {
+			if (strpos($good_protocol_url, $route_matches[0]) !== false) {
+				return str_replace($route_matches[0], $route_matches[1], $good_protocol_url);
+			}
+		}
+		return $good_protocol_url;
+	}
+
+
+	/**
+	 * Determine whether the current cpt supports page templates or not.
+	 *
+	 * @param string $cpt_name The cpt slug we're checking on.
+	 * @return bool True supported, false not.
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @since %VER%
+	 */
+	private function _supports_page_templates(string $cpt_name): bool
+	{
+		/** @var EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions $custom_post_types */
+		$custom_post_types = $this->loader->getShared(
+			'EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions'
+		);
+		$cpt_args          = $custom_post_types->getDefinitions();
+		$cpt_args          = isset($cpt_args[ $cpt_name ]) ? $cpt_args[ $cpt_name ]['args'] : [];
+		$cpt_has_support   = ! empty($cpt_args['page_templates']);
+
+		$post_templates = wp_get_theme()->get_post_templates();
+		// if there are $post_templates for this cpt, then we return false for this method because
+		// that means we aren't going to load our page template manager and leave that up to the native
+		// cpt template manager.
+		return ! isset($post_templates[ $cpt_name ]) ? $cpt_has_support : false;
+	}
+
+
+	/**
+	 * Callback for the page_templates metabox selector.
+	 *
+	 * @return void
+	 * @since %VER%
+	 */
+	public function page_template_meta_box()
+	{
+		global $post;
+		$template = '';
+
+		$page_template_count = count(get_page_templates());
+		if ($page_template_count) {
+			$page_template = get_post_meta($post->ID, '_wp_page_template', true);
+			$template      = ! empty($page_template) ? $page_template : '';
+		}
+		?>
         <p><strong><?php esc_html_e('Template', 'event_espresso') ?></strong></p>
         <label class="screen-reader-text" for="page_template">
             <?php esc_html_e('Page Template', 'event_espresso') ?>
@@ -483,457 +483,457 @@ 
             <?php page_template_dropdown($template); ?>
         </select>
         <?php
-    }
-
-
-    /**
-     * if this post is a draft or scheduled post then we provide a preview button for user to click
-     * Method is called from parent and is hooked into the wp 'get_sample_permalink_html' filter.
-     *
-     * @param string $return    the current html
-     * @param int    $id        the post id for the page
-     * @return string            The new html string for the permalink area
-     * @deprecated 5.0.0.p
-     * @see PreviewButton::addButton()
-     */
-    public function preview_button_html(string $return, int $id): string
-    {
-        return PreviewButton::addButton($return, $id);
-    }
-
-
-    /**
-     * add our custom post status dropdown on the wp post page for this cpt
-     *
-     * @return void
-     */
-    public function custom_post_stati_dropdown()
-    {
-        $statuses         = $this->_cpt_model_obj->get_custom_post_statuses();
-        $cur_status_label = array_key_exists($this->_cpt_model_obj->status(), $statuses)
-            ? $statuses[ $this->_cpt_model_obj->status() ]
-            : '';
-        $template_args    = [
-            'cur_status'            => $this->_cpt_model_obj->status(),
-            'statuses'              => $statuses,
-            'cur_status_label'      => $cur_status_label,
-            'localized_status_save' => sprintf(esc_html__('Save %s', 'event_espresso'), $cur_status_label),
-        ];
-        // we'll add a trash post status (WP doesn't add one for some reason)
-        if ($this->_cpt_model_obj->status() === 'trash') {
-            $template_args['cur_status_label'] = esc_html__('Trashed', 'event_espresso');
-            $statuses['trash']                 = esc_html__('Trashed', 'event_espresso');
-            $template_args['statuses']         = $statuses;
-        }
-
-        $template = EE_ADMIN_TEMPLATE . 'status_dropdown.template.php';
-        EEH_Template::display_template($template, $template_args);
-    }
-
-
-    public function setup_autosave_hooks()
-    {
-        $this->_set_autosave_containers();
-        $this->_load_autosave_scripts_styles();
-    }
-
-
-    /**
-     * This is run on all WordPress autosaves AFTER the autosave is complete and sends along a post object (available
-     * in request data) containing: post_ID of the saved post autosavenonce for the saved post We'll do the check
-     * for the nonce in here, but then this method looks for two things:
-     * 1. Execute a method (if exists) matching 'ee_autosave_' and appended with the given route. OR
-     * 2. do_actions() for global or class specific actions that have been registered (for plugins/addons not in an
-     * EE_Admin_Page class. PLEASE NOTE: Data will be returned using the _return_json() object and so the
-     * $_template_args property should be used to hold the $data array.  We're expecting the following things set in
-     * template args.
-     *    1. $template_args['error'] = IF there is an error you can add the message in here.
-     *    2. $template_args['data']['items'] = an array of items that are setup in key index pairs of 'where_values_go'
-     *    => 'values_to_add'.  In other words, for the datetime metabox we'll have something like
-     *    $this->_template_args['data']['items'] = array(
-     *        'event-datetime-ids' => '1,2,3';
-     *    );
-     *    Keep in mind the following things:
-     *    - "where" index is for the input with the id as that string.
-     *    - "what" index is what will be used for the value of that input.
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    public function do_extra_autosave_stuff()
-    {
-        // next let's check for the autosave nonce (we'll use _verify_nonce )
-        $nonce = $this->request->getRequestParam('autosavenonce');
-        $this->_verify_nonce($nonce, 'autosave');
-        // make sure we define doing autosave (cause WP isn't triggering this we want to make sure we define it)
-        if (! defined('DOING_AUTOSAVE')) {
-            define('DOING_AUTOSAVE', true);
-        }
-        // if we made it here then the nonce checked out.  Let's run our methods and actions
-        $autosave = "_ee_autosave_$this->_current_view";
-        if (method_exists($this, $autosave)) {
-            $this->$autosave();
-        } else {
-            $this->_template_args['success'] = true;
-        }
-        do_action('AHEE__EE_Admin_Page_CPT__do_extra_autosave_stuff__global_after', $this);
-        do_action('AHEE__EE_Admin_Page_CPT__do_extra_autosave_stuff__after_' . get_class($this), $this);
-        // now let's return json
-        $this->_return_json();
-    }
-
-
-    /**
-     * This takes care of setting up default routes and pages that utilize the core WP admin pages.
-     * Child classes can override the defaults (in cases for adding metaboxes etc.)
-     * but take care that you include the defaults here otherwise your core WP admin pages for the cpt won't work!
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _extend_page_config_for_cpt()
-    {
-        // before doing anything we need to make sure this runs ONLY when the loaded page matches the set page_slug
-        if ($this->raw_req_page !== $this->page_slug) {
-            return;
-        }
-        // set page routes and page config but ONLY if we're not viewing a custom setup cpt route as defined in _cpt_routes
-        if (! empty($this->_cpt_object)) {
-            $this->_page_routes = array_merge(
-                [
-                    'create_new' => [$this, '_create_new_cpt_item'],
-                    'edit'       => [$this, '_edit_cpt_item'],
-                ],
-                $this->_page_routes
-            );
-            $this->_page_config = array_merge(
-                [
-                    'create_new' => [
-                        'nav'           => [
-                            'label' => $this->_cpt_object->labels->add_new_item,
-                            'order' => 5,
-                        ],
-                        'require_nonce' => false,
-                    ],
-                    'edit'       => [
-                        'nav'           => [
-                            'label'      => $this->_cpt_object->labels->edit_item,
-                            'order'      => 5,
-                            'persistent' => false,
-                            'url'        => '',
-                        ],
-                        'require_nonce' => false,
-                    ],
-                ],
-                $this->_page_config
-            );
-        }
-        // load the next section only if this is a matching cpt route as set in the cpt routes array.
-        if (! isset($this->_cpt_routes[ $this->_req_action ])) {
-            return;
-        }
-        $this->_cpt_route = true;
-        // $this->_cpt_route = isset($this->_cpt_routes[ $this->_req_action ]);
-        // add_action('FHEE__EE_Admin_Page___load_page_dependencies__after_load', array( $this, 'modify_current_screen') );
-        if (empty($this->_cpt_object)) {
-            $msg = sprintf(
-                esc_html__(
-                    'This page has been set as being related to a registered custom post type, however, the custom post type object could not be retrieved. There are two possible reasons for this:  1. The "%s" does not match a registered post type. or 2. The custom post type is not registered for the "%s" action as indexed in the "$_cpt_routes" property on this class (%s).',
-                    'event_espresso'
-                ),
-                $this->page_slug,
-                $this->_req_action,
-                get_class($this)
-            );
-            throw new EE_Error($msg);
-        }
-        $this->_set_model_object($this->request->getRequestParam('post', 0, DataType::INT));
-    }
-
-
-    /**
-     * Sets the _cpt_model_object property using what has been set for the _cpt_model_name and a given id.
-     *
-     * @param int    $id       The id to retrieve the model object for. If empty we set a default object.
-     * @param bool   $ignore_route_check
-     * @param string $req_type whether the current route is for inserting, updating, or deleting the CPT
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected function _set_model_object(int $id = 0, bool $ignore_route_check = false, string $req_type = '')
-    {
-        $model = null;
-        if (
-            empty($this->_cpt_model_names)
-            || (
-                ! $ignore_route_check
-                && ! isset($this->_cpt_routes[ $this->_req_action ])
-            )
-            || (
-                $this->_cpt_model_obj instanceof EE_CPT_Base
-                && $this->_cpt_model_obj->ID() === $id
-            )
-        ) {
-            // get out cuz we either don't have a model name OR the object has already been set and it has the same id as what has been sent.
-            return;
-        }
-        // if ignore_route_check is true, then get the model name via CustomPostTypeDefinitions
-        if ($ignore_route_check) {
-            $post_type = get_post_type($id);
-            /** @var EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions $custom_post_types */
-            $custom_post_types = $this->loader->getShared(
-                'EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions'
-            );
-            $model_names       = $custom_post_types->getCustomPostTypeModelNames($post_type);
-            if (isset($model_names[ $post_type ])) {
-                $model = EE_Registry::instance()->load_model($model_names[ $post_type ]);
-            }
-        } else {
-            $model = EE_Registry::instance()->load_model($this->_cpt_model_names[ $this->_req_action ]);
-        }
-        if ($model instanceof EEM_Base) {
-            $this->_cpt_model_obj = ! empty($id) ? $model->get_one_by_ID($id) : $model->create_default_object();
-        }
-        do_action(
-            'AHEE__EE_Admin_Page_CPT__set_model_object__after_set_object',
-            $this->_cpt_model_obj,
-            $req_type
-        );
-    }
-
-
-    /**
-     * admin_init_global
-     * This runs all the code that we want executed within the WP admin_init hook.
-     * This method executes for ALL EE Admin pages.
-     *
-     * @return void
-     */
-    public function admin_init_global()
-    {
-        $post_ID = $this->request->getRequestParam('post', 0, DataType::INT);
-        // its possible this is a new save so let's catch that instead
-        $post_ID        = $this->request->getRequestParam('post_ID', $post_ID, DataType::INT);
-        $post           = get_post($post_ID);
-        $post_type      = $post instanceof WP_Post ? $post->post_type : false;
-        $current_route  = $this->request->getRequestParam('current_route', 'shouldneverwork');
-        $route_to_check = $post_type && isset($this->_cpt_routes[ $current_route ])
-            ? $this->_cpt_routes[ $current_route ]
-            : '';
-        add_filter('get_delete_post_link', [$this, 'modify_delete_post_link'], 10, 2);
-        add_filter('get_edit_post_link', [$this, 'modify_edit_post_link'], 10, 2);
-        if ($post_type === $route_to_check) {
-            add_filter('redirect_post_location', [$this, 'cpt_post_location_redirect'], 10, 2);
-        }
-        // now let's filter redirect if we're on a revision page and the revision is for an event CPT.
-        $revision = $this->request->getRequestParam('revision');
-        if (! empty($revision)) {
-            $action = $this->request->getRequestParam('action');
-            // doing a restore?
-            if (! empty($action) && $action === 'restore') {
-                // get post for revision
-                $rev_post   = get_post($revision);
-                $rev_parent = get_post($rev_post->post_parent);
-                // only do our redirect filter AND our restore revision action if the post_type for the parent is one of our cpts.
-                if ($rev_parent && $rev_parent->post_type === $this->page_slug) {
-                    add_filter('wp_redirect', [$this, 'revision_redirect']);
-                    // restores of revisions
-                    add_action('wp_restore_post_revision', [$this, 'restore_revision'], 10, 2);
-                }
-            }
-        }
-        // NOTE we ONLY want to run these hooks if we're on the right class for the given post type.  Otherwise we could see some really freaky things happen!
-        if ($post_type && $post_type === $route_to_check) {
-            // $post_id, $post
-            add_action('save_post', [$this, 'insert_update'], 10, 3);
-            // $post_id
-            add_action('trashed_post', [$this, 'before_trash_cpt_item']);
-            add_action('trashed_post', [$this, 'dont_permanently_delete_ee_cpts']);
-            add_action('untrashed_post', [$this, 'before_restore_cpt_item']);
-            add_action('after_delete_post', [$this, 'before_delete_cpt_item']);
-        }
-    }
-
-
-    /**
-     * Callback for the WordPress trashed_post hook.
-     * Execute some basic checks before calling the trash_cpt_item declared in the child class.
-     *
-     * @param int $post_id
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function before_trash_cpt_item(int $post_id)
-    {
-        $this->_set_model_object($post_id, true, 'trash');
-        // if our cpt object isn't existent then get out immediately.
-        if (! $this->_cpt_model_obj instanceof EE_CPT_Base || $this->_cpt_model_obj->ID() !== $post_id) {
-            return;
-        }
-        $this->trash_cpt_item($post_id);
-    }
-
-
-    /**
-     * Callback for the WordPress untrashed_post hook.
-     * Execute some basic checks before calling the restore_cpt_method in the child class.
-     *
-     * @param $post_id
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function before_restore_cpt_item($post_id)
-    {
-        $this->_set_model_object($post_id, true, 'restore');
-        // if our cpt object isn't existent then get out immediately.
-        if (! $this->_cpt_model_obj instanceof EE_CPT_Base || $this->_cpt_model_obj->ID() !== $post_id) {
-            return;
-        }
-        $this->restore_cpt_item($post_id);
-    }
-
-
-    /**
-     * Callback for the WordPress after_delete_post hook.
-     * Execute some basic checks before calling the delete_cpt_item method in the child class.
-     *
-     * @param $post_id
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function before_delete_cpt_item($post_id)
-    {
-        $this->_set_model_object($post_id, true, 'delete');
-        // if our cpt object isn't existent then get out immediately.
-        if (! $this->_cpt_model_obj instanceof EE_CPT_Base || $this->_cpt_model_obj->ID() !== $post_id) {
-            return;
-        }
-        $this->delete_cpt_item($post_id);
-    }
-
-
-    /**
-     * This simply verifies if the cpt_model_object is instantiated for the given page and throws an error message
-     * accordingly.
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function verify_cpt_object()
-    {
-        $label = ! empty($this->_cpt_object) ? $this->_cpt_object->labels->singular_name : $this->page_label;
-        // verify event object
-        if (! $this->_cpt_model_obj instanceof EE_CPT_Base) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'Something has gone wrong with the page load because we are unable to set up the object for the %1$s.  This usually happens when the given id for the page route is NOT for the correct custom post type for this page',
-                        'event_espresso'
-                    ),
-                    $label
-                )
-            );
-        }
-        // if auto-draft then throw an error
-        if ($this->_cpt_model_obj->get('status') === 'auto-draft') {
-            EE_Error::overwrite_errors();
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'This %1$s was saved without a title, description, or excerpt which means that none of the extra details you added were saved properly.  All autodrafts will show up in the "draft" view of your event list table.  You can delete them from there. Please click the "Add %1$s" button to refresh and restart.',
-                        'event_espresso'
-                    ),
-                    $label
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-    }
-
-
-    /**
-     * admin_footer_scripts_global
-     * Anything triggered by the 'admin_print_footer_scripts' WP hook should be put in here. This particular method
-     * will apply on ALL EE_Admin pages.
-     *
-     * @return void
-     */
-    public function admin_footer_scripts_global()
-    {
-        $this->_add_admin_page_ajax_loading_img();
-        $this->_add_admin_page_overlay();
-    }
-
-
-    /**
-     * add in any global scripts for cpt routes
-     *
-     * @return void
-     */
-    public function load_global_scripts_styles()
-    {
-        parent::load_global_scripts_styles();
-        if ($this->_cpt_model_obj instanceof EE_CPT_Base) {
-            // setup custom post status object for localize script but only if we've got a cpt object
-            $statuses = $this->_cpt_model_obj->get_custom_post_statuses();
-            if (! empty($statuses)) {
-                // get ALL statuses!
-                $statuses = $this->_cpt_model_obj->get_all_post_statuses();
-                // setup object
-                $ee_cpt_statuses = [];
-                foreach ($statuses as $status => $label) {
-                    $ee_cpt_statuses[ $status ] = [
-                        'label'      => $label,
-                        'save_label' => sprintf(
-                            wp_strip_all_tags(__('Save as %s', 'event_espresso')),
-                            $label
-                        ),
-                    ];
-                }
-                wp_localize_script('ee_admin_js', 'eeCPTstatuses', $ee_cpt_statuses);
-            }
-        }
-    }
-
-
-    /**
-     * This is a wrapper for the insert/update routes for cpt items so we can add things that are common to ALL
-     * insert/updates
-     *
-     * @param int     $post_id ID of post being updated
-     * @param WP_Post $post    Post object from WP
-     * @param bool    $update  Whether this is an update or a new save.
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function insert_update(int $post_id, WP_Post $post, bool $update)
-    {
-        // make sure that if this is a revision OR trash action that we don't do any updates!
-        $action = $this->request->getRequestParam('action');
-        if ($action === 'restore' || $action === 'trash') {
-            return;
-        }
-        $this->_set_model_object($post_id, true, 'insert_update');
-        // if our cpt object is not instantiated and its NOT the same post_id as what is triggering this callback, then exit.
-        if (
-            $update
-            && (
-                ! $this->_cpt_model_obj instanceof EE_CPT_Base
-                || $this->_cpt_model_obj->ID() !== $post_id
-            )
-        ) {
-            return;
-        }
-        // check for autosave and update our req_data property accordingly.
-        /*if ( defined('DOING_AUTOSAVE') && DOING_AUTOSAVE && isset( $this->_req_data['ee_autosave_data'] ) ) {
+	}
+
+
+	/**
+	 * if this post is a draft or scheduled post then we provide a preview button for user to click
+	 * Method is called from parent and is hooked into the wp 'get_sample_permalink_html' filter.
+	 *
+	 * @param string $return    the current html
+	 * @param int    $id        the post id for the page
+	 * @return string            The new html string for the permalink area
+	 * @deprecated 5.0.0.p
+	 * @see PreviewButton::addButton()
+	 */
+	public function preview_button_html(string $return, int $id): string
+	{
+		return PreviewButton::addButton($return, $id);
+	}
+
+
+	/**
+	 * add our custom post status dropdown on the wp post page for this cpt
+	 *
+	 * @return void
+	 */
+	public function custom_post_stati_dropdown()
+	{
+		$statuses         = $this->_cpt_model_obj->get_custom_post_statuses();
+		$cur_status_label = array_key_exists($this->_cpt_model_obj->status(), $statuses)
+			? $statuses[ $this->_cpt_model_obj->status() ]
+			: '';
+		$template_args    = [
+			'cur_status'            => $this->_cpt_model_obj->status(),
+			'statuses'              => $statuses,
+			'cur_status_label'      => $cur_status_label,
+			'localized_status_save' => sprintf(esc_html__('Save %s', 'event_espresso'), $cur_status_label),
+		];
+		// we'll add a trash post status (WP doesn't add one for some reason)
+		if ($this->_cpt_model_obj->status() === 'trash') {
+			$template_args['cur_status_label'] = esc_html__('Trashed', 'event_espresso');
+			$statuses['trash']                 = esc_html__('Trashed', 'event_espresso');
+			$template_args['statuses']         = $statuses;
+		}
+
+		$template = EE_ADMIN_TEMPLATE . 'status_dropdown.template.php';
+		EEH_Template::display_template($template, $template_args);
+	}
+
+
+	public function setup_autosave_hooks()
+	{
+		$this->_set_autosave_containers();
+		$this->_load_autosave_scripts_styles();
+	}
+
+
+	/**
+	 * This is run on all WordPress autosaves AFTER the autosave is complete and sends along a post object (available
+	 * in request data) containing: post_ID of the saved post autosavenonce for the saved post We'll do the check
+	 * for the nonce in here, but then this method looks for two things:
+	 * 1. Execute a method (if exists) matching 'ee_autosave_' and appended with the given route. OR
+	 * 2. do_actions() for global or class specific actions that have been registered (for plugins/addons not in an
+	 * EE_Admin_Page class. PLEASE NOTE: Data will be returned using the _return_json() object and so the
+	 * $_template_args property should be used to hold the $data array.  We're expecting the following things set in
+	 * template args.
+	 *    1. $template_args['error'] = IF there is an error you can add the message in here.
+	 *    2. $template_args['data']['items'] = an array of items that are setup in key index pairs of 'where_values_go'
+	 *    => 'values_to_add'.  In other words, for the datetime metabox we'll have something like
+	 *    $this->_template_args['data']['items'] = array(
+	 *        'event-datetime-ids' => '1,2,3';
+	 *    );
+	 *    Keep in mind the following things:
+	 *    - "where" index is for the input with the id as that string.
+	 *    - "what" index is what will be used for the value of that input.
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function do_extra_autosave_stuff()
+	{
+		// next let's check for the autosave nonce (we'll use _verify_nonce )
+		$nonce = $this->request->getRequestParam('autosavenonce');
+		$this->_verify_nonce($nonce, 'autosave');
+		// make sure we define doing autosave (cause WP isn't triggering this we want to make sure we define it)
+		if (! defined('DOING_AUTOSAVE')) {
+			define('DOING_AUTOSAVE', true);
+		}
+		// if we made it here then the nonce checked out.  Let's run our methods and actions
+		$autosave = "_ee_autosave_$this->_current_view";
+		if (method_exists($this, $autosave)) {
+			$this->$autosave();
+		} else {
+			$this->_template_args['success'] = true;
+		}
+		do_action('AHEE__EE_Admin_Page_CPT__do_extra_autosave_stuff__global_after', $this);
+		do_action('AHEE__EE_Admin_Page_CPT__do_extra_autosave_stuff__after_' . get_class($this), $this);
+		// now let's return json
+		$this->_return_json();
+	}
+
+
+	/**
+	 * This takes care of setting up default routes and pages that utilize the core WP admin pages.
+	 * Child classes can override the defaults (in cases for adding metaboxes etc.)
+	 * but take care that you include the defaults here otherwise your core WP admin pages for the cpt won't work!
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _extend_page_config_for_cpt()
+	{
+		// before doing anything we need to make sure this runs ONLY when the loaded page matches the set page_slug
+		if ($this->raw_req_page !== $this->page_slug) {
+			return;
+		}
+		// set page routes and page config but ONLY if we're not viewing a custom setup cpt route as defined in _cpt_routes
+		if (! empty($this->_cpt_object)) {
+			$this->_page_routes = array_merge(
+				[
+					'create_new' => [$this, '_create_new_cpt_item'],
+					'edit'       => [$this, '_edit_cpt_item'],
+				],
+				$this->_page_routes
+			);
+			$this->_page_config = array_merge(
+				[
+					'create_new' => [
+						'nav'           => [
+							'label' => $this->_cpt_object->labels->add_new_item,
+							'order' => 5,
+						],
+						'require_nonce' => false,
+					],
+					'edit'       => [
+						'nav'           => [
+							'label'      => $this->_cpt_object->labels->edit_item,
+							'order'      => 5,
+							'persistent' => false,
+							'url'        => '',
+						],
+						'require_nonce' => false,
+					],
+				],
+				$this->_page_config
+			);
+		}
+		// load the next section only if this is a matching cpt route as set in the cpt routes array.
+		if (! isset($this->_cpt_routes[ $this->_req_action ])) {
+			return;
+		}
+		$this->_cpt_route = true;
+		// $this->_cpt_route = isset($this->_cpt_routes[ $this->_req_action ]);
+		// add_action('FHEE__EE_Admin_Page___load_page_dependencies__after_load', array( $this, 'modify_current_screen') );
+		if (empty($this->_cpt_object)) {
+			$msg = sprintf(
+				esc_html__(
+					'This page has been set as being related to a registered custom post type, however, the custom post type object could not be retrieved. There are two possible reasons for this:  1. The "%s" does not match a registered post type. or 2. The custom post type is not registered for the "%s" action as indexed in the "$_cpt_routes" property on this class (%s).',
+					'event_espresso'
+				),
+				$this->page_slug,
+				$this->_req_action,
+				get_class($this)
+			);
+			throw new EE_Error($msg);
+		}
+		$this->_set_model_object($this->request->getRequestParam('post', 0, DataType::INT));
+	}
+
+
+	/**
+	 * Sets the _cpt_model_object property using what has been set for the _cpt_model_name and a given id.
+	 *
+	 * @param int    $id       The id to retrieve the model object for. If empty we set a default object.
+	 * @param bool   $ignore_route_check
+	 * @param string $req_type whether the current route is for inserting, updating, or deleting the CPT
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected function _set_model_object(int $id = 0, bool $ignore_route_check = false, string $req_type = '')
+	{
+		$model = null;
+		if (
+			empty($this->_cpt_model_names)
+			|| (
+				! $ignore_route_check
+				&& ! isset($this->_cpt_routes[ $this->_req_action ])
+			)
+			|| (
+				$this->_cpt_model_obj instanceof EE_CPT_Base
+				&& $this->_cpt_model_obj->ID() === $id
+			)
+		) {
+			// get out cuz we either don't have a model name OR the object has already been set and it has the same id as what has been sent.
+			return;
+		}
+		// if ignore_route_check is true, then get the model name via CustomPostTypeDefinitions
+		if ($ignore_route_check) {
+			$post_type = get_post_type($id);
+			/** @var EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions $custom_post_types */
+			$custom_post_types = $this->loader->getShared(
+				'EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions'
+			);
+			$model_names       = $custom_post_types->getCustomPostTypeModelNames($post_type);
+			if (isset($model_names[ $post_type ])) {
+				$model = EE_Registry::instance()->load_model($model_names[ $post_type ]);
+			}
+		} else {
+			$model = EE_Registry::instance()->load_model($this->_cpt_model_names[ $this->_req_action ]);
+		}
+		if ($model instanceof EEM_Base) {
+			$this->_cpt_model_obj = ! empty($id) ? $model->get_one_by_ID($id) : $model->create_default_object();
+		}
+		do_action(
+			'AHEE__EE_Admin_Page_CPT__set_model_object__after_set_object',
+			$this->_cpt_model_obj,
+			$req_type
+		);
+	}
+
+
+	/**
+	 * admin_init_global
+	 * This runs all the code that we want executed within the WP admin_init hook.
+	 * This method executes for ALL EE Admin pages.
+	 *
+	 * @return void
+	 */
+	public function admin_init_global()
+	{
+		$post_ID = $this->request->getRequestParam('post', 0, DataType::INT);
+		// its possible this is a new save so let's catch that instead
+		$post_ID        = $this->request->getRequestParam('post_ID', $post_ID, DataType::INT);
+		$post           = get_post($post_ID);
+		$post_type      = $post instanceof WP_Post ? $post->post_type : false;
+		$current_route  = $this->request->getRequestParam('current_route', 'shouldneverwork');
+		$route_to_check = $post_type && isset($this->_cpt_routes[ $current_route ])
+			? $this->_cpt_routes[ $current_route ]
+			: '';
+		add_filter('get_delete_post_link', [$this, 'modify_delete_post_link'], 10, 2);
+		add_filter('get_edit_post_link', [$this, 'modify_edit_post_link'], 10, 2);
+		if ($post_type === $route_to_check) {
+			add_filter('redirect_post_location', [$this, 'cpt_post_location_redirect'], 10, 2);
+		}
+		// now let's filter redirect if we're on a revision page and the revision is for an event CPT.
+		$revision = $this->request->getRequestParam('revision');
+		if (! empty($revision)) {
+			$action = $this->request->getRequestParam('action');
+			// doing a restore?
+			if (! empty($action) && $action === 'restore') {
+				// get post for revision
+				$rev_post   = get_post($revision);
+				$rev_parent = get_post($rev_post->post_parent);
+				// only do our redirect filter AND our restore revision action if the post_type for the parent is one of our cpts.
+				if ($rev_parent && $rev_parent->post_type === $this->page_slug) {
+					add_filter('wp_redirect', [$this, 'revision_redirect']);
+					// restores of revisions
+					add_action('wp_restore_post_revision', [$this, 'restore_revision'], 10, 2);
+				}
+			}
+		}
+		// NOTE we ONLY want to run these hooks if we're on the right class for the given post type.  Otherwise we could see some really freaky things happen!
+		if ($post_type && $post_type === $route_to_check) {
+			// $post_id, $post
+			add_action('save_post', [$this, 'insert_update'], 10, 3);
+			// $post_id
+			add_action('trashed_post', [$this, 'before_trash_cpt_item']);
+			add_action('trashed_post', [$this, 'dont_permanently_delete_ee_cpts']);
+			add_action('untrashed_post', [$this, 'before_restore_cpt_item']);
+			add_action('after_delete_post', [$this, 'before_delete_cpt_item']);
+		}
+	}
+
+
+	/**
+	 * Callback for the WordPress trashed_post hook.
+	 * Execute some basic checks before calling the trash_cpt_item declared in the child class.
+	 *
+	 * @param int $post_id
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function before_trash_cpt_item(int $post_id)
+	{
+		$this->_set_model_object($post_id, true, 'trash');
+		// if our cpt object isn't existent then get out immediately.
+		if (! $this->_cpt_model_obj instanceof EE_CPT_Base || $this->_cpt_model_obj->ID() !== $post_id) {
+			return;
+		}
+		$this->trash_cpt_item($post_id);
+	}
+
+
+	/**
+	 * Callback for the WordPress untrashed_post hook.
+	 * Execute some basic checks before calling the restore_cpt_method in the child class.
+	 *
+	 * @param $post_id
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function before_restore_cpt_item($post_id)
+	{
+		$this->_set_model_object($post_id, true, 'restore');
+		// if our cpt object isn't existent then get out immediately.
+		if (! $this->_cpt_model_obj instanceof EE_CPT_Base || $this->_cpt_model_obj->ID() !== $post_id) {
+			return;
+		}
+		$this->restore_cpt_item($post_id);
+	}
+
+
+	/**
+	 * Callback for the WordPress after_delete_post hook.
+	 * Execute some basic checks before calling the delete_cpt_item method in the child class.
+	 *
+	 * @param $post_id
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function before_delete_cpt_item($post_id)
+	{
+		$this->_set_model_object($post_id, true, 'delete');
+		// if our cpt object isn't existent then get out immediately.
+		if (! $this->_cpt_model_obj instanceof EE_CPT_Base || $this->_cpt_model_obj->ID() !== $post_id) {
+			return;
+		}
+		$this->delete_cpt_item($post_id);
+	}
+
+
+	/**
+	 * This simply verifies if the cpt_model_object is instantiated for the given page and throws an error message
+	 * accordingly.
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function verify_cpt_object()
+	{
+		$label = ! empty($this->_cpt_object) ? $this->_cpt_object->labels->singular_name : $this->page_label;
+		// verify event object
+		if (! $this->_cpt_model_obj instanceof EE_CPT_Base) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'Something has gone wrong with the page load because we are unable to set up the object for the %1$s.  This usually happens when the given id for the page route is NOT for the correct custom post type for this page',
+						'event_espresso'
+					),
+					$label
+				)
+			);
+		}
+		// if auto-draft then throw an error
+		if ($this->_cpt_model_obj->get('status') === 'auto-draft') {
+			EE_Error::overwrite_errors();
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'This %1$s was saved without a title, description, or excerpt which means that none of the extra details you added were saved properly.  All autodrafts will show up in the "draft" view of your event list table.  You can delete them from there. Please click the "Add %1$s" button to refresh and restart.',
+						'event_espresso'
+					),
+					$label
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+	}
+
+
+	/**
+	 * admin_footer_scripts_global
+	 * Anything triggered by the 'admin_print_footer_scripts' WP hook should be put in here. This particular method
+	 * will apply on ALL EE_Admin pages.
+	 *
+	 * @return void
+	 */
+	public function admin_footer_scripts_global()
+	{
+		$this->_add_admin_page_ajax_loading_img();
+		$this->_add_admin_page_overlay();
+	}
+
+
+	/**
+	 * add in any global scripts for cpt routes
+	 *
+	 * @return void
+	 */
+	public function load_global_scripts_styles()
+	{
+		parent::load_global_scripts_styles();
+		if ($this->_cpt_model_obj instanceof EE_CPT_Base) {
+			// setup custom post status object for localize script but only if we've got a cpt object
+			$statuses = $this->_cpt_model_obj->get_custom_post_statuses();
+			if (! empty($statuses)) {
+				// get ALL statuses!
+				$statuses = $this->_cpt_model_obj->get_all_post_statuses();
+				// setup object
+				$ee_cpt_statuses = [];
+				foreach ($statuses as $status => $label) {
+					$ee_cpt_statuses[ $status ] = [
+						'label'      => $label,
+						'save_label' => sprintf(
+							wp_strip_all_tags(__('Save as %s', 'event_espresso')),
+							$label
+						),
+					];
+				}
+				wp_localize_script('ee_admin_js', 'eeCPTstatuses', $ee_cpt_statuses);
+			}
+		}
+	}
+
+
+	/**
+	 * This is a wrapper for the insert/update routes for cpt items so we can add things that are common to ALL
+	 * insert/updates
+	 *
+	 * @param int     $post_id ID of post being updated
+	 * @param WP_Post $post    Post object from WP
+	 * @param bool    $update  Whether this is an update or a new save.
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function insert_update(int $post_id, WP_Post $post, bool $update)
+	{
+		// make sure that if this is a revision OR trash action that we don't do any updates!
+		$action = $this->request->getRequestParam('action');
+		if ($action === 'restore' || $action === 'trash') {
+			return;
+		}
+		$this->_set_model_object($post_id, true, 'insert_update');
+		// if our cpt object is not instantiated and its NOT the same post_id as what is triggering this callback, then exit.
+		if (
+			$update
+			&& (
+				! $this->_cpt_model_obj instanceof EE_CPT_Base
+				|| $this->_cpt_model_obj->ID() !== $post_id
+			)
+		) {
+			return;
+		}
+		// check for autosave and update our req_data property accordingly.
+		/*if ( defined('DOING_AUTOSAVE') && DOING_AUTOSAVE && isset( $this->_req_data['ee_autosave_data'] ) ) {
             foreach( (array) $this->_req_data['ee_autosave_data'] as $id => $values ) {
 
                 foreach ( (array) $values as $key => $value ) {
@@ -943,549 +943,549 @@ 
 
         }/**/ // TODO reactivate after autosave is implemented in 4.2
 
-        // take care of updating any selected page_template IF this cpt supports it.
-
-        $page_template = $this->request->getRequestParam('page_template');
-        if ($this->_supports_page_templates($post->post_type) && ! empty($page_template)) {
-            // wp version aware.
-            if (RecommendedVersions::compareWordPressVersion('4.7')) {
-                $page_templates = wp_get_theme()->get_page_templates();
-            } else {
-                $post->page_template = $page_template;
-                $page_templates      = wp_get_theme()->get_page_templates($post);
-            }
-            if ($page_template !== 'default' && ! isset($page_templates[ $page_template ])) {
-                EE_Error::add_error(
-                    esc_html__('Invalid Page Template.', 'event_espresso'),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            } else {
-                update_post_meta($post_id, '_wp_page_template', $page_template);
-            }
-        }
-        if (defined('DOING_AUTOSAVE') && DOING_AUTOSAVE) {
-            return;
-        } //TODO we'll remove this after reimplementing autosave in 4.2
-        $this->_insert_update_cpt_item($post_id, $post);
-    }
-
-
-    /**
-     * This hooks into the wp_trash_post() function and removes the `_wp_trash_meta_status` and `_wp_trash_meta_time`
-     * post meta IF the trashed post is one of our CPT's - note this method should only be called with our cpt routes
-     * so we don't have to check for our CPT.
-     *
-     * @param int $post_id ID of the post
-     * @return void
-     */
-    public function dont_permanently_delete_ee_cpts(int $post_id)
-    {
-        // only do this if we're actually processing one of our CPTs
-        // if our cpt object isn't existent then get out immediately.
-        if (! $this->_cpt_model_obj instanceof EE_CPT_Base) {
-            return;
-        }
-        delete_post_meta($post_id, '_wp_trash_meta_status');
-        delete_post_meta($post_id, '_wp_trash_meta_time');
-        // our cpts may have comments so let's take care of that too
-        delete_post_meta($post_id, '_wp_trash_meta_comments_status');
-    }
-
-
-    /**
-     * This is a wrapper for the restore_cpt_revision route for cpt items so we can make sure that when a revision is
-     * triggered that we restore related items.  In order to work cpt classes MUST have a restore_cpt_revision method
-     * in them. We also have our OWN action in here so addons can hook into the restore process easily.
-     *
-     * @param int $post_id     ID of cpt item
-     * @param int $revision_id ID of revision being restored
-     * @return void
-     */
-    public function restore_revision(int $post_id, int $revision_id)
-    {
-        $this->_restore_cpt_item($post_id, $revision_id);
-        // global action
-        do_action('AHEE_EE_Admin_Page_CPT__restore_revision', $post_id, $revision_id);
-        // class specific action so you can limit hooking into a specific page.
-        do_action('AHEE_EE_Admin_Page_CPT_' . get_class($this) . '__restore_revision', $post_id, $revision_id);
-    }
-
-
-    /**
-     * @param int $post_id     ID of cpt item
-     * @param int $revision_id ID of revision for item
-     * @return void
-     * @see restore_revision() for details
-     */
-    abstract protected function _restore_cpt_item(int $post_id, int $revision_id);
-
-
-    /**
-     * Execution of this method is added to the end of the load_page_dependencies method in the parent
-     * so that we can fix a bug where default core metaboxes were not being called in the sidebar.
-     * To fix we have to reset the current_screen using the page_slug
-     * (which is identical - or should be - to our registered_post_type id.)
-     * Also, since the core WP file loads the admin_header.php for WP
-     * (and there are a bunch of other things edit-form-advanced.php loads that need to happen really early)
-     * we need to load it NOW, hence our _route_admin_request in here. (Otherwise screen options won't be set).
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function modify_current_screen()
-    {
-        // ONLY do this if the current page_route IS a cpt route
-        if (! $this->_cpt_route) {
-            return;
-        }
-        // routing things REALLY early b/c this is a cpt admin page
-        set_current_screen($this->_cpt_routes[ $this->_req_action ]);
-        $this->_current_screen       = get_current_screen();
-        $this->_current_screen->base = 'event-espresso';
-        $this->_add_help_tabs(); // we make sure we add any help tabs back in!
-        /*try {
+		// take care of updating any selected page_template IF this cpt supports it.
+
+		$page_template = $this->request->getRequestParam('page_template');
+		if ($this->_supports_page_templates($post->post_type) && ! empty($page_template)) {
+			// wp version aware.
+			if (RecommendedVersions::compareWordPressVersion('4.7')) {
+				$page_templates = wp_get_theme()->get_page_templates();
+			} else {
+				$post->page_template = $page_template;
+				$page_templates      = wp_get_theme()->get_page_templates($post);
+			}
+			if ($page_template !== 'default' && ! isset($page_templates[ $page_template ])) {
+				EE_Error::add_error(
+					esc_html__('Invalid Page Template.', 'event_espresso'),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			} else {
+				update_post_meta($post_id, '_wp_page_template', $page_template);
+			}
+		}
+		if (defined('DOING_AUTOSAVE') && DOING_AUTOSAVE) {
+			return;
+		} //TODO we'll remove this after reimplementing autosave in 4.2
+		$this->_insert_update_cpt_item($post_id, $post);
+	}
+
+
+	/**
+	 * This hooks into the wp_trash_post() function and removes the `_wp_trash_meta_status` and `_wp_trash_meta_time`
+	 * post meta IF the trashed post is one of our CPT's - note this method should only be called with our cpt routes
+	 * so we don't have to check for our CPT.
+	 *
+	 * @param int $post_id ID of the post
+	 * @return void
+	 */
+	public function dont_permanently_delete_ee_cpts(int $post_id)
+	{
+		// only do this if we're actually processing one of our CPTs
+		// if our cpt object isn't existent then get out immediately.
+		if (! $this->_cpt_model_obj instanceof EE_CPT_Base) {
+			return;
+		}
+		delete_post_meta($post_id, '_wp_trash_meta_status');
+		delete_post_meta($post_id, '_wp_trash_meta_time');
+		// our cpts may have comments so let's take care of that too
+		delete_post_meta($post_id, '_wp_trash_meta_comments_status');
+	}
+
+
+	/**
+	 * This is a wrapper for the restore_cpt_revision route for cpt items so we can make sure that when a revision is
+	 * triggered that we restore related items.  In order to work cpt classes MUST have a restore_cpt_revision method
+	 * in them. We also have our OWN action in here so addons can hook into the restore process easily.
+	 *
+	 * @param int $post_id     ID of cpt item
+	 * @param int $revision_id ID of revision being restored
+	 * @return void
+	 */
+	public function restore_revision(int $post_id, int $revision_id)
+	{
+		$this->_restore_cpt_item($post_id, $revision_id);
+		// global action
+		do_action('AHEE_EE_Admin_Page_CPT__restore_revision', $post_id, $revision_id);
+		// class specific action so you can limit hooking into a specific page.
+		do_action('AHEE_EE_Admin_Page_CPT_' . get_class($this) . '__restore_revision', $post_id, $revision_id);
+	}
+
+
+	/**
+	 * @param int $post_id     ID of cpt item
+	 * @param int $revision_id ID of revision for item
+	 * @return void
+	 * @see restore_revision() for details
+	 */
+	abstract protected function _restore_cpt_item(int $post_id, int $revision_id);
+
+
+	/**
+	 * Execution of this method is added to the end of the load_page_dependencies method in the parent
+	 * so that we can fix a bug where default core metaboxes were not being called in the sidebar.
+	 * To fix we have to reset the current_screen using the page_slug
+	 * (which is identical - or should be - to our registered_post_type id.)
+	 * Also, since the core WP file loads the admin_header.php for WP
+	 * (and there are a bunch of other things edit-form-advanced.php loads that need to happen really early)
+	 * we need to load it NOW, hence our _route_admin_request in here. (Otherwise screen options won't be set).
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function modify_current_screen()
+	{
+		// ONLY do this if the current page_route IS a cpt route
+		if (! $this->_cpt_route) {
+			return;
+		}
+		// routing things REALLY early b/c this is a cpt admin page
+		set_current_screen($this->_cpt_routes[ $this->_req_action ]);
+		$this->_current_screen       = get_current_screen();
+		$this->_current_screen->base = 'event-espresso';
+		$this->_add_help_tabs(); // we make sure we add any help tabs back in!
+		/*try {
             $this->_route_admin_request();
         } catch ( EE_Error $e ) {
             $e->get_error();
         }/**/
-    }
-
-
-    /**
-     * This allows child classes to modify the default editor title that appears when people add a new or edit an
-     * existing CPT item.     * This uses the _labels property set by the child class via _define_page_props. Just make
-     * sure you have a key in _labels property that equals 'editor_title' and the value can be whatever you want the
-     * default to be.
-     *
-     * @param string|null $title The new title (or existing if there is no editor_title defined)
-     * @return string|null
-     */
-    public function add_custom_editor_default_title(?string $title): ?string
-    {
-        return $this->_labels['editor_title'][ $this->_cpt_routes[ $this->_req_action ] ] ?? $title;
-    }
-
-
-    /**
-     * hooks into the wp_get_shortlink button and makes sure that the shortlink gets generated
-     *
-     * @param string $shortlink   The already generated shortlink
-     * @param int    $id          Post ID for this item
-     * @return string
-     * @deprecated 5.0.0.p
-     * @see EventShortlinkButton::addButton()
-     */
-    public function add_shortlink_button_to_editor(string $shortlink, int $id): string
-    {
-        return EventShortlinkButton::addButton($shortlink, $id);
-    }
-
-
-    /**
-     * overriding the parent route_admin_request method so we DON'T run the route twice on cpt core page loads (it's
-     * already run in modify_current_screen())
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws Throwable
-     */
-    public function route_admin_request()
-    {
-        if ($this->_cpt_route) {
-            return;
-        }
-        try {
-            $this->_route_admin_request();
-        } catch (EE_Error $e) {
-            $e->get_error();
-        }
-    }
-
-
-    /**
-     * Add a hidden form input to cpt core pages so that we know to do redirects to our routes on saves
-     *
-     * @return void
-     */
-    public function cpt_post_form_hidden_input()
-    {
-        // we're also going to add the route value and the current page so we can direct autosave parsing correctly
-        echo '
+	}
+
+
+	/**
+	 * This allows child classes to modify the default editor title that appears when people add a new or edit an
+	 * existing CPT item.     * This uses the _labels property set by the child class via _define_page_props. Just make
+	 * sure you have a key in _labels property that equals 'editor_title' and the value can be whatever you want the
+	 * default to be.
+	 *
+	 * @param string|null $title The new title (or existing if there is no editor_title defined)
+	 * @return string|null
+	 */
+	public function add_custom_editor_default_title(?string $title): ?string
+	{
+		return $this->_labels['editor_title'][ $this->_cpt_routes[ $this->_req_action ] ] ?? $title;
+	}
+
+
+	/**
+	 * hooks into the wp_get_shortlink button and makes sure that the shortlink gets generated
+	 *
+	 * @param string $shortlink   The already generated shortlink
+	 * @param int    $id          Post ID for this item
+	 * @return string
+	 * @deprecated 5.0.0.p
+	 * @see EventShortlinkButton::addButton()
+	 */
+	public function add_shortlink_button_to_editor(string $shortlink, int $id): string
+	{
+		return EventShortlinkButton::addButton($shortlink, $id);
+	}
+
+
+	/**
+	 * overriding the parent route_admin_request method so we DON'T run the route twice on cpt core page loads (it's
+	 * already run in modify_current_screen())
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws Throwable
+	 */
+	public function route_admin_request()
+	{
+		if ($this->_cpt_route) {
+			return;
+		}
+		try {
+			$this->_route_admin_request();
+		} catch (EE_Error $e) {
+			$e->get_error();
+		}
+	}
+
+
+	/**
+	 * Add a hidden form input to cpt core pages so that we know to do redirects to our routes on saves
+	 *
+	 * @return void
+	 */
+	public function cpt_post_form_hidden_input()
+	{
+		// we're also going to add the route value and the current page so we can direct autosave parsing correctly
+		echo '
         <input type="hidden" name="ee_cpt_item_redirect_url" value="' . esc_url_raw($this->_admin_base_url) . '"/>
         <div id="ee-cpt-hidden-inputs">
             <input type="hidden" id="current_route" name="current_route" value="' . esc_attr($this->_current_view) . '"/>
             <input type="hidden" id="current_page" name="current_page" value="' . esc_attr($this->page_slug) . '"/>
         </div>';
-    }
-
-
-    /**
-     * This allows us to redirect the location of revision restores when they happen so it goes to our CPT routes.
-     *
-     * @param string $location Original location url
-     * @return string           new (or original) url to redirect to.
-     * @throws EE_Error
-     */
-    public function revision_redirect(string $location): string
-    {
-        // get revision
-        $revision = $this->request->getRequestParam('revision');
-        // can't do anything without revision so let's get out if not present
-        if (empty($revision)) {
-            return $location;
-        }
-        // get rev_post_data
-        $rev        = get_post($revision);
-        $admin_url  = $this->_admin_base_url;
-        $query_args = [
-            'action'   => 'edit',
-            'post'     => $rev->post_parent,
-            'revision' => $revision,
-            'message'  => 5,
-        ];
-        $this->_process_notices($query_args, true);
-        return EE_Admin_Page_CPT::add_query_args_and_nonce($query_args, $admin_url);
-    }
-
-
-    /**
-     * Modify the edit post link generated by wp core function so that EE CPTs get setup differently.
-     *
-     * @param string $link    the original generated link
-     * @param int    $id      post id
-     * @return string          the link
-     */
-    public function modify_edit_post_link(string $link, int $id): string
-    {
-        $post = get_post($id);
-        $action = $this->request->getRequestParam('action');
-        if (
-            empty($action)
-            || ! isset($this->_cpt_routes[ $action ])
-            || $post->post_type !== $this->_cpt_routes[ $action ]
-        ) {
-            return $link;
-        }
-        $query_args = [
-            'action' => $this->_cpt_edit_routes[ $post->post_type ] ?? 'edit',
-            'post'   => $id,
-        ];
-        return EE_Admin_Page_CPT::add_query_args_and_nonce($query_args, $this->_admin_base_url);
-    }
-
-
-    /**
-     * Modify the trash link on our cpt edit pages so it has the required query var for triggering redirect properly on
-     * our routes.
-     *
-     * @param string $delete_link  original delete link
-     * @param int    $post_id      id of cpt object
-     * @return string new delete link
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function modify_delete_post_link(string $delete_link, int $post_id): string
-    {
-        $post = get_post($post_id);
-        $action = $this->request->getRequestParam('action');
-        if (
-            ! $post instanceof WP_Post
-            || empty($action)
-            || ! isset($this->_cpt_routes[ $action ])
-            || $post->post_type !== $this->_cpt_routes[ $action ]
-        ) {
-            return $delete_link;
-        }
-        $this->_set_model_object($post->ID, true);
-
-        // returns something like `trash_event` or `trash_attendee` or `trash_venue`
-        $action = 'trash_' . str_replace('ee_', '', strtolower(get_class($this->_cpt_model_obj)));
-
-        return EE_Admin_Page::add_query_args_and_nonce(
-            [
-                'page'   => $this->request->getRequestParam('page'),
-                'action' => $action,
-                $this->_cpt_model_obj->get_model()->get_primary_key_field()->get_name() => $post->ID,
-            ],
-            admin_url()
-        );
-    }
-
-
-    /**
-     * This is the callback for the 'redirect_post_location' filter in wp-admin/post.php
-     * so that we can hijack the default redirect locations for wp custom post types
-     * that WE'RE using and send back to OUR routes.  This should only be hooked in on the right route.
-     *
-     * @param string $location This is the incoming currently set redirect location
-     * @param string $post_id  This is the 'ID' value of the wp_posts table
-     * @return string           the new location to redirect to
-     * @throws EE_Error
-     */
-    public function cpt_post_location_redirect(string $location, string $post_id): string
-    {
-        // we DO have a match so let's setup the url
-        // we have to get the post to determine our route
-        $post       = get_post($post_id);
-        $edit_route = $this->_cpt_edit_routes[ $post->post_type ];
-        // shared query_args
-        $query_args = ['action' => $edit_route, 'post' => $post_id];
-
-        $save = $this->request->getRequestParam('save');
-        $publish = $this->request->getRequestParam('publish');
-        $add_meta = $this->request->getRequestParam('addmeta');
-        $delete_meta = $this->request->getRequestParam('deletemeta');
-        if ($save || $publish) {
-            $status = get_post_status($post_id);
-            if ($publish) {
-                switch ($status) {
-                    case 'pending':
-                        $message = 8;
-                        break;
-                    case 'future':
-                        $message = 9;
-                        break;
-                    default:
-                        $message = 6;
-                }
-            } else {
-                $message = 'draft' === $status ? 10 : 1;
-            }
-        } elseif ($add_meta) {
-            $message = 2;
-        } elseif ($delete_meta) {
-            $message = 3;
-        } elseif ($this->request->getRequestParam('action') === 'post-quickpress-save-cont') {
-            $message = 7;
-        } else {
-            $message = 4;
-        }
-        // change the message if the post type is not viewable on the frontend
-        $this->_cpt_object = get_post_type_object($post->post_type);
-
-        $query_args['message'] = $message === 1 && ! $this->_cpt_object->publicly_queryable ? 4 : $message;
-        $this->_process_notices($query_args, true);
-        return EE_Admin_Page_CPT::add_query_args_and_nonce($query_args, $this->_admin_base_url);
-    }
-
-
-    /**
-     * This method is called to inject nav tabs on core WP cpt pages
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    public function inject_nav_tabs()
-    {
-        echo wp_kses($this->_get_main_nav_tabs(), AllowedTags::getWithFormTags());
-    }
-
-
-    /**
-     * This just sets up the post update messages when an update form is loaded
-     *
-     * @param array $messages the original messages array
-     * @return array           the new messages array
-     */
-    public function post_update_messages(array $messages): array
-    {
-        global $post;
-        $id       = $this->request->getRequestParam('post');
-        $id       = empty($id) && is_object($post) ? $post->ID : null;
-        $revision = $this->request->getRequestParam('revision', 0, 'int');
-
-        $messages[ $post->post_type ] = [
-            0  => '', // Unused. Messages start at index 1.
-            1  => sprintf(
-                esc_html__('%1$s updated. %2$sView %1$s%3$s', 'event_espresso'),
-                $this->_cpt_object->labels->singular_name,
-                '<a href="' . esc_url(get_permalink($id)) . '">',
-                '</a>'
-            ),
-            2  => esc_html__('Custom field updated', 'event_espresso'),
-            3  => esc_html__('Custom field deleted.', 'event_espresso'),
-            4  => sprintf(esc_html__('%1$s updated.', 'event_espresso'), $this->_cpt_object->labels->singular_name),
-            5  => $revision
-                ? sprintf(
-                    esc_html__('%s restored to revision from %s', 'event_espresso'),
-                    $this->_cpt_object->labels->singular_name,
-                    wp_post_revision_title($revision, false)
-                )
-                : false,
-            6  => sprintf(
-                esc_html__('%1$s published. %2$sView %1$s%3$s', 'event_espresso'),
-                $this->_cpt_object->labels->singular_name,
-                '<a href="' . esc_url(get_permalink($id)) . '">',
-                '</a>'
-            ),
-            7  => sprintf(esc_html__('%1$s saved.', 'event_espresso'), $this->_cpt_object->labels->singular_name),
-            8  => sprintf(
-                esc_html__('%1$s submitted. %2$sPreview %1$s%3$s', 'event_espresso'),
-                $this->_cpt_object->labels->singular_name,
-                '<a target="_blank" href="' . esc_url(add_query_arg('preview', 'true', get_permalink($id))) . '">',
-                '</a>'
-            ),
-            9  => sprintf(
-                esc_html__('%1$s scheduled for: %2$s. %3$s">Preview %1$s%3$s', 'event_espresso'),
-                $this->_cpt_object->labels->singular_name,
-                '<strong>' . date_i18n('M j, Y @ G:i', strtotime($post->post_date)) . '</strong>',
-                '<a target="_blank" href="' . esc_url(get_permalink($id)),
-                '</a>'
-            ),
-            10 => sprintf(
-                esc_html__('%1$s draft updated. %2$s">Preview page%3$s', 'event_espresso'),
-                $this->_cpt_object->labels->singular_name,
-                '<a target="_blank" href="' . esc_url(add_query_arg('preview', 'true', get_permalink($id))),
-                '</a>'
-            ),
-        ];
-        return $messages;
-    }
-
-
-    /**
-     * default method for the 'create_new' route for cpt admin pages.
-     * For reference what to include in here, see wp-admin/post-new.php
-     *
-     * @return void
-     */
-    protected function _create_new_cpt_item()
-    {
-        // gather template vars for WP_ADMIN_PATH . 'edit-form-advanced.php'
-        global $post, $title, $post_type, $post_type_object;
-        $post_type        = $this->_cpt_routes[ $this->_req_action ];
-        $post_type_object = $this->_cpt_object;
-        $title            = $post_type_object->labels->add_new_item;
-        $post             = $post = get_default_post_to_edit($this->_cpt_routes[ $this->_req_action ], true);
-        add_action('admin_print_styles', [$this, 'add_new_admin_page_global']);
-        // modify the default editor title field with default title.
-        add_filter('enter_title_here', [$this, 'add_custom_editor_default_title']);
-        $this->loadEditorTemplate();
-    }
-
-
-    /**
-     * Enqueues auto-save and loads the editor template
-     *
-     * @param bool $creating
-     */
-    private function loadEditorTemplate(bool $creating = true)
-    {
-        if ($this->admin_config && ! $this->admin_config->useAdvancedEditor()) {
-            add_filter('admin_body_class', function($classes)
-            {
-                $classes .= ' espresso-legacy-editor';
-                return $classes;
-            });
-        }
-
-        global $post, $title, $is_IE, $post_type, $post_type_object;
-        // these vars are used by the template
-        $editing = true;
-        $post_ID = $post->ID;
-        if (apply_filters('FHEE__EE_Admin_Page_CPT___create_new_cpt_item__replace_editor', false, $post) === false) {
-            // only enqueue autosave when creating event (necessary to get permalink/url generated)
-            // otherwise EE doesn't support autosave fully, so to prevent user confusion we disable it in edit context.
-            $action = $this->request->getRequestParam('action');
-            if ($creating) {
-                wp_enqueue_script('autosave');
-            } elseif (
-                isset($this->_cpt_routes[ $action ])
-                && ! isset($this->_labels['hide_add_button_on_cpt_route'][ $action ])
-            ) {
-                $create_new_action = apply_filters(
-                    'FHEE__EE_Admin_Page_CPT___edit_cpt_item__create_new_action',
-                    'create_new',
-                    $this
-                );
-                $post_new_file     = EE_Admin_Page::add_query_args_and_nonce(
-                    [
-                        'action' => $create_new_action,
-                        'page'   => $this->page_slug,
-                    ],
-                    'admin.php'
-                );
-            }
-            include_once WP_ADMIN_PATH . 'edit-form-advanced.php';
-        }
-    }
-
-
-    public function add_new_admin_page_global()
-    {
-        $admin_page = $this->request->getRequestParam('post', 0, DataType::INT) !== 0
-            ? 'post-php'
-            : 'post-new-php';
-        ?>
+	}
+
+
+	/**
+	 * This allows us to redirect the location of revision restores when they happen so it goes to our CPT routes.
+	 *
+	 * @param string $location Original location url
+	 * @return string           new (or original) url to redirect to.
+	 * @throws EE_Error
+	 */
+	public function revision_redirect(string $location): string
+	{
+		// get revision
+		$revision = $this->request->getRequestParam('revision');
+		// can't do anything without revision so let's get out if not present
+		if (empty($revision)) {
+			return $location;
+		}
+		// get rev_post_data
+		$rev        = get_post($revision);
+		$admin_url  = $this->_admin_base_url;
+		$query_args = [
+			'action'   => 'edit',
+			'post'     => $rev->post_parent,
+			'revision' => $revision,
+			'message'  => 5,
+		];
+		$this->_process_notices($query_args, true);
+		return EE_Admin_Page_CPT::add_query_args_and_nonce($query_args, $admin_url);
+	}
+
+
+	/**
+	 * Modify the edit post link generated by wp core function so that EE CPTs get setup differently.
+	 *
+	 * @param string $link    the original generated link
+	 * @param int    $id      post id
+	 * @return string          the link
+	 */
+	public function modify_edit_post_link(string $link, int $id): string
+	{
+		$post = get_post($id);
+		$action = $this->request->getRequestParam('action');
+		if (
+			empty($action)
+			|| ! isset($this->_cpt_routes[ $action ])
+			|| $post->post_type !== $this->_cpt_routes[ $action ]
+		) {
+			return $link;
+		}
+		$query_args = [
+			'action' => $this->_cpt_edit_routes[ $post->post_type ] ?? 'edit',
+			'post'   => $id,
+		];
+		return EE_Admin_Page_CPT::add_query_args_and_nonce($query_args, $this->_admin_base_url);
+	}
+
+
+	/**
+	 * Modify the trash link on our cpt edit pages so it has the required query var for triggering redirect properly on
+	 * our routes.
+	 *
+	 * @param string $delete_link  original delete link
+	 * @param int    $post_id      id of cpt object
+	 * @return string new delete link
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function modify_delete_post_link(string $delete_link, int $post_id): string
+	{
+		$post = get_post($post_id);
+		$action = $this->request->getRequestParam('action');
+		if (
+			! $post instanceof WP_Post
+			|| empty($action)
+			|| ! isset($this->_cpt_routes[ $action ])
+			|| $post->post_type !== $this->_cpt_routes[ $action ]
+		) {
+			return $delete_link;
+		}
+		$this->_set_model_object($post->ID, true);
+
+		// returns something like `trash_event` or `trash_attendee` or `trash_venue`
+		$action = 'trash_' . str_replace('ee_', '', strtolower(get_class($this->_cpt_model_obj)));
+
+		return EE_Admin_Page::add_query_args_and_nonce(
+			[
+				'page'   => $this->request->getRequestParam('page'),
+				'action' => $action,
+				$this->_cpt_model_obj->get_model()->get_primary_key_field()->get_name() => $post->ID,
+			],
+			admin_url()
+		);
+	}
+
+
+	/**
+	 * This is the callback for the 'redirect_post_location' filter in wp-admin/post.php
+	 * so that we can hijack the default redirect locations for wp custom post types
+	 * that WE'RE using and send back to OUR routes.  This should only be hooked in on the right route.
+	 *
+	 * @param string $location This is the incoming currently set redirect location
+	 * @param string $post_id  This is the 'ID' value of the wp_posts table
+	 * @return string           the new location to redirect to
+	 * @throws EE_Error
+	 */
+	public function cpt_post_location_redirect(string $location, string $post_id): string
+	{
+		// we DO have a match so let's setup the url
+		// we have to get the post to determine our route
+		$post       = get_post($post_id);
+		$edit_route = $this->_cpt_edit_routes[ $post->post_type ];
+		// shared query_args
+		$query_args = ['action' => $edit_route, 'post' => $post_id];
+
+		$save = $this->request->getRequestParam('save');
+		$publish = $this->request->getRequestParam('publish');
+		$add_meta = $this->request->getRequestParam('addmeta');
+		$delete_meta = $this->request->getRequestParam('deletemeta');
+		if ($save || $publish) {
+			$status = get_post_status($post_id);
+			if ($publish) {
+				switch ($status) {
+					case 'pending':
+						$message = 8;
+						break;
+					case 'future':
+						$message = 9;
+						break;
+					default:
+						$message = 6;
+				}
+			} else {
+				$message = 'draft' === $status ? 10 : 1;
+			}
+		} elseif ($add_meta) {
+			$message = 2;
+		} elseif ($delete_meta) {
+			$message = 3;
+		} elseif ($this->request->getRequestParam('action') === 'post-quickpress-save-cont') {
+			$message = 7;
+		} else {
+			$message = 4;
+		}
+		// change the message if the post type is not viewable on the frontend
+		$this->_cpt_object = get_post_type_object($post->post_type);
+
+		$query_args['message'] = $message === 1 && ! $this->_cpt_object->publicly_queryable ? 4 : $message;
+		$this->_process_notices($query_args, true);
+		return EE_Admin_Page_CPT::add_query_args_and_nonce($query_args, $this->_admin_base_url);
+	}
+
+
+	/**
+	 * This method is called to inject nav tabs on core WP cpt pages
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function inject_nav_tabs()
+	{
+		echo wp_kses($this->_get_main_nav_tabs(), AllowedTags::getWithFormTags());
+	}
+
+
+	/**
+	 * This just sets up the post update messages when an update form is loaded
+	 *
+	 * @param array $messages the original messages array
+	 * @return array           the new messages array
+	 */
+	public function post_update_messages(array $messages): array
+	{
+		global $post;
+		$id       = $this->request->getRequestParam('post');
+		$id       = empty($id) && is_object($post) ? $post->ID : null;
+		$revision = $this->request->getRequestParam('revision', 0, 'int');
+
+		$messages[ $post->post_type ] = [
+			0  => '', // Unused. Messages start at index 1.
+			1  => sprintf(
+				esc_html__('%1$s updated. %2$sView %1$s%3$s', 'event_espresso'),
+				$this->_cpt_object->labels->singular_name,
+				'<a href="' . esc_url(get_permalink($id)) . '">',
+				'</a>'
+			),
+			2  => esc_html__('Custom field updated', 'event_espresso'),
+			3  => esc_html__('Custom field deleted.', 'event_espresso'),
+			4  => sprintf(esc_html__('%1$s updated.', 'event_espresso'), $this->_cpt_object->labels->singular_name),
+			5  => $revision
+				? sprintf(
+					esc_html__('%s restored to revision from %s', 'event_espresso'),
+					$this->_cpt_object->labels->singular_name,
+					wp_post_revision_title($revision, false)
+				)
+				: false,
+			6  => sprintf(
+				esc_html__('%1$s published. %2$sView %1$s%3$s', 'event_espresso'),
+				$this->_cpt_object->labels->singular_name,
+				'<a href="' . esc_url(get_permalink($id)) . '">',
+				'</a>'
+			),
+			7  => sprintf(esc_html__('%1$s saved.', 'event_espresso'), $this->_cpt_object->labels->singular_name),
+			8  => sprintf(
+				esc_html__('%1$s submitted. %2$sPreview %1$s%3$s', 'event_espresso'),
+				$this->_cpt_object->labels->singular_name,
+				'<a target="_blank" href="' . esc_url(add_query_arg('preview', 'true', get_permalink($id))) . '">',
+				'</a>'
+			),
+			9  => sprintf(
+				esc_html__('%1$s scheduled for: %2$s. %3$s">Preview %1$s%3$s', 'event_espresso'),
+				$this->_cpt_object->labels->singular_name,
+				'<strong>' . date_i18n('M j, Y @ G:i', strtotime($post->post_date)) . '</strong>',
+				'<a target="_blank" href="' . esc_url(get_permalink($id)),
+				'</a>'
+			),
+			10 => sprintf(
+				esc_html__('%1$s draft updated. %2$s">Preview page%3$s', 'event_espresso'),
+				$this->_cpt_object->labels->singular_name,
+				'<a target="_blank" href="' . esc_url(add_query_arg('preview', 'true', get_permalink($id))),
+				'</a>'
+			),
+		];
+		return $messages;
+	}
+
+
+	/**
+	 * default method for the 'create_new' route for cpt admin pages.
+	 * For reference what to include in here, see wp-admin/post-new.php
+	 *
+	 * @return void
+	 */
+	protected function _create_new_cpt_item()
+	{
+		// gather template vars for WP_ADMIN_PATH . 'edit-form-advanced.php'
+		global $post, $title, $post_type, $post_type_object;
+		$post_type        = $this->_cpt_routes[ $this->_req_action ];
+		$post_type_object = $this->_cpt_object;
+		$title            = $post_type_object->labels->add_new_item;
+		$post             = $post = get_default_post_to_edit($this->_cpt_routes[ $this->_req_action ], true);
+		add_action('admin_print_styles', [$this, 'add_new_admin_page_global']);
+		// modify the default editor title field with default title.
+		add_filter('enter_title_here', [$this, 'add_custom_editor_default_title']);
+		$this->loadEditorTemplate();
+	}
+
+
+	/**
+	 * Enqueues auto-save and loads the editor template
+	 *
+	 * @param bool $creating
+	 */
+	private function loadEditorTemplate(bool $creating = true)
+	{
+		if ($this->admin_config && ! $this->admin_config->useAdvancedEditor()) {
+			add_filter('admin_body_class', function($classes)
+			{
+				$classes .= ' espresso-legacy-editor';
+				return $classes;
+			});
+		}
+
+		global $post, $title, $is_IE, $post_type, $post_type_object;
+		// these vars are used by the template
+		$editing = true;
+		$post_ID = $post->ID;
+		if (apply_filters('FHEE__EE_Admin_Page_CPT___create_new_cpt_item__replace_editor', false, $post) === false) {
+			// only enqueue autosave when creating event (necessary to get permalink/url generated)
+			// otherwise EE doesn't support autosave fully, so to prevent user confusion we disable it in edit context.
+			$action = $this->request->getRequestParam('action');
+			if ($creating) {
+				wp_enqueue_script('autosave');
+			} elseif (
+				isset($this->_cpt_routes[ $action ])
+				&& ! isset($this->_labels['hide_add_button_on_cpt_route'][ $action ])
+			) {
+				$create_new_action = apply_filters(
+					'FHEE__EE_Admin_Page_CPT___edit_cpt_item__create_new_action',
+					'create_new',
+					$this
+				);
+				$post_new_file     = EE_Admin_Page::add_query_args_and_nonce(
+					[
+						'action' => $create_new_action,
+						'page'   => $this->page_slug,
+					],
+					'admin.php'
+				);
+			}
+			include_once WP_ADMIN_PATH . 'edit-form-advanced.php';
+		}
+	}
+
+
+	public function add_new_admin_page_global()
+	{
+		$admin_page = $this->request->getRequestParam('post', 0, DataType::INT) !== 0
+			? 'post-php'
+			: 'post-new-php';
+		?>
         <script type="text/javascript">
             adminpage = '<?php echo esc_js($admin_page); ?>';
         </script>
         <?php
-    }
-
-
-    /**
-     * default method for the 'edit' route for cpt admin pages
-     * For reference on what to put in here, refer to wp-admin/post.php
-     *
-     * @return void
-     */
-    protected function _edit_cpt_item()
-    {
-        global $post, $post_type, $post_type_object, $title;
-        $post_id = $this->request->getRequestParam('post', 0, DataType::INT);
-        $post    = $post_id ? get_post($post_id, OBJECT, 'edit') : null;
-        if (empty($post)) {
-            wp_die(
-                esc_html__(
-                    "You attempted to edit an item that doesn't exist. Perhaps it was deleted?",
-                    'event_espresso'
-                )
-            );
-        }
-
-        $post_lock = $this->request->getRequestParam('get-post-lock');
-        if ($post_lock) {
-            wp_set_post_lock($post_id);
-            EEH_URL::safeRedirectAndExit(get_edit_post_link($post_id, 'url'));
-        }
-
-        // template vars for WP_ADMIN_PATH . 'edit-form-advanced.php'
-        $post_type        = $this->_cpt_routes[ $this->_req_action ];
-        $post_type_object = $this->_cpt_object;
-        $title = $this->_labels['editor_title'][ $this->_cpt_routes[ $this->_req_action ] ]
-                 ?? $post_type_object->labels->edit_item;
-
-        if (! wp_check_post_lock($post->ID)) {
-            wp_set_post_lock($post->ID);
-        }
-        add_action('admin_footer', '_admin_notice_post_locked');
-        if (post_type_supports($this->_cpt_routes[ $this->_req_action ], 'comments')) {
-            wp_enqueue_script('admin-comments');
-            enqueue_comment_hotkeys_js();
-        }
-        add_action('admin_print_styles', [$this, 'add_new_admin_page_global']);
-        // modify the default editor title field with default title.
-        add_filter('enter_title_here', [$this, 'add_custom_editor_default_title']);
-        $this->loadEditorTemplate(false);
-    }
-
-
-
-    /**
-     * some getters
-     */
-    /**
-     * This returns the protected _cpt_model_obj property
-     *
-     * @return EE_CPT_Base|null
-     */
-    public function get_cpt_model_obj(): ?EE_CPT_Base
-    {
-        return $this->_cpt_model_obj;
-    }
+	}
+
+
+	/**
+	 * default method for the 'edit' route for cpt admin pages
+	 * For reference on what to put in here, refer to wp-admin/post.php
+	 *
+	 * @return void
+	 */
+	protected function _edit_cpt_item()
+	{
+		global $post, $post_type, $post_type_object, $title;
+		$post_id = $this->request->getRequestParam('post', 0, DataType::INT);
+		$post    = $post_id ? get_post($post_id, OBJECT, 'edit') : null;
+		if (empty($post)) {
+			wp_die(
+				esc_html__(
+					"You attempted to edit an item that doesn't exist. Perhaps it was deleted?",
+					'event_espresso'
+				)
+			);
+		}
+
+		$post_lock = $this->request->getRequestParam('get-post-lock');
+		if ($post_lock) {
+			wp_set_post_lock($post_id);
+			EEH_URL::safeRedirectAndExit(get_edit_post_link($post_id, 'url'));
+		}
+
+		// template vars for WP_ADMIN_PATH . 'edit-form-advanced.php'
+		$post_type        = $this->_cpt_routes[ $this->_req_action ];
+		$post_type_object = $this->_cpt_object;
+		$title = $this->_labels['editor_title'][ $this->_cpt_routes[ $this->_req_action ] ]
+				 ?? $post_type_object->labels->edit_item;
+
+		if (! wp_check_post_lock($post->ID)) {
+			wp_set_post_lock($post->ID);
+		}
+		add_action('admin_footer', '_admin_notice_post_locked');
+		if (post_type_supports($this->_cpt_routes[ $this->_req_action ], 'comments')) {
+			wp_enqueue_script('admin-comments');
+			enqueue_comment_hotkeys_js();
+		}
+		add_action('admin_print_styles', [$this, 'add_new_admin_page_global']);
+		// modify the default editor title field with default title.
+		add_filter('enter_title_here', [$this, 'add_custom_editor_default_title']);
+		$this->loadEditorTemplate(false);
+	}
+
+
+
+	/**
+	 * some getters
+	 */
+	/**
+	 * This returns the protected _cpt_model_obj property
+	 *
+	 * @return EE_CPT_Base|null
+	 */
+	public function get_cpt_model_obj(): ?EE_CPT_Base
+	{
+		return $this->_cpt_model_obj;
+	}
 }

Spacing +69 added lines, -69 removed lines

@@ -92,7 +92,7 @@ 
      *
      * @var array
      */
-    protected array $_pagenow_map= [];
+    protected array $_pagenow_map = [];
 
 
     /**
@@ -155,7 +155,7 @@ 
      */
     protected function getLoader(): LoaderInterface
     {
-        if (! $this->loader instanceof LoaderInterface) {
+        if ( ! $this->loader instanceof LoaderInterface) {
             $this->loader = LoaderFactory::getLoader();
         }
         return $this->loader;
@@ -179,7 +179,7 @@ 
             ],
             $this->_cpt_routes
         );
-        $cpt_route_action     = $this->_cpt_routes[ $this->raw_req_action ] ?? null;
+        $cpt_route_action = $this->_cpt_routes[$this->raw_req_action] ?? null;
         // let's see if the current route has a value for cpt_object_slug. if it does, we use that instead of the page
         $page              = $this->raw_req_page ?: $this->page_slug;
         $page              = $cpt_route_action ?: $page;
@@ -211,10 +211,10 @@ 
         // possibly reset pagenow.
         if (
             $this->page_slug === $this->raw_req_page
-            && isset($this->_pagenow_map[ $this->raw_req_action ])
+            && isset($this->_pagenow_map[$this->raw_req_action])
         ) {
             global $pagenow, $hook_suffix;
-            $pagenow     = $this->_pagenow_map[ $this->raw_req_action ];
+            $pagenow     = $this->_pagenow_map[$this->raw_req_action];
             $hook_suffix = $pagenow;
         }
     }
@@ -246,7 +246,7 @@ 
         if (empty($wp_meta_boxes)) {
             return;
         }
-        $current_metaboxes = $wp_meta_boxes[ $this->page_slug ] ?? [];
+        $current_metaboxes = $wp_meta_boxes[$this->page_slug] ?? [];
         foreach ($current_metaboxes as $box_context) {
             foreach ($box_context as $box_details) {
                 foreach ($box_details as $box) {
@@ -280,7 +280,7 @@ 
             $this
         );
         $containers = apply_filters(
-            'FHEE__EE_Admin_Page_CPT__' . get_class($this) . '___load_autosave_scripts_styles__containers',
+            'FHEE__EE_Admin_Page_CPT__'.get_class($this).'___load_autosave_scripts_styles__containers',
             $containers,
             $this
         );
@@ -318,7 +318,7 @@ 
     protected function _load_page_dependencies()
     {
         // we only add stuff if this is a cpt_route!
-        if (! $this->_cpt_route) {
+        if ( ! $this->_cpt_route) {
             parent::_load_page_dependencies();
             return;
         }
@@ -339,8 +339,8 @@ 
         add_action('post_updated_messages', [$this, 'post_update_messages']);
         // This basically allows us to change the title of the "publish" metabox area
         // on CPT pages by setting a 'publishbox' value in the $_labels property array in the child class.
-        $screen = $this->_cpt_routes[ $this->_req_action ];
-        if (! empty($this->_labels['publishbox'])) {
+        $screen = $this->_cpt_routes[$this->_req_action];
+        if ( ! empty($this->_labels['publishbox'])) {
             $this->addMetaBox(
                 'submitdiv',
                 $this->getPublishBoxTitle(),
@@ -388,8 +388,8 @@ 
         // This is for any plugins that are doing things properly
         // and hooking into the load page hook for core wp cpt routes.
         global $pagenow;
-        add_action('load-' . $pagenow, [$this, 'modify_current_screen'], 20);
-        do_action('load-' . $pagenow);
+        add_action('load-'.$pagenow, [$this, 'modify_current_screen'], 20);
+        do_action('load-'.$pagenow);
         add_action('admin_enqueue_scripts', [$this, 'setup_autosave_hooks'], 30);
         // we route REALLY early.
         try {
@@ -416,8 +416,8 @@ 
                 'admin.php?page=espresso_registrations&action=contact_list',
             ],
             1 => [
-                'edit.php?post_type=' . $this->_cpt_object->name,
-                'admin.php?page=' . $this->_cpt_object->name,
+                'edit.php?post_type='.$this->_cpt_object->name,
+                'admin.php?page='.$this->_cpt_object->name,
             ],
         ];
         foreach ($routes_to_match as $route_matches) {
@@ -446,14 +446,14 @@ 
             'EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions'
         );
         $cpt_args          = $custom_post_types->getDefinitions();
-        $cpt_args          = isset($cpt_args[ $cpt_name ]) ? $cpt_args[ $cpt_name ]['args'] : [];
+        $cpt_args          = isset($cpt_args[$cpt_name]) ? $cpt_args[$cpt_name]['args'] : [];
         $cpt_has_support   = ! empty($cpt_args['page_templates']);
 
         $post_templates = wp_get_theme()->get_post_templates();
         // if there are $post_templates for this cpt, then we return false for this method because
         // that means we aren't going to load our page template manager and leave that up to the native
         // cpt template manager.
-        return ! isset($post_templates[ $cpt_name ]) ? $cpt_has_support : false;
+        return ! isset($post_templates[$cpt_name]) ? $cpt_has_support : false;
     }
 
 
@@ -511,7 +511,7 @@ 
     {
         $statuses         = $this->_cpt_model_obj->get_custom_post_statuses();
         $cur_status_label = array_key_exists($this->_cpt_model_obj->status(), $statuses)
-            ? $statuses[ $this->_cpt_model_obj->status() ]
+            ? $statuses[$this->_cpt_model_obj->status()]
             : '';
         $template_args    = [
             'cur_status'            => $this->_cpt_model_obj->status(),
@@ -526,7 +526,7 @@ 
             $template_args['statuses']         = $statuses;
         }
 
-        $template = EE_ADMIN_TEMPLATE . 'status_dropdown.template.php';
+        $template = EE_ADMIN_TEMPLATE.'status_dropdown.template.php';
         EEH_Template::display_template($template, $template_args);
     }
 
@@ -566,7 +566,7 @@ 
         $nonce = $this->request->getRequestParam('autosavenonce');
         $this->_verify_nonce($nonce, 'autosave');
         // make sure we define doing autosave (cause WP isn't triggering this we want to make sure we define it)
-        if (! defined('DOING_AUTOSAVE')) {
+        if ( ! defined('DOING_AUTOSAVE')) {
             define('DOING_AUTOSAVE', true);
         }
         // if we made it here then the nonce checked out.  Let's run our methods and actions
@@ -577,7 +577,7 @@ 
             $this->_template_args['success'] = true;
         }
         do_action('AHEE__EE_Admin_Page_CPT__do_extra_autosave_stuff__global_after', $this);
-        do_action('AHEE__EE_Admin_Page_CPT__do_extra_autosave_stuff__after_' . get_class($this), $this);
+        do_action('AHEE__EE_Admin_Page_CPT__do_extra_autosave_stuff__after_'.get_class($this), $this);
         // now let's return json
         $this->_return_json();
     }
@@ -599,7 +599,7 @@ 
             return;
         }
         // set page routes and page config but ONLY if we're not viewing a custom setup cpt route as defined in _cpt_routes
-        if (! empty($this->_cpt_object)) {
+        if ( ! empty($this->_cpt_object)) {
             $this->_page_routes = array_merge(
                 [
                     'create_new' => [$this, '_create_new_cpt_item'],
@@ -630,7 +630,7 @@ 
             );
         }
         // load the next section only if this is a matching cpt route as set in the cpt routes array.
-        if (! isset($this->_cpt_routes[ $this->_req_action ])) {
+        if ( ! isset($this->_cpt_routes[$this->_req_action])) {
             return;
         }
         $this->_cpt_route = true;
@@ -671,7 +671,7 @@ 
             empty($this->_cpt_model_names)
             || (
                 ! $ignore_route_check
-                && ! isset($this->_cpt_routes[ $this->_req_action ])
+                && ! isset($this->_cpt_routes[$this->_req_action])
             )
             || (
                 $this->_cpt_model_obj instanceof EE_CPT_Base
@@ -689,11 +689,11 @@ 
                 'EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions'
             );
             $model_names       = $custom_post_types->getCustomPostTypeModelNames($post_type);
-            if (isset($model_names[ $post_type ])) {
-                $model = EE_Registry::instance()->load_model($model_names[ $post_type ]);
+            if (isset($model_names[$post_type])) {
+                $model = EE_Registry::instance()->load_model($model_names[$post_type]);
             }
         } else {
-            $model = EE_Registry::instance()->load_model($this->_cpt_model_names[ $this->_req_action ]);
+            $model = EE_Registry::instance()->load_model($this->_cpt_model_names[$this->_req_action]);
         }
         if ($model instanceof EEM_Base) {
             $this->_cpt_model_obj = ! empty($id) ? $model->get_one_by_ID($id) : $model->create_default_object();
@@ -721,8 +721,8 @@ 
         $post           = get_post($post_ID);
         $post_type      = $post instanceof WP_Post ? $post->post_type : false;
         $current_route  = $this->request->getRequestParam('current_route', 'shouldneverwork');
-        $route_to_check = $post_type && isset($this->_cpt_routes[ $current_route ])
-            ? $this->_cpt_routes[ $current_route ]
+        $route_to_check = $post_type && isset($this->_cpt_routes[$current_route])
+            ? $this->_cpt_routes[$current_route]
             : '';
         add_filter('get_delete_post_link', [$this, 'modify_delete_post_link'], 10, 2);
         add_filter('get_edit_post_link', [$this, 'modify_edit_post_link'], 10, 2);
@@ -731,10 +731,10 @@ 
         }
         // now let's filter redirect if we're on a revision page and the revision is for an event CPT.
         $revision = $this->request->getRequestParam('revision');
-        if (! empty($revision)) {
+        if ( ! empty($revision)) {
             $action = $this->request->getRequestParam('action');
             // doing a restore?
-            if (! empty($action) && $action === 'restore') {
+            if ( ! empty($action) && $action === 'restore') {
                 // get post for revision
                 $rev_post   = get_post($revision);
                 $rev_parent = get_post($rev_post->post_parent);
@@ -771,7 +771,7 @@ 
     {
         $this->_set_model_object($post_id, true, 'trash');
         // if our cpt object isn't existent then get out immediately.
-        if (! $this->_cpt_model_obj instanceof EE_CPT_Base || $this->_cpt_model_obj->ID() !== $post_id) {
+        if ( ! $this->_cpt_model_obj instanceof EE_CPT_Base || $this->_cpt_model_obj->ID() !== $post_id) {
             return;
         }
         $this->trash_cpt_item($post_id);
@@ -790,7 +790,7 @@ 
     {
         $this->_set_model_object($post_id, true, 'restore');
         // if our cpt object isn't existent then get out immediately.
-        if (! $this->_cpt_model_obj instanceof EE_CPT_Base || $this->_cpt_model_obj->ID() !== $post_id) {
+        if ( ! $this->_cpt_model_obj instanceof EE_CPT_Base || $this->_cpt_model_obj->ID() !== $post_id) {
             return;
         }
         $this->restore_cpt_item($post_id);
@@ -809,7 +809,7 @@ 
     {
         $this->_set_model_object($post_id, true, 'delete');
         // if our cpt object isn't existent then get out immediately.
-        if (! $this->_cpt_model_obj instanceof EE_CPT_Base || $this->_cpt_model_obj->ID() !== $post_id) {
+        if ( ! $this->_cpt_model_obj instanceof EE_CPT_Base || $this->_cpt_model_obj->ID() !== $post_id) {
             return;
         }
         $this->delete_cpt_item($post_id);
@@ -828,7 +828,7 @@ 
     {
         $label = ! empty($this->_cpt_object) ? $this->_cpt_object->labels->singular_name : $this->page_label;
         // verify event object
-        if (! $this->_cpt_model_obj instanceof EE_CPT_Base) {
+        if ( ! $this->_cpt_model_obj instanceof EE_CPT_Base) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -883,13 +883,13 @@ 
         if ($this->_cpt_model_obj instanceof EE_CPT_Base) {
             // setup custom post status object for localize script but only if we've got a cpt object
             $statuses = $this->_cpt_model_obj->get_custom_post_statuses();
-            if (! empty($statuses)) {
+            if ( ! empty($statuses)) {
                 // get ALL statuses!
                 $statuses = $this->_cpt_model_obj->get_all_post_statuses();
                 // setup object
                 $ee_cpt_statuses = [];
                 foreach ($statuses as $status => $label) {
-                    $ee_cpt_statuses[ $status ] = [
+                    $ee_cpt_statuses[$status] = [
                         'label'      => $label,
                         'save_label' => sprintf(
                             wp_strip_all_tags(__('Save as %s', 'event_espresso')),
@@ -954,7 +954,7 @@ 
                 $post->page_template = $page_template;
                 $page_templates      = wp_get_theme()->get_page_templates($post);
             }
-            if ($page_template !== 'default' && ! isset($page_templates[ $page_template ])) {
+            if ($page_template !== 'default' && ! isset($page_templates[$page_template])) {
                 EE_Error::add_error(
                     esc_html__('Invalid Page Template.', 'event_espresso'),
                     __FILE__,
@@ -984,7 +984,7 @@ 
     {
         // only do this if we're actually processing one of our CPTs
         // if our cpt object isn't existent then get out immediately.
-        if (! $this->_cpt_model_obj instanceof EE_CPT_Base) {
+        if ( ! $this->_cpt_model_obj instanceof EE_CPT_Base) {
             return;
         }
         delete_post_meta($post_id, '_wp_trash_meta_status');
@@ -1009,7 +1009,7 @@ 
         // global action
         do_action('AHEE_EE_Admin_Page_CPT__restore_revision', $post_id, $revision_id);
         // class specific action so you can limit hooking into a specific page.
-        do_action('AHEE_EE_Admin_Page_CPT_' . get_class($this) . '__restore_revision', $post_id, $revision_id);
+        do_action('AHEE_EE_Admin_Page_CPT_'.get_class($this).'__restore_revision', $post_id, $revision_id);
     }
 
 
@@ -1038,11 +1038,11 @@ 
     public function modify_current_screen()
     {
         // ONLY do this if the current page_route IS a cpt route
-        if (! $this->_cpt_route) {
+        if ( ! $this->_cpt_route) {
             return;
         }
         // routing things REALLY early b/c this is a cpt admin page
-        set_current_screen($this->_cpt_routes[ $this->_req_action ]);
+        set_current_screen($this->_cpt_routes[$this->_req_action]);
         $this->_current_screen       = get_current_screen();
         $this->_current_screen->base = 'event-espresso';
         $this->_add_help_tabs(); // we make sure we add any help tabs back in!
@@ -1065,7 +1065,7 @@ 
      */
     public function add_custom_editor_default_title(?string $title): ?string
     {
-        return $this->_labels['editor_title'][ $this->_cpt_routes[ $this->_req_action ] ] ?? $title;
+        return $this->_labels['editor_title'][$this->_cpt_routes[$this->_req_action]] ?? $title;
     }
 
 
@@ -1115,10 +1115,10 @@ 
     {
         // we're also going to add the route value and the current page so we can direct autosave parsing correctly
         echo '
-        <input type="hidden" name="ee_cpt_item_redirect_url" value="' . esc_url_raw($this->_admin_base_url) . '"/>
+        <input type="hidden" name="ee_cpt_item_redirect_url" value="' . esc_url_raw($this->_admin_base_url).'"/>
         <div id="ee-cpt-hidden-inputs">
-            <input type="hidden" id="current_route" name="current_route" value="' . esc_attr($this->_current_view) . '"/>
-            <input type="hidden" id="current_page" name="current_page" value="' . esc_attr($this->page_slug) . '"/>
+            <input type="hidden" id="current_route" name="current_route" value="' . esc_attr($this->_current_view).'"/>
+            <input type="hidden" id="current_page" name="current_page" value="' . esc_attr($this->page_slug).'"/>
         </div>';
     }
 
@@ -1165,13 +1165,13 @@ 
         $action = $this->request->getRequestParam('action');
         if (
             empty($action)
-            || ! isset($this->_cpt_routes[ $action ])
-            || $post->post_type !== $this->_cpt_routes[ $action ]
+            || ! isset($this->_cpt_routes[$action])
+            || $post->post_type !== $this->_cpt_routes[$action]
         ) {
             return $link;
         }
         $query_args = [
-            'action' => $this->_cpt_edit_routes[ $post->post_type ] ?? 'edit',
+            'action' => $this->_cpt_edit_routes[$post->post_type] ?? 'edit',
             'post'   => $id,
         ];
         return EE_Admin_Page_CPT::add_query_args_and_nonce($query_args, $this->_admin_base_url);
@@ -1195,15 +1195,15 @@ 
         if (
             ! $post instanceof WP_Post
             || empty($action)
-            || ! isset($this->_cpt_routes[ $action ])
-            || $post->post_type !== $this->_cpt_routes[ $action ]
+            || ! isset($this->_cpt_routes[$action])
+            || $post->post_type !== $this->_cpt_routes[$action]
         ) {
             return $delete_link;
         }
         $this->_set_model_object($post->ID, true);
 
         // returns something like `trash_event` or `trash_attendee` or `trash_venue`
-        $action = 'trash_' . str_replace('ee_', '', strtolower(get_class($this->_cpt_model_obj)));
+        $action = 'trash_'.str_replace('ee_', '', strtolower(get_class($this->_cpt_model_obj)));
 
         return EE_Admin_Page::add_query_args_and_nonce(
             [
@@ -1231,7 +1231,7 @@ 
         // we DO have a match so let's setup the url
         // we have to get the post to determine our route
         $post       = get_post($post_id);
-        $edit_route = $this->_cpt_edit_routes[ $post->post_type ];
+        $edit_route = $this->_cpt_edit_routes[$post->post_type];
         // shared query_args
         $query_args = ['action' => $edit_route, 'post' => $post_id];
 
@@ -1298,12 +1298,12 @@ 
         $id       = empty($id) && is_object($post) ? $post->ID : null;
         $revision = $this->request->getRequestParam('revision', 0, 'int');
 
-        $messages[ $post->post_type ] = [
+        $messages[$post->post_type] = [
             0  => '', // Unused. Messages start at index 1.
             1  => sprintf(
                 esc_html__('%1$s updated. %2$sView %1$s%3$s', 'event_espresso'),
                 $this->_cpt_object->labels->singular_name,
-                '<a href="' . esc_url(get_permalink($id)) . '">',
+                '<a href="'.esc_url(get_permalink($id)).'">',
                 '</a>'
             ),
             2  => esc_html__('Custom field updated', 'event_espresso'),
@@ -1319,27 +1319,27 @@ 
             6  => sprintf(
                 esc_html__('%1$s published. %2$sView %1$s%3$s', 'event_espresso'),
                 $this->_cpt_object->labels->singular_name,
-                '<a href="' . esc_url(get_permalink($id)) . '">',
+                '<a href="'.esc_url(get_permalink($id)).'">',
                 '</a>'
             ),
             7  => sprintf(esc_html__('%1$s saved.', 'event_espresso'), $this->_cpt_object->labels->singular_name),
             8  => sprintf(
                 esc_html__('%1$s submitted. %2$sPreview %1$s%3$s', 'event_espresso'),
                 $this->_cpt_object->labels->singular_name,
-                '<a target="_blank" href="' . esc_url(add_query_arg('preview', 'true', get_permalink($id))) . '">',
+                '<a target="_blank" href="'.esc_url(add_query_arg('preview', 'true', get_permalink($id))).'">',
                 '</a>'
             ),
             9  => sprintf(
                 esc_html__('%1$s scheduled for: %2$s. %3$s">Preview %1$s%3$s', 'event_espresso'),
                 $this->_cpt_object->labels->singular_name,
-                '<strong>' . date_i18n('M j, Y @ G:i', strtotime($post->post_date)) . '</strong>',
-                '<a target="_blank" href="' . esc_url(get_permalink($id)),
+                '<strong>'.date_i18n('M j, Y @ G:i', strtotime($post->post_date)).'</strong>',
+                '<a target="_blank" href="'.esc_url(get_permalink($id)),
                 '</a>'
             ),
             10 => sprintf(
                 esc_html__('%1$s draft updated. %2$s">Preview page%3$s', 'event_espresso'),
                 $this->_cpt_object->labels->singular_name,
-                '<a target="_blank" href="' . esc_url(add_query_arg('preview', 'true', get_permalink($id))),
+                '<a target="_blank" href="'.esc_url(add_query_arg('preview', 'true', get_permalink($id))),
                 '</a>'
             ),
         ];
@@ -1357,10 +1357,10 @@ 
     {
         // gather template vars for WP_ADMIN_PATH . 'edit-form-advanced.php'
         global $post, $title, $post_type, $post_type_object;
-        $post_type        = $this->_cpt_routes[ $this->_req_action ];
+        $post_type        = $this->_cpt_routes[$this->_req_action];
         $post_type_object = $this->_cpt_object;
         $title            = $post_type_object->labels->add_new_item;
-        $post             = $post = get_default_post_to_edit($this->_cpt_routes[ $this->_req_action ], true);
+        $post             = $post = get_default_post_to_edit($this->_cpt_routes[$this->_req_action], true);
         add_action('admin_print_styles', [$this, 'add_new_admin_page_global']);
         // modify the default editor title field with default title.
         add_filter('enter_title_here', [$this, 'add_custom_editor_default_title']);
@@ -1394,15 +1394,15 @@ 
             if ($creating) {
                 wp_enqueue_script('autosave');
             } elseif (
-                isset($this->_cpt_routes[ $action ])
-                && ! isset($this->_labels['hide_add_button_on_cpt_route'][ $action ])
+                isset($this->_cpt_routes[$action])
+                && ! isset($this->_labels['hide_add_button_on_cpt_route'][$action])
             ) {
                 $create_new_action = apply_filters(
                     'FHEE__EE_Admin_Page_CPT___edit_cpt_item__create_new_action',
                     'create_new',
                     $this
                 );
-                $post_new_file     = EE_Admin_Page::add_query_args_and_nonce(
+                $post_new_file = EE_Admin_Page::add_query_args_and_nonce(
                     [
                         'action' => $create_new_action,
                         'page'   => $this->page_slug,
@@ -1410,7 +1410,7 @@ 
                     'admin.php'
                 );
             }
-            include_once WP_ADMIN_PATH . 'edit-form-advanced.php';
+            include_once WP_ADMIN_PATH.'edit-form-advanced.php';
         }
     }
 
@@ -1455,16 +1455,16 @@ 
         }
 
         // template vars for WP_ADMIN_PATH . 'edit-form-advanced.php'
-        $post_type        = $this->_cpt_routes[ $this->_req_action ];
+        $post_type        = $this->_cpt_routes[$this->_req_action];
         $post_type_object = $this->_cpt_object;
-        $title = $this->_labels['editor_title'][ $this->_cpt_routes[ $this->_req_action ] ]
+        $title = $this->_labels['editor_title'][$this->_cpt_routes[$this->_req_action]]
                  ?? $post_type_object->labels->edit_item;
 
-        if (! wp_check_post_lock($post->ID)) {
+        if ( ! wp_check_post_lock($post->ID)) {
             wp_set_post_lock($post->ID);
         }
         add_action('admin_footer', '_admin_notice_post_locked');
-        if (post_type_supports($this->_cpt_routes[ $this->_req_action ], 'comments')) {
+        if (post_type_supports($this->_cpt_routes[$this->_req_action], 'comments')) {
             wp_enqueue_script('admin-comments');
             enqueue_comment_hotkeys_js();
         }

core/admin/EE_Admin_List_Table.core.php

Indentation +946 added lines, -946 removed lines

@@ -5,7 +5,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';
 }
 
 
@@ -23,928 +23,928 @@ 
  */
 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 $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 $_data;
-
-
-    /**
-     * This holds the value of all the data available for the given view (for all pages).
-     *
-     * @var int $_all_data_count
-     */
-    protected $_all_data_count;
-
-
-    /**
-     * Will contain the count of trashed items for the view label.
-     *
-     * @var int $_trashed_count
-     */
-    protected $_trashed_count;
-
-
-    /**
-     * This is what will be referenced as the slug for the current screen
-     *
-     * @var string $_screen
-     */
-    protected $_screen;
-
-
-    /**
-     * this is the EE_Admin_Page object
-     *
-     * @var EE_Admin_Page $_admin_page
-     */
-    protected $_admin_page;
-
-
-    /**
-     * The current view
-     *
-     * @var string $_view
-     */
-    protected $_view;
-
-
-    /**
-     * array of possible views for this table
-     *
-     * @var array $_views
-     */
-    protected $_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 $_wp_list_args;
-
-    /**
-     * an array of column names
-     * array(
-     *    'internal-name' => 'Title'
-     * )
-     *
-     * @var array $_columns
-     */
-    protected $_columns;
-
-    /**
-     * An array of sortable columns
-     * array(
-     *    'internal-name' => 'orderby' //or
-     *    'internal-name' => array( 'orderby', true )
-     * )
-     *
-     * @var array $_sortable_columns
-     */
-    protected $_sortable_columns;
-
-    /**
-     * callback method used to perform AJAX row reordering
-     *
-     * @var string $_ajax_sorting_callback
-     */
-    protected $_ajax_sorting_callback;
-
-    /**
-     * An array of hidden columns (if needed)
-     * array('internal-name', 'internal-name')
-     *
-     * @var array $_hidden_columns
-     */
-    protected $_hidden_columns;
-
-    /**
-     * holds the per_page value
-     *
-     * @var int $_per_page
-     */
-    protected $_per_page;
-
-    /**
-     * holds what page number is currently being viewed
-     *
-     * @var int $_current_page
-     */
-    protected $_current_page;
-
-    /**
-     * the reference string for the nonce_action
-     *
-     * @var string $_nonce_action_ref
-     */
-    protected $_nonce_action_ref;
-
-    /**
-     * property to hold incoming request data (as set by the admin_page_core)
-     *
-     * @var array $_req_data
-     */
-    protected $_req_data;
-
-
-    /**
-     * yes / no array for admin form fields
-     *
-     * @var array $_yes_no
-     */
-    protected $_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 $_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 $_primary_column = '';
-
-
-    /**
-     * Used to indicate whether the table has a checkbox column or not.
-     *
-     * @type bool $_has_checkbox_column
-     */
-    protected $_has_checkbox_column = false;
-
-    /**
-     * @var AdminListTableFilters|null
-     */
-    protected ?AdminListTableFilters $admin_list_table_filters = 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->_admin_page   = $admin_page;
-        $this->_req_data     = $this->_admin_page->get_request_data();
-        $this->_view         = $this->_admin_page->get_view();
-        $this->_views        = empty($this->_views) ? $this->_admin_page->get_list_table_view_RLs() : $this->_views;
-        $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();
-
-        $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()
-    {
-        $action = isset($this->_req_data['route']) ? $this->_req_data['route'] : '';
-        $action = empty($action) && isset($this->_req_data['action']) ? $this->_req_data['action'] : $action;
-        // if action is STILL empty, then we set it to default
-        $action = empty($action) ? 'default' : $action;
-        $field  = '<input type="hidden" name="page" value="' . esc_attr($this->_req_data['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 = 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] = isset($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']);
-        }
-        ?>
+	const ACTION_COPY    = 'duplicate';
+
+	const ACTION_DELETE  = 'delete';
+
+	const ACTION_EDIT    = 'edit';
+
+	const ACTION_RESTORE = 'restore';
+
+	const ACTION_TRASH   = 'trash';
+
+	protected static $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 $_data;
+
+
+	/**
+	 * This holds the value of all the data available for the given view (for all pages).
+	 *
+	 * @var int $_all_data_count
+	 */
+	protected $_all_data_count;
+
+
+	/**
+	 * Will contain the count of trashed items for the view label.
+	 *
+	 * @var int $_trashed_count
+	 */
+	protected $_trashed_count;
+
+
+	/**
+	 * This is what will be referenced as the slug for the current screen
+	 *
+	 * @var string $_screen
+	 */
+	protected $_screen;
+
+
+	/**
+	 * this is the EE_Admin_Page object
+	 *
+	 * @var EE_Admin_Page $_admin_page
+	 */
+	protected $_admin_page;
+
+
+	/**
+	 * The current view
+	 *
+	 * @var string $_view
+	 */
+	protected $_view;
+
+
+	/**
+	 * array of possible views for this table
+	 *
+	 * @var array $_views
+	 */
+	protected $_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 $_wp_list_args;
+
+	/**
+	 * an array of column names
+	 * array(
+	 *    'internal-name' => 'Title'
+	 * )
+	 *
+	 * @var array $_columns
+	 */
+	protected $_columns;
+
+	/**
+	 * An array of sortable columns
+	 * array(
+	 *    'internal-name' => 'orderby' //or
+	 *    'internal-name' => array( 'orderby', true )
+	 * )
+	 *
+	 * @var array $_sortable_columns
+	 */
+	protected $_sortable_columns;
+
+	/**
+	 * callback method used to perform AJAX row reordering
+	 *
+	 * @var string $_ajax_sorting_callback
+	 */
+	protected $_ajax_sorting_callback;
+
+	/**
+	 * An array of hidden columns (if needed)
+	 * array('internal-name', 'internal-name')
+	 *
+	 * @var array $_hidden_columns
+	 */
+	protected $_hidden_columns;
+
+	/**
+	 * holds the per_page value
+	 *
+	 * @var int $_per_page
+	 */
+	protected $_per_page;
+
+	/**
+	 * holds what page number is currently being viewed
+	 *
+	 * @var int $_current_page
+	 */
+	protected $_current_page;
+
+	/**
+	 * the reference string for the nonce_action
+	 *
+	 * @var string $_nonce_action_ref
+	 */
+	protected $_nonce_action_ref;
+
+	/**
+	 * property to hold incoming request data (as set by the admin_page_core)
+	 *
+	 * @var array $_req_data
+	 */
+	protected $_req_data;
+
+
+	/**
+	 * yes / no array for admin form fields
+	 *
+	 * @var array $_yes_no
+	 */
+	protected $_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 $_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 $_primary_column = '';
+
+
+	/**
+	 * Used to indicate whether the table has a checkbox column or not.
+	 *
+	 * @type bool $_has_checkbox_column
+	 */
+	protected $_has_checkbox_column = false;
+
+	/**
+	 * @var AdminListTableFilters|null
+	 */
+	protected ?AdminListTableFilters $admin_list_table_filters = 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->_admin_page   = $admin_page;
+		$this->_req_data     = $this->_admin_page->get_request_data();
+		$this->_view         = $this->_admin_page->get_view();
+		$this->_views        = empty($this->_views) ? $this->_admin_page->get_list_table_view_RLs() : $this->_views;
+		$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();
+
+		$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()
+	{
+		$action = isset($this->_req_data['route']) ? $this->_req_data['route'] : '';
+		$action = empty($action) && isset($this->_req_data['action']) ? $this->_req_data['action'] : $action;
+		// if action is STILL empty, then we set it to default
+		$action = empty($action) ? 'default' : $action;
+		$field  = '<input type="hidden" name="page" value="' . esc_attr($this->_req_data['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 = 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] = isset($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']);
+		}
+		?>
         <div class="tablenav <?php echo esc_attr($which); ?>">
             <?php if ($this->_get_bulk_actions()) { ?>
                 <div class="alignleft actions bulkactions">
                     <?php $this->bulk_actions(); ?>
                 </div>
             <?php }
-            $this->extra_tablenav($which);
-            $this->pagination($which);
-            ?>
+			$this->extra_tablenav($which);
+			$this->pagination($which);
+			?>
 
             <br class="clear" />
         </div>
         <?php
-    }
-
-
-    /**
-     * _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 = isset($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()
-    {
-        $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();
-            echo wp_kses($this->_get_hidden_fields(), AllowedTags::getWithFormTags());
-        } else {
-            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
-     * @return string
-     * @since   5.0.0.p
-     */
-    protected function columnContent($id, $content, $align = 'start')
-    {
-        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}";
-
-        $html = "<div class='ee-responsive-table-cell ee-responsive-table-cell--column-{$id} {$align} ee-layout-row'>";
-        $html .= "<div class='ee-responsive-table-cell__heading'>{$heading}</div>";
-        $html .= "<div class='ee-responsive-table-cell__content ee-layout-row'>{$content}</div>";
-        $html .= "</div>";
-        return $html;
-    }
-
-
-    protected function actionsModalMenu($actions): string
-    {
-        return '
+	}
+
+
+	/**
+	 * _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 = isset($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()
+	{
+		$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();
+			echo wp_kses($this->_get_hidden_fields(), AllowedTags::getWithFormTags());
+		} else {
+			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
+	 * @return string
+	 * @since   5.0.0.p
+	 */
+	protected function columnContent($id, $content, $align = 'start')
+	{
+		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}";
+
+		$html = "<div class='ee-responsive-table-cell ee-responsive-table-cell--column-{$id} {$align} ee-layout-row'>";
+		$html .= "<div class='ee-responsive-table-cell__heading'>{$heading}</div>";
+		$html .= "<div class='ee-responsive-table-cell__content ee-layout-row'>{$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') . '"
@@ -956,43 +956,43 @@ 
                 ' . $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()
+		);
+	}
 }

core/admin/templates/admin_wrapper.template.php

Indentation +6 added lines, -6 removed lines

@@ -23,11 +23,11 @@
 	<?php echo wp_kses($nav_tabs, AllowedTags::getWithFormTags()); ?>
 
 	<?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>

Spacing +1 added lines, -1 removed lines

@@ -15,7 +15,7 @@
 <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 id="ajax-notices-container"></div>